warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add #70, #169, #193, #194

Browse Source
This commit is contained in:
Daniel Rojas 2020-11-14 23:27:27 +01:00
parent a75122c95d
commit a251635e96
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/CHANGELOG.md
View File

@ -4,6 +4,7 @@
### New features ### 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)) - 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)) - 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)) - Remove HTML links from the input attributes ([#164](https://github.com/formatc1702/WireViz/pull/164))

6
docs/syntax.md
View File

@ -134,9 +134,12 @@ Since the auto-incremented and auto-assigned designator is not known to the user
colors: <List> # list of colors (see below) colors: <List> # list of colors (see below)
color_code: <str> # one of the supported cable color codes (see below) color_code: <str> # one of the supported cable color codes (see below)
wirelabels: <List> # optional; one label for each wire
# rendering information (all optional) # rendering information (all optional)
show_name: <bool> # defaults to true show_name: <bool> # defaults to true
show_wirecount: <bool> # defaults to true show_wirecount: <bool> # defaults to true
show_wirenumbers: <bool> # defaults to true for cables; false for bundles
``` ```
@ -173,6 +176,8 @@ connections:
- The maximum number of items is unlimited. - The maximum number of items is unlimited.
- Items must alternatingly belong to the `connectors` and the `cables` sections. - Items must alternatingly belong to the `connectors` and the `cables` sections.
- When a connection set defines multiple parallel connections, the number of specified `<pin>`s and `<wire>`s for each component in the set must match. When specifying only one designator, one is auto-generated for each connection of the set. - When a connection set defines multiple parallel connections, the number of specified `<pin>`s and `<wire>`s for each component in the set must match. When specifying only one designator, one is auto-generated for each connection of the set.
- `<pin>` 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`).
- `<wire>` may reference a wire's number within a cable/bundle, its label (as per `wirelabels`) or, if unambiguous, its color.
### Single connections ### Single connections
@ -221,6 +226,7 @@ For connectors with `autogenerate: true`, a new instance, with auto-generated de
- `<int>` to refer to a specific wire, using its number. - `<int>` to refer to a specific wire, using its number.
- `<int>-<int>` auto-expands to a range. - `<int>-<int>` auto-expands to a range.
- `<str>` to refer to a wire's label or color, if unambiguous.
## BOM items and additional components ## BOM items and additional components