From 0466c0a8b02b7d7cf0e9e9ba530e1250e24881ff Mon Sep 17 00:00:00 2001 From: Mauro Bieg <mb21@users.noreply.github.com> Date: Sat, 17 Nov 2018 14:23:49 +0100 Subject: [PATCH] customizing-templates.md: variable options table --- doc/customizing-pandoc.md | 23 +++++++++++++++++++++-- 1 file 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.