@@ -1,31 +1,49 @@
1−---
2−title: Pandoc User's Guide
3−author: John MacFarlane
4−date: June 20, 2021
5−---
1+% Pandoc User's Guide
2+% John MacFarlane
3+% January 7, 2018
64
7−# Synopsis
5+Synopsis
6+========
87
98`pandoc` [*options*] [*input-file*]...
109
11−# Description
10+Description
11+===========
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 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.
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.
2135
2236Pandoc's enhanced version of Markdown includes syntax for [tables],
23−[definition lists], [metadata blocks], [footnotes], [citations], [math],
24−and much more. See below under [Pandoc's Markdown].
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.
2543
2644Pandoc has a modular design: it consists of a set of readers, which parse
2745text in a given format and produce a native representation of the document
28−(an _abstract syntax tree_ or AST), and a set of writers, which convert
46+(like an _abstract syntax tree_ or AST), and a set of writers, which convert
2947this native representation into a target format. Thus, adding an input
3048or output format requires only adding a reader or writer. Users can also
3149run custom [pandoc filters] to modify the intermediate AST.
@@ -40,7 +58,58 @@ model. While conversions from pandoc's Markdown to all formats aspire
4058to be perfect, conversions from formats more expressive than pandoc's
4159Markdown can be expected to be lossy.
4260
43−## Using pandoc
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+--------------
44113
45114If no *input-files* are specified, input is read from *stdin*.
46115Output goes to *stdout* by default. For output to a file,
@@ -61,7 +130,8 @@ If multiple input files are given, `pandoc` will concatenate them all (with
61130blank lines between them) before parsing. (Use `--file-scope` to parse files
62131individually.)
63132
64−## Specifying formats
133+Specifying formats
134+------------------
65135
66136The format of the input and output can be specified explicitly using
67137command-line options. The input format can be specified using the
@@ -93,7 +163,8 @@ If no input file is specified (so that input comes from *stdin*), or
93163if the input files' extensions are unknown, the input format will
94164be assumed to be Markdown.
95165
96−## Character encoding
166+Character encoding
167+------------------
97168
98169Pandoc uses the UTF-8 character encoding for both input and output.
99170If your local character encoding is not UTF-8, you
@@ -106,9 +177,10 @@ RTF, OPML, DocBook, and Texinfo), information about
106177the character encoding is included in the document header, which
107178will only be included if you use the `-s/--standalone` option.
108179
109−[`iconv`]: https://www.gnu.org/software/libiconv/
180+[`iconv`]: http://www.gnu.org/software/libiconv/
110181
111−## Creating a PDF
182+Creating a PDF
183+--------------
112184
113185To produce a PDF, specify an output file with a `.pdf` extension:
114186
@@ -116,18 +188,20 @@ To produce a PDF, specify an output file with a `.pdf` extension:
116188
117189By default, pandoc will use LaTeX to create the PDF, which requires
118190that a LaTeX engine be installed (see `--pdf-engine` below).
119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120−intermediate format. To do this, specify an output file with a
121−`.pdf` extension, as before, but add the `--pdf-engine` option
122−or `-t context`, `-t html`, or `-t ms` to the command line.
123−The tool used to generate the PDF from the intermediate format
124−may be specified using `--pdf-engine`.
125−
126−You can control the PDF style using variables, depending on
127−the intermediate format used: see [variables for LaTeX],
128−[variables for ConTeXt], [variables for `wkhtmltopdf`],
129−[variables for ms]. When HTML is used as an intermediate
130−format, the output can be styled using `--css`.
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`, and `papersize`
204+will affect the output.
131205
132206To debug the PDF creation, it can be useful to look at the intermediate
133207representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -136,137 +210,93 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136210When using LaTeX, the following packages need to be available
137211(they are included with all recent versions of [TeX Live]):
138212[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`iftex`], [`listings`] (if the
213+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140214`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
142−contains images), [`hyperref`], [`xcolor`],
215+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
216+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),
143217[`ulem`], [`geometry`] (with the `geometry` variable set),
144218[`setspace`] (with `linestretch`), and
145219[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
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/
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+
165230[`amsfonts`]: https://ctan.org/pkg/amsfonts
166231[`amsmath`]: https://ctan.org/pkg/amsmath
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
173−[`booktabs`]: https://ctan.org/pkg/booktabs
174−[`csquotes`]: https://ctan.org/pkg/csquotes
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
175236[`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
237+[`longtable`]: https://ctan.org/pkg/longtable
238+[`booktabs`]: https://ctan.org/pkg/booktabs
180239[`graphicx`]: https://ctan.org/pkg/graphicx
181240[`grffile`]: https://ctan.org/pkg/grffile
182−[`hyperref`]: https://ctan.org/pkg/hyperref
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
187−[`mathspec`]: https://ctan.org/pkg/mathspec
188−[`microtype`]: https://ctan.org/pkg/microtype
189−[`natbib`]: https://ctan.org/pkg/natbib
190−[`parskip`]: https://ctan.org/pkg/parskip
191−[`polyglossia`]: https://ctan.org/pkg/polyglossia
192−[`prince`]: https://www.princexml.com/
241+[`geometry`]: https://ctan.org/pkg/geometry
193242[`setspace`]: https://ctan.org/pkg/setspace
243+[`xecjk`]: https://ctan.org/pkg/xecjk
244+[`hyperref`]: https://ctan.org/pkg/hyperref
194245[`ulem`]: https://ctan.org/pkg/ulem
246+[`babel`]: https://ctan.org/pkg/babel
247+[`bidi`]: https://ctan.org/pkg/bidi
248+[`mathspec`]: https://ctan.org/pkg/mathspec
195249[`unicode-math`]: https://ctan.org/pkg/unicode-math
250+[`polyglossia`]: https://ctan.org/pkg/polyglossia
251+[`fontspec`]: https://ctan.org/pkg/fontspec
196252[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
253+[`microtype`]: https://ctan.org/pkg/microtype
254+[`csquotes`]: https://ctan.org/pkg/csquotes
255+[`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/
198260[`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−
261+[`weasyprint`]: http://weasyprint.org
262+[`prince`]: https://www.princexml.com/
205263
206−## Reading from the Web
264+Reading from the Web
265+--------------------
207266
208−Instead of an input file, an absolute URI may be given. In this case
267+Instead of an input file, an absolute URI may be given. In this case
209268pandoc will fetch the content using HTTP:
210269
211− pandoc -f html -t markdown https://www.fsf.org
270+ pandoc -f html -t markdown http://www.fsf.org
212271
213272It is possible to supply a custom User-Agent string or other
214273header when requesting a document from a URL:
215274
216275 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217− https://www.fsf.org
276+ http://www.fsf.org
218277
219−# Options
278+Options
279+=======
220280
221−## General options {.options}
281+General options
282+---------------
222283
223284`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224285
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−
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`.)
270300 Extensions can be individually enabled or disabled by
271301 appending `+EXTENSION` or `-EXTENSION` to the format name.
272302 See [Extensions] below, for a list of extensions and
@@ -275,75 +305,34 @@ header when requesting a document from a URL:
275305
276306`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
277307
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
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
347336 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348337 name. See [Extensions] below, for a list of extensions and their
349338 names. See `--list-output-formats` and `--list-extensions`, below.
@@ -358,43 +347,35 @@ header when requesting a document from a URL:
358347
359348: Specify the user data directory to search for pandoc data files.
360349 If this option is not specified, the default user data directory
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`.
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+
368362 You can find the default user data directory on your system by
369363 looking at the output of `pandoc --version`.
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.
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.
387367
388368`--bash-completion`
389369
390370: Generate a bash completion script. To enable bash completion
391371 with pandoc, add this to your `.bashrc`:
392372
393− eval "$(pandoc --bash-completion)"
373+ eval "$(pandoc --bash-completion)"
394374
395375`--verbose`
396376
397−: Give verbose debugging output.
377+: Give verbose debugging output. Currently this only has an effect
378+ with PDF output.
398379
399380`--quiet`
400381
@@ -420,7 +401,7 @@ header when requesting a document from a URL:
420401
421402`--list-extensions`[`=`*FORMAT*]
422403
423−: List supported extensions for *FORMAT*, one per line, preceded
404+: List supported extensions, one per line, preceded
424405 by a `+` or `-` indicating whether it is enabled by default
425406 in *FORMAT*. If *FORMAT* is not specified, defaults for
426407 pandoc's Markdown are given.
@@ -443,88 +424,12 @@ header when requesting a document from a URL:
443424
444425: Show usage message.
445426
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.
427+Reader options
428+--------------
522429
523430`--base-header-level=`*NUMBER*
524431
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
527− (defaults to 1).
432+: Specify the base level for headers (defaults to 1).
528433
529434`--strip-empty-paragraphs`
530435
@@ -554,7 +459,7 @@ header when requesting a document from a URL:
554459 footnotes and links will not work across files. Reading binary
555460 files (docx, odt, epub) implies `--file-scope`.
556461
557−`-F` *PROGRAM*, `--filter=`*PROGRAM*
462+`--filter=`*PROGRAM*
558463
559464: Specify an executable to be used as a filter transforming the
560465 pandoc AST after the input is parsed and before the output is
@@ -563,11 +468,11 @@ header when requesting a document from a URL:
563468 JSON input and output. The name of the output format will be
564469 passed to the filter as the first argument. Hence,
565470
566− pandoc --filter ./caps.py -t latex
471+ pandoc --filter ./caps.py -t latex
567472
568473 is equivalent to
569474
570− pandoc -t json | ./caps.py latex | pandoc -f json -t latex
475+ pandoc -t json | ./caps.py latex | pandoc -f json -t latex
571476
572477 The latter form may be useful for debugging filters.
573478
@@ -589,65 +494,50 @@ header when requesting a document from a URL:
589494
590495 3. `$PATH` (executable only)
591496
592− Filters, Lua-filters, and citeproc processing are applied in
593− the order specified on the command line.
497+ Filters and lua-filters are applied in the order specified
498+ on the command line.
594499
595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
500+`--lua-filter=`*SCRIPT*
596501
597502: Transform the document in a similar fashion as JSON filters (see
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
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
601506 functions indexed by the name of the AST element on which the filter
602507 function should be applied.
603508
604− The `pandoc` Lua module provides helper functions for element
605− creation. It is always loaded into the script's Lua environment.
509+ The `pandoc` lua module provides helper functions for element
510+ creation. It is always loaded into the script's lua environment.
606511
607− See the [Lua filters documentation] for further details.
512+ The following is an example lua script for macro-expansion:
608513
609− In order of preference, pandoc will look for Lua filters in
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
610521
611− 1. a specified full or relative path
522+ return {{Str = expand_hello_world}}
612523
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.
618524
619525`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620526
621527: Set the metadata field *KEY* to the value *VAL*. A value specified
622− on the command line overrides a value specified in the document
623− using [YAML metadata blocks][Extension: `yaml_metadata_block`].
528+ on the command line overrides a value specified in the document.
624529 Values will be parsed as YAML boolean or string values. If no value is
625530 specified, the value will be treated as Boolean true. Like
626531 `--variable`, `--metadata` causes template variables to be set.
627532 But unlike `--variable`, `--metadata` affects the metadata of the
628533 underlying document (which is accessible from filters and may be
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.
534+ printed in some output formats).
644535
645536`-p`, `--preserve-tabs`
646537
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.
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.
651541
652542`--tab-stop=`*NUMBER*
653543
@@ -657,30 +547,30 @@ header when requesting a document from a URL:
657547
658548: Specifies what to do with insertions, deletions, and comments
659549 produced by the MS Word "Track Changes" feature. `accept` (the
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.
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.
672562
673563`--extract-media=`*DIR*
674564
675565: Extract images and other media contained in or linked from
676566 the source document to the path *DIR*, creating it if
677567 necessary, and adjust the images references in the document
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.
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.
684574
685575`--abbreviations=`*FILE*
686576
@@ -691,30 +581,29 @@ header when requesting a document from a URL:
691581 system default, use
692582 `pandoc --print-default-data-file=abbreviations`. The only
693583 use pandoc makes of this list is in the Markdown reader.
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.
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.
697587
698588[`pandocfilters`]: https://github.com/jgm/pandocfilters
699589[PHP]: https://github.com/vinai/pandocfilters-php
700590[perl]: https://metacpan.org/pod/Pandoc::Filter
701591[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703592
704−## General writer options {.options}
593+General writer options
594+----------------------
705595
706596`-s`, `--standalone`
707597
708598: Produce output with an appropriate header and footer (e.g. a
709599 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710600 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711− output. For `native` output, this option causes metadata to
712− be included; otherwise, metadata is suppressed.
601+ output.
713602
714−`--template=`*FILE*|*URL*
603+`--template=`*FILE*
715604
716−: Use the specified file as a custom template for the generated document.
717− Implies `--standalone`. See [Templates], below, for a description
605+: Use *FILE* as a custom template for the generated document. Implies
606+ `--standalone`. See [Templates], below, for a description
718607 of template syntax. If no extension is specified, an extension
719608 corresponding to the writer will be added, so that `--template=special`
720609 looks for `special.html` for HTML output. If the template is not
@@ -726,29 +615,22 @@ header when requesting a document from a URL:
726615`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727616
728617: Set the template variable *KEY* to the value *VAL* when rendering the
729− document in standalone mode. If no *VAL* is specified, the
730− key will be given the value `true`.
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`.
731623
732624`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733625
734626: Print the system default template for an output *FORMAT*. (See `-t`
735627 for a list of possible *FORMAT*s.) Templates in the user data
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`.
628+ directory are ignored.
745629
746630`--print-default-data-file=`*FILE*
747631
748632: Print a system default data file. Files in the user data directory
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.
633+ are ignored.
752634
753635`--eol=crlf`|`lf`|`native`
754636
@@ -759,12 +641,9 @@ header when requesting a document from a URL:
759641
760642`--dpi`=*NUMBER*
761643
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.
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).
768647
769648`--wrap=auto`|`none`|`preserve`
770649
@@ -777,8 +656,6 @@ header when requesting a document from a URL:
777656 where there are nonsemantic newlines in the source, there
778657 will be nonsemantic newlines in the output as well).
779658 Automatic wrapping does not currently work in HTML output.
780− In `ipynb` output, this option affects wrapping of the
781− contents of markdown cells.
782659
783660`--columns=`*NUMBER*
784661
@@ -791,21 +668,14 @@ header when requesting a document from a URL:
791668: Include an automatically generated table of contents (or, in
792669 the case of `latex`, `context`, `docx`, `odt`,
793670 `opendocument`, `rst`, or `ms`, an instruction to create
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`.
671+ one) in the output document. This option has no effect on
672+ `man`, `docbook4`, `docbook5`, or `jats` output.
803673
804674`--toc-depth=`*NUMBER*
805675
806676: Specify the number of section levels to include in the table
807− of contents. The default is 3 (which means that level-1, 2, and 3
808− headings will be listed in the contents).
677+ of contents. The default is 3 (which means that level 1, 2, and 3
678+ headers will be listed in the contents).
809679
810680`--strip-comments`
811681
@@ -841,10 +711,7 @@ header when requesting a document from a URL:
841711
842712: Prints a JSON version of a highlighting style, which can
843713 be modified, saved with a `.theme` extension, and used
844− with `--highlight-style`. This option may be used with
845− `-o`/`--output` to redirect output to a file, but
846− `-o`/`--output` must come before `--print-highlight-style`
847− on the command line.
714+ with `--highlight-style`.
848715
849716`--syntax-definition=`*FILE*
850717
@@ -852,10 +719,9 @@ header when requesting a document from a URL:
852719 which will be used for syntax highlighting of appropriately
853720 marked code blocks. This can be used to add support for
854721 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
856− multiple syntax definitions.
722+ existing languages.
857723
858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
724+`-H` *FILE*, `--include-in-header=`*FILE*
859725
860726: Include contents of *FILE*, verbatim, at the end of the header.
861727 This can be used, for example, to include special
@@ -863,7 +729,7 @@ header when requesting a document from a URL:
863729 repeatedly to include multiple files in the header. They will be
864730 included in the order specified. Implies `--standalone`.
865731
866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
732+`-B` *FILE*, `--include-before-body=`*FILE*
867733
868734: Include contents of *FILE*, verbatim, at the beginning of the
869735 document body (e.g. after the `<body>` tag in HTML, or the
@@ -872,7 +738,7 @@ header when requesting a document from a URL:
872738 used repeatedly to include multiple files. They will be included in
873739 the order specified. Implies `--standalone`.
874740
875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
741+`-A` *FILE*, `--include-after-body=`*FILE*
876742
877743: Include contents of *FILE*, verbatim, at the end of the document
878744 body (before the `</body>` tag in HTML, or the
@@ -891,39 +757,28 @@ header when requesting a document from a URL:
891757 will not be searched. For example:
892758 `--resource-path=.:test` will search the working directory
893759 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`.
899760
900761`--request-header=`*NAME*`:`*VAL*
901762
902763: Set the request header *NAME* to the value *VAL* when making
903764 HTTP requests (for example, when a URL is given on the
904765 command line, or when resources used in a document must be
905− downloaded). If you're behind a proxy, you also need to set
906− the environment variable `http_proxy` to `http://...`.
907−
908−`--no-check-certificate`
766+ downloaded).
909767
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}
768+Options affecting specific writers
769+----------------------------------
915770
916771`--self-contained`
917772
918773: Produce a standalone HTML file with no external dependencies, using
919774 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
920− images, and videos. Implies `--standalone`. The resulting file should be
921− "self-contained," in the sense that it needs no external files and no net
922− access to be displayed properly by a browser. This option works only with
923− HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924− `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925− and stylesheets at absolute URLs will be downloaded; those at relative
926− URLs will be sought relative to the working directory (if the first source
775+ images, and videos. The resulting file should be "self-contained,"
776+ in the sense that it needs no external files and no net access to be
777+ displayed properly by a browser. This option works only with HTML output
778+ formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
779+ `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
780+ stylesheets at absolute URLs will be downloaded; those at relative URLs
781+ will be sought relative to the working directory (if the first source
927782 file is local) or relative to the base URL (if the first source
928783 file is remote). Elements with the attribute
929784 `data-external="1"` will be left alone; the documents they
@@ -936,18 +791,13 @@ header when requesting a document from a URL:
936791
937792`--html-q-tags`
938793
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.)
794+: Use `<q>` tags for quotes in HTML.
942795
943796`--ascii`
944797
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.
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).
951801
952802`--reference-links`
953803
@@ -956,45 +806,36 @@ header when requesting a document from a URL:
956806 placement of link references is affected by the
957807 `--reference-location` option.
958808
959−`--reference-location=block`|`section`|`document`
809+`--reference-location = block`|`section`|`document`
960810
961811: Specify whether footnotes (and references, if `reference-links` is
962812 set) are placed at the end of the current (top-level) block, the
963813 current section, or the document. The default is
964814 `document`. Currently only affects the markdown writer.
965815
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−
974816`--atx-headers`
975817
976−: *Deprecated synonym for `--markdown-headings=atx`.*
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.)
977821
978−`--top-level-division=default`|`section`|`chapter`|`part`
822+`--top-level-division=[default|section|chapter|part]`
979823
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.
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.
993834
994835`-N`, `--number-sections`
995836
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997− output. By default, sections are not numbered. Sections with class
837+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
838+ By default, sections are not numbered. Sections with class
998839 `unnumbered` will never be numbered, even if `--number-sections`
999840 is specified.
1000841
@@ -1002,19 +843,16 @@ header when requesting a document from a URL:
1002843
1003844: Offset for section headings in HTML output (ignored in other
1004845 output formats). The first number is added to the section number for
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
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
1007848 document to be numbered "6", specify `--number-offset=5`.
1008− If your document starts with a level-2 heading which you want to
849+ If your document starts with a level-2 header which you want to
1009850 be numbered "1.5", specify `--number-offset=1,4`.
1010851 Offsets are 0 by default. Implies `--number-sections`.
1011852
1012853`--listings`
1013854
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].
855+: Use the [`listings`] package for LaTeX code blocks
1018856
1019857`-i`, `--incremental`
1020858
@@ -1023,12 +861,12 @@ header when requesting a document from a URL:
1023861
1024862`--slide-level=`*NUMBER*
1025863
1026−: Specifies that headings with the specified level create
1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
864+: Specifies that headers with the specified level create
865+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1028866 above this level in the hierarchy are used to divide the
1029− slide show into sections; headings below this level create
867+ slide show into sections; headers below this level create
1030868 subheads within a slide. Note that content that is
1031− not contained under slide-level headings will not appear in
869+ not contained under slide-level headers will not appear in
1032870 the slide show. The default is to set the slide level based
1033871 on the contents of the document; see [Structuring the slide
1034872 show].
@@ -1037,8 +875,8 @@ header when requesting a document from a URL:
1037875
1038876: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039877 and attach identifiers to the enclosing `<section>` (or `<div>`)
1040− rather than the heading itself. See
1041− [Heading identifiers], below.
878+ rather than the header itself. See
879+ [Header identifiers], below.
1042880
1043881`--email-obfuscation=none`|`javascript`|`references`
1044882
@@ -1059,7 +897,8 @@ header when requesting a document from a URL:
1059897
1060898: Specify *STRING* as a prefix at the beginning of the title
1061899 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
900+ appears at the beginning of the HTML body). Implies
901+ `--standalone`.
1063902
1064903`-c` *URL*, `--css=`*URL*
1065904
@@ -1067,8 +906,8 @@ header when requesting a document from a URL:
1067906 include multiple files. They will be included in the order specified.
1068907
1069908 A stylesheet is required for generating EPUB. If none is
1070− provided using this option (or the `css` or `stylesheet`
1071− metadata fields), pandoc will look for a file `epub.css` in the
909+ provided using this option (or the `stylesheet` metadata
910+ field), pandoc will look for a file `epub.css` in the
1072911 user data directory (see `--data-dir`). If it is not
1073912 found there, sensible defaults will be used.
1074913
@@ -1080,107 +919,48 @@ header when requesting a document from a URL:
1080919 Docx
1081920
1082921 : For best results, the reference docx should be a modified
1083− version of a docx file produced using pandoc. The contents
1084− of the reference docx are ignored, but its stylesheets and
1085− document properties (including margins, page size, header,
1086− and footer) are used in the new docx. If no reference docx
1087− is specified on the command line, pandoc will look for a
1088− file `reference.docx` in the user data directory (see
1089− `--data-dir`). If this is not found either, sensible
1090− defaults will be used.
1091−
1092− To produce a custom `reference.docx`, first get a copy of
1093− the default `reference.docx`: `pandoc
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
922+ version of a docx file produced using pandoc. The contents
923+ of the reference docx are ignored, but its stylesheets and
924+ document properties (including margins, page size, header,
925+ and footer) are used in the new docx. If no reference docx
926+ is specified on the command line, pandoc will look for a
927+ file `reference.docx` in the user data directory (see
928+ `--data-dir`). If this is not found either, sensible
929+ defaults will be used.
930+
931+ To produce a custom `reference.docx`, first get a copy of
932+ 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.
1144947
1145948 ODT
1146949
1147950 : For best results, the reference ODT should be a modified
1148− version of an ODT produced using pandoc. The contents of
1149− the reference ODT are ignored, but its stylesheets are used
1150− in the new ODT. If no reference ODT is specified on the
1151− command line, pandoc will look for a file `reference.odt` in
1152− the user data directory (see `--data-dir`). If this is not
1153− found either, sensible defaults will be used.
1154−
1155− To produce a custom `reference.odt`, first get a copy of
1156− the default `reference.odt`: `pandoc
1157− -o custom-reference.odt --print-default-data-file reference.odt`.
1158− Then open `custom-reference.odt` in LibreOffice, modify
1159− the styles as you wish, and save the file.
1160−
1161− PowerPoint
1162−
1163− : Templates included with Microsoft PowerPoint 2013 (either with
1164− `.pptx` or `.potx` extension) are known to work, as are most
1165− templates derived from these.
1166−
1167− The specific requirement is that the template should begin with
1168− the following first four layouts:
1169−
1170− 1. Title Slide
1171− 2. Title and Content
1172− 3. Section Header
1173− 4. Two Content
1174−
1175− All templates included with a recent version of MS PowerPoint
1176− will fit these criteria. (You can click on `Layout` under the
1177− `Home` menu to check.)
1178−
1179− You can also modify the default `reference.pptx`: first run
1180− `pandoc -o custom-reference.pptx --print-default-data-file
1181− reference.pptx`, and then modify `custom-reference.pptx`
1182− in MS PowerPoint (pandoc will use the first four layout
1183− slides, as mentioned above).
951+ version of an ODT produced using pandoc. The contents of
952+ the reference ODT are ignored, but its stylesheets are used
953+ in the new ODT. If no reference ODT is specified on the
954+ command line, pandoc will look for a file `reference.odt` in
955+ the user data directory (see `--data-dir`). If this is not
956+ found either, sensible defaults will be used.
957+
958+ To produce a custom `reference.odt`, first get a copy of
959+ 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.
1184964
1185965`--epub-cover-image=`*FILE*
1186966
@@ -1195,8 +975,8 @@ header when requesting a document from a URL:
1195975 The file should contain a series of [Dublin Core elements].
1196976 For example:
1197977
1198− <dc:rights>Creative Commons</dc:rights>
1199− <dc:language>es-AR</dc:language>
978+ <dc:rights>Creative Commons</dc:rights>
979+ <dc:language>es-AR</dc:language>
1200980
1201981 By default, pandoc will include the following metadata elements:
1202982 `<dc:title>` (from the document title), `<dc:creator>` (from the
@@ -1220,40 +1000,40 @@ header when requesting a document from a URL:
12201000 embedded fonts, you will need to add declarations like the following
12211001 to your CSS (see `--css`):
12221002
1223− @font-face {
1224− font-family: DejaVuSans;
1225− font-style: normal;
1226− font-weight: normal;
1227− src:url("DejaVuSans-Regular.ttf");
1228− }
1229− @font-face {
1230− font-family: DejaVuSans;
1231− font-style: normal;
1232− font-weight: bold;
1233− src:url("DejaVuSans-Bold.ttf");
1234− }
1235− @font-face {
1236− font-family: DejaVuSans;
1237− font-style: italic;
1238− font-weight: normal;
1239− src:url("DejaVuSans-Oblique.ttf");
1240− }
1241− @font-face {
1242− font-family: DejaVuSans;
1243− font-style: italic;
1244− font-weight: bold;
1245− src:url("DejaVuSans-BoldOblique.ttf");
1246− }
1247− body { font-family: "DejaVuSans"; }
1003+ @font-face {
1004+ font-family: DejaVuSans;
1005+ font-style: normal;
1006+ font-weight: normal;
1007+ src:url("DejaVuSans-Regular.ttf");
1008+ }
1009+ @font-face {
1010+ font-family: DejaVuSans;
1011+ font-style: normal;
1012+ font-weight: bold;
1013+ src:url("DejaVuSans-Bold.ttf");
1014+ }
1015+ @font-face {
1016+ font-family: DejaVuSans;
1017+ font-style: italic;
1018+ font-weight: normal;
1019+ src:url("DejaVuSans-Oblique.ttf");
1020+ }
1021+ @font-face {
1022+ font-family: DejaVuSans;
1023+ font-style: italic;
1024+ font-weight: bold;
1025+ src:url("DejaVuSans-BoldOblique.ttf");
1026+ }
1027+ body { font-family: "DejaVuSans"; }
12481028
12491029`--epub-chapter-level=`*NUMBER*
12501030
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
1031+: Specify the header level at which to split the EPUB into separate
1032+ "chapter" files. The default is to split into chapters at level 1
1033+ headers. This option only affects the internal composition of the
12541034 EPUB, not the way chapters and sections are displayed to users. Some
12551035 readers may be slow if the chapter files are too large, so for large
1256− documents with few level-1 headings, one might want to use a chapter
1036+ documents with few level 1 headers, one might want to use a chapter
12571037 level of 2 or 3.
12581038
12591039`--epub-subdirectory=`*DIRNAME*
@@ -1262,118 +1042,69 @@ header when requesting a document from a URL:
12621042 the EPUB-specific contents. The default is `EPUB`. To put
12631043 the EPUB contents in the top level, use an empty string.
12641044
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*
1045+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
12751046
12761047: Use the specified engine when producing PDF output.
1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279− and `pdfroff`. If the engine is not in your PATH, the full
1280− path of the engine may be specified here. If this option
1281− is not specified, pandoc uses the following defaults
1282− depending on the output format specified using `-t/--to`:
1283−
1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285− `tectonic`, `latexmk`)
1286− - `-t context`: `context`
1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288− see [print-css.rocks](https://print-css.rocks) for a good
1289− introduction to PDF generation from HTML/CSS.)
1290− - `-t ms`: `pdfroff`
1048+ The default is `pdflatex`. If the engine is not in your PATH,
1049+ the full path of the engine may be specified here.
12911050
12921051`--pdf-engine-opt=`*STRING*
12931052
12941053: Use the given string as a command-line argument to the `pdf-engine`.
1295− For example, to use a persistent directory `foo` for `latexmk`'s
1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297− Note that no check for duplicate options is done.
1298−
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301−[Encoding issue with the listings package]:
1302− https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303−
1304−## Citation rendering {.options}
1305−
1306−`-C`, `--citeproc`
1307−
1308−: Process the citations in the file, replacing them with
1309− rendered citations and adding a bibliography.
1310− Citation processing will not take place unless bibliographic
1311− data is supplied, either through an external file specified
1312− using the `--bibliography` option or the `bibliography`
1313− field in metadata, or via a `references` section in metadata
1314− containing a list of citations in CSL YAML format with
1315− Markdown formatting. The style is controlled by a [CSL]
1316− stylesheet specified using the `--csl` option or the `csl`
1317− field in metadata. (If no stylesheet is specified,
1318− the `chicago-author-date` style will be used by default.)
1319− The citation processing transformation may be applied before
1320− or after filters or Lua filters (see `--filter`,
1321− `--lua-filter`): these transformations are applied in the
1322− order they appear on the command line. For more
1323− information, see the section on [Citations].
1054+ If used multiple times, the arguments are provided with spaces between
1055+ them. Note that no check for duplicate options is done.
1056+
1057+[Dublin Core elements]: http://dublincore.org/documents/dces/
1058+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1059+
1060+Citation rendering
1061+------------------
13241062
13251063`--bibliography=`*FILE*
13261064
13271065: Set the `bibliography` field in the document's metadata to *FILE*,
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`).
1066+ overriding any value set in the metadata, and process citations
1067+ using `pandoc-citeproc`. (This is equivalent to
1068+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1069+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1070+ used, making this equivalent to `--metadata bibliography=FILE`.
1071+ If you supply this argument multiple times, each *FILE* will be added
1072+ to bibliography.
13341073
13351074`--csl=`*FILE*
13361075
13371076: Set the `csl` field in the document's metadata to *FILE*,
13381077 overriding any value set in the metadata. (This is equivalent to
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.
1078+ `--metadata csl=FILE`.)
1079+ This option is only relevant with `pandoc-citeproc`.
13441080
13451081`--citation-abbreviations=`*FILE*
13461082
13471083: Set the `citation-abbreviations` field in the document's metadata to
13481084 *FILE*, overriding any value set in the metadata. (This is equivalent to
13491085 `--metadata citation-abbreviations=FILE`.)
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.
1086+ This option is only relevant with `pandoc-citeproc`.
13541087
13551088`--natbib`
13561089
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`].
1090+: Use [`natbib`] for citations in LaTeX output. This option is not for use
1091+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1092+ use in producing a LaTeX file that can be processed with [`bibtex`].
13611093
13621094`--biblatex`
13631095
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`].
1096+: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1097+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1098+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
13681099
1369−## Math rendering in HTML {.options}
1100+Math rendering in HTML
1101+----------------------
13701102
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.
1103+The default is to render TeX math as far as possible using Unicode characters.
1104+Formulas are put inside a `span` with `class="math"`, so that they may be styled
1105+differently from the surrounding text if needed. However, this gives acceptable
1106+results only for basic math, usually you will want to use `--mathjax` or another
1107+of the following options.
13771108
13781109`--mathjax`[`=`*URL*]
13791110
@@ -1387,11 +1118,10 @@ results only for basic math, usually you will want to use
13871118
13881119`--mathml`
13891120
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.
1121+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1122+ `html4` and `html5`). This is the default in `odt` output. Note that
1123+ currently only Firefox and Safari (and select e-book readers) natively
1124+ support MathML.
13951125
13961126`--webtex`[`=`*URL*]
13971127
@@ -1408,26 +1138,67 @@ results only for basic math, usually you will want to use
14081138`--katex`[`=`*URL*]
14091139
14101140: Use [KaTeX] to display embedded TeX math in HTML output.
1411− The *URL* is the base URL for the KaTeX library. That directory
1412− should contain a `katex.min.js` and a `katex.min.css` file.
1413− If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1141+ The *URL* is the base URL for the KaTeX library. If a *URL* is
1142+ not provided, a link to the KaTeX CDN will be inserted.
1143+
1144+`--katex-stylesheet=`*URL*
1145+
1146+: The *URL* should point to the `katex.css` stylesheet. If this option is
1147+ not specified, a link to the KaTeX CDN will be inserted. Note that this
1148+ option does not imply `--katex`.
1149+
1150+`-m` [*URL*], `--latexmathml`[`=`*URL*]
1151+
1152+: *Deprecated.*
1153+ Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1154+ TeX math will be displayed between `$` or `$$` characters and put in
1155+ `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1156+ change it to MathML. Note that currently only Firefox and Safari
1157+ (and select e-book readers) natively support MathML.
1158+ To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1159+
1160+`--jsmath`[`=`*URL*]
1161+
1162+: *Deprecated.*
1163+ Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1164+ math in HTML output. TeX math will be put inside `<span>` tags
1165+ (for inline math) or `<div>` tags (for display math) with class
1166+ `math` and rendered by the jsMath script. The *URL* should point to
1167+ the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1168+ to in the header of standalone HTML documents. If a *URL* is not provided,
1169+ no link to the jsMath load script will be inserted; it is then
1170+ up to the author to provide such a link in the HTML template.
14141171
14151172`--gladtex`
14161173
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.
1174+: *Deprecated.*
1175+ Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1176+ can then be processed by [gladTeX] to produce images of the typeset
1177+ formulas and an HTML file with links to these images.
1178+ So, the procedure is:
1179+
1180+ pandoc -s --gladtex input.md -o myfile.htex
1181+ gladtex -d myfile-images myfile.htex
1182+ # produces myfile.html and images in myfile-images
14201183
1421− pandoc -s --gladtex input.md -o myfile.htex
1422− gladtex -d image_dir myfile.htex
1423− # produces myfile.html and images in image_dir
1184+`--mimetex`[`=`*URL*]
14241185
1425−[MathML]: https://www.w3.org/Math/
1186+: *Deprecated.*
1187+ Render TeX math using the [mimeTeX] CGI script, which generates an
1188+ image for each TeX formula. This should work in all browsers. If
1189+ *URL* is not specified, it is assumed that the script is at
1190+ `/cgi-bin/mimetex.cgi`.
1191+
1192+[MathML]: http://www.w3.org/Math/
1193+[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1194+[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
14261195[MathJax]: https://www.mathjax.org
1196+[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1197+[mimeTeX]: http://www.forkosh.com/mimetex.html
14271198[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
14291199
1430−## Options for wrapper scripts {.options}
1200+Options for wrapper scripts
1201+---------------------------
14311202
14321203`--dump-args`
14331204
@@ -1445,283 +1216,14 @@ results only for basic math, usually you will want to use
14451216: Ignore command-line arguments (for use in wrapper scripts).
14461217 Regular pandoc options are not ignored. Thus, for example,
14471218
1448− pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
1219+ pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
14491220
14501221 is equivalent to
14511222
1452− pandoc -o foo.html -s
1453−
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`.
1223+ pandoc -o foo.html -s
17141224
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
1225+Templates
1226+=========
17251227
17261228When the `-s/--standalone` option is used, pandoc uses a template to
17271229add header and footer material that is needed for a self-standing
@@ -1740,827 +1242,284 @@ directory (see `--data-dir`, above). *Exceptions:*
17401242- For `pdf` output, customize the `default.latex` template
17411243 (or the `default.context` template, if you use `-t context`,
17421244 or the `default.ms` template, if you use `-t ms`, or the
1743− `default.html` template, if you use `-t html`).
1744−- `docx` and `pptx` have no template (however, you can use
1245+ `default.html5` template, if you use `-t html5`).
1246+- `docx` has no template (however, you can use
17451247 `--reference-doc` to customize the output).
17461248
17471249Templates contain *variables*, which allow for the inclusion of
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.
1250+arbitrary information at any point in the file. Variables may be set
1251+within the document using [YAML metadata blocks][Extension:
1252+`yaml_metadata_block`]. They may also be set at the
1253+command line using the `-V/--variable` option: variables set in this
1254+way override metadata fields with the same name.
17551255
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.
1256+Variables set by pandoc
1257+-----------------------
17611258
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1259+Some variables are set automatically by pandoc. These vary somewhat
1260+depending on the output format, but include metadata fields as well
1261+as the following:
17631262
1764−## Template syntax
1263+`sourcefile`, `outputfile`
1264+: source and destination filenames, as given on the command line.
1265+ `sourcefile` can also be a list if input comes from multiple files, or empty
1266+ if input is from stdin. You can use the following snippet in your template
1267+ to distinguish them:
1268+
1269+ $if(sourcefile)$
1270+ $for(sourcefile)$
1271+ $sourcefile$
1272+ $endfor$
1273+ $else$
1274+ (stdin)
1275+ $endif$
17651276
1766−### Comments
1277+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17671278
1768−Anything between the sequence `$--` and the end of the
1769−line will be treated as a comment and omitted from the output.
1279+`title`, `author`, `date`
1280+: allow identification of basic aspects of the document. Included
1281+ in PDF metadata through LaTeX and ConTeXt. These can be set
1282+ through a [pandoc title block][Extension: `pandoc_title_block`],
1283+ which allows for multiple authors, or through a YAML metadata block:
17701284
1771−### Delimiters
1285+ ---
1286+ author:
1287+ - Aristotle
1288+ - Peter Abelard
1289+ ...
17721290
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.
1291+`subtitle`
1292+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1293+ renders in LaTeX only when using a document class that supports
1294+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1295+ `scrreprt`, `scrbook`).[^subtitle]
17811296
1782−To include a literal `$` in the document, use `$$`.
1297+`institute`
1298+: author affiliations (in LaTeX and Beamer only). Can be a
1299+ list, when there are multiple authors.
17831300
1784−### Interpolated variables
1301+`abstract`
1302+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
17851303
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:
1304+`keywords`
1305+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1306+ may be repeated as for `author`, above
17911307
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−```
1308+`header-includes`
1309+: contents specified by `-H/--include-in-header` (may have multiple
1310+ values)
18021311
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.
1312+`toc`
1313+: non-null value if `--toc/--table-of-contents` was specified
18071314
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.
1315+`toc-title`
1316+: title of table of contents (works only with EPUB,
1317+ opendocument, odt, docx, pptx)
18151318
1816−### Conditionals
1319+`include-before`
1320+: contents specified by `-B/--include-before-body` (may have
1321+ multiple values)
18171322
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:
1323+`include-after`
1324+: contents specified by `-A/--include-after-body` (may have
1325+ multiple values)
18241326
1825−```
1826−$if(foo)$bar$endif$
1327+`body`
1328+: body of document
18271329
1828−$if(foo)$
1829− $foo$
1830−$endif$
1330+`meta-json`
1331+: JSON representation of all of the document's metadata. Field
1332+ values are transformed to the selected output format.
18311333
1832−$if(foo)$
1833−part one
1834−$else$
1835−part two
1836−$endif$
1334+[^subtitle]: To make `subtitle` work with other LaTeX
1335+ document classes, you can add the following to `header-includes`:
18371336
1838−${if(foo)}bar${endif}
1337+ \providecommand{\subtitle}[1]{%
1338+ \usepackage{titling}
1339+ \posttitle{%
1340+ \par\large#1\end{center}}
1341+ }
18391342
1840−${if(foo)}
1841− ${foo}
1842−${endif}
1343+Language variables
1344+------------------
18431345
1844−${if(foo)}
1845−${ foo.bar }
1846−${else}
1847−no foo!
1848−${endif}
1849−```
1346+`lang`
1347+: identifies the main language of the document,
1348+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1349+ For some output formats, pandoc will convert it to an appropriate
1350+ format stored in the additional variables `babel-lang`,
1351+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1352+
1353+ Native pandoc Spans and Divs with the lang attribute
1354+ (value in BCP 47) can be used to switch the language in
1355+ that range. In LaTeX output, `babel-otherlangs` and
1356+ `polyglossia-otherlangs` variables will be generated
1357+ automatically based on the `lang` attributes of Spans
1358+ and Divs in the document.
18501359
1851−The keyword `elseif` may be used to simplify complex nested
1852−conditionals:
1360+`dir`
1361+: the base direction of the document, either `rtl` (right-to-left)
1362+ or `ltr` (left-to-right).
18531363
1854−```
1855−$if(foo)$
1856−XXX
1857−$elseif(bar)$
1858−YYY
1859−$else$
1860−ZZZ
1861−$endif$
1862−```
1364+ For bidirectional documents, native pandoc `span`s and `div`s
1365+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1366+ override the base direction in some output formats.
1367+ This may not always be necessary if the final renderer
1368+ (e.g. the browser, when generating HTML) supports the
1369+ [Unicode Bidirectional Algorithm].
18631370
1864−### For loops
1371+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1372+ is fully supported (use `--pdf-engine=xelatex`).
18651373
1866−A for loop begins with `for(variable)` (enclosed in
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1868−delimiters.
1374+[BCP 47]: https://tools.ietf.org/html/bcp47
1375+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
18691376
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.
1377+Variables for slides
1378+--------------------
18771379
1878−Examples:
1380+Variables are available for [producing slide shows with pandoc],
1381+including all [reveal.js configuration options].
18791382
1880−```
1881−$for(foo)$$foo$$sep$, $endfor$
1383+`titlegraphic`
1384+: title graphic for Beamer documents
18821385
1883−$for(foo)$
1884− - $foo.last$, $foo.first$
1885−$endfor$
1386+`logo`
1387+: logo for Beamer documents
18861388
1887−${ for(foo.bar) }
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1889−${ endfor }
1389+`slidy-url`
1390+: base URL for Slidy documents (defaults to
1391+ `https://www.w3.org/Talks/Tools/Slidy2`)
18901392
1891−$for(mymap)$
1892−$it.name$: $it.office$
1893−$endfor$
1894−```
1393+`slideous-url`
1394+: base URL for Slideous documents (defaults to `slideous`)
18951395
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.
1396+`s5-url`
1397+: base URL for S5 documents (defaults to `s5/default`)
18991398
1900−```
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1902−```
1399+`revealjs-url`
1400+: base URL for reveal.js documents (defaults to `reveal.js`)
19031401
1904−Instead of using `variable` inside the loop, the special
1905−anaphoric keyword `it` may be used.
1402+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1403+: themes for LaTeX [`beamer`] documents
19061404
1907−```
1908−${ for(foo.bar) }
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1405+`themeoptions`
1406+: options for LaTeX beamer themes (a list).
19121407
1913−### Partials
1408+`navigation`
1409+: controls navigation symbols in `beamer` documents
1410+ (default is `empty` for no navigation symbols; other valid values
1411+ are `frame`, `vertical`, and `horizontal`).
19141412
1915−Partials (subtemplates stored in different files) may be
1916−included by using the name of the partial, followed
1917−by `()`, for example:
1413+`section-titles`
1414+: enables on "title pages" for new sections in `beamer`
1415+ documents (default = true).
19181416
1919−```
1920−${ styles() }
1921−```
1417+`beamerarticle`
1418+: when true, the `beamerarticle` package is loaded (for
1419+ producing an article from beamer slides).
19221420
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:
1421+`aspectratio`
1422+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1423+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1424+ default, and `32` for 3:2).
19281425
1929−```
1930−${ styles.html() }
1931−```
1426+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
19321427
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.)
1428+Variables for LaTeX
1429+-------------------
19371430
1938−Partials may optionally be applied to variables using
1939−a colon:
1431+LaTeX variables are used when [creating a PDF].
19401432
1941−```
1942−${ date:fancy() }
1433+`papersize`
1434+: paper size, e.g. `letter`, `a4`
19431435
1944−${ articles:bibentry() }
1945−```
1436+`fontsize`
1437+: font size for body text (e.g. `10pt`, `12pt`)
19461438
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
1439+`documentclass`
1440+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
19501441
1951−```
1952−${ for(articles) }
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1442+`classoption`
1443+: option for document class, e.g. `oneside`; may be repeated
1444+ for multiple options
19561445
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`.
1446+`geometry`
1447+: option for [`geometry`] package, e.g. `margin=1in`;
1448+ may be repeated for multiple options
19611449
1962−Final newlines are omitted from included partials.
1450+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1451+: sets margins, if `geometry` is not used (otherwise `geometry`
1452+ overrides these)
19631453
1964−Partials may include other partials.
1454+`linestretch`
1455+: adjusts line spacing using the [`setspace`]
1456+ package, e.g. `1.25`, `1.5`
19651457
1966−A separator between values of an array may be specified
1967−in square brackets, immediately after the variable name
1968−or partial:
1458+`fontfamily`
1459+: font package for use with `pdflatex`:
1460+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1461+ The default is [Latin Modern][`lm`].
19691462
1970−```
1971−${months[, ]}$
1463+`fontfamilyoptions`
1464+: options for package used as `fontfamily`: e.g. `osf,sc` with
1465+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1466+ figures and true small caps; may be repeated for multiple options
19721467
1973−${articles:bibentry()[; ]$
1974−```
1468+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1469+: font families for use with `xelatex` or
1470+ `lualatex`: take the name of any system font, using the
1471+ [`fontspec`] package. Note that if `CJKmainfont` is used,
1472+ the [`xecjk`] package must be available.
19751473
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.
1474+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1475+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1476+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1477+ available through [`fontspec`], such as the OpenType features
1478+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
19791479
1980−### Nesting
1480+`fontenc`
1481+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1482+ default is `T1` (see guide to [LaTeX font encodings])
19811483
1982−To ensure that content is "nested," that is, subsequent lines
1983−indented, use the `^` directive:
1484+`microtypeoptions`
1485+: options to pass to the microtype package
19841486
1985−```
1986−$item.number$ $^$$item.description$ ($item.price$)
1987−```
1487+`colorlinks`
1488+: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1489+ `urlcolor`, or `toccolor` are set
19881490
1989−In this example, if `item.description` has multiple lines,
1990−they will all be indented to line up with the first line:
1491+`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1492+: color for internal links, citation links, external links, and links in table of contents:
1493+ uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
19911494
1992−```
1993−00123 A fine bottle of 18-year old
1994− Oban whiskey. ($148)
1995−```
1495+`links-as-notes`
1496+: causes links to be printed as footnotes
19961497
1997−To nest multiple lines to the same level, align them
1998−with the `^` directive in the template. For example:
1498+`indent`
1499+: uses document class settings for indentation (the default LaTeX template
1500+ otherwise removes indentation and adds space between paragraphs)
19991501
2000−```
2001−$item.number$ $^$$item.description$ ($item.price$)
2002− (Available til $item.sellby$.)
2003−```
1502+`subparagraph`
1503+: disables default behavior of LaTeX template that redefines (sub)paragraphs
1504+ as sections, changing the appearance of nested headings in some classes
20041505
2005−will produce
1506+`thanks`
1507+: specifies contents of acknowledgments footnote after document title.
20061508
2007−```
2008−00123 A fine bottle of 18-year old
2009− Oban whiskey. ($148)
2010− (Available til March 30, 2020.)
2011−```
1509+`toc`
1510+: include table of contents (can also be set using `--toc/--table-of-contents`)
20121511
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.
1512+`toc-depth`
1513+: level of section to include in table of contents
20171514
2018−### Breakable spaces
1515+`secnumdepth`
1516+: numbering depth for sections, if sections are numbered
20191517
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 `~`).
1518+`lof`, `lot`
1519+: include list of figures, list of tables
20241520
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
2539−
2540−`links-as-notes`
2541−: causes links to be printed as footnotes
2542−
2543−#### Front matter
2544−
2545−`lof`, `lot`
2546−: include list of figures, list of tables
2547−
2548−`thanks`
2549−: contents of acknowledgments footnote after document title
2550−
2551−`toc`
2552−: include table of contents (can also be set using
2553− `--toc/--table-of-contents`)
2554−
2555−`toc-depth`
2556−: level of section to include in table of contents
2557−
2558−#### BibLaTeX Bibliographies
2559−
2560−These variables function when using BibLaTeX for [citation rendering].
2561−
2562−`biblatexoptions`
2563−: list of options for biblatex
1521+`bibliography`
1522+: bibliography to use for resolving references
25641523
25651524`biblio-style`
25661525: bibliography style, when used with `--natbib` and `--biblatex`.
@@ -2568,154 +1527,116 @@ These variables function when using BibLaTeX for [citation rendering].
25681527`biblio-title`
25691528: bibliography title, when used with `--natbib` and `--biblatex`.
25701529
2571−`bibliography`
2572−: bibliography to use for resolving references
1530+`biblatexoptions`
1531+: list of options for biblatex.
25731532
25741533`natbiboptions`
2575−: list of options for natbib
1534+: list of options for natbib.
1535+
1536+`pagestyle`
1537+: An option for LaTeX's `\pagestyle{}`. The default article class
1538+ supports 'plain' (default), 'empty', and 'headings'; headings puts
1539+ section titles in the header.
25761540
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
25811541[`article`]: https://ctan.org/pkg/article
1542+[`report`]: https://ctan.org/pkg/report
25821543[`book`]: https://ctan.org/pkg/book
2583−[`libertinus`]: https://ctan.org/pkg/libertinus
1544+[KOMA-Script]: https://ctan.org/pkg/koma-script
25841545[`memoir`]: https://ctan.org/pkg/memoir
2585−[`report`]: https://ctan.org/pkg/report
2586−
2587−### Variables for ConTeXt
1546+[`xcolor`]: https://ctan.org/pkg/xcolor
1547+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1548+[`mathpazo`]: https://ctan.org/pkg/mathpazo
1549+[LaTeX font encodings]: https://ctan.org/pkg/encguide
25881550
2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.
1551+Variables for ConTeXt
1552+---------------------
25901553
2591−`fontsize`
2592−: font size for body text (e.g. `10pt`, `12pt`)
1554+`papersize`
1555+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1556+ may be repeated for multiple options
25931557
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
1558+`layout`
1559+: options for page margins and text arrangement (see [ConTeXt Layout]);
1560+ may be repeated for multiple options
25971561
2598−`indenting`
2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600− [ConTeXt Indentation]); repeat for multiple options
1562+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1563+: sets margins, if `layout` is not used (otherwise `layout`
1564+ overrides these)
26011565
2602−`interlinespace`
2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604− repeat for multiple options
1566+`fontsize`
1567+: font size for body text (e.g. `10pt`, `12pt`)
26051568
2606−`layout`
2607−: options for page margins and text arrangement (see [ConTeXt Layout]);
2608− repeat for multiple options
1569+`mainfont`, `sansfont`, `monofont`, `mathfont`
1570+: font families: take the name of any system font (see [ConTeXt Font Switching])
26091571
26101572`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
1573+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
26131574
26141575`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
1576+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
26171577
2618−`lof`, `lot`
2619−: include list of figures, list of tables
1578+`indenting`
1579+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1580+ may be repeated for multiple options
26201581
2621−`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
1582+`whitespace`
1583+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
26241584
2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626−: sets margins, if `layout` is not used (otherwise `layout`
2627− overrides these)
1585+`interlinespace`
1586+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1587+ may be repeated for multiple options
1588+
1589+`headertext`, `footertext`
1590+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1591+ may be repeated up to four times for different placement
26281592
26291593`pagenumbering`
26301594: page number style and location (using [`setuppagenumbering`]);
2631− repeat for multiple options
2632−
2633−`papersize`
2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635− repeat for multiple options
2636−
2637−`pdfa`
2638−: adds to the preamble the setup necessary to generate PDF/A
2639− of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640− specified (i.e. the value is set to True, by e.g.
2641− `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642− `1b:2005` will be used as default, for reasons of backwards
2643− compatibility. Using `--variable=pdfa` without specified value
2644− is not supported. To successfully generate PDF/A the required
2645− ICC color profiles have to be available and the content and all
2646− included files (such as images) have to be standard conforming.
2647− The ICC profiles and output intent may be specified using the
2648− variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649− PDFA] for more details.
2650−
2651−`pdfaiccprofile`
2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654− used as default. May be repeated to include multiple profiles. Note that
2655− the profiles have to be available on the system. They can be obtained
2656− from [ConTeXt ICC Profiles].
2657−
2658−`pdfaintent`
2659−: when used in conjunction with `pdfa`, specifies the output intent for
2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.
1595+ may be repeated for multiple options
26621596
26631597`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
1598+: include table of contents (can also be set using `--toc/--table-of-contents`)
26661599
2667−`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
2670−
2671−`includesource`
2672−: include all source documents as file attachments in the PDF file
2673−
2674−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677−[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2685−
2686−### Variables for `wkhtmltopdf`
1600+`lof`, `lot`
1601+: include list of figures, list of tables
26871602
2688−Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689−The `--css` option also affects the output.
1603+[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1604+[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1605+[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1606+[ConTeXt Color]: http://wiki.contextgarden.net/Color
1607+[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1608+[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1609+[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1610+[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1611+[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
26901612
2691−`footer-html`, `header-html`
2692−: add information to the header and footer
1613+Variables for man pages
1614+-----------------------
26931615
2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695−: set the page margins
1616+`section`
1617+: section number in man pages
26961618
2697−`papersize`
2698−: sets the PDF paper size
1619+`header`
1620+: header in man pages
26991621
2700−### Variables for man pages
1622+`footer`
1623+: footer in man pages
27011624
27021625`adjusting`
27031626: adjusts text to left (`l`), right (`r`), center (`c`),
27041627 or both (`b`) margins
27051628
2706−`footer`
2707−: footer in man pages
2708−
2709−`header`
2710−: header in man pages
2711−
27121629`hyphenate`
27131630: if `true` (the default), hyphenation will be used
27141631
2715−`section`
2716−: section number in man pages
1632+Variables for ms
1633+----------------
1634+
1635+`pointsize`
1636+: point size (e.g. `10p`)
27171637
2718−### Variables for ms
1638+`lineheight`
1639+: line height (e.g. `12p`)
27191640
27201641`fontfamily`
27211642: font family (e.g. `T` or `P`)
@@ -2723,81 +1644,62 @@ The `--css` option also affects the output.
27231644`indent`
27241645: paragraph indent (e.g. `2m`)
27251646
2726−`lineheight`
2727−: line height (e.g. `12p`)
1647+Using variables in templates
1648+----------------------------
27281649
2729−`pointsize`
2730−: point size (e.g. `10p`)
1650+Variable names are sequences of alphanumerics, `-`, and `_`,
1651+starting with a letter. A variable name surrounded by `$` signs
1652+will be replaced by its value. For example, the string `$title$` in
27311653
2732−### Variables set automatically
1654+ <title>$title$</title>
27331655
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:
1656+will be replaced by the document title.
27371657
2738−`body`
2739−: body of document
1658+To write a literal `$` in a template, use `$$`.
27401659
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`).
1660+Templates may contain conditionals. The syntax is as follows:
27501661
2751−`header-includes`
2752−: contents specified by `-H/--include-in-header` (may have multiple
2753− values)
2754−
2755−`include-before`
2756−: contents specified by `-B/--include-before-body` (may have
2757− multiple values)
1662+ $if(variable)$
1663+ X
1664+ $else$
1665+ Y
1666+ $endif$
27581667
2759−`include-after`
2760−: contents specified by `-A/--include-after-body` (may have
2761− multiple values)
1668+This will include `X` in the template if `variable` has a non-null
1669+value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1670+any valid template text, and may include interpolated variables or other
1671+conditionals. The `$else$` section may be omitted.
27621672
2763−`meta-json`
2764−: JSON representation of all of the document's metadata. Field
2765− values are transformed to the selected output format.
1673+When variables can have multiple values (for example, `author` in
1674+a multi-author document), you can use the `$for$` keyword:
27661675
2767−`numbersections`
2768−: non-null value if `-N/--number-sections` was specified
1676+ $for(author)$
1677+ <meta name="author" content="$author$" />
1678+ $endfor$
27691679
2770−`sourcefile`, `outputfile`
2771−: source and destination filenames, as given on the command line.
2772− `sourcefile` can also be a list if input comes from multiple files,
2773− or empty if input is from stdin. You can use the following snippet in
2774− your template to distinguish them:
2775−
2776− $if(sourcefile)$
2777− $for(sourcefile)$
2778− $sourcefile$
2779− $endfor$
2780− $else$
2781− (stdin)
2782− $endif$
1680+You can optionally specify a separator to be used between
1681+consecutive items:
27831682
2784− Similarly, `outputfile` can be `-` if output goes to the terminal.
1683+ $for(author)$$author$$sep$, $endfor$
27851684
2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
1685+A dot can be used to select a field of a variable that takes
1686+an object as its value. So, for example:
27871687
2788−`curdir`
2789−: working directory from which pandoc is run.
1688+ $author.name$ ($author.affiliation$)
27901689
2791−`toc`
2792−: non-null value if `--toc/--table-of-contents` was specified
1690+If you use custom templates, you may need to revise them as pandoc
1691+changes. We recommend tracking the changes in the default templates,
1692+and modifying your custom templates accordingly. An easy way to do this
1693+is to fork the [pandoc-templates] repository and merge in changes after each
1694+pandoc release.
27931695
2794−`toc-title`
2795−: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
1696+Templates may contain comments: anything on a line after `$--`
1697+will be treated as a comment and ignored.
27971698
27981699[pandoc-templates]: https://github.com/jgm/pandoc-templates
27991700
2800−# Extensions
1701+Extensions
1702+==========
28011703
28021704The behavior of some of the readers and writers can be adjusted by
28031705enabling or disabling various extensions.
@@ -2814,11 +1716,8 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
28141716`commonmark` and `gfm`.) In the following, extensions that also work
28151717for other formats are covered.
28161718
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
1719+Typography
1720+----------
28221721
28231722#### Extension: `smart` ####
28241723
@@ -2850,12 +1749,13 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
28501749to use the ligatures when possible; if `smart` is disabled
28511750pandoc will use unicode quotation mark and dash characters.
28521751
2853−## Headings and sections
1752+Headers and sections
1753+--------------------
28541754
28551755#### Extension: `auto_identifiers` ####
28561756
2857−A heading without an explicitly specified identifier will be
2858−automatically assigned a unique identifier based on the heading text.
1757+A header without an explicitly specified identifier will be
1758+automatically assigned a unique identifier based on the header text.
28591759
28601760This extension can be enabled/disabled for the following formats:
28611761
@@ -2868,13 +1768,11 @@ output formats
28681768enabled by default in
28691769: `markdown`, `muse`
28701770
2871−The default algorithm used to derive the identifier from the
2872−heading text is:
1771+The algorithm used to derive the identifier from the header text is:
28731772
28741773 - Remove all formatting, links, etc.
28751774 - Remove all footnotes.
2876− - Remove all non-alphanumeric characters,
2877− except underscores, hyphens, and periods.
1775+ - Remove all punctuation, except underscores, hyphens, and periods.
28781776 - Replace all spaces and newlines with hyphens.
28791777 - Convert all alphabetic characters to lowercase.
28801778 - Remove everything up to the first letter (identifiers may
@@ -2883,31 +1781,27 @@ heading text is:
28831781
28841782Thus, for example,
28851783
2886− Heading Identifier
1784+ Header Identifier
28871785 ------------------------------- ----------------------------
2888− `Heading identifiers in HTML` `heading-identifiers-in-html`
2889− `Maître d'hôtel` `maître-dhôtel`
1786+ `Header identifiers in HTML` `header-identifiers-in-html`
28901787 `*Dogs*?--in *my* house?` `dogs--in-my-house`
28911788 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
28921789 `3. Applications` `applications`
28931790 `33` `section`
28941791
28951792These rules should, in most cases, allow one to determine the identifier
2896−from the heading text. The exception is when several headings have the
1793+from the header text. The exception is when several headers have the
28971794same text; in this case, the first will get an identifier as described
28981795above; the second will get the same identifier with `-1` appended; the
28991796third with `-2`; and so on.
29001797
2901−(However, a different algorithm is used if
2902−`gfm_auto_identifiers` is enabled; see below.)
2903−
29041798These identifiers are used to provide link targets in the table of
29051799contents generated by the `--toc|--table-of-contents` option. They
29061800also make it easy to provide links from one section of a document to
29071801another. A link to this section, for example, might look like this:
29081802
29091803 See the section on
2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).
1804+ [header identifiers](#header-identifiers-in-html-latex-and-context).
29111805
29121806Note, however, that this method of providing links to sections works
29131807only in HTML, LaTeX, and ConTeXt formats.
@@ -2915,7 +1809,7 @@ only in HTML, LaTeX, and ConTeXt formats.
29151809If the `--section-divs` option is specified, then each section will
29161810be wrapped in a `section` (or a `div`, if `html4` was specified),
29171811and the identifier will be attached to the enclosing `<section>`
2918−(or `<div>`) tag rather than the heading itself. This allows entire
1812+(or `<div>`) tag rather than the header itself. This allows entire
29191813sections to be manipulated using JavaScript or treated differently in
29201814CSS.
29211815
@@ -2925,15 +1819,8 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
29251819Accents are stripped off of accented Latin letters, and non-Latin
29261820letters are omitted.
29271821
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
1822+Math Input
1823+----------
29371824
29381825The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
29391826[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2943,47 +1830,50 @@ are described in the section about Pandoc's Markdown.
29431830However, they can also be used with HTML input. This is handy for
29441831reading web pages formatted using MathJax, for example.
29451832
2946−## Raw HTML/TeX
1833+Raw HTML/TeX
1834+------------
1835+
1836+The following extensions (especially how they affect Markdown
1837+input/output) are also described in more detail in their respective
1838+sections of [Pandoc's Markdown].
1839+
1840+#### [Extension: `raw_html`] {#raw_html}
1841+
1842+When converting from HTML, parse elements to raw HTML which are not
1843+representable in pandoc's AST.
1844+By default, this is disabled for HTML input.
1845+
1846+#### [Extension: `raw_tex`] {#raw_tex}
29471847
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
1848+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
29501849
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.
1850+This extension can be enabled/disabled for the following formats
1851+(in addition to `markdown`):
29541852
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`):
1853+input formats
1854+: `latex`, `org`, `textile`
1855+
1856+output formats
1857+: `textile`
1858+
1859+#### [Extension: `native_divs`] {#native_divs}
29581860
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
1861+This extension is enabled by default for HTML input. This means that
1862+`div`s are parsed to pandoc native elements. (Alternatively, you
1863+can parse them to raw HTML using `-f html-native_divs+raw_html`.)
29621864
2963− output formats
2964− : `textile`, `commonmark`
1865+When converting HTML to Markdown, for example, you may want to drop all
1866+`div`s and `span`s:
29651867
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`.
1868+ pandoc -f html-native_divs-native_spans -t markdown
29731869
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`.
1870+#### [Extension: `native_spans`] {#native_spans}
29781871
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`.
1872+Analogous to `native_divs` above.
29851873
2986−## Literate Haskell support
1874+
1875+Literate Haskell support
1876+------------------------
29871877
29881878#### Extension: `literate_haskell` ####
29891879
@@ -3004,12 +1894,12 @@ This means that
30041894 - In Markdown input, "bird track" sections will be parsed as Haskell
30051895 code rather than block quotations. Text between `\begin{code}`
30061896 and `\end{code}` will also be treated as Haskell code. For
3007− ATX-style headings the character '=' will be used instead of '#'.
1897+ ATX-style headers the character '=' will be used instead of '#'.
30081898
30091899 - In Markdown output, code blocks with classes `haskell` and `literate`
30101900 will be rendered using bird tracks, and block quotations will be
30111901 indented one space, so they will not be treated as Haskell code.
3012− In addition, headings will be rendered setext-style (with underlines)
1902+ In addition, headers will be rendered setext-style (with underlines)
30131903 rather than ATX-style (with '#' characters). (This is because ghc
30141904 treats '#' characters in column 1 as introducing line numbers.)
30151905
@@ -3040,11 +1930,12 @@ ordinary HTML (without bird tracks).
30401930writes HTML with the Haskell code in bird tracks, so it can be copied
30411931and pasted as literate Haskell source.
30421932
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.
1933+Note that GHC expects the bird tracks in the first column, so indentend literate
1934+code blocks (e.g. inside an itemized environment) will not be picked up by the
1935+Haskell compiler.
30461936
3047−## Other extensions
1937+Other extensions
1938+----------------
30481939
30491940#### Extension: `empty_paragraphs` ####
30501941
@@ -3057,101 +1948,29 @@ input formats
30571948: `docx`, `html`
30581949
30591950output formats
3060−: `docx`, `odt`, `opendocument`, `html`
3061−
3062−#### Extension: `native_numbering` ####
3063−
3064−Enables native numbering of figures and tables. Enumeration
3065−starts at 1.
3066−
3067−This extension can be enabled/disabled for the following formats:
3068−
3069−output formats
3070−: `odt`, `opendocument`
3071−
3072−#### Extension: `xrefs_name` ####
3073−
3074−Links to headings, figures and tables inside the document are
3075−substituted with cross-references that will use the name or caption
3076−of the referenced item. The original link text is replaced once
3077−the generated document is refreshed. This extension can be combined
3078−with `xrefs_number` in which case numbers will appear before the
3079−name.
3080−
3081−Text in cross-references is only made consistent with the referenced
3082−item once the document has been refreshed.
3083−
3084−This extension can be enabled/disabled for the following formats:
3085−
3086−output formats
3087−: `odt`, `opendocument`
3088−
3089−#### Extension: `xrefs_number` ####
3090−
3091−Links to headings, figures and tables inside the document are
3092−substituted with cross-references that will use the number
3093−of the referenced item. The original link text is discarded.
3094−This extension can be combined with `xrefs_name` in which case
3095−the name or caption numbers will appear after the number.
3096−
3097−For the `xrefs_number` to be useful heading numbers must be enabled
3098−in the generated document, also table and figure captions must be enabled
3099−using for example the `native_numbering` extension.
3100−
3101−Numbers in cross-references are only visible in the final document once
3102−it has been refreshed.
3103−
3104−This extension can be enabled/disabled for the following formats:
3105−
3106−output formats
3107−: `odt`, `opendocument`
3108−
3109−#### Extension: `styles` #### {#ext-styles}
3110−
3111−When converting from docx, read all docx styles as divs (for
3112−paragraph styles) and spans (for character styles) regardless
3113−of whether pandoc understands the meaning of these styles.
3114−This can be used with [docx custom styles](#custom-styles).
3115−Disabled by default.
3116−
3117−input formats
3118−: `docx`
1951+: `markdown`, `docx`, `odt`, `opendocument`, `html`
31191952
31201953#### Extension: `amuse` ####
31211954
31221955In the `muse` input format, this enables Text::Amuse
31231956extensions to Emacs Muse markup.
31241957
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−
31331958#### Extension: `citations` {#org-citations}
31341959
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.
1960+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
1961+in `org` input.
31441962
31451963#### Extension: `ntb` ####
31461964
31471965In the `context` output format this enables the use of [Natural Tables
3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
1966+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
1967+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
31501968Natural tables allow more fine-grained global customization but come
31511969at a performance penalty compared to extreme tables.
31521970
31531971
3154−# Pandoc's Markdown
1972+Pandoc's Markdown
1973+=================
31551974
31561975Pandoc understands an extended and slightly revised version of
31571976John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -3161,7 +1980,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the
31611980behavior more granularly. They are described in the following. See also
31621981[Extensions] above, for extensions that work also on other formats.
31631982
3164−## Philosophy
1983+Philosophy
1984+----------
31651985
31661986Markdown is designed to be easy to write, and, even more importantly,
31671987easy to read:
@@ -3169,7 +1989,7 @@ easy to read:
31691989> A Markdown-formatted document should be publishable as-is, as plain
31701990> text, without looking like it's been marked up with tags or formatting
31711991> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
1992+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
31731993
31741994This principle has guided pandoc's decisions in finding syntax for
31751995tables, footnotes, and other extensions.
@@ -3182,7 +2002,8 @@ it discourages it, and provides other, non-HTMLish ways of representing
31822002important document elements like definition lists, tables, mathematics, and
31832003footnotes.
31842004
3185−## Paragraphs
2005+Paragraphs
2006+----------
31862007
31872008A paragraph is one or more lines of text followed by one or more blank lines.
31882009Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -3195,42 +2016,43 @@ Note: in multiline and grid table cells, this is the only way
31952016to create a hard line break, since trailing spaces in the cells
31962017are ignored.
31972018
3198−## Headings
2019+Headers
2020+-------
31992021
3200−There are two kinds of headings: Setext and ATX.
2022+There are two kinds of headers: Setext and ATX.
32012023
3202−### Setext-style headings ###
2024+### Setext-style headers ###
32032025
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):
2026+A setext-style header is a line of text "underlined" with a row of `=` signs
2027+(for a level one header) or `-` signs (for a level two header):
32062028
3207− A level-one heading
3208− ===================
2029+ A level-one header
2030+ ==================
32092031
3210− A level-two heading
3211− -------------------
2032+ A level-two header
2033+ ------------------
32122034
3213−The heading text can contain inline formatting, such as emphasis (see
2035+The header text can contain inline formatting, such as emphasis (see
32142036[Inline formatting], below).
32152037
32162038
3217−### ATX-style headings ###
2039+### ATX-style headers ###
32182040
3219−An ATX-style heading consists of one to six `#` signs and a line of
2041+An ATX-style header consists of one to six `#` signs and a line of
32202042text, optionally followed by any number of `#` signs. The number of
3221−`#` signs at the beginning of the line is the heading level:
2043+`#` signs at the beginning of the line is the header level:
32222044
3223− ## A level-two heading
2045+ ## A level-two header
32242046
3225− ### A level-three heading ###
2047+ ### A level-three header ###
32262048
3227−As with setext-style headings, the heading text can contain formatting:
2049+As with setext-style headers, the header text can contain formatting:
32282050
3229− # A level-one heading with a [link](/url) and *emphasis*
2051+ # A level-one header with a [link](/url) and *emphasis*
32302052
32312053#### Extension: `blank_before_header` ####
32322054
3233−Standard Markdown syntax does not require a blank line before a heading.
2055+Standard Markdown syntax does not require a blank line before a header.
32342056Pandoc does require this (except, of course, at the beginning of the
32352057document). The reason for the requirement is that it is all too easy for a
32362058`#` to end up at the beginning of a line by accident (perhaps through line
@@ -3242,30 +2064,29 @@ wrapping). Consider, for example:
32422064#### Extension: `space_in_atx_header` ####
32432065
32442066Many Markdown implementations do not require a space between the
3245−opening `#`s of an ATX heading and the heading text, so that
3246−`#5 bolt` and `#hashtag` count as headings. With this extension,
2067+opening `#`s of an ATX header and the header text, so that
2068+`#5 bolt` and `#hashtag` count as headers. With this extension,
32472069pandoc does require the space.
32482070
3249−### Heading identifiers ###
2071+### Header identifiers ###
32502072
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
2073+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
32532074
32542075#### Extension: `header_attributes` ####
32552076
3256−Headings can be assigned attributes using this syntax at the end
3257−of the line containing the heading text:
2077+Headers can be assigned attributes using this syntax at the end
2078+of the line containing the header text:
32582079
32592080 {#identifier .class .class key=value key=value}
32602081
3261−Thus, for example, the following headings will all be assigned the identifier
2082+Thus, for example, the following headers will all be assigned the identifier
32622083`foo`:
32632084
3264− # My heading {#foo}
2085+ # My header {#foo}
32652086
3266− ## My heading ## {#foo}
2087+ ## My header ## {#foo}
32672088
3268− My other heading {#foo}
2089+ My other header {#foo}
32692090 ---------------
32702091
32712092(This syntax is compatible with [PHP Markdown Extra].)
@@ -3274,56 +2095,51 @@ Note that although this syntax allows assignment of classes and key/value
32742095attributes, writers generally don't use all of this information. Identifiers,
32752096classes, and key/value attributes are used in HTML and HTML-based formats such
32762097as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
2098+LaTeX, ConTeXt, Textile, and AsciiDoc writers.
32782099
3279−Headings with the class `unnumbered` will not be numbered, even if
2100+Headers with the class `unnumbered` will not be numbered, even if
32802101`--number-sections` is specified. A single hyphen (`-`) in an attribute
32812102context is equivalent to `.unnumbered`, and preferable in non-English
32822103documents. So,
32832104
3284− # My heading {-}
2105+ # My header {-}
32852106
32862107is just the same as
32872108
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.)
2109+ # My header {.unnumbered}
32942110
32952111#### Extension: `implicit_header_references` ####
32962112
3297−Pandoc behaves as if reference links have been defined for each heading.
3298−So, to link to a heading
2113+Pandoc behaves as if reference links have been defined for each header.
2114+So, to link to a header
32992115
3300− # Heading identifiers in HTML
2116+ # Header identifiers in HTML
33012117
33022118you can simply write
33032119
3304− [Heading identifiers in HTML]
2120+ [Header identifiers in HTML]
33052121
33062122or
33072123
3308− [Heading identifiers in HTML][]
2124+ [Header identifiers in HTML][]
33092125
33102126or
33112127
3312− [the section on heading identifiers][heading identifiers in
2128+ [the section on header identifiers][header identifiers in
33132129 HTML]
33142130
33152131instead of giving the identifier explicitly:
33162132
3317− [Heading identifiers in HTML](#heading-identifiers-in-html)
2133+ [Header identifiers in HTML](#header-identifiers-in-html)
33182134
3319−If there are multiple headings with identical text, the corresponding
2135+If there are multiple headers with identical text, the corresponding
33202136reference will link to the first one only, and you will need to use explicit
33212137links to link to the others, as described above.
33222138
33232139Like regular reference links, these references are case-insensitive.
33242140
33252141Explicit link reference definitions always take priority over
3326−implicit heading references. So, in the following example, the
2142+implicit header references. So, in the following example, the
33272143link will point to `bar`, not to `#foo`:
33282144
33292145 # Foo
@@ -3332,11 +2148,12 @@ link will point to `bar`, not to `#foo`:
33322148
33332149 See [foo]
33342150
3335−## Block quotations
2151+Block quotations
2152+----------------
33362153
33372154Markdown uses email conventions for quoting blocks of text.
33382155A block quotation is one or more paragraphs or other block elements
3339−(such as lists or headings), with each line preceded by a `>` character
2156+(such as lists or headers), with each line preceded by a `>` character
33402157and an optional space. (The `>` need not start at the left margin, but
33412158it should not be indented more than three spaces.)
33422159
@@ -3371,19 +2188,19 @@ block in a block quote, you need five spaces after the `>`:
33712188
33722189#### Extension: `blank_before_blockquote` ####
33732190
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
2191+Standard Markdown syntax does not require a blank line before a block
2192+quote. Pandoc does require this (except, of course, at the beginning of the
2193+document). The reason for the requirement is that it is all too easy for a
2194+`>` to end up at the beginning of a line by accident (perhaps through line
2195+wrapping). So, unless the `markdown_strict` format is used, the following does
33802196not produce a nested block quote in pandoc:
33812197
33822198 > This is a block quote.
33832199 >> Nested.
33842200
33852201
3386−## Verbatim (code) blocks
2202+Verbatim (code) blocks
2203+----------------------
33872204
33882205### Indented code blocks ###
33892206
@@ -3391,9 +2208,9 @@ A block of text indented four spaces (or one tab) is treated as verbatim
33912208text: that is, special characters do not trigger special formatting,
33922209and all spaces and line breaks are preserved. For example,
33932210
3394− if (a > 3) {
3395− moveShip(5 * gravity, DOWN);
3396− }
2211+ if (a > 3) {
2212+ moveShip(5 * gravity, DOWN);
2213+ }
33972214
33982215The initial (four space or one tab) indentation is not considered part
33992216of the verbatim text, and is removed in the output.
@@ -3442,19 +2259,17 @@ this syntax:
34422259 ~~~~ {#mycode .haskell .numberLines startFrom="100"}
34432260 qsort [] = []
34442261 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3445− qsort (filter (>= x) xs)
2262+ qsort (filter (>= x) xs)
34462263 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34472264
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:
2265+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2266+`startFrom` is an attribute with value `100`. Some output formats can use this
2267+information to do syntax highlighting. Currently, the only output formats
2268+that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
2269+is supported for your output format and language, then the code block above
2270+will appear highlighted, with numbered lines. (To see which languages are
2271+supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2272+block above will appear as follows:
34582273
34592274 <pre id="mycode" class="haskell numberLines" startFrom="100">
34602275 <code>
@@ -3491,7 +2306,8 @@ To set the highlighting style, use `--highlight-style`.
34912306For more information on highlighting, see [Syntax highlighting],
34922307below.
34932308
3494−## Line blocks
2309+Line blocks
2310+-----------
34952311
34962312#### Extension: `line_blocks` ####
34972313
@@ -3517,12 +2333,10 @@ line must begin with a space.
35172333 | 200 Main St.
35182334 | Berkeley, CA 94718
35192335
3520−Inline formatting (such as emphasis) is allowed in the content,
3521−but not block-level formatting (such as block quotes or lists).
3522−
35232336This syntax is borrowed from [reStructuredText].
35242337
3525−## Lists
2338+Lists
2339+-----
35262340
35272341### Bullet lists ###
35282342
@@ -3569,12 +2383,12 @@ the list marker.
35692383
35702384 * First paragraph.
35712385
3572− Continued.
2386+ Continued.
35732387
35742388 * Second paragraph. With a code block, which must be indented
3575− eight spaces:
2389+ eight spaces:
35762390
3577− { code }
2391+ { code }
35782392
35792393Exception: if the list marker is followed by an indented code
35802394block, which must begin 5 spaces after the list marker, then
@@ -3592,8 +2406,8 @@ containing list item.
35922406
35932407 * fruits
35942408 + apples
3595− - macintosh
3596− - red delicious
2409+ - macintosh
2410+ - red delicious
35972411 + pears
35982412 + peaches
35992413 * vegetables
@@ -3610,7 +2424,7 @@ other blocks in a list item, the first line of each must be indented.
36102424 + Another one; this looks
36112425 bad but is legal.
36122426
3613− Second paragraph of second
2427+ Second paragraph of second
36142428 list item.
36152429
36162430### Ordered lists ###
@@ -3644,18 +2458,18 @@ capital letter with a period, by at least two spaces.[^2]
36442458[^2]: The point of this rule is to ensure that normal paragraphs
36452459 starting with people's initials, like
36462460
3647− B. Russell was an English philosopher.
2461+ B. Russell was an English philosopher.
36482462
36492463 do not get treated as list items.
36502464
36512465 This rule will not prevent
36522466
3653− (C) 2007 Joe Smith
2467+ (C) 2007 Joe Smith
36542468
36552469 from being interpreted as a list item. In this case, a backslash
36562470 escape can be used:
36572471
3658− (C\) 2007 Joe Smith
2472+ (C\) 2007 Joe Smith
36592473
36602474The `fancy_lists` extension also allows '`#`' to be used as an
36612475ordered list marker in place of a numeral:
@@ -3674,9 +2488,9 @@ roman numerals:
36742488 9) Ninth
36752489 10) Tenth
36762490 11) Eleventh
3677− i. subone
3678− ii. subtwo
3679− iii. subthree
2491+ i. subone
2492+ ii. subtwo
2493+ iii. subthree
36802494
36812495Pandoc will start a new list each time a different type of list
36822496marker is used. So, the following will create three lists:
@@ -3692,12 +2506,6 @@ If default list markers are desired, use `#.`:
36922506 #. two
36932507 #. three
36942508
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
37012509
37022510### Definition lists ###
37032511
@@ -3714,21 +2522,20 @@ Pandoc supports definition lists, using the syntax of
37142522
37152523 : Definition 2
37162524
3717− { some code, part of Definition 2 }
2525+ { some code, part of Definition 2 }
37182526
3719− Third paragraph of definition 2.
2527+ Third paragraph of definition 2.
37202528
37212529Each term must fit on one line, which may optionally be followed by
37222530a blank line, and must be followed by one or more definitions.
37232531A definition begins with a colon or tilde, which may be indented one
37242532or two spaces.
37252533
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
2534+A term may have multiple definitions, and each definition may consist of one or
2535+more block elements (paragraph, code block, list, etc.), each indented four
2536+spaces or one tab stop. The body of the definition (including the first line,
2537+aside from the colon or tilde) should be indented four spaces. However,
2538+as with other Markdown lists, you can "lazily" omit indentation except
37322539at the beginning of a paragraph or other block element:
37332540
37342541 Term 1
@@ -3736,7 +2543,7 @@ at the beginning of a paragraph or other block element:
37362543 : Definition
37372544 with lazy continuation.
37382545
3739− Second paragraph of the definition.
2546+ Second paragraph of the definition.
37402547
37412548If you leave space before the definition (as in the example above),
37422549the text of the definition will be treated as a paragraph. In some
@@ -3754,10 +2561,9 @@ definition:
37542561Note that space between items in a definition list is required.
37552562(A variant that loosens this requirement, but disallows "lazy"
37562563hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2564+[Non-pandoc extensions], below.)
37582565
3759−[^3]: I have been influenced by the suggestions of [David
3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2566+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
37612567
37622568### Numbered example lists ###
37632569
@@ -3793,6 +2599,30 @@ list marker. That is, example lists always behave as if the
37932599labels tend to be long, and indenting content to the
37942600first non-space character after the label would be awkward.
37952601
2602+### Compact and loose lists ###
2603+
2604+Pandoc behaves differently from `Markdown.pl` on some "edge
2605+cases" involving lists. Consider this source:
2606+
2607+ + First
2608+ + Second:
2609+ - Fee
2610+ - Fie
2611+ - Foe
2612+
2613+ + Third
2614+
2615+Pandoc transforms this into a "compact list" (with no `<p>` tags around
2616+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2617+"Second" and "Third" (but not "First"), because of the blank space
2618+around "Third". Pandoc follows a simple rule: if the text is followed by
2619+a blank line, it is treated as a paragraph. Since "Second" is followed
2620+by a list, and not a blank line, it isn't treated as a paragraph. The
2621+fact that the list is followed by a blank line is irrelevant. (Note:
2622+Pandoc works this way even when the `markdown_strict` format is specified. This
2623+behavior is consistent with the official Markdown syntax description,
2624+even though it is different from that of `Markdown.pl`.)
2625+
37962626
37972627### Ending a list ###
37982628
@@ -3801,7 +2631,7 @@ What if you want to put an indented code block after a list?
38012631 - item one
38022632 - item two
38032633
3804− { my code block }
2634+ { my code block }
38052635
38062636Trouble! Here pandoc (like other Markdown implementations) will treat
38072637`{ my code block }` as the second paragraph of item two, and not as
@@ -3816,7 +2646,7 @@ any format:
38162646
38172647 <!-- end of list -->
38182648
3819− { my code block }
2649+ { my code block }
38202650
38212651You can use the same trick if you want two consecutive lists instead
38222652of one big list:
@@ -3831,7 +2661,8 @@ of one big list:
38312661 2. dos
38322662 3. tres
38332663
3834−## Horizontal rules
2664+Horizontal rules
2665+----------------
38352666
38362667A line containing a row of three or more `*`, `-`, or `_` characters
38372668(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +2672,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
38412672 ---------------
38422673
38432674
3844−## Tables
2675+Tables
2676+------
38452677
38462678Four kinds of tables may be used. The first three kinds presuppose the use of
38472679a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3860,13 +2692,13 @@ Simple tables look like this:
38602692
38612693 Right Left Center Default
38622694 ------- ------ ---------- -------
3863− 12 12 12 12
3864− 123 123 123 123
3865− 1 1 1 1
2695+ 12 12 12 12
2696+ 123 123 123 123
2697+ 1 1 1 1
38662698
38672699 Table: Demonstration of simple table syntax.
38682700
3869−The header and table rows must each fit on one line. Column
2701+The headers and table rows must each fit on one line. Column
38702702alignments are determined by the position of the header text relative
38712703to the dashed line below it:[^4]
38722704
@@ -3885,22 +2717,22 @@ to the dashed line below it:[^4]
38852717The table must end with a blank line, or a line of dashes followed by
38862718a blank line.
38872719
3888−The column header row may be omitted, provided a dashed line is used
2720+The column headers may be omitted, provided a dashed line is used
38892721to end the table. For example:
38902722
38912723 ------- ------ ---------- -------
3892− 12 12 12 12
3893− 123 123 123 123
3894− 1 1 1 1
2724+ 12 12 12 12
2725+ 123 123 123 123
2726+ 1 1 1 1
38952727 ------- ------ ---------- -------
38962728
3897−When the header row is omitted, column alignments are determined on the basis
2729+When headers are omitted, column alignments are determined on the basis
38982730of the first line of the table body. So, in the tables above, the columns
38992731would be right, left, center, and right aligned, respectively.
39002732
39012733#### Extension: `multiline_tables` ####
39022734
3903−Multiline tables allow header and table rows to span multiple lines
2735+Multiline tables allow headers and table rows to span multiple lines
39042736of text (but cells that span multiple columns or rows of the table are
39052737not supported). Here is an example:
39062738
@@ -3909,11 +2741,11 @@ not supported). Here is an example:
39092741 Header Aligned Aligned Aligned
39102742 ----------- ------- --------------- -------------------------
39112743 First row 12.0 Example of a row that
3912− spans multiple lines.
2744+ spans multiple lines.
39132745
39142746 Second row 5.0 Here's another one. Note
3915− the blank line between
3916− rows.
2747+ the blank line between
2748+ rows.
39172749 -------------------------------------------------------------
39182750
39192751 Table: Here's the caption. It, too, may span
@@ -3922,7 +2754,7 @@ not supported). Here is an example:
39222754These work like simple tables, but with the following differences:
39232755
39242756 - They must begin with a row of dashes, before the header text
3925− (unless the header row is omitted).
2757+ (unless the headers are omitted).
39262758 - They must end with a row of dashes, then a blank line.
39272759 - The rows must be separated by blank lines.
39282760
@@ -3931,18 +2763,18 @@ the columns, and the writers try to reproduce these relative widths in
39312763the output. So, if you find that one of the columns is too narrow in the
39322764output, try widening it in the Markdown source.
39332765
3934−The header may be omitted in multiline tables as well as simple tables:
2766+Headers may be omitted in multiline tables as well as simple tables:
39352767
39362768 ----------- ------- --------------- -------------------------
39372769 First row 12.0 Example of a row that
3938− spans multiple lines.
2770+ spans multiple lines.
39392771
39402772 Second row 5.0 Here's another one. Note
3941− the blank line between
3942− rows.
2773+ the blank line between
2774+ rows.
39432775 ----------- ------- --------------- -------------------------
39442776
3945− : Here's a multiline table without a header.
2777+ : Here's a multiline table without headers.
39462778
39472779It is possible for a multiline table to have just one row, but the row
39482780should be followed by a blank line (and then the row of dashes that ends
@@ -3968,8 +2800,9 @@ The row of `=`s separates the header from the table body, and can be
39682800omitted for a headerless table. The cells of grid tables may contain
39692801arbitrary block elements (multiple paragraphs, code blocks, lists,
39702802etc.). Cells that span multiple columns or rows are not
3971−supported. Grid tables can be created easily using Emacs' table-mode
3972−(`M-x table-insert`).
2803+supported. Grid tables can be created easily using [Emacs table mode].
2804+
2805+[Emacs table mode]: http://table.sourceforge.net/
39732806
39742807Alignments can be specified as with pipe tables, by putting
39752808colons at the boundaries of the separator line after the
@@ -3997,7 +2830,7 @@ and the same number of rows in each column. For example, the
39972830Docutils [sample grid tables] will not render as expected with
39982831Pandoc.
39992832
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2833+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
40012834
40022835
40032836#### Extension: `pipe_tables` ####
@@ -4030,13 +2863,11 @@ legal (though ugly) pipe table:
40302863
40312864The cells of pipe tables cannot contain block elements like paragraphs
40322865and lists, and cannot span multiple lines. If a pipe table contains a
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
2866+row whose printable content is wider than the column width (see
2867+`--columns`), then the cell contents will wrap, with the
2868+relative cell widths determined by the widths of the separator
2869+lines. (In this case, the table will take up the full text
2870+width.) If no lines are wider than column width, then
40402871cell contents will not be wrapped, and the cells will be sized
40412872to their contents.
40422873
@@ -4054,7 +2885,8 @@ you'll need to add colons as above.
40542885
40552886[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
40562887
4057−## Metadata blocks
2888+Metadata blocks
2889+---------------
40582890
40592891#### Extension: `pandoc_title_block` ####
40602892
@@ -4070,42 +2902,30 @@ output.) The block may contain just a title, a title and an author,
40702902or all three elements. If you want to include an author but no
40712903title, or a title and a date but no author, you need a blank line:
40722904
4073−```
4074−%
4075−% Author
4076−```
2905+ %
2906+ % Author
40772907
4078−```
4079−% My title
4080−%
4081−% June 15, 2006
4082−```
2908+ % My title
2909+ %
2910+ % June 15, 2006
40832911
40842912The title may occupy multiple lines, but continuation lines must
40852913begin with leading space, thus:
40862914
4087−```
4088−% My title
4089− on multiple lines
4090−```
2915+ % My title
2916+ on multiple lines
40912917
40922918If a document has multiple authors, the authors may be put on
40932919separate lines with leading space, or separated by semicolons, or
40942920both. So, all of the following are equivalent:
40952921
4096−```
4097−% Author One
4098− Author Two
4099−```
2922+ % Author One
2923+ Author Two
41002924
4101−```
4102−% Author One; Author Two
4103−```
2925+ % Author One; Author Two
41042926
4105−```
4106−% Author One;
4107− Author Two
4108−```
2927+ % Author One;
2928+ Author Two
41092929
41102930The date must fit on one line.
41112931
@@ -4146,7 +2966,7 @@ will also have "Version 4.0" in the header.
41462966
41472967#### Extension: `yaml_metadata_block` ####
41482968
4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three
2969+A YAML metadata block is a valid YAML object, delimited by a line of three
41502970hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
41512971(`...`) at the bottom. A YAML metadata block may occur anywhere in the
41522972document, but if it is not at the beginning, it must be preceded by a blank
@@ -4157,53 +2977,41 @@ and pass it to pandoc as an argument, along with your Markdown files:
41572977 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
41582978
41592979Just be sure that the YAML file begins with `---` and ends with `---` or
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.
2980+`...`.)
41632981
41642982Metadata will be taken from the fields of the YAML object and added to any
41652983existing document metadata. Metadata can contain lists and objects (nested
41662984arbitrarily), but all string scalars will be interpreted as Markdown. Fields
41672985with names ending in an underscore will be ignored by pandoc. (They may be
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).
2986+given a role by external processors.)
41712987
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.
2988+A document may contain multiple metadata blocks. The metadata fields will
2989+be combined through a *left-biased union*: if two metadata blocks attempt
2990+to set the same field, the value from the first block will be taken.
41752991
41762992When pandoc is used with `-t markdown` to create a Markdown document,
41772993a YAML metadata block will be produced only if the `-s/--standalone`
41782994option is used. All of the metadata will appear in a single block
41792995at the beginning of the document.
41802996
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:
2997+Note that YAML escaping rules must be followed. Thus, for example,
2998+if a title contains a colon, it must be quoted. The pipe character
2999+(`|`) can be used to begin an indented block that will be interpreted
3000+literally, without need for escaping. This form is necessary
3001+when the field contains blank lines or block-level formatting:
41883002
41893003 ---
41903004 title: 'This is the title: it contains a colon'
41913005 author:
41923006 - Author One
41933007 - Author Two
4194− keywords: [nothing, nothingness]
3008+ tags: [nothing, nothingness]
41953009 abstract: |
41963010 This is the abstract.
41973011
41983012 It consists of two paragraphs.
41993013 ...
42003014
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−
42073015Template variables will be set automatically from the metadata. Thus, for
42083016example, in writing HTML, the variable `abstract` will be set to the HTML
42093017equivalent of the Markdown in the `abstract` field:
@@ -4244,31 +3052,13 @@ the [`raw_attribute` extension](#extension-raw_attribute)), or it
42443052will be interpreted as markdown. For example:
42453053
42463054 header-includes:
4247− - |
4248− ```{=latex}
3055+ - ```{=latex}
42493056 \let\oldsection\section
42503057 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
42513058 ```
42523059
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
3060+Backslash escapes
3061+-----------------
42723062
42733063#### Extension: `all_symbols_escapable` ####
42743064
@@ -4294,12 +3084,9 @@ which allows only the following characters to be backslash-escaped:
42943084(However, if the `markdown_strict` format is used, the standard Markdown rule
42953085will be used.)
42963086
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).
3087+A backslash-escaped space is parsed as a nonbreaking space. It will
3088+appear in TeX output as `~` and in HTML and XML as `\ ` or
3089+`\ `.
43033090
43043091A backslash-escaped newline (i.e. a backslash occurring at the end of
43053092a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +3096,8 @@ two trailing spaces on a line.
43093096
43103097Backslash escapes do not work in verbatim contexts.
43113098
4312−## Inline formatting
3099+Inline formatting
3100+-----------------
43133101
43143102### Emphasis ###
43153103
@@ -4357,13 +3145,12 @@ text by `~` characters. Thus, for example,
43573145
43583146 H~2~O is a liquid. 2^10^ is 1024.
43593147
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~`.
3148+If the superscripted or subscripted text contains spaces, these spaces
3149+must be escaped with backslashes. (This is to prevent accidental
3150+superscripting and subscripting through the ordinary use of `~` and `^`.)
3151+Thus, if you want the letter P with 'a cat' in subscripts, use
3152+`P~a\ cat~`, not `P~a cat~`.
3153+
43673154
43683155### Verbatim ###
43693156
@@ -4412,7 +3199,8 @@ For compatibility with other Markdown flavors, CSS is also supported:
44123199This will work in all output formats that support small caps.
44133200
44143201
4415−## Math
3202+Math
3203+----
44163204
44173205#### Extension: `tex_math_dollars` ####
44183206
@@ -4424,38 +3212,22 @@ left, and must not be followed immediately by a digit. Thus,
44243212you need to enclose text in literal `$` characters, backslash-escape
44253213them and they won't be treated as math delimiters.
44263214
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−
44313215TeX math will be printed in all output formats. How it is rendered
44323216depends on the output format:
44333217
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}}`.
3218+Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
3219+ ~ It will appear verbatim between `$` characters.
44443220
44453221reStructuredText
44463222 ~ It will be rendered using an [interpreted text role `:math:`].
44473223
44483224AsciiDoc
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.
3225+ ~ It will be rendered as `latexmath:[...]`.
44543226
44553227Texinfo
44563228 ~ It will be rendered inside a `@math` command.
44573229
4458−roff man, Jira markup
3230+groff man
44593231 ~ It will be rendered verbatim without `$`'s.
44603232
44613233MediaWiki, DokuWiki
@@ -4489,9 +3261,10 @@ HTML, Slidy, DZSlides, S5, EPUB
44893261 command-line options selected. Therefore see [Math rendering in HTML]
44903262 above.
44913263
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3264+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
44933265
4494−## Raw HTML
3266+Raw HTML
3267+--------
44953268
44963269#### Extension: `raw_html` ####
44973270
@@ -4502,17 +3275,8 @@ Markdown allows it, but it has been made an extension so that it can
45023275be disabled if desired.)
45033276
45043277The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
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.
3278+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3279+in other formats.
45163280
45173281#### Extension: `markdown_in_html_blocks` ####
45183282
@@ -4529,7 +3293,7 @@ Thus, for example, pandoc will turn
45293293 <table>
45303294 <tr>
45313295 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3296+ <td>[a link](http://google.com)</td>
45333297 </tr>
45343298 </table>
45353299
@@ -4538,14 +3302,14 @@ into
45383302 <table>
45393303 <tr>
45403304 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3305+ <td><a href="http://google.com">a link</a></td>
45423306 </tr>
45433307 </table>
45443308
45453309whereas `Markdown.pl` will preserve it as is.
45463310
4547−There is one exception to this rule: text between `<script>`,
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3311+There is one exception to this rule: text between `<script>` and
3312+`<style>` tags is not interpreted as Markdown.
45493313
45503314This departure from standard Markdown should make it easier to mix
45513315Markdown with HTML block elements. For example, one can surround
@@ -4587,10 +3351,6 @@ Note that in LaTeX environments, like
45873351the material between the begin and end tags will be interpreted as raw
45883352LaTeX, not as Markdown.
45893353
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−
45943354Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
45953355Emacs Org mode, and ConTeXt.
45963356
@@ -4601,7 +3361,7 @@ Emacs Org mode, and ConTeXt.
46013361Inline spans and fenced code blocks with a special
46023362kind of attribute will be parsed as raw content with the
46033363designated format. For example, the following produces a raw
4604−roff `ms` block:
3364+groff `ms` block:
46053365
46063366 ```{=ms}
46073367 .MYMACRO
@@ -4611,24 +3371,9 @@ And the following produces a raw `html` inline element:
46113371
46123372 This is `<a>html</a>`{=html}
46133373
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−
46253374The format name should match the target format name (see
46263375`-t/--to`, above, for a list, or use `pandoc
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`).
3376+--list-output-formats`).
46323377
46333378This extension presupposes that the relevant kind of
46343379inline code or fenced code block is enabled. Thus, for
@@ -4637,11 +3382,12 @@ example, to use a raw attribute with a backtick code block,
46373382
46383383The raw attribute cannot be combined with regular attributes.
46393384
4640−## LaTeX macros
3385+LaTeX macros
3386+------------
46413387
46423388#### Extension: `latex_macros` ####
46433389
4644−When this extension is enabled, pandoc will parse LaTeX
3390+For output formats other than LaTeX, pandoc will parse LaTeX
46453391macro definitions and apply the resulting macros to all LaTeX
46463392math and raw LaTeX. So, for example, the following will work in
46473393all output formats, not just LaTeX:
@@ -4651,20 +3397,18 @@ all output formats, not just LaTeX:
46513397 $\tuple{a, b, c}$
46523398
46533399Note that LaTeX macros will not be applied if they occur
4654−inside a raw span or block marked with the
3400+inside inside a raw span or block marked with the
46553401[`raw_attribute` extension](#extension-raw_attribute).
46563402
46573403When `latex_macros` is disabled, the raw LaTeX and math will
46583404not have macros applied. This is usually a better approach when
46593405you are targeting LaTeX or PDF.
46603406
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.
3407+Whether or not `latex_macros` is enabled, the macro definitions
3408+will still be passed through as raw LaTeX.
46663409
4667−## Links
3410+Links
3411+-----
46683412
46693413Markdown allows links to be specified in several ways.
46703414
@@ -4673,7 +3417,7 @@ Markdown allows links to be specified in several ways.
46733417If you enclose a URL or email address in pointy brackets, it
46743418will become a link:
46753419
4676− <https://google.com>
3420+ <http://google.com>
46773421 <sam@green.eggs.ham>
46783422
46793423### Inline links ###
@@ -4683,7 +3427,7 @@ followed by the URL in parentheses. (Optionally, the URL can
46833427be followed by a link title, in quotes.)
46843428
46853429 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3430+ a title](http://fsf.org "click here for a good time!").
46873431
46883432There can be no space between the bracketed part and the parenthesized part.
46893433The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3456,7 @@ Here are some examples:
47123456
47133457 [my label 1]: /foo/bar.html "My title, optional"
47143458 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3459+ [my label 3]: http://fsf.org (The free software foundation)
47163460 [my label 4]: /bar#special 'A title in single quotes'
47173461
47183462The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3465,7 @@ The URL may optionally be surrounded by angle brackets:
47213465
47223466The title may go on the next line:
47233467
4724− [my label 3]: https://fsf.org
3468+ [my label 3]: http://fsf.org
47253469 "The free software foundation"
47263470
47273471Note that link labels are not case sensitive. So, this will work:
@@ -4759,7 +3503,7 @@ be omitted entirely:
47593503### Internal links ###
47603504
47613505To link to another section of the same document, use the automatically
4762−generated identifier (see [Heading identifiers]). For example:
3506+generated identifier (see [Header identifiers]). For example:
47633507
47643508 See the [Introduction](#introduction).
47653509
@@ -4772,7 +3516,8 @@ or
47723516Internal links are currently supported for HTML formats (including
47733517HTML slide shows and EPUB), LaTeX, and ConTeXt.
47743518
4775−## Images
3519+Images
3520+------
47763521
47773522A link immediately preceded by a `!` will be treated as an image.
47783523The link text will be used as the image's alt text:
@@ -4818,11 +3563,10 @@ Attributes can be set on links and images:
48183563(This syntax is compatible with [PHP Markdown Extra] when only `#id`
48193564and `.class` are used.)
48203565
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.
3566+For HTML and EPUB, all attributes except `width` and `height` (but
3567+including `srcset` and `sizes`) are passed through as is. The other
3568+writers ignore attributes that are not supported by their output
3569+format.
48263570
48273571The `width` and `height` attributes on images are treated specially. When
48283572used without a unit, the unit is assumed to be pixels. However, any of
@@ -4834,27 +3578,24 @@ For example:
48343578{ width=50% }
48353579```
48363580
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).
3581+- Dimensions are converted to inches for output in page-based formats like
3582+ LaTeX. Dimensions are converted to pixels for output in HTML-like
3583+ formats. Use the `--dpi` option to specify the number of pixels per
3584+ inch. The default is 96dpi.
48433585- The `%` unit is generally relative to some available space.
4844− For example the above example will render to the following.
4845− - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847− (If you're using a custom template, you need to configure `graphicx`
4848− as in the default template.)
4849− - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3586+ For example the above example will render to
3587+ `<img href="file.jpg" style="width: 50%;" />` (HTML),
3588+ `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3589+ `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
48503590- Some output formats have a notion of a class
4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3591+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
48523592 or a unique identifier (LaTeX `\caption`), or both (HTML).
48533593- When no `width` or `height` attributes are specified, the fallback
48543594 is to look at the image resolution and the dpi metadata embedded in
48553595 the image file.
48563596
4857−## Divs and Spans
3597+Divs and Spans
3598+--------------
48583599
48593600Using the `native_divs` and `native_spans` extensions
48603601(see [above][Extension: `native_divs`]), HTML syntax can
@@ -4910,7 +3651,8 @@ followed immediately by attributes:
49103651
49113652 [This is *some text*]{.class key="val"}
49123653
4913−## Footnotes
3654+Footnotes
3655+---------
49143656
49153657#### Extension: `footnotes` ####
49163658
@@ -4922,14 +3664,14 @@ Pandoc's Markdown allows footnotes, using the following syntax:
49223664
49233665 [^longnote]: Here's one with multiple blocks.
49243666
4925− Subsequent paragraphs are indented to show that they
3667+ Subsequent paragraphs are indented to show that they
49263668 belong to the previous footnote.
49273669
4928− { some.code }
3670+ { some.code }
49293671
4930− The whole paragraph can be indented, or just the first
4931− line. In this way, multi-paragraph footnotes work like
4932− multi-paragraph list items.
3672+ The whole paragraph can be indented, or just the first
3673+ line. In this way, multi-paragraph footnotes work like
3674+ multi-paragraph list items.
49333675
49343676 This paragraph won't be part of the note, because it
49353677 isn't indented.
@@ -4956,72 +3698,134 @@ they cannot contain multiple paragraphs). The syntax is as follows:
49563698
49573699Inline and regular footnotes may be mixed freely.
49583700
4959−## Citation syntax
3701+Citations
3702+---------
49603703
49613704#### Extension: `citations` ####
49623705
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:
3706+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3707+citations and a bibliography in a number of styles. Basic usage is
3708+
3709+ pandoc --filter pandoc-citeproc myinput.txt
49663710
4967− Blah blah [@doe99; @smith2000; @smith2004].
3711+In order to use this feature, you will need to specify a bibliography file
3712+using the `bibliography` metadata field in a YAML metadata section, or
3713+`--bibliography` command line argument. You can supply multiple `--bibliography`
3714+arguments or set `bibliography` metadata field to YAML array, if you want to
3715+use multiple bibliography files. The bibliography may have any of these
3716+formats:
49683717
4969−How this is rendered depends on the citation style. In an
4970−author-date style, it might render as
3718+ Format File extension
3719+ ------------ --------------
3720+ BibLaTeX .bib
3721+ BibTeX .bibtex
3722+ Copac .copac
3723+ CSL JSON .json
3724+ CSL YAML .yaml
3725+ EndNote .enl
3726+ EndNote XML .xml
3727+ ISI .wos
3728+ MEDLINE .medline
3729+ MODS .mods
3730+ RIS .ris
49713731
4972− Blah blah (Doe 1999, Smith 2000, 2004).
3732+Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3733+use `.bibtex` to force BibTeX.
49733734
4974−In a footnote style, it might render as
3735+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3736+can produce `.json` and `.yaml` files from any of the supported formats.
49753737
4976− Blah blah.[^1]
3738+In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3739+a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
49773740
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).
3741+`<i>...</i>`
3742+: italics
3743+
3744+`<b>...</b>`
3745+: bold
3746+
3747+`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
3748+: small capitals
49813749
4982−See the [CSL user documentation] for more information about CSL
4983−styles and how they affect rendering.
3750+`<sub>...</sub>`
3751+: subscript
49843752
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]`.
3753+`<sup>...</sup>`
3754+: superscript
49943755
4995−Citation items may optionally include a prefix, a locator, and
4996−a suffix. In
3756+`<span class="nocase">...</span>`
3757+: prevent a phrase from being capitalized as title case
49973758
4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
3759+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3760+and CSL YAML formats as far as possible.
49993761
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.
3762+As an alternative to specifying a bibliography file using `--bibliography`
3763+or the YAML metadata field `bibliography`, you can include
3764+the citation data directly in the `references` field of the
3765+document's YAML metadata. The field should contain an array of
3766+YAML-encoded references, for example:
50033767
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.
3768+ ---
3769+ references:
3770+ - type: article-journal
3771+ id: WatsonCrick1953
3772+ author:
3773+ - family: Watson
3774+ given: J. D.
3775+ - family: Crick
3776+ given: F. H. C.
3777+ issued:
3778+ date-parts:
3779+ - - 1953
3780+ - 4
3781+ - 25
3782+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3783+ nucleic acid'
3784+ title-short: Molecular structure of nucleic acids
3785+ container-title: Nature
3786+ volume: 171
3787+ issue: 4356
3788+ page: 737-738
3789+ DOI: 10.1038/171737a0
3790+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
3791+ language: en-GB
3792+ ...
50173793
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:
3794+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3795+of the supported formats.)
50213796
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]
3797+Citations and references can be formatted using any style supported by the
3798+[Citation Style Language], listed in the [Zotero Style Repository].
3799+These files are specified using the `--csl` option or the `csl` metadata field.
3800+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3801+format. The CSL project provides further information on [finding and editing styles].
3802+
3803+To make your citations hyperlinks to the corresponding bibliography
3804+entries, add `link-citations: true` to your YAML metadata.
3805+
3806+Citations go inside square brackets and are separated by semicolons.
3807+Each citation must have a key, composed of '@' + the citation
3808+identifier from the database, and may optionally have a prefix,
3809+a locator, and a suffix. The citation key must begin with a letter, digit,
3810+or `_`, and may contain alphanumerics, `_`, and internal punctuation
3811+characters (`:.#$%&-+?<>~/`). Here are some examples:
3812+
3813+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3814+
3815+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3816+
3817+ Blah blah [@smith04; @doe99].
3818+
3819+`pandoc-citeproc` detects locator terms in the [CSL locale files].
3820+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3821+locale, locator terms can be written in either singular or plural forms,
3822+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3823+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3824+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3825+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3826+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3827+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3828+locator term is used, "page" is assumed.
50253829
50263830A minus sign (`-`) before the `@` will suppress mention of
50273831the author in the citation. This can be useful when the
@@ -5029,103 +3833,71 @@ author is already mentioned in the text:
50293833
50303834 Smith says blah [-@smith04].
50313835
5032−You can also write an author-in-text citation, by omitting the
5033−square brackets:
3836+You can also write an in-text citation, as follows:
50343837
50353838 @smith04 says blah.
50363839
50373840 @smith04 [p. 33] says blah.
50383841
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
3842+If the style calls for a list of works cited, it will be placed
3843+at the end of the document. Normally, you will want to end your
3844+document with an appropriate header:
3845+
3846+ last paragraph...
3847+
3848+ # References
3849+
3850+The bibliography will be inserted after this header. Note that
3851+the `unnumbered` class will be added to this header, so that the
3852+section will not be numbered.
3853+
3854+If you want to include items in the bibliography without actually
3855+citing them in the body text, you can define a dummy `nocite` metadata
3856+field and put the citations there:
3857+
3858+ ---
3859+ nocite: |
3860+ @item1, @item2
3861+ ...
3862+
3863+ @item3
3864+
3865+In this example, the document will contain a citation for `item3`
3866+only, but the bibliography will contain entries for `item1`, `item2`, and
3867+`item3`.
3868+
3869+It is possible to create a bibliography with all the citations,
3870+whether or not they appear in the document, by using a wildcard:
3871+
3872+ ---
3873+ nocite: |
3874+ @*
3875+ ...
3876+
3877+For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3878+to render bibliography. In order to do so, specify bibliography files as
3879+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3880+invocation. Bear in mind that bibliography files have to be in respective
3881+format (either BibTeX or BibLaTeX).
3882+
3883+For more information, see the [pandoc-citeproc man page].
3884+
3885+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3886+[Chicago Manual of Style]: http://chicagomanualofstyle.org
3887+[Citation Style Language]: http://citationstyles.org
50563888[Zotero Style Repository]: https://www.zotero.org/styles
5057−[finding and editing styles]: https://citationstyles.org/authors/
3889+[finding and editing styles]: http://citationstyles.org/styles/
50583890[CSL locale files]: https://github.com/citation-style-language/locales
3891+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
50593892
5060−## Non-default extensions
3893+Non-pandoc extensions
3894+---------------------
50613895
50623896The following Markdown syntax extensions are not enabled by default
50633897in pandoc, but may be enabled by adding `+EXTENSION` to the format
50643898name, where `EXTENSION` is the name of the extension. Thus, for
50653899example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
50663900
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−
51293901#### Extension: `old_dashes` ####
51303902
51313903Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -5209,7 +3981,7 @@ the document, for example:
52093981 Author: John Doe
52103982 Date: September 1, 2008
52113983 Comment: This is a sample mmd title block, with
5212− a field spanning multiple lines.
3984+ a field spanning multiple lines.
52133985
52143986See the MultiMarkdown documentation for details. If `pandoc_title_block` or
52153987`yaml_metadata_block` is enabled, it will take precedence over
@@ -5238,13 +4010,13 @@ and image references. This extension should not be confused with the
52384010
52394011 This is a reference ![image][ref] with multimarkdown attributes.
52404012
5241− [ref]: https://path.to/image "Image title" width=20px height=30px
5242− id=myId class="myClass1 myClass2"
4013+ [ref]: http://path.to/image "Image title" width=20px height=30px
4014+ id=myId class="myClass1 myClass2"
52434015
52444016#### Extension: `mmd_header_identifiers` ####
52454017
5246−Parses multimarkdown style heading identifiers (in square brackets,
5247−after the heading but before any trailing `#`s in an ATX heading).
4018+Parses multimarkdown style header identifiers (in square brackets,
4019+after the header but before any trailing `#`s in an ATX header).
52484020
52494021#### Extension: `compact_definition_lists` ####
52504022
@@ -5263,400 +4035,66 @@ in several respects:
52634035[^6]: To see why laziness is incompatible with relaxing the requirement
52644036 of a blank line between items, consider the following example:
52654037
5266− bar
5267− : definition
5268− foo
5269− : definition
4038+ bar
4039+ : definition
4040+ foo
4041+ : definition
52704042
52714043 Is this a single list item with two definitions of "bar," the first of
52724044 which is lazily wrapped, or two list items? To remove the ambiguity
52734045 we must either disallow lazy wrapping or require a blank line between
52744046 list items.
52754047
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
4048+Markdown variants
4049+-----------------
52924050
52934051In addition to pandoc's extended Markdown, the following Markdown
52944052variants are supported:
52954053
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
5320−citations and a bibliography in a number of styles. Basic usage is
5321−
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
5332−
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:
5339−
5340− Format File extension
5341− ------------ --------------
5342− BibLaTeX .bib
5343− BibTeX .bibtex
5344− CSL JSON .json
5345− CSL YAML .yaml
5346−
5347−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
5349−
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]:
5354−
5355−`<i>...</i>`
5356−: italics
5357−
5358−`<b>...</b>`
5359−: bold
5360−
5361−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5362−: small capitals
5363−
5364−`<sub>...</sub>`
5365−: subscript
5366−
5367−`<sup>...</sup>`
5368−: superscript
5369−
5370−`<span class="nocase">...</span>`
5371−: prevent a phrase from being capitalized as title case
5372−
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:
5378−
5379− ---
5380− references:
5381− - type: article-journal
5382− id: WatsonCrick1953
5383− author:
5384− - family: Watson
5385− given: J. D.
5386− - family: Crick
5387− given: F. H. C.
5388− issued:
5389− date-parts:
5390− - - 1953
5391− - 4
5392− - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
5394− deoxyribose nucleic acid'
5395− title-short: Molecular structure of nucleic acids
5396− container-title: Nature
5397− volume: 171
5398− issue: 4356
5399− page: 737-738
5400− DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
5402− language: en-GB
5403− ...
5404−
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.
5408−
5409−Note that `pandoc` can be used to produce such a YAML metadata
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5411−
5412− pandoc chem.bib -s -f biblatex -t markdown
5413− pandoc chem.json -s -f csljson -t markdown
5414−
5415−Indeed, `pandoc` can convert between any of these
5416−citation formats:
5417−
5418− pandoc chem.bib -s -f biblatex -t csljson
5419− pandoc chem.yaml -s -f markdown -t biblatex
5420−
5421−Running pandoc on a bibliography file with the `--citeproc`
5422−option will create a formatted bibliography in the format
5423−of your choice:
5424−
5425− pandoc chem.bib -s --citeproc -o chem.html
5426− pandoc chem.bib -s --citeproc -o chem.pdf
5427−
5428−### Capitalization in titles
5429−
5430−If you are using a bibtex or biblatex bibliography, then observe
5431−the following rules:
5432−
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`.)
5438−
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:
5442−
5443− title = {My Dinner with {Andre}}
5444−
5445− - In addition, words that should remain lowercase (or camelCase)
5446− should be protected:
5447−
5448− title = {Spin Wave Dispersion on the {nm} Scale}
5449−
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.
5454−
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
5456−the following rules:
5457−
5458− - All titles should be in sentence case.
5459−
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.)
5463−
5464− - Protect words that should not be converted to title case using
5465− this syntax:
5466−
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
5468−
5469−### Conference Papers, Published vs. Unpublished
5470−
5471−For a formally published conference paper, use the biblatex entry type
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
5473−
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`).
5477−
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.
5487−
5488−
5489−## Specifying a citation style
5490−
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:
5507−
5508−
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− }
5517−
5518−
5519−## Citations in note styles
5520−
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,
5527−
5528− Blah blah [@foo, p. 33].
5529−
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].
5535−
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:
5541−
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].
5545−
5546−## Raw content in a style
5547−
5548−To include raw content in a prefix, suffix, delimiter, or term,
5549−surround it with these tags indicating the format:
5550−
5551− {{jats}}<ref>{{/jats}}
5552−
5553−Without the tags, the string will be interpreted as a string
5554−and escaped in the output, rather than being passed through raw.
5555−
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.
5560−
5561−
5562−
5563−## Placement of the bibliography
5564−
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:
5567−
5568− ::: {#refs}
5569− :::
5570−
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.
5574−
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:
5579−
5580− last paragraph...
5581−
5582− # References
5583−
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.
5587−
5588−## Including uncited items in the bibliography
5589−
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:
5593−
5594− ---
5595− nocite: |
5596− @item1, @item2
5597− ...
5598−
5599− @item3
5600−
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`.
5604−
5605−It is possible to create a bibliography with all the citations,
5606−whether or not they appear in the document, by using a wildcard:
5607−
5608− ---
5609− nocite: |
5610− @*
5611− ...
5612−
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.
5619−
5620−## Other relevant metadata fields
5621−
5622−A few other metadata fields affect bibliography formatting:
5623−
5624−`link-citations`
5625−: If true, citations will be
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
5628−
5629−`lang`
5630−: The `lang` field will affect how the style is localized,
5631− for example in the translation of labels, the use
5632− of quotation marks, and the way items are sorted.
5633− (For backwards compatibility, `locale` may be used instead
5634− of `lang`, but this use is deprecated.)
5635−
5636− A BCP 47 language tag is expected: for example, `en`,
5637− `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
5638− syntax (after `-u-`) may be used to specify options for
5639− collation (sorting) more precisely. Here are some examples:
5640−
5641− - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642− - `es-u-co-trad` -- Spanish with the traditional collation
5643− (with `Ch` sorting after `C`).
5644− - `fr-u-kb` -- French with "backwards" accent sorting
5645− (with `coté` sorting after `côte`).
5646− - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647− before lower (default is lower before upper).
5648−
5649−`notes-after-punctuation`
5650−: If true (the default), pandoc will put footnote citations
5651− after following punctuation. For example, if the source
5652− contains `blah blah [@jones99].`, the result will look like
5653− `blah blah.[^1]`, with the note moved after the period and
5654− the space collapsed. If false, the space will still be
5655− collapsed, but the footnote will not be moved after the
5656− punctuation.
5657−
5658−
5659−# Slide shows
4054+`markdown_phpextra` (PHP Markdown Extra)
4055+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4056+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4057+ `header_attributes`, `link_attributes`, `abbreviations`,
4058+ `shortcut_reference_links`, `spaced_reference_links`.
4059+
4060+`markdown_github` (deprecated GitHub-Flavored Markdown)
4061+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4062+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4063+ `space_in_atx_header`, `intraword_underscores`, `strikeout`,
4064+ `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
4065+ `lists_without_preceding_blankline`.
4066+
4067+`markdown_mmd` (MultiMarkdown)
4068+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4069+ `tex_math_double_backslash`, `intraword_underscores`,
4070+ `mmd_title_block`, `footnotes`, `definition_lists`,
4071+ `all_symbols_escapable`, `implicit_header_references`,
4072+ `auto_identifiers`, `mmd_header_identifiers`,
4073+ `shortcut_reference_links`, `implicit_figures`,
4074+ `superscript`, `subscript`, `backtick_code_blocks`,
4075+ `spaced_reference_links`, `raw_attribute`.
4076+
4077+`markdown_strict` (Markdown.pl)
4078+: `raw_html`, `shortcut_reference_links`,
4079+ `spaced_reference_links`.
4080+
4081+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4082+which is implemented as a set of extensions on `commonmark`).
4083+
4084+Note, however, that `commonmark` and `gfm` have limited support
4085+for extensions. Only those listed below (and `smart` and
4086+`raw_tex`) will work. The extensions can, however, all be
4087+individually disabled.
4088+Also, `raw_tex` only affects `gfm` output, not input.
4089+
4090+`gfm` (GitHub-Flavored Markdown)
4091+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4092+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4093+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4094+ `shortcut_reference_links`, `angle_brackets_escapable`.
4095+
4096+Producing slide shows with pandoc
4097+=================================
56604098
56614099You can use pandoc to produce an HTML + JavaScript slide presentation
56624100that can be viewed via a web browser. There are five ways to do this,
@@ -5704,21 +4142,18 @@ To produce an HTML/JavaScript slide show, simply type
57044142
57054143where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
57064144
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.
4145+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4146+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4147+assumed to be available at the relative path `s5/default` (for S5), `slideous`
4148+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4149+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4150+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4151+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4152+the file by default.
4153+
4154+With all HTML slide formats, the `--self-contained` option can be used to
4155+produce a single file that contains all of the data necessary to display the
4156+slide show, including linked scripts, stylesheets, images, and videos.
57224157
57234158To produce a PDF slide show using beamer, type
57244159
@@ -5731,13 +4166,14 @@ To produce a Powerpoint slide show, type
57314166
57324167 pandoc habits.txt -o habits.pptx
57334168
5734−## Structuring the slide show
4169+Structuring the slide show
4170+--------------------------
57354171
5736−By default, the *slide level* is the highest heading level in
4172+By default, the *slide level* is the highest header level in
57374173the hierarchy that is followed immediately by content, and not another
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
4174+header, somewhere in the document. In the example above, level 1 headers
4175+are always followed by level 2 headers, which are followed by content,
4176+so 2 is the slide level. This default can be overridden using
57414177the `--slide-level` option.
57424178
57434179The document is carved up into slides according to the following
@@ -5745,21 +4181,17 @@ rules:
57454181
57464182 * A horizontal rule always starts a new slide.
57474183
5748− * A heading at the slide level always starts a new slide.
4184+ * A header at the slide level always starts a new slide.
57494185
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.)
4186+ * Headers *below* the slide level in the hierarchy create
4187+ headers *within* a slide.
57564188
5757− * Headings *above* the slide level in the hierarchy create
4189+ * Headers *above* the slide level in the hierarchy create
57584190 "title slides," which just contain the section title
57594191 and help to break the slide show into sections.
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).
4192+
4193+ * Content *above* the slide level will not appear in the slide
4194+ show.
57634195
57644196 * A title page is constructed automatically from the document's title
57654197 block, if present. (In the case of beamer, this can be disabled
@@ -5767,57 +4199,32 @@ rules:
57674199
57684200These rules are designed to support many different styles of slide show. If
57694201you don't care about structuring your slides into sections and subsections,
5770−you can just use level-1 headings for all each slide. (In that case, level-1
4202+you can just use level 1 headers for all each slide. (In that case, level 1
57714203will be the slide level.) But you can also structure the slide show into
57724204sections, as in the example above.
57734205
57744206Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5775−layout will be produced, with level-1 headings building horizontally
5776−and level-2 headings building vertically. It is not recommended that
4207+layout will be produced, with level 1 headers building horizontally
4208+and level 2 headers building vertically. It is not recommended that
57774209you use deeper nesting of section levels with reveal.js.
57784210
5779−## Incremental lists
4211+Incremental lists
4212+-----------------
57804213
57814214By default, these writers produce lists that display "all at once."
57824215If you want your lists to display incrementally (one item at a time),
57834216use the `-i` option. If you want a particular list to depart from the
5784−default, put it in a `div` block with class `incremental` or
5785−`nonincremental`. So, for example, using the `fenced div` syntax, the
5786−following would be incremental regardless of the document default:
5787−
5788− ::: incremental
5789−
5790− - Eat spaghetti
5791− - Drink wine
5792−
5793− :::
5794−
5795−or
5796−
5797− ::: nonincremental
5798−
5799− - Eat spaghetti
5800− - Drink wine
5801−
5802− :::
5803−
5804−While using `incremental` and `nonincremental` divs are the
5805−recommended method of setting incremental lists on a per-case basis,
5806−an older method is also supported: putting lists inside a blockquote
5807−will depart from the document default (that is, it will display
5808−incrementally without the `-i` option and all at once with the `-i`
5809−option):
4217+default (that is, to display incrementally without the `-i` option and
4218+all at once with the `-i` option), put it in a block quote:
58104219
58114220 > - Eat spaghetti
58124221 > - Drink wine
58134222
5814−Both methods allow incremental and nonincremental lists to be mixed
5815−in a single document.
4223+In this way incremental and nonincremental lists can be mixed in
4224+a single document.
58164225
5817−Note: Neither the `-i/--incremental` option nor any of the
5818−methods described here currently works for PowerPoint output.
5819−
5820−## Inserting pauses
4226+Inserting pauses
4227+----------------
58214228
58224229You can add "pauses" within a slide by including a paragraph containing
58234230three dots, separated by spaces:
@@ -5830,9 +4237,8 @@ three dots, separated by spaces:
58304237
58314238 content after the pause
58324239
5833−Note: this feature is not yet implemented for PowerPoint output.
5834−
5835−## Styling the slides
4240+Styling the slides
4241+------------------
58364242
58374243You can change the style of HTML slides by putting customized CSS files
58384244in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5857,9 +4263,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
58574263
58584264 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
58594265
5860−Note that heading attributes will turn into slide attributes
4266+Note that header attributes will turn into slide attributes
58614267(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5862−to style individual slides. In beamer, the only heading attribute
4268+to style individual slides. In beamer, the only header attribute
58634269that affects slides is the `allowframebreaks` class, which sets the
58644270`allowframebreaks` option, causing multiple slides to be created
58654271if the content overfills the frame. This is recommended especially for
@@ -5867,10 +4273,11 @@ bibliographies:
58674273
58684274 # References {.allowframebreaks}
58694275
5870−## Speaker notes
4276+Speaker notes
4277+-------------
58714278
5872−Speaker notes are supported in reveal.js and PowerPoint (pptx)
5873−output. You can add notes to your Markdown document thus:
4279+reveal.js has good support for speaker notes. You can add notes to your
4280+Markdown document thus:
58744281
58754282 ::: notes
58764283
@@ -5881,14 +4288,12 @@ output. You can add notes to your Markdown document thus:
58814288
58824289 :::
58834290
5884−To show the notes window in reveal.js, press `s` while viewing the
5885−presentation. Speaker notes in PowerPoint will be available, as usual,
5886−in handouts and presenter view.
5887−
4291+To show the notes window, press `s` while viewing the presentation.
58884292Notes are not yet supported for other slide formats, but the notes
58894293will not appear on the slides themselves.
58904294
5891−## Columns
4295+Columns
4296+-------
58924297
58934298To put material in side by side columns, you can use a native
58944299div container with class `columns`, containing two or more div
@@ -5903,46 +4308,12 @@ containers with class `column` and a `width` attribute:
59034308 :::
59044309 ::::::::::::::
59054310
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
4311+Frame attributes in beamer
4312+--------------------------
59424313
59434314Sometimes it is necessary to add the LaTeX `[fragile]` option to
59444315a frame in beamer (for example, when using the `minted` environment).
5945−This can be forced by adding the `fragile` class to the heading
4316+This can be forced by adding the `fragile` class to the header
59464317introducing the slide:
59474318
59484319 # Fragile slide {.fragile}
@@ -5950,64 +4321,13 @@ introducing the slide:
59504321All of the other frame attributes described in Section 8.1 of
59514322the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
59524323`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5953−`shrink`, `standout`, `noframenumbering`.
5954−
5955−## Background in reveal.js and beamer
5956−
5957−Background images can be added to self-contained reveal.js slideshows and
5958−to beamer slideshows.
5959−
5960−For the same image on every slide, use the configuration
5961−option `background-image` either in the YAML metadata block
5962−or as a command-line variable. (There are no other options in
5963−beamer and the rest of this section concerns reveal.js slideshows.)
5964−
5965−For reveal.js, you can instead use the reveal.js-native option
5966−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967−and `parallaxBackgroundVertical` the same way and must also set
5968−`parallaxBackgroundSize` to have your values take effect.
5969−
5970−To set an image for a particular reveal.js slide, add
5971−`{data-background-image="/path/to/image"}`
5972−to the first slide-level heading on the slide (which may even be empty).
5973−
5974−In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975−only on the first slide.
5976−
5977−Other reveal.js background settings also work on individual slides, including
5978−`data-background-size`, `data-background-repeat`, `data-background-color`,
5979−`data-transition`, and `data-transition-speed`.
5980−
5981−To add a background image to the automatically generated title slide, use the
5982−`title-slide-attributes` variable in the YAML metadata block. It must contain
5983−a map of attribute names and values.
5984−
5985−See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986−details.
5987−
5988−For example in reveal.js:
5989−
5990−```
5991−---
5992−title: My Slideshow
5993−parallaxBackgroundImage: /path/to/my/background_image.png
5994−title-slide-attributes:
5995− data-background-image: /path/to/title_image.png
5996− data-background-size: contain
5997−---
5998−
5999−## Slide One
6000−
6001−Slide 1 has background_image.png as its background.
6002−
6003−## {data-background-image="/path/to/special_image.jpg"}
4324+`shrink`.
60044325
6005−Slide 2 has a special image for its background, even though the heading has no content.
6006−```
6007−
6008−# EPUBs
4326+Creating EPUBs with pandoc
4327+==========================
60094328
6010−## EPUB Metadata
4329+EPUB Metadata
4330+-------------
60114331
60124332EPUB metadata may be specified using the `--epub-metadata` option, but
60134333if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,20 +4405,11 @@ The following fields are recognized:
60854405
60864406`rights`
60874407 ~ 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.
60974408
60984409`cover-image`
60994410 ~ A string value (path to cover image).
61004411
6101−`css` (or legacy: `stylesheet`)
4412+`stylesheet`
61024413 ~ A string value (path to CSS stylesheet).
61034414
61044415`page-progression-direction`
@@ -6115,200 +4426,32 @@ The following fields are recognized:
61154426 - `binding`: `true`|`false` (default `true`)
61164427 - `scroll-axis`: `vertical`|`horizontal`|`default`
61174428
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4429+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
61194430[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
61204431
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
4432+Linked media
4433+------------
4434+
4435+By default, pandoc will download linked media (including audio and
4436+video) and include it in the EPUB container, yielding a completely
61704437self-contained EPUB. If you want to link to external media resources
61714438instead, use raw HTML in your source and add `data-external="1"` to the tag
61724439with the `src` attribute. For example:
61734440
61744441 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
6176− data-external="1" type="audio/mpeg">
4442+ <source src="http://example.com/music/toccata.mp3"
4443+ data-external="1" type="audio/mpeg">
61774444 </source>
61784445 </audio>
61794446
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
4447+Syntax highlighting
4448+===================
63064449
63074450Pandoc will automatically highlight syntax in [fenced code blocks] that
63084451are marked with a language name. The Haskell library [skylighting] is
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`.
4452+used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4453+To see a list of language names that pandoc will recognize, type
4454+`pandoc --list-highlight-languages`.
63124455
63134456The color scheme can be selected using the `--highlight-style` option.
63144457The default color scheme is `pygments`, which imitates the default color
@@ -6316,36 +4459,15 @@ scheme used by the Python library pygments (though pygments is not actually
63164459used to do the highlighting). To see a list of highlight styles,
63174460type `pandoc --list-highlight-styles`.
63184461
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−
63374462To disable highlighting, use the `--no-highlight` option.
63384463
63394464[skylighting]: https://github.com/jgm/skylighting
63404465
6341−# Custom Styles
6342−
6343−Custom styles can be used in the docx and ICML formats.
6344−
6345−## Output
4466+Custom Styles in Docx Output
4467+============================
63464468
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
4469+By default, pandoc's docx output applies a predefined set of styles for
4470+blocks such as paragraphs and block quotes, and uses largely default
63494471formatting (italics, bold) for inlines. This will work for most
63504472purposes, especially alongside a `reference.docx` file. However, if you
63514473need to apply your own styles to blocks, or match a preexisting set of
@@ -6353,10 +4475,8 @@ styles, pandoc allows you to define custom styles for blocks and text
63534475using `div`s and `span`s, respectively.
63544476
63554477If 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,
4478+pandoc will apply your specified style to the contained elements. So,
4479+for example using the `bracketed_spans` syntax,
63604480
63614481 [Get out]{custom-style="Emphatically"}, he said.
63624482
@@ -6372,9 +4492,9 @@ style `Emphatically`. Similarly, using the `fenced_divs` syntax,
63724492
63734493would style the two contained lines with the `Poetry` paragraph style.
63744494
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.
4495+If the styles are not yet in your reference.docx, they will be defined
4496+in the output file as inheriting from normal text. If they are already
4497+defined, pandoc will not alter the definition.
63784498
63794499This feature allows for greatest customization in conjunction with
63804500[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -6384,137 +4504,34 @@ want all italics to be transformed to the `Emphasis` character style
63844504transform all italicized inlines to inlines within an `Emphasis`
63854505custom-style `span`.
63864506
6387−For docx output, you don't need to enable any extensions for
6388−custom styles to work.
6389−
6390−[pandoc filters]: https://pandoc.org/filters.html
6391−
6392−## Input
6393−
6394−The docx reader, by default, only reads those styles that it can
6395−convert into pandoc elements, either by direct conversion or
6396−interpreting the derivation of the input document's styles.
6397−
6398−By enabling the [`styles` extension](#ext-styles) in the docx reader
6399−(`-f docx+styles`), you can produce output that maintains the styles
6400−of the input document, using the `custom-style` class. Paragraph
6401−styles are interpreted as divs, while character styles are interpreted
6402−as spans.
4507+[pandoc filters]: http://pandoc.org/filters.html
64034508
6404−For example, using the `custom-style-reference.docx` file in the test
6405−directory, we have the following different outputs:
4509+Custom writers
4510+==============
64064511
6407−Without the `+styles` extension:
4512+Pandoc can be extended with custom writers written in [lua]. (Pandoc
4513+includes a lua interpreter, so lua need not be installed separately.)
64084514
6409− $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6410− This is some text.
6411−
6412− This is text with an *emphasized* text style. And this is text with a
6413− **strengthened** text style.
6414−
6415− > Here is a styled paragraph that inherits from Block Text.
6416−
6417−And with the extension:
6418−
6419− $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6420−
6421− ::: {custom-style="First Paragraph"}
6422− This is some text.
6423− :::
6424−
6425− ::: {custom-style="Body Text"}
6426− This is text with an [emphasized]{custom-style="Emphatic"} text style.
6427− And this is text with a [strengthened]{custom-style="Strengthened"}
6428− text style.
6429− :::
6430−
6431− ::: {custom-style="My Block Style"}
6432− > Here is a styled paragraph that inherits from Block Text.
6433− :::
6434−
6435−With these custom styles, you can use your input document as a
6436−reference-doc while creating docx output (see below), and maintain the
6437−same styles in your input and output files.
6438−
6439−# Custom writers
6440−
6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442−includes a Lua interpreter, so Lua need not be installed separately.)
6443−
6444−To use a custom writer, simply specify the path to the Lua script
4515+To use a custom writer, simply specify the path to the lua script
64454516in place of the output format. For example:
64464517
64474518 pandoc -t data/sample.lua
64484519
6449−Creating a custom writer requires writing a Lua function for each
4520+Creating a custom writer requires writing a lua function for each
64504521possible element in a pandoc document. To get a documented example
64514522which you can modify according to your needs, do
64524523
64534524 pandoc --print-default-data-file sample.lua
64544525
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
4526+[lua]: http://www.lua.org
4527+
4528+Authors
4529+=======
4530+
4531+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
65144532under the [GPL], version 2 or greater. This software carries no
65154533warranty of any kind. (See COPYRIGHT for full copyright and
65164534warranty notices.) For a full list of contributors, see the file
65174535AUTHORS.md in the pandoc source code.
65184536
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"
4537+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"