From a251635e9640fddddfcdb41cc1c9fa97646d0e04 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Sat, 14 Nov 2020 23:27:27 +0100 Subject: [PATCH] Add #70, #169, #193, #194 --- docs/CHANGELOG.md | 1 + docs/syntax.md | 10 ++++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 8d48a7e..26371d4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -4,6 +4,7 @@ ### New features +- Allow referencing a cable's/bundle's wires by color or by label ([#70](https://github.com/formatc1702/WireViz/issues/70), [#169](https://github.com/formatc1702/WireViz/issues/169), [#193](https://github.com/formatc1702/WireViz/issues/193), [#194](https://github.com/formatc1702/WireViz/pull/194)) - Allow additional BOM items within components ([#50](https://github.com/formatc1702/WireViz/issues/50), [#115](https://github.com/formatc1702/WireViz/pull/115)) - Add option to define connector pin colors ([#53](https://github.com/formatc1702/WireViz/issues/53), [#141](https://github.com/formatc1702/WireViz/pull/141)) - Remove HTML links from the input attributes ([#164](https://github.com/formatc1702/WireViz/pull/164)) diff --git a/docs/syntax.md b/docs/syntax.md index 96a7bd0..2d55751 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -134,9 +134,12 @@ Since the auto-incremented and auto-assigned designator is not known to the user colors: # list of colors (see below) color_code: # one of the supported cable color codes (see below) + wirelabels: # optional; one label for each wire + # rendering information (all optional) - show_name: # defaults to true - show_wirecount: # defaults to true + show_name: # defaults to true + show_wirecount: # defaults to true + show_wirenumbers: # defaults to true for cables; false for bundles ``` @@ -173,6 +176,8 @@ connections: - The maximum number of items is unlimited. - Items must alternatingly belong to the `connectors` and the `cables` sections. - When a connection set defines multiple parallel connections, the number of specified ``s and ``s for each component in the set must match. When specifying only one designator, one is auto-generated for each connection of the set. +- `` may reference a pin's unique ID (as per the connector's `pins` attribute, auto-numbered from 1 by default) or its label (as per `pinlabels`). +- `` may reference a wire's number within a cable/bundle, its label (as per `wirelabels`) or, if unambiguous, its color. ### Single connections @@ -221,6 +226,7 @@ For connectors with `autogenerate: true`, a new instance, with auto-generated de - `` to refer to a specific wire, using its number. - `-` auto-expands to a range. + - `` to refer to a wire's label or color, if unambiguous. ## BOM items and additional components