@@ -1,50 +1,34 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% December 8, 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
18−markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],
19−[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],
20−[EPUB], [ODT], and [Word docx]; and it can write plain text, [Markdown],
21−[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
22−[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]
23−\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
24−[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
25−[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock
26−markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
29−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
30−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,
31−`wkhtmltopdf`, `prince`, or `weasyprint` is 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,98 +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−[JATS]: https://jats.nlm.nih.gov
79−[txt2tags]: http://txt2tags.org
80−[EPUB]: http://idpf.org/epub
81−[OPML]: http://dev.opml.org/spec2.html
82−[OpenDocument]: http://opendocument.xml.org
83−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
84−[Textile]: http://redcloth.org/textile
85−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
86−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
87−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
88−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
89−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
90−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
91−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
92−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
93−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
94−[Haskell]: https://www.haskell.org
95−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
96−[Emacs Org mode]: http://orgmode.org
97−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
98−[DZSlides]: http://paulrouget.com/dzslides/
99−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
100−[PDF]: https://www.adobe.com/pdf/
101−[reveal.js]: http://lab.hakim.se/reveal-js/
102−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
103−[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
104−[TEI Simple]: https://github.com/TEIC/TEI-Simple
105−[Muse]: https://amusewiki.org/library/manual
106−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
107−[Vimwiki]: https://vimwiki.github.io
108−
109−Using `pandoc`
110−--------------
43+## Using pandoc
11144
112−If no *input-file* is specified, input is read from *stdin*.
113−Otherwise, the *input-files* are concatenated (with a blank
114−line between each) and used as input. Output goes to *stdout* by
115−default (though output to the terminal is disabled for the
116−`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
117−forced using `-o -`). For output to a file, use the `-o`
118−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:
11948
12049 pandoc -o output.html input.txt
12150
122−By default, pandoc produces a document fragment, not a standalone
123−document with a proper header and footer. To produce a standalone
124−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:
12554
12655 pandoc -s -o output.html input.txt
12756
12857For more information on how standalone documents are produced, see
129−[Templates], below.
130−
131−Instead of a file, an absolute URI may be given. In this case
132−pandoc will fetch the content using HTTP:
133−
134− pandoc -f html -t markdown http://www.fsf.org
135−
136−It is possible to supply a custom User-Agent string or other
137−header when requesting a document from a URL:
138−
139− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
140− http://www.fsf.org
58+[Templates] below.
14159
14260If multiple input files are given, `pandoc` will concatenate them all (with
143−blank lines between them) before parsing. This feature is disabled for
144− 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
14565
14666The format of the input and output can be specified explicitly using
14767command-line options. The input format can be specified using the
148−`-r/--read` or `-f/--from` options, the output format using the
149−`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
150−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:
15170
15271 pandoc -f markdown -t latex hello.txt
15372
@@ -155,14 +74,15 @@ To convert `hello.html` from HTML to Markdown:
15574
15675 pandoc -f html -t markdown hello.html
15776
158−Supported output formats are listed below under the `-t/--to` option.
159−Supported input formats are listed below under the `-f/--from` option. Note
160−that the `rst`, `textile`, `latex`, and `html` readers are not complete;
161−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.
16282
16383If the input or output format is not specified explicitly, `pandoc`
164−will attempt to guess it from the extensions of
165−the input and output filenames. Thus, for example,
84+will attempt to guess it from the extensions of the filenames.
85+Thus, for example,
16686
16787 pandoc -o hello.tex hello.txt
16888
@@ -171,7 +91,9 @@ is specified (so that output goes to *stdout*), or if the output file's
17191extension is unknown, the output format will default to HTML.
17292If no input file is specified (so that input comes from *stdin*), or
17393if the input files' extensions are unknown, the input format will
174−be assumed to be Markdown unless explicitly specified.
94+be assumed to be Markdown.
95+
96+## Character encoding
17597
17698Pandoc uses the UTF-8 character encoding for both input and output.
17799If your local character encoding is not UTF-8, you
@@ -184,156 +106,247 @@ RTF, OPML, DocBook, and Texinfo), information about
184106the character encoding is included in the document header, which
185107will only be included if you use the `-s/--standalone` option.
186108
187−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
188110
189−Creating a PDF
190−--------------
111+## Creating a PDF
191112
192−To produce a PDF, specify an output file with a `.pdf` extension.
193−By default, pandoc will use LaTeX to create the PDF:
113+To produce a PDF, specify an output file with a `.pdf` extension:
194114
195115 pandoc test.txt -o test.pdf
196116
197−Production of a PDF requires that a LaTeX engine be installed (see
198−`--pdf-engine`, below), and assumes that the following LaTeX packages
199−are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
200−[`ifxetex`], [`ifluatex`], [`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
201140`--listings` option is used), [`fancyvrb`], [`longtable`],
202−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
203−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
204−`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
205145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
206−the LaTeX engine requires [`fontspec`]. `xelatex` uses
207−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
208−`dir` variable set). If the `mathspec` variable is set,
209−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
210−The [`upquote`] and [`microtype`] packages are used if
211−available, and [`csquotes`] will be used for [typography]
212−if added to the template or included in any header file. The
213−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
214−optionally be used for [citation rendering]. These are included
215−with all recent versions of [TeX Live].
216−
217−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
218−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
219−[`weasyprint`] or [`prince`].
220−To do this, specify an output file with a `.pdf` extension, as before,
221−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
222−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
223−
224−PDF output can be controlled using [variables for LaTeX] (if
225−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
226−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
227−If `wkhtmltopdf` is used, then the variables `margin-left`,
228−`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
229−will affect the output.
230−
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/
231165[`amsfonts`]: https://ctan.org/pkg/amsfonts
232166[`amsmath`]: https://ctan.org/pkg/amsmath
233−[`lm`]: https://ctan.org/pkg/lm
234−[`ifxetex`]: https://ctan.org/pkg/ifxetex
235−[`ifluatex`]: https://ctan.org/pkg/ifluatex
236−[`listings`]: https://ctan.org/pkg/listings
237−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
238−[`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
239173[`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
240180[`graphicx`]: https://ctan.org/pkg/graphicx
241181[`grffile`]: https://ctan.org/pkg/grffile
242−[`geometry`]: https://ctan.org/pkg/geometry
243−[`setspace`]: https://ctan.org/pkg/setspace
244−[`xecjk`]: https://ctan.org/pkg/xecjk
245182[`hyperref`]: https://ctan.org/pkg/hyperref
246−[`ulem`]: https://ctan.org/pkg/ulem
247−[`babel`]: https://ctan.org/pkg/babel
248−[`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
249187[`mathspec`]: https://ctan.org/pkg/mathspec
250−[`unicode-math`]: https://ctan.org/pkg/unicode-math
251−[`polyglossia`]: https://ctan.org/pkg/polyglossia
252−[`fontspec`]: https://ctan.org/pkg/fontspec
253−[`upquote`]: https://ctan.org/pkg/upquote
254188[`microtype`]: https://ctan.org/pkg/microtype
255−[`csquotes`]: https://ctan.org/pkg/csquotes
256189[`natbib`]: https://ctan.org/pkg/natbib
257−[`biblatex`]: https://ctan.org/pkg/biblatex
258−[`bibtex`]: https://ctan.org/pkg/bibtex
259−[`biber`]: https://ctan.org/pkg/biber
260−[TeX Live]: http://www.tug.org/texlive/
261−[`wkhtmltopdf`]: https://wkhtmltopdf.org
262−[`weasyprint`]: http://weasyprint.org
190+[`parskip`]: https://ctan.org/pkg/parskip
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
263192[`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
264218
265−Options
266−=======
219+# Options
267220
268−General options
269−---------------
221+## General options {.options}
270222
271223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
272224
273−: Specify input format. *FORMAT* can be `native` (native Haskell),
274− `json` (JSON version of native AST), `markdown` (pandoc's
275− extended Markdown), `markdown_strict` (original unextended
276− Markdown), `markdown_phpextra` (PHP Markdown Extra),
277− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
278− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
279− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
280− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
281− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
282− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
283− `haddock` (Haddock markup), or `latex` (LaTeX).
284− (`markdown_github` provides deprecated and less accurate support
285− for Github-Flavored Markdown; please use `gfm` instead, unless you
286− need to use extensions other than `smart`.)
287− If `+lhs` is appended to `markdown`, `rst`, `latex`, or
288− `html`, the input will be treated as literate Haskell source: see
289− [Literate Haskell support], below. Markdown
290− syntax extensions can be individually enabled or disabled by
291− appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
292− example, `markdown_strict+footnotes+definition_lists` is strict
293− Markdown with footnotes and definition lists enabled, and
294− `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
295− without pipe tables and with hard line breaks. See [Pandoc's
296− 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
297273 their names. See `--list-input-formats` and `--list-extensions`,
298274 below.
299275
300276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
301277
302−: Specify output format. *FORMAT* can be `native` (native Haskell),
303− `json` (JSON version of native AST), `plain` (plain text),
304− `markdown` (pandoc's extended Markdown), `markdown_strict`
305− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
306− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
307− Markdown), `commonmark` (CommonMark Markdown), `rst`
308− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
309− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
310− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
311− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
312− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
313− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
314− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
315− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
316− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
317− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
318− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
319− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
320− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
321− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
322− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
323− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
324− the path of a custom lua writer (see [Custom writers],
325− below). (`markdown_github` provides deprecated and less accurate
326− support for Github-Flavored Markdown; please use `gfm` instead,
327− unless you use extensions that do not work with `gfm`.) Note that
328− `odt`, `epub`, and `epub3` output will not be directed to
329− *stdout*; an output filename must be specified using the
330− `-o/--output` option. If `+lhs` is appended to `markdown`, `rst`,
331− `latex`, `beamer`, `html4`, or `html5`, the output will be
332− rendered as literate Haskell source: see [Literate Haskell
333− support], below. Markdown syntax extensions can be individually
334− enabled or disabled by appending `+EXTENSION` or `-EXTENSION` to
335− the format name, as described above under `-f`. See
336− `--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.
337350
338351`-o` *FILE*, `--output=`*FILE*
339352
@@ -345,35 +358,43 @@ General options
345358
346359: Specify the user data directory to search for pandoc data files.
347360 If this option is not specified, the default user data directory
348− will be used. This is, in UNIX:
349−
350− $HOME/.pandoc
351−
352− in Windows XP:
353−
354− C:\Documents And Settings\USERNAME\Application Data\pandoc
355−
356− and in Windows Vista or later:
357−
358− C:\Users\USERNAME\AppData\Roaming\pandoc
359−
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`.
360368 You can find the default user data directory on your system by
361369 looking at the output of `pandoc --version`.
362− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
363− `slidy`, `slideous`, or `s5` directory
364− 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.
365387
366388`--bash-completion`
367389
368390: Generate a bash completion script. To enable bash completion
369391 with pandoc, add this to your `.bashrc`:
370392
371− eval "$(pandoc --bash-completion)"
393+ eval "$(pandoc --bash-completion)"
372394
373395`--verbose`
374396
375−: Give verbose debugging output. Currently this only has an effect
376− with PDF output.
397+: Give verbose debugging output.
377398
378399`--quiet`
379400
@@ -397,11 +418,12 @@ General options
397418
398419: List supported output formats, one per line.
399420
400−`--list-extensions`
421+`--list-extensions`[`=`*FORMAT*]
401422
402−: List supported Markdown extensions, one per line, followed
423+: List supported extensions for *FORMAT*, one per line, preceded
403424 by a `+` or `-` indicating whether it is enabled by default
404− in pandoc's Markdown.
425+ in *FORMAT*. If *FORMAT* is not specified, defaults for
426+ pandoc's Markdown are given.
405427
406428`--list-highlight-languages`
407429
@@ -421,12 +443,88 @@ General options
421443
422444: Show usage message.
423445
424−Reader options
425−--------------
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.
426522
427523`--base-header-level=`*NUMBER*
428524
429−: 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).
430528
431529`--strip-empty-paragraphs`
432530
@@ -456,7 +554,7 @@ Reader options
456554 footnotes and links will not work across files. Reading binary
457555 files (docx, odt, epub) implies `--file-scope`.
458556
459−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
460558
461559: Specify an executable to be used as a filter transforming the
462560 pandoc AST after the input is parsed and before the output is
@@ -491,47 +589,65 @@ Reader options
491589
492590 3. `$PATH` (executable only)
493591
494−`--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*
495596
496597: Transform the document in a similar fashion as JSON filters (see
497− `--filter`), but use pandoc's build-in lua filtering system. The given
498− lua script is expected to return a list of lua filters which will be
499− 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
500601 functions indexed by the name of the AST element on which the filter
501602 function should be applied.
502603
503− The `pandoc` lua module provides helper functions for element
504− 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.
606+
607+ See the [Lua filters documentation] for further details.
505608
506− The following is an example lua script for macro-expansion:
609+ In order of preference, pandoc will look for Lua filters in
507610
508− function expand_hello_world(inline)
509− if inline.c == '{{helloworld}}' then
510− return pandoc.Emph{ pandoc.Str "Hello, World" }
511− else
512− return inline
513− end
514− end
611+ 1. a specified full or relative path
515612
516− return {{Str = expand_hello_world}}
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
517615
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
518618
519619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
520620
521621: Set the metadata field *KEY* to the value *VAL*. A value specified
522− 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`].
523624 Values will be parsed as YAML boolean or string values. If no value is
524625 specified, the value will be treated as Boolean true. Like
525626 `--variable`, `--metadata` causes template variables to be set.
526627 But unlike `--variable`, `--metadata` affects the metadata of the
527628 underlying document (which is accessible from filters and may be
528− 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.
529644
530645`-p`, `--preserve-tabs`
531646
532−: Preserve tabs instead of converting them to spaces (the default).
533− Note that this will only affect tabs in literal code spans and code
534− 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.
535651
536652`--tab-stop=`*NUMBER*
537653
@@ -541,27 +657,30 @@ Reader options
541657
542658: Specifies what to do with insertions, deletions, and comments
543659 produced by the MS Word "Track Changes" feature. `accept` (the
544− default), inserts all insertions, and ignores all
545− deletions. `reject` inserts all deletions and ignores
546− insertions. Both `accept` and `reject` ignore comments. `all` puts
547− in insertions, deletions, and comments, wrapped in spans with
548− `insertion`, `deletion`, `comment-start`, and `comment-end`
549− classes, respectively. The author and time of change is
550− included. `all` is useful for scripting: only accepting changes
551− from a certain reviewer, say, or before a certain date. This
552− 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.
553672
554673`--extract-media=`*DIR*
555674
556675: Extract images and other media contained in or linked from
557676 the source document to the path *DIR*, creating it if
558677 necessary, and adjust the images references in the document
559− so they point to the extracted files. If the source format is
560− a binary container (docx, epub, or odt), the media is
561− extracted from the container and the original
562− filenames are used. Otherwise the media is read from the
563− file system or downloaded, and new filenames are constructed
564− 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.
565684
566685`--abbreviations=`*FILE*
567686
@@ -572,29 +691,30 @@ Reader options
572691 system default, use
573692 `pandoc --print-default-data-file=abbreviations`. The only
574693 use pandoc makes of this list is in the Markdown reader.
575− Strings ending in a period that are found in this list will
576− be followed by a nonbreaking space, so that the period will
577− 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.
578697
579698[`pandocfilters`]: https://github.com/jgm/pandocfilters
580699[PHP]: https://github.com/vinai/pandocfilters-php
581700[perl]: https://metacpan.org/pod/Pandoc::Filter
582701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
583703
584−General writer options
585−----------------------
704+## General writer options {.options}
586705
587706`-s`, `--standalone`
588707
589708: Produce output with an appropriate header and footer (e.g. a
590709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
591710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
592− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
593713
594−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
595715
596−: Use *FILE* as a custom template for the generated document. Implies
597− `--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
598718 of template syntax. If no extension is specified, an extension
599719 corresponding to the writer will be added, so that `--template=special`
600720 looks for `special.html` for HTML output. If the template is not
@@ -606,22 +726,29 @@ General writer options
606726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
607727
608728: Set the template variable *KEY* to the value *VAL* when rendering the
609− document in standalone mode. This is generally only useful when the
610− `--template` option is used to specify a custom template, since
611− pandoc automatically sets the variables used in the default
612− templates. If no *VAL* is specified, the key will be given the
613− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
614731
615732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
616733
617734: Print the system default template for an output *FORMAT*. (See `-t`
618735 for a list of possible *FORMAT*s.) Templates in the user data
619− 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`.
620745
621746`--print-default-data-file=`*FILE*
622747
623748: Print a system default data file. Files in the user data directory
624− 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.
625752
626753`--eol=crlf`|`lf`|`native`
627754
@@ -632,9 +759,12 @@ General writer options
632759
633760`--dpi`=*NUMBER*
634761
635−: Specify the dpi (dots per inch) value for conversion from pixels
636− to inch/centimeters and vice versa. The default is 96dpi.
637− 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.
638768
639769`--wrap=auto`|`none`|`preserve`
640770
@@ -647,6 +777,8 @@ General writer options
647777 where there are nonsemantic newlines in the source, there
648778 will be nonsemantic newlines in the output as well).
649779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
650782
651783`--columns=`*NUMBER*
652784
@@ -659,14 +791,21 @@ General writer options
659791: Include an automatically generated table of contents (or, in
660792 the case of `latex`, `context`, `docx`, `odt`,
661793 `opendocument`, `rst`, or `ms`, an instruction to create
662− one) in the output document. This option has no effect on
663− `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`.
664803
665804`--toc-depth=`*NUMBER*
666805
667806: Specify the number of section levels to include in the table
668− of contents. The default is 3 (which means that level 1, 2, and 3
669− 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).
670809
671810`--strip-comments`
672811
@@ -702,7 +841,10 @@ General writer options
702841
703842: Prints a JSON version of a highlighting style, which can
704843 be modified, saved with a `.theme` extension, and used
705− with `--highlight-style`.
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.
706848
707849`--syntax-definition=`*FILE*
708850
@@ -710,9 +852,10 @@ General writer options
710852 which will be used for syntax highlighting of appropriately
711853 marked code blocks. This can be used to add support for
712854 new languages or to use altered syntax definitions for
713− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
714857
715−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
716859
717860: Include contents of *FILE*, verbatim, at the end of the header.
718861 This can be used, for example, to include special
@@ -720,7 +863,7 @@ General writer options
720863 repeatedly to include multiple files in the header. They will be
721864 included in the order specified. Implies `--standalone`.
722865
723−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
724867
725868: Include contents of *FILE*, verbatim, at the beginning of the
726869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -729,7 +872,7 @@ General writer options
729872 used repeatedly to include multiple files. They will be included in
730873 the order specified. Implies `--standalone`.
731874
732−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
733876
734877: Include contents of *FILE*, verbatim, at the end of the document
735878 body (before the `</body>` tag in HTML, or the
@@ -748,28 +891,39 @@ General writer options
748891 will not be searched. For example:
749892 `--resource-path=.:test` will search the working directory
750893 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`.
751899
752900`--request-header=`*NAME*`:`*VAL*
753901
754902: Set the request header *NAME* to the value *VAL* when making
755903 HTTP requests (for example, when a URL is given on the
756904 command line, or when resources used in a document must be
757− downloaded).
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
758907
759−Options affecting specific writers
760−----------------------------------
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}
761915
762916`--self-contained`
763917
764918: Produce a standalone HTML file with no external dependencies, using
765919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
766− images, and videos. The resulting file should be "self-contained,"
767− in the sense that it needs no external files and no net access to be
768− displayed properly by a browser. This option works only with HTML output
769− formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
770− `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
771− stylesheets at absolute URLs will be downloaded; those at relative URLs
772− 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
773927 file is local) or relative to the base URL (if the first source
774928 file is remote). Elements with the attribute
775929 `data-external="1"` will be left alone; the documents they
@@ -782,13 +936,18 @@ Options affecting specific writers
782936
783937`--html-q-tags`
784938
785−: 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.)
786942
787943`--ascii`
788944
789−: Use only ASCII characters in output. Currently supported only for
790− HTML and DocBook output (which uses numerical entities instead of
791− 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.
792951
793952`--reference-links`
794953
@@ -797,36 +956,45 @@ Options affecting specific writers
797956 placement of link references is affected by the
798957 `--reference-location` option.
799958
800−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
801960
802961: Specify whether footnotes (and references, if `reference-links` is
803962 set) are placed at the end of the current (top-level) block, the
804963 current section, or the document. The default is
805964 `document`. Currently only affects the markdown writer.
806965
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+
807974`--atx-headers`
808975
809−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
810− to use setext-style headers for levels 1-2, and then ATX headers.
811− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
812977
813−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
814979
815−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
816− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
817− all headers are shifted such that the top-level header becomes the specified
818− type. The default behavior is to determine the best division type via
819− heuristics: unless other conditions apply, `section` is chosen. When the
820− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
821− `article` option is specified), `chapter` is implied as the setting for this
822− option. If `beamer` is the output format, specifying either `chapter` or
823− `part` will cause top-level headers to become `\part{..}`, while
824− 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.
825993
826994`-N`, `--number-sections`
827995
828−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
829− 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
830998 `unnumbered` will never be numbered, even if `--number-sections`
831999 is specified.
8321000
@@ -834,16 +1002,19 @@ Options affecting specific writers
8341002
8351003: Offset for section headings in HTML output (ignored in other
8361004 output formats). The first number is added to the section number for
837− top-level headers, the second for second-level headers, and so on.
838− 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
8391007 document to be numbered "6", specify `--number-offset=5`.
840− 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
8411009 be numbered "1.5", specify `--number-offset=1,4`.
8421010 Offsets are 0 by default. Implies `--number-sections`.
8431011
8441012`--listings`
8451013
846−: 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].
8471018
8481019`-i`, `--incremental`
8491020
@@ -852,22 +1023,22 @@ Options affecting specific writers
8521023
8531024`--slide-level=`*NUMBER*
8541025
855−: Specifies that headers with the specified level create
856− 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
8571028 above this level in the hierarchy are used to divide the
858− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
8591030 subheads within a slide. Note that content that is
860− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
8611032 the slide show. The default is to set the slide level based
8621033 on the contents of the document; see [Structuring the slide
8631034 show].
8641035
8651036`--section-divs`
8661037
867−: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
868− and attach identifiers to the enclosing `<div>` (or `<section>`)
869− rather than the header itself. See
870− [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.
8711042
8721043`--email-obfuscation=none`|`javascript`|`references`
8731044
@@ -888,8 +1059,7 @@ Options affecting specific writers
8881059
8891060: Specify *STRING* as a prefix at the beginning of the title
8901061 that appears in the HTML header (but not in the title as it
891− appears at the beginning of the HTML body). Implies
892− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
8931063
8941064`-c` *URL*, `--css=`*URL*
8951065
@@ -897,8 +1067,8 @@ Options affecting specific writers
8971067 include multiple files. They will be included in the order specified.
8981068
8991069 A stylesheet is required for generating EPUB. If none is
900− provided using this option (or the `stylesheet` metadata
901− 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
9021072 user data directory (see `--data-dir`). If it is not
9031073 found there, sensible defaults will be used.
9041074
@@ -921,20 +1091,56 @@ Options affecting specific writers
9211091
9221092 To produce a custom `reference.docx`, first get a copy of
9231093 the default `reference.docx`: `pandoc
924− --print-default-data-file reference.docx >
925− custom-reference.docx`. Then open `custom-reference.docx`
926− in Word, modify the styles as you wish, and save the file.
927− For best results, do not make changes to this file other
928− than modifying the styles used by pandoc: [paragraph]
929− Normal, Body Text, First Paragraph, Compact, Title,
930− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
931− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
932− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
933− Definition Term, Definition, Caption, Table Caption,
934− Image Caption, Figure, Captioned Figure, TOC Heading;
935− [character] Default Paragraph Font, Body Text Char,
936− Verbatim Char, Footnote Reference, Hyperlink; [table]
937− 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
9381144
9391145 ODT
9401146
@@ -948,10 +1154,33 @@ Options affecting specific writers
9481154
9491155 To produce a custom `reference.odt`, first get a copy of
9501156 the default `reference.odt`: `pandoc
951− --print-default-data-file reference.odt >
952− custom-reference.odt`. Then open `custom-reference.odt` in
953− LibreOffice, modify the styles as you wish, and save the
954− 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).
9551184
9561185`--epub-cover-image=`*FILE*
9571186
@@ -1019,12 +1248,12 @@ Options affecting specific writers
10191248
10201249`--epub-chapter-level=`*NUMBER*
10211250
1022−: Specify the header level at which to split the EPUB into separate
1023− "chapter" files. The default is to split into chapters at level 1
1024− 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
10251254 EPUB, not the way chapters and sections are displayed to users. Some
10261255 readers may be slow if the chapter files are too large, so for large
1027− 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
10281257 level of 2 or 3.
10291258
10301259`--epub-subdirectory=`*DIRNAME*
@@ -1033,69 +1262,118 @@ Options affecting specific writers
10331262 the EPUB-specific contents. The default is `EPUB`. To put
10341263 the EPUB contents in the top level, use an empty string.
10351264
1036−`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
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*
10371275
10381276: Use the specified engine when producing PDF output.
1039− The default is `pdflatex`. If the engine is not in your PATH,
1040− the full path of the engine may be specified here.
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`
10411291
10421292`--pdf-engine-opt=`*STRING*
10431293
10441294: Use the given string as a command-line argument to the `pdf-engine`.
1045− If used multiple times, the arguments are provided with spaces between
1046− them. Note that no check for duplicate options is done.
1047−
1048−[Dublin Core elements]: http://dublincore.org/documents/dces/
1049−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1050−
1051−Citation rendering
1052−------------------
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].
10531324
10541325`--bibliography=`*FILE*
10551326
10561327: Set the `bibliography` field in the document's metadata to *FILE*,
1057− overriding any value set in the metadata, and process citations
1058− using `pandoc-citeproc`. (This is equivalent to
1059− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1060− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1061− used, making this equivalent to `--metadata bibliography=FILE`.
1062− If you supply this argument multiple times, each *FILE* will be added
1063− 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`).
10641334
10651335`--csl=`*FILE*
10661336
10671337: Set the `csl` field in the document's metadata to *FILE*,
10681338 overriding any value set in the metadata. (This is equivalent to
1069− `--metadata csl=FILE`.)
1070− 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.
10711344
10721345`--citation-abbreviations=`*FILE*
10731346
10741347: Set the `citation-abbreviations` field in the document's metadata to
10751348 *FILE*, overriding any value set in the metadata. (This is equivalent to
10761349 `--metadata citation-abbreviations=FILE`.)
1077− 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.
10781354
10791355`--natbib`
10801356
1081−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1082− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1083− 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`].
10841361
10851362`--biblatex`
10861363
1087−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1088− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1089− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
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`].
10901368
1091−Math rendering in HTML
1092−----------------------
1369+## Math rendering in HTML {.options}
10931370
1094−The default is to render TeX math as far as possible using Unicode characters.
1095−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1096−differently from the surrounding text if needed. However, this gives acceptable
1097−results only for basic math, usually you will want to use `--mathjax` or another
1098−of the following options.
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.
10991377
11001378`--mathjax`[`=`*URL*]
11011379
@@ -1106,13 +1384,14 @@ of the following options.
11061384 The *URL* should point to the `MathJax.js` load script.
11071385 If a *URL* is not provided, a link to the Cloudflare CDN will
11081386 be inserted.
1109−
1387+
11101388`--mathml`
11111389
1112−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1113− `html4` and `html5`). This is the default in `odt` output. Note that
1114− currently only Firefox and Safari (and select e-book readers) natively
1115− support MathML.
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.
11161395
11171396`--webtex`[`=`*URL*]
11181397
@@ -1129,67 +1408,26 @@ of the following options.
11291408`--katex`[`=`*URL*]
11301409
11311410: Use [KaTeX] to display embedded TeX math in HTML output.
1132− The *URL* is the base URL for the KaTeX library. If a *URL* is
1133− not provided, a link to the KaTeX CDN will be inserted.
1134−
1135−`--katex-stylesheet=`*URL*
1136−
1137−: The *URL* should point to the `katex.css` stylesheet. If this option is
1138− not specified, a link to the KaTeX CDN will be inserted. Note that this
1139− option does not imply `--katex`.
1140−
1141−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1142−
1143−: *Deprecated.*
1144− Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1145− TeX math will be displayed between `$` or `$$` characters and put in
1146− `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1147− change it to MathML. Note that currently only Firefox and Safari
1148− (and select e-book readers) natively support MathML.
1149− To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1150−
1151−`--jsmath`[`=`*URL*]
1152−
1153−: *Deprecated.*
1154− Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1155− math in HTML output. TeX math will be put inside `<span>` tags
1156− (for inline math) or `<div>` tags (for display math) with class
1157− `math` and rendered by the jsMath script. The *URL* should point to
1158− the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1159− to in the header of standalone HTML documents. If a *URL* is not provided,
1160− no link to the jsMath load script will be inserted; it is then
1161− up to the author to provide such a link in the HTML template.
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.
11621414
11631415`--gladtex`
11641416
1165−: *Deprecated.*
1166− Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1167− can then be processed by [gladTeX] to produce images of the typeset
1168− formulas and an HTML file with links to these images.
1169− So, the procedure is:
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.
11701420
11711421 pandoc -s --gladtex input.md -o myfile.htex
1172− gladtex -d myfile-images myfile.htex
1173− # produces myfile.html and images in myfile-images
1174−
1175−`--mimetex`[`=`*URL*]
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
11761424
1177−: *Deprecated.*
1178− Render TeX math using the [mimeTeX] CGI script, which generates an
1179− image for each TeX formula. This should work in all browsers. If
1180− *URL* is not specified, it is assumed that the script is at
1181− `/cgi-bin/mimetex.cgi`.
1182−
1183−[MathML]: http://www.w3.org/Math/
1184−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1185−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1425+[MathML]: https://www.w3.org/Math/
11861426[MathJax]: https://www.mathjax.org
1187−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1188−[mimeTeX]: http://www.forkosh.com/mimetex.html
11891427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
11901429
1191−Options for wrapper scripts
1192−---------------------------
1430+## Options for wrapper scripts {.options}
11931431
11941432`--dump-args`
11951433
@@ -1213,8 +1451,277 @@ Options for wrapper scripts
12131451
12141452 pandoc -o foo.html -s
12151453
1216−Templates
1217−=========
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
12181725
12191726When the `-s/--standalone` option is used, pandoc uses a template to
12201727add header and footer material that is needed for a self-standing
@@ -1233,486 +1740,1428 @@ directory (see `--data-dir`, above). *Exceptions:*
12331740- For `pdf` output, customize the `default.latex` template
12341741 (or the `default.context` template, if you use `-t context`,
12351742 or the `default.ms` template, if you use `-t ms`, or the
1236− `default.html5` template, if you use `-t html5`).
1237−- `docx` has no template (however, you can use
1743+ `default.html` template, if you use `-t html`).
1744+- `docx` and `pptx` have no template (however, you can use
12381745 `--reference-doc` to customize the output).
12391746
12401747Templates contain *variables*, which allow for the inclusion of
1241−arbitrary information at any point in the file. Variables may be set
1242−within the document using [YAML metadata blocks][Extension:
1243−`yaml_metadata_block`]. They may also be set at the
1244−command line using the `-V/--variable` option: variables set in this
1245−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.
12461755
1247−Variables set by pandoc
1248−-----------------------
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.
12491761
1250−Some variables are set automatically by pandoc. These vary somewhat
1251−depending on the output format, but include metadata fields as well
1252−as the following:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
12531763
1254−`sourcefile`, `outputfile`
1255−: source and destination filenames, as given on the command line.
1256− `sourcefile` can also be a list if input comes from multiple files, or empty
1257− if input is from stdin. You can use the following snippet in your template
1258− to distinguish them:
1764+## Template syntax
12591765
1260− $if(sourcefile)$
1261− $for(sourcefile)$
1262− $sourcefile$
1263− $endfor$
1264− $else$
1265− (stdin)
1266− $endif$
1766+### Comments
12671767
1268− 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.
12691770
1270−`title`, `author`, `date`
1271−: allow identification of basic aspects of the document. Included
1272− in PDF metadata through LaTeX and ConTeXt. These can be set
1273− through a [pandoc title block][Extension: `pandoc_title_block`],
1274− which allows for multiple authors, or through a YAML metadata block:
1771+### Delimiters
12751772
1276− ---
1277− author:
1278− - Aristotle
1279− - Peter Abelard
1280− ...
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.
12811781
1282−`subtitle`
1283−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1284− renders in LaTeX only when using a document class that supports
1285− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1286− `scrreprt`, `scrbook`).[^subtitle]
1782+To include a literal `$` in the document, use `$$`.
12871783
1288−`institute`
1289−: author affiliations (in LaTeX and Beamer only). Can be a
1290− list, when there are multiple authors.
1784+### Interpolated variables
12911785
1292−`abstract`
1293−: 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:
12941791
1295−`keywords`
1296−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1297− 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+```
12981802
1299−`header-includes`
1300−: contents specified by `-H/--include-in-header` (may have multiple
1301− 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.
13021807
1303−`toc`
1304−: 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.
13051815
1306−`toc-title`
1307−: title of table of contents (works only with EPUB,
1308− opendocument, odt, docx)
1816+### Conditionals
13091817
1310−`include-before`
1311−: contents specified by `-B/--include-before-body` (may have
1312− 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:
13131824
1314−`include-after`
1315−: contents specified by `-A/--include-after-body` (may have
1316− multiple values)
1825+```
1826+$if(foo)$bar$endif$
13171827
1318−`body`
1319−: body of document
1828+$if(foo)$
1829+ $foo$
1830+$endif$
13201831
1321−`meta-json`
1322−: JSON representation of all of the document's metadata. Field
1323− values are transformed to the selected output format.
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
13241837
1325−[^subtitle]: To make `subtitle` work with other LaTeX
1326− document classes, you can add the following to `header-includes`:
1838+${if(foo)}bar${endif}
13271839
1328− \providecommand{\subtitle}[1]{%
1329− \usepackage{titling}
1330− \posttitle{%
1331− \par\large#1\end{center}}
1332− }
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
13331843
1334−Language variables
1335−------------------
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
13361850
1337−`lang`
1338−: identifies the main language of the document,
1339− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1340− For some output formats, pandoc will convert it to an appropriate
1341− format stored in the additional variables `babel-lang`,
1342− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1343−
1344− Native pandoc `span`s and `div`s with the lang attribute
1345− (value in BCP 47) can be used to switch the language in
1346− that range.
1347−
1348−`otherlangs`
1349−: a list of other languages used in the document
1350− in the YAML metadata, according to [BCP 47]. For example:
1351− `otherlangs: [en-GB, fr]`.
1352− This is automatically generated from the `lang` attributes
1353− in all `span`s and `div`s but can be overridden.
1354− Currently only used by LaTeX through the generated
1355− `babel-otherlangs` and `polyglossia-otherlangs` variables.
1356− The LaTeX writer outputs polyglossia commands in the text but
1357− the `babel-newcommands` variable contains mappings for them
1358− to the corresponding babel.
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
13591853
1360−`dir`
1361−: the base direction of the document, either `rtl` (right-to-left)
1362− or `ltr` (left-to-right).
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
13631863
1364− For bidirectional documents, native pandoc `span`s and `div`s
1365− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1366− override the base direction in some output formats.
1367− This may not always be necessary if the final renderer
1368− (e.g. the browser, when generating HTML) supports the
1369− [Unicode Bidirectional Algorithm].
1864+### For loops
13701865
1371− When using LaTeX for bidirectional documents, only the `xelatex` engine
1372− is fully supported (use `--pdf-engine=xelatex`).
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
13731869
1374−[BCP 47]: https://tools.ietf.org/html/bcp47
1375−[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.
13761877
1377−Variables for slides
1378−--------------------
1878+Examples:
13791879
1380−Variables are available for [producing slide shows with pandoc],
1381−including all [reveal.js configuration options].
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
13821882
1383−`titlegraphic`
1384−: title graphic for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
13851886
1386−`logo`
1387−: logo for Beamer documents
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
13881890
1389−`slidy-url`
1390−: base URL for Slidy documents (defaults to
1391− `https://www.w3.org/Talks/Tools/Slidy2`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
13921895
1393−`slideous-url`
1394−: 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.
13951899
1396−`s5-url`
1397−: base URL for S5 documents (defaults to `s5/default`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
13981903
1399−`revealjs-url`
1400−: 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.
14011906
1402−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1403−: themes for LaTeX [`beamer`] documents
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
14041912
1405−`themeoptions`
1406−: options for LaTeX beamer themes (a list).
1913+### Partials
14071914
1408−`navigation`
1409−: controls navigation symbols in `beamer` documents
1410− (default is `empty` for no navigation symbols; other valid values
1411− 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:
14121918
1413−`section-titles`
1414−: enables on "title pages" for new sections in `beamer`
1415− documents (default = true).
1919+```
1920+${ styles() }
1921+```
14161922
1417−`beamerarticle`
1418−: when true, the `beamerarticle` package is loaded (for
1419− 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:
14201928
1421−`aspectratio`
1422−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1423− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1424− default, and `32` for 3:2).
1929+```
1930+${ styles.html() }
1931+```
14251932
1426−[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.)
14271937
1428−Variables for LaTeX
1429−-------------------
1938+Partials may optionally be applied to variables using
1939+a colon:
14301940
1431−LaTeX variables are used when [creating a PDF].
1941+```
1942+${ date:fancy() }
14321943
1433−`papersize`
1434−: paper size, e.g. `letter`, `a4`
1944+${ articles:bibentry() }
1945+```
14351946
1436−`fontsize`
1437−: 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
14381950
1439−`documentclass`
1440−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
14411956
1442−`classoption`
1443−: option for document class, e.g. `oneside`; may be repeated
1444− 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`.
14451961
1446−`geometry`
1447−: option for [`geometry`] package, e.g. `margin=1in`;
1448− may be repeated for multiple options
1962+Final newlines are omitted from included partials.
1963+
1964+Partials may include other partials.
1965+
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
1969+
1970+```
1971+${months[, ]}$
1972+
1973+${articles:bibentry()[; ]$
1974+```
1975+
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.
1979+
1980+### Nesting
1981+
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
1984+
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
1988+
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
1991+
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
1996+
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
1999+
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
2004+
2005+will produce
2006+
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
2012+
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.
2017+
2018+### Breakable spaces
2019+
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 `~`).
2024+
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
2029+
2030+### Pipes
2031+
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:
2035+
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
2040+
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
2044+
2045+$employee:name()/uppercase$
2046+```
2047+
2048+Pipes may be chained:
2049+
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
2055+
2056+Some pipes take parameters:
2057+
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
2065+
2066+Currently the following pipes are predefined:
2067+
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.
2072+
2073+- `uppercase`: Converts text to uppercase.
2074+
2075+- `lowercase`: Converts text to lowercase.
2076+
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.
2080+
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2083+
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2087+
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
2091+
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.
2095+
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.
2099+
2100+- `chomp`: Removes trailing newlines (and breakable space).
2101+
2102+- `nowrap`: Disables line wrapping on breakable spaces.
2103+
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`.
2109+
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`.
2114+
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.
2122+
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.
2126+
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.
2130+
2131+
2132+## Variables
2133+
2134+### Metadata variables
2135+
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`]:
2142+
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
2148+
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.
2155+
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
2159+
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
2163+
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
2167+
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
2170+
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
2174+
2175+`category`
2176+: document category, included in docx and pptx metadata
2177+
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:
2182+
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.
2192+
2193+ It consists of two paragraphs
2194+ ...
2195+
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.
2199+
2200+### Language variables
2201+
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.
2208+
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
2211+
2212+ ---
2213+ lang: en-GB
2214+ ...
2215+
2216+ Text in the main document language (British English).
2217+
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
2221+
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
2223+
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
2227+
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].
2234+
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
2238+
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/
2242+
2243+### Variables for HTML
2244+
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`.
2252+
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
2255+
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).
2260+
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
2263+
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
2266+
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
2269+
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2273+
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
2277+
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
14492280
14502281`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1451−: sets margins, if `geometry` is not used (otherwise `geometry`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
2283+
2284+To override or extend some [CSS] for just one document, include for example:
2285+
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+ ---
2303+
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305+
2306+### Variables for HTML math
2307+
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`.
2312+
2313+### Variables for HTML slides
2314+
2315+These affect HTML output when [producing slide shows with pandoc].
2316+
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
2319+
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
2323+
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
2326+
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
2330+
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
2333+
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.
2337+
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`.
2340+
2341+[reveal.js configuration options]: https://revealjs.com/config/
2342+
2343+### Variables for Beamer slides
2344+
2345+These variables change the appearance of PDF slides using [`beamer`].
2346+
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)
2351+
2352+`beamerarticle`
2353+: produce an article from Beamer slides
2354+
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
2357+
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
2360+
2361+`logo`
2362+: logo image for slides
2363+
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367+
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
2370+
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
2373+
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
2376+
2377+`titlegraphic`
2378+: image for title slide
2379+
2380+### Variables for PowerPoint
2381+
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
2384+
2385+`monofont`
2386+: font to use for code.
2387+
2388+### Variables for LaTeX
2389+
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2391+
2392+#### Layout
2393+
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:
2401+
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+ ...
2415+
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
2418+
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
2424+
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`]
2430+
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
2434+
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
2441+
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2445+
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
2452+
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)
2457+
2458+`linestretch`
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
2461+
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
14522464 overrides these)
14532465
1454−`linestretch`
1455−: adjusts line spacing using the [`setspace`]
1456− package, e.g. `1.25`, `1.5`
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.)
14572903
1458−`fontfamily`
1459−: font package for use with `pdflatex`:
1460− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1461− The default is [Latin Modern][`lm`].
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:
14622908
1463−`fontfamilyoptions`
1464−: options for package used as `fontfamily`: e.g. `osf,sc` with
1465− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1466− figures and true small caps; may be repeated for multiple options
2909+ See the section on
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
14672911
1468−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1469−: font families for use with `xelatex` or
1470− `lualatex`: take the name of any system font, using the
1471− [`fontspec`] package. Note that if `CJKmainfont` is used,
1472− the [`xecjk`] package must be available.
2912+Note, however, that this method of providing links to sections works
2913+only in HTML, LaTeX, and ConTeXt formats.
14732914
1474−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1475−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1476− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1477− available through [`fontspec`], such as the OpenType features
1478− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
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.
14792921
1480−`fontenc`
1481−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1482− default is `T1` (see guide to [LaTeX font encodings])
2922+#### Extension: `ascii_identifiers` ####
14832923
1484−`microtypeoptions`
1485−: options to pass to the microtype package
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.
14862927
1487−`colorlinks`
1488−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1489− `urlcolor`, or `toccolor` are set
2928+#### Extension: `gfm_auto_identifiers` ####
14902929
1491−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1492−: color for internal links, citation links, external links, and links in table of contents:
1493− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
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.
14942935
1495−`links-as-notes`
1496−: causes links to be printed as footnotes
2936+## Math Input
14972937
1498−`indent`
1499−: uses document class settings for indentation (the default LaTeX template
1500− otherwise removes indentation and adds space between paragraphs)
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.
15012942
1502−`subparagraph`
1503−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1504− as sections, changing the appearance of nested headings in some classes
2943+However, they can also be used with HTML input. This is handy for
2944+reading web pages formatted using MathJax, for example.
15052945
1506−`thanks`
1507−: specifies contents of acknowledgments footnote after document title.
2946+## Raw HTML/TeX
15082947
1509−`toc`
1510−: include table of contents (can also be set using `--toc/--table-of-contents`)
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
15112950
1512−`toc-depth`
1513−: level of section to include in table of contents
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.
15142954
1515−`secnumdepth`
1516−: numbering depth for sections, if sections are numbered
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`):
15172958
1518−`lof`, `lot`
1519−: include list of figures, list of tables
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
15202962
1521−`bibliography`
1522−: bibliography to use for resolving references
2963+ output formats
2964+ : `textile`, `commonmark`
15232965
1524−`biblio-style`
1525−: bibliography style, when used with `--natbib` and `--biblatex`.
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`.
15262973
1527−`biblio-title`
1528−: bibliography title, when used with `--natbib` and `--biblatex`.
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`.
15292978
1530−`biblatexoptions`
1531−: list of options for biblatex.
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`.
15322985
1533−`natbiboptions`
1534−: list of options for natbib.
2986+## Literate Haskell support
15352987
1536−`pagestyle`
1537−: An option for LaTeX's `\pagestyle{}`. The default article class
1538− supports 'plain' (default), 'empty', and 'headings'; headings puts
1539− section titles in the header.
2988+#### Extension: `literate_haskell` ####
15402989
1541−[`article`]: https://ctan.org/pkg/article
1542−[`report`]: https://ctan.org/pkg/report
1543−[`book`]: https://ctan.org/pkg/book
1544−[KOMA-Script]: https://ctan.org/pkg/koma-script
1545−[`memoir`]: https://ctan.org/pkg/memoir
1546−[`xcolor`]: https://ctan.org/pkg/xcolor
1547−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1548−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1549−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2990+Treat the document as literate Haskell source.
15502991
1551−Variables for ConTeXt
1552−---------------------
2992+This extension can be enabled/disabled for the following formats:
15532993
1554−`papersize`
1555−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1556− may be repeated for multiple options
2994+input formats
2995+: `markdown`, `rst`, `latex`
15572996
1558−`layout`
1559−: options for page margins and text arrangement (see [ConTeXt Layout]);
1560− may be repeated for multiple options
2997+output formats
2998+: `markdown`, `rst`, `latex`, `html`
15612999
1562−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1563−: sets margins, if `layout` is not used (otherwise `layout`
1564− overrides these)
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
15653003
1566−`fontsize`
1567−: font size for body text (e.g. `10pt`, `12pt`)
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 '#'.
15683008
1569−`mainfont`, `sansfont`, `monofont`, `mathfont`
1570−: font families: take the name of any system font (see [ConTeXt Font Switching])
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.)
15713015
1572−`linkcolor`, `contrastcolor`
1573−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
3016+ - In restructured text input, "bird track" sections will be parsed
3017+ as Haskell code.
15743018
1575−`linkstyle`
1576−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
3019+ - In restructured text output, code blocks with class `haskell` will
3020+ be rendered using bird tracks.
15773021
1578−`indenting`
1579−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1580− may be repeated for multiple options
3022+ - In LaTeX input, text in `code` environments will be parsed as
3023+ Haskell code.
15813024
1582−`whitespace`
1583−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
3025+ - In LaTeX output, code blocks with class `haskell` will be rendered
3026+ inside `code` environments.
15843027
1585−`interlinespace`
1586−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1587− may be repeated for multiple options
3028+ - In HTML output, code blocks with class `haskell` will be rendered
3029+ with class `literatehaskell` and bird tracks.
15883030
1589−`headertext`, `footertext`
1590−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1591− may be repeated up to four times for different placement
3031+Examples:
15923032
1593−`pagenumbering`
1594−: page number style and location (using [`setuppagenumbering`]);
1595− may be repeated for multiple options
3033+ pandoc -f markdown+lhs -t html
15963034
1597−`toc`
1598−: include table of contents (can also be set using `--toc/--table-of-contents`)
3035+reads literate Haskell source formatted with Markdown conventions and writes
3036+ordinary HTML (without bird tracks).
15993037
1600−`lof`, `lot`
1601−: include list of figures, list of tables
3038+ pandoc -f markdown+lhs -t html+lhs
16023039
1603−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1604−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1605−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1606−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1607−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1608−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1609−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1610−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1611−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
3040+writes HTML with the Haskell code in bird tracks, so it can be copied
3041+and pasted as literate Haskell source.
16123042
1613−Variables for man pages
1614−-----------------------
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.
16153046
1616−`section`
1617−: section number in man pages
3047+## Other extensions
16183048
1619−`header`
1620−: header in man pages
3049+#### Extension: `empty_paragraphs` ####
16213050
1622−`footer`
1623−: footer in man pages
3051+Allows empty paragraphs. By default empty paragraphs are
3052+omitted.
16243053
1625−`adjusting`
1626−: adjusts text to left (`l`), right (`r`), center (`c`),
1627− or both (`b`) margins
3054+This extension can be enabled/disabled for the following formats:
16283055
1629−`hyphenate`
1630−: if `true` (the default), hyphenation will be used
3056+input formats
3057+: `docx`, `html`
16313058
1632−Variables for ms
1633−----------------
3059+output formats
3060+: `docx`, `odt`, `opendocument`, `html`
16343061
1635−`pointsize`
1636−: point size (e.g. `10p`)
3062+#### Extension: `native_numbering` ####
16373063
1638−`lineheight`
1639−: line height (e.g. `12p`)
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
16403066
1641−`fontfamily`
1642−: font family (e.g. `T` or `P`)
3067+This extension can be enabled/disabled for the following formats:
16433068
1644−`indent`
1645−: paragraph indent (e.g. `2m`)
3069+output formats
3070+: `odt`, `opendocument`
16463071
1647−Using variables in templates
1648−----------------------------
3072+#### Extension: `xrefs_name` ####
16493073
1650−Variable names are sequences of alphanumerics, `-`, and `_`,
1651−starting with a letter. A variable name surrounded by `$` signs
1652−will be replaced by its value. For example, the string `$title$` in
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.
16533080
1654− <title>$title$</title>
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
16553083
1656−will be replaced by the document title.
3084+This extension can be enabled/disabled for the following formats:
16573085
1658−To write a literal `$` in a template, use `$$`.
3086+output formats
3087+: `odt`, `opendocument`
16593088
1660−Templates may contain conditionals. The syntax is as follows:
3089+#### Extension: `xrefs_number` ####
16613090
1662− $if(variable)$
1663− X
1664− $else$
1665− Y
1666− $endif$
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.
16673096
1668−This will include `X` in the template if `variable` has a non-null
1669−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1670−any valid template text, and may include interpolated variables or other
1671−conditionals. The `$else$` section may be omitted.
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.
16723100
1673−When variables can have multiple values (for example, `author` in
1674−a multi-author document), you can use the `$for$` keyword:
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
16753103
1676− $for(author)$
1677− <meta name="author" content="$author$" />
1678− $endfor$
3104+This extension can be enabled/disabled for the following formats:
16793105
1680−You can optionally specify a separator to be used between
1681−consecutive items:
3106+output formats
3107+: `odt`, `opendocument`
16823108
1683− $for(author)$$author$$sep$, $endfor$
3109+#### Extension: `styles` #### {#ext-styles}
16843110
1685−A dot can be used to select a field of a variable that takes
1686−an object as its value. So, for example:
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.
16873116
1688− $author.name$ ($author.affiliation$)
3117+input formats
3118+: `docx`
16893119
1690−If you use custom templates, you may need to revise them as pandoc
1691−changes. We recommend tracking the changes in the default templates,
1692−and modifying your custom templates accordingly. An easy way to do this
1693−is to fork the [pandoc-templates] repository and merge in changes after each
1694−pandoc release.
3120+#### Extension: `amuse` ####
16953121
1696−Templates may contain comments: anything on a line after `$--`
1697−will be treated as a comment and ignored.
3122+In the `muse` input format, this enables Text::Amuse
3123+extensions to Emacs Muse markup.
16983124
1699−[pandoc-templates]: https://github.com/jgm/pandoc-templates
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.
17003137
1701−Pandoc's Markdown
1702−=================
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
17033155
17043156Pandoc understands an extended and slightly revised version of
17053157John Gruber's [Markdown] syntax. This document explains the syntax,
17063158noting differences from standard Markdown. Except where noted, these
17073159differences can be suppressed by using the `markdown_strict` format instead
1708−of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1709−to the format name and disabled by adding `-EXTENSION`. For example,
1710−`markdown_strict+footnotes` is strict Markdown with footnotes
1711−enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1712−Markdown without footnotes or pipe tables.
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.
17133163
1714−Philosophy
1715−----------
3164+## Philosophy
17163165
17173166Markdown is designed to be easy to write, and, even more importantly,
17183167easy to read:
@@ -1720,7 +3169,7 @@ easy to read:
17203169> A Markdown-formatted document should be publishable as-is, as plain
17213170> text, without looking like it's been marked up with tags or formatting
17223171> instructions.
1723−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
17243173
17253174This principle has guided pandoc's decisions in finding syntax for
17263175tables, footnotes, and other extensions.
@@ -1733,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
17333182important document elements like definition lists, tables, mathematics, and
17343183footnotes.
17353184
1736−Paragraphs
1737−----------
3185+## Paragraphs
17383186
17393187A paragraph is one or more lines of text followed by one or more blank lines.
17403188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -1747,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
17473195to create a hard line break, since trailing spaces in the cells
17483196are ignored.
17493197
1750−Headers
1751−-------
3198+## Headings
17523199
1753−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
17543201
1755−### Setext-style headers ###
3202+### Setext-style headings ###
17563203
1757−A setext-style header is a line of text "underlined" with a row of `=` signs
1758−(for a level one header) or `-` signs (for a level two header):
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):
17593206
1760− A level-one header
1761− ==================
3207+ A level-one heading
3208+ ===================
17623209
1763− A level-two header
1764− ------------------
3210+ A level-two heading
3211+ -------------------
17653212
1766−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
17673214[Inline formatting], below).
17683215
17693216
1770−### ATX-style headers ###
3217+### ATX-style headings ###
17713218
1772−An ATX-style header consists of one to six `#` signs and a line of
3219+An ATX-style heading consists of one to six `#` signs and a line of
17733220text, optionally followed by any number of `#` signs. The number of
1774−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
17753222
1776− ## A level-two header
3223+ ## A level-two heading
17773224
1778− ### A level-three header ###
3225+ ### A level-three heading ###
17793226
1780−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
17813228
1782− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
17833230
17843231#### Extension: `blank_before_header` ####
17853232
1786−Standard Markdown syntax does not require a blank line before a header.
3233+Standard Markdown syntax does not require a blank line before a heading.
17873234Pandoc does require this (except, of course, at the beginning of the
17883235document). The reason for the requirement is that it is all too easy for a
17893236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -1795,27 +3242,30 @@ wrapping). Consider, for example:
17953242#### Extension: `space_in_atx_header` ####
17963243
17973244Many Markdown implementations do not require a space between the
1798−opening `#`s of an ATX header and the header text, so that
1799−`#5 bolt` and `#hashtag` count as headers. With this extension,
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
18003247pandoc does require the space.
18013248
1802−### Header identifiers ###
3249+### Heading identifiers ###
3250+
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
18033253
18043254#### Extension: `header_attributes` ####
18053255
1806−Headers can be assigned attributes using this syntax at the end
1807−of the line containing the header text:
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
18083258
18093259 {#identifier .class .class key=value key=value}
18103260
1811−Thus, for example, the following headers will all be assigned the identifier
3261+Thus, for example, the following headings will all be assigned the identifier
18123262`foo`:
18133263
1814− # My header {#foo}
3264+ # My heading {#foo}
18153265
1816− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
18173267
1818− My other header {#foo}
3268+ My other heading {#foo}
18193269 ---------------
18203270
18213271(This syntax is compatible with [PHP Markdown Extra].)
@@ -1824,100 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
18243274attributes, writers generally don't use all of this information. Identifiers,
18253275classes, and key/value attributes are used in HTML and HTML-based formats such
18263276as EPUB and slidy. Identifiers are used for labels and link anchors in the
1827−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
18283278
1829−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
18303280`--number-sections` is specified. A single hyphen (`-`) in an attribute
18313281context is equivalent to `.unnumbered`, and preferable in non-English
18323282documents. So,
18333283
1834− # My header {-}
3284+ # My heading {-}
18353285
18363286is just the same as
18373287
1838− # My header {.unnumbered}
1839−
1840−#### Extension: `auto_identifiers` ####
1841−
1842−A header without an explicitly specified identifier will be
1843−automatically assigned a unique identifier based on the header text.
1844−To derive the identifier from the header text,
1845−
1846− - Remove all formatting, links, etc.
1847− - Remove all footnotes.
1848− - Remove all punctuation, except underscores, hyphens, and periods.
1849− - Replace all spaces and newlines with hyphens.
1850− - Convert all alphabetic characters to lowercase.
1851− - Remove everything up to the first letter (identifiers may
1852− not begin with a number or punctuation mark).
1853− - If nothing is left after this, use the identifier `section`.
1854−
1855−Thus, for example,
1856−
1857− Header Identifier
1858− ------------------------------- ----------------------------
1859− `Header identifiers in HTML` `header-identifiers-in-html`
1860− `*Dogs*?--in *my* house?` `dogs--in-my-house`
1861− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1862− `3. Applications` `applications`
1863− `33` `section`
1864−
1865−These rules should, in most cases, allow one to determine the identifier
1866−from the header text. The exception is when several headers have the
1867−same text; in this case, the first will get an identifier as described
1868−above; the second will get the same identifier with `-1` appended; the
1869−third with `-2`; and so on.
1870−
1871−These identifiers are used to provide link targets in the table of
1872−contents generated by the `--toc|--table-of-contents` option. They
1873−also make it easy to provide links from one section of a document to
1874−another. A link to this section, for example, might look like this:
1875−
1876− See the section on
1877− [header identifiers](#header-identifiers-in-html-latex-and-context).
1878−
1879−Note, however, that this method of providing links to sections works
1880−only in HTML, LaTeX, and ConTeXt formats.
3288+ # My heading {.unnumbered}
18813289
1882−If the `--section-divs` option is specified, then each section will
1883−be wrapped in a `div` (or a `section`, if `html5` was specified),
1884−and the identifier will be attached to the enclosing `<div>`
1885−(or `<section>`) tag rather than the header itself. This allows entire
1886−sections to be manipulated using JavaScript or treated differently in
1887−CSS.
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.)
18883294
18893295#### Extension: `implicit_header_references` ####
18903296
1891−Pandoc behaves as if reference links have been defined for each header.
1892−So, to link to a header
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
18933299
1894− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
18953301
18963302you can simply write
18973303
1898− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
18993305
19003306or
19013307
1902− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
19033309
19043310or
19053311
1906− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
19073313 HTML]
19083314
19093315instead of giving the identifier explicitly:
19103316
1911− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
19123318
1913−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
19143320reference will link to the first one only, and you will need to use explicit
19153321links to link to the others, as described above.
19163322
19173323Like regular reference links, these references are case-insensitive.
19183324
19193325Explicit link reference definitions always take priority over
1920−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
19213327link will point to `bar`, not to `#foo`:
19223328
19233329 # Foo
@@ -1926,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
19263332
19273333 See [foo]
19283334
1929−Block quotations
1930−----------------
3335+## Block quotations
19313336
19323337Markdown uses email conventions for quoting blocks of text.
19333338A block quotation is one or more paragraphs or other block elements
1934−(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
19353340and an optional space. (The `>` need not start at the left margin, but
19363341it should not be indented more than three spaces.)
19373342
@@ -1966,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
19663371
19673372#### Extension: `blank_before_blockquote` ####
19683373
1969−Standard Markdown syntax does not require a blank line before a block
1970−quote. Pandoc does require this (except, of course, at the beginning of the
1971−document). The reason for the requirement is that it is all too easy for a
1972−`>` to end up at the beginning of a line by accident (perhaps through line
1973−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
19743380not produce a nested block quote in pandoc:
19753381
19763382 > This is a block quote.
19773383 >> Nested.
19783384
19793385
1980−Verbatim (code) blocks
1981−----------------------
3386+## Verbatim (code) blocks
19823387
19833388### Indented code blocks ###
19843389
@@ -2040,14 +3445,16 @@ this syntax:
20403445 qsort (filter (>= x) xs)
20413446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20423447
2043−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2044−`startFrom` is an attribute with value `100`. Some output formats can use this
2045−information to do syntax highlighting. Currently, the only output formats
2046−that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
2047−is supported for your output format and language, then the code block above
2048−will appear highlighted, with numbered lines. (To see which languages are
2049−supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2050−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:
20513458
20523459 <pre id="mycode" class="haskell numberLines" startFrom="100">
20533460 <code>
@@ -2084,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
20843491For more information on highlighting, see [Syntax highlighting],
20853492below.
20863493
2087−Line blocks
2088−-----------
3494+## Line blocks
20893495
20903496#### Extension: `line_blocks` ####
20913497
@@ -2111,10 +3517,12 @@ line must begin with a space.
21113517 | 200 Main St.
21123518 | Berkeley, CA 94718
21133519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
21143523This syntax is borrowed from [reStructuredText].
21153524
2116−Lists
2117−-----
3525+## Lists
21183526
21193527### Bullet lists ###
21203528
@@ -2284,6 +3692,12 @@ If default list markers are desired, use `#.`:
22843692 #. two
22853693 #. three
22863694
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
22873701
22883702### Definition lists ###
22893703
@@ -2309,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
23093723A definition begins with a colon or tilde, which may be indented one
23103724or two spaces.
23113725
2312−A term may have multiple definitions, and each definition may consist of one or
2313−more block elements (paragraph, code block, list, etc.), each indented four
2314−spaces or one tab stop. The body of the definition (including the first line,
2315−aside from the colon or tilde) should be indented four spaces. However,
2316−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
23173732at the beginning of a paragraph or other block element:
23183733
23193734 Term 1
@@ -2339,9 +3754,10 @@ definition:
23393754Note that space between items in a definition list is required.
23403755(A variant that loosens this requirement, but disallows "lazy"
23413756hard wrapping, can be activated with `compact_definition_lists`: see
2342−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
23433758
2344−[^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/).
23453761
23463762### Numbered example lists ###
23473763
@@ -2377,30 +3793,6 @@ list marker. That is, example lists always behave as if the
23773793labels tend to be long, and indenting content to the
23783794first non-space character after the label would be awkward.
23793795
2380−### Compact and loose lists ###
2381−
2382−Pandoc behaves differently from `Markdown.pl` on some "edge
2383−cases" involving lists. Consider this source:
2384−
2385− + First
2386− + Second:
2387− - Fee
2388− - Fie
2389− - Foe
2390−
2391− + Third
2392−
2393−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2394−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2395−"Second" and "Third" (but not "First"), because of the blank space
2396−around "Third". Pandoc follows a simple rule: if the text is followed by
2397−a blank line, it is treated as a paragraph. Since "Second" is followed
2398−by a list, and not a blank line, it isn't treated as a paragraph. The
2399−fact that the list is followed by a blank line is irrelevant. (Note:
2400−Pandoc works this way even when the `markdown_strict` format is specified. This
2401−behavior is consistent with the official Markdown syntax description,
2402−even though it is different from that of `Markdown.pl`.)
2403−
24043796
24053797### Ending a list ###
24063798
@@ -2439,8 +3831,7 @@ of one big list:
24393831 2. dos
24403832 3. tres
24413833
2442−Horizontal rules
2443−----------------
3834+## Horizontal rules
24443835
24453836A line containing a row of three or more `*`, `-`, or `_` characters
24463837(optionally separated by spaces) produces a horizontal rule:
@@ -2450,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
24503841 ---------------
24513842
24523843
2453−Tables
2454−------
3844+## Tables
24553845
24563846Four kinds of tables may be used. The first three kinds presuppose the use of
24573847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2476,7 +3866,7 @@ Simple tables look like this:
24763866
24773867 Table: Demonstration of simple table syntax.
24783868
2479−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
24803870alignments are determined by the position of the header text relative
24813871to the dashed line below it:[^4]
24823872
@@ -2495,7 +3885,7 @@ to the dashed line below it:[^4]
24953885The table must end with a blank line, or a line of dashes followed by
24963886a blank line.
24973887
2498−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
24993889to end the table. For example:
25003890
25013891 ------- ------ ---------- -------
@@ -2504,13 +3894,13 @@ to end the table. For example:
25043894 1 1 1 1
25053895 ------- ------ ---------- -------
25063896
2507−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
25083898of the first line of the table body. So, in the tables above, the columns
25093899would be right, left, center, and right aligned, respectively.
25103900
25113901#### Extension: `multiline_tables` ####
25123902
2513−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
25143904of text (but cells that span multiple columns or rows of the table are
25153905not supported). Here is an example:
25163906
@@ -2532,7 +3922,7 @@ not supported). Here is an example:
25323922These work like simple tables, but with the following differences:
25333923
25343924 - They must begin with a row of dashes, before the header text
2535− (unless the headers are omitted).
3925+ (unless the header row is omitted).
25363926 - They must end with a row of dashes, then a blank line.
25373927 - The rows must be separated by blank lines.
25383928
@@ -2541,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
25413931the output. So, if you find that one of the columns is too narrow in the
25423932output, try widening it in the Markdown source.
25433933
2544−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:
25453935
25463936 ----------- ------- --------------- -------------------------
25473937 First row 12.0 Example of a row that
@@ -2552,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
25523942 rows.
25533943 ----------- ------- --------------- -------------------------
25543944
2555− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
25563946
25573947It is possible for a multiline table to have just one row, but the row
25583948should be followed by a blank line (and then the row of dashes that ends
@@ -2578,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
25783968omitted for a headerless table. The cells of grid tables may contain
25793969arbitrary block elements (multiple paragraphs, code blocks, lists,
25803970etc.). Cells that span multiple columns or rows are not
2581−supported. Grid tables can be created easily using [Emacs table mode].
2582−
2583−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
25843973
25853974Alignments can be specified as with pipe tables, by putting
25863975colons at the boundaries of the separator line after the
@@ -2608,7 +3997,7 @@ and the same number of rows in each column. For example, the
26083997Docutils [sample grid tables] will not render as expected with
26093998Pandoc.
26103999
2611−[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
26124001
26134002
26144003#### Extension: `pipe_tables` ####
@@ -2641,11 +4030,13 @@ legal (though ugly) pipe table:
26414030
26424031The cells of pipe tables cannot contain block elements like paragraphs
26434032and lists, and cannot span multiple lines. If a pipe table contains a
2644−row whose printable content is wider than the column width (see
2645−`--columns`), then the cell contents will wrap, with the
2646−relative cell widths determined by the widths of the separator
2647−lines. (In this case, the table will take up the full text
2648−width.) If no lines are wider than column width, then
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
26494040cell contents will not be wrapped, and the cells will be sized
26504041to their contents.
26514042
@@ -2663,8 +4054,7 @@ you'll need to add colons as above.
26634054
26644055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
26654056
2666−Metadata blocks
2667−---------------
4057+## Metadata blocks
26684058
26694059#### Extension: `pandoc_title_block` ####
26704060
@@ -2680,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
26804070or all three elements. If you want to include an author but no
26814071title, or a title and a date but no author, you need a blank line:
26824072
2683− %
2684− % Author
4073+```
4074+%
4075+% Author
4076+```
26854077
2686− % My title
2687− %
2688− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
26894083
26904084The title may occupy multiple lines, but continuation lines must
26914085begin with leading space, thus:
26924086
2693− % My title
2694− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
26954091
26964092If a document has multiple authors, the authors may be put on
26974093separate lines with leading space, or separated by semicolons, or
26984094both. So, all of the following are equivalent:
26994095
2700− % Author One
2701− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
27024100
2703− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
27044104
2705− % Author One;
2706− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
27074109
27084110The date must fit on one line.
27094111
@@ -2744,7 +4146,7 @@ will also have "Version 4.0" in the header.
27444146
27454147#### Extension: `yaml_metadata_block` ####
27464148
2747−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
27484150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
27494151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
27504152document, but if it is not at the beginning, it must be preceded by a blank
@@ -2755,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
27554157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
27564158
27574159Just be sure that the YAML file begins with `---` and ends with `---` or
2758−`...`.)
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.
27594163
27604164Metadata will be taken from the fields of the YAML object and added to any
27614165existing document metadata. Metadata can contain lists and objects (nested
27624166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
27634167with names ending in an underscore will be ignored by pandoc. (They may be
2764−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).
27654171
2766−A document may contain multiple metadata blocks. The metadata fields will
2767−be combined through a *left-biased union*: if two metadata blocks attempt
2768−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.
27694175
27704176When pandoc is used with `-t markdown` to create a Markdown document,
27714177a YAML metadata block will be produced only if the `-s/--standalone`
27724178option is used. All of the metadata will appear in a single block
27734179at the beginning of the document.
27744180
2775−Note that YAML escaping rules must be followed. Thus, for example,
2776−if a title contains a colon, it must be quoted. The pipe character
2777−(`|`) can be used to begin an indented block that will be interpreted
2778−literally, without need for escaping. This form is necessary
2779−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:
27804188
27814189 ---
27824190 title: 'This is the title: it contains a colon'
27834191 author:
27844192 - Author One
27854193 - Author Two
2786− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
27874195 abstract: |
27884196 This is the abstract.
27894197
27904198 It consists of two paragraphs.
27914199 ...
27924200
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+
27934207Template variables will be set automatically from the metadata. Thus, for
27944208example, in writing HTML, the variable `abstract` will be set to the HTML
27954209equivalent of the Markdown in the `abstract` field:
@@ -2823,9 +4237,38 @@ template:
28234237 $endif$
28244238 $endfor$
28254239
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:
4257+
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.
28264262
2827−Backslash escapes
2828−-----------------
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
28294272
28304273#### Extension: `all_symbols_escapable` ####
28314274
@@ -2851,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
28514294(However, if the `markdown_strict` format is used, the standard Markdown rule
28524295will be used.)
28534296
2854−A backslash-escaped space is parsed as a nonbreaking space. It will
2855−appear in TeX output as `~` and in HTML and XML as `\ ` or
2856−`\ `.
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).
28574303
28584304A backslash-escaped newline (i.e. a backslash occurring at the end of
28594305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -2863,8 +4309,7 @@ two trailing spaces on a line.
28634309
28644310Backslash escapes do not work in verbatim contexts.
28654311
2866−Inline formatting
2867−-----------------
4312+## Inline formatting
28684313
28694314### Emphasis ###
28704315
@@ -2912,12 +4357,13 @@ text by `~` characters. Thus, for example,
29124357
29134358 H~2~O is a liquid. 2^10^ is 1024.
29144359
2915−If the superscripted or subscripted text contains spaces, these spaces
2916−must be escaped with backslashes. (This is to prevent accidental
2917−superscripting and subscripting through the ordinary use of `~` and `^`.)
2918−Thus, if you want the letter P with 'a cat' in subscripts, use
2919−`P~a\ cat~`, not `P~a cat~`.
2920−
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~`.
29214367
29224368### Verbatim ###
29234369
@@ -2966,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
29664412This will work in all output formats that support small caps.
29674413
29684414
2969−Math
2970−----
4415+## Math
29714416
29724417#### Extension: `tex_math_dollars` ####
29734418
@@ -2979,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
29794424you need to enclose text in literal `$` characters, backslash-escape
29804425them and they won't be treated as math delimiters.
29814426
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+
29824431TeX math will be printed in all output formats. How it is rendered
29834432depends on the output format:
29844433
2985−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2986− ~ 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}}`.
29874444
29884445reStructuredText
29894446 ~ It will be rendered using an [interpreted text role `:math:`].
29904447
29914448AsciiDoc
2992− ~ 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.
29934454
29944455Texinfo
29954456 ~ It will be rendered inside a `@math` command.
29964457
2997−groff man
4458+roff man, Jira markup
29984459 ~ It will be rendered verbatim without `$`'s.
29994460
30004461MediaWiki, DokuWiki
@@ -3028,12 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
30284489 command-line options selected. Therefore see [Math rendering in HTML]
30294490 above.
30304491
3031−This extension can be used with both `markdown` and `html` input.
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
30324493
3033−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3034−
3035−Raw HTML
3036−--------
4494+## Raw HTML
30374495
30384496#### Extension: `raw_html` ####
30394497
@@ -3044,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
30444502be disabled if desired.)
30454503
30464504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3047−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3048−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.
30494516
30504517#### Extension: `markdown_in_html_blocks` ####
30514518
@@ -3062,7 +4529,7 @@ Thus, for example, pandoc will turn
30624529 <table>
30634530 <tr>
30644531 <td>*one*</td>
3065− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
30664533 </tr>
30674534 </table>
30684535
@@ -3071,72 +4538,33 @@ into
30714538 <table>
30724539 <tr>
30734540 <td><em>one</em></td>
3074− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
30754542 </tr>
30764543 </table>
30774544
30784545whereas `Markdown.pl` will preserve it as is.
30794546
3080−There is one exception to this rule: text between `<script>` and
3081−`<style>` tags is not interpreted as Markdown.
3082−
3083−This departure from standard Markdown should make it easier to mix
3084−Markdown with HTML block elements. For example, one can surround
3085−a block of Markdown text with `<div>` tags without preventing it
3086−from being interpreted as Markdown.
3087−
3088−#### Extension: `native_divs` ####
3089−
3090−Use native pandoc `Div` blocks for content inside `<div>` tags.
3091−For the most part this should give the same output as
3092−`markdown_in_html_blocks`, but it makes it easier to write pandoc
3093−filters to manipulate groups of blocks.
3094−
3095−#### Extension: `native_spans` ####
3096−
3097−Use native pandoc `Span` blocks for content inside `<span>` tags.
3098−For the most part this should give the same output as `raw_html`,
3099−but it makes it easier to write pandoc filters to manipulate groups
3100−of inlines.
3101−
3102−#### Extension: `fenced_divs` ####
3103−
3104−Allow special fenced syntax for native `Div` blocks. A Div
3105−starts with a fence containing at least three consecutive
3106−colons plus some attributes. The attributes may optionally
3107−be followed by another string of consecutive colons.
3108−The attribute syntax is exactly as in fenced code blocks (see
3109−[Extension: `fenced_code_attributes`]). As with fenced
3110−code blocks, one can use either attributes in curly braces
3111−or a single unbraced word, which will be treated as a class
3112−name. The Div ends with another line containing a string of at
3113−least three consecutive colons. The fenced Div should be
3114−separated by blank lines from preceding and following blocks.
3115−
3116−Example:
3117−
3118− ::::: {#special .sidebar}
3119− Here is a paragraph.
3120−
3121− And another.
3122− :::::
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
31234549
3124−Fenced divs can be nested. Opening fences are distinguished
3125−because they *must* have attributes:
4550+This departure from standard Markdown should make it easier to mix
4551+Markdown with HTML block elements. For example, one can surround
4552+a block of Markdown text with `<div>` tags without preventing it
4553+from being interpreted as Markdown.
31264554
3127− ::: Warning ::::::
3128− This is a warning.
4555+#### Extension: `native_divs` ####
31294556
3130− ::: Danger
3131− This is a warning within a warning.
3132− :::
3133− ::::::::::::::::::
4557+Use native pandoc `Div` blocks for content inside `<div>` tags.
4558+For the most part this should give the same output as
4559+`markdown_in_html_blocks`, but it makes it easier to write pandoc
4560+filters to manipulate groups of blocks.
31344561
3135−Fences without attributes are always closing fences. Unlike
3136−with fenced code blocks, the number of colons in the closing
3137−fence need not match the number in the opening fence. However,
3138−it can be helpful for visual clarity to use fences of different
3139−lengths to distinguish nested divs from their parents.
4562+#### Extension: `native_spans` ####
4563+
4564+Use native pandoc `Span` blocks for content inside `<span>` tags.
4565+For the most part this should give the same output as `raw_html`,
4566+but it makes it easier to write pandoc filters to manipulate groups
4567+of inlines.
31404568
31414569#### Extension: `raw_tex` ####
31424570
@@ -3159,6 +4587,10 @@ Note that in LaTeX environments, like
31594587the material between the begin and end tags will be interpreted as raw
31604588LaTeX, not as Markdown.
31614589
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+
31624594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
31634595Emacs Org mode, and ConTeXt.
31644596
@@ -3169,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
31694601Inline spans and fenced code blocks with a special
31704602kind of attribute will be parsed as raw content with the
31714603designated format. For example, the following produces a raw
3172−groff `ms` block:
4604+roff `ms` block:
31734605
31744606 ```{=ms}
31754607 .MYMACRO
@@ -3179,9 +4611,24 @@ And the following produces a raw `html` inline element:
31794611
31804612 This is `<a>html</a>`{=html}
31814613
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+
31824625The format name should match the target format name (see
31834626`-t/--to`, above, for a list, or use `pandoc
3184−--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`).
31854632
31864633This extension presupposes that the relevant kind of
31874634inline code or fenced code block is enabled. Thus, for
@@ -3190,12 +4637,11 @@ example, to use a raw attribute with a backtick code block,
31904637
31914638The raw attribute cannot be combined with regular attributes.
31924639
3193−LaTeX macros
3194−------------
4640+## LaTeX macros
31954641
31964642#### Extension: `latex_macros` ####
31974643
3198−For output formats other than LaTeX, pandoc will parse LaTeX
4644+When this extension is enabled, pandoc will parse LaTeX
31994645macro definitions and apply the resulting macros to all LaTeX
32004646math and raw LaTeX. So, for example, the following will work in
32014647all output formats, not just LaTeX:
@@ -3204,16 +4650,21 @@ all output formats, not just LaTeX:
32044650
32054651 $\tuple{a, b, c}$
32064652
3207−In LaTeX output, the macro definitions will not be passed
3208−through as raw LaTeX.
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).
32094656
3210−When `latex_macros` is disabled, the macro definitions will
3211−be passed through as raw LaTeX, and the raw LaTeX and math will
4657+When `latex_macros` is disabled, the raw LaTeX and math will
32124658not have macros applied. This is usually a better approach when
32134659you are targeting LaTeX or PDF.
32144660
3215−Links
3216−-----
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
32174668
32184669Markdown allows links to be specified in several ways.
32194670
@@ -3222,7 +4673,7 @@ Markdown allows links to be specified in several ways.
32224673If you enclose a URL or email address in pointy brackets, it
32234674will become a link:
32244675
3225− <http://google.com>
4676+ <https://google.com>
32264677 <sam@green.eggs.ham>
32274678
32284679### Inline links ###
@@ -3232,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
32324683be followed by a link title, in quotes.)
32334684
32344685 This is an [inline link](/url), and here's [one with
3235− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
32364687
32374688There can be no space between the bracketed part and the parenthesized part.
32384689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3261,7 +4712,7 @@ Here are some examples:
32614712
32624713 [my label 1]: /foo/bar.html "My title, optional"
32634714 [my label 2]: /foo
3264− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
32654716 [my label 4]: /bar#special 'A title in single quotes'
32664717
32674718The URL may optionally be surrounded by angle brackets:
@@ -3270,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
32704721
32714722The title may go on the next line:
32724723
3273− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
32744725 "The free software foundation"
32754726
32764727Note that link labels are not case sensitive. So, this will work:
@@ -3296,233 +4747,610 @@ not in most other implementations:
32964747 >
32974748 > [quote]: /foo
32984749
3299−#### Extension: `shortcut_reference_links` ####
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.
33005135
3301−In a *shortcut* reference link, the second pair of brackets may
3302−be omitted entirely:
5136+#### Extension: `angle_brackets_escapable` ####
33035137
3304− See [my website].
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`.
33055141
3306− [my website]: http://foo.bar.baz
5142+#### Extension: `lists_without_preceding_blankline` ####
33075143
3308−### Internal links ###
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
33095146
3310−To link to another section of the same document, use the automatically
3311−generated identifier (see [Header identifiers]). For example:
5147+#### Extension: `four_space_rule` ####
33125148
3313− See the [Introduction](#introduction).
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
33145152
3315−or
5153+#### Extension: `spaced_reference_links` ####
33165154
3317− See the [Introduction].
5155+Allow whitespace between the two components of a reference link,
5156+for example,
33185157
3319− [Introduction]: #introduction
5158+ [foo] [bar].
33205159
3321−Internal links are currently supported for HTML formats (including
3322−HTML slide shows and EPUB), LaTeX, and ConTeXt.
5160+#### Extension: `hard_line_breaks` ####
33235161
3324−Images
3325−------
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
33265164
3327−A link immediately preceded by a `!` will be treated as an image.
3328−The link text will be used as the image's alt text:
5165+#### Extension: `ignore_line_breaks` ####
33295166
3330− 
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.
33315171
3332− ![movie reel]
5172+#### Extension: `east_asian_line_breaks` ####
33335173
3334− [movie reel]: movie.gif
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.
33355179
3336−#### Extension: `implicit_figures` ####
5180+#### Extension: `emoji` ####
33375181
3338−An image with nonempty alt text, occurring by itself in a
3339−paragraph, will be rendered as a figure with a caption. The
3340−image's alt text will be used as the caption.
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
33415183
3342− 
5184+#### Extension: `tex_math_single_backslash` ####
33435185
3344−How this is rendered depends on the output format. Some output
3345−formats (e.g. RTF) do not yet support figures. In those
3346−formats, you'll just get an image in a paragraph by itself, with
3347−no caption.
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 `[`.
33485190
3349−If you just want a regular inline image, just make sure it is not
3350−the only thing in the paragraph. One way to do this is to insert a
3351−nonbreaking space after the image:
5191+#### Extension: `tex_math_double_backslash` ####
33525192
3353− \
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.
33545196
3355−Note that in reveal.js slide shows, an image in a paragraph
3356−by itself that has the `stretch` class will fill the screen,
3357−and the caption and figure tags will be omitted.
5197+#### Extension: `markdown_attribute` ####
33585198
3359−#### Extension: `link_attributes` ####
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`.
33605202
3361−Attributes can be set on links and images:
5203+#### Extension: `mmd_title_block` ####
33625204
3363− An inline {#id .class width=30 height=20px}
3364− and a reference ![image][ref] with attributes.
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
33655207
3366− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
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.
33675213
3368−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3369−and `.class` are used.)
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`.
33705217
3371−For HTML and EPUB, all attributes except `width` and `height` (but
3372−including `srcset` and `sizes`) are passed through as is. The other
3373−writers ignore attributes that are not supported by their output
3374−format.
5218+#### Extension: `abbreviations` ####
33755219
3376−The `width` and `height` attributes on images are treated specially. When
3377−used without a unit, the unit is assumed to be pixels. However, any of
3378−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3379−and `%`. There must not be any spaces between the number and the unit.
3380−For example:
5220+Parses PHP Markdown Extra abbreviation keys, like
33815221
3382−```
3383−{ width=50% }
3384−```
5222+ *[HTML]: Hypertext Markup Language
33855223
3386−- Dimensions are converted to inches for output in page-based formats like
3387− LaTeX. Dimensions are converted to pixels for output in HTML-like
3388− formats. Use the `--dpi` option to specify the number of pixels per
3389− inch. The default is 96dpi.
3390−- The `%` unit is generally relative to some available space.
3391− For example the above example will render to
3392− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3393− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3394− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3395−- Some output formats have a notion of a class
3396− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3397− or a unique identifier (LaTeX `\caption`), or both (HTML).
3398−- When no `width` or `height` attributes are specified, the fallback
3399− is to look at the image resolution and the dpi metadata embedded in
3400− the image file.
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).
34015227
3402−Spans
3403−-----
5228+#### Extension: `autolink_bare_uris` ####
34045229
3405−#### Extension: `bracketed_spans` ####
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
34065232
3407−A bracketed sequence of inlines, as one would use to begin
3408−a link, will be treated as a span with attributes if it is
3409−followed immediately by attributes:
5233+#### Extension: `mmd_link_attributes` ####
34105234
3411− [This is *some text*]{.class key="val"}
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.
34125238
3413−Footnotes
3414−---------
5239+ This is a reference ![image][ref] with multimarkdown attributes.
34155240
3416−#### Extension: `footnotes` ####
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
34175243
3418−Pandoc's Markdown allows footnotes, using the following syntax:
5244+#### Extension: `mmd_header_identifiers` ####
34195245
3420− Here is a footnote reference,[^1] and another.[^longnote]
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
34215248
3422− [^1]: Here is the footnote.
5249+#### Extension: `compact_definition_lists` ####
34235250
3424− [^longnote]: Here's one with multiple blocks.
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:
34255254
3426− Subsequent paragraphs are indented to show that they
3427− belong to the previous footnote.
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]
34285262
3429− { some.code }
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
34305265
3431− The whole paragraph can be indented, or just the first
3432− line. In this way, multi-paragraph footnotes work like
3433− multi-paragraph list items.
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
34345270
3435− This paragraph won't be part of the note, because it
3436− isn't indented.
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.
34375275
3438−The identifiers in footnote references may not contain spaces, tabs,
3439−or newlines. These identifiers are used only to correlate the
3440−footnote reference with the note itself; in the output, footnotes
3441−will be numbered sequentially.
5276+#### Extension: `gutenberg` ####
34425277
3443−The footnotes themselves need not be placed at the end of the
3444−document. They may appear anywhere except inside other block elements
3445−(lists, block quotes, tables, etc.). Each footnote should be
3446−separated from surrounding content (including other footnotes)
3447−by blank lines.
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.
34485281
3449−#### Extension: `inline_notes` ####
5282+ [Project Gutenberg]: https://www.gutenberg.org
34505283
3451−Inline footnotes are also allowed (though, unlike regular notes,
3452−they cannot contain multiple paragraphs). The syntax is as follows:
5284+#### Extension: `sourcepos` ####
34535285
3454− Here is an inline note.^[Inlines notes are easier to write, since
3455− you don't have to pick an identifier and move down to type the
3456− note.]
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.
34575290
3458−Inline and regular footnotes may be mixed freely.
5291+## Markdown variants
34595292
3460−Typography
3461−----------
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
34625295
3463−#### Extension: `smart` ####
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)
34645303
3465−Interpret straight quotes as curly quotes, `---` as em-dashes,
3466−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3467−inserted after certain abbreviations, such as "Mr." This
3468−option currently affects the input formats `markdown`,
3469−`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3470−and the output formats `markdown`, `latex`, and `context`.
3471−It is enabled by default for `markdown`, `latex`, and `context`
3472−(in both input and output).
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
34735306
3474−Note: If you are *writing* Markdown, then the `smart` extension
3475−has the reverse effect: what would have been curly quotes comes
3476−out straight.
5307+ pandoc --list-extensions=FORMAT
34775308
3478−In LaTeX, `smart` means to use the standard TeX ligatures
3479−for quotation marks (` `` ` and ` '' ` for double quotes,
3480−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3481−en-dash and `---` for em-dash). If `smart` is disabled,
3482−then in reading LaTeX pandoc will parse these characters
3483−literally. In writing LaTeX, enabling `smart` tells pandoc
3484−to use the ligatures when possible; if `smart` is disabled
3485−pandoc will use unicode quotation mark and dash characters.
5309+where `FORMAT` is replaced with the name of the format.
34865310
3487−Citations
3488−---------
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.
34895316
3490−#### Extension: `citations` ####
5317+# Citations
34915318
3492−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
5319+When the `--citeproc` option is used, pandoc can automatically generate
34935320citations and a bibliography in a number of styles. Basic usage is
34945321
3495− pandoc --filter pandoc-citeproc myinput.txt
5322+ pandoc --citeproc myinput.txt
5323+
5324+To use this feature, you will need to have
5325+
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.
5330+
5331+## Specifying bibliographic data
34965332
3497−In order to use this feature, you will need to specify a bibliography file
3498−using the `bibliography` metadata field in a YAML metadata section, or
3499−`--bibliography` command line argument. You can supply multiple `--bibliography`
3500−arguments or set `bibliography` metadata field to YAML array, if you want to
3501−use multiple bibliography files. The bibliography may have any of these
3502−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:
35035339
35045340 Format File extension
35055341 ------------ --------------
35065342 BibLaTeX .bib
35075343 BibTeX .bibtex
3508− Copac .copac
35095344 CSL JSON .json
35105345 CSL YAML .yaml
3511− EndNote .enl
3512− EndNote XML .xml
3513− ISI .wos
3514− MEDLINE .medline
3515− MODS .mods
3516− RIS .ris
35175346
35185347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3519−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
35205349
3521−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3522−can produce `.json` and `.yaml` files from any of the supported formats.
3523−
3524−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3525−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]:
35265354
35275355`<i>...</i>`
35285356: italics
@@ -3542,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
35425370`<span class="nocase">...</span>`
35435371: prevent a phrase from being capitalized as title case
35445372
3545−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3546−and CSL YAML formats as far as possible.
3547−
3548−As an alternative to specifying a bibliography file using `--bibliography`
3549−or the YAML metadata field `bibliography`, you can include
3550−the citation data directly in the `references` field of the
3551−document's YAML metadata. The field should contain an array of
3552−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:
35535378
35545379 ---
35555380 references:
@@ -3565,349 +5390,273 @@ YAML-encoded references, for example:
35655390 - - 1953
35665391 - 4
35675392 - 25
3568− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3569− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
35705395 title-short: Molecular structure of nucleic acids
35715396 container-title: Nature
35725397 volume: 171
35735398 issue: 4356
35745399 page: 737-738
35755400 DOI: 10.1038/171737a0
3576− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
35775402 language: en-GB
35785403 ...
35795404
3580−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3581−of the supported formats.)
3582−
3583−Citations and references can be formatted using any style supported by the
3584−[Citation Style Language], listed in the [Zotero Style Repository].
3585−These files are specified using the `--csl` option or the `csl` metadata field.
3586−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3587−format. The CSL project provides further information on [finding and editing styles].
3588−
3589−To make your citations hyperlinks to the corresponding bibliography
3590−entries, add `link-citations: true` to your YAML metadata.
3591−
3592−Citations go inside square brackets and are separated by semicolons.
3593−Each citation must have a key, composed of '@' + the citation
3594−identifier from the database, and may optionally have a prefix,
3595−a locator, and a suffix. The citation key must begin with a letter, digit,
3596−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3597−characters (`:.#$%&-+?<>~/`). Here are some examples:
3598−
3599− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3600−
3601− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3602−
3603− Blah blah [@smith04; @doe99].
3604−
3605−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3606−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3607−locale, locator terms can be written in either singular or plural forms,
3608−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3609−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3610−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3611−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3612−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3613−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3614−locator term is used, "page" is assumed.
3615−
3616−A minus sign (`-`) before the `@` will suppress mention of
3617−the author in the citation. This can be useful when the
3618−author is already mentioned in the text:
3619−
3620− Smith says blah [-@smith04].
3621−
3622−You can also write an in-text citation, as follows:
3623−
3624− @smith04 says blah.
3625−
3626− @smith04 [p. 33] says blah.
3627−
3628−If the style calls for a list of works cited, it will be placed
3629−at the end of the document. Normally, you will want to end your
3630−document with an appropriate header:
3631−
3632− last paragraph...
3633−
3634− # References
3635−
3636−The bibliography will be inserted after this header. Note that
3637−the `unnumbered` class will be added to this header, so that the
3638−section will not be numbered.
3639−
3640−If you want to include items in the bibliography without actually
3641−citing them in the body text, you can define a dummy `nocite` metadata
3642−field and put the citations there:
3643−
3644− ---
3645− nocite: |
3646− @item1, @item2
3647− ...
3648−
3649− @item3
3650−
3651−In this example, the document will contain a citation for `item3`
3652−only, but the bibliography will contain entries for `item1`, `item2`, and
3653−`item3`.
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.
36545408
3655−It is possible to create a bibliography with all the citations,
3656−whether or not they appear in the document, by using a wildcard:
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
36575411
3658− ---
3659− nocite: |
3660− @*
3661− ...
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
36625414
3663−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3664−to render bibliography. In order to do so, specify bibliography files as
3665−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3666−invocation. Bear in mind that bibliography files have to be in respective
3667−format (either BibTeX or BibLaTeX).
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
36685417
3669−For more information, see the [pandoc-citeproc man page].
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
36705420
3671−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3672−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3673−[Citation Style Language]: http://citationstyles.org
3674−[Zotero Style Repository]: https://www.zotero.org/styles
3675−[finding and editing styles]: http://citationstyles.org/styles/
3676−[CSL locale files]: https://github.com/citation-style-language/locales
3677−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
36785424
3679−Non-pandoc extensions
3680−---------------------
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
36815427
3682−The following Markdown syntax extensions are not enabled by default
3683−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3684−name, where `EXTENSION` is the name of the extension. Thus, for
3685−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5428+### Capitalization in titles
36865429
3687−#### Extension: `old_dashes` ####
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
36885432
3689−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3690−`-` before a numeral is an en-dash, and `--` is an em-dash.
3691−This option only has an effect if `smart` is enabled. It is
3692−selected automatically for `textile` input.
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`.)
36935438
3694−#### Extension: `angle_brackets_escapable` ####
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:
36955442
3696−Allow `<` and `>` to be backslash-escaped, as they can be in
3697−GitHub flavored Markdown but not original Markdown. This is
3698−implied by pandoc's default `all_symbols_escapable`.
5443+ title = {My Dinner with {Andre}}
36995444
3700−#### Extension: `lists_without_preceding_blankline` ####
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
37015447
3702−Allow a list to occur right after a paragraph, with no intervening
3703−blank space.
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
37045449
3705−#### Extension: `four_space_rule` ####
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.
37065454
3707−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3708−four spaces indent are needed for list item continuation
3709−paragraphs.
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
37105457
3711−#### Extension: `spaced_reference_links` ####
5458+ - All titles should be in sentence case.
37125459
3713−Allow whitespace between the two components of a reference link,
3714−for example,
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.)
37155463
3716− [foo] [bar].
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
37175466
3718−#### Extension: `hard_line_breaks` ####
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
37195468
3720−Causes all newlines within a paragraph to be interpreted as hard line
3721−breaks instead of spaces.
5469+### Conference Papers, Published vs. Unpublished
37225470
3723−#### Extension: `ignore_line_breaks` ####
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
37245473
3725−Causes newlines within a paragraph to be ignored, rather than being
3726−treated as spaces or as hard line breaks. This option is intended for
3727−use with East Asian languages where spaces are not used between words,
3728−but text is divided into lines for readability.
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`).
37295477
3730−#### Extension: `east_asian_line_breaks` ####
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.
37315487
3732−Causes newlines within a paragraph to be ignored, rather than
3733−being treated as spaces or as hard line breaks, when they occur
3734−between two East Asian wide characters. This is a better choice
3735−than `ignore_line_breaks` for texts that include a mix of East
3736−Asian wide characters and other characters.
37375488
3738−#### Extension: `emoji` ####
5489+## Specifying a citation style
37395490
3740−Parses textual emojis like `:smile:` as Unicode emoticons.
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:
37415507
3742−#### Extension: `tex_math_single_backslash` ####
37435508
3744−Causes anything between `\(` and `\)` to be interpreted as inline
3745−TeX math, and anything between `\[` and `\]` to be interpreted
3746−as display TeX math. Note: a drawback of this extension is that
3747−it precludes escaping `(` and `[`.
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+ }
37485517
3749−This extension can be used with both `markdown` and `html` input.
37505518
3751−#### Extension: `tex_math_double_backslash` ####
5519+## Citations in note styles
37525520
3753−Causes anything between `\\(` and `\\)` to be interpreted as inline
3754−TeX math, and anything between `\\[` and `\\]` to be interpreted
3755−as display TeX math.
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,
37565527
3757−#### Extension: `markdown_attribute` ####
5528+ Blah blah [@foo, p. 33].
37585529
3759−By default, pandoc interprets material inside block-level tags as Markdown.
3760−This extension changes the behavior so that Markdown is only parsed
3761−inside block-level tags if the tags have the attribute `markdown=1`.
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].
37625535
3763−#### Extension: `mmd_title_block` ####
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:
37645541
3765−Enables a [MultiMarkdown] style title block at the top of
3766−the document, for example:
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].
37675545
3768− Title: My title
3769− Author: John Doe
3770− Date: September 1, 2008
3771− Comment: This is a sample mmd title block, with
3772− a field spanning multiple lines.
5546+## Raw content in a style
37735547
3774−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3775−`yaml_metadata_block` is enabled, it will take precedence over
3776−`mmd_title_block`.
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
37775550
3778−#### Extension: `abbreviations` ####
5551+ {{jats}}<ref>{{/jats}}
37795552
3780−Parses PHP Markdown Extra abbreviation keys, like
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
37815555
3782− *[HTML]: Hypertext Markup Language
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.
37835560
3784−Note that the pandoc document model does not support
3785−abbreviations, so if this extension is enabled, abbreviation keys are
3786−simply skipped (as opposed to being parsed as paragraphs).
37875561
3788−#### Extension: `autolink_bare_uris` ####
37895562
3790−Makes all absolute URIs into links, even when not surrounded by
3791−pointy braces `<...>`.
5563+## Placement of the bibliography
37925564
3793−#### Extension: `ascii_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:
37945567
3795−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3796−Accents are stripped off of accented Latin letters, and non-Latin
3797−letters are omitted.
5568+ ::: {#refs}
5569+ :::
37985570
3799−#### Extension: `mmd_link_attributes` ####
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.
38005574
3801−Parses multimarkdown style key-value attributes on link
3802−and image references. This extension should not be confused with the
3803−[`link_attributes`](#extension-link_attributes) extension.
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:
38045579
3805− This is a reference ![image][ref] with multimarkdown attributes.
5580+ last paragraph...
38065581
3807− [ref]: http://path.to/image "Image title" width=20px height=30px
3808− id=myId class="myClass1 myClass2"
5582+ # References
38095583
3810−#### Extension: `mmd_header_identifiers` ####
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.
38115587
3812−Parses multimarkdown style header identifiers (in square brackets,
3813−after the header but before any trailing `#`s in an ATX header).
5588+## Including uncited items in the bibliography
38145589
3815−#### Extension: `compact_definition_lists` ####
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:
38165593
3817−Activates the definition list syntax of pandoc 1.12.x and earlier.
3818−This syntax differs from the one described above under [Definition lists]
3819−in several respects:
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
38205598
3821− - No blank line is required between consecutive items of the
3822− definition list.
3823− - To get a "tight" or "compact" list, omit space between consecutive
3824− items; the space between a term and its definition does not affect
3825− anything.
3826− - Lazy wrapping of paragraphs is not allowed: the entire definition must
3827− be indented four spaces.[^6]
5599+ @item3
38285600
3829−[^6]: To see why laziness is incompatible with relaxing the requirement
3830− of a blank line between items, consider the following example:
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`.
38315604
3832− bar
3833− : definition
3834− foo
3835− : definition
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:
38365607
3837− Is this a single list item with two definitions of "bar," the first of
3838− which is lazily wrapped, or two list items? To remove the ambiguity
3839− we must either disallow lazy wrapping or require a blank line between
3840− list items.
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
38415612
3842−#### Extension: `empty_paragraphs` ####
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.
38435619
3844−Allows empty paragraphs. By default empty paragraphs are
3845−omitted. This affects the `docx` reader and writer, the
3846−`opendocument` and `odt` writer, and all HTML-based readers and writers.
5620+## Other relevant metadata fields
38475621
3848−Markdown variants
3849−-----------------
5622+A few other metadata fields affect bibliography formatting:
38505623
3851−In addition to pandoc's extended Markdown, the following Markdown
3852−variants are supported:
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
38535628
3854−`markdown_phpextra` (PHP Markdown Extra)
3855−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3856− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3857− `header_attributes`, `link_attributes`, `abbreviations`,
3858− `shortcut_reference_links`, `spaced_reference_links`.
3859−
3860−`markdown_github` (deprecated GitHub-Flavored Markdown)
3861−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
3862− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3863− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
3864− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
3865− `lists_without_preceding_blankline`.
3866−
3867−`markdown_mmd` (MultiMarkdown)
3868−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3869− `tex_math_double_backslash`, `intraword_underscores`,
3870− `mmd_title_block`, `footnotes`, `definition_lists`,
3871− `all_symbols_escapable`, `implicit_header_references`,
3872− `auto_identifiers`, `mmd_header_identifiers`,
3873− `shortcut_reference_links`, `implicit_figures`,
3874− `superscript`, `subscript`, `backtick_code_blocks`,
3875− `spaced_reference_links`, `raw_attribute`.
3876−
3877−`markdown_strict` (Markdown.pl)
3878−: `raw_html`, `shortcut_reference_links`,
3879− `spaced_reference_links`.
3880−
3881−We also support `gfm` (GitHub-Flavored Markdown) as a set of
3882−extensions on `commonmark`:
3883−
3884−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3885− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3886− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3887− `shortcut_reference_links`, `angle_brackets_escapable`.
3888−
3889− These can all be individually disabled. Note, however, that
3890− `commonmark` and `gfm` have limited support for extensions:
3891− extensions other than those listed above (and `smart` and
3892− `raw_tex`) will have no effect on `commonmark` or `gfm`.
3893− And `raw_tex` only affects `gfm` output, not input.
3894−
3895−Extensions with formats other than Markdown
3896−-------------------------------------------
3897−
3898−Some of the extensions discussed above can be used with formats
3899−other than Markdown:
3900−
3901−* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3902− and `textile` input (and is used by default).
3903−
3904−* `tex_math_dollars`, `tex_math_single_backslash`, and
3905− `tex_math_double_backslash` can be used with `html` input.
3906− (This is handy for reading web pages formatted using MathJax,
3907− for example.)
3908−
3909−Producing slide shows with pandoc
3910−=================================
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
39115660
39125661You can use pandoc to produce an HTML + JavaScript slide presentation
39135662that can be viewed via a web browser. There are five ways to do this,
@@ -3955,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
39555704
39565705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
39575706
3958−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3959−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3960−assumed to be available at the relative path `s5/default` (for S5), `slideous`
3961−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3962−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3963−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3964−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3965−the file by default.
3966−
3967−With all HTML slide formats, the `--self-contained` option can be used to
3968−produce a single file that contains all of the data necessary to display the
3969−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.
39705722
39715723To produce a PDF slide show using beamer, type
39725724
@@ -3979,14 +5731,13 @@ To produce a Powerpoint slide show, type
39795731
39805732 pandoc habits.txt -o habits.pptx
39815733
3982−Structuring the slide show
3983−--------------------------
5734+## Structuring the slide show
39845735
3985−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
39865737the hierarchy that is followed immediately by content, and not another
3987−header, somewhere in the document. In the example above, level 1 headers
3988−are always followed by level 2 headers, which are followed by content,
3989−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
39905741the `--slide-level` option.
39915742
39925743The document is carved up into slides according to the following
@@ -3994,17 +5745,21 @@ rules:
39945745
39955746 * A horizontal rule always starts a new slide.
39965747
3997− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
39985749
3999− * Headers *below* the slide level in the hierarchy create
4000− 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.)
40015756
4002− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
40035758 "title slides," which just contain the section title
40045759 and help to break the slide show into sections.
4005−
4006− * Content *above* the slide level will not appear in the slide
4007− 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).
40085763
40095764 * A title page is constructed automatically from the document's title
40105765 block, if present. (In the case of beamer, this can be disabled
@@ -4012,32 +5767,57 @@ rules:
40125767
40135768These rules are designed to support many different styles of slide show. If
40145769you don't care about structuring your slides into sections and subsections,
4015−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
40165771will be the slide level.) But you can also structure the slide show into
40175772sections, as in the example above.
40185773
40195774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4020−layout will be produced, with level 1 headers building horizontally
4021−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
40225777you use deeper nesting of section levels with reveal.js.
40235778
4024−Incremental lists
4025−-----------------
5779+## Incremental lists
40265780
40275781By default, these writers produce lists that display "all at once."
40285782If you want your lists to display incrementally (one item at a time),
40295783use the `-i` option. If you want a particular list to depart from the
4030−default (that is, to display incrementally without the `-i` option and
4031−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):
40325810
40335811 > - Eat spaghetti
40345812 > - Drink wine
40355813
4036−In this way incremental and nonincremental lists can be mixed in
4037−a single document.
5814+Both methods allow incremental and nonincremental lists to be mixed
5815+in a single document.
40385816
4039−Inserting pauses
4040−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
40415821
40425822You can add "pauses" within a slide by including a paragraph containing
40435823three dots, separated by spaces:
@@ -4050,8 +5830,9 @@ three dots, separated by spaces:
40505830
40515831 content after the pause
40525832
4053−Styling the slides
4054−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
40555836
40565837You can change the style of HTML slides by putting customized CSS files
40575838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4076,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
40765857
40775858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
40785859
4079−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
40805861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4081−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
40825863that affects slides is the `allowframebreaks` class, which sets the
40835864`allowframebreaks` option, causing multiple slides to be created
40845865if the content overfills the frame. This is recommended especially for
@@ -4086,11 +5867,10 @@ bibliographies:
40865867
40875868 # References {.allowframebreaks}
40885869
4089−Speaker notes
4090−-------------
5870+## Speaker notes
40915871
4092−reveal.js has good support for speaker notes. You can add notes to your
4093−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:
40945874
40955875 ::: notes
40965876
@@ -4101,12 +5881,14 @@ Markdown document thus:
41015881
41025882 :::
41035883
4104−To show the notes window, press `s` while viewing the presentation.
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.
5887+
41055888Notes are not yet supported for other slide formats, but the notes
41065889will not appear on the slides themselves.
41075890
4108−Columns
4109−-------
5891+## Columns
41105892
41115893To put material in side by side columns, you can use a native
41125894div container with class `columns`, containing two or more div
@@ -4121,12 +5903,46 @@ containers with class `column` and a `width` attribute:
41215903 :::
41225904 ::::::::::::::
41235905
4124−Frame attributes in beamer
4125−--------------------------
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
41265942
41275943Sometimes it is necessary to add the LaTeX `[fragile]` option to
41285944a frame in beamer (for example, when using the `minted` environment).
4129−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
41305946introducing the slide:
41315947
41325948 # Fragile slide {.fragile}
@@ -4134,13 +5950,64 @@ introducing the slide:
41345950All of the other frame attributes described in Section 8.1 of
41355951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
41365952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4137−`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.)
41385964
4139−Creating EPUBs with pandoc
4140−==========================
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.
41415969
4142−EPUB Metadata
4143−-------------
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"}
6004+
6005+Slide 2 has a special image for its background, even though the heading has no content.
6006+```
6007+
6008+# EPUBs
6009+
6010+## EPUB Metadata
41446011
41456012EPUB metadata may be specified using the `--epub-metadata` option, but
41466013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4218,11 +6085,20 @@ The following fields are recognized:
42186085
42196086`rights`
42206087 ~ 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.
42216097
42226098`cover-image`
42236099 ~ A string value (path to cover image).
42246100
4225−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
42266102 ~ A string value (path to CSS stylesheet).
42276103
42286104`page-progression-direction`
@@ -4239,83 +6115,200 @@ The following fields are recognized:
42396115 - `binding`: `true`|`false` (default `true`)
42406116 - `scroll-axis`: `vertical`|`horizontal`|`default`
42416117
4242−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
42436119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
42446120
4245−Linked media
4246−------------
4247−
4248−By default, pandoc will download linked media (including audio and
4249−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
42506170self-contained EPUB. If you want to link to external media resources
42516171instead, use raw HTML in your source and add `data-external="1"` to the tag
42526172with the `src` attribute. For example:
42536173
42546174 <audio controls="1">
4255− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
42566176 data-external="1" type="audio/mpeg">
42576177 </source>
42586178 </audio>
42596179
4260−Literate Haskell support
4261−========================
4262−
4263−If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4264−format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4265−`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4266−literate Haskell source. This means that
4267−
4268− - In Markdown input, "bird track" sections will be parsed as Haskell
4269− code rather than block quotations. Text between `\begin{code}`
4270− and `\end{code}` will also be treated as Haskell code. For
4271− ATX-style headers the character '=' will be used instead of '#'.
4272−
4273− - In Markdown output, code blocks with classes `haskell` and `literate`
4274− will be rendered using bird tracks, and block quotations will be
4275− indented one space, so they will not be treated as Haskell code.
4276− In addition, headers will be rendered setext-style (with underlines)
4277− rather than ATX-style (with '#' characters). (This is because ghc
4278− treats '#' characters in column 1 as introducing line numbers.)
4279−
4280− - In restructured text input, "bird track" sections will be parsed
4281− as Haskell code.
4282−
4283− - In restructured text output, code blocks with class `haskell` will
4284− 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+```
42856219
4286− - In LaTeX input, text in `code` environments will be parsed as
4287− Haskell code.
6220+## Pyout
42886221
4289− - In LaTeX output, code blocks with class `haskell` will be rendered
4290− 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+```
42916231
4292− - In HTML output, code blocks with class `haskell` will be rendered
4293− with class `literatehaskell` and bird tracks.
6232+## Image
42946233
4295−Examples:
6234+This image  will be
6235+included as a cell attachment.
6236+````
42966237
4297− 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:
42986243
4299−reads literate Haskell source formatted with Markdown conventions and writes
4300−ordinary HTML (without bird tracks).
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
43016247
4302− pandoc -f markdown+lhs -t html+lhs
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
43036251
4304−writes HTML with the Haskell code in bird tracks, so it can be copied
4305−and pasted as literate Haskell source.
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
43066256
4307−Note that GHC expects the bird tracks in the first column, so indentend literate
4308−code blocks (e.g. inside an itemized environment) will not be picked up by the
4309−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+```
43106274
4311−Syntax highlighting
4312−===================
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
43136306
43146307Pandoc will automatically highlight syntax in [fenced code blocks] that
43156308are marked with a language name. The Haskell library [skylighting] is
4316−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4317−To see a list of language names that pandoc will recognize, type
4318−`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`.
43196312
43206313The color scheme can be selected using the `--highlight-style` option.
43216314The default color scheme is `pygments`, which imitates the default color
@@ -4323,15 +6316,36 @@ scheme used by the Python library pygments (though pygments is not actually
43236316used to do the highlighting). To see a list of highlight styles,
43246317type `pandoc --list-highlight-styles`.
43256318
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+
43266337To disable highlighting, use the `--no-highlight` option.
43276338
43286339[skylighting]: https://github.com/jgm/skylighting
43296340
4330−Custom Styles in Docx Output
4331−============================
6341+# Custom Styles
6342+
6343+Custom styles can be used in the docx and ICML formats.
6344+
6345+## Output
43326346
4333−By default, pandoc's docx output applies a predefined set of styles for
4334−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
43356349formatting (italics, bold) for inlines. This will work for most
43366350purposes, especially alongside a `reference.docx` file. However, if you
43376351need to apply your own styles to blocks, or match a preexisting set of
@@ -4339,8 +6353,10 @@ styles, pandoc allows you to define custom styles for blocks and text
43396353using `div`s and `span`s, respectively.
43406354
43416355If you define a `div` or `span` with the attribute `custom-style`,
4342−pandoc will apply your specified style to the contained elements. So,
4343−for example using the `bracketed_spans` syntax,
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,
43446360
43456361 [Get out]{custom-style="Emphatically"}, he said.
43466362
@@ -4356,9 +6372,9 @@ style `Emphatically`. Similarly, using the `fenced_divs` syntax,
43566372
43576373would style the two contained lines with the `Poetry` paragraph style.
43586374
4359−If the styles are not yet in your reference.docx, they will be defined
4360−in the output file as inheriting from normal text. If they are already
4361−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.
43626378
43636379This feature allows for greatest customization in conjunction with
43646380[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -4368,34 +6384,137 @@ want all italics to be transformed to the `Emphasis` character style
43686384transform all italicized inlines to inlines within an `Emphasis`
43696385custom-style `span`.
43706386
4371−[pandoc filters]: http://pandoc.org/filters.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.
43726403
4373−Custom writers
4374−==============
6404+For example, using the `custom-style-reference.docx` file in the test
6405+directory, we have the following different outputs:
43756406
4376−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4377−includes a lua interpreter, so lua need not be installed separately.)
6407+Without the `+styles` extension:
43786408
4379−To use a custom writer, simply specify the path to the lua script
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.
6438+
6439+# Custom writers
6440+
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
6443+
6444+To use a custom writer, simply specify the path to the Lua script
43806445in place of the output format. For example:
43816446
43826447 pandoc -t data/sample.lua
43836448
4384−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
43856450possible element in a pandoc document. To get a documented example
43866451which you can modify according to your needs, do
43876452
43886453 pandoc --print-default-data-file sample.lua
43896454
4390−[lua]: http://www.lua.org
4391−
4392−Authors
4393−=======
4394−
4395−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
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
43966514under the [GPL], version 2 or greater. This software carries no
43976515warranty of any kind. (See COPYRIGHT for full copyright and
43986516warranty notices.) For a full list of contributors, see the file
43996517AUTHORS.md in the pandoc source code.
44006518
4401−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
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"