PDF joiner

Generates a new PDF from other outputs. This is just a PDF joiner, using pdfunite from Poppler Utils.

Type: pdfunite

Parameters:

  • comment : [string=’’] A comment for documentation purposes. It helps to identify the output.

  • dir : [string=’./’] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.

  • name : [string=’’] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.

  • options : [dict] Options for the pdfunite output.

    • Valid keys:

      • output : [string=’%f-%i%I%v.%x’] Name for the generated PDF (%i=name of the output %x=pdf). Affected by global options.

      • outputs : [list(dict)] Which files will be included.

        • Valid keys:

          • from_output : [string=’’] Collect files from the selected output. When used the source option is ignored.

          • 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.

          • filter : [string=’.*\.pdf’] A regular expression that source files must match.

          • from_cwd : [boolean=false] Use the current working directory instead of the dir specified by -d.

      • use_external_command : [boolean=false] Use the pdfunite tool instead of PyPDF2 Python module.

  • type : ‘pdfunite’

  • 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. The categories are currently used for navigate_results.

  • disable_run_by_default : [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don’t want to generate the original. Use the boolean true value to disable the output you are extending.

  • extends : [string=’’] Copy the options section from the indicated output. Used to inherit options from another output of the same type.

  • groups : [string|list(string)=’’] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.

  • output_id : [string=’’] Text to use for the %I expansion content. To differentiate variations of this output.

  • priority : [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.

  • run_by_default : [boolean=true] When enabled this output will be created when no specific outputs are requested.