Skip to content

Commit 1c4fd68

Browse files
authored
Release v0.4.1
2 parents 954c4f5 + 5428646 commit 1c4fd68

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+362
-243
lines changed

docs/CHANGELOG.md

Lines changed: 69 additions & 47 deletions
Large diffs are not rendered by default.

docs/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribution Guidelines
22

3-
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.
3+
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.
44

55
## Submitting a new Issue
66

@@ -27,7 +27,7 @@ When contributing to this repository, please [submit a new issue](https://github
2727
1. Push the changes to your fork.
2828
1. Please format your code using [`isort`](https://pycqa.github.io/isort/) and [`black`](https://black.readthedocs.io) before submitting.
2929
1. Submit a new pull request, using `dev` as the base branch.
30-
- 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.
30+
- 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.
3131
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.
3232

3333
### Hints

docs/buildscript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!--
44
The following text is taken from #118
5-
https://github.com/formatc1702/WireViz/pull/118
5+
https://github.com/wireviz/WireViz/pull/118
66
77
TODO: write a better explaination -->
88

docs/syntax.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ connections:
319319
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.
320320
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.
321321

322+
The default character to trigger autogeneration of components is `.`. A different character can be specified using the `template_separator` option (see below).
323+
322324
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.
323325

324326

@@ -353,6 +355,7 @@ If any component is defined in the `connectors` or `cables` sections but not ref
353355
# If no value is specified for 'title', then the
354356
# output filename without extension is used.
355357
```
358+
See [HTML Output Templates](../src/wireviz/templates/) for how metadata entries can be inserted into the HTML output.
356359

357360
## Options
358361

@@ -387,6 +390,9 @@ If any component is defined in the `connectors` or `cables` sections but not ref
387390
# about additional components inside the diagram node (connector/cable box).
388391
# If False, show all info about additional components inside the diagram node.
389392
mini_bom_mode: <bool> # Default = True
393+
394+
# Character to split template and designator for autogenerated components
395+
template_separator: <str> # Default = '.'
390396
```
391397

392398

examples/demo01.gv

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/demo01.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/demo02.gv

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/demo02.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/ex01.gv

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/ex01.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)