From 088c6038c71561fab87ea7bbb8e2f926c2cacf93 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 7 Jun 2024 17:03:32 +0200 Subject: [PATCH] Add documentation on template separator character --- docs/syntax.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/syntax.md b/docs/syntax.md index 265427d..2c92fd3 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -319,6 +319,8 @@ connections: 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. 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. +The default character to trigger autogeneration of components is `.`. A different character can be specified using the `template_separator` option (see below). + 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. @@ -388,6 +390,9 @@ See [HTML Output Templates](../src/wireviz/templates/) for how metadata entries # about additional components inside the diagram node (connector/cable box). # If False, show all info about additional components inside the diagram node. mini_bom_mode: # Default = True + + # Character to split template and designator for autogenerated components + template_separator: # Default = '.' ```