From 1cf6979d89979aab7bfe7b99c766289d3eaec44d Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Wed, 27 May 2015 11:35:21 +0200 Subject: [PATCH] Dialog BOM: update help displayed by the help button. Rename dialog_footprint_wizard_list.fbp to dialog_footprint_wizard_list_base.fbp, to be consistent with other dialogs. --- eeschema/dialogs/dialog_bom_base.cpp | 2 +- eeschema/dialogs/dialog_bom_base.fbp | 2 +- eeschema/dialogs/dialog_bom_help.html | 249 ++++++++++-------- ... => dialog_footprint_wizard_list_base.fbp} | 0 4 files changed, 137 insertions(+), 116 deletions(-) rename pcbnew/dialogs/{dialog_footprint_wizard_list.fbp => dialog_footprint_wizard_list_base.fbp} (100%) diff --git a/eeschema/dialogs/dialog_bom_base.cpp b/eeschema/dialogs/dialog_bom_base.cpp index 6f96e35428..109ddc98c4 100644 --- a/eeschema/dialogs/dialog_bom_base.cpp +++ b/eeschema/dialogs/dialog_bom_base.cpp @@ -66,7 +66,7 @@ DIALOG_BOM_BASE::DIALOG_BOM_BASE( wxWindow* parent, wxWindowID id, const wxStrin bRightSizer->Add( m_buttonHelp, 0, wxALL|wxEXPAND, 5 ); m_staticline2 = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL ); - bRightSizer->Add( m_staticline2, 0, wxEXPAND|wxRIGHT|wxLEFT, 5 ); + bRightSizer->Add( m_staticline2, 0, wxEXPAND|wxALL, 5 ); m_buttonAddPlugin = new wxButton( this, ID_ADD_PLUGIN, _("Add Plugin"), wxDefaultPosition, wxDefaultSize, 0 ); bRightSizer->Add( m_buttonAddPlugin, 0, wxALIGN_CENTER_HORIZONTAL|wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 ); diff --git a/eeschema/dialogs/dialog_bom_base.fbp b/eeschema/dialogs/dialog_bom_base.fbp index 3393de4827..06230764fe 100644 --- a/eeschema/dialogs/dialog_bom_base.fbp +++ b/eeschema/dialogs/dialog_bom_base.fbp @@ -733,7 +733,7 @@ 5 - wxEXPAND|wxRIGHT|wxLEFT + wxEXPAND|wxALL 0 1 diff --git a/eeschema/dialogs/dialog_bom_help.html b/eeschema/dialogs/dialog_bom_help.html index 7f8dbd2d34..16fd44a2f7 100644 --- a/eeschema/dialogs/dialog_bom_help.html +++ b/eeschema/dialogs/dialog_bom_help.html @@ -3,35 +3,49 @@ kicad help - + - + + + + + + + + + - -

-1 -- Full documentation:

+ +

1 - +Full documentation:

-The -Eeschema -documentation, chapter 14 describes -this intermediate netlist and gives examples
See also -https://answers.launchpad.net/kicad/+faq/2265

-

-2 -- The intermediate Netlist File

+The +Eeschema documentation describes +this intermediate netlist and gives examples
See +also https://answers.launchpad.net/kicad/+faq/2265

+

2 - The intermediate Netlist File

BOM files (and netlist files) can be created from an Intermediate netlist @@ -46,9 +60,7 @@ BOM or other reports.

Depending on the output (BOM or netlist), different subsets of the complete Intermediate Netlist file will be used in the post-processing.

-

-3 -- Conversion to a new format

+

3 - Conversion to a new format

By applying a post-processing filter to the Intermediate netlist file @@ -56,8 +68,8 @@ you can generate foreign netlist files as well as BOM files. Because this conversion is a text to text transformation.

this -post-processing filter can be written using Python, XSLT, or any -other tool capable of taking XML as input.

+post-processing filter can be written using Python, XSLT, +or any other tool capable of taking XML as input.

XSLT itself is a XML language very suitable for XML transformations. There @@ -73,16 +85,15 @@ conventions. The full conversion process is handledby Eeschema, after it is configured once to run xsltproc in a specific way.

-

-4 -- Initialization of the dialog window

+

+A +Python script is somewhat more easy to create.

+

4 - Initialization of the dialog window

You should add a new pluging (a script) in plugin list by clicking on the Add Plugin button.

-

-4.1 -- Plugin Configuration Parameters

+

4.1 - Plugin Configuration Parameters

The Eeschema plug-in configuration dialog requires the following @@ -111,9 +122,8 @@ you click on the generate button the following will happen:

runs the script from the command line to create the final output file.

-

-4.2 -- Generate netlist files with the command line

+

4.2 - Generate netlist files with the command +line

Assuming we are using the program xsltproc.exe @@ -126,25 +136,33 @@ executed with the following command.

-o < output filename > < style-sheet filename > < input XML file to convert >

-On -Windows the command line is -the following.
f:/kicad/bin/xsltproc.exe --o “%O” f:/kicad/bin/plugins/myconverter.xsl “%I”

+On +Windows the command line is the following.
f:/kicad/bin/xsltproc.exe +-o “%O” f:/kicad/bin/plugins/myconverter.xsl “%I”

-On -Linux the command becomes as -following.
xsltproc --o “%O” /usr/local/kicad/bin/plugins/myconverter .xsl -“%I”

-

-Where -myconverter.xsl -is -the style-sheet that you are applying. Do not forget the double -quotes -around +On +Linux the command becomes as following.
xsltproc -o “%O” +/usr/local/kicad/bin/plugins/myconverter .xsl “%I”
where +myconverter.xsl +is +the style-sheet that you are applying.

+

+Do +not forget the double quotes +around the file names, this allows them to have spaces after the -substitution by Eeschema.

+substitution by Eeschema.

+

+If +a Python script is used, the command line is something like +(depending on the Python script):

+

+python +f:/kicad\bin/plugins/bom-in-python/myconverter.py +“%I”“%O”
or
python +/usr/local/kicad/bin/plugins/bom-in-python/myconverter .xsl “%I” +“%O” +

The command line format accepts parameters for filenames:

@@ -154,53 +172,39 @@ supported formatting parameters are.

  • - %B + %B => base filename and path of selected output file, minus path and extension.

  • -

    - %I - => complete filename and path of the temporary input file (the - intermediate net file).

    +

    + %P + => project directory, without name and without trailing '/'.

  • - %O + %I + => complete filename and path of the temporary input file + (the intermediate net file).

    +
  • +

    + %O => complete filename and path (but without extension) of the user chosen output file.

-%I -will be replaced by the actual intermediate file name
%O -will be replaced by the actual output file name.

-

-4.3 -- Command line format: example for xsltproc

-

-4.3.1 -- Command line

-

-The -command line format for xsltproc is the following:
< path of -xsltproc > xsltproc -< xsltproc parameters >

-

-On -Windows:
f:/kicad/bin/xsltproc.exe -o “%O” -f:/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”

-

-On -Linux:
xsltproc --o “%O” -/usr/local/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”

-

-The -above examples assume -xsltproc -is installed on your PC under Windows and all files located in -kicad/bin.

-

-4.3.2 -- Remark:

+%I +will be replaced by the actual intermediate file name(usually +the full root sheet filename with extension “.xml”)
%O +will +be replaced by the actual output file name (the full root sheet +filename minus extension).
%B +will +be replaced by the actual output short file name +(the +short root sheet filename minus extension).
%P +will +be replaced by the actual current project path.

+

4.3 - Command line format:

+

4.3.1 - Remark:

Most of time, the created file must have an extension, depending on its @@ -208,19 +212,49 @@ type.
Therefore you have to add to the option %O the right file extension.

For -instance %O.csv to create a .csv file (comma separated -value file).

+instance:

+
    +
  • +

    + %O.csv + to create a .csv file (comma separated value file).

    +
  • +

    + %O.html + to create a .html file.

    +
  • +

    + %O.bom + to create a .bom file.

    +
+

4.3.2 Example for xsltproc:

+

+The +command line format for xsltproc is the following:
< path of +xsltproc > xsltproc +< xsltproc parameters >

+

+On +Windows:
f:/kicad/bin/xsltproc.exe -o “%O.bom” +f:/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”

+

+On +Linux:
xsltproc -o “%O.bom” +/usr/local/kicad/bin/plugins/netlist_form_pads-pcb.xsl “%I”

+

+The +above examples assume +xsltproc +is installed on your PC under Windows xsl +exe +files +located in kicad/binplugins/.


-

-4.4 -- Command line format: example for -python scripts

-

-4.4.1 -- Command line

+

4.3.3 Example for +python scripts:

The command line format for python is something like:
python @@ -229,34 +263,21 @@ script file name > < input filename > < output filename >

On -Windows:
python.exe f:/kicad/python/my_python_script.py -“%I” “%O”

+Windows:
python.exe f:/kicad/bin/plugins +/bom-in-python/my_python_script.py “%I” +“%O.html”

On -Linux:
python -/usr/local/kicad/python/my_python_script.py “%I” -“%O”

+Linux:
python /usr/local/kicad/bin/plugins +/bom-in-python/my_python_script.py “%I” +“%O.csv”

Assuming -python is installed on your PC.

+python is installed on your PC, and python scripts are located in +kicad/bin/plugins /bom-in-python/.


-

-

-4.4.2 -- Remark:

-

-Most -of time, the created file must have an extension, depending on its -type.
Therefore you have to add to the option %O the -right file extension.

-

-For -instance %O.html to create a .html file.

-

-
-

\ No newline at end of file diff --git a/pcbnew/dialogs/dialog_footprint_wizard_list.fbp b/pcbnew/dialogs/dialog_footprint_wizard_list_base.fbp similarity index 100% rename from pcbnew/dialogs/dialog_footprint_wizard_list.fbp rename to pcbnew/dialogs/dialog_footprint_wizard_list_base.fbp