Skip to content

Commit 320977e

Browse files
committed
Update syntax.md with options.terminology
1 parent c534555 commit 320977e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/syntax.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,24 @@ If any component is defined in the `connectors` or `cables` sections but not ref
392392
393393
# Character to split template and designator for autogenerated components
394394
template_separator: <str> # Default = '.'
395+
396+
# Terms to be replaced by user defined terms
397+
terminology: <terminology> # see below
398+
```
399+
400+
401+
## Terminology
402+
403+
A selection of terms can optionally be replaced by user defined terms.
404+
405+
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.
406+
407+
These are the supported terms (all entries are optional):
408+
```yaml
409+
terminology:
410+
pin: <str>
411+
wire: <str>
412+
shield: <str>
395413
```
396414

397415

0 commit comments

Comments
 (0)