@@ -1,50 +1,34 @@
1−% Pandoc User's Guide
2+title: Pandoc User's Guide
2−% John MacFarlane
3+author: John MacFarlane
3−% October 27, 2017
4+date: June 20, 2021
8`pandoc` [*options*] [*input-file*]...
9`pandoc` [*options*] [*input-file*]...
10−Description
11+# Description
13Pandoc is a [Haskell] library for converting from one markup format to
13Pandoc is a [Haskell] library for converting from one markup format to
14−another, and a command-line tool that uses this library. It can read
14+another, and a command-line tool that uses this library.
15−[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
15+
16−Markdown], [MultiMarkdown], and (subsets of) [Textile],
16+Pandoc can convert between numerous markup and word processing formats,
17−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
17+including, but not limited to, various flavors of [Markdown], [HTML],
18−[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org mode],
18+[LaTeX] and [Word docx]. For the full lists of input and output formats,
19−[DocBook], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx];
19+see the `--from` and `--to` [options below][General options].
20−and it can write plain text, [Markdown], [CommonMark], [PHP Markdown
21−Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
22−[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
23−[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
24−[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
25−markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
26−[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28−Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
29−or [S5] HTML slide shows. It can also produce [PDF] output on
20+Pandoc can also produce [PDF] output: see [creating a PDF], below.
30−systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`,
21+
31−`prince`, or `weasyprint` is installed.
33−Pandoc's enhanced version of Markdown includes syntax for [footnotes],
22+Pandoc's enhanced version of Markdown includes syntax for [tables],
34−[tables], flexible [ordered lists], [definition lists], [fenced code
23+[definition lists], [metadata blocks], [footnotes], [citations], [math],
35−blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
24+and much more. See below under [Pandoc's Markdown].
36−automatic tables of contents, embedded LaTeX [math], [citations], and
25+
37−[Markdown inside HTML block elements][Extension:
38−`markdown_in_html_blocks`]. (These enhancements, described further under
39−[Pandoc's Markdown], can be disabled using the `markdown_strict` input
42−In contrast to most existing tools for converting Markdown to HTML, which
43−use regex substitutions, pandoc has a modular design: it consists of a
26+Pandoc has a modular design: it consists of a set of readers, which parse
44−set of readers, which parse text in a given format and produce a native
27+text in a given format and produce a native representation of the document
45−representation of the document, and a set of writers, which convert
28+(an _abstract syntax tree_ or AST), and a set of writers, which convert
46this native representation into a target format. Thus, adding an input
29this native representation into a target format. Thus, adding an input
47−or output format requires only adding a reader or writer.
30+or output format requires only adding a reader or writer. Users can also
31+run custom [pandoc filters] to modify the intermediate AST.
49Because pandoc's intermediate representation of a document is less
33Because pandoc's intermediate representation of a document is less
50expressive than many of the formats it converts between, one should
34expressive than many of the formats it converts between, one should
@@ -56,96 +40,33 @@ model. While conversions from pandoc's Markdown to all formats aspire
56to be perfect, conversions from formats more expressive than pandoc's
40to be perfect, conversions from formats more expressive than pandoc's
57Markdown can be expected to be lossy.
41Markdown can be expected to be lossy.
59−[Markdown]: http://daringfireball.net/projects/markdown/
60−[CommonMark]: http://commonmark.org
61−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65−[S5]: http://meyerweb.com/eric/tools/s5/
66−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67−[Slideous]: http://goessner.net/articles/slideous/
68−[HTML]: http://www.w3.org/html/
69−[HTML5]: http://www.w3.org/TR/html5/
70−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71−[XHTML]: http://www.w3.org/TR/xhtml1/
72−[LaTeX]: http://latex-project.org
73−[`beamer`]: https://ctan.org/pkg/beamer
74−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75−[ConTeXt]: http://www.contextgarden.net/
76−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77−[DocBook]: http://docbook.org
78−[txt2tags]: http://txt2tags.org
79−[EPUB]: http://idpf.org/epub
80−[OPML]: http://dev.opml.org/spec2.html
81−[OpenDocument]: http://opendocument.xml.org
82−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83−[Textile]: http://redcloth.org/textile
84−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
91−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
92−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
93−[Haskell]: https://www.haskell.org
94−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
95−[Emacs Org mode]: http://orgmode.org
96−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
97−[DZSlides]: http://paulrouget.com/dzslides/
98−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
99−[PDF]: https://www.adobe.com/pdf/
100−[reveal.js]: http://lab.hakim.se/reveal-js/
101−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
102−[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
103−[TEI Simple]: https://github.com/TEIC/TEI-Simple
104−[Muse]: https://amusewiki.org/library/manual
105−[Vimwiki]: https://vimwiki.github.io
107−Using `pandoc`
43+## Using pandoc
110−If no *input-file* is specified, input is read from *stdin*.
45+If no *input-files* are specified, input is read from *stdin*.
111−Otherwise, the *input-files* are concatenated (with a blank
112−line between each) and used as input. Output goes to *stdout* by
46+Output goes to *stdout* by default. For output to a file,
113−default (though output to the terminal is disabled for the
114−`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
115−forced using `-o -`). For output to a file, use the `-o`
116−option:
47+use the `-o` option:
118 pandoc -o output.html input.txt
49 pandoc -o output.html input.txt
120−By default, pandoc produces a document fragment, not a standalone
51+By default, pandoc produces a document fragment. To produce a standalone
121−document with a proper header and footer. To produce a standalone
52+document (e.g. a valid HTML file including `<head>` and `<body>`),
122−document, use the `-s` or `--standalone` flag:
53+use the `-s` or `--standalone` flag:
124 pandoc -s -o output.html input.txt
55 pandoc -s -o output.html input.txt
126For more information on how standalone documents are produced, see
57For more information on how standalone documents are produced, see
127−[Templates], below.
58+[Templates] below.
129−Instead of a file, an absolute URI may be given. In this case
130−pandoc will fetch the content using HTTP:
132− pandoc -f html -t markdown http://www.fsf.org
134−It is possible to supply a custom User-Agent string or other
135−header when requesting a document from a URL:
137− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
140If multiple input files are given, `pandoc` will concatenate them all (with
60If multiple input files are given, `pandoc` will concatenate them all (with
141−blank lines between them) before parsing. This feature is disabled for
61+blank lines between them) before parsing. (Use `--file-scope` to parse files
142− binary input formats such as `EPUB`, `odt`, and `docx`.
62+individually.)
144The format of the input and output can be specified explicitly using
66The format of the input and output can be specified explicitly using
145command-line options. The input format can be specified using the
67command-line options. The input format can be specified using the
146−`-r/--read` or `-f/--from` options, the output format using the
68+`-f/--from` option, the output format using the `-t/--to` option.
147−`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
148−Markdown to LaTeX, you could type:
69+Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
150 pandoc -f markdown -t latex hello.txt
71 pandoc -f markdown -t latex hello.txt
@@ -153,14 +74,15 @@ To convert `hello.html` from HTML to Markdown:
154 pandoc -f html -t markdown hello.html
75 pandoc -f html -t markdown hello.html
156−Supported output formats are listed below under the `-t/--to` option.
77+Supported input and output formats are listed below under [Options]
157−Supported input formats are listed below under the `-f/--from` option. Note
78+(see `-f` for input formats and `-t` for output formats). You
158−that the `rst`, `textile`, `latex`, and `html` readers are not complete;
79+can also use `pandoc --list-input-formats` and
159−there are some constructs that they do not parse.
80+`pandoc --list-output-formats` to print lists of supported
161If the input or output format is not specified explicitly, `pandoc`
83If the input or output format is not specified explicitly, `pandoc`
162−will attempt to guess it from the extensions of
84+will attempt to guess it from the extensions of the filenames.
163−the input and output filenames. Thus, for example,
85+Thus, for example,
165 pandoc -o hello.tex hello.txt
87 pandoc -o hello.tex hello.txt
@@ -169,7 +91,9 @@ is specified (so that output goes to *stdout*), or if the output file's
169extension is unknown, the output format will default to HTML.
91extension is unknown, the output format will default to HTML.
170If no input file is specified (so that input comes from *stdin*), or
92If no input file is specified (so that input comes from *stdin*), or
171if the input files' extensions are unknown, the input format will
93if the input files' extensions are unknown, the input format will
172−be assumed to be Markdown unless explicitly specified.
94+be assumed to be Markdown.
174Pandoc uses the UTF-8 character encoding for both input and output.
98Pandoc uses the UTF-8 character encoding for both input and output.
175If your local character encoding is not UTF-8, you
99If your local character encoding is not UTF-8, you
@@ -182,157 +106,247 @@ RTF, OPML, DocBook, and Texinfo), information about
182the character encoding is included in the document header, which
106the character encoding is included in the document header, which
183will only be included if you use the `-s/--standalone` option.
107will only be included if you use the `-s/--standalone` option.
185−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
187−Creating a PDF
111+## Creating a PDF
190−To produce a PDF, specify an output file with a `.pdf` extension.
113+To produce a PDF, specify an output file with a `.pdf` extension:
191−By default, pandoc will use LaTeX to create the PDF:
193 pandoc test.txt -o test.pdf
115 pandoc test.txt -o test.pdf
117+By default, pandoc will use LaTeX to create the PDF, which requires
195−Production of a PDF requires that a LaTeX engine be installed (see
118+that a LaTeX engine be installed (see `--pdf-engine` below).
196−`--pdf-engine`, below), and assumes that the following LaTeX packages
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`.
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`.
132+To debug the PDF creation, it can be useful to look at the intermediate
133+representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134+to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136+When using LaTeX, the following packages need to be available
137+(they are included with all recent versions of [TeX Live]):
197−are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
138+[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
198−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
199`--listings` option is used), [`fancyvrb`], [`longtable`],
140`--listings` option is used), [`fancyvrb`], [`longtable`],
200−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141+[`booktabs`], [`graphicx`] (if the document
201−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
142+contains images), [`hyperref`], [`xcolor`],
143+[`ulem`], [`geometry`] (with the `geometry` variable set),
202−`geometry` variable set), [`setspace`] (with `linestretch`), and
144+[`setspace`] (with `linestretch`), and
203[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
204−the LaTeX engine requires [`fontspec`]. `xelatex` uses
146+the PDF engine requires [`fontspec`]. `lualatex` uses
205−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
206−`dir` variable set). If the `mathspec` variable is set,
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
207−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
208−The [`upquote`] and [`microtype`] packages are used if
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
209−available, and [`csquotes`] will be used for [smart punctuation]
151+packages are used if available, and [`csquotes`] will be used
210−if added to the template or included in any header file. The
152+for [typography] if the `csquotes` variable or metadata field is
211−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
212−optionally be used for [citation rendering]. These are included
154+and [`biber`] packages can optionally be used for [citation
213−with all recent versions of [TeX Live].
155+rendering]. The following packages will be used to improve
214−
156+output quality if present, but pandoc does not require them to
215−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
157+be present: [`upquote`] (for straight quotes in verbatim
216−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
158+environments), [`microtype`] (for better spacing adjustments),
217−[`weasyprint`] or [`prince`].
159+[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
218−To do this, specify an output file with a `.pdf` extension, as before,
160+better line breaks in URLs), [`bookmark`] (for better PDF
219−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
161+bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
220−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
162+footnotes in tables).
222−PDF output can be controlled using [variables for LaTeX] (if
164+[TeX Live]: https://www.tug.org/texlive/
223−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
224−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
225−If `wkhtmltopdf` is used, then the variables `margin-left`,
226−`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
227−will affect the output.
229[`amsfonts`]: https://ctan.org/pkg/amsfonts
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
230[`amsmath`]: https://ctan.org/pkg/amsmath
166[`amsmath`]: https://ctan.org/pkg/amsmath
231−[`lm`]: https://ctan.org/pkg/lm
167+[`babel`]: https://ctan.org/pkg/babel
232−[`ifxetex`]: https://ctan.org/pkg/ifxetex
168+[`biber`]: https://ctan.org/pkg/biber
233−[`ifluatex`]: https://ctan.org/pkg/ifluatex
169+[`biblatex`]: https://ctan.org/pkg/biblatex
234−[`listings`]: https://ctan.org/pkg/listings
170+[`bibtex`]: https://ctan.org/pkg/bibtex
235−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
171+[`bidi`]: https://ctan.org/pkg/bidi
236−[`longtable`]: https://ctan.org/pkg/longtable
172+[`bookmark`]: https://ctan.org/pkg/bookmark
237[`booktabs`]: https://ctan.org/pkg/booktabs
173[`booktabs`]: https://ctan.org/pkg/booktabs
174+[`csquotes`]: https://ctan.org/pkg/csquotes
175+[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176+[`fontspec`]: https://ctan.org/pkg/fontspec
177+[`footnote`]: https://ctan.org/pkg/footnote
178+[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179+[`geometry`]: https://ctan.org/pkg/geometry
238[`graphicx`]: https://ctan.org/pkg/graphicx
180[`graphicx`]: https://ctan.org/pkg/graphicx
239[`grffile`]: https://ctan.org/pkg/grffile
181[`grffile`]: https://ctan.org/pkg/grffile
240−[`geometry`]: https://ctan.org/pkg/geometry
241−[`setspace`]: https://ctan.org/pkg/setspace
242−[`xecjk`]: https://ctan.org/pkg/xecjk
243[`hyperref`]: https://ctan.org/pkg/hyperref
182[`hyperref`]: https://ctan.org/pkg/hyperref
244−[`ulem`]: https://ctan.org/pkg/ulem
183+[`iftex`]: https://ctan.org/pkg/iftex
245−[`babel`]: https://ctan.org/pkg/babel
184+[`listings`]: https://ctan.org/pkg/listings
246−[`bidi`]: https://ctan.org/pkg/bidi
185+[`lm`]: https://ctan.org/pkg/lm
186+[`longtable`]: https://ctan.org/pkg/longtable
247[`mathspec`]: https://ctan.org/pkg/mathspec
187[`mathspec`]: https://ctan.org/pkg/mathspec
248−[`unicode-math`]: https://ctan.org/pkg/unicode-math
249−[`polyglossia`]: https://ctan.org/pkg/polyglossia
250−[`fontspec`]: https://ctan.org/pkg/fontspec
251−[`upquote`]: https://ctan.org/pkg/upquote
252[`microtype`]: https://ctan.org/pkg/microtype
188[`microtype`]: https://ctan.org/pkg/microtype
253−[`csquotes`]: https://ctan.org/pkg/csquotes
254[`natbib`]: https://ctan.org/pkg/natbib
189[`natbib`]: https://ctan.org/pkg/natbib
255−[`biblatex`]: https://ctan.org/pkg/biblatex
256−[`bibtex`]: https://ctan.org/pkg/bibtex
190+[`parskip`]: https://ctan.org/pkg/parskip
257−[`biber`]: https://ctan.org/pkg/biber
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
258−[TeX Live]: http://www.tug.org/texlive/
259−[`wkhtmltopdf`]: https://wkhtmltopdf.org
260−[`weasyprint`]: http://weasyprint.org
261[`prince`]: https://www.princexml.com/
192[`prince`]: https://www.princexml.com/
193+[`setspace`]: https://ctan.org/pkg/setspace
194+[`ulem`]: https://ctan.org/pkg/ulem
195+[`unicode-math`]: https://ctan.org/pkg/unicode-math
196+[`upquote`]: https://ctan.org/pkg/upquote
197+[`weasyprint`]: https://weasyprint.org
198+[`wkhtmltopdf`]: https://wkhtmltopdf.org
199+[`xcolor`]: https://ctan.org/pkg/xcolor
200+[`xecjk`]: https://ctan.org/pkg/xecjk
201+[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
206+## Reading from the Web
208+Instead of an input file, an absolute URI may be given. In this case
209+pandoc will fetch the content using HTTP:
211+ pandoc -f html -t markdown https://www.fsf.org
263−Options
213+It is possible to supply a custom User-Agent string or other
264−=======
214+header when requesting a document from a URL:
216+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
266−General options
221+## General options {.options}
269`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
271−: Specify input format. *FORMAT* can be `native` (native Haskell),
225+: Specify input format. *FORMAT* can be:
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])
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])
246+ - `ipynb` ([Jupyter notebook])
247+ - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
272− `json` (JSON version of native AST), `markdown` (pandoc's
249+ - `json` (JSON version of native AST)
273− extended Markdown), `markdown_strict` (original unextended
250+ - `latex` ([LaTeX])
251+ - `markdown` ([Pandoc's Markdown])
252+ - `markdown_mmd` ([MultiMarkdown])
274− Markdown), `markdown_phpextra` (PHP Markdown Extra),
253+ - `markdown_phpextra` ([PHP Markdown Extra])
275− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
254+ - `markdown_strict` (original unextended [Markdown])
276− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
255+ - `mediawiki` ([MediaWiki markup])
277− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
256+ - `man` ([roff man])
278− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
257+ - `muse` ([Muse])
258+ - `native` (native Haskell)
279− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
261+ - `org` ([Emacs Org mode])
262+ - `rst` ([reStructuredText])
263+ - `t2t` ([txt2tags])
264+ - `textile` ([Textile])
280− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
265+ - `tikiwiki` ([TikiWiki markup])
281− `haddock` (Haddock markup), or `latex` (LaTeX).
266+ - `twiki` ([TWiki markup])
282− (`markdown_github` provides deprecated and less accurate suppport
267+ - `vimwiki` ([Vimwiki])
283− for Github-Flavored Markdown; please use `gfm` instead, unless you
268+ :::
284− need to use extensions other than `smart`.)
269+
285− If `+lhs` is appended to `markdown`, `rst`, `latex`, or
286− `html`, the input will be treated as literate Haskell source: see
287− [Literate Haskell support], below. Markdown
288− syntax extensions can be individually enabled or disabled by
270+ Extensions can be individually enabled or disabled by
289− appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
271+ appending `+EXTENSION` or `-EXTENSION` to the format name.
290− example, `markdown_strict+footnotes+definition_lists` is strict
291− Markdown with footnotes and definition lists enabled, and
292− `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
293− without pipe tables and with hard line breaks. See [Pandoc's
294− Markdown], below, for a list of extensions and
272+ See [Extensions] below, for a list of extensions and
295 their names. See `--list-input-formats` and `--list-extensions`,
273 their names. See `--list-input-formats` and `--list-extensions`,
298`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
300−: Specify output format. *FORMAT* can be `native` (native Haskell),
278+: Specify output format. *FORMAT* can be:
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)
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)
301− `json` (JSON version of native AST), `plain` (plain text),
310+ - `json` (JSON version of native AST)
312+ - `man` ([roff man])
302− `markdown` (pandoc's extended Markdown), `markdown_strict`
313+ - `markdown` ([Pandoc's Markdown])
314+ - `markdown_mmd` ([MultiMarkdown])
303− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
315+ - `markdown_phpextra` ([PHP Markdown Extra])
304− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
316+ - `markdown_strict` (original unextended [Markdown])
305− Markdown), `commonmark` (CommonMark Markdown), `rst`
306− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
307− or `html5` (HTML5/XHTML [polyglot markup]), `latex`
308− (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
309− `man` (groff man), `mediawiki` (MediaWiki markup),
317+ - `mediawiki` ([MediaWiki markup])
310− `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
318+ - `ms` ([roff ms])
320+ - `native` (native Haskell),
321+ - `odt` ([OpenOffice text document][ODT])
323+ - `opendocument` ([OpenDocument])
324+ - `org` ([Emacs Org mode])
326+ - `plain` (plain text),
327+ - `pptx` ([PowerPoint] slide show)
328+ - `rst` ([reStructuredText])
329+ - `rtf` ([Rich Text Format])
311− `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
330+ - `texinfo` ([GNU Texinfo])
312− `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
331+ - `textile` ([Textile])
313− (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
332+ - `slideous` ([Slideous] HTML and JavaScript slide show)
314− `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
315− (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
316− `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
317− `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
318− Simple), `slidy` (Slidy HTML and JavaScript slide show),
333+ - `slidy` ([Slidy] HTML and JavaScript slide show)
319− `slideous` (Slideous HTML and JavaScript slide show),
320− `dzslides` (DZSlides HTML5 + JavaScript slide show),
334+ - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
321− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
335+ - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
322− (S5 HTML and JavaScript slide show), or the path of a custom
336+ - `s5` ([S5] HTML and JavaScript slide show)
337+ - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
339+ - `zimwiki` ([ZimWiki markup])
323− lua writer (see [Custom writers], below). (`markdown_github`
340+ - the path of a custom Lua writer, see [Custom writers] below
324− provides deprecated and less accurate suppport for
341+ :::
325− Github-Flavored Markdown; please use `gfm` instead, unless
342+
326− you use extensions that do not work with `gfm`.) Note that `odt`,
327− `epub`, and `epub3` output will not be directed to *stdout*;
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
328− an output filename must be specified using the `-o/--output`
344+ to *stdout* unless forced with `-o -`.
329− option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
345+
330− `beamer`, `html4`, or `html5`, the output will be rendered as
331− literate Haskell source: see [Literate Haskell support],
332− below. Markdown syntax extensions can be individually
346+ Extensions can be individually enabled or
333− enabled or disabled by appending `+EXTENSION` or
347+ disabled by appending `+EXTENSION` or `-EXTENSION` to the format
334− `-EXTENSION` to the format name, as described above under `-f`.
348+ name. See [Extensions] below, for a list of extensions and their
335− See `--list-output-formats` and `--list-extensions`, below.
349+ names. See `--list-output-formats` and `--list-extensions`, below.
337`-o` *FILE*, `--output=`*FILE*
351`-o` *FILE*, `--output=`*FILE*
@@ -344,35 +358,43 @@ General options
345: Specify the user data directory to search for pandoc data files.
359: Specify the user data directory to search for pandoc data files.
346 If this option is not specified, the default user data directory
360 If this option is not specified, the default user data directory
347− will be used. This is, in UNIX:
361+ will be used. On \*nix and macOS systems this will be the `pandoc`
348−
362+ subdirectory of the XDG data directory (by default,
349− $HOME/.pandoc
363+ `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
350−
364+ environment variable). If that directory does not exist and
351− in Windows XP:
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
352−
366+ On Windows the default user data directory is
353− C:\Documents And Settings\USERNAME\Application Data\pandoc
355− and in Windows Vista or later:
357− C:\Users\USERNAME\AppData\Roaming\pandoc
367+ `C:\Users\USERNAME\AppData\Roaming\pandoc`.
359 You can find the default user data directory on your system by
368 You can find the default user data directory on your system by
360 looking at the output of `pandoc --version`.
369 looking at the output of `pandoc --version`.
370+ Data files placed in this directory (for example, `reference.odt`,
361− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371+ `reference.docx`, `epub.css`, `templates`) will override
362− `slidy`, `slideous`, or `s5` directory
363− placed in this directory will override pandoc's normal defaults.
372+ pandoc's normal defaults.
374+`-d` *FILE*, `--defaults=`*FILE*
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
365`--bash-completion`
388`--bash-completion`
367: Generate a bash completion script. To enable bash completion
390: Generate a bash completion script. To enable bash completion
368 with pandoc, add this to your `.bashrc`:
391 with pandoc, add this to your `.bashrc`:
370− eval "$(pandoc --bash-completion)"
393+ eval "$(pandoc --bash-completion)"
372`--verbose`
395`--verbose`
374−: Give verbose debugging output. Currently this only has an effect
397+: Give verbose debugging output.
@@ -396,11 +418,12 @@ General options
397: List supported output formats, one per line.
419: List supported output formats, one per line.
399−`--list-extensions`
421+`--list-extensions`[`=`*FORMAT*]
401−: List supported Markdown extensions, one per line, followed
423+: List supported extensions for *FORMAT*, one per line, preceded
402 by a `+` or `-` indicating whether it is enabled by default
424 by a `+` or `-` indicating whether it is enabled by default
425+ in *FORMAT*. If *FORMAT* is not specified, defaults for
403− in pandoc's Markdown.
426+ pandoc's Markdown are given.
405`--list-highlight-languages`
428`--list-highlight-languages`
@@ -420,12 +443,95 @@ General options
421: Show usage message.
444: Show usage message.
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
423−Reader options
504+## Reader options {.options}
506+`--shift-heading-level-by=`*NUMBER*
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.
426`--base-header-level=`*NUMBER*
523`--base-header-level=`*NUMBER*
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
428−: Specify the base level for headers (defaults to 1).
526+ where X = NUMBER - 1.* Specify the base level for headings
529+`--strip-empty-paragraphs`
531+: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532+ Ignore paragraphs with no content. This option is useful
533+ for converting word processing documents where users have
534+ used empty paragraphs to create inter-paragraph space.
430`--indented-code-classes=`*CLASSES*
536`--indented-code-classes=`*CLASSES*
@@ -448,7 +554,7 @@ Reader options
448 footnotes and links will not work across files. Reading binary
554 footnotes and links will not work across files. Reading binary
449 files (docx, odt, epub) implies `--file-scope`.
555 files (docx, odt, epub) implies `--file-scope`.
451−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
453: Specify an executable to be used as a filter transforming the
559: Specify an executable to be used as a filter transforming the
454 pandoc AST after the input is parsed and before the output is
560 pandoc AST after the input is parsed and before the output is
@@ -483,47 +589,65 @@ Reader options
484 3. `$PATH` (executable only)
590 3. `$PATH` (executable only)
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
486−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
488: Transform the document in a similar fashion as JSON filters (see
597: Transform the document in a similar fashion as JSON filters (see
489− `--filter`), but use pandoc's build-in lua filtering system. The given
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
490− lua script is expected to return a list of lua filters which will be
599+ Lua script is expected to return a list of Lua filters which will be
491− applied in order. Each lua filter must contain element-transforming
600+ applied in order. Each Lua filter must contain element-transforming
492 functions indexed by the name of the AST element on which the filter
601 functions indexed by the name of the AST element on which the filter
493 function should be applied.
602 function should be applied.
495− The `pandoc` lua module provides helper functions for element
604+ The `pandoc` Lua module provides helper functions for element
496− creation. It is always loaded into the script's lua environment.
605+ creation. It is always loaded into the script's Lua environment.
607+ See the [Lua filters documentation] for further details.
498− The following is an example lua script for macro-expansion:
609+ In order of preference, pandoc will look for Lua filters in
500− function expand_hello_world(inline)
611+ 1. a specified full or relative path
501− if inline.c == '{{helloworld}}' then
502− return pandoc.Emph{ pandoc.Str "Hello, World" }
508− return {{Str = expand_hello_world}}
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
511`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
513: Set the metadata field *KEY* to the value *VAL*. A value specified
621: Set the metadata field *KEY* to the value *VAL*. A value specified
514− on the command line overrides a value specified in the document.
622+ on the command line overrides a value specified in the document
623+ using [YAML metadata blocks][Extension: `yaml_metadata_block`].
515 Values will be parsed as YAML boolean or string values. If no value is
624 Values will be parsed as YAML boolean or string values. If no value is
516 specified, the value will be treated as Boolean true. Like
625 specified, the value will be treated as Boolean true. Like
517 `--variable`, `--metadata` causes template variables to be set.
626 `--variable`, `--metadata` causes template variables to be set.
518 But unlike `--variable`, `--metadata` affects the metadata of the
627 But unlike `--variable`, `--metadata` affects the metadata of the
519 underlying document (which is accessible from filters and may be
628 underlying document (which is accessible from filters and may be
520− printed in some output formats).
629+ printed in some output formats) and metadata values will be escaped
630+ when inserted into the template.
632+`--metadata-file=`*FILE*
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.
522`-p`, `--preserve-tabs`
645`-p`, `--preserve-tabs`
524−: Preserve tabs instead of converting them to spaces (the default).
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
525− Note that this will only affect tabs in literal code spans and code
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
526− blocks; tabs in regular text will be treated as spaces.
650+ text are always treated as spaces.
528`--tab-stop=`*NUMBER*
652`--tab-stop=`*NUMBER*
@@ -533,27 +657,30 @@ Reader options
534: Specifies what to do with insertions, deletions, and comments
658: Specifies what to do with insertions, deletions, and comments
535 produced by the MS Word "Track Changes" feature. `accept` (the
659 produced by the MS Word "Track Changes" feature. `accept` (the
536− default), inserts all insertions, and ignores all
660+ default) processes all the insertions and deletions.
537− deletions. `reject` inserts all deletions and ignores
538− insertions. Both `accept` and `reject` ignore comments. `all` puts
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
539− in insertions, deletions, and comments, wrapped in spans with
662+ `all` includes all insertions, deletions, and comments, wrapped
540− `insertion`, `deletion`, `comment-start`, and `comment-end`
663+ in spans with `insertion`, `deletion`, `comment-start`, and
541− classes, respectively. The author and time of change is
664+ `comment-end` classes, respectively. The author and time of
542− included. `all` is useful for scripting: only accepting changes
665+ change is included. `all` is useful for scripting: only
543− from a certain reviewer, say, or before a certain date. This
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
544− option only affects the docx reader.
670+ affected paragraph break. This option only affects the docx
546`--extract-media=`*DIR*
673`--extract-media=`*DIR*
548: Extract images and other media contained in or linked from
675: Extract images and other media contained in or linked from
549 the source document to the path *DIR*, creating it if
676 the source document to the path *DIR*, creating it if
550 necessary, and adjust the images references in the document
677 necessary, and adjust the images references in the document
551− so they point to the extracted files. If the source format is
678+ so they point to the extracted files. Media are downloaded,
552− a binary container (docx, epub, or odt), the media is
679+ read from the file system, or extracted from a binary
553− extracted from the container and the original
680+ container (e.g. docx), as needed. The original file paths
554− filenames are used. Otherwise the media is read from the
681+ are used if they are relative paths not containing `..`.
555− file system or downloaded, and new filenames are constructed
682+ Otherwise filenames are constructed from the SHA1 hash of
556− based on SHA1 hashes of the contents.
683+ the contents.
558`--abbreviations=`*FILE*
685`--abbreviations=`*FILE*
@@ -564,29 +691,30 @@ Reader options
564 system default, use
691 system default, use
565 `pandoc --print-default-data-file=abbreviations`. The only
692 `pandoc --print-default-data-file=abbreviations`. The only
566 use pandoc makes of this list is in the Markdown reader.
693 use pandoc makes of this list is in the Markdown reader.
567− Strings ending in a period that are found in this list will
694+ Strings found in this list will be followed by a nonbreaking
568− be followed by a nonbreaking space, so that the period will
569− not produce sentence-ending space in formats like LaTeX.
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
571[`pandocfilters`]: https://github.com/jgm/pandocfilters
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
572[PHP]: https://github.com/vinai/pandocfilters-php
699[PHP]: https://github.com/vinai/pandocfilters-php
573[perl]: https://metacpan.org/pod/Pandoc::Filter
700[perl]: https://metacpan.org/pod/Pandoc::Filter
574[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
576−General writer options
704+## General writer options {.options}
577−----------------------
579`-s`, `--standalone`
706`-s`, `--standalone`
581: Produce output with an appropriate header and footer (e.g. a
708: Produce output with an appropriate header and footer (e.g. a
582 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
583 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
584− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
586−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
588−: Use *FILE* as a custom template for the generated document. Implies
716+: Use the specified file as a custom template for the generated document.
589− `--standalone`. See [Templates], below, for a description
717+ Implies `--standalone`. See [Templates], below, for a description
590 of template syntax. If no extension is specified, an extension
718 of template syntax. If no extension is specified, an extension
591 corresponding to the writer will be added, so that `--template=special`
719 corresponding to the writer will be added, so that `--template=special`
592 looks for `special.html` for HTML output. If the template is not
720 looks for `special.html` for HTML output. If the template is not
@@ -598,22 +726,29 @@ General writer options
598`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
600: Set the template variable *KEY* to the value *VAL* when rendering the
728: Set the template variable *KEY* to the value *VAL* when rendering the
601− document in standalone mode. This is generally only useful when the
729+ document in standalone mode. If no *VAL* is specified, the
602− `--template` option is used to specify a custom template, since
603− pandoc automatically sets the variables used in the default
604− templates. If no *VAL* is specified, the key will be given the
605− value `true`.
730+ key will be given the value `true`.
607`-D` *FORMAT*, `--print-default-template=`*FORMAT*
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
609: Print the system default template for an output *FORMAT*. (See `-t`
734: Print the system default template for an output *FORMAT*. (See `-t`
610 for a list of possible *FORMAT*s.) Templates in the user data
735 for a list of possible *FORMAT*s.) Templates in the user data
611− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
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`.
613`--print-default-data-file=`*FILE*
746`--print-default-data-file=`*FILE*
615: Print a system default data file. Files in the user data directory
748: Print a system default data file. Files in the user data directory
616− are ignored.
749+ are ignored. This option may be used with `-o`/`--output` to
750+ redirect output to a file, but `-o`/`--output` must come before
751+ `--print-default-data-file` on the command line.
618`--eol=crlf`|`lf`|`native`
753`--eol=crlf`|`lf`|`native`
@@ -624,9 +759,12 @@ General writer options
625`--dpi`=*NUMBER*
760`--dpi`=*NUMBER*
627−: Specify the dpi (dots per inch) value for conversion from pixels
762+: Specify the default dpi (dots per inch) value for conversion
628− to inch/centimeters and vice versa. The default is 96dpi.
763+ from pixels to inch/centimeters and vice versa. (Technically,
629− Technically, the correct term would be ppi (pixels per inch).
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.
631`--wrap=auto`|`none`|`preserve`
769`--wrap=auto`|`none`|`preserve`
@@ -639,6 +777,8 @@ General writer options
639 where there are nonsemantic newlines in the source, there
777 where there are nonsemantic newlines in the source, there
640 will be nonsemantic newlines in the output as well).
778 will be nonsemantic newlines in the output as well).
641 Automatic wrapping does not currently work in HTML output.
779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
643`--columns=`*NUMBER*
783`--columns=`*NUMBER*
@@ -651,14 +791,21 @@ General writer options
651: Include an automatically generated table of contents (or, in
791: Include an automatically generated table of contents (or, in
652 the case of `latex`, `context`, `docx`, `odt`,
792 the case of `latex`, `context`, `docx`, `odt`,
653 `opendocument`, `rst`, or `ms`, an instruction to create
793 `opendocument`, `rst`, or `ms`, an instruction to create
654− one) in the output document. This option has no effect on
794+ one) in the output document. This option has no effect
795+ unless `-s/--standalone` is used, and it has no effect
655− `man`, `docbook4`, `docbook5`, or `jats` output.
796+ on `man`, `docbook4`, `docbook5`, or `jats` output.
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`.
657`--toc-depth=`*NUMBER*
804`--toc-depth=`*NUMBER*
659: Specify the number of section levels to include in the table
806: Specify the number of section levels to include in the table
660− of contents. The default is 3 (which means that level 1, 2, and 3
807+ of contents. The default is 3 (which means that level-1, 2, and 3
661− headers will be listed in the contents).
808+ headings will be listed in the contents).
663`--strip-comments`
810`--strip-comments`
@@ -685,8 +832,19 @@ General writer options
685 Instead of a *STYLE* name, a JSON file with extension
832 Instead of a *STYLE* name, a JSON file with extension
686 `.theme` may be supplied. This will be parsed as a KDE
833 `.theme` may be supplied. This will be parsed as a KDE
687 syntax highlighting theme and (if valid) used as the
834 syntax highlighting theme and (if valid) used as the
688− highlighting style. To see a sample theme that can be
835+ highlighting style.
689− modified, `pandoc --print-default-data-file default.theme`.
836+
837+ To generate the JSON version of an existing style,
838+ use `--print-highlight-style`.
840+`--print-highlight-style=`*STYLE*|*FILE*
842+: Prints a JSON version of a highlighting style, which can
843+ be modified, saved with a `.theme` extension, and used
844+ with `--highlight-style`. This option may be used with
845+ `-o`/`--output` to redirect output to a file, but
846+ `-o`/`--output` must come before `--print-highlight-style`
847+ on the command line.
691`--syntax-definition=`*FILE*
849`--syntax-definition=`*FILE*
@@ -694,9 +852,10 @@ General writer options
694 which will be used for syntax highlighting of appropriately
852 which will be used for syntax highlighting of appropriately
695 marked code blocks. This can be used to add support for
853 marked code blocks. This can be used to add support for
696 new languages or to use altered syntax definitions for
854 new languages or to use altered syntax definitions for
697− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
699−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
701: Include contents of *FILE*, verbatim, at the end of the header.
860: Include contents of *FILE*, verbatim, at the end of the header.
702 This can be used, for example, to include special
861 This can be used, for example, to include special
@@ -704,7 +863,7 @@ General writer options
704 repeatedly to include multiple files in the header. They will be
863 repeatedly to include multiple files in the header. They will be
705 included in the order specified. Implies `--standalone`.
864 included in the order specified. Implies `--standalone`.
707−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
709: Include contents of *FILE*, verbatim, at the beginning of the
868: Include contents of *FILE*, verbatim, at the beginning of the
710 document body (e.g. after the `<body>` tag in HTML, or the
869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -713,7 +872,7 @@ General writer options
713 used repeatedly to include multiple files. They will be included in
872 used repeatedly to include multiple files. They will be included in
714 the order specified. Implies `--standalone`.
873 the order specified. Implies `--standalone`.
716−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
718: Include contents of *FILE*, verbatim, at the end of the document
877: Include contents of *FILE*, verbatim, at the end of the document
719 body (before the `</body>` tag in HTML, or the
878 body (before the `</body>` tag in HTML, or the
@@ -732,28 +891,39 @@ General writer options
732 will not be searched. For example:
891 will not be searched. For example:
733 `--resource-path=.:test` will search the working directory
892 `--resource-path=.:test` will search the working directory
734 and the `test` subdirectory, in that order.
893 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`.
736`--request-header=`*NAME*`:`*VAL*
900`--request-header=`*NAME*`:`*VAL*
738: Set the request header *NAME* to the value *VAL* when making
902: Set the request header *NAME* to the value *VAL* when making
739 HTTP requests (for example, when a URL is given on the
903 HTTP requests (for example, when a URL is given on the
740 command line, or when resources used in a document must be
904 command line, or when resources used in a document must be
741− downloaded).
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
908+`--no-check-certificate`
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).
743−Options affecting specific writers
914+## Options affecting specific writers {.options}
744−----------------------------------
746`--self-contained`
916`--self-contained`
748: Produce a standalone HTML file with no external dependencies, using
918: Produce a standalone HTML file with no external dependencies, using
749 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
750− images, and videos. The resulting file should be "self-contained,"
920+ images, and videos. Implies `--standalone`. The resulting file should be
751− in the sense that it needs no external files and no net access to be
921+ "self-contained," in the sense that it needs no external files and no net
752− displayed properly by a browser. This option works only with HTML output
922+ access to be displayed properly by a browser. This option works only with
753− formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
923+ HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
754− `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
924+ `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
755− stylesheets at absolute URLs will be downloaded; those at relative URLs
925+ and stylesheets at absolute URLs will be downloaded; those at relative
756− will be sought relative to the working directory (if the first source
926+ URLs will be sought relative to the working directory (if the first source
757 file is local) or relative to the base URL (if the first source
927 file is local) or relative to the base URL (if the first source
758 file is remote). Elements with the attribute
928 file is remote). Elements with the attribute
759 `data-external="1"` will be left alone; the documents they
929 `data-external="1"` will be left alone; the documents they
@@ -766,13 +936,18 @@ Options affecting specific writers
767`--html-q-tags`
937`--html-q-tags`
769−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
773−: Use only ASCII characters in output. Currently supported only for
945+: Use only ASCII characters in output. Currently supported for XML
774− HTML and DocBook output (which uses numerical entities instead of
946+ and HTML formats (which use entities instead of UTF-8 when this
775− UTF-8 when this option is selected).
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.
777`--reference-links`
952`--reference-links`
@@ -781,35 +956,45 @@ Options affecting specific writers
781 placement of link references is affected by the
956 placement of link references is affected by the
782 `--reference-location` option.
957 `--reference-location` option.
784−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
786: Specify whether footnotes (and references, if `reference-links` is
961: Specify whether footnotes (and references, if `reference-links` is
787 set) are placed at the end of the current (top-level) block, the
962 set) are placed at the end of the current (top-level) block, the
788 current section, or the document. The default is
963 current section, or the document. The default is
789 `document`. Currently only affects the markdown writer.
964 `document`. Currently only affects the markdown writer.
966+`--markdown-headings=setext`|`atx`
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.
791`--atx-headers`
974`--atx-headers`
793−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
976+: *Deprecated synonym for `--markdown-headings=atx`.*
794− to use setext-style headers for levels 1-2, and then ATX headers.
796−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
798−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
980+: Treat top-level headings as the given division type in
799− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
800− all headers are shifted such that the top-level header becomes the specified
983+ shifted such that the top-level heading becomes the
801− type. The default behavior is to determine the best division type via
984+ specified type. The default behavior is to determine the
802− heuristics: unless other conditions apply, `section` is chosen. When the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
803− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
987+ variable is set to `report`, `book`, or `memoir` (unless the
804− `article` option is specified), `chapter` is implied as the setting for this
988+ `article` option is specified), `chapter` is implied as the
805− option. If `beamer` is the output format, specifying either `chapter` or
989+ setting for this option. If `beamer` is the output format,
806− `part` will cause top-level headers to become `\part{..}`, while
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
807− second-level headers remain as their default type.
992+ remain as their default type.
809`-N`, `--number-sections`
994`-N`, `--number-sections`
811−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
812− By default, sections are not numbered. Sections with class
997+ output. By default, sections are not numbered. Sections with class
813 `unnumbered` will never be numbered, even if `--number-sections`
998 `unnumbered` will never be numbered, even if `--number-sections`
814 is specified.
999 is specified.
@@ -817,16 +1002,19 @@ Options affecting specific writers
818: Offset for section headings in HTML output (ignored in other
1003: Offset for section headings in HTML output (ignored in other
819 output formats). The first number is added to the section number for
1004 output formats). The first number is added to the section number for
820− top-level headers, the second for second-level headers, and so on.
1005+ top-level headings, the second for second-level headings, and so on.
821− So, for example, if you want the first top-level header in your
1006+ So, for example, if you want the first top-level heading in your
822 document to be numbered "6", specify `--number-offset=5`.
1007 document to be numbered "6", specify `--number-offset=5`.
823− If your document starts with a level-2 header which you want to
1008+ If your document starts with a level-2 heading which you want to
824 be numbered "1.5", specify `--number-offset=1,4`.
1009 be numbered "1.5", specify `--number-offset=1,4`.
825 Offsets are 0 by default. Implies `--number-sections`.
1010 Offsets are 0 by default. Implies `--number-sections`.
827`--listings`
1012`--listings`
829−: Use the [`listings`] package for LaTeX code blocks
1014+: Use the [`listings`] package for LaTeX code blocks. The package
1015+ does not support multi-byte encoding for source code. To handle UTF-8
1016+ you would need to use a custom template. This issue is fully
1017+ documented here: [Encoding issue with the listings package].
831`-i`, `--incremental`
1019`-i`, `--incremental`
@@ -835,22 +1023,22 @@ Options affecting specific writers
836`--slide-level=`*NUMBER*
1024`--slide-level=`*NUMBER*
838−: Specifies that headers with the specified level create
1026+: Specifies that headings with the specified level create
839− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
840 above this level in the hierarchy are used to divide the
1028 above this level in the hierarchy are used to divide the
841− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
842 subheads within a slide. Note that content that is
1030 subheads within a slide. Note that content that is
843− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
844 the slide show. The default is to set the slide level based
1032 the slide show. The default is to set the slide level based
845 on the contents of the document; see [Structuring the slide
1033 on the contents of the document; see [Structuring the slide
848`--section-divs`
1036`--section-divs`
850−: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
1038+: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
851− and attach identifiers to the enclosing `<div>` (or `<section>`)
1039+ and attach identifiers to the enclosing `<section>` (or `<div>`)
852− rather than the header itself. See
1040+ rather than the heading itself. See
853− [Header identifiers], below.
1041+ [Heading identifiers], below.
855`--email-obfuscation=none`|`javascript`|`references`
1043`--email-obfuscation=none`|`javascript`|`references`
@@ -871,8 +1059,7 @@ Options affecting specific writers
872: Specify *STRING* as a prefix at the beginning of the title
1060: Specify *STRING* as a prefix at the beginning of the title
873 that appears in the HTML header (but not in the title as it
1061 that appears in the HTML header (but not in the title as it
874− appears at the beginning of the HTML body). Implies
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
877`-c` *URL*, `--css=`*URL*
1064`-c` *URL*, `--css=`*URL*
@@ -880,8 +1067,8 @@ Options affecting specific writers
880 include multiple files. They will be included in the order specified.
1067 include multiple files. They will be included in the order specified.
882 A stylesheet is required for generating EPUB. If none is
1069 A stylesheet is required for generating EPUB. If none is
883− provided using this option (or the `stylesheet` metadata
1070+ provided using this option (or the `css` or `stylesheet`
884− field), pandoc will look for a file `epub.css` in the
1071+ metadata fields), pandoc will look for a file `epub.css` in the
885 user data directory (see `--data-dir`). If it is not
1072 user data directory (see `--data-dir`). If it is not
886 found there, sensible defaults will be used.
1073 found there, sensible defaults will be used.
@@ -904,20 +1091,56 @@ Options affecting specific writers
905 To produce a custom `reference.docx`, first get a copy of
1092 To produce a custom `reference.docx`, first get a copy of
906 the default `reference.docx`: `pandoc
1093 the default `reference.docx`: `pandoc
907− --print-default-data-file reference.docx >
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
908− custom-reference.docx`. Then open `custom-reference.docx`
1095+ Then open `custom-reference.docx` in Word, modify the
909− in Word, modify the styles as you wish, and save the file.
1096+ styles as you wish, and save the file. For best
910− For best results, do not make changes to this file other
1097+ results, do not make changes to this file other than
911− than modifying the styles used by pandoc: [paragraph]
1098+ modifying the styles used by pandoc:
912− Normal, Body Text, First Paragraph, Compact, Title,
1104+ - First Paragraph
913− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1111+ - Bibliography
914− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
1112+ - Heading 1
915− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1122+ - Footnote Text
916− Definition Term, Definition, Caption, Table Caption,
1123+ - Definition Term
917− Image Caption, Figure, Captioned Figure, TOC Heading;
1129+ - Captioned Figure
918− [character] Default Paragraph Font, Body Text Char,
1134+ - Default Paragraph Font
919− Verbatim Char, Footnote Reference, Hyperlink; [table]
1137+ - Footnote Reference
920− Table.
1141+ Table style:
@@ -931,10 +1154,33 @@ Options affecting specific writers
932 To produce a custom `reference.odt`, first get a copy of
1155 To produce a custom `reference.odt`, first get a copy of
933 the default `reference.odt`: `pandoc
1156 the default `reference.odt`: `pandoc
934− --print-default-data-file reference.odt >
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
935− custom-reference.odt`. Then open `custom-reference.odt` in
1158+ Then open `custom-reference.odt` in LibreOffice, modify
936− LibreOffice, modify the styles as you wish, and save the
1159+ the styles as you wish, and save the file.
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.
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
1171+ 2. Title and Content
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.)
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).
939`--epub-cover-image=`*FILE*
1185`--epub-cover-image=`*FILE*
@@ -1002,12 +1248,12 @@ Options affecting specific writers
1003`--epub-chapter-level=`*NUMBER*
1249`--epub-chapter-level=`*NUMBER*
1005−: Specify the header level at which to split the EPUB into separate
1251+: Specify the heading level at which to split the EPUB into separate
1006− "chapter" files. The default is to split into chapters at level 1
1252+ "chapter" files. The default is to split into chapters at level-1
1007− headers. This option only affects the internal composition of the
1253+ headings. This option only affects the internal composition of the
1008 EPUB, not the way chapters and sections are displayed to users. Some
1254 EPUB, not the way chapters and sections are displayed to users. Some
1009 readers may be slow if the chapter files are too large, so for large
1255 readers may be slow if the chapter files are too large, so for large
1010− documents with few level 1 headers, one might want to use a chapter
1256+ documents with few level-1 headings, one might want to use a chapter
1011 level of 2 or 3.
1257 level of 2 or 3.
1013`--epub-subdirectory=`*DIRNAME*
1259`--epub-subdirectory=`*DIRNAME*
@@ -1016,111 +1262,145 @@ Options affecting specific writers
1016 the EPUB-specific contents. The default is `EPUB`. To put
1262 the EPUB-specific contents. The default is `EPUB`. To put
1017 the EPUB contents in the top level, use an empty string.
1263 the EPUB contents in the top level, use an empty string.
1019−`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1265+`--ipynb-output=all|none|best`
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`.
1274+`--pdf-engine=`*PROGRAM*
1021: Use the specified engine when producing PDF output.
1276: Use the specified engine when producing PDF output.
1277+ Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278+ `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1022− The default is `pdflatex`. If the engine is not in your PATH,
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1023− the full path of the engine may be specified here.
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`:
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`
1025`--pdf-engine-opt=`*STRING*
1292`--pdf-engine-opt=`*STRING*
1027: Use the given string as a command-line argument to the `pdf-engine`.
1294: Use the given string as a command-line argument to the `pdf-engine`.
1028− If used multiple times, the arguments are provided with spaces between
1295+ For example, to use a persistent directory `foo` for `latexmk`'s
1296+ auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1029− them. Note that no check for duplicate options is done.
1297+ Note that no check for duplicate options is done.
1031−[Dublin Core elements]: http://dublincore.org/documents/dces/
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1032−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1033−
1301+[Encoding issue with the listings package]:
1302+ https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1034−Citation rendering
1304+## Citation rendering {.options}
1035−------------------
1305+
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].
1037`--bibliography=`*FILE*
1325`--bibliography=`*FILE*
1039: Set the `bibliography` field in the document's metadata to *FILE*,
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1040− overriding any value set in the metadata, and process citations
1328+ overriding any value set in the metadata. If you supply
1041− using `pandoc-citeproc`. (This is equivalent to
1042− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1043− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1044− used, making this equivalent to `--metadata bibliography=FILE`.
1045− If you supply this argument multiple times, each *FILE* will be added
1329+ this argument multiple times, each *FILE* will be added to
1046− to bibliography.
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`).
1048`--csl=`*FILE*
1335`--csl=`*FILE*
1050: Set the `csl` field in the document's metadata to *FILE*,
1337: Set the `csl` field in the document's metadata to *FILE*,
1051 overriding any value set in the metadata. (This is equivalent to
1338 overriding any value set in the metadata. (This is equivalent to
1052− `--metadata csl=FILE`.)
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1053− This option is only relevant with `pandoc-citeproc`.
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.
1055`--citation-abbreviations=`*FILE*
1345`--citation-abbreviations=`*FILE*
1057: Set the `citation-abbreviations` field in the document's metadata to
1347: Set the `citation-abbreviations` field in the document's metadata to
1058 *FILE*, overriding any value set in the metadata. (This is equivalent to
1348 *FILE*, overriding any value set in the metadata. (This is equivalent to
1059 `--metadata citation-abbreviations=FILE`.)
1349 `--metadata citation-abbreviations=FILE`.)
1060− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
1062`--natbib`
1355`--natbib`
1064−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1357+: Use [`natbib`] for citations in LaTeX output. This option
1065− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1066− use in producing a LaTeX file that can be processed with [`bibtex`].
1360+ that can be processed with [`bibtex`].
1068`--biblatex`
1362`--biblatex`
1070−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1071− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1072− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1367+ that can be processed with [`bibtex`] or [`biber`].
1074−Math rendering in HTML
1075−----------------------
1077−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1079−: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1080− To insert a link to a local copy of the `LaTeXMathML.js` script,
1081− provide a *URL*. If no *URL* is provided, the contents of the
1082− script will be inserted directly into the HTML header, preserving
1083− portability at the price of efficiency. If you plan to use math on
1084− several pages, it is much better to link to a copy of the script,
1085− so it can be cached.
1089−: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1090− `html4` and `html5`). This is the default in `odt` output.
1092−`--jsmath`[`=`*URL*]
1369+## Math rendering in HTML {.options}
1094−: Use [jsMath] to display embedded TeX math in HTML output.
1371+The default is to render TeX math as far as possible using
1095− The *URL* should point to the jsMath load script (e.g.
1372+Unicode characters. Formulas are put inside a `span` with
1096− `jsMath/easy/load.js`); if provided, it will be linked to in
1373+`class="math"`, so that they may be styled differently from the
1097− the header of standalone HTML documents. If a *URL* is not provided,
1374+surrounding text if needed. However, this gives acceptable
1098− no link to the jsMath load script will be inserted; it is then
1375+results only for basic math, usually you will want to use
1099− up to the author to provide such a link in the HTML template.
1376+`--mathjax` or another of the following options.
1101`--mathjax`[`=`*URL*]
1378`--mathjax`[`=`*URL*]
1103: Use [MathJax] to display embedded TeX math in HTML output.
1380: Use [MathJax] to display embedded TeX math in HTML output.
1381+ TeX math will be put between `\(...\)` (for inline math)
1382+ or `\[...\]` (for display math) and wrapped in `<span>` tags
1383+ with class `math`. Then the MathJax JavaScript will render it.
1104 The *URL* should point to the `MathJax.js` load script.
1384 The *URL* should point to the `MathJax.js` load script.
1105− If a *URL* is not provided, a link to the MathJax CDN will
1385+ If a *URL* is not provided, a link to the Cloudflare CDN will
1106 be inserted.
1386 be inserted.
1108−`--gladtex`
1388+`--mathml`
1110−: Enclose TeX math in `<eq>` tags in HTML output. These can then
1111− be processed by [gladTeX] to produce links to images of the typeset
1114−`--mimetex`[`=`*URL*]
1116−: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1117− specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
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
1119`--webtex`[`=`*URL*]
1396`--webtex`[`=`*URL*]
1121−: Render TeX formulas using an external script that converts TeX
1398+: Convert TeX formulas to `<img>` tags that link to an external script
1122− formulas to images. The formula will be concatenated with the URL
1399+ that converts formulas to images. The formula will be URL-encoded
1400+ and concatenated with the URL provided. For SVG images you can for
1401+ example use `--webtex https://latex.codecogs.com/svg.latex?`.
1123− provided. If *URL* is not specified, the CodeCogs will be used.
1402+ If no URL is specified, the CodeCogs URL generating PNGs
1403+ will be used (`https://latex.codecogs.com/png.latex?`).
1124 Note: the `--webtex` option will affect Markdown output
1404 Note: the `--webtex` option will affect Markdown output
1125 as well as HTML, which is useful if you're targeting a
1405 as well as HTML, which is useful if you're targeting a
1126 version of Markdown without native math support.
1406 version of Markdown without native math support.
@@ -1128,26 +1408,26 @@ Math rendering in HTML
1128`--katex`[`=`*URL*]
1408`--katex`[`=`*URL*]
1130: Use [KaTeX] to display embedded TeX math in HTML output.
1410: Use [KaTeX] to display embedded TeX math in HTML output.
1131− The *URL* is the base URL for the KaTeX library. If a *URL* is
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.
1132− not provided, a link to the KaTeX CDN will be inserted.
1413+ If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1133− Note: [KaTeX] seems to work best with `html5` output.
1414+
1135−`--katex-stylesheet=`*URL*
1417+: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
1137−: The *URL* should point to the `katex.css` stylesheet. If this option is
1421+ pandoc -s --gladtex input.md -o myfile.htex
1138− not specified, a link to the KaTeX CDN will be inserted. Note that this
1422+ gladtex -d image_dir myfile.htex
1139− option does not imply `--katex`.
1423+ # produces myfile.html and images in image_dir
1141−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
1142−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1143−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1144[MathJax]: https://www.mathjax.org
1426[MathJax]: https://www.mathjax.org
1145−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1146−[mimeTeX]: http://www.forkosh.com/mimetex.html
1147[KaTeX]: https://github.com/Khan/KaTeX
1427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
1149−Options for wrapper scripts
1430+## Options for wrapper scripts {.options}
1150−---------------------------
1152`--dump-args`
1432`--dump-args`
@@ -1171,8 +1451,277 @@ Options for wrapper scripts
1172 pandoc -o foo.html -s
1452 pandoc -o foo.html -s
1456+If pandoc completes successfully, it will return exit code 0.
1457+Nonzero exit codes have the following meanings:
1460+----- ------------------------------------
1461+ 3 PandocFailOnWarningError
1463+ 5 PandocTemplateError
1464+ 6 PandocOptionError
1465+ 21 PandocUnknownReaderError
1466+ 22 PandocUnknownWriterError
1467+ 23 PandocUnsupportedExtensionError
1468+ 24 PandocCiteprocError
1469+ 31 PandocEpubSubdirectoryError
1472+ 47 PandocPDFProgramNotFoundError
1474+ 62 PandocShouldNeverHappenError
1476+ 64 PandocParseError
1477+ 65 PandocParsecError
1478+ 66 PandocMakePDFError
1479+ 67 PandocSyntaxMapError
1480+ 83 PandocFilterError
1482+ 92 PandocUTF8DecodingError
1483+ 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
1485+ 97 PandocCouldNotFindDataFileError
1486+ 99 PandocResourceNotFound
1487+----- ------------------------------------
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:
1496+from: markdown+emoji
1497+# reader: may be used instead of from:
1499+# writer: may be used instead of to:
1501+# leave blank for output to stdout:
1503+# leave blank for input from stdin, use [] for no input:
1507+# or you may use input-file: with a single value
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.
1521+self-contained: false
1523+# note that structured variables may be specified:
1525+ documentclass: book
1530+# metadata values specified here are parsed as literal
1531+# string text, not markdown:
1538+# or you may use metadata-file: with a single value
1540+# Note that these take files, not their contents:
1541+include-before-body: []
1542+include-after-body: []
1543+include-in-header: []
1544+resource-path: ["."]
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).
1555+citation-abbreviations: abbrevs.json
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}`.
1572+# ERROR, WARNING, or INFO
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
1581+# part, chapter, section, or default:
1582+top-level-division: chapter
1585+pdf-engine: pdflatex
1588+# you may also use pdf-engine-opt: with a single option
1589+# pdf-engine-opt: "-shell-escape"
1591+# auto, preserve, or none
1596+extract-media: mediadir
1598+table-of-contents: true
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
1606+identifier-prefix: foo
1608+strip-empty-paragraphs: true
1609+# lf, crlf, or native
1611+strip-comments: false
1612+indented-code-classes: []
1614+default-image-extension: ".jpg"
1616+# either a style name of a style definition file:
1617+highlight-style: pygments
1620+# or you may use syntax-definition: with a single value
1623+reference-doc: myref.docx
1625+# method is plain, webtex, gladtex, mathml, mathjax, katex
1626+# you may specify a url with webtex, mathjax, katex
1629+ url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1630+# none, references, or javascript
1631+email-obfuscation: javascript
1639+epub-subdirectory: EPUB
1640+epub-metadata: meta.xml
1643+epub-chapter-level: 1
1644+epub-cover-image: cover.jpg
1646+reference-links: true
1647+# block, section, or document
1648+reference-location: block
1649+markdown-headings: setext
1651+# accept, reject, or all
1652+track-changes: accept
1658+# none, all, or best
1661+# A list of two-element lists
1663+- ["User-Agent", "Mozilla/5.0"]
1665+fail-if-warnings: false
1671+Fields that are omitted will just have their regular
1672+default values. So a defaults file can be as simple as
1679+In fields that expect a file path (or list of file paths), the
1680+following syntax may be used to interpolate environment variables:
1683+csl: ${HOME}/mycsldir/special.csl
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`.
1691+`${.}` will resolve to the directory containing the default
1692+file itself. This allows you to refer to resources contained
1696+epub-cover-image: ${.}/cover.jpg
1697+epub-metadata: ${.}/meta.xml
1699+- . # the working directory from which pandoc is run
1700+- ${.}/images # the images subdirectory of the directory
1701+ # containing this defaults file
1704+This environment variable interpolation syntax *only* works in
1705+fields that expect file paths.
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`.
1715+When multiple defaults are used, their contents will be combined.
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.
1174−Templates
1724+# Templates
1177When the `-s/--standalone` option is used, pandoc uses a template to
1726When the `-s/--standalone` option is used, pandoc uses a template to
1178add header and footer material that is needed for a self-standing
1727add header and footer material that is needed for a self-standing
@@ -1189,482 +1738,1430 @@ directory (see `--data-dir`, above). *Exceptions:*
1189- For `odt` output, customize the `default.opendocument`
1738- For `odt` output, customize the `default.opendocument`
1190 template.
1739 template.
1191- For `pdf` output, customize the `default.latex` template
1740- For `pdf` output, customize the `default.latex` template
1192− (or the `default.beamer` template, if you use `-t beamer`,
1741+ (or the `default.context` template, if you use `-t context`,
1742+ or the `default.ms` template, if you use `-t ms`, or the
1193− or the `default.context` template, if you use `-t context`).
1743+ `default.html` template, if you use `-t html`).
1194−- `docx` has no template (however, you can use
1744+- `docx` and `pptx` have no template (however, you can use
1195 `--reference-doc` to customize the output).
1745 `--reference-doc` to customize the output).
1197Templates contain *variables*, which allow for the inclusion of
1747Templates contain *variables*, which allow for the inclusion of
1198−arbitrary information at any point in the file. Variables may be set
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
1199−within the document using [YAML metadata blocks][Extension:
1751+using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1200−`yaml_metadata_block`]. They may also be set at the
1752+or with the `-M/--metadata` option. In addition, some variables
1201−command line using the `-V/--variable` option: variables set in this
1753+are given default values by pandoc. See [Variables] below for
1202−way override metadata fields with the same name.
1754+a list of variables used in pandoc's default templates.
1204−Variables set by pandoc
1205−-----------------------
1207−Some variables are set automatically by pandoc. These vary somewhat
1756+If you use custom templates, you may need to revise them as pandoc
1208−depending on the output format, but include metadata fields as well
1757+changes. We recommend tracking the changes in the default templates,
1209−as the following:
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.
1211−`sourcefile`, `outputfile`
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
1212−: source and destination filenames, as given on the command line.
1213− `sourcefile` can also be a list if input comes from multiple files, or empty
1214− if input is from stdin. You can use the following snippet in your template
1215− to distinguish them:
1217− $if(sourcefile)$
1764+## Template syntax
1225− Similarly, `outputfile` can be `-` if output goes to the terminal.
1766+### Comments
1227−`title`, `author`, `date`
1768+Anything between the sequence `$--` and the end of the
1228−: allow identification of basic aspects of the document. Included
1769+line will be treated as a comment and omitted from the output.
1229− in PDF metadata through LaTeX and ConTeXt. These can be set
1230− through a [pandoc title block][Extension: `pandoc_title_block`],
1231− which allows for multiple authors, or through a YAML metadata block:
1233− ---
1771+### Delimiters
1239−`subtitle`
1773+To mark variables and control structures in the template,
1240−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1774+either `$`...`$` or `${`...`}` may be used as delimiters.
1241− renders in LaTeX only when using a document class that supports
1775+The styles may also be mixed in the same template, but the
1242− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1776+opening and closing delimiter must match in each case. The
1243− `scrreprt`, `scrbook`).[^subtitle]
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
1245−`institute`
1782+To include a literal `$` in the document, use `$$`.
1246−: author affiliations (in LaTeX and Beamer only). Can be a
1247− list, when there are multiple authors.
1249−`abstract`
1784+### Interpolated variables
1250−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1252−`keywords`
1786+A slot for an interpolated variable is a variable name surrounded
1253−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1787+by matched delimiters. Variable names must begin with a letter
1254− may be repeated as for `author`, above
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:
1256−`header-includes`
1792+```
1257−: contents specified by `-H/--include-in-header` (may have multiple
1793+$foo$
1258− values)
1794+$foo.bar.baz$
1260−`toc`
1803+Variable names with periods are used to get at structured
1261−: non-null value if `--toc/--table-of-contents` was specified
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.
1263−`toc-title`
1808+- If the value of the variable is simple value, it will be
1264−: title of table of contents (works only with EPUB,
1809+ rendered verbatim. (Note that no escaping is done;
1265− opendocument, odt, docx)
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.
1267−`include-before`
1816+### Conditionals
1268−: contents specified by `-B/--include-before-body` (may have
1271−`include-after`
1818+A conditional begins with `if(variable)` (enclosed in
1272−: contents specified by `-A/--include-after-body` (may have
1819+matched delimiters) and ends with `endif` (enclosed in matched
1273− multiple values)
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:
1276−: body of document
1826+$if(foo)$bar$endif$
1278−`meta-json`
1828+$if(foo)$
1279−: JSON representation of all of the document's metadata. Field
1829+ $foo$
1280− values are transformed to the selected output format.
1830+$endif$
1282−[^subtitle]: To make `subtitle` work with other LaTeX
1832+$if(foo)$
1283− document classes, you can add the following to `header-includes`:
1833+part one
1285− \providecommand{\subtitle}[1]{%
1838+${if(foo)}bar${endif}
1286− \usepackage{titling}
1288− \par\large#1\end{center}}
1291−Language variables
1840+${if(foo)}
1292−------------------
1841+ ${foo}
1294−`lang`
1844+${if(foo)}
1295−: identifies the main language of the document,
1845+${ foo.bar }
1296− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1846+${else}
1297− For some output formats, pandoc will convert it to an appropriate
1847+no foo!
1298− format stored in the additional variables `babel-lang`,
1848+${endif}
1299− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1849+```
1301− Native pandoc `span`s and `div`s with the lang attribute
1302− (value in BCP 47) can be used to switch the language in
1306−: a list of other languages used in the document
1307− in the YAML metadata, according to [BCP 47]. For example:
1308− `otherlangs: [en-GB, fr]`.
1309− This is automatically generated from the `lang` attributes
1310− in all `span`s and `div`s but can be overridden.
1311− Currently only used by LaTeX through the generated
1312− `babel-otherlangs` and `polyglossia-otherlangs` variables.
1313− The LaTeX writer outputs polyglossia commands in the text but
1314− the `babel-newcommands` variable contains mappings for them
1315− to the corresponding babel.
1317−`dir`
1851+The keyword `elseif` may be used to simplify complex nested
1318−: the base direction of the document, either `rtl` (right-to-left)
1852+conditionals:
1319− or `ltr` (left-to-right).
1321− For bidirectional documents, native pandoc `span`s and `div`s
1854+```
1322− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1855+$if(foo)$
1323− override the base direction in some output formats.
1856+XXX
1324− This may not always be necessary if the final renderer
1857+$elseif(bar)$
1325− (e.g. the browser, when generating HTML) supports the
1858+YYY
1326− [Unicode Bidirectional Algorithm].
1859+$else$
1328− When using LaTeX for bidirectional documents, only the `xelatex` engine
1864+### For loops
1329− is fully supported (use `--pdf-engine=xelatex`).
1331−[BCP 47]: https://tools.ietf.org/html/bcp47
1866+A for loop begins with `for(variable)` (enclosed in
1332−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1334−Variables for slides
1870+- If `variable` is an array, the material inside the loop will
1335−--------------------
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
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.
1337−Variables are available for [producing slide shows with pandoc],
1878+Examples:
1338−including all [reveal.js configuration options].
1340−`titlegraphic`
1880+```
1341−: title graphic for Beamer documents
1881+$for(foo)$$foo$$sep$, $endfor$
1343−`logo`
1883+$for(foo)$
1344−: logo for Beamer documents
1884+ - $foo.last$, $foo.first$
1346−`slidy-url`
1887+${ for(foo.bar) }
1347−: base URL for Slidy documents (defaults to
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1348− `https://www.w3.org/Talks/Tools/Slidy2`)
1889+${ endfor }
1350−`slideous-url`
1891+$for(mymap)$
1351−: base URL for Slideous documents (defaults to `slideous`)
1892+$it.name$: $it.office$
1353−`s5-url`
1896+You may optionally specify a separator between consecutive
1354−: base URL for S5 documents (defaults to `s5/default`)
1897+values using `sep` (enclosed in matched delimiters). The
1898+material between `sep` and the `endfor` is the separator.
1356−`revealjs-url`
1900+```
1357−: base URL for reveal.js documents (defaults to `reveal.js`)
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1359−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1904+Instead of using `variable` inside the loop, the special
1360−: themes for LaTeX [`beamer`] documents
1905+anaphoric keyword `it` may be used.
1362−`themeoptions`
1907+```
1363−: options for LaTeX beamer themes (a list).
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1365−`navigation`
1913+### Partials
1366−: controls navigation symbols in `beamer` documents
1367− (default is `empty` for no navigation symbols; other valid values
1368− are `frame`, `vertical`, and `horizontal`).
1370−`section-titles`
1915+Partials (subtemplates stored in different files) may be
1371−: enables on "title pages" for new sections in `beamer`
1916+included by using the name of the partial, followed
1372− documents (default = true).
1917+by `()`, for example:
1374−`beamerarticle`
1919+```
1375−: when true, the `beamerarticle` package is loaded (for
1920+${ styles() }
1376− producing an article from beamer slides).
1921+```
1378−`aspectratio`
1923+Partials will be sought in the directory containing
1379−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1924+the main template. The file name will be assumed to
1380− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1925+have the same extension as the main template if it
1381− default, and `32` for 3:2).
1926+lacks an extension. When calling the partial, the
1927+full name including file extension can also be used:
1383−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1929+```
1385−Variables for LaTeX
1933+(If a partial is not found in the directory of the
1386−-------------------
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.)
1388−LaTeX variables are used when [creating a PDF].
1938+Partials may optionally be applied to variables using
1391−: paper size, e.g. `letter`, `a4`
1942+${ date:fancy() }
1393−`fontsize`
1944+${ articles:bibentry() }
1394−: font size for body text (e.g. `10pt`, `12pt`)
1945+```
1396−`documentclass`
1947+If `articles` is an array, this will iterate over its
1397−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1948+values, applying the partial `bibentry()` to each one. So the
1949+second example above is equivalent to
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`.
1962+Final newlines are omitted from included partials.
1964+Partials may include other partials.
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1973+${articles:bibentry()[; ]$
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.
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
1986+$item.number$ $^$$item.description$ ($item.price$)
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
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.
2018+### Breakable spaces
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 `~`).
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
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:
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2045+$employee:name()/uppercase$
2048+Pipes may be chained:
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2056+Some pipes take parameters:
2059+|----------------------|------------|
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2063+|----------------------|------------|
2066+Currently the following pipes are predefined:
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,
2073+- `uppercase`: Converts text to uppercase.
2075+- `lowercase`: Converts text to lowercase.
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.
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
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.
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.
2100+- `chomp`: Removes trailing newlines (and breakable space).
2102+- `nowrap`: Disables line wrapping on breakable spaces.
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`.
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`.
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.
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.
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.
2134+### Metadata variables
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`]:
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.
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
2169+: document subject, included in ODT, PDF, docx and pptx metadata
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
2176+: document category, included in docx and pptx metadata
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:
2184+ title: 'This is the title'
2185+ subtitle: "This is the subtitle"
2193+ It consists of two paragraphs
2196+will include `title`, `author` and `description` as standard document
2197+properties and `subtitle` as a custom property when converting to docx,
2200+### Language variables
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.
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
2216+ Text in the main document language (British English).
2219+ > Cette citation est écrite en français canadien.
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
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].
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
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/
2243+### Variables for HTML
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`.
2254+: sets the CSS `font-family` property on the `html` element.
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).
2262+: sets the CSS `color` property on the `html` element.
2265+: sets the CSS `color` property on all links.
2268+: sets the CSS `font-family` property on `code` elements.
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
2279+: sets the CSS `background-color` property on the `html` element.
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
2284+To override or extend some [CSS] for just one document, include for example:
2290+ font-style: italic;
2293+ background-color: #f0f0f0;
2296+ padding: 0.5em 2em 0.5em 0.5em;
2299+ border-bottom: none;
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2306+### Variables for HTML math
1399`classoption`
2308`classoption`
1400−: option for document class, e.g. `oneside`; may be repeated
2309+: when using [KaTeX](#option--katex), you can render display
1401− for multiple options
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
2313+### Variables for HTML slides
2315+These affect HTML output when [producing slide shows with pandoc].
2318+: author affiliations: can be a list when there are multiple authors
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
2325+: base URL for S5 documents (defaults to `s5/default`)
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
2332+: base URL for Slideous documents (defaults to `slideous`)
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.
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`.
2341+[reveal.js configuration options]: https://revealjs.com/config/
2343+### Variables for Beamer slides
2345+These variables change the appearance of PDF slides using [`beamer`].
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,
2353+: produce an article from Beamer slides
2356+: add extra beamer option with `\setbeameroption{}`
2359+: author affiliations: can be a list when there are multiple authors
2362+: logo image for slides
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2369+: enables "title pages" for new sections (default is true)
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2375+: options for LaTeX beamer themes (a list).
2378+: image for title slide
2380+### Variables for PowerPoint
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
2386+: font to use for code.
2388+### Variables for LaTeX
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
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:
2403+ documentclass: scrartcl
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}
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
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`]
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2450+ - pdfpagemode=FullScreen
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)
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
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)
2472+: paper size, e.g. `letter`, `a4`
2475+: numbering depth for sections (with `--number-sections` option
2476+ or `numbersections` variable)
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
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`].
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:
2495+ fontfamily: libertinus
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`.
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.
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:
2519+ mainfont: TeX Gyre Pagella
2521+ - Numbers=Lowercase
2522+ - Numbers=Proportional
2526+: options to pass to the microtype package
2531+: add color to link text; automatically enabled if any of
2532+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
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
2541+: causes links to be printed as footnotes
2546+: include list of figures, list of tables
2549+: contents of acknowledgments footnote after document title
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
2556+: level of section to include in table of contents
2558+#### BibLaTeX Bibliographies
2560+These variables function when using BibLaTeX for [citation rendering].
2563+: list of options for biblatex
2566+: bibliography style, when used with `--natbib` and `--biblatex`.
2569+: bibliography title, when used with `--natbib` and `--biblatex`.
2572+: bibliography to use for resolving references
2575+: list of options for natbib
2577+[KOMA-Script]: https://ctan.org/pkg/koma-script
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579+[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580+[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581+[`article`]: https://ctan.org/pkg/article
2582+[`book`]: https://ctan.org/pkg/book
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
2584+[`memoir`]: https://ctan.org/pkg/memoir
2585+[`report`]: https://ctan.org/pkg/report
2587+### Variables for ConTeXt
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
2592+: font size for body text (e.g. `10pt`, `12pt`)
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
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
2603+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604+ repeat for multiple options
2607+: options for page margins and text arrangement (see [ConTeXt Layout]);
2608+ repeat for multiple options
2610+`linkcolor`, `contrastcolor`
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
2619+: include list of figures, list of tables
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626+: sets margins, if `layout` is not used (otherwise `layout`
2630+: page number style and location (using [`setuppagenumbering`]);
2631+ repeat for multiple options
2634+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635+ repeat for multiple options
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.
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].
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.
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
2672+: include all source documents as file attachments in the PDF file
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
2686+### Variables for `wkhtmltopdf`
2688+Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689+The `--css` option also affects the output.
2691+`footer-html`, `header-html`
2692+: add information to the header and footer
2694+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695+: set the page margins
2698+: sets the PDF paper size
2700+### Variables for man pages
2703+: adjusts text to left (`l`), right (`r`), center (`c`),
2704+ or both (`b`) margins
2707+: footer in man pages
2710+: header in man pages
2713+: if `true` (the default), hyphenation will be used
2716+: section number in man pages
2718+### Variables for ms
2721+: font family (e.g. `T` or `P`)
2724+: paragraph indent (e.g. `2m`)
2727+: line height (e.g. `12p`)
2730+: point size (e.g. `10p`)
2732+### Variables set automatically
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:
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`).
2752+: contents specified by `-H/--include-in-header` (may have multiple
2756+: contents specified by `-B/--include-before-body` (may have
2760+: contents specified by `-A/--include-after-body` (may have
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
2768+: non-null value if `-N/--number-sections` was specified
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:
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2789+: working directory from which pandoc is run.
2792+: non-null value if `--toc/--table-of-contents` was specified
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2798+[pandoc-templates]: https://github.com/jgm/pandoc-templates
2802+The behavior of some of the readers and writers can be adjusted by
2803+enabling or disabling various extensions.
2805+An extension can be enabled by adding `+EXTENSION`
2806+to the format name and disabled by adding `-EXTENSION`. For example,
2807+`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809+Markdown without footnotes or pipe tables.
2811+The markdown reader and writer make by far the most use of extensions.
2812+Extensions only used by them are therefore covered in the
2813+section [Pandoc's Markdown] below (See [Markdown variants] for
2814+`commonmark` and `gfm`.) In the following, extensions that also work
2815+for other formats are covered.
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`).
2823+#### Extension: `smart` ####
2825+Interpret straight quotes as curly quotes, `---` as em-dashes,
2826+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2827+inserted after certain abbreviations, such as "Mr."
2829+This extension can be enabled/disabled for the following formats:
2832+: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2835+: `markdown`, `latex`, `context`, `rst`
2837+enabled by default in
2838+: `markdown`, `latex`, `context` (both input and output)
2840+Note: If you are *writing* Markdown, then the `smart` extension
2841+has the reverse effect: what would have been curly quotes comes
2844+In LaTeX, `smart` means to use the standard TeX ligatures
2845+for quotation marks (` `` ` and ` '' ` for double quotes,
2846+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2847+en-dash and `---` for em-dash). If `smart` is disabled,
2848+then in reading LaTeX pandoc will parse these characters
2849+literally. In writing LaTeX, enabling `smart` tells pandoc
2850+to use the ligatures when possible; if `smart` is disabled
2851+pandoc will use unicode quotation mark and dash characters.
1403−`geometry`
2853+## Headings and sections
1404−: option for [`geometry`] package, e.g. `margin=1in`;
1405− may be repeated for multiple options
1407−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2855+#### Extension: `auto_identifiers` ####
1408−: sets margins, if `geometry` is not used (otherwise `geometry`
1411−`linestretch`
2857+A heading without an explicitly specified identifier will be
1412−: adjusts line spacing using the [`setspace`]
2858+automatically assigned a unique identifier based on the heading text.
1413− package, e.g. `1.25`, `1.5`
1415−`fontfamily`
2860+This extension can be enabled/disabled for the following formats:
1416−: font package for use with `pdflatex`:
1417− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1418− The default is [Latin Modern][`lm`].
1420−`fontfamilyoptions`
2862+input formats
1421−: options for package used as `fontfamily`: e.g. `osf,sc` with
2863+: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
1422− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1423− figures and true small caps; may be repeated for multiple options
1425−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2865+output formats
1426−: font families for use with `xelatex` or
2866+: `markdown`, `muse`
1427− `lualatex`: take the name of any system font, using the
1428− [`fontspec`] package. Note that if `CJKmainfont` is used,
1429− the [`xecjk`] package must be available.
1431−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2868+enabled by default in
1432−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2869+: `markdown`, `muse`
1433− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1434− available through [`fontspec`], such as the OpenType features
1435− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1437−`fontenc`
2871+The default algorithm used to derive the identifier from the
1438−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2872+heading text is:
1439− default is `T1` (see guide to [LaTeX font encodings])
1441−`microtypeoptions`
2874+ - Remove all formatting, links, etc.
1442−: options to pass to the microtype package
2875+ - Remove all footnotes.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
2878+ - Replace all spaces and newlines with hyphens.
2879+ - Convert all alphabetic characters to lowercase.
2880+ - Remove everything up to the first letter (identifiers may
2881+ not begin with a number or punctuation mark).
2882+ - If nothing is left after this, use the identifier `section`.
1444−`colorlinks`
2884+Thus, for example,
1445−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1446− `urlcolor`, or `toccolor` are set
1448−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
2886+ Heading Identifier
1449−: color for internal links, citation links, external links, and links in table of contents:
2887+ ------------------------------- ----------------------------
1450− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
2890+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
2891+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2892+ `3. Applications` `applications`
1452−`links-as-notes`
2895+These rules should, in most cases, allow one to determine the identifier
1453−: causes links to be printed as footnotes
2896+from the heading text. The exception is when several headings have the
2897+same text; in this case, the first will get an identifier as described
2898+above; the second will get the same identifier with `-1` appended; the
2899+third with `-2`; and so on.
1455−`indent`
2901+(However, a different algorithm is used if
1456−: uses document class settings for indentation (the default LaTeX template
2902+`gfm_auto_identifiers` is enabled; see below.)
1457− otherwise removes indentation and adds space between paragraphs)
1459−`subparagraph`
2904+These identifiers are used to provide link targets in the table of
1460−: disables default behavior of LaTeX template that redefines (sub)paragraphs
2905+contents generated by the `--toc|--table-of-contents` option. They
1461− as sections, changing the appearance of nested headings in some classes
2906+also make it easy to provide links from one section of a document to
2907+another. A link to this section, for example, might look like this:
1463−`thanks`
2909+ See the section on
1464−: specifies contents of acknowledgments footnote after document title.
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
1466−`toc`
2912+Note, however, that this method of providing links to sections works
1467−: include table of contents (can also be set using `--toc/--table-of-contents`)
2913+only in HTML, LaTeX, and ConTeXt formats.
1469−`toc-depth`
2915+If the `--section-divs` option is specified, then each section will
1470−: level of section to include in table of contents
2916+be wrapped in a `section` (or a `div`, if `html4` was specified),
2917+and the identifier will be attached to the enclosing `<section>`
2918+(or `<div>`) tag rather than the heading itself. This allows entire
2919+sections to be manipulated using JavaScript or treated differently in
1472−`secnumdepth`
2922+#### Extension: `ascii_identifiers` ####
1473−: numbering depth for sections, if sections are numbered
1475−`lof`, `lot`
2924+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
1476−: include list of figures, list of tables
2925+Accents are stripped off of accented Latin letters, and non-Latin
2926+letters are omitted.
1478−`bibliography`
2928+#### Extension: `gfm_auto_identifiers` ####
1479−: bibliography to use for resolving references
1481−`biblio-style`
2930+Changes the algorithm used by `auto_identifiers` to conform to
1482−: bibliography style, when used with `--natbib` and `--biblatex`.
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.
1484−`biblio-title`
2936+## Math Input
1485−: bibliography title, when used with `--natbib` and `--biblatex`.
1487−`biblatexoptions`
2938+The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
1488−: list of options for biblatex.
2939+[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2940+[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2941+are described in the section about Pandoc's Markdown.
1490−`natbiboptions`
2943+However, they can also be used with HTML input. This is handy for
1491−: list of options for natbib.
2944+reading web pages formatted using MathJax, for example.
1493−[`article`]: https://ctan.org/pkg/article
2946+## Raw HTML/TeX
1494−[`report`]: https://ctan.org/pkg/report
1495−[`book`]: https://ctan.org/pkg/book
1496−[KOMA-Script]: https://ctan.org/pkg/koma-script
1497−[`memoir`]: https://ctan.org/pkg/memoir
1498−[`xcolor`]: https://ctan.org/pkg/xcolor
1499−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1500−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1501−[LaTeX font encodings]: https://ctan.org/pkg/encguide
1503−Variables for ConTeXt
2948+The following extensions are described in more detail in
1504−---------------------
2949+their respective sections of [Pandoc's Markdown]:
1506−`papersize`
2951+- [`raw_html`](#extension-raw_html) allows HTML elements which
1507−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2952+ are not representable in pandoc's AST to be parsed as raw HTML.
1508− may be repeated for multiple options
2953+ By default, this is disabled for HTML input.
1510−`layout`
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
1511−: options for page margins and text arrangement (see [ConTeXt Layout]);
2956+ to be included in a document. This extension can be enabled/disabled
1512− may be repeated for multiple options
2957+ for the following formats (in addition to `markdown`):
1514−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2959+ input formats
1515−: sets margins, if `layout` is not used (otherwise `layout`
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
1516− overrides these)
2961+ `\eqref` only), `ipynb`
1518−`fontsize`
2963+ output formats
1519−: font size for body text (e.g. `10pt`, `12pt`)
2964+ : `textile`, `commonmark`
1521−`mainfont`, `sansfont`, `monofont`, `mathfont`
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
1522−: font families: take the name of any system font (see [ConTeXt Font Switching])
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`.
1524−`linkcolor`, `contrastcolor`
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
1525−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
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`.
1527−`linkstyle`
2979+- [`native_spans`](#extension-native_spans) causes HTML `span`
1528−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
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`.
1530−`indenting`
2986+## Literate Haskell support
1531−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1532− may be repeated for multiple options
1534−`whitespace`
2988+#### Extension: `literate_haskell` ####
1535−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1537−`interlinespace`
2990+Treat the document as literate Haskell source.
1538−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1539− may be repeated for multiple options
1541−`headertext`, `footertext`
2992+This extension can be enabled/disabled for the following formats:
1542−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1543− may be repeated up to four times for different placement
1545−`pagenumbering`
2994+input formats
1546−: page number style and location (using [`setuppagenumbering`]);
2995+: `markdown`, `rst`, `latex`
1547− may be repeated for multiple options
1549−`toc`
2997+output formats
1550−: include table of contents (can also be set using `--toc/--table-of-contents`)
2998+: `markdown`, `rst`, `latex`, `html`
1552−`lof`, `lot`
3000+If you append `+lhs` (or `+literate_haskell`) to one of the formats
1553−: include list of figures, list of tables
3001+above, pandoc will treat the document as literate Haskell source.
1555−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
3004+ - In Markdown input, "bird track" sections will be parsed as Haskell
1556−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
3005+ code rather than block quotations. Text between `\begin{code}`
1557−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
3006+ and `\end{code}` will also be treated as Haskell code. For
1558−[ConTeXt Color]: http://wiki.contextgarden.net/Color
3007+ ATX-style headings the character '=' will be used instead of '#'.
1559−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1560−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1561−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1562−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1563−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1565−Variables for man pages
3009+ - In Markdown output, code blocks with classes `haskell` and `literate`
1566−-----------------------
3010+ will be rendered using bird tracks, and block quotations will be
3011+ indented one space, so they will not be treated as Haskell code.
3012+ In addition, headings will be rendered setext-style (with underlines)
3013+ rather than ATX-style (with '#' characters). (This is because ghc
3014+ treats '#' characters in column 1 as introducing line numbers.)
1568−`section`
3016+ - In restructured text input, "bird track" sections will be parsed
1569−: section number in man pages
3017+ as Haskell code.
1571−`header`
3019+ - In restructured text output, code blocks with class `haskell` will
1572−: header in man pages
3020+ be rendered using bird tracks.
1574−`footer`
3022+ - In LaTeX input, text in `code` environments will be parsed as
1575−: footer in man pages
3023+ Haskell code.
1577−`adjusting`
3025+ - In LaTeX output, code blocks with class `haskell` will be rendered
1578−: adjusts text to left (`l`), right (`r`), center (`c`),
3026+ inside `code` environments.
1579− or both (`b`) margins
1581−`hyphenate`
3028+ - In HTML output, code blocks with class `haskell` will be rendered
1582−: if `true` (the default), hyphenation will be used
3029+ with class `literatehaskell` and bird tracks.
1584−Variables for ms
3031+Examples:
1587−`pointsize`
3033+ pandoc -f markdown+lhs -t html
1588−: point size (e.g. `10p`)
1590−`lineheight`
3035+reads literate Haskell source formatted with Markdown conventions and writes
1591−: line height (e.g. `12p`)
3036+ordinary HTML (without bird tracks).
1593−`fontfamily`
3038+ pandoc -f markdown+lhs -t html+lhs
1594−: font family (e.g. `T` or `P`)
1596−`indent`
3040+writes HTML with the Haskell code in bird tracks, so it can be copied
1597−: paragraph indent (e.g. `2m`)
3041+and pasted as literate Haskell source.
1599−Using variables in templates
3043+Note that GHC expects the bird tracks in the first column, so indented
1600−----------------------------
3044+literate code blocks (e.g. inside an itemized environment) will not be
3045+picked up by the Haskell compiler.
1602−Variable names are sequences of alphanumerics, `-`, and `_`,
3047+## Other extensions
1603−starting with a letter. A variable name surrounded by `$` signs
1604−will be replaced by its value. For example, the string `$title$` in
1606− <title>$title$</title>
3049+#### Extension: `empty_paragraphs` ####
1608−will be replaced by the document title.
3051+Allows empty paragraphs. By default empty paragraphs are
1610−To write a literal `$` in a template, use `$$`.
3054+This extension can be enabled/disabled for the following formats:
1612−Templates may contain conditionals. The syntax is as follows:
3056+input formats
1614− $if(variable)$
3059+output formats
1615− X
3060+: `docx`, `odt`, `opendocument`, `html`
1620−This will include `X` in the template if `variable` has a non-null
3062+#### Extension: `native_numbering` ####
1621−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1622−any valid template text, and may include interpolated variables or other
1623−conditionals. The `$else$` section may be omitted.
1625−When variables can have multiple values (for example, `author` in
3064+Enables native numbering of figures and tables. Enumeration
1626−a multi-author document), you can use the `$for$` keyword:
3065+starts at 1.
1628− $for(author)$
3067+This extension can be enabled/disabled for the following formats:
1629− <meta name="author" content="$author$" />
1632−You can optionally specify a separator to be used between
3069+output formats
1633−consecutive items:
3070+: `odt`, `opendocument`
1635− $for(author)$$author$$sep$, $endfor$
3072+#### Extension: `xrefs_name` ####
1637−A dot can be used to select a field of a variable that takes
3074+Links to headings, figures and tables inside the document are
1638−an object as its value. So, for example:
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
1640− $author.name$ ($author.affiliation$)
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
1642−If you use custom templates, you may need to revise them as pandoc
3084+This extension can be enabled/disabled for the following formats:
1643−changes. We recommend tracking the changes in the default templates,
1644−and modifying your custom templates accordingly. An easy way to do this
1645−is to fork the [pandoc-templates] repository and merge in changes after each
1648−Templates may contain comments: anything on a line after `$--`
3086+output formats
1649−will be treated as a comment and ignored.
3087+: `odt`, `opendocument`
1651−[pandoc-templates]: https://github.com/jgm/pandoc-templates
3089+#### Extension: `xrefs_number` ####
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.
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.
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3104+This extension can be enabled/disabled for the following formats:
3107+: `odt`, `opendocument`
3109+#### Extension: `styles` #### {#ext-styles}
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.
3120+#### Extension: `amuse` ####
3122+In the `muse` input format, this enables Text::Amuse
3123+extensions to Emacs Muse markup.
3125+#### Extension: `raw_markdown` ####
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
3133+#### Extension: `citations` {#org-citations}
1653−Pandoc's Markdown
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
1654−=================
3136+are also accepted in `org` input.
3138+#### Extension: `element_citations` ####
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.
3145+#### Extension: `ntb` ####
3147+In the `context` output format this enables the use of [Natural Tables
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3150+Natural tables allow more fine-grained global customization but come
3151+at a performance penalty compared to extreme tables.
1656Pandoc understands an extended and slightly revised version of
3156Pandoc understands an extended and slightly revised version of
1657John Gruber's [Markdown] syntax. This document explains the syntax,
3157John Gruber's [Markdown] syntax. This document explains the syntax,
1658noting differences from standard Markdown. Except where noted, these
3158noting differences from standard Markdown. Except where noted, these
1659differences can be suppressed by using the `markdown_strict` format instead
3159differences can be suppressed by using the `markdown_strict` format instead
1660−of `markdown`. An extensions can be enabled by adding `+EXTENSION`
3160+of `markdown`. Extensions can be enabled or disabled to specify the
1661−to the format name and disabled by adding `-EXTENSION`. For example,
3161+behavior more granularly. They are described in the following. See also
1662−`markdown_strict+footnotes` is strict Markdown with footnotes
3162+[Extensions] above, for extensions that work also on other formats.
1663−enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1664−Markdown without footnotes or pipe tables.
1666−Philosophy
3164+## Philosophy
1669Markdown is designed to be easy to write, and, even more importantly,
3166Markdown is designed to be easy to write, and, even more importantly,
1670easy to read:
3167easy to read:
@@ -1672,7 +3169,7 @@ easy to read:
1672> A Markdown-formatted document should be publishable as-is, as plain
3169> A Markdown-formatted document should be publishable as-is, as plain
1673> text, without looking like it's been marked up with tags or formatting
3170> text, without looking like it's been marked up with tags or formatting
1674> instructions.
3171> instructions.
1675−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
1677This principle has guided pandoc's decisions in finding syntax for
3174This principle has guided pandoc's decisions in finding syntax for
1678tables, footnotes, and other extensions.
3175tables, footnotes, and other extensions.
@@ -1685,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
1685important document elements like definition lists, tables, mathematics, and
3182important document elements like definition lists, tables, mathematics, and
1686footnotes.
3183footnotes.
1688−Paragraphs
3185+## Paragraphs
1691A paragraph is one or more lines of text followed by one or more blank lines.
3187A paragraph is one or more lines of text followed by one or more blank lines.
1692Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -1699,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
1699to create a hard line break, since trailing spaces in the cells
3195to create a hard line break, since trailing spaces in the cells
1700are ignored.
3196are ignored.
1702−Headers
3198+## Headings
1705−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
1707−### Setext-style headers ###
3202+### Setext-style headings ###
1709−A setext-style header is a line of text "underlined" with a row of `=` signs
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
1710−(for a level one header) or `-` signs (for a level two header):
3205+(for a level-one heading) or `-` signs (for a level-two heading):
1712− A level-one header
3207+ A level-one heading
1713− ==================
3208+ ===================
1715− A level-two header
3210+ A level-two heading
1716− ------------------
3211+ -------------------
1718−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
1719[Inline formatting], below).
3214[Inline formatting], below).
1722−### ATX-style headers ###
3217+### ATX-style headings ###
1724−An ATX-style header consists of one to six `#` signs and a line of
3219+An ATX-style heading consists of one to six `#` signs and a line of
1725text, optionally followed by any number of `#` signs. The number of
3220text, optionally followed by any number of `#` signs. The number of
1726−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
1728− ## A level-two header
3223+ ## A level-two heading
1730− ### A level-three header ###
3225+ ### A level-three heading ###
1732−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
1734− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
1736#### Extension: `blank_before_header` ####
3231#### Extension: `blank_before_header` ####
1738−Standard Markdown syntax does not require a blank line before a header.
3233+Standard Markdown syntax does not require a blank line before a heading.
1739Pandoc does require this (except, of course, at the beginning of the
3234Pandoc does require this (except, of course, at the beginning of the
1740document). The reason for the requirement is that it is all too easy for a
3235document). The reason for the requirement is that it is all too easy for a
1741`#` to end up at the beginning of a line by accident (perhaps through line
3236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -1747,27 +3242,30 @@ wrapping). Consider, for example:
1747#### Extension: `space_in_atx_header` ####
3242#### Extension: `space_in_atx_header` ####
1749Many Markdown implementations do not require a space between the
3244Many Markdown implementations do not require a space between the
1750−opening `#`s of an ATX header and the header text, so that
3245+opening `#`s of an ATX heading and the heading text, so that
1751−`#5 bolt` and `#hashtag` count as headers. With this extension,
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
1752pandoc does require the space.
3247pandoc does require the space.
1754−### Header identifiers ###
3249+### Heading identifiers ###
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
1756#### Extension: `header_attributes` ####
3254#### Extension: `header_attributes` ####
1758−Headers can be assigned attributes using this syntax at the end
3256+Headings can be assigned attributes using this syntax at the end
1759−of the line containing the header text:
3257+of the line containing the heading text:
1761 {#identifier .class .class key=value key=value}
3259 {#identifier .class .class key=value key=value}
1763−Thus, for example, the following headers will all be assigned the identifier
3261+Thus, for example, the following headings will all be assigned the identifier
1766− # My header {#foo}
3264+ # My heading {#foo}
1768− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
1770− My other header {#foo}
3268+ My other heading {#foo}
1771 ---------------
3269 ---------------
1773(This syntax is compatible with [PHP Markdown Extra].)
3271(This syntax is compatible with [PHP Markdown Extra].)
@@ -1776,100 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
1776attributes, writers generally don't use all of this information. Identifiers,
3274attributes, writers generally don't use all of this information. Identifiers,
1777classes, and key/value attributes are used in HTML and HTML-based formats such
3275classes, and key/value attributes are used in HTML and HTML-based formats such
1778as EPUB and slidy. Identifiers are used for labels and link anchors in the
3276as EPUB and slidy. Identifiers are used for labels and link anchors in the
1779−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
1781−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
1782`--number-sections` is specified. A single hyphen (`-`) in an attribute
3280`--number-sections` is specified. A single hyphen (`-`) in an attribute
1783context is equivalent to `.unnumbered`, and preferable in non-English
3281context is equivalent to `.unnumbered`, and preferable in non-English
1784documents. So,
3282documents. So,
1786− # My header {-}
3284+ # My heading {-}
1788is just the same as
3286is just the same as
1790− # My header {.unnumbered}
3288+ # My heading {.unnumbered}
1792−#### Extension: `auto_identifiers` ####
1794−A header without an explicitly specified identifier will be
1795−automatically assigned a unique identifier based on the header text.
1796−To derive the identifier from the header text,
1798− - Remove all formatting, links, etc.
1799− - Remove all footnotes.
1800− - Remove all punctuation, except underscores, hyphens, and periods.
1801− - Replace all spaces and newlines with hyphens.
1802− - Convert all alphabetic characters to lowercase.
1803− - Remove everything up to the first letter (identifiers may
1804− not begin with a number or punctuation mark).
1805− - If nothing is left after this, use the identifier `section`.
1810− ------------------------------- ----------------------------
1811− `Header identifiers in HTML` `header-identifiers-in-html`
1812− `*Dogs*?--in *my* house?` `dogs--in-my-house`
1813− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1814− `3. Applications` `applications`
1817−These rules should, in most cases, allow one to determine the identifier
1818−from the header text. The exception is when several headers have the
1819−same text; in this case, the first will get an identifier as described
1820−above; the second will get the same identifier with `-1` appended; the
1821−third with `-2`; and so on.
1823−These identifiers are used to provide link targets in the table of
1824−contents generated by the `--toc|--table-of-contents` option. They
1825−also make it easy to provide links from one section of a document to
1826−another. A link to this section, for example, might look like this:
1829− [header identifiers](#header-identifiers-in-html-latex-and-context).
1831−Note, however, that this method of providing links to sections works
1832−only in HTML, LaTeX, and ConTeXt formats.
1834−If the `--section-divs` option is specified, then each section will
3290+If the `unlisted` class is present in addition to `unnumbered`,
1835−be wrapped in a `div` (or a `section`, if `html5` was specified),
3291+the heading will not be included in a table of contents.
1836−and the identifier will be attached to the enclosing `<div>`
3292+(Currently this feature is only implemented for certain
1837−(or `<section>`) tag rather than the header itself. This allows entire
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
1838−sections to be manipulated using JavaScript or treated differently in
1841#### Extension: `implicit_header_references` ####
3295#### Extension: `implicit_header_references` ####
1843−Pandoc behaves as if reference links have been defined for each header.
3297+Pandoc behaves as if reference links have been defined for each heading.
1844−So, to link to a header
3298+So, to link to a heading
1846− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
1848you can simply write
3302you can simply write
1850− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
1854− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
1858− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
1861instead of giving the identifier explicitly:
3315instead of giving the identifier explicitly:
1863− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
1865−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
1866reference will link to the first one only, and you will need to use explicit
3320reference will link to the first one only, and you will need to use explicit
1867links to link to the others, as described above.
3321links to link to the others, as described above.
1869Like regular reference links, these references are case-insensitive.
3323Like regular reference links, these references are case-insensitive.
1871Explicit link reference definitions always take priority over
3325Explicit link reference definitions always take priority over
1872−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
1873link will point to `bar`, not to `#foo`:
3327link will point to `bar`, not to `#foo`:
@@ -1878,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
1879 See [foo]
3333 See [foo]
1881−Block quotations
3335+## Block quotations
1884Markdown uses email conventions for quoting blocks of text.
3337Markdown uses email conventions for quoting blocks of text.
1885A block quotation is one or more paragraphs or other block elements
3338A block quotation is one or more paragraphs or other block elements
1886−(such as lists or headers), with each line preceded by a `>` character
3339+(such as lists or headings), with each line preceded by a `>` character
1887and an optional space. (The `>` need not start at the left margin, but
3340and an optional space. (The `>` need not start at the left margin, but
1888it should not be indented more than three spaces.)
3341it should not be indented more than three spaces.)
@@ -1918,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
1919#### Extension: `blank_before_blockquote` ####
3372#### Extension: `blank_before_blockquote` ####
1921−Standard Markdown syntax does not require a blank line before a block
3374+Standard Markdown syntax does not require a blank line before a
1922−quote. Pandoc does require this (except, of course, at the beginning of the
3375+block quote. Pandoc does require this (except, of course, at
1923−document). The reason for the requirement is that it is all too easy for a
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
1924−`>` to end up at the beginning of a line by accident (perhaps through line
3378+of a line by accident (perhaps through line wrapping). So,
1925−wrapping). So, unless the `markdown_strict` format is used, the following does
3379+unless the `markdown_strict` format is used, the following does
1926not produce a nested block quote in pandoc:
3380not produce a nested block quote in pandoc:
1928 > This is a block quote.
3382 > This is a block quote.
1929 >> Nested.
3383 >> Nested.
1932−Verbatim (code) blocks
3386+## Verbatim (code) blocks
1933−----------------------
1935### Indented code blocks ###
3388### Indented code blocks ###
@@ -1992,14 +3445,16 @@ this syntax:
1992 qsort (filter (>= x) xs)
3445 qsort (filter (>= x) xs)
1993 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1995−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
1996−`startFrom` is an attribute with value `100`. Some output formats can use this
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
1997−information to do syntax highlighting. Currently, the only output formats
3451+highlighting. Currently, the only output formats that uses this
1998−that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
1999−is supported for your output format and language, then the code block above
3453+highlighting is supported for your output format and language,
2000−will appear highlighted, with numbered lines. (To see which languages are
3454+then the code block above will appear highlighted, with numbered
3455+lines. (To see which languages are supported, type `pandoc
2001−supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
3456+--list-highlight-languages`.) Otherwise, the code block above
2002−block above will appear as follows:
3457+will appear as follows:
2004 <pre id="mycode" class="haskell numberLines" startFrom="100">
3459 <pre id="mycode" class="haskell numberLines" startFrom="100">
@@ -2007,6 +3462,12 @@ block above will appear as follows:
3465+The `numberLines` (or `number-lines`) class will cause the lines
3466+of the code block to be numbered, starting with `1` or the value
3467+of the `startFrom` attribute. The `lineAnchors` (or
3468+`line-anchors`) class will cause the lines to be clickable
3469+anchors in HTML output.
2010A shortcut form can also be used for specifying the language of
3471A shortcut form can also be used for specifying the language of
2011the code block:
3472the code block:
@@ -2030,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
2030For more information on highlighting, see [Syntax highlighting],
3491For more information on highlighting, see [Syntax highlighting],
2033−Line blocks
3494+## Line blocks
2036#### Extension: `line_blocks` ####
3496#### Extension: `line_blocks` ####
@@ -2057,10 +3517,12 @@ line must begin with a space.
2057 | 200 Main St.
3517 | 200 Main St.
2058 | Berkeley, CA 94718
3518 | Berkeley, CA 94718
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
2060This syntax is borrowed from [reStructuredText].
3523This syntax is borrowed from [reStructuredText].
2065### Bullet lists ###
3527### Bullet lists ###
@@ -2230,6 +3692,12 @@ If default list markers are desired, use `#.`:
2231 #. three
3693 #. three
3695+#### Extension: `task_lists` ####
3697+Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3699+ - [ ] an unchecked task list item
2234### Definition lists ###
3702### Definition lists ###
@@ -2255,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
2255A definition begins with a colon or tilde, which may be indented one
3723A definition begins with a colon or tilde, which may be indented one
2256or two spaces.
3724or two spaces.
2258−A term may have multiple definitions, and each definition may consist of one or
3726+A term may have multiple definitions, and each definition may
2259−more block elements (paragraph, code block, list, etc.), each indented four
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
2260−spaces or one tab stop. The body of the definition (including the first line,
3729+body of the definition (including the first line, aside from the
2261−aside from the colon or tilde) should be indented four spaces. However,
3730+colon or tilde) should be indented four spaces. However, as with
2262−as with other Markdown lists, you can "lazily" omit indentation except
3731+other Markdown lists, you can "lazily" omit indentation except
2263at the beginning of a paragraph or other block element:
3732at the beginning of a paragraph or other block element:
@@ -2285,9 +3754,10 @@ definition:
2285Note that space between items in a definition list is required.
3754Note that space between items in a definition list is required.
2286(A variant that loosens this requirement, but disallows "lazy"
3755(A variant that loosens this requirement, but disallows "lazy"
2287hard wrapping, can be activated with `compact_definition_lists`: see
3756hard wrapping, can be activated with `compact_definition_lists`: see
2288−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
2290−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2292### Numbered example lists ###
3762### Numbered example lists ###
@@ -2316,30 +3786,12 @@ document:
2316The label can be any string of alphanumeric characters, underscores,
3786The label can be any string of alphanumeric characters, underscores,
2317or hyphens.
3787or hyphens.
2319−
3789+Note: continuation paragraphs in example lists must always
2320−### Compact and loose lists ###
3790+be indented four spaces, regardless of the length of the
2321−
3791+list marker. That is, example lists always behave as if the
2322−Pandoc behaves differently from `Markdown.pl` on some "edge
3792+`four_space_rule` extension is set. This is because example
2323−cases" involving lists. Consider this source:
3793+labels tend to be long, and indenting content to the
2324−
3794+first non-space character after the label would be awkward.
2333−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2334−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2335−"Second" and "Third" (but not "First"), because of the blank space
2336−around "Third". Pandoc follows a simple rule: if the text is followed by
2337−a blank line, it is treated as a paragraph. Since "Second" is followed
2338−by a list, and not a blank line, it isn't treated as a paragraph. The
2339−fact that the list is followed by a blank line is irrelevant. (Note:
2340−Pandoc works this way even when the `markdown_strict` format is specified. This
2341−behavior is consistent with the official Markdown syntax description,
2342−even though it is different from that of `Markdown.pl`.)
2345### Ending a list ###
3797### Ending a list ###
@@ -2379,8 +3831,7 @@ of one big list:
2382−Horizontal rules
3834+## Horizontal rules
2385A line containing a row of three or more `*`, `-`, or `_` characters
3836A line containing a row of three or more `*`, `-`, or `_` characters
2386(optionally separated by spaces) produces a horizontal rule:
3837(optionally separated by spaces) produces a horizontal rule:
@@ -2390,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
2390 ---------------
3841 ---------------
2393−Tables
3844+## Tables
2396Four kinds of tables may be used. The first three kinds presuppose the use of
3846Four kinds of tables may be used. The first three kinds presuppose the use of
2397a fixed-width font, such as Courier. The fourth kind can be used with
3847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2416,7 +3866,7 @@ Simple tables look like this:
2417 Table: Demonstration of simple table syntax.
3867 Table: Demonstration of simple table syntax.
2419−The headers and table rows must each fit on one line. Column
3869+The header and table rows must each fit on one line. Column
2420alignments are determined by the position of the header text relative
3870alignments are determined by the position of the header text relative
2421to the dashed line below it:[^4]
3871to the dashed line below it:[^4]
@@ -2435,7 +3885,7 @@ to the dashed line below it:[^4]
2435The table must end with a blank line, or a line of dashes followed by
3885The table must end with a blank line, or a line of dashes followed by
2436a blank line.
3886a blank line.
2438−The column headers may be omitted, provided a dashed line is used
3888+The column header row may be omitted, provided a dashed line is used
2439to end the table. For example:
3889to end the table. For example:
2441 ------- ------ ---------- -------
3891 ------- ------ ---------- -------
@@ -2444,13 +3894,13 @@ to end the table. For example:
2445 ------- ------ ---------- -------
3895 ------- ------ ---------- -------
2447−When headers are omitted, column alignments are determined on the basis
3897+When the header row is omitted, column alignments are determined on the basis
2448of the first line of the table body. So, in the tables above, the columns
3898of the first line of the table body. So, in the tables above, the columns
2449would be right, left, center, and right aligned, respectively.
3899would be right, left, center, and right aligned, respectively.
2451#### Extension: `multiline_tables` ####
3901#### Extension: `multiline_tables` ####
2453−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
2454of text (but cells that span multiple columns or rows of the table are
3904of text (but cells that span multiple columns or rows of the table are
2455not supported). Here is an example:
3905not supported). Here is an example:
@@ -2472,7 +3922,7 @@ not supported). Here is an example:
2472These work like simple tables, but with the following differences:
3922These work like simple tables, but with the following differences:
2474 - They must begin with a row of dashes, before the header text
3924 - They must begin with a row of dashes, before the header text
2475− (unless the headers are omitted).
3925+ (unless the header row is omitted).
2476 - They must end with a row of dashes, then a blank line.
3926 - They must end with a row of dashes, then a blank line.
2477 - The rows must be separated by blank lines.
3927 - The rows must be separated by blank lines.
@@ -2481,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
2481the output. So, if you find that one of the columns is too narrow in the
3931the output. So, if you find that one of the columns is too narrow in the
2482output, try widening it in the Markdown source.
3932output, try widening it in the Markdown source.
2484−Headers may be omitted in multiline tables as well as simple tables:
3934+The header may be omitted in multiline tables as well as simple tables:
2486 ----------- ------- --------------- -------------------------
3936 ----------- ------- --------------- -------------------------
2487 First row 12.0 Example of a row that
3937 First row 12.0 Example of a row that
@@ -2492,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
2493 ----------- ------- --------------- -------------------------
3943 ----------- ------- --------------- -------------------------
2495− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
2497It is possible for a multiline table to have just one row, but the row
3947It is possible for a multiline table to have just one row, but the row
2498should be followed by a blank line (and then the row of dashes that ends
3948should be followed by a blank line (and then the row of dashes that ends
@@ -2518,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
2518omitted for a headerless table. The cells of grid tables may contain
3968omitted for a headerless table. The cells of grid tables may contain
2519arbitrary block elements (multiple paragraphs, code blocks, lists,
3969arbitrary block elements (multiple paragraphs, code blocks, lists,
2520etc.). Cells that span multiple columns or rows are not
3970etc.). Cells that span multiple columns or rows are not
2521−supported. Grid tables can be created easily using [Emacs table mode].
3971+supported. Grid tables can be created easily using Emacs' table-mode
2522−
3972+(`M-x table-insert`).
2523−[Emacs table mode]: http://table.sourceforge.net/
2525Alignments can be specified as with pipe tables, by putting
3974Alignments can be specified as with pipe tables, by putting
2526colons at the boundaries of the separator line after the
3975colons at the boundaries of the separator line after the
@@ -2548,7 +3997,7 @@ and the same number of rows in each column. For example, the
2548Docutils [sample grid tables] will not render as expected with
3997Docutils [sample grid tables] will not render as expected with
2551−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2554#### Extension: `pipe_tables` ####
4003#### Extension: `pipe_tables` ####
@@ -2581,10 +4030,15 @@ legal (though ugly) pipe table:
2582The cells of pipe tables cannot contain block elements like paragraphs
4031The cells of pipe tables cannot contain block elements like paragraphs
2583and lists, and cannot span multiple lines. If a pipe table contains a
4032and lists, and cannot span multiple lines. If a pipe table contains a
2584−row whose printable content is wider than the column width (see
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
2585−`--columns`), then the cell contents will wrap, with the
4035+the cell contents will wrap, with the relative cell widths determined
2586−relative cell widths determined by the widths of the separator
4036+by the number of dashes in the line separating the table header from
2587−lines.
4037+the table body. (For example `---|-` would make the first column 3/4
4038+and the second column 1/4 of the full text width.)
4039+On the other hand, if no lines are wider than column width, then
4040+cell contents will not be wrapped, and the cells will be sized
2589Note: pandoc also recognizes pipe tables of the following
4043Note: pandoc also recognizes pipe tables of the following
2590form, as can be produced by Emacs' orgtbl-mode:
4044form, as can be produced by Emacs' orgtbl-mode:
@@ -2600,8 +4054,7 @@ you'll need to add colons as above.
2601[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2603−Metadata blocks
4057+## Metadata blocks
2606#### Extension: `pandoc_title_block` ####
4059#### Extension: `pandoc_title_block` ####
@@ -2617,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
2617or all three elements. If you want to include an author but no
4070or all three elements. If you want to include an author but no
2618title, or a title and a date but no author, you need a blank line:
4071title, or a title and a date but no author, you need a blank line:
2621− % Author
4075+% Author
2623− % My title
4079+% My title
2625− % June 15, 2006
4081+% June 15, 2006
2627The title may occupy multiple lines, but continuation lines must
4084The title may occupy multiple lines, but continuation lines must
2628begin with leading space, thus:
4085begin with leading space, thus:
2630− % My title
4088+% My title
2631− on multiple lines
4089+ on multiple lines
2633If a document has multiple authors, the authors may be put on
4092If a document has multiple authors, the authors may be put on
2634separate lines with leading space, or separated by semicolons, or
4093separate lines with leading space, or separated by semicolons, or
2635both. So, all of the following are equivalent:
4094both. So, all of the following are equivalent:
2637− % Author One
4097+% Author One
2638− Author Two
4098+ Author Two
2640− % Author One; Author Two
4102+% Author One; Author Two
2642− % Author One;
4106+% Author One;
2643− Author Two
4107+ Author Two
2645The date must fit on one line.
4110The date must fit on one line.
@@ -2681,7 +4146,7 @@ will also have "Version 4.0" in the header.
2682#### Extension: `yaml_metadata_block` ####
4147#### Extension: `yaml_metadata_block` ####
2684−A YAML metadata block is a valid YAML object, delimited by a line of three
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
2685hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2686(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2687document, but if it is not at the beginning, it must be preceded by a blank
4152document, but if it is not at the beginning, it must be preceded by a blank
@@ -2692,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
2692 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
2694Just be sure that the YAML file begins with `---` and ends with `---` or
4159Just be sure that the YAML file begins with `---` and ends with `---` or
2695−`...`.)
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.
2697Metadata will be taken from the fields of the YAML object and added to any
4164Metadata will be taken from the fields of the YAML object and added to any
2698existing document metadata. Metadata can contain lists and objects (nested
4165existing document metadata. Metadata can contain lists and objects (nested
2699arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2700with names ending in an underscore will be ignored by pandoc. (They may be
4167with names ending in an underscore will be ignored by pandoc. (They may be
2701−given a role by external processors.)
4168+given a role by external processors.) Field names must not be
4169+interpretable as YAML numbers or boolean values (so, for
4170+example, `yes`, `True`, and `15` cannot be used as field names).
2703−A document may contain multiple metadata blocks. The metadata fields will
4172+A document may contain multiple metadata blocks. If two
2704−be combined through a *left-biased union*: if two metadata blocks attempt
2705−to set the same field, the value from the first block will be taken.
4173+metadata blocks attempt to set the same field, the value from
4174+the second block will be taken.
2707When pandoc is used with `-t markdown` to create a Markdown document,
4176When pandoc is used with `-t markdown` to create a Markdown document,
2708a YAML metadata block will be produced only if the `-s/--standalone`
4177a YAML metadata block will be produced only if the `-s/--standalone`
2709option is used. All of the metadata will appear in a single block
4178option is used. All of the metadata will appear in a single block
2710at the beginning of the document.
4179at the beginning of the document.
2712−Note that YAML escaping rules must be followed. Thus, for example,
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
2713−if a title contains a colon, it must be quoted. The pipe character
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
2714−(`|`) can be used to begin an indented block that will be interpreted
4185+an indented block that will be interpreted literally, without need for
2715−literally, without need for escaping. This form is necessary
4186+escaping. This form is necessary when the field contains blank lines
2716−when the field contains blank lines or block-level formatting:
4187+or block-level formatting:
2719 title: 'This is the title: it contains a colon'
4190 title: 'This is the title: it contains a colon'
2721 - Author One
4192 - Author One
2722 - Author Two
4193 - Author Two
2723− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
2724 abstract: |
4195 abstract: |
2725 This is the abstract.
4196 This is the abstract.
2727 It consists of two paragraphs.
4198 It consists of two paragraphs.
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
2730Template variables will be set automatically from the metadata. Thus, for
4207Template variables will be set automatically from the metadata. Thus, for
2731example, in writing HTML, the variable `abstract` will be set to the HTML
4208example, in writing HTML, the variable `abstract` will be set to the HTML
2732equivalent of the Markdown in the `abstract` field:
4209equivalent of the Markdown in the `abstract` field:
@@ -2760,9 +4237,38 @@ template:
2761 $endfor$
4238 $endfor$
4240+Raw content to include in the document's header may be specified
4241+using `header-includes`; however, it is important to mark up
4242+this content as raw code for a particular output format, using
4243+the [`raw_attribute` extension](#extension-raw_attribute)), or it
4244+will be interpreted as markdown. For example:
4249+ \let\oldsection\section
4250+ \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
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:
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
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.
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
2764−Backslash escapes
4271+## Backslash escapes
2767#### Extension: `all_symbols_escapable` ####
4273#### Extension: `all_symbols_escapable` ####
@@ -2788,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
2788(However, if the `markdown_strict` format is used, the standard Markdown rule
4294(However, if the `markdown_strict` format is used, the standard Markdown rule
2789will be used.)
4295will be used.)
2791−A backslash-escaped space is parsed as a nonbreaking space. It will
4297+A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
2792−appear in TeX output as `~` and in HTML and XML as `\ ` or
4298+it will appear as `~`. In HTML and XML output, it will appear as a
2793−`\ `.
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
2795A backslash-escaped newline (i.e. a backslash occurring at the end of
4304A backslash-escaped newline (i.e. a backslash occurring at the end of
2796a line) is parsed as a hard line break. It will appear in TeX output as
4305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -2800,8 +4309,7 @@ two trailing spaces on a line.
2801Backslash escapes do not work in verbatim contexts.
4310Backslash escapes do not work in verbatim contexts.
2803−Inline formatting
4312+## Inline formatting
2806### Emphasis ###
4314### Emphasis ###
@@ -2849,12 +4357,13 @@ text by `~` characters. Thus, for example,
2850 H~2~O is a liquid. 2^10^ is 1024.
4358 H~2~O is a liquid. 2^10^ is 1024.
4360+The text between `^...^` or `~...~` may not contain spaces or
2852−If the superscripted or subscripted text contains spaces, these spaces
4361+newlines. If the superscripted or subscripted text contains
2853−must be escaped with backslashes. (This is to prevent accidental
4362+spaces, these spaces must be escaped with backslashes. (This is
2854−superscripting and subscripting through the ordinary use of `~` and `^`.)
4363+to prevent accidental superscripting and subscripting through
4364+the ordinary use of `~` and `^`, and also bad interactions with
2855−Thus, if you want the letter P with 'a cat' in subscripts, use
4365+footnotes.) Thus, if you want the letter P with 'a cat' in
2856−`P~a\ cat~`, not `P~a cat~`.
4366+subscripts, use `P~a\ cat~`, not `P~a cat~`.
2859### Verbatim ###
4368### Verbatim ###
@@ -2888,19 +4397,22 @@ Attributes can be attached to verbatim text, just as with
2889### Small caps ###
4398### Small caps ###
2891−To write small caps, you can use an HTML span tag:
4400+To write small caps, use the `smallcaps` class:
2893− <span style="font-variant:small-caps;">Small caps</span>
4402+ [Small caps]{.smallcaps}
4404+Or, without the `bracketed_spans` extension:
2895−(The semicolon is optional and there may be space after the
4406+ <span class="smallcaps">Small caps</span>
2896−colon.) This will work in all output formats that support small caps.
2898−Alternatively, you can also use the new `bracketed_spans` syntax:
4408+For compatibility with other Markdown flavors, CSS is also supported:
2900− [Small caps]{style="font-variant:small-caps;"}
4410+ <span style="font-variant:small-caps;">Small caps</span>
4412+This will work in all output formats that support small caps.
2905#### Extension: `tex_math_dollars` ####
4417#### Extension: `tex_math_dollars` ####
@@ -2912,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
2912you need to enclose text in literal `$` characters, backslash-escape
4424you need to enclose text in literal `$` characters, backslash-escape
2913them and they won't be treated as math delimiters.
4425them and they won't be treated as math delimiters.
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.)
2915TeX math will be printed in all output formats. How it is rendered
4431TeX math will be printed in all output formats. How it is rendered
2916depends on the output format:
4432depends on the output format:
4435+ ~ It will appear verbatim surrounded by `\(...\)` (for inline
4436+ math) or `\[...\]` (for display math).
2918−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
4438+Markdown, Emacs Org mode, ConTeXt, ZimWiki
2919− ~ It will appear verbatim between `$` characters.
4439+ ~ It will appear verbatim surrounded by `$...$` (for inline
4440+ math) or `$$...$$` (for display math).
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
2921reStructuredText
4445reStructuredText
2922 ~ It will be rendered using an [interpreted text role `:math:`].
4446 ~ It will be rendered using an [interpreted text role `:math:`].
2925− ~ It will be rendered as `latexmath:[...]`.
4449+ ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4450+ surrounded by `latexmath:[$...$]` (for inline math) or
4451+ `[latexmath]++++\[...\]+++` (for display math).
4452+ For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4453+ (`$..$` and `\[..\]`) are omitted.
2928 ~ It will be rendered inside a `@math` command.
4456 ~ It will be rendered inside a `@math` command.
2930−groff man
4458+roff man, Jira markup
2931 ~ It will be rendered verbatim without `$`'s.
4459 ~ It will be rendered verbatim without `$`'s.
2933MediaWiki, DokuWiki
4461MediaWiki, DokuWiki
@@ -2958,58 +4486,12 @@ FictionBook2
2959HTML, Slidy, DZSlides, S5, EPUB
4487HTML, Slidy, DZSlides, S5, EPUB
2960 ~ The way math is rendered in HTML will depend on the
4488 ~ The way math is rendered in HTML will depend on the
2961− command-line options selected:
4489+ command-line options selected. Therefore see [Math rendering in HTML]
2963− 1. The default is to render TeX math as far as possible using Unicode
4491+
2964− characters, as with RTF, DocBook, and OpenDocument output. Formulas
2965− are put inside a `span` with `class="math"`, so that they may be
2966− styled differently from the surrounding text if needed.
2968− 2. If the `--latexmathml` option is used, TeX math will be displayed
2969− between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2970− The [LaTeXMathML] script will be used to render it as formulas.
2971− (This trick does not work in all browsers, but it works in Firefox.
2972− In browsers that do not support LaTeXMathML, TeX math will appear
2973− verbatim between `$` characters.)
2975− 3. If the `--jsmath` option is used, TeX math will be put inside
2976− `<span>` tags (for inline math) or `<div>` tags (for display math)
2977− with class `math`. The [jsMath] script will be used to render
2980− 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2981− be called to generate images for each TeX formula. This should
2982− work in all browsers. The `--mimetex` option takes an optional URL
2983− as argument. If no URL is specified, it will be assumed that the
2984− mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2986− 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2987− in `<eq>` tags in the HTML output. The resulting `htex` file may then
2988− be processed by [gladTeX], which will produce image files for each
2989− formula and an HTML file with links to these images. So, the
2992− pandoc -s --gladtex myfile.txt -o myfile.htex
2993− gladtex -d myfile-images myfile.htex
2994− # produces myfile.html and images in myfile-images
2996− 6. If the `--webtex` option is used, TeX formulas will be converted
2997− to `<img>` tags that link to an external script that converts
2998− formulas to images. The formula will be URL-encoded and concatenated
2999− with the URL provided. For SVG images you can for example use
3000− `--webtex https://latex.codecogs.com/svg.latex?`.
3001− If no URL is specified, the CodeCogs URL generating PNGs
3002− will be used (`https://latex.codecogs.com/png.latex?`).
3004− 7. If the `--mathjax` option is used, TeX math will be displayed
3005− between `\(...\)` (for inline math) or `\[...\]` (for display
3006− math) and put in `<span>` tags with class `math`.
3007− The [MathJax] script will be used to render it as formulas.
3009−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3011−Raw HTML
4494+## Raw HTML
3014#### Extension: `raw_html` ####
4496#### Extension: `raw_html` ####
@@ -3020,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
3020be disabled if desired.)
4502be disabled if desired.)
3022The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3023−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
4505+DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3024−in other formats.
4506+output, and suppressed in other formats.
4508+For a more explicit way of including raw HTML in a Markdown
4509+document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
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.
3026#### Extension: `markdown_in_html_blocks` ####
4517#### Extension: `markdown_in_html_blocks` ####
@@ -3038,7 +4529,7 @@ Thus, for example, pandoc will turn
3040 <td>*one*</td>
4531 <td>*one*</td>
3041− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
3043 </table>
4534 </table>
@@ -3047,14 +4538,14 @@ into
3049 <td><em>one</em></td>
4540 <td><em>one</em></td>
3050− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
3052 </table>
4543 </table>
3054whereas `Markdown.pl` will preserve it as is.
4545whereas `Markdown.pl` will preserve it as is.
3056−There is one exception to this rule: text between `<script>` and
4547+There is one exception to this rule: text between `<script>`,
3057−`<style>` tags is not interpreted as Markdown.
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3059This departure from standard Markdown should make it easier to mix
4550This departure from standard Markdown should make it easier to mix
3060Markdown with HTML block elements. For example, one can surround
4551Markdown with HTML block elements. For example, one can surround
@@ -3075,39 +4566,6 @@ For the most part this should give the same output as `raw_html`,
3075but it makes it easier to write pandoc filters to manipulate groups
4566but it makes it easier to write pandoc filters to manipulate groups
3076of inlines.
4567of inlines.
3078−#### Extension: `fenced_divs` ####
3080−Allow special fenced syntax for native `Div` blocks. A Div
3081−starts with a fence containing at least three consecutive
3082−colons plus some attributes. The attributes may optionally
3083−be followed by another string of consecutive colons.
3084−The attribute syntax is exactly as in fenced code blocks (see
3085−[Extension-fenced_code_attributes], above). As with fenced
3086−code blocks, one can use either attributes in curly braces
3087−or a single unbraced word, which will be treated as a class
3088−name. The Div ends with another line containing a string of at
3089−least three consecutive colons. The fenced Div should be
3090−separated by blank lines from preceding and following blocks.
3094− ::::: {#special .sidebar}
3095− Here is a paragraph.
3100−Fenced divs can be nested. Opening fences are distinguished
3101−because they *must* have attributes:
3107− This is a warning within a warning.
3111#### Extension: `raw_tex` ####
4569#### Extension: `raw_tex` ####
3113In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4571In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
@@ -3129,6 +4587,10 @@ Note that in LaTeX environments, like
3129the material between the begin and end tags will be interpreted as raw
4587the material between the begin and end tags will be interpreted as raw
3130LaTeX, not as Markdown.
4588LaTeX, not as Markdown.
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`].
3132Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3133Emacs Org mode, and ConTeXt.
4595Emacs Org mode, and ConTeXt.
@@ -3139,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
3139Inline spans and fenced code blocks with a special
4601Inline spans and fenced code blocks with a special
3140kind of attribute will be parsed as raw content with the
4602kind of attribute will be parsed as raw content with the
3141designated format. For example, the following produces a raw
4603designated format. For example, the following produces a raw
3142−groff `ms` block:
4604+roff `ms` block:
3144 ```{=ms}
4606 ```{=ms}
3145 .MYMACRO
4607 .MYMACRO
@@ -3149,9 +4611,24 @@ And the following produces a raw `html` inline element:
3150 This is `<a>html</a>`{=html}
4612 This is `<a>html</a>`{=html}
4614+This can be useful to insert raw xml into `docx` documents, e.g.
4620+ <w:br w:type="page"/>
3152The format name should match the target format name (see
4625The format name should match the target format name (see
3153`-t/--to`, above, for a list, or use `pandoc
4626`-t/--to`, above, for a list, or use `pandoc
3154−--list-output-formats`).
4627+--list-output-formats`). Use `openxml` for `docx` output,
4628+`opendocument` for `odt` output, `html5` for `epub3` output,
4629+`html4` for `epub2` output, and `latex`, `beamer`,
4630+`ms`, or `html5` for `pdf` output (depending on what you
4631+use for `--pdf-engine`).
3156This extension presupposes that the relevant kind of
4633This extension presupposes that the relevant kind of
3157inline code or fenced code block is enabled. Thus, for
4634inline code or fenced code block is enabled. Thus, for
@@ -3160,26 +4637,34 @@ example, to use a raw attribute with a backtick code block,
3161The raw attribute cannot be combined with regular attributes.
4638The raw attribute cannot be combined with regular attributes.
3163−LaTeX macros
4640+## LaTeX macros
3166#### Extension: `latex_macros` ####
4642#### Extension: `latex_macros` ####
3168−For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
4644+When this extension is enabled, pandoc will parse LaTeX
3169−`\renewcommand` definitions and apply the resulting macros to all LaTeX
4645+macro definitions and apply the resulting macros to all LaTeX
3170−math. So, for example, the following will work in all output formats,
4646+math and raw LaTeX. So, for example, the following will work in
3171−not just LaTeX:
4647+all output formats, not just LaTeX:
3173 \newcommand{\tuple}[1]{\langle #1 \rangle}
4649 \newcommand{\tuple}[1]{\langle #1 \rangle}
3175 $\tuple{a, b, c}$
4651 $\tuple{a, b, c}$
3177−In LaTeX output, the `\newcommand` definition will simply be passed
4653+Note that LaTeX macros will not be applied if they occur
3178−unchanged to the output.
4654+inside a raw span or block marked with the
4655+[`raw_attribute` extension](#extension-raw_attribute).
4657+When `latex_macros` is disabled, the raw LaTeX and math will
4658+not have macros applied. This is usually a better approach when
4659+you are targeting LaTeX or PDF.
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
3184Markdown allows links to be specified in several ways.
4669Markdown allows links to be specified in several ways.
@@ -3188,7 +4673,7 @@ Markdown allows links to be specified in several ways.
3188If you enclose a URL or email address in pointy brackets, it
4673If you enclose a URL or email address in pointy brackets, it
3189will become a link:
4674will become a link:
3191− <http://google.com>
4676+ <https://google.com>
3192 <sam@green.eggs.ham>
4677 <sam@green.eggs.ham>
3194### Inline links ###
4679### Inline links ###
@@ -3198,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
3198be followed by a link title, in quotes.)
4683be followed by a link title, in quotes.)
3200 This is an [inline link](/url), and here's [one with
4685 This is an [inline link](/url), and here's [one with
3201− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
3203There can be no space between the bracketed part and the parenthesized part.
4688There can be no space between the bracketed part and the parenthesized part.
3204The link text can contain formatting (such as emphasis), but the title cannot.
4689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3227,7 +4712,7 @@ Here are some examples:
3228 [my label 1]: /foo/bar.html "My title, optional"
4713 [my label 1]: /foo/bar.html "My title, optional"
3229 [my label 2]: /foo
4714 [my label 2]: /foo
3230− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
3231 [my label 4]: /bar#special 'A title in single quotes'
4716 [my label 4]: /bar#special 'A title in single quotes'
3233The URL may optionally be surrounded by angle brackets:
4718The URL may optionally be surrounded by angle brackets:
@@ -3236,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
3237The title may go on the next line:
4722The title may go on the next line:
3239− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
3240 "The free software foundation"
4725 "The free software foundation"
3242Note that link labels are not case sensitive. So, this will work:
4727Note that link labels are not case sensitive. So, this will work:
@@ -3258,235 +4743,614 @@ such as list items or block quotes. Pandoc lifts this arbitrary
3258seeming restriction. So the following is fine in pandoc, though
4743seeming restriction. So the following is fine in pandoc, though
3259not in most other implementations:
4744not in most other implementations:
3261− > My block [quote].
4746+ > My block [quote].
3263− > [quote]: /foo
4748+ > [quote]: /foo
4750+#### Extension: `shortcut_reference_links` ####
4752+In a *shortcut* reference link, the second pair of brackets may
4753+be omitted entirely:
4757+ [my website]: http://foo.bar.baz
4759+### Internal links ###
4761+To link to another section of the same document, use the automatically
4762+generated identifier (see [Heading identifiers]). For example:
4764+ See the [Introduction](#introduction).
4768+ See the [Introduction].
4770+ [Introduction]: #introduction
4772+Internal links are currently supported for HTML formats (including
4773+HTML slide shows and EPUB), LaTeX, and ConTeXt.
4777+A link immediately preceded by a `!` will be treated as an image.
4778+The link text will be used as the image's alt text:
4780+ 
4784+ [movie reel]: movie.gif
4786+#### Extension: `implicit_figures` ####
4788+An image with nonempty alt text, occurring by itself in a
4789+paragraph, will be rendered as a figure with a caption. The
4790+image's alt text will be used as the caption.
4792+ 
4794+How this is rendered depends on the output format. Some output
4795+formats (e.g. RTF) do not yet support figures. In those
4796+formats, you'll just get an image in a paragraph by itself, with
4799+If you just want a regular inline image, just make sure it is not
4800+the only thing in the paragraph. One way to do this is to insert a
4801+nonbreaking space after the image:
4803+ \
4805+Note that in reveal.js slide shows, an image in a paragraph
4806+by itself that has the `stretch` class will fill the screen,
4807+and the caption and figure tags will be omitted.
4809+#### Extension: `link_attributes` ####
4811+Attributes can be set on links and images:
4813+ An inline {#id .class width=30 height=20px}
4814+ and a reference ![image][ref] with attributes.
4816+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4818+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819+and `.class` are used.)
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.
4827+The `width` and `height` attributes on images are treated specially. When
4828+used without a unit, the unit is assumed to be pixels. However, any of
4829+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4830+and `%`. There must not be any spaces between the number and the unit.
4834+{ width=50% }
4837+- Dimensions may be converted to a form that is compatible with
4838+ the output format (for example, dimensions given in pixels will
4839+ be converted to inches when converting HTML to LaTeX). Conversion
4840+ between pixels and physical measurements is affected by the
4841+ `--dpi` option (by default, 96 dpi is assumed, unless the image
4842+ itself contains dpi information).
4843+- The `%` unit is generally relative to some available space.
4844+ For example the above example will render to the following.
4845+ - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846+ - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847+ (If you're using a custom template, you need to configure `graphicx`
4848+ as in the default template.)
4849+ - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4850+- Some output formats have a notion of a class
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4852+ or a unique identifier (LaTeX `\caption`), or both (HTML).
4853+- When no `width` or `height` attributes are specified, the fallback
4854+ is to look at the image resolution and the dpi metadata embedded in
4859+Using the `native_divs` and `native_spans` extensions
4860+(see [above][Extension: `native_divs`]), HTML syntax can
4861+be used as part of markdown to create native `Div` and `Span`
4862+elements in the pandoc AST (as opposed to raw HTML).
4863+However, there is also nicer syntax available:
4865+#### Extension: `fenced_divs` ####
4867+Allow special fenced syntax for native `Div` blocks. A Div
4868+starts with a fence containing at least three consecutive
4869+colons plus some attributes. The attributes may optionally
4870+be followed by another string of consecutive colons.
4871+The attribute syntax is exactly as in fenced code blocks (see
4872+[Extension: `fenced_code_attributes`]). As with fenced
4873+code blocks, one can use either attributes in curly braces
4874+or a single unbraced word, which will be treated as a class
4875+name. The Div ends with another line containing a string of at
4876+least three consecutive colons. The fenced Div should be
4877+separated by blank lines from preceding and following blocks.
4881+ ::::: {#special .sidebar}
4882+ Here is a paragraph.
4887+Fenced divs can be nested. Opening fences are distinguished
4888+because they *must* have attributes:
4894+ This is a warning within a warning.
4898+Fences without attributes are always closing fences. Unlike
4899+with fenced code blocks, the number of colons in the closing
4900+fence need not match the number in the opening fence. However,
4901+it can be helpful for visual clarity to use fences of different
4902+lengths to distinguish nested divs from their parents.
4905+#### Extension: `bracketed_spans` ####
4907+A bracketed sequence of inlines, as one would use to begin
4908+a link, will be treated as a `Span` with attributes if it is
4909+followed immediately by attributes:
4911+ [This is *some text*]{.class key="val"}
4915+#### Extension: `footnotes` ####
4917+Pandoc's Markdown allows footnotes, using the following syntax:
4919+ Here is a footnote reference,[^1] and another.[^longnote]
4921+ [^1]: Here is the footnote.
4923+ [^longnote]: Here's one with multiple blocks.
4925+ Subsequent paragraphs are indented to show that they
4926+ belong to the previous footnote.
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.
4934+ This paragraph won't be part of the note, because it
4937+The identifiers in footnote references may not contain spaces, tabs,
4938+or newlines. These identifiers are used only to correlate the
4939+footnote reference with the note itself; in the output, footnotes
4940+will be numbered sequentially.
4942+The footnotes themselves need not be placed at the end of the
4943+document. They may appear anywhere except inside other block elements
4944+(lists, block quotes, tables, etc.). Each footnote should be
4945+separated from surrounding content (including other footnotes)
4948+#### Extension: `inline_notes` ####
4950+Inline footnotes are also allowed (though, unlike regular notes,
4951+they cannot contain multiple paragraphs). The syntax is as follows:
4953+ Here is an inline note.^[Inlines notes are easier to write, since
4954+ you don't have to pick an identifier and move down to type the
4957+Inline and regular footnotes may be mixed freely.
4961+#### Extension: `citations` ####
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:
4967+ Blah blah [@doe99; @smith2000; @smith2004].
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
4974+In a footnote style, it might render as
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).
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
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]`.
4995+Citation items may optionally include a prefix, a locator, and
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
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.
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.
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:
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]
5026+A minus sign (`-`) before the `@` will suppress mention of
5027+the author in the citation. This can be useful when the
5028+author is already mentioned in the text:
5030+ Smith says blah [-@smith04].
5032+You can also write an author-in-text citation, by omitting the
5035+ @smith04 says blah.
5037+ @smith04 [p. 33] says blah.
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.
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.
5051+[CSL user documentation]: https://citationstyles.org/authors/
5052+[CSL]: https://docs.citationstyles.org/en/stable/specification.html
5053+[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5054+[Chicago Manual of Style]: https://chicagomanualofstyle.org
5055+[Citation Style Language]: https://citationstyles.org
5056+[Zotero Style Repository]: https://www.zotero.org/styles
5057+[finding and editing styles]: https://citationstyles.org/authors/
5058+[CSL locale files]: https://github.com/citation-style-language/locales
5060+## Non-default extensions
5062+The following Markdown syntax extensions are not enabled by default
5063+in pandoc, but may be enabled by adding `+EXTENSION` to the format
5064+name, where `EXTENSION` is the name of the extension. Thus, for
5065+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5067+#### Extension: `rebase_relative_paths` ####
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.
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
5083+ pandoc chap*/*.md -f markdown+rebase_relative_paths
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.
5090+Absolute paths and URLs are not changed. Neither are empty
5091+paths or paths consisting entirely of a fragment, e.g., `#foo`.
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.
5098+#### Extension: `attributes` ####
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`].
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
5111+- Consecutive attribute specifiers may be used,
5112+ either for blocks or for inlines. Their attributes
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
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.
3265−#### Extension: `shortcut_reference_links` ####
5129+#### Extension: `old_dashes` ####
3267−In a *shortcut* reference link, the second pair of brackets may
5131+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3268−be omitted entirely:
5132+`-` before a numeral is an en-dash, and `--` is an em-dash.
5133+This option only has an effect if `smart` is enabled. It is
5134+selected automatically for `textile` input.
3270− See [my website].
5136+#### Extension: `angle_brackets_escapable` ####
3272− [my website]: http://foo.bar.baz
5138+Allow `<` and `>` to be backslash-escaped, as they can be in
5139+GitHub flavored Markdown but not original Markdown. This is
5140+implied by pandoc's default `all_symbols_escapable`.
3274−### Internal links ###
5142+#### Extension: `lists_without_preceding_blankline` ####
3276−To link to another section of the same document, use the automatically
5144+Allow a list to occur right after a paragraph, with no intervening
3277−generated identifier (see [Header identifiers]). For example:
5145+blank space.
3279− See the [Introduction](#introduction).
5147+#### Extension: `four_space_rule` ####
3281−or
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
3283− See the [Introduction].
5153+#### Extension: `spaced_reference_links` ####
3285− [Introduction]: #introduction
5155+Allow whitespace between the two components of a reference link,
3287−Internal links are currently supported for HTML formats (including
5158+ [foo] [bar].
3288−HTML slide shows and EPUB), LaTeX, and ConTeXt.
3290−Images
5160+#### Extension: `hard_line_breaks` ####
3293−A link immediately preceded by a `!` will be treated as an image.
5162+Causes all newlines within a paragraph to be interpreted as hard line
3294−The link text will be used as the image's alt text:
5163+breaks instead of spaces.
3296− 
5165+#### Extension: `ignore_line_breaks` ####
3298− ![movie reel]
5167+Causes newlines within a paragraph to be ignored, rather than being
5168+treated as spaces or as hard line breaks. This option is intended for
5169+use with East Asian languages where spaces are not used between words,
5170+but text is divided into lines for readability.
3300− [movie reel]: movie.gif
5172+#### Extension: `east_asian_line_breaks` ####
3302−#### Extension: `implicit_figures` ####
5174+Causes newlines within a paragraph to be ignored, rather than
5175+being treated as spaces or as hard line breaks, when they occur
5176+between two East Asian wide characters. This is a better choice
5177+than `ignore_line_breaks` for texts that include a mix of East
5178+Asian wide characters and other characters.
3304−An image with nonempty alt text, occurring by itself in a
5180+#### Extension: `emoji` ####
3305−paragraph, will be rendered as a figure with a caption. The
3306−image's alt text will be used as the caption.
3308− 
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
3310−How this is rendered depends on the output format. Some output
5184+#### Extension: `tex_math_single_backslash` ####
3311−formats (e.g. RTF) do not yet support figures. In those
3312−formats, you'll just get an image in a paragraph by itself, with
3315−If you just want a regular inline image, just make sure it is not
5186+Causes anything between `\(` and `\)` to be interpreted as inline
3316−the only thing in the paragraph. One way to do this is to insert a
5187+TeX math, and anything between `\[` and `\]` to be interpreted
3317−nonbreaking space after the image:
5188+as display TeX math. Note: a drawback of this extension is that
5189+it precludes escaping `(` and `[`.
3319− \
5191+#### Extension: `tex_math_double_backslash` ####
3321−Note that in reveal.js slide shows, an image in a paragraph
5193+Causes anything between `\\(` and `\\)` to be interpreted as inline
3322−by itself that has the `stretch` class will fill the screen,
5194+TeX math, and anything between `\\[` and `\\]` to be interpreted
3323−and the caption and figure tags will be omitted.
5195+as display TeX math.
3325−#### Extension: `link_attributes` ####
5197+#### Extension: `markdown_attribute` ####
3327−Attributes can be set on links and images:
5199+By default, pandoc interprets material inside block-level tags as Markdown.
5200+This extension changes the behavior so that Markdown is only parsed
5201+inside block-level tags if the tags have the attribute `markdown=1`.
3329− An inline {#id .class width=30 height=20px}
5203+#### Extension: `mmd_title_block` ####
3330− and a reference ![image][ref] with attributes.
3332− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
3334−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
5208+ Title: My title
3335−and `.class` are used.)
5209+ Author: John Doe
5210+ Date: September 1, 2008
5211+ Comment: This is a sample mmd title block, with
5212+ a field spanning multiple lines.
3337−For HTML and EPUB, all attributes except `width` and `height` (but
5214+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3338−including `srcset` and `sizes`) are passed through as is. The other
5215+`yaml_metadata_block` is enabled, it will take precedence over
3339−writers ignore attributes that are not supported by their output
5216+`mmd_title_block`.
3342−The `width` and `height` attributes on images are treated specially. When
5218+#### Extension: `abbreviations` ####
3343−used without a unit, the unit is assumed to be pixels. However, any of
3344−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3345−and `%`. There must not be any spaces between the number and the unit.
3348−```
5220+Parses PHP Markdown Extra abbreviation keys, like
3349−{ width=50% }
3352−- Dimensions are converted to inches for output in page-based formats like
5222+ *[HTML]: Hypertext Markup Language
3353− LaTeX. Dimensions are converted to pixels for output in HTML-like
3354− formats. Use the `--dpi` option to specify the number of pixels per
3355− inch. The default is 96dpi.
3356−- The `%` unit is generally relative to some available space.
3357− For example the above example will render to
3358− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3359− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3360− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3361−- Some output formats have a notion of a class
3362− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3363− or a unique identifier (LaTeX `\caption`), or both (HTML).
3364−- When no `width` or `height` attributes are specified, the fallback
3365− is to look at the image resolution and the dpi metadata embedded in
3368−Spans
5224+Note that the pandoc document model does not support
3369−-----
5225+abbreviations, so if this extension is enabled, abbreviation keys are
5226+simply skipped (as opposed to being parsed as paragraphs).
3371−#### Extension: `bracketed_spans` ####
5228+#### Extension: `autolink_bare_uris` ####
3373−A bracketed sequence of inlines, as one would use to begin
5230+Makes all absolute URIs into links, even when not surrounded by
3374−a link, will be treated as a span with attributes if it is
5231+pointy braces `<...>`.
3375−followed immediately by attributes:
3377− [This is *some text*]{.class key="val"}
5233+#### Extension: `mmd_link_attributes` ####
3379−Footnotes
5235+Parses multimarkdown style key-value attributes on link
3380−---------
5236+and image references. This extension should not be confused with the
5237+[`link_attributes`](#extension-link_attributes) extension.
3382−#### Extension: `footnotes` ####
5239+ This is a reference ![image][ref] with multimarkdown attributes.
3384−Pandoc's Markdown allows footnotes, using the following syntax:
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
3386− Here is a footnote reference,[^1] and another.[^longnote]
5244+#### Extension: `mmd_header_identifiers` ####
3388− [^1]: Here is the footnote.
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
3390− [^longnote]: Here's one with multiple blocks.
5249+#### Extension: `compact_definition_lists` ####
3392− Subsequent paragraphs are indented to show that they
5251+Activates the definition list syntax of pandoc 1.12.x and earlier.
3393− belong to the previous footnote.
5252+This syntax differs from the one described above under [Definition lists]
5253+in several respects:
3395− { some.code }
5255+ - No blank line is required between consecutive items of the
5257+ - To get a "tight" or "compact" list, omit space between consecutive
5258+ items; the space between a term and its definition does not affect
5260+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261+ be indented four spaces.[^6]
3397− The whole paragraph can be indented, or just the first
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
3398− line. In this way, multi-paragraph footnotes work like
5264+ of a blank line between items, consider the following example:
3399− multi-paragraph list items.
3401− This paragraph won't be part of the note, because it
5266+ bar
3402− isn't indented.
5267+ : definition
3404−The identifiers in footnote references may not contain spaces, tabs,
5271+ Is this a single list item with two definitions of "bar," the first of
3405−or newlines. These identifiers are used only to correlate the
5272+ which is lazily wrapped, or two list items? To remove the ambiguity
3406−footnote reference with the note itself; in the output, footnotes
5273+ we must either disallow lazy wrapping or require a blank line between
3407−will be numbered sequentially.
5274+ list items.
3409−The footnotes themselves need not be placed at the end of the
5276+#### Extension: `gutenberg` ####
3410−document. They may appear anywhere except inside other block elements
3411−(lists, block quotes, tables, etc.). Each footnote should be
3412−separated from surrounding content (including other footnotes)
3415−#### Extension: `inline_notes` ####
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.
3417−Inline footnotes are also allowed (though, unlike regular notes,
5282+ [Project Gutenberg]: https://www.gutenberg.org
3418−they cannot contain multiple paragraphs). The syntax is as follows:
3420− Here is an inline note.^[Inlines notes are easier to write, since
5284+#### Extension: `sourcepos` ####
3421− you don't have to pick an identifier and move down to type the
3424−Inline and regular footnotes may be mixed freely.
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.
3426−Typography
5291+## Markdown variants
3429−#### Extension: `smart` ####
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
3431−Interpret straight quotes as curly quotes, `---` as em-dashes,
5296+- `markdown_phpextra` (PHP Markdown Extra)
3432−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
3433−inserted after certain abbreviations, such as "Mr." This
5298+- `markdown_mmd` (MultiMarkdown)
3434−option currently affects the input formats `markdown`,
5299+- `markdown_strict` (Markdown.pl)
3435−`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
5300+- `commonmark` (CommonMark)
3436−and the output formats `markdown`, `latex`, and `context`.
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
3438−Note: If you are *writing* Markdown, then the `smart` extension
5304+To see which extensions are supported for a given format,
3439−has the reverse effect: what would have been curly quotes comes
5305+and which are enabled by default, you can use the command
3442−In LaTeX, `smart` means to use the standard TeX ligatures
5307+ pandoc --list-extensions=FORMAT
3443−for quotation marks (` `` ` and ` '' ` for double quotes,
3444−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3445−en-dash and `---` for em-dash). If `smart` is disabled,
3446−then in reading LaTeX pandoc will parse these characters
3447−literally. In writing LaTeX, enabling `smart` tells pandoc
3448−to use the ligatures when possible; if `smart` is disabled
3449−pandoc will use unicode quotation mark and dash characters.
3451−Citations
5309+where `FORMAT` is replaced with the name of the format.
3454−#### Extension: `citations` ####
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.
3456−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
5319+When the `--citeproc` option is used, pandoc can automatically generate
3457citations and a bibliography in a number of styles. Basic usage is
5320citations and a bibliography in a number of styles. Basic usage is
3459− pandoc --filter pandoc-citeproc myinput.txt
5322+ pandoc --citeproc myinput.txt
3461−In order to use this feature, you will need to specify a bibliography file
5324+To use this feature, you will need to have
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.
5331+## Specifying bibliographic data
5333+You can specify an external bibliography using the
3462−using the `bibliography` metadata field in a YAML metadata section, or
5334+`bibliography` metadata field in a YAML metadata section or the
3463−`--bibliography` command line argument. You can supply multiple `--bibliography`
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
3464−arguments or set `bibliography` metadata field to YAML array, if you want to
5337+`--bibliography` arguments or set `bibliography` metadata field
3465−use multiple bibliography files. The bibliography may have any of these
5338+to YAML array. A bibliography may have any of these formats:
3468 Format File extension
5340 Format File extension
3469 ------------ --------------
5341 ------------ --------------
3470 BibLaTeX .bib
5342 BibLaTeX .bib
3471 BibTeX .bibtex
5343 BibTeX .bibtex
3473 CSL JSON .json
5344 CSL JSON .json
3474 CSL YAML .yaml
5345 CSL YAML .yaml
3482Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3483−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
3485−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3486−can produce `.json` and `.yaml` files from any of the supported formats.
3488−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
5350+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351+inside fields such as `title`; in CSL YAML databases, pandoc
3489−a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
5352+Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
3491`<i>...</i>`
5355`<i>...</i>`
3492: italics
5356: italics
@@ -3506,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
3506`<span class="nocase">...</span>`
5370`<span class="nocase">...</span>`
3507: prevent a phrase from being capitalized as title case
5371: prevent a phrase from being capitalized as title case
3509−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3510−and CSL YAML formats as far as possible.
3512−As an alternative to specifying a bibliography file using `--bibliography`
5373+As an alternative to specifying a bibliography file using
3513−or the YAML metadata field `bibliography`, you can include
5374+`--bibliography` or the YAML metadata field `bibliography`, you
3514−the citation data directly in the `references` field of the
5375+can include the citation data directly in the `references` field
3515−document's YAML metadata. The field should contain an array of
5376+of the document's YAML metadata. The field should contain an
3516−YAML-encoded references, for example:
5377+array of YAML-encoded references, for example:
3519 references:
5380 references:
@@ -3529,345 +5390,279 @@ YAML-encoded references, for example:
3529 - - 1953
5390 - - 1953
3532− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
5393+ title: 'Molecular structure of nucleic acids: a structure for
3533− nucleic acid'
5394+ deoxyribose nucleic acid'
3534 title-short: Molecular structure of nucleic acids
5395 title-short: Molecular structure of nucleic acids
3535 container-title: Nature
5396 container-title: Nature
3536 volume: 171
5397 volume: 171
3537 issue: 4356
5398 issue: 4356
3538 page: 737-738
5399 page: 737-738
3539 DOI: 10.1038/171737a0
5400 DOI: 10.1038/171737a0
3540− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
3541 language: en-GB
5402 language: en-GB
3544−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
5405+If both an external bibliography and inline (YAML metadata)
3545−of the supported formats.)
5406+references are provided, both will be used. In case of
3546−
5407+conflicting `id`s, the inline references will take precedence.
3547−Citations and references can be formatted using any style supported by the
3548−[Citation Style Language], listed in the [Zotero Style Repository].
3549−These files are specified using the `--csl` option or the `csl` metadata field.
3550−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3551−format. The CSL project provides further information on [finding and editing styles].
3553−To make your citations hyperlinks to the corresponding bibliography
3554−entries, add `link-citations: true` to your YAML metadata.
3556−Citations go inside square brackets and are separated by semicolons.
3557−Each citation must have a key, composed of '@' + the citation
3558−identifier from the database, and may optionally have a prefix,
3559−a locator, and a suffix. The citation key must begin with a letter, digit,
3560−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3561−characters (`:.#$%&-+?<>~/`). Here are some examples:
3563− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3565− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3567− Blah blah [@smith04; @doe99].
3569−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3570−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3571−locale, locator terms can be written in either singular or plural forms,
3572−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3573−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3574−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3575−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3576−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3577−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3578−locator term is used, "page" is assumed.
3580−A minus sign (`-`) before the `@` will suppress mention of
3581−the author in the citation. This can be useful when the
3582−author is already mentioned in the text:
3584− Smith says blah [-@smith04].
3586−You can also write an in-text citation, as follows:
3588− @smith04 says blah.
3590− @smith04 [p. 33] says blah.
3592−If the style calls for a list of works cited, it will be placed
3593−at the end of the document. Normally, you will want to end your
3594−document with an appropriate header:
3600−The bibliography will be inserted after this header. Note that
3601−the `unnumbered` class will be added to this header, so that the
3602−section will not be numbered.
3604−If you want to include items in the bibliography without actually
3605−citing them in the body text, you can define a dummy `nocite` metadata
3606−field and put the citations there:
3608− ---
5409+Note that `pandoc` can be used to produce such a YAML metadata
3609− nocite: |
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
3613− @item3
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
3615−In this example, the document will contain a citation for `item3`
5415+Indeed, `pandoc` can convert between any of these
3616−only, but the bibliography will contain entries for `item1`, `item2`, and
5416+citation formats:
3619−It is possible to create a bibliography with all the citations,
5418+ pandoc chem.bib -s -f biblatex -t csljson
3620−whether or not they appear in the document, by using a wildcard:
5419+ pandoc chem.yaml -s -f markdown -t biblatex
3622− ---
5421+Running pandoc on a bibliography file with the `--citeproc`
3623− nocite: |
5422+option will create a formatted bibliography in the format
3624− @*
5423+of your choice:
3627−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
5425+ pandoc chem.bib -s --citeproc -o chem.html
3628−to render bibliography. In order to do so, specify bibliography files as
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
3629−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3630−invocation. Bear in mind that bibliography files have to be in respective
3631−format (either BibTeX or BibLaTeX).
3633−For more information, see the [pandoc-citeproc man page].
5428+### Capitalization in titles
3635−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5430+If you are using a bibtex or biblatex bibliography, then observe
3636−[Chicago Manual of Style]: http://chicagomanualofstyle.org
5431+the following rules:
3637−[Citation Style Language]: http://citationstyles.org
3638−[Zotero Style Repository]: https://www.zotero.org/styles
3639−[finding and editing styles]: http://citationstyles.org/styles/
3640−[CSL locale files]: https://github.com/citation-style-language/locales
3641−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3643−Non-pandoc extensions
5433+ - English titles should be in title case. Non-English titles should
3644−---------------------
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`.)
3646−The following Markdown syntax extensions are not enabled by default
5439+ - As is standard with bibtex/biblatex, proper names should be
3647−in pandoc, but may be enabled by adding `+EXTENSION` to the format
5440+ protected with curly braces so that they won't be lowercased
3648−name, where `EXTENSION` is the name of the extension. Thus, for
5441+ in styles that call for sentence case. For example:
3649−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3651−#### Extension: `old_dashes` ####
5443+ title = {My Dinner with {Andre}}
3653−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5445+ - In addition, words that should remain lowercase (or camelCase)
3654−`-` before a numeral is an en-dash, and `--` is an em-dash.
5446+ should be protected:
3655−This option only has an effect if `smart` is enabled. It is
3656−selected automatically for `textile` input.
3658−#### Extension: `angle_brackets_escapable` ####
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
3660−Allow `<` and `>` to be backslash-escaped, as they can be in
5450+ Though this is not necessary in bibtex/biblatex, it is necessary
3661−GitHub flavored Markdown but not original Markdown. This is
5451+ with citeproc, which stores titles internally in sentence case,
3662−implied by pandoc's default `all_symbols_escapable`.
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.
3664−#### Extension: `lists_without_preceding_blankline` ####
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
3666−Allow a list to occur right after a paragraph, with no intervening
5458+ - All titles should be in sentence case.
3669−#### Extension: `four_space_rule` ####
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.)
3671−Selects the pandoc <= 2.0 behavior for parsing lists, so that
5464+ - Protect words that should not be converted to title case using
3672−four spaces indent are needed for list item continuation
5465+ this syntax:
3675−#### Extension: `spaced_reference_links` ####
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
3677−Allow whitespace between the two components of a reference link,
5469+### Conference Papers, Published vs. Unpublished
3680− [foo] [bar].
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
3682−#### Extension: `hard_line_breaks` ####
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`).
3684−Causes all newlines within a paragraph to be interpreted as hard line
5478+For a talk, an unpublished conference paper, or a poster
3685−breaks instead of spaces.
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.
3687−#### Extension: `ignore_line_breaks` ####
3689−Causes newlines within a paragraph to be ignored, rather than being
5489+## Specifying a citation style
3690−treated as spaces or as hard line breaks. This option is intended for
3691−use with East Asian languages where spaces are not used between words,
3692−but text is divided into lines for readability.
3694−#### Extension: `east_asian_line_breaks` ####
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
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
3696−Causes newlines within a paragraph to be ignored, rather than
3697−being treated as spaces or as hard line breaks, when they occur
3698−between two East Asian wide characters. This is a better choice
3699−than `ignore_line_breaks` for texts that include a mix of East
3700−Asian wide characters and other characters.
3702−##### Extension: `emoji` ####
5509+ { "default": {
5510+ "container-title": {
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
5512+ "Estates Gazette": "EG",
5513+ "Scots Law Times": "SLT"
3704−Parses textual emojis like `:smile:` as Unicode emoticons.
3706−#### Extension: `tex_math_single_backslash` ####
5519+## Citations in note styles
3708−Causes anything between `\(` and `\)` to be interpreted as inline
5521+Pandoc's citation processing is designed to allow you to
3709−TeX math, and anything between `\[` and `\]` to be interpreted
5522+move between author-date, numerical, and note styles without
3710−as display TeX math. Note: a drawback of this extension is that
5523+modifying the markdown source. When you're using a note
3711−it precludes escaping `(` and `[`.
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
3713−#### Extension: `tex_math_double_backslash` ####
5528+ Blah blah [@foo, p. 33].
3715−Causes anything between `\\(` and `\\)` to be interpreted as inline
5530+The footnote will be created automatically. Pandoc will take
3716−TeX math, and anything between `\\[` and `\\]` to be interpreted
5531+care of removing the space and moving the note before or
3717−as display TeX math.
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
3719−#### Extension: `markdown_attribute` ####
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:
3721−By default, pandoc interprets material inside block-level tags as Markdown.
5542+ [^1]: Some studies [@foo; @bar, p. 33] show that
3722−This extension changes the behavior so that Markdown is only parsed
5543+ frubulicious zoosnaps are quantical. For a survey
3723−inside block-level tags if the tags have the attribute `markdown=1`.
5544+ of the literature, see @baz [chap. 1].
3725−#### Extension: `mmd_title_block` ####
5546+## Raw content in a style
3727−Enables a [MultiMarkdown] style title block at the top of
5548+To include raw content in a prefix, suffix, delimiter, or term,
3728−the document, for example:
5549+surround it with these tags indicating the format:
3730− Title: My title
5551+ {{jats}}<ref>{{/jats}}
3732− Date: September 1, 2008
3733− Comment: This is a sample mmd title block, with
3734− a field spanning multiple lines.
3736−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5553+Without the tags, the string will be interpreted as a string
3737−`yaml_metadata_block` is enabled, it will take precedence over
5554+and escaped in the output, rather than being passed through raw.
3740−#### Extension: `abbreviations` ####
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.
3742−Parses PHP Markdown Extra abbreviation keys, like
3744− *[HTML]: Hypertext Markup Language
3746−Note that the pandoc document model does not support
5563+## Placement of the bibliography
3747−abbreviations, so if this extension is enabled, abbreviation keys are
3748−simply skipped (as opposed to being parsed as paragraphs).
3750−#### Extension: `autolink_bare_uris` ####
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:
3752−Makes all absolute URIs into links, even when not surrounded by
5568+ ::: {#refs}
3753−pointy braces `<...>`.
5569+ :::
3755−#### Extension: `ascii_identifiers` ####
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.
3757−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
5575+If you wish the bibliography to have a section heading, you can
3758−Accents are stripped off of accented Latin letters, and non-Latin
5576+set `reference-section-title` in the metadata, or put the heading
3759−letters are omitted.
5577+at the beginning of the div with id `refs` (if you are using it)
5578+or at the end of your document:
3761−#### Extension: `mmd_link_attributes` ####
5580+ last paragraph...
3763−Parses multimarkdown style key-value attributes on link
5582+ # References
3764−and image references. This extension should not be confused with the
3765−[`link_attributes`](#extension-link_attributes) extension.
3767− This is a reference ![image][ref] with multimarkdown attributes.
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.
3769− [ref]: http://path.to/image "Image title" width=20px height=30px
5588+## Including uncited items in the bibliography
3770− id=myId class="myClass1 myClass2"
3772−#### Extension: `mmd_header_identifiers` ####
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:
3774−Parses multimarkdown style header identifiers (in square brackets,
5594+ ---
3775−after the header but before any trailing `#`s in an ATX header).
5595+ nocite: |
3777−#### Extension: `compact_definition_lists` ####
5599+ @item3
3779−Activates the definition list syntax of pandoc 1.12.x and earlier.
5601+In this example, the document will contain a citation for `item3`
3780−This syntax differs from the one described above under [Definition lists]
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
3781−in several respects:
5603+`item3`.
3783− - No blank line is required between consecutive items of the
5605+It is possible to create a bibliography with all the citations,
3784− definition list.
5606+whether or not they appear in the document, by using a wildcard:
3785− - To get a "tight" or "compact" list, omit space between consecutive
3786− items; the space between a term and its definition does not affect
3788− - Lazy wrapping of paragraphs is not allowed: the entire definition must
3789− be indented four spaces.[^6]
3791−[^6]: To see why laziness is incompatible with relaxing the requirement
5608+ ---
3792− of a blank line between items, consider the following example:
5609+ nocite: |
3794− bar
5613+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
3795− : definition
5614+render the bibliography. In order to do so, specify bibliography
3796− foo
5615+files as outlined above, and add `--natbib` or `--biblatex`
3797− : definition
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.
3799− Is this a single list item with two definitions of "bar," the first of
5620+## Other relevant metadata fields
3800− which is lazily wrapped, or two list items? To remove the ambiguity
3801− we must either disallow lazy wrapping or require a blank line between
3804−Markdown variants
5622+A few other metadata fields affect bibliography formatting:
3807−In addition to pandoc's extended Markdown, the following Markdown
5624+`link-citations`
3808−variants are supported:
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
3810−`markdown_phpextra` (PHP Markdown Extra)
5629+`lang`
3811−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5630+: The `lang` field will affect how the style is localized,
3812− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5631+ for example in the translation of labels, the use
3813− `header_attributes`, `link_attributes`, `abbreviations`,
5632+ of quotation marks, and the way items are sorted.
3814− `shortcut_reference_links`, `spaced_reference_links`.
5633+ (For backwards compatibility, `locale` may be used instead
3815−
5634+ of `lang`, but this use is deprecated.)
3816−`markdown_github` (deprecated GitHub-Flavored Markdown)
5635+
3817−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
5636+ A BCP 47 language tag is expected: for example, `en`,
3818− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
5637+ `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
3819− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
5638+ syntax (after `-u-`) may be used to specify options for
3820− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
5639+ collation (sorting) more precisely. Here are some examples:
3821− `lists_without_preceding_blankline`.
5640+
3822−
5641+ - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
3823−`markdown_mmd` (MultiMarkdown)
5642+ - `es-u-co-trad` -- Spanish with the traditional collation
3824−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5643+ (with `Ch` sorting after `C`).
3825− `tex_math_double_backslash`, `intraword_underscores`,
5644+ - `fr-u-kb` -- French with "backwards" accent sorting
3826− `mmd_title_block`, `footnotes`, `definition_lists`,
5645+ (with `coté` sorting after `côte`).
3827− `all_symbols_escapable`, `implicit_header_references`,
5646+ - `en-US-u-kf-upper` -- English with uppercase letters sorting
3828− `auto_identifiers`, `mmd_header_identifiers`,
5647+ before lower (default is lower before upper).
3829− `shortcut_reference_links`, `implicit_figures`,
5648+
3830− `superscript`, `subscript`, `backtick_code_blocks`,
5649+`notes-after-punctuation`
3831− `spaced_reference_links`, `raw_attribute`.
5650+: If true (the default), pandoc will put footnote citations
3832−
5651+ after following punctuation. For example, if the source
3833−`markdown_strict` (Markdown.pl)
5652+ contains `blah blah [@jones99].`, the result will look like
3834−: `raw_html`, `shortcut_reference_links`,
5653+ `blah blah.[^1]`, with the note moved after the period and
3835− `spaced_reference_links`.
5654+ the space collapsed. If false, the space will still be
3836−
5655+ collapsed, but the footnote will not be moved after the
3837−We also support `gfm` (GitHub-Flavored Markdown) as a set of
5656+ punctuation.
3838−extensions on `commonmark`:
5657+
3840−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5659+# Slide shows
3841− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3842− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3843− `shortcut_reference_links`, `angle_brackets_escapable`.
3845− These can all be individually disabled. Note, however, that
3846− `commonmark` and `gfm` have limited support for extensions:
3847− extensions other than those listed above (and `smart`) will have
3848− no effect on `commonmark` or `gfm`.
3850−Extensions with formats other than Markdown
3851−-------------------------------------------
3853−Some of the extensions discussed above can be used with formats
3854−other than Markdown:
3856−* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3857− and `textile` input (and is used by default).
3859−* `tex_math_dollars`, `tex_math_single_backslash`, and
3860− `tex_math_double_backslash` can be used with `html` input.
3861− (This is handy for reading web pages formatted using MathJax,
3864−Producing slide shows with pandoc
3865−=================================
3867You can use pandoc to produce an HTML + JavaScript slide presentation
5661You can use pandoc to produce an HTML + JavaScript slide presentation
3868that can be viewed via a web browser. There are five ways to do this,
5662that can be viewed via a web browser. There are five ways to do this,
3869using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5663using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3870−You can also produce a PDF slide show using LaTeX [`beamer`].
5664+You can also produce a PDF slide show using LaTeX [`beamer`], or
5665+slides shows in Microsoft [PowerPoint] format.
3872Here's the Markdown source for a simple slide show, `habits.txt`:
5667Here's the Markdown source for a simple slide show, `habits.txt`:
@@ -3909,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
3910where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3912−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
3913−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
3914−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5710+the relative path `s5/default` (for S5), `slideous` (for
3915−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
3916−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
3917−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
5714+variables; see [Variables for HTML slides], above.) For
3918−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5715+DZSlides, the (relatively short) JavaScript and CSS are included
3919−the file by default.
5716+in the file by default.
3921−With all HTML slide formats, the `--self-contained` option can be used to
5718+With all HTML slide formats, the `--self-contained` option can
3922−produce a single file that contains all of the data necessary to display the
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
3923−slide show, including linked scripts, stylesheets, images, and videos.
5721+stylesheets, images, and videos.
3925To produce a PDF slide show using beamer, type
5723To produce a PDF slide show using beamer, type
@@ -3929,14 +5727,17 @@ To produce a PDF slide show using beamer, type
3929Note that a reveal.js slide show can also be converted to a PDF
5727Note that a reveal.js slide show can also be converted to a PDF
3930by printing it to a file from the browser.
5728by printing it to a file from the browser.
3932−Structuring the slide show
5730+To produce a Powerpoint slide show, type
3933−--------------------------
5731+
5732+ pandoc habits.txt -o habits.pptx
5734+## Structuring the slide show
3935−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
3936the hierarchy that is followed immediately by content, and not another
5737the hierarchy that is followed immediately by content, and not another
3937−header, somewhere in the document. In the example above, level 1 headers
5738+heading, somewhere in the document. In the example above, level-1 headings
3938−are always followed by level 2 headers, which are followed by content,
5739+are always followed by level-2 headings, which are followed by content,
3939−so 2 is the slide level. This default can be overridden using
5740+so the slide level is 2. This default can be overridden using
3940the `--slide-level` option.
5741the `--slide-level` option.
3942The document is carved up into slides according to the following
5743The document is carved up into slides according to the following
@@ -3944,17 +5745,21 @@ rules:
3945 * A horizontal rule always starts a new slide.
5746 * A horizontal rule always starts a new slide.
3947− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
3949− * Headers *below* the slide level in the hierarchy create
5750+ * Headings *below* the slide level in the hierarchy create
3950− headers *within* a slide.
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.)
3952− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
3953 "title slides," which just contain the section title
5758 "title slides," which just contain the section title
3954 and help to break the slide show into sections.
5759 and help to break the slide show into sections.
3955−
5760+ Non-slide content under these headings will be included
3956− * Content *above* the slide level will not appear in the slide
5761+ on the title slide (for HTML slide shows) or in a
3957− show.
5762+ subsequent slide with the same title (for beamer).
3959 * A title page is constructed automatically from the document's title
5764 * A title page is constructed automatically from the document's title
3960 block, if present. (In the case of beamer, this can be disabled
5765 block, if present. (In the case of beamer, this can be disabled
@@ -3962,32 +5767,57 @@ rules:
3963These rules are designed to support many different styles of slide show. If
5768These rules are designed to support many different styles of slide show. If
3964you don't care about structuring your slides into sections and subsections,
5769you don't care about structuring your slides into sections and subsections,
3965−you can just use level 1 headers for all each slide. (In that case, level 1
5770+you can just use level-1 headings for all each slide. (In that case, level-1
3966will be the slide level.) But you can also structure the slide show into
5771will be the slide level.) But you can also structure the slide show into
3967sections, as in the example above.
5772sections, as in the example above.
3969Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3970−layout will be produced, with level 1 headers building horizontally
5775+layout will be produced, with level-1 headings building horizontally
3971−and level 2 headers building vertically. It is not recommended that
5776+and level-2 headings building vertically. It is not recommended that
3972you use deeper nesting of section levels with reveal.js.
5777you use deeper nesting of section levels with reveal.js.
3974−Incremental lists
5779+## Incremental lists
3977By default, these writers produce lists that display "all at once."
5781By default, these writers produce lists that display "all at once."
3978If you want your lists to display incrementally (one item at a time),
5782If you want your lists to display incrementally (one item at a time),
3979use the `-i` option. If you want a particular list to depart from the
5783use 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:
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
3980−default (that is, to display incrementally without the `-i` option and
5808+incrementally without the `-i` option and all at once with the `-i`
3981−all at once with the `-i` option), put it in a block quote:
5809+option):
3983 > - Eat spaghetti
5811 > - Eat spaghetti
3984 > - Drink wine
5812 > - Drink wine
3986−In this way incremental and nonincremental lists can be mixed in
5814+Both methods allow incremental and nonincremental lists to be mixed
3987−a single document.
5815+in a single document.
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
3989−Inserting pauses
5820+## Inserting pauses
3992You can add "pauses" within a slide by including a paragraph containing
5822You can add "pauses" within a slide by including a paragraph containing
3993three dots, separated by spaces:
5823three dots, separated by spaces:
@@ -4000,8 +5830,9 @@ three dots, separated by spaces:
4001 content after the pause
5831 content after the pause
5833+Note: this feature is not yet implemented for PowerPoint output.
4003−Styling the slides
5835+## Styling the slides
4006You can change the style of HTML slides by putting customized CSS files
5837You can change the style of HTML slides by putting customized CSS files
4007in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4026,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
4027 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4029−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
4030(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4031−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
4032that affects slides is the `allowframebreaks` class, which sets the
5863that affects slides is the `allowframebreaks` class, which sets the
4033`allowframebreaks` option, causing multiple slides to be created
5864`allowframebreaks` option, causing multiple slides to be created
4034if the content overfills the frame. This is recommended especially for
5865if the content overfills the frame. This is recommended especially for
@@ -4036,30 +5867,82 @@ bibliographies:
4037 # References {.allowframebreaks}
5868 # References {.allowframebreaks}
4039−Speaker notes
5870+## Speaker notes
5872+Speaker notes are supported in reveal.js and PowerPoint (pptx)
5873+output. You can add notes to your Markdown document thus:
4042−reveal.js has good support for speaker notes. You can add notes to your
5875+ ::: notes
4043−Markdown document thus:
4045− <div class="notes">
4046 This is my note.
5877 This is my note.
4048 - It can contain Markdown
5879 - It can contain Markdown
4049 - like this list
5880 - like this list
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.
4053−To show the notes window, press `s` while viewing the presentation.
4054Notes are not yet supported for other slide formats, but the notes
5888Notes are not yet supported for other slide formats, but the notes
4055will not appear on the slides themselves.
5889will not appear on the slides themselves.
5893+To put material in side by side columns, you can use a native
5894+div container with class `columns`, containing two or more div
5895+containers with class `column` and a `width` attribute:
5897+ :::::::::::::: {.columns}
5898+ ::: {.column width="40%"}
5901+ ::: {.column width="60%"}
5906+### Additional columns attributes in beamer
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.
5913+ :::::::::::::: {.columns align=center totalwidth=8em}
5914+ ::: {.column width="40%"}
5917+ ::: {.column width="60%" align=bottom}
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`.
5926+The `totalwidth` attribute limits the width of the columns to the given value.
5928+ :::::::::::::: {.columns align=top .onlytextwidth}
5929+ ::: {.column width="40%" align=center}
5932+ ::: {.column width="60%"}
5937+The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5939+See Section 12.7 of the [Beamer User's Guide] for more details.
4057−Frame attributes in beamer
5941+## Frame attributes in beamer
4058−--------------------------
4060Sometimes it is necessary to add the LaTeX `[fragile]` option to
5943Sometimes it is necessary to add the LaTeX `[fragile]` option to
4061a frame in beamer (for example, when using the `minted` environment).
5944a frame in beamer (for example, when using the `minted` environment).
4062−This can be forced by adding the `fragile` class to the header
5945+This can be forced by adding the `fragile` class to the heading
4063introducing the slide:
5946introducing the slide:
4065 # Fragile slide {.fragile}
5948 # Fragile slide {.fragile}
@@ -4067,13 +5950,64 @@ introducing the slide:
4067All of the other frame attributes described in Section 8.1 of
5950All of the other frame attributes described in Section 8.1 of
4068the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4069`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4070−`shrink`.
5953+`shrink`, `standout`, `noframenumbering`.
5955+## Background in reveal.js and beamer
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
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.)
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.
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).
4072−Creating EPUBs with pandoc
5974+In reveal.js's overview mode, the parallaxBackgroundImage will show up
4073−==========================
5975+only on the first slide.
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`.
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.
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5988+For example in reveal.js:
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
6001+Slide 1 has background_image.png as its background.
6003+## {data-background-image="/path/to/special_image.jpg"}
6005+Slide 2 has a special image for its background, even though the heading has no content.
4075−EPUB Metadata
6010+## EPUB Metadata
4078EPUB metadata may be specified using the `--epub-metadata` option, but
6012EPUB metadata may be specified using the `--epub-metadata` option, but
4079if the source document is Markdown, it is better to use a [YAML metadata
6013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4151,11 +6085,20 @@ The following fields are recognized:
4153 ~ A string value.
6087 ~ A string value.
6089+`belongs-to-collection`
6090+ ~ A string value. identifies the name of a collection to which
6091+ the EPUB Publication belongs.
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.
4155`cover-image`
6098`cover-image`
4156 ~ A string value (path to cover image).
6099 ~ A string value (path to cover image).
4158−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
4159 ~ A string value (path to CSS stylesheet).
6102 ~ A string value (path to CSS stylesheet).
4161`page-progression-direction`
6104`page-progression-direction`
@@ -4172,83 +6115,200 @@ The following fields are recognized:
4172 - `binding`: `true`|`false` (default `true`)
6115 - `binding`: `true`|`false` (default `true`)
4173 - `scroll-axis`: `vertical`|`horizontal`|`default`
6116 - `scroll-axis`: `vertical`|`horizontal`|`default`
4175−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4176[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
6119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
6121+## The `epub:type` attribute
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:
6127+ # My chapter {epub:type=prologue}
6129+Which will result in:
6131+ <body epub:type="frontmatter">
6132+ <section epub:type="prologue">
6133+ <h1>My chapter</h1>
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.
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
6147+keywords frontmatter
6149+contributors frontmatter
6150+other-credits frontmatter
6152+revision-history frontmatter
6153+titlepage frontmatter
6154+halftitlepage frontmatter
6155+seriespage frontmatter
6156+foreword frontmatter
6160+bibliography backmatter
6163+[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
4178−Linked media
6165+## Linked media
4181−By default, pandoc will download linked media (including audio and
6167+By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6168+`<video>` or `<source>` element present in the generated EPUB,
4182−video) and include it in the EPUB container, yielding a completely
6169+and include it in the EPUB container, yielding a completely
4183self-contained EPUB. If you want to link to external media resources
6170self-contained EPUB. If you want to link to external media resources
4184instead, use raw HTML in your source and add `data-external="1"` to the tag
6171instead, use raw HTML in your source and add `data-external="1"` to the tag
4185with the `src` attribute. For example:
6172with the `src` attribute. For example:
4187 <audio controls="1">
6174 <audio controls="1">
4188− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
4189 data-external="1" type="audio/mpeg">
6176 data-external="1" type="audio/mpeg">
4190 </source>
6177 </source>
4191 </audio>
6178 </audio>
4193−Literate Haskell support
6180+# Jupyter notebooks
4194−========================
6181+
4195−
6182+When creating a [Jupyter notebook], pandoc will try to infer the
4196−If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
6183+notebook structure. Code blocks with the class `code` will be
4197−format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
6184+taken as code cells, and intervening content will be taken as
4198−`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
6185+Markdown cells. Attachments will automatically be created for
4199−literate Haskell source. This means that
6186+images in Markdown cells. Metadata will be taken from the
4200−
6187+`jupyter` metadata field. For example:
4201− - In Markdown input, "bird track" sections will be parsed as Haskell
6188+
4202− code rather than block quotations. Text between `\begin{code}`
6189+````
4203− and `\end{code}` will also be treated as Haskell code. For
6190+---
4204− ATX-style headers the character '=' will be used instead of '#'.
6191+title: My notebook
4206− - In Markdown output, code blocks with classes `haskell` and `literate`
6193+ nbformat: 4
4207− will be rendered using bird tracks, and block quotations will be
6194+ nbformat_minor: 5
4208− indented one space, so they will not be treated as Haskell code.
6195+ kernelspec:
4209− In addition, headers will be rendered setext-style (with underlines)
6196+ display_name: Python 2
4210− rather than ATX-style (with '#' characters). (This is because ghc
6197+ language: python
4211− treats '#' characters in column 1 as introducing line numbers.)
6198+ name: python2
4212−
6199+ language_info:
4213− - In restructured text input, "bird track" sections will be parsed
6200+ codemirror_mode:
4214− as Haskell code.
6201+ name: ipython
4216− - In restructured text output, code blocks with class `haskell` will
6203+ file_extension: ".py"
4217− be rendered using bird tracks.
6204+ mimetype: "text/x-python"
6206+ nbconvert_exporter: "python"
6207+ pygments_lexer: "ipython2"
6213+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6214+bibendum felis dictum sodales.
4219− - In LaTeX input, text in `code` environments will be parsed as
6220+## Pyout
4222− - In LaTeX output, code blocks with class `haskell` will be rendered
6222+``` code
4223− inside `code` environments.
6223+from IPython.display import HTML
6226+console.log("hello");
4225− - In HTML output, code blocks with class `haskell` will be rendered
6232+## Image
4226− with class `literatehaskell` and bird tracks.
4228−Examples:
6234+This image  will be
6235+included as a cell attachment.
4230− pandoc -f markdown+lhs -t html
6238+If you want to add cell attributes, group cells differently, or
6239+add output to code cells, then you need to include divs to
6240+indicate the structure. You can use either [fenced
6241+divs][Extension: `fenced_divs`] or [native divs][Extension:
6242+`native_divs`] for this. Here is an example:
4232−reads literate Haskell source formatted with Markdown conventions and writes
6244+````
4233−ordinary HTML (without bird tracks).
6245+:::::: {.cell .markdown}
4235− pandoc -f markdown+lhs -t html+lhs
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
4237−writes HTML with the Haskell code in bird tracks, so it can be copied
6252+:::::: {.cell .code execution_count=1}
4238−and pasted as literate Haskell source.
6253+``` {.python}
4240−Note that GHC expects the bird tracks in the first column, so indentend literate
6257+::: {.output .stream .stdout}
4241−code blocks (e.g. inside an itemized environment) will not be picked up by the
6258+```
4242−Haskell compiler.
6259+hello
6264+:::::: {.cell .code execution_count=2}
6266+from IPython.display import HTML
6269+console.log("hello");
6275+::: {.output .execute_result execution_count=2}
6278+console.log("hello");
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.
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.
4244−Syntax highlighting
6305+# Syntax highlighting
4247Pandoc will automatically highlight syntax in [fenced code blocks] that
6307Pandoc will automatically highlight syntax in [fenced code blocks] that
4248are marked with a language name. The Haskell library [skylighting] is
6308are marked with a language name. The Haskell library [skylighting] is
6309+used for highlighting. Currently highlighting is supported only for
4249−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
6310+HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
4250−To see a list of language names that pandoc will recognize, type
4251−`pandoc --list-highlight-languages`.
6311+that pandoc will recognize, type `pandoc --list-highlight-languages`.
4253The color scheme can be selected using the `--highlight-style` option.
6313The color scheme can be selected using the `--highlight-style` option.
4254The default color scheme is `pygments`, which imitates the default color
6314The default color scheme is `pygments`, which imitates the default color
@@ -4256,15 +6316,36 @@ scheme used by the Python library pygments (though pygments is not actually
4256used to do the highlighting). To see a list of highlight styles,
6316used to do the highlighting). To see a list of highlight styles,
4257type `pandoc --list-highlight-styles`.
6317type `pandoc --list-highlight-styles`.
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:
6324+ pandoc --print-highlight-style pygments > my.theme
6326+Then edit `my.theme` and use it like this:
6328+ pandoc --highlight-style my.theme
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).
4259To disable highlighting, use the `--no-highlight` option.
6337To disable highlighting, use the `--no-highlight` option.
4261[skylighting]: https://github.com/jgm/skylighting
6339[skylighting]: https://github.com/jgm/skylighting
4263−Custom Styles in Docx Output
6341+# Custom Styles
4264−============================
6343+Custom styles can be used in the docx and ICML formats.
4266−By default, pandoc's docx output applies a predefined set of styles for
6347+By default, pandoc's docx and ICML output applies a predefined set of styles
4267−blocks such as paragraphs and block quotes, and uses largely default
6348+for blocks such as paragraphs and block quotes, and uses largely default
4268formatting (italics, bold) for inlines. This will work for most
6349formatting (italics, bold) for inlines. This will work for most
4269purposes, especially alongside a `reference.docx` file. However, if you
6350purposes, especially alongside a `reference.docx` file. However, if you
4270need to apply your own styles to blocks, or match a preexisting set of
6351need to apply your own styles to blocks, or match a preexisting set of
@@ -4272,26 +6353,28 @@ styles, pandoc allows you to define custom styles for blocks and text
4272using `div`s and `span`s, respectively.
6353using `div`s and `span`s, respectively.
4274If you define a `div` or `span` with the attribute `custom-style`,
6355If you define a `div` or `span` with the attribute `custom-style`,
4275−pandoc will apply your specified style to the contained elements. So,
6356+pandoc will apply your specified style to the contained elements (with
4276−for example,
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,
4278− <span custom-style="Emphatically">Get out,</span> he said.
6361+ [Get out]{custom-style="Emphatically"}, he said.
4280−would produce a docx file with "Get out," styled with character
6363+would produce a docx file with "Get out" styled with character
4281−style `Emphatically`. Similarly,
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4283 Dickinson starts the poem simply:
6366 Dickinson starts the poem simply:
4285− <div custom-style="Poetry">
6368+ ::: {custom-style="Poetry"}
4286 | A Bird came down the Walk---
6369 | A Bird came down the Walk---
4287 | He did not know I saw---
6370 | He did not know I saw---
4290would style the two contained lines with the `Poetry` paragraph style.
6373would style the two contained lines with the `Poetry` paragraph style.
4292−If the styles are not yet in your reference.docx, they will be defined
4293−in the output file as inheriting from normal text. If they are already
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.
4294−defined, pandoc will not alter the definition.
6377+If they are already defined, pandoc will not alter the definition.
4296This feature allows for greatest customization in conjunction with
6379This feature allows for greatest customization in conjunction with
4297[pandoc filters]. If you want all paragraphs after block quotes to be
6380[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -4301,34 +6384,137 @@ want all italics to be transformed to the `Emphasis` character style
4301transform all italicized inlines to inlines within an `Emphasis`
6384transform all italicized inlines to inlines within an `Emphasis`
4302custom-style `span`.
6385custom-style `span`.
6387+For docx output, you don't need to enable any extensions for
6388+custom styles to work.
4304−[pandoc filters]: http://pandoc.org/filters.html
6390+[pandoc filters]: https://pandoc.org/filters.html
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.
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
4306−Custom writers
6404+For example, using the `custom-style-reference.docx` file in the test
4307−==============
6405+directory, we have the following different outputs:
4309−Pandoc can be extended with custom writers written in [lua]. (Pandoc
6407+Without the `+styles` extension:
4310−includes a lua interpreter, so lua need not be installed separately.)
6409+ $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6412+ This is text with an *emphasized* text style. And this is text with a
6413+ **strengthened** text style.
6415+ > Here is a styled paragraph that inherits from Block Text.
6417+And with the extension:
6419+ $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6421+ ::: {custom-style="First Paragraph"}
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"}
6431+ ::: {custom-style="My Block Style"}
6432+ > Here is a styled paragraph that inherits from Block Text.
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.
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
4312−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
4313in place of the output format. For example:
6445in place of the output format. For example:
4315 pandoc -t data/sample.lua
6447 pandoc -t data/sample.lua
4317−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
4318possible element in a pandoc document. To get a documented example
6450possible element in a pandoc document. To get a documented example
4319which you can modify according to your needs, do
6451which you can modify according to your needs, do
4321 pandoc --print-default-data-file sample.lua
6453 pandoc --print-default-data-file sample.lua
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]).
4323−[lua]: http://www.lua.org
6462+[Lua]: https://www.lua.org
6464+# Reproducible builds
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).
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).
6479+# A note on security
6481+If you use pandoc to convert user-contributed content in a web
6482+application, here are some things to keep in mind:
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.
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)
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.
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
4325−Authors
6511+# Authors
4328−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
4329under the [GPL], version 2 or greater. This software carries no
6514under the [GPL], version 2 or greater. This software carries no
4330warranty of any kind. (See COPYRIGHT for full copyright and
6515warranty of any kind. (See COPYRIGHT for full copyright and
4331warranty notices.) For a full list of contributors, see the file
6516warranty notices.) For a full list of contributors, see the file
4332AUTHORS.md in the pandoc source code.
6517AUTHORS.md in the pandoc source code.
4334−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6519+[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6520+[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"