@@ -1,50 +1,34 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% March 26, 2017
1+---
2+title: Pandoc User's Guide
3+author: John MacFarlane
4+date: June 20, 2021
5+---
46
5−Synopsis
6−========
7+# Synopsis
78
89`pandoc` [*options*] [*input-file*]...
910
10−Description
11−===========
11+# Description
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
14−another, and a command-line tool that uses this library. It can read
15−[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
16−Markdown], [MultiMarkdown], and (subsets of) [Textile],
17−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
18−[TikiWiki markup], [Haddock markup], [OPML], [Emacs Org mode], [DocBook],
19−[Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx]; and it can
20−write plain text, [Markdown], [CommonMark], [PHP Markdown
21−Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
22−[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
23−[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
24−[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
25−markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
26−[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28−Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
29−or [S5] HTML slide shows. It can also produce [PDF] output on
30−systems where LaTeX, ConTeXt, `pdfroff`, or `wkhtmltopdf` is
31−installed.
32−
33−Pandoc's enhanced version of Markdown includes syntax for [footnotes],
34−[tables], flexible [ordered lists], [definition lists], [fenced code
35−blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
36−automatic tables of contents, embedded LaTeX [math], [citations], and
37−[Markdown inside HTML block elements][Extension:
38−`markdown_in_html_blocks`]. (These enhancements, described further under
39−[Pandoc's Markdown], can be disabled using the `markdown_strict` input
40−or output format.)
41−
42−In contrast to most existing tools for converting Markdown to HTML, which
43−use regex substitutions, pandoc has a modular design: it consists of a
44−set of readers, which parse text in a given format and produce a native
45−representation of the document, and a set of writers, which convert
14+another, and a command-line tool that uses this library.
15+
16+Pandoc can convert between numerous markup and word processing formats,
17+including, but not limited to, various flavors of [Markdown], [HTML],
18+[LaTeX] and [Word docx]. For the full lists of input and output formats,
19+see the `--from` and `--to` [options below][General options].
20+Pandoc can also produce [PDF] output: see [creating a PDF], below.
21+
22+Pandoc's enhanced version of Markdown includes syntax for [tables],
23+[definition lists], [metadata blocks], [footnotes], [citations], [math],
24+and much more. See below under [Pandoc's Markdown].
25+
26+Pandoc has a modular design: it consists of a set of readers, which parse
27+text in a given format and produce a native representation of the document
28+(an _abstract syntax tree_ or AST), and a set of writers, which convert
4629this native representation into a target format. Thus, adding an input
47−or output format requires only adding a reader or writer.
30+or output format requires only adding a reader or writer. Users can also
31+run custom [pandoc filters] to modify the intermediate AST.
4832
4933Because pandoc's intermediate representation of a document is less
5034expressive than many of the formats it converts between, one should
@@ -56,94 +40,33 @@ model. While conversions from pandoc's Markdown to all formats aspire
5640to be perfect, conversions from formats more expressive than pandoc's
5741Markdown can be expected to be lossy.
5842
59−[Markdown]: http://daringfireball.net/projects/markdown/
60−[CommonMark]: http://commonmark.org
61−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65−[S5]: http://meyerweb.com/eric/tools/s5/
66−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67−[Slideous]: http://goessner.net/articles/slideous/
68−[HTML]: http://www.w3.org/html/
69−[HTML5]: http://www.w3.org/TR/html5/
70−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71−[XHTML]: http://www.w3.org/TR/xhtml1/
72−[LaTeX]: http://latex-project.org
73−[`beamer`]: https://ctan.org/pkg/beamer
74−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75−[ConTeXt]: http://www.contextgarden.net/
76−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77−[DocBook]: http://docbook.org
78−[txt2tags]: http://txt2tags.org
79−[EPUB]: http://idpf.org/epub
80−[OPML]: http://dev.opml.org/spec2.html
81−[OpenDocument]: http://opendocument.xml.org
82−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83−[Textile]: http://redcloth.org/textile
84−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
91−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
92−[Haskell]: https://www.haskell.org
93−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
94−[Emacs Org mode]: http://orgmode.org
95−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
96−[DZSlides]: http://paulrouget.com/dzslides/
97−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
98−[PDF]: https://www.adobe.com/pdf/
99−[reveal.js]: http://lab.hakim.se/reveal-js/
100−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
101−[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
102−[TEI Simple]: https://github.com/TEIC/TEI-Simple
103−[Muse]: https://amusewiki.org/library/manual
104−[Vimwiki]: https://vimwiki.github.io
105−
106−Using `pandoc`
107−--------------
43+## Using pandoc
10844
109−If no *input-file* is specified, input is read from *stdin*.
110−Otherwise, the *input-files* are concatenated (with a blank
111−line between each) and used as input. Output goes to *stdout* by
112−default (though output to the terminal is disabled for the
113−`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
114−forced using `-o -`). For output to a file, use the `-o`
115−option:
45+If no *input-files* are specified, input is read from *stdin*.
46+Output goes to *stdout* by default. For output to a file,
47+use the `-o` option:
11648
11749 pandoc -o output.html input.txt
11850
119−By default, pandoc produces a document fragment, not a standalone
120−document with a proper header and footer. To produce a standalone
121−document, use the `-s` or `--standalone` flag:
51+By default, pandoc produces a document fragment. To produce a standalone
52+document (e.g. a valid HTML file including `<head>` and `<body>`),
53+use the `-s` or `--standalone` flag:
12254
12355 pandoc -s -o output.html input.txt
12456
12557For more information on how standalone documents are produced, see
126−[Templates], below.
127−
128−Instead of a file, an absolute URI may be given. In this case
129−pandoc will fetch the content using HTTP:
130−
131− pandoc -f html -t markdown http://www.fsf.org
132−
133−It is possible to supply a custom User-Agent string when requesting a
134−document from a URL, by setting an environment variable:
135−
136− USER_AGENT="Mozilla/5.0" pandoc -f html -t markdown http://www.fsf.org
58+[Templates] below.
13759
13860If multiple input files are given, `pandoc` will concatenate them all (with
139−blank lines between them) before parsing. This feature is disabled for
140− binary input formats such as `EPUB`, `odt`, and `docx`.
61+blank lines between them) before parsing. (Use `--file-scope` to parse files
62+individually.)
63+
64+## Specifying formats
14165
14266The format of the input and output can be specified explicitly using
14367command-line options. The input format can be specified using the
144−`-r/--read` or `-f/--from` options, the output format using the
145−`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
146−Markdown to LaTeX, you could type:
68+`-f/--from` option, the output format using the `-t/--to` option.
69+Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
14770
14871 pandoc -f markdown -t latex hello.txt
14972
@@ -151,14 +74,15 @@ To convert `hello.html` from HTML to Markdown:
15174
15275 pandoc -f html -t markdown hello.html
15376
154−Supported output formats are listed below under the `-t/--to` option.
155−Supported input formats are listed below under the `-f/--from` option. Note
156−that the `rst`, `textile`, `latex`, and `html` readers are not complete;
157−there are some constructs that they do not parse.
77+Supported input and output formats are listed below under [Options]
78+(see `-f` for input formats and `-t` for output formats). You
79+can also use `pandoc --list-input-formats` and
80+`pandoc --list-output-formats` to print lists of supported
81+formats.
15882
15983If the input or output format is not specified explicitly, `pandoc`
160−will attempt to guess it from the extensions of
161−the input and output filenames. Thus, for example,
84+will attempt to guess it from the extensions of the filenames.
85+Thus, for example,
16286
16387 pandoc -o hello.tex hello.txt
16488
@@ -167,7 +91,9 @@ is specified (so that output goes to *stdout*), or if the output file's
16791extension is unknown, the output format will default to HTML.
16892If no input file is specified (so that input comes from *stdin*), or
16993if the input files' extensions are unknown, the input format will
170−be assumed to be Markdown unless explicitly specified.
94+be assumed to be Markdown.
95+
96+## Character encoding
17197
17298Pandoc uses the UTF-8 character encoding for both input and output.
17399If your local character encoding is not UTF-8, you
@@ -180,151 +106,247 @@ RTF, OPML, DocBook, and Texinfo), information about
180106the character encoding is included in the document header, which
181107will only be included if you use the `-s/--standalone` option.
182108
183−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
184110
185−Creating a PDF
186−--------------
111+## Creating a PDF
187112
188−To produce a PDF, specify an output file with a `.pdf` extension.
189−By default, pandoc will use LaTeX to convert it to PDF:
113+To produce a PDF, specify an output file with a `.pdf` extension:
190114
191115 pandoc test.txt -o test.pdf
192116
193−Production of a PDF requires that a LaTeX engine be installed (see
194−`--latex-engine`, below), and assumes that the following LaTeX packages
195−are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
196−[`ifxetex`], [`ifluatex`], [`eurosym`], [`listings`] (if the
117+By default, pandoc will use LaTeX to create the PDF, which requires
118+that a LaTeX engine be installed (see `--pdf-engine` below).
119+Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120+intermediate format. To do this, specify an output file with a
121+`.pdf` extension, as before, but add the `--pdf-engine` option
122+or `-t context`, `-t html`, or `-t ms` to the command line.
123+The tool used to generate the PDF from the intermediate format
124+may be specified using `--pdf-engine`.
125+
126+You can control the PDF style using variables, depending on
127+the intermediate format used: see [variables for LaTeX],
128+[variables for ConTeXt], [variables for `wkhtmltopdf`],
129+[variables for ms]. When HTML is used as an intermediate
130+format, the output can be styled using `--css`.
131+
132+To debug the PDF creation, it can be useful to look at the intermediate
133+representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134+to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
135+
136+When using LaTeX, the following packages need to be available
137+(they are included with all recent versions of [TeX Live]):
138+[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139+[`iftex`], [`listings`] (if the
197140`--listings` option is used), [`fancyvrb`], [`longtable`],
198−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
199−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
200−`geometry` variable set), [`setspace`] (with `linestretch`), and
141+[`booktabs`], [`graphicx`] (if the document
142+contains images), [`hyperref`], [`xcolor`],
143+[`ulem`], [`geometry`] (with the `geometry` variable set),
144+[`setspace`] (with `linestretch`), and
201145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
202−the LaTeX engine requires [`fontspec`]. `xelatex` uses
203−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
204−`dir` variable set). If the `mathspec` variable is set,
205−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
206−The [`upquote`] and [`microtype`] packages are used if
207−available, and [`csquotes`] will be used for [smart punctuation]
208−if added to the template or included in any header file. The
209−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
210−optionally be used for [citation rendering]. These are included
211−with all recent versions of [TeX Live].
212−
213−Alternatively, pandoc can use ConTeXt, `wkhtmltopdf`, or
214−`pdfroff` to create a PDF. To do this, specify an output file
215−with a `.pdf` extension, as before, but add `-t context`, `-t
216−html5`, or `-t ms` to the command line.
217−
218−PDF output can be controlled using [variables for LaTeX] (if
219−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
220−If `wkhtmltopdf` is used, then the variables `margin-left`,
221−`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
222−will affect the output, as will `--css`.
223−
146+the PDF engine requires [`fontspec`]. `lualatex` uses
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151+packages are used if available, and [`csquotes`] will be used
152+for [typography] if the `csquotes` variable or metadata field is
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154+and [`biber`] packages can optionally be used for [citation
155+rendering]. The following packages will be used to improve
156+output quality if present, but pandoc does not require them to
157+be present: [`upquote`] (for straight quotes in verbatim
158+environments), [`microtype`] (for better spacing adjustments),
159+[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160+better line breaks in URLs), [`bookmark`] (for better PDF
161+bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162+footnotes in tables).
163+
164+[TeX Live]: https://www.tug.org/texlive/
224165[`amsfonts`]: https://ctan.org/pkg/amsfonts
225166[`amsmath`]: https://ctan.org/pkg/amsmath
226−[`lm`]: https://ctan.org/pkg/lm
227−[`ifxetex`]: https://ctan.org/pkg/ifxetex
228−[`ifluatex`]: https://ctan.org/pkg/ifluatex
229−[`eurosym`]: https://ctan.org/pkg/eurosym
230−[`listings`]: https://ctan.org/pkg/listings
231−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
232−[`longtable`]: https://ctan.org/pkg/longtable
167+[`babel`]: https://ctan.org/pkg/babel
168+[`biber`]: https://ctan.org/pkg/biber
169+[`biblatex`]: https://ctan.org/pkg/biblatex
170+[`bibtex`]: https://ctan.org/pkg/bibtex
171+[`bidi`]: https://ctan.org/pkg/bidi
172+[`bookmark`]: https://ctan.org/pkg/bookmark
233173[`booktabs`]: https://ctan.org/pkg/booktabs
174+[`csquotes`]: https://ctan.org/pkg/csquotes
175+[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176+[`fontspec`]: https://ctan.org/pkg/fontspec
177+[`footnote`]: https://ctan.org/pkg/footnote
178+[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179+[`geometry`]: https://ctan.org/pkg/geometry
234180[`graphicx`]: https://ctan.org/pkg/graphicx
235181[`grffile`]: https://ctan.org/pkg/grffile
236−[`geometry`]: https://ctan.org/pkg/geometry
237−[`setspace`]: https://ctan.org/pkg/setspace
238−[`xecjk`]: https://ctan.org/pkg/xecjk
239182[`hyperref`]: https://ctan.org/pkg/hyperref
240−[`ulem`]: https://ctan.org/pkg/ulem
241−[`babel`]: https://ctan.org/pkg/babel
242−[`bidi`]: https://ctan.org/pkg/bidi
183+[`iftex`]: https://ctan.org/pkg/iftex
184+[`listings`]: https://ctan.org/pkg/listings
185+[`lm`]: https://ctan.org/pkg/lm
186+[`longtable`]: https://ctan.org/pkg/longtable
243187[`mathspec`]: https://ctan.org/pkg/mathspec
244−[`unicode-math`]: https://ctan.org/pkg/unicode-math
245−[`polyglossia`]: https://ctan.org/pkg/polyglossia
246−[`fontspec`]: https://ctan.org/pkg/fontspec
247−[`upquote`]: https://ctan.org/pkg/upquote
248188[`microtype`]: https://ctan.org/pkg/microtype
249−[`csquotes`]: https://ctan.org/pkg/csquotes
250189[`natbib`]: https://ctan.org/pkg/natbib
251−[`biblatex`]: https://ctan.org/pkg/biblatex
252−[`bibtex`]: https://ctan.org/pkg/bibtex
253−[`biber`]: https://ctan.org/pkg/biber
254−[TeX Live]: http://www.tug.org/texlive/
190+[`parskip`]: https://ctan.org/pkg/parskip
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
192+[`prince`]: https://www.princexml.com/
193+[`setspace`]: https://ctan.org/pkg/setspace
194+[`ulem`]: https://ctan.org/pkg/ulem
195+[`unicode-math`]: https://ctan.org/pkg/unicode-math
196+[`upquote`]: https://ctan.org/pkg/upquote
197+[`weasyprint`]: https://weasyprint.org
198+[`wkhtmltopdf`]: https://wkhtmltopdf.org
199+[`xcolor`]: https://ctan.org/pkg/xcolor
200+[`xecjk`]: https://ctan.org/pkg/xecjk
201+[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
203+
204+
205+
206+## Reading from the Web
207+
208+Instead of an input file, an absolute URI may be given. In this case
209+pandoc will fetch the content using HTTP:
210+
211+ pandoc -f html -t markdown https://www.fsf.org
212+
213+It is possible to supply a custom User-Agent string or other
214+header when requesting a document from a URL:
215+
216+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217+ https://www.fsf.org
255218
256−Options
257−=======
219+# Options
258220
259−General options
260−---------------
221+## General options {.options}
261222
262223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
263224
264−: Specify input format. *FORMAT* can be `native` (native Haskell),
265− `json` (JSON version of native AST), `markdown` (pandoc's
266− extended Markdown), `markdown_strict` (original unextended
267− Markdown), `markdown_phpextra` (PHP Markdown Extra),
268− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
269− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
270− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
271− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
272− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
273− markup), `tikiwiki` (TikiWiki markup), `haddock` (Haddock markup), or
274− `latex` (LaTeX). (`markdown_github` provides deprecated and
275− less accurate suppport for Github-Flavored Markdown; please
276− use `gfm` instead, unless you use extensions that do not work
277− with `gfm`.) If `+lhs` is appended to `markdown`, `rst`, `latex`, or
278− `html`, the input will be treated as literate Haskell source: see
279− [Literate Haskell support], below. Markdown
280− syntax extensions can be individually enabled or disabled by
281− appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
282− example, `markdown_strict+footnotes+definition_lists` is strict
283− Markdown with footnotes and definition lists enabled, and
284− `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
285− without pipe tables and with hard line breaks. See [Pandoc's
286− Markdown], below, for a list of extensions and
225+: Specify input format. *FORMAT* can be:
226+
227+ ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
230+ - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
232+ - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
235+ - `docbook` ([DocBook])
236+ - `docx` ([Word docx])
237+ - `dokuwiki` ([DokuWiki markup])
238+ - `epub` ([EPUB])
239+ - `fb2` ([FictionBook2] e-book)
240+ - `gfm` ([GitHub-Flavored Markdown]),
241+ or the deprecated and less accurate `markdown_github`;
242+ use [`markdown_github`](#markdown-variants) only
243+ if you need extensions not supported in [`gfm`](#markdown-variants).
244+ - `haddock` ([Haddock markup])
245+ - `html` ([HTML])
246+ - `ipynb` ([Jupyter notebook])
247+ - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
249+ - `json` (JSON version of native AST)
250+ - `latex` ([LaTeX])
251+ - `markdown` ([Pandoc's Markdown])
252+ - `markdown_mmd` ([MultiMarkdown])
253+ - `markdown_phpextra` ([PHP Markdown Extra])
254+ - `markdown_strict` (original unextended [Markdown])
255+ - `mediawiki` ([MediaWiki markup])
256+ - `man` ([roff man])
257+ - `muse` ([Muse])
258+ - `native` (native Haskell)
259+ - `odt` ([ODT])
260+ - `opml` ([OPML])
261+ - `org` ([Emacs Org mode])
262+ - `rst` ([reStructuredText])
263+ - `t2t` ([txt2tags])
264+ - `textile` ([Textile])
265+ - `tikiwiki` ([TikiWiki markup])
266+ - `twiki` ([TWiki markup])
267+ - `vimwiki` ([Vimwiki])
268+ :::
269+
270+ Extensions can be individually enabled or disabled by
271+ appending `+EXTENSION` or `-EXTENSION` to the format name.
272+ See [Extensions] below, for a list of extensions and
287273 their names. See `--list-input-formats` and `--list-extensions`,
288274 below.
289275
290276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
291277
292−: Specify output format. *FORMAT* can be `native` (native Haskell),
293− `json` (JSON version of native AST), `plain` (plain text),
294− `markdown` (pandoc's extended Markdown), `markdown_strict`
295− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
296− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
297− Markdown), `commonmark` (CommonMark Markdown), `rst`
298− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
299− or `html5` (HTML5/XHTML [polyglot markup]), `latex`
300− (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
301− `man` (groff man), `mediawiki` (MediaWiki markup),
302− `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
303− `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
304− `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
305− (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
306− `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
307− (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
308− `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
309− `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
310− Simple), `slidy` (Slidy HTML and JavaScript slide show),
311− `slideous` (Slideous HTML and JavaScript slide show),
312− `dzslides` (DZSlides HTML5 + JavaScript slide show),
313− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
314− (S5 HTML and JavaScript slide show), or the path of a custom
315− lua writer (see [Custom writers], below). (`markdown_github`
316− provides deprecated and less accurate suppport for
317− Github-Flavored Markdown; please use `gfm` instead, unless
318− you use extensions that do not work with `gfm`.) Note that `odt`,
319− `epub`, and `epub3` output will not be directed to *stdout*;
320− an output filename must be specified using the `-o/--output`
321− option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
322− `beamer`, `html4`, or `html5`, the output will be rendered as
323− literate Haskell source: see [Literate Haskell support],
324− below. Markdown syntax extensions can be individually
325− enabled or disabled by appending `+EXTENSION` or
326− `-EXTENSION` to the format name, as described above under `-f`.
327− See `--list-output-formats` and `--list-extensions`, below.
278+: Specify output format. *FORMAT* can be:
279+
280+ ::: {#output-formats}
281+ - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282+ - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
285+ - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
287+ - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
289+ - `docbook` or `docbook4` ([DocBook] 4)
290+ - `docbook5` (DocBook 5)
291+ - `docx` ([Word docx])
292+ - `dokuwiki` ([DokuWiki markup])
293+ - `epub` or `epub3` ([EPUB] v3 book)
294+ - `epub2` (EPUB v2)
295+ - `fb2` ([FictionBook2] e-book)
296+ - `gfm` ([GitHub-Flavored Markdown]),
297+ or the deprecated and less accurate `markdown_github`;
298+ use [`markdown_github`](#markdown-variants) only
299+ if you need extensions not supported in [`gfm`](#markdown-variants).
300+ - `haddock` ([Haddock markup])
301+ - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302+ - `html4` ([XHTML] 1.0 Transitional)
303+ - `icml` ([InDesign ICML])
304+ - `ipynb` ([Jupyter notebook])
305+ - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306+ - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307+ - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308+ - `jats` (alias for `jats_archiving`)
309+ - `jira` ([Jira]/Confluence wiki markup)
310+ - `json` (JSON version of native AST)
311+ - `latex` ([LaTeX])
312+ - `man` ([roff man])
313+ - `markdown` ([Pandoc's Markdown])
314+ - `markdown_mmd` ([MultiMarkdown])
315+ - `markdown_phpextra` ([PHP Markdown Extra])
316+ - `markdown_strict` (original unextended [Markdown])
317+ - `mediawiki` ([MediaWiki markup])
318+ - `ms` ([roff ms])
319+ - `muse` ([Muse]),
320+ - `native` (native Haskell),
321+ - `odt` ([OpenOffice text document][ODT])
322+ - `opml` ([OPML])
323+ - `opendocument` ([OpenDocument])
324+ - `org` ([Emacs Org mode])
325+ - `pdf` ([PDF])
326+ - `plain` (plain text),
327+ - `pptx` ([PowerPoint] slide show)
328+ - `rst` ([reStructuredText])
329+ - `rtf` ([Rich Text Format])
330+ - `texinfo` ([GNU Texinfo])
331+ - `textile` ([Textile])
332+ - `slideous` ([Slideous] HTML and JavaScript slide show)
333+ - `slidy` ([Slidy] HTML and JavaScript slide show)
334+ - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
335+ - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336+ - `s5` ([S5] HTML and JavaScript slide show)
337+ - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
339+ - `zimwiki` ([ZimWiki markup])
340+ - the path of a custom Lua writer, see [Custom writers] below
341+ :::
342+
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344+ to *stdout* unless forced with `-o -`.
345+
346+ Extensions can be individually enabled or
347+ disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348+ name. See [Extensions] below, for a list of extensions and their
349+ names. See `--list-output-formats` and `--list-extensions`, below.
328350
329351`-o` *FILE*, `--output=`*FILE*
330352
@@ -336,35 +358,43 @@ General options
336358
337359: Specify the user data directory to search for pandoc data files.
338360 If this option is not specified, the default user data directory
339− will be used. This is, in UNIX:
340−
341− $HOME/.pandoc
342−
343− in Windows XP:
344−
345− C:\Documents And Settings\USERNAME\Application Data\pandoc
346−
347− and in Windows Vista or later:
348−
349− C:\Users\USERNAME\AppData\Roaming\pandoc
350−
361+ will be used. On \*nix and macOS systems this will be the `pandoc`
362+ subdirectory of the XDG data directory (by default,
363+ `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364+ environment variable). If that directory does not exist and
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366+ On Windows the default user data directory is
367+ `C:\Users\USERNAME\AppData\Roaming\pandoc`.
351368 You can find the default user data directory on your system by
352369 looking at the output of `pandoc --version`.
353− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
354− `slidy`, `slideous`, or `s5` directory
355− placed in this directory will override pandoc's normal defaults.
370+ Data files placed in this directory (for example, `reference.odt`,
371+ `reference.docx`, `epub.css`, `templates`) will override
372+ pandoc's normal defaults.
373+
374+`-d` *FILE*, `--defaults=`*FILE*
375+
376+: Specify a set of default option settings. *FILE* is a YAML
377+ file whose fields correspond to command-line option
378+ settings. All options for document conversion, including input
379+ and output files, can be set using a defaults file. The file will
380+ be searched for first in the working directory, and then in
381+ the `defaults` subdirectory of the user data directory
382+ (see `--data-dir`). The `.yaml` extension may be omitted.
383+ See the section [Default files] for more information on the
384+ file format. Settings from the defaults file may be
385+ overridden or extended by subsequent options on the command
386+ line.
356387
357388`--bash-completion`
358389
359390: Generate a bash completion script. To enable bash completion
360391 with pandoc, add this to your `.bashrc`:
361392
362− eval "$(pandoc --bash-completion)"
393+ eval "$(pandoc --bash-completion)"
363394
364395`--verbose`
365396
366−: Give verbose debugging output. Currently this only has an effect
367− with PDF output.
397+: Give verbose debugging output.
368398
369399`--quiet`
370400
@@ -388,11 +418,12 @@ General options
388418
389419: List supported output formats, one per line.
390420
391−`--list-extensions`
421+`--list-extensions`[`=`*FORMAT*]
392422
393−: List supported Markdown extensions, one per line, followed
423+: List supported extensions for *FORMAT*, one per line, preceded
394424 by a `+` or `-` indicating whether it is enabled by default
395− in pandoc's Markdown.
425+ in *FORMAT*. If *FORMAT* is not specified, defaults for
426+ pandoc's Markdown are given.
396427
397428`--list-highlight-languages`
398429
@@ -412,12 +443,95 @@ General options
412443
413444: Show usage message.
414445
415−Reader options
416−--------------
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
448+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450+[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451+[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452+[S5]: https://meyerweb.com/eric/tools/s5/
453+[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454+[Slideous]: https://goessner.net/articles/slideous/
455+[HTML]: https://www.w3.org/html/
456+[HTML5]: https://html.spec.whatwg.org/
457+[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
460+[`beamer`]: https://ctan.org/pkg/beamer
461+[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462+[ConTeXt]: https://www.contextgarden.net/
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464+[DocBook]: https://docbook.org
465+[JATS]: https://jats.nlm.nih.gov
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
468+[EPUB]: http://idpf.org/epub
469+[OPML]: http://dev.opml.org/spec2.html
470+[OpenDocument]: http://opendocument.xml.org
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
473+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476+[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481+[CSV]: https://tools.ietf.org/html/rfc4180
482+[roff man]: https://man.cx/groff_man(7)
483+[roff ms]: https://man.cx/groff_ms(7)
484+[Haskell]: https://www.haskell.org
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486+[Emacs Org mode]: https://orgmode.org
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488+[AsciiDoctor]: https://asciidoctor.org/
489+[DZSlides]: https://paulrouget.com/dzslides/
490+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491+[PDF]: https://www.adobe.com/pdf/
492+[reveal.js]: https://revealjs.com/
493+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494+[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495+[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496+[TEI Simple]: https://github.com/TEIC/TEI-Simple
497+[Muse]: https://amusewiki.org/library/manual
498+[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499+[Vimwiki]: https://vimwiki.github.io
500+[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501+[BibTeX]: https://ctan.org/pkg/bibtex
502+[BibLaTeX]: https://ctan.org/pkg/biblatex
503+
504+## Reader options {.options}
505+
506+`--shift-heading-level-by=`*NUMBER*
507+
508+: Shift heading levels by a positive or negative integer.
509+ For example, with `--shift-heading-level-by=-1`, level 2
510+ headings become level 1 headings, and level 3 headings
511+ become level 2 headings. Headings cannot have a level
512+ less than 1, so a heading that would be shifted below level 1
513+ becomes a regular paragraph. Exception: with a shift of -N,
514+ a level-N heading at the beginning of the document
515+ replaces the metadata title. `--shift-heading-level-by=-1`
516+ is a good choice when converting HTML or Markdown documents that
517+ use an initial level-1 heading for the document title and
518+ level-2+ headings for sections. `--shift-heading-level-by=1`
519+ may be a good choice for converting Markdown documents that
520+ use level-1 headings for sections to HTML, since pandoc uses
521+ a level-1 heading to render the document title.
417522
418523`--base-header-level=`*NUMBER*
419524
420−: Specify the base level for headers (defaults to 1).
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
526+ where X = NUMBER - 1.* Specify the base level for headings
527+ (defaults to 1).
528+
529+`--strip-empty-paragraphs`
530+
531+: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532+ Ignore paragraphs with no content. This option is useful
533+ for converting word processing documents where users have
534+ used empty paragraphs to create inter-paragraph space.
421535
422536`--indented-code-classes=`*CLASSES*
423537
@@ -440,7 +554,7 @@ Reader options
440554 footnotes and links will not work across files. Reading binary
441555 files (docx, odt, epub) implies `--file-scope`.
442556
443−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
444558
445559: Specify an executable to be used as a filter transforming the
446560 pandoc AST after the input is parsed and before the output is
@@ -462,7 +576,7 @@ Reader options
462576 Those who would prefer to write filters in python can use the
463577 module [`pandocfilters`], installable from PyPI. There are also
464578 pandoc filter libraries in [PHP], [perl], and
465− [javascript/node.js].
579+ [JavaScript/node.js].
466580
467581 In order of preference, pandoc will look for filters in
468582
@@ -470,50 +584,70 @@ Reader options
470584 non-executable)
471585
472586 2. `$DATADIR/filters` (executable or non-executable)
587+ where `$DATADIR` is the user data directory (see
588+ `--data-dir`, above).
473589
474590 3. `$PATH` (executable only)
475591
476−`--lua-filter=`*SCRIPT*
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
594+
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
477596
478597: Transform the document in a similar fashion as JSON filters (see
479− `--filter`), but use pandoc's build-in lua filtering system. The given
480− lua script is expected to return a list of lua filters which will be
481− applied in order. Each lua filter must contain element-transforming
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
599+ Lua script is expected to return a list of Lua filters which will be
600+ applied in order. Each Lua filter must contain element-transforming
482601 functions indexed by the name of the AST element on which the filter
483602 function should be applied.
484603
485− The `pandoc` lua module provides helper functions for element
486− creation. It is always loaded into the script's lua environment.
604+ The `pandoc` Lua module provides helper functions for element
605+ creation. It is always loaded into the script's Lua environment.
487606
488− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
489608
490− function expand_hello_world(inline)
491− if inline.c == '{{helloworld}}' then
492− return pandoc.Emph{ pandoc.Str "Hello, World" }
493− else
494− return inline
495− end
496− end
609+ In order of preference, pandoc will look for Lua filters in
497610
498− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
499612
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
615+
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
500618
501619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
502620
503621: Set the metadata field *KEY* to the value *VAL*. A value specified
504− on the command line overrides a value specified in the document.
622+ on the command line overrides a value specified in the document
623+ using [YAML metadata blocks][Extension: `yaml_metadata_block`].
505624 Values will be parsed as YAML boolean or string values. If no value is
506625 specified, the value will be treated as Boolean true. Like
507626 `--variable`, `--metadata` causes template variables to be set.
508627 But unlike `--variable`, `--metadata` affects the metadata of the
509628 underlying document (which is accessible from filters and may be
510− printed in some output formats).
629+ printed in some output formats) and metadata values will be escaped
630+ when inserted into the template.
631+
632+`--metadata-file=`*FILE*
633+
634+: Read metadata from the supplied YAML (or JSON) file. This
635+ option can be used with every input format, but string scalars
636+ in the YAML file will always be parsed as Markdown. Generally,
637+ the input will be handled the same as in [YAML metadata
638+ blocks][Extension: `yaml_metadata_block`]. This option can be
639+ used repeatedly to include multiple metadata files; values in
640+ files specified later on the command line will be preferred
641+ over those specified in earlier files. Metadata values
642+ specified inside the document, or by using `-M`, overwrite
643+ values specified with this option.
511644
512645`-p`, `--preserve-tabs`
513646
514−: Preserve tabs instead of converting them to spaces (the default).
515− Note that this will only affect tabs in literal code spans and code
516− blocks; tabs in regular text will be treated as spaces.
647+: Preserve tabs instead of converting them to spaces. (By default, pandoc
648+ converts tabs to spaces before parsing its input.) Note that this will
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
650+ text are always treated as spaces.
517651
518652`--tab-stop=`*NUMBER*
519653
@@ -523,27 +657,30 @@ Reader options
523657
524658: Specifies what to do with insertions, deletions, and comments
525659 produced by the MS Word "Track Changes" feature. `accept` (the
526− default), inserts all insertions, and ignores all
527− deletions. `reject` inserts all deletions and ignores
528− insertions. Both `accept` and `reject` ignore comments. `all` puts
529− in insertions, deletions, and comments, wrapped in spans with
530− `insertion`, `deletion`, `comment-start`, and `comment-end`
531− classes, respectively. The author and time of change is
532− included. `all` is useful for scripting: only accepting changes
533− from a certain reviewer, say, or before a certain date. This
534− option only affects the docx reader.
660+ default) processes all the insertions and deletions.
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
662+ `all` includes all insertions, deletions, and comments, wrapped
663+ in spans with `insertion`, `deletion`, `comment-start`, and
664+ `comment-end` classes, respectively. The author and time of
665+ change is included. `all` is useful for scripting: only
666+ accepting changes from a certain reviewer, say, or before a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
669+ `paragraph-insertion`/`paragraph-deletion` before the
670+ affected paragraph break. This option only affects the docx
671+ reader.
535672
536673`--extract-media=`*DIR*
537674
538675: Extract images and other media contained in or linked from
539676 the source document to the path *DIR*, creating it if
540677 necessary, and adjust the images references in the document
541− so they point to the extracted files. If the source format is
542− a binary container (docx, epub, or odt), the media is
543− extracted from the container and the original
544− filenames are used. Otherwise the media is read from the
545− file system or downloaded, and new filenames are constructed
546− based on SHA1 hashes of the contents.
678+ so they point to the extracted files. Media are downloaded,
679+ read from the file system, or extracted from a binary
680+ container (e.g. docx), as needed. The original file paths
681+ are used if they are relative paths not containing `..`.
682+ Otherwise filenames are constructed from the SHA1 hash of
683+ the contents.
547684
548685`--abbreviations=`*FILE*
549686
@@ -554,29 +691,30 @@ Reader options
554691 system default, use
555692 `pandoc --print-default-data-file=abbreviations`. The only
556693 use pandoc makes of this list is in the Markdown reader.
557− Strings ending in a period that are found in this list will
558− be followed by a nonbreaking space, so that the period will
559− not produce sentence-ending space in formats like LaTeX.
694+ Strings found in this list will be followed by a nonbreaking
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
560697
561698[`pandocfilters`]: https://github.com/jgm/pandocfilters
562699[PHP]: https://github.com/vinai/pandocfilters-php
563700[perl]: https://metacpan.org/pod/Pandoc::Filter
564−[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
701+[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
565703
566−General writer options
567−----------------------
704+## General writer options {.options}
568705
569706`-s`, `--standalone`
570707
571708: Produce output with an appropriate header and footer (e.g. a
572709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
573710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
574− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
575713
576−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
577715
578−: Use *FILE* as a custom template for the generated document. Implies
579− `--standalone`. See [Templates], below, for a description
716+: Use the specified file as a custom template for the generated document.
717+ Implies `--standalone`. See [Templates], below, for a description
580718 of template syntax. If no extension is specified, an extension
581719 corresponding to the writer will be added, so that `--template=special`
582720 looks for `special.html` for HTML output. If the template is not
@@ -588,22 +726,29 @@ General writer options
588726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
589727
590728: Set the template variable *KEY* to the value *VAL* when rendering the
591− document in standalone mode. This is generally only useful when the
592− `--template` option is used to specify a custom template, since
593− pandoc automatically sets the variables used in the default
594− templates. If no *VAL* is specified, the key will be given the
595− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
596731
597732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
598733
599734: Print the system default template for an output *FORMAT*. (See `-t`
600735 for a list of possible *FORMAT*s.) Templates in the user data
601− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
740+
741+ Note that some of the default templates use partials, for
742+ example `styles.html`. To print the partials, use
743+ `--print-default-data-file`: for example,
744+ `--print-default-data-file=templates/styles.html`.
602745
603746`--print-default-data-file=`*FILE*
604747
605748: Print a system default data file. Files in the user data directory
606− are ignored.
749+ are ignored. This option may be used with `-o`/`--output` to
750+ redirect output to a file, but `-o`/`--output` must come before
751+ `--print-default-data-file` on the command line.
607752
608753`--eol=crlf`|`lf`|`native`
609754
@@ -614,9 +759,12 @@ General writer options
614759
615760`--dpi`=*NUMBER*
616761
617−: Specify the dpi (dots per inch) value for conversion from pixels
618− to inch/centimeters and vice versa. The default is 96dpi.
619− Technically, the correct term would be ppi (pixels per inch).
762+: Specify the default dpi (dots per inch) value for conversion
763+ from pixels to inch/centimeters and vice versa. (Technically,
764+ the correct term would be ppi: pixels per inch.) The default
765+ is 96dpi. When images contain information about dpi
766+ internally, the encoded value is used instead of the default
767+ specified by this option.
620768
621769`--wrap=auto`|`none`|`preserve`
622770
@@ -629,6 +777,8 @@ General writer options
629777 where there are nonsemantic newlines in the source, there
630778 will be nonsemantic newlines in the output as well).
631779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
632782
633783`--columns=`*NUMBER*
634784
@@ -641,14 +791,29 @@ General writer options
641791: Include an automatically generated table of contents (or, in
642792 the case of `latex`, `context`, `docx`, `odt`,
643793 `opendocument`, `rst`, or `ms`, an instruction to create
644− one) in the output document. This option has no effect on
645− `man`, `docbook4`, `docbook5`, or `jats` output.
794+ one) in the output document. This option has no effect
795+ unless `-s/--standalone` is used, and it has no effect
796+ on `man`, `docbook4`, `docbook5`, or `jats` output.
797+
798+ Note that if you are producing a PDF via `ms`, the table
799+ of contents will appear at the beginning of the
800+ document, before the title. If you would prefer it to
801+ be at the end of the document, use the option
802+ `--pdf-engine-opt=--no-toc-relocation`.
646803
647804`--toc-depth=`*NUMBER*
648805
649806: Specify the number of section levels to include in the table
650− of contents. The default is 3 (which means that level 1, 2, and 3
651− headers will be listed in the contents).
807+ of contents. The default is 3 (which means that level-1, 2, and 3
808+ headings will be listed in the contents).
809+
810+`--strip-comments`
811+
812+: Strip out HTML comments in the Markdown or Textile source,
813+ rather than passing them on to Markdown, Textile or HTML
814+ output as raw HTML. This does not apply to HTML comments
815+ inside raw HTML blocks when the `markdown_in_html_blocks`
816+ extension is not set.
652817
653818`--no-highlight`
654819
@@ -667,8 +832,19 @@ General writer options
667832 Instead of a *STYLE* name, a JSON file with extension
668833 `.theme` may be supplied. This will be parsed as a KDE
669834 syntax highlighting theme and (if valid) used as the
670− highlighting style. To see a sample theme that can be
671− modified, `pandoc --print-default-data-file default.theme`.
835+ highlighting style.
836+
837+ To generate the JSON version of an existing style,
838+ use `--print-highlight-style`.
839+
840+`--print-highlight-style=`*STYLE*|*FILE*
841+
842+: Prints a JSON version of a highlighting style, which can
843+ be modified, saved with a `.theme` extension, and used
844+ with `--highlight-style`. This option may be used with
845+ `-o`/`--output` to redirect output to a file, but
846+ `-o`/`--output` must come before `--print-highlight-style`
847+ on the command line.
672848
673849`--syntax-definition=`*FILE*
674850
@@ -676,9 +852,10 @@ General writer options
676852 which will be used for syntax highlighting of appropriately
677853 marked code blocks. This can be used to add support for
678854 new languages or to use altered syntax definitions for
679− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
680857
681−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
682859
683860: Include contents of *FILE*, verbatim, at the end of the header.
684861 This can be used, for example, to include special
@@ -686,7 +863,7 @@ General writer options
686863 repeatedly to include multiple files in the header. They will be
687864 included in the order specified. Implies `--standalone`.
688865
689−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
690867
691868: Include contents of *FILE*, verbatim, at the beginning of the
692869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -695,7 +872,7 @@ General writer options
695872 used repeatedly to include multiple files. They will be included in
696873 the order specified. Implies `--standalone`.
697874
698−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
699876
700877: Include contents of *FILE*, verbatim, at the end of the document
701878 body (before the `</body>` tag in HTML, or the
@@ -714,21 +891,39 @@ General writer options
714891 will not be searched. For example:
715892 `--resource-path=.:test` will search the working directory
716893 and the `test` subdirectory, in that order.
894+ This option can be used repeatedly. Search path components
895+ that come later on the command line will be searched before
896+ those that come earlier, so
897+ `--resource-path foo:bar --resource-path baz:bim` is
898+ equivalent to `--resource-path baz:bim:foo:bar`.
717899
718−Options affecting specific writers
719−----------------------------------
900+`--request-header=`*NAME*`:`*VAL*
901+
902+: Set the request header *NAME* to the value *VAL* when making
903+ HTTP requests (for example, when a URL is given on the
904+ command line, or when resources used in a document must be
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
907+
908+`--no-check-certificate`
909+
910+: Disable the certificate verification to allow access to
911+ unsecure HTTP resources (for example when the certificate
912+ is no longer valid or self signed).
913+
914+## Options affecting specific writers {.options}
720915
721916`--self-contained`
722917
723918: Produce a standalone HTML file with no external dependencies, using
724919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
725− images, and videos. The resulting file should be "self-contained,"
726− in the sense that it needs no external files and no net access to be
727− displayed properly by a browser. This option works only with HTML output
728− formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
729− `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
730− stylesheets at absolute URLs will be downloaded; those at relative URLs
731− will be sought relative to the working directory (if the first source
920+ images, and videos. Implies `--standalone`. The resulting file should be
921+ "self-contained," in the sense that it needs no external files and no net
922+ access to be displayed properly by a browser. This option works only with
923+ HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924+ `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925+ and stylesheets at absolute URLs will be downloaded; those at relative
926+ URLs will be sought relative to the working directory (if the first source
732927 file is local) or relative to the base URL (if the first source
733928 file is remote). Elements with the attribute
734929 `data-external="1"` will be left alone; the documents they
@@ -741,13 +936,18 @@ Options affecting specific writers
741936
742937`--html-q-tags`
743938
744−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
941+ format used.)
745942
746943`--ascii`
747944
748−: Use only ASCII characters in output. Currently supported only for
749− HTML and DocBook output (which uses numerical entities instead of
750− UTF-8 when this option is selected).
945+: Use only ASCII characters in output. Currently supported for XML
946+ and HTML formats (which use entities instead of UTF-8 when this
947+ option is selected), CommonMark, gfm, and Markdown (which use
948+ entities), roff ms (which use hexadecimal escapes), and to a
949+ limited degree LaTeX (which uses standard commands for accented
950+ characters when possible). roff man output uses ASCII by default.
751951
752952`--reference-links`
753953
@@ -756,35 +956,45 @@ Options affecting specific writers
756956 placement of link references is affected by the
757957 `--reference-location` option.
758958
759−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
760960
761961: Specify whether footnotes (and references, if `reference-links` is
762962 set) are placed at the end of the current (top-level) block, the
763963 current section, or the document. The default is
764964 `document`. Currently only affects the markdown writer.
765965
966+`--markdown-headings=setext`|`atx`
967+
968+: Specify whether to use ATX-style (`#`-prefixed) or
969+ Setext-style (underlined) headings for level 1 and 2
970+ headings in Markdown output. (The default is `atx`.)
971+ ATX-style headings are always used for levels 3+.
972+ This option also affects Markdown cells in `ipynb` output.
973+
766974`--atx-headers`
767975
768−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
769− to use setext-style headers for levels 1-2, and then ATX headers.
976+: *Deprecated synonym for `--markdown-headings=atx`.*
770977
771−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
772979
773−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
774− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
775− all headers are shifted such that the top-level header becomes the specified
776− type. The default behavior is to determine the best division type via
777− heuristics: unless other conditions apply, `section` is chosen. When the
778− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
779− `article` option is specified), `chapter` is implied as the setting for this
780− option. If `beamer` is the output format, specifying either `chapter` or
781− `part` will cause top-level headers to become `\part{..}`, while
782− second-level headers remain as their default type.
980+: Treat top-level headings as the given division type in
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
983+ shifted such that the top-level heading becomes the
984+ specified type. The default behavior is to determine the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
987+ variable is set to `report`, `book`, or `memoir` (unless the
988+ `article` option is specified), `chapter` is implied as the
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
992+ remain as their default type.
783993
784994`-N`, `--number-sections`
785995
786−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
787− By default, sections are not numbered. Sections with class
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997+ output. By default, sections are not numbered. Sections with class
788998 `unnumbered` will never be numbered, even if `--number-sections`
789999 is specified.
7901000
@@ -792,16 +1002,19 @@ Options affecting specific writers
7921002
7931003: Offset for section headings in HTML output (ignored in other
7941004 output formats). The first number is added to the section number for
795− top-level headers, the second for second-level headers, and so on.
796− So, for example, if you want the first top-level header in your
1005+ top-level headings, the second for second-level headings, and so on.
1006+ So, for example, if you want the first top-level heading in your
7971007 document to be numbered "6", specify `--number-offset=5`.
798− If your document starts with a level-2 header which you want to
1008+ If your document starts with a level-2 heading which you want to
7991009 be numbered "1.5", specify `--number-offset=1,4`.
8001010 Offsets are 0 by default. Implies `--number-sections`.
8011011
8021012`--listings`
8031013
804−: Use the [`listings`] package for LaTeX code blocks
1014+: Use the [`listings`] package for LaTeX code blocks. The package
1015+ does not support multi-byte encoding for source code. To handle UTF-8
1016+ you would need to use a custom template. This issue is fully
1017+ documented here: [Encoding issue with the listings package].
8051018
8061019`-i`, `--incremental`
8071020
@@ -810,22 +1023,22 @@ Options affecting specific writers
8101023
8111024`--slide-level=`*NUMBER*
8121025
813−: Specifies that headers with the specified level create
814− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1026+: Specifies that headings with the specified level create
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
8151028 above this level in the hierarchy are used to divide the
816− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
8171030 subheads within a slide. Note that content that is
818− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
8191032 the slide show. The default is to set the slide level based
8201033 on the contents of the document; see [Structuring the slide
8211034 show].
8221035
8231036`--section-divs`
8241037
825−: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
826− and attach identifiers to the enclosing `<div>` (or `<section>`)
827− rather than the header itself. See
828− [Header identifiers], below.
1038+: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039+ and attach identifiers to the enclosing `<section>` (or `<div>`)
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
8291042
8301043`--email-obfuscation=none`|`javascript`|`references`
8311044
@@ -846,8 +1059,7 @@ Options affecting specific writers
8461059
8471060: Specify *STRING* as a prefix at the beginning of the title
8481061 that appears in the HTML header (but not in the title as it
849− appears at the beginning of the HTML body). Implies
850− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
8511063
8521064`-c` *URL*, `--css=`*URL*
8531065
@@ -855,8 +1067,8 @@ Options affecting specific writers
8551067 include multiple files. They will be included in the order specified.
8561068
8571069 A stylesheet is required for generating EPUB. If none is
858− provided using this option (or the `stylesheet` metadata
859− field), pandoc will look for a file `epub.css` in the
1070+ provided using this option (or the `css` or `stylesheet`
1071+ metadata fields), pandoc will look for a file `epub.css` in the
8601072 user data directory (see `--data-dir`). If it is not
8611073 found there, sensible defaults will be used.
8621074
@@ -879,20 +1091,56 @@ Options affecting specific writers
8791091
8801092 To produce a custom `reference.docx`, first get a copy of
8811093 the default `reference.docx`: `pandoc
882− --print-default-data-file reference.docx >
883− custom-reference.docx`. Then open `custom-reference.docx`
884− in Word, modify the styles as you wish, and save the file.
885− For best results, do not make changes to this file other
886− than modifying the styles used by pandoc: [paragraph]
887− Normal, Body Text, First Paragraph, Compact, Title,
888− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
889− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
890− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
891− Definition Term, Definition, Caption, Table Caption,
892− Image Caption, Figure, Captioned Figure, TOC Heading;
893− [character] Default Paragraph Font, Body Text Char,
894− Verbatim Char, Footnote Reference, Hyperlink; [table]
895− Table.
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
1095+ Then open `custom-reference.docx` in Word, modify the
1096+ styles as you wish, and save the file. For best
1097+ results, do not make changes to this file other than
1098+ modifying the styles used by pandoc:
1099+
1100+ Paragraph styles:
1101+
1102+ - Normal
1103+ - Body Text
1104+ - First Paragraph
1105+ - Compact
1106+ - Title
1107+ - Subtitle
1108+ - Author
1109+ - Date
1110+ - Abstract
1111+ - Bibliography
1112+ - Heading 1
1113+ - Heading 2
1114+ - Heading 3
1115+ - Heading 4
1116+ - Heading 5
1117+ - Heading 6
1118+ - Heading 7
1119+ - Heading 8
1120+ - Heading 9
1121+ - Block Text
1122+ - Footnote Text
1123+ - Definition Term
1124+ - Definition
1125+ - Caption
1126+ - Table Caption
1127+ - Image Caption
1128+ - Figure
1129+ - Captioned Figure
1130+ - TOC Heading
1131+
1132+ Character styles:
1133+
1134+ - Default Paragraph Font
1135+ - Body Text Char
1136+ - Verbatim Char
1137+ - Footnote Reference
1138+ - Hyperlink
1139+ - Section Number
1140+
1141+ Table style:
1142+
1143+ - Table
8961144
8971145 ODT
8981146
@@ -906,10 +1154,33 @@ Options affecting specific writers
9061154
9071155 To produce a custom `reference.odt`, first get a copy of
9081156 the default `reference.odt`: `pandoc
909− --print-default-data-file reference.odt >
910− custom-reference.odt`. Then open `custom-reference.odt` in
911− LibreOffice, modify the styles as you wish, and save the
912− file.
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
1158+ Then open `custom-reference.odt` in LibreOffice, modify
1159+ the styles as you wish, and save the file.
1160+
1161+ PowerPoint
1162+
1163+ : Templates included with Microsoft PowerPoint 2013 (either with
1164+ `.pptx` or `.potx` extension) are known to work, as are most
1165+ templates derived from these.
1166+
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
1169+
1170+ 1. Title Slide
1171+ 2. Title and Content
1172+ 3. Section Header
1173+ 4. Two Content
1174+
1175+ All templates included with a recent version of MS PowerPoint
1176+ will fit these criteria. (You can click on `Layout` under the
1177+ `Home` menu to check.)
1178+
1179+ You can also modify the default `reference.pptx`: first run
1180+ `pandoc -o custom-reference.pptx --print-default-data-file
1181+ reference.pptx`, and then modify `custom-reference.pptx`
1182+ in MS PowerPoint (pandoc will use the first four layout
1183+ slides, as mentioned above).
9131184
9141185`--epub-cover-image=`*FILE*
9151186
@@ -977,12 +1248,12 @@ Options affecting specific writers
9771248
9781249`--epub-chapter-level=`*NUMBER*
9791250
980−: Specify the header level at which to split the EPUB into separate
981− "chapter" files. The default is to split into chapters at level 1
982− headers. This option only affects the internal composition of the
1251+: Specify the heading level at which to split the EPUB into separate
1252+ "chapter" files. The default is to split into chapters at level-1
1253+ headings. This option only affects the internal composition of the
9831254 EPUB, not the way chapters and sections are displayed to users. Some
9841255 readers may be slow if the chapter files are too large, so for large
985− documents with few level 1 headers, one might want to use a chapter
1256+ documents with few level-1 headings, one might want to use a chapter
9861257 level of 2 or 3.
9871258
9881259`--epub-subdirectory=`*DIRNAME*
@@ -991,111 +1262,145 @@ Options affecting specific writers
9911262 the EPUB-specific contents. The default is `EPUB`. To put
9921263 the EPUB contents in the top level, use an empty string.
9931264
994−`--latex-engine=pdflatex`|`lualatex`|`xelatex`
995−
996−: Use the specified LaTeX engine when producing PDF output.
997− The default is `pdflatex`. If the engine is not in your PATH,
998− the full path of the engine may be specified here.
999−
1000−`--latex-engine-opt=`*STRING*
1001−
1002−: Use the given string as a command-line argument to the `latex-engine`.
1003− If used multiple times, the arguments are provided with spaces between
1004− them. Note that no check for duplicate options is done.
1005−
1006−[Dublin Core elements]: http://dublincore.org/documents/dces/
1007−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1008−
1009−Citation rendering
1010−------------------
1265+`--ipynb-output=all|none|best`
1266+
1267+: Determines how ipynb output cells are treated. `all` means
1268+ that all of the data formats included in the original are
1269+ preserved. `none` means that the contents of data cells
1270+ are omitted. `best` causes pandoc to try to pick the
1271+ richest data block in each output cell that is compatible
1272+ with the output format. The default is `best`.
1273+
1274+`--pdf-engine=`*PROGRAM*
1275+
1276+: Use the specified engine when producing PDF output.
1277+ Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278+ `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1280+ path of the engine may be specified here. If this option
1281+ is not specified, pandoc uses the following defaults
1282+ depending on the output format specified using `-t/--to`:
1283+
1284+ - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285+ `tectonic`, `latexmk`)
1286+ - `-t context`: `context`
1287+ - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288+ see [print-css.rocks](https://print-css.rocks) for a good
1289+ introduction to PDF generation from HTML/CSS.)
1290+ - `-t ms`: `pdfroff`
1291+
1292+`--pdf-engine-opt=`*STRING*
1293+
1294+: Use the given string as a command-line argument to the `pdf-engine`.
1295+ For example, to use a persistent directory `foo` for `latexmk`'s
1296+ auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297+ Note that no check for duplicate options is done.
1298+
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301+[Encoding issue with the listings package]:
1302+ https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303+
1304+## Citation rendering {.options}
1305+
1306+`-C`, `--citeproc`
1307+
1308+: Process the citations in the file, replacing them with
1309+ rendered citations and adding a bibliography.
1310+ Citation processing will not take place unless bibliographic
1311+ data is supplied, either through an external file specified
1312+ using the `--bibliography` option or the `bibliography`
1313+ field in metadata, or via a `references` section in metadata
1314+ containing a list of citations in CSL YAML format with
1315+ Markdown formatting. The style is controlled by a [CSL]
1316+ stylesheet specified using the `--csl` option or the `csl`
1317+ field in metadata. (If no stylesheet is specified,
1318+ the `chicago-author-date` style will be used by default.)
1319+ The citation processing transformation may be applied before
1320+ or after filters or Lua filters (see `--filter`,
1321+ `--lua-filter`): these transformations are applied in the
1322+ order they appear on the command line. For more
1323+ information, see the section on [Citations].
10111324
10121325`--bibliography=`*FILE*
10131326
10141327: Set the `bibliography` field in the document's metadata to *FILE*,
1015− overriding any value set in the metadata, and process citations
1016− using `pandoc-citeproc`. (This is equivalent to
1017− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1018− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1019− used, making this equivalent to `--metadata bibliography=FILE`.
1020− If you supply this argument multiple times, each *FILE* will be added
1021− to bibliography.
1328+ overriding any value set in the metadata. If you supply
1329+ this argument multiple times, each *FILE* will be added to
1330+ bibliography. If *FILE* is a URL, it will be fetched
1331+ via HTTP. If *FILE* is not found relative to the
1332+ working directory, it will be sought in the resource path
1333+ (see `--resource-path`).
10221334
10231335`--csl=`*FILE*
10241336
10251337: Set the `csl` field in the document's metadata to *FILE*,
10261338 overriding any value set in the metadata. (This is equivalent to
1027− `--metadata csl=FILE`.)
1028− This option is only relevant with `pandoc-citeproc`.
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340+ fetched via HTTP. If *FILE* is not found relative to the
1341+ working directory, it will be sought in the resource path
1342+ (see `--resource-path`) and finally in the `csl`
1343+ subdirectory of the pandoc user data directory.
10291344
10301345`--citation-abbreviations=`*FILE*
10311346
10321347: Set the `citation-abbreviations` field in the document's metadata to
10331348 *FILE*, overriding any value set in the metadata. (This is equivalent to
10341349 `--metadata citation-abbreviations=FILE`.)
1035− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
10361354
10371355`--natbib`
10381356
1039−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1040− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1041− use in producing a LaTeX file that can be processed with [`bibtex`].
1357+: Use [`natbib`] for citations in LaTeX output. This option
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1360+ that can be processed with [`bibtex`].
10421361
10431362`--biblatex`
10441363
1045−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1046− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1047− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1048−
1049−Math rendering in HTML
1050−----------------------
1051−
1052−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1053−
1054−: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1055− To insert a link to a local copy of the `LaTeXMathML.js` script,
1056− provide a *URL*. If no *URL* is provided, the contents of the
1057− script will be inserted directly into the HTML header, preserving
1058− portability at the price of efficiency. If you plan to use math on
1059− several pages, it is much better to link to a copy of the script,
1060− so it can be cached.
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1367+ that can be processed with [`bibtex`] or [`biber`].
10611368
1062−`--mathml`
1063−
1064−: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1065− `html4` and `html5`). This is the default in `odt` output.
1369+## Math rendering in HTML {.options}
10661370
1067−`--jsmath`[`=`*URL*]
1068−
1069−: Use [jsMath] to display embedded TeX math in HTML output.
1070− The *URL* should point to the jsMath load script (e.g.
1071− `jsMath/easy/load.js`); if provided, it will be linked to in
1072− the header of standalone HTML documents. If a *URL* is not provided,
1073− no link to the jsMath load script will be inserted; it is then
1074− up to the author to provide such a link in the HTML template.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1373+`class="math"`, so that they may be styled differently from the
1374+surrounding text if needed. However, this gives acceptable
1375+results only for basic math, usually you will want to use
1376+`--mathjax` or another of the following options.
10751377
10761378`--mathjax`[`=`*URL*]
10771379
10781380: Use [MathJax] to display embedded TeX math in HTML output.
1381+ TeX math will be put between `\(...\)` (for inline math)
1382+ or `\[...\]` (for display math) and wrapped in `<span>` tags
1383+ with class `math`. Then the MathJax JavaScript will render it.
10791384 The *URL* should point to the `MathJax.js` load script.
1080− If a *URL* is not provided, a link to the MathJax CDN will
1385+ If a *URL* is not provided, a link to the Cloudflare CDN will
10811386 be inserted.
10821387
1083−`--gladtex`
1084−
1085−: Enclose TeX math in `<eq>` tags in HTML output. These can then
1086− be processed by [gladTeX] to produce links to images of the typeset
1087− formulas.
1088−
1089−`--mimetex`[`=`*URL*]
1388+`--mathml`
10901389
1091−: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1092− specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1392+ default in `odt` output. Note that currently only Firefox
1393+ and Safari (and select e-book readers) natively support
1394+ MathML.
10931395
10941396`--webtex`[`=`*URL*]
10951397
1096−: Render TeX formulas using an external script that converts TeX
1097− formulas to images. The formula will be concatenated with the URL
1098− provided. If *URL* is not specified, the CodeCogs will be used.
1398+: Convert TeX formulas to `<img>` tags that link to an external script
1399+ that converts formulas to images. The formula will be URL-encoded
1400+ and concatenated with the URL provided. For SVG images you can for
1401+ example use `--webtex https://latex.codecogs.com/svg.latex?`.
1402+ If no URL is specified, the CodeCogs URL generating PNGs
1403+ will be used (`https://latex.codecogs.com/png.latex?`).
10991404 Note: the `--webtex` option will affect Markdown output
11001405 as well as HTML, which is useful if you're targeting a
11011406 version of Markdown without native math support.
@@ -1103,26 +1408,26 @@ Math rendering in HTML
11031408`--katex`[`=`*URL*]
11041409
11051410: Use [KaTeX] to display embedded TeX math in HTML output.
1106− The *URL* should point to the `katex.js` load script. If a *URL* is
1107− not provided, a link to the KaTeX CDN will be inserted.
1108− Note: [KaTeX] seems to work best with `html5` output.
1411+ The *URL* is the base URL for the KaTeX library. That directory
1412+ should contain a `katex.min.js` and a `katex.min.css` file.
1413+ If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1414+
1415+`--gladtex`
11091416
1110−`--katex-stylesheet=`*URL*
1417+: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
11111420
1112−: The *URL* should point to the `katex.css` stylesheet. If this option is
1113− not specified, a link to the KaTeX CDN will be inserted. Note that this
1114− option does not imply `--katex`.
1421+ pandoc -s --gladtex input.md -o myfile.htex
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
11151424
1116−[MathML]: http://www.w3.org/Math/
1117−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1118−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1425+[MathML]: https://www.w3.org/Math/
11191426[MathJax]: https://www.mathjax.org
1120−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1121−[mimeTeX]: http://www.forkosh.com/mimetex.html
11221427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
11231429
1124−Options for wrapper scripts
1125−---------------------------
1430+## Options for wrapper scripts {.options}
11261431
11271432`--dump-args`
11281433
@@ -1146,8 +1451,277 @@ Options for wrapper scripts
11461451
11471452 pandoc -o foo.html -s
11481453
1149−Templates
1150−=========
1454+# Exit codes
1455+
1456+If pandoc completes successfully, it will return exit code 0.
1457+Nonzero exit codes have the following meanings:
1458+
1459+ Code Error
1460+----- ------------------------------------
1461+ 3 PandocFailOnWarningError
1462+ 4 PandocAppError
1463+ 5 PandocTemplateError
1464+ 6 PandocOptionError
1465+ 21 PandocUnknownReaderError
1466+ 22 PandocUnknownWriterError
1467+ 23 PandocUnsupportedExtensionError
1468+ 24 PandocCiteprocError
1469+ 31 PandocEpubSubdirectoryError
1470+ 43 PandocPDFError
1471+ 44 PandocXMLError
1472+ 47 PandocPDFProgramNotFoundError
1473+ 61 PandocHttpError
1474+ 62 PandocShouldNeverHappenError
1475+ 63 PandocSomeError
1476+ 64 PandocParseError
1477+ 65 PandocParsecError
1478+ 66 PandocMakePDFError
1479+ 67 PandocSyntaxMapError
1480+ 83 PandocFilterError
1481+ 91 PandocMacroLoop
1482+ 92 PandocUTF8DecodingError
1483+ 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
1485+ 97 PandocCouldNotFindDataFileError
1486+ 99 PandocResourceNotFound
1487+----- ------------------------------------
1488+
1489+# Default files
1490+
1491+The `--defaults` option may be used to specify a package
1492+of options. Here is a sample defaults file demonstrating all of
1493+the fields that may be used:
1494+
1495+``` yaml
1496+from: markdown+emoji
1497+# reader: may be used instead of from:
1498+to: html5
1499+# writer: may be used instead of to:
1500+
1501+# leave blank for output to stdout:
1502+output-file:
1503+# leave blank for input from stdin, use [] for no input:
1504+input-files:
1505+- preface.md
1506+- content.md
1507+# or you may use input-file: with a single value
1508+
1509+# Include options from the specified defaults files.
1510+# The files will be searched for first in the working directory
1511+# and then in the defaults subdirectory of the user data directory.
1512+# The files are included in the same order in which they appear in
1513+# the list. Options specified in this defaults file always have
1514+# priority over the included ones.
1515+defaults:
1516+- defsA
1517+- defsB
1518+
1519+template: letter
1520+standalone: true
1521+self-contained: false
1522+
1523+# note that structured variables may be specified:
1524+variables:
1525+ documentclass: book
1526+ classoption:
1527+ - twosides
1528+ - draft
1529+
1530+# metadata values specified here are parsed as literal
1531+# string text, not markdown:
1532+metadata:
1533+ author:
1534+ - Sam Smith
1535+ - Julie Liu
1536+metadata-files:
1537+- boilerplate.yaml
1538+# or you may use metadata-file: with a single value
1539+
1540+# Note that these take files, not their contents:
1541+include-before-body: []
1542+include-after-body: []
1543+include-in-header: []
1544+resource-path: ["."]
1545+
1546+# turn on built-in citation processing. Note that if you need
1547+# control over when the citeproc processing is done relative
1548+# to other filters, you should instead use `citeproc` in the
1549+# list of `filters` (see below).
1550+citeproc: true
1551+csl: ieee
1552+bibliography:
1553+- foobar.bib
1554+- barbaz.json
1555+citation-abbreviations: abbrevs.json
1556+
1557+# Filters will be assumed to be Lua filters if they have
1558+# the .lua extension, and json filters otherwise. But
1559+# the filter type can also be specified explicitly, as shown.
1560+# Filters are run in the order specified.
1561+# To include the built-in citeproc filter, use either `citeproc`
1562+# or `{type: citeproc}`.
1563+filters:
1564+- wordcount.lua
1565+- type: json
1566+ path: foo.lua
1567+
1568+file-scope: false
1569+
1570+data-dir:
1571+
1572+# ERROR, WARNING, or INFO
1573+verbosity: INFO
1574+log-file: log.json
1575+
1576+# citeproc, natbib, or biblatex. This only affects LaTeX
1577+# output. If you want to use citeproc to format citations,
1578+# you should also set 'citeproc: true' (see above).
1579+cite-method: citeproc
1580+
1581+# part, chapter, section, or default:
1582+top-level-division: chapter
1583+abbreviations:
1584+
1585+pdf-engine: pdflatex
1586+pdf-engine-opts:
1587+- "-shell-escape"
1588+# you may also use pdf-engine-opt: with a single option
1589+# pdf-engine-opt: "-shell-escape"
1590+
1591+# auto, preserve, or none
1592+wrap: auto
1593+columns: 78
1594+dpi: 72
1595+
1596+extract-media: mediadir
1597+
1598+table-of-contents: true
1599+toc-depth: 2
1600+number-sections: false
1601+# a list of offsets at each heading level
1602+number-offset: [0,0,0,0,0,0]
1603+# toc: may also be used instead of table-of-contents:
1604+shift-heading-level-by: 1
1605+section-divs: true
1606+identifier-prefix: foo
1607+title-prefix: ""
1608+strip-empty-paragraphs: true
1609+# lf, crlf, or native
1610+eol: lf
1611+strip-comments: false
1612+indented-code-classes: []
1613+ascii: true
1614+default-image-extension: ".jpg"
1615+
1616+# either a style name of a style definition file:
1617+highlight-style: pygments
1618+syntax-definitions:
1619+- c.xml
1620+# or you may use syntax-definition: with a single value
1621+listings: false
1622+
1623+reference-doc: myref.docx
1624+
1625+# method is plain, webtex, gladtex, mathml, mathjax, katex
1626+# you may specify a url with webtex, mathjax, katex
1627+html-math-method:
1628+ method: mathjax
1629+ url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1630+# none, references, or javascript
1631+email-obfuscation: javascript
1632+
1633+tab-stop: 8
1634+preserve-tabs: true
1635+
1636+incremental: false
1637+slide-level: 2
1638+
1639+epub-subdirectory: EPUB
1640+epub-metadata: meta.xml
1641+epub-fonts:
1642+- foobar.otf
1643+epub-chapter-level: 1
1644+epub-cover-image: cover.jpg
1645+
1646+reference-links: true
1647+# block, section, or document
1648+reference-location: block
1649+markdown-headings: setext
1650+
1651+# accept, reject, or all
1652+track-changes: accept
1653+
1654+html-q-tags: false
1655+css:
1656+- site.css
1657+
1658+# none, all, or best
1659+ipynb-output: best
1660+
1661+# A list of two-element lists
1662+request-headers:
1663+- ["User-Agent", "Mozilla/5.0"]
1664+
1665+fail-if-warnings: false
1666+dump-args: false
1667+ignore-args: false
1668+trace: false
1669+```
1670+
1671+Fields that are omitted will just have their regular
1672+default values. So a defaults file can be as simple as
1673+one line:
1674+
1675+``` yaml
1676+verbosity: INFO
1677+```
1678+
1679+In fields that expect a file path (or list of file paths), the
1680+following syntax may be used to interpolate environment variables:
1681+
1682+``` yaml
1683+csl: ${HOME}/mycsldir/special.csl
1684+```
1685+
1686+`${USERDATA}` may also be used; this will always resolve to the
1687+user data directory that is current when the defaults file is
1688+parsed, regardless of the setting of the environment
1689+variable `USERDATA`.
1690+
1691+`${.}` will resolve to the directory containing the default
1692+file itself. This allows you to refer to resources contained
1693+in that directory:
1694+
1695+``` yaml
1696+epub-cover-image: ${.}/cover.jpg
1697+epub-metadata: ${.}/meta.xml
1698+resource-path:
1699+- . # the working directory from which pandoc is run
1700+- ${.}/images # the images subdirectory of the directory
1701+ # containing this defaults file
1702+```
1703+
1704+This environment variable interpolation syntax *only* works in
1705+fields that expect file paths.
1706+
1707+Default files can be placed in the `defaults` subdirectory of
1708+the user data directory and used from any directory. For
1709+example, one could create a file specifying defaults for writing
1710+letters, save it as `letter.yaml` in the `defaults` subdirectory
1711+of the user data directory, and then invoke these defaults
1712+from any directory using `pandoc --defaults letter`
1713+or `pandoc -dletter`.
1714+
1715+When multiple defaults are used, their contents will be combined.
1716+
1717+Note that, where command-line arguments may be repeated
1718+(`--metadata-file`, `--css`, `--include-in-header`,
1719+`--include-before-body`, `--include-after-body`, `--variable`,
1720+`--metadata`, `--syntax-definition`), the values specified on
1721+the command line will combine with values specified in the
1722+defaults file, rather than replacing them.
1723+
1724+# Templates
11511725
11521726When the `-s/--standalone` option is used, pandoc uses a template to
11531727add header and footer material that is needed for a self-standing
@@ -1164,684 +1738,1592 @@ directory (see `--data-dir`, above). *Exceptions:*
11641738- For `odt` output, customize the `default.opendocument`
11651739 template.
11661740- For `pdf` output, customize the `default.latex` template
1167− (or the `default.beamer` template, if you use `-t beamer`,
1168− or the `default.context` template, if you use `-t context`).
1169−- `docx` has no template (however, you can use
1741+ (or the `default.context` template, if you use `-t context`,
1742+ or the `default.ms` template, if you use `-t ms`, or the
1743+ `default.html` template, if you use `-t html`).
1744+- `docx` and `pptx` have no template (however, you can use
11701745 `--reference-doc` to customize the output).
11711746
11721747Templates contain *variables*, which allow for the inclusion of
1173−arbitrary information at any point in the file. Variables may be set
1174−within the document using [YAML metadata blocks][Extension:
1175−`yaml_metadata_block`]. They may also be set at the
1176−command line using the `-V/--variable` option: variables set in this
1177−way override metadata fields with the same name.
1748+arbitrary information at any point in the file. They may be set at the
1749+command line using the `-V/--variable` option. If a variable is not set,
1750+pandoc will look for the key in the document's metadata, which can be set
1751+using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1752+or with the `-M/--metadata` option. In addition, some variables
1753+are given default values by pandoc. See [Variables] below for
1754+a list of variables used in pandoc's default templates.
11781755
1179−Variables set by pandoc
1180−-----------------------
1756+If you use custom templates, you may need to revise them as pandoc
1757+changes. We recommend tracking the changes in the default templates,
1758+and modifying your custom templates accordingly. An easy way to do this
1759+is to fork the [pandoc-templates] repository and merge in
1760+changes after each pandoc release.
11811761
1182−Some variables are set automatically by pandoc. These vary somewhat
1183−depending on the output format, but include metadata fields as well
1184−as the following:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
11851763
1186−`sourcefile`, `outputfile`
1187−: source and destination filenames, as given on the command line.
1188− `sourcefile` can also be a list if input comes from multiple files, or empty
1189− if input is from stdin. You can use the following snippet in your template
1190− to distinguish them:
1764+## Template syntax
11911765
1192− $if(sourcefile)$
1193− $for(sourcefile)$
1194− $sourcefile$
1195− $endfor$
1196− $else$
1197− (stdin)
1198− $endif$
1766+### Comments
11991767
1200− Similarly, `outputfile` can be `-` if output goes to the terminal.
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
12011770
1202−`title`, `author`, `date`
1203−: allow identification of basic aspects of the document. Included
1204− in PDF metadata through LaTeX and ConTeXt. These can be set
1205− through a [pandoc title block][Extension: `pandoc_title_block`],
1206− which allows for multiple authors, or through a YAML metadata block:
1771+### Delimiters
12071772
1208− ---
1209− author:
1210− - Aristotle
1211− - Peter Abelard
1212− ...
1773+To mark variables and control structures in the template,
1774+either `$`...`$` or `${`...`}` may be used as delimiters.
1775+The styles may also be mixed in the same template, but the
1776+opening and closing delimiter must match in each case. The
1777+opening delimiter may be followed by one or more spaces
1778+or tabs, which will be ignored. The closing delimiter may
1779+be followed by one or more spaces or tabs, which will be
1780+ignored.
12131781
1214−`subtitle`
1215−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1216− renders in LaTeX only when using a document class that supports
1217− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1218− `scrreprt`, `scrbook`).[^subtitle]
1782+To include a literal `$` in the document, use `$$`.
12191783
1220−`institute`
1221−: author affiliations (in LaTeX and Beamer only). Can be a
1222− list, when there are multiple authors.
1784+### Interpolated variables
12231785
1224−`abstract`
1225−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1786+A slot for an interpolated variable is a variable name surrounded
1787+by matched delimiters. Variable names must begin with a letter
1788+and can contain letters, numbers, `_`, `-`, and `.`. The
1789+keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1790+not be used as variable names. Examples:
12261791
1227−`keywords`
1228−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1229− may be repeated as for `author`, above
1792+```
1793+$foo$
1794+$foo.bar.baz$
1795+$foo_bar.baz-bim$
1796+$ foo $
1797+${foo}
1798+${foo.bar.baz}
1799+${foo_bar.baz-bim}
1800+${ foo }
1801+```
12301802
1231−`header-includes`
1232−: contents specified by `-H/--include-in-header` (may have multiple
1233− values)
1803+Variable names with periods are used to get at structured
1804+variable values. So, for example, `employee.salary` will return the
1805+value of the `salary` field of the object that is the value of
1806+the `employee` field.
12341807
1235−`toc`
1236−: non-null value if `--toc/--table-of-contents` was specified
1808+- If the value of the variable is simple value, it will be
1809+ rendered verbatim. (Note that no escaping is done;
1810+ the assumption is that the calling program will escape
1811+ the strings appropriately for the output format.)
1812+- If the value is a list, the values will be concatenated.
1813+- If the value is a map, the string `true` will be rendered.
1814+- Every other value will be rendered as the empty string.
12371815
1238−`toc-title`
1239−: title of table of contents (works only with EPUB,
1240− opendocument, odt, docx)
1816+### Conditionals
12411817
1242−`include-before`
1243−: contents specified by `-B/--include-before-body` (may have
1244− multiple values)
1818+A conditional begins with `if(variable)` (enclosed in
1819+matched delimiters) and ends with `endif` (enclosed in matched
1820+delimiters). It may optionally contain an `else` (enclosed in
1821+matched delimiters). The `if` section is used if
1822+`variable` has a non-empty value, otherwise the `else`
1823+section is used (if present). Examples:
12451824
1246−`include-after`
1247−: contents specified by `-A/--include-after-body` (may have
1248− multiple values)
1825+```
1826+$if(foo)$bar$endif$
12491827
1250−`body`
1251−: body of document
1828+$if(foo)$
1829+ $foo$
1830+$endif$
12521831
1253−`meta-json`
1254−: JSON representation of all of the document's metadata. Field
1255− values are transformed to the selected output format.
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
12561837
1257−[^subtitle]: To make `subtitle` work with other LaTeX
1258− document classes, you can add the following to `header-includes`:
1838+${if(foo)}bar${endif}
12591839
1260− \providecommand{\subtitle}[1]{%
1261− \usepackage{titling}
1262− \posttitle{%
1263− \par\large#1\end{center}}
1264− }
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
12651843
1266−Language variables
1267−------------------
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
12681850
1269−`lang`
1270−: identifies the main language of the document,
1271− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1272− For some output formats, pandoc will convert it to an appropriate
1273− format stored in the additional variables `babel-lang`,
1274− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1275−
1276− Native pandoc `span`s and `div`s with the lang attribute
1277− (value in BCP 47) can be used to switch the language in
1278− that range.
1279−
1280−`otherlangs`
1281−: a list of other languages used in the document
1282− in the YAML metadata, according to [BCP 47]. For example:
1283− `otherlangs: [en-GB, fr]`.
1284− This is automatically generated from the `lang` attributes
1285− in all `span`s and `div`s but can be overridden.
1286− Currently only used by LaTeX through the generated
1287− `babel-otherlangs` and `polyglossia-otherlangs` variables.
1288− The LaTeX writer outputs polyglossia commands in the text but
1289− the `babel-newcommands` variable contains mappings for them
1290− to the corresponding babel.
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
12911853
1292−`dir`
1293−: the base direction of the document, either `rtl` (right-to-left)
1294− or `ltr` (left-to-right).
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
12951863
1296− For bidirectional documents, native pandoc `span`s and `div`s
1297− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1298− override the base direction in some output formats.
1299− This may not always be necessary if the final renderer
1300− (e.g. the browser, when generating HTML) supports the
1301− [Unicode Bidirectional Algorithm].
1864+### For loops
13021865
1303− When using LaTeX for bidirectional documents, only the `xelatex` engine
1304− is fully supported (use `--latex-engine=xelatex`).
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
13051869
1306−[BCP 47]: https://tools.ietf.org/html/bcp47
1307−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1870+- If `variable` is an array, the material inside the loop will
1871+ be evaluated repeatedly, with `variable` being set to each
1872+ value of the array in turn, and concatenated.
1873+- If `variable` is a map, the material inside will be set to
1874+ the map.
1875+- If the value of the associated variable is not an array or
1876+ a map, a single iteration will be performed on its value.
13081877
1309−Variables for slides
1310−--------------------
1878+Examples:
13111879
1312−Variables are available for [producing slide shows with pandoc],
1313−including all [reveal.js configuration options].
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
13141882
1315−`titlegraphic`
1316−: title graphic for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
13171886
1318−`logo`
1319−: logo for Beamer documents
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
13201890
1321−`slidy-url`
1322−: base URL for Slidy documents (defaults to
1323− `https://www.w3.org/Talks/Tools/Slidy2`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
13241895
1325−`slideous-url`
1326−: base URL for Slideous documents (defaults to `slideous`)
1896+You may optionally specify a separator between consecutive
1897+values using `sep` (enclosed in matched delimiters). The
1898+material between `sep` and the `endfor` is the separator.
13271899
1328−`s5-url`
1329−: base URL for S5 documents (defaults to `s5/default`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
13301903
1331−`revealjs-url`
1332−: base URL for reveal.js documents (defaults to `reveal.js`)
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
13331906
1334−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1335−: themes for LaTeX [`beamer`] documents
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
13361912
1337−`themeoptions`
1338−: options for LaTeX beamer themes (a list).
1913+### Partials
13391914
1340−`navigation`
1341−: controls navigation symbols in `beamer` documents
1342− (default is `empty` for no navigation symbols; other valid values
1343− are `frame`, `vertical`, and `horizontal`).
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
13441918
1345−`section-titles`
1346−: enables on "title pages" for new sections in `beamer`
1347− documents (default = true).
1919+```
1920+${ styles() }
1921+```
13481922
1349−`beamerarticle`
1350−: when true, the `beamerarticle` package is loaded (for
1351− producing an article from beamer slides).
1923+Partials will be sought in the directory containing
1924+the main template. The file name will be assumed to
1925+have the same extension as the main template if it
1926+lacks an extension. When calling the partial, the
1927+full name including file extension can also be used:
13521928
1353−`aspectratio`
1354−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1355− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1356− default, and `32` for 3:2).
1929+```
1930+${ styles.html() }
1931+```
13571932
1358−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1933+(If a partial is not found in the directory of the
1934+template and the template path is given as a relative
1935+path, it will also be sought in the `templates`
1936+subdirectory of the user data directory.)
13591937
1360−Variables for LaTeX
1361−-------------------
1938+Partials may optionally be applied to variables using
1939+a colon:
13621940
1363−LaTeX variables are used when [creating a PDF].
1941+```
1942+${ date:fancy() }
13641943
1365−`papersize`
1366−: paper size, e.g. `letter`, `a4`
1944+${ articles:bibentry() }
1945+```
13671946
1368−`fontsize`
1369−: font size for body text (e.g. `10pt`, `12pt`)
1947+If `articles` is an array, this will iterate over its
1948+values, applying the partial `bibentry()` to each one. So the
1949+second example above is equivalent to
13701950
1371−`documentclass`
1372−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
13731956
1374−`classoption`
1375−: option for document class, e.g. `oneside`; may be repeated
1376− for multiple options
1957+Note that the anaphoric keyword `it` must be used when
1958+iterating over partials. In the above examples,
1959+the `bibentry` partial should contain `it.title`
1960+(and so on) instead of `articles.title`.
13771961
1378−`geometry`
1379−: option for [`geometry`] package, e.g. `margin=1in`;
1380− may be repeated for multiple options
1962+Final newlines are omitted from included partials.
13811963
1382−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1383−: sets margins, if `geometry` is not used (otherwise `geometry`
1384− overrides these)
1964+Partials may include other partials.
13851965
1386−`linestretch`
1387−: adjusts line spacing using the [`setspace`]
1388− package, e.g. `1.25`, `1.5`
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
13891969
1390−`fontfamily`
1391−: font package for use with `pdflatex`:
1392− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1393− The default is [Latin Modern][`lm`].
1970+```
1971+${months[, ]}$
13941972
1395−`fontfamilyoptions`
1396−: options for package used as `fontfamily`: e.g. `osf,sc` with
1397− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1398− figures and true small caps; may be repeated for multiple options
1973+${articles:bibentry()[; ]$
1974+```
13991975
1400−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1401−: font families for use with `xelatex` or
1402− `lualatex`: take the name of any system font, using the
1403− [`fontspec`] package. Note that if `CJKmainfont` is used,
1404− the [`xecjk`] package must be available.
1976+The separator in this case is literal and (unlike with `sep`
1977+in an explicit `for` loop) cannot contain interpolated
1978+variables or other template directives.
14051979
1406−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1407−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1408− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1409− available through [`fontspec`], such as the OpenType features
1410− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1980+### Nesting
14111981
1412−`fontenc`
1413−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1414− default is `T1` (see guide to [LaTeX font encodings])
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
14151984
1416−`microtypeoptions`
1417−: options to pass to the microtype package
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
14181988
1419−`colorlinks`
1420−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1421− `urlcolor`, or `toccolor` are set
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
14221991
1423−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1424−: color for internal links, citation links, external links, and links in table of contents:
1425− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
14261996
1427−`links-as-notes`
1428−: causes links to be printed as footnotes
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
14291999
1430−`indent`
1431−: uses document class settings for indentation (the default LaTeX template
1432− otherwise removes indentation and adds space between paragraphs)
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
14332004
1434−`subparagraph`
1435−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1436− as sections, changing the appearance of nested headings in some classes
2005+will produce
14372006
1438−`thanks`
1439−: specifies contents of acknowledgments footnote after document title.
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
14402012
1441−`toc`
1442−: include table of contents (can also be set using `--toc/--table-of-contents`)
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
14432017
1444−`toc-depth`
1445−: level of section to include in table of contents
2018+### Breakable spaces
14462019
1447−`secnumdepth`
1448−: numbering depth for sections, if sections are numbered
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
14492024
1450−`lof`, `lot`
1451−: include list of figures, list of tables
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
14522029
1453−`bibliography`
1454−: bibliography to use for resolving references
2030+### Pipes
14552031
1456−`biblio-style`
1457−: bibliography style, when used with `--natbib` and `--biblatex`.
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
14582035
1459−`biblio-title`
1460−: bibliography title, when used with `--natbib` and `--biblatex`.
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
14612040
1462−`biblatexoptions`
1463−: list of options for biblatex.
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
14642044
1465−`natbiboptions`
1466−: list of options for natbib.
2045+$employee:name()/uppercase$
2046+```
14672047
1468−[`article`]: https://ctan.org/pkg/article
1469−[`report`]: https://ctan.org/pkg/report
1470−[`book`]: https://ctan.org/pkg/book
1471−[KOMA-Script]: https://ctan.org/pkg/koma-script
1472−[`memoir`]: https://ctan.org/pkg/memoir
1473−[`xcolor`]: https://ctan.org/pkg/xcolor
1474−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1475−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1476−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2048+Pipes may be chained:
14772049
1478−Variables for ConTeXt
1479−---------------------
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
14802055
1481−`papersize`
1482−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1483− may be repeated for multiple options
2056+Some pipes take parameters:
14842057
1485−`layout`
1486−: options for page margins and text arrangement (see [ConTeXt Layout]);
1487− may be repeated for multiple options
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
14882065
1489−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1490−: sets margins, if `layout` is not used (otherwise `layout`
1491− overrides these)
2066+Currently the following pipes are predefined:
14922067
1493−`fontsize`
1494−: font size for body text (e.g. `10pt`, `12pt`)
2068+- `pairs`: Converts a map or array to an array of maps,
2069+ each with `key` and `value` fields. If the original
2070+ value was an array, the `key` will be the array index,
2071+ starting with 1.
14952072
1496−`mainfont`, `sansfont`, `monofont`, `mathfont`
1497−: font families: take the name of any system font (see [ConTeXt Font Switching])
2073+- `uppercase`: Converts text to uppercase.
14982074
1499−`linkcolor`, `contrastcolor`
1500−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2075+- `lowercase`: Converts text to lowercase.
15012076
1502−`linkstyle`
1503−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
15042080
1505−`indenting`
1506−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1507− may be repeated for multiple options
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
15082083
1509−`whitespace`
1510−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
15112087
1512−`interlinespace`
1513−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1514− may be repeated for multiple options
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
15152091
1516−`headertext`, `footertext`
1517−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1518− may be repeated up to four times for different placement
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
15192095
1520−`pagenumbering`
1521−: page number style and location (using [`setuppagenumbering`]);
1522− may be repeated for multiple options
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
15232099
1524−`toc`
1525−: include table of contents (can also be set using `--toc/--table-of-contents`)
2100+- `chomp`: Removes trailing newlines (and breakable space).
15262101
1527−`lof`, `lot`
1528−: include list of figures, list of tables
2102+- `nowrap`: Disables line wrapping on breakable spaces.
15292103
1530−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1531−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1532−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1533−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1534−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1535−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1536−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1537−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1538−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
15392109
1540−Variables for man pages
1541−-----------------------
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
15422114
1543−`section`
1544−: section number in man pages
2115+- `left n "leftborder" "rightborder"`: Renders a textual value
2116+ in a block of width `n`, aligned to the left, with an optional
2117+ left and right border. Has no effect on other values. This
2118+ can be used to align material in tables. Widths are positive
2119+ integers indicating the number of characters. Borders
2120+ are strings inside double quotes; literal `"` and `\` characters
2121+ must be backslash-escaped.
15452122
1546−`header`
1547−: header in man pages
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
15482126
1549−`footer`
1550−: footer in man pages
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
15512130
1552−`adjusting`
1553−: adjusts text to left (`l`), right (`r`), center (`c`),
1554− or both (`b`) margins
15552131
1556−`hyphenate`
1557−: if `true` (the default), hyphenation will be used
2132+## Variables
15582133
1559−Variables for ms
1560−----------------
2134+### Metadata variables
15612135
1562−`pointsize`
1563−: point size (e.g. `10p`)
2136+`title`, `author`, `date`
2137+: allow identification of basic aspects of the document. Included
2138+ in PDF metadata through LaTeX and ConTeXt. These can be set
2139+ through a [pandoc title block][Extension: `pandoc_title_block`],
2140+ which allows for multiple authors, or through a
2141+ [YAML metadata block][Extension: `yaml_metadata_block`]:
15642142
1565−`lineheight`
1566−: line height (e.g. `12p`)
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
15672148
1568−`fontfamily`
1569−: font family (e.g. `T` or `P`)
2149+ Note that if you just want to set PDF or HTML metadata, without
2150+ including a title block in the document itself, you can
2151+ set the `title-meta`, `author-meta`, and `date-meta`
2152+ variables. (By default these are set automatically, based
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
15702155
1571−`indent`
1572−: paragraph indent (e.g. `2m`)
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
15732159
1574−Using variables in templates
1575−----------------------------
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
15762163
1577−Variable names are sequences of alphanumerics, `-`, and `_`,
1578−starting with a letter. A variable name surrounded by `$` signs
1579−will be replaced by its value. For example, the string `$title$` in
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
15802167
1581− <title>$title$</title>
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
15822170
1583−will be replaced by the document title.
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
15842174
1585−To write a literal `$` in a template, use `$$`.
2175+`category`
2176+: document category, included in docx and pptx metadata
15862177
1587−Templates may contain conditionals. The syntax is as follows:
2178+Additionally,
2179+any root-level string metadata, not included in ODT, docx
2180+or pptx metadata is added as a *custom property*.
2181+The following [YAML] metadata block for instance:
15882182
1589− $if(variable)$
1590− X
1591− $else$
1592− Y
1593− $endif$
2183+ ---
2184+ title: 'This is the title'
2185+ subtitle: "This is the subtitle"
2186+ author:
2187+ - Author One
2188+ - Author Two
2189+ description: |
2190+ This is a long
2191+ description.
15942192
1595−This will include `X` in the template if `variable` has a non-null
1596−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1597−any valid template text, and may include interpolated variables or other
1598−conditionals. The `$else$` section may be omitted.
2193+ It consists of two paragraphs
2194+ ...
15992195
1600−When variables can have multiple values (for example, `author` in
1601−a multi-author document), you can use the `$for$` keyword:
2196+will include `title`, `author` and `description` as standard document
2197+properties and `subtitle` as a custom property when converting to docx,
2198+ODT or pptx.
16022199
1603− $for(author)$
1604− <meta name="author" content="$author$" />
1605− $endfor$
2200+### Language variables
16062201
1607−You can optionally specify a separator to be used between
1608−consecutive items:
2202+`lang`
2203+: identifies the main language of the document using IETF language
2204+ tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205+ The [Language subtag lookup] tool can look up or verify these tags.
2206+ This affects most formats, and controls hyphenation in PDF output
2207+ when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
16092208
1610− $for(author)$$author$$sep$, $endfor$
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
16112211
1612−A dot can be used to select a field of a variable that takes
1613−an object as its value. So, for example:
2212+ ---
2213+ lang: en-GB
2214+ ...
16142215
1615− $author.name$ ($author.affiliation$)
2216+ Text in the main document language (British English).
16162217
1617−If you use custom templates, you may need to revise them as pandoc
1618−changes. We recommend tracking the changes in the default templates,
1619−and modifying your custom templates accordingly. An easy way to do this
1620−is to fork the [pandoc-templates] repository and merge in changes after each
1621−pandoc release.
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
16222221
1623−[pandoc-templates]: https://github.com/jgm/pandoc-templates
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
16242223
1625−Pandoc's Markdown
1626−=================
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
16272227
1628−Pandoc understands an extended and slightly revised version of
1629−John Gruber's [Markdown] syntax. This document explains the syntax,
1630−noting differences from standard Markdown. Except where noted, these
1631−differences can be suppressed by using the `markdown_strict` format instead
1632−of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1633−to the format name and disabled by adding `-EXTENSION`. For example,
1634−`markdown_strict+footnotes` is strict Markdown with footnotes
1635−enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1636−Markdown without footnotes or pipe tables.
2228+ For bidirectional documents, native pandoc `span`s and
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230+ be used to override the base direction in some output
2231+ formats. This may not always be necessary if the final
2232+ renderer (e.g. the browser, when generating HTML) supports
2233+ the [Unicode Bidirectional Algorithm].
16372234
1638−Philosophy
1639−----------
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
16402238
1641−Markdown is designed to be easy to write, and, even more importantly,
1642−easy to read:
2239+[BCP 47]: https://tools.ietf.org/html/bcp47
2240+[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2241+[Language subtag lookup]: https://r12a.github.io/app-subtags/
16432242
1644−> A Markdown-formatted document should be publishable as-is, as plain
1645−> text, without looking like it's been marked up with tags or formatting
1646−> instructions.
1647−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2243+### Variables for HTML
16482244
1649−This principle has guided pandoc's decisions in finding syntax for
1650−tables, footnotes, and other extensions.
2245+`document-css`
2246+: Enables inclusion of most of the [CSS] in the `styles.html`
2247+ [partial](#partials) (have a look with
2248+ `pandoc --print-default-data-file=templates/styles.html`).
2249+ Unless you use [`--css`](#option--css), this variable
2250+ is set to `true` by default. You can disable it with
2251+ e.g. `pandoc -M document-css=false`.
16512252
1652−There is, however, one respect in which pandoc's aims are different
1653−from the original aims of Markdown. Whereas Markdown was originally
1654−designed with HTML generation in mind, pandoc is designed for multiple
1655−output formats. Thus, while pandoc allows the embedding of raw HTML,
1656−it discourages it, and provides other, non-HTMLish ways of representing
1657−important document elements like definition lists, tables, mathematics, and
1658−footnotes.
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
16592255
1660−Paragraphs
1661−----------
2256+`fontsize`
2257+: sets the base CSS `font-size`, which you'd usually set
2258+ to e.g. `20px`, but it also accepts `pt`
2259+ (12pt = 16px in most browsers).
16622260
1663−A paragraph is one or more lines of text followed by one or more blank lines.
1664−Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1665−If you need a hard line break, put two or more spaces at the end of a line.
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
16662263
1667−#### Extension: `escaped_line_breaks` ####
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
16682266
1669−A backslash followed by a newline is also a hard line break.
1670−Note: in multiline and grid table cells, this is the only way
1671−to create a hard line break, since trailing spaces in the cells
1672−are ignored.
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
16732269
1674−Headers
1675−-------
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
16762273
1677−There are two kinds of headers: Setext and ATX.
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
16782277
1679−### Setext-style headers ###
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
16802280
1681−A setext-style header is a line of text "underlined" with a row of `=` signs
1682−(for a level one header) or `-` signs (for a level two header):
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
16832283
1684− A level-one header
1685− ==================
2284+To override or extend some [CSS] for just one document, include for example:
16862285
1687− A level-two header
1688− ------------------
2286+ ---
2287+ header-includes: |
2288+ <style>
2289+ blockquote {
2290+ font-style: italic;
2291+ }
2292+ tr.even {
2293+ background-color: #f0f0f0;
2294+ }
2295+ td, th {
2296+ padding: 0.5em 2em 0.5em 0.5em;
2297+ }
2298+ tbody {
2299+ border-bottom: none;
2300+ }
2301+ </style>
2302+ ---
16892303
1690−The header text can contain inline formatting, such as emphasis (see
1691−[Inline formatting], below).
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
16922305
2306+### Variables for HTML math
16932307
1694−### ATX-style headers ###
2308+`classoption`
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
16952312
1696−An ATX-style header consists of one to six `#` signs and a line of
1697−text, optionally followed by any number of `#` signs. The number of
1698−`#` signs at the beginning of the line is the header level:
2313+### Variables for HTML slides
16992314
1700− ## A level-two header
2315+These affect HTML output when [producing slide shows with pandoc].
17012316
1702− ### A level-three header ###
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
17032319
1704−As with setext-style headers, the header text can contain formatting:
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
17052323
1706− # A level-one header with a [link](/url) and *emphasis*
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
17072326
1708−#### Extension: `blank_before_header` ####
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
17092330
1710−Standard Markdown syntax does not require a blank line before a header.
1711−Pandoc does require this (except, of course, at the beginning of the
1712−document). The reason for the requirement is that it is all too easy for a
1713−`#` to end up at the beginning of a line by accident (perhaps through line
1714−wrapping). Consider, for example:
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
17152333
1716− I like several of their flavors of ice cream:
1717− #22, for example, and #5.
2334+`title-slide-attributes`
2335+: additional attributes for the title slide of reveal.js slide shows.
2336+ See [background in reveal.js and beamer] for an example.
17182337
1719−#### Extension: `space_in_atx_header` ####
2338+All [reveal.js configuration options] are available as variables.
2339+To turn off boolean flags that default to true in reveal.js, use `0`.
17202340
1721−Many Markdown implementations do not require a space between the
1722−opening `#`s of an ATX header and the header text, so that
1723−`#5 bolt` and `#hashtag` count as headers. With this extension,
1724−pandoc does require the space.
2341+[reveal.js configuration options]: https://revealjs.com/config/
17252342
1726−### Header identifiers ###
2343+### Variables for Beamer slides
17272344
1728−#### Extension: `header_attributes` ####
2345+These variables change the appearance of PDF slides using [`beamer`].
17292346
1730−Headers can be assigned attributes using this syntax at the end
1731−of the line containing the header text:
2347+`aspectratio`
2348+: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349+ `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350+ `32` for 3:2)
17322351
1733− {#identifier .class .class key=value key=value}
2352+`beamerarticle`
2353+: produce an article from Beamer slides
17342354
1735−Thus, for example, the following headers will all be assigned the identifier
1736−`foo`:
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
17372357
1738− # My header {#foo}
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
17392360
1740− ## My header ## {#foo}
2361+`logo`
2362+: logo image for slides
17412363
1742− My other header {#foo}
1743− ---------------
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
17442367
1745−(This syntax is compatible with [PHP Markdown Extra].)
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
17462370
1747−Note that although this syntax allows assignment of classes and key/value
1748−attributes, writers generally don't use all of this information. Identifiers,
1749−classes, and key/value attributes are used in HTML and HTML-based formats such
1750−as EPUB and slidy. Identifiers are used for labels and link anchors in the
1751−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
17522373
1753−Headers with the class `unnumbered` will not be numbered, even if
1754−`--number-sections` is specified. A single hyphen (`-`) in an attribute
1755−context is equivalent to `.unnumbered`, and preferable in non-English
1756−documents. So,
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
17572376
1758− # My header {-}
2377+`titlegraphic`
2378+: image for title slide
17592379
1760−is just the same as
2380+### Variables for PowerPoint
17612381
1762− # My header {.unnumbered}
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
17632384
1764−#### Extension: `auto_identifiers` ####
2385+`monofont`
2386+: font to use for code.
17652387
1766−A header without an explicitly specified identifier will be
1767−automatically assigned a unique identifier based on the header text.
1768−To derive the identifier from the header text,
2388+### Variables for LaTeX
17692389
1770− - Remove all formatting, links, etc.
1771− - Remove all footnotes.
1772− - Remove all punctuation, except underscores, hyphens, and periods.
1773− - Replace all spaces and newlines with hyphens.
1774− - Convert all alphabetic characters to lowercase.
1775− - Remove everything up to the first letter (identifiers may
1776− not begin with a number or punctuation mark).
1777− - If nothing is left after this, use the identifier `section`.
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
17782391
1779−Thus, for example,
2392+#### Layout
17802393
1781− Header Identifier
1782− ------------------------------- ----------------------------
1783− `Header identifiers in HTML` `header-identifiers-in-html`
1784− `*Dogs*?--in *my* house?` `dogs--in-my-house`
1785− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1786− `3. Applications` `applications`
1787− `33` `section`
2394+`block-headings`
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
2397+ classes) free-standing rather than run-in; requires further
2398+ formatting to distinguish from `\subsubsection` (third- or
2399+ fourth-level headings). Instead of using this option,
2400+ [KOMA-Script] can adjust headings more extensively:
17882401
1789−These rules should, in most cases, allow one to determine the identifier
1790−from the header text. The exception is when several headers have the
1791−same text; in this case, the first will get an identifier as described
1792−above; the second will get the same identifier with `-1` appended; the
1793−third with `-2`; and so on.
2402+ ---
2403+ documentclass: scrartcl
2404+ header-includes: |
2405+ \RedeclareSectionCommand[
2406+ beforeskip=-10pt plus -2pt minus -1pt,
2407+ afterskip=1sp plus -1sp minus 1sp,
2408+ font=\normalfont\itshape]{paragraph}
2409+ \RedeclareSectionCommand[
2410+ beforeskip=-10pt plus -2pt minus -1pt,
2411+ afterskip=1sp plus -1sp minus 1sp,
2412+ font=\normalfont\scshape,
2413+ indent=0pt]{subparagraph}
2414+ ...
17942415
1795−These identifiers are used to provide link targets in the table of
1796−contents generated by the `--toc|--table-of-contents` option. They
1797−also make it easy to provide links from one section of a document to
1798−another. A link to this section, for example, might look like this:
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
17992418
1800− See the section on
1801− [header identifiers](#header-identifiers-in-html-latex-and-context).
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
18022424
1803−Note, however, that this method of providing links to sections works
1804−only in HTML, LaTeX, and ConTeXt formats.
2425+`documentclass`
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429+ default to smaller margins; or [`memoir`]
18052430
1806−If the `--section-divs` option is specified, then each section will
1807−be wrapped in a `div` (or a `section`, if `html5` was specified),
1808−and the identifier will be attached to the enclosing `<div>`
1809−(or `<section>`) tag rather than the header itself. This allows entire
1810−sections to be manipulated using JavaScript or treated differently in
1811−CSS.
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
18122434
1813−#### Extension: `implicit_header_references` ####
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
18142441
1815−Pandoc behaves as if reference links have been defined for each header.
1816−So, to link to a header
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
18172445
1818− # Header identifiers in HTML
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
18192452
1820−you can simply write
2453+`indent`
2454+: if true, pandoc will use document class settings for
2455+ indentation (the default LaTeX template otherwise removes
2456+ indentation and adds space between paragraphs)
18212457
1822− [Header identifiers in HTML]
2458+`linestretch`
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
18232461
1824−or
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
2464+ overrides these)
2465+
2466+`pagestyle`
2467+: control `\pagestyle{}`: the default article class
2468+ supports `plain` (default), `empty` (no running heads or page numbers),
2469+ and `headings` (section titles in running heads)
2470+
2471+`papersize`
2472+: paper size, e.g. `letter`, `a4`
2473+
2474+`secnumdepth`
2475+: numbering depth for sections (with `--number-sections` option
2476+ or `numbersections` variable)
2477+
2478+#### Fonts
2479+
2480+`fontenc`
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483+
2484+`fontfamily`
2485+: font package for use with `pdflatex`:
2486+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487+ The default is [Latin Modern][`lm`].
2488+
2489+`fontfamilyoptions`
2490+: options for package used as `fontfamily`; repeat for multiple options.
2491+ For example, to use the Libertine font with proportional lowercase
2492+ (old-style) figures through the [`libertinus`] package:
2493+
2494+ ---
2495+ fontfamily: libertinus
2496+ fontfamilyoptions:
2497+ - osf
2498+ - p
2499+ ...
2500+
2501+`fontsize`
2502+: font size for body text. The standard classes allow 10pt, 11pt, and
2503+ 12pt. To use another size, set `documentclass` to one of
2504+ the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2505+
2506+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2507+: font families for use with `xelatex` or
2508+ `lualatex`: take the name of any system font, using the
2509+ [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2510+
2511+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2512+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2513+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2514+ choices available through [`fontspec`]; repeat for multiple
2515+ options. For example, to use the [TeX Gyre] version of
2516+ Palatino with lowercase figures:
2517+
2518+ ---
2519+ mainfont: TeX Gyre Pagella
2520+ mainfontoptions:
2521+ - Numbers=Lowercase
2522+ - Numbers=Proportional
2523+ ...
2524+
2525+`microtypeoptions`
2526+: options to pass to the microtype package
2527+
2528+#### Links
2529+
2530+`colorlinks`
2531+: add color to link text; automatically enabled if any of
2532+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533+
2534+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535+: color for internal links, external links, citation links, linked
2536+ URLs, and links in table of contents, respectively: uses options
2537+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538+ `x11names` lists
2539+
2540+`links-as-notes`
2541+: causes links to be printed as footnotes
2542+
2543+#### Front matter
2544+
2545+`lof`, `lot`
2546+: include list of figures, list of tables
2547+
2548+`thanks`
2549+: contents of acknowledgments footnote after document title
2550+
2551+`toc`
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
2554+
2555+`toc-depth`
2556+: level of section to include in table of contents
2557+
2558+#### BibLaTeX Bibliographies
2559+
2560+These variables function when using BibLaTeX for [citation rendering].
2561+
2562+`biblatexoptions`
2563+: list of options for biblatex
2564+
2565+`biblio-style`
2566+: bibliography style, when used with `--natbib` and `--biblatex`.
2567+
2568+`biblio-title`
2569+: bibliography title, when used with `--natbib` and `--biblatex`.
2570+
2571+`bibliography`
2572+: bibliography to use for resolving references
2573+
2574+`natbiboptions`
2575+: list of options for natbib
2576+
2577+[KOMA-Script]: https://ctan.org/pkg/koma-script
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579+[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580+[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581+[`article`]: https://ctan.org/pkg/article
2582+[`book`]: https://ctan.org/pkg/book
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
2584+[`memoir`]: https://ctan.org/pkg/memoir
2585+[`report`]: https://ctan.org/pkg/report
2586+
2587+### Variables for ConTeXt
2588+
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590+
2591+`fontsize`
2592+: font size for body text (e.g. `10pt`, `12pt`)
2593+
2594+`headertext`, `footertext`
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
2597+
2598+`indenting`
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
2601+
2602+`interlinespace`
2603+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604+ repeat for multiple options
2605+
2606+`layout`
2607+: options for page margins and text arrangement (see [ConTeXt Layout]);
2608+ repeat for multiple options
2609+
2610+`linkcolor`, `contrastcolor`
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
2613+
2614+`linkstyle`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
2617+
2618+`lof`, `lot`
2619+: include list of figures, list of tables
2620+
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
2624+
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626+: sets margins, if `layout` is not used (otherwise `layout`
2627+ overrides these)
2628+
2629+`pagenumbering`
2630+: page number style and location (using [`setuppagenumbering`]);
2631+ repeat for multiple options
2632+
2633+`papersize`
2634+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635+ repeat for multiple options
2636+
2637+`pdfa`
2638+: adds to the preamble the setup necessary to generate PDF/A
2639+ of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640+ specified (i.e. the value is set to True, by e.g.
2641+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642+ `1b:2005` will be used as default, for reasons of backwards
2643+ compatibility. Using `--variable=pdfa` without specified value
2644+ is not supported. To successfully generate PDF/A the required
2645+ ICC color profiles have to be available and the content and all
2646+ included files (such as images) have to be standard conforming.
2647+ The ICC profiles and output intent may be specified using the
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649+ PDFA] for more details.
2650+
2651+`pdfaiccprofile`
2652+: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653+ in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654+ used as default. May be repeated to include multiple profiles. Note that
2655+ the profiles have to be available on the system. They can be obtained
2656+ from [ConTeXt ICC Profiles].
2657+
2658+`pdfaintent`
2659+: when used in conjunction with `pdfa`, specifies the output intent for
2660+ the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661+ If left unspecified, `sRGB IEC61966-2.1` is used as default.
2662+
2663+`toc`
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
2666+
2667+`whitespace`
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
2670+
2671+`includesource`
2672+: include all source documents as file attachments in the PDF file
2673+
2674+[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675+[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676+[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677+[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678+[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679+[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680+[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681+[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682+[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683+[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684+[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2685+
2686+### Variables for `wkhtmltopdf`
2687+
2688+Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689+The `--css` option also affects the output.
2690+
2691+`footer-html`, `header-html`
2692+: add information to the header and footer
2693+
2694+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695+: set the page margins
2696+
2697+`papersize`
2698+: sets the PDF paper size
2699+
2700+### Variables for man pages
2701+
2702+`adjusting`
2703+: adjusts text to left (`l`), right (`r`), center (`c`),
2704+ or both (`b`) margins
2705+
2706+`footer`
2707+: footer in man pages
2708+
2709+`header`
2710+: header in man pages
2711+
2712+`hyphenate`
2713+: if `true` (the default), hyphenation will be used
2714+
2715+`section`
2716+: section number in man pages
2717+
2718+### Variables for ms
2719+
2720+`fontfamily`
2721+: font family (e.g. `T` or `P`)
2722+
2723+`indent`
2724+: paragraph indent (e.g. `2m`)
2725+
2726+`lineheight`
2727+: line height (e.g. `12p`)
2728+
2729+`pointsize`
2730+: point size (e.g. `10p`)
2731+
2732+### Variables set automatically
2733+
2734+Pandoc sets these variables automatically in response to [options] or
2735+document contents; users can also modify them. These vary depending
2736+on the output format, and include the following:
2737+
2738+`body`
2739+: body of document
2740+
2741+`date-meta`
2742+: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2743+ included in all HTML based formats (dzslides, epub,
2744+ html, html4, html5, revealjs, s5, slideous, slidy).
2745+ The recognized formats for `date` are: `mm/dd/yyyy`,
2746+ `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2747+ (e.g. either `02 Apr 2018` or `02 April 2018`),
2748+ `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2749+ `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2750+
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
2754+
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
2758+
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
2762+
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
2766+
2767+`numbersections`
2768+: non-null value if `-N/--number-sections` was specified
2769+
2770+`sourcefile`, `outputfile`
2771+: source and destination filenames, as given on the command line.
2772+ `sourcefile` can also be a list if input comes from multiple files,
2773+ or empty if input is from stdin. You can use the following snippet in
2774+ your template to distinguish them:
2775+
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
2783+
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
2785+
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787+
2788+`curdir`
2789+: working directory from which pandoc is run.
2790+
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
2793+
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2797+
2798+[pandoc-templates]: https://github.com/jgm/pandoc-templates
2799+
2800+# Extensions
2801+
2802+The behavior of some of the readers and writers can be adjusted by
2803+enabling or disabling various extensions.
2804+
2805+An extension can be enabled by adding `+EXTENSION`
2806+to the format name and disabled by adding `-EXTENSION`. For example,
2807+`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809+Markdown without footnotes or pipe tables.
2810+
2811+The markdown reader and writer make by far the most use of extensions.
2812+Extensions only used by them are therefore covered in the
2813+section [Pandoc's Markdown] below (See [Markdown variants] for
2814+`commonmark` and `gfm`.) In the following, extensions that also work
2815+for other formats are covered.
2816+
2817+Note that markdown extensions added to the `ipynb` format
2818+affect Markdown cells in Jupyter notebooks (as do command-line
2819+options like `--atx-headers`).
2820+
2821+## Typography
2822+
2823+#### Extension: `smart` ####
2824+
2825+Interpret straight quotes as curly quotes, `---` as em-dashes,
2826+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2827+inserted after certain abbreviations, such as "Mr."
2828+
2829+This extension can be enabled/disabled for the following formats:
2830+
2831+input formats
2832+: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2833+
2834+output formats
2835+: `markdown`, `latex`, `context`, `rst`
2836+
2837+enabled by default in
2838+: `markdown`, `latex`, `context` (both input and output)
2839+
2840+Note: If you are *writing* Markdown, then the `smart` extension
2841+has the reverse effect: what would have been curly quotes comes
2842+out straight.
2843+
2844+In LaTeX, `smart` means to use the standard TeX ligatures
2845+for quotation marks (` `` ` and ` '' ` for double quotes,
2846+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2847+en-dash and `---` for em-dash). If `smart` is disabled,
2848+then in reading LaTeX pandoc will parse these characters
2849+literally. In writing LaTeX, enabling `smart` tells pandoc
2850+to use the ligatures when possible; if `smart` is disabled
2851+pandoc will use unicode quotation mark and dash characters.
2852+
2853+## Headings and sections
2854+
2855+#### Extension: `auto_identifiers` ####
2856+
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
2859+
2860+This extension can be enabled/disabled for the following formats:
2861+
2862+input formats
2863+: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2864+
2865+output formats
2866+: `markdown`, `muse`
2867+
2868+enabled by default in
2869+: `markdown`, `muse`
2870+
2871+The default algorithm used to derive the identifier from the
2872+heading text is:
2873+
2874+ - Remove all formatting, links, etc.
2875+ - Remove all footnotes.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
2878+ - Replace all spaces and newlines with hyphens.
2879+ - Convert all alphabetic characters to lowercase.
2880+ - Remove everything up to the first letter (identifiers may
2881+ not begin with a number or punctuation mark).
2882+ - If nothing is left after this, use the identifier `section`.
2883+
2884+Thus, for example,
2885+
2886+ Heading Identifier
2887+ ------------------------------- ----------------------------
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
2890+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
2891+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2892+ `3. Applications` `applications`
2893+ `33` `section`
2894+
2895+These rules should, in most cases, allow one to determine the identifier
2896+from the heading text. The exception is when several headings have the
2897+same text; in this case, the first will get an identifier as described
2898+above; the second will get the same identifier with `-1` appended; the
2899+third with `-2`; and so on.
2900+
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
2903+
2904+These identifiers are used to provide link targets in the table of
2905+contents generated by the `--toc|--table-of-contents` option. They
2906+also make it easy to provide links from one section of a document to
2907+another. A link to this section, for example, might look like this:
2908+
2909+ See the section on
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2911+
2912+Note, however, that this method of providing links to sections works
2913+only in HTML, LaTeX, and ConTeXt formats.
2914+
2915+If the `--section-divs` option is specified, then each section will
2916+be wrapped in a `section` (or a `div`, if `html4` was specified),
2917+and the identifier will be attached to the enclosing `<section>`
2918+(or `<div>`) tag rather than the heading itself. This allows entire
2919+sections to be manipulated using JavaScript or treated differently in
2920+CSS.
2921+
2922+#### Extension: `ascii_identifiers` ####
2923+
2924+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2925+Accents are stripped off of accented Latin letters, and non-Latin
2926+letters are omitted.
2927+
2928+#### Extension: `gfm_auto_identifiers` ####
2929+
2930+Changes the algorithm used by `auto_identifiers` to conform to
2931+GitHub's method. Spaces are converted to dashes (`-`),
2932+uppercase characters to lowercase characters, and punctuation
2933+characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
2935+
2936+## Math Input
2937+
2938+The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2939+[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2940+[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2941+are described in the section about Pandoc's Markdown.
2942+
2943+However, they can also be used with HTML input. This is handy for
2944+reading web pages formatted using MathJax, for example.
2945+
2946+## Raw HTML/TeX
2947+
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
2950+
2951+- [`raw_html`](#extension-raw_html) allows HTML elements which
2952+ are not representable in pandoc's AST to be parsed as raw HTML.
2953+ By default, this is disabled for HTML input.
2954+
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2956+ to be included in a document. This extension can be enabled/disabled
2957+ for the following formats (in addition to `markdown`):
2958+
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
2962+
2963+ output formats
2964+ : `textile`, `commonmark`
2965+
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967+ only raw TeX in markdown cells, but data with mime type
2968+ `text/html` in output cells. Since the `ipynb` reader attempts
2969+ to preserve the richest possible outputs when several options
2970+ are given, you will get best results if you disable `raw_html`
2971+ and `raw_tex` when converting to formats like `docx` which don't
2972+ allow raw `html` or `tex`.
2973+
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2975+ elements to be parsed as native pandoc Div blocks.
2976+ If you want them to be parsed as raw HTML, use
2977+ `-f html-native_divs+raw_html`.
2978+
2979+- [`native_spans`](#extension-native_spans) causes HTML `span`
2980+ elements to be parsed as native pandoc Span inlines.
2981+ If you want them to be parsed as raw HTML, use
2982+ `-f html-native_spans+raw_html`. If you want to drop all
2983+ `div`s and `span`s when converting HTML to Markdown, you
2984+ can use `pandoc -f html-native_divs-native_spans -t markdown`.
2985+
2986+## Literate Haskell support
2987+
2988+#### Extension: `literate_haskell` ####
2989+
2990+Treat the document as literate Haskell source.
2991+
2992+This extension can be enabled/disabled for the following formats:
2993+
2994+input formats
2995+: `markdown`, `rst`, `latex`
2996+
2997+output formats
2998+: `markdown`, `rst`, `latex`, `html`
2999+
3000+If you append `+lhs` (or `+literate_haskell`) to one of the formats
3001+above, pandoc will treat the document as literate Haskell source.
3002+This means that
3003+
3004+ - In Markdown input, "bird track" sections will be parsed as Haskell
3005+ code rather than block quotations. Text between `\begin{code}`
3006+ and `\end{code}` will also be treated as Haskell code. For
3007+ ATX-style headings the character '=' will be used instead of '#'.
3008+
3009+ - In Markdown output, code blocks with classes `haskell` and `literate`
3010+ will be rendered using bird tracks, and block quotations will be
3011+ indented one space, so they will not be treated as Haskell code.
3012+ In addition, headings will be rendered setext-style (with underlines)
3013+ rather than ATX-style (with '#' characters). (This is because ghc
3014+ treats '#' characters in column 1 as introducing line numbers.)
3015+
3016+ - In restructured text input, "bird track" sections will be parsed
3017+ as Haskell code.
3018+
3019+ - In restructured text output, code blocks with class `haskell` will
3020+ be rendered using bird tracks.
3021+
3022+ - In LaTeX input, text in `code` environments will be parsed as
3023+ Haskell code.
3024+
3025+ - In LaTeX output, code blocks with class `haskell` will be rendered
3026+ inside `code` environments.
3027+
3028+ - In HTML output, code blocks with class `haskell` will be rendered
3029+ with class `literatehaskell` and bird tracks.
3030+
3031+Examples:
3032+
3033+ pandoc -f markdown+lhs -t html
3034+
3035+reads literate Haskell source formatted with Markdown conventions and writes
3036+ordinary HTML (without bird tracks).
3037+
3038+ pandoc -f markdown+lhs -t html+lhs
3039+
3040+writes HTML with the Haskell code in bird tracks, so it can be copied
3041+and pasted as literate Haskell source.
3042+
3043+Note that GHC expects the bird tracks in the first column, so indented
3044+literate code blocks (e.g. inside an itemized environment) will not be
3045+picked up by the Haskell compiler.
3046+
3047+## Other extensions
3048+
3049+#### Extension: `empty_paragraphs` ####
3050+
3051+Allows empty paragraphs. By default empty paragraphs are
3052+omitted.
3053+
3054+This extension can be enabled/disabled for the following formats:
3055+
3056+input formats
3057+: `docx`, `html`
3058+
3059+output formats
3060+: `docx`, `odt`, `opendocument`, `html`
3061+
3062+#### Extension: `native_numbering` ####
3063+
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
3066+
3067+This extension can be enabled/disabled for the following formats:
3068+
3069+output formats
3070+: `odt`, `opendocument`
3071+
3072+#### Extension: `xrefs_name` ####
3073+
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3079+name.
3080+
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3083+
3084+This extension can be enabled/disabled for the following formats:
3085+
3086+output formats
3087+: `odt`, `opendocument`
3088+
3089+#### Extension: `xrefs_number` ####
3090+
3091+Links to headings, figures and tables inside the document are
3092+substituted with cross-references that will use the number
3093+of the referenced item. The original link text is discarded.
3094+This extension can be combined with `xrefs_name` in which case
3095+the name or caption numbers will appear after the number.
3096+
3097+For the `xrefs_number` to be useful heading numbers must be enabled
3098+in the generated document, also table and figure captions must be enabled
3099+using for example the `native_numbering` extension.
3100+
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3103+
3104+This extension can be enabled/disabled for the following formats:
3105+
3106+output formats
3107+: `odt`, `opendocument`
3108+
3109+#### Extension: `styles` #### {#ext-styles}
3110+
3111+When converting from docx, read all docx styles as divs (for
3112+paragraph styles) and spans (for character styles) regardless
3113+of whether pandoc understands the meaning of these styles.
3114+This can be used with [docx custom styles](#custom-styles).
3115+Disabled by default.
3116+
3117+input formats
3118+: `docx`
3119+
3120+#### Extension: `amuse` ####
3121+
3122+In the `muse` input format, this enables Text::Amuse
3123+extensions to Emacs Muse markup.
3124+
3125+#### Extension: `raw_markdown` ####
3126+
3127+In the `ipynb` input format, this causes Markdown cells
3128+to be included as raw Markdown blocks (allowing lossless
3129+round-tripping) rather than being parsed. Use this only
3130+when you are targeting `ipynb` or a markdown-based
3131+output format.
3132+
3133+#### Extension: `citations` {#org-citations}
3134+
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
3137+
3138+#### Extension: `element_citations` ####
3139+
3140+In the `jats` output formats, this causes reference items to
3141+be replaced with `<element-citation>` elements. These
3142+elements are not influenced by CSL styles, but all information
3143+on the item is included in tags.
3144+
3145+#### Extension: `ntb` ####
3146+
3147+In the `context` output format this enables the use of [Natural Tables
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3150+Natural tables allow more fine-grained global customization but come
3151+at a performance penalty compared to extreme tables.
3152+
3153+
3154+# Pandoc's Markdown
3155+
3156+Pandoc understands an extended and slightly revised version of
3157+John Gruber's [Markdown] syntax. This document explains the syntax,
3158+noting differences from standard Markdown. Except where noted, these
3159+differences can be suppressed by using the `markdown_strict` format instead
3160+of `markdown`. Extensions can be enabled or disabled to specify the
3161+behavior more granularly. They are described in the following. See also
3162+[Extensions] above, for extensions that work also on other formats.
3163+
3164+## Philosophy
3165+
3166+Markdown is designed to be easy to write, and, even more importantly,
3167+easy to read:
3168+
3169+> A Markdown-formatted document should be publishable as-is, as plain
3170+> text, without looking like it's been marked up with tags or formatting
3171+> instructions.
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3173+
3174+This principle has guided pandoc's decisions in finding syntax for
3175+tables, footnotes, and other extensions.
3176+
3177+There is, however, one respect in which pandoc's aims are different
3178+from the original aims of Markdown. Whereas Markdown was originally
3179+designed with HTML generation in mind, pandoc is designed for multiple
3180+output formats. Thus, while pandoc allows the embedding of raw HTML,
3181+it discourages it, and provides other, non-HTMLish ways of representing
3182+important document elements like definition lists, tables, mathematics, and
3183+footnotes.
3184+
3185+## Paragraphs
3186+
3187+A paragraph is one or more lines of text followed by one or more blank lines.
3188+Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3189+If you need a hard line break, put two or more spaces at the end of a line.
3190+
3191+#### Extension: `escaped_line_breaks` ####
3192+
3193+A backslash followed by a newline is also a hard line break.
3194+Note: in multiline and grid table cells, this is the only way
3195+to create a hard line break, since trailing spaces in the cells
3196+are ignored.
3197+
3198+## Headings
3199+
3200+There are two kinds of headings: Setext and ATX.
3201+
3202+### Setext-style headings ###
3203+
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
3205+(for a level-one heading) or `-` signs (for a level-two heading):
3206+
3207+ A level-one heading
3208+ ===================
3209+
3210+ A level-two heading
3211+ -------------------
3212+
3213+The heading text can contain inline formatting, such as emphasis (see
3214+[Inline formatting], below).
3215+
3216+
3217+### ATX-style headings ###
3218+
3219+An ATX-style heading consists of one to six `#` signs and a line of
3220+text, optionally followed by any number of `#` signs. The number of
3221+`#` signs at the beginning of the line is the heading level:
3222+
3223+ ## A level-two heading
3224+
3225+ ### A level-three heading ###
3226+
3227+As with setext-style headings, the heading text can contain formatting:
3228+
3229+ # A level-one heading with a [link](/url) and *emphasis*
3230+
3231+#### Extension: `blank_before_header` ####
3232+
3233+Standard Markdown syntax does not require a blank line before a heading.
3234+Pandoc does require this (except, of course, at the beginning of the
3235+document). The reason for the requirement is that it is all too easy for a
3236+`#` to end up at the beginning of a line by accident (perhaps through line
3237+wrapping). Consider, for example:
3238+
3239+ I like several of their flavors of ice cream:
3240+ #22, for example, and #5.
3241+
3242+#### Extension: `space_in_atx_header` ####
3243+
3244+Many Markdown implementations do not require a space between the
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
3247+pandoc does require the space.
3248+
3249+### Heading identifiers ###
3250+
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
3253+
3254+#### Extension: `header_attributes` ####
3255+
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
3258+
3259+ {#identifier .class .class key=value key=value}
3260+
3261+Thus, for example, the following headings will all be assigned the identifier
3262+`foo`:
3263+
3264+ # My heading {#foo}
3265+
3266+ ## My heading ## {#foo}
3267+
3268+ My other heading {#foo}
3269+ ---------------
3270+
3271+(This syntax is compatible with [PHP Markdown Extra].)
3272+
3273+Note that although this syntax allows assignment of classes and key/value
3274+attributes, writers generally don't use all of this information. Identifiers,
3275+classes, and key/value attributes are used in HTML and HTML-based formats such
3276+as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3278+
3279+Headings with the class `unnumbered` will not be numbered, even if
3280+`--number-sections` is specified. A single hyphen (`-`) in an attribute
3281+context is equivalent to `.unnumbered`, and preferable in non-English
3282+documents. So,
3283+
3284+ # My heading {-}
3285+
3286+is just the same as
3287+
3288+ # My heading {.unnumbered}
3289+
3290+If the `unlisted` class is present in addition to `unnumbered`,
3291+the heading will not be included in a table of contents.
3292+(Currently this feature is only implemented for certain
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3294+
3295+#### Extension: `implicit_header_references` ####
3296+
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
18253299
1826− [Header identifiers in HTML][]
3300+ # Heading identifiers in HTML
3301+
3302+you can simply write
3303+
3304+ [Heading identifiers in HTML]
3305+
3306+or
3307+
3308+ [Heading identifiers in HTML][]
18273309
18283310or
18293311
1830− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
18313313 HTML]
18323314
18333315instead of giving the identifier explicitly:
18343316
1835− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
18363318
1837−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
18383320reference will link to the first one only, and you will need to use explicit
18393321links to link to the others, as described above.
18403322
18413323Like regular reference links, these references are case-insensitive.
18423324
18433325Explicit link reference definitions always take priority over
1844−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
18453327link will point to `bar`, not to `#foo`:
18463328
18473329 # Foo
@@ -1850,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
18503332
18513333 See [foo]
18523334
1853−Block quotations
1854−----------------
3335+## Block quotations
18553336
18563337Markdown uses email conventions for quoting blocks of text.
18573338A block quotation is one or more paragraphs or other block elements
1858−(such as lists or headers), with each line preceded by a `>` character
3339+(such as lists or headings), with each line preceded by a `>` character
18593340and an optional space. (The `>` need not start at the left margin, but
18603341it should not be indented more than three spaces.)
18613342
@@ -1890,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
18903371
18913372#### Extension: `blank_before_blockquote` ####
18923373
1893−Standard Markdown syntax does not require a blank line before a block
1894−quote. Pandoc does require this (except, of course, at the beginning of the
1895−document). The reason for the requirement is that it is all too easy for a
1896−`>` to end up at the beginning of a line by accident (perhaps through line
1897−wrapping). So, unless the `markdown_strict` format is used, the following does
3374+Standard Markdown syntax does not require a blank line before a
3375+block quote. Pandoc does require this (except, of course, at
3376+the beginning of the document). The reason for the requirement
3377+is that it is all too easy for a `>` to end up at the beginning
3378+of a line by accident (perhaps through line wrapping). So,
3379+unless the `markdown_strict` format is used, the following does
18983380not produce a nested block quote in pandoc:
18993381
19003382 > This is a block quote.
19013383 >> Nested.
19023384
19033385
1904−Verbatim (code) blocks
1905−----------------------
3386+## Verbatim (code) blocks
19063387
19073388### Indented code blocks ###
19083389
@@ -1964,14 +3445,16 @@ this syntax:
19643445 qsort (filter (>= x) xs)
19653446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19663447
1967−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1968−`startFrom` is an attribute with value `100`. Some output formats can use this
1969−information to do syntax highlighting. Currently, the only output formats
1970−that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
1971−is supported for your output format and language, then the code block above
1972−will appear highlighted, with numbered lines. (To see which languages are
1973−supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
1974−block above will appear as follows:
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
3451+highlighting. Currently, the only output formats that uses this
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3453+highlighting is supported for your output format and language,
3454+then the code block above will appear highlighted, with numbered
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
3457+will appear as follows:
19753458
19763459 <pre id="mycode" class="haskell numberLines" startFrom="100">
19773460 <code>
@@ -1979,6 +3462,12 @@ block above will appear as follows:
19793462 </code>
19803463 </pre>
19813464
3465+The `numberLines` (or `number-lines`) class will cause the lines
3466+of the code block to be numbered, starting with `1` or the value
3467+of the `startFrom` attribute. The `lineAnchors` (or
3468+`line-anchors`) class will cause the lines to be clickable
3469+anchors in HTML output.
3470+
19823471A shortcut form can also be used for specifying the language of
19833472the code block:
19843473
@@ -2002,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
20023491For more information on highlighting, see [Syntax highlighting],
20033492below.
20043493
2005−Line blocks
2006−-----------
3494+## Line blocks
20073495
20083496#### Extension: `line_blocks` ####
20093497
@@ -2029,10 +3517,12 @@ line must begin with a space.
20293517 | 200 Main St.
20303518 | Berkeley, CA 94718
20313519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
20323523This syntax is borrowed from [reStructuredText].
20333524
2034−Lists
2035−-----
3525+## Lists
20363526
20373527### Bullet lists ###
20383528
@@ -2202,6 +3692,12 @@ If default list markers are desired, use `#.`:
22023692 #. two
22033693 #. three
22043694
3695+#### Extension: `task_lists` ####
3696+
3697+Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3698+
3699+ - [ ] an unchecked task list item
3700+ - [x] checked item
22053701
22063702### Definition lists ###
22073703
@@ -2227,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
22273723A definition begins with a colon or tilde, which may be indented one
22283724or two spaces.
22293725
2230−A term may have multiple definitions, and each definition may consist of one or
2231−more block elements (paragraph, code block, list, etc.), each indented four
2232−spaces or one tab stop. The body of the definition (including the first line,
2233−aside from the colon or tilde) should be indented four spaces. However,
2234−as with other Markdown lists, you can "lazily" omit indentation except
3726+A term may have multiple definitions, and each definition may
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
3729+body of the definition (including the first line, aside from the
3730+colon or tilde) should be indented four spaces. However, as with
3731+other Markdown lists, you can "lazily" omit indentation except
22353732at the beginning of a paragraph or other block element:
22363733
22373734 Term 1
@@ -2257,9 +3754,10 @@ definition:
22573754Note that space between items in a definition list is required.
22583755(A variant that loosens this requirement, but disallows "lazy"
22593756hard wrapping, can be activated with `compact_definition_lists`: see
2260−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
22613758
2262−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
22633761
22643762### Numbered example lists ###
22653763
@@ -2288,30 +3786,12 @@ document:
22883786The label can be any string of alphanumeric characters, underscores,
22893787or hyphens.
22903788
2291−
2292−### Compact and loose lists ###
2293−
2294−Pandoc behaves differently from `Markdown.pl` on some "edge
2295−cases" involving lists. Consider this source:
2296−
2297− + First
2298− + Second:
2299− - Fee
2300− - Fie
2301− - Foe
2302−
2303− + Third
2304−
2305−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2306−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2307−"Second" and "Third" (but not "First"), because of the blank space
2308−around "Third". Pandoc follows a simple rule: if the text is followed by
2309−a blank line, it is treated as a paragraph. Since "Second" is followed
2310−by a list, and not a blank line, it isn't treated as a paragraph. The
2311−fact that the list is followed by a blank line is irrelevant. (Note:
2312−Pandoc works this way even when the `markdown_strict` format is specified. This
2313−behavior is consistent with the official Markdown syntax description,
2314−even though it is different from that of `Markdown.pl`.)
3789+Note: continuation paragraphs in example lists must always
3790+be indented four spaces, regardless of the length of the
3791+list marker. That is, example lists always behave as if the
3792+`four_space_rule` extension is set. This is because example
3793+labels tend to be long, and indenting content to the
3794+first non-space character after the label would be awkward.
23153795
23163796
23173797### Ending a list ###
@@ -2351,8 +3831,7 @@ of one big list:
23513831 2. dos
23523832 3. tres
23533833
2354−Horizontal rules
2355−----------------
3834+## Horizontal rules
23563835
23573836A line containing a row of three or more `*`, `-`, or `_` characters
23583837(optionally separated by spaces) produces a horizontal rule:
@@ -2362,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
23623841 ---------------
23633842
23643843
2365−Tables
2366−------
3844+## Tables
23673845
23683846Four kinds of tables may be used. The first three kinds presuppose the use of
23693847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2388,7 +3866,7 @@ Simple tables look like this:
23883866
23893867 Table: Demonstration of simple table syntax.
23903868
2391−The headers and table rows must each fit on one line. Column
3869+The header and table rows must each fit on one line. Column
23923870alignments are determined by the position of the header text relative
23933871to the dashed line below it:[^4]
23943872
@@ -2407,7 +3885,7 @@ to the dashed line below it:[^4]
24073885The table must end with a blank line, or a line of dashes followed by
24083886a blank line.
24093887
2410−The column headers may be omitted, provided a dashed line is used
3888+The column header row may be omitted, provided a dashed line is used
24113889to end the table. For example:
24123890
24133891 ------- ------ ---------- -------
@@ -2416,13 +3894,13 @@ to end the table. For example:
24163894 1 1 1 1
24173895 ------- ------ ---------- -------
24183896
2419−When headers are omitted, column alignments are determined on the basis
3897+When the header row is omitted, column alignments are determined on the basis
24203898of the first line of the table body. So, in the tables above, the columns
24213899would be right, left, center, and right aligned, respectively.
24223900
24233901#### Extension: `multiline_tables` ####
24243902
2425−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
24263904of text (but cells that span multiple columns or rows of the table are
24273905not supported). Here is an example:
24283906
@@ -2444,7 +3922,7 @@ not supported). Here is an example:
24443922These work like simple tables, but with the following differences:
24453923
24463924 - They must begin with a row of dashes, before the header text
2447− (unless the headers are omitted).
3925+ (unless the header row is omitted).
24483926 - They must end with a row of dashes, then a blank line.
24493927 - The rows must be separated by blank lines.
24503928
@@ -2453,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
24533931the output. So, if you find that one of the columns is too narrow in the
24543932output, try widening it in the Markdown source.
24553933
2456−Headers may be omitted in multiline tables as well as simple tables:
3934+The header may be omitted in multiline tables as well as simple tables:
24573935
24583936 ----------- ------- --------------- -------------------------
24593937 First row 12.0 Example of a row that
@@ -2464,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
24643942 rows.
24653943 ----------- ------- --------------- -------------------------
24663944
2467− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
24683946
24693947It is possible for a multiline table to have just one row, but the row
24703948should be followed by a blank line (and then the row of dashes that ends
@@ -2490,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
24903968omitted for a headerless table. The cells of grid tables may contain
24913969arbitrary block elements (multiple paragraphs, code blocks, lists,
24923970etc.). Cells that span multiple columns or rows are not
2493−supported. Grid tables can be created easily using [Emacs table mode].
2494−
2495−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
24963973
24973974Alignments can be specified as with pipe tables, by putting
24983975colons at the boundaries of the separator line after the
@@ -2520,7 +3997,7 @@ and the same number of rows in each column. For example, the
25203997Docutils [sample grid tables] will not render as expected with
25213998Pandoc.
25223999
2523−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
25244001
25254002
25264003#### Extension: `pipe_tables` ####
@@ -2553,10 +4030,15 @@ legal (though ugly) pipe table:
25534030
25544031The cells of pipe tables cannot contain block elements like paragraphs
25554032and lists, and cannot span multiple lines. If a pipe table contains a
2556−row whose printable content is wider than the column width (see
2557−`--columns`), then the cell contents will wrap, with the
2558−relative cell widths determined by the widths of the separator
2559−lines.
4033+row whose Markdown content is wider than the column width (see
4034+`--columns`), then the table will take up the full text width and
4035+the cell contents will wrap, with the relative cell widths determined
4036+by the number of dashes in the line separating the table header from
4037+the table body. (For example `---|-` would make the first column 3/4
4038+and the second column 1/4 of the full text width.)
4039+On the other hand, if no lines are wider than column width, then
4040+cell contents will not be wrapped, and the cells will be sized
4041+to their contents.
25604042
25614043Note: pandoc also recognizes pipe tables of the following
25624044form, as can be produced by Emacs' orgtbl-mode:
@@ -2572,8 +4054,7 @@ you'll need to add colons as above.
25724054
25734055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
25744056
2575−Metadata blocks
2576−---------------
4057+## Metadata blocks
25774058
25784059#### Extension: `pandoc_title_block` ####
25794060
@@ -2589,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
25894070or all three elements. If you want to include an author but no
25904071title, or a title and a date but no author, you need a blank line:
25914072
2592− %
2593− % Author
4073+```
4074+%
4075+% Author
4076+```
25944077
2595− % My title
2596− %
2597− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
25984083
25994084The title may occupy multiple lines, but continuation lines must
26004085begin with leading space, thus:
26014086
2602− % My title
2603− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
26044091
26054092If a document has multiple authors, the authors may be put on
26064093separate lines with leading space, or separated by semicolons, or
26074094both. So, all of the following are equivalent:
26084095
2609− % Author One
2610− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
26114100
2612− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
26134104
2614− % Author One;
2615− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
26164109
26174110The date must fit on one line.
26184111
@@ -2653,7 +4146,7 @@ will also have "Version 4.0" in the header.
26534146
26544147#### Extension: `yaml_metadata_block` ####
26554148
2656−A YAML metadata block is a valid YAML object, delimited by a line of three
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
26574150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
26584151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
26594152document, but if it is not at the beginning, it must be preceded by a blank
@@ -2664,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
26644157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
26654158
26664159Just be sure that the YAML file begins with `---` and ends with `---` or
2667−`...`.)
4160+`...`.) Alternatively, you can use the `--metadata-file` option. Using
4161+that approach however, you cannot reference content (like footnotes)
4162+from the main markdown input document.
26684163
26694164Metadata will be taken from the fields of the YAML object and added to any
26704165existing document metadata. Metadata can contain lists and objects (nested
26714166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
26724167with names ending in an underscore will be ignored by pandoc. (They may be
2673−given a role by external processors.)
4168+given a role by external processors.) Field names must not be
4169+interpretable as YAML numbers or boolean values (so, for
4170+example, `yes`, `True`, and `15` cannot be used as field names).
26744171
2675−A document may contain multiple metadata blocks. The metadata fields will
2676−be combined through a *left-biased union*: if two metadata blocks attempt
2677−to set the same field, the value from the first block will be taken.
4172+A document may contain multiple metadata blocks. If two
4173+metadata blocks attempt to set the same field, the value from
4174+the second block will be taken.
26784175
26794176When pandoc is used with `-t markdown` to create a Markdown document,
26804177a YAML metadata block will be produced only if the `-s/--standalone`
26814178option is used. All of the metadata will appear in a single block
26824179at the beginning of the document.
26834180
2684−Note that YAML escaping rules must be followed. Thus, for example,
2685−if a title contains a colon, it must be quoted. The pipe character
2686−(`|`) can be used to begin an indented block that will be interpreted
2687−literally, without need for escaping. This form is necessary
2688−when the field contains blank lines or block-level formatting:
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
4182+if a title contains a colon, it must be quoted, and if it contains a
4183+backslash escape, then it must be ensured that it is not treated as a
4184+[YAML escape sequence]. The pipe character (`|`) can be used to begin
4185+an indented block that will be interpreted literally, without need for
4186+escaping. This form is necessary when the field contains blank lines
4187+or block-level formatting:
26894188
26904189 ---
26914190 title: 'This is the title: it contains a colon'
26924191 author:
26934192 - Author One
26944193 - Author Two
2695− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
26964195 abstract: |
26974196 This is the abstract.
26984197
26994198 It consists of two paragraphs.
27004199 ...
27014200
4201+The literal block after the `|` must be indented relative to the
4202+line containing the `|`. If it is not, the YAML will be invalid
4203+and pandoc will not interpret it as metadata. For an overview
4204+of the complex rules governing YAML, see the [Wikipedia entry on
4205+YAML syntax].
4206+
27024207Template variables will be set automatically from the metadata. Thus, for
27034208example, in writing HTML, the variable `abstract` will be set to the HTML
27044209equivalent of the Markdown in the `abstract` field:
@@ -2732,9 +4237,38 @@ template:
27324237 $endif$
27334238 $endfor$
27344239
4240+Raw content to include in the document's header may be specified
4241+using `header-includes`; however, it is important to mark up
4242+this content as raw code for a particular output format, using
4243+the [`raw_attribute` extension](#extension-raw_attribute)), or it
4244+will be interpreted as markdown. For example:
4245+
4246+ header-includes:
4247+ - |
4248+ ```{=latex}
4249+ \let\oldsection\section
4250+ \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4251+ ```
4252+
4253+Note: the `yaml_metadata_block` extension works with
4254+`commonmark` as well as `markdown` (and it is enabled by default
4255+in `gfm` and `commonmark_x`). However, in these formats the
4256+following restrictions apply:
27354257
2736−Backslash escapes
2737−-----------------
4258+- The YAML metadata block must occur at the beginning of the
4259+ document (and there can be only one). If multiple files are
4260+ given as arguments to pandoc, only the first can be a YAML
4261+ metadata block.
4262+
4263+- The leaf nodes of the YAML structure are parsed in isolation from
4264+ each other and from the rest of the document. So, for
4265+ example, you can't use a reference link in these contexts
4266+ if the link definition is somewhere else in the document.
4267+
4268+[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
4269+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
4270+
4271+## Backslash escapes
27384272
27394273#### Extension: `all_symbols_escapable` ####
27404274
@@ -2760,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
27604294(However, if the `markdown_strict` format is used, the standard Markdown rule
27614295will be used.)
27624296
2763−A backslash-escaped space is parsed as a nonbreaking space. It will
2764−appear in TeX output as `~` and in HTML and XML as `\ ` or
2765−`\ `.
4297+A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4298+it will appear as `~`. In HTML and XML output, it will appear as a
4299+literal unicode nonbreaking space character (note that it will thus
4300+actually look "invisible" in the generated HTML source; you can still
4301+use the `--ascii` command-line option to make it appear as an explicit
4302+entity).
27664303
27674304A backslash-escaped newline (i.e. a backslash occurring at the end of
27684305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -2772,8 +4309,7 @@ two trailing spaces on a line.
27724309
27734310Backslash escapes do not work in verbatim contexts.
27744311
2775−Inline formatting
2776−-----------------
4312+## Inline formatting
27774313
27784314### Emphasis ###
27794315
@@ -2821,12 +4357,13 @@ text by `~` characters. Thus, for example,
28214357
28224358 H~2~O is a liquid. 2^10^ is 1024.
28234359
2824−If the superscripted or subscripted text contains spaces, these spaces
2825−must be escaped with backslashes. (This is to prevent accidental
2826−superscripting and subscripting through the ordinary use of `~` and `^`.)
2827−Thus, if you want the letter P with 'a cat' in subscripts, use
2828−`P~a\ cat~`, not `P~a cat~`.
2829−
4360+The text between `^...^` or `~...~` may not contain spaces or
4361+newlines. If the superscripted or subscripted text contains
4362+spaces, these spaces must be escaped with backslashes. (This is
4363+to prevent accidental superscripting and subscripting through
4364+the ordinary use of `~` and `^`, and also bad interactions with
4365+footnotes.) Thus, if you want the letter P with 'a cat' in
4366+subscripts, use `P~a\ cat~`, not `P~a cat~`.
28304367
28314368### Verbatim ###
28324369
@@ -2860,19 +4397,22 @@ Attributes can be attached to verbatim text, just as with
28604397
28614398### Small caps ###
28624399
2863−To write small caps, you can use an HTML span tag:
4400+To write small caps, use the `smallcaps` class:
28644401
2865− <span style="font-variant:small-caps;">Small caps</span>
4402+ [Small caps]{.smallcaps}
4403+
4404+Or, without the `bracketed_spans` extension:
4405+
4406+ <span class="smallcaps">Small caps</span>
4407+
4408+For compatibility with other Markdown flavors, CSS is also supported:
28664409
2867−(The semicolon is optional and there may be space after the
2868−colon.) This will work in all output formats that support small caps.
4410+ <span style="font-variant:small-caps;">Small caps</span>
28694411
2870−Alternatively, you can also use the new `bracketed_spans` syntax:
4412+This will work in all output formats that support small caps.
28714413
2872− [Small caps]{style="font-variant:small-caps;"}
28734414
2874−Math
2875−----
4415+## Math
28764416
28774417#### Extension: `tex_math_dollars` ####
28784418
@@ -2884,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
28844424you need to enclose text in literal `$` characters, backslash-escape
28854425them and they won't be treated as math delimiters.
28864426
4427+For display math, use `$$` delimiters. (In this case, the delimiters
4428+may be separated from the formula by whitespace. However, there can be
4429+no blank lines betwen the opening and closing `$$` delimiters.)
4430+
28874431TeX math will be printed in all output formats. How it is rendered
28884432depends on the output format:
28894433
2890−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2891− ~ It will appear verbatim between `$` characters.
4434+LaTeX
4435+ ~ It will appear verbatim surrounded by `\(...\)` (for inline
4436+ math) or `\[...\]` (for display math).
4437+
4438+Markdown, Emacs Org mode, ConTeXt, ZimWiki
4439+ ~ It will appear verbatim surrounded by `$...$` (for inline
4440+ math) or `$$...$$` (for display math).
4441+
4442+XWiki
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
28924444
28934445reStructuredText
28944446 ~ It will be rendered using an [interpreted text role `:math:`].
28954447
28964448AsciiDoc
2897− ~ It will be rendered as `latexmath:[...]`.
4449+ ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4450+ surrounded by `latexmath:[$...$]` (for inline math) or
4451+ `[latexmath]++++\[...\]+++` (for display math).
4452+ For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4453+ (`$..$` and `\[..\]`) are omitted.
28984454
28994455Texinfo
29004456 ~ It will be rendered inside a `@math` command.
29014457
2902−groff man
4458+roff man, Jira markup
29034459 ~ It will be rendered verbatim without `$`'s.
29044460
29054461MediaWiki, DokuWiki
@@ -2930,58 +4486,12 @@ FictionBook2
29304486
29314487HTML, Slidy, DZSlides, S5, EPUB
29324488 ~ The way math is rendered in HTML will depend on the
2933− command-line options selected:
2934−
2935− 1. The default is to render TeX math as far as possible using Unicode
2936− characters, as with RTF, DocBook, and OpenDocument output. Formulas
2937− are put inside a `span` with `class="math"`, so that they may be
2938− styled differently from the surrounding text if needed.
2939−
2940− 2. If the `--latexmathml` option is used, TeX math will be displayed
2941− between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2942− The [LaTeXMathML] script will be used to render it as formulas.
2943− (This trick does not work in all browsers, but it works in Firefox.
2944− In browsers that do not support LaTeXMathML, TeX math will appear
2945− verbatim between `$` characters.)
2946−
2947− 3. If the `--jsmath` option is used, TeX math will be put inside
2948− `<span>` tags (for inline math) or `<div>` tags (for display math)
2949− with class `math`. The [jsMath] script will be used to render
2950− it.
2951−
2952− 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2953− be called to generate images for each TeX formula. This should
2954− work in all browsers. The `--mimetex` option takes an optional URL
2955− as argument. If no URL is specified, it will be assumed that the
2956− mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2957−
2958− 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2959− in `<eq>` tags in the HTML output. The resulting `htex` file may then
2960− be processed by [gladTeX], which will produce image files for each
2961− formula and an HTML file with links to these images. So, the
2962− procedure is:
2963−
2964− pandoc -s --gladtex myfile.txt -o myfile.htex
2965− gladtex -d myfile-images myfile.htex
2966− # produces myfile.html and images in myfile-images
2967−
2968− 6. If the `--webtex` option is used, TeX formulas will be converted
2969− to `<img>` tags that link to an external script that converts
2970− formulas to images. The formula will be URL-encoded and concatenated
2971− with the URL provided. For SVG images you can for example use
2972− `--webtex https://latex.codecogs.com/svg.latex?`.
2973− If no URL is specified, the CodeCogs URL generating PNGs
2974− will be used (`https://latex.codecogs.com/png.latex?`).
2975−
2976− 7. If the `--mathjax` option is used, TeX math will be displayed
2977− between `\(...\)` (for inline math) or `\[...\]` (for display
2978− math) and put in `<span>` tags with class `math`.
2979− The [MathJax] script will be used to render it as formulas.
2980−
2981−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
2982−
2983−Raw HTML
2984−--------
4489+ command-line options selected. Therefore see [Math rendering in HTML]
4490+ above.
4491+
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4493+
4494+## Raw HTML
29854495
29864496#### Extension: `raw_html` ####
29874497
@@ -2992,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
29924502be disabled if desired.)
29934503
29944504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
2995−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
2996−in other formats.
4505+DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4506+output, and suppressed in other formats.
4507+
4508+For a more explicit way of including raw HTML in a Markdown
4509+document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4510+
4511+In the CommonMark format, if `raw_html` is enabled, superscripts,
4512+subscripts, strikeouts and small capitals will be represented as HTML.
4513+Otherwise, plain-text fallbacks will be used. Note that even if
4514+`raw_html` is disabled, tables will be rendered with HTML syntax if
4515+they cannot use pipe syntax.
29974516
29984517#### Extension: `markdown_in_html_blocks` ####
29994518
@@ -3010,7 +4529,7 @@ Thus, for example, pandoc will turn
30104529 <table>
30114530 <tr>
30124531 <td>*one*</td>
3013− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
30144533 </tr>
30154534 </table>
30164535
@@ -3019,14 +4538,14 @@ into
30194538 <table>
30204539 <tr>
30214540 <td><em>one</em></td>
3022− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
30234542 </tr>
30244543 </table>
30254544
30264545whereas `Markdown.pl` will preserve it as is.
30274546
3028−There is one exception to this rule: text between `<script>` and
3029−`<style>` tags is not interpreted as Markdown.
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
30304549
30314550This departure from standard Markdown should make it easier to mix
30324551Markdown with HTML block elements. For example, one can surround
@@ -3068,6 +4587,10 @@ Note that in LaTeX environments, like
30684587the material between the begin and end tags will be interpreted as raw
30694588LaTeX, not as Markdown.
30704589
4590+For a more explicit and flexible way of including raw TeX in a
4591+Markdown document, see the [`raw_attribute`
4592+extension][Extension: `raw_attribute`].
4593+
30714594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
30724595Emacs Org mode, and ConTeXt.
30734596
@@ -3078,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
30784601Inline spans and fenced code blocks with a special
30794602kind of attribute will be parsed as raw content with the
30804603designated format. For example, the following produces a raw
3081−groff `ms` block:
4604+roff `ms` block:
30824605
30834606 ```{=ms}
30844607 .MYMACRO
@@ -3088,9 +4611,24 @@ And the following produces a raw `html` inline element:
30884611
30894612 This is `<a>html</a>`{=html}
30904613
4614+This can be useful to insert raw xml into `docx` documents, e.g.
4615+a pagebreak:
4616+
4617+ ```{=openxml}
4618+ <w:p>
4619+ <w:r>
4620+ <w:br w:type="page"/>
4621+ </w:r>
4622+ </w:p>
4623+ ```
4624+
30914625The format name should match the target format name (see
30924626`-t/--to`, above, for a list, or use `pandoc
3093−--list-output-formats`).
4627+--list-output-formats`). Use `openxml` for `docx` output,
4628+`opendocument` for `odt` output, `html5` for `epub3` output,
4629+`html4` for `epub2` output, and `latex`, `beamer`,
4630+`ms`, or `html5` for `pdf` output (depending on what you
4631+use for `--pdf-engine`).
30944632
30954633This extension presupposes that the relevant kind of
30964634inline code or fenced code block is enabled. Thus, for
@@ -3099,26 +4637,34 @@ example, to use a raw attribute with a backtick code block,
30994637
31004638The raw attribute cannot be combined with regular attributes.
31014639
3102−LaTeX macros
3103−------------
4640+## LaTeX macros
31044641
31054642#### Extension: `latex_macros` ####
31064643
3107−For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
3108−`\renewcommand` definitions and apply the resulting macros to all LaTeX
3109−math. So, for example, the following will work in all output formats,
3110−not just LaTeX:
4644+When this extension is enabled, pandoc will parse LaTeX
4645+macro definitions and apply the resulting macros to all LaTeX
4646+math and raw LaTeX. So, for example, the following will work in
4647+all output formats, not just LaTeX:
31114648
31124649 \newcommand{\tuple}[1]{\langle #1 \rangle}
31134650
31144651 $\tuple{a, b, c}$
31154652
3116−In LaTeX output, the `\newcommand` definition will simply be passed
3117−unchanged to the output.
4653+Note that LaTeX macros will not be applied if they occur
4654+inside a raw span or block marked with the
4655+[`raw_attribute` extension](#extension-raw_attribute).
31184656
4657+When `latex_macros` is disabled, the raw LaTeX and math will
4658+not have macros applied. This is usually a better approach when
4659+you are targeting LaTeX or PDF.
31194660
3120−Links
3121−-----
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
4665+enabled.
4666+
4667+## Links
31224668
31234669Markdown allows links to be specified in several ways.
31244670
@@ -3127,7 +4673,7 @@ Markdown allows links to be specified in several ways.
31274673If you enclose a URL or email address in pointy brackets, it
31284674will become a link:
31294675
3130− <http://google.com>
4676+ <https://google.com>
31314677 <sam@green.eggs.ham>
31324678
31334679### Inline links ###
@@ -3137,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
31374683be followed by a link title, in quotes.)
31384684
31394685 This is an [inline link](/url), and here's [one with
3140− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
31414687
31424688There can be no space between the bracketed part and the parenthesized part.
31434689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3166,7 +4712,7 @@ Here are some examples:
31664712
31674713 [my label 1]: /foo/bar.html "My title, optional"
31684714 [my label 2]: /foo
3169− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
31704716 [my label 4]: /bar#special 'A title in single quotes'
31714717
31724718The URL may optionally be surrounded by angle brackets:
@@ -3175,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
31754721
31764722The title may go on the next line:
31774723
3178− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
31794725 "The free software foundation"
31804726
31814727Note that link labels are not case sensitive. So, this will work:
@@ -3197,235 +4743,614 @@ such as list items or block quotes. Pandoc lifts this arbitrary
31974743seeming restriction. So the following is fine in pandoc, though
31984744not in most other implementations:
31994745
3200− > My block [quote].
3201− >
3202− > [quote]: /foo
4746+ > My block [quote].
4747+ >
4748+ > [quote]: /foo
4749+
4750+#### Extension: `shortcut_reference_links` ####
4751+
4752+In a *shortcut* reference link, the second pair of brackets may
4753+be omitted entirely:
4754+
4755+ See [my website].
4756+
4757+ [my website]: http://foo.bar.baz
4758+
4759+### Internal links ###
4760+
4761+To link to another section of the same document, use the automatically
4762+generated identifier (see [Heading identifiers]). For example:
4763+
4764+ See the [Introduction](#introduction).
4765+
4766+or
4767+
4768+ See the [Introduction].
4769+
4770+ [Introduction]: #introduction
4771+
4772+Internal links are currently supported for HTML formats (including
4773+HTML slide shows and EPUB), LaTeX, and ConTeXt.
4774+
4775+## Images
4776+
4777+A link immediately preceded by a `!` will be treated as an image.
4778+The link text will be used as the image's alt text:
4779+
4780+ 
4781+
4782+ ![movie reel]
4783+
4784+ [movie reel]: movie.gif
4785+
4786+#### Extension: `implicit_figures` ####
4787+
4788+An image with nonempty alt text, occurring by itself in a
4789+paragraph, will be rendered as a figure with a caption. The
4790+image's alt text will be used as the caption.
4791+
4792+ 
4793+
4794+How this is rendered depends on the output format. Some output
4795+formats (e.g. RTF) do not yet support figures. In those
4796+formats, you'll just get an image in a paragraph by itself, with
4797+no caption.
4798+
4799+If you just want a regular inline image, just make sure it is not
4800+the only thing in the paragraph. One way to do this is to insert a
4801+nonbreaking space after the image:
4802+
4803+ \
4804+
4805+Note that in reveal.js slide shows, an image in a paragraph
4806+by itself that has the `stretch` class will fill the screen,
4807+and the caption and figure tags will be omitted.
4808+
4809+#### Extension: `link_attributes` ####
4810+
4811+Attributes can be set on links and images:
4812+
4813+ An inline {#id .class width=30 height=20px}
4814+ and a reference ![image][ref] with attributes.
4815+
4816+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4817+
4818+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819+and `.class` are used.)
4820+
4821+For HTML and EPUB, all known HTML5 attributes except `width` and
4822+`height` (but including `srcset` and `sizes`) are passed through
4823+as is. Unknown attributes are passed through as custom
4824+attributes, with `data-` prepended. The other writers ignore
4825+attributes that are not specifically supported by their output format.
4826+
4827+The `width` and `height` attributes on images are treated specially. When
4828+used without a unit, the unit is assumed to be pixels. However, any of
4829+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4830+and `%`. There must not be any spaces between the number and the unit.
4831+For example:
4832+
4833+```
4834+{ width=50% }
4835+```
4836+
4837+- Dimensions may be converted to a form that is compatible with
4838+ the output format (for example, dimensions given in pixels will
4839+ be converted to inches when converting HTML to LaTeX). Conversion
4840+ between pixels and physical measurements is affected by the
4841+ `--dpi` option (by default, 96 dpi is assumed, unless the image
4842+ itself contains dpi information).
4843+- The `%` unit is generally relative to some available space.
4844+ For example the above example will render to the following.
4845+ - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846+ - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847+ (If you're using a custom template, you need to configure `graphicx`
4848+ as in the default template.)
4849+ - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4850+- Some output formats have a notion of a class
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4852+ or a unique identifier (LaTeX `\caption`), or both (HTML).
4853+- When no `width` or `height` attributes are specified, the fallback
4854+ is to look at the image resolution and the dpi metadata embedded in
4855+ the image file.
4856+
4857+## Divs and Spans
4858+
4859+Using the `native_divs` and `native_spans` extensions
4860+(see [above][Extension: `native_divs`]), HTML syntax can
4861+be used as part of markdown to create native `Div` and `Span`
4862+elements in the pandoc AST (as opposed to raw HTML).
4863+However, there is also nicer syntax available:
4864+
4865+#### Extension: `fenced_divs` ####
4866+
4867+Allow special fenced syntax for native `Div` blocks. A Div
4868+starts with a fence containing at least three consecutive
4869+colons plus some attributes. The attributes may optionally
4870+be followed by another string of consecutive colons.
4871+The attribute syntax is exactly as in fenced code blocks (see
4872+[Extension: `fenced_code_attributes`]). As with fenced
4873+code blocks, one can use either attributes in curly braces
4874+or a single unbraced word, which will be treated as a class
4875+name. The Div ends with another line containing a string of at
4876+least three consecutive colons. The fenced Div should be
4877+separated by blank lines from preceding and following blocks.
4878+
4879+Example:
4880+
4881+ ::::: {#special .sidebar}
4882+ Here is a paragraph.
4883+
4884+ And another.
4885+ :::::
4886+
4887+Fenced divs can be nested. Opening fences are distinguished
4888+because they *must* have attributes:
4889+
4890+ ::: Warning ::::::
4891+ This is a warning.
4892+
4893+ ::: Danger
4894+ This is a warning within a warning.
4895+ :::
4896+ ::::::::::::::::::
4897+
4898+Fences without attributes are always closing fences. Unlike
4899+with fenced code blocks, the number of colons in the closing
4900+fence need not match the number in the opening fence. However,
4901+it can be helpful for visual clarity to use fences of different
4902+lengths to distinguish nested divs from their parents.
4903+
4904+
4905+#### Extension: `bracketed_spans` ####
4906+
4907+A bracketed sequence of inlines, as one would use to begin
4908+a link, will be treated as a `Span` with attributes if it is
4909+followed immediately by attributes:
4910+
4911+ [This is *some text*]{.class key="val"}
4912+
4913+## Footnotes
4914+
4915+#### Extension: `footnotes` ####
4916+
4917+Pandoc's Markdown allows footnotes, using the following syntax:
4918+
4919+ Here is a footnote reference,[^1] and another.[^longnote]
4920+
4921+ [^1]: Here is the footnote.
4922+
4923+ [^longnote]: Here's one with multiple blocks.
4924+
4925+ Subsequent paragraphs are indented to show that they
4926+ belong to the previous footnote.
4927+
4928+ { some.code }
4929+
4930+ The whole paragraph can be indented, or just the first
4931+ line. In this way, multi-paragraph footnotes work like
4932+ multi-paragraph list items.
4933+
4934+ This paragraph won't be part of the note, because it
4935+ isn't indented.
4936+
4937+The identifiers in footnote references may not contain spaces, tabs,
4938+or newlines. These identifiers are used only to correlate the
4939+footnote reference with the note itself; in the output, footnotes
4940+will be numbered sequentially.
4941+
4942+The footnotes themselves need not be placed at the end of the
4943+document. They may appear anywhere except inside other block elements
4944+(lists, block quotes, tables, etc.). Each footnote should be
4945+separated from surrounding content (including other footnotes)
4946+by blank lines.
4947+
4948+#### Extension: `inline_notes` ####
4949+
4950+Inline footnotes are also allowed (though, unlike regular notes,
4951+they cannot contain multiple paragraphs). The syntax is as follows:
4952+
4953+ Here is an inline note.^[Inlines notes are easier to write, since
4954+ you don't have to pick an identifier and move down to type the
4955+ note.]
4956+
4957+Inline and regular footnotes may be mixed freely.
4958+
4959+## Citation syntax
4960+
4961+#### Extension: `citations` ####
4962+
4963+To cite a bibliographic item with an identifier foo, use the
4964+syntax `@foo`. Normal citations should be included in square
4965+brackets, with semicolons separating distinct items:
4966+
4967+ Blah blah [@doe99; @smith2000; @smith2004].
4968+
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
4971+
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
4973+
4974+In a footnote style, it might render as
4975+
4976+ Blah blah.[^1]
4977+
4978+ [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4979+ Susan Smith, "Flies," *Journal of Insects* (2000);
4980+ Susan Smith, "Bees," *Journal of Insects* (2004).
4981+
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
4984+
4985+Unless a citation key start with a letter, digit, or `_`,
4986+and contains only alphanumerics and internal punctuation
4987+characters (`:.#$%&-+?<>~/`), it must be surrounded
4988+by curly braces, which are not considered part of the key.
4989+In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final
4990+period is not *internal* punctuation, so it is not included in
4991+the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including
4992+the final period. The curly braces are recommended if you use URLs as
4993+keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.
4994+
4995+Citation items may optionally include a prefix, a locator, and
4996+a suffix. In
4997+
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4999+
5000+The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
5001+and suffix `and *passim*`. The second item (`smith04`) has
5002+locator `chap. 1` and no prefix or suffix.
5003+
5004+Pandoc uses some heuristics to separate the locator from the
5005+rest of the subject. It is sensitive to the locator terms
5006+defined in the [CSL locale files]. Either abbreviated or
5007+unabbreviated forms are accepted. In the `en-US` locale, locator
5008+terms can be written in either singular or plural forms, as
5009+`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5010+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
5011+`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012+`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
5013+`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
5014+`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
5015+`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5016+locator term is used, "page" is assumed.
5017+
5018+In complex cases, you can force something to be treated as
5019+a locator by enclosing it in curly braces or prevent parsing
5020+the suffix as locator by prepending curly braces:
5021+
5022+ [@smith{ii, A, D-Z}, with a suffix]
5023+ [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
5025+
5026+A minus sign (`-`) before the `@` will suppress mention of
5027+the author in the citation. This can be useful when the
5028+author is already mentioned in the text:
5029+
5030+ Smith says blah [-@smith04].
5031+
5032+You can also write an author-in-text citation, by omitting the
5033+square brackets:
5034+
5035+ @smith04 says blah.
5036+
5037+ @smith04 [p. 33] says blah.
5038+
5039+This will cause the author's name to be rendered, followed by
5040+the bibliographical details. Use this form when you want to
5041+make the citation the subject of a sentence.
5042+
5043+When you are using a note style, it is usually better to let
5044+citeproc create the footnotes from citations rather than writing
5045+an explicit note. If you do write an explicit note that
5046+contains a citation, note that normal citations will be put in
5047+parentheses, while author-in-text citations will not. For
5048+this reason, it is sometimes preferable to use the
5049+author-in-text style inside notes when using a note style.
5050+
5051+[CSL user documentation]: https://citationstyles.org/authors/
5052+[CSL]: https://docs.citationstyles.org/en/stable/specification.html
5053+[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5054+[Chicago Manual of Style]: https://chicagomanualofstyle.org
5055+[Citation Style Language]: https://citationstyles.org
5056+[Zotero Style Repository]: https://www.zotero.org/styles
5057+[finding and editing styles]: https://citationstyles.org/authors/
5058+[CSL locale files]: https://github.com/citation-style-language/locales
5059+
5060+## Non-default extensions
5061+
5062+The following Markdown syntax extensions are not enabled by default
5063+in pandoc, but may be enabled by adding `+EXTENSION` to the format
5064+name, where `EXTENSION` is the name of the extension. Thus, for
5065+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5066+
5067+#### Extension: `rebase_relative_paths` ####
5068+
5069+Rewrite relative paths for Markdown links and images, depending
5070+on the path of the file containing the link or image link. For
5071+each link or image, pandoc will compute the directory of the
5072+containing file, relative to the working directory, and prepend
5073+the resulting path to the link or image path.
5074+
5075+The use of this extension is best understood by example.
5076+Suppose you have a a subdirectory for each chapter of a book,
5077+`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a
5078+number of images used in the chapter. You would like to have
5079+`` in `chap1/text.md` refer to
5080+`chap1/spider.jpg` and `` in `chap2/text.md`
5081+refer to `chap2/spider.jpg`. To do this, use
5082+
5083+ pandoc chap*/*.md -f markdown+rebase_relative_paths
5084+
5085+Without this extension, you would have to use
5086+`` in `chap1/text.md` and
5087+`` in `chap2/text.md`. Links with
5088+relative paths will be rewritten in the same way as images.
5089+
5090+Absolute paths and URLs are not changed. Neither are empty
5091+paths or paths consisting entirely of a fragment, e.g., `#foo`.
5092+
5093+Note that relative paths in reference links and images will
5094+be rewritten relative to the file containing the link
5095+reference definition, not the file containing the reference link
5096+or image itself, if these differ.
5097+
5098+#### Extension: `attributes` ####
5099+
5100+Allows attributes to be attached to any inline or block-level
5101+element. The syntax for the attributes is the same as that
5102+used in [`header_attributes`][Extension: `header_attributes`].
5103+
5104+- Attributes that occur immediately after an inline
5105+ element affect that element. If they follow a space, then they
5106+ belong to the space. (Hence, this option subsumes
5107+ `inline_code_attributes` and `link_attributes`.)
5108+- Attributes that occur immediately before a block
5109+ element, on a line by themselves, affect that
5110+ element.
5111+- Consecutive attribute specifiers may be used,
5112+ either for blocks or for inlines. Their attributes
5113+ will be combined.
5114+- Attributes that occur at the end of the text of
5115+ a Setext or ATX heading (separated by whitespace
5116+ from the text) affect the heading element. (Hence, this
5117+ option subsumes `header_attributes`.)
5118+- Attributes that occur after the opening fence
5119+ in a fenced code block affect the code block element. (Hence,
5120+ this option subsumes `fenced_code_attributes`.)
5121+- Attributes that occur at the end of a reference
5122+ link definition affect links that refer to that
5123+ definition.
5124+
5125+Note that pandoc's AST does not currently allow attributes
5126+to be attached to arbitrary elements. Hence a Span or Div
5127+container will be added if needed.
5128+
5129+#### Extension: `old_dashes` ####
5130+
5131+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5132+`-` before a numeral is an en-dash, and `--` is an em-dash.
5133+This option only has an effect if `smart` is enabled. It is
5134+selected automatically for `textile` input.
5135+
5136+#### Extension: `angle_brackets_escapable` ####
5137+
5138+Allow `<` and `>` to be backslash-escaped, as they can be in
5139+GitHub flavored Markdown but not original Markdown. This is
5140+implied by pandoc's default `all_symbols_escapable`.
32035141
3204−#### Extension: `shortcut_reference_links` ####
5142+#### Extension: `lists_without_preceding_blankline` ####
32055143
3206−In a *shortcut* reference link, the second pair of brackets may
3207−be omitted entirely:
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
32085146
3209− See [my website].
5147+#### Extension: `four_space_rule` ####
32105148
3211− [my website]: http://foo.bar.baz
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
32125152
3213−### Internal links ###
5153+#### Extension: `spaced_reference_links` ####
32145154
3215−To link to another section of the same document, use the automatically
3216−generated identifier (see [Header identifiers]). For example:
5155+Allow whitespace between the two components of a reference link,
5156+for example,
32175157
3218− See the [Introduction](#introduction).
5158+ [foo] [bar].
32195159
3220−or
5160+#### Extension: `hard_line_breaks` ####
32215161
3222− See the [Introduction].
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
32235164
3224− [Introduction]: #introduction
5165+#### Extension: `ignore_line_breaks` ####
32255166
3226−Internal links are currently supported for HTML formats (including
3227−HTML slide shows and EPUB), LaTeX, and ConTeXt.
5167+Causes newlines within a paragraph to be ignored, rather than being
5168+treated as spaces or as hard line breaks. This option is intended for
5169+use with East Asian languages where spaces are not used between words,
5170+but text is divided into lines for readability.
32285171
3229−Images
3230−------
5172+#### Extension: `east_asian_line_breaks` ####
32315173
3232−A link immediately preceded by a `!` will be treated as an image.
3233−The link text will be used as the image's alt text:
5174+Causes newlines within a paragraph to be ignored, rather than
5175+being treated as spaces or as hard line breaks, when they occur
5176+between two East Asian wide characters. This is a better choice
5177+than `ignore_line_breaks` for texts that include a mix of East
5178+Asian wide characters and other characters.
32345179
3235− 
5180+#### Extension: `emoji` ####
32365181
3237− ![movie reel]
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
32385183
3239− [movie reel]: movie.gif
5184+#### Extension: `tex_math_single_backslash` ####
32405185
3241−#### Extension: `implicit_figures` ####
5186+Causes anything between `\(` and `\)` to be interpreted as inline
5187+TeX math, and anything between `\[` and `\]` to be interpreted
5188+as display TeX math. Note: a drawback of this extension is that
5189+it precludes escaping `(` and `[`.
32425190
3243−An image with nonempty alt text, occurring by itself in a
3244−paragraph, will be rendered as a figure with a caption. The
3245−image's alt text will be used as the caption.
5191+#### Extension: `tex_math_double_backslash` ####
32465192
3247− 
5193+Causes anything between `\\(` and `\\)` to be interpreted as inline
5194+TeX math, and anything between `\\[` and `\\]` to be interpreted
5195+as display TeX math.
32485196
3249−How this is rendered depends on the output format. Some output
3250−formats (e.g. RTF) do not yet support figures. In those
3251−formats, you'll just get an image in a paragraph by itself, with
3252−no caption.
5197+#### Extension: `markdown_attribute` ####
32535198
3254−If you just want a regular inline image, just make sure it is not
3255−the only thing in the paragraph. One way to do this is to insert a
3256−nonbreaking space after the image:
5199+By default, pandoc interprets material inside block-level tags as Markdown.
5200+This extension changes the behavior so that Markdown is only parsed
5201+inside block-level tags if the tags have the attribute `markdown=1`.
32575202
3258− \
5203+#### Extension: `mmd_title_block` ####
32595204
3260−Note that in reveal.js slide shows, an image in a paragraph
3261−by itself that has the `stretch` class will fill the screen,
3262−and the caption and figure tags will be omitted.
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
32635207
3264−#### Extension: `link_attributes` ####
5208+ Title: My title
5209+ Author: John Doe
5210+ Date: September 1, 2008
5211+ Comment: This is a sample mmd title block, with
5212+ a field spanning multiple lines.
32655213
3266−Attributes can be set on links and images:
5214+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5215+`yaml_metadata_block` is enabled, it will take precedence over
5216+`mmd_title_block`.
32675217
3268− An inline {#id .class width=30 height=20px}
3269− and a reference ![image][ref] with attributes.
5218+#### Extension: `abbreviations` ####
32705219
3271− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5220+Parses PHP Markdown Extra abbreviation keys, like
32725221
3273−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3274−and `.class` are used.)
5222+ *[HTML]: Hypertext Markup Language
32755223
3276−For HTML and EPUB, all attributes except `width` and `height` (but
3277−including `srcset` and `sizes`) are passed through as is. The other
3278−writers ignore attributes that are not supported by their output
3279−format.
5224+Note that the pandoc document model does not support
5225+abbreviations, so if this extension is enabled, abbreviation keys are
5226+simply skipped (as opposed to being parsed as paragraphs).
32805227
3281−The `width` and `height` attributes on images are treated specially. When
3282−used without a unit, the unit is assumed to be pixels. However, any of
3283−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3284−and `%`. There must not be any spaces between the number and the unit.
3285−For example:
5228+#### Extension: `autolink_bare_uris` ####
32865229
3287−```
3288−{ width=50% }
3289−```
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
32905232
3291−- Dimensions are converted to inches for output in page-based formats like
3292− LaTeX. Dimensions are converted to pixels for output in HTML-like
3293− formats. Use the `--dpi` option to specify the number of pixels per
3294− inch. The default is 96dpi.
3295−- The `%` unit is generally relative to some available space.
3296− For example the above example will render to
3297− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3298− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3299− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3300−- Some output formats have a notion of a class
3301− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3302− or a unique identifier (LaTeX `\caption`), or both (HTML).
3303−- When no `width` or `height` attributes are specified, the fallback
3304− is to look at the image resolution and the dpi metadata embedded in
3305− the image file.
5233+#### Extension: `mmd_link_attributes` ####
33065234
3307−Spans
3308−-----
5235+Parses multimarkdown style key-value attributes on link
5236+and image references. This extension should not be confused with the
5237+[`link_attributes`](#extension-link_attributes) extension.
33095238
3310−#### Extension: `bracketed_spans` ####
5239+ This is a reference ![image][ref] with multimarkdown attributes.
33115240
3312−A bracketed sequence of inlines, as one would use to begin
3313−a link, will be treated as a span with attributes if it is
3314−followed immediately by attributes:
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
33155243
3316− [This is *some text*]{.class key="val"}
5244+#### Extension: `mmd_header_identifiers` ####
33175245
3318−Footnotes
3319−---------
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
33205248
3321−#### Extension: `footnotes` ####
5249+#### Extension: `compact_definition_lists` ####
33225250
3323−Pandoc's Markdown allows footnotes, using the following syntax:
5251+Activates the definition list syntax of pandoc 1.12.x and earlier.
5252+This syntax differs from the one described above under [Definition lists]
5253+in several respects:
33245254
3325− Here is a footnote reference,[^1] and another.[^longnote]
5255+ - No blank line is required between consecutive items of the
5256+ definition list.
5257+ - To get a "tight" or "compact" list, omit space between consecutive
5258+ items; the space between a term and its definition does not affect
5259+ anything.
5260+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261+ be indented four spaces.[^6]
33265262
3327− [^1]: Here is the footnote.
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
33285265
3329− [^longnote]: Here's one with multiple blocks.
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
33305270
3331− Subsequent paragraphs are indented to show that they
3332− belong to the previous footnote.
5271+ Is this a single list item with two definitions of "bar," the first of
5272+ which is lazily wrapped, or two list items? To remove the ambiguity
5273+ we must either disallow lazy wrapping or require a blank line between
5274+ list items.
33335275
3334− { some.code }
5276+#### Extension: `gutenberg` ####
33355277
3336− The whole paragraph can be indented, or just the first
3337− line. In this way, multi-paragraph footnotes work like
3338− multi-paragraph list items.
5278+Use [Project Gutenberg] conventions for `plain` output:
5279+all-caps for strong emphasis, surround by underscores
5280+for regular emphasis, add extra blank space around headings.
33395281
3340− This paragraph won't be part of the note, because it
3341− isn't indented.
5282+ [Project Gutenberg]: https://www.gutenberg.org
33425283
3343−The identifiers in footnote references may not contain spaces, tabs,
3344−or newlines. These identifiers are used only to correlate the
3345−footnote reference with the note itself; in the output, footnotes
3346−will be numbered sequentially.
5284+#### Extension: `sourcepos` ####
33475285
3348−The footnotes themselves need not be placed at the end of the
3349−document. They may appear anywhere except inside other block elements
3350−(lists, block quotes, tables, etc.). Each footnote should be
3351−separated from surrounding content (including other footnotes)
3352−by blank lines.
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
33535290
3354−#### Extension: `inline_notes` ####
5291+## Markdown variants
33555292
3356−Inline footnotes are also allowed (though, unlike regular notes,
3357−they cannot contain multiple paragraphs). The syntax is as follows:
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
33585295
3359− Here is an inline note.^[Inlines notes are easier to write, since
3360− you don't have to pick an identifier and move down to type the
3361− note.]
5296+- `markdown_phpextra` (PHP Markdown Extra)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
33625303
3363−Inline and regular footnotes may be mixed freely.
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
33645306
3365−Typography
3366−----------
5307+ pandoc --list-extensions=FORMAT
33675308
3368−#### Extension: `smart` ####
5309+where `FORMAT` is replaced with the name of the format.
33695310
3370−Interpret straight quotes as curly quotes, `---` as em-dashes,
3371−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3372−inserted after certain abbreviations, such as "Mr." This
3373−option currently affects the input formats `markdown`,
3374−`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3375−and the output formats `markdown`, `latex`, and `context`.
5311+Note that the list of extensions for `commonmark`,
5312+`gfm`, and `commonmark_x` are defined relative to default
5313+commonmark. So, for example, `backtick_code_blocks`
5314+does not appear as an extension, since it is enabled by
5315+default and cannot be disabled.
33765316
3377−Note: If you are *writing* Markdown, then the `smart` extension
3378−has the reverse effect: what would have been curly quotes comes
3379−out straight.
5317+# Citations
33805318
3381−In LaTeX, `smart` means to use the standard TeX ligatures
3382−for quotation marks (` `` ` and ` '' ` for double quotes,
3383−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3384−en-dash and `---` for em-dash). If `smart` is disabled,
3385−then in reading LaTeX pandoc will parse these characters
3386−literally. In writing LaTeX, enabling `smart` tells pandoc
3387−to use the ligatures when possible; if `smart` is disabled
3388−pandoc will use unicode quotation mark and dash characters.
5319+When the `--citeproc` option is used, pandoc can automatically generate
5320+citations and a bibliography in a number of styles. Basic usage is
33895321
3390−Citations
3391−---------
5322+ pandoc --citeproc myinput.txt
33925323
3393−#### Extension: `citations` ####
5324+To use this feature, you will need to have
33945325
3395−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3396−citations and a bibliography in a number of styles. Basic usage is
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
33975330
3398− pandoc --filter pandoc-citeproc myinput.txt
5331+## Specifying bibliographic data
33995332
3400−In order to use this feature, you will need to specify a bibliography file
3401−using the `bibliography` metadata field in a YAML metadata section, or
3402−`--bibliography` command line argument. You can supply multiple `--bibliography`
3403−arguments or set `bibliography` metadata field to YAML array, if you want to
3404−use multiple bibliography files. The bibliography may have any of these
3405−formats:
5333+You can specify an external bibliography using the
5334+`bibliography` metadata field in a YAML metadata section or the
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
5337+`--bibliography` arguments or set `bibliography` metadata field
5338+to YAML array. A bibliography may have any of these formats:
34065339
34075340 Format File extension
34085341 ------------ --------------
34095342 BibLaTeX .bib
34105343 BibTeX .bibtex
3411− Copac .copac
34125344 CSL JSON .json
34135345 CSL YAML .yaml
3414− EndNote .enl
3415− EndNote XML .xml
3416− ISI .wos
3417− MEDLINE .medline
3418− MODS .mods
3419− RIS .ris
34205346
34215347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3422−use `.bibtex` to force BibTeX.
3423−
3424−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3425−can produce `.json` and `.yaml` files from any of the supported formats.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
34265349
3427−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3428−a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
5350+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351+inside fields such as `title`; in CSL YAML databases, pandoc
5352+Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5353+markup specs]:
34295354
34305355`<i>...</i>`
34315356: italics
@@ -3445,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
34455370`<span class="nocase">...</span>`
34465371: prevent a phrase from being capitalized as title case
34475372
3448−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3449−and CSL YAML formats as far as possible.
3450−
3451−As an alternative to specifying a bibliography file using `--bibliography`
3452−or the YAML metadata field `bibliography`, you can include
3453−the citation data directly in the `references` field of the
3454−document's YAML metadata. The field should contain an array of
3455−YAML-encoded references, for example:
5373+As an alternative to specifying a bibliography file using
5374+`--bibliography` or the YAML metadata field `bibliography`, you
5375+can include the citation data directly in the `references` field
5376+of the document's YAML metadata. The field should contain an
5377+array of YAML-encoded references, for example:
34565378
34575379 ---
34585380 references:
@@ -3467,329 +5389,280 @@ YAML-encoded references, for example:
34675389 date-parts:
34685390 - - 1953
34695391 - 4
3470− - 25
3471− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3472− nucleic acid'
3473− title-short: Molecular structure of nucleic acids
3474− container-title: Nature
3475− volume: 171
3476− issue: 4356
3477− page: 737-738
3478− DOI: 10.1038/171737a0
3479− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3480− language: en-GB
3481− ...
3482−
3483−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3484−of the supported formats.)
3485−
3486−Citations and references can be formatted using any style supported by the
3487−[Citation Style Language], listed in the [Zotero Style Repository].
3488−These files are specified using the `--csl` option or the `csl` metadata field.
3489−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3490−format. The CSL project provides further information on [finding and editing styles].
3491−
3492−To make your citations hyperlinks to the corresponding bibliography
3493−entries, add `link-citations: true` to your YAML metadata.
3494−
3495−Citations go inside square brackets and are separated by semicolons.
3496−Each citation must have a key, composed of '@' + the citation
3497−identifier from the database, and may optionally have a prefix,
3498−a locator, and a suffix. The citation key must begin with a letter, digit,
3499−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3500−characters (`:.#$%&-+?<>~/`). Here are some examples:
3501−
3502− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3503−
3504− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3505−
3506− Blah blah [@smith04; @doe99].
3507−
3508−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3509−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3510−locale, locator terms can be written in either singular or plural forms,
3511−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3512−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3513−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3514−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3515−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3516−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3517−locator term is used, "page" is assumed.
3518−
3519−A minus sign (`-`) before the `@` will suppress mention of
3520−the author in the citation. This can be useful when the
3521−author is already mentioned in the text:
3522−
3523− Smith says blah [-@smith04].
3524−
3525−You can also write an in-text citation, as follows:
3526−
3527− @smith04 says blah.
3528−
3529− @smith04 [p. 33] says blah.
3530−
3531−If the style calls for a list of works cited, it will be placed
3532−at the end of the document. Normally, you will want to end your
3533−document with an appropriate header:
3534−
3535− last paragraph...
3536−
3537− # References
3538−
3539−The bibliography will be inserted after this header. Note that
3540−the `unnumbered` class will be added to this header, so that the
3541−section will not be numbered.
3542−
3543−If you want to include items in the bibliography without actually
3544−citing them in the body text, you can define a dummy `nocite` metadata
3545−field and put the citations there:
3546−
3547− ---
3548− nocite: |
3549− @item1, @item2
3550− ...
3551−
3552− @item3
3553−
3554−In this example, the document will contain a citation for `item3`
3555−only, but the bibliography will contain entries for `item1`, `item2`, and
3556−`item3`.
3557−
3558−It is possible to create a bibliography with all the citations,
3559−whether or not they appear in the document, by using a wildcard:
3560−
3561− ---
3562− nocite: |
3563− @*
5392+ - 25
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
5395+ title-short: Molecular structure of nucleic acids
5396+ container-title: Nature
5397+ volume: 171
5398+ issue: 4356
5399+ page: 737-738
5400+ DOI: 10.1038/171737a0
5401+ URL: https://www.nature.com/articles/171737a0
5402+ language: en-GB
35645403 ...
35655404
3566−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3567−to render bibliography. In order to do so, specify bibliography files as
3568−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3569−invocation. Bear in mind that bibliography files have to be in respective
3570−format (either BibTeX or BibLaTeX).
5405+If both an external bibliography and inline (YAML metadata)
5406+references are provided, both will be used. In case of
5407+conflicting `id`s, the inline references will take precedence.
35715408
3572−For more information, see the [pandoc-citeproc man page].
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
35735411
3574−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3575−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3576−[Citation Style Language]: http://citationstyles.org
3577−[Zotero Style Repository]: https://www.zotero.org/styles
3578−[finding and editing styles]: http://citationstyles.org/styles/
3579−[CSL locale files]: https://github.com/citation-style-language/locales
3580−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3581−
3582−Non-pandoc extensions
3583−---------------------
3584−
3585−The following Markdown syntax extensions are not enabled by default
3586−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3587−name, where `EXTENSION` is the name of the extension. Thus, for
3588−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
35895414
3590−#### Extension: `old_dashes` ####
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
35915417
3592−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3593−`-` before a numeral is an en-dash, and `--` is an em-dash.
3594−This option only has an effect if `smart` is enabled. It is
3595−selected automatically for `textile` input.
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
35965420
3597−#### Extension: `angle_brackets_escapable` ####
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
35985424
3599−Allow `<` and `>` to be backslash-escaped, as they can be in
3600−GitHub flavored Markdown but not original Markdown. This is
3601−implied by pandoc's default `all_symbols_escapable`.
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
36025427
3603−#### Extension: `lists_without_preceding_blankline` ####
5428+### Capitalization in titles
36045429
3605−Allow a list to occur right after a paragraph, with no intervening
3606−blank space.
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
36075432
3608−#### Extension: `four_space_rule` ####
5433+ - English titles should be in title case. Non-English titles should
5434+ be in sentence case, and the `langid` field in biblatex should be
5435+ set to the relevant language. (The following values are treated
5436+ as English: `american`, `british`, `canadian`, `english`,
5437+ `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
36095438
3610−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3611−four spaces indent are needed for list item continuation
3612−paragraphs.
5439+ - As is standard with bibtex/biblatex, proper names should be
5440+ protected with curly braces so that they won't be lowercased
5441+ in styles that call for sentence case. For example:
36135442
3614−#### Extension: `spaced_reference_links` ####
5443+ title = {My Dinner with {Andre}}
36155444
3616−Allow whitespace between the two components of a reference link,
3617−for example,
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
36185447
3619− [foo] [bar].
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
36205449
3621−#### Extension: `hard_line_breaks` ####
5450+ Though this is not necessary in bibtex/biblatex, it is necessary
5451+ with citeproc, which stores titles internally in sentence case,
5452+ and converts to title case in styles that require it. Here we
5453+ protect "nm" so that it doesn't get converted to "Nm" at this stage.
36225454
3623−Causes all newlines within a paragraph to be interpreted as hard line
3624−breaks instead of spaces.
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
36255457
3626−#### Extension: `ignore_line_breaks` ####
5458+ - All titles should be in sentence case.
36275459
3628−Causes newlines within a paragraph to be ignored, rather than being
3629−treated as spaces or as hard line breaks. This option is intended for
3630−use with East Asian languages where spaces are not used between words,
3631−but text is divided into lines for readability.
5460+ - Use the `language` field for non-English titles to prevent their
5461+ conversion to title case in styles that call for this. (Conversion
5462+ happens only if `language` begins with `en` or is left empty.)
36325463
3633−#### Extension: `east_asian_line_breaks` ####
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
36345466
3635−Causes newlines within a paragraph to be ignored, rather than
3636−being treated as spaces or as hard line breaks, when they occur
3637−between two East Asian wide characters. This is a better choice
3638−than `ignore_line_breaks` for texts that include a mix of East
3639−Asian wide characters and other characters.
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
36405468
3641−##### Extension: `emoji` ####
5469+### Conference Papers, Published vs. Unpublished
36425470
3643−Parses textual emojis like `:smile:` as Unicode emoticons.
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
36445473
3645−#### Extension: `tex_math_single_backslash` ####
5474+For an unpublished manuscript, use the biblatex entry type
5475+`unpublished` without an `eventtitle` field (this entry type
5476+will be mapped to CSL `manuscript`).
36465477
3647−Causes anything between `\(` and `\)` to be interpreted as inline
3648−TeX math, and anything between `\[` and `\]` to be interpreted
3649−as display TeX math. Note: a drawback of this extension is that
3650−it precludes escaping `(` and `[`.
5478+For a talk, an unpublished conference paper, or a poster
5479+presentation, use the biblatex entry type `unpublished` with an
5480+`eventtitle` field (this entry type will be mapped to CSL
5481+`speech`). Use the biblatex `type` field to indicate the type,
5482+e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5483+too, though `eventdate` will not be rendered by most CSL styles.
5484+Note that `venue` is for the event's venue, unlike `location`
5485+which describes the publisher's location; do not use the latter
5486+for an unpublished conference paper.
36515487
3652−#### Extension: `tex_math_double_backslash` ####
36535488
3654−Causes anything between `\\(` and `\\)` to be interpreted as inline
3655−TeX math, and anything between `\\[` and `\\]` to be interpreted
3656−as display TeX math.
5489+## Specifying a citation style
36575490
3658−#### Extension: `markdown_attribute` ####
5491+Citations and references can be formatted using any style supported by the
5492+[Citation Style Language], listed in the [Zotero Style Repository].
5493+These files are specified using the `--csl` option or the `csl`
5494+(or `citation-style`) metadata field. By default, pandoc will
5495+use the [Chicago Manual of Style] author-date format. (You can
5496+override this default by copying a CSL style of your choice
5497+to `default.csl` in your user data directory.)
5498+The CSL project provides further information on [finding and
5499+editing styles].
5500+
5501+The `--citation-abbreviations` option (or the
5502+`citation-abbreviations` metadata field) may be used to specify
5503+a JSON file containing abbreviations of journals that should be
5504+used in formatted bibliographies when `form="short"` is
5505+specified. The format of the file can be illustrated with an
5506+example:
36595507
3660−By default, pandoc interprets material inside block-level tags as Markdown.
3661−This extension changes the behavior so that Markdown is only parsed
3662−inside block-level tags if the tags have the attribute `markdown=1`.
36635508
3664−#### Extension: `mmd_title_block` ####
5509+ { "default": {
5510+ "container-title": {
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
5512+ "Estates Gazette": "EG",
5513+ "Scots Law Times": "SLT"
5514+ }
5515+ }
5516+ }
36655517
3666−Enables a [MultiMarkdown] style title block at the top of
3667−the document, for example:
36685518
3669− Title: My title
3670− Author: John Doe
3671− Date: September 1, 2008
3672− Comment: This is a sample mmd title block, with
3673− a field spanning multiple lines.
5519+## Citations in note styles
36745520
3675−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3676−`yaml_metadata_block` is enabled, it will take precedence over
3677−`mmd_title_block`.
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
5526+example,
36785527
3679−#### Extension: `abbreviations` ####
5528+ Blah blah [@foo, p. 33].
36805529
3681−Parses PHP Markdown Extra abbreviation keys, like
5530+The footnote will be created automatically. Pandoc will take
5531+care of removing the space and moving the note before or
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
5534+metadata fields].
36825535
3683− *[HTML]: Hypertext Markup Language
5536+In some cases you may need to put a citation inside a regular
5537+footnote. Normal citations in footnotes (such as `[@foo, p.
5538+33]`) will be rendered in parentheses. In-text citations (such
5539+as `@foo [p. 33]`) will be rendered without parentheses. (A
5540+comma will be added if appropriate.) Thus:
36845541
3685−Note that the pandoc document model does not support
3686−abbreviations, so if this extension is enabled, abbreviation keys are
3687−simply skipped (as opposed to being parsed as paragraphs).
5542+ [^1]: Some studies [@foo; @bar, p. 33] show that
5543+ frubulicious zoosnaps are quantical. For a survey
5544+ of the literature, see @baz [chap. 1].
36885545
3689−#### Extension: `autolink_bare_uris` ####
5546+## Raw content in a style
36905547
3691−Makes all absolute URIs into links, even when not surrounded by
3692−pointy braces `<...>`.
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
36935550
3694−#### Extension: `ascii_identifiers` ####
5551+ {{jats}}<ref>{{/jats}}
36955552
3696−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3697−Accents are stripped off of accented Latin letters, and non-Latin
3698−letters are omitted.
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
36995555
3700−#### Extension: `mmd_link_attributes` ####
5556+This feature allows stylesheets to be customized to give
5557+different output for different output formats. However,
5558+stylesheets customized in this way will not be usable
5559+by other CSL implementations.
37015560
3702−Parses multimarkdown style key-value attributes on link
3703−and image references. This extension should not be confused with the
3704−[`link_attributes`](#extension-link_attributes) extension.
37055561
3706− This is a reference ![image][ref] with multimarkdown attributes.
37075562
3708− [ref]: http://path.to/image "Image title" width=20px height=30px
3709− id=myId class="myClass1 myClass2"
5563+## Placement of the bibliography
37105564
3711−#### Extension: `mmd_header_identifiers` ####
5565+If the style calls for a list of works cited, it will be placed
5566+in a div with id `refs`, if one exists:
37125567
3713−Parses multimarkdown style header identifiers (in square brackets,
3714−after the header but before any trailing `#`s in an ATX header).
5568+ ::: {#refs}
5569+ :::
37155570
3716−#### Extension: `compact_definition_lists` ####
5571+Otherwise, it will be placed at the end of the document.
5572+Generation of the bibliography can be suppressed by setting
5573+`suppress-bibliography: true` in the YAML metadata.
37175574
3718−Activates the definition list syntax of pandoc 1.12.x and earlier.
3719−This syntax differs from the one described above under [Definition lists]
3720−in several respects:
5575+If you wish the bibliography to have a section heading, you can
5576+set `reference-section-title` in the metadata, or put the heading
5577+at the beginning of the div with id `refs` (if you are using it)
5578+or at the end of your document:
37215579
3722− - No blank line is required between consecutive items of the
3723− definition list.
3724− - To get a "tight" or "compact" list, omit space between consecutive
3725− items; the space between a term and its definition does not affect
3726− anything.
3727− - Lazy wrapping of paragraphs is not allowed: the entire definition must
3728− be indented four spaces.[^6]
5580+ last paragraph...
37295581
3730−[^6]: To see why laziness is incompatible with relaxing the requirement
3731− of a blank line between items, consider the following example:
5582+ # References
37325583
3733− bar
3734− : definition
3735− foo
3736− : definition
5584+The bibliography will be inserted after this heading. Note that
5585+the `unnumbered` class will be added to this heading, so that the
5586+section will not be numbered.
37375587
3738− Is this a single list item with two definitions of "bar," the first of
3739− which is lazily wrapped, or two list items? To remove the ambiguity
3740− we must either disallow lazy wrapping or require a blank line between
3741− list items.
5588+## Including uncited items in the bibliography
37425589
3743−Markdown variants
3744−-----------------
5590+If you want to include items in the bibliography without actually
5591+citing them in the body text, you can define a dummy `nocite` metadata
5592+field and put the citations there:
37455593
3746−In addition to pandoc's extended Markdown, the following Markdown
3747−variants are supported:
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
37485598
3749−`markdown_phpextra` (PHP Markdown Extra)
3750−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3751− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3752− `header_attributes`, `link_attributes`, `abbreviations`,
3753− `shortcut_reference_links`.
5599+ @item3
37545600
3755−`gfm` and `markdown_github` (GitHub-Flavored Markdown)
3756−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3757− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3758− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3759− `shortcut_reference_links`, `angle_brackets_escapable`.
5601+In this example, the document will contain a citation for `item3`
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
5603+`item3`.
37605604
3761−`markdown_mmd` (MultiMarkdown)
3762−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3763− `tex_math_double_backslash`, `intraword_underscores`,
3764− `mmd_title_block`, `footnotes`, `definition_lists`,
3765− `all_symbols_escapable`, `implicit_header_references`,
3766− `auto_identifiers`, `mmd_header_identifiers`,
3767− `shortcut_reference_links`.
5605+It is possible to create a bibliography with all the citations,
5606+whether or not they appear in the document, by using a wildcard:
37685607
3769−`markdown_strict` (Markdown.pl)
3770−: `raw_html`
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
37715612
3772−Extensions with formats other than Markdown
3773−-------------------------------------------
5613+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5614+render the bibliography. In order to do so, specify bibliography
5615+files as outlined above, and add `--natbib` or `--biblatex`
5616+argument to `pandoc` invocation. Bear in mind that bibliography
5617+files have to be in either BibTeX (for `--natbib`)
5618+or BibLaTeX (for `--biblatex`) format.
37745619
3775−Some of the extensions discussed above can be used with formats
3776−other than Markdown:
5620+## Other relevant metadata fields
37775621
3778−* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3779− and `textile` input (and is used by default).
5622+A few other metadata fields affect bibliography formatting:
37805623
3781−* `tex_math_dollars`, `tex_math_single_backslash`, and
3782− `tex_math_double_backslash` can be used with `html` input.
3783− (This is handy for reading web pages formatted using MathJax,
3784− for example.)
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
37855628
3786−Producing slide shows with pandoc
3787−=================================
5629+`lang`
5630+: The `lang` field will affect how the style is localized,
5631+ for example in the translation of labels, the use
5632+ of quotation marks, and the way items are sorted.
5633+ (For backwards compatibility, `locale` may be used instead
5634+ of `lang`, but this use is deprecated.)
5635+
5636+ A BCP 47 language tag is expected: for example, `en`,
5637+ `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
5638+ syntax (after `-u-`) may be used to specify options for
5639+ collation (sorting) more precisely. Here are some examples:
5640+
5641+ - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642+ - `es-u-co-trad` -- Spanish with the traditional collation
5643+ (with `Ch` sorting after `C`).
5644+ - `fr-u-kb` -- French with "backwards" accent sorting
5645+ (with `coté` sorting after `côte`).
5646+ - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647+ before lower (default is lower before upper).
5648+
5649+`notes-after-punctuation`
5650+: If true (the default), pandoc will put footnote citations
5651+ after following punctuation. For example, if the source
5652+ contains `blah blah [@jones99].`, the result will look like
5653+ `blah blah.[^1]`, with the note moved after the period and
5654+ the space collapsed. If false, the space will still be
5655+ collapsed, but the footnote will not be moved after the
5656+ punctuation.
5657+
5658+
5659+# Slide shows
37885660
37895661You can use pandoc to produce an HTML + JavaScript slide presentation
37905662that can be viewed via a web browser. There are five ways to do this,
37915663using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3792−You can also produce a PDF slide show using LaTeX [`beamer`].
5664+You can also produce a PDF slide show using LaTeX [`beamer`], or
5665+slides shows in Microsoft [PowerPoint] format.
37935666
37945667Here's the Markdown source for a simple slide show, `habits.txt`:
37955668
@@ -3831,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
38315704
38325705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
38335706
3834−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3835−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3836−assumed to be available at the relative path `s5/default` (for S5), `slideous`
3837−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3838−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3839−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3840−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3841−the file by default.
3842−
3843−With all HTML slide formats, the `--self-contained` option can be used to
3844−produce a single file that contains all of the data necessary to display the
3845−slide show, including linked scripts, stylesheets, images, and videos.
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5710+the relative path `s5/default` (for S5), `slideous` (for
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5714+variables; see [Variables for HTML slides], above.) For
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5716+in the file by default.
5717+
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
38465722
38475723To produce a PDF slide show using beamer, type
38485724
@@ -3851,14 +5727,17 @@ To produce a PDF slide show using beamer, type
38515727Note that a reveal.js slide show can also be converted to a PDF
38525728by printing it to a file from the browser.
38535729
3854−Structuring the slide show
3855−--------------------------
5730+To produce a Powerpoint slide show, type
5731+
5732+ pandoc habits.txt -o habits.pptx
5733+
5734+## Structuring the slide show
38565735
3857−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
38585737the hierarchy that is followed immediately by content, and not another
3859−header, somewhere in the document. In the example above, level 1 headers
3860−are always followed by level 2 headers, which are followed by content,
3861−so 2 is the slide level. This default can be overridden using
5738+heading, somewhere in the document. In the example above, level-1 headings
5739+are always followed by level-2 headings, which are followed by content,
5740+so the slide level is 2. This default can be overridden using
38625741the `--slide-level` option.
38635742
38645743The document is carved up into slides according to the following
@@ -3866,17 +5745,21 @@ rules:
38665745
38675746 * A horizontal rule always starts a new slide.
38685747
3869− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
38705749
3871− * Headers *below* the slide level in the hierarchy create
3872− headers *within* a slide.
5750+ * Headings *below* the slide level in the hierarchy create
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
38735756
3874− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
38755758 "title slides," which just contain the section title
38765759 and help to break the slide show into sections.
3877−
3878− * Content *above* the slide level will not appear in the slide
3879− show.
5760+ Non-slide content under these headings will be included
5761+ on the title slide (for HTML slide shows) or in a
5762+ subsequent slide with the same title (for beamer).
38805763
38815764 * A title page is constructed automatically from the document's title
38825765 block, if present. (In the case of beamer, this can be disabled
@@ -3884,32 +5767,57 @@ rules:
38845767
38855768These rules are designed to support many different styles of slide show. If
38865769you don't care about structuring your slides into sections and subsections,
3887−you can just use level 1 headers for all each slide. (In that case, level 1
5770+you can just use level-1 headings for all each slide. (In that case, level-1
38885771will be the slide level.) But you can also structure the slide show into
38895772sections, as in the example above.
38905773
38915774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3892−layout will be produced, with level 1 headers building horizontally
3893−and level 2 headers building vertically. It is not recommended that
5775+layout will be produced, with level-1 headings building horizontally
5776+and level-2 headings building vertically. It is not recommended that
38945777you use deeper nesting of section levels with reveal.js.
38955778
3896−Incremental lists
3897−-----------------
5779+## Incremental lists
38985780
38995781By default, these writers produce lists that display "all at once."
39005782If you want your lists to display incrementally (one item at a time),
39015783use the `-i` option. If you want a particular list to depart from the
3902−default (that is, to display incrementally without the `-i` option and
3903−all at once with the `-i` option), put it in a block quote:
5784+default, put it in a `div` block with class `incremental` or
5785+`nonincremental`. So, for example, using the `fenced div` syntax, the
5786+following would be incremental regardless of the document default:
5787+
5788+ ::: incremental
5789+
5790+ - Eat spaghetti
5791+ - Drink wine
5792+
5793+ :::
5794+
5795+or
5796+
5797+ ::: nonincremental
5798+
5799+ - Eat spaghetti
5800+ - Drink wine
5801+
5802+ :::
5803+
5804+While using `incremental` and `nonincremental` divs are the
5805+recommended method of setting incremental lists on a per-case basis,
5806+an older method is also supported: putting lists inside a blockquote
5807+will depart from the document default (that is, it will display
5808+incrementally without the `-i` option and all at once with the `-i`
5809+option):
39045810
39055811 > - Eat spaghetti
39065812 > - Drink wine
39075813
3908−In this way incremental and nonincremental lists can be mixed in
3909−a single document.
5814+Both methods allow incremental and nonincremental lists to be mixed
5815+in a single document.
39105816
3911−Inserting pauses
3912−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
39135821
39145822You can add "pauses" within a slide by including a paragraph containing
39155823three dots, separated by spaces:
@@ -3922,8 +5830,9 @@ three dots, separated by spaces:
39225830
39235831 content after the pause
39245832
3925−Styling the slides
3926−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
39275836
39285837You can change the style of HTML slides by putting customized CSS files
39295838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -3948,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
39485857
39495858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
39505859
3951−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
39525861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3953−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
39545863that affects slides is the `allowframebreaks` class, which sets the
39555864`allowframebreaks` option, causing multiple slides to be created
39565865if the content overfills the frame. This is recommended especially for
@@ -3958,30 +5867,82 @@ bibliographies:
39585867
39595868 # References {.allowframebreaks}
39605869
3961−Speaker notes
3962−-------------
5870+## Speaker notes
39635871
3964−reveal.js has good support for speaker notes. You can add notes to your
3965−Markdown document thus:
5872+Speaker notes are supported in reveal.js and PowerPoint (pptx)
5873+output. You can add notes to your Markdown document thus:
5874+
5875+ ::: notes
39665876
3967− <div class="notes">
39685877 This is my note.
39695878
39705879 - It can contain Markdown
39715880 - like this list
39725881
3973− </div>
5882+ :::
5883+
5884+To show the notes window in reveal.js, press `s` while viewing the
5885+presentation. Speaker notes in PowerPoint will be available, as usual,
5886+in handouts and presenter view.
39745887
3975−To show the notes window, press `s` while viewing the presentation.
39765888Notes are not yet supported for other slide formats, but the notes
39775889will not appear on the slides themselves.
39785890
3979−Frame attributes in beamer
3980−--------------------------
5891+## Columns
5892+
5893+To put material in side by side columns, you can use a native
5894+div container with class `columns`, containing two or more div
5895+containers with class `column` and a `width` attribute:
5896+
5897+ :::::::::::::: {.columns}
5898+ ::: {.column width="40%"}
5899+ contents...
5900+ :::
5901+ ::: {.column width="60%"}
5902+ contents...
5903+ :::
5904+ ::::::::::::::
5905+
5906+### Additional columns attributes in beamer
5907+
5908+The div containers with classes `columns` and `column` can optionally have
5909+an `align` attribute.
5910+The class `columns` can optionally have a `totalwidth` attribute or an
5911+`onlytextwidth` class.
5912+
5913+ :::::::::::::: {.columns align=center totalwidth=8em}
5914+ ::: {.column width="40%"}
5915+ contents...
5916+ :::
5917+ ::: {.column width="60%" align=bottom}
5918+ contents...
5919+ :::
5920+ ::::::::::::::
5921+
5922+The `align` attributes on `columns` and `column` can be used with the
5923+values `top`, `top-baseline`, `center` and `bottom` to vertically align
5924+the columns. It defaults to `top` in `columns`.
5925+
5926+The `totalwidth` attribute limits the width of the columns to the given value.
5927+
5928+ :::::::::::::: {.columns align=top .onlytextwidth}
5929+ ::: {.column width="40%" align=center}
5930+ contents...
5931+ :::
5932+ ::: {.column width="60%"}
5933+ contents...
5934+ :::
5935+ ::::::::::::::
5936+
5937+The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5938+
5939+See Section 12.7 of the [Beamer User's Guide] for more details.
5940+
5941+## Frame attributes in beamer
39815942
39825943Sometimes it is necessary to add the LaTeX `[fragile]` option to
39835944a frame in beamer (for example, when using the `minted` environment).
3984−This can be forced by adding the `fragile` class to the header
5945+This can be forced by adding the `fragile` class to the heading
39855946introducing the slide:
39865947
39875948 # Fragile slide {.fragile}
@@ -3989,13 +5950,64 @@ introducing the slide:
39895950All of the other frame attributes described in Section 8.1 of
39905951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
39915952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
3992−`shrink`.
5953+`shrink`, `standout`, `noframenumbering`.
5954+
5955+## Background in reveal.js and beamer
5956+
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
5959+
5960+For the same image on every slide, use the configuration
5961+option `background-image` either in the YAML metadata block
5962+or as a command-line variable. (There are no other options in
5963+beamer and the rest of this section concerns reveal.js slideshows.)
5964+
5965+For reveal.js, you can instead use the reveal.js-native option
5966+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967+and `parallaxBackgroundVertical` the same way and must also set
5968+`parallaxBackgroundSize` to have your values take effect.
5969+
5970+To set an image for a particular reveal.js slide, add
5971+`{data-background-image="/path/to/image"}`
5972+to the first slide-level heading on the slide (which may even be empty).
5973+
5974+In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975+only on the first slide.
5976+
5977+Other reveal.js background settings also work on individual slides, including
5978+`data-background-size`, `data-background-repeat`, `data-background-color`,
5979+`data-transition`, and `data-transition-speed`.
5980+
5981+To add a background image to the automatically generated title slide, use the
5982+`title-slide-attributes` variable in the YAML metadata block. It must contain
5983+a map of attribute names and values.
5984+
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986+details.
5987+
5988+For example in reveal.js:
5989+
5990+```
5991+---
5992+title: My Slideshow
5993+parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
5997+---
5998+
5999+## Slide One
6000+
6001+Slide 1 has background_image.png as its background.
6002+
6003+## {data-background-image="/path/to/special_image.jpg"}
39936004
3994−Creating EPUBs with pandoc
3995−==========================
6005+Slide 2 has a special image for its background, even though the heading has no content.
6006+```
6007+
6008+# EPUBs
39966009
3997−EPUB Metadata
3998−-------------
6010+## EPUB Metadata
39996011
40006012EPUB metadata may be specified using the `--epub-metadata` option, but
40016013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4073,11 +6085,20 @@ The following fields are recognized:
40736085
40746086`rights`
40756087 ~ A string value.
6088+
6089+`belongs-to-collection`
6090+ ~ A string value. identifies the name of a collection to which
6091+ the EPUB Publication belongs.
6092+
6093+`group-position`
6094+ ~ The `group-position` field indicates the numeric position in which
6095+ the EPUB Publication belongs relative to other works belonging to
6096+ the same `belongs-to-collection` field.
40766097
40776098`cover-image`
40786099 ~ A string value (path to cover image).
40796100
4080−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
40816102 ~ A string value (path to CSS stylesheet).
40826103
40836104`page-progression-direction`
@@ -4094,83 +6115,200 @@ The following fields are recognized:
40946115 - `binding`: `true`|`false` (default `true`)
40956116 - `scroll-axis`: `vertical`|`horizontal`|`default`
40966117
4097−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
40986119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
40996120
4100−Linked media
4101−------------
4102−
4103−By default, pandoc will download linked media (including audio and
4104−video) and include it in the EPUB container, yielding a completely
6121+## The `epub:type` attribute
6122+
6123+For `epub3` output, you can mark up the heading that corresponds to an EPUB
6124+chapter using the [`epub:type` attribute][epub-type]. For example, to set
6125+the attribute to the value `prologue`, use this markdown:
6126+
6127+ # My chapter {epub:type=prologue}
6128+
6129+Which will result in:
6130+
6131+ <body epub:type="frontmatter">
6132+ <section epub:type="prologue">
6133+ <h1>My chapter</h1>
6134+
6135+Pandoc will output `<body epub:type="bodymatter">`, unless
6136+you use one of the following values, in which case either
6137+`frontmatter` or `backmatter` will be output.
6138+
6139+`epub:type` of first section `epub:type` of body
6140+---------------------------- ------------------
6141+prologue frontmatter
6142+abstract frontmatter
6143+acknowledgments frontmatter
6144+copyright-page frontmatter
6145+dedication frontmatter
6146+credits frontmatter
6147+keywords frontmatter
6148+imprint frontmatter
6149+contributors frontmatter
6150+other-credits frontmatter
6151+errata frontmatter
6152+revision-history frontmatter
6153+titlepage frontmatter
6154+halftitlepage frontmatter
6155+seriespage frontmatter
6156+foreword frontmatter
6157+preface frontmatter
6158+appendix backmatter
6159+colophon backmatter
6160+bibliography backmatter
6161+index backmatter
6162+
6163+[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6164+
6165+## Linked media
6166+
6167+By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6168+`<video>` or `<source>` element present in the generated EPUB,
6169+and include it in the EPUB container, yielding a completely
41056170self-contained EPUB. If you want to link to external media resources
41066171instead, use raw HTML in your source and add `data-external="1"` to the tag
41076172with the `src` attribute. For example:
41086173
41096174 <audio controls="1">
4110− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
41116176 data-external="1" type="audio/mpeg">
41126177 </source>
41136178 </audio>
41146179
4115−Literate Haskell support
4116−========================
4117−
4118−If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4119−format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4120−`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4121−literate Haskell source. This means that
4122−
4123− - In Markdown input, "bird track" sections will be parsed as Haskell
4124− code rather than block quotations. Text between `\begin{code}`
4125− and `\end{code}` will also be treated as Haskell code. For
4126− ATX-style headers the character '=' will be used instead of '#'.
4127−
4128− - In Markdown output, code blocks with classes `haskell` and `literate`
4129− will be rendered using bird tracks, and block quotations will be
4130− indented one space, so they will not be treated as Haskell code.
4131− In addition, headers will be rendered setext-style (with underlines)
4132− rather than ATX-style (with '#' characters). (This is because ghc
4133− treats '#' characters in column 1 as introducing line numbers.)
4134−
4135− - In restructured text input, "bird track" sections will be parsed
4136− as Haskell code.
4137−
4138− - In restructured text output, code blocks with class `haskell` will
4139− be rendered using bird tracks.
6180+# Jupyter notebooks
6181+
6182+When creating a [Jupyter notebook], pandoc will try to infer the
6183+notebook structure. Code blocks with the class `code` will be
6184+taken as code cells, and intervening content will be taken as
6185+Markdown cells. Attachments will automatically be created for
6186+images in Markdown cells. Metadata will be taken from the
6187+`jupyter` metadata field. For example:
6188+
6189+````
6190+---
6191+title: My notebook
6192+jupyter:
6193+ nbformat: 4
6194+ nbformat_minor: 5
6195+ kernelspec:
6196+ display_name: Python 2
6197+ language: python
6198+ name: python2
6199+ language_info:
6200+ codemirror_mode:
6201+ name: ipython
6202+ version: 2
6203+ file_extension: ".py"
6204+ mimetype: "text/x-python"
6205+ name: "python"
6206+ nbconvert_exporter: "python"
6207+ pygments_lexer: "ipython2"
6208+ version: "2.7.15"
6209+---
6210+
6211+# Lorem ipsum
6212+
6213+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6214+bibendum felis dictum sodales.
6215+
6216+``` code
6217+print("hello")
6218+```
41406219
4141− - In LaTeX input, text in `code` environments will be parsed as
4142− Haskell code.
6220+## Pyout
41436221
4144− - In LaTeX output, code blocks with class `haskell` will be rendered
4145− inside `code` environments.
6222+``` code
6223+from IPython.display import HTML
6224+HTML("""
6225+<script>
6226+console.log("hello");
6227+</script>
6228+<b>HTML</b>
6229+""")
6230+```
41466231
4147− - In HTML output, code blocks with class `haskell` will be rendered
4148− with class `literatehaskell` and bird tracks.
6232+## Image
41496233
4150−Examples:
6234+This image  will be
6235+included as a cell attachment.
6236+````
41516237
4152− pandoc -f markdown+lhs -t html
6238+If you want to add cell attributes, group cells differently, or
6239+add output to code cells, then you need to include divs to
6240+indicate the structure. You can use either [fenced
6241+divs][Extension: `fenced_divs`] or [native divs][Extension:
6242+`native_divs`] for this. Here is an example:
41536243
4154−reads literate Haskell source formatted with Markdown conventions and writes
4155−ordinary HTML (without bird tracks).
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
41566247
4157− pandoc -f markdown+lhs -t html+lhs
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
41586251
4159−writes HTML with the Haskell code in bird tracks, so it can be copied
4160−and pasted as literate Haskell source.
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
41616256
4162−Note that GHC expects the bird tracks in the first column, so indentend literate
4163−code blocks (e.g. inside an itemized environment) will not be picked up by the
4164−Haskell compiler.
6257+::: {.output .stream .stdout}
6258+```
6259+hello
6260+```
6261+:::
6262+::::::
6263+
6264+:::::: {.cell .code execution_count=2}
6265+``` {.python}
6266+from IPython.display import HTML
6267+HTML("""
6268+<script>
6269+console.log("hello");
6270+</script>
6271+<b>HTML</b>
6272+""")
6273+```
41656274
4166−Syntax highlighting
4167−===================
6275+::: {.output .execute_result execution_count=2}
6276+```{=html}
6277+<script>
6278+console.log("hello");
6279+</script>
6280+<b>HTML</b>
6281+hello
6282+```
6283+:::
6284+::::::
6285+````
6286+
6287+If you include raw HTML or TeX in an output cell, use the
6288+[raw attribute][Extension: `fenced_attribute`], as shown
6289+in the last cell of the example above. Although pandoc can
6290+process "bare" raw HTML and TeX, the result is often
6291+interspersed raw elements and normal textual elements, and
6292+in an output cell pandoc expects a single, connected raw
6293+block. To avoid using raw HTML or TeX except when
6294+marked explicitly using raw attributes, we recommend
6295+specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6296+translating between Markdown and ipynb notebooks.
6297+
6298+Note that options and extensions that affect reading and
6299+writing of Markdown will also affect Markdown cells in ipynb
6300+notebooks. For example, `--wrap=preserve` will preserve
6301+soft line breaks in Markdown cells; `--atx-headers` will
6302+cause ATX-style headings to be used; and `--preserve-tabs` will
6303+prevent tabs from being turned to spaces.
6304+
6305+# Syntax highlighting
41686306
41696307Pandoc will automatically highlight syntax in [fenced code blocks] that
41706308are marked with a language name. The Haskell library [skylighting] is
4171−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4172−To see a list of language names that pandoc will recognize, type
4173−`pandoc --list-highlight-languages`.
6309+used for highlighting. Currently highlighting is supported only for
6310+HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6311+that pandoc will recognize, type `pandoc --list-highlight-languages`.
41746312
41756313The color scheme can be selected using the `--highlight-style` option.
41766314The default color scheme is `pygments`, which imitates the default color
@@ -4178,15 +6316,36 @@ scheme used by the Python library pygments (though pygments is not actually
41786316used to do the highlighting). To see a list of highlight styles,
41796317type `pandoc --list-highlight-styles`.
41806318
6319+If you are not satisfied with the predefined styles, you can
6320+use `--print-highlight-style` to generate a JSON `.theme` file which
6321+can be modified and used as the argument to `--highlight-style`. To
6322+get a JSON version of the `pygments` style, for example:
6323+
6324+ pandoc --print-highlight-style pygments > my.theme
6325+
6326+Then edit `my.theme` and use it like this:
6327+
6328+ pandoc --highlight-style my.theme
6329+
6330+If you are not satisfied with the built-in highlighting, or you
6331+want highlight a language that isn't supported, you can use the
6332+`--syntax-definition` option to load a [KDE-style XML syntax definition
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
6334+Before writing your own, have a look at KDE's [repository of syntax
6335+definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6336+
41816337To disable highlighting, use the `--no-highlight` option.
41826338
41836339[skylighting]: https://github.com/jgm/skylighting
41846340
4185−Custom Styles in Docx Output
4186−============================
6341+# Custom Styles
6342+
6343+Custom styles can be used in the docx and ICML formats.
6344+
6345+## Output
41876346
4188−By default, pandoc's docx output applies a predefined set of styles for
4189−blocks such as paragraphs and block quotes, and uses largely default
6347+By default, pandoc's docx and ICML output applies a predefined set of styles
6348+for blocks such as paragraphs and block quotes, and uses largely default
41906349formatting (italics, bold) for inlines. This will work for most
41916350purposes, especially alongside a `reference.docx` file. However, if you
41926351need to apply your own styles to blocks, or match a preexisting set of
@@ -4194,26 +6353,28 @@ styles, pandoc allows you to define custom styles for blocks and text
41946353using `div`s and `span`s, respectively.
41956354
41966355If you define a `div` or `span` with the attribute `custom-style`,
4197−pandoc will apply your specified style to the contained elements. So,
4198−for example,
6356+pandoc will apply your specified style to the contained elements (with
6357+the exception of elements whose function depends on a style, like
6358+headings, code blocks, block quotes, or links). So, for example, using
6359+the `bracketed_spans` syntax,
41996360
4200− <span custom-style="Emphatically">Get out,</span> he said.
6361+ [Get out]{custom-style="Emphatically"}, he said.
42016362
4202−would produce a docx file with "Get out," styled with character
4203−style `Emphatically`. Similarly,
6363+would produce a docx file with "Get out" styled with character
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
42046365
42056366 Dickinson starts the poem simply:
42066367
4207− <div custom-style="Poetry">
6368+ ::: {custom-style="Poetry"}
42086369 | A Bird came down the Walk---
42096370 | He did not know I saw---
4210− </div>
6371+ :::
42116372
42126373would style the two contained lines with the `Poetry` paragraph style.
42136374
4214−If the styles are not yet in your reference.docx, they will be defined
4215−in the output file as inheriting from normal text. If they are already
4216−defined, pandoc will not alter the definition.
6375+For docx output, styles will be defined in the output file as inheriting
6376+from normal text, if the styles are not yet in your reference.docx.
6377+If they are already defined, pandoc will not alter the definition.
42176378
42186379This feature allows for greatest customization in conjunction with
42196380[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -4223,206 +6384,137 @@ want all italics to be transformed to the `Emphasis` character style
42236384transform all italicized inlines to inlines within an `Emphasis`
42246385custom-style `span`.
42256386
4226−[pandoc filters]: http://pandoc.org/scripting.html
6387+For docx output, you don't need to enable any extensions for
6388+custom styles to work.
6389+
6390+[pandoc filters]: https://pandoc.org/filters.html
6391+
6392+## Input
6393+
6394+The docx reader, by default, only reads those styles that it can
6395+convert into pandoc elements, either by direct conversion or
6396+interpreting the derivation of the input document's styles.
6397+
6398+By enabling the [`styles` extension](#ext-styles) in the docx reader
6399+(`-f docx+styles`), you can produce output that maintains the styles
6400+of the input document, using the `custom-style` class. Paragraph
6401+styles are interpreted as divs, while character styles are interpreted
6402+as spans.
6403+
6404+For example, using the `custom-style-reference.docx` file in the test
6405+directory, we have the following different outputs:
6406+
6407+Without the `+styles` extension:
6408+
6409+ $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6410+ This is some text.
6411+
6412+ This is text with an *emphasized* text style. And this is text with a
6413+ **strengthened** text style.
6414+
6415+ > Here is a styled paragraph that inherits from Block Text.
6416+
6417+And with the extension:
6418+
6419+ $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6420+
6421+ ::: {custom-style="First Paragraph"}
6422+ This is some text.
6423+ :::
6424+
6425+ ::: {custom-style="Body Text"}
6426+ This is text with an [emphasized]{custom-style="Emphatic"} text style.
6427+ And this is text with a [strengthened]{custom-style="Strengthened"}
6428+ text style.
6429+ :::
6430+
6431+ ::: {custom-style="My Block Style"}
6432+ > Here is a styled paragraph that inherits from Block Text.
6433+ :::
6434+
6435+With these custom styles, you can use your input document as a
6436+reference-doc while creating docx output (see below), and maintain the
6437+same styles in your input and output files.
42276438
4228−Custom writers
4229−==============
6439+# Custom writers
42306440
4231−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4232−includes a lua interpreter, so lua need not be installed separately.)
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
42336443
4234−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
42356445in place of the output format. For example:
42366446
42376447 pandoc -t data/sample.lua
42386448
4239−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
42406450possible element in a pandoc document. To get a documented example
42416451which you can modify according to your needs, do
42426452
42436453 pandoc --print-default-data-file sample.lua
42446454
4245−[lua]: http://www.lua.org
4246−
4247−Authors
4248−=======
4249−
4250−© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
4251−[GPL], version 2 or greater. This software carries no warranty of
4252−any kind. (See COPYRIGHT for full copyright and warranty notices.)
4253−
4254−Contributors include
4255−Arata Mizuki,
4256−Aaron Wolen,
4257−Albert Krewinkel,
4258−Alex Ivkin,
4259−Alex Vong,
4260−Alexander Kondratskiy,
4261−Alexander Sulfrian,
4262−Alexander V Vershilov,
4263−Alfred Wechselberger,
4264−Andreas Lööw,
4265−Andrew Dunning,
4266−Antoine Latter,
4267−Arata Mizuki,
4268−Arlo O'Keeffe,
4269−Artyom Kazak,
4270−B. Scott Michel,
4271−Ben Gamari,
4272−Beni Cherniavsky-Paskin,
4273−Benoit Schweblin,
4274−Bjorn Buckwalter,
4275−Bradley Kuhn,
4276−Brent Yorgey,
4277−Bryan O'Sullivan,
4278−Caleb McDaniel,
4279−Calvin Beck,
4280−Carlos Sosa,
4281−Chris Black,
4282−Christian Conkle,
4283−Christoffer Ackelman,
4284−Christoffer Sawicki,
4285−Clare Macrae,
4286−Clint Adams,
4287−Conal Elliott,
4288−Craig S. Bosma,
4289−Daniel Bergey,
4290−Daniel T. Staal,
4291−Daniele D'Orazio,
4292−David Lazar,
4293−David Röthlisberger,
4294−Denis Laxalde,
4295−Douglas Calvert,
4296−Emanuel Evans,
4297−Emily Eisenberg,
4298−Eric Kow,
4299−Eric Seidel,
4300−Felix Yan,
4301−Florian Eitel,
4302−François Gannaz,
4303−Freiric Barral,
4304−Freirich Raabe,
4305−Frerich Raabe,
4306−Fyodor Sheremetyev,
4307−Gabor Pali,
4308−Gavin Beatty,
4309−Gottfried Haider,
4310−Greg Maslov,
4311−Greg Rundlett,
4312−Grégory Bataille,
4313−Gwern Branwen,
4314−Hans-Peter Deifel,
4315−Henrik Tramberend,
4316−Henry de Valence,
4317−Hubert Plociniczak,
4318−Ilya V. Portnov,
4319−Ivo Clarysse,
4320−J. Lewis Muir,
4321−Jaime Marquínez Ferrándiz,
4322−Jakob Voß,
4323−James Aspnes,
4324−Jamie F. Olson,
4325−Jan Larres,
4326−Jan Schulz,
4327−Jason Ronallo,
4328−Jeff Arnold,
4329−Jeff Runningen,
4330−Jens Petersen,
4331−Jesse Rosenthal,
4332−Joe Hillenbrand,
4333−John MacFarlane,
4334−John Muccigrosso,
4335−Jonas Smedegaard,
4336−Jonathan Daugherty,
4337−Jose Luis Duran,
4338−Josef Svenningsson,
4339−Julien Cretel,
4340−Juliusz Gonera,
4341−Justin Bogner,
4342−Jérémy Bobbio,
4343−Kelsey Hightower,
4344−Kolen Cheung,
4345−Konstantin Zudov,
4346−Kristof Bastiaensen,
4347−Lars-Dominik Braun,
4348−Luke Plant,
4349−Mark Szepieniec,
4350−Mark Wright,
4351−Martin Linn,
4352−Masayoshi Takahashi,
4353−Matej Kollar,
4354−Mathias Schenner,
4355−Mathieu Duponchelle,
4356−Matthew Eddey,
4357−Matthew Pickering,
4358−Matthias C. M. Troffaes,
4359−Mauro Bieg,
4360−Max Bolingbroke,
4361−Max Rydahl Andersen,
4362−Merijn Verstraaten,
4363−Michael Beaumont,
4364−Michael Chladek,
4365−Michael Snoyman,
4366−Michael Thompson,
4367−MinRK,
4368−Morton Fox,
4369−Nathan Gass,
4370−Neil Mayhew,
4371−Nick Bart,
4372−Nicolas Kaiser,
4373−Nikolay Yakimov,
4374−Oliver Matthews,
4375−Ophir Lifshitz,
4376−Pablo Rodríguez,
4377−Paul Rivier,
4378−Paulo Tanimoto,
4379−Peter Wang,
4380−Philippe Ombredanne,
4381−Phillip Alday,
4382−Prayag Verma,
4383−Puneeth Chaganti,
4384−Ralf Stephan,
4385−Raniere Silva,
4386−Recai Oktaş,
4387−RyanGlScott,
4388−Scott Morrison,
4389−Sergei Trofimovich,
4390−Sergey Astanin,
4391−Shahbaz Youssefi,
4392−Shaun Attfield,
4393−Sidarth Kapur,
4394−Sidharth Kapur,
4395−Simon Hengel,
4396−Sumit Sahrawat,
4397−Thomas Hodgson,
4398−Thomas Weißschuh,
4399−Tim Lin,
4400−Timothy Humphries,
4401−Tiziano Müller,
4402−Todd Sifleet,
4403−Tom Leese,
4404−Uli Köhler,
4405−Václav Zeman,
4406−Viktor Kronvall,
4407−Vincent,
4408−Václav Haisman,
4409−Václav Zeman,
4410−Wandmalfarbe,
4411−Waldir Pimenta,
4412−Wikiwide,
4413−Xavier Olive,
4414−bumper314,
4415−csforste,
4416−infinity0x,
4417−nkalvi,
4418−qerub,
4419−robabla,
4420−roblabla,
4421−rodja.trappe,
4422−rski,
4423−shreevatsa.public,
4424−takahashim,
4425−tgkokk,
4426−thsutton.
4427−
4428−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6455+Note that custom writers have no default template. If you want
6456+to use `--standalone` with a custom writer, you will need to
6457+specify a template manually using `--template` or add a new
6458+default template with the name
6459+`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6460+subdirectory of your user data directory (see [Templates]).
6461+
6462+[Lua]: https://www.lua.org
6463+
6464+# Reproducible builds
6465+
6466+Some of the document formats pandoc targets (such as EPUB,
6467+docx, and ODT) include build timestamps in the generated document.
6468+That means that the files generated on successive builds will
6469+differ, even if the source does not. To avoid this, set the
6470+`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6471+be taken from it instead of the current time.
6472+`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6473+(specifying the number of second since midnight UTC January 1, 1970).
6474+
6475+Some document formats also include a unique identifier. For
6476+EPUB, this can be set explicitly by setting the `identifier`
6477+metadata field (see [EPUB Metadata], above).
6478+
6479+# A note on security
6480+
6481+If you use pandoc to convert user-contributed content in a web
6482+application, here are some things to keep in mind:
6483+
6484+1. Although pandoc itself will not create or modify any files other
6485+ than those you explicitly ask it create (with the exception
6486+ of temporary files used in producing PDFs), a filter or custom
6487+ writer could in principle do anything on your file system. Please
6488+ audit filters and custom writers very carefully before using them.
6489+
6490+2. If your application uses pandoc as a Haskell library (rather than
6491+ shelling out to the executable), it is possible to use it in a mode
6492+ that fully isolates pandoc from your file system, by running the
6493+ pandoc operations in the `PandocPure` monad. See the document
6494+ [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
6495+ for more details.
6496+
6497+3. Pandoc's parsers can exhibit pathological performance on some
6498+ corner cases. It is wise to put any pandoc operations under
6499+ a timeout, to avoid DOS attacks that exploit these issues.
6500+ If you are using the pandoc executable, you can add the
6501+ command line options `+RTS -M512M -RTS` (for example) to limit
6502+ the heap size to 512MB.
6503+
6504+4. The HTML generated by pandoc is not guaranteed to be safe.
6505+ If `raw_html` is enabled for the Markdown input, users can
6506+ inject arbitrary HTML. Even if `raw_html` is disabled,
6507+ users can include dangerous content in URLs and attributes.
6508+ To be safe, you should run all the generated HTML through
6509+ an HTML sanitizer.
6510+
6511+# Authors
6512+
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
6514+under the [GPL], version 2 or greater. This software carries no
6515+warranty of any kind. (See COPYRIGHT for full copyright and
6516+warranty notices.) For a full list of contributors, see the file
6517+AUTHORS.md in the pandoc source code.
6518+
6519+[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6520+[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"