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

[DOCs] Added a note about the importance of %i 

- When using position output and separate files

Related to #222
This commit is contained in:
Salvador E. Tropea 2022-07-14 08:28:31 -03:00
parent ba7bebd980
commit 882999edf4
3 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

@ -2385,7 +2385,8 @@ Notes:
* Valid keys:
- **`format`**: [string='ASCII'] [ASCII,CSV] Format for the position file.
- **`only_smd`**: [boolean=true] Only include the surface mount components.
- **`output`**: [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options.
- **`output`**: [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv').
Important: when using separate files you must use `%i` to differentiate them. Affected by global options.
- **`separate_files_for_front_and_back`**: [boolean=true] Generate two separated files, one for the top and another for the bottom.
- **`units`**: [string='millimeters'] [millimeters,inches,mils] Units used for the positions. Affected by global options.
- `bottom_negative_x`: [boolean=false] Use negative X coordinates for footprints on bottom layer.

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

@ -1334,7 +1334,8 @@ outputs:
include_virtual: false
# [boolean=true] Only include the surface mount components
only_smd: true
# [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Affected by global options
# [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv').
# Important: when using separate files you must use `%i` to differentiate them. Affected by global options
output: '%f-%i%I%v.%x'
# [boolean=true] Generate two separated files, one for the top and another for the bottom
separate_files_for_front_and_back: true

3
kibot/out_position.py
View File

@ -66,7 +66,8 @@ class PositionOptions(VariantOptions):
self.only_smd = True
""" *Only include the surface mount components """
self.output = GS.def_global_output
""" *Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv') """
""" *Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv').
Important: when using separate files you must use `%i` to differentiate them """
self.units = 'millimeters'
""" *[millimeters,inches,mils] Units used for the positions. Affected by global options """
self.columns = PosColumns