diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 5fdd2d4d..14183a63 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,6 @@ # Change Log -## [0.3](https://github.com/formatc1702/WireViz/tree/v0.3) (202X-XX-XX) +## [0.3](https://github.com/formatc1702/WireViz/tree/v0.3) (2021-10-11) ### New features @@ -9,15 +9,26 @@ - Add support for length units in cables and wires ([#7](https://github.com/formatc1702/WireViz/issues/7), [#196](https://github.com/formatc1702/WireViz/pull/196) (with work from [#161](https://github.com/formatc1702/WireViz/pull/161), [#162](https://github.com/formatc1702/WireViz/pull/162), [#171](https://github.com/formatc1702/WireViz/pull/171)), [#198](https://github.com/formatc1702/WireViz/pull/198), [#205](https://github.com/formatc1702/WireViz/issues/205). [#206](https://github.com/formatc1702/WireViz/pull/206)) - 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)) +- Add harness metadata section ([#158](https://github.com/formatc1702/WireViz/issues/158), [#214](https://github.com/formatc1702/WireViz/pull/214)) +- Add support for supplier and supplier part number information ([#240](https://github.com/formatc1702/WireViz/issues/240), [#241](https://github.com/formatc1702/WireViz/pull/241/)) +- Add graph rendering options (colors, font, color name display style, ...) ([#158](https://github.com/formatc1702/WireViz/issues/158), [#214](https://github.com/formatc1702/WireViz/pull/214)) +- Add support for background colors for cables and connectors, as well as for some individual cells ([#210](https://github.com/formatc1702/WireViz/issues/210), [#219](https://github.com/formatc1702/WireViz/pull/219)) +- Add optional tweaking of the .gv output ([#215](https://github.com/formatc1702/WireViz/pull/215)) (experimental) ## Misc. fixes +- Remove case-sensitivity issues with pin names and labels ([#160](https://github.com/formatc1702/WireViz/issues/160), [#229](https://github.com/formatc1702/WireViz/pull/229)) - Improve type hinting ([#156](https://github.com/formatc1702/WireViz/issues/156), [#163](https://github.com/formatc1702/WireViz/pull/163)) - Move BOM management and HTML functions to separate modules ([#151](https://github.com/formatc1702/WireViz/issues/151), [#192](https://github.com/formatc1702/WireViz/pull/192)) - Simplify BOM code ([#197](https://github.com/formatc1702/WireViz/pull/197)) - Bug fixes ([#218](https://github.com/formatc1702/WireViz/pull/218), [#221](https://github.com/formatc1702/WireViz/pull/221)) +## Known issues + +- Including images in the harness may lead to issues in the following cases: ([#189](https://github.com/formatc1702/WireViz/pull/189), [#220](https://github.com/formatc1702/WireViz/issues/220)) + - When using the `-o`/`--output_file` CLI option, specifying an output path in a different directory from the input file + - When using the `--prepend-file` CLI option, specifying a prepend file in a different directory from the mail input file ## [0.2](https://github.com/formatc1702/WireViz/tree/v0.2) (2020-10-17) diff --git a/docs/syntax.md b/docs/syntax.md index 4a7a52ac..8da04aee 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,57 +29,17 @@ additional_bom_items: # custom items to add to BOM - # BOM item (see below) ... -``` - -## 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' +metadata: # dictionary of meta-information describing the harness + : # any number of key value pairs (see below) + ... - # Fontname to use in diagram and HTML output - fontname: # Default = 'arial' +options: # dictionary of common attributes for the whole harness + : # optional harness attributes (see below) + ... - # 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 +tweak: # optional tweaking of .gv output + ... ``` - ## Connector attributes ```yaml @@ -100,8 +54,10 @@ additional_bom_items: # custom items to add to BOM # product information (all optional) ignore_in_bom: # if set to true the connector is not added to the BOM pn: # [internal] part number - mpn: # manufacturer part number manufacturer: # manufacturer name + mpn: # manufacturer part number + supplier: # supplier name + spn: # supplier part number additional_components: # additional components - # additional component (see below) @@ -117,6 +73,8 @@ additional_bom_items: # custom items to add to BOM # no color marks will be added to remaining pins # rendering information (all optional) + bgcolor: # Background color of diagram connector box + bgcolor_title: # Background color of title in diagram connector box style: