diff --git a/README.md b/README.md index 83d89a18..638cdca4 100644 --- a/README.md +++ b/README.md @@ -405,7 +405,7 @@ Next time you need this list just use an alias, like this: - `number`: [number=1] Number of boards to build (components multiplier). - `output`: [string='%f-%i%v.%x'] filename for the output (%i=bom). Affected by global options. - `use_alt`: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18. - - `variant`: [string=''] Board variant(s), used to determine which components + - `variant`: [string=''] Board variant, used to determine which components are output to the BoM.. - `xlsx`: [dict] Options for the XLSX format. * Valid keys: @@ -812,7 +812,10 @@ Next time you need this list just use an alias, like this: - `name`: [string=''] Used to identify this particular output definition. - `options`: [dict] Options for the `pdf_sch_print` output. * Valid keys: + - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. + A short-cut to use for simple cases where a variant is an overkill. - `output`: [string='%f-%i%v.%x'] filename for the output PDF (%i=schematic %x=pdf). Affected by global options. + - `variant`: [string=''] Board variant(s), used to determine which components are crossed.. * Pick & place * Type: `position` @@ -877,6 +880,8 @@ Next time you need this list just use an alias, like this: - `name`: [string=''] Used to identify this particular output definition. - `options`: [dict] Options for the `sch_variant` output. * Valid keys: + - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. + A short-cut to use for simple cases where a variant is an overkill. - `variant`: [string=''] Board variant(s) to apply. * STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure) diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index f564ed59..e5c745a3 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -121,7 +121,7 @@ outputs: output: '%f-%i%v.%x' # [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18 use_alt: false - # [string=''] Board variant(s), used to determine which components + # [string=''] Board variant, used to determine which components # are output to the BoM. variant: '' # [dict] Options for the XLSX format @@ -619,8 +619,13 @@ outputs: type: 'pdf_sch_print' dir: 'Example/pdf_sch_print_dir' options: + # [string|list(string)=''] Name of the filter to mark components as not fitted. + # A short-cut to use for simple cases where a variant is an overkill + dnf_filter: '' # [string='%f-%i%v.%x'] filename for the output PDF (%i=schematic %x=pdf). Affected by global options output: '%f-%i%v.%x' + # [string=''] Board variant(s), used to determine which components are crossed. + variant: '' # Pick & place: # This output is what you get from the 'File/Fabrication output/Footprint poistion (.pos) file' menu in pcbnew. @@ -694,6 +699,9 @@ outputs: type: 'sch_variant' dir: 'Example/sch_variant_dir' options: + # [string|list(string)=''] Name of the filter to mark components as not fitted. + # A short-cut to use for simple cases where a variant is an overkill + dnf_filter: '' # [string=''] Board variant(s) to apply variant: ''