aboutsummaryrefslogtreecommitdiff
path: root/doc/customizing-pandoc.md
diff options
context:
space:
mode:
authorMauro Bieg <mb21@users.noreply.github.com>2018-11-17 14:23:49 +0100
committerGitHub <noreply@github.com>2018-11-17 14:23:49 +0100
commit0466c0a8b02b7d7cf0e9e9ba530e1250e24881ff (patch)
treee585d7abddd064f679470ab7827c251c3f5ab31a /doc/customizing-pandoc.md
parentd532eb14ebaca9e6255b428d40e22284a8a981d2 (diff)
downloadpandoc-0466c0a8b02b7d7cf0e9e9ba530e1250e24881ff.tar.gz
customizing-templates.md: variable options table
Diffstat (limited to 'doc/customizing-pandoc.md')
-rw-r--r--doc/customizing-pandoc.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/customizing-pandoc.md b/doc/customizing-pandoc.md
index 0fdfc8115..fc0e57edd 100644
--- a/doc/customizing-pandoc.md
+++ b/doc/customizing-pandoc.md
@@ -39,8 +39,27 @@ or by putting the custom template in your user data directory
(on linux and macOS, `~/.pandoc/templates/`).
Note that in many cases you can avoid the need for a custom
-template by making use of the `--include-in-header`,
-`--include-before-body`, and `--include-after-body` options.
+template by including a file with the `--include-in-header`,
+`--include-before-body`, or `--include-after-body` option.
+Or you can set the corresponding template variable directly.
+
+### Template variables
+
+There are several ways to set template variables:
+
+| | [`--variable`] | [`--metadata`] | [YAML metadata] and [`--metadata-file`] |
+|:---------------|:------------------|:------------------|:----------------------------|
+| values can be… | strings and bools | strings and bools | also YAML objects and lists |
+| strings are… | inserted verbatim | escaped | interpreted as markdown |
+| accessible by filters: | no | yes | yes |
+
+
+[`--variable`]: http://pandoc.org/MANUAL.html#option--variable
+[`--metadata`]: http://pandoc.org/MANUAL.html#option--metadata
+[YAML metadata]: http://pandoc.org/MANUAL.html#extension-yaml_metadata_block
+[`--metadata-file`]: http://pandoc.org/MANUAL.html#option--metadata-file
+
+
For more information, see [Templates](/MANUAL.html#templates) in
the pandoc manual.