diff --git a/docs/syntax.md b/docs/syntax.md index 2da6c7d5..b9946be8 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -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: # Default = '.' + + # Terms to be replaced by user defined terms + 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: + wire: + shield: ```