From 4ee78df4c4c0b83e557a2bf3888ad6479f1d7edb Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Wed, 7 Aug 2024 10:39:15 -0300 Subject: [PATCH] [DOCs][Updated] Options marked as case insensitive --- docs/samples/generic_plot.kibot.yaml | 30 +++++++++++------------ docs/source/KiPlotYAML.rst | 2 +- docs/source/configuration/outputs/bom.rst | 30 +++++++++++------------ docs/source/configuration/sup_globals.rst | 2 +- 4 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 4476ea620..c10d927db 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -442,7 +442,7 @@ outputs: field: 'Row' # [list(dict)|list(string)|string=''] List of fields to join to this column join: - # [string=''] Name of the field + # [string=''] {no_case} Name of the field - field: 'Voltage' # [string=''] Text to use instead of a field. This option is incompatible with the `field` option. # Any space to separate it should be added in the text. @@ -481,7 +481,7 @@ outputs: field: 'Row' # [list(dict)|list(string)|string=''] List of fields to join to this column join: - # [string=''] Name of the field + # [string=''] {no_case} Name of the field - field: 'Voltage' # [string=''] Text to use instead of a field. This option is incompatible with the `field` option. # Any space to separate it should be added in the text. @@ -540,7 +540,7 @@ outputs: # If you need to customize the filter, or apply it before, you can disable this option and # add a custom filter to the filter chain expand_text_vars: true - # [string='Config'] Field name used for internal filters (not for variants) + # [string='Config'] {no_case} Field name used for internal filters (not for variants) fit_field: 'Config' # [string|list(string)='no,yes'] {comma_sep} Values for the `Footprint Populate` column footprint_populate_values: 'no,yes' @@ -552,7 +552,7 @@ outputs: format: 'Auto' # [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector group_connectors: true - # [list(string)] List of fields used for sorting individual components into groups. + # [list(string)] {no_case} List of fields used for sorting individual components into groups. # Components which match (comparing *all* fields) will be grouped together. # Field names are case-insensitive. # For empty fields the behavior is defined by the `group_fields_fallbacks`, `merge_blank_fields` and @@ -563,7 +563,7 @@ outputs: # If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib', # 'Voltage', 'Tolerance', 'Current', 'Power'] is used group_fields: ['part', 'part lib', 'value', 'footprint', 'footprint lib', 'voltage', 'tolerance', 'current', 'power'] - # [list(string)=[]] List of fields to be used when the fields in `group_fields` are empty. + # [list(string)=[]] {no_case} List of fields to be used when the fields in `group_fields` are empty. # The first field in this list is the fallback for the first in `group_fields`, and so on group_fields_fallbacks: [] # [dict={}] Options for the HRTXT formats @@ -584,9 +584,9 @@ outputs: html: # [boolean=true] Use colors to show the field type col_colors: true - # [string=''] Column with links to the datasheet + # [string=''] {no_case} Column with links to the datasheet datasheet_as_link: '' - # [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page + # [string|list(string)=''] {no_case} Column/s containing Digi-Key part numbers, will be linked to web page digikey_link: '' # [string|list(string)=''] Information to put after the title and before the pcb and stats info extra_info: '' @@ -598,7 +598,7 @@ outputs: hide_stats_info: false # [boolean=true] Use a color for empty cells. Applies only when `col_colors` is `true` highlight_empty: true - # [boolean|string|list(string)=''] Column/s containing LCSC part numbers, will be linked to web page. + # [boolean|string|list(string)=''] {no_case} Column/s containing LCSC part numbers, will be linked to web page. # Use **true** to copy the value indicated by the `field_lcsc_part` global option lcsc_link: '' # [string|boolean=''] PNG/SVG file to use as logo, use false to remove. @@ -606,7 +606,7 @@ outputs: logo: '' # [number=370] Used when the logo is an SVG image. This width is used to render the SVG image logo_width: 370 - # [string|list(string)=''] Column/s containing Mouser part numbers, will be linked to web page + # [string|list(string)=''] {no_case} Column/s containing Mouser part numbers, will be linked to web page mouser_link: '' # [list(dict)=[]] Used to highlight rows using filters. Rows that match a filter can be colored. # Note that these rows won't have colored columns @@ -633,7 +633,7 @@ outputs: merge_blank_fields: true # [boolean=true] When creating groups two components with empty/missing field will be interpreted as with the same value merge_both_blank: true - # [list(string)=computed for your project] List of fields where we tolerate conflicts. + # [list(string)=computed for your project] {no_case} List of fields where we tolerate conflicts. # Use it to avoid undesired warnings. # By default the field indicated in `fit_field`, the field used for variants and # the field `part` are excluded @@ -682,9 +682,9 @@ outputs: xlsx: # [boolean=true] Use colors to show the field type col_colors: true - # [string=''] Column with links to the datasheet + # [string=''] {no_case} Column with links to the datasheet datasheet_as_link: '' - # [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page + # [string|list(string)=''] {no_case} Column/s containing Digi-Key part numbers, will be linked to web page digikey_link: '' # [string|list(string)=''] Information to put after the title and before the pcb and stats info extra_info: '' @@ -711,7 +711,7 @@ outputs: kicost_config: '' # [boolean=false] Used to add a column with the distributor's description. So you can check this is the right component kicost_dist_desc: false - # [boolean|string|list(string)=''] Column/s containing LCSC part numbers, will be linked to web page. + # [boolean|string|list(string)=''] {no_case} Column/s containing LCSC part numbers, will be linked to web page. # Use **true** to copy the value indicated by the `field_lcsc_part` global option lcsc_link: '' # [string|boolean=''] PNG/SVG file to use as logo, use false to remove. @@ -723,7 +723,7 @@ outputs: logo_width: 370 # [number=60] [20,999] Maximum column width (characters) max_col_width: 60 - # [string|list(string)=''] Column/s containing Mouser part numbers, will be linked to web page + # [string|list(string)=''] {no_case} Column/s containing Mouser part numbers, will be linked to web page mouser_link: '' # [list(dict)=[]] Used to highlight rows using filters. Rows that match a filter can be colored. # Note that these rows won't have colored columns @@ -753,7 +753,7 @@ outputs: field: 'Row' # [list(dict)|list(string)|string=''] List of fields to join to this column join: - # [string=''] Name of the field + # [string=''] {no_case} Name of the field - field: 'Voltage' # [string=''] Text to use instead of a field. This option is incompatible with the `field` option. # Any space to separate it should be added in the text. diff --git a/docs/source/KiPlotYAML.rst b/docs/source/KiPlotYAML.rst index 3b6189083..3a4fc628e 100644 --- a/docs/source/KiPlotYAML.rst +++ b/docs/source/KiPlotYAML.rst @@ -67,7 +67,7 @@ And here are some examples for strings: Note that quotes are optional and can be used to disambiguate. -.. _no_case +.. _no_case: Also note that most strings are case sensitive, but things like schematic field names aren't. In this case using *value* or *Value* is the same. diff --git a/docs/source/configuration/outputs/bom.rst b/docs/source/configuration/outputs/bom.rst index 866e9cd59..ebbe12ae6 100644 --- a/docs/source/configuration/outputs/bom.rst +++ b/docs/source/configuration/outputs/bom.rst @@ -46,7 +46,7 @@ Parameters: - Valid keys: - - **field** :index:`: ` [:ref:`string `] (default: ``''``) Name of the field. + - **field** :index:`: ` [:ref:`string `] (default: ``''``) [:ref:`case insensitive `]Name of the field. - ``text`` :index:`: ` [:ref:`string `] (default: ``''``) Text to use instead of a field. This option is incompatible with the `field` option. Any space to separate it should be added in the text. Use \\n for newline and \\t for tab. @@ -73,7 +73,7 @@ Parameters: - **format** :index:`: ` [:ref:`string `] (default: ``'Auto'``) (choices: "HTML", "CSV", "TXT", "TSV", "XML", "XLSX", "HRTXT", "Auto") format for the BoM. `Auto` defaults to CSV or a guess according to the options. HRTXT stands for Human Readable TeXT. - - **group_fields** :index:`: ` [:ref:`list(string) `] (default: ``['part', 'part lib', 'value', 'footprint', 'footprint lib', 'voltage', 'tolerance', 'current', 'power']``) List of fields used for sorting individual components into groups. + - **group_fields** :index:`: ` [:ref:`list(string) `] (default: ``['part', 'part lib', 'value', 'footprint', 'footprint lib', 'voltage', 'tolerance', 'current', 'power']``) [:ref:`case insensitive `]List of fields used for sorting individual components into groups. Components which match (comparing *all* fields) will be grouped together. Field names are case-insensitive. For empty fields the behavior is defined by the `group_fields_fallbacks`, `merge_blank_fields` and @@ -99,25 +99,25 @@ Parameters: - Valid keys: - - **datasheet_as_link** :index:`: ` [:ref:`string `] (default: ``''``) Column with links to the datasheet. + - **datasheet_as_link** :index:`: ` [:ref:`string `] (default: ``''``) [:ref:`case insensitive `]Column with links to the datasheet. - **generate_dnf** :index:`: ` [:ref:`boolean `] (default: ``true``) Generate a separated section for DNF (Do Not Fit) components. - **logo** :index:`: ` [:ref:`string ` | :ref:`boolean `] (default: ``''``) PNG/SVG file to use as logo, use false to remove. Note that when using an SVG this is first converted to a PNG using `logo_width`. - **title** :index:`: ` [:ref:`string `] (default: ``'KiBot Bill of Materials'``) BoM title. - ``col_colors`` :index:`: ` [:ref:`boolean `] (default: ``true``) Use colors to show the field type. - - ``digikey_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing Digi-Key part numbers, will be linked to web page. + - ``digikey_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing Digi-Key part numbers, will be linked to web page. - ``extra_info`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Information to put after the title and before the pcb and stats info. - ``hide_pcb_info`` :index:`: ` [:ref:`boolean `] (default: ``false``) Hide project information. - ``hide_stats_info`` :index:`: ` [:ref:`boolean `] (default: ``false``) Hide statistics information. - ``highlight_empty`` :index:`: ` [:ref:`boolean `] (default: ``true``) Use a color for empty cells. Applies only when `col_colors` is `true`. - - ``lcsc_link`` :index:`: ` [:ref:`boolean ` | :ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing LCSC part numbers, will be linked to web page. + - ``lcsc_link`` :index:`: ` [:ref:`boolean ` | :ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing LCSC part numbers, will be linked to web page. Use **true** to copy the value indicated by the `field_lcsc_part` global option. - ``logo_width`` :index:`: ` [:ref:`number `] (default: ``370``) Used when the logo is an SVG image. This width is used to render the SVG image. - - ``mouser_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing Mouser part numbers, will be linked to web page. + - ``mouser_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing Mouser part numbers, will be linked to web page. - ``row_colors`` :index:`: ` [:ref:`list(dict) `] (default: ``[]``) Used to highlight rows using filters. Rows that match a filter can be colored. Note that these rows won't have colored columns. @@ -146,7 +146,7 @@ Parameters: - Valid keys: - - **datasheet_as_link** :index:`: ` [:ref:`string `] (default: ``''``) Column with links to the datasheet. + - **datasheet_as_link** :index:`: ` [:ref:`string `] (default: ``''``) [:ref:`case insensitive `]Column with links to the datasheet. - **generate_dnf** :index:`: ` [:ref:`boolean `] (default: ``true``) Generate a separated section for DNF (Do Not Fit) components. - **kicost** :index:`: ` [:ref:`boolean `] (default: ``false``) Enable KiCost worksheet creation. Note: an example of how to use it on CI/CD can be found `here `__. @@ -157,7 +157,7 @@ Parameters: Works with only some KiCost APIs. - **title** :index:`: ` [:ref:`string `] (default: ``'KiBot Bill of Materials'``) BoM title. - ``col_colors`` :index:`: ` [:ref:`boolean `] (default: ``true``) Use colors to show the field type. - - ``digikey_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing Digi-Key part numbers, will be linked to web page. + - ``digikey_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing Digi-Key part numbers, will be linked to web page. - ``extra_info`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Information to put after the title and before the pcb and stats info. @@ -174,13 +174,13 @@ Parameters: To understand how to achieve this, and also how to make use of the cache please visit the `kicost_ci_test `__ repo. - ``kicost_dist_desc`` :index:`: ` [:ref:`boolean `] (default: ``false``) Used to add a column with the distributor's description. So you can check this is the right component. - - ``lcsc_link`` :index:`: ` [:ref:`boolean ` | :ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing LCSC part numbers, will be linked to web page. + - ``lcsc_link`` :index:`: ` [:ref:`boolean ` | :ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing LCSC part numbers, will be linked to web page. Use **true** to copy the value indicated by the `field_lcsc_part` global option. - ``logo_scale`` :index:`: ` [:ref:`number `] (default: ``2``) Scaling factor for the logo. Note that this value isn't honored by all spreadsheet software. - ``logo_width`` :index:`: ` [:ref:`number `] (default: ``370``) Used when the logo is an SVG image. This width is used to render the SVG image. - ``max_col_width`` :index:`: ` [:ref:`number `] (default: ``60``) (range: 20 to 999) Maximum column width (characters). - - ``mouser_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) Column/s containing Mouser part numbers, will be linked to web page. + - ``mouser_link`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``''``) [:ref:`case insensitive `]Column/s containing Mouser part numbers, will be linked to web page. - ``row_colors`` :index:`: ` [:ref:`list(dict) `] (default: ``[]``) Used to highlight rows using filters. Rows that match a filter can be colored. Note that these rows won't have colored columns. @@ -211,7 +211,7 @@ Parameters: - Valid keys: - - **field** :index:`: ` [:ref:`string `] (default: ``''``) Name of the field. + - **field** :index:`: ` [:ref:`string `] (default: ``''``) [:ref:`case insensitive `]Name of the field. - ``text`` :index:`: ` [:ref:`string `] (default: ``''``) Text to use instead of a field. This option is incompatible with the `field` option. Any space to separate it should be added in the text. Use \\n for newline and \\t for tab. @@ -268,7 +268,7 @@ Parameters: - Valid keys: - - **field** :index:`: ` [:ref:`string `] (default: ``''``) Name of the field. + - **field** :index:`: ` [:ref:`string `] (default: ``''``) [:ref:`case insensitive `]Name of the field. - ``text`` :index:`: ` [:ref:`string `] (default: ``''``) Text to use instead of a field. This option is incompatible with the `field` option. Any space to separate it should be added in the text. Use \\n for newline and \\t for tab. @@ -305,19 +305,19 @@ Parameters: This is done using a **_expand_text_vars** filter. If you need to customize the filter, or apply it before, you can disable this option and add a custom filter to the filter chain. - - ``fit_field`` :index:`: ` [:ref:`string `] (default: ``'Config'``) Field name used for internal filters (not for variants). + - ``fit_field`` :index:`: ` [:ref:`string `] (default: ``'Config'``) [:ref:`case insensitive `]Field name used for internal filters (not for variants). - ``footprint_populate_values`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``'no,yes'``) [:ref:`comma separated `] Values for the `Footprint Populate` column. - ``footprint_type_values`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``'SMD,THT,VIRTUAL'``) [:ref:`comma separated `] Values for the `Footprint Type` column. - ``group_connectors`` :index:`: ` [:ref:`boolean `] (default: ``true``) Connectors with the same footprints will be grouped together, independent of the name of the connector. - - ``group_fields_fallbacks`` :index:`: ` [:ref:`list(string) `] (default: ``[]``) List of fields to be used when the fields in `group_fields` are empty. + - ``group_fields_fallbacks`` :index:`: ` [:ref:`list(string) `] (default: ``[]``) [:ref:`case insensitive `]List of fields to be used when the fields in `group_fields` are empty. The first field in this list is the fallback for the first in `group_fields`, and so on. - ``int_qtys`` :index:`: ` [:ref:`boolean `] (default: ``true``) Component quantities are always expressed as integers. Using the ceil() function. - ``merge_blank_fields`` :index:`: ` [:ref:`boolean `] (default: ``true``) Component groups with blank fields will be merged into the most compatible group, where possible. - ``merge_both_blank`` :index:`: ` [:ref:`boolean `] (default: ``true``) When creating groups two components with empty/missing field will be interpreted as with the same value. - - ``no_conflict`` :index:`: ` [:ref:`list(string) `] (default: computed for your project) List of fields where we tolerate conflicts. + - ``no_conflict`` :index:`: ` [:ref:`list(string) `] (default: computed for your project) [:ref:`case insensitive `]List of fields where we tolerate conflicts. Use it to avoid undesired warnings. By default the field indicated in `fit_field`, the field used for variants and the field `part` are excluded. diff --git a/docs/source/configuration/sup_globals.rst b/docs/source/configuration/sup_globals.rst index 0aa011f2e..494015b0f 100644 --- a/docs/source/configuration/sup_globals.rst +++ b/docs/source/configuration/sup_globals.rst @@ -91,7 +91,7 @@ This is because the plating reduces the hole, so you need to use a bigger drill. For more information consult: https://www.eurocircuits.com/pcb-design-guidelines/drilled-holes/. - ``field_3D_model`` :index:`: ` [:ref:`string `] (default: ``'_3D_model'``) Name for the field controlling the 3D models used for a component. - - ``field_current`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``['current']``) Name/s of the field/s used for the current raiting. + - ``field_current`` :index:`: ` [:ref:`string ` | :ref:`list(string) `] (default: ``['current', 'i']``) Name/s of the field/s used for the current raiting. You can use `_field_current` as field name to use it in most places. - ``field_lcsc_part`` :index:`: ` [:ref:`string `] (default: ``''``) The name of the schematic field that contains the part number for the LCSC/JLCPCB distributor.