PopulateOptions parameters

  • format : [string] (default: 'html') (choices: “html”, “md”) Format for the generated output.

  • input : [string] (default: '') Name of the input file describing the assembly. Must be a markdown file. Note that the YAML section of the file will be skipped, all the needed information comes from this output and the renderer output, not from the YAML section.
    When empty we use a dummy template, you should provide something better.

  • renderer : [string] (default: '') Name of the output used to render the PCB steps. Currently this must be a pcbdraw or render_3d output.

  • dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • imgname : [string] (default: 'img/populating_%d.%x') Pattern used for the image names. The %d is replaced by the image number. The %x is replaced by the extension. Note that the format is selected by the renderer.

  • initial_components : [string | list(string)] (default: '') [comma separated] List of components soldered before the first step.

  • pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • template : [string] The name of the handlebars template used for the HTML output. The extension must be .handlebars, it will be added when missing.
    The simple.handlebars template is a built-in template.

  • variant : [string] (default: '') Board variant to apply.