warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update syntax.md

Browse Source
This commit is contained in:
Daniel Rojas 2021-08-27 19:03:06 +02:00
parent 6e59163cca
commit f0b3789d9d
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/syntax.md
View File

@ -100,8 +100,10 @@ additional_bom_items: # custom items to add to BOM
# product information (all optional) # product information (all optional)
ignore_in_bom: <bool> # if set to true the connector is not added to the BOM ignore_in_bom: <bool> # if set to true the connector is not added to the BOM
pn: <str> # [internal] part number pn: <str> # [internal] part number
mpn: <str> # manufacturer part number
manufacturer: <str> # manufacturer name manufacturer: <str> # manufacturer name
mpn: <str> # manufacturer part number
supplier: <str> # supplier name
spn: <str> # supplier part number
additional_components: # additional components additional_components: # additional components
- <additional-component> # additional component (see below) - <additional-component> # additional component (see below)
@ -173,8 +175,10 @@ Since the auto-incremented and auto-assigned designator is not known to the user
# product information (all optional) # product information (all optional)
ignore_in_bom: <bool> # if set to true the cable or wires are not added to the BOM ignore_in_bom: <bool> # if set to true the cable or wires are not added to the BOM
pn: <str> # [internal] part number pn: <str> # [internal] part number
mpn: <str> # manufacturer part number
manufacturer: <str> # manufacturer name manufacturer: <str> # manufacturer name
mpn: <str> # manufacturer part number
supplier: <str> # supplier name
spn: <str> # supplier part number
additional_components: # additional components additional_components: # additional components
- <additional-component> # additional component (see below) - <additional-component> # additional component (see below)
@ -309,8 +313,10 @@ Parts can be added to a connector or cable in the section `<additional-component
# total_length sum of lengths of each wire in the bundle # total_length sum of lengths of each wire in the bundle
unit: <str> unit: <str>
pn: <str> # [internal] part number pn: <str> # [internal] part number
mpn: <str> # manufacturer part number
manufacturer: <str> # manufacturer name manufacturer: <str> # manufacturer name
mpn: <str> # manufacturer part number
supplier: <str> # supplier name
spn: <str> # supplier part number
``` ```
Alternatively items can be added to just the BOM by putting them in the section `<bom-item>` above. Alternatively items can be added to just the BOM by putting them in the section `<bom-item>` above.
@ -323,8 +329,10 @@ Alternatively items can be added to just the BOM by putting them in the section
unit: <str> unit: <str>
designators: <List> designators: <List>
pn: <str> # [internal] part number pn: <str> # [internal] part number
mpn: <str> # manufacturer part number
manufacturer: <str> # manufacturer name manufacturer: <str> # manufacturer name
mpn: <str> # manufacturer part number
supplier: <str> # supplier name
spn: <str> # supplier part number
``` ```
## Colors ## Colors
@ -402,6 +410,8 @@ The following attributes accept multiline strings:
- `notes` - `notes`
- `manufacturer` - `manufacturer`
- `mpn` - `mpn`
- `supplier`
- `spn`
- `image.caption` - `image.caption`
### Method 1 ### Method 1