Skip to content

Commit

Permalink
[DOCs][Updated] Options marked as case insensitive
Browse files Browse the repository at this point in the history
  • Loading branch information
set-soft committed Aug 7, 2024
1 parent bb99190 commit 4ee78df
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 32 deletions.
30 changes: 15 additions & 15 deletions docs/samples/generic_plot.kibot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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'
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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: ''
Expand All @@ -598,15 +598,15 @@ 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.
# Note that when using an SVG this is first converted to a PNG using `logo_width`
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
Expand All @@ -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
Expand Down Expand Up @@ -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: ''
Expand All @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/KiPlotYAML.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 4ee78df

Please sign in to comment.