@@ -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], [Muse], [txt2tags], [Vimwiki], [EPUB],
20−[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], [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,97 +40,33 @@ model. While conversions from pandoc's Markdown to all formats aspire
5640to be perfect, conversions from formats more expressive than pandoc's
5741Markdown can be expected to be lossy.
5842
59−[Markdown]: http://daringfireball.net/projects/markdown/
60−[CommonMark]: http://commonmark.org
61−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65−[S5]: http://meyerweb.com/eric/tools/s5/
66−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67−[Slideous]: http://goessner.net/articles/slideous/
68−[HTML]: http://www.w3.org/html/
69−[HTML5]: http://www.w3.org/TR/html5/
70−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71−[XHTML]: http://www.w3.org/TR/xhtml1/
72−[LaTeX]: http://latex-project.org
73−[`beamer`]: https://ctan.org/pkg/beamer
74−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75−[ConTeXt]: http://www.contextgarden.net/
76−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77−[DocBook]: http://docbook.org
78−[txt2tags]: http://txt2tags.org
79−[EPUB]: http://idpf.org/epub
80−[OPML]: http://dev.opml.org/spec2.html
81−[OpenDocument]: http://opendocument.xml.org
82−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83−[Textile]: http://redcloth.org/textile
84−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
91−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
92−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
93−[Haskell]: https://www.haskell.org
94−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
95−[Emacs Org mode]: http://orgmode.org
96−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
97−[DZSlides]: http://paulrouget.com/dzslides/
98−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
99−[PDF]: https://www.adobe.com/pdf/
100−[reveal.js]: http://lab.hakim.se/reveal-js/
101−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
102−[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
103−[TEI Simple]: https://github.com/TEIC/TEI-Simple
104−[Muse]: https://amusewiki.org/library/manual
105−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
106−[Vimwiki]: https://vimwiki.github.io
107−
108−Using `pandoc`
109−--------------
43+## Using pandoc
11044
111−If no *input-file* is specified, input is read from *stdin*.
112−Otherwise, the *input-files* are concatenated (with a blank
113−line between each) and used as input. Output goes to *stdout* by
114−default (though output to the terminal is disabled for the
115−`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
116−forced using `-o -`). For output to a file, use the `-o`
117−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:
11848
11949 pandoc -o output.html input.txt
12050
121−By default, pandoc produces a document fragment, not a standalone
122−document with a proper header and footer. To produce a standalone
123−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:
12454
12555 pandoc -s -o output.html input.txt
12656
12757For more information on how standalone documents are produced, see
128−[Templates], below.
129−
130−Instead of a file, an absolute URI may be given. In this case
131−pandoc will fetch the content using HTTP:
132−
133− pandoc -f html -t markdown http://www.fsf.org
134−
135−It is possible to supply a custom User-Agent string or other
136−header when requesting a document from a URL:
137−
138− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
139− http://www.fsf.org
58+[Templates] below.
14059
14160If multiple input files are given, `pandoc` will concatenate them all (with
142−blank lines between them) before parsing. This feature is disabled for
143− 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
14465
14566The format of the input and output can be specified explicitly using
14667command-line options. The input format can be specified using the
147−`-r/--read` or `-f/--from` options, the output format using the
148−`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
149−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:
15070
15171 pandoc -f markdown -t latex hello.txt
15272
@@ -154,14 +74,15 @@ To convert `hello.html` from HTML to Markdown:
15474
15575 pandoc -f html -t markdown hello.html
15676
157−Supported output formats are listed below under the `-t/--to` option.
158−Supported input formats are listed below under the `-f/--from` option. Note
159−that the `rst`, `textile`, `latex`, and `html` readers are not complete;
160−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.
16182
16283If the input or output format is not specified explicitly, `pandoc`
163−will attempt to guess it from the extensions of
164−the input and output filenames. Thus, for example,
84+will attempt to guess it from the extensions of the filenames.
85+Thus, for example,
16586
16687 pandoc -o hello.tex hello.txt
16788
@@ -170,7 +91,9 @@ is specified (so that output goes to *stdout*), or if the output file's
17091extension is unknown, the output format will default to HTML.
17192If no input file is specified (so that input comes from *stdin*), or
17293if the input files' extensions are unknown, the input format will
173−be assumed to be Markdown unless explicitly specified.
94+be assumed to be Markdown.
95+
96+## Character encoding
17497
17598Pandoc uses the UTF-8 character encoding for both input and output.
17699If your local character encoding is not UTF-8, you
@@ -183,156 +106,247 @@ RTF, OPML, DocBook, and Texinfo), information about
183106the character encoding is included in the document header, which
184107will only be included if you use the `-s/--standalone` option.
185108
186−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
187110
188−Creating a PDF
189−--------------
111+## Creating a PDF
190112
191−To produce a PDF, specify an output file with a `.pdf` extension.
192−By default, pandoc will use LaTeX to create the PDF:
113+To produce a PDF, specify an output file with a `.pdf` extension:
193114
194115 pandoc test.txt -o test.pdf
195116
196−Production of a PDF requires that a LaTeX engine be installed (see
197−`--pdf-engine`, below), and assumes that the following LaTeX packages
198−are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
199−[`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
200140`--listings` option is used), [`fancyvrb`], [`longtable`],
201−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
202−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
203−`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
204145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
205−the LaTeX engine requires [`fontspec`]. `xelatex` uses
206−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
207−`dir` variable set). If the `mathspec` variable is set,
208−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
209−The [`upquote`] and [`microtype`] packages are used if
210−available, and [`csquotes`] will be used for [typography]
211−if added to the template or included in any header file. The
212−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
213−optionally be used for [citation rendering]. These are included
214−with all recent versions of [TeX Live].
215−
216−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
217−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
218−[`weasyprint`] or [`prince`].
219−To do this, specify an output file with a `.pdf` extension, as before,
220−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
221−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
222−
223−PDF output can be controlled using [variables for LaTeX] (if
224−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
225−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
226−If `wkhtmltopdf` is used, then the variables `margin-left`,
227−`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
228−will affect the output.
229−
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/
230165[`amsfonts`]: https://ctan.org/pkg/amsfonts
231166[`amsmath`]: https://ctan.org/pkg/amsmath
232−[`lm`]: https://ctan.org/pkg/lm
233−[`ifxetex`]: https://ctan.org/pkg/ifxetex
234−[`ifluatex`]: https://ctan.org/pkg/ifluatex
235−[`listings`]: https://ctan.org/pkg/listings
236−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
237−[`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
238173[`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
239180[`graphicx`]: https://ctan.org/pkg/graphicx
240181[`grffile`]: https://ctan.org/pkg/grffile
241−[`geometry`]: https://ctan.org/pkg/geometry
242−[`setspace`]: https://ctan.org/pkg/setspace
243−[`xecjk`]: https://ctan.org/pkg/xecjk
244182[`hyperref`]: https://ctan.org/pkg/hyperref
245−[`ulem`]: https://ctan.org/pkg/ulem
246−[`babel`]: https://ctan.org/pkg/babel
247−[`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
248187[`mathspec`]: https://ctan.org/pkg/mathspec
249−[`unicode-math`]: https://ctan.org/pkg/unicode-math
250−[`polyglossia`]: https://ctan.org/pkg/polyglossia
251−[`fontspec`]: https://ctan.org/pkg/fontspec
252−[`upquote`]: https://ctan.org/pkg/upquote
253188[`microtype`]: https://ctan.org/pkg/microtype
254−[`csquotes`]: https://ctan.org/pkg/csquotes
255189[`natbib`]: https://ctan.org/pkg/natbib
256−[`biblatex`]: https://ctan.org/pkg/biblatex
257−[`bibtex`]: https://ctan.org/pkg/bibtex
258−[`biber`]: https://ctan.org/pkg/biber
259−[TeX Live]: http://www.tug.org/texlive/
260−[`wkhtmltopdf`]: https://wkhtmltopdf.org
261−[`weasyprint`]: http://weasyprint.org
190+[`parskip`]: https://ctan.org/pkg/parskip
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
262192[`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:
263210
264−Options
265−=======
211+ pandoc -f html -t markdown https://www.fsf.org
266212
267−General options
268−---------------
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
218+
219+# Options
220+
221+## General options {.options}
269222
270223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
271224
272−: Specify input format. *FORMAT* can be `native` (native Haskell),
273− `json` (JSON version of native AST), `markdown` (pandoc's
274− extended Markdown), `markdown_strict` (original unextended
275− Markdown), `markdown_phpextra` (PHP Markdown Extra),
276− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
277− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
278− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
279− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
280− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
281− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
282− `haddock` (Haddock markup), or `latex` (LaTeX).
283− (`markdown_github` provides deprecated and less accurate support
284− for Github-Flavored Markdown; please use `gfm` instead, unless you
285− need to use extensions other than `smart`.)
286− If `+lhs` is appended to `markdown`, `rst`, `latex`, or
287− `html`, the input will be treated as literate Haskell source: see
288− [Literate Haskell support], below. Markdown
289− syntax extensions can be individually enabled or disabled by
290− appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
291− example, `markdown_strict+footnotes+definition_lists` is strict
292− Markdown with footnotes and definition lists enabled, and
293− `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
294− without pipe tables and with hard line breaks. See [Pandoc's
295− 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
296273 their names. See `--list-input-formats` and `--list-extensions`,
297274 below.
298275
299276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
300277
301−: Specify output format. *FORMAT* can be `native` (native Haskell),
302− `json` (JSON version of native AST), `plain` (plain text),
303− `markdown` (pandoc's extended Markdown), `markdown_strict`
304− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
305− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
306− Markdown), `commonmark` (CommonMark Markdown), `rst`
307− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
308− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
309− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
310− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
311− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
312− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
313− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
314− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
315− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
316− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
317− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
318− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
319− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
320− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
321− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
322− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
323− the path of a custom lua writer (see [Custom writers],
324− below). (`markdown_github` provides deprecated and less accurate
325− support for Github-Flavored Markdown; please use `gfm` instead,
326− unless you use extensions that do not work with `gfm`.) Note that
327− `odt`, `epub`, and `epub3` output will not be directed to
328− *stdout*; an output filename must be specified using the
329− `-o/--output` option. If `+lhs` is appended to `markdown`, `rst`,
330− `latex`, `beamer`, `html4`, or `html5`, the output will be
331− rendered as literate Haskell source: see [Literate Haskell
332− support], below. Markdown syntax extensions can be individually
333− enabled or disabled by appending `+EXTENSION` or `-EXTENSION` to
334− the format name, as described above under `-f`. See
335− `--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.
336350
337351`-o` *FILE*, `--output=`*FILE*
338352
@@ -344,35 +358,43 @@ General options
344358
345359: Specify the user data directory to search for pandoc data files.
346360 If this option is not specified, the default user data directory
347− will be used. This is, in UNIX:
348−
349− $HOME/.pandoc
350−
351− in Windows XP:
352−
353− C:\Documents And Settings\USERNAME\Application Data\pandoc
354−
355− and in Windows Vista or later:
356−
357− C:\Users\USERNAME\AppData\Roaming\pandoc
358−
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`.
359368 You can find the default user data directory on your system by
360369 looking at the output of `pandoc --version`.
361− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
362− `slidy`, `slideous`, or `s5` directory
363− 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.
364387
365388`--bash-completion`
366389
367390: Generate a bash completion script. To enable bash completion
368391 with pandoc, add this to your `.bashrc`:
369392
370− eval "$(pandoc --bash-completion)"
393+ eval "$(pandoc --bash-completion)"
371394
372395`--verbose`
373396
374−: Give verbose debugging output. Currently this only has an effect
375− with PDF output.
397+: Give verbose debugging output.
376398
377399`--quiet`
378400
@@ -396,11 +418,12 @@ General options
396418
397419: List supported output formats, one per line.
398420
399−`--list-extensions`
421+`--list-extensions`[`=`*FORMAT*]
400422
401−: List supported Markdown extensions, one per line, followed
423+: List supported extensions for *FORMAT*, one per line, preceded
402424 by a `+` or `-` indicating whether it is enabled by default
403− in pandoc's Markdown.
425+ in *FORMAT*. If *FORMAT* is not specified, defaults for
426+ pandoc's Markdown are given.
404427
405428`--list-highlight-languages`
406429
@@ -420,12 +443,88 @@ General options
420443
421444: Show usage message.
422445
423−Reader options
424−--------------
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.
425522
426523`--base-header-level=`*NUMBER*
427524
428−: 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).
429528
430529`--strip-empty-paragraphs`
431530
@@ -455,7 +554,7 @@ Reader options
455554 footnotes and links will not work across files. Reading binary
456555 files (docx, odt, epub) implies `--file-scope`.
457556
458−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
459558
460559: Specify an executable to be used as a filter transforming the
461560 pandoc AST after the input is parsed and before the output is
@@ -490,47 +589,65 @@ Reader options
490589
491590 3. `$PATH` (executable only)
492591
493−`--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*
494596
495597: Transform the document in a similar fashion as JSON filters (see
496− `--filter`), but use pandoc's build-in lua filtering system. The given
497− lua script is expected to return a list of lua filters which will be
498− 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
499601 functions indexed by the name of the AST element on which the filter
500602 function should be applied.
501603
502− The `pandoc` lua module provides helper functions for element
503− 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.
504608
505− The following is an example lua script for macro-expansion:
609+ In order of preference, pandoc will look for Lua filters in
506610
507− function expand_hello_world(inline)
508− if inline.c == '{{helloworld}}' then
509− return pandoc.Emph{ pandoc.Str "Hello, World" }
510− else
511− return inline
512− end
513− end
611+ 1. a specified full or relative path
514612
515− return {{Str = expand_hello_world}}
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
516615
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
517618
518619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
519620
520621: Set the metadata field *KEY* to the value *VAL*. A value specified
521− 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`].
522624 Values will be parsed as YAML boolean or string values. If no value is
523625 specified, the value will be treated as Boolean true. Like
524626 `--variable`, `--metadata` causes template variables to be set.
525627 But unlike `--variable`, `--metadata` affects the metadata of the
526628 underlying document (which is accessible from filters and may be
527− 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.
528644
529645`-p`, `--preserve-tabs`
530646
531−: Preserve tabs instead of converting them to spaces (the default).
532− Note that this will only affect tabs in literal code spans and code
533− 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.
534651
535652`--tab-stop=`*NUMBER*
536653
@@ -540,27 +657,30 @@ Reader options
540657
541658: Specifies what to do with insertions, deletions, and comments
542659 produced by the MS Word "Track Changes" feature. `accept` (the
543− default), inserts all insertions, and ignores all
544− deletions. `reject` inserts all deletions and ignores
545− insertions. Both `accept` and `reject` ignore comments. `all` puts
546− in insertions, deletions, and comments, wrapped in spans with
547− `insertion`, `deletion`, `comment-start`, and `comment-end`
548− classes, respectively. The author and time of change is
549− included. `all` is useful for scripting: only accepting changes
550− from a certain reviewer, say, or before a certain date. This
551− 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.
552672
553673`--extract-media=`*DIR*
554674
555675: Extract images and other media contained in or linked from
556676 the source document to the path *DIR*, creating it if
557677 necessary, and adjust the images references in the document
558− so they point to the extracted files. If the source format is
559− a binary container (docx, epub, or odt), the media is
560− extracted from the container and the original
561− filenames are used. Otherwise the media is read from the
562− file system or downloaded, and new filenames are constructed
563− 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.
564684
565685`--abbreviations=`*FILE*
566686
@@ -571,29 +691,30 @@ Reader options
571691 system default, use
572692 `pandoc --print-default-data-file=abbreviations`. The only
573693 use pandoc makes of this list is in the Markdown reader.
574− Strings ending in a period that are found in this list will
575− be followed by a nonbreaking space, so that the period will
576− 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.
577697
578698[`pandocfilters`]: https://github.com/jgm/pandocfilters
579699[PHP]: https://github.com/vinai/pandocfilters-php
580700[perl]: https://metacpan.org/pod/Pandoc::Filter
581701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
582703
583−General writer options
584−----------------------
704+## General writer options {.options}
585705
586706`-s`, `--standalone`
587707
588708: Produce output with an appropriate header and footer (e.g. a
589709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
590710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
591− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
592713
593−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
594715
595−: Use *FILE* as a custom template for the generated document. Implies
596− `--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
597718 of template syntax. If no extension is specified, an extension
598719 corresponding to the writer will be added, so that `--template=special`
599720 looks for `special.html` for HTML output. If the template is not
@@ -605,22 +726,29 @@ General writer options
605726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
606727
607728: Set the template variable *KEY* to the value *VAL* when rendering the
608− document in standalone mode. This is generally only useful when the
609− `--template` option is used to specify a custom template, since
610− pandoc automatically sets the variables used in the default
611− templates. If no *VAL* is specified, the key will be given the
612− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
613731
614732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
615733
616734: Print the system default template for an output *FORMAT*. (See `-t`
617735 for a list of possible *FORMAT*s.) Templates in the user data
618− 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`.
619745
620746`--print-default-data-file=`*FILE*
621747
622748: Print a system default data file. Files in the user data directory
623− 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.
624752
625753`--eol=crlf`|`lf`|`native`
626754
@@ -631,9 +759,12 @@ General writer options
631759
632760`--dpi`=*NUMBER*
633761
634−: Specify the dpi (dots per inch) value for conversion from pixels
635− to inch/centimeters and vice versa. The default is 96dpi.
636− 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.
637768
638769`--wrap=auto`|`none`|`preserve`
639770
@@ -646,6 +777,8 @@ General writer options
646777 where there are nonsemantic newlines in the source, there
647778 will be nonsemantic newlines in the output as well).
648779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
649782
650783`--columns=`*NUMBER*
651784
@@ -658,14 +791,21 @@ General writer options
658791: Include an automatically generated table of contents (or, in
659792 the case of `latex`, `context`, `docx`, `odt`,
660793 `opendocument`, `rst`, or `ms`, an instruction to create
661− one) in the output document. This option has no effect on
662− `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`.
663803
664804`--toc-depth=`*NUMBER*
665805
666806: Specify the number of section levels to include in the table
667− of contents. The default is 3 (which means that level 1, 2, and 3
668− 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).
669809
670810`--strip-comments`
671811
@@ -701,7 +841,10 @@ General writer options
701841
702842: Prints a JSON version of a highlighting style, which can
703843 be modified, saved with a `.theme` extension, and used
704− 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.
705848
706849`--syntax-definition=`*FILE*
707850
@@ -709,9 +852,10 @@ General writer options
709852 which will be used for syntax highlighting of appropriately
710853 marked code blocks. This can be used to add support for
711854 new languages or to use altered syntax definitions for
712− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
713857
714−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
715859
716860: Include contents of *FILE*, verbatim, at the end of the header.
717861 This can be used, for example, to include special
@@ -719,7 +863,7 @@ General writer options
719863 repeatedly to include multiple files in the header. They will be
720864 included in the order specified. Implies `--standalone`.
721865
722−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
723867
724868: Include contents of *FILE*, verbatim, at the beginning of the
725869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -728,7 +872,7 @@ General writer options
728872 used repeatedly to include multiple files. They will be included in
729873 the order specified. Implies `--standalone`.
730874
731−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
732876
733877: Include contents of *FILE*, verbatim, at the end of the document
734878 body (before the `</body>` tag in HTML, or the
@@ -747,28 +891,39 @@ General writer options
747891 will not be searched. For example:
748892 `--resource-path=.:test` will search the working directory
749893 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`.
750899
751900`--request-header=`*NAME*`:`*VAL*
752901
753902: Set the request header *NAME* to the value *VAL* when making
754903 HTTP requests (for example, when a URL is given on the
755904 command line, or when resources used in a document must be
756− downloaded).
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
907+
908+`--no-check-certificate`
909+
910+: Disable the certificate verification to allow access to
911+ unsecure HTTP resources (for example when the certificate
912+ is no longer valid or self signed).
757913
758−Options affecting specific writers
759−----------------------------------
914+## Options affecting specific writers {.options}
760915
761916`--self-contained`
762917
763918: Produce a standalone HTML file with no external dependencies, using
764919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
765− images, and videos. The resulting file should be "self-contained,"
766− in the sense that it needs no external files and no net access to be
767− displayed properly by a browser. This option works only with HTML output
768− formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
769− `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
770− stylesheets at absolute URLs will be downloaded; those at relative URLs
771− 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
772927 file is local) or relative to the base URL (if the first source
773928 file is remote). Elements with the attribute
774929 `data-external="1"` will be left alone; the documents they
@@ -781,13 +936,18 @@ Options affecting specific writers
781936
782937`--html-q-tags`
783938
784−: 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.)
785942
786943`--ascii`
787944
788−: Use only ASCII characters in output. Currently supported only for
789− HTML and DocBook output (which uses numerical entities instead of
790− 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.
791951
792952`--reference-links`
793953
@@ -796,36 +956,45 @@ Options affecting specific writers
796956 placement of link references is affected by the
797957 `--reference-location` option.
798958
799−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
800960
801961: Specify whether footnotes (and references, if `reference-links` is
802962 set) are placed at the end of the current (top-level) block, the
803963 current section, or the document. The default is
804964 `document`. Currently only affects the markdown writer.
805965
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+
806974`--atx-headers`
807975
808−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
809− to use setext-style headers for levels 1-2, and then ATX headers.
810− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
811977
812−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
813979
814−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
815− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
816− all headers are shifted such that the top-level header becomes the specified
817− type. The default behavior is to determine the best division type via
818− heuristics: unless other conditions apply, `section` is chosen. When the
819− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
820− `article` option is specified), `chapter` is implied as the setting for this
821− option. If `beamer` is the output format, specifying either `chapter` or
822− `part` will cause top-level headers to become `\part{..}`, while
823− 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.
824993
825994`-N`, `--number-sections`
826995
827−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
828− 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
829998 `unnumbered` will never be numbered, even if `--number-sections`
830999 is specified.
8311000
@@ -833,16 +1002,19 @@ Options affecting specific writers
8331002
8341003: Offset for section headings in HTML output (ignored in other
8351004 output formats). The first number is added to the section number for
836− top-level headers, the second for second-level headers, and so on.
837− 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
8381007 document to be numbered "6", specify `--number-offset=5`.
839− 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
8401009 be numbered "1.5", specify `--number-offset=1,4`.
8411010 Offsets are 0 by default. Implies `--number-sections`.
8421011
8431012`--listings`
8441013
845−: 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].
8461018
8471019`-i`, `--incremental`
8481020
@@ -851,22 +1023,22 @@ Options affecting specific writers
8511023
8521024`--slide-level=`*NUMBER*
8531025
854−: Specifies that headers with the specified level create
855− 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
8561028 above this level in the hierarchy are used to divide the
857− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
8581030 subheads within a slide. Note that content that is
859− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
8601032 the slide show. The default is to set the slide level based
8611033 on the contents of the document; see [Structuring the slide
8621034 show].
8631035
8641036`--section-divs`
8651037
866−: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
867− and attach identifiers to the enclosing `<div>` (or `<section>`)
868− rather than the header itself. See
869− [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.
8701042
8711043`--email-obfuscation=none`|`javascript`|`references`
8721044
@@ -887,8 +1059,7 @@ Options affecting specific writers
8871059
8881060: Specify *STRING* as a prefix at the beginning of the title
8891061 that appears in the HTML header (but not in the title as it
890− appears at the beginning of the HTML body). Implies
891− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
8921063
8931064`-c` *URL*, `--css=`*URL*
8941065
@@ -896,8 +1067,8 @@ Options affecting specific writers
8961067 include multiple files. They will be included in the order specified.
8971068
8981069 A stylesheet is required for generating EPUB. If none is
899− provided using this option (or the `stylesheet` metadata
900− 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
9011072 user data directory (see `--data-dir`). If it is not
9021073 found there, sensible defaults will be used.
9031074
@@ -920,20 +1091,56 @@ Options affecting specific writers
9201091
9211092 To produce a custom `reference.docx`, first get a copy of
9221093 the default `reference.docx`: `pandoc
923− --print-default-data-file reference.docx >
924− custom-reference.docx`. Then open `custom-reference.docx`
925− in Word, modify the styles as you wish, and save the file.
926− For best results, do not make changes to this file other
927− than modifying the styles used by pandoc: [paragraph]
928− Normal, Body Text, First Paragraph, Compact, Title,
929− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
930− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
931− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
932− Definition Term, Definition, Caption, Table Caption,
933− Image Caption, Figure, Captioned Figure, TOC Heading;
934− [character] Default Paragraph Font, Body Text Char,
935− Verbatim Char, Footnote Reference, Hyperlink; [table]
936− 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
9371144
9381145 ODT
9391146
@@ -947,10 +1154,33 @@ Options affecting specific writers
9471154
9481155 To produce a custom `reference.odt`, first get a copy of
9491156 the default `reference.odt`: `pandoc
950− --print-default-data-file reference.odt >
951− custom-reference.odt`. Then open `custom-reference.odt` in
952− LibreOffice, modify the styles as you wish, and save the
953− 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).
9541184
9551185`--epub-cover-image=`*FILE*
9561186
@@ -1018,12 +1248,12 @@ Options affecting specific writers
10181248
10191249`--epub-chapter-level=`*NUMBER*
10201250
1021−: Specify the header level at which to split the EPUB into separate
1022− "chapter" files. The default is to split into chapters at level 1
1023− 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
10241254 EPUB, not the way chapters and sections are displayed to users. Some
10251255 readers may be slow if the chapter files are too large, so for large
1026− 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
10271257 level of 2 or 3.
10281258
10291259`--epub-subdirectory=`*DIRNAME*
@@ -1032,69 +1262,118 @@ Options affecting specific writers
10321262 the EPUB-specific contents. The default is `EPUB`. To put
10331263 the EPUB contents in the top level, use an empty string.
10341264
1035−`--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*
10361275
10371276: Use the specified engine when producing PDF output.
1038− The default is `pdflatex`. If the engine is not in your PATH,
1039− 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`
10401291
10411292`--pdf-engine-opt=`*STRING*
10421293
10431294: Use the given string as a command-line argument to the `pdf-engine`.
1044− If used multiple times, the arguments are provided with spaces between
1045− them. Note that no check for duplicate options is done.
1046−
1047−[Dublin Core elements]: http://dublincore.org/documents/dces/
1048−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1049−
1050−Citation rendering
1051−------------------
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].
10521324
10531325`--bibliography=`*FILE*
10541326
10551327: Set the `bibliography` field in the document's metadata to *FILE*,
1056− overriding any value set in the metadata, and process citations
1057− using `pandoc-citeproc`. (This is equivalent to
1058− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1059− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1060− used, making this equivalent to `--metadata bibliography=FILE`.
1061− If you supply this argument multiple times, each *FILE* will be added
1062− 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`).
10631334
10641335`--csl=`*FILE*
10651336
10661337: Set the `csl` field in the document's metadata to *FILE*,
10671338 overriding any value set in the metadata. (This is equivalent to
1068− `--metadata csl=FILE`.)
1069− 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.
10701344
10711345`--citation-abbreviations=`*FILE*
10721346
10731347: Set the `citation-abbreviations` field in the document's metadata to
10741348 *FILE*, overriding any value set in the metadata. (This is equivalent to
10751349 `--metadata citation-abbreviations=FILE`.)
1076− 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.
10771354
10781355`--natbib`
10791356
1080−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1081− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1082− 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`].
10831361
10841362`--biblatex`
10851363
1086−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1087− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1088− 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`].
10891368
1090−Math rendering in HTML
1091−----------------------
1369+## Math rendering in HTML {.options}
10921370
1093−The default is to render TeX math as far as possible using Unicode characters.
1094−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1095−differently from the surrounding text if needed. However, this gives acceptable
1096−results only for basic math, usually you will want to use `--mathjax` or another
1097−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.
10981377
10991378`--mathjax`[`=`*URL*]
11001379
@@ -1105,13 +1384,14 @@ of the following options.
11051384 The *URL* should point to the `MathJax.js` load script.
11061385 If a *URL* is not provided, a link to the Cloudflare CDN will
11071386 be inserted.
1108−
1387+
11091388`--mathml`
11101389
1111−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1112− `html4` and `html5`). This is the default in `odt` output. Note that
1113− currently only Firefox and Safari (and select e-book readers) natively
1114− 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.
11151395
11161396`--webtex`[`=`*URL*]
11171397
@@ -1128,67 +1408,26 @@ of the following options.
11281408`--katex`[`=`*URL*]
11291409
11301410: Use [KaTeX] to display embedded TeX math in HTML output.
1131− The *URL* is the base URL for the KaTeX library. If a *URL* is
1132− not provided, a link to the KaTeX CDN will be inserted.
1133−
1134−`--katex-stylesheet=`*URL*
1135−
1136−: The *URL* should point to the `katex.css` stylesheet. If this option is
1137− not specified, a link to the KaTeX CDN will be inserted. Note that this
1138− option does not imply `--katex`.
1139−
1140−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1141−
1142−: *Deprecated.*
1143− Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1144− TeX math will be displayed between `$` or `$$` characters and put in
1145− `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1146− change it to MathML. Note that currently only Firefox and Safari
1147− (and select e-book readers) natively support MathML.
1148− To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1149−
1150−`--jsmath`[`=`*URL*]
1151−
1152−: *Deprecated.*
1153− Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1154− math in HTML output. TeX math will be put inside `<span>` tags
1155− (for inline math) or `<div>` tags (for display math) with class
1156− `math` and rendered by the jsMath script. The *URL* should point to
1157− the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1158− to in the header of standalone HTML documents. If a *URL* is not provided,
1159− no link to the jsMath load script will be inserted; it is then
1160− 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.
11611414
11621415`--gladtex`
11631416
1164−: *Deprecated.*
1165− Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1166− can then be processed by [gladTeX] to produce images of the typeset
1167− formulas and an HTML file with links to these images.
1168− 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.
11691420
11701421 pandoc -s --gladtex input.md -o myfile.htex
1171− gladtex -d myfile-images myfile.htex
1172− # produces myfile.html and images in myfile-images
1173−
1174−`--mimetex`[`=`*URL*]
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
11751424
1176−: *Deprecated.*
1177− Render TeX math using the [mimeTeX] CGI script, which generates an
1178− image for each TeX formula. This should work in all browsers. If
1179− *URL* is not specified, it is assumed that the script is at
1180− `/cgi-bin/mimetex.cgi`.
1181−
1182−[MathML]: http://www.w3.org/Math/
1183−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1184−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1425+[MathML]: https://www.w3.org/Math/
11851426[MathJax]: https://www.mathjax.org
1186−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1187−[mimeTeX]: http://www.forkosh.com/mimetex.html
11881427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
11891429
1190−Options for wrapper scripts
1191−---------------------------
1430+## Options for wrapper scripts {.options}
11921431
11931432`--dump-args`
11941433
@@ -1212,8 +1451,277 @@ Options for wrapper scripts
12121451
12131452 pandoc -o foo.html -s
12141453
1215−Templates
1216−=========
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
12171725
12181726When the `-s/--standalone` option is used, pandoc uses a template to
12191727add header and footer material that is needed for a self-standing
@@ -1232,691 +1740,1590 @@ directory (see `--data-dir`, above). *Exceptions:*
12321740- For `pdf` output, customize the `default.latex` template
12331741 (or the `default.context` template, if you use `-t context`,
12341742 or the `default.ms` template, if you use `-t ms`, or the
1235− `default.html5` template, if you use `-t html5`).
1236−- `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
12371745 `--reference-doc` to customize the output).
12381746
12391747Templates contain *variables*, which allow for the inclusion of
1240−arbitrary information at any point in the file. Variables may be set
1241−within the document using [YAML metadata blocks][Extension:
1242−`yaml_metadata_block`]. They may also be set at the
1243−command line using the `-V/--variable` option: variables set in this
1244−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.
12451755
1246−Variables set by pandoc
1247−-----------------------
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.
12481761
1249−Some variables are set automatically by pandoc. These vary somewhat
1250−depending on the output format, but include metadata fields as well
1251−as the following:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
12521763
1253−`sourcefile`, `outputfile`
1254−: source and destination filenames, as given on the command line.
1255− `sourcefile` can also be a list if input comes from multiple files, or empty
1256− if input is from stdin. You can use the following snippet in your template
1257− to distinguish them:
1764+## Template syntax
12581765
1259− $if(sourcefile)$
1260− $for(sourcefile)$
1261− $sourcefile$
1262− $endfor$
1263− $else$
1264− (stdin)
1265− $endif$
1766+### Comments
12661767
1267− 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.
12681770
1269−`title`, `author`, `date`
1270−: allow identification of basic aspects of the document. Included
1271− in PDF metadata through LaTeX and ConTeXt. These can be set
1272− through a [pandoc title block][Extension: `pandoc_title_block`],
1273− which allows for multiple authors, or through a YAML metadata block:
1771+### Delimiters
12741772
1275− ---
1276− author:
1277− - Aristotle
1278− - Peter Abelard
1279− ...
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.
12801781
1281−`subtitle`
1282−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1283− renders in LaTeX only when using a document class that supports
1284− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1285− `scrreprt`, `scrbook`).[^subtitle]
1782+To include a literal `$` in the document, use `$$`.
12861783
1287−`institute`
1288−: author affiliations (in LaTeX and Beamer only). Can be a
1289− list, when there are multiple authors.
1784+### Interpolated variables
12901785
1291−`abstract`
1292−: 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:
12931791
1294−`keywords`
1295−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1296− 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+```
12971802
1298−`header-includes`
1299−: contents specified by `-H/--include-in-header` (may have multiple
1300− 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.
13011807
1302−`toc`
1303−: 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.
13041815
1305−`toc-title`
1306−: title of table of contents (works only with EPUB,
1307− opendocument, odt, docx)
1816+### Conditionals
13081817
1309−`include-before`
1310−: contents specified by `-B/--include-before-body` (may have
1311− 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:
13121824
1313−`include-after`
1314−: contents specified by `-A/--include-after-body` (may have
1315− multiple values)
1825+```
1826+$if(foo)$bar$endif$
13161827
1317−`body`
1318−: body of document
1828+$if(foo)$
1829+ $foo$
1830+$endif$
13191831
1320−`meta-json`
1321−: JSON representation of all of the document's metadata. Field
1322− values are transformed to the selected output format.
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
13231837
1324−[^subtitle]: To make `subtitle` work with other LaTeX
1325− document classes, you can add the following to `header-includes`:
1838+${if(foo)}bar${endif}
13261839
1327− \providecommand{\subtitle}[1]{%
1328− \usepackage{titling}
1329− \posttitle{%
1330− \par\large#1\end{center}}
1331− }
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
13321843
1333−Language variables
1334−------------------
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
13351850
1336−`lang`
1337−: identifies the main language of the document,
1338− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1339− For some output formats, pandoc will convert it to an appropriate
1340− format stored in the additional variables `babel-lang`,
1341− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1342−
1343− Native pandoc `span`s and `div`s with the lang attribute
1344− (value in BCP 47) can be used to switch the language in
1345− that range.
1346−
1347−`otherlangs`
1348−: a list of other languages used in the document
1349− in the YAML metadata, according to [BCP 47]. For example:
1350− `otherlangs: [en-GB, fr]`.
1351− This is automatically generated from the `lang` attributes
1352− in all `span`s and `div`s but can be overridden.
1353− Currently only used by LaTeX through the generated
1354− `babel-otherlangs` and `polyglossia-otherlangs` variables.
1355− The LaTeX writer outputs polyglossia commands in the text but
1356− the `babel-newcommands` variable contains mappings for them
1357− to the corresponding babel.
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
13581853
1359−`dir`
1360−: the base direction of the document, either `rtl` (right-to-left)
1361− or `ltr` (left-to-right).
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
13621863
1363− For bidirectional documents, native pandoc `span`s and `div`s
1364− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1365− override the base direction in some output formats.
1366− This may not always be necessary if the final renderer
1367− (e.g. the browser, when generating HTML) supports the
1368− [Unicode Bidirectional Algorithm].
1864+### For loops
13691865
1370− When using LaTeX for bidirectional documents, only the `xelatex` engine
1371− 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.
13721869
1373−[BCP 47]: https://tools.ietf.org/html/bcp47
1374−[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.
13751877
1376−Variables for slides
1377−--------------------
1878+Examples:
13781879
1379−Variables are available for [producing slide shows with pandoc],
1380−including all [reveal.js configuration options].
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
13811882
1382−`titlegraphic`
1383−: title graphic for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
13841886
1385−`logo`
1386−: logo for Beamer documents
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
13871890
1388−`slidy-url`
1389−: base URL for Slidy documents (defaults to
1390− `https://www.w3.org/Talks/Tools/Slidy2`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
13911895
1392−`slideous-url`
1393−: 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.
13941899
1395−`s5-url`
1396−: base URL for S5 documents (defaults to `s5/default`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
13971903
1398−`revealjs-url`
1399−: 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.
14001906
1401−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1402−: themes for LaTeX [`beamer`] documents
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
14031912
1404−`themeoptions`
1405−: options for LaTeX beamer themes (a list).
1913+### Partials
14061914
1407−`navigation`
1408−: controls navigation symbols in `beamer` documents
1409− (default is `empty` for no navigation symbols; other valid values
1410− 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:
14111918
1412−`section-titles`
1413−: enables on "title pages" for new sections in `beamer`
1414− documents (default = true).
1919+```
1920+${ styles() }
1921+```
14151922
1416−`beamerarticle`
1417−: when true, the `beamerarticle` package is loaded (for
1418− 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:
14191928
1420−`aspectratio`
1421−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1422− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1423− default, and `32` for 3:2).
1929+```
1930+${ styles.html() }
1931+```
14241932
1425−[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.)
14261937
1427−Variables for LaTeX
1428−-------------------
1938+Partials may optionally be applied to variables using
1939+a colon:
14291940
1430−LaTeX variables are used when [creating a PDF].
1941+```
1942+${ date:fancy() }
14311943
1432−`papersize`
1433−: paper size, e.g. `letter`, `a4`
1944+${ articles:bibentry() }
1945+```
14341946
1435−`fontsize`
1436−: 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
14371950
1438−`documentclass`
1439−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
14401956
1441−`classoption`
1442−: option for document class, e.g. `oneside`; may be repeated
1443− 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`.
14441961
1445−`geometry`
1446−: option for [`geometry`] package, e.g. `margin=1in`;
1447− may be repeated for multiple options
1962+Final newlines are omitted from included partials.
14481963
1449−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1450−: sets margins, if `geometry` is not used (otherwise `geometry`
1451− overrides these)
1964+Partials may include other partials.
14521965
1453−`linestretch`
1454−: adjusts line spacing using the [`setspace`]
1455− package, e.g. `1.25`, `1.5`
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
14561969
1457−`fontfamily`
1458−: font package for use with `pdflatex`:
1459− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1460− The default is [Latin Modern][`lm`].
1970+```
1971+${months[, ]}$
14611972
1462−`fontfamilyoptions`
1463−: options for package used as `fontfamily`: e.g. `osf,sc` with
1464− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1465− figures and true small caps; may be repeated for multiple options
1973+${articles:bibentry()[; ]$
1974+```
14661975
1467−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1468−: font families for use with `xelatex` or
1469− `lualatex`: take the name of any system font, using the
1470− [`fontspec`] package. Note that if `CJKmainfont` is used,
1471− the [`xecjk`] package must be available.
1976+The separator in this case is literal and (unlike with `sep`
1977+in an explicit `for` loop) cannot contain interpolated
1978+variables or other template directives.
14721979
1473−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1474−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1475− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1476− available through [`fontspec`], such as the OpenType features
1477− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1980+### Nesting
14781981
1479−`fontenc`
1480−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1481− default is `T1` (see guide to [LaTeX font encodings])
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
14821984
1483−`microtypeoptions`
1484−: options to pass to the microtype package
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
14851988
1486−`colorlinks`
1487−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1488− `urlcolor`, or `toccolor` are set
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
14891991
1490−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1491−: color for internal links, citation links, external links, and links in table of contents:
1492− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
14931996
1494−`links-as-notes`
1495−: causes links to be printed as footnotes
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
14961999
1497−`indent`
1498−: uses document class settings for indentation (the default LaTeX template
1499− otherwise removes indentation and adds space between paragraphs)
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
15002004
1501−`subparagraph`
1502−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1503− as sections, changing the appearance of nested headings in some classes
2005+will produce
15042006
1505−`thanks`
1506−: specifies contents of acknowledgments footnote after document title.
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
15072012
1508−`toc`
1509−: include table of contents (can also be set using `--toc/--table-of-contents`)
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
15102017
1511−`toc-depth`
1512−: level of section to include in table of contents
2018+### Breakable spaces
15132019
1514−`secnumdepth`
1515−: numbering depth for sections, if sections are numbered
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
15162024
1517−`lof`, `lot`
1518−: include list of figures, list of tables
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
15192029
1520−`bibliography`
1521−: bibliography to use for resolving references
2030+### Pipes
15222031
1523−`biblio-style`
1524−: bibliography style, when used with `--natbib` and `--biblatex`.
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
15252035
1526−`biblio-title`
1527−: bibliography title, when used with `--natbib` and `--biblatex`.
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
15282040
1529−`biblatexoptions`
1530−: list of options for biblatex.
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
15312044
1532−`natbiboptions`
1533−: list of options for natbib.
2045+$employee:name()/uppercase$
2046+```
15342047
1535−`pagestyle`
1536−: An option for LaTeX's `\pagestyle{}`. The default article class
1537− supports 'plain' (default), 'empty', and 'headings'; headings puts
1538− section titles in the header.
2048+Pipes may be chained:
15392049
1540−[`article`]: https://ctan.org/pkg/article
1541−[`report`]: https://ctan.org/pkg/report
1542−[`book`]: https://ctan.org/pkg/book
1543−[KOMA-Script]: https://ctan.org/pkg/koma-script
1544−[`memoir`]: https://ctan.org/pkg/memoir
1545−[`xcolor`]: https://ctan.org/pkg/xcolor
1546−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1547−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1548−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
15492055
1550−Variables for ConTeXt
1551−---------------------
2056+Some pipes take parameters:
15522057
1553−`papersize`
1554−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1555− may be repeated for multiple options
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
15562065
1557−`layout`
1558−: options for page margins and text arrangement (see [ConTeXt Layout]);
1559− may be repeated for multiple options
2066+Currently the following pipes are predefined:
15602067
1561−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1562−: sets margins, if `layout` is not used (otherwise `layout`
1563− overrides these)
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.
15642072
1565−`fontsize`
1566−: font size for body text (e.g. `10pt`, `12pt`)
2073+- `uppercase`: Converts text to uppercase.
15672074
1568−`mainfont`, `sansfont`, `monofont`, `mathfont`
1569−: font families: take the name of any system font (see [ConTeXt Font Switching])
2075+- `lowercase`: Converts text to lowercase.
15702076
1571−`linkcolor`, `contrastcolor`
1572−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
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.
15732080
1574−`linkstyle`
1575−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
15762083
1577−`indenting`
1578−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1579− may be repeated for multiple options
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
15802087
1581−`whitespace`
1582−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
15832091
1584−`interlinespace`
1585−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1586− may be repeated for multiple options
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.
15872095
1588−`headertext`, `footertext`
1589−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1590− may be repeated up to four times for different placement
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.
15912099
1592−`pagenumbering`
1593−: page number style and location (using [`setuppagenumbering`]);
1594− may be repeated for multiple options
2100+- `chomp`: Removes trailing newlines (and breakable space).
15952101
1596−`toc`
1597−: include table of contents (can also be set using `--toc/--table-of-contents`)
2102+- `nowrap`: Disables line wrapping on breakable spaces.
15982103
1599−`lof`, `lot`
1600−: include list of figures, list of tables
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`.
16012109
1602−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1603−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1604−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1605−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1606−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1607−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1608−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1609−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1610−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
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`.
16112114
1612−Variables for man pages
1613−-----------------------
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.
16142122
1615−`section`
1616−: section number in man pages
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
16172126
1618−`header`
1619−: header in man pages
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
16202130
1621−`footer`
1622−: footer in man pages
16232131
1624−`adjusting`
1625−: adjusts text to left (`l`), right (`r`), center (`c`),
1626− or both (`b`) margins
2132+## Variables
16272133
1628−`hyphenate`
1629−: if `true` (the default), hyphenation will be used
2134+### Metadata variables
16302135
1631−Variables for ms
1632−----------------
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`]:
16332142
1634−`pointsize`
1635−: point size (e.g. `10p`)
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
16362148
1637−`lineheight`
1638−: line height (e.g. `12p`)
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.
16392155
1640−`fontfamily`
1641−: font family (e.g. `T` or `P`)
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
16422159
1643−`indent`
1644−: paragraph indent (e.g. `2m`)
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
16452163
1646−Using variables in templates
1647−----------------------------
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
16482167
1649−Variable names are sequences of alphanumerics, `-`, and `_`,
1650−starting with a letter. A variable name surrounded by `$` signs
1651−will be replaced by its value. For example, the string `$title$` in
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
16522170
1653− <title>$title$</title>
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
16542174
1655−will be replaced by the document title.
2175+`category`
2176+: document category, included in docx and pptx metadata
16562177
1657−To write a literal `$` in a template, use `$$`.
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:
16582182
1659−Templates may contain conditionals. The syntax is as follows:
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.
16602192
1661− $if(variable)$
1662− X
1663− $else$
1664− Y
1665− $endif$
2193+ It consists of two paragraphs
2194+ ...
16662195
1667−This will include `X` in the template if `variable` has a non-null
1668−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1669−any valid template text, and may include interpolated variables or other
1670−conditionals. The `$else$` section may be omitted.
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.
16712199
1672−When variables can have multiple values (for example, `author` in
1673−a multi-author document), you can use the `$for$` keyword:
2200+### Language variables
16742201
1675− $for(author)$
1676− <meta name="author" content="$author$" />
1677− $endfor$
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.
16782208
1679−You can optionally specify a separator to be used between
1680−consecutive items:
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
16812211
1682− $for(author)$$author$$sep$, $endfor$
2212+ ---
2213+ lang: en-GB
2214+ ...
16832215
1684−A dot can be used to select a field of a variable that takes
1685−an object as its value. So, for example:
2216+ Text in the main document language (British English).
16862217
1687− $author.name$ ($author.affiliation$)
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
16882221
1689−If you use custom templates, you may need to revise them as pandoc
1690−changes. We recommend tracking the changes in the default templates,
1691−and modifying your custom templates accordingly. An easy way to do this
1692−is to fork the [pandoc-templates] repository and merge in changes after each
1693−pandoc release.
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
16942223
1695−Templates may contain comments: anything on a line after `$--`
1696−will be treated as a comment and ignored.
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
16972227
1698−[pandoc-templates]: https://github.com/jgm/pandoc-templates
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].
16992234
1700−Pandoc's Markdown
1701−=================
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
17022238
1703−Pandoc understands an extended and slightly revised version of
1704−John Gruber's [Markdown] syntax. This document explains the syntax,
1705−noting differences from standard Markdown. Except where noted, these
1706−differences can be suppressed by using the `markdown_strict` format instead
1707−of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1708−to the format name and disabled by adding `-EXTENSION`. For example,
1709−`markdown_strict+footnotes` is strict Markdown with footnotes
1710−enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1711−Markdown without footnotes or pipe tables.
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/
17122242
1713−Philosophy
1714−----------
2243+### Variables for HTML
17152244
1716−Markdown is designed to be easy to write, and, even more importantly,
1717−easy to read:
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`.
17182252
1719−> A Markdown-formatted document should be publishable as-is, as plain
1720−> text, without looking like it's been marked up with tags or formatting
1721−> instructions.
1722−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
17232255
1724−This principle has guided pandoc's decisions in finding syntax for
1725−tables, footnotes, and other extensions.
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).
17262260
1727−There is, however, one respect in which pandoc's aims are different
1728−from the original aims of Markdown. Whereas Markdown was originally
1729−designed with HTML generation in mind, pandoc is designed for multiple
1730−output formats. Thus, while pandoc allows the embedding of raw HTML,
1731−it discourages it, and provides other, non-HTMLish ways of representing
1732−important document elements like definition lists, tables, mathematics, and
1733−footnotes.
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
17342263
1735−Paragraphs
1736−----------
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
17372266
1738−A paragraph is one or more lines of text followed by one or more blank lines.
1739−Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1740−If you need a hard line break, put two or more spaces at the end of a line.
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
17412269
1742−#### Extension: `escaped_line_breaks` ####
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
17432273
1744−A backslash followed by a newline is also a hard line break.
1745−Note: in multiline and grid table cells, this is the only way
1746−to create a hard line break, since trailing spaces in the cells
1747−are ignored.
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
17482277
1749−Headers
1750−-------
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
17512280
1752−There are two kinds of headers: Setext and ATX.
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
17532283
1754−### Setext-style headers ###
2284+To override or extend some [CSS] for just one document, include for example:
17552285
1756−A setext-style header is a line of text "underlined" with a row of `=` signs
1757−(for a level one header) or `-` signs (for a level two header):
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+ ---
17582303
1759− A level-one header
1760− ==================
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
17612305
1762− A level-two header
1763− ------------------
2306+### Variables for HTML math
17642307
1765−The header text can contain inline formatting, such as emphasis (see
1766−[Inline formatting], below).
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`.
17672312
2313+### Variables for HTML slides
17682314
1769−### ATX-style headers ###
2315+These affect HTML output when [producing slide shows with pandoc].
17702316
1771−An ATX-style header consists of one to six `#` signs and a line of
1772−text, optionally followed by any number of `#` signs. The number of
1773−`#` signs at the beginning of the line is the header level:
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
17742319
1775− ## A level-two header
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
17762323
1777− ### A level-three header ###
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
17782326
1779−As with setext-style headers, the header text can contain formatting:
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
17802330
1781− # A level-one header with a [link](/url) and *emphasis*
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
17822333
1783−#### Extension: `blank_before_header` ####
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.
17842337
1785−Standard Markdown syntax does not require a blank line before a header.
1786−Pandoc does require this (except, of course, at the beginning of the
1787−document). The reason for the requirement is that it is all too easy for a
1788−`#` to end up at the beginning of a line by accident (perhaps through line
1789−wrapping). Consider, for example:
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`.
17902340
1791− I like several of their flavors of ice cream:
1792− #22, for example, and #5.
2341+[reveal.js configuration options]: https://revealjs.com/config/
17932342
1794−#### Extension: `space_in_atx_header` ####
2343+### Variables for Beamer slides
17952344
1796−Many Markdown implementations do not require a space between the
1797−opening `#`s of an ATX header and the header text, so that
1798−`#5 bolt` and `#hashtag` count as headers. With this extension,
1799−pandoc does require the space.
2345+These variables change the appearance of PDF slides using [`beamer`].
18002346
1801−### Header identifiers ###
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)
18022351
1803−#### Extension: `header_attributes` ####
2352+`beamerarticle`
2353+: produce an article from Beamer slides
18042354
1805−Headers can be assigned attributes using this syntax at the end
1806−of the line containing the header text:
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
18072357
1808− {#identifier .class .class key=value key=value}
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
18092360
1810−Thus, for example, the following headers will all be assigned the identifier
1811−`foo`:
2361+`logo`
2362+: logo image for slides
18122363
1813− # My header {#foo}
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
18142367
1815− ## My header ## {#foo}
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
18162370
1817− My other header {#foo}
1818− ---------------
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
18192373
1820−(This syntax is compatible with [PHP Markdown Extra].)
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
18212376
1822−Note that although this syntax allows assignment of classes and key/value
1823−attributes, writers generally don't use all of this information. Identifiers,
1824−classes, and key/value attributes are used in HTML and HTML-based formats such
1825−as EPUB and slidy. Identifiers are used for labels and link anchors in the
1826−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2377+`titlegraphic`
2378+: image for title slide
18272379
1828−Headers with the class `unnumbered` will not be numbered, even if
1829−`--number-sections` is specified. A single hyphen (`-`) in an attribute
1830−context is equivalent to `.unnumbered`, and preferable in non-English
1831−documents. So,
2380+### Variables for PowerPoint
18322381
1833− # My header {-}
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
18342384
1835−is just the same as
2385+`monofont`
2386+: font to use for code.
18362387
1837− # My header {.unnumbered}
2388+### Variables for LaTeX
18382389
1839−#### Extension: `auto_identifiers` ####
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
18402391
1841−A header without an explicitly specified identifier will be
1842−automatically assigned a unique identifier based on the header text.
1843−To derive the identifier from the header text,
2392+#### Layout
18442393
1845− - Remove all formatting, links, etc.
1846− - Remove all footnotes.
1847− - Remove all punctuation, except underscores, hyphens, and periods.
1848− - Replace all spaces and newlines with hyphens.
1849− - Convert all alphabetic characters to lowercase.
1850− - Remove everything up to the first letter (identifiers may
1851− not begin with a number or punctuation mark).
1852− - If nothing is left after this, use the identifier `section`.
2394+`block-headings`
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
2397+ classes) free-standing rather than run-in; requires further
2398+ formatting to distinguish from `\subsubsection` (third- or
2399+ fourth-level headings). Instead of using this option,
2400+ [KOMA-Script] can adjust headings more extensively:
18532401
1854−Thus, for example,
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+ ...
18552415
1856− Header Identifier
1857− ------------------------------- ----------------------------
1858− `Header identifiers in HTML` `header-identifiers-in-html`
1859− `*Dogs*?--in *my* house?` `dogs--in-my-house`
1860− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1861− `3. Applications` `applications`
1862− `33` `section`
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
18632418
1864−These rules should, in most cases, allow one to determine the identifier
1865−from the header text. The exception is when several headers have the
1866−same text; in this case, the first will get an identifier as described
1867−above; the second will get the same identifier with `-1` appended; the
1868−third with `-2`; and so on.
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
18692424
1870−These identifiers are used to provide link targets in the table of
1871−contents generated by the `--toc|--table-of-contents` option. They
1872−also make it easy to provide links from one section of a document to
1873−another. A link to this section, for example, might look like this:
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`]
18742430
1875− See the section on
1876− [header identifiers](#header-identifiers-in-html-latex-and-context).
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
18772434
1878−Note, however, that this method of providing links to sections works
1879−only in HTML, LaTeX, and ConTeXt formats.
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
18802441
1881−If the `--section-divs` option is specified, then each section will
1882−be wrapped in a `div` (or a `section`, if `html5` was specified),
1883−and the identifier will be attached to the enclosing `<div>`
1884−(or `<section>`) tag rather than the header itself. This allows entire
1885−sections to be manipulated using JavaScript or treated differently in
1886−CSS.
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
18872445
1888−#### Extension: `implicit_header_references` ####
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
18892452
1890−Pandoc behaves as if reference links have been defined for each header.
1891−So, to link to a header
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)
18922457
1893− # Header identifiers in HTML
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`
2464+ overrides these)
2465+
2466+`pagestyle`
2467+: control `\pagestyle{}`: the default article class
2468+ supports `plain` (default), `empty` (no running heads or page numbers),
2469+ and `headings` (section titles in running heads)
2470+
2471+`papersize`
2472+: paper size, e.g. `letter`, `a4`
2473+
2474+`secnumdepth`
2475+: numbering depth for sections (with `--number-sections` option
2476+ or `numbersections` variable)
2477+
2478+#### Fonts
2479+
2480+`fontenc`
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483+
2484+`fontfamily`
2485+: font package for use with `pdflatex`:
2486+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487+ The default is [Latin Modern][`lm`].
2488+
2489+`fontfamilyoptions`
2490+: options for package used as `fontfamily`; repeat for multiple options.
2491+ For example, to use the Libertine font with proportional lowercase
2492+ (old-style) figures through the [`libertinus`] package:
2493+
2494+ ---
2495+ fontfamily: libertinus
2496+ fontfamilyoptions:
2497+ - osf
2498+ - p
2499+ ...
2500+
2501+`fontsize`
2502+: font size for body text. The standard classes allow 10pt, 11pt, and
2503+ 12pt. To use another size, set `documentclass` to one of
2504+ the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2505+
2506+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2507+: font families for use with `xelatex` or
2508+ `lualatex`: take the name of any system font, using the
2509+ [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2510+
2511+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2512+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2513+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2514+ choices available through [`fontspec`]; repeat for multiple
2515+ options. For example, to use the [TeX Gyre] version of
2516+ Palatino with lowercase figures:
2517+
2518+ ---
2519+ mainfont: TeX Gyre Pagella
2520+ mainfontoptions:
2521+ - Numbers=Lowercase
2522+ - Numbers=Proportional
2523+ ...
2524+
2525+`microtypeoptions`
2526+: options to pass to the microtype package
2527+
2528+#### Links
2529+
2530+`colorlinks`
2531+: add color to link text; automatically enabled if any of
2532+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533+
2534+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535+: color for internal links, external links, citation links, linked
2536+ URLs, and links in table of contents, respectively: uses options
2537+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538+ `x11names` lists
2539+
2540+`links-as-notes`
2541+: causes links to be printed as footnotes
2542+
2543+#### Front matter
2544+
2545+`lof`, `lot`
2546+: include list of figures, list of tables
2547+
2548+`thanks`
2549+: contents of acknowledgments footnote after document title
2550+
2551+`toc`
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
2554+
2555+`toc-depth`
2556+: level of section to include in table of contents
2557+
2558+#### BibLaTeX Bibliographies
2559+
2560+These variables function when using BibLaTeX for [citation rendering].
2561+
2562+`biblatexoptions`
2563+: list of options for biblatex
2564+
2565+`biblio-style`
2566+: bibliography style, when used with `--natbib` and `--biblatex`.
2567+
2568+`biblio-title`
2569+: bibliography title, when used with `--natbib` and `--biblatex`.
2570+
2571+`bibliography`
2572+: bibliography to use for resolving references
2573+
2574+`natbiboptions`
2575+: list of options for natbib
2576+
2577+[KOMA-Script]: https://ctan.org/pkg/koma-script
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579+[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580+[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581+[`article`]: https://ctan.org/pkg/article
2582+[`book`]: https://ctan.org/pkg/book
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
2584+[`memoir`]: https://ctan.org/pkg/memoir
2585+[`report`]: https://ctan.org/pkg/report
2586+
2587+### Variables for ConTeXt
2588+
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590+
2591+`fontsize`
2592+: font size for body text (e.g. `10pt`, `12pt`)
2593+
2594+`headertext`, `footertext`
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
2597+
2598+`indenting`
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
2601+
2602+`interlinespace`
2603+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604+ repeat for multiple options
2605+
2606+`layout`
2607+: options for page margins and text arrangement (see [ConTeXt Layout]);
2608+ repeat for multiple options
2609+
2610+`linkcolor`, `contrastcolor`
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
2613+
2614+`linkstyle`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
2617+
2618+`lof`, `lot`
2619+: include list of figures, list of tables
2620+
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
2624+
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626+: sets margins, if `layout` is not used (otherwise `layout`
2627+ overrides these)
2628+
2629+`pagenumbering`
2630+: page number style and location (using [`setuppagenumbering`]);
2631+ repeat for multiple options
2632+
2633+`papersize`
2634+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635+ repeat for multiple options
2636+
2637+`pdfa`
2638+: adds to the preamble the setup necessary to generate PDF/A
2639+ of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640+ specified (i.e. the value is set to True, by e.g.
2641+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642+ `1b:2005` will be used as default, for reasons of backwards
2643+ compatibility. Using `--variable=pdfa` without specified value
2644+ is not supported. To successfully generate PDF/A the required
2645+ ICC color profiles have to be available and the content and all
2646+ included files (such as images) have to be standard conforming.
2647+ The ICC profiles and output intent may be specified using the
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649+ PDFA] for more details.
2650+
2651+`pdfaiccprofile`
2652+: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653+ in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654+ used as default. May be repeated to include multiple profiles. Note that
2655+ the profiles have to be available on the system. They can be obtained
2656+ from [ConTeXt ICC Profiles].
2657+
2658+`pdfaintent`
2659+: when used in conjunction with `pdfa`, specifies the output intent for
2660+ the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661+ If left unspecified, `sRGB IEC61966-2.1` is used as default.
2662+
2663+`toc`
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
2666+
2667+`whitespace`
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
2670+
2671+`includesource`
2672+: include all source documents as file attachments in the PDF file
2673+
2674+[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675+[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676+[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677+[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678+[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679+[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680+[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681+[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682+[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683+[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684+[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2685+
2686+### Variables for `wkhtmltopdf`
2687+
2688+Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689+The `--css` option also affects the output.
2690+
2691+`footer-html`, `header-html`
2692+: add information to the header and footer
2693+
2694+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695+: set the page margins
2696+
2697+`papersize`
2698+: sets the PDF paper size
2699+
2700+### Variables for man pages
2701+
2702+`adjusting`
2703+: adjusts text to left (`l`), right (`r`), center (`c`),
2704+ or both (`b`) margins
2705+
2706+`footer`
2707+: footer in man pages
2708+
2709+`header`
2710+: header in man pages
2711+
2712+`hyphenate`
2713+: if `true` (the default), hyphenation will be used
2714+
2715+`section`
2716+: section number in man pages
2717+
2718+### Variables for ms
2719+
2720+`fontfamily`
2721+: font family (e.g. `T` or `P`)
2722+
2723+`indent`
2724+: paragraph indent (e.g. `2m`)
2725+
2726+`lineheight`
2727+: line height (e.g. `12p`)
2728+
2729+`pointsize`
2730+: point size (e.g. `10p`)
2731+
2732+### Variables set automatically
2733+
2734+Pandoc sets these variables automatically in response to [options] or
2735+document contents; users can also modify them. These vary depending
2736+on the output format, and include the following:
2737+
2738+`body`
2739+: body of document
2740+
2741+`date-meta`
2742+: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2743+ included in all HTML based formats (dzslides, epub,
2744+ html, html4, html5, revealjs, s5, slideous, slidy).
2745+ The recognized formats for `date` are: `mm/dd/yyyy`,
2746+ `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2747+ (e.g. either `02 Apr 2018` or `02 April 2018`),
2748+ `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2749+ `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
2750+
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
2754+
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
2758+
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
2762+
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
2766+
2767+`numbersections`
2768+: non-null value if `-N/--number-sections` was specified
2769+
2770+`sourcefile`, `outputfile`
2771+: source and destination filenames, as given on the command line.
2772+ `sourcefile` can also be a list if input comes from multiple files,
2773+ or empty if input is from stdin. You can use the following snippet in
2774+ your template to distinguish them:
2775+
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
2783+
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
2785+
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787+
2788+`curdir`
2789+: working directory from which pandoc is run.
2790+
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
2793+
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2797+
2798+[pandoc-templates]: https://github.com/jgm/pandoc-templates
2799+
2800+# Extensions
2801+
2802+The behavior of some of the readers and writers can be adjusted by
2803+enabling or disabling various extensions.
2804+
2805+An extension can be enabled by adding `+EXTENSION`
2806+to the format name and disabled by adding `-EXTENSION`. For example,
2807+`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809+Markdown without footnotes or pipe tables.
2810+
2811+The markdown reader and writer make by far the most use of extensions.
2812+Extensions only used by them are therefore covered in the
2813+section [Pandoc's Markdown] below (See [Markdown variants] for
2814+`commonmark` and `gfm`.) In the following, extensions that also work
2815+for other formats are covered.
2816+
2817+Note that markdown extensions added to the `ipynb` format
2818+affect Markdown cells in Jupyter notebooks (as do command-line
2819+options like `--atx-headers`).
2820+
2821+## Typography
2822+
2823+#### Extension: `smart` ####
2824+
2825+Interpret straight quotes as curly quotes, `---` as em-dashes,
2826+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2827+inserted after certain abbreviations, such as "Mr."
2828+
2829+This extension can be enabled/disabled for the following formats:
2830+
2831+input formats
2832+: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2833+
2834+output formats
2835+: `markdown`, `latex`, `context`, `rst`
2836+
2837+enabled by default in
2838+: `markdown`, `latex`, `context` (both input and output)
2839+
2840+Note: If you are *writing* Markdown, then the `smart` extension
2841+has the reverse effect: what would have been curly quotes comes
2842+out straight.
2843+
2844+In LaTeX, `smart` means to use the standard TeX ligatures
2845+for quotation marks (` `` ` and ` '' ` for double quotes,
2846+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2847+en-dash and `---` for em-dash). If `smart` is disabled,
2848+then in reading LaTeX pandoc will parse these characters
2849+literally. In writing LaTeX, enabling `smart` tells pandoc
2850+to use the ligatures when possible; if `smart` is disabled
2851+pandoc will use unicode quotation mark and dash characters.
2852+
2853+## Headings and sections
2854+
2855+#### Extension: `auto_identifiers` ####
2856+
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
2859+
2860+This extension can be enabled/disabled for the following formats:
2861+
2862+input formats
2863+: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2864+
2865+output formats
2866+: `markdown`, `muse`
2867+
2868+enabled by default in
2869+: `markdown`, `muse`
2870+
2871+The default algorithm used to derive the identifier from the
2872+heading text is:
2873+
2874+ - Remove all formatting, links, etc.
2875+ - Remove all footnotes.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
2878+ - Replace all spaces and newlines with hyphens.
2879+ - Convert all alphabetic characters to lowercase.
2880+ - Remove everything up to the first letter (identifiers may
2881+ not begin with a number or punctuation mark).
2882+ - If nothing is left after this, use the identifier `section`.
2883+
2884+Thus, for example,
2885+
2886+ Heading Identifier
2887+ ------------------------------- ----------------------------
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
2890+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
2891+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2892+ `3. Applications` `applications`
2893+ `33` `section`
2894+
2895+These rules should, in most cases, allow one to determine the identifier
2896+from the heading text. The exception is when several headings have the
2897+same text; in this case, the first will get an identifier as described
2898+above; the second will get the same identifier with `-1` appended; the
2899+third with `-2`; and so on.
2900+
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
2903+
2904+These identifiers are used to provide link targets in the table of
2905+contents generated by the `--toc|--table-of-contents` option. They
2906+also make it easy to provide links from one section of a document to
2907+another. A link to this section, for example, might look like this:
2908+
2909+ See the section on
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2911+
2912+Note, however, that this method of providing links to sections works
2913+only in HTML, LaTeX, and ConTeXt formats.
2914+
2915+If the `--section-divs` option is specified, then each section will
2916+be wrapped in a `section` (or a `div`, if `html4` was specified),
2917+and the identifier will be attached to the enclosing `<section>`
2918+(or `<div>`) tag rather than the heading itself. This allows entire
2919+sections to be manipulated using JavaScript or treated differently in
2920+CSS.
2921+
2922+#### Extension: `ascii_identifiers` ####
2923+
2924+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2925+Accents are stripped off of accented Latin letters, and non-Latin
2926+letters are omitted.
2927+
2928+#### Extension: `gfm_auto_identifiers` ####
2929+
2930+Changes the algorithm used by `auto_identifiers` to conform to
2931+GitHub's method. Spaces are converted to dashes (`-`),
2932+uppercase characters to lowercase characters, and punctuation
2933+characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
2935+
2936+## Math Input
2937+
2938+The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2939+[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2940+[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2941+are described in the section about Pandoc's Markdown.
2942+
2943+However, they can also be used with HTML input. This is handy for
2944+reading web pages formatted using MathJax, for example.
2945+
2946+## Raw HTML/TeX
2947+
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
2950+
2951+- [`raw_html`](#extension-raw_html) allows HTML elements which
2952+ are not representable in pandoc's AST to be parsed as raw HTML.
2953+ By default, this is disabled for HTML input.
2954+
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2956+ to be included in a document. This extension can be enabled/disabled
2957+ for the following formats (in addition to `markdown`):
2958+
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
2962+
2963+ output formats
2964+ : `textile`, `commonmark`
2965+
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967+ only raw TeX in markdown cells, but data with mime type
2968+ `text/html` in output cells. Since the `ipynb` reader attempts
2969+ to preserve the richest possible outputs when several options
2970+ are given, you will get best results if you disable `raw_html`
2971+ and `raw_tex` when converting to formats like `docx` which don't
2972+ allow raw `html` or `tex`.
2973+
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2975+ elements to be parsed as native pandoc Div blocks.
2976+ If you want them to be parsed as raw HTML, use
2977+ `-f html-native_divs+raw_html`.
2978+
2979+- [`native_spans`](#extension-native_spans) causes HTML `span`
2980+ elements to be parsed as native pandoc Span inlines.
2981+ If you want them to be parsed as raw HTML, use
2982+ `-f html-native_spans+raw_html`. If you want to drop all
2983+ `div`s and `span`s when converting HTML to Markdown, you
2984+ can use `pandoc -f html-native_divs-native_spans -t markdown`.
2985+
2986+## Literate Haskell support
2987+
2988+#### Extension: `literate_haskell` ####
2989+
2990+Treat the document as literate Haskell source.
2991+
2992+This extension can be enabled/disabled for the following formats:
2993+
2994+input formats
2995+: `markdown`, `rst`, `latex`
2996+
2997+output formats
2998+: `markdown`, `rst`, `latex`, `html`
2999+
3000+If you append `+lhs` (or `+literate_haskell`) to one of the formats
3001+above, pandoc will treat the document as literate Haskell source.
3002+This means that
3003+
3004+ - In Markdown input, "bird track" sections will be parsed as Haskell
3005+ code rather than block quotations. Text between `\begin{code}`
3006+ and `\end{code}` will also be treated as Haskell code. For
3007+ ATX-style headings the character '=' will be used instead of '#'.
3008+
3009+ - In Markdown output, code blocks with classes `haskell` and `literate`
3010+ will be rendered using bird tracks, and block quotations will be
3011+ indented one space, so they will not be treated as Haskell code.
3012+ In addition, headings will be rendered setext-style (with underlines)
3013+ rather than ATX-style (with '#' characters). (This is because ghc
3014+ treats '#' characters in column 1 as introducing line numbers.)
3015+
3016+ - In restructured text input, "bird track" sections will be parsed
3017+ as Haskell code.
3018+
3019+ - In restructured text output, code blocks with class `haskell` will
3020+ be rendered using bird tracks.
3021+
3022+ - In LaTeX input, text in `code` environments will be parsed as
3023+ Haskell code.
3024+
3025+ - In LaTeX output, code blocks with class `haskell` will be rendered
3026+ inside `code` environments.
3027+
3028+ - In HTML output, code blocks with class `haskell` will be rendered
3029+ with class `literatehaskell` and bird tracks.
3030+
3031+Examples:
3032+
3033+ pandoc -f markdown+lhs -t html
3034+
3035+reads literate Haskell source formatted with Markdown conventions and writes
3036+ordinary HTML (without bird tracks).
3037+
3038+ pandoc -f markdown+lhs -t html+lhs
3039+
3040+writes HTML with the Haskell code in bird tracks, so it can be copied
3041+and pasted as literate Haskell source.
3042+
3043+Note that GHC expects the bird tracks in the first column, so indented
3044+literate code blocks (e.g. inside an itemized environment) will not be
3045+picked up by the Haskell compiler.
3046+
3047+## Other extensions
3048+
3049+#### Extension: `empty_paragraphs` ####
3050+
3051+Allows empty paragraphs. By default empty paragraphs are
3052+omitted.
3053+
3054+This extension can be enabled/disabled for the following formats:
3055+
3056+input formats
3057+: `docx`, `html`
3058+
3059+output formats
3060+: `docx`, `odt`, `opendocument`, `html`
3061+
3062+#### Extension: `native_numbering` ####
3063+
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
3066+
3067+This extension can be enabled/disabled for the following formats:
3068+
3069+output formats
3070+: `odt`, `opendocument`
3071+
3072+#### Extension: `xrefs_name` ####
3073+
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3079+name.
3080+
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3083+
3084+This extension can be enabled/disabled for the following formats:
3085+
3086+output formats
3087+: `odt`, `opendocument`
3088+
3089+#### Extension: `xrefs_number` ####
3090+
3091+Links to headings, figures and tables inside the document are
3092+substituted with cross-references that will use the number
3093+of the referenced item. The original link text is discarded.
3094+This extension can be combined with `xrefs_name` in which case
3095+the name or caption numbers will appear after the number.
3096+
3097+For the `xrefs_number` to be useful heading numbers must be enabled
3098+in the generated document, also table and figure captions must be enabled
3099+using for example the `native_numbering` extension.
3100+
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3103+
3104+This extension can be enabled/disabled for the following formats:
3105+
3106+output formats
3107+: `odt`, `opendocument`
3108+
3109+#### Extension: `styles` #### {#ext-styles}
3110+
3111+When converting from docx, read all docx styles as divs (for
3112+paragraph styles) and spans (for character styles) regardless
3113+of whether pandoc understands the meaning of these styles.
3114+This can be used with [docx custom styles](#custom-styles).
3115+Disabled by default.
3116+
3117+input formats
3118+: `docx`
3119+
3120+#### Extension: `amuse` ####
3121+
3122+In the `muse` input format, this enables Text::Amuse
3123+extensions to Emacs Muse markup.
3124+
3125+#### Extension: `raw_markdown` ####
3126+
3127+In the `ipynb` input format, this causes Markdown cells
3128+to be included as raw Markdown blocks (allowing lossless
3129+round-tripping) rather than being parsed. Use this only
3130+when you are targeting `ipynb` or a markdown-based
3131+output format.
3132+
3133+#### Extension: `citations` {#org-citations}
3134+
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
3137+
3138+#### Extension: `element_citations` ####
3139+
3140+In the `jats` output formats, this causes reference items to
3141+be replaced with `<element-citation>` elements. These
3142+elements are not influenced by CSL styles, but all information
3143+on the item is included in tags.
3144+
3145+#### Extension: `ntb` ####
3146+
3147+In the `context` output format this enables the use of [Natural Tables
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3150+Natural tables allow more fine-grained global customization but come
3151+at a performance penalty compared to extreme tables.
3152+
3153+
3154+# Pandoc's Markdown
3155+
3156+Pandoc understands an extended and slightly revised version of
3157+John Gruber's [Markdown] syntax. This document explains the syntax,
3158+noting differences from standard Markdown. Except where noted, these
3159+differences can be suppressed by using the `markdown_strict` format instead
3160+of `markdown`. Extensions can be enabled or disabled to specify the
3161+behavior more granularly. They are described in the following. See also
3162+[Extensions] above, for extensions that work also on other formats.
3163+
3164+## Philosophy
3165+
3166+Markdown is designed to be easy to write, and, even more importantly,
3167+easy to read:
3168+
3169+> A Markdown-formatted document should be publishable as-is, as plain
3170+> text, without looking like it's been marked up with tags or formatting
3171+> instructions.
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3173+
3174+This principle has guided pandoc's decisions in finding syntax for
3175+tables, footnotes, and other extensions.
3176+
3177+There is, however, one respect in which pandoc's aims are different
3178+from the original aims of Markdown. Whereas Markdown was originally
3179+designed with HTML generation in mind, pandoc is designed for multiple
3180+output formats. Thus, while pandoc allows the embedding of raw HTML,
3181+it discourages it, and provides other, non-HTMLish ways of representing
3182+important document elements like definition lists, tables, mathematics, and
3183+footnotes.
3184+
3185+## Paragraphs
3186+
3187+A paragraph is one or more lines of text followed by one or more blank lines.
3188+Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3189+If you need a hard line break, put two or more spaces at the end of a line.
3190+
3191+#### Extension: `escaped_line_breaks` ####
3192+
3193+A backslash followed by a newline is also a hard line break.
3194+Note: in multiline and grid table cells, this is the only way
3195+to create a hard line break, since trailing spaces in the cells
3196+are ignored.
3197+
3198+## Headings
3199+
3200+There are two kinds of headings: Setext and ATX.
3201+
3202+### Setext-style headings ###
3203+
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
3205+(for a level-one heading) or `-` signs (for a level-two heading):
3206+
3207+ A level-one heading
3208+ ===================
3209+
3210+ A level-two heading
3211+ -------------------
3212+
3213+The heading text can contain inline formatting, such as emphasis (see
3214+[Inline formatting], below).
3215+
3216+
3217+### ATX-style headings ###
3218+
3219+An ATX-style heading consists of one to six `#` signs and a line of
3220+text, optionally followed by any number of `#` signs. The number of
3221+`#` signs at the beginning of the line is the heading level:
3222+
3223+ ## A level-two heading
3224+
3225+ ### A level-three heading ###
3226+
3227+As with setext-style headings, the heading text can contain formatting:
3228+
3229+ # A level-one heading with a [link](/url) and *emphasis*
3230+
3231+#### Extension: `blank_before_header` ####
3232+
3233+Standard Markdown syntax does not require a blank line before a heading.
3234+Pandoc does require this (except, of course, at the beginning of the
3235+document). The reason for the requirement is that it is all too easy for a
3236+`#` to end up at the beginning of a line by accident (perhaps through line
3237+wrapping). Consider, for example:
3238+
3239+ I like several of their flavors of ice cream:
3240+ #22, for example, and #5.
3241+
3242+#### Extension: `space_in_atx_header` ####
3243+
3244+Many Markdown implementations do not require a space between the
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
3247+pandoc does require the space.
3248+
3249+### Heading identifiers ###
3250+
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
3253+
3254+#### Extension: `header_attributes` ####
3255+
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
3258+
3259+ {#identifier .class .class key=value key=value}
3260+
3261+Thus, for example, the following headings will all be assigned the identifier
3262+`foo`:
3263+
3264+ # My heading {#foo}
3265+
3266+ ## My heading ## {#foo}
3267+
3268+ My other heading {#foo}
3269+ ---------------
3270+
3271+(This syntax is compatible with [PHP Markdown Extra].)
3272+
3273+Note that although this syntax allows assignment of classes and key/value
3274+attributes, writers generally don't use all of this information. Identifiers,
3275+classes, and key/value attributes are used in HTML and HTML-based formats such
3276+as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3278+
3279+Headings with the class `unnumbered` will not be numbered, even if
3280+`--number-sections` is specified. A single hyphen (`-`) in an attribute
3281+context is equivalent to `.unnumbered`, and preferable in non-English
3282+documents. So,
3283+
3284+ # My heading {-}
3285+
3286+is just the same as
3287+
3288+ # My heading {.unnumbered}
3289+
3290+If the `unlisted` class is present in addition to `unnumbered`,
3291+the heading will not be included in a table of contents.
3292+(Currently this feature is only implemented for certain
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3294+
3295+#### Extension: `implicit_header_references` ####
3296+
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
3299+
3300+ # Heading identifiers in HTML
18943301
18953302you can simply write
18963303
1897− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
18983305
18993306or
19003307
1901− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
19023309
19033310or
19043311
1905− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
19063313 HTML]
19073314
19083315instead of giving the identifier explicitly:
19093316
1910− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
19113318
1912−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
19133320reference will link to the first one only, and you will need to use explicit
19143321links to link to the others, as described above.
19153322
19163323Like regular reference links, these references are case-insensitive.
19173324
19183325Explicit link reference definitions always take priority over
1919−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
19203327link will point to `bar`, not to `#foo`:
19213328
19223329 # Foo
@@ -1925,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
19253332
19263333 See [foo]
19273334
1928−Block quotations
1929−----------------
3335+## Block quotations
19303336
19313337Markdown uses email conventions for quoting blocks of text.
19323338A block quotation is one or more paragraphs or other block elements
1933−(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
19343340and an optional space. (The `>` need not start at the left margin, but
19353341it should not be indented more than three spaces.)
19363342
@@ -1965,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
19653371
19663372#### Extension: `blank_before_blockquote` ####
19673373
1968−Standard Markdown syntax does not require a blank line before a block
1969−quote. Pandoc does require this (except, of course, at the beginning of the
1970−document). The reason for the requirement is that it is all too easy for a
1971−`>` to end up at the beginning of a line by accident (perhaps through line
1972−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
19733380not produce a nested block quote in pandoc:
19743381
19753382 > This is a block quote.
19763383 >> Nested.
19773384
19783385
1979−Verbatim (code) blocks
1980−----------------------
3386+## Verbatim (code) blocks
19813387
19823388### Indented code blocks ###
19833389
@@ -2039,14 +3445,16 @@ this syntax:
20393445 qsort (filter (>= x) xs)
20403446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20413447
2042−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2043−`startFrom` is an attribute with value `100`. Some output formats can use this
2044−information to do syntax highlighting. Currently, the only output formats
2045−that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
2046−is supported for your output format and language, then the code block above
2047−will appear highlighted, with numbered lines. (To see which languages are
2048−supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2049−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:
20503458
20513459 <pre id="mycode" class="haskell numberLines" startFrom="100">
20523460 <code>
@@ -2083,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
20833491For more information on highlighting, see [Syntax highlighting],
20843492below.
20853493
2086−Line blocks
2087−-----------
3494+## Line blocks
20883495
20893496#### Extension: `line_blocks` ####
20903497
@@ -2110,10 +3517,12 @@ line must begin with a space.
21103517 | 200 Main St.
21113518 | Berkeley, CA 94718
21123519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
21133523This syntax is borrowed from [reStructuredText].
21143524
2115−Lists
2116−-----
3525+## Lists
21173526
21183527### Bullet lists ###
21193528
@@ -2283,6 +3692,12 @@ If default list markers are desired, use `#.`:
22833692 #. two
22843693 #. three
22853694
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
22863701
22873702### Definition lists ###
22883703
@@ -2308,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
23083723A definition begins with a colon or tilde, which may be indented one
23093724or two spaces.
23103725
2311−A term may have multiple definitions, and each definition may consist of one or
2312−more block elements (paragraph, code block, list, etc.), each indented four
2313−spaces or one tab stop. The body of the definition (including the first line,
2314−aside from the colon or tilde) should be indented four spaces. However,
2315−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
23163732at the beginning of a paragraph or other block element:
23173733
23183734 Term 1
@@ -2338,9 +3754,10 @@ definition:
23383754Note that space between items in a definition list is required.
23393755(A variant that loosens this requirement, but disallows "lazy"
23403756hard wrapping, can be activated with `compact_definition_lists`: see
2341−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
23423758
2343−[^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/).
23443761
23453762### Numbered example lists ###
23463763
@@ -2369,30 +3786,12 @@ document:
23693786The label can be any string of alphanumeric characters, underscores,
23703787or hyphens.
23713788
2372−
2373−### Compact and loose lists ###
2374−
2375−Pandoc behaves differently from `Markdown.pl` on some "edge
2376−cases" involving lists. Consider this source:
2377−
2378− + First
2379− + Second:
2380− - Fee
2381− - Fie
2382− - Foe
2383−
2384− + Third
2385−
2386−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2387−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2388−"Second" and "Third" (but not "First"), because of the blank space
2389−around "Third". Pandoc follows a simple rule: if the text is followed by
2390−a blank line, it is treated as a paragraph. Since "Second" is followed
2391−by a list, and not a blank line, it isn't treated as a paragraph. The
2392−fact that the list is followed by a blank line is irrelevant. (Note:
2393−Pandoc works this way even when the `markdown_strict` format is specified. This
2394−behavior is consistent with the official Markdown syntax description,
2395−even though it is different from that of `Markdown.pl`.)
3789+Note: continuation paragraphs in example lists must always
3790+be indented four spaces, regardless of the length of the
3791+list marker. That is, example lists always behave as if the
3792+`four_space_rule` extension is set. This is because example
3793+labels tend to be long, and indenting content to the
3794+first non-space character after the label would be awkward.
23963795
23973796
23983797### Ending a list ###
@@ -2432,8 +3831,7 @@ of one big list:
24323831 2. dos
24333832 3. tres
24343833
2435−Horizontal rules
2436−----------------
3834+## Horizontal rules
24373835
24383836A line containing a row of three or more `*`, `-`, or `_` characters
24393837(optionally separated by spaces) produces a horizontal rule:
@@ -2443,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
24433841 ---------------
24443842
24453843
2446−Tables
2447−------
3844+## Tables
24483845
24493846Four kinds of tables may be used. The first three kinds presuppose the use of
24503847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2469,7 +3866,7 @@ Simple tables look like this:
24693866
24703867 Table: Demonstration of simple table syntax.
24713868
2472−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
24733870alignments are determined by the position of the header text relative
24743871to the dashed line below it:[^4]
24753872
@@ -2488,7 +3885,7 @@ to the dashed line below it:[^4]
24883885The table must end with a blank line, or a line of dashes followed by
24893886a blank line.
24903887
2491−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
24923889to end the table. For example:
24933890
24943891 ------- ------ ---------- -------
@@ -2497,13 +3894,13 @@ to end the table. For example:
24973894 1 1 1 1
24983895 ------- ------ ---------- -------
24993896
2500−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
25013898of the first line of the table body. So, in the tables above, the columns
25023899would be right, left, center, and right aligned, respectively.
25033900
25043901#### Extension: `multiline_tables` ####
25053902
2506−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
25073904of text (but cells that span multiple columns or rows of the table are
25083905not supported). Here is an example:
25093906
@@ -2525,7 +3922,7 @@ not supported). Here is an example:
25253922These work like simple tables, but with the following differences:
25263923
25273924 - They must begin with a row of dashes, before the header text
2528− (unless the headers are omitted).
3925+ (unless the header row is omitted).
25293926 - They must end with a row of dashes, then a blank line.
25303927 - The rows must be separated by blank lines.
25313928
@@ -2534,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
25343931the output. So, if you find that one of the columns is too narrow in the
25353932output, try widening it in the Markdown source.
25363933
2537−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:
25383935
25393936 ----------- ------- --------------- -------------------------
25403937 First row 12.0 Example of a row that
@@ -2545,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
25453942 rows.
25463943 ----------- ------- --------------- -------------------------
25473944
2548− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
25493946
25503947It is possible for a multiline table to have just one row, but the row
25513948should be followed by a blank line (and then the row of dashes that ends
@@ -2571,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
25713968omitted for a headerless table. The cells of grid tables may contain
25723969arbitrary block elements (multiple paragraphs, code blocks, lists,
25733970etc.). Cells that span multiple columns or rows are not
2574−supported. Grid tables can be created easily using [Emacs table mode].
2575−
2576−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
25773973
25783974Alignments can be specified as with pipe tables, by putting
25793975colons at the boundaries of the separator line after the
@@ -2601,7 +3997,7 @@ and the same number of rows in each column. For example, the
26013997Docutils [sample grid tables] will not render as expected with
26023998Pandoc.
26033999
2604−[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
26054001
26064002
26074003#### Extension: `pipe_tables` ####
@@ -2634,10 +4030,15 @@ legal (though ugly) pipe table:
26344030
26354031The cells of pipe tables cannot contain block elements like paragraphs
26364032and lists, and cannot span multiple lines. If a pipe table contains a
2637−row whose printable content is wider than the column width (see
2638−`--columns`), then the cell contents will wrap, with the
2639−relative cell widths determined by the widths of the separator
2640−lines.
4033+row whose Markdown content is wider than the column width (see
4034+`--columns`), then the table will take up the full text width and
4035+the cell contents will wrap, with the relative cell widths determined
4036+by the number of dashes in the line separating the table header from
4037+the table body. (For example `---|-` would make the first column 3/4
4038+and the second column 1/4 of the full text width.)
4039+On the other hand, if no lines are wider than column width, then
4040+cell contents will not be wrapped, and the cells will be sized
4041+to their contents.
26414042
26424043Note: pandoc also recognizes pipe tables of the following
26434044form, as can be produced by Emacs' orgtbl-mode:
@@ -2653,8 +4054,7 @@ you'll need to add colons as above.
26534054
26544055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
26554056
2656−Metadata blocks
2657−---------------
4057+## Metadata blocks
26584058
26594059#### Extension: `pandoc_title_block` ####
26604060
@@ -2670,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
26704070or all three elements. If you want to include an author but no
26714071title, or a title and a date but no author, you need a blank line:
26724072
2673− %
2674− % Author
4073+```
4074+%
4075+% Author
4076+```
26754077
2676− % My title
2677− %
2678− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
26794083
26804084The title may occupy multiple lines, but continuation lines must
26814085begin with leading space, thus:
26824086
2683− % My title
2684− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
26854091
26864092If a document has multiple authors, the authors may be put on
26874093separate lines with leading space, or separated by semicolons, or
26884094both. So, all of the following are equivalent:
26894095
2690− % Author One
2691− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
26924100
2693− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
26944104
2695− % Author One;
2696− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
26974109
26984110The date must fit on one line.
26994111
@@ -2734,7 +4146,7 @@ will also have "Version 4.0" in the header.
27344146
27354147#### Extension: `yaml_metadata_block` ####
27364148
2737−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
27384150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
27394151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
27404152document, but if it is not at the beginning, it must be preceded by a blank
@@ -2745,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
27454157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
27464158
27474159Just be sure that the YAML file begins with `---` and ends with `---` or
2748−`...`.)
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.
27494163
27504164Metadata will be taken from the fields of the YAML object and added to any
27514165existing document metadata. Metadata can contain lists and objects (nested
27524166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
27534167with names ending in an underscore will be ignored by pandoc. (They may be
2754−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).
27554171
2756−A document may contain multiple metadata blocks. The metadata fields will
2757−be combined through a *left-biased union*: if two metadata blocks attempt
2758−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.
27594175
27604176When pandoc is used with `-t markdown` to create a Markdown document,
27614177a YAML metadata block will be produced only if the `-s/--standalone`
27624178option is used. All of the metadata will appear in a single block
27634179at the beginning of the document.
27644180
2765−Note that YAML escaping rules must be followed. Thus, for example,
2766−if a title contains a colon, it must be quoted. The pipe character
2767−(`|`) can be used to begin an indented block that will be interpreted
2768−literally, without need for escaping. This form is necessary
2769−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:
27704188
27714189 ---
27724190 title: 'This is the title: it contains a colon'
27734191 author:
27744192 - Author One
27754193 - Author Two
2776− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
27774195 abstract: |
27784196 This is the abstract.
27794197
27804198 It consists of two paragraphs.
27814199 ...
27824200
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+
27834207Template variables will be set automatically from the metadata. Thus, for
27844208example, in writing HTML, the variable `abstract` will be set to the HTML
27854209equivalent of the Markdown in the `abstract` field:
@@ -2813,9 +4237,38 @@ template:
28134237 $endif$
28144238 $endfor$
28154239
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+ ```
28164252
2817−Backslash escapes
2818−-----------------
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.
4262+
4263+- The leaf nodes of the YAML structure are parsed in isolation from
4264+ each other and from the rest of the document. So, for
4265+ example, you can't use a reference link in these contexts
4266+ if the link definition is somewhere else in the document.
4267+
4268+[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
4269+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
4270+
4271+## Backslash escapes
28194272
28204273#### Extension: `all_symbols_escapable` ####
28214274
@@ -2841,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
28414294(However, if the `markdown_strict` format is used, the standard Markdown rule
28424295will be used.)
28434296
2844−A backslash-escaped space is parsed as a nonbreaking space. It will
2845−appear in TeX output as `~` and in HTML and XML as `\ ` or
2846−`\ `.
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).
28474303
28484304A backslash-escaped newline (i.e. a backslash occurring at the end of
28494305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -2853,8 +4309,7 @@ two trailing spaces on a line.
28534309
28544310Backslash escapes do not work in verbatim contexts.
28554311
2856−Inline formatting
2857−-----------------
4312+## Inline formatting
28584313
28594314### Emphasis ###
28604315
@@ -2902,12 +4357,13 @@ text by `~` characters. Thus, for example,
29024357
29034358 H~2~O is a liquid. 2^10^ is 1024.
29044359
2905−If the superscripted or subscripted text contains spaces, these spaces
2906−must be escaped with backslashes. (This is to prevent accidental
2907−superscripting and subscripting through the ordinary use of `~` and `^`.)
2908−Thus, if you want the letter P with 'a cat' in subscripts, use
2909−`P~a\ cat~`, not `P~a cat~`.
2910−
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~`.
29114367
29124368### Verbatim ###
29134369
@@ -2956,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
29564412This will work in all output formats that support small caps.
29574413
29584414
2959−Math
2960−----
4415+## Math
29614416
29624417#### Extension: `tex_math_dollars` ####
29634418
@@ -2969,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
29694424you need to enclose text in literal `$` characters, backslash-escape
29704425them and they won't be treated as math delimiters.
29714426
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+
29724431TeX math will be printed in all output formats. How it is rendered
29734432depends on the output format:
29744433
2975−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2976− ~ 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}}`.
29774444
29784445reStructuredText
29794446 ~ It will be rendered using an [interpreted text role `:math:`].
29804447
29814448AsciiDoc
2982− ~ 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.
29834454
29844455Texinfo
29854456 ~ It will be rendered inside a `@math` command.
29864457
2987−groff man
4458+roff man, Jira markup
29884459 ~ It will be rendered verbatim without `$`'s.
29894460
29904461MediaWiki, DokuWiki
@@ -3018,12 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
30184489 command-line options selected. Therefore see [Math rendering in HTML]
30194490 above.
30204491
3021−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
30224493
3023−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3024−
3025−Raw HTML
3026−--------
4494+## Raw HTML
30274495
30284496#### Extension: `raw_html` ####
30294497
@@ -3034,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
30344502be disabled if desired.)
30354503
30364504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3037−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3038−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.
30394516
30404517#### Extension: `markdown_in_html_blocks` ####
30414518
@@ -3052,7 +4529,7 @@ Thus, for example, pandoc will turn
30524529 <table>
30534530 <tr>
30544531 <td>*one*</td>
3055− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
30564533 </tr>
30574534 </table>
30584535
@@ -3061,14 +4538,14 @@ into
30614538 <table>
30624539 <tr>
30634540 <td><em>one</em></td>
3064− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
30654542 </tr>
30664543 </table>
30674544
30684545whereas `Markdown.pl` will preserve it as is.
30694546
3070−There is one exception to this rule: text between `<script>` and
3071−`<style>` tags is not interpreted as Markdown.
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
30724549
30734550This departure from standard Markdown should make it easier to mix
30744551Markdown with HTML block elements. For example, one can surround
@@ -3077,56 +4554,17 @@ from being interpreted as Markdown.
30774554
30784555#### Extension: `native_divs` ####
30794556
3080−Use native pandoc `Div` blocks for content inside `<div>` tags.
3081−For the most part this should give the same output as
3082−`markdown_in_html_blocks`, but it makes it easier to write pandoc
3083−filters to manipulate groups of blocks.
3084−
3085−#### Extension: `native_spans` ####
3086−
3087−Use native pandoc `Span` blocks for content inside `<span>` tags.
3088−For the most part this should give the same output as `raw_html`,
3089−but it makes it easier to write pandoc filters to manipulate groups
3090−of inlines.
3091−
3092−#### Extension: `fenced_divs` ####
3093−
3094−Allow special fenced syntax for native `Div` blocks. A Div
3095−starts with a fence containing at least three consecutive
3096−colons plus some attributes. The attributes may optionally
3097−be followed by another string of consecutive colons.
3098−The attribute syntax is exactly as in fenced code blocks (see
3099−[Extension: `fenced_code_attributes`]). As with fenced
3100−code blocks, one can use either attributes in curly braces
3101−or a single unbraced word, which will be treated as a class
3102−name. The Div ends with another line containing a string of at
3103−least three consecutive colons. The fenced Div should be
3104−separated by blank lines from preceding and following blocks.
3105−
3106−Example:
3107−
3108− ::::: {#special .sidebar}
3109− Here is a paragraph.
3110−
3111− And another.
3112− :::::
3113−
3114−Fenced divs can be nested. Opening fences are distinguished
3115−because they *must* have attributes:
3116−
3117− ::: Warning ::::::
3118− This is a warning.
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.
31194561
3120− ::: Danger
3121− This is a warning within a warning.
3122− :::
3123− ::::::::::::::::::
4562+#### Extension: `native_spans` ####
31244563
3125−Fences without attributes are always closing fences. Unlike
3126−with fenced code blocks, the number of colons in the closing
3127−fence need not match the number in the opening fence. However,
3128−it can be helpful for visual clarity to use fences of different
3129−lengths to distinguish nested divs from their parents.
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.
31304568
31314569#### Extension: `raw_tex` ####
31324570
@@ -3149,6 +4587,10 @@ Note that in LaTeX environments, like
31494587the material between the begin and end tags will be interpreted as raw
31504588LaTeX, not as Markdown.
31514589
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+
31524594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
31534595Emacs Org mode, and ConTeXt.
31544596
@@ -3159,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
31594601Inline spans and fenced code blocks with a special
31604602kind of attribute will be parsed as raw content with the
31614603designated format. For example, the following produces a raw
3162−groff `ms` block:
4604+roff `ms` block:
31634605
31644606 ```{=ms}
31654607 .MYMACRO
@@ -3169,9 +4611,24 @@ And the following produces a raw `html` inline element:
31694611
31704612 This is `<a>html</a>`{=html}
31714613
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+
31724625The format name should match the target format name (see
31734626`-t/--to`, above, for a list, or use `pandoc
3174−--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`).
31754632
31764633This extension presupposes that the relevant kind of
31774634inline code or fenced code block is enabled. Thus, for
@@ -3180,26 +4637,34 @@ example, to use a raw attribute with a backtick code block,
31804637
31814638The raw attribute cannot be combined with regular attributes.
31824639
3183−LaTeX macros
3184−------------
4640+## LaTeX macros
31854641
31864642#### Extension: `latex_macros` ####
31874643
3188−For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
3189−`\renewcommand` definitions and apply the resulting macros to all LaTeX
3190−math. So, for example, the following will work in all output formats,
3191−not just LaTeX:
4644+When this extension is enabled, pandoc will parse LaTeX
4645+macro definitions and apply the resulting macros to all LaTeX
4646+math and raw LaTeX. So, for example, the following will work in
4647+all output formats, not just LaTeX:
31924648
31934649 \newcommand{\tuple}[1]{\langle #1 \rangle}
31944650
31954651 $\tuple{a, b, c}$
31964652
3197−In LaTeX output, the `\newcommand` definition will simply be passed
3198−unchanged to the output.
4653+Note that LaTeX macros will not be applied if they occur
4654+inside a raw span or block marked with the
4655+[`raw_attribute` extension](#extension-raw_attribute).
31994656
4657+When `latex_macros` is disabled, the raw LaTeX and math will
4658+not have macros applied. This is usually a better approach when
4659+you are targeting LaTeX or PDF.
32004660
3201−Links
3202−-----
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
32034668
32044669Markdown allows links to be specified in several ways.
32054670
@@ -3208,7 +4673,7 @@ Markdown allows links to be specified in several ways.
32084673If you enclose a URL or email address in pointy brackets, it
32094674will become a link:
32104675
3211− <http://google.com>
4676+ <https://google.com>
32124677 <sam@green.eggs.ham>
32134678
32144679### Inline links ###
@@ -3218,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
32184683be followed by a link title, in quotes.)
32194684
32204685 This is an [inline link](/url), and here's [one with
3221− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
32224687
32234688There can be no space between the bracketed part and the parenthesized part.
32244689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3247,7 +4712,7 @@ Here are some examples:
32474712
32484713 [my label 1]: /foo/bar.html "My title, optional"
32494714 [my label 2]: /foo
3250− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
32514716 [my label 4]: /bar#special 'A title in single quotes'
32524717
32534718The URL may optionally be surrounded by angle brackets:
@@ -3256,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
32564721
32574722The title may go on the next line:
32584723
3259− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
32604725 "The free software foundation"
32614726
32624727Note that link labels are not case sensitive. So, this will work:
@@ -3282,231 +4747,610 @@ not in most other implementations:
32824747 >
32834748 > [quote]: /foo
32844749
3285−#### 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.
5135+
5136+#### Extension: `angle_brackets_escapable` ####
5137+
5138+Allow `<` and `>` to be backslash-escaped, as they can be in
5139+GitHub flavored Markdown but not original Markdown. This is
5140+implied by pandoc's default `all_symbols_escapable`.
5141+
5142+#### Extension: `lists_without_preceding_blankline` ####
32865143
3287−In a *shortcut* reference link, the second pair of brackets may
3288−be omitted entirely:
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
32895146
3290− See [my website].
5147+#### Extension: `four_space_rule` ####
32915148
3292− [my website]: http://foo.bar.baz
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
32935152
3294−### Internal links ###
5153+#### Extension: `spaced_reference_links` ####
32955154
3296−To link to another section of the same document, use the automatically
3297−generated identifier (see [Header identifiers]). For example:
5155+Allow whitespace between the two components of a reference link,
5156+for example,
32985157
3299− See the [Introduction](#introduction).
5158+ [foo] [bar].
33005159
3301−or
5160+#### Extension: `hard_line_breaks` ####
33025161
3303− See the [Introduction].
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
33045164
3305− [Introduction]: #introduction
5165+#### Extension: `ignore_line_breaks` ####
33065166
3307−Internal links are currently supported for HTML formats (including
3308−HTML slide shows and EPUB), LaTeX, and ConTeXt.
5167+Causes newlines within a paragraph to be ignored, rather than being
5168+treated as spaces or as hard line breaks. This option is intended for
5169+use with East Asian languages where spaces are not used between words,
5170+but text is divided into lines for readability.
33095171
3310−Images
3311−------
5172+#### Extension: `east_asian_line_breaks` ####
33125173
3313−A link immediately preceded by a `!` will be treated as an image.
3314−The link text will be used as the image's alt text:
5174+Causes newlines within a paragraph to be ignored, rather than
5175+being treated as spaces or as hard line breaks, when they occur
5176+between two East Asian wide characters. This is a better choice
5177+than `ignore_line_breaks` for texts that include a mix of East
5178+Asian wide characters and other characters.
33155179
3316− 
5180+#### Extension: `emoji` ####
33175181
3318− ![movie reel]
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
33195183
3320− [movie reel]: movie.gif
5184+#### Extension: `tex_math_single_backslash` ####
33215185
3322−#### Extension: `implicit_figures` ####
5186+Causes anything between `\(` and `\)` to be interpreted as inline
5187+TeX math, and anything between `\[` and `\]` to be interpreted
5188+as display TeX math. Note: a drawback of this extension is that
5189+it precludes escaping `(` and `[`.
33235190
3324−An image with nonempty alt text, occurring by itself in a
3325−paragraph, will be rendered as a figure with a caption. The
3326−image's alt text will be used as the caption.
5191+#### Extension: `tex_math_double_backslash` ####
33275192
3328− 
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.
33295196
3330−How this is rendered depends on the output format. Some output
3331−formats (e.g. RTF) do not yet support figures. In those
3332−formats, you'll just get an image in a paragraph by itself, with
3333−no caption.
5197+#### Extension: `markdown_attribute` ####
33345198
3335−If you just want a regular inline image, just make sure it is not
3336−the only thing in the paragraph. One way to do this is to insert a
3337−nonbreaking space after the image:
5199+By default, pandoc interprets material inside block-level tags as Markdown.
5200+This extension changes the behavior so that Markdown is only parsed
5201+inside block-level tags if the tags have the attribute `markdown=1`.
33385202
3339− \
5203+#### Extension: `mmd_title_block` ####
33405204
3341−Note that in reveal.js slide shows, an image in a paragraph
3342−by itself that has the `stretch` class will fill the screen,
3343−and the caption and figure tags will be omitted.
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
33445207
3345−#### Extension: `link_attributes` ####
5208+ Title: My title
5209+ Author: John Doe
5210+ Date: September 1, 2008
5211+ Comment: This is a sample mmd title block, with
5212+ a field spanning multiple lines.
33465213
3347−Attributes can be set on links and images:
5214+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5215+`yaml_metadata_block` is enabled, it will take precedence over
5216+`mmd_title_block`.
33485217
3349− An inline {#id .class width=30 height=20px}
3350− and a reference ![image][ref] with attributes.
5218+#### Extension: `abbreviations` ####
33515219
3352− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5220+Parses PHP Markdown Extra abbreviation keys, like
33535221
3354−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3355−and `.class` are used.)
5222+ *[HTML]: Hypertext Markup Language
33565223
3357−For HTML and EPUB, all attributes except `width` and `height` (but
3358−including `srcset` and `sizes`) are passed through as is. The other
3359−writers ignore attributes that are not supported by their output
3360−format.
5224+Note that the pandoc document model does not support
5225+abbreviations, so if this extension is enabled, abbreviation keys are
5226+simply skipped (as opposed to being parsed as paragraphs).
33615227
3362−The `width` and `height` attributes on images are treated specially. When
3363−used without a unit, the unit is assumed to be pixels. However, any of
3364−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3365−and `%`. There must not be any spaces between the number and the unit.
3366−For example:
5228+#### Extension: `autolink_bare_uris` ####
33675229
3368−```
3369−{ width=50% }
3370−```
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
33715232
3372−- Dimensions are converted to inches for output in page-based formats like
3373− LaTeX. Dimensions are converted to pixels for output in HTML-like
3374− formats. Use the `--dpi` option to specify the number of pixels per
3375− inch. The default is 96dpi.
3376−- The `%` unit is generally relative to some available space.
3377− For example the above example will render to
3378− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3379− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3380− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3381−- Some output formats have a notion of a class
3382− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3383− or a unique identifier (LaTeX `\caption`), or both (HTML).
3384−- When no `width` or `height` attributes are specified, the fallback
3385− is to look at the image resolution and the dpi metadata embedded in
3386− the image file.
5233+#### Extension: `mmd_link_attributes` ####
33875234
3388−Spans
3389−-----
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.
33905238
3391−#### Extension: `bracketed_spans` ####
5239+ This is a reference ![image][ref] with multimarkdown attributes.
33925240
3393−A bracketed sequence of inlines, as one would use to begin
3394−a link, will be treated as a span with attributes if it is
3395−followed immediately by attributes:
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
33965243
3397− [This is *some text*]{.class key="val"}
5244+#### Extension: `mmd_header_identifiers` ####
33985245
3399−Footnotes
3400−---------
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
34015248
3402−#### Extension: `footnotes` ####
5249+#### Extension: `compact_definition_lists` ####
34035250
3404−Pandoc's Markdown allows footnotes, using the following syntax:
5251+Activates the definition list syntax of pandoc 1.12.x and earlier.
5252+This syntax differs from the one described above under [Definition lists]
5253+in several respects:
34055254
3406− Here is a footnote reference,[^1] and another.[^longnote]
5255+ - No blank line is required between consecutive items of the
5256+ definition list.
5257+ - To get a "tight" or "compact" list, omit space between consecutive
5258+ items; the space between a term and its definition does not affect
5259+ anything.
5260+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261+ be indented four spaces.[^6]
34075262
3408− [^1]: Here is the footnote.
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
34095265
3410− [^longnote]: Here's one with multiple blocks.
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
34115270
3412− Subsequent paragraphs are indented to show that they
3413− belong to the previous footnote.
5271+ Is this a single list item with two definitions of "bar," the first of
5272+ which is lazily wrapped, or two list items? To remove the ambiguity
5273+ we must either disallow lazy wrapping or require a blank line between
5274+ list items.
34145275
3415− { some.code }
5276+#### Extension: `gutenberg` ####
34165277
3417− The whole paragraph can be indented, or just the first
3418− line. In this way, multi-paragraph footnotes work like
3419− multi-paragraph list items.
5278+Use [Project Gutenberg] conventions for `plain` output:
5279+all-caps for strong emphasis, surround by underscores
5280+for regular emphasis, add extra blank space around headings.
34205281
3421− This paragraph won't be part of the note, because it
3422− isn't indented.
5282+ [Project Gutenberg]: https://www.gutenberg.org
34235283
3424−The identifiers in footnote references may not contain spaces, tabs,
3425−or newlines. These identifiers are used only to correlate the
3426−footnote reference with the note itself; in the output, footnotes
3427−will be numbered sequentially.
5284+#### Extension: `sourcepos` ####
34285285
3429−The footnotes themselves need not be placed at the end of the
3430−document. They may appear anywhere except inside other block elements
3431−(lists, block quotes, tables, etc.). Each footnote should be
3432−separated from surrounding content (including other footnotes)
3433−by blank lines.
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
34345290
3435−#### Extension: `inline_notes` ####
5291+## Markdown variants
34365292
3437−Inline footnotes are also allowed (though, unlike regular notes,
3438−they cannot contain multiple paragraphs). The syntax is as follows:
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
34395295
3440− Here is an inline note.^[Inlines notes are easier to write, since
3441− you don't have to pick an identifier and move down to type the
3442− note.]
5296+- `markdown_phpextra` (PHP Markdown Extra)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
34435303
3444−Inline and regular footnotes may be mixed freely.
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
34455306
3446−Typography
3447−----------
5307+ pandoc --list-extensions=FORMAT
34485308
3449−#### Extension: `smart` ####
5309+where `FORMAT` is replaced with the name of the format.
34505310
3451−Interpret straight quotes as curly quotes, `---` as em-dashes,
3452−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3453−inserted after certain abbreviations, such as "Mr." This
3454−option currently affects the input formats `markdown`,
3455−`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3456−and the output formats `markdown`, `latex`, and `context`.
5311+Note that the list of extensions for `commonmark`,
5312+`gfm`, and `commonmark_x` are defined relative to default
5313+commonmark. So, for example, `backtick_code_blocks`
5314+does not appear as an extension, since it is enabled by
5315+default and cannot be disabled.
34575316
3458−Note: If you are *writing* Markdown, then the `smart` extension
3459−has the reverse effect: what would have been curly quotes comes
3460−out straight.
5317+# Citations
34615318
3462−In LaTeX, `smart` means to use the standard TeX ligatures
3463−for quotation marks (` `` ` and ` '' ` for double quotes,
3464−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3465−en-dash and `---` for em-dash). If `smart` is disabled,
3466−then in reading LaTeX pandoc will parse these characters
3467−literally. In writing LaTeX, enabling `smart` tells pandoc
3468−to use the ligatures when possible; if `smart` is disabled
3469−pandoc will use unicode quotation mark and dash characters.
5319+When the `--citeproc` option is used, pandoc can automatically generate
5320+citations and a bibliography in a number of styles. Basic usage is
34705321
3471−Citations
3472−---------
5322+ pandoc --citeproc myinput.txt
34735323
3474−#### Extension: `citations` ####
5324+To use this feature, you will need to have
34755325
3476−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3477−citations and a bibliography in a number of styles. Basic usage is
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
34785330
3479− pandoc --filter pandoc-citeproc myinput.txt
5331+## Specifying bibliographic data
34805332
3481−In order to use this feature, you will need to specify a bibliography file
3482−using the `bibliography` metadata field in a YAML metadata section, or
3483−`--bibliography` command line argument. You can supply multiple `--bibliography`
3484−arguments or set `bibliography` metadata field to YAML array, if you want to
3485−use multiple bibliography files. The bibliography may have any of these
3486−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:
34875339
34885340 Format File extension
34895341 ------------ --------------
34905342 BibLaTeX .bib
34915343 BibTeX .bibtex
3492− Copac .copac
34935344 CSL JSON .json
34945345 CSL YAML .yaml
3495− EndNote .enl
3496− EndNote XML .xml
3497− ISI .wos
3498− MEDLINE .medline
3499− MODS .mods
3500− RIS .ris
35015346
35025347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3503−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
35045349
3505−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3506−can produce `.json` and `.yaml` files from any of the supported formats.
3507−
3508−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3509−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]:
35105354
35115355`<i>...</i>`
35125356: italics
@@ -3526,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
35265370`<span class="nocase">...</span>`
35275371: prevent a phrase from being capitalized as title case
35285372
3529−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3530−and CSL YAML formats as far as possible.
3531−
3532−As an alternative to specifying a bibliography file using `--bibliography`
3533−or the YAML metadata field `bibliography`, you can include
3534−the citation data directly in the `references` field of the
3535−document's YAML metadata. The field should contain an array of
3536−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:
35375378
35385379 ---
35395380 references:
@@ -3549,349 +5390,273 @@ YAML-encoded references, for example:
35495390 - - 1953
35505391 - 4
35515392 - 25
3552− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3553− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
35545395 title-short: Molecular structure of nucleic acids
35555396 container-title: Nature
35565397 volume: 171
35575398 issue: 4356
35585399 page: 737-738
35595400 DOI: 10.1038/171737a0
3560− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
35615402 language: en-GB
35625403 ...
35635404
3564−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3565−of the supported formats.)
3566−
3567−Citations and references can be formatted using any style supported by the
3568−[Citation Style Language], listed in the [Zotero Style Repository].
3569−These files are specified using the `--csl` option or the `csl` metadata field.
3570−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3571−format. The CSL project provides further information on [finding and editing styles].
3572−
3573−To make your citations hyperlinks to the corresponding bibliography
3574−entries, add `link-citations: true` to your YAML metadata.
3575−
3576−Citations go inside square brackets and are separated by semicolons.
3577−Each citation must have a key, composed of '@' + the citation
3578−identifier from the database, and may optionally have a prefix,
3579−a locator, and a suffix. The citation key must begin with a letter, digit,
3580−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3581−characters (`:.#$%&-+?<>~/`). Here are some examples:
3582−
3583− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3584−
3585− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3586−
3587− Blah blah [@smith04; @doe99].
3588−
3589−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3590−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3591−locale, locator terms can be written in either singular or plural forms,
3592−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3593−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3594−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3595−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3596−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3597−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3598−locator term is used, "page" is assumed.
3599−
3600−A minus sign (`-`) before the `@` will suppress mention of
3601−the author in the citation. This can be useful when the
3602−author is already mentioned in the text:
3603−
3604− Smith says blah [-@smith04].
3605−
3606−You can also write an in-text citation, as follows:
3607−
3608− @smith04 says blah.
3609−
3610− @smith04 [p. 33] says blah.
3611−
3612−If the style calls for a list of works cited, it will be placed
3613−at the end of the document. Normally, you will want to end your
3614−document with an appropriate header:
3615−
3616− last paragraph...
3617−
3618− # References
3619−
3620−The bibliography will be inserted after this header. Note that
3621−the `unnumbered` class will be added to this header, so that the
3622−section will not be numbered.
3623−
3624−If you want to include items in the bibliography without actually
3625−citing them in the body text, you can define a dummy `nocite` metadata
3626−field and put the citations there:
3627−
3628− ---
3629− nocite: |
3630− @item1, @item2
3631− ...
3632−
3633− @item3
3634−
3635−In this example, the document will contain a citation for `item3`
3636−only, but the bibliography will contain entries for `item1`, `item2`, and
3637−`item3`.
3638−
3639−It is possible to create a bibliography with all the citations,
3640−whether or not they appear in the document, by using a wildcard:
3641−
3642− ---
3643− nocite: |
3644− @*
3645− ...
3646−
3647−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3648−to render bibliography. In order to do so, specify bibliography files as
3649−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3650−invocation. Bear in mind that bibliography files have to be in respective
3651−format (either BibTeX or BibLaTeX).
5405+If both an external bibliography and inline (YAML metadata)
5406+references are provided, both will be used. In case of
5407+conflicting `id`s, the inline references will take precedence.
36525408
3653−For more information, see the [pandoc-citeproc man page].
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
36545411
3655−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3656−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3657−[Citation Style Language]: http://citationstyles.org
3658−[Zotero Style Repository]: https://www.zotero.org/styles
3659−[finding and editing styles]: http://citationstyles.org/styles/
3660−[CSL locale files]: https://github.com/citation-style-language/locales
3661−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
36625414
3663−Non-pandoc extensions
3664−---------------------
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
36655417
3666−The following Markdown syntax extensions are not enabled by default
3667−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3668−name, where `EXTENSION` is the name of the extension. Thus, for
3669−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
36705420
3671−#### Extension: `old_dashes` ####
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
36725424
3673−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3674−`-` before a numeral is an en-dash, and `--` is an em-dash.
3675−This option only has an effect if `smart` is enabled. It is
3676−selected automatically for `textile` input.
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
36775427
3678−#### Extension: `angle_brackets_escapable` ####
5428+### Capitalization in titles
36795429
3680−Allow `<` and `>` to be backslash-escaped, as they can be in
3681−GitHub flavored Markdown but not original Markdown. This is
3682−implied by pandoc's default `all_symbols_escapable`.
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
36835432
3684−#### Extension: `lists_without_preceding_blankline` ####
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`.)
36855438
3686−Allow a list to occur right after a paragraph, with no intervening
3687−blank space.
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:
36885442
3689−#### Extension: `four_space_rule` ####
5443+ title = {My Dinner with {Andre}}
36905444
3691−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3692−four spaces indent are needed for list item continuation
3693−paragraphs.
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
36945447
3695−#### Extension: `spaced_reference_links` ####
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
36965449
3697−Allow whitespace between the two components of a reference link,
3698−for example,
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.
36995454
3700− [foo] [bar].
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
37015457
3702−#### Extension: `hard_line_breaks` ####
5458+ - All titles should be in sentence case.
37035459
3704−Causes all newlines within a paragraph to be interpreted as hard line
3705−breaks instead of spaces.
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.)
37065463
3707−#### Extension: `ignore_line_breaks` ####
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
37085466
3709−Causes newlines within a paragraph to be ignored, rather than being
3710−treated as spaces or as hard line breaks. This option is intended for
3711−use with East Asian languages where spaces are not used between words,
3712−but text is divided into lines for readability.
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
37135468
3714−#### Extension: `east_asian_line_breaks` ####
5469+### Conference Papers, Published vs. Unpublished
37155470
3716−Causes newlines within a paragraph to be ignored, rather than
3717−being treated as spaces or as hard line breaks, when they occur
3718−between two East Asian wide characters. This is a better choice
3719−than `ignore_line_breaks` for texts that include a mix of East
3720−Asian wide characters and other characters.
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
37215473
3722−#### Extension: `emoji` ####
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`).
37235477
3724−Parses textual emojis like `:smile:` as Unicode emoticons.
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.
37255487
3726−#### Extension: `tex_math_single_backslash` ####
37275488
3728−Causes anything between `\(` and `\)` to be interpreted as inline
3729−TeX math, and anything between `\[` and `\]` to be interpreted
3730−as display TeX math. Note: a drawback of this extension is that
3731−it precludes escaping `(` and `[`.
5489+## Specifying a citation style
37325490
3733−This extension can be used with both `markdown` and `html` input.
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:
37345507
3735−#### Extension: `tex_math_double_backslash` ####
37365508
3737−Causes anything between `\\(` and `\\)` to be interpreted as inline
3738−TeX math, and anything between `\\[` and `\\]` to be interpreted
3739−as display TeX math.
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+ }
37405517
3741−#### Extension: `markdown_attribute` ####
37425518
3743−By default, pandoc interprets material inside block-level tags as Markdown.
3744−This extension changes the behavior so that Markdown is only parsed
3745−inside block-level tags if the tags have the attribute `markdown=1`.
5519+## Citations in note styles
37465520
3747−#### Extension: `mmd_title_block` ####
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
5526+example,
37485527
3749−Enables a [MultiMarkdown] style title block at the top of
3750−the document, for example:
5528+ Blah blah [@foo, p. 33].
37515529
3752− Title: My title
3753− Author: John Doe
3754− Date: September 1, 2008
3755− Comment: This is a sample mmd title block, with
3756− a field spanning multiple lines.
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].
37575535
3758−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3759−`yaml_metadata_block` is enabled, it will take precedence over
3760−`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:
37615541
3762−#### Extension: `abbreviations` ####
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].
37635545
3764−Parses PHP Markdown Extra abbreviation keys, like
5546+## Raw content in a style
37655547
3766− *[HTML]: Hypertext Markup Language
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
37675550
3768−Note that the pandoc document model does not support
3769−abbreviations, so if this extension is enabled, abbreviation keys are
3770−simply skipped (as opposed to being parsed as paragraphs).
5551+ {{jats}}<ref>{{/jats}}
37715552
3772−#### Extension: `autolink_bare_uris` ####
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
37735555
3774−Makes all absolute URIs into links, even when not surrounded by
3775−pointy braces `<...>`.
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.
37765560
3777−#### Extension: `ascii_identifiers` ####
37785561
3779−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3780−Accents are stripped off of accented Latin letters, and non-Latin
3781−letters are omitted.
37825562
3783−#### Extension: `mmd_link_attributes` ####
5563+## Placement of the bibliography
37845564
3785−Parses multimarkdown style key-value attributes on link
3786−and image references. This extension should not be confused with the
3787−[`link_attributes`](#extension-link_attributes) extension.
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:
37885567
3789− This is a reference ![image][ref] with multimarkdown attributes.
5568+ ::: {#refs}
5569+ :::
37905570
3791− [ref]: http://path.to/image "Image title" width=20px height=30px
3792− id=myId class="myClass1 myClass2"
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.
37935574
3794−#### Extension: `mmd_header_identifiers` ####
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:
37955579
3796−Parses multimarkdown style header identifiers (in square brackets,
3797−after the header but before any trailing `#`s in an ATX header).
5580+ last paragraph...
37985581
3799−#### Extension: `compact_definition_lists` ####
5582+ # References
38005583
3801−Activates the definition list syntax of pandoc 1.12.x and earlier.
3802−This syntax differs from the one described above under [Definition lists]
3803−in several respects:
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.
38045587
3805− - No blank line is required between consecutive items of the
3806− definition list.
3807− - To get a "tight" or "compact" list, omit space between consecutive
3808− items; the space between a term and its definition does not affect
3809− anything.
3810− - Lazy wrapping of paragraphs is not allowed: the entire definition must
3811− be indented four spaces.[^6]
5588+## Including uncited items in the bibliography
38125589
3813−[^6]: To see why laziness is incompatible with relaxing the requirement
3814− of a blank line between items, consider the following example:
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:
38155593
3816− bar
3817− : definition
3818− foo
3819− : definition
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
38205598
3821− Is this a single list item with two definitions of "bar," the first of
3822− which is lazily wrapped, or two list items? To remove the ambiguity
3823− we must either disallow lazy wrapping or require a blank line between
3824− list items.
5599+ @item3
38255600
3826−#### Extension: `empty_paragraphs` ####
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`.
38275604
3828−Allows empty paragraphs. By default empty paragraphs are
3829−omitted. This affects the `docx` reader and writer, the
3830−`opendocument` and `odt` writer, and all HTML-based readers and writers.
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:
5607+
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
38315612
3832−Markdown variants
3833−-----------------
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.
38345619
3835−In addition to pandoc's extended Markdown, the following Markdown
3836−variants are supported:
5620+## Other relevant metadata fields
38375621
3838−`markdown_phpextra` (PHP Markdown Extra)
3839−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3840− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3841− `header_attributes`, `link_attributes`, `abbreviations`,
3842− `shortcut_reference_links`, `spaced_reference_links`.
3843−
3844−`markdown_github` (deprecated GitHub-Flavored Markdown)
3845−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
3846− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3847− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
3848− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
3849− `lists_without_preceding_blankline`.
3850−
3851−`markdown_mmd` (MultiMarkdown)
3852−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3853− `tex_math_double_backslash`, `intraword_underscores`,
3854− `mmd_title_block`, `footnotes`, `definition_lists`,
3855− `all_symbols_escapable`, `implicit_header_references`,
3856− `auto_identifiers`, `mmd_header_identifiers`,
3857− `shortcut_reference_links`, `implicit_figures`,
3858− `superscript`, `subscript`, `backtick_code_blocks`,
3859− `spaced_reference_links`, `raw_attribute`.
3860−
3861−`markdown_strict` (Markdown.pl)
3862−: `raw_html`, `shortcut_reference_links`,
3863− `spaced_reference_links`.
3864−
3865−We also support `gfm` (GitHub-Flavored Markdown) as a set of
3866−extensions on `commonmark`:
3867−
3868−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3869− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3870− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3871− `shortcut_reference_links`, `angle_brackets_escapable`.
3872−
3873− These can all be individually disabled. Note, however, that
3874− `commonmark` and `gfm` have limited support for extensions:
3875− extensions other than those listed above (and `smart` and
3876− `raw_tex`) will have no effect on `commonmark` or `gfm`.
3877− And `raw_tex` only affects `gfm` output, not input.
3878−
3879−Extensions with formats other than Markdown
3880−-------------------------------------------
3881−
3882−Some of the extensions discussed above can be used with formats
3883−other than Markdown:
3884−
3885−* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3886− and `textile` input (and is used by default).
3887−
3888−* `tex_math_dollars`, `tex_math_single_backslash`, and
3889− `tex_math_double_backslash` can be used with `html` input.
3890− (This is handy for reading web pages formatted using MathJax,
3891− for example.)
3892−
3893−Producing slide shows with pandoc
3894−=================================
5622+A few other metadata fields affect bibliography formatting:
5623+
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
5628+
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
38955660
38965661You can use pandoc to produce an HTML + JavaScript slide presentation
38975662that can be viewed via a web browser. There are five ways to do this,
@@ -3939,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
39395704
39405705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
39415706
3942−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3943−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3944−assumed to be available at the relative path `s5/default` (for S5), `slideous`
3945−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3946−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3947−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3948−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3949−the file by default.
3950−
3951−With all HTML slide formats, the `--self-contained` option can be used to
3952−produce a single file that contains all of the data necessary to display the
3953−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.
39545722
39555723To produce a PDF slide show using beamer, type
39565724
@@ -3963,14 +5731,13 @@ To produce a Powerpoint slide show, type
39635731
39645732 pandoc habits.txt -o habits.pptx
39655733
3966−Structuring the slide show
3967−--------------------------
5734+## Structuring the slide show
39685735
3969−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
39705737the hierarchy that is followed immediately by content, and not another
3971−header, somewhere in the document. In the example above, level 1 headers
3972−are always followed by level 2 headers, which are followed by content,
3973−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
39745741the `--slide-level` option.
39755742
39765743The document is carved up into slides according to the following
@@ -3978,17 +5745,21 @@ rules:
39785745
39795746 * A horizontal rule always starts a new slide.
39805747
3981− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
39825749
3983− * Headers *below* the slide level in the hierarchy create
3984− 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.)
39855756
3986− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
39875758 "title slides," which just contain the section title
39885759 and help to break the slide show into sections.
3989−
3990− * Content *above* the slide level will not appear in the slide
3991− 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).
39925763
39935764 * A title page is constructed automatically from the document's title
39945765 block, if present. (In the case of beamer, this can be disabled
@@ -3996,32 +5767,57 @@ rules:
39965767
39975768These rules are designed to support many different styles of slide show. If
39985769you don't care about structuring your slides into sections and subsections,
3999−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
40005771will be the slide level.) But you can also structure the slide show into
40015772sections, as in the example above.
40025773
40035774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4004−layout will be produced, with level 1 headers building horizontally
4005−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
40065777you use deeper nesting of section levels with reveal.js.
40075778
4008−Incremental lists
4009−-----------------
5779+## Incremental lists
40105780
40115781By default, these writers produce lists that display "all at once."
40125782If you want your lists to display incrementally (one item at a time),
40135783use the `-i` option. If you want a particular list to depart from the
4014−default (that is, to display incrementally without the `-i` option and
4015−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):
40165810
40175811 > - Eat spaghetti
40185812 > - Drink wine
40195813
4020−In this way incremental and nonincremental lists can be mixed in
4021−a single document.
5814+Both methods allow incremental and nonincremental lists to be mixed
5815+in a single document.
40225816
4023−Inserting pauses
4024−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
40255821
40265822You can add "pauses" within a slide by including a paragraph containing
40275823three dots, separated by spaces:
@@ -4034,8 +5830,9 @@ three dots, separated by spaces:
40345830
40355831 content after the pause
40365832
4037−Styling the slides
4038−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
40395836
40405837You can change the style of HTML slides by putting customized CSS files
40415838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4060,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
40605857
40615858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
40625859
4063−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
40645861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4065−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
40665863that affects slides is the `allowframebreaks` class, which sets the
40675864`allowframebreaks` option, causing multiple slides to be created
40685865if the content overfills the frame. This is recommended especially for
@@ -4070,11 +5867,10 @@ bibliographies:
40705867
40715868 # References {.allowframebreaks}
40725869
4073−Speaker notes
4074−-------------
5870+## Speaker notes
40755871
4076−reveal.js has good support for speaker notes. You can add notes to your
4077−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:
40785874
40795875 ::: notes
40805876
@@ -4085,12 +5881,14 @@ Markdown document thus:
40855881
40865882 :::
40875883
4088−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+
40895888Notes are not yet supported for other slide formats, but the notes
40905889will not appear on the slides themselves.
40915890
4092−Columns
4093−-------
5891+## Columns
40945892
40955893To put material in side by side columns, you can use a native
40965894div container with class `columns`, containing two or more div
@@ -4105,12 +5903,46 @@ containers with class `column` and a `width` attribute:
41055903 :::
41065904 ::::::::::::::
41075905
4108−Frame attributes in beamer
4109−--------------------------
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
41105942
41115943Sometimes it is necessary to add the LaTeX `[fragile]` option to
41125944a frame in beamer (for example, when using the `minted` environment).
4113−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
41145946introducing the slide:
41155947
41165948 # Fragile slide {.fragile}
@@ -4118,13 +5950,64 @@ introducing the slide:
41185950All of the other frame attributes described in Section 8.1 of
41195951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
41205952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4121−`shrink`.
5953+`shrink`, `standout`, `noframenumbering`.
5954+
5955+## Background in reveal.js and beamer
5956+
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
5959+
5960+For the same image on every slide, use the configuration
5961+option `background-image` either in the YAML metadata block
5962+or as a command-line variable. (There are no other options in
5963+beamer and the rest of this section concerns reveal.js slideshows.)
5964+
5965+For reveal.js, you can instead use the reveal.js-native option
5966+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967+and `parallaxBackgroundVertical` the same way and must also set
5968+`parallaxBackgroundSize` to have your values take effect.
5969+
5970+To set an image for a particular reveal.js slide, add
5971+`{data-background-image="/path/to/image"}`
5972+to the first slide-level heading on the slide (which may even be empty).
41225973
4123−Creating EPUBs with pandoc
4124−==========================
5974+In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975+only on the first slide.
41255976
4126−EPUB Metadata
4127−-------------
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
41286011
41296012EPUB metadata may be specified using the `--epub-metadata` option, but
41306013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4202,11 +6085,20 @@ The following fields are recognized:
42026085
42036086`rights`
42046087 ~ 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.
42056097
42066098`cover-image`
42076099 ~ A string value (path to cover image).
42086100
4209−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
42106102 ~ A string value (path to CSS stylesheet).
42116103
42126104`page-progression-direction`
@@ -4223,83 +6115,200 @@ The following fields are recognized:
42236115 - `binding`: `true`|`false` (default `true`)
42246116 - `scroll-axis`: `vertical`|`horizontal`|`default`
42256117
4226−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
42276119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
42286120
4229−Linked media
4230−------------
4231−
4232−By default, pandoc will download linked media (including audio and
4233−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
42346170self-contained EPUB. If you want to link to external media resources
42356171instead, use raw HTML in your source and add `data-external="1"` to the tag
42366172with the `src` attribute. For example:
42376173
42386174 <audio controls="1">
4239− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
42406176 data-external="1" type="audio/mpeg">
42416177 </source>
42426178 </audio>
42436179
4244−Literate Haskell support
4245−========================
4246−
4247−If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4248−format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4249−`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4250−literate Haskell source. This means that
4251−
4252− - In Markdown input, "bird track" sections will be parsed as Haskell
4253− code rather than block quotations. Text between `\begin{code}`
4254− and `\end{code}` will also be treated as Haskell code. For
4255− ATX-style headers the character '=' will be used instead of '#'.
4256−
4257− - In Markdown output, code blocks with classes `haskell` and `literate`
4258− will be rendered using bird tracks, and block quotations will be
4259− indented one space, so they will not be treated as Haskell code.
4260− In addition, headers will be rendered setext-style (with underlines)
4261− rather than ATX-style (with '#' characters). (This is because ghc
4262− treats '#' characters in column 1 as introducing line numbers.)
4263−
4264− - In restructured text input, "bird track" sections will be parsed
4265− as Haskell code.
4266−
4267− - In restructured text output, code blocks with class `haskell` will
4268− 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+```
42696219
4270− - In LaTeX input, text in `code` environments will be parsed as
4271− Haskell code.
6220+## Pyout
42726221
4273− - In LaTeX output, code blocks with class `haskell` will be rendered
4274− 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+```
42756231
4276− - In HTML output, code blocks with class `haskell` will be rendered
4277− with class `literatehaskell` and bird tracks.
6232+## Image
42786233
4279−Examples:
6234+This image  will be
6235+included as a cell attachment.
6236+````
42806237
4281− 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:
42826243
4283−reads literate Haskell source formatted with Markdown conventions and writes
4284−ordinary HTML (without bird tracks).
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
42856247
4286− pandoc -f markdown+lhs -t html+lhs
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
42876251
4288−writes HTML with the Haskell code in bird tracks, so it can be copied
4289−and pasted as literate Haskell source.
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
42906256
4291−Note that GHC expects the bird tracks in the first column, so indentend literate
4292−code blocks (e.g. inside an itemized environment) will not be picked up by the
4293−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+```
42946274
4295−Syntax highlighting
4296−===================
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
42976306
42986307Pandoc will automatically highlight syntax in [fenced code blocks] that
42996308are marked with a language name. The Haskell library [skylighting] is
4300−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4301−To see a list of language names that pandoc will recognize, type
4302−`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`.
43036312
43046313The color scheme can be selected using the `--highlight-style` option.
43056314The default color scheme is `pygments`, which imitates the default color
@@ -4307,15 +6316,36 @@ scheme used by the Python library pygments (though pygments is not actually
43076316used to do the highlighting). To see a list of highlight styles,
43086317type `pandoc --list-highlight-styles`.
43096318
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+
43106337To disable highlighting, use the `--no-highlight` option.
43116338
43126339[skylighting]: https://github.com/jgm/skylighting
43136340
4314−Custom Styles in Docx Output
4315−============================
6341+# Custom Styles
43166342
4317−By default, pandoc's docx output applies a predefined set of styles for
4318−blocks such as paragraphs and block quotes, and uses largely default
6343+Custom styles can be used in the docx and ICML formats.
6344+
6345+## Output
6346+
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
43196349formatting (italics, bold) for inlines. This will work for most
43206350purposes, especially alongside a `reference.docx` file. However, if you
43216351need to apply your own styles to blocks, or match a preexisting set of
@@ -4323,26 +6353,28 @@ styles, pandoc allows you to define custom styles for blocks and text
43236353using `div`s and `span`s, respectively.
43246354
43256355If you define a `div` or `span` with the attribute `custom-style`,
4326−pandoc will apply your specified style to the contained elements. So,
4327−for example,
6356+pandoc will apply your specified style to the contained elements (with
6357+the exception of elements whose function depends on a style, like
6358+headings, code blocks, block quotes, or links). So, for example, using
6359+the `bracketed_spans` syntax,
43286360
4329− <span custom-style="Emphatically">Get out,</span> he said.
6361+ [Get out]{custom-style="Emphatically"}, he said.
43306362
4331−would produce a docx file with "Get out," styled with character
4332−style `Emphatically`. Similarly,
6363+would produce a docx file with "Get out" styled with character
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
43336365
43346366 Dickinson starts the poem simply:
43356367
4336− <div custom-style="Poetry">
6368+ ::: {custom-style="Poetry"}
43376369 | A Bird came down the Walk---
43386370 | He did not know I saw---
4339− </div>
6371+ :::
43406372
43416373would style the two contained lines with the `Poetry` paragraph style.
43426374
4343−If the styles are not yet in your reference.docx, they will be defined
4344−in the output file as inheriting from normal text. If they are already
4345−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.
43466378
43476379This feature allows for greatest customization in conjunction with
43486380[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -4352,34 +6384,137 @@ want all italics to be transformed to the `Emphasis` character style
43526384transform all italicized inlines to inlines within an `Emphasis`
43536385custom-style `span`.
43546386
4355−[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.
43566403
4357−Custom writers
4358−==============
6404+For example, using the `custom-style-reference.docx` file in the test
6405+directory, we have the following different outputs:
43596406
4360−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4361−includes a lua interpreter, so lua need not be installed separately.)
6407+Without the `+styles` extension:
43626408
4363−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
43646445in place of the output format. For example:
43656446
43666447 pandoc -t data/sample.lua
43676448
4368−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
43696450possible element in a pandoc document. To get a documented example
43706451which you can modify according to your needs, do
43716452
43726453 pandoc --print-default-data-file sample.lua
43736454
4374−[lua]: http://www.lua.org
4375−
4376−Authors
4377−=======
4378−
4379−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
43806514under the [GPL], version 2 or greater. This software carries no
43816515warranty of any kind. (See COPYRIGHT for full copyright and
43826516warranty notices.) For a full list of contributors, see the file
43836517AUTHORS.md in the pandoc source code.
43846518
4385−[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"