Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

MANUAL: Put all template variable docs into one section.

Browse source
This commit is contained in:
John MacFarlane 2019-09-29 15:14:46 -07:00
parent 2956c695f6
commit 054c30228d
1 changed files with 38 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
MANUAL.txt
View file

@ -1426,7 +1426,8 @@ command line using the `-V/--variable` option. If a variable is not set,
pandoc will look for the key in the document's metadata, which can be set pandoc will look for the key in the document's metadata, which can be set
using either [YAML metadata blocks][Extension: `yaml_metadata_block`] using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
or with the `-M/--metadata` option. In addition, some variables or with the `-M/--metadata` option. In addition, some variables
are given default values by pandoc. are given default values by pandoc. See [Variables] below for
a list of variables used in pandoc's default templates.
If you use custom templates, you may need to revise them as pandoc If you use custom templates, you may need to revise them as pandoc
changes. We recommend tracking the changes in the default templates, changes. We recommend tracking the changes in the default templates,
@ -1684,8 +1685,9 @@ $for(article)$
$endfor$ $endfor$
``` ```
## Variables
## Metadata variables ### Metadata variables
`title`, `author`, `date` `title`, `author`, `date`
: allow identification of basic aspects of the document. Included : allow identification of basic aspects of the document. Included
@ -1750,7 +1752,7 @@ will include `title`, `author` and `description` as standard document
properties and `subtitle` as a custom property when converting to docx, properties and `subtitle` as a custom property when converting to docx,
ODT or pptx. ODT or pptx.
## Language variables ### Language variables
`lang` `lang`
: identifies the main language of the document using IETF language : identifies the main language of the document using IETF language
@ -1792,7 +1794,7 @@ ODT or pptx.
[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics [Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
[Language subtag lookup]: https://r12a.github.io/app-subtags/ [Language subtag lookup]: https://r12a.github.io/app-subtags/
## Variables for HTML slides ### Variables for HTML slides
These affect HTML output when [producing slide shows with pandoc]. These affect HTML output when [producing slide shows with pandoc].
@ -1814,7 +1816,7 @@ To turn off boolean flags that default to true in reveal.js, use `0`.
[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration [reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
## Variables for Beamer slides ### Variables for Beamer slides
These variables change the appearance of PDF slides using [`beamer`]. These variables change the appearance of PDF slides using [`beamer`].
@ -1843,7 +1845,7 @@ These variables change the appearance of PDF slides using [`beamer`].
: enables "title pages" for new sections (default is true) : enables "title pages" for new sections (default is true)
`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme` `theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
: beamer themes: : beamer themes
`themeoptions` `themeoptions`
: options for LaTeX beamer themes (a list). : options for LaTeX beamer themes (a list).
@ -1851,26 +1853,27 @@ These variables change the appearance of PDF slides using [`beamer`].
`titlegraphic` `titlegraphic`
: image for title slide : image for title slide
## Variables for PowerPoint slide shows ### Variables for PowerPoint
These variables control the visual aspects of a slide show that are not easily These variables control the visual aspects of a slide show that
controled via templates. are not easily controled via templates.
`monofont` `monofont`
: font to use for code. : font to use for code.
## Variables for LaTeX ### Variables for LaTeX
Pandoc uses these variables when [creating a PDF] with a LaTeX engine. Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
### Layout #### Layout
`block-headings` `block-headings`
: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or : make `\paragraph` and `\subparagraph` (fourth- and
fifth- and sixth-level with book classes) free-standing rather than run-in; fifth-level headings, or fifth- and sixth-level with book
requires further formatting to distinguish from `\subsubsection` (third- or classes) free-standing rather than run-in; requires further
fourth-level headings). Instead of using this option, [KOMA-Script] can adjust formatting to distinguish from `\subsubsection` (third- or
headings more extensively: fourth-level headings). Instead of using this option,
[KOMA-Script] can adjust headings more extensively:
--- ---
documentclass: scrartcl documentclass: scrartcl
@ -1935,7 +1938,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
: numbering depth for sections (with `--number-sections` option : numbering depth for sections (with `--number-sections` option
or `numbersections` variable) or `numbersections` variable)
### Fonts #### Fonts
`fontenc` `fontenc`
: allows font encoding to be specified through `fontenc` package (with `pdflatex`); : allows font encoding to be specified through `fontenc` package (with `pdflatex`);
@ -1959,9 +1962,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
... ...
`fontsize` `fontsize`
: font size for body text. The standard classes allow 10pt, 11pt, and 12pt. : font size for body text. The standard classes allow 10pt, 11pt, and
To use another size, set `documentclass` to one of the [KOMA-Script] classes, 12pt. To use another size, set `documentclass` to one of
such as `scrartcl` or `scrbook`. the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont` `mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
: font families for use with `xelatex` or : font families for use with `xelatex` or
@ -1970,9 +1973,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions` `mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`, : options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
`CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
available through [`fontspec`]; repeat for multiple options. For example, choices available through [`fontspec`]; repeat for multiple
to use the [TeX Gyre] version of Palatino with lowercase figures: options. For example, to use the [TeX Gyre] version of
Palatino with lowercase figures:
--- ---
mainfont: TeX Gyre Pagella mainfont: TeX Gyre Pagella
@ -1984,7 +1988,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
`microtypeoptions` `microtypeoptions`
: options to pass to the microtype package : options to pass to the microtype package
### Links #### Links
`colorlinks` `colorlinks`
: add color to link text; automatically enabled if any of : add color to link text; automatically enabled if any of
@ -1999,7 +2003,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
`links-as-notes` `links-as-notes`
: causes links to be printed as footnotes : causes links to be printed as footnotes
### Front matter #### Front matter
`lof`, `lot` `lof`, `lot`
: include list of figures, list of tables : include list of figures, list of tables
@ -2013,7 +2017,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
`toc-depth` `toc-depth`
: level of section to include in table of contents : level of section to include in table of contents
### BibLaTeX Bibliographies #### BibLaTeX Bibliographies
These variables function when using BibLaTeX for [citation rendering]. These variables function when using BibLaTeX for [citation rendering].
@ -2042,7 +2046,7 @@ These variables function when using BibLaTeX for [citation rendering].
[`memoir`]: https://ctan.org/pkg/memoir [`memoir`]: https://ctan.org/pkg/memoir
[`report`]: https://ctan.org/pkg/report [`report`]: https://ctan.org/pkg/report
## Variables for ConTeXt ### Variables for ConTeXt
Pandoc uses these variables when [creating a PDF] with ConTeXt. Pandoc uses these variables when [creating a PDF] with ConTeXt.
@ -2134,7 +2138,7 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace [`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering [`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
## Variables for `wkhtmltopdf` ### Variables for `wkhtmltopdf`
Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`]. Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
The `--css` option also affects the output. The `--css` option also affects the output.
@ -2148,7 +2152,7 @@ The `--css` option also affects the output.
`papersize` `papersize`
: sets the PDF paper size : sets the PDF paper size
## Variables for man pages ### Variables for man pages
`adjusting` `adjusting`
: adjusts text to left (`l`), right (`r`), center (`c`), : adjusts text to left (`l`), right (`r`), center (`c`),
@ -2166,7 +2170,7 @@ The `--css` option also affects the output.
`section` `section`
: section number in man pages : section number in man pages
## Variables for ms ### Variables for ms
`fontfamily` `fontfamily`
: font family (e.g. `T` or `P`) : font family (e.g. `T` or `P`)
@ -2180,7 +2184,7 @@ The `--css` option also affects the output.
`pointsize` `pointsize`
: point size (e.g. `10p`) : point size (e.g. `10p`)
## Structural variables ### Variables set automatically
Pandoc sets these variables automatically in response to [options] or Pandoc sets these variables automatically in response to [options] or
document contents; users can also modify them. These vary depending document contents; users can also modify them. These vary depending
@ -2220,9 +2224,9 @@ on the output format, and include the following:
`sourcefile`, `outputfile` `sourcefile`, `outputfile`
: source and destination filenames, as given on the command line. : source and destination filenames, as given on the command line.
`sourcefile` can also be a list if input comes from multiple files, or empty `sourcefile` can also be a list if input comes from multiple files,
if input is from stdin. You can use the following snippet in your template or empty if input is from stdin. You can use the following snippet in
to distinguish them: your template to distinguish them:
$if(sourcefile)$ $if(sourcefile)$
$for(sourcefile)$ $for(sourcefile)$