templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documented the added features.

This commit is contained in:
Salvador E. Tropea 2022-07-11 12:41:23 -03:00
parent 209248ae8d
commit 139ee82bdc
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1844,7 +1844,7 @@ Notes:
- **`format`**: [string='HTML'] [HTML,CSV,XML,XLSX] Format for the BoM.
- **`number`**: [number=1] Number of boards to build (components multiplier).
- **`output`**: [string='%f-%i%I%v.%x'] Filename for the output (%i=bom). Affected by global options.
- `conf`: [string|dict] BoM configuration file, relative to PCB.
- `conf`: [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed.
You can also define the configuration here, will be stored in `config.kibom.ini`.
* Valid keys:
- **`columns`**: [list(dict)|list(string)] List of columns to display.
@ -2588,6 +2588,7 @@ Notes:
In Debian/Ubuntu environments: install `pandoc`, `texlive-latex-base` and `texlive-latex-recommended`.
- **`output`**: [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options.
- **`template`**: [string='full'] Name for one of the internal templates (full, full_svg, simple) or a custom template file.
Environment variables and ~ are allowed.
Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`).
- `convert_from`: [string='markdown'] Original format for the report conversion. Current templates are `markdown`. See `do_convert`.
- `converted_output`: [string='%f-%i%I%v.%x'] Converted output file name (%i='report', %x=`convert_to`).

3
docs/samples/generic_plot.kibot.yaml
View File

@ -797,7 +797,7 @@ outputs:
type: 'kibom'
dir: 'Example/kibom_dir'
options:
# [string|dict] BoM configuration file, relative to PCB.
# [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed.
# You can also define the configuration here, will be stored in `config.kibom.ini`
conf:
# [list(dict)|list(string)] List of columns to display.
@ -1546,6 +1546,7 @@ outputs:
# [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options
output: '%f-%i%I%v.%x'
# [string='full'] Name for one of the internal templates (full, full_svg, simple) or a custom template file.
# Environment variables and ~ are allowed.
# Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`)
template: 'full'
# Schematic with variant generator:

2
kibot/out_kibom.py
View File

@ -342,7 +342,7 @@ class KiBoMOptions(BaseOptions):
variants with the ';' (semicolon) character.
This isn't related to the KiBot concept of variants """
self.conf = KiBoMConfig
""" [string|dict] BoM configuration file, relative to PCB.
""" [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed.
You can also define the configuration here, will be stored in `config.kibom.ini` """
self.separator = ','
""" CSV Separator """

1
kibot/out_report.py
View File

@ -177,6 +177,7 @@ class ReportOptions(BaseOptions):
""" *Output file name (%i='report', %x='txt') """
self.template = 'full'
""" *Name for one of the internal templates (full, full_svg, simple) or a custom template file.
Environment variables and ~ are allowed.
Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`) """
self.convert_from = 'markdown'
""" Original format for the report conversion. Current templates are `markdown`. See `do_convert` """