Documentation improvements

This commit is contained in:
Oliver 2016-05-15 23:25:29 +10:00
parent 9ae520e60e
commit aaa6a30047
3 changed files with 4 additions and 5 deletions

View File

@ -60,14 +60,13 @@ BoM generation options can be configured (on a per-project basis) by editing the
* *ignore_dnf*: Component groups marked as 'DNF' (do not fit) will be excluded from the BoM output
* *number_rows*: Add row numbers to the BoM output
* *group_connectors*: If this option is set, connector comparison based on the 'Value' field is ignored. This allows multiple connectors which are named for their function (e.g. "Power", "ICP" etc) can be grouped together.
* *test_regex*: If this option is set, each component group row is test against a list of (user configurable) regular expressions. If any matches are found, that row is excluded from the output BoM file.
* *IGNORE_COLUMNS*: A list of columns can be marked as 'ignore', and will not be output to the BoM file. By default, the *Part_Lib* and *Footprint_Lib* columns are ignored.
* *EXCLUDE_COMPONENT_VALUES*: A list of regular expressions to ignore components based on their value
* *EXCLUDE_COMPONENT_REFS*: A list of regular expressions to ignore components based on their reference
* *EXCLUDE_COMPONENT_FP*: A list of regular expressions to ignore components based on their footprint
* *COMPONENT_ALIASES*: A list of space-separated values which allows multiple schematic symbol visualisations to be consolidated.
* *REGEXCLUDE_<COLUMN_NAME>*: A list of regular expressions to ignore components based on the value in a given column.
Example configuration file (.ini format)
![alt tag](example/options.png?raw=True "Configuration")
Example configuration file (.ini format) *default values shown*
![alt tag](example/ini.png?raw=True "Configuration")
## Example

BIN
example/ini.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB