Strings in YAML

External

• http://www.yaml.org/spec/1.2/spec.html#id2795688
• https://www.baeldung.com/yaml-multi-line
• http://blogs.perl.org/users/tinita/2018/03/strings-in-yaml---to-quote-or-not-to-quote.html
• https://yaml-multiline.info

TODO

TODO:

• How can it be parsed and dumped with python.

Literal Style

Multi-line strings can be written using the '|' character followed by a new line. To be considered multi-line content, the first line under the '|'-terminated line must be indented on a level deeper that the line containing the '|' and the subsequent multi-line lines must be indented with the same offset as the first line. Trailing white space is stripped. The new line characters are preserved.

This is correct multi-line (the multi-lines must be indented under 'data'):

data: |
  This is a
  multi-line
  text section

The value of data is equivalent with "This is a\nmulti-line\ntext selection\n".

This is NOT a correct mult-line, because the "mult-lines" are not correctly indented:

data: |
This is not
a correct multi-line

The "|" multi-line operator implies that a trailing newline will be added to the string. In the correct above example, the data value will be equivalent with "This is a\nmulti-line\ntext selection\n" - note the trailing new line. If we want the YAML processor to strip off the trailing newline, we should use "|-" instead of "|":

dataWithoutTrailingNewLine: |-
  This is a
  multi-line
  text section

The dataWithoutTrailingNewLine value is equivalent with "This is a\nmulti-line\ntext selection". Note the lack of trailing newline.

If we want the trailing whitespace to be preserved, we should use "|+" instead of "|":

dataWithTrailingWhitespacePreserved: |+
  This is a
  multi-line
  text section


another: value

The dataWithTrailingWhitespacePreserved value is equivalent with "This is a\nmulti-line\ntext selection\n\n\n".

Folded Style

The '>' character followed by a new line folds all the new lines, after removing trailing white space and new lines. All but the last newline will be converted to space.

data: >
   This is another
   multi-line
   text section
   but in the final form
   it will be just one long string
   without new lines
   except the last one

The data value is equivalent with "This is another multi-line text section but in the final form it will be just one long string without new lines except the last one\n"

If we wan to drop the trailing newline instead of preserving it, use ">-" instead of ">":

dataWihtoutTrailingNewLine: >-
   Something
   else

dataWihtoutTrailingNewLine value is equivalent with "Something else". Note the lack of trailing newline.