[DOCs][Updated ] Changelog and recent changes

- Report template as extended choice
- name/comment as basic for filters

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Report:
   - Solder paste usage stats (#616)
   - Support for variants (See #616)
+  - Testpoints report (See #638)
 - xDRC: configurable category (#647)
 - Schematic:
   - Support for text boxes inside symbols (#621)

docs/samples/generic_plot.kibot.yaml

@@ -3546,9 +3546,10 @@ outputs:
       solder_paste_metal_amount: 87.75
       # [number=0.12] Stencil thickness in mm. Used to compute solder paste usage
       stencil_thickness: 0.12
-      # [string='full'] Name for one of the internal templates (full, full_svg, simple) or a custom template file.
+      # [string='full'] [full,full_svg,simple,testpoints,*] Name for one of the internal templates or a custom template file.
       # Environment variables and ~ are allowed.
-      # Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`)
+      # Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`).
+      # Note: the testpoint variables uses the `testpoint` fabrication attribute of pads
       template: 'full'
       # [string=''] Board variant to apply
       variant: ''

docs/source/Changelog.rst

@@ -56,6 +56,7 @@ Added
 
    -  Solder paste usage stats (#616)
    -  Support for variants (See #616)
+   -  Testpoints report (See #638)
 
 -  xDRC: configurable category (#647)
 -  Schematic:
@@ -66,6 +67,10 @@ Added
 
    -  Support for KiCad 8 bitmaps (#623)
 
+-  Position:
+
+   -  Support for panels repeating the same component (See #656)
+
 Fixed:
 ~~~~~~
 

docs/source/configuration/filters/expand_text_vars.rst

@@ -8,8 +8,8 @@ Expand Text Variables
 
    This filter expands KiCad 6 text variables (${VARIABLE}).
 
-   -  ``comment`` :index:`: <pair: filter - expand_text_vars; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **comment** :index:`: <pair: filter - expand_text_vars; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - expand_text_vars; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``include_kicad_env`` :index:`: <pair: filter - expand_text_vars; include_kicad_env>` [:ref:`boolean <boolean>`] (default: ``true``) Also expand KiCad environment variables.
    -  ``include_os_env`` :index:`: <pair: filter - expand_text_vars; include_os_env>` [:ref:`boolean <boolean>`] (default: ``false``) Also expand system environment variables.
-   -  ``name`` :index:`: <pair: filter - expand_text_vars; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
 

docs/source/configuration/filters/field_modify.rst

@@ -8,13 +8,13 @@ Field Modifier
 
    Changes the content of one or more fields.
 
-   -  ``comment`` :index:`: <pair: filter - field_modify; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **comment** :index:`: <pair: filter - field_modify; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - field_modify; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``fields`` :index:`: <pair: filter - field_modify; fields>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``'Datasheet'``) [:ref:`comma separated <comma_sep>`] Fields to convert.
 
    -  ``include`` :index:`: <pair: filter - field_modify; include>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``''``) Name of the filter to select which components will be affected.
       Applied to all if nothing specified here.
 
-   -  ``name`` :index:`: <pair: filter - field_modify; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``regex`` :index:`: <pair: filter - field_modify; regex>` [:ref:`string <string>`] (default: ``'(https?://\\S+)'``) Regular expression to match the field content.
       Only fields that matches will be modified.
       An empty regex will match anything.

docs/source/configuration/filters/field_rename.rst

@@ -9,8 +9,8 @@ Field Renamer
    This filter implements a field renamer. |br|
    The internal `_kicost_rename` filter emulates the KiCost behavior. |br|
 
-   -  ``comment`` :index:`: <pair: filter - field_rename; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
-   -  ``name`` :index:`: <pair: filter - field_rename; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
+   -  **comment** :index:`: <pair: filter - field_rename; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - field_rename; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``rename`` :index:`: <pair: filter - field_rename; rename>`  [:ref:`FieldRename parameters <FieldRename_fi>`] [:ref:`list(dict) <list(dict)>`] (default: ``[]``) Fields to rename.
 
 .. toctree::

docs/source/configuration/filters/generic.rst

@@ -12,7 +12,8 @@ Generic filter
    The internal `_mechanical` filter emulates the KiBoM behavior for default exclusions. |br|
    The internal `_kicost_dnp` filter emulates KiCost's `dnp` field. |br|
 
-   -  ``comment`` :index:`: <pair: filter - generic; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **comment** :index:`: <pair: filter - generic; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - generic; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``config_field`` :index:`: <pair: filter - generic; config_field>` [:ref:`string <string>`] (default: ``'Config'``) Name of the field used to classify components.
    -  ``config_separators`` :index:`: <pair: filter - generic; config_separators>` [:ref:`string <string>`] (default: ``' ,'``) Characters used to separate options inside the config field.
    -  ``exclude_all_hash_ref`` :index:`: <pair: filter - generic; exclude_all_hash_ref>` [:ref:`boolean <boolean>`] (default: ``false``) Exclude all components with a reference starting with #.
@@ -44,7 +45,6 @@ Generic filter
       Use `dnf_list` for ['dnf', 'dnl', 'dnp', 'do not fit', 'do not load', 'do not place', 'no stuff', 'nofit', 'noload', 'noplace', 'nostuff', 'not fitted', 'not loaded', 'not placed'].
       Use `dnc_list` for ['dnc', 'do not change', 'fixed', 'no change'].
 
-   -  ``name`` :index:`: <pair: filter - generic; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
 
 .. toctree::
    :caption: Used dicts

docs/source/configuration/filters/rot_footprint.rst

@@ -11,22 +11,22 @@ Footprint Rotator
    The `JLCPCB Rotation Offset` and `JLCPCB Position Offset` fields can be used to adjust special cases. |br|
    The internal `_rot_footprint` filter implements the simplest case. |br|
 
+   -  **comment** :index:`: <pair: filter - rot_footprint; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - rot_footprint; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``bennymeg_mode`` :index:`: <pair: filter - rot_footprint; bennymeg_mode>` [:ref:`boolean <boolean>`] (default: ``true``) Implements the `rot_fields` and `offset_fields` in the same way that the bennymeg/JLC-Plugin-for-KiCad tool.
       Note that the computation for bottom rotations is wrong, forcing the user to uses arbitrary rotations.
       The correct computation is `(180 - component rot) + angle` but the plugin does `180 - (component rot + angle)`.
       This option forces the wrong computation for compatibility.
       This option also controls the way offset signs are interpreted. When enabled the offsets matches this plugin,
       when disabled matches the interpretation used by the matthewlai/JLCKicadTools plugin.
       Disabling this option you'll get better algorithms, but loose compatibility with this plugin.
-   -  ``comment`` :index:`: <pair: filter - rot_footprint; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
    -  ``extend`` :index:`: <pair: filter - rot_footprint; extend>` [:ref:`boolean <boolean>`] (default: ``true``) Extends the internal list of rotations with the one provided.
       Otherwise just use the provided list.
       Note that the provided list has more precedence than the internal list.
    -  ``invert_bottom`` :index:`: <pair: filter - rot_footprint; invert_bottom>` [:ref:`boolean <boolean>`] (default: ``false``) Rotation for bottom components is negated, resulting in either: `(- component rot - angle)`
       or when combined with `negative_bottom`, `(angle - component rot)`.
    -  ``mirror_bottom`` :index:`: <pair: filter - rot_footprint; mirror_bottom>` [:ref:`boolean <boolean>`] (default: ``false``) The original component rotation for components in the bottom is mirrored before applying
       the adjust so you get `(180 - component rot + angle)`. This is used by JLCPCB.
-   -  ``name`` :index:`: <pair: filter - rot_footprint; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``negative_bottom`` :index:`: <pair: filter - rot_footprint; negative_bottom>` [:ref:`boolean <boolean>`] (default: ``true``) Rotation for bottom components is computed via subtraction as `(component rot - angle)`.
    -  ``offset_fields`` :index:`: <pair: filter - rot_footprint; offset_fields>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``['JLCPCB Position Offset', 'JLCPosOffset']``) [:ref:`comma separated <comma_sep>`] List of fields that can contain a position offset.
       The optional fields can contain a comma separated x,y position offset.

docs/source/configuration/filters/separate_pins.rst

@@ -17,11 +17,11 @@ Separate Pins
    Needs KiCad 6 or newer. |br|
 .. 
 
+   -  **comment** :index:`: <pair: filter - separate_pins; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - separate_pins; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``attribute`` :index:`: <pair: filter - separate_pins; attribute>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``['testpoint']``) (choices: "bga", "local_fiducial", "global_fiducial", "testpoint", "heatsink", "castellated", "none") Fabrication
       attribute/s of the included pads.
 
-   -  ``comment`` :index:`: <pair: filter - separate_pins; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
    -  ``keep_component`` :index:`: <pair: filter - separate_pins; keep_component>` [:ref:`boolean <boolean>`] (default: ``false``) If we also keep the original component or we just get the selected pads.
-   -  ``name`` :index:`: <pair: filter - separate_pins; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``ref_sep`` :index:`: <pair: filter - separate_pins; ref_sep>` [:ref:`string <string>`] (default: ``'.'``) Separator used in the reference (i.e. R10.1).
 

docs/source/configuration/filters/spec_to_field.rst

@@ -13,15 +13,15 @@ Spec to Field
    the `bom` output. Make sure you can do this before trying to use this filter. |br|
    Usage `example <https://inti-cmnb.github.io/kibot-examples-1/spec_to_field/>`__. |br|
 
+   -  **comment** :index:`: <pair: filter - spec_to_field; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
    -  **from_output** :index:`: <pair: filter - spec_to_field; from_output>` [:ref:`string <string>`] (default: ``''``) Name of the output used to collect the specs.
       Currently this must be a `bom` output with KiCost enabled and a distributor that returns specs.
+   -  **name** :index:`: <pair: filter - spec_to_field; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  **specs** :index:`: <pair: filter - spec_to_field; specs>`  [:ref:`SpecOptions parameters <SpecOptions_fi>`] [:ref:`list(dict) <list(dict)>` | :ref:`dict <dict>`] (default: ``[{'spec': '_voltage', 'field': '_field_voltage'}, {'spec': '_tolerance', 'field': '_field_tolerance'}, {'spec': '_power', 'field': '_field_power'}, {'spec': '_current', 'field': '_field_current'}]``) One or more specs to be copied.
    -  ``check_dist_coherence`` :index:`: <pair: filter - spec_to_field; check_dist_coherence>` [:ref:`boolean <boolean>`] (default: ``true``) Check that the data we got from different distributors is equivalent.
    -  ``check_dist_fields`` :index:`: <pair: filter - spec_to_field; check_dist_fields>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``['_value', '_tolerance', '_power', '_current', '_voltage', '_temp_coeff']``) [:ref:`comma separated <comma_sep>`] List of fields to include in the check.
       For a full list of fields consult the `specs` option.
 
-   -  ``comment`` :index:`: <pair: filter - spec_to_field; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
-   -  ``name`` :index:`: <pair: filter - spec_to_field; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
 
 .. toctree::
    :caption: Used dicts

docs/source/configuration/filters/subparts.rst

@@ -11,17 +11,17 @@ Subparts
    Some people use it to include connectors and cables related to a connector in the PCB. |br|
    `KiCost docs <https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html>`__. |br|
 
+   -  **comment** :index:`: <pair: filter - subparts; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - subparts; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``check_multiplier`` :index:`: <pair: filter - subparts; check_multiplier>` [:ref:`list(string) <list(string)>`] (default: computed for your project) List of fields to include for multiplier computation.
       If empty all fields in `split_fields` and `manf_pn_field` are used.
 
-   -  ``comment`` :index:`: <pair: filter - subparts; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
    -  ``manf_field`` :index:`: <pair: filter - subparts; manf_field>` [:ref:`string <string>`] (default: ``'manf'``) Field for the manufacturer name.
    -  ``manf_pn_field`` :index:`: <pair: filter - subparts; manf_pn_field>` [:ref:`string <string>`] (default: ``'manf#'``) Field for the manufacturer part number.
    -  ``modify_first_value`` :index:`: <pair: filter - subparts; modify_first_value>` [:ref:`boolean <boolean>`] (default: ``true``) Modify even the value for the first component in the list (KiCost behavior).
    -  ``modify_value`` :index:`: <pair: filter - subparts; modify_value>` [:ref:`boolean <boolean>`] (default: ``true``) Add '- p N/M' to the value.
    -  ``mult_separators`` :index:`: <pair: filter - subparts; mult_separators>` [:ref:`string <string>`] (default: ``':'``) Separators used for the multiplier. Each character in this string is a valid separator.
    -  ``multiplier`` :index:`: <pair: filter - subparts; multiplier>` [:ref:`boolean <boolean>`] (default: ``true``) Enables the subpart multiplier mechanism.
-   -  ``name`` :index:`: <pair: filter - subparts; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``ref_sep`` :index:`: <pair: filter - subparts; ref_sep>` [:ref:`string <string>`] (default: ``'#'``) Separator used in the reference (i.e. R10#1).
    -  ``separators`` :index:`: <pair: filter - subparts; separators>` [:ref:`string <string>`] (default: ``';,'``) Separators used between subparts. Each character in this string is a valid separator.
    -  ``split_fields`` :index:`: <pair: filter - subparts; split_fields>` [:ref:`list(string) <list(string)>`] (default: ``['arrow#', 'digikey#', 'farnell#', 'lcsc#', 'mouser#', 'newark#', 'rs#', 'tme#']``) List of fields to split, usually the distributors part numbers.

docs/source/configuration/filters/urlify.rst

@@ -8,8 +8,8 @@ URLify
 
    Converts URL text in fields to HTML URLs.
 
-   -  ``comment`` :index:`: <pair: filter - urlify; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **comment** :index:`: <pair: filter - urlify; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - urlify; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``fields`` :index:`: <pair: filter - urlify; fields>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``'Datasheet'``) [:ref:`comma separated <comma_sep>`] Fields to convert.
 
-   -  ``name`` :index:`: <pair: filter - urlify; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
 

docs/source/configuration/filters/value_split.rst

@@ -10,10 +10,10 @@ Value Splitter
    I.e. extracts the tolerance and puts it in the `tolerance` field. |br|
    Usage `example <https://inti-cmnb.github.io/kibot-examples-1/value_split/>`__. |br|
 
+   -  **comment** :index:`: <pair: filter - value_split; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - value_split; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``autoplace`` :index:`: <pair: filter - value_split; autoplace>` [:ref:`boolean <boolean>`] (default: ``true``) Try to figure out the position for the added fields.
    -  ``autoplace_mechanism`` :index:`: <pair: filter - value_split; autoplace_mechanism>` [:ref:`string <string>`] (default: ``'bottom'``) (choices: "bottom", "top") Put the new field at the bottom/top of the last field.
-   -  ``comment`` :index:`: <pair: filter - value_split; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
-   -  ``name`` :index:`: <pair: filter - value_split; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``package`` :index:`: <pair: filter - value_split; package>` [:ref:`string <string>`] (default: ``'yes'``) (choices: "yes", "no", "soft") Policy for the package.
       yes = overwrite existing value, no = don't touch, soft = copy if not defined.
    -  ``power`` :index:`: <pair: filter - value_split; power>` [:ref:`string <string>`] (default: ``'yes'``) (choices: "yes", "no", "soft") Policy for the power rating.

docs/source/configuration/filters/var_rename.rst

@@ -13,9 +13,9 @@ Variant Renamer
    with *Diode_SMD:D_0805_2012Metric* will change the footprint when *VARIANT* is in use. Of course the
    footprints should be similar, or your PCB will become invalid. |br|
 
-   -  ``comment`` :index:`: <pair: filter - var_rename; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **comment** :index:`: <pair: filter - var_rename; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
+   -  **name** :index:`: <pair: filter - var_rename; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``force_variant`` :index:`: <pair: filter - var_rename; force_variant>` [:ref:`string <string>`] (default: ``''``) Use this variant instead of the current variant. Useful for IBoM variants.
-   -  ``name`` :index:`: <pair: filter - var_rename; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
    -  ``separator`` :index:`: <pair: filter - var_rename; separator>` [:ref:`string <string>`] (default: ``':'``) Separator used between the variant and the field name.
    -  ``variant_to_value`` :index:`: <pair: filter - var_rename; variant_to_value>` [:ref:`boolean <boolean>`] (default: ``false``) Rename fields matching the variant to the value of the component.