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

Fine-tune, add placeholders

Browse Source
This commit is contained in:
Daniel Rojas 2020-07-20 16:42:31 +02:00
parent f0dffe6ed9
commit 38cfaaf333
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
syntax.md
View File

@ -3,16 +3,16 @@
## Main sections ## Main sections
```yaml ```yaml
connectors: # dictionary of all used connectors connectors: # dictionary of all used connectors
X1: # unique connector designator/name X1: # unique connector designator/name
... # connector attributes (see below) ... # connector attributes (see below)
X2: X2:
... ...
... ...
cables: # dictionary of all used cables and wires cables: # dictionary of all used cables and wires
W1: # unique cable designator/name W1: # unique cable designator/name
... # cable attributes (see below) ... # cable attributes (see below)
W2: W2:
... ...
... ...
@ -20,7 +20,7 @@ cables: # dictionary of all used cables and wires
connections: # list of all connections to be made connections: # list of all connections to be made
# between cables and connectors # between cables and connectors
- -
... # connection set (see below) ... # connection set (see below)
- -
... ...
``` ```
@ -194,7 +194,7 @@ Cables accept multiline strings in the `type` and `notes` attributes.
### Method 1 ### Method 1
By using `|`, every following indented line is treated as a new line By using `|`, every following indented line is treated as a new line.
```yaml ```yaml
attribute: | attribute: |
@ -205,10 +205,15 @@ attribute: |
## Method 2 ## Method 2
By using double quoted strings, `\n` within the string is converted to a new line. By using double quoted strings, `\n` within the string is converted to a new line.
Plain (no quotes) or single quoted strings do not convert `\n`.
```yaml ```yaml
attribute: "This is line 1.\nThis is line 2." attribute: "This is line 1.\nThis is line 2."
``` ```
Plain (no quotes) or single quoted strings do not convert `\n`.
See [yaml-multiline.info](https://yaml-multiline.info/) for more information. See [yaml-multiline.info](https://yaml-multiline.info/) for more information.
## Inheritance
Add link to YAML spec.