Release v0.4.1

wireviz · Jul 13, 2024 · 1c4fd68 · 1c4fd68
2 parents 954c4f5 + 5428646
commit 1c4fd68
Show file tree

Hide file tree

Showing 66 changed files with 362 additions and 243 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contribution Guidelines
 
-When contributing to this repository, please [submit a new issue](https://github.com/formatc1702/WireViz/issues) first to discuss the proposed change, before submitting a pull request.
+When contributing to this repository, please [submit a new issue](https://github.com/wireviz/WireViz/issues) first to discuss the proposed change, before submitting a pull request.
 
 ## Submitting a new Issue
 
@@ -27,7 +27,7 @@ When contributing to this repository, please [submit a new issue](https://github
 1. Push the changes to your fork.
 1. Please format your code using [`isort`](https://pycqa.github.io/isort/) and [`black`](https://black.readthedocs.io) before submitting.
 1. Submit a new pull request, using `dev` as the base branch.
-  - If your code changes or extends the WireViz YAML syntax, be sure to update the [syntax description document](https://github.com/formatc1702/WireViz/blob/dev/docs/syntax.md) in your PR.
+  - If your code changes or extends the WireViz YAML syntax, be sure to update the [syntax description document](https://github.com/wireviz/WireViz/blob/dev/docs/syntax.md) in your PR.
 1. Please include in the PR description (and optionally also in the commit message body) a reference (# followed by issue number) to the issue where the suggested changes are discussed.
 
 ### Hints

diff --git a/docs/buildscript.md b/docs/buildscript.md
@@ -2,7 +2,7 @@
 
 <!--
 The following text is taken from #118
-https://github.com/formatc1702/WireViz/pull/118
+https://github.com/wireviz/WireViz/pull/118
 
 TODO: write a better explaination -->
 

diff --git a/docs/syntax.md b/docs/syntax.md
@@ -319,6 +319,8 @@ connections:
 Since the internally assigned designator of an unnamed component is not known to the user, one instance of the connector can not be referenced again outside the point of creation (i.e. in other connection sets, or later in the same set). Autogeneration of unnamed instances is therefore only useful for terminals with only one wire attached, or splices with exactly one wire going in, and one wire going out.
 If a component is to be used in other connection sets (e.g. for a three-way splice, or a crimp where multiple wires are joined), a named instance needs to be used.
 
+The default character to trigger autogeneration of components is `.`. A different character can be specified using the `template_separator` option (see below).
+
 Names of autogenerated components are hidden by default. While they can be shown in the graphical output using the `show_name: true` option, it is not recommended to manually use the internally assigned designator (starting with a double underscore `__`), since it might change in future WireViz versions, or when the order of items in connection sets changes.
 
 
@@ -353,6 +355,7 @@ If any component is defined in the `connectors` or `cables` sections but not ref
   # If no value is specified for 'title', then the
   # output filename without extension is used.
 ```
+See [HTML Output Templates](../src/wireviz/templates/) for how metadata entries can be inserted into the HTML output.
 
 ## Options
 
@@ -387,6 +390,9 @@ If any component is defined in the `connectors` or `cables` sections but not ref
   # 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: <bool>        # Default = True
+
+  # Character to split template and designator for autogenerated components
+  template_separator: <str>    # Default = '.'
 ```
 
 

diff --git a/examples/demo01.gv b/examples/demo01.gv
diff --git a/examples/demo01.html b/examples/demo01.html
diff --git a/examples/demo02.gv b/examples/demo02.gv
diff --git a/examples/demo02.html b/examples/demo02.html
diff --git a/examples/ex01.gv b/examples/ex01.gv
diff --git a/examples/ex01.html b/examples/ex01.html
diff --git a/examples/ex02.gv b/examples/ex02.gv
diff --git a/examples/ex02.html b/examples/ex02.html
diff --git a/examples/ex03.gv b/examples/ex03.gv
diff --git a/examples/ex03.html b/examples/ex03.html
diff --git a/examples/ex04.gv b/examples/ex04.gv
diff --git a/examples/ex04.html b/examples/ex04.html
diff --git a/examples/ex05.gv b/examples/ex05.gv
diff --git a/examples/ex05.html b/examples/ex05.html
diff --git a/examples/ex06.bom.tsv b/examples/ex06.bom.tsv
diff --git a/examples/ex06.gv b/examples/ex06.gv
diff --git a/examples/ex06.html b/examples/ex06.html
diff --git a/examples/ex07.gv b/examples/ex07.gv
diff --git a/examples/ex07.html b/examples/ex07.html
diff --git a/examples/ex08.gv b/examples/ex08.gv
diff --git a/examples/ex08.html b/examples/ex08.html
diff --git a/examples/ex09.gv b/examples/ex09.gv
diff --git a/examples/ex09.html b/examples/ex09.html
diff --git a/examples/ex10.gv b/examples/ex10.gv
diff --git a/examples/ex10.html b/examples/ex10.html
diff --git a/examples/ex11.gv b/examples/ex11.gv
diff --git a/examples/ex11.html b/examples/ex11.html
diff --git a/examples/ex12.gv b/examples/ex12.gv
diff --git a/examples/ex12.html b/examples/ex12.html
diff --git a/examples/ex13.gv b/examples/ex13.gv
diff --git a/examples/ex13.html b/examples/ex13.html
diff --git a/examples/ex14.gv b/examples/ex14.gv
diff --git a/examples/ex14.html b/examples/ex14.html
diff --git a/setup.py b/setup.py
@@ -27,6 +27,7 @@
     keywords="cable connector hardware harness wiring wiring-diagram wiring-harness",
     url=APP_URL,
     package_dir={"": "src"},
+    package_data={CMD_NAME: ["templates/*.html"]},
     packages=find_packages("src"),
     entry_points={
         "console_scripts": [