@@ -1,49 +1,31 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% March 17, 2018
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
1414another, and a command-line tool that uses this library.
1515
16−Pandoc can read [Markdown], [CommonMark], [PHP Markdown Extra],
17−[GitHub-Flavored Markdown], [MultiMarkdown], and (subsets of) [Textile],
18−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
19−markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],
20−[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],
21−[EPUB], [ODT], and [Word docx].
22−
23−Pandoc can write plain text, [Markdown],
24−[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
25−[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]
26−\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
27−[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
28−[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock
29−markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
30−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
31−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
32−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
33−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,
34−`wkhtmltopdf`, `prince`, or `weasyprint` is installed.
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.
3521
3622Pandoc's enhanced version of Markdown includes syntax for [tables],
37−[definition lists], [metadata blocks], [`Div` blocks][Extension:
38−`fenced_divs`], [footnotes] and [citations], embedded
39−[LaTeX][Extension: `raw_tex`] (including [math]), [Markdown inside HTML
40−block elements][Extension: `markdown_in_html_blocks`], and much more.
41−These enhancements, described further under [Pandoc's Markdown],
42−can be disabled using the `markdown_strict` format.
23+[definition lists], [metadata blocks], [footnotes], [citations], [math],
24+and much more. See below under [Pandoc's Markdown].
4325
4426Pandoc has a modular design: it consists of a set of readers, which parse
4527text in a given format and produce a native representation of the document
46−(like an _abstract syntax tree_ or AST), and a set of writers, which convert
28+(an _abstract syntax tree_ or AST), and a set of writers, which convert
4729this native representation into a target format. Thus, adding an input
4830or output format requires only adding a reader or writer. Users can also
4931run custom [pandoc filters] to modify the intermediate AST.
@@ -58,58 +40,7 @@ model. While conversions from pandoc's Markdown to all formats aspire
5840to be perfect, conversions from formats more expressive than pandoc's
5941Markdown can be expected to be lossy.
6042
61−[Markdown]: http://daringfireball.net/projects/markdown/
62−[CommonMark]: http://commonmark.org
63−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
64−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
65−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
66−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
67−[S5]: http://meyerweb.com/eric/tools/s5/
68−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
69−[Slideous]: http://goessner.net/articles/slideous/
70−[HTML]: http://www.w3.org/html/
71−[HTML5]: http://www.w3.org/TR/html5/
72−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
73−[XHTML]: http://www.w3.org/TR/xhtml1/
74−[LaTeX]: http://latex-project.org
75−[`beamer`]: https://ctan.org/pkg/beamer
76−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
77−[ConTeXt]: http://www.contextgarden.net/
78−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
79−[DocBook]: http://docbook.org
80−[JATS]: https://jats.nlm.nih.gov
81−[txt2tags]: http://txt2tags.org
82−[EPUB]: http://idpf.org/epub
83−[OPML]: http://dev.opml.org/spec2.html
84−[OpenDocument]: http://opendocument.xml.org
85−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
86−[Textile]: http://redcloth.org/textile
87−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
88−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
89−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
90−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
91−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
92−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
93−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
94−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
95−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
96−[Haskell]: https://www.haskell.org
97−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
98−[Emacs Org mode]: http://orgmode.org
99−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
100−[DZSlides]: http://paulrouget.com/dzslides/
101−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
102−[PDF]: https://www.adobe.com/pdf/
103−[reveal.js]: http://lab.hakim.se/reveal-js/
104−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
105−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
106−[TEI Simple]: https://github.com/TEIC/TEI-Simple
107−[Muse]: https://amusewiki.org/library/manual
108−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
109−[Vimwiki]: https://vimwiki.github.io
110−
111−Using `pandoc`
112−--------------
43+## Using pandoc
11344
11445If no *input-files* are specified, input is read from *stdin*.
11546Output goes to *stdout* by default. For output to a file,
@@ -130,8 +61,7 @@ If multiple input files are given, `pandoc` will concatenate them all (with
13061blank lines between them) before parsing. (Use `--file-scope` to parse files
13162individually.)
13263
133−Specifying formats
134−------------------
64+## Specifying formats
13565
13666The format of the input and output can be specified explicitly using
13767command-line options. The input format can be specified using the
@@ -163,8 +93,7 @@ If no input file is specified (so that input comes from *stdin*), or
16393if the input files' extensions are unknown, the input format will
16494be assumed to be Markdown.
16595
166−Character encoding
167−------------------
96+## Character encoding
16897
16998Pandoc uses the UTF-8 character encoding for both input and output.
17099If your local character encoding is not UTF-8, you
@@ -177,10 +106,9 @@ RTF, OPML, DocBook, and Texinfo), information about
177106the character encoding is included in the document header, which
178107will only be included if you use the `-s/--standalone` option.
179108
180−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
181110
182−Creating a PDF
183−--------------
111+## Creating a PDF
184112
185113To produce a PDF, specify an output file with a `.pdf` extension:
186114
@@ -188,20 +116,18 @@ To produce a PDF, specify an output file with a `.pdf` extension:
188116
189117By default, pandoc will use LaTeX to create the PDF, which requires
190118that a LaTeX engine be installed (see `--pdf-engine` below).
191−
192−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
193−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
194−[`weasyprint`] or [`prince`].
195−To do this, specify an output file with a `.pdf` extension, as before,
196−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
197−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
198−
199−PDF output can be controlled using [variables for LaTeX] (if
200−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
201−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
202−If `wkhtmltopdf` is used, then the variables `margin-left`,
203−`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
204−`header-html` and `papersize` will affect the output.
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`.
205131
206132To debug the PDF creation, it can be useful to look at the intermediate
207133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -210,93 +136,137 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
210136When using LaTeX, the following packages need to be available
211137(they are included with all recent versions of [TeX Live]):
212138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
213−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
214140`--listings` option is used), [`fancyvrb`], [`longtable`],
215−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
216−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),
141+[`booktabs`], [`graphicx`] (if the document
142+contains images), [`hyperref`], [`xcolor`],
217143[`ulem`], [`geometry`] (with the `geometry` variable set),
218144[`setspace`] (with `linestretch`), and
219145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
220−the LaTeX engine requires [`fontspec`]. `xelatex` uses
221−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
222−`dir` variable set). If the `mathspec` variable is set,
223−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
224−The [`upquote`] and [`microtype`] packages are used if
225−available, and [`csquotes`] will be used for [typography]
226−if added to the template or included in any header file. The
227−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
228−optionally be used for [citation rendering].
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+
263205
264−Reading from the Web
265−--------------------
206+## Reading from the Web
266207
267−Instead of an input file, an absolute URI may be given. In this case
208+Instead of an input file, an absolute URI may be given. In this case
268209pandoc will fetch the content using HTTP:
269210
270− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
271212
272213It is possible to supply a custom User-Agent string or other
273214header when requesting a document from a URL:
274215
275216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
276− http://www.fsf.org
217+ https://www.fsf.org
277218
278−Options
279−=======
219+# Options
280220
281−General options
282−---------------
221+## General options {.options}
283222
284223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
285224
286−: Specify input format. *FORMAT* can be `native` (native Haskell),
287− `json` (JSON version of native AST), `markdown` (pandoc's
288− extended Markdown), `markdown_strict` (original unextended
289− Markdown), `markdown_phpextra` (PHP Markdown Extra),
290− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
291− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
292− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
293− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
294− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
295− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
296− `haddock` (Haddock markup), or `latex` (LaTeX).
297− (`markdown_github` provides deprecated and less accurate support
298− for Github-Flavored Markdown; please use `gfm` instead, unless you
299− need to use extensions other than `smart`.)
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+
300270 Extensions can be individually enabled or disabled by
301271 appending `+EXTENSION` or `-EXTENSION` to the format name.
302272 See [Extensions] below, for a list of extensions and
@@ -305,34 +275,75 @@ General options
305275
306276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
307277
308−: Specify output format. *FORMAT* can be `native` (native Haskell),
309− `json` (JSON version of native AST), `plain` (plain text),
310− `markdown` (pandoc's extended Markdown), `markdown_strict`
311− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
312− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
313− Markdown), `commonmark` (CommonMark Markdown), `rst`
314− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
315− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
316− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
317− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
318− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
319− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
320− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
321− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
322− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
323− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
324− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
325− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
326− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
327− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
328− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
329− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
330− the path of a custom lua writer (see [Custom writers],
331− below). (`markdown_github` provides deprecated and less accurate
332− support for Github-Flavored Markdown; please use `gfm` instead,
333− unless you use extensions that do not work with `gfm`.) Note that
334− `odt`, `docx`, and `epub` output will not be directed to *stdout*
335− unless forced with `-o -`. Extensions can be individually enabled or
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
336347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
337348 name. See [Extensions] below, for a list of extensions and their
338349 names. See `--list-output-formats` and `--list-extensions`, below.
@@ -347,23 +358,32 @@ General options
347358
348359: Specify the user data directory to search for pandoc data files.
349360 If this option is not specified, the default user data directory
350− will be used. This is, in UNIX:
351−
352− $HOME/.pandoc
353−
354− in Windows XP:
355−
356− C:\Documents And Settings\USERNAME\Application Data\pandoc
357−
358− and in Windows Vista or later:
359−
360− C:\Users\USERNAME\AppData\Roaming\pandoc
361−
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`.
362368 You can find the default user data directory on your system by
363369 looking at the output of `pandoc --version`.
364− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
365− `slidy`, `slideous`, or `s5` directory
366− 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.
367387
368388`--bash-completion`
369389
@@ -374,8 +394,7 @@ General options
374394
375395`--verbose`
376396
377−: Give verbose debugging output. Currently this only has an effect
378− with PDF output.
397+: Give verbose debugging output.
379398
380399`--quiet`
381400
@@ -401,7 +420,7 @@ General options
401420
402421`--list-extensions`[`=`*FORMAT*]
403422
404−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
405424 by a `+` or `-` indicating whether it is enabled by default
406425 in *FORMAT*. If *FORMAT* is not specified, defaults for
407426 pandoc's Markdown are given.
@@ -424,12 +443,88 @@ General options
424443
425444: Show usage message.
426445
427−Reader options
428−--------------
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.
429522
430523`--base-header-level=`*NUMBER*
431524
432−: 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).
433528
434529`--strip-empty-paragraphs`
435530
@@ -459,7 +554,7 @@ Reader options
459554 footnotes and links will not work across files. Reading binary
460555 files (docx, odt, epub) implies `--file-scope`.
461556
462−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
463558
464559: Specify an executable to be used as a filter transforming the
465560 pandoc AST after the input is parsed and before the output is
@@ -494,50 +589,65 @@ Reader options
494589
495590 3. `$PATH` (executable only)
496591
497− Filters and lua-filters are applied in the order specified
498− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
499594
500−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
501596
502597: Transform the document in a similar fashion as JSON filters (see
503− `--filter`), but use pandoc's build-in lua filtering system. The given
504− lua script is expected to return a list of lua filters which will be
505− 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
506601 functions indexed by the name of the AST element on which the filter
507602 function should be applied.
508603
509− The `pandoc` lua module provides helper functions for element
510− 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.
511606
512− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
513608
514− function expand_hello_world(inline)
515− if inline.c == '{{helloworld}}' then
516− return pandoc.Emph{ pandoc.Str "Hello, World" }
517− else
518− return inline
519− end
520− end
609+ In order of preference, pandoc will look for Lua filters in
521610
522− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
523612
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
615+
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
524618
525619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
526620
527621: Set the metadata field *KEY* to the value *VAL*. A value specified
528− 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`].
529624 Values will be parsed as YAML boolean or string values. If no value is
530625 specified, the value will be treated as Boolean true. Like
531626 `--variable`, `--metadata` causes template variables to be set.
532627 But unlike `--variable`, `--metadata` affects the metadata of the
533628 underlying document (which is accessible from filters and may be
534− 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.
535644
536645`-p`, `--preserve-tabs`
537646
538−: Preserve tabs instead of converting them to spaces (the default).
539− Note that this will only affect tabs in literal code spans and code
540− 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.
541651
542652`--tab-stop=`*NUMBER*
543653
@@ -547,30 +657,30 @@ Reader options
547657
548658: Specifies what to do with insertions, deletions, and comments
549659 produced by the MS Word "Track Changes" feature. `accept` (the
550− default), inserts all insertions, and ignores all
551− deletions. `reject` inserts all deletions and ignores
552− insertions. Both `accept` and `reject` ignore comments. `all` puts
553− in insertions, deletions, and comments, wrapped in spans with
554− `insertion`, `deletion`, `comment-start`, and `comment-end`
555− classes, respectively. The author and time of change is
556− included. `all` is useful for scripting: only accepting changes
557− from a certain reviewer, say, or before a certain date. If a
558− paragraph is inserted or deleted, `track-changes=all` produces a
559− span with the class `paragraph-insertion`/`paragraph-deletion`
560− before the affected paragraph break. This option only affects the
561− 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.
562672
563673`--extract-media=`*DIR*
564674
565675: Extract images and other media contained in or linked from
566676 the source document to the path *DIR*, creating it if
567677 necessary, and adjust the images references in the document
568− so they point to the extracted files. If the source format is
569− a binary container (docx, epub, or odt), the media is
570− extracted from the container and the original
571− filenames are used. Otherwise the media is read from the
572− file system or downloaded, and new filenames are constructed
573− 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.
574684
575685`--abbreviations=`*FILE*
576686
@@ -581,29 +691,30 @@ Reader options
581691 system default, use
582692 `pandoc --print-default-data-file=abbreviations`. The only
583693 use pandoc makes of this list is in the Markdown reader.
584− Strings ending in a period that are found in this list will
585− be followed by a nonbreaking space, so that the period will
586− 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.
587697
588698[`pandocfilters`]: https://github.com/jgm/pandocfilters
589699[PHP]: https://github.com/vinai/pandocfilters-php
590700[perl]: https://metacpan.org/pod/Pandoc::Filter
591701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
592703
593−General writer options
594−----------------------
704+## General writer options {.options}
595705
596706`-s`, `--standalone`
597707
598708: Produce output with an appropriate header and footer (e.g. a
599709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
600710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
601− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
602713
603−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
604715
605−: Use *FILE* as a custom template for the generated document. Implies
606− `--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
607718 of template syntax. If no extension is specified, an extension
608719 corresponding to the writer will be added, so that `--template=special`
609720 looks for `special.html` for HTML output. If the template is not
@@ -615,22 +726,29 @@ General writer options
615726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
616727
617728: Set the template variable *KEY* to the value *VAL* when rendering the
618− document in standalone mode. This is generally only useful when the
619− `--template` option is used to specify a custom template, since
620− pandoc automatically sets the variables used in the default
621− templates. If no *VAL* is specified, the key will be given the
622− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
623731
624732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
625733
626734: Print the system default template for an output *FORMAT*. (See `-t`
627735 for a list of possible *FORMAT*s.) Templates in the user data
628− 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`.
629745
630746`--print-default-data-file=`*FILE*
631747
632748: Print a system default data file. Files in the user data directory
633− 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.
634752
635753`--eol=crlf`|`lf`|`native`
636754
@@ -641,9 +759,12 @@ General writer options
641759
642760`--dpi`=*NUMBER*
643761
644−: Specify the dpi (dots per inch) value for conversion from pixels
645− to inch/centimeters and vice versa. The default is 96dpi.
646− 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.
647768
648769`--wrap=auto`|`none`|`preserve`
649770
@@ -656,6 +777,8 @@ General writer options
656777 where there are nonsemantic newlines in the source, there
657778 will be nonsemantic newlines in the output as well).
658779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
659782
660783`--columns=`*NUMBER*
661784
@@ -668,14 +791,21 @@ General writer options
668791: Include an automatically generated table of contents (or, in
669792 the case of `latex`, `context`, `docx`, `odt`,
670793 `opendocument`, `rst`, or `ms`, an instruction to create
671− one) in the output document. This option has no effect on
672− `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`.
673803
674804`--toc-depth=`*NUMBER*
675805
676806: Specify the number of section levels to include in the table
677− of contents. The default is 3 (which means that level 1, 2, and 3
678− 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).
679809
680810`--strip-comments`
681811
@@ -711,7 +841,10 @@ General writer options
711841
712842: Prints a JSON version of a highlighting style, which can
713843 be modified, saved with a `.theme` extension, and used
714− 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.
715848
716849`--syntax-definition=`*FILE*
717850
@@ -719,9 +852,10 @@ General writer options
719852 which will be used for syntax highlighting of appropriately
720853 marked code blocks. This can be used to add support for
721854 new languages or to use altered syntax definitions for
722− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
723857
724−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
725859
726860: Include contents of *FILE*, verbatim, at the end of the header.
727861 This can be used, for example, to include special
@@ -729,7 +863,7 @@ General writer options
729863 repeatedly to include multiple files in the header. They will be
730864 included in the order specified. Implies `--standalone`.
731865
732−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
733867
734868: Include contents of *FILE*, verbatim, at the beginning of the
735869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -738,7 +872,7 @@ General writer options
738872 used repeatedly to include multiple files. They will be included in
739873 the order specified. Implies `--standalone`.
740874
741−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
742876
743877: Include contents of *FILE*, verbatim, at the end of the document
744878 body (before the `</body>` tag in HTML, or the
@@ -757,16 +891,27 @@ General writer options
757891 will not be searched. For example:
758892 `--resource-path=.:test` will search the working directory
759893 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`.
760899
761900`--request-header=`*NAME*`:`*VAL*
762901
763902: Set the request header *NAME* to the value *VAL* when making
764903 HTTP requests (for example, when a URL is given on the
765904 command line, or when resources used in a document must be
766− 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`
767909
768−Options affecting specific writers
769−----------------------------------
910+: Disable the certificate verification to allow access to
911+ unsecure HTTP resources (for example when the certificate
912+ is no longer valid or self signed).
913+
914+## Options affecting specific writers {.options}
770915
771916`--self-contained`
772917
@@ -791,13 +936,18 @@ Options affecting specific writers
791936
792937`--html-q-tags`
793938
794−: 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.)
795942
796943`--ascii`
797944
798−: Use only ASCII characters in output. Currently supported only for
799− HTML and DocBook output (which uses numerical entities instead of
800− 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.
801951
802952`--reference-links`
803953
@@ -806,36 +956,45 @@ Options affecting specific writers
806956 placement of link references is affected by the
807957 `--reference-location` option.
808958
809−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
810960
811961: Specify whether footnotes (and references, if `reference-links` is
812962 set) are placed at the end of the current (top-level) block, the
813963 current section, or the document. The default is
814964 `document`. Currently only affects the markdown writer.
815965
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+
816974`--atx-headers`
817975
818−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
819− to use setext-style headers for levels 1-2, and then ATX headers.
820− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
821977
822−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
823979
824−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
825− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
826− all headers are shifted such that the top-level header becomes the specified
827− type. The default behavior is to determine the best division type via
828− heuristics: unless other conditions apply, `section` is chosen. When the
829− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
830− `article` option is specified), `chapter` is implied as the setting for this
831− option. If `beamer` is the output format, specifying either `chapter` or
832− `part` will cause top-level headers to become `\part{..}`, while
833− 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.
834993
835994`-N`, `--number-sections`
836995
837−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
838− 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
839998 `unnumbered` will never be numbered, even if `--number-sections`
840999 is specified.
8411000
@@ -843,16 +1002,19 @@ Options affecting specific writers
8431002
8441003: Offset for section headings in HTML output (ignored in other
8451004 output formats). The first number is added to the section number for
846− top-level headers, the second for second-level headers, and so on.
847− 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
8481007 document to be numbered "6", specify `--number-offset=5`.
849− 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
8501009 be numbered "1.5", specify `--number-offset=1,4`.
8511010 Offsets are 0 by default. Implies `--number-sections`.
8521011
8531012`--listings`
8541013
855−: 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].
8561018
8571019`-i`, `--incremental`
8581020
@@ -861,12 +1023,12 @@ Options affecting specific writers
8611023
8621024`--slide-level=`*NUMBER*
8631025
864−: Specifies that headers with the specified level create
865− 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
8661028 above this level in the hierarchy are used to divide the
867− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
8681030 subheads within a slide. Note that content that is
869− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
8701032 the slide show. The default is to set the slide level based
8711033 on the contents of the document; see [Structuring the slide
8721034 show].
@@ -875,8 +1037,8 @@ Options affecting specific writers
8751037
8761038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
8771039 and attach identifiers to the enclosing `<section>` (or `<div>`)
878− rather than the header itself. See
879− [Header identifiers], below.
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
8801042
8811043`--email-obfuscation=none`|`javascript`|`references`
8821044
@@ -897,8 +1059,7 @@ Options affecting specific writers
8971059
8981060: Specify *STRING* as a prefix at the beginning of the title
8991061 that appears in the HTML header (but not in the title as it
900− appears at the beginning of the HTML body). Implies
901− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
9021063
9031064`-c` *URL*, `--css=`*URL*
9041065
@@ -906,8 +1067,8 @@ Options affecting specific writers
9061067 include multiple files. They will be included in the order specified.
9071068
9081069 A stylesheet is required for generating EPUB. If none is
909− provided using this option (or the `stylesheet` metadata
910− 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
9111072 user data directory (see `--data-dir`). If it is not
9121073 found there, sensible defaults will be used.
9131074
@@ -930,20 +1091,56 @@ Options affecting specific writers
9301091
9311092 To produce a custom `reference.docx`, first get a copy of
9321093 the default `reference.docx`: `pandoc
933− --print-default-data-file reference.docx >
934− custom-reference.docx`. Then open `custom-reference.docx`
935− in Word, modify the styles as you wish, and save the file.
936− For best results, do not make changes to this file other
937− than modifying the styles used by pandoc: [paragraph]
938− Normal, Body Text, First Paragraph, Compact, Title,
939− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
940− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
941− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
942− Definition Term, Definition, Caption, Table Caption,
943− Image Caption, Figure, Captioned Figure, TOC Heading;
944− [character] Default Paragraph Font, Body Text Char,
945− Verbatim Char, Footnote Reference, Hyperlink; [table]
946− 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
9471144
9481145 ODT
9491146
@@ -957,19 +1154,18 @@ Options affecting specific writers
9571154
9581155 To produce a custom `reference.odt`, first get a copy of
9591156 the default `reference.odt`: `pandoc
960− --print-default-data-file reference.odt >
961− custom-reference.odt`. Then open `custom-reference.odt` in
962− LibreOffice, modify the styles as you wish, and save the
963− 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.
9641160
9651161 PowerPoint
9661162
967− : Any template included with a recent install of Microsoft
968− PowerPoint (either with `.pptx` or `.potx` extension) should
969− work, as will most templates derived from these.
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.
9701166
971− The specific requirement is that the template should contain
972− the following four layouts as its first four layouts:
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
9731169
9741170 1. Title Slide
9751171 2. Title and Content
@@ -981,10 +1177,10 @@ Options affecting specific writers
9811177 `Home` menu to check.)
9821178
9831179 You can also modify the default `reference.pptx`: first run
984− `pandoc --print-default-data-file reference.pptx >
985− custom-reference.pptx`, and then modify
986− `custom-reference.pptx` in MS PowerPoint (pandoc will use the
987− first four layout slides, as mentioned above).
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).
9881184
9891185`--epub-cover-image=`*FILE*
9901186
@@ -1052,12 +1248,12 @@ Options affecting specific writers
10521248
10531249`--epub-chapter-level=`*NUMBER*
10541250
1055−: Specify the header level at which to split the EPUB into separate
1056− "chapter" files. The default is to split into chapters at level 1
1057− 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
10581254 EPUB, not the way chapters and sections are displayed to users. Some
10591255 readers may be slow if the chapter files are too large, so for large
1060− 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
10611257 level of 2 or 3.
10621258
10631259`--epub-subdirectory=`*DIRNAME*
@@ -1066,69 +1262,118 @@ Options affecting specific writers
10661262 the EPUB-specific contents. The default is `EPUB`. To put
10671263 the EPUB contents in the top level, use an empty string.
10681264
1069−`--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*
10701275
10711276: Use the specified engine when producing PDF output.
1072− The default is `pdflatex`. If the engine is not in your PATH,
1073− 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`
10741291
10751292`--pdf-engine-opt=`*STRING*
10761293
10771294: Use the given string as a command-line argument to the `pdf-engine`.
1078− If used multiple times, the arguments are provided with spaces between
1079− them. Note that no check for duplicate options is done.
1080−
1081−[Dublin Core elements]: http://dublincore.org/documents/dces/
1082−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1083−
1084−Citation rendering
1085−------------------
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].
10861324
10871325`--bibliography=`*FILE*
10881326
10891327: Set the `bibliography` field in the document's metadata to *FILE*,
1090− overriding any value set in the metadata, and process citations
1091− using `pandoc-citeproc`. (This is equivalent to
1092− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1093− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1094− used, making this equivalent to `--metadata bibliography=FILE`.
1095− If you supply this argument multiple times, each *FILE* will be added
1096− 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`).
10971334
10981335`--csl=`*FILE*
10991336
11001337: Set the `csl` field in the document's metadata to *FILE*,
11011338 overriding any value set in the metadata. (This is equivalent to
1102− `--metadata csl=FILE`.)
1103− 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.
11041344
11051345`--citation-abbreviations=`*FILE*
11061346
11071347: Set the `citation-abbreviations` field in the document's metadata to
11081348 *FILE*, overriding any value set in the metadata. (This is equivalent to
11091349 `--metadata citation-abbreviations=FILE`.)
1110− 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.
11111354
11121355`--natbib`
11131356
1114−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1115− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1116− 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`].
11171361
11181362`--biblatex`
11191363
1120−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1121− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1122− 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`].
11231368
1124−Math rendering in HTML
1125−----------------------
1369+## Math rendering in HTML {.options}
11261370
1127−The default is to render TeX math as far as possible using Unicode characters.
1128−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1129−differently from the surrounding text if needed. However, this gives acceptable
1130−results only for basic math, usually you will want to use `--mathjax` or another
1131−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.
11321377
11331378`--mathjax`[`=`*URL*]
11341379
@@ -1142,10 +1387,11 @@ of the following options.
11421387
11431388`--mathml`
11441389
1145−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1146− `html4` and `html5`). This is the default in `odt` output. Note that
1147− currently only Firefox and Safari (and select e-book readers) natively
1148− 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.
11491395
11501396`--webtex`[`=`*URL*]
11511397
@@ -1162,67 +1408,26 @@ of the following options.
11621408`--katex`[`=`*URL*]
11631409
11641410: Use [KaTeX] to display embedded TeX math in HTML output.
1165− The *URL* is the base URL for the KaTeX library. If a *URL* is
1166− not provided, a link to the KaTeX CDN will be inserted.
1167−
1168−`--katex-stylesheet=`*URL*
1169−
1170−: The *URL* should point to the `katex.css` stylesheet. If this option is
1171− not specified, a link to the KaTeX CDN will be inserted. Note that this
1172− option does not imply `--katex`.
1173−
1174−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1175−
1176−: *Deprecated.*
1177− Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1178− TeX math will be displayed between `$` or `$$` characters and put in
1179− `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1180− change it to MathML. Note that currently only Firefox and Safari
1181− (and select e-book readers) natively support MathML.
1182− To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1183−
1184−`--jsmath`[`=`*URL*]
1185−
1186−: *Deprecated.*
1187− Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1188− math in HTML output. TeX math will be put inside `<span>` tags
1189− (for inline math) or `<div>` tags (for display math) with class
1190− `math` and rendered by the jsMath script. The *URL* should point to
1191− the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1192− to in the header of standalone HTML documents. If a *URL* is not provided,
1193− no link to the jsMath load script will be inserted; it is then
1194− 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.
11951414
11961415`--gladtex`
11971416
1198−: *Deprecated.*
1199− Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1200− can then be processed by [gladTeX] to produce images of the typeset
1201− formulas and an HTML file with links to these images.
1202− 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.
12031420
12041421 pandoc -s --gladtex input.md -o myfile.htex
1205− gladtex -d myfile-images myfile.htex
1206− # produces myfile.html and images in myfile-images
1207−
1208−`--mimetex`[`=`*URL*]
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
12091424
1210−: *Deprecated.*
1211− Render TeX math using the [mimeTeX] CGI script, which generates an
1212− image for each TeX formula. This should work in all browsers. If
1213− *URL* is not specified, it is assumed that the script is at
1214− `/cgi-bin/mimetex.cgi`.
1215−
1216−[MathML]: http://www.w3.org/Math/
1217−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1218−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1425+[MathML]: https://www.w3.org/Math/
12191426[MathJax]: https://www.mathjax.org
1220−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1221−[mimeTeX]: http://www.forkosh.com/mimetex.html
12221427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
12231429
1224−Options for wrapper scripts
1225−---------------------------
1430+## Options for wrapper scripts {.options}
12261431
12271432`--dump-args`
12281433
@@ -1246,8 +1451,277 @@ Options for wrapper scripts
12461451
12471452 pandoc -o foo.html -s
12481453
1249−Templates
1250−=========
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
12511725
12521726When the `-s/--standalone` option is used, pandoc uses a template to
12531727add header and footer material that is needed for a self-standing
@@ -1266,284 +1740,827 @@ directory (see `--data-dir`, above). *Exceptions:*
12661740- For `pdf` output, customize the `default.latex` template
12671741 (or the `default.context` template, if you use `-t context`,
12681742 or the `default.ms` template, if you use `-t ms`, or the
1269− `default.html5` template, if you use `-t html5`).
1270−- `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
12711745 `--reference-doc` to customize the output).
12721746
12731747Templates contain *variables*, which allow for the inclusion of
1274−arbitrary information at any point in the file. Variables may be set
1275−within the document using [YAML metadata blocks][Extension:
1276−`yaml_metadata_block`]. They may also be set at the
1277−command line using the `-V/--variable` option: variables set in this
1278−way override metadata fields with the same name.
1279−
1280−Variables set by pandoc
1281−-----------------------
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.
12821755
1283−Some variables are set automatically by pandoc. These vary somewhat
1284−depending on the output format, but include metadata fields as well
1285−as the following:
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.
12861761
1287−`sourcefile`, `outputfile`
1288−: source and destination filenames, as given on the command line.
1289− `sourcefile` can also be a list if input comes from multiple files, or empty
1290− if input is from stdin. You can use the following snippet in your template
1291− to distinguish them:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
12921763
1293− $if(sourcefile)$
1294− $for(sourcefile)$
1295− $sourcefile$
1296− $endfor$
1297− $else$
1298− (stdin)
1299− $endif$
1764+## Template syntax
13001765
1301− Similarly, `outputfile` can be `-` if output goes to the terminal.
1766+### Comments
13021767
1303−`title`, `author`, `date`
1304−: allow identification of basic aspects of the document. Included
1305− in PDF metadata through LaTeX and ConTeXt. These can be set
1306− through a [pandoc title block][Extension: `pandoc_title_block`],
1307− which allows for multiple authors, or through a YAML metadata block:
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
13081770
1309− ---
1310− author:
1311− - Aristotle
1312− - Peter Abelard
1313− ...
1771+### Delimiters
13141772
1315−`subtitle`
1316−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1317− renders in LaTeX only when using a document class that supports
1318− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1319− `scrreprt`, `scrbook`).[^subtitle]
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.
13201781
1321−`institute`
1322−: author affiliations (in LaTeX and Beamer only). Can be a
1323− list, when there are multiple authors.
1782+To include a literal `$` in the document, use `$$`.
13241783
1325−`abstract`
1326−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1784+### Interpolated variables
13271785
1328−`keywords`
1329−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1330− may be repeated as for `author`, above
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:
13311791
1332−`header-includes`
1333−: contents specified by `-H/--include-in-header` (may have multiple
1334− values)
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+```
13351802
1336−`toc`
1337−: non-null value if `--toc/--table-of-contents` was specified
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.
13381807
1339−`toc-title`
1340−: title of table of contents (works only with EPUB,
1341− opendocument, odt, docx, pptx)
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.
13421815
1343−`include-before`
1344−: contents specified by `-B/--include-before-body` (may have
1345− multiple values)
1816+### Conditionals
13461817
1347−`include-after`
1348−: contents specified by `-A/--include-after-body` (may have
1349− 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:
13501824
1351−`body`
1352−: body of document
1825+```
1826+$if(foo)$bar$endif$
13531827
1354−`meta-json`
1355−: JSON representation of all of the document's metadata. Field
1356− values are transformed to the selected output format.
1828+$if(foo)$
1829+ $foo$
1830+$endif$
13571831
1358−[^subtitle]: To make `subtitle` work with other LaTeX
1359− document classes, you can add the following to `header-includes`:
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
13601837
1361− \providecommand{\subtitle}[1]{%
1362− \usepackage{titling}
1363− \posttitle{%
1364− \par\large#1\end{center}}
1365− }
1838+${if(foo)}bar${endif}
13661839
1367−Language variables
1368−------------------
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
13691843
1370−`lang`
1371−: identifies the main language of the document,
1372− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1373− For some output formats, pandoc will convert it to an appropriate
1374− format stored in the additional variables `babel-lang`,
1375− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1376−
1377− Native pandoc Spans and Divs with the lang attribute
1378− (value in BCP 47) can be used to switch the language in
1379− that range. In LaTeX output, `babel-otherlangs` and
1380− `polyglossia-otherlangs` variables will be generated
1381− automatically based on the `lang` attributes of Spans
1382− and Divs in the document.
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
13831850
1384−`dir`
1385−: the base direction of the document, either `rtl` (right-to-left)
1386− or `ltr` (left-to-right).
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
13871853
1388− For bidirectional documents, native pandoc `span`s and `div`s
1389− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1390− override the base direction in some output formats.
1391− This may not always be necessary if the final renderer
1392− (e.g. the browser, when generating HTML) supports the
1393− [Unicode Bidirectional Algorithm].
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
13941863
1395− When using LaTeX for bidirectional documents, only the `xelatex` engine
1396− is fully supported (use `--pdf-engine=xelatex`).
1864+### For loops
13971865
1398−[BCP 47]: https://tools.ietf.org/html/bcp47
1399−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
14001869
1401−Variables for slides
1402−--------------------
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.
14031877
1404−Variables are available for [producing slide shows with pandoc],
1405−including all [reveal.js configuration options].
1878+Examples:
14061879
1407−`titlegraphic`
1408−: title graphic for Beamer documents
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
14091882
1410−`logo`
1411−: logo for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
14121886
1413−`slidy-url`
1414−: base URL for Slidy documents (defaults to
1415− `https://www.w3.org/Talks/Tools/Slidy2`)
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
14161890
1417−`slideous-url`
1418−: base URL for Slideous documents (defaults to `slideous`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
14191895
1420−`s5-url`
1421−: base URL for S5 documents (defaults to `s5/default`)
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.
14221899
1423−`revealjs-url`
1424−: base URL for reveal.js documents (defaults to `reveal.js`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
14251903
1426−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1427−: themes for LaTeX [`beamer`] documents
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
14281906
1429−`themeoptions`
1430−: options for LaTeX beamer themes (a list).
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
14311912
1432−`navigation`
1433−: controls navigation symbols in `beamer` documents
1434− (default is `empty` for no navigation symbols; other valid values
1435− are `frame`, `vertical`, and `horizontal`).
1913+### Partials
14361914
1437−`section-titles`
1438−: enables on "title pages" for new sections in `beamer`
1439− documents (default = true).
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
14401918
1441−`beamerarticle`
1442−: when true, the `beamerarticle` package is loaded (for
1443− producing an article from beamer slides).
1919+```
1920+${ styles() }
1921+```
14441922
1445−`aspectratio`
1446−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1447− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1448− default, and `32` for 3:2).
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:
14491928
1450−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1929+```
1930+${ styles.html() }
1931+```
14511932
1452−Variables for LaTeX
1453−-------------------
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.)
14541937
1455−LaTeX variables are used when [creating a PDF].
1938+Partials may optionally be applied to variables using
1939+a colon:
14561940
1457−`papersize`
1458−: paper size, e.g. `letter`, `a4`
1941+```
1942+${ date:fancy() }
14591943
1460−`fontsize`
1461−: font size for body text (e.g. `10pt`, `12pt`)
1944+${ articles:bibentry() }
1945+```
14621946
1463−`documentclass`
1464−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
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
14651950
1466−`classoption`
1467−: option for document class, e.g. `oneside`; may be repeated
1468− for multiple options
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
14691956
1470−`geometry`
1471−: option for [`geometry`] package, e.g. `margin=1in`;
1472− may be repeated 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`.
14731961
1474−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1475−: sets margins, if `geometry` is not used (otherwise `geometry`
1476− overrides these)
1962+Final newlines are omitted from included partials.
14771963
1478−`linestretch`
1479−: adjusts line spacing using the [`setspace`]
1480− package, e.g. `1.25`, `1.5`
1964+Partials may include other partials.
14811965
1482−`fontfamily`
1483−: font package for use with `pdflatex`:
1484− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1485− The default is [Latin Modern][`lm`].
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
14861969
1487−`fontfamilyoptions`
1488−: options for package used as `fontfamily`: e.g. `osf,sc` with
1489− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1490− figures and true small caps; may be repeated for multiple options
1970+```
1971+${months[, ]}$
14911972
1492−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1493−: font families for use with `xelatex` or
1494− `lualatex`: take the name of any system font, using the
1495− [`fontspec`] package. Note that if `CJKmainfont` is used,
1496− the [`xecjk`] package must be available.
1973+${articles:bibentry()[; ]$
1974+```
14971975
1498−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1499−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1500− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1501− available through [`fontspec`], such as the OpenType features
1502− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
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.
15031979
1504−`fontenc`
1505−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1506− default is `T1` (see guide to [LaTeX font encodings])
1980+### Nesting
15071981
1508−`microtypeoptions`
1509−: options to pass to the microtype package
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
15101984
1511−`colorlinks`
1512−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1513− `urlcolor`, or `toccolor` are set
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
15141988
1515−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1516−: color for internal links, citation links, external links, and links in table of contents:
1517− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
1991+
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
1996+
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
1999+
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
2004+
2005+will produce
2006+
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
2012+
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
2017+
2018+### Breakable spaces
2019+
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
2024+
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
2029+
2030+### Pipes
2031+
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
2035+
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
2040+
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
2044+
2045+$employee:name()/uppercase$
2046+```
2047+
2048+Pipes may be chained:
2049+
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
2055+
2056+Some pipes take parameters:
2057+
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
2065+
2066+Currently the following pipes are predefined:
2067+
2068+- `pairs`: Converts a map or array to an array of maps,
2069+ each with `key` and `value` fields. If the original
2070+ value was an array, the `key` will be the array index,
2071+ starting with 1.
2072+
2073+- `uppercase`: Converts text to uppercase.
2074+
2075+- `lowercase`: Converts text to lowercase.
2076+
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
2080+
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2083+
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2087+
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
2091+
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
2095+
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
2099+
2100+- `chomp`: Removes trailing newlines (and breakable space).
2101+
2102+- `nowrap`: Disables line wrapping on breakable spaces.
2103+
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
2109+
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
2114+
2115+- `left n "leftborder" "rightborder"`: Renders a textual value
2116+ in a block of width `n`, aligned to the left, with an optional
2117+ left and right border. Has no effect on other values. This
2118+ can be used to align material in tables. Widths are positive
2119+ integers indicating the number of characters. Borders
2120+ are strings inside double quotes; literal `"` and `\` characters
2121+ must be backslash-escaped.
2122+
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
2126+
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
2130+
2131+
2132+## Variables
2133+
2134+### Metadata variables
2135+
2136+`title`, `author`, `date`
2137+: allow identification of basic aspects of the document. Included
2138+ in PDF metadata through LaTeX and ConTeXt. These can be set
2139+ through a [pandoc title block][Extension: `pandoc_title_block`],
2140+ which allows for multiple authors, or through a
2141+ [YAML metadata block][Extension: `yaml_metadata_block`]:
2142+
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
2148+
2149+ Note that if you just want to set PDF or HTML metadata, without
2150+ including a title block in the document itself, you can
2151+ set the `title-meta`, `author-meta`, and `date-meta`
2152+ variables. (By default these are set automatically, based
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
2155+
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
2159+
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
2163+
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
2167+
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
2170+
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
2174+
2175+`category`
2176+: document category, included in docx and pptx metadata
2177+
2178+Additionally,
2179+any root-level string metadata, not included in ODT, docx
2180+or pptx metadata is added as a *custom property*.
2181+The following [YAML] metadata block for instance:
2182+
2183+ ---
2184+ title: 'This is the title'
2185+ subtitle: "This is the subtitle"
2186+ author:
2187+ - Author One
2188+ - Author Two
2189+ description: |
2190+ This is a long
2191+ description.
2192+
2193+ It consists of two paragraphs
2194+ ...
2195+
2196+will include `title`, `author` and `description` as standard document
2197+properties and `subtitle` as a custom property when converting to docx,
2198+ODT or pptx.
2199+
2200+### Language variables
2201+
2202+`lang`
2203+: identifies the main language of the document using IETF language
2204+ tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205+ The [Language subtag lookup] tool can look up or verify these tags.
2206+ This affects most formats, and controls hyphenation in PDF output
2207+ when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2208+
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
2211+
2212+ ---
2213+ lang: en-GB
2214+ ...
2215+
2216+ Text in the main document language (British English).
2217+
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
2221+
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
2223+
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
2227+
2228+ For bidirectional documents, native pandoc `span`s and
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230+ be used to override the base direction in some output
2231+ formats. This may not always be necessary if the final
2232+ renderer (e.g. the browser, when generating HTML) supports
2233+ the [Unicode Bidirectional Algorithm].
2234+
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
2238+
2239+[BCP 47]: https://tools.ietf.org/html/bcp47
2240+[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2241+[Language subtag lookup]: https://r12a.github.io/app-subtags/
2242+
2243+### Variables for HTML
2244+
2245+`document-css`
2246+: Enables inclusion of most of the [CSS] in the `styles.html`
2247+ [partial](#partials) (have a look with
2248+ `pandoc --print-default-data-file=templates/styles.html`).
2249+ Unless you use [`--css`](#option--css), this variable
2250+ is set to `true` by default. You can disable it with
2251+ e.g. `pandoc -M document-css=false`.
2252+
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
2255+
2256+`fontsize`
2257+: sets the base CSS `font-size`, which you'd usually set
2258+ to e.g. `20px`, but it also accepts `pt`
2259+ (12pt = 16px in most browsers).
2260+
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
2263+
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
2266+
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
2269+
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2273+
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
2277+
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
2280+
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
2283+
2284+To override or extend some [CSS] for just one document, include for example:
2285+
2286+ ---
2287+ header-includes: |
2288+ <style>
2289+ blockquote {
2290+ font-style: italic;
2291+ }
2292+ tr.even {
2293+ background-color: #f0f0f0;
2294+ }
2295+ td, th {
2296+ padding: 0.5em 2em 0.5em 0.5em;
2297+ }
2298+ tbody {
2299+ border-bottom: none;
2300+ }
2301+ </style>
2302+ ---
2303+
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305+
2306+### Variables for HTML math
2307+
2308+`classoption`
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
2312+
2313+### Variables for HTML slides
2314+
2315+These affect HTML output when [producing slide shows with pandoc].
2316+
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
2319+
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
2323+
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
2326+
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
2330+
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
2333+
2334+`title-slide-attributes`
2335+: additional attributes for the title slide of reveal.js slide shows.
2336+ See [background in reveal.js and beamer] for an example.
2337+
2338+All [reveal.js configuration options] are available as variables.
2339+To turn off boolean flags that default to true in reveal.js, use `0`.
2340+
2341+[reveal.js configuration options]: https://revealjs.com/config/
2342+
2343+### Variables for Beamer slides
2344+
2345+These variables change the appearance of PDF slides using [`beamer`].
2346+
2347+`aspectratio`
2348+: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349+ `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350+ `32` for 3:2)
2351+
2352+`beamerarticle`
2353+: produce an article from Beamer slides
2354+
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
2357+
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
2360+
2361+`logo`
2362+: logo image for slides
2363+
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367+
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
2370+
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
2373+
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
2376+
2377+`titlegraphic`
2378+: image for title slide
2379+
2380+### Variables for PowerPoint
2381+
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
2384+
2385+`monofont`
2386+: font to use for code.
2387+
2388+### Variables for LaTeX
2389+
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2391+
2392+#### Layout
2393+
2394+`block-headings`
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
2397+ classes) free-standing rather than run-in; requires further
2398+ formatting to distinguish from `\subsubsection` (third- or
2399+ fourth-level headings). Instead of using this option,
2400+ [KOMA-Script] can adjust headings more extensively:
2401+
2402+ ---
2403+ documentclass: scrartcl
2404+ header-includes: |
2405+ \RedeclareSectionCommand[
2406+ beforeskip=-10pt plus -2pt minus -1pt,
2407+ afterskip=1sp plus -1sp minus 1sp,
2408+ font=\normalfont\itshape]{paragraph}
2409+ \RedeclareSectionCommand[
2410+ beforeskip=-10pt plus -2pt minus -1pt,
2411+ afterskip=1sp plus -1sp minus 1sp,
2412+ font=\normalfont\scshape,
2413+ indent=0pt]{subparagraph}
2414+ ...
2415+
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
2418+
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
2424+
2425+`documentclass`
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429+ default to smaller margins; or [`memoir`]
2430+
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
2434+
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
2441+
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2445+
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
2452+
2453+`indent`
2454+: if true, pandoc will use document class settings for
2455+ indentation (the default LaTeX template otherwise removes
2456+ indentation and adds space between paragraphs)
2457+
2458+`linestretch`
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
2461+
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
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
15182539
15192540`links-as-notes`
15202541: causes links to be printed as footnotes
15212542
1522−`indent`
1523−: uses document class settings for indentation (the default LaTeX template
1524− otherwise removes indentation and adds space between paragraphs)
2543+#### Front matter
15252544
1526−`subparagraph`
1527−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1528− as sections, changing the appearance of nested headings in some classes
2545+`lof`, `lot`
2546+: include list of figures, list of tables
15292547
15302548`thanks`
1531−: specifies contents of acknowledgments footnote after document title.
2549+: contents of acknowledgments footnote after document title
15322550
15332551`toc`
1534−: include table of contents (can also be set using `--toc/--table-of-contents`)
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
15352554
15362555`toc-depth`
15372556: level of section to include in table of contents
15382557
1539−`secnumdepth`
1540−: numbering depth for sections, if sections are numbered
2558+#### BibLaTeX Bibliographies
15412559
1542−`lof`, `lot`
1543−: include list of figures, list of tables
2560+These variables function when using BibLaTeX for [citation rendering].
15442561
1545−`bibliography`
1546−: bibliography to use for resolving references
2562+`biblatexoptions`
2563+: list of options for biblatex
15472564
15482565`biblio-style`
15492566: bibliography style, when used with `--natbib` and `--biblatex`.
@@ -1551,126 +2568,154 @@ LaTeX variables are used when [creating a PDF].
15512568`biblio-title`
15522569: bibliography title, when used with `--natbib` and `--biblatex`.
15532570
1554−`biblatexoptions`
1555−: list of options for biblatex.
2571+`bibliography`
2572+: bibliography to use for resolving references
15562573
15572574`natbiboptions`
1558−: list of options for natbib.
1559−
1560−`pagestyle`
1561−: An option for LaTeX's `\pagestyle{}`. The default article class
1562− supports 'plain' (default), 'empty', and 'headings'; headings puts
1563− section titles in the header.
2575+: list of options for natbib
15642576
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
15652581[`article`]: https://ctan.org/pkg/article
1566−[`report`]: https://ctan.org/pkg/report
15672582[`book`]: https://ctan.org/pkg/book
1568−[KOMA-Script]: https://ctan.org/pkg/koma-script
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
15692584[`memoir`]: https://ctan.org/pkg/memoir
1570−[`xcolor`]: https://ctan.org/pkg/xcolor
1571−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1572−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1573−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2585+[`report`]: https://ctan.org/pkg/report
15742586
1575−Variables for ConTeXt
1576−---------------------
2587+### Variables for ConTeXt
15772588
1578−`papersize`
1579−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1580− may be repeated for multiple options
1581−
1582−`layout`
1583−: options for page margins and text arrangement (see [ConTeXt Layout]);
1584− may be repeated for multiple options
1585−
1586−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1587−: sets margins, if `layout` is not used (otherwise `layout`
1588− overrides these)
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
15892590
15902591`fontsize`
15912592: font size for body text (e.g. `10pt`, `12pt`)
15922593
1593−`mainfont`, `sansfont`, `monofont`, `mathfont`
1594−: font families: take the name of any system font (see [ConTeXt Font Switching])
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
15952609
15962610`linkcolor`, `contrastcolor`
1597−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
15982613
15992614`linkstyle`
1600−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
16012617
1602−`indenting`
1603−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1604− may be repeated for multiple options
1605−
1606−`whitespace`
1607−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2618+`lof`, `lot`
2619+: include list of figures, list of tables
16082620
1609−`interlinespace`
1610−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1611− may be repeated for multiple options
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
16122624
1613−`headertext`, `footertext`
1614−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1615− may be repeated up to four times for different placement
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626+: sets margins, if `layout` is not used (otherwise `layout`
2627+ overrides these)
16162628
16172629`pagenumbering`
16182630: page number style and location (using [`setuppagenumbering`]);
1619− may be repeated for multiple options
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.
16202662
16212663`toc`
1622−: include table of contents (can also be set using `--toc/--table-of-contents`)
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
16232666
1624−`lof`, `lot`
1625−: include list of figures, list of tables
2667+`whitespace`
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
16262670
1627−`pdfa`
1628−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1629− To successfully generate PDF/A the required ICC color profiles have to
1630− be available and the content and all included files (such as images)
1631− have to be standard conforming. The ICC profiles can be obtained
1632− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1633− details.
1634−
1635−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1636−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1637−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1638−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1639−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1640−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1641−[ConTeXt ICC Profiles]: http://wiki.contextgarden.net/PDFX#ICC_profiles
1642−[ConTeXt PDFA]: http://wiki.contextgarden.net/PDF/A
1643−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1644−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1645−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1646−
1647−Variables for man pages
1648−-----------------------
2671+`includesource`
2672+: include all source documents as file attachments in the PDF file
16492673
1650−`section`
1651−: section number in man pages
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
16522685
1653−`header`
1654−: header in man pages
2686+### Variables for `wkhtmltopdf`
16552687
1656−`footer`
1657−: footer in man pages
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
16582701
16592702`adjusting`
16602703: adjusts text to left (`l`), right (`r`), center (`c`),
16612704 or both (`b`) margins
16622705
2706+`footer`
2707+: footer in man pages
2708+
2709+`header`
2710+: header in man pages
2711+
16632712`hyphenate`
16642713: if `true` (the default), hyphenation will be used
16652714
1666−Variables for ms
1667−----------------
1668−
1669−`pointsize`
1670−: point size (e.g. `10p`)
2715+`section`
2716+: section number in man pages
16712717
1672−`lineheight`
1673−: line height (e.g. `12p`)
2718+### Variables for ms
16742719
16752720`fontfamily`
16762721: font family (e.g. `T` or `P`)
@@ -1678,62 +2723,81 @@ Variables for ms
16782723`indent`
16792724: paragraph indent (e.g. `2m`)
16802725
1681−Using variables in templates
1682−----------------------------
2726+`lineheight`
2727+: line height (e.g. `12p`)
2728+
2729+`pointsize`
2730+: point size (e.g. `10p`)
16832731
1684−Variable names are sequences of alphanumerics, `-`, and `_`,
1685−starting with a letter. A variable name surrounded by `$` signs
1686−will be replaced by its value. For example, the string `$title$` in
2732+### Variables set automatically
16872733
1688− <title>$title$</title>
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:
16892737
1690−will be replaced by the document title.
2738+`body`
2739+: body of document
16912740
1692−To write a literal `$` in a template, use `$$`.
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`).
16932750
1694−Templates may contain conditionals. The syntax is as follows:
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
16952754
1696− $if(variable)$
1697− X
1698− $else$
1699− Y
1700− $endif$
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
17012758
1702−This will include `X` in the template if `variable` has a non-null
1703−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1704−any valid template text, and may include interpolated variables or other
1705−conditionals. The `$else$` section may be omitted.
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
17062762
1707−When variables can have multiple values (for example, `author` in
1708−a multi-author document), you can use the `$for$` keyword:
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
17092766
1710− $for(author)$
1711− <meta name="author" content="$author$" />
1712− $endfor$
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:
17132775
1714−You can optionally specify a separator to be used between
1715−consecutive items:
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
17162783
1717− $for(author)$$author$$sep$, $endfor$
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17182785
1719−A dot can be used to select a field of a variable that takes
1720−an object as its value. So, for example:
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
17212787
1722− $author.name$ ($author.affiliation$)
2788+`curdir`
2789+: working directory from which pandoc is run.
17232790
1724−If you use custom templates, you may need to revise them as pandoc
1725−changes. We recommend tracking the changes in the default templates,
1726−and modifying your custom templates accordingly. An easy way to do this
1727−is to fork the [pandoc-templates] repository and merge in changes after each
1728−pandoc release.
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
17292793
1730−Templates may contain comments: anything on a line after `$--`
1731−will be treated as a comment and ignored.
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
17322797
17332798[pandoc-templates]: https://github.com/jgm/pandoc-templates
17342799
1735−Extensions
1736−==========
2800+# Extensions
17372801
17382802The behavior of some of the readers and writers can be adjusted by
17392803enabling or disabling various extensions.
@@ -1750,8 +2814,11 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
17502814`commonmark` and `gfm`.) In the following, extensions that also work
17512815for other formats are covered.
17522816
1753−Typography
1754−----------
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
17552822
17562823#### Extension: `smart` ####
17572824
@@ -1783,13 +2850,12 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
17832850to use the ligatures when possible; if `smart` is disabled
17842851pandoc will use unicode quotation mark and dash characters.
17852852
1786−Headers and sections
1787−--------------------
2853+## Headings and sections
17882854
17892855#### Extension: `auto_identifiers` ####
17902856
1791−A header without an explicitly specified identifier will be
1792−automatically assigned a unique identifier based on the header text.
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
17932859
17942860This extension can be enabled/disabled for the following formats:
17952861
@@ -1802,11 +2868,13 @@ output formats
18022868enabled by default in
18032869: `markdown`, `muse`
18042870
1805−The algorithm used to derive the identifier from the header text is:
2871+The default algorithm used to derive the identifier from the
2872+heading text is:
18062873
18072874 - Remove all formatting, links, etc.
18082875 - Remove all footnotes.
1809− - Remove all punctuation, except underscores, hyphens, and periods.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
18102878 - Replace all spaces and newlines with hyphens.
18112879 - Convert all alphabetic characters to lowercase.
18122880 - Remove everything up to the first letter (identifiers may
@@ -1815,27 +2883,31 @@ The algorithm used to derive the identifier from the header text is:
18152883
18162884Thus, for example,
18172885
1818− Header Identifier
2886+ Heading Identifier
18192887 ------------------------------- ----------------------------
1820− `Header identifiers in HTML` `header-identifiers-in-html`
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
18212890 `*Dogs*?--in *my* house?` `dogs--in-my-house`
18222891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
18232892 `3. Applications` `applications`
18242893 `33` `section`
18252894
18262895These rules should, in most cases, allow one to determine the identifier
1827−from the header text. The exception is when several headers have the
2896+from the heading text. The exception is when several headings have the
18282897same text; in this case, the first will get an identifier as described
18292898above; the second will get the same identifier with `-1` appended; the
18302899third with `-2`; and so on.
18312900
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
2903+
18322904These identifiers are used to provide link targets in the table of
18332905contents generated by the `--toc|--table-of-contents` option. They
18342906also make it easy to provide links from one section of a document to
18352907another. A link to this section, for example, might look like this:
18362908
18372909 See the section on
1838− [header identifiers](#header-identifiers-in-html-latex-and-context).
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
18392911
18402912Note, however, that this method of providing links to sections works
18412913only in HTML, LaTeX, and ConTeXt formats.
@@ -1843,7 +2915,7 @@ only in HTML, LaTeX, and ConTeXt formats.
18432915If the `--section-divs` option is specified, then each section will
18442916be wrapped in a `section` (or a `div`, if `html4` was specified),
18452917and the identifier will be attached to the enclosing `<section>`
1846−(or `<div>`) tag rather than the header itself. This allows entire
2918+(or `<div>`) tag rather than the heading itself. This allows entire
18472919sections to be manipulated using JavaScript or treated differently in
18482920CSS.
18492921
@@ -1853,8 +2925,15 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
18532925Accents are stripped off of accented Latin letters, and non-Latin
18542926letters are omitted.
18552927
1856−Math Input
1857−----------
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
18582937
18592938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
18602939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -1864,50 +2943,47 @@ are described in the section about Pandoc's Markdown.
18642943However, they can also be used with HTML input. This is handy for
18652944reading web pages formatted using MathJax, for example.
18662945
1867−Raw HTML/TeX
1868−------------
1869−
1870−The following extensions (especially how they affect Markdown
1871−input/output) are also described in more detail in their respective
1872−sections of [Pandoc's Markdown].
2946+## Raw HTML/TeX
18732947
1874−#### [Extension: `raw_html`] {#raw_html}
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
18752950
1876−When converting from HTML, parse elements to raw HTML which are not
1877−representable in pandoc's AST.
1878−By default, this is disabled for HTML input.
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.
18792954
1880−#### [Extension: `raw_tex`] {#raw_tex}
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`):
18812958
1882−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
18832962
1884−This extension can be enabled/disabled for the following formats
1885−(in addition to `markdown`):
2963+ output formats
2964+ : `textile`, `commonmark`
18862965
1887−input formats
1888−: `latex`, `org`, `textile`
1889−
1890−output formats
1891−: `textile`
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`.
18922973
1893−#### [Extension: `native_divs`] {#native_divs}
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`.
18942978
1895−This extension is enabled by default for HTML input. This means that
1896−`div`s are parsed to pandoc native elements. (Alternatively, you
1897−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
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`.
18982985
1899−When converting HTML to Markdown, for example, you may want to drop all
1900−`div`s and `span`s:
1901−
1902− pandoc -f html-native_divs-native_spans -t markdown
1903−
1904−#### [Extension: `native_spans`] {#native_spans}
1905−
1906−Analogous to `native_divs` above.
1907−
1908−
1909−Literate Haskell support
1910−------------------------
2986+## Literate Haskell support
19112987
19122988#### Extension: `literate_haskell` ####
19132989
@@ -1928,12 +3004,12 @@ This means that
19283004 - In Markdown input, "bird track" sections will be parsed as Haskell
19293005 code rather than block quotations. Text between `\begin{code}`
19303006 and `\end{code}` will also be treated as Haskell code. For
1931− ATX-style headers the character '=' will be used instead of '#'.
3007+ ATX-style headings the character '=' will be used instead of '#'.
19323008
19333009 - In Markdown output, code blocks with classes `haskell` and `literate`
19343010 will be rendered using bird tracks, and block quotations will be
19353011 indented one space, so they will not be treated as Haskell code.
1936− In addition, headers will be rendered setext-style (with underlines)
3012+ In addition, headings will be rendered setext-style (with underlines)
19373013 rather than ATX-style (with '#' characters). (This is because ghc
19383014 treats '#' characters in column 1 as introducing line numbers.)
19393015
@@ -1964,12 +3040,11 @@ ordinary HTML (without bird tracks).
19643040writes HTML with the Haskell code in bird tracks, so it can be copied
19653041and pasted as literate Haskell source.
19663042
1967−Note that GHC expects the bird tracks in the first column, so indentend literate
1968−code blocks (e.g. inside an itemized environment) will not be picked up by the
1969−Haskell compiler.
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.
19703046
1971−Other extensions
1972−----------------
3047+## Other extensions
19733048
19743049#### Extension: `empty_paragraphs` ####
19753050
@@ -1982,14 +3057,62 @@ input formats
19823057: `docx`, `html`
19833058
19843059output formats
1985−: `markdown`, `docx`, `odt`, `opendocument`, `html`
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`
19863108
19873109#### Extension: `styles` #### {#ext-styles}
19883110
1989−Read all docx styles as divs (for paragraph styles) and spans (for
1990−character styles) regardless of whether pandoc understands the meaning
1991−of these styles. This can be used with [docx custom
1992−styles](#custom-styles-in-docx). Disabled by default.
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.
19933116
19943117input formats
19953118: `docx`
@@ -1999,22 +3122,36 @@ input formats
19993122In the `muse` input format, this enables Text::Amuse
20003123extensions to Emacs Muse markup.
20013124
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+
20023133#### Extension: `citations` {#org-citations}
20033134
2004−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2005−in `org` input.
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.
20063144
20073145#### Extension: `ntb` ####
20083146
20093147In the `context` output format this enables the use of [Natural Tables
2010−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2011−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
20123150Natural tables allow more fine-grained global customization but come
20133151at a performance penalty compared to extreme tables.
20143152
20153153
2016−Pandoc's Markdown
2017−=================
3154+# Pandoc's Markdown
20183155
20193156Pandoc understands an extended and slightly revised version of
20203157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2024,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
20243161behavior more granularly. They are described in the following. See also
20253162[Extensions] above, for extensions that work also on other formats.
20263163
2027−Philosophy
2028−----------
3164+## Philosophy
20293165
20303166Markdown is designed to be easy to write, and, even more importantly,
20313167easy to read:
@@ -2033,7 +3169,7 @@ easy to read:
20333169> A Markdown-formatted document should be publishable as-is, as plain
20343170> text, without looking like it's been marked up with tags or formatting
20353171> instructions.
2036−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
20373173
20383174This principle has guided pandoc's decisions in finding syntax for
20393175tables, footnotes, and other extensions.
@@ -2046,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
20463182important document elements like definition lists, tables, mathematics, and
20473183footnotes.
20483184
2049−Paragraphs
2050−----------
3185+## Paragraphs
20513186
20523187A paragraph is one or more lines of text followed by one or more blank lines.
20533188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2060,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
20603195to create a hard line break, since trailing spaces in the cells
20613196are ignored.
20623197
2063−Headers
2064−-------
3198+## Headings
20653199
2066−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
20673201
2068−### Setext-style headers ###
3202+### Setext-style headings ###
20693203
2070−A setext-style header is a line of text "underlined" with a row of `=` signs
2071−(for a level one header) or `-` signs (for a level two header):
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
3205+(for a level-one heading) or `-` signs (for a level-two heading):
20723206
2073− A level-one header
2074− ==================
3207+ A level-one heading
3208+ ===================
20753209
2076− A level-two header
2077− ------------------
3210+ A level-two heading
3211+ -------------------
20783212
2079−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
20803214[Inline formatting], below).
20813215
20823216
2083−### ATX-style headers ###
3217+### ATX-style headings ###
20843218
2085−An ATX-style header consists of one to six `#` signs and a line of
3219+An ATX-style heading consists of one to six `#` signs and a line of
20863220text, optionally followed by any number of `#` signs. The number of
2087−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
20883222
2089− ## A level-two header
3223+ ## A level-two heading
20903224
2091− ### A level-three header ###
3225+ ### A level-three heading ###
20923226
2093−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
20943228
2095− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
20963230
20973231#### Extension: `blank_before_header` ####
20983232
2099−Standard Markdown syntax does not require a blank line before a header.
3233+Standard Markdown syntax does not require a blank line before a heading.
21003234Pandoc does require this (except, of course, at the beginning of the
21013235document). The reason for the requirement is that it is all too easy for a
21023236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -2108,29 +3242,30 @@ wrapping). Consider, for example:
21083242#### Extension: `space_in_atx_header` ####
21093243
21103244Many Markdown implementations do not require a space between the
2111−opening `#`s of an ATX header and the header text, so that
2112−`#5 bolt` and `#hashtag` count as headers. With this extension,
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
21133247pandoc does require the space.
21143248
2115−### Header identifiers ###
3249+### Heading identifiers ###
21163250
2117−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
21183253
21193254#### Extension: `header_attributes` ####
21203255
2121−Headers can be assigned attributes using this syntax at the end
2122−of the line containing the header text:
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
21233258
21243259 {#identifier .class .class key=value key=value}
21253260
2126−Thus, for example, the following headers will all be assigned the identifier
3261+Thus, for example, the following headings will all be assigned the identifier
21273262`foo`:
21283263
2129− # My header {#foo}
3264+ # My heading {#foo}
21303265
2131− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
21323267
2133− My other header {#foo}
3268+ My other heading {#foo}
21343269 ---------------
21353270
21363271(This syntax is compatible with [PHP Markdown Extra].)
@@ -2139,51 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
21393274attributes, writers generally don't use all of this information. Identifiers,
21403275classes, and key/value attributes are used in HTML and HTML-based formats such
21413276as EPUB and slidy. Identifiers are used for labels and link anchors in the
2142−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
21433278
2144−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
21453280`--number-sections` is specified. A single hyphen (`-`) in an attribute
21463281context is equivalent to `.unnumbered`, and preferable in non-English
21473282documents. So,
21483283
2149− # My header {-}
3284+ # My heading {-}
21503285
21513286is just the same as
21523287
2153− # My header {.unnumbered}
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.)
21543294
21553295#### Extension: `implicit_header_references` ####
21563296
2157−Pandoc behaves as if reference links have been defined for each header.
2158−So, to link to a header
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
21593299
2160− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
21613301
21623302you can simply write
21633303
2164− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
21653305
21663306or
21673307
2168− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
21693309
21703310or
21713311
2172− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
21733313 HTML]
21743314
21753315instead of giving the identifier explicitly:
21763316
2177− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
21783318
2179−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
21803320reference will link to the first one only, and you will need to use explicit
21813321links to link to the others, as described above.
21823322
21833323Like regular reference links, these references are case-insensitive.
21843324
21853325Explicit link reference definitions always take priority over
2186−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
21873327link will point to `bar`, not to `#foo`:
21883328
21893329 # Foo
@@ -2192,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
21923332
21933333 See [foo]
21943334
2195−Block quotations
2196−----------------
3335+## Block quotations
21973336
21983337Markdown uses email conventions for quoting blocks of text.
21993338A block quotation is one or more paragraphs or other block elements
2200−(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
22013340and an optional space. (The `>` need not start at the left margin, but
22023341it should not be indented more than three spaces.)
22033342
@@ -2232,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
22323371
22333372#### Extension: `blank_before_blockquote` ####
22343373
2235−Standard Markdown syntax does not require a blank line before a block
2236−quote. Pandoc does require this (except, of course, at the beginning of the
2237−document). The reason for the requirement is that it is all too easy for a
2238−`>` to end up at the beginning of a line by accident (perhaps through line
2239−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
22403380not produce a nested block quote in pandoc:
22413381
22423382 > This is a block quote.
22433383 >> Nested.
22443384
22453385
2246−Verbatim (code) blocks
2247−----------------------
3386+## Verbatim (code) blocks
22483387
22493388### Indented code blocks ###
22503389
@@ -2306,14 +3445,16 @@ this syntax:
23063445 qsort (filter (>= x) xs)
23073446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23083447
2309−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2310−`startFrom` is an attribute with value `100`. Some output formats can use this
2311−information to do syntax highlighting. Currently, the only output formats
2312−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2313−highlighting is supported for your output format and language, then the code
2314−block above will appear highlighted, with numbered lines. (To see which
2315−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2316−the code 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:
23173458
23183459 <pre id="mycode" class="haskell numberLines" startFrom="100">
23193460 <code>
@@ -2350,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
23503491For more information on highlighting, see [Syntax highlighting],
23513492below.
23523493
2353−Line blocks
2354−-----------
3494+## Line blocks
23553495
23563496#### Extension: `line_blocks` ####
23573497
@@ -2377,10 +3517,12 @@ line must begin with a space.
23773517 | 200 Main St.
23783518 | Berkeley, CA 94718
23793519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
23803523This syntax is borrowed from [reStructuredText].
23813524
2382−Lists
2383−-----
3525+## Lists
23843526
23853527### Bullet lists ###
23863528
@@ -2550,6 +3692,12 @@ If default list markers are desired, use `#.`:
25503692 #. two
25513693 #. three
25523694
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
25533701
25543702### Definition lists ###
25553703
@@ -2575,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
25753723A definition begins with a colon or tilde, which may be indented one
25763724or two spaces.
25773725
2578−A term may have multiple definitions, and each definition may consist of one or
2579−more block elements (paragraph, code block, list, etc.), each indented four
2580−spaces or one tab stop. The body of the definition (including the first line,
2581−aside from the colon or tilde) should be indented four spaces. However,
2582−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
25833732at the beginning of a paragraph or other block element:
25843733
25853734 Term 1
@@ -2605,9 +3754,10 @@ definition:
26053754Note that space between items in a definition list is required.
26063755(A variant that loosens this requirement, but disallows "lazy"
26073756hard wrapping, can be activated with `compact_definition_lists`: see
2608−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
26093758
2610−[^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/).
26113761
26123762### Numbered example lists ###
26133763
@@ -2643,30 +3793,6 @@ list marker. That is, example lists always behave as if the
26433793labels tend to be long, and indenting content to the
26443794first non-space character after the label would be awkward.
26453795
2646−### Compact and loose lists ###
2647−
2648−Pandoc behaves differently from `Markdown.pl` on some "edge
2649−cases" involving lists. Consider this source:
2650−
2651− + First
2652− + Second:
2653− - Fee
2654− - Fie
2655− - Foe
2656−
2657− + Third
2658−
2659−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2660−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2661−"Second" and "Third" (but not "First"), because of the blank space
2662−around "Third". Pandoc follows a simple rule: if the text is followed by
2663−a blank line, it is treated as a paragraph. Since "Second" is followed
2664−by a list, and not a blank line, it isn't treated as a paragraph. The
2665−fact that the list is followed by a blank line is irrelevant. (Note:
2666−Pandoc works this way even when the `markdown_strict` format is specified. This
2667−behavior is consistent with the official Markdown syntax description,
2668−even though it is different from that of `Markdown.pl`.)
2669−
26703796
26713797### Ending a list ###
26723798
@@ -2705,8 +3831,7 @@ of one big list:
27053831 2. dos
27063832 3. tres
27073833
2708−Horizontal rules
2709−----------------
3834+## Horizontal rules
27103835
27113836A line containing a row of three or more `*`, `-`, or `_` characters
27123837(optionally separated by spaces) produces a horizontal rule:
@@ -2716,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
27163841 ---------------
27173842
27183843
2719−Tables
2720−------
3844+## Tables
27213845
27223846Four kinds of tables may be used. The first three kinds presuppose the use of
27233847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2742,7 +3866,7 @@ Simple tables look like this:
27423866
27433867 Table: Demonstration of simple table syntax.
27443868
2745−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
27463870alignments are determined by the position of the header text relative
27473871to the dashed line below it:[^4]
27483872
@@ -2761,7 +3885,7 @@ to the dashed line below it:[^4]
27613885The table must end with a blank line, or a line of dashes followed by
27623886a blank line.
27633887
2764−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
27653889to end the table. For example:
27663890
27673891 ------- ------ ---------- -------
@@ -2770,13 +3894,13 @@ to end the table. For example:
27703894 1 1 1 1
27713895 ------- ------ ---------- -------
27723896
2773−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
27743898of the first line of the table body. So, in the tables above, the columns
27753899would be right, left, center, and right aligned, respectively.
27763900
27773901#### Extension: `multiline_tables` ####
27783902
2779−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
27803904of text (but cells that span multiple columns or rows of the table are
27813905not supported). Here is an example:
27823906
@@ -2798,7 +3922,7 @@ not supported). Here is an example:
27983922These work like simple tables, but with the following differences:
27993923
28003924 - They must begin with a row of dashes, before the header text
2801− (unless the headers are omitted).
3925+ (unless the header row is omitted).
28023926 - They must end with a row of dashes, then a blank line.
28033927 - The rows must be separated by blank lines.
28043928
@@ -2807,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
28073931the output. So, if you find that one of the columns is too narrow in the
28083932output, try widening it in the Markdown source.
28093933
2810−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:
28113935
28123936 ----------- ------- --------------- -------------------------
28133937 First row 12.0 Example of a row that
@@ -2818,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
28183942 rows.
28193943 ----------- ------- --------------- -------------------------
28203944
2821− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
28223946
28233947It is possible for a multiline table to have just one row, but the row
28243948should be followed by a blank line (and then the row of dashes that ends
@@ -2844,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
28443968omitted for a headerless table. The cells of grid tables may contain
28453969arbitrary block elements (multiple paragraphs, code blocks, lists,
28463970etc.). Cells that span multiple columns or rows are not
2847−supported. Grid tables can be created easily using [Emacs table mode].
2848−
2849−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
28503973
28513974Alignments can be specified as with pipe tables, by putting
28523975colons at the boundaries of the separator line after the
@@ -2874,7 +3997,7 @@ and the same number of rows in each column. For example, the
28743997Docutils [sample grid tables] will not render as expected with
28753998Pandoc.
28763999
2877−[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
28784001
28794002
28804003#### Extension: `pipe_tables` ####
@@ -2907,11 +4030,13 @@ legal (though ugly) pipe table:
29074030
29084031The cells of pipe tables cannot contain block elements like paragraphs
29094032and lists, and cannot span multiple lines. If a pipe table contains a
2910−row whose printable content is wider than the column width (see
2911−`--columns`), then the cell contents will wrap, with the
2912−relative cell widths determined by the widths of the separator
2913−lines. (In this case, the table will take up the full text
2914−width.) If no lines are wider than column width, then
4033+row whose Markdown content is wider than the column width (see
4034+`--columns`), then the table will take up the full text width and
4035+the cell contents will wrap, with the relative cell widths determined
4036+by the number of dashes in the line separating the table header from
4037+the table body. (For example `---|-` would make the first column 3/4
4038+and the second column 1/4 of the full text width.)
4039+On the other hand, if no lines are wider than column width, then
29154040cell contents will not be wrapped, and the cells will be sized
29164041to their contents.
29174042
@@ -2929,8 +4054,7 @@ you'll need to add colons as above.
29294054
29304055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
29314056
2932−Metadata blocks
2933−---------------
4057+## Metadata blocks
29344058
29354059#### Extension: `pandoc_title_block` ####
29364060
@@ -2946,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
29464070or all three elements. If you want to include an author but no
29474071title, or a title and a date but no author, you need a blank line:
29484072
2949− %
2950− % Author
4073+```
4074+%
4075+% Author
4076+```
29514077
2952− % My title
2953− %
2954− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
29554083
29564084The title may occupy multiple lines, but continuation lines must
29574085begin with leading space, thus:
29584086
2959− % My title
2960− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
29614091
29624092If a document has multiple authors, the authors may be put on
29634093separate lines with leading space, or separated by semicolons, or
29644094both. So, all of the following are equivalent:
29654095
2966− % Author One
2967− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
29684100
2969− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
29704104
2971− % Author One;
2972− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
29734109
29744110The date must fit on one line.
29754111
@@ -3010,7 +4146,7 @@ will also have "Version 4.0" in the header.
30104146
30114147#### Extension: `yaml_metadata_block` ####
30124148
3013−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
30144150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
30154151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
30164152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3021,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
30214157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
30224158
30234159Just be sure that the YAML file begins with `---` and ends with `---` or
3024−`...`.)
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.
30254163
30264164Metadata will be taken from the fields of the YAML object and added to any
30274165existing document metadata. Metadata can contain lists and objects (nested
30284166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
30294167with names ending in an underscore will be ignored by pandoc. (They may be
3030−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).
30314171
3032−A document may contain multiple metadata blocks. The metadata fields will
3033−be combined through a *left-biased union*: if two metadata blocks attempt
3034−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.
30354175
30364176When pandoc is used with `-t markdown` to create a Markdown document,
30374177a YAML metadata block will be produced only if the `-s/--standalone`
30384178option is used. All of the metadata will appear in a single block
30394179at the beginning of the document.
30404180
3041−Note that YAML escaping rules must be followed. Thus, for example,
3042−if a title contains a colon, it must be quoted. The pipe character
3043−(`|`) can be used to begin an indented block that will be interpreted
3044−literally, without need for escaping. This form is necessary
3045−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:
30464188
30474189 ---
30484190 title: 'This is the title: it contains a colon'
30494191 author:
30504192 - Author One
30514193 - Author Two
3052− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
30534195 abstract: |
30544196 This is the abstract.
30554197
30564198 It consists of two paragraphs.
30574199 ...
30584200
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+
30594207Template variables will be set automatically from the metadata. Thus, for
30604208example, in writing HTML, the variable `abstract` will be set to the HTML
30614209equivalent of the Markdown in the `abstract` field:
@@ -3096,13 +4244,31 @@ the [`raw_attribute` extension](#extension-raw_attribute)), or it
30964244will be interpreted as markdown. For example:
30974245
30984246 header-includes:
3099− - ```{=latex}
4247+ - |
4248+ ```{=latex}
31004249 \let\oldsection\section
31014250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
31024251 ```
31034252
3104−Backslash escapes
3105−-----------------
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
31064272
31074273#### Extension: `all_symbols_escapable` ####
31084274
@@ -3128,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
31284294(However, if the `markdown_strict` format is used, the standard Markdown rule
31294295will be used.)
31304296
3131−A backslash-escaped space is parsed as a nonbreaking space. It will
3132−appear in TeX output as `~` and in HTML and XML as `\ ` or
3133−`\ `.
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).
31344303
31354304A backslash-escaped newline (i.e. a backslash occurring at the end of
31364305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3140,8 +4309,7 @@ two trailing spaces on a line.
31404309
31414310Backslash escapes do not work in verbatim contexts.
31424311
3143−Inline formatting
3144−-----------------
4312+## Inline formatting
31454313
31464314### Emphasis ###
31474315
@@ -3189,12 +4357,13 @@ text by `~` characters. Thus, for example,
31894357
31904358 H~2~O is a liquid. 2^10^ is 1024.
31914359
3192−If the superscripted or subscripted text contains spaces, these spaces
3193−must be escaped with backslashes. (This is to prevent accidental
3194−superscripting and subscripting through the ordinary use of `~` and `^`.)
3195−Thus, if you want the letter P with 'a cat' in subscripts, use
3196−`P~a\ cat~`, not `P~a cat~`.
3197−
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~`.
31984367
31994368### Verbatim ###
32004369
@@ -3243,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
32434412This will work in all output formats that support small caps.
32444413
32454414
3246−Math
3247−----
4415+## Math
32484416
32494417#### Extension: `tex_math_dollars` ####
32504418
@@ -3256,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
32564424you need to enclose text in literal `$` characters, backslash-escape
32574425them and they won't be treated as math delimiters.
32584426
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+
32594431TeX math will be printed in all output formats. How it is rendered
32604432depends on the output format:
32614433
3262−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
3263− ~ 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}}`.
32644444
32654445reStructuredText
32664446 ~ It will be rendered using an [interpreted text role `:math:`].
32674447
32684448AsciiDoc
3269− ~ 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.
32704454
32714455Texinfo
32724456 ~ It will be rendered inside a `@math` command.
32734457
3274−groff man
4458+roff man, Jira markup
32754459 ~ It will be rendered verbatim without `$`'s.
32764460
32774461MediaWiki, DokuWiki
@@ -3305,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
33054489 command-line options selected. Therefore see [Math rendering in HTML]
33064490 above.
33074491
3308−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
33094493
3310−Raw HTML
3311−--------
4494+## Raw HTML
33124495
33134496#### Extension: `raw_html` ####
33144497
@@ -3319,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
33194502be disabled if desired.)
33204503
33214504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3322−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3323−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.
33244516
33254517#### Extension: `markdown_in_html_blocks` ####
33264518
@@ -3337,7 +4529,7 @@ Thus, for example, pandoc will turn
33374529 <table>
33384530 <tr>
33394531 <td>*one*</td>
3340− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
33414533 </tr>
33424534 </table>
33434535
@@ -3346,14 +4538,14 @@ into
33464538 <table>
33474539 <tr>
33484540 <td><em>one</em></td>
3349− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
33504542 </tr>
33514543 </table>
33524544
33534545whereas `Markdown.pl` will preserve it as is.
33544546
3355−There is one exception to this rule: text between `<script>` and
3356−`<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.
33574549
33584550This departure from standard Markdown should make it easier to mix
33594551Markdown with HTML block elements. For example, one can surround
@@ -3395,6 +4587,10 @@ Note that in LaTeX environments, like
33954587the material between the begin and end tags will be interpreted as raw
33964588LaTeX, not as Markdown.
33974589
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+
33984594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
33994595Emacs Org mode, and ConTeXt.
34004596
@@ -3405,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
34054601Inline spans and fenced code blocks with a special
34064602kind of attribute will be parsed as raw content with the
34074603designated format. For example, the following produces a raw
3408−groff `ms` block:
4604+roff `ms` block:
34094605
34104606 ```{=ms}
34114607 .MYMACRO
@@ -3415,9 +4611,24 @@ And the following produces a raw `html` inline element:
34154611
34164612 This is `<a>html</a>`{=html}
34174613
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+
34184625The format name should match the target format name (see
34194626`-t/--to`, above, for a list, or use `pandoc
3420−--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`).
34214632
34224633This extension presupposes that the relevant kind of
34234634inline code or fenced code block is enabled. Thus, for
@@ -3426,12 +4637,11 @@ example, to use a raw attribute with a backtick code block,
34264637
34274638The raw attribute cannot be combined with regular attributes.
34284639
3429−LaTeX macros
3430−------------
4640+## LaTeX macros
34314641
34324642#### Extension: `latex_macros` ####
34334643
3434−For output formats other than LaTeX, pandoc will parse LaTeX
4644+When this extension is enabled, pandoc will parse LaTeX
34354645macro definitions and apply the resulting macros to all LaTeX
34364646math and raw LaTeX. So, for example, the following will work in
34374647all output formats, not just LaTeX:
@@ -3441,18 +4651,20 @@ all output formats, not just LaTeX:
34414651 $\tuple{a, b, c}$
34424652
34434653Note that LaTeX macros will not be applied if they occur
3444−inside inside a raw span or block marked with the
4654+inside a raw span or block marked with the
34454655[`raw_attribute` extension](#extension-raw_attribute).
34464656
34474657When `latex_macros` is disabled, the raw LaTeX and math will
34484658not have macros applied. This is usually a better approach when
34494659you are targeting LaTeX or PDF.
34504660
3451−Whether or not `latex_macros` is enabled, the macro definitions
3452−will still be passed through as raw LaTeX.
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.
34534666
3454−Links
3455−-----
4667+## Links
34564668
34574669Markdown allows links to be specified in several ways.
34584670
@@ -3461,7 +4673,7 @@ Markdown allows links to be specified in several ways.
34614673If you enclose a URL or email address in pointy brackets, it
34624674will become a link:
34634675
3464− <http://google.com>
4676+ <https://google.com>
34654677 <sam@green.eggs.ham>
34664678
34674679### Inline links ###
@@ -3471,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
34714683be followed by a link title, in quotes.)
34724684
34734685 This is an [inline link](/url), and here's [one with
3474− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
34754687
34764688There can be no space between the bracketed part and the parenthesized part.
34774689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3500,7 +4712,7 @@ Here are some examples:
35004712
35014713 [my label 1]: /foo/bar.html "My title, optional"
35024714 [my label 2]: /foo
3503− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
35044716 [my label 4]: /bar#special 'A title in single quotes'
35054717
35064718The URL may optionally be surrounded by angle brackets:
@@ -3509,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
35094721
35104722The title may go on the next line:
35114723
3512− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
35134725 "The free software foundation"
35144726
35154727Note that link labels are not case sensitive. So, this will work:
@@ -3547,7 +4759,7 @@ be omitted entirely:
35474759### Internal links ###
35484760
35494761To link to another section of the same document, use the automatically
3550−generated identifier (see [Header identifiers]). For example:
4762+generated identifier (see [Heading identifiers]). For example:
35514763
35524764 See the [Introduction](#introduction).
35534765
@@ -3560,8 +4772,7 @@ or
35604772Internal links are currently supported for HTML formats (including
35614773HTML slide shows and EPUB), LaTeX, and ConTeXt.
35624774
3563−Images
3564−------
4775+## Images
35654776
35664777A link immediately preceded by a `!` will be treated as an image.
35674778The link text will be used as the image's alt text:
@@ -3607,10 +4818,11 @@ Attributes can be set on links and images:
36074818(This syntax is compatible with [PHP Markdown Extra] when only `#id`
36084819and `.class` are used.)
36094820
3610−For HTML and EPUB, all attributes except `width` and `height` (but
3611−including `srcset` and `sizes`) are passed through as is. The other
3612−writers ignore attributes that are not supported by their output
3613−format.
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.
36144826
36154827The `width` and `height` attributes on images are treated specially. When
36164828used without a unit, the unit is assumed to be pixels. However, any of
@@ -3622,24 +4834,27 @@ For example:
36224834{ width=50% }
36234835```
36244836
3625−- Dimensions are converted to inches for output in page-based formats like
3626− LaTeX. Dimensions are converted to pixels for output in HTML-like
3627− formats. Use the `--dpi` option to specify the number of pixels per
3628− inch. The default is 96dpi.
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).
36294843- The `%` unit is generally relative to some available space.
3630− For example the above example will render to
3631− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3632− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3633− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
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]`
36344850- Some output formats have a notion of a class
3635− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
36364852 or a unique identifier (LaTeX `\caption`), or both (HTML).
36374853- When no `width` or `height` attributes are specified, the fallback
36384854 is to look at the image resolution and the dpi metadata embedded in
36394855 the image file.
36404856
3641−Divs and Spans
3642−--------------
4857+## Divs and Spans
36434858
36444859Using the `native_divs` and `native_spans` extensions
36454860(see [above][Extension: `native_divs`]), HTML syntax can
@@ -3695,8 +4910,7 @@ followed immediately by attributes:
36954910
36964911 [This is *some text*]{.class key="val"}
36974912
3698−Footnotes
3699−---------
4913+## Footnotes
37004914
37014915#### Extension: `footnotes` ####
37024916
@@ -3742,45 +4956,401 @@ they cannot contain multiple paragraphs). The syntax is as follows:
37424956
37434957Inline and regular footnotes may be mixed freely.
37444958
3745−Citations
3746−---------
4959+## Citation syntax
37474960
37484961#### Extension: `citations` ####
37494962
3750−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
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` ####
5143+
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
5146+
5147+#### Extension: `four_space_rule` ####
5148+
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
5152+
5153+#### Extension: `spaced_reference_links` ####
5154+
5155+Allow whitespace between the two components of a reference link,
5156+for example,
5157+
5158+ [foo] [bar].
5159+
5160+#### Extension: `hard_line_breaks` ####
5161+
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
5164+
5165+#### Extension: `ignore_line_breaks` ####
5166+
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.
5171+
5172+#### Extension: `east_asian_line_breaks` ####
5173+
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.
5179+
5180+#### Extension: `emoji` ####
5181+
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
5183+
5184+#### Extension: `tex_math_single_backslash` ####
5185+
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 `[`.
5190+
5191+#### Extension: `tex_math_double_backslash` ####
5192+
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.
5196+
5197+#### Extension: `markdown_attribute` ####
5198+
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`.
5202+
5203+#### Extension: `mmd_title_block` ####
5204+
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
5207+
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.
5213+
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`.
5217+
5218+#### Extension: `abbreviations` ####
5219+
5220+Parses PHP Markdown Extra abbreviation keys, like
5221+
5222+ *[HTML]: Hypertext Markup Language
5223+
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).
5227+
5228+#### Extension: `autolink_bare_uris` ####
5229+
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
5232+
5233+#### Extension: `mmd_link_attributes` ####
5234+
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.
5238+
5239+ This is a reference ![image][ref] with multimarkdown attributes.
5240+
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
5243+
5244+#### Extension: `mmd_header_identifiers` ####
5245+
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
5248+
5249+#### Extension: `compact_definition_lists` ####
5250+
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:
5254+
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]
5262+
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
5265+
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
5270+
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.
5275+
5276+#### Extension: `gutenberg` ####
5277+
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.
5281+
5282+ [Project Gutenberg]: https://www.gutenberg.org
5283+
5284+#### Extension: `sourcepos` ####
5285+
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.
5290+
5291+## Markdown variants
5292+
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
5295+
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)
5303+
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
5306+
5307+ pandoc --list-extensions=FORMAT
5308+
5309+where `FORMAT` is replaced with the name of the format.
5310+
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.
5316+
5317+# Citations
5318+
5319+When the `--citeproc` option is used, pandoc can automatically generate
37515320citations and a bibliography in a number of styles. Basic usage is
37525321
3753− pandoc --filter pandoc-citeproc myinput.txt
5322+ pandoc --citeproc myinput.txt
5323+
5324+To use this feature, you will need to have
5325+
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
5330+
5331+## Specifying bibliographic data
37545332
3755−In order to use this feature, you will need to specify a bibliography file
3756−using the `bibliography` metadata field in a YAML metadata section, or
3757−`--bibliography` command line argument. You can supply multiple `--bibliography`
3758−arguments or set `bibliography` metadata field to YAML array, if you want to
3759−use multiple bibliography files. The bibliography may have any of these
3760−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:
37615339
37625340 Format File extension
37635341 ------------ --------------
37645342 BibLaTeX .bib
37655343 BibTeX .bibtex
3766− Copac .copac
37675344 CSL JSON .json
37685345 CSL YAML .yaml
3769− EndNote .enl
3770− EndNote XML .xml
3771− ISI .wos
3772− MEDLINE .medline
3773− MODS .mods
3774− RIS .ris
37755346
37765347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3777−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
37785349
3779−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3780−can produce `.json` and `.yaml` files from any of the supported formats.
3781−
3782−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3783−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]:
37845354
37855355`<i>...</i>`
37865356: italics
@@ -3800,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
38005370`<span class="nocase">...</span>`
38015371: prevent a phrase from being capitalized as title case
38025372
3803−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3804−and CSL YAML formats as far as possible.
3805−
3806−As an alternative to specifying a bibliography file using `--bibliography`
3807−or the YAML metadata field `bibliography`, you can include
3808−the citation data directly in the `references` field of the
3809−document's YAML metadata. The field should contain an array of
3810−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:
38115378
38125379 ---
38135380 references:
@@ -3823,322 +5390,273 @@ YAML-encoded references, for example:
38235390 - - 1953
38245391 - 4
38255392 - 25
3826− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3827− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
38285395 title-short: Molecular structure of nucleic acids
38295396 container-title: Nature
38305397 volume: 171
38315398 issue: 4356
38325399 page: 737-738
38335400 DOI: 10.1038/171737a0
3834− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
38355402 language: en-GB
38365403 ...
38375404
3838−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3839−of the supported formats.)
3840−
3841−Citations and references can be formatted using any style supported by the
3842−[Citation Style Language], listed in the [Zotero Style Repository].
3843−These files are specified using the `--csl` option or the `csl` metadata field.
3844−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3845−format. The CSL project provides further information on [finding and editing styles].
3846−
3847−To make your citations hyperlinks to the corresponding bibliography
3848−entries, add `link-citations: true` to your YAML metadata.
3849−
3850−Citations go inside square brackets and are separated by semicolons.
3851−Each citation must have a key, composed of '@' + the citation
3852−identifier from the database, and may optionally have a prefix,
3853−a locator, and a suffix. The citation key must begin with a letter, digit,
3854−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3855−characters (`:.#$%&-+?<>~/`). Here are some examples:
3856−
3857− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3858−
3859− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3860−
3861− Blah blah [@smith04; @doe99].
3862−
3863−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3864−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3865−locale, locator terms can be written in either singular or plural forms,
3866−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3867−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3868−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3869−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3870−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3871−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3872−locator term is used, "page" is assumed.
3873−
3874−A minus sign (`-`) before the `@` will suppress mention of
3875−the author in the citation. This can be useful when the
3876−author is already mentioned in the text:
3877−
3878− Smith says blah [-@smith04].
3879−
3880−You can also write an in-text citation, as follows:
3881−
3882− @smith04 says blah.
3883−
3884− @smith04 [p. 33] says blah.
3885−
3886−If the style calls for a list of works cited, it will be placed
3887−at the end of the document. Normally, you will want to end your
3888−document with an appropriate header:
3889−
3890− last paragraph...
3891−
3892− # References
3893−
3894−The bibliography will be inserted after this header. Note that
3895−the `unnumbered` class will be added to this header, so that the
3896−section will not be numbered.
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.
38975408
3898−If you want to include items in the bibliography without actually
3899−citing them in the body text, you can define a dummy `nocite` metadata
3900−field and put the citations there:
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
39015411
3902− ---
3903− nocite: |
3904− @item1, @item2
3905− ...
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
39065414
3907− @item3
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
39085417
3909−In this example, the document will contain a citation for `item3`
3910−only, but the bibliography will contain entries for `item1`, `item2`, and
3911−`item3`.
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
39125420
3913−It is possible to create a bibliography with all the citations,
3914−whether or not they appear in the document, by using a wildcard:
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
39155424
3916− ---
3917− nocite: |
3918− @*
3919− ...
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
39205427
3921−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3922−to render bibliography. In order to do so, specify bibliography files as
3923−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3924−invocation. Bear in mind that bibliography files have to be in respective
3925−format (either BibTeX or BibLaTeX).
5428+### Capitalization in titles
39265429
3927−For more information, see the [pandoc-citeproc man page].
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
39285432
3929−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3930−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3931−[Citation Style Language]: http://citationstyles.org
3932−[Zotero Style Repository]: https://www.zotero.org/styles
3933−[finding and editing styles]: http://citationstyles.org/styles/
3934−[CSL locale files]: https://github.com/citation-style-language/locales
3935−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
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`.)
39365438
3937−Non-pandoc extensions
3938−---------------------
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:
39395442
3940−The following Markdown syntax extensions are not enabled by default
3941−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3942−name, where `EXTENSION` is the name of the extension. Thus, for
3943−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5443+ title = {My Dinner with {Andre}}
39445444
3945−#### Extension: `old_dashes` ####
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
39465447
3947−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3948−`-` before a numeral is an en-dash, and `--` is an em-dash.
3949−This option only has an effect if `smart` is enabled. It is
3950−selected automatically for `textile` input.
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
39515449
3952−#### Extension: `angle_brackets_escapable` ####
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.
39535454
3954−Allow `<` and `>` to be backslash-escaped, as they can be in
3955−GitHub flavored Markdown but not original Markdown. This is
3956−implied by pandoc's default `all_symbols_escapable`.
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
39575457
3958−#### Extension: `lists_without_preceding_blankline` ####
5458+ - All titles should be in sentence case.
39595459
3960−Allow a list to occur right after a paragraph, with no intervening
3961−blank space.
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.)
39625463
3963−#### Extension: `four_space_rule` ####
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
39645466
3965−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3966−four spaces indent are needed for list item continuation
3967−paragraphs.
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
39685468
3969−#### Extension: `spaced_reference_links` ####
5469+### Conference Papers, Published vs. Unpublished
39705470
3971−Allow whitespace between the two components of a reference link,
3972−for example,
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
39735473
3974− [foo] [bar].
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`).
39755477
3976−#### Extension: `hard_line_breaks` ####
5478+For a talk, an unpublished conference paper, or a poster
5479+presentation, use the biblatex entry type `unpublished` with an
5480+`eventtitle` field (this entry type will be mapped to CSL
5481+`speech`). Use the biblatex `type` field to indicate the type,
5482+e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5483+too, though `eventdate` will not be rendered by most CSL styles.
5484+Note that `venue` is for the event's venue, unlike `location`
5485+which describes the publisher's location; do not use the latter
5486+for an unpublished conference paper.
39775487
3978−Causes all newlines within a paragraph to be interpreted as hard line
3979−breaks instead of spaces.
39805488
3981−#### Extension: `ignore_line_breaks` ####
5489+## Specifying a citation style
39825490
3983−Causes newlines within a paragraph to be ignored, rather than being
3984−treated as spaces or as hard line breaks. This option is intended for
3985−use with East Asian languages where spaces are not used between words,
3986−but text is divided into lines for readability.
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:
39875507
3988−#### Extension: `east_asian_line_breaks` ####
39895508
3990−Causes newlines within a paragraph to be ignored, rather than
3991−being treated as spaces or as hard line breaks, when they occur
3992−between two East Asian wide characters. This is a better choice
3993−than `ignore_line_breaks` for texts that include a mix of East
3994−Asian wide characters and other characters.
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+ }
39955517
3996−#### Extension: `emoji` ####
39975518
3998−Parses textual emojis like `:smile:` as Unicode emoticons.
5519+## Citations in note styles
39995520
4000−#### Extension: `tex_math_single_backslash` ####
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,
40015527
4002−Causes anything between `\(` and `\)` to be interpreted as inline
4003−TeX math, and anything between `\[` and `\]` to be interpreted
4004−as display TeX math. Note: a drawback of this extension is that
4005−it precludes escaping `(` and `[`.
5528+ Blah blah [@foo, p. 33].
40065529
4007−#### Extension: `tex_math_double_backslash` ####
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].
40085535
4009−Causes anything between `\\(` and `\\)` to be interpreted as inline
4010−TeX math, and anything between `\\[` and `\\]` to be interpreted
4011−as display TeX math.
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:
40125541
4013−#### Extension: `markdown_attribute` ####
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].
40145545
4015−By default, pandoc interprets material inside block-level tags as Markdown.
4016−This extension changes the behavior so that Markdown is only parsed
4017−inside block-level tags if the tags have the attribute `markdown=1`.
5546+## Raw content in a style
40185547
4019−#### Extension: `mmd_title_block` ####
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
40205550
4021−Enables a [MultiMarkdown] style title block at the top of
4022−the document, for example:
5551+ {{jats}}<ref>{{/jats}}
40235552
4024− Title: My title
4025− Author: John Doe
4026− Date: September 1, 2008
4027− Comment: This is a sample mmd title block, with
4028− a field spanning multiple lines.
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
40295555
4030−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4031−`yaml_metadata_block` is enabled, it will take precedence over
4032−`mmd_title_block`.
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.
40335560
4034−#### Extension: `abbreviations` ####
40355561
4036−Parses PHP Markdown Extra abbreviation keys, like
40375562
4038− *[HTML]: Hypertext Markup Language
5563+## Placement of the bibliography
40395564
4040−Note that the pandoc document model does not support
4041−abbreviations, so if this extension is enabled, abbreviation keys are
4042−simply skipped (as opposed to being parsed as paragraphs).
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:
40435567
4044−#### Extension: `autolink_bare_uris` ####
5568+ ::: {#refs}
5569+ :::
40455570
4046−Makes all absolute URIs into links, even when not surrounded by
4047−pointy braces `<...>`.
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.
40485574
4049−#### Extension: `mmd_link_attributes` ####
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:
40505579
4051−Parses multimarkdown style key-value attributes on link
4052−and image references. This extension should not be confused with the
4053−[`link_attributes`](#extension-link_attributes) extension.
5580+ last paragraph...
40545581
4055− This is a reference ![image][ref] with multimarkdown attributes.
5582+ # References
40565583
4057− [ref]: http://path.to/image "Image title" width=20px height=30px
4058− id=myId class="myClass1 myClass2"
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.
40595587
4060−#### Extension: `mmd_header_identifiers` ####
5588+## Including uncited items in the bibliography
40615589
4062−Parses multimarkdown style header identifiers (in square brackets,
4063−after the header but before any trailing `#`s in an ATX header).
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:
40645593
4065−#### Extension: `compact_definition_lists` ####
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
40665598
4067−Activates the definition list syntax of pandoc 1.12.x and earlier.
4068−This syntax differs from the one described above under [Definition lists]
4069−in several respects:
5599+ @item3
40705600
4071− - No blank line is required between consecutive items of the
4072− definition list.
4073− - To get a "tight" or "compact" list, omit space between consecutive
4074− items; the space between a term and its definition does not affect
4075− anything.
4076− - Lazy wrapping of paragraphs is not allowed: the entire definition must
4077− be indented four spaces.[^6]
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`.
40785604
4079−[^6]: To see why laziness is incompatible with relaxing the requirement
4080− of a blank line between items, consider the following example:
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:
40815607
4082− bar
4083− : definition
4084− foo
4085− : definition
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
40865612
4087− Is this a single list item with two definitions of "bar," the first of
4088− which is lazily wrapped, or two list items? To remove the ambiguity
4089− we must either disallow lazy wrapping or require a blank line between
4090− list items.
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.
40915619
4092−Markdown variants
4093−-----------------
5620+## Other relevant metadata fields
40945621
4095−In addition to pandoc's extended Markdown, the following Markdown
4096−variants are supported:
5622+A few other metadata fields affect bibliography formatting:
40975623
4098−`markdown_phpextra` (PHP Markdown Extra)
4099−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4100− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4101− `header_attributes`, `link_attributes`, `abbreviations`,
4102− `shortcut_reference_links`, `spaced_reference_links`.
4103−
4104−`markdown_github` (deprecated GitHub-Flavored Markdown)
4105−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4106− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4107− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
4108− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
4109− `lists_without_preceding_blankline`.
4110−
4111−`markdown_mmd` (MultiMarkdown)
4112−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4113− `tex_math_double_backslash`, `intraword_underscores`,
4114− `mmd_title_block`, `footnotes`, `definition_lists`,
4115− `all_symbols_escapable`, `implicit_header_references`,
4116− `auto_identifiers`, `mmd_header_identifiers`,
4117− `shortcut_reference_links`, `implicit_figures`,
4118− `superscript`, `subscript`, `backtick_code_blocks`,
4119− `spaced_reference_links`, `raw_attribute`.
4120−
4121−`markdown_strict` (Markdown.pl)
4122−: `raw_html`, `shortcut_reference_links`,
4123− `spaced_reference_links`.
4124−
4125−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4126−which is implemented as a set of extensions on `commonmark`).
4127−
4128−Note, however, that `commonmark` and `gfm` have limited support
4129−for extensions. Only those listed below (and `smart` and
4130−`raw_tex`) will work. The extensions can, however, all be
4131−individually disabled.
4132−Also, `raw_tex` only affects `gfm` output, not input.
4133−
4134−`gfm` (GitHub-Flavored Markdown)
4135−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4136− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4137− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4138− `shortcut_reference_links`, `angle_brackets_escapable`.
4139−
4140−Producing slide shows with pandoc
4141−=================================
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
41425660
41435661You can use pandoc to produce an HTML + JavaScript slide presentation
41445662that can be viewed via a web browser. There are five ways to do this,
@@ -4186,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
41865704
41875705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
41885706
4189−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4190−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4191−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4192−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4193−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4194−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4195−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4196−the file by default.
4197−
4198−With all HTML slide formats, the `--self-contained` option can be used to
4199−produce a single file that contains all of the data necessary to display the
4200−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.
42015722
42025723To produce a PDF slide show using beamer, type
42035724
@@ -4210,14 +5731,13 @@ To produce a Powerpoint slide show, type
42105731
42115732 pandoc habits.txt -o habits.pptx
42125733
4213−Structuring the slide show
4214−--------------------------
5734+## Structuring the slide show
42155735
4216−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
42175737the hierarchy that is followed immediately by content, and not another
4218−header, somewhere in the document. In the example above, level 1 headers
4219−are always followed by level 2 headers, which are followed by content,
4220−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
42215741the `--slide-level` option.
42225742
42235743The document is carved up into slides according to the following
@@ -4225,17 +5745,21 @@ rules:
42255745
42265746 * A horizontal rule always starts a new slide.
42275747
4228− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
42295749
4230− * Headers *below* the slide level in the hierarchy create
4231− 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.)
42325756
4233− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
42345758 "title slides," which just contain the section title
42355759 and help to break the slide show into sections.
4236−
4237− * Content *above* the slide level will not appear in the slide
4238− 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).
42395763
42405764 * A title page is constructed automatically from the document's title
42415765 block, if present. (In the case of beamer, this can be disabled
@@ -4243,17 +5767,16 @@ rules:
42435767
42445768These rules are designed to support many different styles of slide show. If
42455769you don't care about structuring your slides into sections and subsections,
4246−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
42475771will be the slide level.) But you can also structure the slide show into
42485772sections, as in the example above.
42495773
42505774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4251−layout will be produced, with level 1 headers building horizontally
4252−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
42535777you use deeper nesting of section levels with reveal.js.
42545778
4255−Incremental lists
4256−-----------------
5779+## Incremental lists
42575780
42585781By default, these writers produce lists that display "all at once."
42595782If you want your lists to display incrementally (one item at a time),
@@ -4291,8 +5814,10 @@ option):
42915814Both methods allow incremental and nonincremental lists to be mixed
42925815in a single document.
42935816
4294−Inserting pauses
4295−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
42965821
42975822You can add "pauses" within a slide by including a paragraph containing
42985823three dots, separated by spaces:
@@ -4305,8 +5830,9 @@ three dots, separated by spaces:
43055830
43065831 content after the pause
43075832
4308−Styling the slides
4309−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
43105836
43115837You can change the style of HTML slides by putting customized CSS files
43125838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4331,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
43315857
43325858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
43335859
4334−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
43355861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4336−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
43375863that affects slides is the `allowframebreaks` class, which sets the
43385864`allowframebreaks` option, causing multiple slides to be created
43395865if the content overfills the frame. This is recommended especially for
@@ -4341,8 +5867,7 @@ bibliographies:
43415867
43425868 # References {.allowframebreaks}
43435869
4344−Speaker notes
4345−-------------
5870+## Speaker notes
43465871
43475872Speaker notes are supported in reveal.js and PowerPoint (pptx)
43485873output. You can add notes to your Markdown document thus:
@@ -4363,8 +5888,7 @@ in handouts and presenter view.
43635888Notes are not yet supported for other slide formats, but the notes
43645889will not appear on the slides themselves.
43655890
4366−Columns
4367−-------
5891+## Columns
43685892
43695893To put material in side by side columns, you can use a native
43705894div container with class `columns`, containing two or more div
@@ -4379,12 +5903,46 @@ containers with class `column` and a `width` attribute:
43795903 :::
43805904 ::::::::::::::
43815905
4382−Frame attributes in beamer
4383−--------------------------
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
43845942
43855943Sometimes it is necessary to add the LaTeX `[fragile]` option to
43865944a frame in beamer (for example, when using the `minted` environment).
4387−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
43885946introducing the slide:
43895947
43905948 # Fragile slide {.fragile}
@@ -4392,41 +5950,50 @@ introducing the slide:
43925950All of the other frame attributes described in Section 8.1 of
43935951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
43945952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4395−`shrink`.
5953+`shrink`, `standout`, `noframenumbering`.
43965954
4397−Background in reveal.js
4398−-----------------------
5955+## Background in reveal.js and beamer
43995956
4400−Background images can be added to self-contained reveal.js slideshows.
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
44015959
4402−For the same image on every slide, use the reveal.js configuration
4403−option `parallaxBackgroundImage` either in the YAML metadata block
4404−or as a command-line variable. You can also set
4405−`parallaxBackgroundHorizontal` and `parallaxBackgroundVertical` the same
4406−way and must also set `parallaxBackgroundSize` to have your values
4407−take effect.
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.)
44085964
4409−To set an image for a particular slide, add
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
44105971`{data-background-image="/path/to/image"}`
4411−to the first slide-level header on the slide (which may even be empty).
5972+to the first slide-level heading on the slide (which may even be empty).
44125973
44135974In reveal.js's overview mode, the parallaxBackgroundImage will show up
44145975only on the first slide.
44155976
4416−Other background settings also work on individual slides, including
5977+Other reveal.js background settings also work on individual slides, including
44175978`data-background-size`, `data-background-repeat`, `data-background-color`,
44185979`data-transition`, and `data-transition-speed`.
44195980
4420−See the [reveal.js
4421−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4422−for more details.
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.
44235984
4424−For example:
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986+details.
5987+
5988+For example in reveal.js:
44255989
44265990```
44275991---
44285992title: My Slideshow
44295993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
44305997---
44315998
44325999## Slide One
@@ -4435,14 +6002,12 @@ Slide 1 has background_image.png as its background.
44356002
44366003## {data-background-image="/path/to/special_image.jpg"}
44376004
4438−Slide 2 has a special image for its background, even though the header has no content.
6005+Slide 2 has a special image for its background, even though the heading has no content.
44396006```
44406007
4441−Creating EPUBs with pandoc
4442−==========================
6008+# EPUBs
44436009
4444−EPUB Metadata
4445−-------------
6010+## EPUB Metadata
44466011
44476012EPUB metadata may be specified using the `--epub-metadata` option, but
44486013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4520,11 +6085,20 @@ The following fields are recognized:
45206085
45216086`rights`
45226087 ~ 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.
45236097
45246098`cover-image`
45256099 ~ A string value (path to cover image).
45266100
4527−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
45286102 ~ A string value (path to CSS stylesheet).
45296103
45306104`page-progression-direction`
@@ -4541,32 +6115,200 @@ The following fields are recognized:
45416115 - `binding`: `true`|`false` (default `true`)
45426116 - `scroll-axis`: `vertical`|`horizontal`|`default`
45436117
4544−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
45456119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
45466120
4547−Linked media
4548−------------
4549−
4550−By default, pandoc will download linked media (including audio and
4551−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
45526170self-contained EPUB. If you want to link to external media resources
45536171instead, use raw HTML in your source and add `data-external="1"` to the tag
45546172with the `src` attribute. For example:
45556173
45566174 <audio controls="1">
4557− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
45586176 data-external="1" type="audio/mpeg">
45596177 </source>
45606178 </audio>
45616179
4562−Syntax highlighting
4563−===================
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+```
6219+
6220+## Pyout
6221+
6222+``` code
6223+from IPython.display import HTML
6224+HTML("""
6225+<script>
6226+console.log("hello");
6227+</script>
6228+<b>HTML</b>
6229+""")
6230+```
6231+
6232+## Image
6233+
6234+This image  will be
6235+included as a cell attachment.
6236+````
6237+
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:
6243+
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
6247+
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
6251+
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
6256+
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+```
6274+
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
45646306
45656307Pandoc will automatically highlight syntax in [fenced code blocks] that
45666308are marked with a language name. The Haskell library [skylighting] is
4567−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4568−To see a list of language names that pandoc will recognize, type
4569−`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`.
45706312
45716313The color scheme can be selected using the `--highlight-style` option.
45726314The default color scheme is `pygments`, which imitates the default color
@@ -4574,15 +6316,80 @@ scheme used by the Python library pygments (though pygments is not actually
45746316used to do the highlighting). To see a list of highlight styles,
45756317type `pandoc --list-highlight-styles`.
45766318
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+
45776337To disable highlighting, use the `--no-highlight` option.
45786338
45796339[skylighting]: https://github.com/jgm/skylighting
45806340
4581−Custom Styles in Docx
4582−=====================
6341+# Custom Styles
6342+
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
6349+formatting (italics, bold) for inlines. This will work for most
6350+purposes, especially alongside a `reference.docx` file. However, if you
6351+need to apply your own styles to blocks, or match a preexisting set of
6352+styles, pandoc allows you to define custom styles for blocks and text
6353+using `div`s and `span`s, respectively.
6354+
6355+If you define a `div` or `span` with the attribute `custom-style`,
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,
6360+
6361+ [Get out]{custom-style="Emphatically"}, he said.
6362+
6363+would produce a docx file with "Get out" styled with character
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6365+
6366+ Dickinson starts the poem simply:
6367+
6368+ ::: {custom-style="Poetry"}
6369+ | A Bird came down the Walk---
6370+ | He did not know I saw---
6371+ :::
6372+
6373+would style the two contained lines with the `Poetry` paragraph style.
6374+
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.
6378+
6379+This feature allows for greatest customization in conjunction with
6380+[pandoc filters]. If you want all paragraphs after block quotes to be
6381+indented, you can write a filter to apply the styles necessary. If you
6382+want all italics to be transformed to the `Emphasis` character style
6383+(perhaps to change their color), you can write a filter which will
6384+transform all italicized inlines to inlines within an `Emphasis`
6385+custom-style `span`.
6386+
6387+For docx output, you don't need to enable any extensions for
6388+custom styles to work.
45836389
4584−Input
4585−-----
6390+[pandoc filters]: https://pandoc.org/filters.html
6391+
6392+## Input
45866393
45876394The docx reader, by default, only reads those styles that it can
45886395convert into pandoc elements, either by direct conversion or
@@ -4611,17 +6418,17 @@ And with the extension:
46116418
46126419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
46136420
4614− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
46156422 This is some text.
46166423 :::
46176424
4618− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
46196426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
46206427 And this is text with a [strengthened]{custom-style="Strengthened"}
46216428 text style.
46226429 :::
46236430
4624− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
46256432 > Here is a styled paragraph that inherits from Block Text.
46266433 :::
46276434
@@ -4629,75 +6436,85 @@ With these custom styles, you can use your input document as a
46296436reference-doc while creating docx output (see below), and maintain the
46306437same styles in your input and output files.
46316438
4632−Output
4633−------
4634−
4635−By default, pandoc's docx output applies a predefined set of styles for
4636−blocks such as paragraphs and block quotes, and uses largely default
4637−formatting (italics, bold) for inlines. This will work for most
4638−purposes, especially alongside a `reference.docx` file. However, if you
4639−need to apply your own styles to blocks, or match a preexisting set of
4640−styles, pandoc allows you to define custom styles for blocks and text
4641−using `div`s and `span`s, respectively.
4642−
4643−If you define a `div` or `span` with the attribute `custom-style`,
4644−pandoc will apply your specified style to the contained elements. So,
4645−for example using the `bracketed_spans` syntax,
4646−
4647− [Get out]{custom-style="Emphatically"}, he said.
4648−
4649−would produce a docx file with "Get out" styled with character
4650−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4651−
4652− Dickinson starts the poem simply:
4653−
4654− ::: {custom-style="Poetry"}
4655− | A Bird came down the Walk---
4656− | He did not know I saw---
4657− :::
4658−
4659−would style the two contained lines with the `Poetry` paragraph style.
4660−
4661−If the styles are not yet in your reference.docx, they will be defined
4662−in the output file as inheriting from normal text. If they are already
4663−defined, pandoc will not alter the definition.
4664−
4665−This feature allows for greatest customization in conjunction with
4666−[pandoc filters]. If you want all paragraphs after block quotes to be
4667−indented, you can write a filter to apply the styles necessary. If you
4668−want all italics to be transformed to the `Emphasis` character style
4669−(perhaps to change their color), you can write a filter which will
4670−transform all italicized inlines to inlines within an `Emphasis`
4671−custom-style `span`.
4672−
4673−[pandoc filters]: http://pandoc.org/filters.html
4674−
4675−Custom writers
4676−==============
6439+# Custom writers
46776440
4678−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4679−includes a lua interpreter, so lua need not be installed separately.)
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
46806443
4681−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
46826445in place of the output format. For example:
46836446
46846447 pandoc -t data/sample.lua
46856448
4686−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
46876450possible element in a pandoc document. To get a documented example
46886451which you can modify according to your needs, do
46896452
46906453 pandoc --print-default-data-file sample.lua
46916454
4692−[lua]: http://www.lua.org
4693−
4694−Authors
4695−=======
4696−
4697−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
46986514under the [GPL], version 2 or greater. This software carries no
46996515warranty of any kind. (See COPYRIGHT for full copyright and
47006516warranty notices.) For a full list of contributors, see the file
47016517AUTHORS.md in the pandoc source code.
47026518
4703−[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"