aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2021-06-02 22:48:56 -0600
committerJohn MacFarlane <jgm@berkeley.edu>2021-06-02 22:48:56 -0600
commita54a19cca5d00378f6103d0bb5a6e3ca2dcfef3c (patch)
tree7d4d8f606ba07a4c92f6b6dd2fcb3b4f9655e224 /MANUAL.txt
parent311736fb0ae21e5b5c78d1ad6fa4b3f4840941f9 (diff)
downloadpandoc-a54a19cca5d00378f6103d0bb5a6e3ca2dcfef3c.tar.gz
MANUAL: more details and a useful link for YAML syntax.
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index b0c5962c4..b4f74b8c4 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -4199,6 +4199,12 @@ or block-level formatting:
It consists of two paragraphs.
...
+The literal block after the `|` must be indented relative to the
+line containing the `|`. If it is not, the YAML will be invalid
+and pandoc will not interpret it as metadata. For an overview
+of the complex rules governing YAML, see the [Wikipedia entry on
+YAML syntax].
+
Template variables will be set automatically from the metadata. Thus, for
example, in writing HTML, the variable `abstract` will be set to the HTML
equivalent of the Markdown in the `abstract` field:
@@ -4261,6 +4267,7 @@ following restrictions apply:
if the link definition is somewhere else in the document.
[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
## Backslash escapes