From 0caeaffb4ff330068fd176cb7172d0709dd3241a Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Mon, 27 Jul 2020 20:23:36 +0200 Subject: [PATCH] shorten to --- syntax.md | 94 +++++++++++++++++++++++++++---------------------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/syntax.md b/syntax.md index ca69d15..b47ef14 100644 --- a/syntax.md +++ b/syntax.md @@ -4,16 +4,16 @@ ```yaml connectors: # dictionary of all used connectors - : # unique connector designator/name + : # unique connector designator/name ... # connector attributes (see below) - : + : ... ... cables: # dictionary of all used cables and wires - : # unique cable designator/name + : # unique cable designator/name ... # cable attributes (see below) - : + : ... ... @@ -34,17 +34,17 @@ additional_bom_items: # custom items to add to BOM ## Connector attributes ```yaml -: # unique connector designator/name + : # unique connector designator/name # general information about a connector (all optional) - type: - subtype: + type: + subtype: color: # see below - notes: + notes: # product information (all optional) - pn: # [internal] part number - mpn: # manufacturer part number - manufacturer: # manufacturer name + pn: # [internal] part number + mpn: # manufacturer part number + manufacturer: # manufacturer name # pinout information # at least one of the following must be specified @@ -88,31 +88,31 @@ Since the auto-incremented and auto-assigned designator is not known to the user ## Cable attributes ```yaml -: # unique cable designator/name + : # unique cable designator/name # general information about a connector (all optional) - category: # may be set to bundle; - # generates one BOM item for every wire in the bundle - # instead of a single item for the entire cable; - # renders with a dashed outline - type: - gauge: # allowed formats: - # mm2 is understood - # AWG is understood - # is assumed to be mm2 - # custom units and formats are allowed - # but unavailable for auto-conversion - show_equiv: # defaults to false; can auto-convert between mm2 and AWG - # and display the result when set to true - length: # is assumed to be in meters - shield: # defaults to false - # the shield can be accessed in connections - # using 's' as the wire number - notes: + category: # may be set to bundle; + # generates one BOM item for every wire in the bundle + # instead of a single item for the entire cable; + # renders with a dashed outline + type: + gauge: # allowed formats: + # mm2 is understood + # AWG is understood + # is assumed to be mm2 + # custom units and formats are allowed + # but unavailable for auto-conversion + show_equiv: # defaults to false; can auto-convert between mm2 and AWG + # and display the result when set to true + length: # is assumed to be in meters + shield: # defaults to false + # the shield can be accessed in connections + # using 's' as the wire number + notes: # product information (all optional) - pn: # [internal] part number - mpn: # manufacturer part number - manufacturer: # manufacturer name + pn: # [internal] part number + mpn: # manufacturer part number + manufacturer: # manufacturer name # conductor information # the following combinations are permitted: @@ -175,7 +175,7 @@ connections: #### Connectors -- `- : ` attaches a pin of the connector, referring to a pin number (from the connector's `pins` attribute) or a pin label (from its `pinlabels` attribute), provided the label is unique. +- `- : ` attaches a pin of the connector, referring to a pin number (from the connector's `pins` attribute) or a pin label (from its `pinlabels` attribute), provided the label is unique. - `- ` is allowed for simple connectors, since they have only one pin to connect. For connectors with `autogenerate: true`, a new instance, with auto-generated designator, is created. @@ -192,7 +192,7 @@ For connectors with `autogenerate: true`, a new instance, with auto-generated de Each `` may be: - - `` to refer to a specific pin, using its number (from its `pins` attribute) or its label (from its `pinlabels` attribute, provided the label is unique for this connector) + - `` to refer to a specific pin, using its number (from its `pins` attribute) or its label (from its `pinlabels` attribute, provided the label is unique for this connector) - `-` auto-expands to a range, e.g. `1-4` auto-expands to `1,2,3,4`; `9-7` will auto-expand to `9,8,7`. @@ -231,20 +231,20 @@ Additional BOM entries can be generated in the sections marked `` abov ```yaml - - description: - qty: # when used in the additional_bom_items section: - # manually specify qty. - # when used within a component: - # manually specify qty. - # pincount match number of pins of connector - # wirecount match number of wires of cable/bundle - # connectioncount match number of connected pins + description: + qty: # when used in the additional_bom_items section: + # manually specify qty. + # when used within a component: + # manually specify qty. + # pincount match number of pins of connector + # wirecount match number of wires of cable/bundle + # connectioncount match number of connected pins # all the following are optional: - unit: + unit: designators: - pn: # [internal] part number - mpn: # manufacturer part number - manufacturer: # manufacturer name + pn: # [internal] part number + mpn: # manufacturer part number + manufacturer: # manufacturer name ``` ## Colors