git.iko.soy/typeable/pandoc
on master help sign in
MANUAL: Put all template variable docs into one section.
054c302John MacFarlane
MANUAL.txt+38−34
@@ -1426,7 +1426,8 @@ command line using the `-V/--variable` option. If a variable is not set,
1426pandoc will look for the key in the document's metadata, which can be set
1426pandoc will look for the key in the document's metadata, which can be set
1427using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1427using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1428or with the `-M/--metadata` option. In addition, some variables
1428or with the `-M/--metadata` option. In addition, some variables
1429−are given default values by pandoc.
1429+are given default values by pandoc. See [Variables] below for
1430+a list of variables used in pandoc's default templates.
1430
1431
1431If you use custom templates, you may need to revise them as pandoc
1432If you use custom templates, you may need to revise them as pandoc
1432changes. We recommend tracking the changes in the default templates,
1433changes. We recommend tracking the changes in the default templates,
@@ -1684,8 +1685,9 @@ $for(article)$
1684$endfor$
1685$endfor$
1685```
1686```
1686
1687
1688+## Variables
1687
1689
1688−## Metadata variables
1690+### Metadata variables
1689
1691
1690`title`, `author`, `date`
1692`title`, `author`, `date`
1691: allow identification of basic aspects of the document. Included
1693: allow identification of basic aspects of the document. Included
@@ -1750,7 +1752,7 @@ will include `title`, `author` and `description` as standard document
1750properties and `subtitle` as a custom property when converting to docx,
1752properties and `subtitle` as a custom property when converting to docx,
1751ODT or pptx.
1753ODT or pptx.
1752
1754
1753−## Language variables
1755+### Language variables
1754
1756
1755`lang`
1757`lang`
1756: identifies the main language of the document using IETF language
1758: identifies the main language of the document using IETF language
@@ -1792,7 +1794,7 @@ ODT or pptx.
1792[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1794[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1793[Language subtag lookup]: https://r12a.github.io/app-subtags/
1795[Language subtag lookup]: https://r12a.github.io/app-subtags/
1794
1796
1795−## Variables for HTML slides
1797+### Variables for HTML slides
1796
1798
1797These affect HTML output when [producing slide shows with pandoc].
1799These affect HTML output when [producing slide shows with pandoc].
1798
1800
@@ -1814,7 +1816,7 @@ To turn off boolean flags that default to true in reveal.js, use `0`.
1814
1816
1815[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1817[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1816
1818
1817−## Variables for Beamer slides
1819+### Variables for Beamer slides
1818
1820
1819These variables change the appearance of PDF slides using [`beamer`].
1821These variables change the appearance of PDF slides using [`beamer`].
1820
1822
@@ -1843,7 +1845,7 @@ These variables change the appearance of PDF slides using [`beamer`].
1843: enables "title pages" for new sections (default is true)
1845: enables "title pages" for new sections (default is true)
1844
1846
1845`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1847`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1846−: beamer themes:
1848+: beamer themes
1847
1849
1848`themeoptions`
1850`themeoptions`
1849: options for LaTeX beamer themes (a list).
1851: options for LaTeX beamer themes (a list).
@@ -1851,26 +1853,27 @@ These variables change the appearance of PDF slides using [`beamer`].
1851`titlegraphic`
1853`titlegraphic`
1852: image for title slide
1854: image for title slide
1853
1855
1854−## Variables for PowerPoint slide shows
1856+### Variables for PowerPoint
1855
1857
1856−These variables control the visual aspects of a slide show that are not easily
1858+These variables control the visual aspects of a slide show that
1857−controled via templates.
1859+are not easily controled via templates.
1858
1860
1859`monofont`
1861`monofont`
1860: font to use for code.
1862: font to use for code.
1861
1863
1862−## Variables for LaTeX
1864+### Variables for LaTeX
1863
1865
1864Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1866Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1865
1867
1866−### Layout
1868+#### Layout
1867
1869
1868`block-headings`
1870`block-headings`
1869−: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or
1871+: make `\paragraph` and `\subparagraph` (fourth- and
1872+ fifth-level headings, or fifth- and sixth-level with book
1870− fifth- and sixth-level with book classes) free-standing rather than run-in;
1873+ classes) free-standing rather than run-in; requires further
1871− requires further formatting to distinguish from `\subsubsection` (third- or
1874+ formatting to distinguish from `\subsubsection` (third- or
1872− fourth-level headings). Instead of using this option, [KOMA-Script] can adjust
1875+ fourth-level headings). Instead of using this option,
1873− headings more extensively:
1876+ [KOMA-Script] can adjust headings more extensively:
1874
1877
1875 ---
1878 ---
1876 documentclass: scrartcl
1879 documentclass: scrartcl
@@ -1935,7 +1938,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1935: numbering depth for sections (with `--number-sections` option
1938: numbering depth for sections (with `--number-sections` option
1936 or `numbersections` variable)
1939 or `numbersections` variable)
1937
1940
1938−### Fonts
1941+#### Fonts
1939
1942
1940`fontenc`
1943`fontenc`
1941: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1944: 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.
1959 ...
1962 ...
1960
1963
1961`fontsize`
1964`fontsize`
1962−: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1965+: font size for body text. The standard classes allow 10pt, 11pt, and
1963− To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1966+ 12pt. To use another size, set `documentclass` to one of
1964− such as `scrartcl` or `scrbook`.
1967+ the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
1965
1968
1966`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1969`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1967: font families for use with `xelatex` or
1970: font families for use with `xelatex` or
@@ -1970,9 +1973,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1970
1973
1971`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1974`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1972: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1975: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1973− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1976+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
1974− available through [`fontspec`]; repeat for multiple options. For example,
1977+ choices available through [`fontspec`]; repeat for multiple
1978+ options. For example, to use the [TeX Gyre] version of
1975− to use the [TeX Gyre] version of Palatino with lowercase figures:
1979+ Palatino with lowercase figures:
1976
1980
1977 ---
1981 ---
1978 mainfont: TeX Gyre Pagella
1982 mainfont: TeX Gyre Pagella
@@ -1984,7 +1988,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1984`microtypeoptions`
1988`microtypeoptions`
1985: options to pass to the microtype package
1989: options to pass to the microtype package
1986
1990
1987−### Links
1991+#### Links
1988
1992
1989`colorlinks`
1993`colorlinks`
1990: add color to link text; automatically enabled if any of
1994: 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.
1999`links-as-notes`
2003`links-as-notes`
2000: causes links to be printed as footnotes
2004: causes links to be printed as footnotes
2001
2005
2002−### Front matter
2006+#### Front matter
2003
2007
2004`lof`, `lot`
2008`lof`, `lot`
2005: include list of figures, list of tables
2009: include list of figures, list of tables
@@ -2013,7 +2017,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2013`toc-depth`
2017`toc-depth`
2014: level of section to include in table of contents
2018: level of section to include in table of contents
2015
2019
2016−### BibLaTeX Bibliographies
2020+#### BibLaTeX Bibliographies
2017
2021
2018These variables function when using BibLaTeX for [citation rendering].
2022These variables function when using BibLaTeX for [citation rendering].
2019
2023
@@ -2042,7 +2046,7 @@ These variables function when using BibLaTeX for [citation rendering].
2042[`memoir`]: https://ctan.org/pkg/memoir
2046[`memoir`]: https://ctan.org/pkg/memoir
2043[`report`]: https://ctan.org/pkg/report
2047[`report`]: https://ctan.org/pkg/report
2044
2048
2045−## Variables for ConTeXt
2049+### Variables for ConTeXt
2046
2050
2047Pandoc uses these variables when [creating a PDF] with ConTeXt.
2051Pandoc uses these variables when [creating a PDF] with ConTeXt.
2048
2052
@@ -2134,7 +2138,7 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
2134[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2138[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2135[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2139[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2136
2140
2137−## Variables for `wkhtmltopdf`
2141+### Variables for `wkhtmltopdf`
2138
2142
2139Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2143Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2140The `--css` option also affects the output.
2144The `--css` option also affects the output.
@@ -2148,7 +2152,7 @@ The `--css` option also affects the output.
2148`papersize`
2152`papersize`
2149: sets the PDF paper size
2153: sets the PDF paper size
2150
2154
2151−## Variables for man pages
2155+### Variables for man pages
2152
2156
2153`adjusting`
2157`adjusting`
2154: adjusts text to left (`l`), right (`r`), center (`c`),
2158: adjusts text to left (`l`), right (`r`), center (`c`),
@@ -2166,7 +2170,7 @@ The `--css` option also affects the output.
2166`section`
2170`section`
2167: section number in man pages
2171: section number in man pages
2168
2172
2169−## Variables for ms
2173+### Variables for ms
2170
2174
2171`fontfamily`
2175`fontfamily`
2172: font family (e.g. `T` or `P`)
2176: font family (e.g. `T` or `P`)
@@ -2180,7 +2184,7 @@ The `--css` option also affects the output.
2180`pointsize`
2184`pointsize`
2181: point size (e.g. `10p`)
2185: point size (e.g. `10p`)
2182
2186
2183−## Structural variables
2187+### Variables set automatically
2184
2188
2185Pandoc sets these variables automatically in response to [options] or
2189Pandoc sets these variables automatically in response to [options] or
2186document contents; users can also modify them. These vary depending
2190document contents; users can also modify them. These vary depending
@@ -2220,9 +2224,9 @@ on the output format, and include the following:
2220
2224
2221`sourcefile`, `outputfile`
2225`sourcefile`, `outputfile`
2222: source and destination filenames, as given on the command line.
2226: source and destination filenames, as given on the command line.
2223− `sourcefile` can also be a list if input comes from multiple files, or empty
2227+ `sourcefile` can also be a list if input comes from multiple files,
2224− if input is from stdin. You can use the following snippet in your template
2228+ or empty if input is from stdin. You can use the following snippet in
2225− to distinguish them:
2229+ your template to distinguish them:
2226
2230
2227 $if(sourcefile)$
2231 $if(sourcefile)$
2228 $for(sourcefile)$
2232 $for(sourcefile)$