@@ -1,50 +1,34 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% December 27, 2017
1+---
2+title: Pandoc User's Guide
3+author: John MacFarlane
4+date: June 20, 2021
5+---
46
5−Synopsis
6−========
7+# Synopsis
78
89`pandoc` [*options*] [*input-file*]...
910
10−Description
11−===========
11+# Description
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
14−another, and a command-line tool that uses this library. It can read
15−[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
16−Markdown], [MultiMarkdown], and (subsets of) [Textile],
17−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki
18−markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],
19−[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],
20−[EPUB], [ODT], and [Word docx]; and it can write plain text, [Markdown],
21−[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],
22−[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]
23−\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],
24−[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],
25−[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock
26−markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27−[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
29−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
30−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,
31−`wkhtmltopdf`, `prince`, or `weasyprint` is installed.
32−
33−Pandoc's enhanced version of Markdown includes syntax for [footnotes],
34−[tables], flexible [ordered lists], [definition lists], [fenced code
35−blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
36−automatic tables of contents, embedded LaTeX [math], [citations], and
37−[Markdown inside HTML block elements][Extension:
38−`markdown_in_html_blocks`]. (These enhancements, described further under
39−[Pandoc's Markdown], can be disabled using the `markdown_strict` input
40−or output format.)
41−
42−In contrast to most existing tools for converting Markdown to HTML, which
43−use regex substitutions, pandoc has a modular design: it consists of a
44−set of readers, which parse text in a given format and produce a native
45−representation of the document, and a set of writers, which convert
14+another, and a command-line tool that uses this library.
15+
16+Pandoc can convert between numerous markup and word processing formats,
17+including, but not limited to, various flavors of [Markdown], [HTML],
18+[LaTeX] and [Word docx]. For the full lists of input and output formats,
19+see the `--from` and `--to` [options below][General options].
20+Pandoc can also produce [PDF] output: see [creating a PDF], below.
21+
22+Pandoc's enhanced version of Markdown includes syntax for [tables],
23+[definition lists], [metadata blocks], [footnotes], [citations], [math],
24+and much more. See below under [Pandoc's Markdown].
25+
26+Pandoc has a modular design: it consists of a set of readers, which parse
27+text in a given format and produce a native representation of the document
28+(an _abstract syntax tree_ or AST), and a set of writers, which convert
4629this native representation into a target format. Thus, adding an input
47−or output format requires only adding a reader or writer.
30+or output format requires only adding a reader or writer. Users can also
31+run custom [pandoc filters] to modify the intermediate AST.
4832
4933Because pandoc's intermediate representation of a document is less
5034expressive than many of the formats it converts between, one should
@@ -56,98 +40,33 @@ model. While conversions from pandoc's Markdown to all formats aspire
5640to be perfect, conversions from formats more expressive than pandoc's
5741Markdown can be expected to be lossy.
5842
59−[Markdown]: http://daringfireball.net/projects/markdown/
60−[CommonMark]: http://commonmark.org
61−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65−[S5]: http://meyerweb.com/eric/tools/s5/
66−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67−[Slideous]: http://goessner.net/articles/slideous/
68−[HTML]: http://www.w3.org/html/
69−[HTML5]: http://www.w3.org/TR/html5/
70−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71−[XHTML]: http://www.w3.org/TR/xhtml1/
72−[LaTeX]: http://latex-project.org
73−[`beamer`]: https://ctan.org/pkg/beamer
74−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75−[ConTeXt]: http://www.contextgarden.net/
76−[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77−[DocBook]: http://docbook.org
78−[JATS]: https://jats.nlm.nih.gov
79−[txt2tags]: http://txt2tags.org
80−[EPUB]: http://idpf.org/epub
81−[OPML]: http://dev.opml.org/spec2.html
82−[OpenDocument]: http://opendocument.xml.org
83−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
84−[Textile]: http://redcloth.org/textile
85−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
86−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
87−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
88−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
89−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
90−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
91−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
92−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
93−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
94−[Haskell]: https://www.haskell.org
95−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
96−[Emacs Org mode]: http://orgmode.org
97−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
98−[DZSlides]: http://paulrouget.com/dzslides/
99−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
100−[PDF]: https://www.adobe.com/pdf/
101−[reveal.js]: http://lab.hakim.se/reveal-js/
102−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
103−[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
104−[TEI Simple]: https://github.com/TEIC/TEI-Simple
105−[Muse]: https://amusewiki.org/library/manual
106−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
107−[Vimwiki]: https://vimwiki.github.io
108−
109−Using `pandoc`
110−--------------
43+## Using pandoc
11144
112−If no *input-file* is specified, input is read from *stdin*.
113−Otherwise, the *input-files* are concatenated (with a blank
114−line between each) and used as input. Output goes to *stdout* by
115−default (though output to the terminal is disabled for the
116−`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
117−forced using `-o -`). For output to a file, use the `-o`
118−option:
45+If no *input-files* are specified, input is read from *stdin*.
46+Output goes to *stdout* by default. For output to a file,
47+use the `-o` option:
11948
12049 pandoc -o output.html input.txt
12150
122−By default, pandoc produces a document fragment, not a standalone
123−document with a proper header and footer. To produce a standalone
124−document, use the `-s` or `--standalone` flag:
51+By default, pandoc produces a document fragment. To produce a standalone
52+document (e.g. a valid HTML file including `<head>` and `<body>`),
53+use the `-s` or `--standalone` flag:
12554
12655 pandoc -s -o output.html input.txt
12756
12857For more information on how standalone documents are produced, see
129−[Templates], below.
130−
131−Instead of a file, an absolute URI may be given. In this case
132−pandoc will fetch the content using HTTP:
133−
134− pandoc -f html -t markdown http://www.fsf.org
135−
136−It is possible to supply a custom User-Agent string or other
137−header when requesting a document from a URL:
138−
139− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
140− http://www.fsf.org
58+[Templates] below.
14159
14260If multiple input files are given, `pandoc` will concatenate them all (with
143−blank lines between them) before parsing. This feature is disabled for
144− binary input formats such as `EPUB`, `odt`, and `docx`.
61+blank lines between them) before parsing. (Use `--file-scope` to parse files
62+individually.)
63+
64+## Specifying formats
14565
14666The format of the input and output can be specified explicitly using
14767command-line options. The input format can be specified using the
148−`-r/--read` or `-f/--from` options, the output format using the
149−`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
150−Markdown to LaTeX, you could type:
68+`-f/--from` option, the output format using the `-t/--to` option.
69+Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
15170
15271 pandoc -f markdown -t latex hello.txt
15372
@@ -155,14 +74,15 @@ To convert `hello.html` from HTML to Markdown:
15574
15675 pandoc -f html -t markdown hello.html
15776
158−Supported output formats are listed below under the `-t/--to` option.
159−Supported input formats are listed below under the `-f/--from` option. Note
160−that the `rst`, `textile`, `latex`, and `html` readers are not complete;
161−there are some constructs that they do not parse.
77+Supported input and output formats are listed below under [Options]
78+(see `-f` for input formats and `-t` for output formats). You
79+can also use `pandoc --list-input-formats` and
80+`pandoc --list-output-formats` to print lists of supported
81+formats.
16282
16383If the input or output format is not specified explicitly, `pandoc`
164−will attempt to guess it from the extensions of
165−the input and output filenames. Thus, for example,
84+will attempt to guess it from the extensions of the filenames.
85+Thus, for example,
16686
16787 pandoc -o hello.tex hello.txt
16888
@@ -171,7 +91,9 @@ is specified (so that output goes to *stdout*), or if the output file's
17191extension is unknown, the output format will default to HTML.
17292If no input file is specified (so that input comes from *stdin*), or
17393if the input files' extensions are unknown, the input format will
174−be assumed to be Markdown unless explicitly specified.
94+be assumed to be Markdown.
95+
96+## Character encoding
17597
17698Pandoc uses the UTF-8 character encoding for both input and output.
17799If your local character encoding is not UTF-8, you
@@ -184,106 +106,167 @@ RTF, OPML, DocBook, and Texinfo), information about
184106the character encoding is included in the document header, which
185107will only be included if you use the `-s/--standalone` option.
186108
187−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
188110
189−Creating a PDF
190−--------------
111+## Creating a PDF
191112
192−To produce a PDF, specify an output file with a `.pdf` extension.
193−By default, pandoc will use LaTeX to create the PDF:
113+To produce a PDF, specify an output file with a `.pdf` extension:
194114
195115 pandoc test.txt -o test.pdf
196116
197−Production of a PDF requires that a LaTeX engine be installed (see
198−`--pdf-engine`, below), and assumes that the following LaTeX packages
199−are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
200−[`ifxetex`], [`ifluatex`], [`listings`] (if the
117+By default, pandoc will use LaTeX to create the PDF, which requires
118+that a LaTeX engine be installed (see `--pdf-engine` below).
119+Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120+intermediate format. To do this, specify an output file with a
121+`.pdf` extension, as before, but add the `--pdf-engine` option
122+or `-t context`, `-t html`, or `-t ms` to the command line.
123+The tool used to generate the PDF from the intermediate format
124+may be specified using `--pdf-engine`.
125+
126+You can control the PDF style using variables, depending on
127+the intermediate format used: see [variables for LaTeX],
128+[variables for ConTeXt], [variables for `wkhtmltopdf`],
129+[variables for ms]. When HTML is used as an intermediate
130+format, the output can be styled using `--css`.
131+
132+To debug the PDF creation, it can be useful to look at the intermediate
133+representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134+to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
135+
136+When using LaTeX, the following packages need to be available
137+(they are included with all recent versions of [TeX Live]):
138+[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139+[`iftex`], [`listings`] (if the
201140`--listings` option is used), [`fancyvrb`], [`longtable`],
202−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
203−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
204−`geometry` variable set), [`setspace`] (with `linestretch`), and
141+[`booktabs`], [`graphicx`] (if the document
142+contains images), [`hyperref`], [`xcolor`],
143+[`ulem`], [`geometry`] (with the `geometry` variable set),
144+[`setspace`] (with `linestretch`), and
205145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
206−the LaTeX engine requires [`fontspec`]. `xelatex` uses
207−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
208−`dir` variable set). If the `mathspec` variable is set,
209−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
210−The [`upquote`] and [`microtype`] packages are used if
211−available, and [`csquotes`] will be used for [typography]
212−if added to the template or included in any header file. The
213−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
214−optionally be used for [citation rendering]. These are included
215−with all recent versions of [TeX Live].
216−
217−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
218−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
219−[`weasyprint`] or [`prince`].
220−To do this, specify an output file with a `.pdf` extension, as before,
221−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
222−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
223−
224−PDF output can be controlled using [variables for LaTeX] (if
225−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
226−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
227−If `wkhtmltopdf` is used, then the variables `margin-left`,
228−`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
229−will affect the output.
230−
146+the PDF engine requires [`fontspec`]. `lualatex` uses
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151+packages are used if available, and [`csquotes`] will be used
152+for [typography] if the `csquotes` variable or metadata field is
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154+and [`biber`] packages can optionally be used for [citation
155+rendering]. The following packages will be used to improve
156+output quality if present, but pandoc does not require them to
157+be present: [`upquote`] (for straight quotes in verbatim
158+environments), [`microtype`] (for better spacing adjustments),
159+[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160+better line breaks in URLs), [`bookmark`] (for better PDF
161+bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162+footnotes in tables).
163+
164+[TeX Live]: https://www.tug.org/texlive/
231165[`amsfonts`]: https://ctan.org/pkg/amsfonts
232166[`amsmath`]: https://ctan.org/pkg/amsmath
233−[`lm`]: https://ctan.org/pkg/lm
234−[`ifxetex`]: https://ctan.org/pkg/ifxetex
235−[`ifluatex`]: https://ctan.org/pkg/ifluatex
236−[`listings`]: https://ctan.org/pkg/listings
237−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
238−[`longtable`]: https://ctan.org/pkg/longtable
167+[`babel`]: https://ctan.org/pkg/babel
168+[`biber`]: https://ctan.org/pkg/biber
169+[`biblatex`]: https://ctan.org/pkg/biblatex
170+[`bibtex`]: https://ctan.org/pkg/bibtex
171+[`bidi`]: https://ctan.org/pkg/bidi
172+[`bookmark`]: https://ctan.org/pkg/bookmark
239173[`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
240180[`graphicx`]: https://ctan.org/pkg/graphicx
241181[`grffile`]: https://ctan.org/pkg/grffile
242−[`geometry`]: https://ctan.org/pkg/geometry
243−[`setspace`]: https://ctan.org/pkg/setspace
244−[`xecjk`]: https://ctan.org/pkg/xecjk
245182[`hyperref`]: https://ctan.org/pkg/hyperref
246−[`ulem`]: https://ctan.org/pkg/ulem
247−[`babel`]: https://ctan.org/pkg/babel
248−[`bidi`]: https://ctan.org/pkg/bidi
183+[`iftex`]: https://ctan.org/pkg/iftex
184+[`listings`]: https://ctan.org/pkg/listings
185+[`lm`]: https://ctan.org/pkg/lm
186+[`longtable`]: https://ctan.org/pkg/longtable
249187[`mathspec`]: https://ctan.org/pkg/mathspec
250−[`unicode-math`]: https://ctan.org/pkg/unicode-math
251−[`polyglossia`]: https://ctan.org/pkg/polyglossia
252−[`fontspec`]: https://ctan.org/pkg/fontspec
253−[`upquote`]: https://ctan.org/pkg/upquote
254188[`microtype`]: https://ctan.org/pkg/microtype
255−[`csquotes`]: https://ctan.org/pkg/csquotes
256189[`natbib`]: https://ctan.org/pkg/natbib
257−[`biblatex`]: https://ctan.org/pkg/biblatex
258−[`bibtex`]: https://ctan.org/pkg/bibtex
259−[`biber`]: https://ctan.org/pkg/biber
260−[TeX Live]: http://www.tug.org/texlive/
261−[`wkhtmltopdf`]: https://wkhtmltopdf.org
262−[`weasyprint`]: http://weasyprint.org
190+[`parskip`]: https://ctan.org/pkg/parskip
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
263192[`prince`]: https://www.princexml.com/
193+[`setspace`]: https://ctan.org/pkg/setspace
194+[`ulem`]: https://ctan.org/pkg/ulem
195+[`unicode-math`]: https://ctan.org/pkg/unicode-math
196+[`upquote`]: https://ctan.org/pkg/upquote
197+[`weasyprint`]: https://weasyprint.org
198+[`wkhtmltopdf`]: https://wkhtmltopdf.org
199+[`xcolor`]: https://ctan.org/pkg/xcolor
200+[`xecjk`]: https://ctan.org/pkg/xecjk
201+[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
203+
204+
205+
206+## Reading from the Web
207+
208+Instead of an input file, an absolute URI may be given. In this case
209+pandoc will fetch the content using HTTP:
210+
211+ pandoc -f html -t markdown https://www.fsf.org
212+
213+It is possible to supply a custom User-Agent string or other
214+header when requesting a document from a URL:
215+
216+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217+ https://www.fsf.org
264218
265−Options
266−=======
219+# Options
267220
268−General options
269−---------------
221+## General options {.options}
270222
271223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
272224
273−: Specify input format. *FORMAT* can be `native` (native Haskell),
274− `json` (JSON version of native AST), `markdown` (pandoc's
275− extended Markdown), `markdown_strict` (original unextended
276− Markdown), `markdown_phpextra` (PHP Markdown Extra),
277− `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
278− `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
279− (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
280− (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
281− `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
282− markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
283− `haddock` (Haddock markup), or `latex` (LaTeX).
284− (`markdown_github` provides deprecated and less accurate support
285− for Github-Flavored Markdown; please use `gfm` instead, unless you
286− need to use extensions other than `smart`.)
225+: Specify input format. *FORMAT* can be:
226+
227+ ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
230+ - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
232+ - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
235+ - `docbook` ([DocBook])
236+ - `docx` ([Word docx])
237+ - `dokuwiki` ([DokuWiki markup])
238+ - `epub` ([EPUB])
239+ - `fb2` ([FictionBook2] e-book)
240+ - `gfm` ([GitHub-Flavored Markdown]),
241+ or the deprecated and less accurate `markdown_github`;
242+ use [`markdown_github`](#markdown-variants) only
243+ if you need extensions not supported in [`gfm`](#markdown-variants).
244+ - `haddock` ([Haddock markup])
245+ - `html` ([HTML])
246+ - `ipynb` ([Jupyter notebook])
247+ - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
249+ - `json` (JSON version of native AST)
250+ - `latex` ([LaTeX])
251+ - `markdown` ([Pandoc's Markdown])
252+ - `markdown_mmd` ([MultiMarkdown])
253+ - `markdown_phpextra` ([PHP Markdown Extra])
254+ - `markdown_strict` (original unextended [Markdown])
255+ - `mediawiki` ([MediaWiki markup])
256+ - `man` ([roff man])
257+ - `muse` ([Muse])
258+ - `native` (native Haskell)
259+ - `odt` ([ODT])
260+ - `opml` ([OPML])
261+ - `org` ([Emacs Org mode])
262+ - `rst` ([reStructuredText])
263+ - `t2t` ([txt2tags])
264+ - `textile` ([Textile])
265+ - `tikiwiki` ([TikiWiki markup])
266+ - `twiki` ([TWiki markup])
267+ - `vimwiki` ([Vimwiki])
268+ :::
269+
287270 Extensions can be individually enabled or disabled by
288271 appending `+EXTENSION` or `-EXTENSION` to the format name.
289272 See [Extensions] below, for a list of extensions and
@@ -292,35 +275,75 @@ General options
292275
293276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
294277
295−: Specify output format. *FORMAT* can be `native` (native Haskell),
296− `json` (JSON version of native AST), `plain` (plain text),
297− `markdown` (pandoc's extended Markdown), `markdown_strict`
298− (original unextended Markdown), `markdown_phpextra` (PHP Markdown
299− Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
300− Markdown), `commonmark` (CommonMark Markdown), `rst`
301− (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or
302− `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`
303− (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),
304− `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),
305− `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org
306− mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or
307− `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),
308− `opendocument` (OpenDocument), `odt` (OpenOffice text document),
309− `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
310− format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),
311− `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`
312− (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and
313− JavaScript slide show), `slideous` (Slideous HTML and JavaScript
314− slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
315− `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5
316− HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or
317− the path of a custom lua writer (see [Custom writers],
318− below). (`markdown_github` provides deprecated and less accurate
319− support for Github-Flavored Markdown; please use `gfm` instead,
320− unless you use extensions that do not work with `gfm`.) Note that
321− `odt`, `epub`, and `epub3` output will not be directed to
322− *stdout*; an output filename must be specified using the
323− `-o/--output` option. Extensions can be individually enabled or
278+: Specify output format. *FORMAT* can be:
279+
280+ ::: {#output-formats}
281+ - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282+ - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
285+ - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
287+ - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
289+ - `docbook` or `docbook4` ([DocBook] 4)
290+ - `docbook5` (DocBook 5)
291+ - `docx` ([Word docx])
292+ - `dokuwiki` ([DokuWiki markup])
293+ - `epub` or `epub3` ([EPUB] v3 book)
294+ - `epub2` (EPUB v2)
295+ - `fb2` ([FictionBook2] e-book)
296+ - `gfm` ([GitHub-Flavored Markdown]),
297+ or the deprecated and less accurate `markdown_github`;
298+ use [`markdown_github`](#markdown-variants) only
299+ if you need extensions not supported in [`gfm`](#markdown-variants).
300+ - `haddock` ([Haddock markup])
301+ - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302+ - `html4` ([XHTML] 1.0 Transitional)
303+ - `icml` ([InDesign ICML])
304+ - `ipynb` ([Jupyter notebook])
305+ - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306+ - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307+ - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308+ - `jats` (alias for `jats_archiving`)
309+ - `jira` ([Jira]/Confluence wiki markup)
310+ - `json` (JSON version of native AST)
311+ - `latex` ([LaTeX])
312+ - `man` ([roff man])
313+ - `markdown` ([Pandoc's Markdown])
314+ - `markdown_mmd` ([MultiMarkdown])
315+ - `markdown_phpextra` ([PHP Markdown Extra])
316+ - `markdown_strict` (original unextended [Markdown])
317+ - `mediawiki` ([MediaWiki markup])
318+ - `ms` ([roff ms])
319+ - `muse` ([Muse]),
320+ - `native` (native Haskell),
321+ - `odt` ([OpenOffice text document][ODT])
322+ - `opml` ([OPML])
323+ - `opendocument` ([OpenDocument])
324+ - `org` ([Emacs Org mode])
325+ - `pdf` ([PDF])
326+ - `plain` (plain text),
327+ - `pptx` ([PowerPoint] slide show)
328+ - `rst` ([reStructuredText])
329+ - `rtf` ([Rich Text Format])
330+ - `texinfo` ([GNU Texinfo])
331+ - `textile` ([Textile])
332+ - `slideous` ([Slideous] HTML and JavaScript slide show)
333+ - `slidy` ([Slidy] HTML and JavaScript slide show)
334+ - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
335+ - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336+ - `s5` ([S5] HTML and JavaScript slide show)
337+ - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
339+ - `zimwiki` ([ZimWiki markup])
340+ - the path of a custom Lua writer, see [Custom writers] below
341+ :::
342+
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
344+ to *stdout* unless forced with `-o -`.
345+
346+ Extensions can be individually enabled or
324347 disabled by appending `+EXTENSION` or `-EXTENSION` to the format
325348 name. See [Extensions] below, for a list of extensions and their
326349 names. See `--list-output-formats` and `--list-extensions`, below.
@@ -335,35 +358,43 @@ General options
335358
336359: Specify the user data directory to search for pandoc data files.
337360 If this option is not specified, the default user data directory
338− will be used. This is, in UNIX:
339−
340− $HOME/.pandoc
341−
342− in Windows XP:
343−
344− C:\Documents And Settings\USERNAME\Application Data\pandoc
345−
346− and in Windows Vista or later:
347−
348− C:\Users\USERNAME\AppData\Roaming\pandoc
349−
361+ will be used. On \*nix and macOS systems this will be the `pandoc`
362+ subdirectory of the XDG data directory (by default,
363+ `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364+ environment variable). If that directory does not exist and
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366+ On Windows the default user data directory is
367+ `C:\Users\USERNAME\AppData\Roaming\pandoc`.
350368 You can find the default user data directory on your system by
351369 looking at the output of `pandoc --version`.
352− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
353− `slidy`, `slideous`, or `s5` directory
354− placed in this directory will override pandoc's normal defaults.
370+ Data files placed in this directory (for example, `reference.odt`,
371+ `reference.docx`, `epub.css`, `templates`) will override
372+ pandoc's normal defaults.
373+
374+`-d` *FILE*, `--defaults=`*FILE*
375+
376+: Specify a set of default option settings. *FILE* is a YAML
377+ file whose fields correspond to command-line option
378+ settings. All options for document conversion, including input
379+ and output files, can be set using a defaults file. The file will
380+ be searched for first in the working directory, and then in
381+ the `defaults` subdirectory of the user data directory
382+ (see `--data-dir`). The `.yaml` extension may be omitted.
383+ See the section [Default files] for more information on the
384+ file format. Settings from the defaults file may be
385+ overridden or extended by subsequent options on the command
386+ line.
355387
356388`--bash-completion`
357389
358390: Generate a bash completion script. To enable bash completion
359391 with pandoc, add this to your `.bashrc`:
360392
361− eval "$(pandoc --bash-completion)"
393+ eval "$(pandoc --bash-completion)"
362394
363395`--verbose`
364396
365−: Give verbose debugging output. Currently this only has an effect
366− with PDF output.
397+: Give verbose debugging output.
367398
368399`--quiet`
369400
@@ -389,9 +420,10 @@ General options
389420
390421`--list-extensions`[`=`*FORMAT*]
391422
392−: List supported Markdown extensions, one per line, followed
423+: List supported extensions for *FORMAT*, one per line, preceded
393424 by a `+` or `-` indicating whether it is enabled by default
394− in *FORMAT* (defaulting to pandoc's Markdown).
425+ in *FORMAT*. If *FORMAT* is not specified, defaults for
426+ pandoc's Markdown are given.
395427
396428`--list-highlight-languages`
397429
@@ -411,12 +443,88 @@ General options
411443
412444: Show usage message.
413445
414−Reader options
415−--------------
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
448+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450+[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451+[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452+[S5]: https://meyerweb.com/eric/tools/s5/
453+[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454+[Slideous]: https://goessner.net/articles/slideous/
455+[HTML]: https://www.w3.org/html/
456+[HTML5]: https://html.spec.whatwg.org/
457+[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
460+[`beamer`]: https://ctan.org/pkg/beamer
461+[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462+[ConTeXt]: https://www.contextgarden.net/
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464+[DocBook]: https://docbook.org
465+[JATS]: https://jats.nlm.nih.gov
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
468+[EPUB]: http://idpf.org/epub
469+[OPML]: http://dev.opml.org/spec2.html
470+[OpenDocument]: http://opendocument.xml.org
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
473+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476+[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481+[CSV]: https://tools.ietf.org/html/rfc4180
482+[roff man]: https://man.cx/groff_man(7)
483+[roff ms]: https://man.cx/groff_ms(7)
484+[Haskell]: https://www.haskell.org
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486+[Emacs Org mode]: https://orgmode.org
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488+[AsciiDoctor]: https://asciidoctor.org/
489+[DZSlides]: https://paulrouget.com/dzslides/
490+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491+[PDF]: https://www.adobe.com/pdf/
492+[reveal.js]: https://revealjs.com/
493+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494+[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495+[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496+[TEI Simple]: https://github.com/TEIC/TEI-Simple
497+[Muse]: https://amusewiki.org/library/manual
498+[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499+[Vimwiki]: https://vimwiki.github.io
500+[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501+[BibTeX]: https://ctan.org/pkg/bibtex
502+[BibLaTeX]: https://ctan.org/pkg/biblatex
503+
504+## Reader options {.options}
505+
506+`--shift-heading-level-by=`*NUMBER*
507+
508+: Shift heading levels by a positive or negative integer.
509+ For example, with `--shift-heading-level-by=-1`, level 2
510+ headings become level 1 headings, and level 3 headings
511+ become level 2 headings. Headings cannot have a level
512+ less than 1, so a heading that would be shifted below level 1
513+ becomes a regular paragraph. Exception: with a shift of -N,
514+ a level-N heading at the beginning of the document
515+ replaces the metadata title. `--shift-heading-level-by=-1`
516+ is a good choice when converting HTML or Markdown documents that
517+ use an initial level-1 heading for the document title and
518+ level-2+ headings for sections. `--shift-heading-level-by=1`
519+ may be a good choice for converting Markdown documents that
520+ use level-1 headings for sections to HTML, since pandoc uses
521+ a level-1 heading to render the document title.
416522
417523`--base-header-level=`*NUMBER*
418524
419−: Specify the base level for headers (defaults to 1).
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
526+ where X = NUMBER - 1.* Specify the base level for headings
527+ (defaults to 1).
420528
421529`--strip-empty-paragraphs`
422530
@@ -446,7 +554,7 @@ Reader options
446554 footnotes and links will not work across files. Reading binary
447555 files (docx, odt, epub) implies `--file-scope`.
448556
449−`--filter=`*PROGRAM*
557+`-F` *PROGRAM*, `--filter=`*PROGRAM*
450558
451559: Specify an executable to be used as a filter transforming the
452560 pandoc AST after the input is parsed and before the output is
@@ -481,47 +589,65 @@ Reader options
481589
482590 3. `$PATH` (executable only)
483591
484−`--lua-filter=`*SCRIPT*
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
594+
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
485596
486597: Transform the document in a similar fashion as JSON filters (see
487− `--filter`), but use pandoc's build-in lua filtering system. The given
488− lua script is expected to return a list of lua filters which will be
489− applied in order. Each lua filter must contain element-transforming
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
599+ Lua script is expected to return a list of Lua filters which will be
600+ applied in order. Each Lua filter must contain element-transforming
490601 functions indexed by the name of the AST element on which the filter
491602 function should be applied.
492603
493− The `pandoc` lua module provides helper functions for element
494− creation. It is always loaded into the script's lua environment.
604+ The `pandoc` Lua module provides helper functions for element
605+ creation. It is always loaded into the script's Lua environment.
606+
607+ See the [Lua filters documentation] for further details.
495608
496− The following is an example lua script for macro-expansion:
609+ In order of preference, pandoc will look for Lua filters in
497610
498− function expand_hello_world(inline)
499− if inline.c == '{{helloworld}}' then
500− return pandoc.Emph{ pandoc.Str "Hello, World" }
501− else
502− return inline
503− end
504− end
611+ 1. a specified full or relative path
505612
506− return {{Str = expand_hello_world}}
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
507615
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
508618
509619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
510620
511621: Set the metadata field *KEY* to the value *VAL*. A value specified
512− 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`].
513624 Values will be parsed as YAML boolean or string values. If no value is
514625 specified, the value will be treated as Boolean true. Like
515626 `--variable`, `--metadata` causes template variables to be set.
516627 But unlike `--variable`, `--metadata` affects the metadata of the
517628 underlying document (which is accessible from filters and may be
518− printed in some output formats).
629+ printed in some output formats) and metadata values will be escaped
630+ when inserted into the template.
631+
632+`--metadata-file=`*FILE*
633+
634+: Read metadata from the supplied YAML (or JSON) file. This
635+ option can be used with every input format, but string scalars
636+ in the YAML file will always be parsed as Markdown. Generally,
637+ the input will be handled the same as in [YAML metadata
638+ blocks][Extension: `yaml_metadata_block`]. This option can be
639+ used repeatedly to include multiple metadata files; values in
640+ files specified later on the command line will be preferred
641+ over those specified in earlier files. Metadata values
642+ specified inside the document, or by using `-M`, overwrite
643+ values specified with this option.
519644
520645`-p`, `--preserve-tabs`
521646
522−: Preserve tabs instead of converting them to spaces (the default).
523− Note that this will only affect tabs in literal code spans and code
524− blocks; tabs in regular text will be treated as spaces.
647+: Preserve tabs instead of converting them to spaces. (By default, pandoc
648+ converts tabs to spaces before parsing its input.) Note that this will
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
650+ text are always treated as spaces.
525651
526652`--tab-stop=`*NUMBER*
527653
@@ -531,27 +657,30 @@ Reader options
531657
532658: Specifies what to do with insertions, deletions, and comments
533659 produced by the MS Word "Track Changes" feature. `accept` (the
534− default), inserts all insertions, and ignores all
535− deletions. `reject` inserts all deletions and ignores
536− insertions. Both `accept` and `reject` ignore comments. `all` puts
537− in insertions, deletions, and comments, wrapped in spans with
538− `insertion`, `deletion`, `comment-start`, and `comment-end`
539− classes, respectively. The author and time of change is
540− included. `all` is useful for scripting: only accepting changes
541− from a certain reviewer, say, or before a certain date. This
542− option only affects the docx reader.
660+ default) processes all the insertions and deletions.
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
662+ `all` includes all insertions, deletions, and comments, wrapped
663+ in spans with `insertion`, `deletion`, `comment-start`, and
664+ `comment-end` classes, respectively. The author and time of
665+ change is included. `all` is useful for scripting: only
666+ accepting changes from a certain reviewer, say, or before a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
669+ `paragraph-insertion`/`paragraph-deletion` before the
670+ affected paragraph break. This option only affects the docx
671+ reader.
543672
544673`--extract-media=`*DIR*
545674
546675: Extract images and other media contained in or linked from
547676 the source document to the path *DIR*, creating it if
548677 necessary, and adjust the images references in the document
549− so they point to the extracted files. If the source format is
550− a binary container (docx, epub, or odt), the media is
551− extracted from the container and the original
552− filenames are used. Otherwise the media is read from the
553− file system or downloaded, and new filenames are constructed
554− based on SHA1 hashes of the contents.
678+ so they point to the extracted files. Media are downloaded,
679+ read from the file system, or extracted from a binary
680+ container (e.g. docx), as needed. The original file paths
681+ are used if they are relative paths not containing `..`.
682+ Otherwise filenames are constructed from the SHA1 hash of
683+ the contents.
555684
556685`--abbreviations=`*FILE*
557686
@@ -562,29 +691,30 @@ Reader options
562691 system default, use
563692 `pandoc --print-default-data-file=abbreviations`. The only
564693 use pandoc makes of this list is in the Markdown reader.
565− Strings ending in a period that are found in this list will
566− be followed by a nonbreaking space, so that the period will
567− not produce sentence-ending space in formats like LaTeX.
694+ Strings found in this list will be followed by a nonbreaking
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
568697
569698[`pandocfilters`]: https://github.com/jgm/pandocfilters
570699[PHP]: https://github.com/vinai/pandocfilters-php
571700[perl]: https://metacpan.org/pod/Pandoc::Filter
572701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
573703
574−General writer options
575−----------------------
704+## General writer options {.options}
576705
577706`-s`, `--standalone`
578707
579708: Produce output with an appropriate header and footer (e.g. a
580709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
581710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
582− output.
711+ output. For `native` output, this option causes metadata to
712+ be included; otherwise, metadata is suppressed.
583713
584−`--template=`*FILE*
714+`--template=`*FILE*|*URL*
585715
586−: Use *FILE* as a custom template for the generated document. Implies
587− `--standalone`. See [Templates], below, for a description
716+: Use the specified file as a custom template for the generated document.
717+ Implies `--standalone`. See [Templates], below, for a description
588718 of template syntax. If no extension is specified, an extension
589719 corresponding to the writer will be added, so that `--template=special`
590720 looks for `special.html` for HTML output. If the template is not
@@ -596,22 +726,29 @@ General writer options
596726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
597727
598728: Set the template variable *KEY* to the value *VAL* when rendering the
599− document in standalone mode. This is generally only useful when the
600− `--template` option is used to specify a custom template, since
601− pandoc automatically sets the variables used in the default
602− templates. If no *VAL* is specified, the key will be given the
603− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
604731
605732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
606733
607734: Print the system default template for an output *FORMAT*. (See `-t`
608735 for a list of possible *FORMAT*s.) Templates in the user data
609− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
740+
741+ Note that some of the default templates use partials, for
742+ example `styles.html`. To print the partials, use
743+ `--print-default-data-file`: for example,
744+ `--print-default-data-file=templates/styles.html`.
610745
611746`--print-default-data-file=`*FILE*
612747
613748: Print a system default data file. Files in the user data directory
614− 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.
615752
616753`--eol=crlf`|`lf`|`native`
617754
@@ -622,9 +759,12 @@ General writer options
622759
623760`--dpi`=*NUMBER*
624761
625−: Specify the dpi (dots per inch) value for conversion from pixels
626− to inch/centimeters and vice versa. The default is 96dpi.
627− Technically, the correct term would be ppi (pixels per inch).
762+: Specify the default dpi (dots per inch) value for conversion
763+ from pixels to inch/centimeters and vice versa. (Technically,
764+ the correct term would be ppi: pixels per inch.) The default
765+ is 96dpi. When images contain information about dpi
766+ internally, the encoded value is used instead of the default
767+ specified by this option.
628768
629769`--wrap=auto`|`none`|`preserve`
630770
@@ -637,6 +777,8 @@ General writer options
637777 where there are nonsemantic newlines in the source, there
638778 will be nonsemantic newlines in the output as well).
639779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
640782
641783`--columns=`*NUMBER*
642784
@@ -649,14 +791,21 @@ General writer options
649791: Include an automatically generated table of contents (or, in
650792 the case of `latex`, `context`, `docx`, `odt`,
651793 `opendocument`, `rst`, or `ms`, an instruction to create
652− one) in the output document. This option has no effect on
653− `man`, `docbook4`, `docbook5`, or `jats` output.
794+ one) in the output document. This option has no effect
795+ unless `-s/--standalone` is used, and it has no effect
796+ on `man`, `docbook4`, `docbook5`, or `jats` output.
797+
798+ Note that if you are producing a PDF via `ms`, the table
799+ of contents will appear at the beginning of the
800+ document, before the title. If you would prefer it to
801+ be at the end of the document, use the option
802+ `--pdf-engine-opt=--no-toc-relocation`.
654803
655804`--toc-depth=`*NUMBER*
656805
657806: Specify the number of section levels to include in the table
658− of contents. The default is 3 (which means that level 1, 2, and 3
659− headers will be listed in the contents).
807+ of contents. The default is 3 (which means that level-1, 2, and 3
808+ headings will be listed in the contents).
660809
661810`--strip-comments`
662811
@@ -692,7 +841,10 @@ General writer options
692841
693842: Prints a JSON version of a highlighting style, which can
694843 be modified, saved with a `.theme` extension, and used
695− 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.
696848
697849`--syntax-definition=`*FILE*
698850
@@ -700,9 +852,10 @@ General writer options
700852 which will be used for syntax highlighting of appropriately
701853 marked code blocks. This can be used to add support for
702854 new languages or to use altered syntax definitions for
703− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
704857
705−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
706859
707860: Include contents of *FILE*, verbatim, at the end of the header.
708861 This can be used, for example, to include special
@@ -710,7 +863,7 @@ General writer options
710863 repeatedly to include multiple files in the header. They will be
711864 included in the order specified. Implies `--standalone`.
712865
713−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
714867
715868: Include contents of *FILE*, verbatim, at the beginning of the
716869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -719,7 +872,7 @@ General writer options
719872 used repeatedly to include multiple files. They will be included in
720873 the order specified. Implies `--standalone`.
721874
722−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
723876
724877: Include contents of *FILE*, verbatim, at the end of the document
725878 body (before the `</body>` tag in HTML, or the
@@ -738,28 +891,39 @@ General writer options
738891 will not be searched. For example:
739892 `--resource-path=.:test` will search the working directory
740893 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`.
741899
742900`--request-header=`*NAME*`:`*VAL*
743901
744902: Set the request header *NAME* to the value *VAL* when making
745903 HTTP requests (for example, when a URL is given on the
746904 command line, or when resources used in a document must be
747− downloaded).
905+ downloaded). If you're behind a proxy, you also need to set
906+ the environment variable `http_proxy` to `http://...`.
748907
749−Options affecting specific writers
750−----------------------------------
908+`--no-check-certificate`
909+
910+: Disable the certificate verification to allow access to
911+ unsecure HTTP resources (for example when the certificate
912+ is no longer valid or self signed).
913+
914+## Options affecting specific writers {.options}
751915
752916`--self-contained`
753917
754918: Produce a standalone HTML file with no external dependencies, using
755919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
756− images, and videos. The resulting file should be "self-contained,"
757− in the sense that it needs no external files and no net access to be
758− displayed properly by a browser. This option works only with HTML output
759− formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
760− `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
761− stylesheets at absolute URLs will be downloaded; those at relative URLs
762− will be sought relative to the working directory (if the first source
920+ images, and videos. Implies `--standalone`. The resulting file should be
921+ "self-contained," in the sense that it needs no external files and no net
922+ access to be displayed properly by a browser. This option works only with
923+ HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924+ `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925+ and stylesheets at absolute URLs will be downloaded; those at relative
926+ URLs will be sought relative to the working directory (if the first source
763927 file is local) or relative to the base URL (if the first source
764928 file is remote). Elements with the attribute
765929 `data-external="1"` will be left alone; the documents they
@@ -772,13 +936,18 @@ Options affecting specific writers
772936
773937`--html-q-tags`
774938
775−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
941+ format used.)
776942
777943`--ascii`
778944
779−: Use only ASCII characters in output. Currently supported only for
780− HTML and DocBook output (which uses numerical entities instead of
781− UTF-8 when this option is selected).
945+: Use only ASCII characters in output. Currently supported for XML
946+ and HTML formats (which use entities instead of UTF-8 when this
947+ option is selected), CommonMark, gfm, and Markdown (which use
948+ entities), roff ms (which use hexadecimal escapes), and to a
949+ limited degree LaTeX (which uses standard commands for accented
950+ characters when possible). roff man output uses ASCII by default.
782951
783952`--reference-links`
784953
@@ -787,36 +956,45 @@ Options affecting specific writers
787956 placement of link references is affected by the
788957 `--reference-location` option.
789958
790−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
791960
792961: Specify whether footnotes (and references, if `reference-links` is
793962 set) are placed at the end of the current (top-level) block, the
794963 current section, or the document. The default is
795964 `document`. Currently only affects the markdown writer.
796965
966+`--markdown-headings=setext`|`atx`
967+
968+: Specify whether to use ATX-style (`#`-prefixed) or
969+ Setext-style (underlined) headings for level 1 and 2
970+ headings in Markdown output. (The default is `atx`.)
971+ ATX-style headings are always used for levels 3+.
972+ This option also affects Markdown cells in `ipynb` output.
973+
797974`--atx-headers`
798975
799−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
800− to use setext-style headers for levels 1-2, and then ATX headers.
801− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
802977
803−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
804979
805−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
806− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
807− all headers are shifted such that the top-level header becomes the specified
808− type. The default behavior is to determine the best division type via
809− heuristics: unless other conditions apply, `section` is chosen. When the
810− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
811− `article` option is specified), `chapter` is implied as the setting for this
812− option. If `beamer` is the output format, specifying either `chapter` or
813− `part` will cause top-level headers to become `\part{..}`, while
814− second-level headers remain as their default type.
980+: Treat top-level headings as the given division type in
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
983+ shifted such that the top-level heading becomes the
984+ specified type. The default behavior is to determine the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
987+ variable is set to `report`, `book`, or `memoir` (unless the
988+ `article` option is specified), `chapter` is implied as the
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
992+ remain as their default type.
815993
816994`-N`, `--number-sections`
817995
818−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
819− By default, sections are not numbered. Sections with class
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997+ output. By default, sections are not numbered. Sections with class
820998 `unnumbered` will never be numbered, even if `--number-sections`
821999 is specified.
8221000
@@ -824,16 +1002,19 @@ Options affecting specific writers
8241002
8251003: Offset for section headings in HTML output (ignored in other
8261004 output formats). The first number is added to the section number for
827− top-level headers, the second for second-level headers, and so on.
828− So, for example, if you want the first top-level header in your
1005+ top-level headings, the second for second-level headings, and so on.
1006+ So, for example, if you want the first top-level heading in your
8291007 document to be numbered "6", specify `--number-offset=5`.
830− 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
8311009 be numbered "1.5", specify `--number-offset=1,4`.
8321010 Offsets are 0 by default. Implies `--number-sections`.
8331011
8341012`--listings`
8351013
836−: 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].
8371018
8381019`-i`, `--incremental`
8391020
@@ -842,22 +1023,22 @@ Options affecting specific writers
8421023
8431024`--slide-level=`*NUMBER*
8441025
845−: Specifies that headers with the specified level create
846− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1026+: Specifies that headings with the specified level create
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
8471028 above this level in the hierarchy are used to divide the
848− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
8491030 subheads within a slide. Note that content that is
850− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
8511032 the slide show. The default is to set the slide level based
8521033 on the contents of the document; see [Structuring the slide
8531034 show].
8541035
8551036`--section-divs`
8561037
857−: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
858− and attach identifiers to the enclosing `<div>` (or `<section>`)
859− rather than the header itself. See
860− [Header identifiers], below.
1038+: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039+ and attach identifiers to the enclosing `<section>` (or `<div>`)
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
8611042
8621043`--email-obfuscation=none`|`javascript`|`references`
8631044
@@ -878,8 +1059,7 @@ Options affecting specific writers
8781059
8791060: Specify *STRING* as a prefix at the beginning of the title
8801061 that appears in the HTML header (but not in the title as it
881− appears at the beginning of the HTML body). Implies
882− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
8831063
8841064`-c` *URL*, `--css=`*URL*
8851065
@@ -887,8 +1067,8 @@ Options affecting specific writers
8871067 include multiple files. They will be included in the order specified.
8881068
8891069 A stylesheet is required for generating EPUB. If none is
890− provided using this option (or the `stylesheet` metadata
891− field), pandoc will look for a file `epub.css` in the
1070+ provided using this option (or the `css` or `stylesheet`
1071+ metadata fields), pandoc will look for a file `epub.css` in the
8921072 user data directory (see `--data-dir`). If it is not
8931073 found there, sensible defaults will be used.
8941074
@@ -911,20 +1091,56 @@ Options affecting specific writers
9111091
9121092 To produce a custom `reference.docx`, first get a copy of
9131093 the default `reference.docx`: `pandoc
914− --print-default-data-file reference.docx >
915− custom-reference.docx`. Then open `custom-reference.docx`
916− in Word, modify the styles as you wish, and save the file.
917− For best results, do not make changes to this file other
918− than modifying the styles used by pandoc: [paragraph]
919− Normal, Body Text, First Paragraph, Compact, Title,
920− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
921− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
922− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
923− Definition Term, Definition, Caption, Table Caption,
924− Image Caption, Figure, Captioned Figure, TOC Heading;
925− [character] Default Paragraph Font, Body Text Char,
926− Verbatim Char, Footnote Reference, Hyperlink; [table]
927− Table.
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
1095+ Then open `custom-reference.docx` in Word, modify the
1096+ styles as you wish, and save the file. For best
1097+ results, do not make changes to this file other than
1098+ modifying the styles used by pandoc:
1099+
1100+ Paragraph styles:
1101+
1102+ - Normal
1103+ - Body Text
1104+ - First Paragraph
1105+ - Compact
1106+ - Title
1107+ - Subtitle
1108+ - Author
1109+ - Date
1110+ - Abstract
1111+ - Bibliography
1112+ - Heading 1
1113+ - Heading 2
1114+ - Heading 3
1115+ - Heading 4
1116+ - Heading 5
1117+ - Heading 6
1118+ - Heading 7
1119+ - Heading 8
1120+ - Heading 9
1121+ - Block Text
1122+ - Footnote Text
1123+ - Definition Term
1124+ - Definition
1125+ - Caption
1126+ - Table Caption
1127+ - Image Caption
1128+ - Figure
1129+ - Captioned Figure
1130+ - TOC Heading
1131+
1132+ Character styles:
1133+
1134+ - Default Paragraph Font
1135+ - Body Text Char
1136+ - Verbatim Char
1137+ - Footnote Reference
1138+ - Hyperlink
1139+ - Section Number
1140+
1141+ Table style:
1142+
1143+ - Table
9281144
9291145 ODT
9301146
@@ -938,10 +1154,33 @@ Options affecting specific writers
9381154
9391155 To produce a custom `reference.odt`, first get a copy of
9401156 the default `reference.odt`: `pandoc
941− --print-default-data-file reference.odt >
942− custom-reference.odt`. Then open `custom-reference.odt` in
943− LibreOffice, modify the styles as you wish, and save the
944− file.
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
1158+ Then open `custom-reference.odt` in LibreOffice, modify
1159+ the styles as you wish, and save the file.
1160+
1161+ PowerPoint
1162+
1163+ : Templates included with Microsoft PowerPoint 2013 (either with
1164+ `.pptx` or `.potx` extension) are known to work, as are most
1165+ templates derived from these.
1166+
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
1169+
1170+ 1. Title Slide
1171+ 2. Title and Content
1172+ 3. Section Header
1173+ 4. Two Content
1174+
1175+ All templates included with a recent version of MS PowerPoint
1176+ will fit these criteria. (You can click on `Layout` under the
1177+ `Home` menu to check.)
1178+
1179+ You can also modify the default `reference.pptx`: first run
1180+ `pandoc -o custom-reference.pptx --print-default-data-file
1181+ reference.pptx`, and then modify `custom-reference.pptx`
1182+ in MS PowerPoint (pandoc will use the first four layout
1183+ slides, as mentioned above).
9451184
9461185`--epub-cover-image=`*FILE*
9471186
@@ -1009,12 +1248,12 @@ Options affecting specific writers
10091248
10101249`--epub-chapter-level=`*NUMBER*
10111250
1012−: Specify the header level at which to split the EPUB into separate
1013− "chapter" files. The default is to split into chapters at level 1
1014− headers. This option only affects the internal composition of the
1251+: Specify the heading level at which to split the EPUB into separate
1252+ "chapter" files. The default is to split into chapters at level-1
1253+ headings. This option only affects the internal composition of the
10151254 EPUB, not the way chapters and sections are displayed to users. Some
10161255 readers may be slow if the chapter files are too large, so for large
1017− 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
10181257 level of 2 or 3.
10191258
10201259`--epub-subdirectory=`*DIRNAME*
@@ -1023,69 +1262,118 @@ Options affecting specific writers
10231262 the EPUB-specific contents. The default is `EPUB`. To put
10241263 the EPUB contents in the top level, use an empty string.
10251264
1026−`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1265+`--ipynb-output=all|none|best`
1266+
1267+: Determines how ipynb output cells are treated. `all` means
1268+ that all of the data formats included in the original are
1269+ preserved. `none` means that the contents of data cells
1270+ are omitted. `best` causes pandoc to try to pick the
1271+ richest data block in each output cell that is compatible
1272+ with the output format. The default is `best`.
1273+
1274+`--pdf-engine=`*PROGRAM*
10271275
10281276: Use the specified engine when producing PDF output.
1029− The default is `pdflatex`. If the engine is not in your PATH,
1030− the full path of the engine may be specified here.
1277+ Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278+ `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1280+ path of the engine may be specified here. If this option
1281+ is not specified, pandoc uses the following defaults
1282+ depending on the output format specified using `-t/--to`:
1283+
1284+ - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285+ `tectonic`, `latexmk`)
1286+ - `-t context`: `context`
1287+ - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288+ see [print-css.rocks](https://print-css.rocks) for a good
1289+ introduction to PDF generation from HTML/CSS.)
1290+ - `-t ms`: `pdfroff`
10311291
10321292`--pdf-engine-opt=`*STRING*
10331293
10341294: Use the given string as a command-line argument to the `pdf-engine`.
1035− If used multiple times, the arguments are provided with spaces between
1036− them. Note that no check for duplicate options is done.
1037−
1038−[Dublin Core elements]: http://dublincore.org/documents/dces/
1039−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1040−
1041−Citation rendering
1042−------------------
1295+ For example, to use a persistent directory `foo` for `latexmk`'s
1296+ auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297+ Note that no check for duplicate options is done.
1298+
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301+[Encoding issue with the listings package]:
1302+ https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303+
1304+## Citation rendering {.options}
1305+
1306+`-C`, `--citeproc`
1307+
1308+: Process the citations in the file, replacing them with
1309+ rendered citations and adding a bibliography.
1310+ Citation processing will not take place unless bibliographic
1311+ data is supplied, either through an external file specified
1312+ using the `--bibliography` option or the `bibliography`
1313+ field in metadata, or via a `references` section in metadata
1314+ containing a list of citations in CSL YAML format with
1315+ Markdown formatting. The style is controlled by a [CSL]
1316+ stylesheet specified using the `--csl` option or the `csl`
1317+ field in metadata. (If no stylesheet is specified,
1318+ the `chicago-author-date` style will be used by default.)
1319+ The citation processing transformation may be applied before
1320+ or after filters or Lua filters (see `--filter`,
1321+ `--lua-filter`): these transformations are applied in the
1322+ order they appear on the command line. For more
1323+ information, see the section on [Citations].
10431324
10441325`--bibliography=`*FILE*
10451326
10461327: Set the `bibliography` field in the document's metadata to *FILE*,
1047− overriding any value set in the metadata, and process citations
1048− using `pandoc-citeproc`. (This is equivalent to
1049− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1050− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1051− used, making this equivalent to `--metadata bibliography=FILE`.
1052− If you supply this argument multiple times, each *FILE* will be added
1053− to bibliography.
1328+ overriding any value set in the metadata. If you supply
1329+ this argument multiple times, each *FILE* will be added to
1330+ bibliography. If *FILE* is a URL, it will be fetched
1331+ via HTTP. If *FILE* is not found relative to the
1332+ working directory, it will be sought in the resource path
1333+ (see `--resource-path`).
10541334
10551335`--csl=`*FILE*
10561336
10571337: Set the `csl` field in the document's metadata to *FILE*,
10581338 overriding any value set in the metadata. (This is equivalent to
1059− `--metadata csl=FILE`.)
1060− This option is only relevant with `pandoc-citeproc`.
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340+ fetched via HTTP. If *FILE* is not found relative to the
1341+ working directory, it will be sought in the resource path
1342+ (see `--resource-path`) and finally in the `csl`
1343+ subdirectory of the pandoc user data directory.
10611344
10621345`--citation-abbreviations=`*FILE*
10631346
10641347: Set the `citation-abbreviations` field in the document's metadata to
10651348 *FILE*, overriding any value set in the metadata. (This is equivalent to
10661349 `--metadata citation-abbreviations=FILE`.)
1067− 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.
10681354
10691355`--natbib`
10701356
1071−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1072− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1073− use in producing a LaTeX file that can be processed with [`bibtex`].
1357+: Use [`natbib`] for citations in LaTeX output. This option
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1360+ that can be processed with [`bibtex`].
10741361
10751362`--biblatex`
10761363
1077−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1078− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1079− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1367+ that can be processed with [`bibtex`] or [`biber`].
10801368
1081−Math rendering in HTML
1082−----------------------
1369+## Math rendering in HTML {.options}
10831370
1084−The default is to render TeX math as far as possible using Unicode characters.
1085−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1086−differently from the surrounding text if needed. However, this gives acceptable
1087−results only for basic math, usually you will want to use `--mathjax` or another
1088−of the following options.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1373+`class="math"`, so that they may be styled differently from the
1374+surrounding text if needed. However, this gives acceptable
1375+results only for basic math, usually you will want to use
1376+`--mathjax` or another of the following options.
10891377
10901378`--mathjax`[`=`*URL*]
10911379
@@ -1099,10 +1387,11 @@ of the following options.
10991387
11001388`--mathml`
11011389
1102−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1103− `html4` and `html5`). This is the default in `odt` output. Note that
1104− currently only Firefox and Safari (and select e-book readers) natively
1105− support MathML.
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1392+ default in `odt` output. Note that currently only Firefox
1393+ and Safari (and select e-book readers) natively support
1394+ MathML.
11061395
11071396`--webtex`[`=`*URL*]
11081397
@@ -1119,67 +1408,26 @@ of the following options.
11191408`--katex`[`=`*URL*]
11201409
11211410: Use [KaTeX] to display embedded TeX math in HTML output.
1122− The *URL* is the base URL for the KaTeX library. If a *URL* is
1123− not provided, a link to the KaTeX CDN will be inserted.
1124−
1125−`--katex-stylesheet=`*URL*
1126−
1127−: The *URL* should point to the `katex.css` stylesheet. If this option is
1128− not specified, a link to the KaTeX CDN will be inserted. Note that this
1129− option does not imply `--katex`.
1130−
1131−`-m` [*URL*], `--latexmathml`[`=`*URL*]
1132−
1133−: *Deprecated.*
1134− Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1135− TeX math will be displayed between `$` or `$$` characters and put in
1136− `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then
1137− change it to MathML. Note that currently only Firefox and Safari
1138− (and select e-book readers) natively support MathML.
1139− To insert a link the `LaTeXMathML.js` script, provide a *URL*.
1140−
1141−`--jsmath`[`=`*URL*]
1142−
1143−: *Deprecated.*
1144− Use [jsMath] (the predecessor of MathJax) to display embedded TeX
1145− math in HTML output. TeX math will be put inside `<span>` tags
1146− (for inline math) or `<div>` tags (for display math) with class
1147− `math` and rendered by the jsMath script. The *URL* should point to
1148− the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked
1149− to in the header of standalone HTML documents. If a *URL* is not provided,
1150− no link to the jsMath load script will be inserted; it is then
1151− up to the author to provide such a link in the HTML template.
1411+ The *URL* is the base URL for the KaTeX library. That directory
1412+ should contain a `katex.min.js` and a `katex.min.css` file.
1413+ If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
11521414
11531415`--gladtex`
11541416
1155−: *Deprecated.*
1156− Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1157− can then be processed by [gladTeX] to produce images of the typeset
1158− formulas and an HTML file with links to these images.
1159− So, the procedure is:
1417+: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
11601420
11611421 pandoc -s --gladtex input.md -o myfile.htex
1162− gladtex -d myfile-images myfile.htex
1163− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
11641424
1165−`--mimetex`[`=`*URL*]
1166−
1167−: *Deprecated.*
1168− Render TeX math using the [mimeTeX] CGI script, which generates an
1169− image for each TeX formula. This should work in all browsers. If
1170− *URL* is not specified, it is assumed that the script is at
1171− `/cgi-bin/mimetex.cgi`.
1172−
1173−[MathML]: http://www.w3.org/Math/
1174−[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1175−[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1425+[MathML]: https://www.w3.org/Math/
11761426[MathJax]: https://www.mathjax.org
1177−[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1178−[mimeTeX]: http://www.forkosh.com/mimetex.html
11791427[KaTeX]: https://github.com/Khan/KaTeX
1428+[GladTeX]: https://humenda.github.io/GladTeX/
11801429
1181−Options for wrapper scripts
1182−---------------------------
1430+## Options for wrapper scripts {.options}
11831431
11841432`--dump-args`
11851433
@@ -1203,8 +1451,277 @@ Options for wrapper scripts
12031451
12041452 pandoc -o foo.html -s
12051453
1206−Templates
1207−=========
1454+# Exit codes
1455+
1456+If pandoc completes successfully, it will return exit code 0.
1457+Nonzero exit codes have the following meanings:
1458+
1459+ Code Error
1460+----- ------------------------------------
1461+ 3 PandocFailOnWarningError
1462+ 4 PandocAppError
1463+ 5 PandocTemplateError
1464+ 6 PandocOptionError
1465+ 21 PandocUnknownReaderError
1466+ 22 PandocUnknownWriterError
1467+ 23 PandocUnsupportedExtensionError
1468+ 24 PandocCiteprocError
1469+ 31 PandocEpubSubdirectoryError
1470+ 43 PandocPDFError
1471+ 44 PandocXMLError
1472+ 47 PandocPDFProgramNotFoundError
1473+ 61 PandocHttpError
1474+ 62 PandocShouldNeverHappenError
1475+ 63 PandocSomeError
1476+ 64 PandocParseError
1477+ 65 PandocParsecError
1478+ 66 PandocMakePDFError
1479+ 67 PandocSyntaxMapError
1480+ 83 PandocFilterError
1481+ 91 PandocMacroLoop
1482+ 92 PandocUTF8DecodingError
1483+ 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
1485+ 97 PandocCouldNotFindDataFileError
1486+ 99 PandocResourceNotFound
1487+----- ------------------------------------
1488+
1489+# Default files
1490+
1491+The `--defaults` option may be used to specify a package
1492+of options. Here is a sample defaults file demonstrating all of
1493+the fields that may be used:
1494+
1495+``` yaml
1496+from: markdown+emoji
1497+# reader: may be used instead of from:
1498+to: html5
1499+# writer: may be used instead of to:
1500+
1501+# leave blank for output to stdout:
1502+output-file:
1503+# leave blank for input from stdin, use [] for no input:
1504+input-files:
1505+- preface.md
1506+- content.md
1507+# or you may use input-file: with a single value
1508+
1509+# Include options from the specified defaults files.
1510+# The files will be searched for first in the working directory
1511+# and then in the defaults subdirectory of the user data directory.
1512+# The files are included in the same order in which they appear in
1513+# the list. Options specified in this defaults file always have
1514+# priority over the included ones.
1515+defaults:
1516+- defsA
1517+- defsB
1518+
1519+template: letter
1520+standalone: true
1521+self-contained: false
1522+
1523+# note that structured variables may be specified:
1524+variables:
1525+ documentclass: book
1526+ classoption:
1527+ - twosides
1528+ - draft
1529+
1530+# metadata values specified here are parsed as literal
1531+# string text, not markdown:
1532+metadata:
1533+ author:
1534+ - Sam Smith
1535+ - Julie Liu
1536+metadata-files:
1537+- boilerplate.yaml
1538+# or you may use metadata-file: with a single value
1539+
1540+# Note that these take files, not their contents:
1541+include-before-body: []
1542+include-after-body: []
1543+include-in-header: []
1544+resource-path: ["."]
1545+
1546+# turn on built-in citation processing. Note that if you need
1547+# control over when the citeproc processing is done relative
1548+# to other filters, you should instead use `citeproc` in the
1549+# list of `filters` (see below).
1550+citeproc: true
1551+csl: ieee
1552+bibliography:
1553+- foobar.bib
1554+- barbaz.json
1555+citation-abbreviations: abbrevs.json
1556+
1557+# Filters will be assumed to be Lua filters if they have
1558+# the .lua extension, and json filters otherwise. But
1559+# the filter type can also be specified explicitly, as shown.
1560+# Filters are run in the order specified.
1561+# To include the built-in citeproc filter, use either `citeproc`
1562+# or `{type: citeproc}`.
1563+filters:
1564+- wordcount.lua
1565+- type: json
1566+ path: foo.lua
1567+
1568+file-scope: false
1569+
1570+data-dir:
1571+
1572+# ERROR, WARNING, or INFO
1573+verbosity: INFO
1574+log-file: log.json
1575+
1576+# citeproc, natbib, or biblatex. This only affects LaTeX
1577+# output. If you want to use citeproc to format citations,
1578+# you should also set 'citeproc: true' (see above).
1579+cite-method: citeproc
1580+
1581+# part, chapter, section, or default:
1582+top-level-division: chapter
1583+abbreviations:
1584+
1585+pdf-engine: pdflatex
1586+pdf-engine-opts:
1587+- "-shell-escape"
1588+# you may also use pdf-engine-opt: with a single option
1589+# pdf-engine-opt: "-shell-escape"
1590+
1591+# auto, preserve, or none
1592+wrap: auto
1593+columns: 78
1594+dpi: 72
1595+
1596+extract-media: mediadir
1597+
1598+table-of-contents: true
1599+toc-depth: 2
1600+number-sections: false
1601+# a list of offsets at each heading level
1602+number-offset: [0,0,0,0,0,0]
1603+# toc: may also be used instead of table-of-contents:
1604+shift-heading-level-by: 1
1605+section-divs: true
1606+identifier-prefix: foo
1607+title-prefix: ""
1608+strip-empty-paragraphs: true
1609+# lf, crlf, or native
1610+eol: lf
1611+strip-comments: false
1612+indented-code-classes: []
1613+ascii: true
1614+default-image-extension: ".jpg"
1615+
1616+# either a style name of a style definition file:
1617+highlight-style: pygments
1618+syntax-definitions:
1619+- c.xml
1620+# or you may use syntax-definition: with a single value
1621+listings: false
1622+
1623+reference-doc: myref.docx
1624+
1625+# method is plain, webtex, gladtex, mathml, mathjax, katex
1626+# you may specify a url with webtex, mathjax, katex
1627+html-math-method:
1628+ method: mathjax
1629+ url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1630+# none, references, or javascript
1631+email-obfuscation: javascript
1632+
1633+tab-stop: 8
1634+preserve-tabs: true
1635+
1636+incremental: false
1637+slide-level: 2
1638+
1639+epub-subdirectory: EPUB
1640+epub-metadata: meta.xml
1641+epub-fonts:
1642+- foobar.otf
1643+epub-chapter-level: 1
1644+epub-cover-image: cover.jpg
1645+
1646+reference-links: true
1647+# block, section, or document
1648+reference-location: block
1649+markdown-headings: setext
1650+
1651+# accept, reject, or all
1652+track-changes: accept
1653+
1654+html-q-tags: false
1655+css:
1656+- site.css
1657+
1658+# none, all, or best
1659+ipynb-output: best
1660+
1661+# A list of two-element lists
1662+request-headers:
1663+- ["User-Agent", "Mozilla/5.0"]
1664+
1665+fail-if-warnings: false
1666+dump-args: false
1667+ignore-args: false
1668+trace: false
1669+```
1670+
1671+Fields that are omitted will just have their regular
1672+default values. So a defaults file can be as simple as
1673+one line:
1674+
1675+``` yaml
1676+verbosity: INFO
1677+```
1678+
1679+In fields that expect a file path (or list of file paths), the
1680+following syntax may be used to interpolate environment variables:
1681+
1682+``` yaml
1683+csl: ${HOME}/mycsldir/special.csl
1684+```
1685+
1686+`${USERDATA}` may also be used; this will always resolve to the
1687+user data directory that is current when the defaults file is
1688+parsed, regardless of the setting of the environment
1689+variable `USERDATA`.
1690+
1691+`${.}` will resolve to the directory containing the default
1692+file itself. This allows you to refer to resources contained
1693+in that directory:
1694+
1695+``` yaml
1696+epub-cover-image: ${.}/cover.jpg
1697+epub-metadata: ${.}/meta.xml
1698+resource-path:
1699+- . # the working directory from which pandoc is run
1700+- ${.}/images # the images subdirectory of the directory
1701+ # containing this defaults file
1702+```
1703+
1704+This environment variable interpolation syntax *only* works in
1705+fields that expect file paths.
1706+
1707+Default files can be placed in the `defaults` subdirectory of
1708+the user data directory and used from any directory. For
1709+example, one could create a file specifying defaults for writing
1710+letters, save it as `letter.yaml` in the `defaults` subdirectory
1711+of the user data directory, and then invoke these defaults
1712+from any directory using `pandoc --defaults letter`
1713+or `pandoc -dletter`.
1714+
1715+When multiple defaults are used, their contents will be combined.
1716+
1717+Note that, where command-line arguments may be repeated
1718+(`--metadata-file`, `--css`, `--include-in-header`,
1719+`--include-before-body`, `--include-after-body`, `--variable`,
1720+`--metadata`, `--syntax-definition`), the values specified on
1721+the command line will combine with values specified in the
1722+defaults file, rather than replacing them.
1723+
1724+# Templates
12081725
12091726When the `-s/--standalone` option is used, pandoc uses a template to
12101727add header and footer material that is needed for a self-standing
@@ -1223,2083 +1740,3127 @@ directory (see `--data-dir`, above). *Exceptions:*
12231740- For `pdf` output, customize the `default.latex` template
12241741 (or the `default.context` template, if you use `-t context`,
12251742 or the `default.ms` template, if you use `-t ms`, or the
1226− `default.html5` template, if you use `-t html5`).
1227−- `docx` has no template (however, you can use
1743+ `default.html` template, if you use `-t html`).
1744+- `docx` and `pptx` have no template (however, you can use
12281745 `--reference-doc` to customize the output).
12291746
12301747Templates contain *variables*, which allow for the inclusion of
1231−arbitrary information at any point in the file. Variables may be set
1232−within the document using [YAML metadata blocks][Extension:
1233−`yaml_metadata_block`]. They may also be set at the
1234−command line using the `-V/--variable` option: variables set in this
1235−way override metadata fields with the same name.
1748+arbitrary information at any point in the file. They may be set at the
1749+command line using the `-V/--variable` option. If a variable is not set,
1750+pandoc will look for the key in the document's metadata, which can be set
1751+using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1752+or with the `-M/--metadata` option. In addition, some variables
1753+are given default values by pandoc. See [Variables] below for
1754+a list of variables used in pandoc's default templates.
12361755
1237−Variables set by pandoc
1238−-----------------------
1756+If you use custom templates, you may need to revise them as pandoc
1757+changes. We recommend tracking the changes in the default templates,
1758+and modifying your custom templates accordingly. An easy way to do this
1759+is to fork the [pandoc-templates] repository and merge in
1760+changes after each pandoc release.
12391761
1240−Some variables are set automatically by pandoc. These vary somewhat
1241−depending on the output format, but include metadata fields as well
1242−as the following:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
12431763
1244−`sourcefile`, `outputfile`
1245−: source and destination filenames, as given on the command line.
1246− `sourcefile` can also be a list if input comes from multiple files, or empty
1247− if input is from stdin. You can use the following snippet in your template
1248− to distinguish them:
1764+## Template syntax
12491765
1250− $if(sourcefile)$
1251− $for(sourcefile)$
1252− $sourcefile$
1253− $endfor$
1254− $else$
1255− (stdin)
1256− $endif$
1766+### Comments
12571767
1258− 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.
12591770
1260−`title`, `author`, `date`
1261−: allow identification of basic aspects of the document. Included
1262− in PDF metadata through LaTeX and ConTeXt. These can be set
1263− through a [pandoc title block][Extension: `pandoc_title_block`],
1264− which allows for multiple authors, or through a YAML metadata block:
1771+### Delimiters
12651772
1266− ---
1267− author:
1268− - Aristotle
1269− - Peter Abelard
1270− ...
1773+To mark variables and control structures in the template,
1774+either `$`...`$` or `${`...`}` may be used as delimiters.
1775+The styles may also be mixed in the same template, but the
1776+opening and closing delimiter must match in each case. The
1777+opening delimiter may be followed by one or more spaces
1778+or tabs, which will be ignored. The closing delimiter may
1779+be followed by one or more spaces or tabs, which will be
1780+ignored.
12711781
1272−`subtitle`
1273−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1274− renders in LaTeX only when using a document class that supports
1275− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1276− `scrreprt`, `scrbook`).[^subtitle]
1782+To include a literal `$` in the document, use `$$`.
12771783
1278−`institute`
1279−: author affiliations (in LaTeX and Beamer only). Can be a
1280− list, when there are multiple authors.
1784+### Interpolated variables
12811785
1282−`abstract`
1283−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1786+A slot for an interpolated variable is a variable name surrounded
1787+by matched delimiters. Variable names must begin with a letter
1788+and can contain letters, numbers, `_`, `-`, and `.`. The
1789+keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1790+not be used as variable names. Examples:
12841791
1285−`keywords`
1286−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1287− may be repeated as for `author`, above
1792+```
1793+$foo$
1794+$foo.bar.baz$
1795+$foo_bar.baz-bim$
1796+$ foo $
1797+${foo}
1798+${foo.bar.baz}
1799+${foo_bar.baz-bim}
1800+${ foo }
1801+```
12881802
1289−`header-includes`
1290−: contents specified by `-H/--include-in-header` (may have multiple
1291− values)
1803+Variable names with periods are used to get at structured
1804+variable values. So, for example, `employee.salary` will return the
1805+value of the `salary` field of the object that is the value of
1806+the `employee` field.
12921807
1293−`toc`
1294−: non-null value if `--toc/--table-of-contents` was specified
1808+- If the value of the variable is simple value, it will be
1809+ rendered verbatim. (Note that no escaping is done;
1810+ the assumption is that the calling program will escape
1811+ the strings appropriately for the output format.)
1812+- If the value is a list, the values will be concatenated.
1813+- If the value is a map, the string `true` will be rendered.
1814+- Every other value will be rendered as the empty string.
12951815
1296−`toc-title`
1297−: title of table of contents (works only with EPUB,
1298− opendocument, odt, docx)
1816+### Conditionals
12991817
1300−`include-before`
1301−: contents specified by `-B/--include-before-body` (may have
1302− multiple values)
1818+A conditional begins with `if(variable)` (enclosed in
1819+matched delimiters) and ends with `endif` (enclosed in matched
1820+delimiters). It may optionally contain an `else` (enclosed in
1821+matched delimiters). The `if` section is used if
1822+`variable` has a non-empty value, otherwise the `else`
1823+section is used (if present). Examples:
13031824
1304−`include-after`
1305−: contents specified by `-A/--include-after-body` (may have
1306− multiple values)
1825+```
1826+$if(foo)$bar$endif$
13071827
1308−`body`
1309−: body of document
1828+$if(foo)$
1829+ $foo$
1830+$endif$
13101831
1311−`meta-json`
1312−: JSON representation of all of the document's metadata. Field
1313− values are transformed to the selected output format.
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
13141837
1315−[^subtitle]: To make `subtitle` work with other LaTeX
1316− document classes, you can add the following to `header-includes`:
1838+${if(foo)}bar${endif}
13171839
1318− \providecommand{\subtitle}[1]{%
1319− \usepackage{titling}
1320− \posttitle{%
1321− \par\large#1\end{center}}
1322− }
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
13231843
1324−Language variables
1325−------------------
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
13261850
1327−`lang`
1328−: identifies the main language of the document,
1329− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1330− For some output formats, pandoc will convert it to an appropriate
1331− format stored in the additional variables `babel-lang`,
1332− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1333−
1334− Native pandoc `span`s and `div`s with the lang attribute
1335− (value in BCP 47) can be used to switch the language in
1336− that range.
1337−
1338−`otherlangs`
1339−: a list of other languages used in the document
1340− in the YAML metadata, according to [BCP 47]. For example:
1341− `otherlangs: [en-GB, fr]`.
1342− This is automatically generated from the `lang` attributes
1343− in all `span`s and `div`s but can be overridden.
1344− Currently only used by LaTeX through the generated
1345− `babel-otherlangs` and `polyglossia-otherlangs` variables.
1346− The LaTeX writer outputs polyglossia commands in the text but
1347− the `babel-newcommands` variable contains mappings for them
1348− to the corresponding babel.
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
13491853
1350−`dir`
1351−: the base direction of the document, either `rtl` (right-to-left)
1352− or `ltr` (left-to-right).
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
13531863
1354− For bidirectional documents, native pandoc `span`s and `div`s
1355− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1356− override the base direction in some output formats.
1357− This may not always be necessary if the final renderer
1358− (e.g. the browser, when generating HTML) supports the
1359− [Unicode Bidirectional Algorithm].
1864+### For loops
13601865
1361− When using LaTeX for bidirectional documents, only the `xelatex` engine
1362− is fully supported (use `--pdf-engine=xelatex`).
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
13631869
1364−[BCP 47]: https://tools.ietf.org/html/bcp47
1365−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1870+- If `variable` is an array, the material inside the loop will
1871+ be evaluated repeatedly, with `variable` being set to each
1872+ value of the array in turn, and concatenated.
1873+- If `variable` is a map, the material inside will be set to
1874+ the map.
1875+- If the value of the associated variable is not an array or
1876+ a map, a single iteration will be performed on its value.
13661877
1367−Variables for slides
1368−--------------------
1878+Examples:
13691879
1370−Variables are available for [producing slide shows with pandoc],
1371−including all [reveal.js configuration options].
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
13721882
1373−`titlegraphic`
1374−: title graphic for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
13751886
1376−`logo`
1377−: logo for Beamer documents
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
13781890
1379−`slidy-url`
1380−: base URL for Slidy documents (defaults to
1381− `https://www.w3.org/Talks/Tools/Slidy2`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
13821895
1383−`slideous-url`
1384−: base URL for Slideous documents (defaults to `slideous`)
1896+You may optionally specify a separator between consecutive
1897+values using `sep` (enclosed in matched delimiters). The
1898+material between `sep` and the `endfor` is the separator.
13851899
1386−`s5-url`
1387−: base URL for S5 documents (defaults to `s5/default`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
13881903
1389−`revealjs-url`
1390−: base URL for reveal.js documents (defaults to `reveal.js`)
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
13911906
1392−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1393−: themes for LaTeX [`beamer`] documents
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
13941912
1395−`themeoptions`
1396−: options for LaTeX beamer themes (a list).
1913+### Partials
13971914
1398−`navigation`
1399−: controls navigation symbols in `beamer` documents
1400− (default is `empty` for no navigation symbols; other valid values
1401− are `frame`, `vertical`, and `horizontal`).
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
14021918
1403−`section-titles`
1404−: enables on "title pages" for new sections in `beamer`
1405− documents (default = true).
1919+```
1920+${ styles() }
1921+```
14061922
1407−`beamerarticle`
1408−: when true, the `beamerarticle` package is loaded (for
1409− producing an article from beamer slides).
1923+Partials will be sought in the directory containing
1924+the main template. The file name will be assumed to
1925+have the same extension as the main template if it
1926+lacks an extension. When calling the partial, the
1927+full name including file extension can also be used:
14101928
1411−`aspectratio`
1412−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1413− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1414− default, and `32` for 3:2).
1929+```
1930+${ styles.html() }
1931+```
14151932
1416−[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.)
14171937
1418−Variables for LaTeX
1419−-------------------
1938+Partials may optionally be applied to variables using
1939+a colon:
14201940
1421−LaTeX variables are used when [creating a PDF].
1941+```
1942+${ date:fancy() }
14221943
1423−`papersize`
1424−: paper size, e.g. `letter`, `a4`
1944+${ articles:bibentry() }
1945+```
14251946
1426−`fontsize`
1427−: font size for body text (e.g. `10pt`, `12pt`)
1947+If `articles` is an array, this will iterate over its
1948+values, applying the partial `bibentry()` to each one. So the
1949+second example above is equivalent to
14281950
1429−`documentclass`
1430−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
14311956
1432−`classoption`
1433−: option for document class, e.g. `oneside`; may be repeated
1434− for multiple options
1957+Note that the anaphoric keyword `it` must be used when
1958+iterating over partials. In the above examples,
1959+the `bibentry` partial should contain `it.title`
1960+(and so on) instead of `articles.title`.
14351961
1436−`geometry`
1437−: option for [`geometry`] package, e.g. `margin=1in`;
1438− may be repeated for multiple options
1962+Final newlines are omitted from included partials.
14391963
1440−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1441−: sets margins, if `geometry` is not used (otherwise `geometry`
1442− overrides these)
1964+Partials may include other partials.
14431965
1444−`linestretch`
1445−: adjusts line spacing using the [`setspace`]
1446− package, e.g. `1.25`, `1.5`
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
14471969
1448−`fontfamily`
1449−: font package for use with `pdflatex`:
1450− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1451− The default is [Latin Modern][`lm`].
1970+```
1971+${months[, ]}$
14521972
1453−`fontfamilyoptions`
1454−: options for package used as `fontfamily`: e.g. `osf,sc` with
1455− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1456− figures and true small caps; may be repeated for multiple options
1973+${articles:bibentry()[; ]$
1974+```
14571975
1458−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1459−: font families for use with `xelatex` or
1460− `lualatex`: take the name of any system font, using the
1461− [`fontspec`] package. Note that if `CJKmainfont` is used,
1462− the [`xecjk`] package must be available.
1976+The separator in this case is literal and (unlike with `sep`
1977+in an explicit `for` loop) cannot contain interpolated
1978+variables or other template directives.
14631979
1464−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1465−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1466− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1467− available through [`fontspec`], such as the OpenType features
1468− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1980+### Nesting
14691981
1470−`fontenc`
1471−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1472− default is `T1` (see guide to [LaTeX font encodings])
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
14731984
1474−`microtypeoptions`
1475−: options to pass to the microtype package
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
14761988
1477−`colorlinks`
1478−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1479− `urlcolor`, or `toccolor` are set
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
14801991
1481−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1482−: color for internal links, citation links, external links, and links in table of contents:
1483− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
14841996
1485−`links-as-notes`
1486−: causes links to be printed as footnotes
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
14871999
1488−`indent`
1489−: uses document class settings for indentation (the default LaTeX template
1490− otherwise removes indentation and adds space between paragraphs)
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
14912004
1492−`subparagraph`
1493−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1494− as sections, changing the appearance of nested headings in some classes
2005+will produce
14952006
1496−`thanks`
1497−: specifies contents of acknowledgments footnote after document title.
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
14982012
1499−`toc`
1500−: include table of contents (can also be set using `--toc/--table-of-contents`)
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
15012017
1502−`toc-depth`
1503−: level of section to include in table of contents
2018+### Breakable spaces
15042019
1505−`secnumdepth`
1506−: numbering depth for sections, if sections are numbered
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
15072024
1508−`lof`, `lot`
1509−: include list of figures, list of tables
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
15102029
1511−`bibliography`
1512−: bibliography to use for resolving references
2030+### Pipes
15132031
1514−`biblio-style`
1515−: bibliography style, when used with `--natbib` and `--biblatex`.
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
15162035
1517−`biblio-title`
1518−: bibliography title, when used with `--natbib` and `--biblatex`.
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
15192040
1520−`biblatexoptions`
1521−: list of options for biblatex.
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
15222044
1523−`natbiboptions`
1524−: list of options for natbib.
2045+$employee:name()/uppercase$
2046+```
15252047
1526−`pagestyle`
1527−: An option for LaTeX's `\pagestyle{}`. The default article class
1528− supports 'plain' (default), 'empty', and 'headings'; headings puts
1529− section titles in the header.
2048+Pipes may be chained:
15302049
1531−[`article`]: https://ctan.org/pkg/article
1532−[`report`]: https://ctan.org/pkg/report
1533−[`book`]: https://ctan.org/pkg/book
1534−[KOMA-Script]: https://ctan.org/pkg/koma-script
1535−[`memoir`]: https://ctan.org/pkg/memoir
1536−[`xcolor`]: https://ctan.org/pkg/xcolor
1537−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1538−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1539−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
15402055
1541−Variables for ConTeXt
1542−---------------------
2056+Some pipes take parameters:
15432057
1544−`papersize`
1545−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1546− may be repeated for multiple options
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
15472065
1548−`layout`
1549−: options for page margins and text arrangement (see [ConTeXt Layout]);
1550− may be repeated for multiple options
2066+Currently the following pipes are predefined:
15512067
1552−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1553−: sets margins, if `layout` is not used (otherwise `layout`
1554− overrides these)
2068+- `pairs`: Converts a map or array to an array of maps,
2069+ each with `key` and `value` fields. If the original
2070+ value was an array, the `key` will be the array index,
2071+ starting with 1.
15552072
1556−`fontsize`
1557−: font size for body text (e.g. `10pt`, `12pt`)
2073+- `uppercase`: Converts text to uppercase.
15582074
1559−`mainfont`, `sansfont`, `monofont`, `mathfont`
1560−: font families: take the name of any system font (see [ConTeXt Font Switching])
2075+- `lowercase`: Converts text to lowercase.
15612076
1562−`linkcolor`, `contrastcolor`
1563−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
15642080
1565−`linkstyle`
1566−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
15672083
1568−`indenting`
1569−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1570− may be repeated for multiple options
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
15712087
1572−`whitespace`
1573−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
15742091
1575−`interlinespace`
1576−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1577− may be repeated for multiple options
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
15782095
1579−`headertext`, `footertext`
1580−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1581− may be repeated up to four times for different placement
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
15822099
1583−`pagenumbering`
1584−: page number style and location (using [`setuppagenumbering`]);
1585− may be repeated for multiple options
2100+- `chomp`: Removes trailing newlines (and breakable space).
15862101
1587−`toc`
1588−: include table of contents (can also be set using `--toc/--table-of-contents`)
2102+- `nowrap`: Disables line wrapping on breakable spaces.
15892103
1590−`lof`, `lot`
1591−: include list of figures, list of tables
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
15922109
1593−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1594−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1595−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1596−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1597−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1598−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1599−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1600−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1601−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
16022114
1603−Variables for man pages
1604−-----------------------
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.
16052122
1606−`section`
1607−: section number in man pages
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
16082126
1609−`header`
1610−: header in man pages
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
16112130
1612−`footer`
1613−: footer in man pages
16142131
1615−`adjusting`
1616−: adjusts text to left (`l`), right (`r`), center (`c`),
1617− or both (`b`) margins
2132+## Variables
16182133
1619−`hyphenate`
1620−: if `true` (the default), hyphenation will be used
2134+### Metadata variables
16212135
1622−Variables for ms
1623−----------------
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`]:
16242142
1625−`pointsize`
1626−: point size (e.g. `10p`)
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
16272148
1628−`lineheight`
1629−: line height (e.g. `12p`)
2149+ Note that if you just want to set PDF or HTML metadata, without
2150+ including a title block in the document itself, you can
2151+ set the `title-meta`, `author-meta`, and `date-meta`
2152+ variables. (By default these are set automatically, based
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
16302155
1631−`fontfamily`
1632−: font family (e.g. `T` or `P`)
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
16332159
1634−`indent`
1635−: paragraph indent (e.g. `2m`)
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
16362163
1637−Using variables in templates
1638−----------------------------
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
16392167
1640−Variable names are sequences of alphanumerics, `-`, and `_`,
1641−starting with a letter. A variable name surrounded by `$` signs
1642−will be replaced by its value. For example, the string `$title$` in
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
16432170
1644− <title>$title$</title>
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
16452174
1646−will be replaced by the document title.
2175+`category`
2176+: document category, included in docx and pptx metadata
16472177
1648−To write a literal `$` in a template, use `$$`.
2178+Additionally,
2179+any root-level string metadata, not included in ODT, docx
2180+or pptx metadata is added as a *custom property*.
2181+The following [YAML] metadata block for instance:
16492182
1650−Templates may contain conditionals. The syntax is as follows:
2183+ ---
2184+ title: 'This is the title'
2185+ subtitle: "This is the subtitle"
2186+ author:
2187+ - Author One
2188+ - Author Two
2189+ description: |
2190+ This is a long
2191+ description.
16512192
1652− $if(variable)$
1653− X
1654− $else$
1655− Y
1656− $endif$
2193+ It consists of two paragraphs
2194+ ...
16572195
1658−This will include `X` in the template if `variable` has a non-null
1659−value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1660−any valid template text, and may include interpolated variables or other
1661−conditionals. The `$else$` section may be omitted.
2196+will include `title`, `author` and `description` as standard document
2197+properties and `subtitle` as a custom property when converting to docx,
2198+ODT or pptx.
16622199
1663−When variables can have multiple values (for example, `author` in
1664−a multi-author document), you can use the `$for$` keyword:
2200+### Language variables
16652201
1666− $for(author)$
1667− <meta name="author" content="$author$" />
1668− $endfor$
2202+`lang`
2203+: identifies the main language of the document using IETF language
2204+ tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205+ The [Language subtag lookup] tool can look up or verify these tags.
2206+ This affects most formats, and controls hyphenation in PDF output
2207+ when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
16692208
1670−You can optionally specify a separator to be used between
1671−consecutive items:
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
16722211
1673− $for(author)$$author$$sep$, $endfor$
2212+ ---
2213+ lang: en-GB
2214+ ...
16742215
1675−A dot can be used to select a field of a variable that takes
1676−an object as its value. So, for example:
2216+ Text in the main document language (British English).
16772217
1678− $author.name$ ($author.affiliation$)
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
16792221
1680−If you use custom templates, you may need to revise them as pandoc
1681−changes. We recommend tracking the changes in the default templates,
1682−and modifying your custom templates accordingly. An easy way to do this
1683−is to fork the [pandoc-templates] repository and merge in changes after each
1684−pandoc release.
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
16852223
1686−Templates may contain comments: anything on a line after `$--`
1687−will be treated as a comment and ignored.
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
16882227
1689−[pandoc-templates]: https://github.com/jgm/pandoc-templates
2228+ For bidirectional documents, native pandoc `span`s and
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230+ be used to override the base direction in some output
2231+ formats. This may not always be necessary if the final
2232+ renderer (e.g. the browser, when generating HTML) supports
2233+ the [Unicode Bidirectional Algorithm].
16902234
1691−Extensions
1692−==========
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
16932238
1694−The behavior of some of the readers and writers can be adjusted by
1695−enabling or disabling various extensions.
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/
16962242
1697−An extension can be enabled by adding `+EXTENSION`
1698−to the format name and disabled by adding `-EXTENSION`. For example,
1699−`--from markdown_strict+footnotes` is strict Markdown with footnotes
1700−enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
1701−Markdown without footnotes or pipe tables.
2243+### Variables for HTML
17022244
1703−The markdown reader and writer make by far the most use of extensions.
1704−Extensions only used by them are therefore covered in the
1705−section [Pandoc's Markdown] below (See [Markdown variants] for
1706−`commonmark` and `gfm`.) In the following, extensions that also work
1707−for other formats are covered.
2245+`document-css`
2246+: Enables inclusion of most of the [CSS] in the `styles.html`
2247+ [partial](#partials) (have a look with
2248+ `pandoc --print-default-data-file=templates/styles.html`).
2249+ Unless you use [`--css`](#option--css), this variable
2250+ is set to `true` by default. You can disable it with
2251+ e.g. `pandoc -M document-css=false`.
17082252
1709−Typography
1710−----------
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
17112255
1712−#### Extension: `smart` ####
2256+`fontsize`
2257+: sets the base CSS `font-size`, which you'd usually set
2258+ to e.g. `20px`, but it also accepts `pt`
2259+ (12pt = 16px in most browsers).
17132260
1714−Interpret straight quotes as curly quotes, `---` as em-dashes,
1715−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
1716−inserted after certain abbreviations, such as "Mr."
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
17172263
1718−This extension can be enabled/disabled for the following formats:
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
17192266
1720−input formats
1721−: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
17222269
1723−output formats
1724−: `markdown`, `latex`, `context`, `rst`
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
17252273
1726−enabled by default in
1727−: `markdown`, `latex`, `context` (both input and output)
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
17282277
1729−Note: If you are *writing* Markdown, then the `smart` extension
1730−has the reverse effect: what would have been curly quotes comes
1731−out straight.
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
17322280
1733−In LaTeX, `smart` means to use the standard TeX ligatures
1734−for quotation marks (` `` ` and ` '' ` for double quotes,
1735−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
1736−en-dash and `---` for em-dash). If `smart` is disabled,
1737−then in reading LaTeX pandoc will parse these characters
1738−literally. In writing LaTeX, enabling `smart` tells pandoc
1739−to use the ligatures when possible; if `smart` is disabled
1740−pandoc will use unicode quotation mark and dash characters.
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
17412283
1742−Headers and sections
1743−--------------------
2284+To override or extend some [CSS] for just one document, include for example:
17442285
1745−#### Extension: `auto_identifiers` ####
2286+ ---
2287+ header-includes: |
2288+ <style>
2289+ blockquote {
2290+ font-style: italic;
2291+ }
2292+ tr.even {
2293+ background-color: #f0f0f0;
2294+ }
2295+ td, th {
2296+ padding: 0.5em 2em 0.5em 0.5em;
2297+ }
2298+ tbody {
2299+ border-bottom: none;
2300+ }
2301+ </style>
2302+ ---
17462303
1747−A header without an explicitly specified identifier will be
1748−automatically assigned a unique identifier based on the header text.
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
17492305
1750−This extension can be enabled/disabled for the following formats:
2306+### Variables for HTML math
17512307
1752−input formats
1753−: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2308+`classoption`
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
17542312
1755−output formats
1756−: `markdown`, `muse`
2313+### Variables for HTML slides
17572314
1758−enabled by default in
1759−: `markdown`, `muse`
2315+These affect HTML output when [producing slide shows with pandoc].
17602316
1761−The algorithm used to derive the identifier from the header text is:
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
17622319
1763− - Remove all formatting, links, etc.
1764− - Remove all footnotes.
1765− - Remove all punctuation, except underscores, hyphens, and periods.
1766− - Replace all spaces and newlines with hyphens.
1767− - Convert all alphabetic characters to lowercase.
1768− - Remove everything up to the first letter (identifiers may
1769− not begin with a number or punctuation mark).
1770− - If nothing is left after this, use the identifier `section`.
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
17712323
1772−Thus, for example,
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
17732326
1774− Header Identifier
1775− ------------------------------- ----------------------------
1776− `Header identifiers in HTML` `header-identifiers-in-html`
1777− `*Dogs*?--in *my* house?` `dogs--in-my-house`
1778− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1779− `3. Applications` `applications`
1780− `33` `section`
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
17812330
1782−These rules should, in most cases, allow one to determine the identifier
1783−from the header text. The exception is when several headers have the
1784−same text; in this case, the first will get an identifier as described
1785−above; the second will get the same identifier with `-1` appended; the
1786−third with `-2`; and so on.
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
17872333
1788−These identifiers are used to provide link targets in the table of
1789−contents generated by the `--toc|--table-of-contents` option. They
1790−also make it easy to provide links from one section of a document to
1791−another. A link to this section, for example, might look like this:
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.
17922337
1793− See the section on
1794− [header identifiers](#header-identifiers-in-html-latex-and-context).
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`.
17952340
1796−Note, however, that this method of providing links to sections works
1797−only in HTML, LaTeX, and ConTeXt formats.
2341+[reveal.js configuration options]: https://revealjs.com/config/
17982342
1799−If the `--section-divs` option is specified, then each section will
1800−be wrapped in a `div` (or a `section`, if `html5` was specified),
1801−and the identifier will be attached to the enclosing `<div>`
1802−(or `<section>`) tag rather than the header itself. This allows entire
1803−sections to be manipulated using JavaScript or treated differently in
1804−CSS.
2343+### Variables for Beamer slides
18052344
1806−#### Extension: `ascii_identifiers` ####
2345+These variables change the appearance of PDF slides using [`beamer`].
18072346
1808−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
1809−Accents are stripped off of accented Latin letters, and non-Latin
1810−letters are omitted.
2347+`aspectratio`
2348+: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349+ `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350+ `32` for 3:2)
18112351
1812−Math Input
1813−----------
2352+`beamerarticle`
2353+: produce an article from Beamer slides
18142354
1815−The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
1816−[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
1817−[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
1818−are described in the section about Pandoc's Markdown.
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
18192357
1820−However, they can also be used with HTML input. This is handy for
1821−reading web pages formatted using MathJax, for example.
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
18222360
1823−Raw HTML/TeX
1824−------------
2361+`logo`
2362+: logo image for slides
18252363
1826−The following extensions (especially how they affect Markdown
1827−input/output) are also described in more detail in their respective
1828−sections of [Pandoc's Markdown].
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
18292367
1830−#### [Extension: `raw_html`] {#raw_html}
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
18312370
1832−When converting from HTML, parse elements to raw HTML which are not
1833−representable in pandoc's AST.
1834−By default, this is disabled for HTML input.
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
18352373
1836−#### [Extension: `raw_tex`] {#raw_tex}
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
18372376
1838−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2377+`titlegraphic`
2378+: image for title slide
18392379
1840−This extension can be enabled/disabled for the following formats
1841−(in addition to `markdown`):
2380+### Variables for PowerPoint
18422381
1843−input formats
1844−: `latex`, `org`, `textile`
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
18452384
1846−output formats
1847−: `textile`
2385+`monofont`
2386+: font to use for code.
18482387
1849−#### [Extension: `native_divs`] {#native_divs}
2388+### Variables for LaTeX
18502389
1851−This extension is enabled by default for HTML input. This means that
1852−`div`s are parsed to pandoc native elements. (Alternatively, you
1853−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
18542391
1855−When converting HTML to Markdown, for example, you may want to drop all
1856−`div`s and `span`s:
2392+#### Layout
18572393
1858− pandoc -f html-native_divs-native_spans -t markdown
2394+`block-headings`
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
2397+ classes) free-standing rather than run-in; requires further
2398+ formatting to distinguish from `\subsubsection` (third- or
2399+ fourth-level headings). Instead of using this option,
2400+ [KOMA-Script] can adjust headings more extensively:
18592401
1860−#### [Extension: `native_spans`] {#native_spans}
2402+ ---
2403+ documentclass: scrartcl
2404+ header-includes: |
2405+ \RedeclareSectionCommand[
2406+ beforeskip=-10pt plus -2pt minus -1pt,
2407+ afterskip=1sp plus -1sp minus 1sp,
2408+ font=\normalfont\itshape]{paragraph}
2409+ \RedeclareSectionCommand[
2410+ beforeskip=-10pt plus -2pt minus -1pt,
2411+ afterskip=1sp plus -1sp minus 1sp,
2412+ font=\normalfont\scshape,
2413+ indent=0pt]{subparagraph}
2414+ ...
18612415
1862−Analogous to `native_divs` above.
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
18632418
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
18642424
1865−Literate Haskell support
1866−------------------------
2425+`documentclass`
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429+ default to smaller margins; or [`memoir`]
18672430
1868−#### Extension: `literate_haskell` ####
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
18692434
1870−Treat the document as literate Haskell source.
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
18712441
1872−This extension can be enabled/disabled for the following formats:
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
18732445
1874−input formats
1875−: `markdown`, `rst`, `latex`
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
18762452
1877−output formats
1878−: `markdown`, `rst`, `latex`, `html`
2453+`indent`
2454+: if true, pandoc will use document class settings for
2455+ indentation (the default LaTeX template otherwise removes
2456+ indentation and adds space between paragraphs)
18792457
1880−If you append `+lhs` (or `+literate_haskell`) to one of the formats
1881−above, pandoc will treat the document as literate Haskell source.
1882−This means that
2458+`linestretch`
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
18832461
1884− - In Markdown input, "bird track" sections will be parsed as Haskell
1885− code rather than block quotations. Text between `\begin{code}`
1886− and `\end{code}` will also be treated as Haskell code. For
1887− ATX-style headers the character '=' will be used instead of '#'.
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
2464+ overrides these)
18882465
1889− - In Markdown output, code blocks with classes `haskell` and `literate`
1890− will be rendered using bird tracks, and block quotations will be
1891− indented one space, so they will not be treated as Haskell code.
1892− In addition, headers will be rendered setext-style (with underlines)
1893− rather than ATX-style (with '#' characters). (This is because ghc
1894− treats '#' characters in column 1 as introducing line numbers.)
2466+`pagestyle`
2467+: control `\pagestyle{}`: the default article class
2468+ supports `plain` (default), `empty` (no running heads or page numbers),
2469+ and `headings` (section titles in running heads)
18952470
1896− - In restructured text input, "bird track" sections will be parsed
1897− as Haskell code.
2471+`papersize`
2472+: paper size, e.g. `letter`, `a4`
18982473
1899− - In restructured text output, code blocks with class `haskell` will
1900− be rendered using bird tracks.
2474+`secnumdepth`
2475+: numbering depth for sections (with `--number-sections` option
2476+ or `numbersections` variable)
19012477
1902− - In LaTeX input, text in `code` environments will be parsed as
1903− Haskell code.
2478+#### Fonts
19042479
1905− - In LaTeX output, code blocks with class `haskell` will be rendered
1906− inside `code` environments.
2480+`fontenc`
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
19072483
1908− - In HTML output, code blocks with class `haskell` will be rendered
1909− with class `literatehaskell` and bird tracks.
2484+`fontfamily`
2485+: font package for use with `pdflatex`:
2486+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487+ The default is [Latin Modern][`lm`].
19102488
1911−Examples:
2489+`fontfamilyoptions`
2490+: options for package used as `fontfamily`; repeat for multiple options.
2491+ For example, to use the Libertine font with proportional lowercase
2492+ (old-style) figures through the [`libertinus`] package:
19122493
1913− pandoc -f markdown+lhs -t html
2494+ ---
2495+ fontfamily: libertinus
2496+ fontfamilyoptions:
2497+ - osf
2498+ - p
2499+ ...
19142500
1915−reads literate Haskell source formatted with Markdown conventions and writes
1916−ordinary HTML (without bird tracks).
2501+`fontsize`
2502+: font size for body text. The standard classes allow 10pt, 11pt, and
2503+ 12pt. To use another size, set `documentclass` to one of
2504+ the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
19172505
1918− pandoc -f markdown+lhs -t html+lhs
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.
19192510
1920−writes HTML with the Haskell code in bird tracks, so it can be copied
1921−and pasted as literate Haskell source.
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:
19222517
1923−Note that GHC expects the bird tracks in the first column, so indentend literate
1924−code blocks (e.g. inside an itemized environment) will not be picked up by the
1925−Haskell compiler.
2518+ ---
2519+ mainfont: TeX Gyre Pagella
2520+ mainfontoptions:
2521+ - Numbers=Lowercase
2522+ - Numbers=Proportional
2523+ ...
19262524
1927−Other extensions
1928−----------------
2525+`microtypeoptions`
2526+: options to pass to the microtype package
19292527
1930−#### Extension: `empty_paragraphs` ####
2528+#### Links
19312529
1932−Allows empty paragraphs. By default empty paragraphs are
1933−omitted.
2530+`colorlinks`
2531+: add color to link text; automatically enabled if any of
2532+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
19342533
1935−This extension can be enabled/disabled for the following formats:
2534+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535+: color for internal links, external links, citation links, linked
2536+ URLs, and links in table of contents, respectively: uses options
2537+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538+ `x11names` lists
19362539
1937−input formats
1938−: `docx`, `html`
2540+`links-as-notes`
2541+: causes links to be printed as footnotes
19392542
1940−output formats
1941−: `markdown`, `docx`, `odt`, `opendocument`, `html`
2543+#### Front matter
19422544
1943−#### Extension: `amuse` ####
2545+`lof`, `lot`
2546+: include list of figures, list of tables
19442547
1945−In the `muse` input format, this enables Text::Amuse
1946−extensions to Emacs Muse markup.
2548+`thanks`
2549+: contents of acknowledgments footnote after document title
19472550
1948−#### Extension: `citations` {#org-citations}
2551+`toc`
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
19492554
1950−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
1951−in `org` input.
2555+`toc-depth`
2556+: level of section to include in table of contents
19522557
2558+#### BibLaTeX Bibliographies
19532559
1954−Pandoc's Markdown
1955−=================
2560+These variables function when using BibLaTeX for [citation rendering].
19562561
1957−Pandoc understands an extended and slightly revised version of
1958−John Gruber's [Markdown] syntax. This document explains the syntax,
1959−noting differences from standard Markdown. Except where noted, these
1960−differences can be suppressed by using the `markdown_strict` format instead
1961−of `markdown`. Extensions can be enabled or disabled to specify the
1962−behavior more granularly. They are described in the following. See also
1963−[Extensions] above, for extensions that work also on other formats.
2562+`biblatexoptions`
2563+: list of options for biblatex
19642564
1965−Philosophy
1966−----------
2565+`biblio-style`
2566+: bibliography style, when used with `--natbib` and `--biblatex`.
19672567
1968−Markdown is designed to be easy to write, and, even more importantly,
1969−easy to read:
2568+`biblio-title`
2569+: bibliography title, when used with `--natbib` and `--biblatex`.
19702570
1971−> A Markdown-formatted document should be publishable as-is, as plain
1972−> text, without looking like it's been marked up with tags or formatting
1973−> instructions.
1974−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2571+`bibliography`
2572+: bibliography to use for resolving references
19752573
1976−This principle has guided pandoc's decisions in finding syntax for
1977−tables, footnotes, and other extensions.
2574+`natbiboptions`
2575+: list of options for natbib
19782576
1979−There is, however, one respect in which pandoc's aims are different
1980−from the original aims of Markdown. Whereas Markdown was originally
1981−designed with HTML generation in mind, pandoc is designed for multiple
1982−output formats. Thus, while pandoc allows the embedding of raw HTML,
1983−it discourages it, and provides other, non-HTMLish ways of representing
1984−important document elements like definition lists, tables, mathematics, and
1985−footnotes.
2577+[KOMA-Script]: https://ctan.org/pkg/koma-script
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579+[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580+[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581+[`article`]: https://ctan.org/pkg/article
2582+[`book`]: https://ctan.org/pkg/book
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
2584+[`memoir`]: https://ctan.org/pkg/memoir
2585+[`report`]: https://ctan.org/pkg/report
19862586
1987−Paragraphs
1988−----------
2587+### Variables for ConTeXt
19892588
1990−A paragraph is one or more lines of text followed by one or more blank lines.
1991−Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1992−If you need a hard line break, put two or more spaces at the end of a line.
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
19932590
1994−#### Extension: `escaped_line_breaks` ####
2591+`fontsize`
2592+: font size for body text (e.g. `10pt`, `12pt`)
19952593
1996−A backslash followed by a newline is also a hard line break.
1997−Note: in multiline and grid table cells, this is the only way
1998−to create a hard line break, since trailing spaces in the cells
1999−are ignored.
2594+`headertext`, `footertext`
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
20002597
2001−Headers
2002−-------
2598+`indenting`
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
20032601
2004−There are two kinds of headers: Setext and ATX.
2602+`interlinespace`
2603+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604+ repeat for multiple options
20052605
2006−### Setext-style headers ###
2606+`layout`
2607+: options for page margins and text arrangement (see [ConTeXt Layout]);
2608+ repeat for multiple options
20072609
2008−A setext-style header is a line of text "underlined" with a row of `=` signs
2009−(for a level one header) or `-` signs (for a level two header):
2610+`linkcolor`, `contrastcolor`
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
20102613
2011− A level-one header
2012− ==================
2614+`linkstyle`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
20132617
2014− A level-two header
2015− ------------------
2618+`lof`, `lot`
2619+: include list of figures, list of tables
20162620
2017−The header text can contain inline formatting, such as emphasis (see
2018−[Inline formatting], below).
2621+`mainfont`, `sansfont`, `monofont`, `mathfont`
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
20192624
2625+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626+: sets margins, if `layout` is not used (otherwise `layout`
2627+ overrides these)
20202628
2021−### ATX-style headers ###
2629+`pagenumbering`
2630+: page number style and location (using [`setuppagenumbering`]);
2631+ repeat for multiple options
20222632
2023−An ATX-style header consists of one to six `#` signs and a line of
2024−text, optionally followed by any number of `#` signs. The number of
2025−`#` signs at the beginning of the line is the header level:
2633+`papersize`
2634+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635+ repeat for multiple options
2636+
2637+`pdfa`
2638+: adds to the preamble the setup necessary to generate PDF/A
2639+ of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640+ specified (i.e. the value is set to True, by e.g.
2641+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642+ `1b:2005` will be used as default, for reasons of backwards
2643+ compatibility. Using `--variable=pdfa` without specified value
2644+ is not supported. To successfully generate PDF/A the required
2645+ ICC color profiles have to be available and the content and all
2646+ included files (such as images) have to be standard conforming.
2647+ The ICC profiles and output intent may be specified using the
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649+ PDFA] for more details.
2650+
2651+`pdfaiccprofile`
2652+: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653+ in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654+ used as default. May be repeated to include multiple profiles. Note that
2655+ the profiles have to be available on the system. They can be obtained
2656+ from [ConTeXt ICC Profiles].
2657+
2658+`pdfaintent`
2659+: when used in conjunction with `pdfa`, specifies the output intent for
2660+ the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661+ If left unspecified, `sRGB IEC61966-2.1` is used as default.
20262662
2027− ## A level-two header
2663+`toc`
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
20282666
2029− ### A level-three header ###
2667+`whitespace`
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
20302670
2031−As with setext-style headers, the header text can contain formatting:
2671+`includesource`
2672+: include all source documents as file attachments in the PDF file
20322673
2033− # A level-one header with a [link](/url) and *emphasis*
2674+[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675+[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676+[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677+[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678+[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679+[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680+[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681+[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682+[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683+[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684+[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
20342685
2035−#### Extension: `blank_before_header` ####
2686+### Variables for `wkhtmltopdf`
20362687
2037−Standard Markdown syntax does not require a blank line before a header.
2038−Pandoc does require this (except, of course, at the beginning of the
2039−document). The reason for the requirement is that it is all too easy for a
2040−`#` to end up at the beginning of a line by accident (perhaps through line
2041−wrapping). Consider, for example:
2688+Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689+The `--css` option also affects the output.
20422690
2043− I like several of their flavors of ice cream:
2044− #22, for example, and #5.
2691+`footer-html`, `header-html`
2692+: add information to the header and footer
20452693
2046−#### Extension: `space_in_atx_header` ####
2694+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695+: set the page margins
20472696
2048−Many Markdown implementations do not require a space between the
2049−opening `#`s of an ATX header and the header text, so that
2050−`#5 bolt` and `#hashtag` count as headers. With this extension,
2051−pandoc does require the space.
2697+`papersize`
2698+: sets the PDF paper size
20522699
2053−### Header identifiers ###
2700+### Variables for man pages
20542701
2055−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
2702+`adjusting`
2703+: adjusts text to left (`l`), right (`r`), center (`c`),
2704+ or both (`b`) margins
20562705
2057−#### Extension: `header_attributes` ####
2706+`footer`
2707+: footer in man pages
20582708
2059−Headers can be assigned attributes using this syntax at the end
2060−of the line containing the header text:
2709+`header`
2710+: header in man pages
20612711
2062− {#identifier .class .class key=value key=value}
2712+`hyphenate`
2713+: if `true` (the default), hyphenation will be used
20632714
2064−Thus, for example, the following headers will all be assigned the identifier
2065−`foo`:
2715+`section`
2716+: section number in man pages
20662717
2067− # My header {#foo}
2718+### Variables for ms
20682719
2069− ## My header ## {#foo}
2720+`fontfamily`
2721+: font family (e.g. `T` or `P`)
20702722
2071− My other header {#foo}
2072− ---------------
2723+`indent`
2724+: paragraph indent (e.g. `2m`)
20732725
2074−(This syntax is compatible with [PHP Markdown Extra].)
2726+`lineheight`
2727+: line height (e.g. `12p`)
20752728
2076−Note that although this syntax allows assignment of classes and key/value
2077−attributes, writers generally don't use all of this information. Identifiers,
2078−classes, and key/value attributes are used in HTML and HTML-based formats such
2079−as EPUB and slidy. Identifiers are used for labels and link anchors in the
2080−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2729+`pointsize`
2730+: point size (e.g. `10p`)
20812731
2082−Headers with the class `unnumbered` will not be numbered, even if
2083−`--number-sections` is specified. A single hyphen (`-`) in an attribute
2084−context is equivalent to `.unnumbered`, and preferable in non-English
2085−documents. So,
2732+### Variables set automatically
20862733
2087− # My header {-}
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:
20882737
2089−is just the same as
2738+`body`
2739+: body of document
20902740
2091− # My header {.unnumbered}
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`).
20922750
2093−#### Extension: `implicit_header_references` ####
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
20942754
2095−Pandoc behaves as if reference links have been defined for each header.
2096−So, to link to a header
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
20972758
2098− # Header identifiers in HTML
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
20992762
2100−you can simply write
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
21012766
2102− [Header identifiers in HTML]
2767+`numbersections`
2768+: non-null value if `-N/--number-sections` was specified
21032769
2104−or
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:
21052775
2106− [Header identifiers in HTML][]
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
21072783
2108−or
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
21092785
2110− [the section on header identifiers][header identifiers in
2111− HTML]
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
21122787
2113−instead of giving the identifier explicitly:
2788+`curdir`
2789+: working directory from which pandoc is run.
21142790
2115− [Header identifiers in HTML](#header-identifiers-in-html)
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
21162793
2117−If there are multiple headers with identical text, the corresponding
2118−reference will link to the first one only, and you will need to use explicit
2119−links to link to the others, as described above.
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
21202797
2121−Like regular reference links, these references are case-insensitive.
2798+[pandoc-templates]: https://github.com/jgm/pandoc-templates
21222799
2123−Explicit link reference definitions always take priority over
2124−implicit header references. So, in the following example, the
2125−link will point to `bar`, not to `#foo`:
2800+# Extensions
21262801
2127− # Foo
2802+The behavior of some of the readers and writers can be adjusted by
2803+enabling or disabling various extensions.
21282804
2129− [foo]: bar
2805+An extension can be enabled by adding `+EXTENSION`
2806+to the format name and disabled by adding `-EXTENSION`. For example,
2807+`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809+Markdown without footnotes or pipe tables.
21302810
2131− See [foo]
2811+The markdown reader and writer make by far the most use of extensions.
2812+Extensions only used by them are therefore covered in the
2813+section [Pandoc's Markdown] below (See [Markdown variants] for
2814+`commonmark` and `gfm`.) In the following, extensions that also work
2815+for other formats are covered.
21322816
2133−Block quotations
2134−----------------
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`).
21352820
2136−Markdown uses email conventions for quoting blocks of text.
2137−A block quotation is one or more paragraphs or other block elements
2138−(such as lists or headers), with each line preceded by a `>` character
2139−and an optional space. (The `>` need not start at the left margin, but
2140−it should not be indented more than three spaces.)
2821+## Typography
21412822
2142− > This is a block quote. This
2143− > paragraph has two lines.
2144− >
2145− > 1. This is a list inside a block quote.
2146− > 2. Second item.
2823+#### Extension: `smart` ####
21472824
2148−A "lazy" form, which requires the `>` character only on the first
2149−line of each block, is also allowed:
2825+Interpret straight quotes as curly quotes, `---` as em-dashes,
2826+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2827+inserted after certain abbreviations, such as "Mr."
21502828
2151− > This is a block quote. This
2152− paragraph has two lines.
2829+This extension can be enabled/disabled for the following formats:
21532830
2154− > 1. This is a list inside a block quote.
2155− 2. Second item.
2831+input formats
2832+: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
21562833
2157−Among the block elements that can be contained in a block quote are
2158−other block quotes. That is, block quotes can be nested:
2834+output formats
2835+: `markdown`, `latex`, `context`, `rst`
21592836
2160− > This is a block quote.
2161− >
2162− > > A block quote within a block quote.
2837+enabled by default in
2838+: `markdown`, `latex`, `context` (both input and output)
21632839
2164−If the `>` character is followed by an optional space, that space
2165−will be considered part of the block quote marker and not part of
2166−the indentation of the contents. Thus, to put an indented code
2167−block in a block quote, you need five spaces after the `>`:
2840+Note: If you are *writing* Markdown, then the `smart` extension
2841+has the reverse effect: what would have been curly quotes comes
2842+out straight.
21682843
2169− > code
2844+In LaTeX, `smart` means to use the standard TeX ligatures
2845+for quotation marks (` `` ` and ` '' ` for double quotes,
2846+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2847+en-dash and `---` for em-dash). If `smart` is disabled,
2848+then in reading LaTeX pandoc will parse these characters
2849+literally. In writing LaTeX, enabling `smart` tells pandoc
2850+to use the ligatures when possible; if `smart` is disabled
2851+pandoc will use unicode quotation mark and dash characters.
21702852
2171−#### Extension: `blank_before_blockquote` ####
2853+## Headings and sections
21722854
2173−Standard Markdown syntax does not require a blank line before a block
2174−quote. Pandoc does require this (except, of course, at the beginning of the
2175−document). The reason for the requirement is that it is all too easy for a
2176−`>` to end up at the beginning of a line by accident (perhaps through line
2177−wrapping). So, unless the `markdown_strict` format is used, the following does
2178−not produce a nested block quote in pandoc:
2855+#### Extension: `auto_identifiers` ####
21792856
2180− > This is a block quote.
2181− >> Nested.
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
21822859
2860+This extension can be enabled/disabled for the following formats:
21832861
2184−Verbatim (code) blocks
2185−----------------------
2862+input formats
2863+: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
21862864
2187−### Indented code blocks ###
2865+output formats
2866+: `markdown`, `muse`
21882867
2189−A block of text indented four spaces (or one tab) is treated as verbatim
2190−text: that is, special characters do not trigger special formatting,
2191−and all spaces and line breaks are preserved. For example,
2868+enabled by default in
2869+: `markdown`, `muse`
21922870
2193− if (a > 3) {
2194− moveShip(5 * gravity, DOWN);
2195− }
2871+The default algorithm used to derive the identifier from the
2872+heading text is:
21962873
2197−The initial (four space or one tab) indentation is not considered part
2198−of the verbatim text, and is removed in the output.
2874+ - Remove all formatting, links, etc.
2875+ - Remove all footnotes.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
2878+ - Replace all spaces and newlines with hyphens.
2879+ - Convert all alphabetic characters to lowercase.
2880+ - Remove everything up to the first letter (identifiers may
2881+ not begin with a number or punctuation mark).
2882+ - If nothing is left after this, use the identifier `section`.
21992883
2200−Note: blank lines in the verbatim text need not begin with four spaces.
2884+Thus, for example,
22012885
2886+ Heading Identifier
2887+ ------------------------------- ----------------------------
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
2890+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
2891+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2892+ `3. Applications` `applications`
2893+ `33` `section`
22022894
2203−### Fenced code blocks ###
2895+These rules should, in most cases, allow one to determine the identifier
2896+from the heading text. The exception is when several headings have the
2897+same text; in this case, the first will get an identifier as described
2898+above; the second will get the same identifier with `-1` appended; the
2899+third with `-2`; and so on.
22042900
2205−#### Extension: `fenced_code_blocks` ####
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
22062903
2207−In addition to standard indented code blocks, pandoc supports
2208−*fenced* code blocks. These begin with a row of three or more
2209−tildes (`~`) and end with a row of tildes that must be at least as long as
2210−the starting row. Everything between these lines is treated as code. No
2211−indentation is necessary:
2904+These identifiers are used to provide link targets in the table of
2905+contents generated by the `--toc|--table-of-contents` option. They
2906+also make it easy to provide links from one section of a document to
2907+another. A link to this section, for example, might look like this:
22122908
2213− ~~~~~~~
2214− if (a > 3) {
2215− moveShip(5 * gravity, DOWN);
2216− }
2217− ~~~~~~~
2909+ See the section on
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
22182911
2219−Like regular code blocks, fenced code blocks must be separated
2220−from surrounding text by blank lines.
2912+Note, however, that this method of providing links to sections works
2913+only in HTML, LaTeX, and ConTeXt formats.
22212914
2222−If the code itself contains a row of tildes or backticks, just use a longer
2223−row of tildes or backticks at the start and end:
2915+If the `--section-divs` option is specified, then each section will
2916+be wrapped in a `section` (or a `div`, if `html4` was specified),
2917+and the identifier will be attached to the enclosing `<section>`
2918+(or `<div>`) tag rather than the heading itself. This allows entire
2919+sections to be manipulated using JavaScript or treated differently in
2920+CSS.
22242921
2225− ~~~~~~~~~~~~~~~~
2226− ~~~~~~~~~~
2227− code including tildes
2228− ~~~~~~~~~~
2229− ~~~~~~~~~~~~~~~~
2922+#### Extension: `ascii_identifiers` ####
22302923
2231−#### Extension: `backtick_code_blocks` ####
2924+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2925+Accents are stripped off of accented Latin letters, and non-Latin
2926+letters are omitted.
22322927
2233−Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
2234−(`~`).
2928+#### Extension: `gfm_auto_identifiers` ####
22352929
2236−#### Extension: `fenced_code_attributes` ####
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.
22372935
2238−Optionally, you may attach attributes to fenced or backtick code block using
2239−this syntax:
2936+## Math Input
22402937
2241− ~~~~ {#mycode .haskell .numberLines startFrom="100"}
2242− qsort [] = []
2243− qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
2244− qsort (filter (>= x) xs)
2245− ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2938+The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2939+[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2940+[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2941+are described in the section about Pandoc's Markdown.
22462942
2247−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2248−`startFrom` is an attribute with value `100`. Some output formats can use this
2249−information to do syntax highlighting. Currently, the only output formats
2250−that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
2251−is supported for your output format and language, then the code block above
2252−will appear highlighted, with numbered lines. (To see which languages are
2253−supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2254−block above will appear as follows:
2943+However, they can also be used with HTML input. This is handy for
2944+reading web pages formatted using MathJax, for example.
22552945
2256− <pre id="mycode" class="haskell numberLines" startFrom="100">
2257− <code>
2258− ...
2259− </code>
2260− </pre>
2946+## Raw HTML/TeX
22612947
2262−The `numberLines` (or `number-lines`) class will cause the lines
2263−of the code block to be numbered, starting with `1` or the value
2264−of the `startFrom` attribute. The `lineAnchors` (or
2265−`line-anchors`) class will cause the lines to be clickable
2266−anchors in HTML output.
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
22672950
2268−A shortcut form can also be used for specifying the language of
2269−the code block:
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.
22702954
2271− ```haskell
2272− qsort [] = []
2273− ```
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2956+ to be included in a document. This extension can be enabled/disabled
2957+ for the following formats (in addition to `markdown`):
22742958
2275−This is equivalent to:
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
22762962
2277− ``` {.haskell}
2278− qsort [] = []
2279− ```
2963+ output formats
2964+ : `textile`, `commonmark`
22802965
2281−If the `fenced_code_attributes` extension is disabled, but
2282−input contains class attribute(s) for the code block, the first
2283−class attribute will be printed after the opening fence as a bare
2284−word.
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`.
22852973
2286−To prevent all highlighting, use the `--no-highlight` flag.
2287−To set the highlighting style, use `--highlight-style`.
2288−For more information on highlighting, see [Syntax highlighting],
2289−below.
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2975+ elements to be parsed as native pandoc Div blocks.
2976+ If you want them to be parsed as raw HTML, use
2977+ `-f html-native_divs+raw_html`.
22902978
2291−Line blocks
2292−-----------
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`.
22932985
2294−#### Extension: `line_blocks` ####
2986+## Literate Haskell support
22952987
2296−A line block is a sequence of lines beginning with a vertical bar (`|`)
2297−followed by a space. The division into lines will be preserved in
2298−the output, as will any leading spaces; otherwise, the lines will
2299−be formatted as Markdown. This is useful for verse and addresses:
2988+#### Extension: `literate_haskell` ####
23002989
2301− | The limerick packs laughs anatomical
2302− | In space that is quite economical.
2303− | But the good ones I've seen
2304− | So seldom are clean
2305− | And the clean ones so seldom are comical
2990+Treat the document as literate Haskell source.
23062991
2307− | 200 Main St.
2308− | Berkeley, CA 94718
2992+This extension can be enabled/disabled for the following formats:
23092993
2310−The lines can be hard-wrapped if needed, but the continuation
2311−line must begin with a space.
2994+input formats
2995+: `markdown`, `rst`, `latex`
23122996
2313− | The Right Honorable Most Venerable and Righteous Samuel L.
2314− Constable, Jr.
2315− | 200 Main St.
2316− | Berkeley, CA 94718
2997+output formats
2998+: `markdown`, `rst`, `latex`, `html`
23172999
2318−This syntax is borrowed from [reStructuredText].
3000+If you append `+lhs` (or `+literate_haskell`) to one of the formats
3001+above, pandoc will treat the document as literate Haskell source.
3002+This means that
23193003
2320−Lists
2321−-----
3004+ - In Markdown input, "bird track" sections will be parsed as Haskell
3005+ code rather than block quotations. Text between `\begin{code}`
3006+ and `\end{code}` will also be treated as Haskell code. For
3007+ ATX-style headings the character '=' will be used instead of '#'.
23223008
2323−### Bullet lists ###
3009+ - In Markdown output, code blocks with classes `haskell` and `literate`
3010+ will be rendered using bird tracks, and block quotations will be
3011+ indented one space, so they will not be treated as Haskell code.
3012+ In addition, headings will be rendered setext-style (with underlines)
3013+ rather than ATX-style (with '#' characters). (This is because ghc
3014+ treats '#' characters in column 1 as introducing line numbers.)
23243015
2325−A bullet list is a list of bulleted list items. A bulleted list
2326−item begins with a bullet (`*`, `+`, or `-`). Here is a simple
2327−example:
3016+ - In restructured text input, "bird track" sections will be parsed
3017+ as Haskell code.
23283018
2329− * one
2330− * two
2331− * three
3019+ - In restructured text output, code blocks with class `haskell` will
3020+ be rendered using bird tracks.
23323021
2333−This will produce a "compact" list. If you want a "loose" list, in which
2334−each item is formatted as a paragraph, put spaces between the items:
3022+ - In LaTeX input, text in `code` environments will be parsed as
3023+ Haskell code.
23353024
2336− * one
3025+ - In LaTeX output, code blocks with class `haskell` will be rendered
3026+ inside `code` environments.
23373027
2338− * two
3028+ - In HTML output, code blocks with class `haskell` will be rendered
3029+ with class `literatehaskell` and bird tracks.
23393030
2340− * three
3031+Examples:
23413032
2342−The bullets need not be flush with the left margin; they may be
2343−indented one, two, or three spaces. The bullet must be followed
2344−by whitespace.
3033+ pandoc -f markdown+lhs -t html
23453034
2346−List items look best if subsequent lines are flush with the first
2347−line (after the bullet):
3035+reads literate Haskell source formatted with Markdown conventions and writes
3036+ordinary HTML (without bird tracks).
23483037
2349− * here is my first
2350− list item.
2351− * and my second.
3038+ pandoc -f markdown+lhs -t html+lhs
23523039
2353−But Markdown also allows a "lazy" format:
3040+writes HTML with the Haskell code in bird tracks, so it can be copied
3041+and pasted as literate Haskell source.
23543042
2355− * here is my first
2356− list item.
2357− * and my second.
3043+Note that GHC expects the bird tracks in the first column, so indented
3044+literate code blocks (e.g. inside an itemized environment) will not be
3045+picked up by the Haskell compiler.
23583046
2359−### Block content in list items ###
3047+## Other extensions
23603048
2361−A list item may contain multiple paragraphs and other block-level
2362−content. However, subsequent paragraphs must be preceded by a blank line
2363−and indented to line up with the first non-space content after
2364−the list marker.
3049+#### Extension: `empty_paragraphs` ####
23653050
2366− * First paragraph.
3051+Allows empty paragraphs. By default empty paragraphs are
3052+omitted.
23673053
2368− Continued.
3054+This extension can be enabled/disabled for the following formats:
23693055
2370− * Second paragraph. With a code block, which must be indented
2371− eight spaces:
3056+input formats
3057+: `docx`, `html`
23723058
2373− { code }
3059+output formats
3060+: `docx`, `odt`, `opendocument`, `html`
23743061
2375−Exception: if the list marker is followed by an indented code
2376−block, which must begin 5 spaces after the list marker, then
2377−subsequent paragraphs must begin two columns after the last
2378−character of the list marker:
3062+#### Extension: `native_numbering` ####
23793063
2380− * code
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
23813066
2382− continuation paragraph
3067+This extension can be enabled/disabled for the following formats:
23833068
2384−List items may include other lists. In this case the preceding blank
2385−line is optional. The nested list must be indented to line up with
2386−the first non-space character after the list marker of the
2387−containing list item.
3069+output formats
3070+: `odt`, `opendocument`
23883071
2389− * fruits
2390− + apples
2391− - macintosh
2392− - red delicious
2393− + pears
2394− + peaches
2395− * vegetables
2396− + broccoli
2397− + chard
3072+#### Extension: `xrefs_name` ####
23983073
2399−As noted above, Markdown allows you to write list items "lazily," instead of
2400−indenting continuation lines. However, if there are multiple paragraphs or
2401−other blocks in a list item, the first line of each must be indented.
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3079+name.
24023080
2403− + A lazy, lazy, list
2404− item.
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
24053083
2406− + Another one; this looks
2407− bad but is legal.
3084+This extension can be enabled/disabled for the following formats:
24083085
2409− Second paragraph of second
2410− list item.
3086+output formats
3087+: `odt`, `opendocument`
24113088
2412−### Ordered lists ###
3089+#### Extension: `xrefs_number` ####
24133090
2414−Ordered lists work just like bulleted lists, except that the items
2415−begin with enumerators rather than bullets.
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.
24163096
2417−In standard Markdown, enumerators are decimal numbers followed
2418−by a period and a space. The numbers themselves are ignored, so
2419−there is no difference between this list:
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.
24203100
2421− 1. one
2422− 2. two
2423− 3. three
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
24243103
2425−and this one:
3104+This extension can be enabled/disabled for the following formats:
24263105
2427− 5. one
2428− 7. two
2429− 1. three
3106+output formats
3107+: `odt`, `opendocument`
24303108
2431−#### Extension: `fancy_lists` ####
3109+#### Extension: `styles` #### {#ext-styles}
24323110
2433−Unlike standard Markdown, pandoc allows ordered list items to be marked
2434−with uppercase and lowercase letters and roman numerals, in addition to
2435−Arabic numerals. List markers may be enclosed in parentheses or followed by a
2436−single right-parentheses or period. They must be separated from the
2437−text that follows by at least one space, and, if the list marker is a
2438−capital letter with a period, by at least two spaces.[^2]
3111+When converting from docx, read all docx styles as divs (for
3112+paragraph styles) and spans (for character styles) regardless
3113+of whether pandoc understands the meaning of these styles.
3114+This can be used with [docx custom styles](#custom-styles).
3115+Disabled by default.
24393116
2440−[^2]: The point of this rule is to ensure that normal paragraphs
2441− starting with people's initials, like
3117+input formats
3118+: `docx`
24423119
2443− B. Russell was an English philosopher.
3120+#### Extension: `amuse` ####
24443121
2445− do not get treated as list items.
3122+In the `muse` input format, this enables Text::Amuse
3123+extensions to Emacs Muse markup.
24463124
2447− This rule will not prevent
3125+#### Extension: `raw_markdown` ####
24483126
2449− (C) 2007 Joe Smith
3127+In the `ipynb` input format, this causes Markdown cells
3128+to be included as raw Markdown blocks (allowing lossless
3129+round-tripping) rather than being parsed. Use this only
3130+when you are targeting `ipynb` or a markdown-based
3131+output format.
24503132
2451− from being interpreted as a list item. In this case, a backslash
2452− escape can be used:
3133+#### Extension: `citations` {#org-citations}
24533134
2454− (C\) 2007 Joe Smith
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
24553137
2456−The `fancy_lists` extension also allows '`#`' to be used as an
2457−ordered list marker in place of a numeral:
3138+#### Extension: `element_citations` ####
24583139
2459− #. one
2460− #. two
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.
24613144
2462−#### Extension: `startnum` ####
3145+#### Extension: `ntb` ####
24633146
2464−Pandoc also pays attention to the type of list marker used, and to the
2465−starting number, and both of these are preserved where possible in the
2466−output format. Thus, the following yields a list with numbers followed
2467−by a single parenthesis, starting with 9, and a sublist with lowercase
2468−roman numerals:
3147+In the `context` output format this enables the use of [Natural Tables
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3150+Natural tables allow more fine-grained global customization but come
3151+at a performance penalty compared to extreme tables.
24693152
2470− 9) Ninth
2471− 10) Tenth
2472− 11) Eleventh
2473− i. subone
2474− ii. subtwo
2475− iii. subthree
24763153
2477−Pandoc will start a new list each time a different type of list
2478−marker is used. So, the following will create three lists:
3154+# Pandoc's Markdown
24793155
2480− (2) Two
2481− (5) Three
2482− 1. Four
2483− * Five
3156+Pandoc understands an extended and slightly revised version of
3157+John Gruber's [Markdown] syntax. This document explains the syntax,
3158+noting differences from standard Markdown. Except where noted, these
3159+differences can be suppressed by using the `markdown_strict` format instead
3160+of `markdown`. Extensions can be enabled or disabled to specify the
3161+behavior more granularly. They are described in the following. See also
3162+[Extensions] above, for extensions that work also on other formats.
24843163
2485−If default list markers are desired, use `#.`:
3164+## Philosophy
24863165
2487− #. one
2488− #. two
2489− #. three
3166+Markdown is designed to be easy to write, and, even more importantly,
3167+easy to read:
24903168
3169+> A Markdown-formatted document should be publishable as-is, as plain
3170+> text, without looking like it's been marked up with tags or formatting
3171+> instructions.
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
24913173
2492−### Definition lists ###
3174+This principle has guided pandoc's decisions in finding syntax for
3175+tables, footnotes, and other extensions.
24933176
2494−#### Extension: `definition_lists` ####
3177+There is, however, one respect in which pandoc's aims are different
3178+from the original aims of Markdown. Whereas Markdown was originally
3179+designed with HTML generation in mind, pandoc is designed for multiple
3180+output formats. Thus, while pandoc allows the embedding of raw HTML,
3181+it discourages it, and provides other, non-HTMLish ways of representing
3182+important document elements like definition lists, tables, mathematics, and
3183+footnotes.
24953184
2496−Pandoc supports definition lists, using the syntax of
2497−[PHP Markdown Extra] with some extensions.[^3]
3185+## Paragraphs
24983186
2499− Term 1
3187+A paragraph is one or more lines of text followed by one or more blank lines.
3188+Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3189+If you need a hard line break, put two or more spaces at the end of a line.
25003190
2501− : Definition 1
3191+#### Extension: `escaped_line_breaks` ####
25023192
2503− Term 2 with *inline markup*
3193+A backslash followed by a newline is also a hard line break.
3194+Note: in multiline and grid table cells, this is the only way
3195+to create a hard line break, since trailing spaces in the cells
3196+are ignored.
25043197
2505− : Definition 2
3198+## Headings
25063199
2507− { some code, part of Definition 2 }
3200+There are two kinds of headings: Setext and ATX.
25083201
2509− Third paragraph of definition 2.
3202+### Setext-style headings ###
25103203
2511−Each term must fit on one line, which may optionally be followed by
2512−a blank line, and must be followed by one or more definitions.
2513−A definition begins with a colon or tilde, which may be indented one
2514−or two spaces.
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
3205+(for a level-one heading) or `-` signs (for a level-two heading):
25153206
2516−A term may have multiple definitions, and each definition may consist of one or
2517−more block elements (paragraph, code block, list, etc.), each indented four
2518−spaces or one tab stop. The body of the definition (including the first line,
2519−aside from the colon or tilde) should be indented four spaces. However,
2520−as with other Markdown lists, you can "lazily" omit indentation except
2521−at the beginning of a paragraph or other block element:
3207+ A level-one heading
3208+ ===================
25223209
2523− Term 1
3210+ A level-two heading
3211+ -------------------
25243212
2525− : Definition
2526− with lazy continuation.
3213+The heading text can contain inline formatting, such as emphasis (see
3214+[Inline formatting], below).
25273215
2528− Second paragraph of the definition.
25293216
2530−If you leave space before the definition (as in the example above),
2531−the text of the definition will be treated as a paragraph. In some
2532−output formats, this will mean greater spacing between term/definition
2533−pairs. For a more compact definition list, omit the space before the
2534−definition:
3217+### ATX-style headings ###
25353218
2536− Term 1
2537− ~ Definition 1
3219+An ATX-style heading consists of one to six `#` signs and a line of
3220+text, optionally followed by any number of `#` signs. The number of
3221+`#` signs at the beginning of the line is the heading level:
25383222
2539− Term 2
2540− ~ Definition 2a
2541− ~ Definition 2b
3223+ ## A level-two heading
25423224
2543−Note that space between items in a definition list is required.
2544−(A variant that loosens this requirement, but disallows "lazy"
2545−hard wrapping, can be activated with `compact_definition_lists`: see
2546−[Non-pandoc extensions], below.)
3225+ ### A level-three heading ###
25473226
2548−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3227+As with setext-style headings, the heading text can contain formatting:
25493228
2550−### Numbered example lists ###
3229+ # A level-one heading with a [link](/url) and *emphasis*
25513230
2552−#### Extension: `example_lists` ####
3231+#### Extension: `blank_before_header` ####
25533232
2554−The special list marker `@` can be used for sequentially numbered
2555−examples. The first list item with a `@` marker will be numbered '1',
2556−the next '2', and so on, throughout the document. The numbered examples
2557−need not occur in a single list; each new list using `@` will take up
2558−where the last stopped. So, for example:
3233+Standard Markdown syntax does not require a blank line before a heading.
3234+Pandoc does require this (except, of course, at the beginning of the
3235+document). The reason for the requirement is that it is all too easy for a
3236+`#` to end up at the beginning of a line by accident (perhaps through line
3237+wrapping). Consider, for example:
25593238
2560− (@) My first example will be numbered (1).
2561− (@) My second example will be numbered (2).
3239+ I like several of their flavors of ice cream:
3240+ #22, for example, and #5.
25623241
2563− Explanation of examples.
3242+#### Extension: `space_in_atx_header` ####
25643243
2565− (@) My third example will be numbered (3).
3244+Many Markdown implementations do not require a space between the
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
3247+pandoc does require the space.
25663248
2567−Numbered examples can be labeled and referred to elsewhere in the
2568−document:
3249+### Heading identifiers ###
25693250
2570− (@good) This is a good example.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
25713253
2572− As (@good) illustrates, ...
3254+#### Extension: `header_attributes` ####
25733255
2574−The label can be any string of alphanumeric characters, underscores,
2575−or hyphens.
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
25763258
2577−Note: continuation paragraphs in example lists must always
2578−be indented four spaces, regardless of the length of the
2579−list marker. That is, example lists always behave as if the
2580−`four_space_rule` extension is set. This is because example
2581−labels tend to be long, and indenting content to the
2582−first non-space character after the label would be awkward.
3259+ {#identifier .class .class key=value key=value}
25833260
2584−### Compact and loose lists ###
3261+Thus, for example, the following headings will all be assigned the identifier
3262+`foo`:
25853263
2586−Pandoc behaves differently from `Markdown.pl` on some "edge
2587−cases" involving lists. Consider this source:
3264+ # My heading {#foo}
25883265
2589− + First
2590− + Second:
2591− - Fee
2592− - Fie
2593− - Foe
3266+ ## My heading ## {#foo}
25943267
2595− + Third
3268+ My other heading {#foo}
3269+ ---------------
25963270
2597−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2598−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2599−"Second" and "Third" (but not "First"), because of the blank space
2600−around "Third". Pandoc follows a simple rule: if the text is followed by
2601−a blank line, it is treated as a paragraph. Since "Second" is followed
2602−by a list, and not a blank line, it isn't treated as a paragraph. The
2603−fact that the list is followed by a blank line is irrelevant. (Note:
2604−Pandoc works this way even when the `markdown_strict` format is specified. This
2605−behavior is consistent with the official Markdown syntax description,
2606−even though it is different from that of `Markdown.pl`.)
3271+(This syntax is compatible with [PHP Markdown Extra].)
26073272
3273+Note that although this syntax allows assignment of classes and key/value
3274+attributes, writers generally don't use all of this information. Identifiers,
3275+classes, and key/value attributes are used in HTML and HTML-based formats such
3276+as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
26083278
2609−### Ending a list ###
3279+Headings with the class `unnumbered` will not be numbered, even if
3280+`--number-sections` is specified. A single hyphen (`-`) in an attribute
3281+context is equivalent to `.unnumbered`, and preferable in non-English
3282+documents. So,
26103283
2611−What if you want to put an indented code block after a list?
3284+ # My heading {-}
26123285
2613− - item one
2614− - item two
3286+is just the same as
26153287
2616− { my code block }
3288+ # My heading {.unnumbered}
26173289
2618−Trouble! Here pandoc (like other Markdown implementations) will treat
2619−`{ my code block }` as the second paragraph of item two, and not as
2620−a code block.
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.)
26213294
2622−To "cut off" the list after item two, you can insert some non-indented
2623−content, like an HTML comment, which won't produce visible output in
2624−any format:
3295+#### Extension: `implicit_header_references` ####
26253296
2626− - item one
2627− - item two
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
26283299
2629− <!-- end of list -->
3300+ # Heading identifiers in HTML
26303301
2631− { my code block }
3302+you can simply write
26323303
2633−You can use the same trick if you want two consecutive lists instead
2634−of one big list:
3304+ [Heading identifiers in HTML]
26353305
2636− 1. one
2637− 2. two
2638− 3. three
3306+or
26393307
2640− <!-- -->
3308+ [Heading identifiers in HTML][]
26413309
2642− 1. uno
2643− 2. dos
2644− 3. tres
3310+or
26453311
2646−Horizontal rules
2647−----------------
3312+ [the section on heading identifiers][heading identifiers in
3313+ HTML]
26483314
2649−A line containing a row of three or more `*`, `-`, or `_` characters
2650−(optionally separated by spaces) produces a horizontal rule:
3315+instead of giving the identifier explicitly:
26513316
2652− * * * *
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
26533318
2654− ---------------
3319+If there are multiple headings with identical text, the corresponding
3320+reference will link to the first one only, and you will need to use explicit
3321+links to link to the others, as described above.
26553322
3323+Like regular reference links, these references are case-insensitive.
26563324
2657−Tables
2658−------
3325+Explicit link reference definitions always take priority over
3326+implicit heading references. So, in the following example, the
3327+link will point to `bar`, not to `#foo`:
26593328
2660−Four kinds of tables may be used. The first three kinds presuppose the use of
2661−a fixed-width font, such as Courier. The fourth kind can be used with
2662−proportionally spaced fonts, as it does not require lining up columns.
3329+ # Foo
26633330
2664−#### Extension: `table_captions` ####
3331+ [foo]: bar
26653332
2666−A caption may optionally be provided with all 4 kinds of tables (as
2667−illustrated in the examples below). A caption is a paragraph beginning
2668−with the string `Table:` (or just `:`), which will be stripped off.
2669−It may appear either before or after the table.
3333+ See [foo]
26703334
2671−#### Extension: `simple_tables` ####
3335+## Block quotations
26723336
2673−Simple tables look like this:
3337+Markdown uses email conventions for quoting blocks of text.
3338+A block quotation is one or more paragraphs or other block elements
3339+(such as lists or headings), with each line preceded by a `>` character
3340+and an optional space. (The `>` need not start at the left margin, but
3341+it should not be indented more than three spaces.)
26743342
2675− Right Left Center Default
2676− ------- ------ ---------- -------
2677− 12 12 12 12
3343+ > This is a block quote. This
3344+ > paragraph has two lines.
3345+ >
3346+ > 1. This is a list inside a block quote.
3347+ > 2. Second item.
3348+
3349+A "lazy" form, which requires the `>` character only on the first
3350+line of each block, is also allowed:
3351+
3352+ > This is a block quote. This
3353+ paragraph has two lines.
3354+
3355+ > 1. This is a list inside a block quote.
3356+ 2. Second item.
3357+
3358+Among the block elements that can be contained in a block quote are
3359+other block quotes. That is, block quotes can be nested:
3360+
3361+ > This is a block quote.
3362+ >
3363+ > > A block quote within a block quote.
3364+
3365+If the `>` character is followed by an optional space, that space
3366+will be considered part of the block quote marker and not part of
3367+the indentation of the contents. Thus, to put an indented code
3368+block in a block quote, you need five spaces after the `>`:
3369+
3370+ > code
3371+
3372+#### Extension: `blank_before_blockquote` ####
3373+
3374+Standard Markdown syntax does not require a blank line before a
3375+block quote. Pandoc does require this (except, of course, at
3376+the beginning of the document). The reason for the requirement
3377+is that it is all too easy for a `>` to end up at the beginning
3378+of a line by accident (perhaps through line wrapping). So,
3379+unless the `markdown_strict` format is used, the following does
3380+not produce a nested block quote in pandoc:
3381+
3382+ > This is a block quote.
3383+ >> Nested.
3384+
3385+
3386+## Verbatim (code) blocks
3387+
3388+### Indented code blocks ###
3389+
3390+A block of text indented four spaces (or one tab) is treated as verbatim
3391+text: that is, special characters do not trigger special formatting,
3392+and all spaces and line breaks are preserved. For example,
3393+
3394+ if (a > 3) {
3395+ moveShip(5 * gravity, DOWN);
3396+ }
3397+
3398+The initial (four space or one tab) indentation is not considered part
3399+of the verbatim text, and is removed in the output.
3400+
3401+Note: blank lines in the verbatim text need not begin with four spaces.
3402+
3403+
3404+### Fenced code blocks ###
3405+
3406+#### Extension: `fenced_code_blocks` ####
3407+
3408+In addition to standard indented code blocks, pandoc supports
3409+*fenced* code blocks. These begin with a row of three or more
3410+tildes (`~`) and end with a row of tildes that must be at least as long as
3411+the starting row. Everything between these lines is treated as code. No
3412+indentation is necessary:
3413+
3414+ ~~~~~~~
3415+ if (a > 3) {
3416+ moveShip(5 * gravity, DOWN);
3417+ }
3418+ ~~~~~~~
3419+
3420+Like regular code blocks, fenced code blocks must be separated
3421+from surrounding text by blank lines.
3422+
3423+If the code itself contains a row of tildes or backticks, just use a longer
3424+row of tildes or backticks at the start and end:
3425+
3426+ ~~~~~~~~~~~~~~~~
3427+ ~~~~~~~~~~
3428+ code including tildes
3429+ ~~~~~~~~~~
3430+ ~~~~~~~~~~~~~~~~
3431+
3432+#### Extension: `backtick_code_blocks` ####
3433+
3434+Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes
3435+(`~`).
3436+
3437+#### Extension: `fenced_code_attributes` ####
3438+
3439+Optionally, you may attach attributes to fenced or backtick code block using
3440+this syntax:
3441+
3442+ ~~~~ {#mycode .haskell .numberLines startFrom="100"}
3443+ qsort [] = []
3444+ qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
3445+ qsort (filter (>= x) xs)
3446+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3447+
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
3451+highlighting. Currently, the only output formats that uses this
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3453+highlighting is supported for your output format and language,
3454+then the code block above will appear highlighted, with numbered
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
3457+will appear as follows:
3458+
3459+ <pre id="mycode" class="haskell numberLines" startFrom="100">
3460+ <code>
3461+ ...
3462+ </code>
3463+ </pre>
3464+
3465+The `numberLines` (or `number-lines`) class will cause the lines
3466+of the code block to be numbered, starting with `1` or the value
3467+of the `startFrom` attribute. The `lineAnchors` (or
3468+`line-anchors`) class will cause the lines to be clickable
3469+anchors in HTML output.
3470+
3471+A shortcut form can also be used for specifying the language of
3472+the code block:
3473+
3474+ ```haskell
3475+ qsort [] = []
3476+ ```
3477+
3478+This is equivalent to:
3479+
3480+ ``` {.haskell}
3481+ qsort [] = []
3482+ ```
3483+
3484+If the `fenced_code_attributes` extension is disabled, but
3485+input contains class attribute(s) for the code block, the first
3486+class attribute will be printed after the opening fence as a bare
3487+word.
3488+
3489+To prevent all highlighting, use the `--no-highlight` flag.
3490+To set the highlighting style, use `--highlight-style`.
3491+For more information on highlighting, see [Syntax highlighting],
3492+below.
3493+
3494+## Line blocks
3495+
3496+#### Extension: `line_blocks` ####
3497+
3498+A line block is a sequence of lines beginning with a vertical bar (`|`)
3499+followed by a space. The division into lines will be preserved in
3500+the output, as will any leading spaces; otherwise, the lines will
3501+be formatted as Markdown. This is useful for verse and addresses:
3502+
3503+ | The limerick packs laughs anatomical
3504+ | In space that is quite economical.
3505+ | But the good ones I've seen
3506+ | So seldom are clean
3507+ | And the clean ones so seldom are comical
3508+
3509+ | 200 Main St.
3510+ | Berkeley, CA 94718
3511+
3512+The lines can be hard-wrapped if needed, but the continuation
3513+line must begin with a space.
3514+
3515+ | The Right Honorable Most Venerable and Righteous Samuel L.
3516+ Constable, Jr.
3517+ | 200 Main St.
3518+ | Berkeley, CA 94718
3519+
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
3523+This syntax is borrowed from [reStructuredText].
3524+
3525+## Lists
3526+
3527+### Bullet lists ###
3528+
3529+A bullet list is a list of bulleted list items. A bulleted list
3530+item begins with a bullet (`*`, `+`, or `-`). Here is a simple
3531+example:
3532+
3533+ * one
3534+ * two
3535+ * three
3536+
3537+This will produce a "compact" list. If you want a "loose" list, in which
3538+each item is formatted as a paragraph, put spaces between the items:
3539+
3540+ * one
3541+
3542+ * two
3543+
3544+ * three
3545+
3546+The bullets need not be flush with the left margin; they may be
3547+indented one, two, or three spaces. The bullet must be followed
3548+by whitespace.
3549+
3550+List items look best if subsequent lines are flush with the first
3551+line (after the bullet):
3552+
3553+ * here is my first
3554+ list item.
3555+ * and my second.
3556+
3557+But Markdown also allows a "lazy" format:
3558+
3559+ * here is my first
3560+ list item.
3561+ * and my second.
3562+
3563+### Block content in list items ###
3564+
3565+A list item may contain multiple paragraphs and other block-level
3566+content. However, subsequent paragraphs must be preceded by a blank line
3567+and indented to line up with the first non-space content after
3568+the list marker.
3569+
3570+ * First paragraph.
3571+
3572+ Continued.
3573+
3574+ * Second paragraph. With a code block, which must be indented
3575+ eight spaces:
3576+
3577+ { code }
3578+
3579+Exception: if the list marker is followed by an indented code
3580+block, which must begin 5 spaces after the list marker, then
3581+subsequent paragraphs must begin two columns after the last
3582+character of the list marker:
3583+
3584+ * code
3585+
3586+ continuation paragraph
3587+
3588+List items may include other lists. In this case the preceding blank
3589+line is optional. The nested list must be indented to line up with
3590+the first non-space character after the list marker of the
3591+containing list item.
3592+
3593+ * fruits
3594+ + apples
3595+ - macintosh
3596+ - red delicious
3597+ + pears
3598+ + peaches
3599+ * vegetables
3600+ + broccoli
3601+ + chard
3602+
3603+As noted above, Markdown allows you to write list items "lazily," instead of
3604+indenting continuation lines. However, if there are multiple paragraphs or
3605+other blocks in a list item, the first line of each must be indented.
3606+
3607+ + A lazy, lazy, list
3608+ item.
3609+
3610+ + Another one; this looks
3611+ bad but is legal.
3612+
3613+ Second paragraph of second
3614+ list item.
3615+
3616+### Ordered lists ###
3617+
3618+Ordered lists work just like bulleted lists, except that the items
3619+begin with enumerators rather than bullets.
3620+
3621+In standard Markdown, enumerators are decimal numbers followed
3622+by a period and a space. The numbers themselves are ignored, so
3623+there is no difference between this list:
3624+
3625+ 1. one
3626+ 2. two
3627+ 3. three
3628+
3629+and this one:
3630+
3631+ 5. one
3632+ 7. two
3633+ 1. three
3634+
3635+#### Extension: `fancy_lists` ####
3636+
3637+Unlike standard Markdown, pandoc allows ordered list items to be marked
3638+with uppercase and lowercase letters and roman numerals, in addition to
3639+Arabic numerals. List markers may be enclosed in parentheses or followed by a
3640+single right-parentheses or period. They must be separated from the
3641+text that follows by at least one space, and, if the list marker is a
3642+capital letter with a period, by at least two spaces.[^2]
3643+
3644+[^2]: The point of this rule is to ensure that normal paragraphs
3645+ starting with people's initials, like
3646+
3647+ B. Russell was an English philosopher.
3648+
3649+ do not get treated as list items.
3650+
3651+ This rule will not prevent
3652+
3653+ (C) 2007 Joe Smith
3654+
3655+ from being interpreted as a list item. In this case, a backslash
3656+ escape can be used:
3657+
3658+ (C\) 2007 Joe Smith
3659+
3660+The `fancy_lists` extension also allows '`#`' to be used as an
3661+ordered list marker in place of a numeral:
3662+
3663+ #. one
3664+ #. two
3665+
3666+#### Extension: `startnum` ####
3667+
3668+Pandoc also pays attention to the type of list marker used, and to the
3669+starting number, and both of these are preserved where possible in the
3670+output format. Thus, the following yields a list with numbers followed
3671+by a single parenthesis, starting with 9, and a sublist with lowercase
3672+roman numerals:
3673+
3674+ 9) Ninth
3675+ 10) Tenth
3676+ 11) Eleventh
3677+ i. subone
3678+ ii. subtwo
3679+ iii. subthree
3680+
3681+Pandoc will start a new list each time a different type of list
3682+marker is used. So, the following will create three lists:
3683+
3684+ (2) Two
3685+ (5) Three
3686+ 1. Four
3687+ * Five
3688+
3689+If default list markers are desired, use `#.`:
3690+
3691+ #. one
3692+ #. two
3693+ #. three
3694+
3695+#### Extension: `task_lists` ####
3696+
3697+Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3698+
3699+ - [ ] an unchecked task list item
3700+ - [x] checked item
3701+
3702+### Definition lists ###
3703+
3704+#### Extension: `definition_lists` ####
3705+
3706+Pandoc supports definition lists, using the syntax of
3707+[PHP Markdown Extra] with some extensions.[^3]
3708+
3709+ Term 1
3710+
3711+ : Definition 1
3712+
3713+ Term 2 with *inline markup*
3714+
3715+ : Definition 2
3716+
3717+ { some code, part of Definition 2 }
3718+
3719+ Third paragraph of definition 2.
3720+
3721+Each term must fit on one line, which may optionally be followed by
3722+a blank line, and must be followed by one or more definitions.
3723+A definition begins with a colon or tilde, which may be indented one
3724+or two spaces.
3725+
3726+A term may have multiple definitions, and each definition may
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
3729+body of the definition (including the first line, aside from the
3730+colon or tilde) should be indented four spaces. However, as with
3731+other Markdown lists, you can "lazily" omit indentation except
3732+at the beginning of a paragraph or other block element:
3733+
3734+ Term 1
3735+
3736+ : Definition
3737+ with lazy continuation.
3738+
3739+ Second paragraph of the definition.
3740+
3741+If you leave space before the definition (as in the example above),
3742+the text of the definition will be treated as a paragraph. In some
3743+output formats, this will mean greater spacing between term/definition
3744+pairs. For a more compact definition list, omit the space before the
3745+definition:
3746+
3747+ Term 1
3748+ ~ Definition 1
3749+
3750+ Term 2
3751+ ~ Definition 2a
3752+ ~ Definition 2b
3753+
3754+Note that space between items in a definition list is required.
3755+(A variant that loosens this requirement, but disallows "lazy"
3756+hard wrapping, can be activated with `compact_definition_lists`: see
3757+[Non-default extensions], below.)
3758+
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3761+
3762+### Numbered example lists ###
3763+
3764+#### Extension: `example_lists` ####
3765+
3766+The special list marker `@` can be used for sequentially numbered
3767+examples. The first list item with a `@` marker will be numbered '1',
3768+the next '2', and so on, throughout the document. The numbered examples
3769+need not occur in a single list; each new list using `@` will take up
3770+where the last stopped. So, for example:
3771+
3772+ (@) My first example will be numbered (1).
3773+ (@) My second example will be numbered (2).
3774+
3775+ Explanation of examples.
3776+
3777+ (@) My third example will be numbered (3).
3778+
3779+Numbered examples can be labeled and referred to elsewhere in the
3780+document:
3781+
3782+ (@good) This is a good example.
3783+
3784+ As (@good) illustrates, ...
3785+
3786+The label can be any string of alphanumeric characters, underscores,
3787+or hyphens.
3788+
3789+Note: continuation paragraphs in example lists must always
3790+be indented four spaces, regardless of the length of the
3791+list marker. That is, example lists always behave as if the
3792+`four_space_rule` extension is set. This is because example
3793+labels tend to be long, and indenting content to the
3794+first non-space character after the label would be awkward.
3795+
3796+
3797+### Ending a list ###
3798+
3799+What if you want to put an indented code block after a list?
3800+
3801+ - item one
3802+ - item two
3803+
3804+ { my code block }
3805+
3806+Trouble! Here pandoc (like other Markdown implementations) will treat
3807+`{ my code block }` as the second paragraph of item two, and not as
3808+a code block.
3809+
3810+To "cut off" the list after item two, you can insert some non-indented
3811+content, like an HTML comment, which won't produce visible output in
3812+any format:
3813+
3814+ - item one
3815+ - item two
3816+
3817+ <!-- end of list -->
3818+
3819+ { my code block }
3820+
3821+You can use the same trick if you want two consecutive lists instead
3822+of one big list:
3823+
3824+ 1. one
3825+ 2. two
3826+ 3. three
3827+
3828+ <!-- -->
3829+
3830+ 1. uno
3831+ 2. dos
3832+ 3. tres
3833+
3834+## Horizontal rules
3835+
3836+A line containing a row of three or more `*`, `-`, or `_` characters
3837+(optionally separated by spaces) produces a horizontal rule:
3838+
3839+ * * * *
3840+
3841+ ---------------
3842+
3843+
3844+## Tables
3845+
3846+Four kinds of tables may be used. The first three kinds presuppose the use of
3847+a fixed-width font, such as Courier. The fourth kind can be used with
3848+proportionally spaced fonts, as it does not require lining up columns.
3849+
3850+#### Extension: `table_captions` ####
3851+
3852+A caption may optionally be provided with all 4 kinds of tables (as
3853+illustrated in the examples below). A caption is a paragraph beginning
3854+with the string `Table:` (or just `:`), which will be stripped off.
3855+It may appear either before or after the table.
3856+
3857+#### Extension: `simple_tables` ####
3858+
3859+Simple tables look like this:
3860+
3861+ Right Left Center Default
3862+ ------- ------ ---------- -------
3863+ 12 12 12 12
26783864 123 123 123 123
26793865 1 1 1 1
26803866
2681− Table: Demonstration of simple table syntax.
3867+ Table: Demonstration of simple table syntax.
3868+
3869+The header and table rows must each fit on one line. Column
3870+alignments are determined by the position of the header text relative
3871+to the dashed line below it:[^4]
3872+
3873+ - If the dashed line is flush with the header text on the right side
3874+ but extends beyond it on the left, the column is right-aligned.
3875+ - If the dashed line is flush with the header text on the left side
3876+ but extends beyond it on the right, the column is left-aligned.
3877+ - If the dashed line extends beyond the header text on both sides,
3878+ the column is centered.
3879+ - If the dashed line is flush with the header text on both sides,
3880+ the default alignment is used (in most cases, this will be left).
3881+
3882+[^4]: This scheme is due to Michel Fortin, who proposed it on the
3883+ [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
3884+
3885+The table must end with a blank line, or a line of dashes followed by
3886+a blank line.
3887+
3888+The column header row may be omitted, provided a dashed line is used
3889+to end the table. For example:
3890+
3891+ ------- ------ ---------- -------
3892+ 12 12 12 12
3893+ 123 123 123 123
3894+ 1 1 1 1
3895+ ------- ------ ---------- -------
3896+
3897+When the header row is omitted, column alignments are determined on the basis
3898+of the first line of the table body. So, in the tables above, the columns
3899+would be right, left, center, and right aligned, respectively.
3900+
3901+#### Extension: `multiline_tables` ####
3902+
3903+Multiline tables allow header and table rows to span multiple lines
3904+of text (but cells that span multiple columns or rows of the table are
3905+not supported). Here is an example:
3906+
3907+ -------------------------------------------------------------
3908+ Centered Default Right Left
3909+ Header Aligned Aligned Aligned
3910+ ----------- ------- --------------- -------------------------
3911+ First row 12.0 Example of a row that
3912+ spans multiple lines.
3913+
3914+ Second row 5.0 Here's another one. Note
3915+ the blank line between
3916+ rows.
3917+ -------------------------------------------------------------
3918+
3919+ Table: Here's the caption. It, too, may span
3920+ multiple lines.
3921+
3922+These work like simple tables, but with the following differences:
3923+
3924+ - They must begin with a row of dashes, before the header text
3925+ (unless the header row is omitted).
3926+ - They must end with a row of dashes, then a blank line.
3927+ - The rows must be separated by blank lines.
3928+
3929+In multiline tables, the table parser pays attention to the widths of
3930+the columns, and the writers try to reproduce these relative widths in
3931+the output. So, if you find that one of the columns is too narrow in the
3932+output, try widening it in the Markdown source.
3933+
3934+The header may be omitted in multiline tables as well as simple tables:
3935+
3936+ ----------- ------- --------------- -------------------------
3937+ First row 12.0 Example of a row that
3938+ spans multiple lines.
3939+
3940+ Second row 5.0 Here's another one. Note
3941+ the blank line between
3942+ rows.
3943+ ----------- ------- --------------- -------------------------
3944+
3945+ : Here's a multiline table without a header.
3946+
3947+It is possible for a multiline table to have just one row, but the row
3948+should be followed by a blank line (and then the row of dashes that ends
3949+the table), or the table may be interpreted as a simple table.
3950+
3951+#### Extension: `grid_tables` ####
3952+
3953+Grid tables look like this:
3954+
3955+ : Sample grid table.
3956+
3957+ +---------------+---------------+--------------------+
3958+ | Fruit | Price | Advantages |
3959+ +===============+===============+====================+
3960+ | Bananas | $1.34 | - built-in wrapper |
3961+ | | | - bright color |
3962+ +---------------+---------------+--------------------+
3963+ | Oranges | $2.10 | - cures scurvy |
3964+ | | | - tasty |
3965+ +---------------+---------------+--------------------+
3966+
3967+The row of `=`s separates the header from the table body, and can be
3968+omitted for a headerless table. The cells of grid tables may contain
3969+arbitrary block elements (multiple paragraphs, code blocks, lists,
3970+etc.). Cells that span multiple columns or rows are not
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
26823973
2683−The headers and table rows must each fit on one line. Column
2684−alignments are determined by the position of the header text relative
2685−to the dashed line below it:[^4]
3974+Alignments can be specified as with pipe tables, by putting
3975+colons at the boundaries of the separator line after the
3976+header:
3977+
3978+ +---------------+---------------+--------------------+
3979+ | Right | Left | Centered |
3980+ +==============:+:==============+:==================:+
3981+ | Bananas | $1.34 | built-in wrapper |
3982+ +---------------+---------------+--------------------+
3983+
3984+For headerless tables, the colons go on the top line instead:
3985+
3986+ +--------------:+:--------------+:------------------:+
3987+ | Right | Left | Centered |
3988+ +---------------+---------------+--------------------+
3989+
3990+##### Grid Table Limitations #####
3991+
3992+Pandoc does not support grid tables with row spans or column spans.
3993+This means that neither variable numbers of columns across rows nor
3994+variable numbers of rows across columns are supported by Pandoc.
3995+All grid tables must have the same number of columns in each row,
3996+and the same number of rows in each column. For example, the
3997+Docutils [sample grid tables] will not render as expected with
3998+Pandoc.
3999+
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
4001+
4002+
4003+#### Extension: `pipe_tables` ####
4004+
4005+Pipe tables look like this:
4006+
4007+ | Right | Left | Default | Center |
4008+ |------:|:-----|---------|:------:|
4009+ | 12 | 12 | 12 | 12 |
4010+ | 123 | 123 | 123 | 123 |
4011+ | 1 | 1 | 1 | 1 |
4012+
4013+ : Demonstration of pipe table syntax.
4014+
4015+The syntax is identical to [PHP Markdown Extra tables]. The beginning and
4016+ending pipe characters are optional, but pipes are required between all
4017+columns. The colons indicate column alignment as shown. The header
4018+cannot be omitted. To simulate a headerless table, include a header
4019+with blank cells.
4020+
4021+Since the pipes indicate column boundaries, columns need not be vertically
4022+aligned, as they are in the above example. So, this is a perfectly
4023+legal (though ugly) pipe table:
4024+
4025+ fruit| price
4026+ -----|-----:
4027+ apple|2.05
4028+ pear|1.37
4029+ orange|3.09
4030+
4031+The cells of pipe tables cannot contain block elements like paragraphs
4032+and lists, and cannot span multiple lines. If a pipe table contains a
4033+row whose Markdown content is wider than the column width (see
4034+`--columns`), then the table will take up the full text width and
4035+the cell contents will wrap, with the relative cell widths determined
4036+by the number of dashes in the line separating the table header from
4037+the table body. (For example `---|-` would make the first column 3/4
4038+and the second column 1/4 of the full text width.)
4039+On the other hand, if no lines are wider than column width, then
4040+cell contents will not be wrapped, and the cells will be sized
4041+to their contents.
4042+
4043+Note: pandoc also recognizes pipe tables of the following
4044+form, as can be produced by Emacs' orgtbl-mode:
4045+
4046+ | One | Two |
4047+ |-----+-------|
4048+ | my | table |
4049+ | is | nice |
4050+
4051+The difference is that `+` is used instead of `|`. Other orgtbl features
4052+are not supported. In particular, to get non-default column alignment,
4053+you'll need to add colons as above.
4054+
4055+[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4056+
4057+## Metadata blocks
4058+
4059+#### Extension: `pandoc_title_block` ####
4060+
4061+If the file begins with a title block
4062+
4063+ % title
4064+ % author(s) (separated by semicolons)
4065+ % date
4066+
4067+it will be parsed as bibliographic information, not regular text. (It
4068+will be used, for example, in the title of standalone LaTeX or HTML
4069+output.) The block may contain just a title, a title and an author,
4070+or all three elements. If you want to include an author but no
4071+title, or a title and a date but no author, you need a blank line:
4072+
4073+```
4074+%
4075+% Author
4076+```
4077+
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
4083+
4084+The title may occupy multiple lines, but continuation lines must
4085+begin with leading space, thus:
4086+
4087+```
4088+% My title
4089+ on multiple lines
4090+```
4091+
4092+If a document has multiple authors, the authors may be put on
4093+separate lines with leading space, or separated by semicolons, or
4094+both. So, all of the following are equivalent:
4095+
4096+```
4097+% Author One
4098+ Author Two
4099+```
4100+
4101+```
4102+% Author One; Author Two
4103+```
4104+
4105+```
4106+% Author One;
4107+ Author Two
4108+```
4109+
4110+The date must fit on one line.
4111+
4112+All three metadata fields may contain standard inline formatting
4113+(italics, links, footnotes, etc.).
4114+
4115+Title blocks will always be parsed, but they will affect the output only
4116+when the `--standalone` (`-s`) option is chosen. In HTML output, titles
4117+will appear twice: once in the document head -- this is the title that
4118+will appear at the top of the window in a browser -- and once at the
4119+beginning of the document body. The title in the document head can have
4120+an optional prefix attached (`--title-prefix` or `-T` option). The title
4121+in the body appears as an H1 element with class "title", so it can be
4122+suppressed or reformatted with CSS. If a title prefix is specified with
4123+`-T` and no title block appears in the document, the title prefix will
4124+be used by itself as the HTML title.
4125+
4126+The man page writer extracts a title, man page section number, and
4127+other header and footer information from the title line. The title
4128+is assumed to be the first word on the title line, which may optionally
4129+end with a (single-digit) section number in parentheses. (There should
4130+be no space between the title and the parentheses.) Anything after
4131+this is assumed to be additional footer and header text. A single pipe
4132+character (`|`) should be used to separate the footer text from the header
4133+text. Thus,
4134+
4135+ % PANDOC(1)
4136+
4137+will yield a man page with the title `PANDOC` and section 1.
4138+
4139+ % PANDOC(1) Pandoc User Manuals
4140+
4141+will also have "Pandoc User Manuals" in the footer.
4142+
4143+ % PANDOC(1) Pandoc User Manuals | Version 4.0
4144+
4145+will also have "Version 4.0" in the header.
4146+
4147+#### Extension: `yaml_metadata_block` ####
4148+
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
4150+hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4151+(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4152+document, but if it is not at the beginning, it must be preceded by a blank
4153+line. (Note that, because of the way pandoc concatenates input files when
4154+several are provided, you may also keep the metadata in a separate YAML file
4155+and pass it to pandoc as an argument, along with your Markdown files:
4156+
4157+ pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4158+
4159+Just be sure that the YAML file begins with `---` and ends with `---` or
4160+`...`.) Alternatively, you can use the `--metadata-file` option. Using
4161+that approach however, you cannot reference content (like footnotes)
4162+from the main markdown input document.
4163+
4164+Metadata will be taken from the fields of the YAML object and added to any
4165+existing document metadata. Metadata can contain lists and objects (nested
4166+arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4167+with names ending in an underscore will be ignored by pandoc. (They may be
4168+given a role by external processors.) Field names must not be
4169+interpretable as YAML numbers or boolean values (so, for
4170+example, `yes`, `True`, and `15` cannot be used as field names).
4171+
4172+A document may contain multiple metadata blocks. If two
4173+metadata blocks attempt to set the same field, the value from
4174+the second block will be taken.
4175+
4176+When pandoc is used with `-t markdown` to create a Markdown document,
4177+a YAML metadata block will be produced only if the `-s/--standalone`
4178+option is used. All of the metadata will appear in a single block
4179+at the beginning of the document.
4180+
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
4182+if a title contains a colon, it must be quoted, and if it contains a
4183+backslash escape, then it must be ensured that it is not treated as a
4184+[YAML escape sequence]. The pipe character (`|`) can be used to begin
4185+an indented block that will be interpreted literally, without need for
4186+escaping. This form is necessary when the field contains blank lines
4187+or block-level formatting:
4188+
4189+ ---
4190+ title: 'This is the title: it contains a colon'
4191+ author:
4192+ - Author One
4193+ - Author Two
4194+ keywords: [nothing, nothingness]
4195+ abstract: |
4196+ This is the abstract.
4197+
4198+ It consists of two paragraphs.
4199+ ...
4200+
4201+The literal block after the `|` must be indented relative to the
4202+line containing the `|`. If it is not, the YAML will be invalid
4203+and pandoc will not interpret it as metadata. For an overview
4204+of the complex rules governing YAML, see the [Wikipedia entry on
4205+YAML syntax].
4206+
4207+Template variables will be set automatically from the metadata. Thus, for
4208+example, in writing HTML, the variable `abstract` will be set to the HTML
4209+equivalent of the Markdown in the `abstract` field:
4210+
4211+ <p>This is the abstract.</p>
4212+ <p>It consists of two paragraphs.</p>
4213+
4214+Variables can contain arbitrary YAML structures, but the template must match
4215+this structure. The `author` variable in the default templates expects a
4216+simple list or string, but can be changed to support more complicated
4217+structures. The following combination, for example, would add an affiliation
4218+to the author if one is given:
4219+
4220+ ---
4221+ title: The document title
4222+ author:
4223+ - name: Author One
4224+ affiliation: University of Somewhere
4225+ - name: Author Two
4226+ affiliation: University of Nowhere
4227+ ...
4228+
4229+To use the structured authors in the example above, you would need a custom
4230+template:
4231+
4232+ $for(author)$
4233+ $if(author.name)$
4234+ $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
4235+ $else$
4236+ $author$
4237+ $endif$
4238+ $endfor$
4239+
4240+Raw content to include in the document's header may be specified
4241+using `header-includes`; however, it is important to mark up
4242+this content as raw code for a particular output format, using
4243+the [`raw_attribute` extension](#extension-raw_attribute)), or it
4244+will be interpreted as markdown. For example:
4245+
4246+ header-includes:
4247+ - |
4248+ ```{=latex}
4249+ \let\oldsection\section
4250+ \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4251+ ```
4252+
4253+Note: the `yaml_metadata_block` extension works with
4254+`commonmark` as well as `markdown` (and it is enabled by default
4255+in `gfm` and `commonmark_x`). However, in these formats the
4256+following restrictions apply:
4257+
4258+- The YAML metadata block must occur at the beginning of the
4259+ document (and there can be only one). If multiple files are
4260+ given as arguments to pandoc, only the first can be a YAML
4261+ metadata block.
4262+
4263+- The leaf nodes of the YAML structure are parsed in isolation from
4264+ each other and from the rest of the document. So, for
4265+ example, you can't use a reference link in these contexts
4266+ if the link definition is somewhere else in the document.
4267+
4268+[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
4269+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
4270+
4271+## Backslash escapes
4272+
4273+#### Extension: `all_symbols_escapable` ####
4274+
4275+Except inside a code block or inline code, any punctuation or space
4276+character preceded by a backslash will be treated literally, even if it
4277+would normally indicate formatting. Thus, for example, if one writes
4278+
4279+ *\*hello\**
4280+
4281+one will get
4282+
4283+ <em>*hello*</em>
26864284
2687− - If the dashed line is flush with the header text on the right side
2688− but extends beyond it on the left, the column is right-aligned.
2689− - If the dashed line is flush with the header text on the left side
2690− but extends beyond it on the right, the column is left-aligned.
2691− - If the dashed line extends beyond the header text on both sides,
2692− the column is centered.
2693− - If the dashed line is flush with the header text on both sides,
2694− the default alignment is used (in most cases, this will be left).
4285+instead of
26954286
2696−[^4]: This scheme is due to Michel Fortin, who proposed it on the
2697− [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
4287+ <strong>hello</strong>
26984288
2699−The table must end with a blank line, or a line of dashes followed by
2700−a blank line.
4289+This rule is easier to remember than standard Markdown's rule,
4290+which allows only the following characters to be backslash-escaped:
27014291
2702−The column headers may be omitted, provided a dashed line is used
2703−to end the table. For example:
4292+ \`*_{}[]()>#+-.!
27044293
2705− ------- ------ ---------- -------
2706− 12 12 12 12
2707− 123 123 123 123
2708− 1 1 1 1
2709− ------- ------ ---------- -------
4294+(However, if the `markdown_strict` format is used, the standard Markdown rule
4295+will be used.)
27104296
2711−When headers are omitted, column alignments are determined on the basis
2712−of the first line of the table body. So, in the tables above, the columns
2713−would be right, left, center, and right aligned, respectively.
4297+A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
4298+it will appear as `~`. In HTML and XML output, it will appear as a
4299+literal unicode nonbreaking space character (note that it will thus
4300+actually look "invisible" in the generated HTML source; you can still
4301+use the `--ascii` command-line option to make it appear as an explicit
4302+entity).
27144303
2715−#### Extension: `multiline_tables` ####
4304+A backslash-escaped newline (i.e. a backslash occurring at the end of
4305+a line) is parsed as a hard line break. It will appear in TeX output as
4306+`\\` and in HTML as `<br />`. This is a nice alternative to
4307+Markdown's "invisible" way of indicating hard line breaks using
4308+two trailing spaces on a line.
27164309
2717−Multiline tables allow headers and table rows to span multiple lines
2718−of text (but cells that span multiple columns or rows of the table are
2719−not supported). Here is an example:
4310+Backslash escapes do not work in verbatim contexts.
27204311
2721− -------------------------------------------------------------
2722− Centered Default Right Left
2723− Header Aligned Aligned Aligned
2724− ----------- ------- --------------- -------------------------
2725− First row 12.0 Example of a row that
2726− spans multiple lines.
4312+## Inline formatting
27274313
2728− Second row 5.0 Here's another one. Note
2729− the blank line between
2730− rows.
2731− -------------------------------------------------------------
4314+### Emphasis ###
27324315
2733− Table: Here's the caption. It, too, may span
2734− multiple lines.
4316+To *emphasize* some text, surround it with `*`s or `_`, like this:
27354317
2736−These work like simple tables, but with the following differences:
4318+ This text is _emphasized with underscores_, and this
4319+ is *emphasized with asterisks*.
27374320
2738− - They must begin with a row of dashes, before the header text
2739− (unless the headers are omitted).
2740− - They must end with a row of dashes, then a blank line.
2741− - The rows must be separated by blank lines.
4321+Double `*` or `_` produces **strong emphasis**:
27424322
2743−In multiline tables, the table parser pays attention to the widths of
2744−the columns, and the writers try to reproduce these relative widths in
2745−the output. So, if you find that one of the columns is too narrow in the
2746−output, try widening it in the Markdown source.
4323+ This is **strong emphasis** and __with underscores__.
27474324
2748−Headers may be omitted in multiline tables as well as simple tables:
4325+A `*` or `_` character surrounded by spaces, or backslash-escaped,
4326+will not trigger emphasis:
27494327
2750− ----------- ------- --------------- -------------------------
2751− First row 12.0 Example of a row that
2752− spans multiple lines.
4328+ This is * not emphasized *, and \*neither is this\*.
27534329
2754− Second row 5.0 Here's another one. Note
2755− the blank line between
2756− rows.
2757− ----------- ------- --------------- -------------------------
4330+#### Extension: `intraword_underscores` ####
27584331
2759− : Here's a multiline table without headers.
4332+Because `_` is sometimes used inside words and identifiers,
4333+pandoc does not interpret a `_` surrounded by alphanumeric
4334+characters as an emphasis marker. If you want to emphasize
4335+just part of a word, use `*`:
27604336
2761−It is possible for a multiline table to have just one row, but the row
2762−should be followed by a blank line (and then the row of dashes that ends
2763−the table), or the table may be interpreted as a simple table.
4337+ feas*ible*, not feas*able*.
27644338
2765−#### Extension: `grid_tables` ####
27664339
2767−Grid tables look like this:
4340+### Strikeout ###
27684341
2769− : Sample grid table.
4342+#### Extension: `strikeout` ####
27704343
2771− +---------------+---------------+--------------------+
2772− | Fruit | Price | Advantages |
2773− +===============+===============+====================+
2774− | Bananas | $1.34 | - built-in wrapper |
2775− | | | - bright color |
2776− +---------------+---------------+--------------------+
2777− | Oranges | $2.10 | - cures scurvy |
2778− | | | - tasty |
2779− +---------------+---------------+--------------------+
4344+To strikeout a section of text with a horizontal line, begin and end it
4345+with `~~`. Thus, for example,
27804346
2781−The row of `=`s separates the header from the table body, and can be
2782−omitted for a headerless table. The cells of grid tables may contain
2783−arbitrary block elements (multiple paragraphs, code blocks, lists,
2784−etc.). Cells that span multiple columns or rows are not
2785−supported. Grid tables can be created easily using [Emacs table mode].
4347+ This ~~is deleted text.~~
27864348
2787−[Emacs table mode]: http://table.sourceforge.net/
27884349
2789−Alignments can be specified as with pipe tables, by putting
2790−colons at the boundaries of the separator line after the
2791−header:
4350+### Superscripts and subscripts ###
27924351
2793− +---------------+---------------+--------------------+
2794− | Right | Left | Centered |
2795− +==============:+:==============+:==================:+
2796− | Bananas | $1.34 | built-in wrapper |
2797− +---------------+---------------+--------------------+
4352+#### Extension: `superscript`, `subscript` ####
27984353
2799−For headerless tables, the colons go on the top line instead:
4354+Superscripts may be written by surrounding the superscripted text by `^`
4355+characters; subscripts may be written by surrounding the subscripted
4356+text by `~` characters. Thus, for example,
28004357
2801− +--------------:+:--------------+:------------------:+
2802− | Right | Left | Centered |
2803− +---------------+---------------+--------------------+
4358+ H~2~O is a liquid. 2^10^ is 1024.
28044359
2805−##### Grid Table Limitations #####
4360+The text between `^...^` or `~...~` may not contain spaces or
4361+newlines. If the superscripted or subscripted text contains
4362+spaces, these spaces must be escaped with backslashes. (This is
4363+to prevent accidental superscripting and subscripting through
4364+the ordinary use of `~` and `^`, and also bad interactions with
4365+footnotes.) Thus, if you want the letter P with 'a cat' in
4366+subscripts, use `P~a\ cat~`, not `P~a cat~`.
28064367
2807−Pandoc does not support grid tables with row spans or column spans.
2808−This means that neither variable numbers of columns across rows nor
2809−variable numbers of rows across columns are supported by Pandoc.
2810−All grid tables must have the same number of columns in each row,
2811−and the same number of rows in each column. For example, the
2812−Docutils [sample grid tables] will not render as expected with
2813−Pandoc.
4368+### Verbatim ###
28144369
2815−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4370+To make a short span of text verbatim, put it inside backticks:
28164371
4372+ What is the difference between `>>=` and `>>`?
28174373
2818−#### Extension: `pipe_tables` ####
4374+If the verbatim text includes a backtick, use double backticks:
28194375
2820−Pipe tables look like this:
4376+ Here is a literal backtick `` ` ``.
28214377
2822− | Right | Left | Default | Center |
2823− |------:|:-----|---------|:------:|
2824− | 12 | 12 | 12 | 12 |
2825− | 123 | 123 | 123 | 123 |
2826− | 1 | 1 | 1 | 1 |
4378+(The spaces after the opening backticks and before the closing
4379+backticks will be ignored.)
28274380
2828− : Demonstration of pipe table syntax.
4381+The general rule is that a verbatim span starts with a string
4382+of consecutive backticks (optionally followed by a space)
4383+and ends with a string of the same number of backticks (optionally
4384+preceded by a space).
28294385
2830−The syntax is identical to [PHP Markdown Extra tables]. The beginning and
2831−ending pipe characters are optional, but pipes are required between all
2832−columns. The colons indicate column alignment as shown. The header
2833−cannot be omitted. To simulate a headerless table, include a header
2834−with blank cells.
4386+Note that backslash-escapes (and other Markdown constructs) do not
4387+work in verbatim contexts:
28354388
2836−Since the pipes indicate column boundaries, columns need not be vertically
2837−aligned, as they are in the above example. So, this is a perfectly
2838−legal (though ugly) pipe table:
4389+ This is a backslash followed by an asterisk: `\*`.
28394390
2840− fruit| price
2841− -----|-----:
2842− apple|2.05
2843− pear|1.37
2844− orange|3.09
4391+#### Extension: `inline_code_attributes` ####
28454392
2846−The cells of pipe tables cannot contain block elements like paragraphs
2847−and lists, and cannot span multiple lines. If a pipe table contains a
2848−row whose printable content is wider than the column width (see
2849−`--columns`), then the cell contents will wrap, with the
2850−relative cell widths determined by the widths of the separator
2851−lines. (In this case, the table will take up the full text
2852−width.) If no lines are wider than column width, then
2853−cell contents will not be wrapped, and the cells will be sized
2854−to their contents.
4393+Attributes can be attached to verbatim text, just as with
4394+[fenced code blocks]:
28554395
2856−Note: pandoc also recognizes pipe tables of the following
2857−form, as can be produced by Emacs' orgtbl-mode:
4396+ `<$>`{.haskell}
28584397
2859− | One | Two |
2860− |-----+-------|
2861− | my | table |
2862− | is | nice |
4398+### Small caps ###
28634399
2864−The difference is that `+` is used instead of `|`. Other orgtbl features
2865−are not supported. In particular, to get non-default column alignment,
2866−you'll need to add colons as above.
4400+To write small caps, use the `smallcaps` class:
28674401
2868−[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4402+ [Small caps]{.smallcaps}
28694403
2870−Metadata blocks
2871−---------------
4404+Or, without the `bracketed_spans` extension:
28724405
2873−#### Extension: `pandoc_title_block` ####
4406+ <span class="smallcaps">Small caps</span>
28744407
2875−If the file begins with a title block
4408+For compatibility with other Markdown flavors, CSS is also supported:
28764409
2877− % title
2878− % author(s) (separated by semicolons)
2879− % date
4410+ <span style="font-variant:small-caps;">Small caps</span>
28804411
2881−it will be parsed as bibliographic information, not regular text. (It
2882−will be used, for example, in the title of standalone LaTeX or HTML
2883−output.) The block may contain just a title, a title and an author,
2884−or all three elements. If you want to include an author but no
2885−title, or a title and a date but no author, you need a blank line:
4412+This will work in all output formats that support small caps.
28864413
2887− %
2888− % Author
28894414
2890− % My title
2891− %
2892− % June 15, 2006
4415+## Math
28934416
2894−The title may occupy multiple lines, but continuation lines must
2895−begin with leading space, thus:
4417+#### Extension: `tex_math_dollars` ####
28964418
2897− % My title
2898− on multiple lines
4419+Anything between two `$` characters will be treated as TeX math. The
4420+opening `$` must have a non-space character immediately to its right,
4421+while the closing `$` must have a non-space character immediately to its
4422+left, and must not be followed immediately by a digit. Thus,
4423+`$20,000 and $30,000` won't parse as math. If for some reason
4424+you need to enclose text in literal `$` characters, backslash-escape
4425+them and they won't be treated as math delimiters.
28994426
2900−If a document has multiple authors, the authors may be put on
2901−separate lines with leading space, or separated by semicolons, or
2902−both. So, all of the following are equivalent:
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.)
29034430
2904− % Author One
2905− Author Two
4431+TeX math will be printed in all output formats. How it is rendered
4432+depends on the output format:
29064433
2907− % Author One; Author Two
4434+LaTeX
4435+ ~ It will appear verbatim surrounded by `\(...\)` (for inline
4436+ math) or `\[...\]` (for display math).
29084437
2909− % Author One;
2910− Author Two
4438+Markdown, Emacs Org mode, ConTeXt, ZimWiki
4439+ ~ It will appear verbatim surrounded by `$...$` (for inline
4440+ math) or `$$...$$` (for display math).
29114441
2912−The date must fit on one line.
4442+XWiki
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
29134444
2914−All three metadata fields may contain standard inline formatting
2915−(italics, links, footnotes, etc.).
4445+reStructuredText
4446+ ~ It will be rendered using an [interpreted text role `:math:`].
29164447
2917−Title blocks will always be parsed, but they will affect the output only
2918−when the `--standalone` (`-s`) option is chosen. In HTML output, titles
2919−will appear twice: once in the document head -- this is the title that
2920−will appear at the top of the window in a browser -- and once at the
2921−beginning of the document body. The title in the document head can have
2922−an optional prefix attached (`--title-prefix` or `-T` option). The title
2923−in the body appears as an H1 element with class "title", so it can be
2924−suppressed or reformatted with CSS. If a title prefix is specified with
2925−`-T` and no title block appears in the document, the title prefix will
2926−be used by itself as the HTML title.
4448+AsciiDoc
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.
29274454
2928−The man page writer extracts a title, man page section number, and
2929−other header and footer information from the title line. The title
2930−is assumed to be the first word on the title line, which may optionally
2931−end with a (single-digit) section number in parentheses. (There should
2932−be no space between the title and the parentheses.) Anything after
2933−this is assumed to be additional footer and header text. A single pipe
2934−character (`|`) should be used to separate the footer text from the header
2935−text. Thus,
4455+Texinfo
4456+ ~ It will be rendered inside a `@math` command.
29364457
2937− % PANDOC(1)
4458+roff man, Jira markup
4459+ ~ It will be rendered verbatim without `$`'s.
29384460
2939−will yield a man page with the title `PANDOC` and section 1.
4461+MediaWiki, DokuWiki
4462+ ~ It will be rendered inside `<math>` tags.
29404463
2941− % PANDOC(1) Pandoc User Manuals
4464+Textile
4465+ ~ It will be rendered inside `<span class="math">` tags.
29424466
2943−will also have "Pandoc User Manuals" in the footer.
4467+RTF, OpenDocument
4468+ ~ It will be rendered, if possible, using Unicode characters,
4469+ and will otherwise appear verbatim.
29444470
2945− % PANDOC(1) Pandoc User Manuals | Version 4.0
4471+ODT
4472+ ~ It will be rendered, if possible, using MathML.
4473+
4474+DocBook
4475+ ~ If the `--mathml` flag is used, it will be rendered using MathML
4476+ in an `inlineequation` or `informalequation` tag. Otherwise it
4477+ will be rendered, if possible, using Unicode characters.
29464478
2947−will also have "Version 4.0" in the header.
4479+Docx
4480+ ~ It will be rendered using OMML math markup.
29484481
2949−#### Extension: `yaml_metadata_block` ####
4482+FictionBook2
4483+ ~ If the `--webtex` option is used, formulas are rendered as images
4484+ using CodeCogs or other compatible web service, downloaded
4485+ and embedded in the e-book. Otherwise, they will appear verbatim.
29504486
2951−A YAML metadata block is a valid YAML object, delimited by a line of three
2952−hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
2953−(`...`) at the bottom. A YAML metadata block may occur anywhere in the
2954−document, but if it is not at the beginning, it must be preceded by a blank
2955−line. (Note that, because of the way pandoc concatenates input files when
2956−several are provided, you may also keep the metadata in a separate YAML file
2957−and pass it to pandoc as an argument, along with your Markdown files:
4487+HTML, Slidy, DZSlides, S5, EPUB
4488+ ~ The way math is rendered in HTML will depend on the
4489+ command-line options selected. Therefore see [Math rendering in HTML]
4490+ above.
29584491
2959− pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
29604493
2961−Just be sure that the YAML file begins with `---` and ends with `---` or
2962−`...`.)
4494+## Raw HTML
29634495
2964−Metadata will be taken from the fields of the YAML object and added to any
2965−existing document metadata. Metadata can contain lists and objects (nested
2966−arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2967−with names ending in an underscore will be ignored by pandoc. (They may be
2968−given a role by external processors.)
4496+#### Extension: `raw_html` ####
29694497
2970−A document may contain multiple metadata blocks. The metadata fields will
2971−be combined through a *left-biased union*: if two metadata blocks attempt
2972−to set the same field, the value from the first block will be taken.
4498+Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
4499+(except verbatim contexts, where `<`, `>`, and `&` are interpreted
4500+literally). (Technically this is not an extension, since standard
4501+Markdown allows it, but it has been made an extension so that it can
4502+be disabled if desired.)
29734503
2974−When pandoc is used with `-t markdown` to create a Markdown document,
2975−a YAML metadata block will be produced only if the `-s/--standalone`
2976−option is used. All of the metadata will appear in a single block
2977−at the beginning of the document.
4504+The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4505+DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4506+output, and suppressed in other formats.
29784507
2979−Note that YAML escaping rules must be followed. Thus, for example,
2980−if a title contains a colon, it must be quoted. The pipe character
2981−(`|`) can be used to begin an indented block that will be interpreted
2982−literally, without need for escaping. This form is necessary
2983−when the field contains blank lines or block-level formatting:
4508+For a more explicit way of including raw HTML in a Markdown
4509+document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
29844510
2985− ---
2986− title: 'This is the title: it contains a colon'
2987− author:
2988− - Author One
2989− - Author Two
2990− tags: [nothing, nothingness]
2991− abstract: |
2992− This is the abstract.
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.
29934516
2994− It consists of two paragraphs.
2995− ...
4517+#### Extension: `markdown_in_html_blocks` ####
29964518
2997−Template variables will be set automatically from the metadata. Thus, for
2998−example, in writing HTML, the variable `abstract` will be set to the HTML
2999−equivalent of the Markdown in the `abstract` field:
4519+Standard Markdown allows you to include HTML "blocks": blocks
4520+of HTML between balanced tags that are separated from the surrounding text
4521+with blank lines, and start and end at the left margin. Within
4522+these blocks, everything is interpreted as HTML, not Markdown;
4523+so (for example), `*` does not signify emphasis.
30004524
3001− <p>This is the abstract.</p>
3002− <p>It consists of two paragraphs.</p>
4525+Pandoc behaves this way when the `markdown_strict` format is used; but
4526+by default, pandoc interprets material between HTML block tags as Markdown.
4527+Thus, for example, pandoc will turn
30034528
3004−Variables can contain arbitrary YAML structures, but the template must match
3005−this structure. The `author` variable in the default templates expects a
3006−simple list or string, but can be changed to support more complicated
3007−structures. The following combination, for example, would add an affiliation
3008−to the author if one is given:
4529+ <table>
4530+ <tr>
4531+ <td>*one*</td>
4532+ <td>[a link](https://google.com)</td>
4533+ </tr>
4534+ </table>
30094535
3010− ---
3011− title: The document title
3012− author:
3013− - name: Author One
3014− affiliation: University of Somewhere
3015− - name: Author Two
3016− affiliation: University of Nowhere
3017− ...
4536+into
30184537
3019−To use the structured authors in the example above, you would need a custom
3020−template:
4538+ <table>
4539+ <tr>
4540+ <td><em>one</em></td>
4541+ <td><a href="https://google.com">a link</a></td>
4542+ </tr>
4543+ </table>
30214544
3022− $for(author)$
3023− $if(author.name)$
3024− $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
3025− $else$
3026− $author$
3027− $endif$
3028− $endfor$
4545+whereas `Markdown.pl` will preserve it as is.
30294546
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
30304549
3031−Backslash escapes
3032−-----------------
4550+This departure from standard Markdown should make it easier to mix
4551+Markdown with HTML block elements. For example, one can surround
4552+a block of Markdown text with `<div>` tags without preventing it
4553+from being interpreted as Markdown.
30334554
3034−#### Extension: `all_symbols_escapable` ####
4555+#### Extension: `native_divs` ####
30354556
3036−Except inside a code block or inline code, any punctuation or space
3037−character preceded by a backslash will be treated literally, even if it
3038−would normally indicate formatting. Thus, for example, if one writes
4557+Use native pandoc `Div` blocks for content inside `<div>` tags.
4558+For the most part this should give the same output as
4559+`markdown_in_html_blocks`, but it makes it easier to write pandoc
4560+filters to manipulate groups of blocks.
30394561
3040− *\*hello\**
4562+#### Extension: `native_spans` ####
30414563
3042−one will get
4564+Use native pandoc `Span` blocks for content inside `<span>` tags.
4565+For the most part this should give the same output as `raw_html`,
4566+but it makes it easier to write pandoc filters to manipulate groups
4567+of inlines.
30434568
3044− <em>*hello*</em>
4569+#### Extension: `raw_tex` ####
30454570
3046−instead of
4571+In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
4572+included in a document. Inline TeX commands will be preserved and passed
4573+unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
4574+LaTeX to include BibTeX citations:
30474575
3048− <strong>hello</strong>
4576+ This result was proved in \cite{jones.1967}.
30494577
3050−This rule is easier to remember than standard Markdown's rule,
3051−which allows only the following characters to be backslash-escaped:
4578+Note that in LaTeX environments, like
30524579
3053− \`*_{}[]()>#+-.!
4580+ \begin{tabular}{|l|l|}\hline
4581+ Age & Frequency \\ \hline
4582+ 18--25 & 15 \\
4583+ 26--35 & 33 \\
4584+ 36--45 & 22 \\ \hline
4585+ \end{tabular}
30544586
3055−(However, if the `markdown_strict` format is used, the standard Markdown rule
3056−will be used.)
4587+the material between the begin and end tags will be interpreted as raw
4588+LaTeX, not as Markdown.
30574589
3058−A backslash-escaped space is parsed as a nonbreaking space. It will
3059−appear in TeX output as `~` and in HTML and XML as `\ ` or
3060−`\ `.
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`].
30614593
3062−A backslash-escaped newline (i.e. a backslash occurring at the end of
3063−a line) is parsed as a hard line break. It will appear in TeX output as
3064−`\\` and in HTML as `<br />`. This is a nice alternative to
3065−Markdown's "invisible" way of indicating hard line breaks using
3066−two trailing spaces on a line.
4594+Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4595+Emacs Org mode, and ConTeXt.
30674596
3068−Backslash escapes do not work in verbatim contexts.
4597+### Generic raw attribute ###
30694598
3070−Inline formatting
3071−-----------------
4599+#### Extension: `raw_attribute` ####
30724600
3073−### Emphasis ###
4601+Inline spans and fenced code blocks with a special
4602+kind of attribute will be parsed as raw content with the
4603+designated format. For example, the following produces a raw
4604+roff `ms` block:
30744605
3075−To *emphasize* some text, surround it with `*`s or `_`, like this:
4606+ ```{=ms}
4607+ .MYMACRO
4608+ blah blah
4609+ ```
4610+And the following produces a raw `html` inline element:
30764611
3077− This text is _emphasized with underscores_, and this
3078− is *emphasized with asterisks*.
4612+ This is `<a>html</a>`{=html}
30794613
3080−Double `*` or `_` produces **strong emphasis**:
4614+This can be useful to insert raw xml into `docx` documents, e.g.
4615+a pagebreak:
30814616
3082− This is **strong emphasis** and __with underscores__.
4617+ ```{=openxml}
4618+ <w:p>
4619+ <w:r>
4620+ <w:br w:type="page"/>
4621+ </w:r>
4622+ </w:p>
4623+ ```
30834624
3084−A `*` or `_` character surrounded by spaces, or backslash-escaped,
3085−will not trigger emphasis:
4625+The format name should match the target format name (see
4626+`-t/--to`, above, for a list, or use `pandoc
4627+--list-output-formats`). Use `openxml` for `docx` output,
4628+`opendocument` for `odt` output, `html5` for `epub3` output,
4629+`html4` for `epub2` output, and `latex`, `beamer`,
4630+`ms`, or `html5` for `pdf` output (depending on what you
4631+use for `--pdf-engine`).
30864632
3087− This is * not emphasized *, and \*neither is this\*.
4633+This extension presupposes that the relevant kind of
4634+inline code or fenced code block is enabled. Thus, for
4635+example, to use a raw attribute with a backtick code block,
4636+`backtick_code_blocks` must be enabled.
30884637
3089−#### Extension: `intraword_underscores` ####
4638+The raw attribute cannot be combined with regular attributes.
30904639
3091−Because `_` is sometimes used inside words and identifiers,
3092−pandoc does not interpret a `_` surrounded by alphanumeric
3093−characters as an emphasis marker. If you want to emphasize
3094−just part of a word, use `*`:
4640+## LaTeX macros
30954641
3096− feas*ible*, not feas*able*.
4642+#### Extension: `latex_macros` ####
30974643
4644+When this extension is enabled, pandoc will parse LaTeX
4645+macro definitions and apply the resulting macros to all LaTeX
4646+math and raw LaTeX. So, for example, the following will work in
4647+all output formats, not just LaTeX:
30984648
3099−### Strikeout ###
4649+ \newcommand{\tuple}[1]{\langle #1 \rangle}
31004650
3101−#### Extension: `strikeout` ####
4651+ $\tuple{a, b, c}$
31024652
3103−To strikeout a section of text with a horizontal line, begin and end it
3104−with `~~`. Thus, for example,
4653+Note that LaTeX macros will not be applied if they occur
4654+inside a raw span or block marked with the
4655+[`raw_attribute` extension](#extension-raw_attribute).
31054656
3106− This ~~is deleted text.~~
4657+When `latex_macros` is disabled, the raw LaTeX and math will
4658+not have macros applied. This is usually a better approach when
4659+you are targeting LaTeX or PDF.
31074660
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
4665+enabled.
31084666
3109−### Superscripts and subscripts ###
4667+## Links
31104668
3111−#### Extension: `superscript`, `subscript` ####
4669+Markdown allows links to be specified in several ways.
31124670
3113−Superscripts may be written by surrounding the superscripted text by `^`
3114−characters; subscripts may be written by surrounding the subscripted
3115−text by `~` characters. Thus, for example,
4671+### Automatic links ###
31164672
3117− H~2~O is a liquid. 2^10^ is 1024.
4673+If you enclose a URL or email address in pointy brackets, it
4674+will become a link:
31184675
3119−If the superscripted or subscripted text contains spaces, these spaces
3120−must be escaped with backslashes. (This is to prevent accidental
3121−superscripting and subscripting through the ordinary use of `~` and `^`.)
3122−Thus, if you want the letter P with 'a cat' in subscripts, use
3123−`P~a\ cat~`, not `P~a cat~`.
4676+ <https://google.com>
4677+ <sam@green.eggs.ham>
31244678
4679+### Inline links ###
31254680
3126−### Verbatim ###
4681+An inline link consists of the link text in square brackets,
4682+followed by the URL in parentheses. (Optionally, the URL can
4683+be followed by a link title, in quotes.)
31274684
3128−To make a short span of text verbatim, put it inside backticks:
4685+ This is an [inline link](/url), and here's [one with
4686+ a title](https://fsf.org "click here for a good time!").
31294687
3130− What is the difference between `>>=` and `>>`?
4688+There can be no space between the bracketed part and the parenthesized part.
4689+The link text can contain formatting (such as emphasis), but the title cannot.
31314690
3132−If the verbatim text includes a backtick, use double backticks:
4691+Email addresses in inline links are not autodetected, so they have to be
4692+prefixed with `mailto`:
31334693
3134− Here is a literal backtick `` ` ``.
4694+ [Write me!](mailto:sam@green.eggs.ham)
31354695
3136−(The spaces after the opening backticks and before the closing
3137−backticks will be ignored.)
4696+### Reference links ###
31384697
3139−The general rule is that a verbatim span starts with a string
3140−of consecutive backticks (optionally followed by a space)
3141−and ends with a string of the same number of backticks (optionally
3142−preceded by a space).
4698+An *explicit* reference link has two parts, the link itself and the link
4699+definition, which may occur elsewhere in the document (either
4700+before or after the link).
31434701
3144−Note that backslash-escapes (and other Markdown constructs) do not
3145−work in verbatim contexts:
4702+The link consists of link text in square brackets, followed by a label in
4703+square brackets. (There cannot be space between the two unless the
4704+`spaced_reference_links` extension is enabled.) The link definition
4705+consists of the bracketed label, followed by a colon and a space, followed by
4706+the URL, and optionally (after a space) a link title either in quotes or in
4707+parentheses. The label must not be parseable as a citation (assuming
4708+the `citations` extension is enabled): citations take precedence over
4709+link labels.
31464710
3147− This is a backslash followed by an asterisk: `\*`.
4711+Here are some examples:
31484712
3149−#### Extension: `inline_code_attributes` ####
4713+ [my label 1]: /foo/bar.html "My title, optional"
4714+ [my label 2]: /foo
4715+ [my label 3]: https://fsf.org (The free software foundation)
4716+ [my label 4]: /bar#special 'A title in single quotes'
31504717
3151−Attributes can be attached to verbatim text, just as with
3152−[fenced code blocks]:
4718+The URL may optionally be surrounded by angle brackets:
31534719
3154− `<$>`{.haskell}
4720+ [my label 5]: <http://foo.bar.baz>
31554721
3156−### Small caps ###
4722+The title may go on the next line:
31574723
3158−To write small caps, use the `smallcaps` class:
4724+ [my label 3]: https://fsf.org
4725+ "The free software foundation"
31594726
3160− [Small caps]{.smallcaps}
4727+Note that link labels are not case sensitive. So, this will work:
31614728
3162−Or, without the `bracketed_spans` extension:
4729+ Here is [my link][FOO]
31634730
3164− <span class="smallcaps">Small caps</span>
4731+ [Foo]: /bar/baz
31654732
3166−For compatibility with other Markdown flavors, CSS is also supported:
4733+In an *implicit* reference link, the second pair of brackets is
4734+empty:
31674735
3168− <span style="font-variant:small-caps;">Small caps</span>
4736+ See [my website][].
31694737
3170−This will work in all output formats that support small caps.
4738+ [my website]: http://foo.bar.baz
31714739
4740+Note: In `Markdown.pl` and most other Markdown implementations,
4741+reference link definitions cannot occur in nested constructions
4742+such as list items or block quotes. Pandoc lifts this arbitrary
4743+seeming restriction. So the following is fine in pandoc, though
4744+not in most other implementations:
31724745
3173−Math
3174−----
4746+ > My block [quote].
4747+ >
4748+ > [quote]: /foo
31754749
3176−#### Extension: `tex_math_dollars` ####
4750+#### Extension: `shortcut_reference_links` ####
31774751
3178−Anything between two `$` characters will be treated as TeX math. The
3179−opening `$` must have a non-space character immediately to its right,
3180−while the closing `$` must have a non-space character immediately to its
3181−left, and must not be followed immediately by a digit. Thus,
3182−`$20,000 and $30,000` won't parse as math. If for some reason
3183−you need to enclose text in literal `$` characters, backslash-escape
3184−them and they won't be treated as math delimiters.
4752+In a *shortcut* reference link, the second pair of brackets may
4753+be omitted entirely:
31854754
3186−TeX math will be printed in all output formats. How it is rendered
3187−depends on the output format:
4755+ See [my website].
31884756
3189−Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
3190− ~ It will appear verbatim between `$` characters.
4757+ [my website]: http://foo.bar.baz
31914758
3192−reStructuredText
3193− ~ It will be rendered using an [interpreted text role `:math:`].
4759+### Internal links ###
31944760
3195−AsciiDoc
3196− ~ It will be rendered as `latexmath:[...]`.
4761+To link to another section of the same document, use the automatically
4762+generated identifier (see [Heading identifiers]). For example:
31974763
3198−Texinfo
3199− ~ It will be rendered inside a `@math` command.
4764+ See the [Introduction](#introduction).
32004765
3201−groff man
3202− ~ It will be rendered verbatim without `$`'s.
4766+or
32034767
3204−MediaWiki, DokuWiki
3205− ~ It will be rendered inside `<math>` tags.
4768+ See the [Introduction].
32064769
3207−Textile
3208− ~ It will be rendered inside `<span class="math">` tags.
4770+ [Introduction]: #introduction
32094771
3210−RTF, OpenDocument
3211− ~ It will be rendered, if possible, using Unicode characters,
3212− and will otherwise appear verbatim.
4772+Internal links are currently supported for HTML formats (including
4773+HTML slide shows and EPUB), LaTeX, and ConTeXt.
32134774
3214−ODT
3215− ~ It will be rendered, if possible, using MathML.
4775+## Images
32164776
3217−DocBook
3218− ~ If the `--mathml` flag is used, it will be rendered using MathML
3219− in an `inlineequation` or `informalequation` tag. Otherwise it
3220− will be rendered, if possible, using Unicode characters.
4777+A link immediately preceded by a `!` will be treated as an image.
4778+The link text will be used as the image's alt text:
32214779
3222−Docx
3223− ~ It will be rendered using OMML math markup.
4780+ 
32244781
3225−FictionBook2
3226− ~ If the `--webtex` option is used, formulas are rendered as images
3227− using CodeCogs or other compatible web service, downloaded
3228− and embedded in the e-book. Otherwise, they will appear verbatim.
4782+ ![movie reel]
32294783
3230−HTML, Slidy, DZSlides, S5, EPUB
3231− ~ The way math is rendered in HTML will depend on the
3232− command-line options selected. Therefore see [Math rendering in HTML]
3233− above.
4784+ [movie reel]: movie.gif
32344785
3235−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4786+#### Extension: `implicit_figures` ####
32364787
3237−Raw HTML
3238−--------
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.
32394791
3240−#### Extension: `raw_html` ####
4792+ 
32414793
3242−Markdown allows you to insert raw HTML (or DocBook) anywhere in a document
3243−(except verbatim contexts, where `<`, `>`, and `&` are interpreted
3244−literally). (Technically this is not an extension, since standard
3245−Markdown allows it, but it has been made an extension so that it can
3246−be disabled if desired.)
4794+How this is rendered depends on the output format. Some output
4795+formats (e.g. RTF) do not yet support figures. In those
4796+formats, you'll just get an image in a paragraph by itself, with
4797+no caption.
32474798
3248−The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3249−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3250−in other formats.
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:
32514802
3252−#### Extension: `markdown_in_html_blocks` ####
4803+ \
32534804
3254−Standard Markdown allows you to include HTML "blocks": blocks
3255−of HTML between balanced tags that are separated from the surrounding text
3256−with blank lines, and start and end at the left margin. Within
3257−these blocks, everything is interpreted as HTML, not Markdown;
3258−so (for example), `*` does not signify emphasis.
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.
32594808
3260−Pandoc behaves this way when the `markdown_strict` format is used; but
3261−by default, pandoc interprets material between HTML block tags as Markdown.
3262−Thus, for example, pandoc will turn
4809+#### Extension: `link_attributes` ####
32634810
3264− <table>
3265− <tr>
3266− <td>*one*</td>
3267− <td>[a link](http://google.com)</td>
3268− </tr>
3269− </table>
4811+Attributes can be set on links and images:
32704812
3271−into
4813+ An inline {#id .class width=30 height=20px}
4814+ and a reference ![image][ref] with attributes.
32724815
3273− <table>
3274− <tr>
3275− <td><em>one</em></td>
3276− <td><a href="http://google.com">a link</a></td>
3277− </tr>
3278− </table>
4816+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
32794817
3280−whereas `Markdown.pl` will preserve it as is.
4818+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819+and `.class` are used.)
32814820
3282−There is one exception to this rule: text between `<script>` and
3283−`<style>` tags is not interpreted as Markdown.
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.
32844826
3285−This departure from standard Markdown should make it easier to mix
3286−Markdown with HTML block elements. For example, one can surround
3287−a block of Markdown text with `<div>` tags without preventing it
3288−from being interpreted as Markdown.
4827+The `width` and `height` attributes on images are treated specially. When
4828+used without a unit, the unit is assumed to be pixels. However, any of
4829+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4830+and `%`. There must not be any spaces between the number and the unit.
4831+For example:
32894832
3290−#### Extension: `native_divs` ####
4833+```
4834+{ width=50% }
4835+```
32914836
3292−Use native pandoc `Div` blocks for content inside `<div>` tags.
3293−For the most part this should give the same output as
3294−`markdown_in_html_blocks`, but it makes it easier to write pandoc
3295−filters to manipulate groups of blocks.
4837+- Dimensions may be converted to a form that is compatible with
4838+ the output format (for example, dimensions given in pixels will
4839+ be converted to inches when converting HTML to LaTeX). Conversion
4840+ between pixels and physical measurements is affected by the
4841+ `--dpi` option (by default, 96 dpi is assumed, unless the image
4842+ itself contains dpi information).
4843+- The `%` unit is generally relative to some available space.
4844+ For example the above example will render to the following.
4845+ - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846+ - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847+ (If you're using a custom template, you need to configure `graphicx`
4848+ as in the default template.)
4849+ - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4850+- Some output formats have a notion of a class
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4852+ or a unique identifier (LaTeX `\caption`), or both (HTML).
4853+- When no `width` or `height` attributes are specified, the fallback
4854+ is to look at the image resolution and the dpi metadata embedded in
4855+ the image file.
32964856
3297−#### Extension: `native_spans` ####
4857+## Divs and Spans
32984858
3299−Use native pandoc `Span` blocks for content inside `<span>` tags.
3300−For the most part this should give the same output as `raw_html`,
3301−but it makes it easier to write pandoc filters to manipulate groups
3302−of inlines.
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:
33034864
33044865#### Extension: `fenced_divs` ####
33054866
@@ -3340,364 +4901,456 @@ fence need not match the number in the opening fence. However,
33404901it can be helpful for visual clarity to use fences of different
33414902lengths to distinguish nested divs from their parents.
33424903
3343−#### Extension: `raw_tex` ####
33444904
3345−In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
3346−included in a document. Inline TeX commands will be preserved and passed
3347−unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use
3348−LaTeX to include BibTeX citations:
4905+#### Extension: `bracketed_spans` ####
33494906
3350− This result was proved in \cite{jones.1967}.
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:
33514910
3352−Note that in LaTeX environments, like
4911+ [This is *some text*]{.class key="val"}
33534912
3354− \begin{tabular}{|l|l|}\hline
3355− Age & Frequency \\ \hline
3356− 18--25 & 15 \\
3357− 26--35 & 33 \\
3358− 36--45 & 22 \\ \hline
3359− \end{tabular}
4913+## Footnotes
33604914
3361−the material between the begin and end tags will be interpreted as raw
3362−LaTeX, not as Markdown.
4915+#### Extension: `footnotes` ####
33634916
3364−Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3365−Emacs Org mode, and ConTeXt.
4917+Pandoc's Markdown allows footnotes, using the following syntax:
33664918
3367−### Generic raw attribute ###
4919+ Here is a footnote reference,[^1] and another.[^longnote]
33684920
3369−#### Extension: `raw_attribute` ####
4921+ [^1]: Here is the footnote.
33704922
3371−Inline spans and fenced code blocks with a special
3372−kind of attribute will be parsed as raw content with the
3373−designated format. For example, the following produces a raw
3374−groff `ms` block:
4923+ [^longnote]: Here's one with multiple blocks.
33754924
3376− ```{=ms}
3377− .MYMACRO
3378− blah blah
3379− ```
3380−And the following produces a raw `html` inline element:
4925+ Subsequent paragraphs are indented to show that they
4926+ belong to the previous footnote.
33814927
3382− This is `<a>html</a>`{=html}
4928+ { some.code }
33834929
3384−The format name should match the target format name (see
3385−`-t/--to`, above, for a list, or use `pandoc
3386−--list-output-formats`).
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.
33874933
3388−This extension presupposes that the relevant kind of
3389−inline code or fenced code block is enabled. Thus, for
3390−example, to use a raw attribute with a backtick code block,
3391−`backtick_code_blocks` must be enabled.
4934+ This paragraph won't be part of the note, because it
4935+ isn't indented.
33924936
3393−The raw attribute cannot be combined with regular attributes.
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.
33944941
3395−LaTeX macros
3396−------------
4942+The footnotes themselves need not be placed at the end of the
4943+document. They may appear anywhere except inside other block elements
4944+(lists, block quotes, tables, etc.). Each footnote should be
4945+separated from surrounding content (including other footnotes)
4946+by blank lines.
33974947
3398−#### Extension: `latex_macros` ####
4948+#### Extension: `inline_notes` ####
33994949
3400−For output formats other than LaTeX, pandoc will parse LaTeX
3401−macro definitions and apply the resulting macros to all LaTeX
3402−math and raw LaTeX. So, for example, the following will work in
3403−all output formats, not just LaTeX:
4950+Inline footnotes are also allowed (though, unlike regular notes,
4951+they cannot contain multiple paragraphs). The syntax is as follows:
34044952
3405− \newcommand{\tuple}[1]{\langle #1 \rangle}
4953+ Here is an inline note.^[Inlines notes are easier to write, since
4954+ you don't have to pick an identifier and move down to type the
4955+ note.]
34064956
3407− $\tuple{a, b, c}$
4957+Inline and regular footnotes may be mixed freely.
34084958
3409−In LaTeX output, the macro definitions will not be passed
3410−through as raw LaTeX.
4959+## Citation syntax
34114960
3412−When `latex_macros` is disabled, the macro definitions will
3413−be passed through as raw LaTeX, and the raw LaTeX and math will
3414−not have macros applied. This is usually a better approach when
3415−you are targeting LaTeX or PDF.
4961+#### Extension: `citations` ####
34164962
3417−Links
3418−-----
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:
34194966
3420−Markdown allows links to be specified in several ways.
4967+ Blah blah [@doe99; @smith2000; @smith2004].
34214968
3422−### Automatic links ###
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
34234971
3424−If you enclose a URL or email address in pointy brackets, it
3425−will become a link:
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
34264973
3427− <http://google.com>
3428− <sam@green.eggs.ham>
4974+In a footnote style, it might render as
34294975
3430−### Inline links ###
4976+ Blah blah.[^1]
34314977
3432−An inline link consists of the link text in square brackets,
3433−followed by the URL in parentheses. (Optionally, the URL can
3434−be followed by a link title, in quotes.)
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).
34354981
3436− This is an [inline link](/url), and here's [one with
3437− a title](http://fsf.org "click here for a good time!").
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
34384984
3439−There can be no space between the bracketed part and the parenthesized part.
3440−The link text can contain formatting (such as emphasis), but the title cannot.
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]`.
34414994
3442−Email addresses in inline links are not autodetected, so they have to be
3443−prefixed with `mailto`:
4995+Citation items may optionally include a prefix, a locator, and
4996+a suffix. In
34444997
3445− [Write me!](mailto:sam@green.eggs.ham)
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4999+
5000+The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
5001+and suffix `and *passim*`. The second item (`smith04`) has
5002+locator `chap. 1` and no prefix or suffix.
5003+
5004+Pandoc uses some heuristics to separate the locator from the
5005+rest of the subject. It is sensitive to the locator terms
5006+defined in the [CSL locale files]. Either abbreviated or
5007+unabbreviated forms are accepted. In the `en-US` locale, locator
5008+terms can be written in either singular or plural forms, as
5009+`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5010+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
5011+`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012+`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
5013+`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
5014+`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
5015+`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5016+locator term is used, "page" is assumed.
5017+
5018+In complex cases, you can force something to be treated as
5019+a locator by enclosing it in curly braces or prevent parsing
5020+the suffix as locator by prepending curly braces:
5021+
5022+ [@smith{ii, A, D-Z}, with a suffix]
5023+ [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
5025+
5026+A minus sign (`-`) before the `@` will suppress mention of
5027+the author in the citation. This can be useful when the
5028+author is already mentioned in the text:
34465029
3447−### Reference links ###
5030+ Smith says blah [-@smith04].
34485031
3449−An *explicit* reference link has two parts, the link itself and the link
3450−definition, which may occur elsewhere in the document (either
3451−before or after the link).
5032+You can also write an author-in-text citation, by omitting the
5033+square brackets:
34525034
3453−The link consists of link text in square brackets, followed by a label in
3454−square brackets. (There cannot be space between the two unless the
3455−`spaced_reference_links` extension is enabled.) The link definition
3456−consists of the bracketed label, followed by a colon and a space, followed by
3457−the URL, and optionally (after a space) a link title either in quotes or in
3458−parentheses. The label must not be parseable as a citation (assuming
3459−the `citations` extension is enabled): citations take precedence over
3460−link labels.
5035+ @smith04 says blah.
34615036
3462−Here are some examples:
5037+ @smith04 [p. 33] says blah.
34635038
3464− [my label 1]: /foo/bar.html "My title, optional"
3465− [my label 2]: /foo
3466− [my label 3]: http://fsf.org (The free software foundation)
3467− [my label 4]: /bar#special 'A title in single quotes'
5039+This will cause the author's name to be rendered, followed by
5040+the bibliographical details. Use this form when you want to
5041+make the citation the subject of a sentence.
5042+
5043+When you are using a note style, it is usually better to let
5044+citeproc create the footnotes from citations rather than writing
5045+an explicit note. If you do write an explicit note that
5046+contains a citation, note that normal citations will be put in
5047+parentheses, while author-in-text citations will not. For
5048+this reason, it is sometimes preferable to use the
5049+author-in-text style inside notes when using a note style.
5050+
5051+[CSL user documentation]: https://citationstyles.org/authors/
5052+[CSL]: https://docs.citationstyles.org/en/stable/specification.html
5053+[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5054+[Chicago Manual of Style]: https://chicagomanualofstyle.org
5055+[Citation Style Language]: https://citationstyles.org
5056+[Zotero Style Repository]: https://www.zotero.org/styles
5057+[finding and editing styles]: https://citationstyles.org/authors/
5058+[CSL locale files]: https://github.com/citation-style-language/locales
34685059
3469−The URL may optionally be surrounded by angle brackets:
5060+## Non-default extensions
34705061
3471− [my label 5]: <http://foo.bar.baz>
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.
34725066
3473−The title may go on the next line:
5067+#### Extension: `rebase_relative_paths` ####
5068+
5069+Rewrite relative paths for Markdown links and images, depending
5070+on the path of the file containing the link or image link. For
5071+each link or image, pandoc will compute the directory of the
5072+containing file, relative to the working directory, and prepend
5073+the resulting path to the link or image path.
5074+
5075+The use of this extension is best understood by example.
5076+Suppose you have a a subdirectory for each chapter of a book,
5077+`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a
5078+number of images used in the chapter. You would like to have
5079+`` in `chap1/text.md` refer to
5080+`chap1/spider.jpg` and `` in `chap2/text.md`
5081+refer to `chap2/spider.jpg`. To do this, use
5082+
5083+ pandoc chap*/*.md -f markdown+rebase_relative_paths
5084+
5085+Without this extension, you would have to use
5086+`` in `chap1/text.md` and
5087+`` in `chap2/text.md`. Links with
5088+relative paths will be rewritten in the same way as images.
5089+
5090+Absolute paths and URLs are not changed. Neither are empty
5091+paths or paths consisting entirely of a fragment, e.g., `#foo`.
5092+
5093+Note that relative paths in reference links and images will
5094+be rewritten relative to the file containing the link
5095+reference definition, not the file containing the reference link
5096+or image itself, if these differ.
5097+
5098+#### Extension: `attributes` ####
5099+
5100+Allows attributes to be attached to any inline or block-level
5101+element. The syntax for the attributes is the same as that
5102+used in [`header_attributes`][Extension: `header_attributes`].
5103+
5104+- Attributes that occur immediately after an inline
5105+ element affect that element. If they follow a space, then they
5106+ belong to the space. (Hence, this option subsumes
5107+ `inline_code_attributes` and `link_attributes`.)
5108+- Attributes that occur immediately before a block
5109+ element, on a line by themselves, affect that
5110+ element.
5111+- Consecutive attribute specifiers may be used,
5112+ either for blocks or for inlines. Their attributes
5113+ will be combined.
5114+- Attributes that occur at the end of the text of
5115+ a Setext or ATX heading (separated by whitespace
5116+ from the text) affect the heading element. (Hence, this
5117+ option subsumes `header_attributes`.)
5118+- Attributes that occur after the opening fence
5119+ in a fenced code block affect the code block element. (Hence,
5120+ this option subsumes `fenced_code_attributes`.)
5121+- Attributes that occur at the end of a reference
5122+ link definition affect links that refer to that
5123+ definition.
5124+
5125+Note that pandoc's AST does not currently allow attributes
5126+to be attached to arbitrary elements. Hence a Span or Div
5127+container will be added if needed.
34745128
3475− [my label 3]: http://fsf.org
3476− "The free software foundation"
5129+#### Extension: `old_dashes` ####
34775130
3478−Note that link labels are not case sensitive. So, this will work:
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.
34795135
3480− Here is [my link][FOO]
5136+#### Extension: `angle_brackets_escapable` ####
34815137
3482− [Foo]: /bar/baz
5138+Allow `<` and `>` to be backslash-escaped, as they can be in
5139+GitHub flavored Markdown but not original Markdown. This is
5140+implied by pandoc's default `all_symbols_escapable`.
34835141
3484−In an *implicit* reference link, the second pair of brackets is
3485−empty:
5142+#### Extension: `lists_without_preceding_blankline` ####
34865143
3487− See [my website][].
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
34885146
3489− [my website]: http://foo.bar.baz
5147+#### Extension: `four_space_rule` ####
34905148
3491−Note: In `Markdown.pl` and most other Markdown implementations,
3492−reference link definitions cannot occur in nested constructions
3493−such as list items or block quotes. Pandoc lifts this arbitrary
3494−seeming restriction. So the following is fine in pandoc, though
3495−not in most other implementations:
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
34965152
3497− > My block [quote].
3498− >
3499− > [quote]: /foo
5153+#### Extension: `spaced_reference_links` ####
35005154
3501−#### Extension: `shortcut_reference_links` ####
5155+Allow whitespace between the two components of a reference link,
5156+for example,
35025157
3503−In a *shortcut* reference link, the second pair of brackets may
3504−be omitted entirely:
5158+ [foo] [bar].
35055159
3506− See [my website].
5160+#### Extension: `hard_line_breaks` ####
35075161
3508− [my website]: http://foo.bar.baz
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
35095164
3510−### Internal links ###
5165+#### Extension: `ignore_line_breaks` ####
35115166
3512−To link to another section of the same document, use the automatically
3513−generated identifier (see [Header identifiers]). For example:
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.
35145171
3515− See the [Introduction](#introduction).
5172+#### Extension: `east_asian_line_breaks` ####
35165173
3517−or
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.
35185179
3519− See the [Introduction].
5180+#### Extension: `emoji` ####
35205181
3521− [Introduction]: #introduction
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
35225183
3523−Internal links are currently supported for HTML formats (including
3524−HTML slide shows and EPUB), LaTeX, and ConTeXt.
5184+#### Extension: `tex_math_single_backslash` ####
35255185
3526−Images
3527−------
5186+Causes anything between `\(` and `\)` to be interpreted as inline
5187+TeX math, and anything between `\[` and `\]` to be interpreted
5188+as display TeX math. Note: a drawback of this extension is that
5189+it precludes escaping `(` and `[`.
35285190
3529−A link immediately preceded by a `!` will be treated as an image.
3530−The link text will be used as the image's alt text:
5191+#### Extension: `tex_math_double_backslash` ####
35315192
3532− 
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.
35335196
3534− ![movie reel]
5197+#### Extension: `markdown_attribute` ####
35355198
3536− [movie reel]: movie.gif
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`.
35375202
3538−#### Extension: `implicit_figures` ####
5203+#### Extension: `mmd_title_block` ####
35395204
3540−An image with nonempty alt text, occurring by itself in a
3541−paragraph, will be rendered as a figure with a caption. The
3542−image's alt text will be used as the caption.
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
35435207
3544− 
5208+ Title: My title
5209+ Author: John Doe
5210+ Date: September 1, 2008
5211+ Comment: This is a sample mmd title block, with
5212+ a field spanning multiple lines.
35455213
3546−How this is rendered depends on the output format. Some output
3547−formats (e.g. RTF) do not yet support figures. In those
3548−formats, you'll just get an image in a paragraph by itself, with
3549−no caption.
5214+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5215+`yaml_metadata_block` is enabled, it will take precedence over
5216+`mmd_title_block`.
35505217
3551−If you just want a regular inline image, just make sure it is not
3552−the only thing in the paragraph. One way to do this is to insert a
3553−nonbreaking space after the image:
5218+#### Extension: `abbreviations` ####
35545219
3555− \
5220+Parses PHP Markdown Extra abbreviation keys, like
35565221
3557−Note that in reveal.js slide shows, an image in a paragraph
3558−by itself that has the `stretch` class will fill the screen,
3559−and the caption and figure tags will be omitted.
5222+ *[HTML]: Hypertext Markup Language
35605223
3561−#### Extension: `link_attributes` ####
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).
35625227
3563−Attributes can be set on links and images:
5228+#### Extension: `autolink_bare_uris` ####
35645229
3565− An inline {#id .class width=30 height=20px}
3566− and a reference ![image][ref] with attributes.
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
35675232
3568− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5233+#### Extension: `mmd_link_attributes` ####
35695234
3570−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3571−and `.class` are used.)
5235+Parses multimarkdown style key-value attributes on link
5236+and image references. This extension should not be confused with the
5237+[`link_attributes`](#extension-link_attributes) extension.
35725238
3573−For HTML and EPUB, all attributes except `width` and `height` (but
3574−including `srcset` and `sizes`) are passed through as is. The other
3575−writers ignore attributes that are not supported by their output
3576−format.
5239+ This is a reference ![image][ref] with multimarkdown attributes.
35775240
3578−The `width` and `height` attributes on images are treated specially. When
3579−used without a unit, the unit is assumed to be pixels. However, any of
3580−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3581−and `%`. There must not be any spaces between the number and the unit.
3582−For example:
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
35835243
3584−```
3585−{ width=50% }
3586−```
5244+#### Extension: `mmd_header_identifiers` ####
35875245
3588−- Dimensions are converted to inches for output in page-based formats like
3589− LaTeX. Dimensions are converted to pixels for output in HTML-like
3590− formats. Use the `--dpi` option to specify the number of pixels per
3591− inch. The default is 96dpi.
3592−- The `%` unit is generally relative to some available space.
3593− For example the above example will render to
3594− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3595− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3596− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3597−- Some output formats have a notion of a class
3598− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3599− or a unique identifier (LaTeX `\caption`), or both (HTML).
3600−- When no `width` or `height` attributes are specified, the fallback
3601− is to look at the image resolution and the dpi metadata embedded in
3602− the image file.
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
36035248
3604−Spans
3605−-----
5249+#### Extension: `compact_definition_lists` ####
36065250
3607−#### 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:
36085254
3609−A bracketed sequence of inlines, as one would use to begin
3610−a link, will be treated as a span with attributes if it is
3611−followed immediately by attributes:
5255+ - No blank line is required between consecutive items of the
5256+ definition list.
5257+ - To get a "tight" or "compact" list, omit space between consecutive
5258+ items; the space between a term and its definition does not affect
5259+ anything.
5260+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261+ be indented four spaces.[^6]
36125262
3613− [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:
36145265
3615−Footnotes
3616−---------
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
36175270
3618−#### 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
5274+ list items.
36195275
3620−Pandoc's Markdown allows footnotes, using the following syntax:
5276+#### Extension: `gutenberg` ####
36215277
3622− 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.
36235281
3624− [^1]: Here is the footnote.
5282+ [Project Gutenberg]: https://www.gutenberg.org
36255283
3626− [^longnote]: Here's one with multiple blocks.
5284+#### Extension: `sourcepos` ####
36275285
3628− Subsequent paragraphs are indented to show that they
3629− belong to the previous footnote.
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
36305290
3631− { some.code }
5291+## Markdown variants
36325292
3633− The whole paragraph can be indented, or just the first
3634− line. In this way, multi-paragraph footnotes work like
3635− multi-paragraph list items.
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
36365295
3637− This paragraph won't be part of the note, because it
3638− isn't indented.
5296+- `markdown_phpextra` (PHP Markdown Extra)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
36395303
3640−The identifiers in footnote references may not contain spaces, tabs,
3641−or newlines. These identifiers are used only to correlate the
3642−footnote reference with the note itself; in the output, footnotes
3643−will be numbered sequentially.
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
36445306
3645−The footnotes themselves need not be placed at the end of the
3646−document. They may appear anywhere except inside other block elements
3647−(lists, block quotes, tables, etc.). Each footnote should be
3648−separated from surrounding content (including other footnotes)
3649−by blank lines.
5307+ pandoc --list-extensions=FORMAT
36505308
3651−#### Extension: `inline_notes` ####
5309+where `FORMAT` is replaced with the name of the format.
36525310
3653−Inline footnotes are also allowed (though, unlike regular notes,
3654−they cannot contain multiple paragraphs). The syntax is as follows:
5311+Note that the list of extensions for `commonmark`,
5312+`gfm`, and `commonmark_x` are defined relative to default
5313+commonmark. So, for example, `backtick_code_blocks`
5314+does not appear as an extension, since it is enabled by
5315+default and cannot be disabled.
36555316
3656− Here is an inline note.^[Inlines notes are easier to write, since
3657− you don't have to pick an identifier and move down to type the
3658− note.]
5317+# Citations
36595318
3660−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
36615321
3662−Citations
3663−---------
5322+ pandoc --citeproc myinput.txt
36645323
3665−#### Extension: `citations` ####
5324+To use this feature, you will need to have
36665325
3667−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3668−citations and a bibliography in a number of styles. Basic usage is
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
36695330
3670− pandoc --filter pandoc-citeproc myinput.txt
5331+## Specifying bibliographic data
36715332
3672−In order to use this feature, you will need to specify a bibliography file
3673−using the `bibliography` metadata field in a YAML metadata section, or
3674−`--bibliography` command line argument. You can supply multiple `--bibliography`
3675−arguments or set `bibliography` metadata field to YAML array, if you want to
3676−use multiple bibliography files. The bibliography may have any of these
3677−formats:
5333+You can specify an external bibliography using the
5334+`bibliography` metadata field in a YAML metadata section or the
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
5337+`--bibliography` arguments or set `bibliography` metadata field
5338+to YAML array. A bibliography may have any of these formats:
36785339
36795340 Format File extension
36805341 ------------ --------------
36815342 BibLaTeX .bib
36825343 BibTeX .bibtex
3683− Copac .copac
36845344 CSL JSON .json
36855345 CSL YAML .yaml
3686− EndNote .enl
3687− EndNote XML .xml
3688− ISI .wos
3689− MEDLINE .medline
3690− MODS .mods
3691− RIS .ris
36925346
36935347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3694−use `.bibtex` to force BibTeX.
3695−
3696−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3697−can produce `.json` and `.yaml` files from any of the supported formats.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
36985349
3699−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3700−a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
5350+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351+inside fields such as `title`; in CSL YAML databases, pandoc
5352+Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5353+markup specs]:
37015354
37025355`<i>...</i>`
37035356: italics
@@ -3717,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
37175370`<span class="nocase">...</span>`
37185371: prevent a phrase from being capitalized as title case
37195372
3720−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3721−and CSL YAML formats as far as possible.
3722−
3723−As an alternative to specifying a bibliography file using `--bibliography`
3724−or the YAML metadata field `bibliography`, you can include
3725−the citation data directly in the `references` field of the
3726−document's YAML metadata. The field should contain an array of
3727−YAML-encoded references, for example:
5373+As an alternative to specifying a bibliography file using
5374+`--bibliography` or the YAML metadata field `bibliography`, you
5375+can include the citation data directly in the `references` field
5376+of the document's YAML metadata. The field should contain an
5377+array of YAML-encoded references, for example:
37285378
37295379 ---
37305380 references:
@@ -3740,322 +5390,273 @@ YAML-encoded references, for example:
37405390 - - 1953
37415391 - 4
37425392 - 25
3743− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3744− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
37455395 title-short: Molecular structure of nucleic acids
37465396 container-title: Nature
37475397 volume: 171
37485398 issue: 4356
37495399 page: 737-738
37505400 DOI: 10.1038/171737a0
3751− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
37525402 language: en-GB
3753− ...
3754−
3755−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3756−of the supported formats.)
3757−
3758−Citations and references can be formatted using any style supported by the
3759−[Citation Style Language], listed in the [Zotero Style Repository].
3760−These files are specified using the `--csl` option or the `csl` metadata field.
3761−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3762−format. The CSL project provides further information on [finding and editing styles].
3763−
3764−To make your citations hyperlinks to the corresponding bibliography
3765−entries, add `link-citations: true` to your YAML metadata.
3766−
3767−Citations go inside square brackets and are separated by semicolons.
3768−Each citation must have a key, composed of '@' + the citation
3769−identifier from the database, and may optionally have a prefix,
3770−a locator, and a suffix. The citation key must begin with a letter, digit,
3771−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3772−characters (`:.#$%&-+?<>~/`). Here are some examples:
3773−
3774− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3775−
3776− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3777−
3778− Blah blah [@smith04; @doe99].
3779−
3780−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3781−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3782−locale, locator terms can be written in either singular or plural forms,
3783−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3784−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3785−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3786−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3787−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3788−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3789−locator term is used, "page" is assumed.
3790−
3791−A minus sign (`-`) before the `@` will suppress mention of
3792−the author in the citation. This can be useful when the
3793−author is already mentioned in the text:
3794−
3795− Smith says blah [-@smith04].
3796−
3797−You can also write an in-text citation, as follows:
3798−
3799− @smith04 says blah.
3800−
3801− @smith04 [p. 33] says blah.
3802−
3803−If the style calls for a list of works cited, it will be placed
3804−at the end of the document. Normally, you will want to end your
3805−document with an appropriate header:
3806−
3807− last paragraph...
5403+ ...
38085404
3809− # References
5405+If both an external bibliography and inline (YAML metadata)
5406+references are provided, both will be used. In case of
5407+conflicting `id`s, the inline references will take precedence.
38105408
3811−The bibliography will be inserted after this header. Note that
3812−the `unnumbered` class will be added to this header, so that the
3813−section will not be numbered.
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
38145411
3815−If you want to include items in the bibliography without actually
3816−citing them in the body text, you can define a dummy `nocite` metadata
3817−field and put the citations there:
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
38185414
3819− ---
3820− nocite: |
3821− @item1, @item2
3822− ...
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
38235417
3824− @item3
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
38255420
3826−In this example, the document will contain a citation for `item3`
3827−only, but the bibliography will contain entries for `item1`, `item2`, and
3828−`item3`.
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
38295424
3830−It is possible to create a bibliography with all the citations,
3831−whether or not they appear in the document, by using a wildcard:
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
38325427
3833− ---
3834− nocite: |
3835− @*
3836− ...
5428+### Capitalization in titles
38375429
3838−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3839−to render bibliography. In order to do so, specify bibliography files as
3840−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3841−invocation. Bear in mind that bibliography files have to be in respective
3842−format (either BibTeX or BibLaTeX).
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
38435432
3844−For more information, see the [pandoc-citeproc man page].
5433+ - English titles should be in title case. Non-English titles should
5434+ be in sentence case, and the `langid` field in biblatex should be
5435+ set to the relevant language. (The following values are treated
5436+ as English: `american`, `british`, `canadian`, `english`,
5437+ `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
38455438
3846−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3847−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3848−[Citation Style Language]: http://citationstyles.org
3849−[Zotero Style Repository]: https://www.zotero.org/styles
3850−[finding and editing styles]: http://citationstyles.org/styles/
3851−[CSL locale files]: https://github.com/citation-style-language/locales
3852−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5439+ - As is standard with bibtex/biblatex, proper names should be
5440+ protected with curly braces so that they won't be lowercased
5441+ in styles that call for sentence case. For example:
38535442
3854−Non-pandoc extensions
3855−---------------------
5443+ title = {My Dinner with {Andre}}
38565444
3857−The following Markdown syntax extensions are not enabled by default
3858−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3859−name, where `EXTENSION` is the name of the extension. Thus, for
3860−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
38615447
3862−#### Extension: `old_dashes` ####
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
38635449
3864−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3865−`-` before a numeral is an en-dash, and `--` is an em-dash.
3866−This option only has an effect if `smart` is enabled. It is
3867−selected automatically for `textile` input.
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.
38685454
3869−#### Extension: `angle_brackets_escapable` ####
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
38705457
3871−Allow `<` and `>` to be backslash-escaped, as they can be in
3872−GitHub flavored Markdown but not original Markdown. This is
3873−implied by pandoc's default `all_symbols_escapable`.
5458+ - All titles should be in sentence case.
38745459
3875−#### Extension: `lists_without_preceding_blankline` ####
5460+ - Use the `language` field for non-English titles to prevent their
5461+ conversion to title case in styles that call for this. (Conversion
5462+ happens only if `language` begins with `en` or is left empty.)
38765463
3877−Allow a list to occur right after a paragraph, with no intervening
3878−blank space.
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
38795466
3880−#### Extension: `four_space_rule` ####
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
38815468
3882−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3883−four spaces indent are needed for list item continuation
3884−paragraphs.
5469+### Conference Papers, Published vs. Unpublished
38855470
3886−#### Extension: `spaced_reference_links` ####
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
38875473
3888−Allow whitespace between the two components of a reference link,
3889−for example,
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`).
38905477
3891− [foo] [bar].
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.
38925487
3893−#### Extension: `hard_line_breaks` ####
38945488
3895−Causes all newlines within a paragraph to be interpreted as hard line
3896−breaks instead of spaces.
5489+## Specifying a citation style
38975490
3898−#### Extension: `ignore_line_breaks` ####
5491+Citations and references can be formatted using any style supported by the
5492+[Citation Style Language], listed in the [Zotero Style Repository].
5493+These files are specified using the `--csl` option or the `csl`
5494+(or `citation-style`) metadata field. By default, pandoc will
5495+use the [Chicago Manual of Style] author-date format. (You can
5496+override this default by copying a CSL style of your choice
5497+to `default.csl` in your user data directory.)
5498+The CSL project provides further information on [finding and
5499+editing styles].
5500+
5501+The `--citation-abbreviations` option (or the
5502+`citation-abbreviations` metadata field) may be used to specify
5503+a JSON file containing abbreviations of journals that should be
5504+used in formatted bibliographies when `form="short"` is
5505+specified. The format of the file can be illustrated with an
5506+example:
38995507
3900−Causes newlines within a paragraph to be ignored, rather than being
3901−treated as spaces or as hard line breaks. This option is intended for
3902−use with East Asian languages where spaces are not used between words,
3903−but text is divided into lines for readability.
39045508
3905−#### Extension: `east_asian_line_breaks` ####
5509+ { "default": {
5510+ "container-title": {
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
5512+ "Estates Gazette": "EG",
5513+ "Scots Law Times": "SLT"
5514+ }
5515+ }
5516+ }
39065517
3907−Causes newlines within a paragraph to be ignored, rather than
3908−being treated as spaces or as hard line breaks, when they occur
3909−between two East Asian wide characters. This is a better choice
3910−than `ignore_line_breaks` for texts that include a mix of East
3911−Asian wide characters and other characters.
39125518
3913−#### Extension: `emoji` ####
5519+## Citations in note styles
39145520
3915−Parses textual emojis like `:smile:` as Unicode emoticons.
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
5526+example,
39165527
3917−#### Extension: `tex_math_single_backslash` ####
5528+ Blah blah [@foo, p. 33].
39185529
3919−Causes anything between `\(` and `\)` to be interpreted as inline
3920−TeX math, and anything between `\[` and `\]` to be interpreted
3921−as display TeX math. Note: a drawback of this extension is that
3922−it precludes escaping `(` and `[`.
5530+The footnote will be created automatically. Pandoc will take
5531+care of removing the space and moving the note before or
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
5534+metadata fields].
39235535
3924−#### Extension: `tex_math_double_backslash` ####
5536+In some cases you may need to put a citation inside a regular
5537+footnote. Normal citations in footnotes (such as `[@foo, p.
5538+33]`) will be rendered in parentheses. In-text citations (such
5539+as `@foo [p. 33]`) will be rendered without parentheses. (A
5540+comma will be added if appropriate.) Thus:
39255541
3926−Causes anything between `\\(` and `\\)` to be interpreted as inline
3927−TeX math, and anything between `\\[` and `\\]` to be interpreted
3928−as display TeX math.
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].
39295545
3930−#### Extension: `markdown_attribute` ####
5546+## Raw content in a style
39315547
3932−By default, pandoc interprets material inside block-level tags as Markdown.
3933−This extension changes the behavior so that Markdown is only parsed
3934−inside block-level tags if the tags have the attribute `markdown=1`.
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
39355550
3936−#### Extension: `mmd_title_block` ####
5551+ {{jats}}<ref>{{/jats}}
39375552
3938−Enables a [MultiMarkdown] style title block at the top of
3939−the document, for example:
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
39405555
3941− Title: My title
3942− Author: John Doe
3943− Date: September 1, 2008
3944− Comment: This is a sample mmd title block, with
3945− a field spanning multiple lines.
5556+This feature allows stylesheets to be customized to give
5557+different output for different output formats. However,
5558+stylesheets customized in this way will not be usable
5559+by other CSL implementations.
39465560
3947−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3948−`yaml_metadata_block` is enabled, it will take precedence over
3949−`mmd_title_block`.
39505561
3951−#### Extension: `abbreviations` ####
39525562
3953−Parses PHP Markdown Extra abbreviation keys, like
5563+## Placement of the bibliography
39545564
3955− *[HTML]: Hypertext Markup Language
5565+If the style calls for a list of works cited, it will be placed
5566+in a div with id `refs`, if one exists:
39565567
3957−Note that the pandoc document model does not support
3958−abbreviations, so if this extension is enabled, abbreviation keys are
3959−simply skipped (as opposed to being parsed as paragraphs).
5568+ ::: {#refs}
5569+ :::
39605570
3961−#### Extension: `autolink_bare_uris` ####
5571+Otherwise, it will be placed at the end of the document.
5572+Generation of the bibliography can be suppressed by setting
5573+`suppress-bibliography: true` in the YAML metadata.
39625574
3963−Makes all absolute URIs into links, even when not surrounded by
3964−pointy braces `<...>`.
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:
39655579
3966−#### Extension: `mmd_link_attributes` ####
5580+ last paragraph...
39675581
3968−Parses multimarkdown style key-value attributes on link
3969−and image references. This extension should not be confused with the
3970−[`link_attributes`](#extension-link_attributes) extension.
5582+ # References
39715583
3972− This is a reference ![image][ref] with multimarkdown attributes.
5584+The bibliography will be inserted after this heading. Note that
5585+the `unnumbered` class will be added to this heading, so that the
5586+section will not be numbered.
39735587
3974− [ref]: http://path.to/image "Image title" width=20px height=30px
3975− id=myId class="myClass1 myClass2"
5588+## Including uncited items in the bibliography
39765589
3977−#### Extension: `mmd_header_identifiers` ####
5590+If you want to include items in the bibliography without actually
5591+citing them in the body text, you can define a dummy `nocite` metadata
5592+field and put the citations there:
39785593
3979−Parses multimarkdown style header identifiers (in square brackets,
3980−after the header but before any trailing `#`s in an ATX header).
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
39815598
3982−#### Extension: `compact_definition_lists` ####
5599+ @item3
39835600
3984−Activates the definition list syntax of pandoc 1.12.x and earlier.
3985−This syntax differs from the one described above under [Definition lists]
3986−in several respects:
5601+In this example, the document will contain a citation for `item3`
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
5603+`item3`.
39875604
3988− - No blank line is required between consecutive items of the
3989− definition list.
3990− - To get a "tight" or "compact" list, omit space between consecutive
3991− items; the space between a term and its definition does not affect
3992− anything.
3993− - Lazy wrapping of paragraphs is not allowed: the entire definition must
3994− be indented four spaces.[^6]
5605+It is possible to create a bibliography with all the citations,
5606+whether or not they appear in the document, by using a wildcard:
39955607
3996−[^6]: To see why laziness is incompatible with relaxing the requirement
3997− of a blank line between items, consider the following example:
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
39985612
3999− bar
4000− : definition
4001− foo
4002− : definition
5613+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5614+render the bibliography. In order to do so, specify bibliography
5615+files as outlined above, and add `--natbib` or `--biblatex`
5616+argument to `pandoc` invocation. Bear in mind that bibliography
5617+files have to be in either BibTeX (for `--natbib`)
5618+or BibLaTeX (for `--biblatex`) format.
40035619
4004− Is this a single list item with two definitions of "bar," the first of
4005− which is lazily wrapped, or two list items? To remove the ambiguity
4006− we must either disallow lazy wrapping or require a blank line between
4007− list items.
5620+## Other relevant metadata fields
40085621
4009−Markdown variants
4010−-----------------
5622+A few other metadata fields affect bibliography formatting:
40115623
4012−In addition to pandoc's extended Markdown, the following Markdown
4013−variants are supported:
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
40145628
4015−`markdown_phpextra` (PHP Markdown Extra)
4016−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4017− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4018− `header_attributes`, `link_attributes`, `abbreviations`,
4019− `shortcut_reference_links`, `spaced_reference_links`.
4020−
4021−`markdown_github` (deprecated GitHub-Flavored Markdown)
4022−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4023− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4024− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
4025− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
4026− `lists_without_preceding_blankline`.
4027−
4028−`markdown_mmd` (MultiMarkdown)
4029−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4030− `tex_math_double_backslash`, `intraword_underscores`,
4031− `mmd_title_block`, `footnotes`, `definition_lists`,
4032− `all_symbols_escapable`, `implicit_header_references`,
4033− `auto_identifiers`, `mmd_header_identifiers`,
4034− `shortcut_reference_links`, `implicit_figures`,
4035− `superscript`, `subscript`, `backtick_code_blocks`,
4036− `spaced_reference_links`, `raw_attribute`.
4037−
4038−`markdown_strict` (Markdown.pl)
4039−: `raw_html`, `shortcut_reference_links`,
4040− `spaced_reference_links`.
4041−
4042−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4043−which is implemented as a set of extensions on `commonmark`).
4044−
4045−Note, however, that `commonmark` and `gfm` have limited support
4046−for extensions. Only those listed below (and `smart` and
4047−`raw_tex`) will work. The extensions can, however, all be
4048−individually disabled.
4049−Also, `raw_tex` only affects `gfm` output, not input.
4050−
4051−`gfm` (GitHub-Flavored Markdown)
4052−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4053− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4054− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4055− `shortcut_reference_links`, `angle_brackets_escapable`.
4056−
4057−Producing slide shows with pandoc
4058−=================================
5629+`lang`
5630+: The `lang` field will affect how the style is localized,
5631+ for example in the translation of labels, the use
5632+ of quotation marks, and the way items are sorted.
5633+ (For backwards compatibility, `locale` may be used instead
5634+ of `lang`, but this use is deprecated.)
5635+
5636+ A BCP 47 language tag is expected: for example, `en`,
5637+ `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
5638+ syntax (after `-u-`) may be used to specify options for
5639+ collation (sorting) more precisely. Here are some examples:
5640+
5641+ - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642+ - `es-u-co-trad` -- Spanish with the traditional collation
5643+ (with `Ch` sorting after `C`).
5644+ - `fr-u-kb` -- French with "backwards" accent sorting
5645+ (with `coté` sorting after `côte`).
5646+ - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647+ before lower (default is lower before upper).
5648+
5649+`notes-after-punctuation`
5650+: If true (the default), pandoc will put footnote citations
5651+ after following punctuation. For example, if the source
5652+ contains `blah blah [@jones99].`, the result will look like
5653+ `blah blah.[^1]`, with the note moved after the period and
5654+ the space collapsed. If false, the space will still be
5655+ collapsed, but the footnote will not be moved after the
5656+ punctuation.
5657+
5658+
5659+# Slide shows
40595660
40605661You can use pandoc to produce an HTML + JavaScript slide presentation
40615662that can be viewed via a web browser. There are five ways to do this,
@@ -4103,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
41035704
41045705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
41055706
4106−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4107−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4108−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4109−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4110−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4111−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4112−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4113−the file by default.
4114−
4115−With all HTML slide formats, the `--self-contained` option can be used to
4116−produce a single file that contains all of the data necessary to display the
4117−slide show, including linked scripts, stylesheets, images, and videos.
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5710+the relative path `s5/default` (for S5), `slideous` (for
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5714+variables; see [Variables for HTML slides], above.) For
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5716+in the file by default.
5717+
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
41185722
41195723To produce a PDF slide show using beamer, type
41205724
@@ -4127,14 +5731,13 @@ To produce a Powerpoint slide show, type
41275731
41285732 pandoc habits.txt -o habits.pptx
41295733
4130−Structuring the slide show
4131−--------------------------
5734+## Structuring the slide show
41325735
4133−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
41345737the hierarchy that is followed immediately by content, and not another
4135−header, somewhere in the document. In the example above, level 1 headers
4136−are always followed by level 2 headers, which are followed by content,
4137−so 2 is the slide level. This default can be overridden using
5738+heading, somewhere in the document. In the example above, level-1 headings
5739+are always followed by level-2 headings, which are followed by content,
5740+so the slide level is 2. This default can be overridden using
41385741the `--slide-level` option.
41395742
41405743The document is carved up into slides according to the following
@@ -4142,17 +5745,21 @@ rules:
41425745
41435746 * A horizontal rule always starts a new slide.
41445747
4145− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
41465749
4147− * Headers *below* the slide level in the hierarchy create
4148− headers *within* a slide.
5750+ * Headings *below* the slide level in the hierarchy create
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
41495756
4150− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
41515758 "title slides," which just contain the section title
41525759 and help to break the slide show into sections.
4153−
4154− * Content *above* the slide level will not appear in the slide
4155− show.
5760+ Non-slide content under these headings will be included
5761+ on the title slide (for HTML slide shows) or in a
5762+ subsequent slide with the same title (for beamer).
41565763
41575764 * A title page is constructed automatically from the document's title
41585765 block, if present. (In the case of beamer, this can be disabled
@@ -4160,32 +5767,57 @@ rules:
41605767
41615768These rules are designed to support many different styles of slide show. If
41625769you don't care about structuring your slides into sections and subsections,
4163−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
41645771will be the slide level.) But you can also structure the slide show into
41655772sections, as in the example above.
41665773
41675774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4168−layout will be produced, with level 1 headers building horizontally
4169−and level 2 headers building vertically. It is not recommended that
5775+layout will be produced, with level-1 headings building horizontally
5776+and level-2 headings building vertically. It is not recommended that
41705777you use deeper nesting of section levels with reveal.js.
41715778
4172−Incremental lists
4173−-----------------
5779+## Incremental lists
41745780
41755781By default, these writers produce lists that display "all at once."
41765782If you want your lists to display incrementally (one item at a time),
41775783use the `-i` option. If you want a particular list to depart from the
4178−default (that is, to display incrementally without the `-i` option and
4179−all at once with the `-i` option), put it in a block quote:
5784+default, put it in a `div` block with class `incremental` or
5785+`nonincremental`. So, for example, using the `fenced div` syntax, the
5786+following would be incremental regardless of the document default:
5787+
5788+ ::: incremental
5789+
5790+ - Eat spaghetti
5791+ - Drink wine
5792+
5793+ :::
5794+
5795+or
5796+
5797+ ::: nonincremental
5798+
5799+ - Eat spaghetti
5800+ - Drink wine
5801+
5802+ :::
5803+
5804+While using `incremental` and `nonincremental` divs are the
5805+recommended method of setting incremental lists on a per-case basis,
5806+an older method is also supported: putting lists inside a blockquote
5807+will depart from the document default (that is, it will display
5808+incrementally without the `-i` option and all at once with the `-i`
5809+option):
41805810
41815811 > - Eat spaghetti
41825812 > - Drink wine
41835813
4184−In this way incremental and nonincremental lists can be mixed in
4185−a single document.
5814+Both methods allow incremental and nonincremental lists to be mixed
5815+in a single document.
41865816
4187−Inserting pauses
4188−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
41895821
41905822You can add "pauses" within a slide by including a paragraph containing
41915823three dots, separated by spaces:
@@ -4198,8 +5830,9 @@ three dots, separated by spaces:
41985830
41995831 content after the pause
42005832
4201−Styling the slides
4202−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
42035836
42045837You can change the style of HTML slides by putting customized CSS files
42055838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4224,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
42245857
42255858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
42265859
4227−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
42285861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4229−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
42305863that affects slides is the `allowframebreaks` class, which sets the
42315864`allowframebreaks` option, causing multiple slides to be created
42325865if the content overfills the frame. This is recommended especially for
@@ -4234,11 +5867,10 @@ bibliographies:
42345867
42355868 # References {.allowframebreaks}
42365869
4237−Speaker notes
4238−-------------
5870+## Speaker notes
42395871
4240−reveal.js has good support for speaker notes. You can add notes to your
4241−Markdown document thus:
5872+Speaker notes are supported in reveal.js and PowerPoint (pptx)
5873+output. You can add notes to your Markdown document thus:
42425874
42435875 ::: notes
42445876
@@ -4249,12 +5881,14 @@ Markdown document thus:
42495881
42505882 :::
42515883
4252−To show the notes window, press `s` while viewing the presentation.
5884+To show the notes window in reveal.js, press `s` while viewing the
5885+presentation. Speaker notes in PowerPoint will be available, as usual,
5886+in handouts and presenter view.
5887+
42535888Notes are not yet supported for other slide formats, but the notes
42545889will not appear on the slides themselves.
42555890
4256−Columns
4257−-------
5891+## Columns
42585892
42595893To put material in side by side columns, you can use a native
42605894div container with class `columns`, containing two or more div
@@ -4269,12 +5903,46 @@ containers with class `column` and a `width` attribute:
42695903 :::
42705904 ::::::::::::::
42715905
4272−Frame attributes in beamer
4273−--------------------------
5906+### Additional columns attributes in beamer
5907+
5908+The div containers with classes `columns` and `column` can optionally have
5909+an `align` attribute.
5910+The class `columns` can optionally have a `totalwidth` attribute or an
5911+`onlytextwidth` class.
5912+
5913+ :::::::::::::: {.columns align=center totalwidth=8em}
5914+ ::: {.column width="40%"}
5915+ contents...
5916+ :::
5917+ ::: {.column width="60%" align=bottom}
5918+ contents...
5919+ :::
5920+ ::::::::::::::
5921+
5922+The `align` attributes on `columns` and `column` can be used with the
5923+values `top`, `top-baseline`, `center` and `bottom` to vertically align
5924+the columns. It defaults to `top` in `columns`.
5925+
5926+The `totalwidth` attribute limits the width of the columns to the given value.
5927+
5928+ :::::::::::::: {.columns align=top .onlytextwidth}
5929+ ::: {.column width="40%" align=center}
5930+ contents...
5931+ :::
5932+ ::: {.column width="60%"}
5933+ contents...
5934+ :::
5935+ ::::::::::::::
5936+
5937+The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5938+
5939+See Section 12.7 of the [Beamer User's Guide] for more details.
5940+
5941+## Frame attributes in beamer
42745942
42755943Sometimes it is necessary to add the LaTeX `[fragile]` option to
42765944a frame in beamer (for example, when using the `minted` environment).
4277−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
42785946introducing the slide:
42795947
42805948 # Fragile slide {.fragile}
@@ -4282,13 +5950,64 @@ introducing the slide:
42825950All of the other frame attributes described in Section 8.1 of
42835951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
42845952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4285−`shrink`.
5953+`shrink`, `standout`, `noframenumbering`.
5954+
5955+## Background in reveal.js and beamer
5956+
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
5959+
5960+For the same image on every slide, use the configuration
5961+option `background-image` either in the YAML metadata block
5962+or as a command-line variable. (There are no other options in
5963+beamer and the rest of this section concerns reveal.js slideshows.)
5964+
5965+For reveal.js, you can instead use the reveal.js-native option
5966+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967+and `parallaxBackgroundVertical` the same way and must also set
5968+`parallaxBackgroundSize` to have your values take effect.
5969+
5970+To set an image for a particular reveal.js slide, add
5971+`{data-background-image="/path/to/image"}`
5972+to the first slide-level heading on the slide (which may even be empty).
5973+
5974+In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975+only on the first slide.
5976+
5977+Other reveal.js background settings also work on individual slides, including
5978+`data-background-size`, `data-background-repeat`, `data-background-color`,
5979+`data-transition`, and `data-transition-speed`.
5980+
5981+To add a background image to the automatically generated title slide, use the
5982+`title-slide-attributes` variable in the YAML metadata block. It must contain
5983+a map of attribute names and values.
5984+
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986+details.
5987+
5988+For example in reveal.js:
5989+
5990+```
5991+---
5992+title: My Slideshow
5993+parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
5997+---
5998+
5999+## Slide One
6000+
6001+Slide 1 has background_image.png as its background.
6002+
6003+## {data-background-image="/path/to/special_image.jpg"}
42866004
4287−Creating EPUBs with pandoc
4288−==========================
6005+Slide 2 has a special image for its background, even though the heading has no content.
6006+```
6007+
6008+# EPUBs
42896009
4290−EPUB Metadata
4291−-------------
6010+## EPUB Metadata
42926011
42936012EPUB metadata may be specified using the `--epub-metadata` option, but
42946013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4366,11 +6085,20 @@ The following fields are recognized:
43666085
43676086`rights`
43686087 ~ A string value.
6088+
6089+`belongs-to-collection`
6090+ ~ A string value. identifies the name of a collection to which
6091+ the EPUB Publication belongs.
6092+
6093+`group-position`
6094+ ~ The `group-position` field indicates the numeric position in which
6095+ the EPUB Publication belongs relative to other works belonging to
6096+ the same `belongs-to-collection` field.
43696097
43706098`cover-image`
43716099 ~ A string value (path to cover image).
43726100
4373−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
43746102 ~ A string value (path to CSS stylesheet).
43756103
43766104`page-progression-direction`
@@ -4387,32 +6115,200 @@ The following fields are recognized:
43876115 - `binding`: `true`|`false` (default `true`)
43886116 - `scroll-axis`: `vertical`|`horizontal`|`default`
43896117
4390−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
43916119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
43926120
4393−Linked media
4394−------------
4395−
4396−By default, pandoc will download linked media (including audio and
4397−video) and include it in the EPUB container, yielding a completely
6121+## The `epub:type` attribute
6122+
6123+For `epub3` output, you can mark up the heading that corresponds to an EPUB
6124+chapter using the [`epub:type` attribute][epub-type]. For example, to set
6125+the attribute to the value `prologue`, use this markdown:
6126+
6127+ # My chapter {epub:type=prologue}
6128+
6129+Which will result in:
6130+
6131+ <body epub:type="frontmatter">
6132+ <section epub:type="prologue">
6133+ <h1>My chapter</h1>
6134+
6135+Pandoc will output `<body epub:type="bodymatter">`, unless
6136+you use one of the following values, in which case either
6137+`frontmatter` or `backmatter` will be output.
6138+
6139+`epub:type` of first section `epub:type` of body
6140+---------------------------- ------------------
6141+prologue frontmatter
6142+abstract frontmatter
6143+acknowledgments frontmatter
6144+copyright-page frontmatter
6145+dedication frontmatter
6146+credits frontmatter
6147+keywords frontmatter
6148+imprint frontmatter
6149+contributors frontmatter
6150+other-credits frontmatter
6151+errata frontmatter
6152+revision-history frontmatter
6153+titlepage frontmatter
6154+halftitlepage frontmatter
6155+seriespage frontmatter
6156+foreword frontmatter
6157+preface frontmatter
6158+appendix backmatter
6159+colophon backmatter
6160+bibliography backmatter
6161+index backmatter
6162+
6163+[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6164+
6165+## Linked media
6166+
6167+By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6168+`<video>` or `<source>` element present in the generated EPUB,
6169+and include it in the EPUB container, yielding a completely
43986170self-contained EPUB. If you want to link to external media resources
43996171instead, use raw HTML in your source and add `data-external="1"` to the tag
44006172with the `src` attribute. For example:
44016173
44026174 <audio controls="1">
4403− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
44046176 data-external="1" type="audio/mpeg">
44056177 </source>
44066178 </audio>
44076179
4408−Syntax highlighting
4409−===================
6180+# Jupyter notebooks
6181+
6182+When creating a [Jupyter notebook], pandoc will try to infer the
6183+notebook structure. Code blocks with the class `code` will be
6184+taken as code cells, and intervening content will be taken as
6185+Markdown cells. Attachments will automatically be created for
6186+images in Markdown cells. Metadata will be taken from the
6187+`jupyter` metadata field. For example:
6188+
6189+````
6190+---
6191+title: My notebook
6192+jupyter:
6193+ nbformat: 4
6194+ nbformat_minor: 5
6195+ kernelspec:
6196+ display_name: Python 2
6197+ language: python
6198+ name: python2
6199+ language_info:
6200+ codemirror_mode:
6201+ name: ipython
6202+ version: 2
6203+ file_extension: ".py"
6204+ mimetype: "text/x-python"
6205+ name: "python"
6206+ nbconvert_exporter: "python"
6207+ pygments_lexer: "ipython2"
6208+ version: "2.7.15"
6209+---
6210+
6211+# Lorem ipsum
6212+
6213+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6214+bibendum felis dictum sodales.
6215+
6216+``` code
6217+print("hello")
6218+```
6219+
6220+## Pyout
6221+
6222+``` code
6223+from IPython.display import HTML
6224+HTML("""
6225+<script>
6226+console.log("hello");
6227+</script>
6228+<b>HTML</b>
6229+""")
6230+```
6231+
6232+## Image
6233+
6234+This image  will be
6235+included as a cell attachment.
6236+````
6237+
6238+If you want to add cell attributes, group cells differently, or
6239+add output to code cells, then you need to include divs to
6240+indicate the structure. You can use either [fenced
6241+divs][Extension: `fenced_divs`] or [native divs][Extension:
6242+`native_divs`] for this. Here is an example:
6243+
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
6247+
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
6251+
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
6256+
6257+::: {.output .stream .stdout}
6258+```
6259+hello
6260+```
6261+:::
6262+::::::
6263+
6264+:::::: {.cell .code execution_count=2}
6265+``` {.python}
6266+from IPython.display import HTML
6267+HTML("""
6268+<script>
6269+console.log("hello");
6270+</script>
6271+<b>HTML</b>
6272+""")
6273+```
6274+
6275+::: {.output .execute_result execution_count=2}
6276+```{=html}
6277+<script>
6278+console.log("hello");
6279+</script>
6280+<b>HTML</b>
6281+hello
6282+```
6283+:::
6284+::::::
6285+````
6286+
6287+If you include raw HTML or TeX in an output cell, use the
6288+[raw attribute][Extension: `fenced_attribute`], as shown
6289+in the last cell of the example above. Although pandoc can
6290+process "bare" raw HTML and TeX, the result is often
6291+interspersed raw elements and normal textual elements, and
6292+in an output cell pandoc expects a single, connected raw
6293+block. To avoid using raw HTML or TeX except when
6294+marked explicitly using raw attributes, we recommend
6295+specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6296+translating between Markdown and ipynb notebooks.
6297+
6298+Note that options and extensions that affect reading and
6299+writing of Markdown will also affect Markdown cells in ipynb
6300+notebooks. For example, `--wrap=preserve` will preserve
6301+soft line breaks in Markdown cells; `--atx-headers` will
6302+cause ATX-style headings to be used; and `--preserve-tabs` will
6303+prevent tabs from being turned to spaces.
6304+
6305+# Syntax highlighting
44106306
44116307Pandoc will automatically highlight syntax in [fenced code blocks] that
44126308are marked with a language name. The Haskell library [skylighting] is
4413−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4414−To see a list of language names that pandoc will recognize, type
4415−`pandoc --list-highlight-languages`.
6309+used for highlighting. Currently highlighting is supported only for
6310+HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6311+that pandoc will recognize, type `pandoc --list-highlight-languages`.
44166312
44176313The color scheme can be selected using the `--highlight-style` option.
44186314The default color scheme is `pygments`, which imitates the default color
@@ -4420,15 +6316,36 @@ scheme used by the Python library pygments (though pygments is not actually
44206316used to do the highlighting). To see a list of highlight styles,
44216317type `pandoc --list-highlight-styles`.
44226318
6319+If you are not satisfied with the predefined styles, you can
6320+use `--print-highlight-style` to generate a JSON `.theme` file which
6321+can be modified and used as the argument to `--highlight-style`. To
6322+get a JSON version of the `pygments` style, for example:
6323+
6324+ pandoc --print-highlight-style pygments > my.theme
6325+
6326+Then edit `my.theme` and use it like this:
6327+
6328+ pandoc --highlight-style my.theme
6329+
6330+If you are not satisfied with the built-in highlighting, or you
6331+want highlight a language that isn't supported, you can use the
6332+`--syntax-definition` option to load a [KDE-style XML syntax definition
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
6334+Before writing your own, have a look at KDE's [repository of syntax
6335+definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6336+
44236337To disable highlighting, use the `--no-highlight` option.
44246338
44256339[skylighting]: https://github.com/jgm/skylighting
44266340
4427−Custom Styles in Docx Output
4428−============================
6341+# Custom Styles
6342+
6343+Custom styles can be used in the docx and ICML formats.
6344+
6345+## Output
44296346
4430−By default, pandoc's docx output applies a predefined set of styles for
4431−blocks such as paragraphs and block quotes, and uses largely default
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
44326349formatting (italics, bold) for inlines. This will work for most
44336350purposes, especially alongside a `reference.docx` file. However, if you
44346351need to apply your own styles to blocks, or match a preexisting set of
@@ -4436,8 +6353,10 @@ styles, pandoc allows you to define custom styles for blocks and text
44366353using `div`s and `span`s, respectively.
44376354
44386355If you define a `div` or `span` with the attribute `custom-style`,
4439−pandoc will apply your specified style to the contained elements. So,
4440−for example using the `bracketed_spans` syntax,
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,
44416360
44426361 [Get out]{custom-style="Emphatically"}, he said.
44436362
@@ -4453,9 +6372,9 @@ style `Emphatically`. Similarly, using the `fenced_divs` syntax,
44536372
44546373would style the two contained lines with the `Poetry` paragraph style.
44556374
4456−If the styles are not yet in your reference.docx, they will be defined
4457−in the output file as inheriting from normal text. If they are already
4458−defined, pandoc will not alter the definition.
6375+For docx output, styles will be defined in the output file as inheriting
6376+from normal text, if the styles are not yet in your reference.docx.
6377+If they are already defined, pandoc will not alter the definition.
44596378
44606379This feature allows for greatest customization in conjunction with
44616380[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -4465,34 +6384,137 @@ want all italics to be transformed to the `Emphasis` character style
44656384transform all italicized inlines to inlines within an `Emphasis`
44666385custom-style `span`.
44676386
4468−[pandoc filters]: http://pandoc.org/filters.html
6387+For docx output, you don't need to enable any extensions for
6388+custom styles to work.
6389+
6390+[pandoc filters]: https://pandoc.org/filters.html
6391+
6392+## Input
6393+
6394+The docx reader, by default, only reads those styles that it can
6395+convert into pandoc elements, either by direct conversion or
6396+interpreting the derivation of the input document's styles.
6397+
6398+By enabling the [`styles` extension](#ext-styles) in the docx reader
6399+(`-f docx+styles`), you can produce output that maintains the styles
6400+of the input document, using the `custom-style` class. Paragraph
6401+styles are interpreted as divs, while character styles are interpreted
6402+as spans.
44696403
4470−Custom writers
4471−==============
6404+For example, using the `custom-style-reference.docx` file in the test
6405+directory, we have the following different outputs:
44726406
4473−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4474−includes a lua interpreter, so lua need not be installed separately.)
6407+Without the `+styles` extension:
44756408
4476−To use a custom writer, simply specify the path to the lua script
6409+ $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6410+ This is some text.
6411+
6412+ This is text with an *emphasized* text style. And this is text with a
6413+ **strengthened** text style.
6414+
6415+ > Here is a styled paragraph that inherits from Block Text.
6416+
6417+And with the extension:
6418+
6419+ $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6420+
6421+ ::: {custom-style="First Paragraph"}
6422+ This is some text.
6423+ :::
6424+
6425+ ::: {custom-style="Body Text"}
6426+ This is text with an [emphasized]{custom-style="Emphatic"} text style.
6427+ And this is text with a [strengthened]{custom-style="Strengthened"}
6428+ text style.
6429+ :::
6430+
6431+ ::: {custom-style="My Block Style"}
6432+ > Here is a styled paragraph that inherits from Block Text.
6433+ :::
6434+
6435+With these custom styles, you can use your input document as a
6436+reference-doc while creating docx output (see below), and maintain the
6437+same styles in your input and output files.
6438+
6439+# Custom writers
6440+
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
6443+
6444+To use a custom writer, simply specify the path to the Lua script
44776445in place of the output format. For example:
44786446
44796447 pandoc -t data/sample.lua
44806448
4481−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
44826450possible element in a pandoc document. To get a documented example
44836451which you can modify according to your needs, do
44846452
44856453 pandoc --print-default-data-file sample.lua
44866454
4487−[lua]: http://www.lua.org
4488−
4489−Authors
4490−=======
4491−
4492−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6455+Note that custom writers have no default template. If you want
6456+to use `--standalone` with a custom writer, you will need to
6457+specify a template manually using `--template` or add a new
6458+default template with the name
6459+`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6460+subdirectory of your user data directory (see [Templates]).
6461+
6462+[Lua]: https://www.lua.org
6463+
6464+# Reproducible builds
6465+
6466+Some of the document formats pandoc targets (such as EPUB,
6467+docx, and ODT) include build timestamps in the generated document.
6468+That means that the files generated on successive builds will
6469+differ, even if the source does not. To avoid this, set the
6470+`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6471+be taken from it instead of the current time.
6472+`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6473+(specifying the number of second since midnight UTC January 1, 1970).
6474+
6475+Some document formats also include a unique identifier. For
6476+EPUB, this can be set explicitly by setting the `identifier`
6477+metadata field (see [EPUB Metadata], above).
6478+
6479+# A note on security
6480+
6481+If you use pandoc to convert user-contributed content in a web
6482+application, here are some things to keep in mind:
6483+
6484+1. Although pandoc itself will not create or modify any files other
6485+ than those you explicitly ask it create (with the exception
6486+ of temporary files used in producing PDFs), a filter or custom
6487+ writer could in principle do anything on your file system. Please
6488+ audit filters and custom writers very carefully before using them.
6489+
6490+2. If your application uses pandoc as a Haskell library (rather than
6491+ shelling out to the executable), it is possible to use it in a mode
6492+ that fully isolates pandoc from your file system, by running the
6493+ pandoc operations in the `PandocPure` monad. See the document
6494+ [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
6495+ for more details.
6496+
6497+3. Pandoc's parsers can exhibit pathological performance on some
6498+ corner cases. It is wise to put any pandoc operations under
6499+ a timeout, to avoid DOS attacks that exploit these issues.
6500+ If you are using the pandoc executable, you can add the
6501+ command line options `+RTS -M512M -RTS` (for example) to limit
6502+ the heap size to 512MB.
6503+
6504+4. The HTML generated by pandoc is not guaranteed to be safe.
6505+ If `raw_html` is enabled for the Markdown input, users can
6506+ inject arbitrary HTML. Even if `raw_html` is disabled,
6507+ users can include dangerous content in URLs and attributes.
6508+ To be safe, you should run all the generated HTML through
6509+ an HTML sanitizer.
6510+
6511+# Authors
6512+
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
44936514under the [GPL], version 2 or greater. This software carries no
44946515warranty of any kind. (See COPYRIGHT for full copyright and
44956516warranty notices.) For a full list of contributors, see the file
44966517AUTHORS.md in the pandoc source code.
44976518
4498−[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"