diff --git a/docs/syntax.md b/docs/syntax.md index 5ecaadd..f959531 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -3,12 +3,6 @@ ## Main sections ```yaml -metadata: # dictionary of meta-information describing the harness - : # any number of key value pairs (see below) - ... -options: # dictionary of common attributes for the whole harness - : # optional harness attributes (see below) - ... connectors: # dictionary of all used connectors : # unique connector designator/name ... # connector attributes (see below) @@ -35,59 +29,17 @@ additional_bom_items: # custom items to add to BOM - # BOM item (see below) ... +metadata: # dictionary of meta-information describing the harness + : # any number of key value pairs (see below) + ... + +options: # dictionary of common attributes for the whole harness + : # optional harness attributes (see below) + ... + tweak: # optional tweaking of .gv output ... ``` - -## Metadata entries - -```yaml - # Meta-information describing the harness - - # Each key/value pair replaces all key references in - # the HTML output template with the belonging value. - # Typical keys are 'title', 'description', and 'notes', - # but any key is accepted. Unused keys are ignored. - : # Any valid YAML syntax is accepted - # If no value is specified for 'title', then the - # output filename without extension is used. -``` - -## Options - -```yaml - # Common attributes for the whole harness. - # All entries are optional and have default values. - - # Background color of diagram and HTML output - bgcolor: # Default = 'WH' - - # Background color of other diagram elements - bgcolor_node: # Default = 'WH' - bgcolor_connector: # Default = bgcolor_node - bgcolor_cable: # Default = bgcolor_node - bgcolor_bundle: # Default = bgcolor_cable - - # How to display colors as text in the diagram - # 'full' : Lowercase full color name - # 'FULL' : Uppercase full color name - # 'hex' : Lowercase hexadecimal values - # 'HEX' : Uppercase hexadecimal values - # 'short': Lowercase short color name - # 'SHORT': Uppercase short color name - # 'ger' : Lowercase short German color name - # 'GER' : Uppercase short German color name - color_mode: # Default = 'SHORT' - - # Fontname to use in diagram and HTML output - fontname: # Default = 'arial' - - # If True, show only a BOM entry reference together with basic info - # 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 -``` - ## Connector attributes ```yaml @@ -294,6 +246,56 @@ For connectors with `autogenerate: true`, a new instance, with auto-generated de - `` to refer to a wire's label or color, if unambiguous. + +## Metadata entries + +```yaml + # Meta-information describing the harness + + # Each key/value pair replaces all key references in + # the HTML output template with the belonging value. + # Typical keys are 'title', 'description', and 'notes', + # but any key is accepted. Unused keys are ignored. + : # Any valid YAML syntax is accepted + # If no value is specified for 'title', then the + # output filename without extension is used. +``` + +## Options + +```yaml + # Common attributes for the whole harness. + # All entries are optional and have default values. + + # Background color of diagram and HTML output + bgcolor: # Default = 'WH' + + # Background color of other diagram elements + bgcolor_node: # Default = 'WH' + bgcolor_connector: # Default = bgcolor_node + bgcolor_cable: # Default = bgcolor_node + bgcolor_bundle: # Default = bgcolor_cable + + # How to display colors as text in the diagram + # 'full' : Lowercase full color name + # 'FULL' : Uppercase full color name + # 'hex' : Lowercase hexadecimal values + # 'HEX' : Uppercase hexadecimal values + # 'short': Lowercase short color name + # 'SHORT': Uppercase short color name + # 'ger' : Lowercase short German color name + # 'GER' : Uppercase short German color name + color_mode: # Default = 'SHORT' + + # Fontname to use in diagram and HTML output + fontname: # Default = 'arial' + + # If True, show only a BOM entry reference together with basic info + # 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 +``` + ## BOM items and additional components Connectors (both regular, and auto-generated), cables, and wires of a bundle are automatically added to the BOM, @@ -352,7 +354,7 @@ Alternatively items can be added to just the BOM by putting them in the section override: # dict of .gv entries to override # Each entry is identified by its leading string # in lines beginning with a TAB character. - # The leading string might be in "quotes" in + # The leading string might be in "quotes" in # the .gv output. This leading string must be # followed by attributes in [square brackets]. # Entries with an attribute containing HTML are