Skip to content

Commit

Permalink
Update syntax.md with options.terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
kvid committed Jun 30, 2024
1 parent 85b3922 commit 683d7cc
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```


Expand Down

0 comments on commit 683d7cc

Please sign in to comment.