@@ -1,49 +1,31 @@
1−% Pandoc User's Guide
2+title: Pandoc User's Guide
2−% John MacFarlane
3+author: John MacFarlane
3−% January 18, 2018
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
14another, and a command-line tool that uses this library.
14another, and a command-line tool that uses this library.
16−Pandoc can read [Markdown], [CommonMark], [PHP Markdown Extra],
16+Pandoc can convert between numerous markup and word processing formats,
17−[GitHub-Flavored Markdown], [MultiMarkdown], and (subsets of) [Textile],
17+including, but not limited to, various flavors of [Markdown], [HTML],
18−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
18+[LaTeX] and [Word docx]. For the full lists of input and output formats,
19−markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],
19+see the `--from` and `--to` [options below][General options].
20−[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],
20+Pandoc can also produce [PDF] output: see [creating a PDF], below.
21−[EPUB], [ODT], and [Word docx].
23−Pandoc can write plain text, [Markdown],
24−[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
25−[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]
26−\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
27−[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
28−[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock
29−markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
30−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
31−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
32−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
33−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,
34−`wkhtmltopdf`, `prince`, or `weasyprint` is installed.
36Pandoc's enhanced version of Markdown includes syntax for [tables],
22Pandoc's enhanced version of Markdown includes syntax for [tables],
37−[definition lists], [metadata blocks], [`Div` blocks][Extension:
23+[definition lists], [metadata blocks], [footnotes], [citations], [math],
38−`fenced_divs`], [footnotes] and [citations], embedded
39−[LaTeX][Extension: `raw_tex`] (including [math]), [Markdown inside HTML
40−block elements][Extension: `markdown_in_html_blocks`], and much more.
41−These enhancements, described further under [Pandoc's Markdown],
24+and much more. See below under [Pandoc's Markdown].
42−can be disabled using the `markdown_strict` format.
44Pandoc has a modular design: it consists of a set of readers, which parse
26Pandoc has a modular design: it consists of a set of readers, which parse
45text in a given format and produce a native representation of the document
27text in a given format and produce a native representation of the document
46−(like an _abstract syntax tree_ or AST), and a set of writers, which convert
28+(an _abstract syntax tree_ or AST), and a set of writers, which convert
47this native representation into a target format. Thus, adding an input
29this native representation into a target format. Thus, adding an input
48or output format requires only adding a reader or writer. Users can also
30or output format requires only adding a reader or writer. Users can also
49run custom [pandoc filters] to modify the intermediate AST.
31run custom [pandoc filters] to modify the intermediate AST.
@@ -58,58 +40,7 @@ model. While conversions from pandoc's Markdown to all formats aspire
58to be perfect, conversions from formats more expressive than pandoc's
40to be perfect, conversions from formats more expressive than pandoc's
59Markdown can be expected to be lossy.
41Markdown can be expected to be lossy.
61−[Markdown]: http://daringfireball.net/projects/markdown/
62−[CommonMark]: http://commonmark.org
63−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
64−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
65−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
66−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
67−[S5]: http://meyerweb.com/eric/tools/s5/
68−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
69−[Slideous]: http://goessner.net/articles/slideous/
70−[HTML]: http://www.w3.org/html/
71−[HTML5]: http://www.w3.org/TR/html5/
72−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
73−[XHTML]: http://www.w3.org/TR/xhtml1/
74−[LaTeX]: http://latex-project.org
75−[`beamer`]: https://ctan.org/pkg/beamer
76−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
77−[ConTeXt]: http://www.contextgarden.net/
78−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
79−[DocBook]: http://docbook.org
80−[JATS]: https://jats.nlm.nih.gov
81−[txt2tags]: http://txt2tags.org
82−[EPUB]: http://idpf.org/epub
83−[OPML]: http://dev.opml.org/spec2.html
84−[OpenDocument]: http://opendocument.xml.org
85−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
86−[Textile]: http://redcloth.org/textile
87−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
88−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
89−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
90−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
91−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
92−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
93−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
94−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
95−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
96−[Haskell]: https://www.haskell.org
97−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
98−[Emacs Org mode]: http://orgmode.org
99−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
100−[DZSlides]: http://paulrouget.com/dzslides/
101−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
102−[PDF]: https://www.adobe.com/pdf/
103−[reveal.js]: http://lab.hakim.se/reveal-js/
104−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
105−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
106−[TEI Simple]: https://github.com/TEIC/TEI-Simple
107−[Muse]: https://amusewiki.org/library/manual
108−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
109−[Vimwiki]: https://vimwiki.github.io
111−Using `pandoc`
43+## Using pandoc
114If no *input-files* are specified, input is read from *stdin*.
45If no *input-files* are specified, input is read from *stdin*.
115Output goes to *stdout* by default. For output to a file,
46Output goes to *stdout* by default. For output to a file,
@@ -130,8 +61,7 @@ If multiple input files are given, `pandoc` will concatenate them all (with
130blank lines between them) before parsing. (Use `--file-scope` to parse files
61blank lines between them) before parsing. (Use `--file-scope` to parse files
131individually.)
62individually.)
133−Specifying formats
64+## Specifying formats
136The format of the input and output can be specified explicitly using
66The format of the input and output can be specified explicitly using
137command-line options. The input format can be specified using the
67command-line options. The input format can be specified using the
@@ -163,8 +93,7 @@ If no input file is specified (so that input comes from *stdin*), or
163if the input files' extensions are unknown, the input format will
93if the input files' extensions are unknown, the input format will
164be assumed to be Markdown.
94be assumed to be Markdown.
166−Character encoding
96+## Character encoding
169Pandoc uses the UTF-8 character encoding for both input and output.
98Pandoc uses the UTF-8 character encoding for both input and output.
170If your local character encoding is not UTF-8, you
99If your local character encoding is not UTF-8, you
@@ -177,10 +106,9 @@ RTF, OPML, DocBook, and Texinfo), information about
177the character encoding is included in the document header, which
106the character encoding is included in the document header, which
178will only be included if you use the `-s/--standalone` option.
107will only be included if you use the `-s/--standalone` option.
180−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
182−Creating a PDF
111+## Creating a PDF
185To produce a PDF, specify an output file with a `.pdf` extension:
113To produce a PDF, specify an output file with a `.pdf` extension:
@@ -188,20 +116,18 @@ To produce a PDF, specify an output file with a `.pdf` extension:
189By default, pandoc will use LaTeX to create the PDF, which requires
117By default, pandoc will use LaTeX to create the PDF, which requires
190that a LaTeX engine be installed (see `--pdf-engine` below).
118that a LaTeX engine be installed (see `--pdf-engine` below).
192−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
119+Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
193−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
194−[`weasyprint`] or [`prince`].
195−To do this, specify an output file with a `.pdf` extension, as before,
120+intermediate format. To do this, specify an output file with a
196−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
121+`.pdf` extension, as before, but add the `--pdf-engine` option
197−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
122+or `-t context`, `-t html`, or `-t ms` to the command line.
198−
123+The tool used to generate the PDF from the intermediate format
199−PDF output can be controlled using [variables for LaTeX] (if
124+may be specified using `--pdf-engine`.
200−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
125+
201−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
126+You can control the PDF style using variables, depending on
202−If `wkhtmltopdf` is used, then the variables `margin-left`,
127+the intermediate format used: see [variables for LaTeX],
203−`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
128+[variables for ConTeXt], [variables for `wkhtmltopdf`],
204−`header-html` and `papersize` will affect the output.
129+[variables for ms]. When HTML is used as an intermediate
130+format, the output can be styled using `--css`.
206To debug the PDF creation, it can be useful to look at the intermediate
132To debug the PDF creation, it can be useful to look at the intermediate
207representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -210,93 +136,137 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
210When using LaTeX, the following packages need to be available
136When using LaTeX, the following packages need to be available
211(they are included with all recent versions of [TeX Live]):
137(they are included with all recent versions of [TeX Live]):
212[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
213−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
214`--listings` option is used), [`fancyvrb`], [`longtable`],
140`--listings` option is used), [`fancyvrb`], [`longtable`],
215−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141+[`booktabs`], [`graphicx`] (if the document
216−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),
142+contains images), [`hyperref`], [`xcolor`],
217[`ulem`], [`geometry`] (with the `geometry` variable set),
143[`ulem`], [`geometry`] (with the `geometry` variable set),
218[`setspace`] (with `linestretch`), and
144[`setspace`] (with `linestretch`), and
219[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
220−the LaTeX engine requires [`fontspec`]. `xelatex` uses
146+the PDF engine requires [`fontspec`]. `lualatex` uses
221−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
222−`dir` variable set). If the `mathspec` variable is set,
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
223−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
224−The [`upquote`] and [`microtype`] packages are used if
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
225−available, and [`csquotes`] will be used for [typography]
151+packages are used if available, and [`csquotes`] will be used
226−if added to the template or included in any header file. The
152+for [typography] if the `csquotes` variable or metadata field is
227−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
228−optionally be used for [citation rendering].
154+and [`biber`] packages can optionally be used for [citation
229−
155+rendering]. The following packages will be used to improve
156+output quality if present, but pandoc does not require them to
157+be present: [`upquote`] (for straight quotes in verbatim
158+environments), [`microtype`] (for better spacing adjustments),
159+[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160+better line breaks in URLs), [`bookmark`] (for better PDF
161+bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162+footnotes in tables).
164+[TeX Live]: https://www.tug.org/texlive/
230[`amsfonts`]: https://ctan.org/pkg/amsfonts
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
231[`amsmath`]: https://ctan.org/pkg/amsmath
166[`amsmath`]: https://ctan.org/pkg/amsmath
232−[`lm`]: https://ctan.org/pkg/lm
167+[`babel`]: https://ctan.org/pkg/babel
233−[`ifxetex`]: https://ctan.org/pkg/ifxetex
168+[`biber`]: https://ctan.org/pkg/biber
234−[`ifluatex`]: https://ctan.org/pkg/ifluatex
169+[`biblatex`]: https://ctan.org/pkg/biblatex
235−[`listings`]: https://ctan.org/pkg/listings
170+[`bibtex`]: https://ctan.org/pkg/bibtex
236−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
171+[`bidi`]: https://ctan.org/pkg/bidi
237−[`longtable`]: https://ctan.org/pkg/longtable
172+[`bookmark`]: https://ctan.org/pkg/bookmark
238[`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
239[`graphicx`]: https://ctan.org/pkg/graphicx
180[`graphicx`]: https://ctan.org/pkg/graphicx
240[`grffile`]: https://ctan.org/pkg/grffile
181[`grffile`]: https://ctan.org/pkg/grffile
241−[`geometry`]: https://ctan.org/pkg/geometry
242−[`setspace`]: https://ctan.org/pkg/setspace
243−[`xecjk`]: https://ctan.org/pkg/xecjk
244[`hyperref`]: https://ctan.org/pkg/hyperref
182[`hyperref`]: https://ctan.org/pkg/hyperref
245−[`ulem`]: https://ctan.org/pkg/ulem
183+[`iftex`]: https://ctan.org/pkg/iftex
246−[`babel`]: https://ctan.org/pkg/babel
184+[`listings`]: https://ctan.org/pkg/listings
247−[`bidi`]: https://ctan.org/pkg/bidi
185+[`lm`]: https://ctan.org/pkg/lm
186+[`longtable`]: https://ctan.org/pkg/longtable
248[`mathspec`]: https://ctan.org/pkg/mathspec
187[`mathspec`]: https://ctan.org/pkg/mathspec
249−[`unicode-math`]: https://ctan.org/pkg/unicode-math
250−[`polyglossia`]: https://ctan.org/pkg/polyglossia
251−[`fontspec`]: https://ctan.org/pkg/fontspec
252−[`upquote`]: https://ctan.org/pkg/upquote
253[`microtype`]: https://ctan.org/pkg/microtype
188[`microtype`]: https://ctan.org/pkg/microtype
254−[`csquotes`]: https://ctan.org/pkg/csquotes
255[`natbib`]: https://ctan.org/pkg/natbib
189[`natbib`]: https://ctan.org/pkg/natbib
256−[`biblatex`]: https://ctan.org/pkg/biblatex
257−[`bibtex`]: https://ctan.org/pkg/bibtex
190+[`parskip`]: https://ctan.org/pkg/parskip
258−[`biber`]: https://ctan.org/pkg/biber
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
259−[TeX Live]: http://www.tug.org/texlive/
260−[`wkhtmltopdf`]: https://wkhtmltopdf.org
261−[`weasyprint`]: http://weasyprint.org
262[`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
267−Instead of an input file, an absolute URI may be given. In this case
208+Instead of an input file, an absolute URI may be given. In this case
268pandoc will fetch the content using HTTP:
209pandoc will fetch the content using HTTP:
270− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
272It is possible to supply a custom User-Agent string or other
213It is possible to supply a custom User-Agent string or other
273header when requesting a document from a URL:
214header when requesting a document from a URL:
275 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
276− http://www.fsf.org
217+ https://www.fsf.org
281−General options
221+## General options {.options}
284`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
286−: 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)
287− `json` (JSON version of native AST), `markdown` (pandoc's
249+ - `json` (JSON version of native AST)
288− extended Markdown), `markdown_strict` (original unextended
250+ - `latex` ([LaTeX])
251+ - `markdown` ([Pandoc's Markdown])
252+ - `markdown_mmd` ([MultiMarkdown])
289− Markdown), `markdown_phpextra` (PHP Markdown Extra),
253+ - `markdown_phpextra` ([PHP Markdown Extra])
290− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
254+ - `markdown_strict` (original unextended [Markdown])
291− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
255+ - `mediawiki` ([MediaWiki markup])
292− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
256+ - `man` ([roff man])
293− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
257+ - `muse` ([Muse])
258+ - `native` (native Haskell)
294− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
261+ - `org` ([Emacs Org mode])
262+ - `rst` ([reStructuredText])
263+ - `t2t` ([txt2tags])
264+ - `textile` ([Textile])
295− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
265+ - `tikiwiki` ([TikiWiki markup])
296− `haddock` (Haddock markup), or `latex` (LaTeX).
266+ - `twiki` ([TWiki markup])
297− (`markdown_github` provides deprecated and less accurate support
267+ - `vimwiki` ([Vimwiki])
298− for Github-Flavored Markdown; please use `gfm` instead, unless you
268+ :::
299− need to use extensions other than `smart`.)
269+
300 Extensions can be individually enabled or disabled by
270 Extensions can be individually enabled or disabled by
301 appending `+EXTENSION` or `-EXTENSION` to the format name.
271 appending `+EXTENSION` or `-EXTENSION` to the format name.
302 See [Extensions] below, for a list of extensions and
272 See [Extensions] below, for a list of extensions and
@@ -305,34 +275,75 @@ General options
306`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
308−: 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)
309− `json` (JSON version of native AST), `plain` (plain text),
310+ - `json` (JSON version of native AST)
312+ - `man` ([roff man])
310− `markdown` (pandoc's extended Markdown), `markdown_strict`
313+ - `markdown` ([Pandoc's Markdown])
314+ - `markdown_mmd` ([MultiMarkdown])
311− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
315+ - `markdown_phpextra` ([PHP Markdown Extra])
312− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
316+ - `markdown_strict` (original unextended [Markdown])
313− Markdown), `commonmark` (CommonMark Markdown), `rst`
314− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
315− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
316− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
317− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
317+ - `mediawiki` ([MediaWiki markup])
318− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
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])
319− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
330+ - `texinfo` ([GNU Texinfo])
320− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
331+ - `textile` ([Textile])
321− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
332+ - `slideous` ([Slideous] HTML and JavaScript slide show)
322− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
323− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
324− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
325− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
333+ - `slidy` ([Slidy] HTML and JavaScript slide show)
326− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
327− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
334+ - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
328− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
335+ - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
329− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
336+ - `s5` ([S5] HTML and JavaScript slide show)
337+ - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
339+ - `zimwiki` ([ZimWiki markup])
330− the path of a custom lua writer (see [Custom writers],
340+ - the path of a custom Lua writer, see [Custom writers] below
331− below). (`markdown_github` provides deprecated and less accurate
341+ :::
332− support for Github-Flavored Markdown; please use `gfm` instead,
342+
333− unless you use extensions that do not work with `gfm`.) Note that
334− `odt`, `docx`, and `epub` output will not be directed to *stdout*
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344+ to *stdout* unless forced with `-o -`.
335− unless forced with `-o -`. Extensions can be individually enabled or
346+ Extensions can be individually enabled or
336 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
337 name. See [Extensions] below, for a list of extensions and their
348 name. See [Extensions] below, for a list of extensions and their
338 names. See `--list-output-formats` and `--list-extensions`, below.
349 names. See `--list-output-formats` and `--list-extensions`, below.
@@ -347,23 +358,32 @@ General options
348: Specify the user data directory to search for pandoc data files.
359: Specify the user data directory to search for pandoc data files.
349 If this option is not specified, the default user data directory
360 If this option is not specified, the default user data directory
350− will be used. This is, in UNIX:
361+ will be used. On \*nix and macOS systems this will be the `pandoc`
351−
362+ subdirectory of the XDG data directory (by default,
352− $HOME/.pandoc
363+ `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
353−
364+ environment variable). If that directory does not exist and
354− in Windows XP:
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
355−
366+ On Windows the default user data directory is
356− C:\Documents And Settings\USERNAME\Application Data\pandoc
358− and in Windows Vista or later:
360− C:\Users\USERNAME\AppData\Roaming\pandoc
367+ `C:\Users\USERNAME\AppData\Roaming\pandoc`.
362 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
363 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`,
364− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371+ `reference.docx`, `epub.css`, `templates`) will override
365− `slidy`, `slideous`, or `s5` directory
366− 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
368`--bash-completion`
388`--bash-completion`
@@ -374,8 +394,7 @@ General options
375`--verbose`
395`--verbose`
377−: Give verbose debugging output. Currently this only has an effect
397+: Give verbose debugging output.
@@ -401,7 +420,7 @@ General options
402`--list-extensions`[`=`*FORMAT*]
421`--list-extensions`[`=`*FORMAT*]
404−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
405 by a `+` or `-` indicating whether it is enabled by default
424 by a `+` or `-` indicating whether it is enabled by default
406 in *FORMAT*. If *FORMAT* is not specified, defaults for
425 in *FORMAT*. If *FORMAT* is not specified, defaults for
407 pandoc's Markdown are given.
426 pandoc's Markdown are given.
@@ -424,12 +443,88 @@ General options
425: 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
427−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.
430`--base-header-level=`*NUMBER*
523`--base-header-level=`*NUMBER*
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
432−: Specify the base level for headers (defaults to 1).
526+ where X = NUMBER - 1.* Specify the base level for headings
434`--strip-empty-paragraphs`
529`--strip-empty-paragraphs`
@@ -459,7 +554,7 @@ Reader options
459 footnotes and links will not work across files. Reading binary
554 footnotes and links will not work across files. Reading binary
460 files (docx, odt, epub) implies `--file-scope`.
555 files (docx, odt, epub) implies `--file-scope`.
462−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
464: Specify an executable to be used as a filter transforming the
559: Specify an executable to be used as a filter transforming the
465 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
@@ -494,50 +589,65 @@ Reader options
495 3. `$PATH` (executable only)
590 3. `$PATH` (executable only)
497− Filters and lua-filters are applied in the order specified
592+ Filters, Lua-filters, and citeproc processing are applied in
498− on the command line.
593+ the order specified on the command line.
500−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
502: Transform the document in a similar fashion as JSON filters (see
597: Transform the document in a similar fashion as JSON filters (see
503− `--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
504− 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
505− applied in order. Each lua filter must contain element-transforming
600+ applied in order. Each Lua filter must contain element-transforming
506 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
507 function should be applied.
602 function should be applied.
509− The `pandoc` lua module provides helper functions for element
604+ The `pandoc` Lua module provides helper functions for element
510− creation. It is always loaded into the script's lua environment.
605+ creation. It is always loaded into the script's Lua environment.
512− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
514− function expand_hello_world(inline)
609+ In order of preference, pandoc will look for Lua filters in
515− if inline.c == '{{helloworld}}' then
516− return pandoc.Emph{ pandoc.Str "Hello, World" }
522− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
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.
525`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
527: 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
528− on the command line overrides a value specified in the document.
622+ on the command line overrides a value specified in the document
623+ using [YAML metadata blocks][Extension: `yaml_metadata_block`].
529 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
530 specified, the value will be treated as Boolean true. Like
625 specified, the value will be treated as Boolean true. Like
531 `--variable`, `--metadata` causes template variables to be set.
626 `--variable`, `--metadata` causes template variables to be set.
532 But unlike `--variable`, `--metadata` affects the metadata of the
627 But unlike `--variable`, `--metadata` affects the metadata of the
533 underlying document (which is accessible from filters and may be
628 underlying document (which is accessible from filters and may be
534− printed in some output formats).
629+ printed in some output formats) and metadata values will be escaped
630+ when inserted into the template.
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.
536`-p`, `--preserve-tabs`
645`-p`, `--preserve-tabs`
538−: 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
539− 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
540− blocks; tabs in regular text will be treated as spaces.
650+ text are always treated as spaces.
542`--tab-stop=`*NUMBER*
652`--tab-stop=`*NUMBER*
@@ -547,30 +657,30 @@ Reader options
548: Specifies what to do with insertions, deletions, and comments
658: Specifies what to do with insertions, deletions, and comments
549 produced by the MS Word "Track Changes" feature. `accept` (the
659 produced by the MS Word "Track Changes" feature. `accept` (the
550− default), inserts all insertions, and ignores all
660+ default) processes all the insertions and deletions.
551− deletions. `reject` inserts all deletions and ignores
552− insertions. Both `accept` and `reject` ignore comments. `all` puts
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
553− in insertions, deletions, and comments, wrapped in spans with
662+ `all` includes all insertions, deletions, and comments, wrapped
554− `insertion`, `deletion`, `comment-start`, and `comment-end`
663+ in spans with `insertion`, `deletion`, `comment-start`, and
555− classes, respectively. The author and time of change is
664+ `comment-end` classes, respectively. The author and time of
556− included. `all` is useful for scripting: only accepting changes
665+ change is included. `all` is useful for scripting: only
557− from a certain reviewer, say, or before a certain date. If a
666+ accepting changes from a certain reviewer, say, or before a
558− paragraph is inserted or deleted, `track-changes=all` produces a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
559− span with the class `paragraph-insertion`/`paragraph-deletion`
669+ `paragraph-insertion`/`paragraph-deletion` before the
560− before the affected paragraph break. This option only affects the
670+ affected paragraph break. This option only affects the docx
561− docx reader.
671+ reader.
563`--extract-media=`*DIR*
673`--extract-media=`*DIR*
565: Extract images and other media contained in or linked from
675: Extract images and other media contained in or linked from
566 the source document to the path *DIR*, creating it if
676 the source document to the path *DIR*, creating it if
567 necessary, and adjust the images references in the document
677 necessary, and adjust the images references in the document
568− so they point to the extracted files. If the source format is
678+ so they point to the extracted files. Media are downloaded,
569− a binary container (docx, epub, or odt), the media is
679+ read from the file system, or extracted from a binary
570− extracted from the container and the original
680+ container (e.g. docx), as needed. The original file paths
571− filenames are used. Otherwise the media is read from the
681+ are used if they are relative paths not containing `..`.
572− file system or downloaded, and new filenames are constructed
682+ Otherwise filenames are constructed from the SHA1 hash of
573− based on SHA1 hashes of the contents.
683+ the contents.
575`--abbreviations=`*FILE*
685`--abbreviations=`*FILE*
@@ -581,29 +691,30 @@ Reader options
581 system default, use
691 system default, use
582 `pandoc --print-default-data-file=abbreviations`. The only
692 `pandoc --print-default-data-file=abbreviations`. The only
583 use pandoc makes of this list is in the Markdown reader.
693 use pandoc makes of this list is in the Markdown reader.
584− Strings ending in a period that are found in this list will
694+ Strings found in this list will be followed by a nonbreaking
585− be followed by a nonbreaking space, so that the period will
586− 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.
588[`pandocfilters`]: https://github.com/jgm/pandocfilters
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
589[PHP]: https://github.com/vinai/pandocfilters-php
699[PHP]: https://github.com/vinai/pandocfilters-php
590[perl]: https://metacpan.org/pod/Pandoc::Filter
700[perl]: https://metacpan.org/pod/Pandoc::Filter
591[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
593−General writer options
704+## General writer options {.options}
594−----------------------
596`-s`, `--standalone`
706`-s`, `--standalone`
598: Produce output with an appropriate header and footer (e.g. a
708: Produce output with an appropriate header and footer (e.g. a
599 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
600 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
601− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
603−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
605−: Use *FILE* as a custom template for the generated document. Implies
716+: Use the specified file as a custom template for the generated document.
606− `--standalone`. See [Templates], below, for a description
717+ Implies `--standalone`. See [Templates], below, for a description
607 of template syntax. If no extension is specified, an extension
718 of template syntax. If no extension is specified, an extension
608 corresponding to the writer will be added, so that `--template=special`
719 corresponding to the writer will be added, so that `--template=special`
609 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
@@ -615,22 +726,29 @@ General writer options
615`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
617: 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
618− document in standalone mode. This is generally only useful when the
729+ document in standalone mode. If no *VAL* is specified, the
619− `--template` option is used to specify a custom template, since
620− pandoc automatically sets the variables used in the default
621− templates. If no *VAL* is specified, the key will be given the
622− value `true`.
730+ key will be given the value `true`.
624`-D` *FORMAT*, `--print-default-template=`*FORMAT*
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
626: Print the system default template for an output *FORMAT*. (See `-t`
734: Print the system default template for an output *FORMAT*. (See `-t`
627 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
628− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
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`.
630`--print-default-data-file=`*FILE*
746`--print-default-data-file=`*FILE*
632: 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
633− are ignored.
749+ are ignored. This option may be used with `-o`/`--output` to
750+ redirect output to a file, but `-o`/`--output` must come before
751+ `--print-default-data-file` on the command line.
635`--eol=crlf`|`lf`|`native`
753`--eol=crlf`|`lf`|`native`
@@ -641,9 +759,12 @@ General writer options
642`--dpi`=*NUMBER*
760`--dpi`=*NUMBER*
644−: Specify the dpi (dots per inch) value for conversion from pixels
762+: Specify the default dpi (dots per inch) value for conversion
645− to inch/centimeters and vice versa. The default is 96dpi.
763+ from pixels to inch/centimeters and vice versa. (Technically,
646− 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.
648`--wrap=auto`|`none`|`preserve`
769`--wrap=auto`|`none`|`preserve`
@@ -656,6 +777,8 @@ General writer options
656 where there are nonsemantic newlines in the source, there
777 where there are nonsemantic newlines in the source, there
657 will be nonsemantic newlines in the output as well).
778 will be nonsemantic newlines in the output as well).
658 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.
660`--columns=`*NUMBER*
783`--columns=`*NUMBER*
@@ -668,14 +791,21 @@ General writer options
668: Include an automatically generated table of contents (or, in
791: Include an automatically generated table of contents (or, in
669 the case of `latex`, `context`, `docx`, `odt`,
792 the case of `latex`, `context`, `docx`, `odt`,
670 `opendocument`, `rst`, or `ms`, an instruction to create
793 `opendocument`, `rst`, or `ms`, an instruction to create
671− 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
672− `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`.
674`--toc-depth=`*NUMBER*
804`--toc-depth=`*NUMBER*
676: Specify the number of section levels to include in the table
806: Specify the number of section levels to include in the table
677− of contents. The default is 3 (which means that level 1, 2, and 3
807+ of contents. The default is 3 (which means that level-1, 2, and 3
678− headers will be listed in the contents).
808+ headings will be listed in the contents).
680`--strip-comments`
810`--strip-comments`
@@ -711,7 +841,10 @@ General writer options
712: Prints a JSON version of a highlighting style, which can
842: Prints a JSON version of a highlighting style, which can
713 be modified, saved with a `.theme` extension, and used
843 be modified, saved with a `.theme` extension, and used
714− with `--highlight-style`.
844+ with `--highlight-style`. This option may be used with
845+ `-o`/`--output` to redirect output to a file, but
846+ `-o`/`--output` must come before `--print-highlight-style`
847+ on the command line.
716`--syntax-definition=`*FILE*
849`--syntax-definition=`*FILE*
@@ -719,9 +852,10 @@ General writer options
719 which will be used for syntax highlighting of appropriately
852 which will be used for syntax highlighting of appropriately
720 marked code blocks. This can be used to add support for
853 marked code blocks. This can be used to add support for
721 new languages or to use altered syntax definitions for
854 new languages or to use altered syntax definitions for
722− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
724−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
726: Include contents of *FILE*, verbatim, at the end of the header.
860: Include contents of *FILE*, verbatim, at the end of the header.
727 This can be used, for example, to include special
861 This can be used, for example, to include special
@@ -729,7 +863,7 @@ General writer options
729 repeatedly to include multiple files in the header. They will be
863 repeatedly to include multiple files in the header. They will be
730 included in the order specified. Implies `--standalone`.
864 included in the order specified. Implies `--standalone`.
732−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
734: Include contents of *FILE*, verbatim, at the beginning of the
868: Include contents of *FILE*, verbatim, at the beginning of the
735 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
@@ -738,7 +872,7 @@ General writer options
738 used repeatedly to include multiple files. They will be included in
872 used repeatedly to include multiple files. They will be included in
739 the order specified. Implies `--standalone`.
873 the order specified. Implies `--standalone`.
741−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
743: Include contents of *FILE*, verbatim, at the end of the document
877: Include contents of *FILE*, verbatim, at the end of the document
744 body (before the `</body>` tag in HTML, or the
878 body (before the `</body>` tag in HTML, or the
@@ -757,16 +891,27 @@ General writer options
757 will not be searched. For example:
891 will not be searched. For example:
758 `--resource-path=.:test` will search the working directory
892 `--resource-path=.:test` will search the working directory
759 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`.
761`--request-header=`*NAME*`:`*VAL*
900`--request-header=`*NAME*`:`*VAL*
763: Set the request header *NAME* to the value *VAL* when making
902: Set the request header *NAME* to the value *VAL* when making
764 HTTP requests (for example, when a URL is given on the
903 HTTP requests (for example, when a URL is given on the
765 command line, or when resources used in a document must be
904 command line, or when resources used in a document must be
766− downloaded).
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
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).
768−Options affecting specific writers
914+## Options affecting specific writers {.options}
769−----------------------------------
771`--self-contained`
916`--self-contained`
@@ -791,13 +936,18 @@ Options affecting specific writers
792`--html-q-tags`
937`--html-q-tags`
794−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
798−: Use only ASCII characters in output. Currently supported only for
945+: Use only ASCII characters in output. Currently supported for XML
799− HTML and DocBook output (which uses numerical entities instead of
946+ and HTML formats (which use entities instead of UTF-8 when this
800− 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.
802`--reference-links`
952`--reference-links`
@@ -806,36 +956,45 @@ Options affecting specific writers
806 placement of link references is affected by the
956 placement of link references is affected by the
807 `--reference-location` option.
957 `--reference-location` option.
809−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
811: Specify whether footnotes (and references, if `reference-links` is
961: Specify whether footnotes (and references, if `reference-links` is
812 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
813 current section, or the document. The default is
963 current section, or the document. The default is
814 `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.
816`--atx-headers`
974`--atx-headers`
818−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
976+: *Deprecated synonym for `--markdown-headings=atx`.*
819− to use setext-style headers for levels 1-2, and then ATX headers.
820− (Note: for `gfm` output, ATX headers are always used.)
822−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
824−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
980+: Treat top-level headings as the given division type in
825− 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
826− all headers are shifted such that the top-level header becomes the specified
983+ shifted such that the top-level heading becomes the
827− type. The default behavior is to determine the best division type via
984+ specified type. The default behavior is to determine the
828− 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`
829− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
987+ variable is set to `report`, `book`, or `memoir` (unless the
830− `article` option is specified), `chapter` is implied as the setting for this
988+ `article` option is specified), `chapter` is implied as the
831− option. If `beamer` is the output format, specifying either `chapter` or
989+ setting for this option. If `beamer` is the output format,
832− `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
833− second-level headers remain as their default type.
992+ remain as their default type.
835`-N`, `--number-sections`
994`-N`, `--number-sections`
837−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
838− By default, sections are not numbered. Sections with class
997+ output. By default, sections are not numbered. Sections with class
839 `unnumbered` will never be numbered, even if `--number-sections`
998 `unnumbered` will never be numbered, even if `--number-sections`
840 is specified.
999 is specified.
@@ -843,16 +1002,19 @@ Options affecting specific writers
844: Offset for section headings in HTML output (ignored in other
1003: Offset for section headings in HTML output (ignored in other
845 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
846− 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.
847− 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
848 document to be numbered "6", specify `--number-offset=5`.
1007 document to be numbered "6", specify `--number-offset=5`.
849− If your document starts with a level-2 header which you want to
1008+ If your document starts with a level-2 heading which you want to
850 be numbered "1.5", specify `--number-offset=1,4`.
1009 be numbered "1.5", specify `--number-offset=1,4`.
851 Offsets are 0 by default. Implies `--number-sections`.
1010 Offsets are 0 by default. Implies `--number-sections`.
853`--listings`
1012`--listings`
855−: Use the [`listings`] package for LaTeX code blocks
1014+: Use the [`listings`] package for LaTeX code blocks. The package
1015+ does not support multi-byte encoding for source code. To handle UTF-8
1016+ you would need to use a custom template. This issue is fully
1017+ documented here: [Encoding issue with the listings package].
857`-i`, `--incremental`
1019`-i`, `--incremental`
@@ -861,12 +1023,12 @@ Options affecting specific writers
862`--slide-level=`*NUMBER*
1024`--slide-level=`*NUMBER*
864−: Specifies that headers with the specified level create
1026+: Specifies that headings with the specified level create
865− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
866 above this level in the hierarchy are used to divide the
1028 above this level in the hierarchy are used to divide the
867− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
868 subheads within a slide. Note that content that is
1030 subheads within a slide. Note that content that is
869− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
870 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
871 on the contents of the document; see [Structuring the slide
1033 on the contents of the document; see [Structuring the slide
@@ -875,8 +1037,8 @@ Options affecting specific writers
876: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
877 and attach identifiers to the enclosing `<section>` (or `<div>`)
1039 and attach identifiers to the enclosing `<section>` (or `<div>`)
878− rather than the header itself. See
1040+ rather than the heading itself. See
879− [Header identifiers], below.
1041+ [Heading identifiers], below.
881`--email-obfuscation=none`|`javascript`|`references`
1043`--email-obfuscation=none`|`javascript`|`references`
@@ -897,8 +1059,7 @@ Options affecting specific writers
898: Specify *STRING* as a prefix at the beginning of the title
1060: Specify *STRING* as a prefix at the beginning of the title
899 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
900− appears at the beginning of the HTML body). Implies
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
903`-c` *URL*, `--css=`*URL*
1064`-c` *URL*, `--css=`*URL*
@@ -906,8 +1067,8 @@ Options affecting specific writers
906 include multiple files. They will be included in the order specified.
1067 include multiple files. They will be included in the order specified.
908 A stylesheet is required for generating EPUB. If none is
1069 A stylesheet is required for generating EPUB. If none is
909− provided using this option (or the `stylesheet` metadata
1070+ provided using this option (or the `css` or `stylesheet`
910− field), pandoc will look for a file `epub.css` in the
1071+ metadata fields), pandoc will look for a file `epub.css` in the
911 user data directory (see `--data-dir`). If it is not
1072 user data directory (see `--data-dir`). If it is not
912 found there, sensible defaults will be used.
1073 found there, sensible defaults will be used.
@@ -930,20 +1091,56 @@ Options affecting specific writers
931 To produce a custom `reference.docx`, first get a copy of
1092 To produce a custom `reference.docx`, first get a copy of
932 the default `reference.docx`: `pandoc
1093 the default `reference.docx`: `pandoc
933− --print-default-data-file reference.docx >
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
934− custom-reference.docx`. Then open `custom-reference.docx`
1095+ Then open `custom-reference.docx` in Word, modify the
935− in Word, modify the styles as you wish, and save the file.
1096+ styles as you wish, and save the file. For best
936− For best results, do not make changes to this file other
1097+ results, do not make changes to this file other than
937− than modifying the styles used by pandoc: [paragraph]
1098+ modifying the styles used by pandoc:
938− Normal, Body Text, First Paragraph, Compact, Title,
1104+ - First Paragraph
939− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1111+ - Bibliography
940− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
1112+ - Heading 1
941− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1122+ - Footnote Text
942− Definition Term, Definition, Caption, Table Caption,
1123+ - Definition Term
943− Image Caption, Figure, Captioned Figure, TOC Heading;
1129+ - Captioned Figure
944− [character] Default Paragraph Font, Body Text Char,
1134+ - Default Paragraph Font
945− Verbatim Char, Footnote Reference, Hyperlink; [table]
1137+ - Footnote Reference
946− Table.
1141+ Table style:
@@ -957,19 +1154,18 @@ Options affecting specific writers
958 To produce a custom `reference.odt`, first get a copy of
1155 To produce a custom `reference.odt`, first get a copy of
959 the default `reference.odt`: `pandoc
1156 the default `reference.odt`: `pandoc
960− --print-default-data-file reference.odt >
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
961− custom-reference.odt`. Then open `custom-reference.odt` in
1158+ Then open `custom-reference.odt` in LibreOffice, modify
962− LibreOffice, modify the styles as you wish, and save the
1159+ the styles as you wish, and save the file.
965 PowerPoint
1161 PowerPoint
967− : Any template included with a recent install of Microsoft
1163+ : Templates included with Microsoft PowerPoint 2013 (either with
968− PowerPoint (either with `.pptx` or `.potx` extension) should
1164+ `.pptx` or `.potx` extension) are known to work, as are most
969− work, as will most templates derived from these.
1165+ templates derived from these.
971− The specific requirement is that the template should contain
1167+ The specific requirement is that the template should begin with
972− the following four layouts as its first four layouts:
1168+ the following first four layouts:
974 1. Title Slide
1170 1. Title Slide
975 2. Title and Content
1171 2. Title and Content
@@ -981,10 +1177,10 @@ Options affecting specific writers
981 `Home` menu to check.)
1177 `Home` menu to check.)
983 You can also modify the default `reference.pptx`: first run
1179 You can also modify the default `reference.pptx`: first run
984− `pandoc --print-default-data-file reference.pptx >
1180+ `pandoc -o custom-reference.pptx --print-default-data-file
985− custom-reference.pptx`, and then modify
1181+ reference.pptx`, and then modify `custom-reference.pptx`
986− `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1182+ in MS PowerPoint (pandoc will use the first four layout
987− first four layout slides, as mentioned above).
1183+ slides, as mentioned above).
989`--epub-cover-image=`*FILE*
1185`--epub-cover-image=`*FILE*
@@ -1052,12 +1248,12 @@ Options affecting specific writers
1053`--epub-chapter-level=`*NUMBER*
1249`--epub-chapter-level=`*NUMBER*
1055−: 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
1056− "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
1057− headers. This option only affects the internal composition of the
1253+ headings. This option only affects the internal composition of the
1058 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
1059 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
1060− documents with few level 1 headers, one might want to use a chapter
1256+ documents with few level-1 headings, one might want to use a chapter
1061 level of 2 or 3.
1257 level of 2 or 3.
1063`--epub-subdirectory=`*DIRNAME*
1259`--epub-subdirectory=`*DIRNAME*
@@ -1066,69 +1262,118 @@ Options affecting specific writers
1066 the EPUB-specific contents. The default is `EPUB`. To put
1262 the EPUB-specific contents. The default is `EPUB`. To put
1067 the EPUB contents in the top level, use an empty string.
1263 the EPUB contents in the top level, use an empty string.
1069−`--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*
1071: 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`,
1072− 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
1073− 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`
1075`--pdf-engine-opt=`*STRING*
1292`--pdf-engine-opt=`*STRING*
1077: 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`.
1078− 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`.
1079− them. Note that no check for duplicate options is done.
1297+ Note that no check for duplicate options is done.
1081−[Dublin Core elements]: http://dublincore.org/documents/dces/
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1082−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1083−
1301+[Encoding issue with the listings package]:
1302+ https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1084−Citation rendering
1304+## Citation rendering {.options}
1085−------------------
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].
1087`--bibliography=`*FILE*
1325`--bibliography=`*FILE*
1089: Set the `bibliography` field in the document's metadata to *FILE*,
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1090− overriding any value set in the metadata, and process citations
1328+ overriding any value set in the metadata. If you supply
1091− using `pandoc-citeproc`. (This is equivalent to
1092− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1093− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1094− used, making this equivalent to `--metadata bibliography=FILE`.
1095− If you supply this argument multiple times, each *FILE* will be added
1329+ this argument multiple times, each *FILE* will be added to
1096− 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`).
1098`--csl=`*FILE*
1335`--csl=`*FILE*
1100: Set the `csl` field in the document's metadata to *FILE*,
1337: Set the `csl` field in the document's metadata to *FILE*,
1101 overriding any value set in the metadata. (This is equivalent to
1338 overriding any value set in the metadata. (This is equivalent to
1102− `--metadata csl=FILE`.)
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1103− 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.
1105`--citation-abbreviations=`*FILE*
1345`--citation-abbreviations=`*FILE*
1107: Set the `citation-abbreviations` field in the document's metadata to
1347: Set the `citation-abbreviations` field in the document's metadata to
1108 *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
1109 `--metadata citation-abbreviations=FILE`.)
1349 `--metadata citation-abbreviations=FILE`.)
1110− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
1112`--natbib`
1355`--natbib`
1114−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1357+: Use [`natbib`] for citations in LaTeX output. This option
1115− 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
1116− use in producing a LaTeX file that can be processed with [`bibtex`].
1360+ that can be processed with [`bibtex`].
1118`--biblatex`
1362`--biblatex`
1120−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1121− 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
1122− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1367+ that can be processed with [`bibtex`] or [`biber`].
1124−Math rendering in HTML
1369+## Math rendering in HTML {.options}
1125−----------------------
1127−The default is to render TeX math as far as possible using Unicode characters.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1128−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1373+`class="math"`, so that they may be styled differently from the
1129−differently from the surrounding text if needed. However, this gives acceptable
1374+surrounding text if needed. However, this gives acceptable
1130−results only for basic math, usually you will want to use `--mathjax` or another
1375+results only for basic math, usually you will want to use
1131−of the following options.
1376+`--mathjax` or another of the following options.
1133`--mathjax`[`=`*URL*]
1378`--mathjax`[`=`*URL*]
@@ -1142,10 +1387,11 @@ of the following options.
1143`--mathml`
1388`--mathml`
1145−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1146− `html4` and `html5`). This is the default in `odt` output. Note that
1392+ default in `odt` output. Note that currently only Firefox
1147− currently only Firefox and Safari (and select e-book readers) natively
1393+ and Safari (and select e-book readers) natively support
1148− support MathML.
1394+ MathML.
1150`--webtex`[`=`*URL*]
1396`--webtex`[`=`*URL*]
@@ -1162,67 +1408,26 @@ of the following options.
1162`--katex`[`=`*URL*]
1408`--katex`[`=`*URL*]
1164: Use [KaTeX] to display embedded TeX math in HTML output.
1410: Use [KaTeX] to display embedded TeX math in HTML output.
1165− The *URL* is the base URL for the KaTeX library. If a *URL* is
1411+ The *URL* is the base URL for the KaTeX library. That directory
1166− not provided, a link to the KaTeX CDN will be inserted.
1412+ should contain a `katex.min.js` and a `katex.min.css` file.
1168−`--katex-stylesheet=`*URL*
1170−: The *URL* should point to the `katex.css` stylesheet. If this option is
1171− not specified, a link to the KaTeX CDN will be inserted. Note that this
1172− option does not imply `--katex`.
1174−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1177− Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1178− TeX math will be displayed between `$` or `$$` characters and put in
1179− `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1180− change it to MathML. Note that currently only Firefox and Safari
1181− (and select e-book readers) natively support MathML.
1182− To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1184−`--jsmath`[`=`*URL*]
1187− Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1188− math in HTML output. TeX math will be put inside `<span>` tags
1189− (for inline math) or `<div>` tags (for display math) with class
1190− `math` and rendered by the jsMath script. The *URL* should point to
1191− the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1192− to in the header of standalone HTML documents. If a *URL* is not provided,
1193− no link to the jsMath load script will be inserted; it is then
1413+ If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1194− up to the author to provide such a link in the HTML template.
1196`--gladtex`
1415`--gladtex`
1199− Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1417+: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1200− can then be processed by [gladTeX] to produce images of the typeset
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1201− formulas and an HTML file with links to these images.
1419+ formulas and an HTML file with these images embedded.
1202− So, the procedure is:
1204 pandoc -s --gladtex input.md -o myfile.htex
1421 pandoc -s --gladtex input.md -o myfile.htex
1205− gladtex -d myfile-images myfile.htex
1422+ gladtex -d image_dir myfile.htex
1206− # produces myfile.html and images in myfile-images
1423+ # produces myfile.html and images in image_dir
1208−`--mimetex`[`=`*URL*]
1211− Render TeX math using the [mimeTeX] CGI script, which generates an
1212− image for each TeX formula. This should work in all browsers. If
1213− *URL* is not specified, it is assumed that the script is at
1214− `/cgi-bin/mimetex.cgi`.
1216−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
1217−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1218−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1219[MathJax]: https://www.mathjax.org
1426[MathJax]: https://www.mathjax.org
1220−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1221−[mimeTeX]: http://www.forkosh.com/mimetex.html
1222[KaTeX]: https://github.com/Khan/KaTeX
1427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
1224−Options for wrapper scripts
1430+## Options for wrapper scripts {.options}
1225−---------------------------
1227`--dump-args`
1432`--dump-args`
@@ -1246,8 +1451,277 @@ Options for wrapper scripts
1247 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.
1249−Templates
1724+# Templates
1252When the `-s/--standalone` option is used, pandoc uses a template to
1726When the `-s/--standalone` option is used, pandoc uses a template to
1253add header and footer material that is needed for a self-standing
1727add header and footer material that is needed for a self-standing
@@ -1266,284 +1740,827 @@ directory (see `--data-dir`, above). *Exceptions:*
1266- For `pdf` output, customize the `default.latex` template
1740- For `pdf` output, customize the `default.latex` template
1267 (or the `default.context` template, if you use `-t context`,
1741 (or the `default.context` template, if you use `-t context`,
1268 or the `default.ms` template, if you use `-t ms`, or the
1742 or the `default.ms` template, if you use `-t ms`, or the
1269− `default.html5` template, if you use `-t html5`).
1743+ `default.html` template, if you use `-t html`).
1270−- `docx` has no template (however, you can use
1744+- `docx` and `pptx` have no template (however, you can use
1271 `--reference-doc` to customize the output).
1745 `--reference-doc` to customize the output).
1273Templates contain *variables*, which allow for the inclusion of
1747Templates contain *variables*, which allow for the inclusion of
1274−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
1275−within the document using [YAML metadata blocks][Extension:
1751+using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1276−`yaml_metadata_block`]. They may also be set at the
1752+or with the `-M/--metadata` option. In addition, some variables
1277−command line using the `-V/--variable` option: variables set in this
1753+are given default values by pandoc. See [Variables] below for
1278−way override metadata fields with the same name.
1754+a list of variables used in pandoc's default templates.
1280−Variables set by pandoc
1756+If you use custom templates, you may need to revise them as pandoc
1281−-----------------------
1757+changes. We recommend tracking the changes in the default templates,
1758+and modifying your custom templates accordingly. An easy way to do this
1759+is to fork the [pandoc-templates] repository and merge in
1760+changes after each pandoc release.
1283−Some variables are set automatically by pandoc. These vary somewhat
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
1284−depending on the output format, but include metadata fields as well
1287−`sourcefile`, `outputfile`
1764+## Template syntax
1288−: source and destination filenames, as given on the command line.
1289− `sourcefile` can also be a list if input comes from multiple files, or empty
1290− if input is from stdin. You can use the following snippet in your template
1291− to distinguish them:
1293− $if(sourcefile)$
1766+### Comments
1301− Similarly, `outputfile` can be `-` if output goes to the terminal.
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
1303−`title`, `author`, `date`
1771+### Delimiters
1304−: allow identification of basic aspects of the document. Included
1305− in PDF metadata through LaTeX and ConTeXt. These can be set
1306− through a [pandoc title block][Extension: `pandoc_title_block`],
1307− which allows for multiple authors, or through a YAML metadata block:
1309− ---
1773+To mark variables and control structures in the template,
1310− author:
1774+either `$`...`$` or `${`...`}` may be used as delimiters.
1311− - Aristotle
1775+The styles may also be mixed in the same template, but the
1312− - Peter Abelard
1776+opening and closing delimiter must match in each case. The
1313− ...
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
1315−`subtitle`
1782+To include a literal `$` in the document, use `$$`.
1316−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1317− renders in LaTeX only when using a document class that supports
1318− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1319− `scrreprt`, `scrbook`).[^subtitle]
1321−`institute`
1784+### Interpolated variables
1322−: author affiliations (in LaTeX and Beamer only). Can be a
1323− list, when there are multiple authors.
1325−`abstract`
1786+A slot for an interpolated variable is a variable name surrounded
1326−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1787+by matched delimiters. Variable names must begin with a letter
1788+and can contain letters, numbers, `_`, `-`, and `.`. The
1789+keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1790+not be used as variable names. Examples:
1329−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1793+$foo$
1330− may be repeated as for `author`, above
1794+$foo.bar.baz$
1332−`header-includes`
1803+Variable names with periods are used to get at structured
1333−: contents specified by `-H/--include-in-header` (may have multiple
1804+variable values. So, for example, `employee.salary` will return the
1334− values)
1805+value of the `salary` field of the object that is the value of
1806+the `employee` field.
1336−`toc`
1808+- If the value of the variable is simple value, it will be
1337−: non-null value if `--toc/--table-of-contents` was specified
1809+ rendered verbatim. (Note that no escaping is done;
1810+ the assumption is that the calling program will escape
1811+ the strings appropriately for the output format.)
1812+- If the value is a list, the values will be concatenated.
1813+- If the value is a map, the string `true` will be rendered.
1814+- Every other value will be rendered as the empty string.
1339−`toc-title`
1816+### Conditionals
1340−: title of table of contents (works only with EPUB,
1341− opendocument, odt, docx, pptx)
1343−`include-before`
1818+A conditional begins with `if(variable)` (enclosed in
1344−: contents specified by `-B/--include-before-body` (may have
1819+matched delimiters) and ends with `endif` (enclosed in matched
1345− 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:
1347−`include-after`
1825+```
1348−: contents specified by `-A/--include-after-body` (may have
1826+$if(foo)$bar$endif$
1351−`body`
1828+$if(foo)$
1352−: body of document
1829+ $foo$
1354−`meta-json`
1832+$if(foo)$
1355−: JSON representation of all of the document's metadata. Field
1833+part one
1356− values are transformed to the selected output format.
1834+$else$
1358−[^subtitle]: To make `subtitle` work with other LaTeX
1838+${if(foo)}bar${endif}
1359− document classes, you can add the following to `header-includes`:
1361− \providecommand{\subtitle}[1]{%
1840+${if(foo)}
1362− \usepackage{titling}
1841+ ${foo}
1363− \posttitle{%
1842+${endif}
1364− \par\large#1\end{center}}
1367−Language variables
1844+${if(foo)}
1368−------------------
1845+${ foo.bar }
1370−`lang`
1851+The keyword `elseif` may be used to simplify complex nested
1371−: identifies the main language of the document,
1852+conditionals:
1372− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1373− For some output formats, pandoc will convert it to an appropriate
1374− format stored in the additional variables `babel-lang`,
1375− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1377− Native pandoc Spans and Divs with the lang attribute
1378− (value in BCP 47) can be used to switch the language in
1379− that range. In LaTeX output, `babel-otherlangs` and
1380− `polyglossia-otherlangs` variables will be generated
1381− automatically based on the `lang` attributes of Spans
1382− and Divs in the document.
1385−: the base direction of the document, either `rtl` (right-to-left)
1855+$if(foo)$
1386− or `ltr` (left-to-right).
1856+XXX
1388− For bidirectional documents, native pandoc `span`s and `div`s
1864+### For loops
1389− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1390− override the base direction in some output formats.
1391− This may not always be necessary if the final renderer
1392− (e.g. the browser, when generating HTML) supports the
1393− [Unicode Bidirectional Algorithm].
1395− When using LaTeX for bidirectional documents, only the `xelatex` engine
1866+A for loop begins with `for(variable)` (enclosed in
1396− is fully supported (use `--pdf-engine=xelatex`).
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1398−[BCP 47]: https://tools.ietf.org/html/bcp47
1870+- If `variable` is an array, the material inside the loop will
1399−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
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.
1401−Variables for slides
1878+Examples:
1402−--------------------
1404−Variables are available for [producing slide shows with pandoc],
1880+```
1405−including all [reveal.js configuration options].
1881+$for(foo)$$foo$$sep$, $endfor$
1407−`titlegraphic`
1883+$for(foo)$
1408−: title graphic for Beamer documents
1884+ - $foo.last$, $foo.first$
1410−`logo`
1887+${ for(foo.bar) }
1411−: logo for Beamer documents
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1413−`slidy-url`
1891+$for(mymap)$
1414−: base URL for Slidy documents (defaults to
1892+$it.name$: $it.office$
1415− `https://www.w3.org/Talks/Tools/Slidy2`)
1893+$endfor$
1417−`slideous-url`
1896+You may optionally specify a separator between consecutive
1418−: base URL for Slideous documents (defaults to `slideous`)
1897+values using `sep` (enclosed in matched delimiters). The
1898+material between `sep` and the `endfor` is the separator.
1421−: base URL for S5 documents (defaults to `s5/default`)
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1423−`revealjs-url`
1904+Instead of using `variable` inside the loop, the special
1424−: base URL for reveal.js documents (defaults to `reveal.js`)
1905+anaphoric keyword `it` may be used.
1426−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1907+```
1427−: themes for LaTeX [`beamer`] documents
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1429−`themeoptions`
1913+### Partials
1430−: options for LaTeX beamer themes (a list).
1432−`navigation`
1915+Partials (subtemplates stored in different files) may be
1433−: controls navigation symbols in `beamer` documents
1916+included by using the name of the partial, followed
1434− (default is `empty` for no navigation symbols; other valid values
1917+by `()`, for example:
1435− are `frame`, `vertical`, and `horizontal`).
1437−`section-titles`
1919+```
1438−: enables on "title pages" for new sections in `beamer`
1920+${ styles() }
1439− documents (default = true).
1921+```
1441−`beamerarticle`
1923+Partials will be sought in the directory containing
1442−: when true, the `beamerarticle` package is loaded (for
1924+the main template. The file name will be assumed to
1443− producing an article from beamer slides).
1925+have the same extension as the main template if it
1926+lacks an extension. When calling the partial, the
1927+full name including file extension can also be used:
1445−`aspectratio`
1929+```
1446−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1930+${ styles.html() }
1447− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1931+```
1448− default, and `32` for 3:2).
1450−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1933+(If a partial is not found in the directory of the
1934+template and the template path is given as a relative
1935+path, it will also be sought in the `templates`
1936+subdirectory of the user data directory.)
1452−Variables for LaTeX
1938+Partials may optionally be applied to variables using
1453−-------------------
1939+a colon:
1455−LaTeX variables are used when [creating a PDF].
1941+```
1457−`papersize`
1944+${ articles:bibentry() }
1458−: paper size, e.g. `letter`, `a4`
1945+```
1460−`fontsize`
1947+If `articles` is an array, this will iterate over its
1461−: font size for body text (e.g. `10pt`, `12pt`)
1948+values, applying the partial `bibentry()` to each one. So the
1949+second example above is equivalent to
1463−`documentclass`
1951+```
1464−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1952+${ for(articles) }
1466−`classoption`
1957+Note that the anaphoric keyword `it` must be used when
1467−: option for document class, e.g. `oneside`; may be repeated
1958+iterating over partials. In the above examples,
1468− for multiple options
1959+the `bibentry` partial should contain `it.title`
1960+(and so on) instead of `articles.title`.
1470−`geometry`
1962+Final newlines are omitted from included partials.
1471−: option for [`geometry`] package, e.g. `margin=1in`;
1472− may be repeated for multiple options
1474−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1964+Partials may include other partials.
1475−: sets margins, if `geometry` is not used (otherwise `geometry`
1478−`linestretch`
1966+A separator between values of an array may be specified
1479−: adjusts line spacing using the [`setspace`]
1967+in square brackets, immediately after the variable name
1480− package, e.g. `1.25`, `1.5`
1968+or partial:
1482−`fontfamily`
1970+```
1483−: font package for use with `pdflatex`:
1971+${months[, ]}$
1484− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1485− The default is [Latin Modern][`lm`].
1487−`fontfamilyoptions`
1973+${articles:bibentry()[; ]$
1488−: options for package used as `fontfamily`: e.g. `osf,sc` with
1974+```
1489− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1490− figures and true small caps; may be repeated for multiple options
1492−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1976+The separator in this case is literal and (unlike with `sep`
1493−: font families for use with `xelatex` or
1977+in an explicit `for` loop) cannot contain interpolated
1494− `lualatex`: take the name of any system font, using the
1978+variables or other template directives.
1495− [`fontspec`] package. Note that if `CJKmainfont` is used,
1496− the [`xecjk`] package must be available.
1498−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1980+### Nesting
1499−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1500− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1501− available through [`fontspec`], such as the OpenType features
1502− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1504−`fontenc`
1982+To ensure that content is "nested," that is, subsequent lines
1505−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1983+indented, use the `^` directive:
1506− default is `T1` (see guide to [LaTeX font encodings])
1508−`microtypeoptions`
1985+```
1509−: options to pass to the microtype package
1986+$item.number$ $^$$item.description$ ($item.price$)
1511−`colorlinks`
1989+In this example, if `item.description` has multiple lines,
1512−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1990+they will all be indented to line up with the first line:
1513− `urlcolor`, or `toccolor` are set
1515−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1992+```
1516−: color for internal links, citation links, external links, and links in table of contents:
1993+00123 A fine bottle of 18-year old
1517− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1994+ Oban whiskey. ($148)
1519−`links-as-notes`
1997+To nest multiple lines to the same level, align them
1520−: causes links to be printed as footnotes
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
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
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
1523−: uses document class settings for indentation (the default LaTeX template
2455+ indentation (the default LaTeX template otherwise removes
1524− otherwise removes indentation and adds space between paragraphs)
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
1526−`subparagraph`
2528+#### Links
1527−: disables default behavior of LaTeX template that redefines (sub)paragraphs
2529+
1528− as sections, changing the appearance of nested headings in some classes
2530+`colorlinks`
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
1531−: specifies contents of acknowledgments footnote after document title.
2549+: contents of acknowledgments footnote after document title
1534−: include table of contents (can also be set using `--toc/--table-of-contents`)
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
1536`toc-depth`
2555`toc-depth`
1537: level of section to include in table of contents
2556: level of section to include in table of contents
1539−`secnumdepth`
2558+#### BibLaTeX Bibliographies
1540−: numbering depth for sections, if sections are numbered
1542−`lof`, `lot`
2560+These variables function when using BibLaTeX for [citation rendering].
1543−: include list of figures, list of tables
1545−`bibliography`
2562+`biblatexoptions`
1546−: bibliography to use for resolving references
2563+: list of options for biblatex
1548`biblio-style`
2565`biblio-style`
1549: bibliography style, when used with `--natbib` and `--biblatex`.
2566: bibliography style, when used with `--natbib` and `--biblatex`.
@@ -1551,116 +2568,154 @@ LaTeX variables are used when [creating a PDF].
1551`biblio-title`
2568`biblio-title`
1552: bibliography title, when used with `--natbib` and `--biblatex`.
2569: bibliography title, when used with `--natbib` and `--biblatex`.
1554−`biblatexoptions`
2571+`bibliography`
1555−: list of options for biblatex.
2572+: bibliography to use for resolving references
1557`natbiboptions`
2574`natbiboptions`
1558−: list of options for natbib.
2575+: list of options for natbib
1561−: An option for LaTeX's `\pagestyle{}`. The default article class
1562− supports 'plain' (default), 'empty', and 'headings'; headings puts
1563− section titles in the header.
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
1565[`article`]: https://ctan.org/pkg/article
2581[`article`]: https://ctan.org/pkg/article
1566−[`report`]: https://ctan.org/pkg/report
1567[`book`]: https://ctan.org/pkg/book
2582[`book`]: https://ctan.org/pkg/book
1568−[KOMA-Script]: https://ctan.org/pkg/koma-script
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
1569[`memoir`]: https://ctan.org/pkg/memoir
2584[`memoir`]: https://ctan.org/pkg/memoir
1570−[`xcolor`]: https://ctan.org/pkg/xcolor
1571−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1572−[`mathpazo`]: https://ctan.org/pkg/mathpazo
2585+[`report`]: https://ctan.org/pkg/report
1573−[LaTeX font encodings]: https://ctan.org/pkg/encguide
1575−Variables for ConTeXt
1576−---------------------
1578−`papersize`
2587+### Variables for ConTeXt
1579−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1580− may be repeated for multiple options
1582−`layout`
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
1583−: options for page margins and text arrangement (see [ConTeXt Layout]);
1584− may be repeated for multiple options
1586−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1587−: sets margins, if `layout` is not used (otherwise `layout`
1590`fontsize`
2591`fontsize`
1591: font size for body text (e.g. `10pt`, `12pt`)
2592: font size for body text (e.g. `10pt`, `12pt`)
1593−`mainfont`, `sansfont`, `monofont`, `mathfont`
2594+`headertext`, `footertext`
1594−: font families: take the name of any system font (see [ConTeXt Font Switching])
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
1596`linkcolor`, `contrastcolor`
2610`linkcolor`, `contrastcolor`
1597−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
1599`linkstyle`
2614`linkstyle`
1600−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
1602−`indenting`
2618+`lof`, `lot`
1603−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2619+: include list of figures, list of tables
1604− may be repeated for multiple options
1607−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
1609−`interlinespace`
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
1610−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2622+: font families: take the name of any system font (see
1611− may be repeated for multiple options
2623+ [ConTeXt Font Switching])
1613−`headertext`, `footertext`
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1614−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2626+: sets margins, if `layout` is not used (otherwise `layout`
1615− may be repeated up to four times for different placement
2627+ overrides these)
1617`pagenumbering`
2629`pagenumbering`
1618: page number style and location (using [`setuppagenumbering`]);
2630: page number style and location (using [`setuppagenumbering`]);
1619− may be repeated for multiple options
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.
1622−: include table of contents (can also be set using `--toc/--table-of-contents`)
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
1624−`lof`, `lot`
2667+`whitespace`
1625−: include list of figures, list of tables
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
1627−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
2671+`includesource`
1628−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
2672+: include all source documents as file attachments in the PDF file
1629−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1630−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1631−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1632−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1633−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1634−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1635−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1637−Variables for man pages
2674+[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1638−-----------------------
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
1640−`section`
2686+### Variables for `wkhtmltopdf`
1641−: section number in man pages
1643−`header`
2688+Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
1644−: header in man pages
2689+The `--css` option also affects the output.
1646−`footer`
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
1647−: footer in man pages
2700+### Variables for man pages
1649`adjusting`
2702`adjusting`
1650: adjusts text to left (`l`), right (`r`), center (`c`),
2703: adjusts text to left (`l`), right (`r`), center (`c`),
1651 or both (`b`) margins
2704 or both (`b`) margins
2707+: footer in man pages
2710+: header in man pages
1653`hyphenate`
2712`hyphenate`
1654: if `true` (the default), hyphenation will be used
2713: if `true` (the default), hyphenation will be used
1656−Variables for ms
2715+`section`
1657−----------------
2716+: section number in man pages
1660−: point size (e.g. `10p`)
1662−`lineheight`
2718+### Variables for ms
1663−: line height (e.g. `12p`)
1665`fontfamily`
2720`fontfamily`
1666: font family (e.g. `T` or `P`)
2721: font family (e.g. `T` or `P`)
@@ -1668,62 +2723,81 @@ Variables for ms
1669: paragraph indent (e.g. `2m`)
2724: paragraph indent (e.g. `2m`)
1671−Using variables in templates
2726+`lineheight`
1672−----------------------------
2727+: line height (e.g. `12p`)
1674−Variable names are sequences of alphanumerics, `-`, and `_`,
2729+`pointsize`
1675−starting with a letter. A variable name surrounded by `$` signs
2730+: point size (e.g. `10p`)
1676−will be replaced by its value. For example, the string `$title$` in
1678− <title>$title$</title>
2732+### Variables set automatically
1680−will be replaced by the document title.
2734+Pandoc sets these variables automatically in response to [options] or
2735+document contents; users can also modify them. These vary depending
2736+on the output format, and include the following:
1682−To write a literal `$` in a template, use `$$`.
2738+`body`
1684−Templates may contain conditionals. The syntax is as follows:
2741+`date-meta`
2742+: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2743+ included in all HTML based formats (dzslides, epub,
2744+ html, html4, html5, revealjs, s5, slideous, slidy).
2745+ The recognized formats for `date` are: `mm/dd/yyyy`,
2746+ `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2747+ (e.g. either `02 Apr 2018` or `02 April 2018`),
2748+ `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2749+ `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
1686− $if(variable)$
2751+`header-includes`
1687− X
2752+: contents specified by `-H/--include-in-header` (may have multiple
1688− $else$
2753+ values)
1692−This will include `X` in the template if `variable` has a non-null
2755+`include-before`
1693−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
2756+: contents specified by `-B/--include-before-body` (may have
1694−any valid template text, and may include interpolated variables or other
2757+ multiple values)
1695−conditionals. The `$else$` section may be omitted.
2760+: contents specified by `-A/--include-after-body` (may have
1697−When variables can have multiple values (for example, `author` in
2761+ multiple values)
1698−a multi-author document), you can use the `$for$` keyword:
1700− $for(author)$
2763+`meta-json`
1701− <meta name="author" content="$author$" />
2764+: JSON representation of all of the document's metadata. Field
1702− $endfor$
2765+ values are transformed to the selected output format.
1704−You can optionally specify a separator to be used between
2767+`numbersections`
1705−consecutive items:
2768+: non-null value if `-N/--number-sections` was specified
1707− $for(author)$$author$$sep$, $endfor$
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:
1709−A dot can be used to select a field of a variable that takes
2776+ $if(sourcefile)$
1710−an object as its value. So, for example:
2777+ $for(sourcefile)$
1712− $author.name$ ($author.affiliation$)
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
1714−If you use custom templates, you may need to revise them as pandoc
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
1715−changes. We recommend tracking the changes in the default templates,
1716−and modifying your custom templates accordingly. An easy way to do this
1717−is to fork the [pandoc-templates] repository and merge in changes after each
1720−Templates may contain comments: anything on a line after `$--`
2788+`curdir`
1721−will be treated as a comment and ignored.
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)
1723[pandoc-templates]: https://github.com/jgm/pandoc-templates
2798[pandoc-templates]: https://github.com/jgm/pandoc-templates
1725−Extensions
2800+# Extensions
1728The behavior of some of the readers and writers can be adjusted by
2802The behavior of some of the readers and writers can be adjusted by
1729enabling or disabling various extensions.
2803enabling or disabling various extensions.
@@ -1740,8 +2814,11 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
1740`commonmark` and `gfm`.) In the following, extensions that also work
2814`commonmark` and `gfm`.) In the following, extensions that also work
1741for other formats are covered.
2815for 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`).
1743−Typography
2821+## Typography
1746#### Extension: `smart` ####
2823#### Extension: `smart` ####
@@ -1773,13 +2850,12 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
1773to use the ligatures when possible; if `smart` is disabled
2850to use the ligatures when possible; if `smart` is disabled
1774pandoc will use unicode quotation mark and dash characters.
2851pandoc will use unicode quotation mark and dash characters.
1776−Headers and sections
2853+## Headings and sections
1777−--------------------
1779#### Extension: `auto_identifiers` ####
2855#### Extension: `auto_identifiers` ####
1781−A header without an explicitly specified identifier will be
2857+A heading without an explicitly specified identifier will be
1782−automatically assigned a unique identifier based on the header text.
2858+automatically assigned a unique identifier based on the heading text.
1784This extension can be enabled/disabled for the following formats:
2860This extension can be enabled/disabled for the following formats:
@@ -1792,11 +2868,13 @@ output formats
1792enabled by default in
2868enabled by default in
1793: `markdown`, `muse`
2869: `markdown`, `muse`
1795−The algorithm used to derive the identifier from the header text is:
2871+The default algorithm used to derive the identifier from the
1797 - Remove all formatting, links, etc.
2874 - Remove all formatting, links, etc.
1798 - Remove all footnotes.
2875 - Remove all footnotes.
2876+ - Remove all non-alphanumeric characters,
1799− - Remove all punctuation, except underscores, hyphens, and periods.
2877+ except underscores, hyphens, and periods.
1800 - Replace all spaces and newlines with hyphens.
2878 - Replace all spaces and newlines with hyphens.
1801 - Convert all alphabetic characters to lowercase.
2879 - Convert all alphabetic characters to lowercase.
1802 - Remove everything up to the first letter (identifiers may
2880 - Remove everything up to the first letter (identifiers may
@@ -1805,27 +2883,31 @@ The algorithm used to derive the identifier from the header text is:
1806Thus, for example,
2884Thus, for example,
1808− Header Identifier
2886+ Heading Identifier
1809 ------------------------------- ----------------------------
2887 ------------------------------- ----------------------------
1810− `Header identifiers in HTML` `header-identifiers-in-html`
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
1811 `*Dogs*?--in *my* house?` `dogs--in-my-house`
2890 `*Dogs*?--in *my* house?` `dogs--in-my-house`
1812 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1813 `3. Applications` `applications`
2892 `3. Applications` `applications`
1814 `33` `section`
2893 `33` `section`
1816These rules should, in most cases, allow one to determine the identifier
2895These rules should, in most cases, allow one to determine the identifier
1817−from the header text. The exception is when several headers have the
2896+from the heading text. The exception is when several headings have the
1818same text; in this case, the first will get an identifier as described
2897same text; in this case, the first will get an identifier as described
1819above; the second will get the same identifier with `-1` appended; the
2898above; the second will get the same identifier with `-1` appended; the
1820third with `-2`; and so on.
2899third with `-2`; and so on.
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
1822These identifiers are used to provide link targets in the table of
2904These identifiers are used to provide link targets in the table of
1823contents generated by the `--toc|--table-of-contents` option. They
2905contents generated by the `--toc|--table-of-contents` option. They
1824also make it easy to provide links from one section of a document to
2906also make it easy to provide links from one section of a document to
1825another. A link to this section, for example, might look like this:
2907another. A link to this section, for example, might look like this:
1827 See the section on
2909 See the section on
1828− [header identifiers](#header-identifiers-in-html-latex-and-context).
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
1830Note, however, that this method of providing links to sections works
2912Note, however, that this method of providing links to sections works
1831only in HTML, LaTeX, and ConTeXt formats.
2913only in HTML, LaTeX, and ConTeXt formats.
@@ -1833,7 +2915,7 @@ only in HTML, LaTeX, and ConTeXt formats.
1833If the `--section-divs` option is specified, then each section will
2915If the `--section-divs` option is specified, then each section will
1834be wrapped in a `section` (or a `div`, if `html4` was specified),
2916be wrapped in a `section` (or a `div`, if `html4` was specified),
1835and the identifier will be attached to the enclosing `<section>`
2917and the identifier will be attached to the enclosing `<section>`
1836−(or `<div>`) tag rather than the header itself. This allows entire
2918+(or `<div>`) tag rather than the heading itself. This allows entire
1837sections to be manipulated using JavaScript or treated differently in
2919sections to be manipulated using JavaScript or treated differently in
@@ -1843,8 +2925,15 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
1843Accents are stripped off of accented Latin letters, and non-Latin
2925Accents are stripped off of accented Latin letters, and non-Latin
1844letters are omitted.
2926letters are omitted.
2928+#### Extension: `gfm_auto_identifiers` ####
2930+Changes the algorithm used by `auto_identifiers` to conform to
2931+GitHub's method. Spaces are converted to dashes (`-`),
2932+uppercase characters to lowercase characters, and punctuation
2933+characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
1846−Math Input
2936+## Math Input
1849The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
1850[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -1854,50 +2943,47 @@ are described in the section about Pandoc's Markdown.
1854However, they can also be used with HTML input. This is handy for
2943However, they can also be used with HTML input. This is handy for
1855reading web pages formatted using MathJax, for example.
2944reading web pages formatted using MathJax, for example.
1857−Raw HTML/TeX
2946+## Raw HTML/TeX
1860−The following extensions (especially how they affect Markdown
1861−input/output) are also described in more detail in their respective
1862−sections of [Pandoc's Markdown].
1864−#### [Extension: `raw_html`] {#raw_html}
1866−When converting from HTML, parse elements to raw HTML which are not
1867−representable in pandoc's AST.
1868−By default, this is disabled for HTML input.
1870−#### [Extension: `raw_tex`] {#raw_tex}
2948+The following extensions are described in more detail in
1871−
2949+their respective sections of [Pandoc's Markdown]:
1872−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
1874−This extension can be enabled/disabled for the following formats
1875−(in addition to `markdown`):
1878−: `latex`, `org`, `textile`
1883−#### [Extension: `native_divs`] {#native_divs}
2951+- [`raw_html`](#extension-raw_html) allows HTML elements which
2952+ are not representable in pandoc's AST to be parsed as raw HTML.
2953+ By default, this is disabled for HTML input.
1885−This extension is enabled by default for HTML input. This means that
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
1886−`div`s are parsed to pandoc native elements. (Alternatively, you
2956+ to be included in a document. This extension can be enabled/disabled
1887−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2957+ for the following formats (in addition to `markdown`):
1889−When converting HTML to Markdown, for example, you may want to drop all
2959+ input formats
1890−`div`s and `span`s:
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
1892− pandoc -f html-native_divs-native_spans -t markdown
2963+ output formats
2964+ : `textile`, `commonmark`
1894−#### [Extension: `native_spans`] {#native_spans}
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967+ only raw TeX in markdown cells, but data with mime type
2968+ `text/html` in output cells. Since the `ipynb` reader attempts
2969+ to preserve the richest possible outputs when several options
2970+ are given, you will get best results if you disable `raw_html`
2971+ and `raw_tex` when converting to formats like `docx` which don't
2972+ allow raw `html` or `tex`.
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2975+ elements to be parsed as native pandoc Div blocks.
2976+ If you want them to be parsed as raw HTML, use
1896−Analogous to `native_divs` above.
2977+ `-f html-native_divs+raw_html`.
2979+- [`native_spans`](#extension-native_spans) causes HTML `span`
2980+ elements to be parsed as native pandoc Span inlines.
2981+ If you want them to be parsed as raw HTML, use
2982+ `-f html-native_spans+raw_html`. If you want to drop all
2983+ `div`s and `span`s when converting HTML to Markdown, you
2984+ can use `pandoc -f html-native_divs-native_spans -t markdown`.
1899−Literate Haskell support
2986+## Literate Haskell support
1900−------------------------
1902#### Extension: `literate_haskell` ####
2988#### Extension: `literate_haskell` ####
@@ -1918,12 +3004,12 @@ This means that
1918 - In Markdown input, "bird track" sections will be parsed as Haskell
3004 - In Markdown input, "bird track" sections will be parsed as Haskell
1919 code rather than block quotations. Text between `\begin{code}`
3005 code rather than block quotations. Text between `\begin{code}`
1920 and `\end{code}` will also be treated as Haskell code. For
3006 and `\end{code}` will also be treated as Haskell code. For
1921− ATX-style headers the character '=' will be used instead of '#'.
3007+ ATX-style headings the character '=' will be used instead of '#'.
1923 - In Markdown output, code blocks with classes `haskell` and `literate`
3009 - In Markdown output, code blocks with classes `haskell` and `literate`
1924 will be rendered using bird tracks, and block quotations will be
3010 will be rendered using bird tracks, and block quotations will be
1925 indented one space, so they will not be treated as Haskell code.
3011 indented one space, so they will not be treated as Haskell code.
1926− In addition, headers will be rendered setext-style (with underlines)
3012+ In addition, headings will be rendered setext-style (with underlines)
1927 rather than ATX-style (with '#' characters). (This is because ghc
3013 rather than ATX-style (with '#' characters). (This is because ghc
1928 treats '#' characters in column 1 as introducing line numbers.)
3014 treats '#' characters in column 1 as introducing line numbers.)
@@ -1954,12 +3040,11 @@ ordinary HTML (without bird tracks).
1954writes HTML with the Haskell code in bird tracks, so it can be copied
3040writes HTML with the Haskell code in bird tracks, so it can be copied
1955and pasted as literate Haskell source.
3041and pasted as literate Haskell source.
1957−Note that GHC expects the bird tracks in the first column, so indentend literate
3043+Note that GHC expects the bird tracks in the first column, so indented
1958−code blocks (e.g. inside an itemized environment) will not be picked up by the
3044+literate code blocks (e.g. inside an itemized environment) will not be
1959−Haskell compiler.
3045+picked up by the Haskell compiler.
1961−Other extensions
3047+## Other extensions
1964#### Extension: `empty_paragraphs` ####
3049#### Extension: `empty_paragraphs` ####
@@ -1972,14 +3057,62 @@ input formats
1972: `docx`, `html`
3057: `docx`, `html`
1974output formats
3059output formats
1975−: `markdown`, `docx`, `odt`, `opendocument`, `html`
3060+: `docx`, `odt`, `opendocument`, `html`
3062+#### Extension: `native_numbering` ####
3064+Enables native numbering of figures and tables. Enumeration
3067+This extension can be enabled/disabled for the following formats:
3070+: `odt`, `opendocument`
3072+#### Extension: `xrefs_name` ####
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3084+This extension can be enabled/disabled for the following formats:
3087+: `odt`, `opendocument`
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`
1977#### Extension: `styles` #### {#ext-styles}
3109#### Extension: `styles` #### {#ext-styles}
3111+When converting from docx, read all docx styles as divs (for
1979−Read all docx styles as divs (for paragraph styles) and spans (for
3112+paragraph styles) and spans (for character styles) regardless
1980−character styles) regardless of whether pandoc understands the meaning
3113+of whether pandoc understands the meaning of these styles.
1981−of these styles. This can be used with [docx custom
3114+This can be used with [docx custom styles](#custom-styles).
1982−styles](#custom-styles-in-docx). Disabled by default.
3115+Disabled by default.
1984input formats
3117input formats
@@ -1989,22 +3122,36 @@ input formats
1989In the `muse` input format, this enables Text::Amuse
3122In the `muse` input format, this enables Text::Amuse
1990extensions to Emacs Muse markup.
3123extensions 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
1992#### Extension: `citations` {#org-citations}
3133#### Extension: `citations` {#org-citations}
1994−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
1995−in `org` input.
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.
1997#### Extension: `ntb` ####
3145#### Extension: `ntb` ####
1999In the `context` output format this enables the use of [Natural Tables
3147In the `context` output format this enables the use of [Natural Tables
2000−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2001−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2002Natural tables allow more fine-grained global customization but come
3150Natural tables allow more fine-grained global customization but come
2003at a performance penalty compared to extreme tables.
3151at a performance penalty compared to extreme tables.
2006−Pandoc's Markdown
3154+# Pandoc's Markdown
2009Pandoc understands an extended and slightly revised version of
3156Pandoc understands an extended and slightly revised version of
2010John Gruber's [Markdown] syntax. This document explains the syntax,
3157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2014,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
2014behavior more granularly. They are described in the following. See also
3161behavior more granularly. They are described in the following. See also
2015[Extensions] above, for extensions that work also on other formats.
3162[Extensions] above, for extensions that work also on other formats.
2017−Philosophy
3164+## Philosophy
2020Markdown is designed to be easy to write, and, even more importantly,
3166Markdown is designed to be easy to write, and, even more importantly,
2021easy to read:
3167easy to read:
@@ -2023,7 +3169,7 @@ easy to read:
2023> A Markdown-formatted document should be publishable as-is, as plain
3169> A Markdown-formatted document should be publishable as-is, as plain
2024> 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
2025> instructions.
3171> instructions.
2026−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2028This principle has guided pandoc's decisions in finding syntax for
3174This principle has guided pandoc's decisions in finding syntax for
2029tables, footnotes, and other extensions.
3175tables, footnotes, and other extensions.
@@ -2036,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
2036important document elements like definition lists, tables, mathematics, and
3182important document elements like definition lists, tables, mathematics, and
2037footnotes.
3183footnotes.
2039−Paragraphs
3185+## Paragraphs
2042A 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.
2043Newlines 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.
@@ -2050,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
2050to create a hard line break, since trailing spaces in the cells
3195to create a hard line break, since trailing spaces in the cells
2051are ignored.
3196are ignored.
2053−Headers
3198+## Headings
2056−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
2058−### Setext-style headers ###
3202+### Setext-style headings ###
2060−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
2061−(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):
2063− A level-one header
3207+ A level-one heading
2064− ==================
3208+ ===================
2066− A level-two header
3210+ A level-two heading
2067− ------------------
3211+ -------------------
2069−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
2070[Inline formatting], below).
3214[Inline formatting], below).
2073−### ATX-style headers ###
3217+### ATX-style headings ###
2075−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
2076text, optionally followed by any number of `#` signs. The number of
3220text, optionally followed by any number of `#` signs. The number of
2077−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
2079− ## A level-two header
3223+ ## A level-two heading
2081− ### A level-three header ###
3225+ ### A level-three heading ###
2083−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
2085− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
2087#### Extension: `blank_before_header` ####
3231#### Extension: `blank_before_header` ####
2089−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.
2090Pandoc does require this (except, of course, at the beginning of the
3234Pandoc does require this (except, of course, at the beginning of the
2091document). 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
2092`#` 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
@@ -2098,29 +3242,30 @@ wrapping). Consider, for example:
2098#### Extension: `space_in_atx_header` ####
3242#### Extension: `space_in_atx_header` ####
2100Many Markdown implementations do not require a space between the
3244Many Markdown implementations do not require a space between the
2101−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
2102−`#5 bolt` and `#hashtag` count as headers. With this extension,
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
2103pandoc does require the space.
3247pandoc does require the space.
2105−### Header identifiers ###
3249+### Heading identifiers ###
3251+See also the [`auto_identifiers`
2107−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3252+extension](#extension-auto_identifiers) above.
2109#### Extension: `header_attributes` ####
3254#### Extension: `header_attributes` ####
2111−Headers can be assigned attributes using this syntax at the end
3256+Headings can be assigned attributes using this syntax at the end
2112−of the line containing the header text:
3257+of the line containing the heading text:
2114 {#identifier .class .class key=value key=value}
3259 {#identifier .class .class key=value key=value}
2116−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
2119− # My header {#foo}
3264+ # My heading {#foo}
2121− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
2123− My other header {#foo}
3268+ My other heading {#foo}
2124 ---------------
3269 ---------------
2126(This syntax is compatible with [PHP Markdown Extra].)
3271(This syntax is compatible with [PHP Markdown Extra].)
@@ -2129,51 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
2129attributes, writers generally don't use all of this information. Identifiers,
3274attributes, writers generally don't use all of this information. Identifiers,
2130classes, 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
2131as 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
2132−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
2134−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
2135`--number-sections` is specified. A single hyphen (`-`) in an attribute
3280`--number-sections` is specified. A single hyphen (`-`) in an attribute
2136context is equivalent to `.unnumbered`, and preferable in non-English
3281context is equivalent to `.unnumbered`, and preferable in non-English
2137documents. So,
3282documents. So,
2139− # My header {-}
3284+ # My heading {-}
2141is just the same as
3286is just the same as
2143− # My header {.unnumbered}
3288+ # My heading {.unnumbered}
3290+If the `unlisted` class is present in addition to `unnumbered`,
3291+the heading will not be included in a table of contents.
3292+(Currently this feature is only implemented for certain
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
2145#### Extension: `implicit_header_references` ####
3295#### Extension: `implicit_header_references` ####
2147−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.
2148−So, to link to a header
3298+So, to link to a heading
2150− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
2152you can simply write
3302you can simply write
2154− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
2158− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
2162− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
2165instead of giving the identifier explicitly:
3315instead of giving the identifier explicitly:
2167− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
2169−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
2170reference 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
2171links to link to the others, as described above.
3321links to link to the others, as described above.
2173Like regular reference links, these references are case-insensitive.
3323Like regular reference links, these references are case-insensitive.
2175Explicit link reference definitions always take priority over
3325Explicit link reference definitions always take priority over
2176−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
2177link will point to `bar`, not to `#foo`:
3327link will point to `bar`, not to `#foo`:
@@ -2182,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
2183 See [foo]
3333 See [foo]
2185−Block quotations
3335+## Block quotations
2188Markdown uses email conventions for quoting blocks of text.
3337Markdown uses email conventions for quoting blocks of text.
2189A block quotation is one or more paragraphs or other block elements
3338A block quotation is one or more paragraphs or other block elements
2190−(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
2191and 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
2192it should not be indented more than three spaces.)
3341it should not be indented more than three spaces.)
@@ -2222,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
2223#### Extension: `blank_before_blockquote` ####
3372#### Extension: `blank_before_blockquote` ####
2225−Standard Markdown syntax does not require a blank line before a block
3374+Standard Markdown syntax does not require a blank line before a
2226−quote. Pandoc does require this (except, of course, at the beginning of the
3375+block quote. Pandoc does require this (except, of course, at
2227−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
2228−`>` 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,
2229−wrapping). So, unless the `markdown_strict` format is used, the following does
3379+unless the `markdown_strict` format is used, the following does
2230not produce a nested block quote in pandoc:
3380not produce a nested block quote in pandoc:
2232 > This is a block quote.
3382 > This is a block quote.
2233 >> Nested.
3383 >> Nested.
2236−Verbatim (code) blocks
3386+## Verbatim (code) blocks
2237−----------------------
2239### Indented code blocks ###
3388### Indented code blocks ###
@@ -2296,14 +3445,16 @@ this syntax:
2296 qsort (filter (>= x) xs)
3445 qsort (filter (>= x) xs)
2297 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2299−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
2300−`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
2301−information to do syntax highlighting. Currently, the only output formats
3451+highlighting. Currently, the only output formats that uses this
2302−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2303−highlighting is supported for your output format and language, then the code
3453+highlighting is supported for your output format and language,
2304−block above will appear highlighted, with numbered lines. (To see which
3454+then the code block above will appear highlighted, with numbered
2305−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
2306−the code block above will appear as follows:
3457+will appear as follows:
2308 <pre id="mycode" class="haskell numberLines" startFrom="100">
3459 <pre id="mycode" class="haskell numberLines" startFrom="100">
@@ -2340,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
2340For more information on highlighting, see [Syntax highlighting],
3491For more information on highlighting, see [Syntax highlighting],
2343−Line blocks
3494+## Line blocks
2346#### Extension: `line_blocks` ####
3496#### Extension: `line_blocks` ####
@@ -2367,10 +3517,12 @@ line must begin with a space.
2367 | 200 Main St.
3517 | 200 Main St.
2368 | 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).
2370This syntax is borrowed from [reStructuredText].
3523This syntax is borrowed from [reStructuredText].
2375### Bullet lists ###
3527### Bullet lists ###
@@ -2540,6 +3692,12 @@ If default list markers are desired, use `#.`:
2541 #. 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
2544### Definition lists ###
3702### Definition lists ###
@@ -2565,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
2565A 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
2566or two spaces.
3724or two spaces.
2568−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
2569−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
2570−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
2571−aside from the colon or tilde) should be indented four spaces. However,
3730+colon or tilde) should be indented four spaces. However, as with
2572−as with other Markdown lists, you can "lazily" omit indentation except
3731+other Markdown lists, you can "lazily" omit indentation except
2573at the beginning of a paragraph or other block element:
3732at the beginning of a paragraph or other block element:
@@ -2595,9 +3754,10 @@ definition:
2595Note that space between items in a definition list is required.
3754Note that space between items in a definition list is required.
2596(A variant that loosens this requirement, but disallows "lazy"
3755(A variant that loosens this requirement, but disallows "lazy"
2597hard wrapping, can be activated with `compact_definition_lists`: see
3756hard wrapping, can be activated with `compact_definition_lists`: see
2598−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
2600−[^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/).
2602### Numbered example lists ###
3762### Numbered example lists ###
@@ -2633,30 +3793,6 @@ list marker. That is, example lists always behave as if the
2633labels tend to be long, and indenting content to the
3793labels tend to be long, and indenting content to the
2634first non-space character after the label would be awkward.
3794first non-space character after the label would be awkward.
2636−### Compact and loose lists ###
2638−Pandoc behaves differently from `Markdown.pl` on some "edge
2639−cases" involving lists. Consider this source:
2649−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2650−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2651−"Second" and "Third" (but not "First"), because of the blank space
2652−around "Third". Pandoc follows a simple rule: if the text is followed by
2653−a blank line, it is treated as a paragraph. Since "Second" is followed
2654−by a list, and not a blank line, it isn't treated as a paragraph. The
2655−fact that the list is followed by a blank line is irrelevant. (Note:
2656−Pandoc works this way even when the `markdown_strict` format is specified. This
2657−behavior is consistent with the official Markdown syntax description,
2658−even though it is different from that of `Markdown.pl`.)
2661### Ending a list ###
3797### Ending a list ###
@@ -2695,8 +3831,7 @@ of one big list:
2698−Horizontal rules
3834+## Horizontal rules
2701A line containing a row of three or more `*`, `-`, or `_` characters
3836A line containing a row of three or more `*`, `-`, or `_` characters
2702(optionally separated by spaces) produces a horizontal rule:
3837(optionally separated by spaces) produces a horizontal rule:
@@ -2706,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
2706 ---------------
3841 ---------------
2709−Tables
3844+## Tables
2712Four 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
2713a 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
@@ -2732,7 +3866,7 @@ Simple tables look like this:
2733 Table: Demonstration of simple table syntax.
3867 Table: Demonstration of simple table syntax.
2735−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
2736alignments are determined by the position of the header text relative
3870alignments are determined by the position of the header text relative
2737to the dashed line below it:[^4]
3871to the dashed line below it:[^4]
@@ -2751,7 +3885,7 @@ to the dashed line below it:[^4]
2751The 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
2752a blank line.
3886a blank line.
2754−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
2755to end the table. For example:
3889to end the table. For example:
2757 ------- ------ ---------- -------
3891 ------- ------ ---------- -------
@@ -2760,13 +3894,13 @@ to end the table. For example:
2761 ------- ------ ---------- -------
3895 ------- ------ ---------- -------
2763−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
2764of 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
2765would be right, left, center, and right aligned, respectively.
3899would be right, left, center, and right aligned, respectively.
2767#### Extension: `multiline_tables` ####
3901#### Extension: `multiline_tables` ####
2769−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
2770of 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
2771not supported). Here is an example:
3905not supported). Here is an example:
@@ -2788,7 +3922,7 @@ not supported). Here is an example:
2788These work like simple tables, but with the following differences:
3922These work like simple tables, but with the following differences:
2790 - 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
2791− (unless the headers are omitted).
3925+ (unless the header row is omitted).
2792 - 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.
2793 - The rows must be separated by blank lines.
3927 - The rows must be separated by blank lines.
@@ -2797,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
2797the 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
2798output, try widening it in the Markdown source.
3932output, try widening it in the Markdown source.
2800−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:
2802 ----------- ------- --------------- -------------------------
3936 ----------- ------- --------------- -------------------------
2803 First row 12.0 Example of a row that
3937 First row 12.0 Example of a row that
@@ -2808,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
2809 ----------- ------- --------------- -------------------------
3943 ----------- ------- --------------- -------------------------
2811− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
2813It 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
2814should 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
@@ -2834,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
2834omitted for a headerless table. The cells of grid tables may contain
3968omitted for a headerless table. The cells of grid tables may contain
2835arbitrary block elements (multiple paragraphs, code blocks, lists,
3969arbitrary block elements (multiple paragraphs, code blocks, lists,
2836etc.). Cells that span multiple columns or rows are not
3970etc.). Cells that span multiple columns or rows are not
2837−supported. Grid tables can be created easily using [Emacs table mode].
3971+supported. Grid tables can be created easily using Emacs' table-mode
2838−
3972+(`M-x table-insert`).
2839−[Emacs table mode]: http://table.sourceforge.net/
2841Alignments can be specified as with pipe tables, by putting
3974Alignments can be specified as with pipe tables, by putting
2842colons at the boundaries of the separator line after the
3975colons at the boundaries of the separator line after the
@@ -2864,7 +3997,7 @@ and the same number of rows in each column. For example, the
2864Docutils [sample grid tables] will not render as expected with
3997Docutils [sample grid tables] will not render as expected with
2867−[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
2870#### Extension: `pipe_tables` ####
4003#### Extension: `pipe_tables` ####
@@ -2897,11 +4030,13 @@ legal (though ugly) pipe table:
2898The cells of pipe tables cannot contain block elements like paragraphs
4031The cells of pipe tables cannot contain block elements like paragraphs
2899and 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
2900−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
2901−`--columns`), then the cell contents will wrap, with the
4035+the cell contents will wrap, with the relative cell widths determined
2902−relative cell widths determined by the widths of the separator
4036+by the number of dashes in the line separating the table header from
2903−lines. (In this case, the table will take up the full text
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.)
2904−width.) If no lines are wider than column width, then
4039+On the other hand, if no lines are wider than column width, then
2905cell contents will not be wrapped, and the cells will be sized
4040cell contents will not be wrapped, and the cells will be sized
2906to their contents.
4041to their contents.
@@ -2919,8 +4054,7 @@ you'll need to add colons as above.
2920[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
2922−Metadata blocks
4057+## Metadata blocks
2925#### Extension: `pandoc_title_block` ####
4059#### Extension: `pandoc_title_block` ####
@@ -2936,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
2936or 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
2937title, 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:
2940− % Author
4075+% Author
2942− % My title
4079+% My title
2944− % June 15, 2006
4081+% June 15, 2006
2946The title may occupy multiple lines, but continuation lines must
4084The title may occupy multiple lines, but continuation lines must
2947begin with leading space, thus:
4085begin with leading space, thus:
2949− % My title
4088+% My title
2950− on multiple lines
4089+ on multiple lines
2952If a document has multiple authors, the authors may be put on
4092If a document has multiple authors, the authors may be put on
2953separate lines with leading space, or separated by semicolons, or
4093separate lines with leading space, or separated by semicolons, or
2954both. So, all of the following are equivalent:
4094both. So, all of the following are equivalent:
2956− % Author One
4097+% Author One
2957− Author Two
4098+ Author Two
2959− % Author One; Author Two
4102+% Author One; Author Two
2961− % Author One;
4106+% Author One;
2962− Author Two
4107+ Author Two
2964The date must fit on one line.
4110The date must fit on one line.
@@ -3000,7 +4146,7 @@ will also have "Version 4.0" in the header.
3001#### Extension: `yaml_metadata_block` ####
4147#### Extension: `yaml_metadata_block` ####
3003−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
3004hyphens (`---`) 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
3005(`...`) 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
3006document, 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
@@ -3011,41 +4157,53 @@ and pass it to pandoc as an argument, along with your Markdown files:
3011 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
3013Just 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
3014−`...`.)
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.
3016Metadata 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
3017existing document metadata. Metadata can contain lists and objects (nested
4165existing document metadata. Metadata can contain lists and objects (nested
3018arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
3019with 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
3020−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).
3022−A document may contain multiple metadata blocks. The metadata fields will
4172+A document may contain multiple metadata blocks. If two
3023−be combined through a *left-biased union*: if two metadata blocks attempt
3024−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.
3026When pandoc is used with `-t markdown` to create a Markdown document,
4176When pandoc is used with `-t markdown` to create a Markdown document,
3027a YAML metadata block will be produced only if the `-s/--standalone`
4177a YAML metadata block will be produced only if the `-s/--standalone`
3028option 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
3029at the beginning of the document.
4179at the beginning of the document.
3031−Note that YAML escaping rules must be followed. Thus, for example,
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
3032−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
3033−(`|`) can be used to begin an indented block that will be interpreted
4185+an indented block that will be interpreted literally, without need for
3034−literally, without need for escaping. This form is necessary
4186+escaping. This form is necessary when the field contains blank lines
3035−when the field contains blank lines or block-level formatting:
4187+or block-level formatting:
3038 title: 'This is the title: it contains a colon'
4190 title: 'This is the title: it contains a colon'
3040 - Author One
4192 - Author One
3041 - Author Two
4193 - Author Two
3042− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
3043 abstract: |
4195 abstract: |
3044 This is the abstract.
4196 This is the abstract.
3046 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
3049Template variables will be set automatically from the metadata. Thus, for
4207Template variables will be set automatically from the metadata. Thus, for
3050example, 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
3051equivalent of the Markdown in the `abstract` field:
4209equivalent of the Markdown in the `abstract` field:
@@ -3086,13 +4244,31 @@ the [`raw_attribute` extension](#extension-raw_attribute)), or it
3086will be interpreted as markdown. For example:
4244will be interpreted as markdown. For example:
3088 header-includes:
4246 header-includes:
3089− - ```{=latex}
4248+ ```{=latex}
3090 \let\oldsection\section
4249 \let\oldsection\section
3091 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
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
3094−Backslash escapes
4271+## Backslash escapes
3097#### Extension: `all_symbols_escapable` ####
4273#### Extension: `all_symbols_escapable` ####
@@ -3118,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
3118(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
3119will be used.)
4295will be used.)
3121−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,
3122−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
3123−`\ `.
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
3125A 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
3126a 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
@@ -3130,8 +4309,7 @@ two trailing spaces on a line.
3131Backslash escapes do not work in verbatim contexts.
4310Backslash escapes do not work in verbatim contexts.
3133−Inline formatting
4312+## Inline formatting
3136### Emphasis ###
4314### Emphasis ###
@@ -3179,12 +4357,13 @@ text by `~` characters. Thus, for example,
3180 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
3182−If the superscripted or subscripted text contains spaces, these spaces
4361+newlines. If the superscripted or subscripted text contains
3183−must be escaped with backslashes. (This is to prevent accidental
4362+spaces, these spaces must be escaped with backslashes. (This is
3184−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
3185−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
3186−`P~a\ cat~`, not `P~a cat~`.
4366+subscripts, use `P~a\ cat~`, not `P~a cat~`.
3189### Verbatim ###
4368### Verbatim ###
@@ -3233,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
3233This will work in all output formats that support small caps.
4412This will work in all output formats that support small caps.
3239#### Extension: `tex_math_dollars` ####
4417#### Extension: `tex_math_dollars` ####
@@ -3246,22 +4424,38 @@ left, and must not be followed immediately by a digit. Thus,
3246you need to enclose text in literal `$` characters, backslash-escape
4424you need to enclose text in literal `$` characters, backslash-escape
3247them 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.)
3249TeX 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
3250depends on the output format:
4432depends on the output format:
4435+ ~ It will appear verbatim surrounded by `\(...\)` (for inline
4436+ math) or `\[...\]` (for display math).
3252−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
4438+Markdown, Emacs Org mode, ConTeXt, ZimWiki
3253− ~ 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}}`.
3255reStructuredText
4445reStructuredText
3256 ~ It will be rendered using an [interpreted text role `:math:`].
4446 ~ It will be rendered using an [interpreted text role `:math:`].
3259− ~ 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.
3262 ~ It will be rendered inside a `@math` command.
4456 ~ It will be rendered inside a `@math` command.
3264−groff man
4458+roff man, Jira markup
3265 ~ It will be rendered verbatim without `$`'s.
4459 ~ It will be rendered verbatim without `$`'s.
3267MediaWiki, DokuWiki
4461MediaWiki, DokuWiki
@@ -3295,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
3295 command-line options selected. Therefore see [Math rendering in HTML]
4489 command-line options selected. Therefore see [Math rendering in HTML]
3298−[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
3300−Raw HTML
4494+## Raw HTML
3303#### Extension: `raw_html` ####
4496#### Extension: `raw_html` ####
@@ -3309,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
3309be disabled if desired.)
4502be disabled if desired.)
3311The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3312−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
4505+DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3313−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.
3315#### Extension: `markdown_in_html_blocks` ####
4517#### Extension: `markdown_in_html_blocks` ####
@@ -3327,7 +4529,7 @@ Thus, for example, pandoc will turn
3329 <td>*one*</td>
4531 <td>*one*</td>
3330− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
3332 </table>
4534 </table>
@@ -3336,14 +4538,14 @@ into
3338 <td><em>one</em></td>
4540 <td><em>one</em></td>
3339− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
3341 </table>
4543 </table>
3343whereas `Markdown.pl` will preserve it as is.
4545whereas `Markdown.pl` will preserve it as is.
3345−There is one exception to this rule: text between `<script>` and
4547+There is one exception to this rule: text between `<script>`,
3346−`<style>` tags is not interpreted as Markdown.
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3348This departure from standard Markdown should make it easier to mix
4550This departure from standard Markdown should make it easier to mix
3349Markdown with HTML block elements. For example, one can surround
4551Markdown with HTML block elements. For example, one can surround
@@ -3385,6 +4587,10 @@ Note that in LaTeX environments, like
3385the 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
3386LaTeX, 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`].
3388Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3389Emacs Org mode, and ConTeXt.
4595Emacs Org mode, and ConTeXt.
@@ -3395,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
3395Inline spans and fenced code blocks with a special
4601Inline spans and fenced code blocks with a special
3396kind of attribute will be parsed as raw content with the
4602kind of attribute will be parsed as raw content with the
3397designated format. For example, the following produces a raw
4603designated format. For example, the following produces a raw
3398−groff `ms` block:
4604+roff `ms` block:
3400 ```{=ms}
4606 ```{=ms}
3401 .MYMACRO
4607 .MYMACRO
@@ -3405,9 +4611,24 @@ And the following produces a raw `html` inline element:
3406 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"/>
3408The format name should match the target format name (see
4625The format name should match the target format name (see
3409`-t/--to`, above, for a list, or use `pandoc
4626`-t/--to`, above, for a list, or use `pandoc
3410−--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`).
3412This extension presupposes that the relevant kind of
4633This extension presupposes that the relevant kind of
3413inline code or fenced code block is enabled. Thus, for
4634inline code or fenced code block is enabled. Thus, for
@@ -3416,12 +4637,11 @@ example, to use a raw attribute with a backtick code block,
3417The raw attribute cannot be combined with regular attributes.
4638The raw attribute cannot be combined with regular attributes.
3419−LaTeX macros
4640+## LaTeX macros
3422#### Extension: `latex_macros` ####
4642#### Extension: `latex_macros` ####
3424−For output formats other than LaTeX, pandoc will parse LaTeX
4644+When this extension is enabled, pandoc will parse LaTeX
3425macro definitions and apply the resulting macros to all LaTeX
4645macro definitions and apply the resulting macros to all LaTeX
3426math and raw LaTeX. So, for example, the following will work in
4646math and raw LaTeX. So, for example, the following will work in
3427all output formats, not just LaTeX:
4647all output formats, not just LaTeX:
@@ -3431,18 +4651,20 @@ all output formats, not just LaTeX:
3431 $\tuple{a, b, c}$
4651 $\tuple{a, b, c}$
3433Note that LaTeX macros will not be applied if they occur
4653Note that LaTeX macros will not be applied if they occur
3434−inside inside a raw span or block marked with the
4654+inside a raw span or block marked with the
3435[`raw_attribute` extension](#extension-raw_attribute).
4655[`raw_attribute` extension](#extension-raw_attribute).
3437When `latex_macros` is disabled, the raw LaTeX and math will
4657When `latex_macros` is disabled, the raw LaTeX and math will
3438not have macros applied. This is usually a better approach when
4658not have macros applied. This is usually a better approach when
3439you are targeting LaTeX or PDF.
4659you are targeting LaTeX or PDF.
3441−Whether or not `latex_macros` is enabled, the macro definitions
3442−will still be passed through as raw LaTeX.
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
3447Markdown allows links to be specified in several ways.
4669Markdown allows links to be specified in several ways.
@@ -3451,7 +4673,7 @@ Markdown allows links to be specified in several ways.
3451If you enclose a URL or email address in pointy brackets, it
4673If you enclose a URL or email address in pointy brackets, it
3452will become a link:
4674will become a link:
3454− <http://google.com>
4676+ <https://google.com>
3455 <sam@green.eggs.ham>
4677 <sam@green.eggs.ham>
3457### Inline links ###
4679### Inline links ###
@@ -3461,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
3461be followed by a link title, in quotes.)
4683be followed by a link title, in quotes.)
3463 This is an [inline link](/url), and here's [one with
4685 This is an [inline link](/url), and here's [one with
3464− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
3466There 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.
3467The 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.
@@ -3490,7 +4712,7 @@ Here are some examples:
3491 [my label 1]: /foo/bar.html "My title, optional"
4713 [my label 1]: /foo/bar.html "My title, optional"
3492 [my label 2]: /foo
4714 [my label 2]: /foo
3493− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
3494 [my label 4]: /bar#special 'A title in single quotes'
4716 [my label 4]: /bar#special 'A title in single quotes'
3496The URL may optionally be surrounded by angle brackets:
4718The URL may optionally be surrounded by angle brackets:
@@ -3499,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
3500The title may go on the next line:
4722The title may go on the next line:
3502− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
3503 "The free software foundation"
4725 "The free software foundation"
3505Note that link labels are not case sensitive. So, this will work:
4727Note that link labels are not case sensitive. So, this will work:
@@ -3537,7 +4759,7 @@ be omitted entirely:
3537### Internal links ###
4759### Internal links ###
3539To link to another section of the same document, use the automatically
4761To link to another section of the same document, use the automatically
3540−generated identifier (see [Header identifiers]). For example:
4762+generated identifier (see [Heading identifiers]). For example:
3542 See the [Introduction](#introduction).
4764 See the [Introduction](#introduction).
@@ -3550,8 +4772,7 @@ or
3550Internal links are currently supported for HTML formats (including
4772Internal links are currently supported for HTML formats (including
3551HTML slide shows and EPUB), LaTeX, and ConTeXt.
4773HTML slide shows and EPUB), LaTeX, and ConTeXt.
3553−Images
4775+## Images
3556A link immediately preceded by a `!` will be treated as an image.
4777A link immediately preceded by a `!` will be treated as an image.
3557The link text will be used as the image's alt text:
4778The link text will be used as the image's alt text:
@@ -3562,215 +4783,574 @@ The link text will be used as the image's alt text:
3563 [movie reel]: movie.gif
4784 [movie reel]: movie.gif
3565−#### Extension: `implicit_figures` ####
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.
5129+#### Extension: `old_dashes` ####
5131+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5132+`-` before a numeral is an en-dash, and `--` is an em-dash.
5133+This option only has an effect if `smart` is enabled. It is
5134+selected automatically for `textile` input.
5136+#### Extension: `angle_brackets_escapable` ####
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`.
5142+#### Extension: `lists_without_preceding_blankline` ####
5144+Allow a list to occur right after a paragraph, with no intervening
5147+#### Extension: `four_space_rule` ####
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5153+#### Extension: `spaced_reference_links` ####
5155+Allow whitespace between the two components of a reference link,
5160+#### Extension: `hard_line_breaks` ####
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
5165+#### Extension: `ignore_line_breaks` ####
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.
3567−An image with nonempty alt text, occurring by itself in a
5172+#### Extension: `east_asian_line_breaks` ####
3568−paragraph, will be rendered as a figure with a caption. The
3569−image's alt text will be used as the caption.
3571− 
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.
3573−How this is rendered depends on the output format. Some output
5180+#### Extension: `emoji` ####
3574−formats (e.g. RTF) do not yet support figures. In those
3575−formats, you'll just get an image in a paragraph by itself, with
3578−If you just want a regular inline image, just make sure it is not
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
3579−the only thing in the paragraph. One way to do this is to insert a
3580−nonbreaking space after the image:
3582− \
5184+#### Extension: `tex_math_single_backslash` ####
3584−Note that in reveal.js slide shows, an image in a paragraph
5186+Causes anything between `\(` and `\)` to be interpreted as inline
3585−by itself that has the `stretch` class will fill the screen,
5187+TeX math, and anything between `\[` and `\]` to be interpreted
3586−and the caption and figure tags will be omitted.
5188+as display TeX math. Note: a drawback of this extension is that
5189+it precludes escaping `(` and `[`.
3588−#### Extension: `link_attributes` ####
5191+#### Extension: `tex_math_double_backslash` ####
3590−Attributes can be set on links and images:
5193+Causes anything between `\\(` and `\\)` to be interpreted as inline
5194+TeX math, and anything between `\\[` and `\\]` to be interpreted
5195+as display TeX math.
3592− An inline {#id .class width=30 height=20px}
5197+#### Extension: `markdown_attribute` ####
3593− and a reference ![image][ref] with attributes.
3595− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
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`.
3597−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
5203+#### Extension: `mmd_title_block` ####
3598−and `.class` are used.)
3600−For HTML and EPUB, all attributes except `width` and `height` (but
5205+Enables a [MultiMarkdown] style title block at the top of
3601−including `srcset` and `sizes`) are passed through as is. The other
5206+the document, for example:
3602−writers ignore attributes that are not supported by their output
3605−The `width` and `height` attributes on images are treated specially. When
5208+ Title: My title
3606−used without a unit, the unit is assumed to be pixels. However, any of
5209+ Author: John Doe
3607−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
5210+ Date: September 1, 2008
3608−and `%`. There must not be any spaces between the number and the unit.
5211+ Comment: This is a sample mmd title block, with
3609−For example:
5212+ a field spanning multiple lines.
3611−```
5214+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3612−{ width=50% }
5215+`yaml_metadata_block` is enabled, it will take precedence over
3613−```
5216+`mmd_title_block`.
3615−- Dimensions are converted to inches for output in page-based formats like
5218+#### Extension: `abbreviations` ####
3616− LaTeX. Dimensions are converted to pixels for output in HTML-like
3617− formats. Use the `--dpi` option to specify the number of pixels per
3618− inch. The default is 96dpi.
3619−- The `%` unit is generally relative to some available space.
3620− For example the above example will render to
3621− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3622− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3623− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3624−- Some output formats have a notion of a class
3625− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3626− or a unique identifier (LaTeX `\caption`), or both (HTML).
3627−- When no `width` or `height` attributes are specified, the fallback
3628− is to look at the image resolution and the dpi metadata embedded in
3631−Divs and Spans
5220+Parses PHP Markdown Extra abbreviation keys, like
3634−Using the `native_divs` and `native_spans` extensions
5222+ *[HTML]: Hypertext Markup Language
3635−(see [above][Extension: `native_divs`]), HTML syntax can
3636−be used as part of markdown to create native `Div` and `Span`
3637−elements in the pandoc AST (as opposed to raw HTML).
3638−However, there is also nicer syntax available:
3640−#### Extension: `fenced_divs` ####
5224+Note that the pandoc document model does not support
5225+abbreviations, so if this extension is enabled, abbreviation keys are
5226+simply skipped (as opposed to being parsed as paragraphs).
3642−Allow special fenced syntax for native `Div` blocks. A Div
5228+#### Extension: `autolink_bare_uris` ####
3643−starts with a fence containing at least three consecutive
3644−colons plus some attributes. The attributes may optionally
3645−be followed by another string of consecutive colons.
3646−The attribute syntax is exactly as in fenced code blocks (see
3647−[Extension: `fenced_code_attributes`]). As with fenced
3648−code blocks, one can use either attributes in curly braces
3649−or a single unbraced word, which will be treated as a class
3650−name. The Div ends with another line containing a string of at
3651−least three consecutive colons. The fenced Div should be
3652−separated by blank lines from preceding and following blocks.
3654−Example:
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
3656− ::::: {#special .sidebar}
5233+#### Extension: `mmd_link_attributes` ####
3657− Here is a paragraph.
3659− And another.
5235+Parses multimarkdown style key-value attributes on link
3660− :::::
5236+and image references. This extension should not be confused with the
5237+[`link_attributes`](#extension-link_attributes) extension.
3662−Fenced divs can be nested. Opening fences are distinguished
5239+ This is a reference ![image][ref] with multimarkdown attributes.
3663−because they *must* have attributes:
3665− ::: Warning ::::::
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
3666− This is a warning.
5242+ id=myId class="myClass1 myClass2"
3668− ::: Danger
5244+#### Extension: `mmd_header_identifiers` ####
3669− This is a warning within a warning.
3673−Fences without attributes are always closing fences. Unlike
5246+Parses multimarkdown style heading identifiers (in square brackets,
3674−with fenced code blocks, the number of colons in the closing
5247+after the heading but before any trailing `#`s in an ATX heading).
3675−fence need not match the number in the opening fence. However,
3676−it can be helpful for visual clarity to use fences of different
3677−lengths to distinguish nested divs from their parents.
5249+#### Extension: `compact_definition_lists` ####
3680−#### Extension: `bracketed_spans` ####
5251+Activates the definition list syntax of pandoc 1.12.x and earlier.
5252+This syntax differs from the one described above under [Definition lists]
5253+in several respects:
3682−A bracketed sequence of inlines, as one would use to begin
5255+ - No blank line is required between consecutive items of the
3683−a link, will be treated as a `Span` with attributes if it is
5256+ definition list.
3684−followed immediately by attributes:
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]
3686− [This is *some text*]{.class key="val"}
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
3689−---------
5267+ : definition
3691−#### Extension: `footnotes` ####
5271+ Is this a single list item with two definitions of "bar," the first of
5272+ which is lazily wrapped, or two list items? To remove the ambiguity
5273+ we must either disallow lazy wrapping or require a blank line between
3693−Pandoc's Markdown allows footnotes, using the following syntax:
5276+#### Extension: `gutenberg` ####
3695− Here is a footnote reference,[^1] and another.[^longnote]
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.
3697− [^1]: Here is the footnote.
5282+ [Project Gutenberg]: https://www.gutenberg.org
3699− [^longnote]: Here's one with multiple blocks.
5284+#### Extension: `sourcepos` ####
3701− Subsequent paragraphs are indented to show that they
5286+Include source position attributes when parsing `commonmark`.
3702− belong to the previous footnote.
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.
3704− { some.code }
5291+## Markdown variants
3706− The whole paragraph can be indented, or just the first
5293+In addition to pandoc's extended Markdown, the following Markdown
3707− line. In this way, multi-paragraph footnotes work like
5294+variants are supported:
3708− multi-paragraph list items.
3710− This paragraph won't be part of the note, because it
5296+- `markdown_phpextra` (PHP Markdown Extra)
3711− isn't indented.
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
3713−The identifiers in footnote references may not contain spaces, tabs,
5304+To see which extensions are supported for a given format,
3714−or newlines. These identifiers are used only to correlate the
5305+and which are enabled by default, you can use the command
3715−footnote reference with the note itself; in the output, footnotes
3716−will be numbered sequentially.
3718−The footnotes themselves need not be placed at the end of the
5307+ pandoc --list-extensions=FORMAT
3719−document. They may appear anywhere except inside other block elements
3720−(lists, block quotes, tables, etc.). Each footnote should be
3721−separated from surrounding content (including other footnotes)
3724−#### Extension: `inline_notes` ####
5309+where `FORMAT` is replaced with the name of the format.
3726−Inline footnotes are also allowed (though, unlike regular notes,
5311+Note that the list of extensions for `commonmark`,
3727−they cannot contain multiple paragraphs). The syntax is as follows:
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.
3729− Here is an inline note.^[Inlines notes are easier to write, since
5317+# Citations
3730− you don't have to pick an identifier and move down to type the
3733−Inline and regular footnotes may be mixed freely.
5319+When the `--citeproc` option is used, pandoc can automatically generate
5320+citations and a bibliography in a number of styles. Basic usage is
3735−Citations
5322+ pandoc --citeproc myinput.txt
3738−#### Extension: `citations` ####
5324+To use this feature, you will need to have
3740−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
5326+- a document containing citations (see [Extension: `citations`]);
3741−citations and a bibliography in a number of styles. Basic usage is
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.
3743− pandoc --filter pandoc-citeproc myinput.txt
5331+## Specifying bibliographic data
3745−In order to use this feature, you will need to specify a bibliography file
5333+You can specify an external bibliography using the
3746−using the `bibliography` metadata field in a YAML metadata section, or
5334+`bibliography` metadata field in a YAML metadata section or the
3747−`--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
3748−arguments or set `bibliography` metadata field to YAML array, if you want to
5337+`--bibliography` arguments or set `bibliography` metadata field
3749−use multiple bibliography files. The bibliography may have any of these
5338+to YAML array. A bibliography may have any of these formats:
3752 Format File extension
5340 Format File extension
3753 ------------ --------------
5341 ------------ --------------
3754 BibLaTeX .bib
5342 BibLaTeX .bib
3755 BibTeX .bibtex
5343 BibTeX .bibtex
3757 CSL JSON .json
5344 CSL JSON .json
3758 CSL YAML .yaml
5345 CSL YAML .yaml
3766Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3767−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
3769−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3770−can produce `.json` and `.yaml` files from any of the supported formats.
3772−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
3773−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
3775`<i>...</i>`
5355`<i>...</i>`
3776: italics
5356: italics
@@ -3790,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
3790`<span class="nocase">...</span>`
5370`<span class="nocase">...</span>`
3791: prevent a phrase from being capitalized as title case
5371: prevent a phrase from being capitalized as title case
3793−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3794−and CSL YAML formats as far as possible.
3796−As an alternative to specifying a bibliography file using `--bibliography`
5373+As an alternative to specifying a bibliography file using
3797−or the YAML metadata field `bibliography`, you can include
5374+`--bibliography` or the YAML metadata field `bibliography`, you
3798−the citation data directly in the `references` field of the
5375+can include the citation data directly in the `references` field
3799−document's YAML metadata. The field should contain an array of
5376+of the document's YAML metadata. The field should contain an
3800−YAML-encoded references, for example:
5377+array of YAML-encoded references, for example:
3803 references:
5380 references:
@@ -3813,322 +5390,273 @@ YAML-encoded references, for example:
3813 - - 1953
5390 - - 1953
3816− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
5393+ title: 'Molecular structure of nucleic acids: a structure for
3817− nucleic acid'
5394+ deoxyribose nucleic acid'
3818 title-short: Molecular structure of nucleic acids
5395 title-short: Molecular structure of nucleic acids
3819 container-title: Nature
5396 container-title: Nature
3820 volume: 171
5397 volume: 171
3821 issue: 4356
5398 issue: 4356
3822 page: 737-738
5399 page: 737-738
3823 DOI: 10.1038/171737a0
5400 DOI: 10.1038/171737a0
3824− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
3825 language: en-GB
5402 language: en-GB
3828−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
5405+If both an external bibliography and inline (YAML metadata)
3829−of the supported formats.)
5406+references are provided, both will be used. In case of
3830−
5407+conflicting `id`s, the inline references will take precedence.
3831−Citations and references can be formatted using any style supported by the
3832−[Citation Style Language], listed in the [Zotero Style Repository].
3833−These files are specified using the `--csl` option or the `csl` metadata field.
3834−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3835−format. The CSL project provides further information on [finding and editing styles].
3837−To make your citations hyperlinks to the corresponding bibliography
3838−entries, add `link-citations: true` to your YAML metadata.
3840−Citations go inside square brackets and are separated by semicolons.
3841−Each citation must have a key, composed of '@' + the citation
3842−identifier from the database, and may optionally have a prefix,
3843−a locator, and a suffix. The citation key must begin with a letter, digit,
3844−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3845−characters (`:.#$%&-+?<>~/`). Here are some examples:
3847− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3849− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3851− Blah blah [@smith04; @doe99].
3853−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3854−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3855−locale, locator terms can be written in either singular or plural forms,
3856−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3857−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3858−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3859−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3860−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3861−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3862−locator term is used, "page" is assumed.
3864−A minus sign (`-`) before the `@` will suppress mention of
3865−the author in the citation. This can be useful when the
3866−author is already mentioned in the text:
3868− Smith says blah [-@smith04].
3870−You can also write an in-text citation, as follows:
3872− @smith04 says blah.
3874− @smith04 [p. 33] says blah.
3876−If the style calls for a list of works cited, it will be placed
3877−at the end of the document. Normally, you will want to end your
3878−document with an appropriate header:
3884−The bibliography will be inserted after this header. Note that
5409+Note that `pandoc` can be used to produce such a YAML metadata
3885−the `unnumbered` class will be added to this header, so that the
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
3886−section will not be numbered.
3888−If you want to include items in the bibliography without actually
3889−citing them in the body text, you can define a dummy `nocite` metadata
3890−field and put the citations there:
3892− ---
5412+ pandoc chem.bib -s -f biblatex -t markdown
3893− nocite: |
5413+ pandoc chem.json -s -f csljson -t markdown
3897− @item3
5415+Indeed, `pandoc` can convert between any of these
3899−In this example, the document will contain a citation for `item3`
5418+ pandoc chem.bib -s -f biblatex -t csljson
3900−only, but the bibliography will contain entries for `item1`, `item2`, and
5419+ pandoc chem.yaml -s -f markdown -t biblatex
3903−It is possible to create a bibliography with all the citations,
5421+Running pandoc on a bibliography file with the `--citeproc`
3904−whether or not they appear in the document, by using a wildcard:
5422+option will create a formatted bibliography in the format
3906− ---
5425+ pandoc chem.bib -s --citeproc -o chem.html
3907− nocite: |
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
3911−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
5428+### Capitalization in titles
3912−to render bibliography. In order to do so, specify bibliography files as
3913−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3914−invocation. Bear in mind that bibliography files have to be in respective
3915−format (either BibTeX or BibLaTeX).
3917−For more information, see the [pandoc-citeproc man page].
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
3919−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5433+ - English titles should be in title case. Non-English titles should
3920−[Chicago Manual of Style]: http://chicagomanualofstyle.org
5434+ be in sentence case, and the `langid` field in biblatex should be
3921−[Citation Style Language]: http://citationstyles.org
5435+ set to the relevant language. (The following values are treated
3922−[Zotero Style Repository]: https://www.zotero.org/styles
5436+ as English: `american`, `british`, `canadian`, `english`,
3923−[finding and editing styles]: http://citationstyles.org/styles/
5437+ `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
3924−[CSL locale files]: https://github.com/citation-style-language/locales
3925−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
3927−Non-pandoc extensions
5439+ - As is standard with bibtex/biblatex, proper names should be
3928−---------------------
5440+ protected with curly braces so that they won't be lowercased
5441+ in styles that call for sentence case. For example:
3930−The following Markdown syntax extensions are not enabled by default
5443+ title = {My Dinner with {Andre}}
3931−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3932−name, where `EXTENSION` is the name of the extension. Thus, for
3933−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
3935−#### Extension: `old_dashes` ####
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
3937−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
3938−`-` before a numeral is an en-dash, and `--` is an em-dash.
3939−This option only has an effect if `smart` is enabled. It is
3940−selected automatically for `textile` input.
3942−#### Extension: `angle_brackets_escapable` ####
5450+ Though this is not necessary in bibtex/biblatex, it is necessary
5451+ with citeproc, which stores titles internally in sentence case,
5452+ and converts to title case in styles that require it. Here we
5453+ protect "nm" so that it doesn't get converted to "Nm" at this stage.
3944−Allow `<` and `>` to be backslash-escaped, as they can be in
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
3945−GitHub flavored Markdown but not original Markdown. This is
5456+the following rules:
3946−implied by pandoc's default `all_symbols_escapable`.
3948−#### Extension: `lists_without_preceding_blankline` ####
5458+ - All titles should be in sentence case.
3950−Allow a list to occur right after a paragraph, with no intervening
5460+ - Use the `language` field for non-English titles to prevent their
3951−blank space.
5461+ conversion to title case in styles that call for this. (Conversion
5462+ happens only if `language` begins with `en` or is left empty.)
3953−#### Extension: `four_space_rule` ####
5464+ - Protect words that should not be converted to title case using
3955−Selects the pandoc <= 2.0 behavior for parsing lists, so that
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
3956−four spaces indent are needed for list item continuation
3959−#### Extension: `spaced_reference_links` ####
5469+### Conference Papers, Published vs. Unpublished
3961−Allow whitespace between the two components of a reference link,
5471+For a formally published conference paper, use the biblatex entry type
3962−for example,
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
3964− [foo] [bar].
5474+For an unpublished manuscript, use the biblatex entry type
5475+`unpublished` without an `eventtitle` field (this entry type
5476+will be mapped to CSL `manuscript`).
3966−#### Extension: `hard_line_breaks` ####
5478+For a talk, an unpublished conference paper, or a poster
5479+presentation, use the biblatex entry type `unpublished` with an
5480+`eventtitle` field (this entry type will be mapped to CSL
5481+`speech`). Use the biblatex `type` field to indicate the type,
5482+e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5483+too, though `eventdate` will not be rendered by most CSL styles.
5484+Note that `venue` is for the event's venue, unlike `location`
5485+which describes the publisher's location; do not use the latter
5486+for an unpublished conference paper.
3968−Causes all newlines within a paragraph to be interpreted as hard line
3969−breaks instead of spaces.
3971−#### Extension: `ignore_line_breaks` ####
5489+## Specifying a citation style
3973−Causes newlines within a paragraph to be ignored, rather than being
5491+Citations and references can be formatted using any style supported by the
3974−treated as spaces or as hard line breaks. This option is intended for
5492+[Citation Style Language], listed in the [Zotero Style Repository].
3975−use with East Asian languages where spaces are not used between words,
5493+These files are specified using the `--csl` option or the `csl`
3976−but text is divided into lines for readability.
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
3978−#### Extension: `east_asian_line_breaks` ####
3980−Causes newlines within a paragraph to be ignored, rather than
5509+ { "default": {
3981−being treated as spaces or as hard line breaks, when they occur
5510+ "container-title": {
3982−between two East Asian wide characters. This is a better choice
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
3983−than `ignore_line_breaks` for texts that include a mix of East
5512+ "Estates Gazette": "EG",
3984−Asian wide characters and other characters.
5513+ "Scots Law Times": "SLT"
3986−#### Extension: `emoji` ####
3988−Parses textual emojis like `:smile:` as Unicode emoticons.
5519+## Citations in note styles
3990−#### Extension: `tex_math_single_backslash` ####
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
3992−Causes anything between `\(` and `\)` to be interpreted as inline
5528+ Blah blah [@foo, p. 33].
3993−TeX math, and anything between `\[` and `\]` to be interpreted
3994−as display TeX math. Note: a drawback of this extension is that
3995−it precludes escaping `(` and `[`.
3997−#### Extension: `tex_math_double_backslash` ####
5530+The footnote will be created automatically. Pandoc will take
5531+care of removing the space and moving the note before or
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
3999−Causes anything between `\\(` and `\\)` to be interpreted as inline
5536+In some cases you may need to put a citation inside a regular
4000−TeX math, and anything between `\\[` and `\\]` to be interpreted
5537+footnote. Normal citations in footnotes (such as `[@foo, p.
4001−as display TeX math.
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:
4003−#### Extension: `markdown_attribute` ####
5542+ [^1]: Some studies [@foo; @bar, p. 33] show that
5543+ frubulicious zoosnaps are quantical. For a survey
5544+ of the literature, see @baz [chap. 1].
4005−By default, pandoc interprets material inside block-level tags as Markdown.
5546+## Raw content in a style
4006−This extension changes the behavior so that Markdown is only parsed
4007−inside block-level tags if the tags have the attribute `markdown=1`.
4009−#### Extension: `mmd_title_block` ####
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
4011−Enables a [MultiMarkdown] style title block at the top of
5551+ {{jats}}<ref>{{/jats}}
4012−the document, for example:
4014− Title: My title
5553+Without the tags, the string will be interpreted as a string
4015− Author: John Doe
5554+and escaped in the output, rather than being passed through raw.
4016− Date: September 1, 2008
4017− Comment: This is a sample mmd title block, with
4018− a field spanning multiple lines.
4020−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5556+This feature allows stylesheets to be customized to give
4021−`yaml_metadata_block` is enabled, it will take precedence over
5557+different output for different output formats. However,
4022−`mmd_title_block`.
5558+stylesheets customized in this way will not be usable
5559+by other CSL implementations.
4024−#### Extension: `abbreviations` ####
4026−Parses PHP Markdown Extra abbreviation keys, like
4028− *[HTML]: Hypertext Markup Language
5563+## Placement of the bibliography
4030−Note that the pandoc document model does not support
5565+If the style calls for a list of works cited, it will be placed
4031−abbreviations, so if this extension is enabled, abbreviation keys are
5566+in a div with id `refs`, if one exists:
4032−simply skipped (as opposed to being parsed as paragraphs).
4034−#### Extension: `autolink_bare_uris` ####
5568+ ::: {#refs}
4036−Makes all absolute URIs into links, even when not surrounded by
5571+Otherwise, it will be placed at the end of the document.
4037−pointy braces `<...>`.
5572+Generation of the bibliography can be suppressed by setting
5573+`suppress-bibliography: true` in the YAML metadata.
4039−#### Extension: `mmd_link_attributes` ####
5575+If you wish the bibliography to have a section heading, you can
5576+set `reference-section-title` in the metadata, or put the heading
5577+at the beginning of the div with id `refs` (if you are using it)
5578+or at the end of your document:
4041−Parses multimarkdown style key-value attributes on link
5580+ last paragraph...
4042−and image references. This extension should not be confused with the
4043−[`link_attributes`](#extension-link_attributes) extension.
4045− This is a reference ![image][ref] with multimarkdown attributes.
5582+ # References
4047− [ref]: http://path.to/image "Image title" width=20px height=30px
5584+The bibliography will be inserted after this heading. Note that
4048− id=myId class="myClass1 myClass2"
5585+the `unnumbered` class will be added to this heading, so that the
5586+section will not be numbered.
4050−#### Extension: `mmd_header_identifiers` ####
5588+## Including uncited items in the bibliography
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:
4052−Parses multimarkdown style header identifiers (in square brackets,
5594+ ---
4053−after the header but before any trailing `#`s in an ATX header).
5595+ nocite: |
4055−#### Extension: `compact_definition_lists` ####
5599+ @item3
4057−Activates the definition list syntax of pandoc 1.12.x and earlier.
5601+In this example, the document will contain a citation for `item3`
4058−This syntax differs from the one described above under [Definition lists]
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
4059−in several respects:
5603+`item3`.
4061− - No blank line is required between consecutive items of the
5605+It is possible to create a bibliography with all the citations,
4062− definition list.
5606+whether or not they appear in the document, by using a wildcard:
4063− - To get a "tight" or "compact" list, omit space between consecutive
4064− items; the space between a term and its definition does not affect
4066− - Lazy wrapping of paragraphs is not allowed: the entire definition must
4067− be indented four spaces.[^6]
4069−[^6]: To see why laziness is incompatible with relaxing the requirement
5608+ ---
4070− of a blank line between items, consider the following example:
5609+ nocite: |
4072− bar
5613+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4073− : definition
5614+render the bibliography. In order to do so, specify bibliography
4074− foo
5615+files as outlined above, and add `--natbib` or `--biblatex`
4075− : 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.
4077− Is this a single list item with two definitions of "bar," the first of
5620+## Other relevant metadata fields
4078− which is lazily wrapped, or two list items? To remove the ambiguity
4079− we must either disallow lazy wrapping or require a blank line between
4082−Markdown variants
5622+A few other metadata fields affect bibliography formatting:
4085−In addition to pandoc's extended Markdown, the following Markdown
5624+`link-citations`
4086−variants are supported:
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
4088−`markdown_phpextra` (PHP Markdown Extra)
5629+`lang`
4089−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5630+: The `lang` field will affect how the style is localized,
4090− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5631+ for example in the translation of labels, the use
4091− `header_attributes`, `link_attributes`, `abbreviations`,
5632+ of quotation marks, and the way items are sorted.
4092− `shortcut_reference_links`, `spaced_reference_links`.
5633+ (For backwards compatibility, `locale` may be used instead
4093−
5634+ of `lang`, but this use is deprecated.)
4094−`markdown_github` (deprecated GitHub-Flavored Markdown)
5635+
4095−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
5636+ A BCP 47 language tag is expected: for example, `en`,
4096− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
5637+ `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
4097− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
5638+ syntax (after `-u-`) may be used to specify options for
4098− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
5639+ collation (sorting) more precisely. Here are some examples:
4099− `lists_without_preceding_blankline`.
5640+
4100−
5641+ - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
4101−`markdown_mmd` (MultiMarkdown)
5642+ - `es-u-co-trad` -- Spanish with the traditional collation
4102−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5643+ (with `Ch` sorting after `C`).
4103− `tex_math_double_backslash`, `intraword_underscores`,
5644+ - `fr-u-kb` -- French with "backwards" accent sorting
4104− `mmd_title_block`, `footnotes`, `definition_lists`,
5645+ (with `coté` sorting after `côte`).
4105− `all_symbols_escapable`, `implicit_header_references`,
5646+ - `en-US-u-kf-upper` -- English with uppercase letters sorting
4106− `auto_identifiers`, `mmd_header_identifiers`,
5647+ before lower (default is lower before upper).
4107− `shortcut_reference_links`, `implicit_figures`,
5648+
4108− `superscript`, `subscript`, `backtick_code_blocks`,
5649+`notes-after-punctuation`
4109− `spaced_reference_links`, `raw_attribute`.
5650+: If true (the default), pandoc will put footnote citations
4110−
5651+ after following punctuation. For example, if the source
4111−`markdown_strict` (Markdown.pl)
5652+ contains `blah blah [@jones99].`, the result will look like
4112−: `raw_html`, `shortcut_reference_links`,
5653+ `blah blah.[^1]`, with the note moved after the period and
4113− `spaced_reference_links`.
5654+ the space collapsed. If false, the space will still be
4114−
5655+ collapsed, but the footnote will not be moved after the
4115−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5656+ punctuation.
4116−which is implemented as a set of extensions on `commonmark`).
5657+
4118−Note, however, that `commonmark` and `gfm` have limited support
5659+# Slide shows
4119−for extensions. Only those listed below (and `smart` and
4120−`raw_tex`) will work. The extensions can, however, all be
4121−individually disabled.
4122−Also, `raw_tex` only affects `gfm` output, not input.
4124−`gfm` (GitHub-Flavored Markdown)
4125−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4126− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4127− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4128− `shortcut_reference_links`, `angle_brackets_escapable`.
4130−Producing slide shows with pandoc
4131−=================================
4133You can use pandoc to produce an HTML + JavaScript slide presentation
5661You can use pandoc to produce an HTML + JavaScript slide presentation
4134that 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,
@@ -4176,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
4177where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
4179−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
4180−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5708+pandoc with the `-s/--standalone` option embeds a link to
4181−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5709+JavaScript and CSS files, which are assumed to be available at
4182−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5710+the relative path `s5/default` (for S5), `slideous` (for
4183−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
4184−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
4185−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
4186−the file by default.
5714+variables; see [Variables for HTML slides], above.) For
4187−
5715+DZSlides, the (relatively short) JavaScript and CSS are included
4188−With all HTML slide formats, the `--self-contained` option can be used to
5716+in the file by default.
4189−produce a single file that contains all of the data necessary to display the
5717+
4190−slide show, including linked scripts, stylesheets, images, and videos.
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
4192To produce a PDF slide show using beamer, type
5723To produce a PDF slide show using beamer, type
@@ -4200,14 +5731,13 @@ To produce a Powerpoint slide show, type
4201 pandoc habits.txt -o habits.pptx
5732 pandoc habits.txt -o habits.pptx
4203−Structuring the slide show
5734+## Structuring the slide show
4204−--------------------------
4206−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
4207the hierarchy that is followed immediately by content, and not another
5737the hierarchy that is followed immediately by content, and not another
4208−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
4209−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,
4210−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
4211the `--slide-level` option.
5741the `--slide-level` option.
4213The document is carved up into slides according to the following
5743The document is carved up into slides according to the following
@@ -4215,17 +5745,21 @@ rules:
4216 * A horizontal rule always starts a new slide.
5746 * A horizontal rule always starts a new slide.
4218− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
4220− * Headers *below* the slide level in the hierarchy create
5750+ * Headings *below* the slide level in the hierarchy create
4221− 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.)
4223− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
4224 "title slides," which just contain the section title
5758 "title slides," which just contain the section title
4225 and help to break the slide show into sections.
5759 and help to break the slide show into sections.
4226−
5760+ Non-slide content under these headings will be included
4227− * Content *above* the slide level will not appear in the slide
5761+ on the title slide (for HTML slide shows) or in a
4228− show.
5762+ subsequent slide with the same title (for beamer).
4230 * A title page is constructed automatically from the document's title
5764 * A title page is constructed automatically from the document's title
4231 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
@@ -4233,32 +5767,57 @@ rules:
4234These 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
4235you don't care about structuring your slides into sections and subsections,
5769you don't care about structuring your slides into sections and subsections,
4236−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
4237will 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
4238sections, as in the example above.
5772sections, as in the example above.
4240Note: 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
4241−layout will be produced, with level 1 headers building horizontally
5775+layout will be produced, with level-1 headings building horizontally
4242−and level 2 headers building vertically. It is not recommended that
5776+and level-2 headings building vertically. It is not recommended that
4243you use deeper nesting of section levels with reveal.js.
5777you use deeper nesting of section levels with reveal.js.
4245−Incremental lists
5779+## Incremental lists
4248By default, these writers produce lists that display "all at once."
5781By default, these writers produce lists that display "all at once."
4249If 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),
4250use 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
4251−default (that is, to display incrementally without the `-i` option and
5784+default, put it in a `div` block with class `incremental` or
4252−all at once with the `-i` option), put it in a block quote:
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
5808+incrementally without the `-i` option and all at once with the `-i`
4254 > - Eat spaghetti
5811 > - Eat spaghetti
4255 > - Drink wine
5812 > - Drink wine
4257−In this way incremental and nonincremental lists can be mixed in
5814+Both methods allow incremental and nonincremental lists to be mixed
4258−a single document.
5815+in a single document.
4260−Inserting pauses
5817+Note: Neither the `-i/--incremental` option nor any of the
4261−----------------
5818+methods described here currently works for PowerPoint output.
4263You can add "pauses" within a slide by including a paragraph containing
5822You can add "pauses" within a slide by including a paragraph containing
4264three dots, separated by spaces:
5823three dots, separated by spaces:
@@ -4271,8 +5830,9 @@ three dots, separated by spaces:
4272 content after the pause
5831 content after the pause
4274−Styling the slides
5833+Note: this feature is not yet implemented for PowerPoint output.
4275−------------------
5834+
5835+## Styling the slides
4277You 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
4278in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4297,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
4298 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
4300−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
4301(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4302−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
4303that affects slides is the `allowframebreaks` class, which sets the
5863that affects slides is the `allowframebreaks` class, which sets the
4304`allowframebreaks` option, causing multiple slides to be created
5864`allowframebreaks` option, causing multiple slides to be created
4305if the content overfills the frame. This is recommended especially for
5865if the content overfills the frame. This is recommended especially for
@@ -4307,8 +5867,7 @@ bibliographies:
4308 # References {.allowframebreaks}
5868 # References {.allowframebreaks}
4310−Speaker notes
5870+## Speaker notes
4313Speaker notes are supported in reveal.js and PowerPoint (pptx)
5872Speaker notes are supported in reveal.js and PowerPoint (pptx)
4314output. You can add notes to your Markdown document thus:
5873output. You can add notes to your Markdown document thus:
@@ -4329,8 +5888,7 @@ in handouts and presenter view.
4329Notes are not yet supported for other slide formats, but the notes
5888Notes are not yet supported for other slide formats, but the notes
4330will not appear on the slides themselves.
5889will not appear on the slides themselves.
4332−Columns
5891+## Columns
4335To put material in side by side columns, you can use a native
5893To put material in side by side columns, you can use a native
4336div container with class `columns`, containing two or more div
5894div container with class `columns`, containing two or more div
@@ -4345,12 +5903,46 @@ containers with class `column` and a `width` attribute:
4346 ::::::::::::::
5904 ::::::::::::::
4348−Frame attributes in beamer
5906+### Additional columns attributes in beamer
4349−--------------------------
5907+
5908+The div containers with classes `columns` and `column` can optionally have
5909+an `align` attribute.
5910+The class `columns` can optionally have a `totalwidth` attribute or an
5911+`onlytextwidth` class.
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.
5941+## Frame attributes in beamer
4351Sometimes it is necessary to add the LaTeX `[fragile]` option to
5943Sometimes it is necessary to add the LaTeX `[fragile]` option to
4352a frame in beamer (for example, when using the `minted` environment).
5944a frame in beamer (for example, when using the `minted` environment).
4353−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
4354introducing the slide:
5946introducing the slide:
4356 # Fragile slide {.fragile}
5948 # Fragile slide {.fragile}
@@ -4358,13 +5950,64 @@ introducing the slide:
4358All of the other frame attributes described in Section 8.1 of
5950All of the other frame attributes described in Section 8.1 of
4359the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4360`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4361−`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).
5974+In reveal.js's overview mode, the parallaxBackgroundImage will show up
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.
4363−Creating EPUBs with pandoc
6008+# EPUBs
4364−==========================
4366−EPUB Metadata
6010+## EPUB Metadata
4369EPUB metadata may be specified using the `--epub-metadata` option, but
6012EPUB metadata may be specified using the `--epub-metadata` option, but
4370if 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
@@ -4442,11 +6085,20 @@ The following fields are recognized:
4444 ~ 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.
4446`cover-image`
6098`cover-image`
4447 ~ A string value (path to cover image).
6099 ~ A string value (path to cover image).
4449−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
4450 ~ A string value (path to CSS stylesheet).
6102 ~ A string value (path to CSS stylesheet).
4452`page-progression-direction`
6104`page-progression-direction`
@@ -4463,32 +6115,200 @@ The following fields are recognized:
4463 - `binding`: `true`|`false` (default `true`)
6115 - `binding`: `true`|`false` (default `true`)
4464 - `scroll-axis`: `vertical`|`horizontal`|`default`
6116 - `scroll-axis`: `vertical`|`horizontal`|`default`
4466−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4467[`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
4469−Linked media
6121+## The `epub:type` attribute
4471−
6123+For `epub3` output, you can mark up the heading that corresponds to an EPUB
4472−By default, pandoc will download linked media (including audio and
6124+chapter using the [`epub:type` attribute][epub-type]. For example, to set
4473−video) and include it in the EPUB container, yielding a completely
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
6167+By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6168+`<video>` or `<source>` element present in the generated EPUB,
6169+and include it in the EPUB container, yielding a completely
4474self-contained EPUB. If you want to link to external media resources
6170self-contained EPUB. If you want to link to external media resources
4475instead, 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
4476with the `src` attribute. For example:
6172with the `src` attribute. For example:
4478 <audio controls="1">
6174 <audio controls="1">
4479− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
4480 data-external="1" type="audio/mpeg">
6176 data-external="1" type="audio/mpeg">
4481 </source>
6177 </source>
4482 </audio>
6178 </audio>
4484−Syntax highlighting
6180+# Jupyter notebooks
4485−===================
6181+
6182+When creating a [Jupyter notebook], pandoc will try to infer the
6183+notebook structure. Code blocks with the class `code` will be
6184+taken as code cells, and intervening content will be taken as
6185+Markdown cells. Attachments will automatically be created for
6186+images in Markdown cells. Metadata will be taken from the
6187+`jupyter` metadata field. For example:
6196+ display_name: Python 2
6203+ file_extension: ".py"
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.
6223+from IPython.display import HTML
6226+console.log("hello");
6234+This image  will be
6235+included as a cell attachment.
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:
6245+:::::: {.cell .markdown}
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6252+:::::: {.cell .code execution_count=1}
6257+::: {.output .stream .stdout}
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.
6305+# Syntax highlighting
4487Pandoc will automatically highlight syntax in [fenced code blocks] that
6307Pandoc will automatically highlight syntax in [fenced code blocks] that
4488are marked with a language name. The Haskell library [skylighting] is
6308are marked with a language name. The Haskell library [skylighting] is
4489−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
6309+used for highlighting. Currently highlighting is supported only for
4490−To see a list of language names that pandoc will recognize, type
6310+HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
4491−`pandoc --list-highlight-languages`.
6311+that pandoc will recognize, type `pandoc --list-highlight-languages`.
4493The color scheme can be selected using the `--highlight-style` option.
6313The color scheme can be selected using the `--highlight-style` option.
4494The default color scheme is `pygments`, which imitates the default color
6314The default color scheme is `pygments`, which imitates the default color
@@ -4496,15 +6316,80 @@ scheme used by the Python library pygments (though pygments is not actually
4496used to do the highlighting). To see a list of highlight styles,
6316used to do the highlighting). To see a list of highlight styles,
4497type `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).
4499To disable highlighting, use the `--no-highlight` option.
6337To disable highlighting, use the `--no-highlight` option.
4501[skylighting]: https://github.com/jgm/skylighting
6339[skylighting]: https://github.com/jgm/skylighting
4503−Custom Styles in Docx
6341+# Custom Styles
4504−=====================
6342+
6343+Custom styles can be used in the docx and ICML formats.
6347+By default, pandoc's docx and ICML output applies a predefined set of styles
6348+for blocks such as paragraphs and block quotes, and uses largely default
6349+formatting (italics, bold) for inlines. This will work for most
6350+purposes, especially alongside a `reference.docx` file. However, if you
6351+need to apply your own styles to blocks, or match a preexisting set of
6352+styles, pandoc allows you to define custom styles for blocks and text
6353+using `div`s and `span`s, respectively.
6355+If you define a `div` or `span` with the attribute `custom-style`,
6356+pandoc will apply your specified style to the contained elements (with
6357+the exception of elements whose function depends on a style, like
6358+headings, code blocks, block quotes, or links). So, for example, using
6359+the `bracketed_spans` syntax,
6361+ [Get out]{custom-style="Emphatically"}, he said.
6363+would produce a docx file with "Get out" styled with character
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6366+ Dickinson starts the poem simply:
6368+ ::: {custom-style="Poetry"}
6369+ | A Bird came down the Walk---
6370+ | He did not know I saw---
6373+would style the two contained lines with the `Poetry` paragraph style.
6375+For docx output, styles will be defined in the output file as inheriting
6376+from normal text, if the styles are not yet in your reference.docx.
6377+If they are already defined, pandoc will not alter the definition.
6379+This feature allows for greatest customization in conjunction with
6380+[pandoc filters]. If you want all paragraphs after block quotes to be
6381+indented, you can write a filter to apply the styles necessary. If you
6382+want all italics to be transformed to the `Emphasis` character style
6383+(perhaps to change their color), you can write a filter which will
6384+transform all italicized inlines to inlines within an `Emphasis`
6385+custom-style `span`.
6387+For docx output, you don't need to enable any extensions for
6388+custom styles to work.
6390+[pandoc filters]: https://pandoc.org/filters.html
4509The docx reader, by default, only reads those styles that it can
6394The docx reader, by default, only reads those styles that it can
4510convert into pandoc elements, either by direct conversion or
6395convert into pandoc elements, either by direct conversion or
@@ -4532,19 +6417,18 @@ Without the `+styles` extension:
4532And with the extension:
6417And with the extension:
4534 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
4535− ::: {custom-style="FirstParagraph"}
6420+
6421+ ::: {custom-style="First Paragraph"}
4536 This is some text.
6422 This is some text.
4539− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
4540− This is text with an
6426+ This is text with an [emphasized]{custom-style="Emphatic"} text style.
4541− *[[emphasized]{custom-style="Emphatic"}]{custom-style="Emphatic"}* text
6427+ And this is text with a [strengthened]{custom-style="Strengthened"}
4542− style. And this is text with a
4543− **[[strengthened]{custom-style="Strengthened"}]{custom-style="Strengthened"}**
4544 text style.
6428 text style.
4547− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
4548 > Here is a styled paragraph that inherits from Block Text.
6432 > Here is a styled paragraph that inherits from Block Text.
@@ -4552,75 +6436,85 @@ With these custom styles, you can use your input document as a
4552reference-doc while creating docx output (see below), and maintain the
6436reference-doc while creating docx output (see below), and maintain the
4553same styles in your input and output files.
6437same styles in your input and output files.
4555−Output
6439+# Custom writers
4558−By default, pandoc's docx output applies a predefined set of styles for
4559−blocks such as paragraphs and block quotes, and uses largely default
4560−formatting (italics, bold) for inlines. This will work for most
4561−purposes, especially alongside a `reference.docx` file. However, if you
4562−need to apply your own styles to blocks, or match a preexisting set of
4563−styles, pandoc allows you to define custom styles for blocks and text
4564−using `div`s and `span`s, respectively.
4566−If you define a `div` or `span` with the attribute `custom-style`,
4567−pandoc will apply your specified style to the contained elements. So,
4568−for example using the `bracketed_spans` syntax,
4570− [Get out]{custom-style="Emphatically"}, he said.
4572−would produce a docx file with "Get out" styled with character
4573−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4575− Dickinson starts the poem simply:
4577− ::: {custom-style="Poetry"}
4578− | A Bird came down the Walk---
4579− | He did not know I saw---
4582−would style the two contained lines with the `Poetry` paragraph style.
4584−If the styles are not yet in your reference.docx, they will be defined
4585−in the output file as inheriting from normal text. If they are already
4586−defined, pandoc will not alter the definition.
4588−This feature allows for greatest customization in conjunction with
4589−[pandoc filters]. If you want all paragraphs after block quotes to be
4590−indented, you can write a filter to apply the styles necessary. If you
4591−want all italics to be transformed to the `Emphasis` character style
4592−(perhaps to change their color), you can write a filter which will
4593−transform all italicized inlines to inlines within an `Emphasis`
4594−custom-style `span`.
4596−[pandoc filters]: http://pandoc.org/filters.html
4601−Pandoc can be extended with custom writers written in [lua]. (Pandoc
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
4602−includes a lua interpreter, so lua need not be installed separately.)
6442+includes a Lua interpreter, so Lua need not be installed separately.)
4604−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
4605in place of the output format. For example:
6445in place of the output format. For example:
4607 pandoc -t data/sample.lua
6447 pandoc -t data/sample.lua
4609−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
4610possible element in a pandoc document. To get a documented example
6450possible element in a pandoc document. To get a documented example
4611which you can modify according to your needs, do
6451which you can modify according to your needs, do
4613 pandoc --print-default-data-file sample.lua
6453 pandoc --print-default-data-file sample.lua
4615−[lua]: http://www.lua.org
6455+Note that custom writers have no default template. If you want
4616−
6456+to use `--standalone` with a custom writer, you will need to
4617−Authors
6457+specify a template manually using `--template` or add a new
4618−=======
6458+default template with the name
4619−
6459+`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
4620−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6460+subdirectory of your user data directory (see [Templates]).
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
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
4621under the [GPL], version 2 or greater. This software carries no
6514under the [GPL], version 2 or greater. This software carries no
4622warranty of any kind. (See COPYRIGHT for full copyright and
6515warranty of any kind. (See COPYRIGHT for full copyright and
4623warranty notices.) For a full list of contributors, see the file
6516warranty notices.) For a full list of contributors, see the file
4624AUTHORS.md in the pandoc source code.
6517AUTHORS.md in the pandoc source code.
4626−[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"