From e4ee39eadf783a94b284b643a8fd7876a55aa208 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Wed, 14 Sep 2022 13:33:38 -0300 Subject: [PATCH] [DOCs] Added details about what poor means regarding to worksheet Related to #233 --- README.md | 7 +++++++ docs/samples/generic_plot.kibot.yaml | 6 ++++++ kibot/out_any_layer.py | 1 + 3 files changed, 14 insertions(+) diff --git a/README.md b/README.md index f787c742..84becf0f 100644 --- a/README.md +++ b/README.md @@ -1668,6 +1668,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `custom_reports`: [list(dict)] A list of customized reports for the manufacturer. * Valid keys: @@ -1838,6 +1839,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - **`subtract_mask_from_silk`**: [boolean=false] Subtract the solder mask from the silk screen. - **`use_gerber_net_attributes`**: [boolean=true] Include netlist metadata. @@ -1900,6 +1902,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `custom_reports`: [list(dict)] A list of customized reports for the manufacturer. * Valid keys: @@ -2458,6 +2461,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `custom_reports`: [list(dict)] A list of customized reports for the manufacturer. * Valid keys: @@ -2487,6 +2491,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. @@ -2695,6 +2700,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - **`scaling`**: [number=1] Scale factor (0 means autoscaling). - `a4_output`: [boolean=true] Force A4 paper size. @@ -2973,6 +2979,7 @@ Notes: For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options. - **`plot_sheet_reference`**: [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs. - `custom_reports`: [list(dict)] A list of customized reports for the manufacturer. * Valid keys: diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index fa89e4b1..b9ccb7b8 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -567,6 +567,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Plot using the contour, instead of the center line. @@ -725,6 +726,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=false] Subtract the solder mask from the silk screen @@ -793,6 +795,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [number=0] Scale factor (0 means autoscaling) @@ -1379,6 +1382,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Cover the vias @@ -1563,6 +1567,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [number=1.0] Fine grain adjust for the X scale (floating point multiplier) @@ -1836,6 +1841,7 @@ outputs: # [boolean=true] Include the footprint values plot_footprint_values: true # [boolean=false] Include the frame and title block. Only available for KiCad 6 and you get a poor result + # (i.e. always the default worksheet style, also problems expanding text variables). # The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs plot_sheet_reference: false # [boolean=true] Cover the vias diff --git a/kibot/out_any_layer.py b/kibot/out_any_layer.py index 12779259..17452133 100644 --- a/kibot/out_any_layer.py +++ b/kibot/out_any_layer.py @@ -50,6 +50,7 @@ class AnyLayerOptions(VariantOptions): """ Do not plot the component pads in the silk screen (KiCad 5.x only) """ self.plot_sheet_reference = False """ *Include the frame and title block. Only available for KiCad 6 and you get a poor result + (i.e. always the default worksheet style, also problems expanding text variables). The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs """ self.plot_footprint_refs = True """ Include the footprint references """