Skip to content

Commit

Permalink
Fine-tune, add placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
formatc1702 committed Jul 20, 2020
1 parent f0dffe6 commit 38cfaaf
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@
## Main sections

```yaml
connectors: # dictionary of all used connectors
X1: # unique connector designator/name
... # connector attributes (see below)
connectors: # dictionary of all used connectors
X1: # unique connector designator/name
... # connector attributes (see below)
X2:
...
...

cables: # dictionary of all used cables and wires
W1: # unique cable designator/name
... # cable attributes (see below)
cables: # dictionary of all used cables and wires
W1: # unique cable designator/name
... # cable attributes (see below)
W2:
...
...

connections: # list of all connections to be made
# between cables and connectors
-
... # connection set (see below)
... # connection set (see below)
-
...
```
Expand Down Expand Up @@ -194,7 +194,7 @@ Cables accept multiline strings in the `type` and `notes` attributes.

### 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
attribute: |
Expand All @@ -205,10 +205,15 @@ attribute: |
## Method 2
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
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.

## Inheritance

Add link to YAML spec.

0 comments on commit 38cfaaf

Please sign in to comment.