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

Update syntax.md with options.terminology

Browse Source
This commit is contained in:
KV 2024-06-30 18:41:49 +02:00 committed by kvid
parent c53455533e
commit 320977e2ec
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/syntax.md
View File

@ -392,6 +392,24 @@ If any component is defined in the `connectors` or `cables` sections but not ref
# Character to split template and designator for autogenerated components
template_separator: <str> # Default = '.'
# Terms to be replaced by user defined terms
terminology: <terminology> # see below
```
## Terminology
A selection of terms can optionally be replaced by user defined terms.
This is a simple literal replacement of such terms in the diagram and BOM output. The original term is assumed in grammatical variations, like "{pin}s" and "{shield}ed", and that might create weird results in some use cases.
These are the supported terms (all entries are optional):
```yaml
terminology:
pin: <str>
wire: <str>
shield: <str>
```