Skip to content

Commit 5905041

Browse files
committed
Add documentation on template separator character
1 parent a3281b0 commit 5905041

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/syntax.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ connections:
319319
Since the internally assigned designator of an unnamed component is not known to the user, one instance of the connector can not be referenced again outside the point of creation (i.e. in other connection sets, or later in the same set). Autogeneration of unnamed instances is therefore only useful for terminals with only one wire attached, or splices with exactly one wire going in, and one wire going out.
320320
If a component is to be used in other connection sets (e.g. for a three-way splice, or a crimp where multiple wires are joined), a named instance needs to be used.
321321

322+
The default character to trigger autogeneration of components is `.`. A different character can be specified using the `template_separator` option (see below).
323+
322324
Names of autogenerated components are hidden by default. While they can be shown in the graphical output using the `show_name: true` option, it is not recommended to manually use the internally assigned designator (starting with a double underscore `__`), since it might change in future WireViz versions, or when the order of items in connection sets changes.
323325

324326

@@ -387,6 +389,9 @@ If any component is defined in the `connectors` or `cables` sections but not ref
387389
# about additional components inside the diagram node (connector/cable box).
388390
# If False, show all info about additional components inside the diagram node.
389391
mini_bom_mode: <bool> # Default = True
392+
393+
# Character to split template and designator for autogenerated components
394+
template_separator: <str> # Default = '.'
390395
```
391396

392397

0 commit comments

Comments
 (0)