From 267a38c32f28c247f5072cf3953bfe79250ad2e6 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 11 Apr 2022 17:37:03 -0300 Subject: [PATCH] Documented the %X substitutions for SVG output in pcb_print --- README.md | 2 +- docs/samples/generic_plot.kibot.yaml | 2 +- kibot/out_pcb_print.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6588a377..29980d0f 100644 --- a/README.md +++ b/README.md @@ -1538,7 +1538,7 @@ Next time you need this list just use an alias, like this: - `drill_marks`: [string='full'] What to use to indicate the drill places, can be none, small or full (for real scale). - `format`: [string='PDF'] [PDF,SVG] Format for the output file/s. - `hide_excluded`: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. - - `output`: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=assembly, %x=pdf). Affected by global options. + - `output`: [string='%f-%i%I%v.%x'] Filename for the output (%i=assembly, %x=pdf)/(%i=assembly_page_NN, %x=svg). Affected by global options. - *output_name*: Alias for output. - `pages`: [list(dict)] List of pages to include in the output document. Each page contains one or more layers of the PCB. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index e7e85318..7b6375ab 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -970,7 +970,7 @@ outputs: format: 'PDF' # [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant hide_excluded: false - # [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=assembly, %x=pdf). Affected by global options + # [string='%f-%i%I%v.%x'] Filename for the output (%i=assembly, %x=pdf)/(%i=assembly_page_NN, %x=svg). Affected by global options output: '%f-%i%I%v.%x' # `output_name` is an alias for `output` # [list(dict)] List of pages to include in the output document. diff --git a/kibot/out_pcb_print.py b/kibot/out_pcb_print.py index 68a0be93..4f7320e7 100644 --- a/kibot/out_pcb_print.py +++ b/kibot/out_pcb_print.py @@ -219,7 +219,7 @@ class PCB_PrintOptions(VariantOptions): self.output_name = None """ {output} """ self.output = GS.def_global_output - """ Filename for the output PDF (%i=assembly, %x=pdf)""" + """ Filename for the output (%i=assembly, %x=pdf)/(%i=assembly_page_NN, %x=svg)""" self.hide_excluded = False """ Hide components in the Fab layer that are marked as excluded by a variant """ self._drill_marks = 'full'