From cdb6d393ac6886f0d6a008bc0ccd1a0cc84a9d28 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Sat, 16 Apr 2022 19:35:35 -0300 Subject: [PATCH] Added more recommendations to use `pcb_print` - Can replace: pdf, ps, svg, pdf_pcb_print and svg_pcb_print --- README.md | 8 ++++++-- docs/samples/generic_plot.kibot.yaml | 9 +++++++-- kibot/out_pdf.py | 3 ++- kibot/out_pdf_pcb_print.py | 2 +- kibot/out_ps.py | 3 ++- kibot/out_svg.py | 3 ++- kibot/out_svg_pcb_print.py | 2 +- 7 files changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c80241b5..62439199 100644 --- a/README.md +++ b/README.md @@ -1648,6 +1648,7 @@ Next time you need this list just use an alias, like this: * Description: Exports the PCB to the most common exchange format. Suitable for printing. Note that this output isn't the best for documating your project. This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. - `custom_reports`: [list(dict)] A list of customized reports for the manufacturer. @@ -1719,7 +1720,7 @@ Next time you need this list just use an alias, like this: * Description: Exports the PCB to the most common exchange format. Suitable for printing. This is the main format to document your PCB. This output is what you get from the 'File/Print' menu in pcbnew. - The `pcb_print` is an alternative. + The `pcb_print` is usually a better alternative. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. - `dir`: [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. @@ -1808,6 +1809,7 @@ Next time you need this list just use an alias, like this: - `source`: [string='*.pdf'] File names to add, wildcards allowed. Use ** for recursive match. By default this pattern is applied to the output dir specified with `-d` command line option. See the `from_cwd` option. + - `use_external_command`: [boolean=false] Use the `pdfunite` tool instead of PyPDF2 Python module. - `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output. - `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested. @@ -1847,6 +1849,7 @@ Next time you need this list just use an alias, like this: * Type: `ps` * Description: Exports the PCB to a format suitable for printing. This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. - `dir`: [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. @@ -2073,6 +2076,7 @@ Next time you need this list just use an alias, like this: * Description: Exports the PCB to a format suitable for 2D graphics software. Unlike bitmaps SVG drawings can be scaled without losing resolution. This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. - `dir`: [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. @@ -2121,7 +2125,7 @@ Next time you need this list just use an alias, like this: * Type: `svg_pcb_print` * Description: Exports the PCB to the scalable vector graphics format. This output is what you get from the 'File/Print' menu in pcbnew. - The `pcb_print` is an alternative. + The `pcb_print` is usually a better alternative. * Valid keys: - `comment`: [string=''] A comment for documentation purposes. - `dir`: [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index d83724be..ffc0dc71 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -1122,6 +1122,7 @@ outputs: # PDF (Portable Document Format): # Note that this output isn't the best for documating your project. # This output is what you get from the File/Plot menu in pcbnew. + # The `pcb_print` is usually a better alternative. - name: 'pdf_example' comment: 'Exports the PCB to the most common exchange format. Suitable for printing.' type: 'pdf' @@ -1175,7 +1176,7 @@ outputs: # PDF PCB Print (Portable Document Format): # This is the main format to document your PCB. # This output is what you get from the 'File/Print' menu in pcbnew. - # The `pcb_print` is an alternative. + # The `pcb_print` is usually a better alternative. - name: 'pdf_pcb_print_example' comment: 'Exports the PCB to the most common exchange format. Suitable for printing.' type: 'pdf_pcb_print' @@ -1257,6 +1258,8 @@ outputs: # By default this pattern is applied to the output dir specified with `-d` command line option. # See the `from_cwd` option source: '*.pdf' + # [boolean=false] Use the `pdfunite` tool instead of PyPDF2 Python module + use_external_command: false # Pick & place: # This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. - name: 'position_example' @@ -1293,6 +1296,7 @@ outputs: variant: '' # PS (Postscript): # This output is what you get from the File/Plot menu in pcbnew. + # The `pcb_print` is usually a better alternative. - name: 'ps_example' comment: 'Exports the PCB to a format suitable for printing.' type: 'ps' @@ -1536,6 +1540,7 @@ outputs: # SVG (Scalable Vector Graphics): # Unlike bitmaps SVG drawings can be scaled without losing resolution. # This output is what you get from the File/Plot menu in pcbnew. + # The `pcb_print` is usually a better alternative. - name: 'svg_example' comment: 'Exports the PCB to a format suitable for 2D graphics software.' type: 'svg' @@ -1588,7 +1593,7 @@ outputs: layers: all # SVG PCB Print (Scalable Vector Graphics): # This output is what you get from the 'File/Print' menu in pcbnew. - # The `pcb_print` is an alternative. + # The `pcb_print` is usually a better alternative. - name: 'svg_pcb_print_example' comment: 'Exports the PCB to the scalable vector graphics format.' type: 'svg_pcb_print' diff --git a/kibot/out_pdf.py b/kibot/out_pdf.py index cddb2d1b..0c744a80 100644 --- a/kibot/out_pdf.py +++ b/kibot/out_pdf.py @@ -47,7 +47,8 @@ class PDF(AnyLayer, DrillMarks): """ PDF (Portable Document Format) Exports the PCB to the most common exchange format. Suitable for printing. Note that this output isn't the best for documating your project. - This output is what you get from the File/Plot menu in pcbnew. """ + This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. """ def __init__(self): super().__init__() with document: diff --git a/kibot/out_pdf_pcb_print.py b/kibot/out_pdf_pcb_print.py index 37bb198f..f9dec514 100644 --- a/kibot/out_pdf_pcb_print.py +++ b/kibot/out_pdf_pcb_print.py @@ -28,7 +28,7 @@ class PDF_PCB_Print(BaseOutput): # noqa: F821 Exports the PCB to the most common exchange format. Suitable for printing. This is the main format to document your PCB. This output is what you get from the 'File/Print' menu in pcbnew. - The `pcb_print` is an alternative. """ + The `pcb_print` is usually a better alternative. """ def __init__(self): super().__init__() with document: diff --git a/kibot/out_ps.py b/kibot/out_ps.py index 7985b9d1..b566288e 100644 --- a/kibot/out_ps.py +++ b/kibot/out_ps.py @@ -78,7 +78,8 @@ class PSOptions(DrillMarks): class PS(AnyLayer): """ PS (Postscript) Exports the PCB to a format suitable for printing. - This output is what you get from the File/Plot menu in pcbnew. """ + This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. """ def __init__(self): super().__init__() with document: diff --git a/kibot/out_svg.py b/kibot/out_svg.py index cae7e7cd..fb3c65bc 100644 --- a/kibot/out_svg.py +++ b/kibot/out_svg.py @@ -44,7 +44,8 @@ class SVG(AnyLayer): """ SVG (Scalable Vector Graphics) Exports the PCB to a format suitable for 2D graphics software. Unlike bitmaps SVG drawings can be scaled without losing resolution. - This output is what you get from the File/Plot menu in pcbnew. """ + This output is what you get from the File/Plot menu in pcbnew. + The `pcb_print` is usually a better alternative. """ def __init__(self): super().__init__() with document: diff --git a/kibot/out_svg_pcb_print.py b/kibot/out_svg_pcb_print.py index 3a800dda..056bd6ea 100644 --- a/kibot/out_svg_pcb_print.py +++ b/kibot/out_svg_pcb_print.py @@ -42,7 +42,7 @@ class SVG_PCB_Print(BaseOutput): # noqa: F821 """ SVG PCB Print (Scalable Vector Graphics) Exports the PCB to the scalable vector graphics format. This output is what you get from the 'File/Print' menu in pcbnew. - The `pcb_print` is an alternative. """ + The `pcb_print` is usually a better alternative. """ def __init__(self): super().__init__() with document: