@@ -1,34 +1,50 @@
1−---
2−title: Pandoc User's Guide
3−author: John MacFarlane
4−date: June 20, 2021
5−---
1+% Pandoc User's Guide
2+% John MacFarlane
3+% October 27, 2017
64
7−# Synopsis
5+Synopsis
6+========
87
98`pandoc` [*options*] [*input-file*]...
109
11−# Description
10+Description
11+===========
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
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
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 markup],
18+[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org mode],
19+[DocBook], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx];
20+and it can write plain text, [Markdown], [CommonMark], [PHP Markdown
21+Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
22+[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
23+[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
24+[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
25+markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
26+[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27+[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28+Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
29+or [S5] HTML slide shows. It can also produce [PDF] output on
30+systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`,
31+`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
2946this native representation into a target format. Thus, adding an input
30−or output format requires only adding a reader or writer. Users can also
31−run custom [pandoc filters] to modify the intermediate AST.
47+or output format requires only adding a reader or writer.
3248
3349Because pandoc's intermediate representation of a document is less
3450expressive than many of the formats it converts between, one should
@@ -40,33 +56,96 @@ model. While conversions from pandoc's Markdown to all formats aspire
4056to be perfect, conversions from formats more expressive than pandoc's
4157Markdown can be expected to be lossy.
4258
43−## Using pandoc
59+[Markdown]: http://daringfireball.net/projects/markdown/
60+[CommonMark]: http://commonmark.org
61+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65+[S5]: http://meyerweb.com/eric/tools/s5/
66+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67+[Slideous]: http://goessner.net/articles/slideous/
68+[HTML]: http://www.w3.org/html/
69+[HTML5]: http://www.w3.org/TR/html5/
70+[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71+[XHTML]: http://www.w3.org/TR/xhtml1/
72+[LaTeX]: http://latex-project.org
73+[`beamer`]: https://ctan.org/pkg/beamer
74+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75+[ConTeXt]: http://www.contextgarden.net/
76+[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77+[DocBook]: http://docbook.org
78+[txt2tags]: http://txt2tags.org
79+[EPUB]: http://idpf.org/epub
80+[OPML]: http://dev.opml.org/spec2.html
81+[OpenDocument]: http://opendocument.xml.org
82+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83+[Textile]: http://redcloth.org/textile
84+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
91+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
92+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
93+[Haskell]: https://www.haskell.org
94+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
95+[Emacs Org mode]: http://orgmode.org
96+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
97+[DZSlides]: http://paulrouget.com/dzslides/
98+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
99+[PDF]: https://www.adobe.com/pdf/
100+[reveal.js]: http://lab.hakim.se/reveal-js/
101+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
102+[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
103+[TEI Simple]: https://github.com/TEIC/TEI-Simple
104+[Muse]: https://amusewiki.org/library/manual
105+[Vimwiki]: https://vimwiki.github.io
106+
107+Using `pandoc`
108+--------------
44109
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:
110+If no *input-file* is specified, input is read from *stdin*.
111+Otherwise, the *input-files* are concatenated (with a blank
112+line between each) and used as input. Output goes to *stdout* by
113+default (though output to the terminal is disabled for the
114+`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
115+forced using `-o -`). For output to a file, use the `-o`
116+option:
48117
49118 pandoc -o output.html input.txt
50119
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:
120+By default, pandoc produces a document fragment, not a standalone
121+document with a proper header and footer. To produce a standalone
122+document, use the `-s` or `--standalone` flag:
54123
55124 pandoc -s -o output.html input.txt
56125
57126For more information on how standalone documents are produced, see
58−[Templates] below.
127+[Templates], below.
59128
60−If multiple input files are given, `pandoc` will concatenate them all (with
61−blank lines between them) before parsing. (Use `--file-scope` to parse files
62−individually.)
129+Instead of a file, an absolute URI may be given. In this case
130+pandoc will fetch the content using HTTP:
131+
132+ pandoc -f html -t markdown http://www.fsf.org
133+
134+It is possible to supply a custom User-Agent string or other
135+header when requesting a document from a URL:
136+
137+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
138+ http://www.fsf.org
63139
64−## Specifying formats
140+If multiple input files are given, `pandoc` will concatenate them all (with
141+blank lines between them) before parsing. This feature is disabled for
142+ binary input formats such as `EPUB`, `odt`, and `docx`.
65143
66144The format of the input and output can be specified explicitly using
67145command-line options. The input format can be specified using the
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:
146+`-r/--read` or `-f/--from` options, the output format using the
147+`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
148+Markdown to LaTeX, you could type:
70149
71150 pandoc -f markdown -t latex hello.txt
72151
@@ -74,15 +153,14 @@ To convert `hello.html` from HTML to Markdown:
74153
75154 pandoc -f html -t markdown hello.html
76155
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.
156+Supported output formats are listed below under the `-t/--to` option.
157+Supported input formats are listed below under the `-f/--from` option. Note
158+that the `rst`, `textile`, `latex`, and `html` readers are not complete;
159+there are some constructs that they do not parse.
82160
83161If the input or output format is not specified explicitly, `pandoc`
84−will attempt to guess it from the extensions of the filenames.
85−Thus, for example,
162+will attempt to guess it from the extensions of
163+the input and output filenames. Thus, for example,
86164
87165 pandoc -o hello.tex hello.txt
88166
@@ -91,9 +169,7 @@ is specified (so that output goes to *stdout*), or if the output file's
91169extension is unknown, the output format will default to HTML.
92170If no input file is specified (so that input comes from *stdin*), or
93171if the input files' extensions are unknown, the input format will
94−be assumed to be Markdown.
95−
96−## Character encoding
172+be assumed to be Markdown unless explicitly specified.
97173
98174Pandoc uses the UTF-8 character encoding for both input and output.
99175If your local character encoding is not UTF-8, you
@@ -106,247 +182,157 @@ RTF, OPML, DocBook, and Texinfo), information about
106182the character encoding is included in the document header, which
107183will only be included if you use the `-s/--standalone` option.
108184
109−[`iconv`]: https://www.gnu.org/software/libiconv/
185+[`iconv`]: http://www.gnu.org/software/libiconv/
110186
111−## Creating a PDF
187+Creating a PDF
188+--------------
112189
113−To produce a PDF, specify an output file with a `.pdf` extension:
190+To produce a PDF, specify an output file with a `.pdf` extension.
191+By default, pandoc will use LaTeX to create the PDF:
114192
115193 pandoc test.txt -o test.pdf
116194
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
195+Production of a PDF requires that a LaTeX engine be installed (see
196+`--pdf-engine`, below), and assumes that the following LaTeX packages
197+are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
198+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140199`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
142−contains images), [`hyperref`], [`xcolor`],
143−[`ulem`], [`geometry`] (with the `geometry` variable set),
144−[`setspace`] (with `linestretch`), and
200+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
201+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
202+`geometry` variable set), [`setspace`] (with `linestretch`), and
145203[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146−the PDF engine requires [`fontspec`]. `lualatex` uses
147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149−`mathspec` variable is set, `xelatex` will use [`mathspec`]
150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151−packages are used if available, and [`csquotes`] will be used
152−for [typography] if the `csquotes` variable or metadata field is
153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154−and [`biber`] packages can optionally be used for [citation
155−rendering]. The following packages will be used to improve
156−output quality if present, but pandoc does not require them to
157−be present: [`upquote`] (for straight quotes in verbatim
158−environments), [`microtype`] (for better spacing adjustments),
159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160−better line breaks in URLs), [`bookmark`] (for better PDF
161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162−footnotes in tables).
163−
164−[TeX Live]: https://www.tug.org/texlive/
204+the LaTeX engine requires [`fontspec`]. `xelatex` uses
205+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
206+`dir` variable set). If the `mathspec` variable is set,
207+`xelatex` will use [`mathspec`] instead of [`unicode-math`].
208+The [`upquote`] and [`microtype`] packages are used if
209+available, and [`csquotes`] will be used for [smart punctuation]
210+if added to the template or included in any header file. The
211+[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
212+optionally be used for [citation rendering]. These are included
213+with all recent versions of [TeX Live].
214+
215+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
216+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
217+[`weasyprint`] or [`prince`].
218+To do this, specify an output file with a `.pdf` extension, as before,
219+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
220+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
221+
222+PDF output can be controlled using [variables for LaTeX] (if
223+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
224+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
225+If `wkhtmltopdf` is used, then the variables `margin-left`,
226+`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
227+will affect the output.
228+
165229[`amsfonts`]: https://ctan.org/pkg/amsfonts
166230[`amsmath`]: https://ctan.org/pkg/amsmath
167−[`babel`]: https://ctan.org/pkg/babel
168−[`biber`]: https://ctan.org/pkg/biber
169−[`biblatex`]: https://ctan.org/pkg/biblatex
170−[`bibtex`]: https://ctan.org/pkg/bibtex
171−[`bidi`]: https://ctan.org/pkg/bidi
172−[`bookmark`]: https://ctan.org/pkg/bookmark
173−[`booktabs`]: https://ctan.org/pkg/booktabs
174−[`csquotes`]: https://ctan.org/pkg/csquotes
231+[`lm`]: https://ctan.org/pkg/lm
232+[`ifxetex`]: https://ctan.org/pkg/ifxetex
233+[`ifluatex`]: https://ctan.org/pkg/ifluatex
234+[`listings`]: https://ctan.org/pkg/listings
175235[`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
236+[`longtable`]: https://ctan.org/pkg/longtable
237+[`booktabs`]: https://ctan.org/pkg/booktabs
180238[`graphicx`]: https://ctan.org/pkg/graphicx
181239[`grffile`]: https://ctan.org/pkg/grffile
182−[`hyperref`]: https://ctan.org/pkg/hyperref
183−[`iftex`]: https://ctan.org/pkg/iftex
184−[`listings`]: https://ctan.org/pkg/listings
185−[`lm`]: https://ctan.org/pkg/lm
186−[`longtable`]: https://ctan.org/pkg/longtable
187−[`mathspec`]: https://ctan.org/pkg/mathspec
188−[`microtype`]: https://ctan.org/pkg/microtype
189−[`natbib`]: https://ctan.org/pkg/natbib
190−[`parskip`]: https://ctan.org/pkg/parskip
191−[`polyglossia`]: https://ctan.org/pkg/polyglossia
192−[`prince`]: https://www.princexml.com/
240+[`geometry`]: https://ctan.org/pkg/geometry
193241[`setspace`]: https://ctan.org/pkg/setspace
242+[`xecjk`]: https://ctan.org/pkg/xecjk
243+[`hyperref`]: https://ctan.org/pkg/hyperref
194244[`ulem`]: https://ctan.org/pkg/ulem
245+[`babel`]: https://ctan.org/pkg/babel
246+[`bidi`]: https://ctan.org/pkg/bidi
247+[`mathspec`]: https://ctan.org/pkg/mathspec
195248[`unicode-math`]: https://ctan.org/pkg/unicode-math
249+[`polyglossia`]: https://ctan.org/pkg/polyglossia
250+[`fontspec`]: https://ctan.org/pkg/fontspec
196251[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
252+[`microtype`]: https://ctan.org/pkg/microtype
253+[`csquotes`]: https://ctan.org/pkg/csquotes
254+[`natbib`]: https://ctan.org/pkg/natbib
255+[`biblatex`]: https://ctan.org/pkg/biblatex
256+[`bibtex`]: https://ctan.org/pkg/bibtex
257+[`biber`]: https://ctan.org/pkg/biber
258+[TeX Live]: http://www.tug.org/texlive/
198259[`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
260+[`weasyprint`]: http://weasyprint.org
261+[`prince`]: https://www.princexml.com/
218262
219−# Options
263+Options
264+=======
220265
221−## General options {.options}
266+General options
267+---------------
222268
223269`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224270
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−
270− Extensions can be individually enabled or disabled by
271− appending `+EXTENSION` or `-EXTENSION` to the format name.
272− See [Extensions] below, for a list of extensions and
271+: Specify input format. *FORMAT* can be `native` (native Haskell),
272+ `json` (JSON version of native AST), `markdown` (pandoc's
273+ extended Markdown), `markdown_strict` (original unextended
274+ Markdown), `markdown_phpextra` (PHP Markdown Extra),
275+ `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
276+ `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
277+ (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
278+ (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
279+ `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
280+ markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),
281+ `haddock` (Haddock markup), or `latex` (LaTeX).
282+ (`markdown_github` provides deprecated and less accurate suppport
283+ for Github-Flavored Markdown; please use `gfm` instead, unless you
284+ need to use extensions other than `smart`.)
285+ If `+lhs` is appended to `markdown`, `rst`, `latex`, or
286+ `html`, the input will be treated as literate Haskell source: see
287+ [Literate Haskell support], below. Markdown
288+ syntax extensions can be individually enabled or disabled by
289+ appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
290+ example, `markdown_strict+footnotes+definition_lists` is strict
291+ Markdown with footnotes and definition lists enabled, and
292+ `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
293+ without pipe tables and with hard line breaks. See [Pandoc's
294+ Markdown], below, for a list of extensions and
273295 their names. See `--list-input-formats` and `--list-extensions`,
274296 below.
275297
276298`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
277299
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
347− disabled by appending `+EXTENSION` or `-EXTENSION` to the format
348− name. See [Extensions] below, for a list of extensions and their
349− names. See `--list-output-formats` and `--list-extensions`, below.
300+: Specify output format. *FORMAT* can be `native` (native Haskell),
301+ `json` (JSON version of native AST), `plain` (plain text),
302+ `markdown` (pandoc's extended Markdown), `markdown_strict`
303+ (original unextended Markdown), `markdown_phpextra` (PHP Markdown
304+ Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
305+ Markdown), `commonmark` (CommonMark Markdown), `rst`
306+ (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
307+ or `html5` (HTML5/XHTML [polyglot markup]), `latex`
308+ (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
309+ `man` (groff man), `mediawiki` (MediaWiki markup),
310+ `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
311+ `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
312+ `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
313+ (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
314+ `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
315+ (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
316+ `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
317+ `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
318+ Simple), `slidy` (Slidy HTML and JavaScript slide show),
319+ `slideous` (Slideous HTML and JavaScript slide show),
320+ `dzslides` (DZSlides HTML5 + JavaScript slide show),
321+ `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
322+ (S5 HTML and JavaScript slide show), or the path of a custom
323+ lua writer (see [Custom writers], below). (`markdown_github`
324+ provides deprecated and less accurate suppport for
325+ Github-Flavored Markdown; please use `gfm` instead, unless
326+ you use extensions that do not work with `gfm`.) Note that `odt`,
327+ `epub`, and `epub3` output will not be directed to *stdout*;
328+ an output filename must be specified using the `-o/--output`
329+ option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
330+ `beamer`, `html4`, or `html5`, the output will be rendered as
331+ literate Haskell source: see [Literate Haskell support],
332+ below. Markdown syntax extensions can be individually
333+ enabled or disabled by appending `+EXTENSION` or
334+ `-EXTENSION` to the format name, as described above under `-f`.
335+ See `--list-output-formats` and `--list-extensions`, below.
350336
351337`-o` *FILE*, `--output=`*FILE*
352338
@@ -358,43 +344,35 @@ header when requesting a document from a URL:
358344
359345: Specify the user data directory to search for pandoc data files.
360346 If this option is not specified, the default user data directory
361− will be used. On \*nix and macOS systems this will be the `pandoc`
362− subdirectory of the XDG data directory (by default,
363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364− environment variable). If that directory does not exist and
365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366− On Windows the default user data directory is
367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.
347+ will be used. This is, in UNIX:
348+
349+ $HOME/.pandoc
350+
351+ in Windows XP:
352+
353+ C:\Documents And Settings\USERNAME\Application Data\pandoc
354+
355+ and in Windows Vista or later:
356+
357+ C:\Users\USERNAME\AppData\Roaming\pandoc
358+
368359 You can find the default user data directory on your system by
369360 looking at the output of `pandoc --version`.
370− Data files placed in this directory (for example, `reference.odt`,
371− `reference.docx`, `epub.css`, `templates`) will override
372− pandoc's normal defaults.
373−
374−`-d` *FILE*, `--defaults=`*FILE*
375−
376−: Specify a set of default option settings. *FILE* is a YAML
377− file whose fields correspond to command-line option
378− settings. All options for document conversion, including input
379− and output files, can be set using a defaults file. The file will
380− be searched for first in the working directory, and then in
381− the `defaults` subdirectory of the user data directory
382− (see `--data-dir`). The `.yaml` extension may be omitted.
383− See the section [Default files] for more information on the
384− file format. Settings from the defaults file may be
385− overridden or extended by subsequent options on the command
386− line.
361+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
362+ `slidy`, `slideous`, or `s5` directory
363+ placed in this directory will override pandoc's normal defaults.
387364
388365`--bash-completion`
389366
390367: Generate a bash completion script. To enable bash completion
391368 with pandoc, add this to your `.bashrc`:
392369
393− eval "$(pandoc --bash-completion)"
370+ eval "$(pandoc --bash-completion)"
394371
395372`--verbose`
396373
397−: Give verbose debugging output.
374+: Give verbose debugging output. Currently this only has an effect
375+ with PDF output.
398376
399377`--quiet`
400378
@@ -418,12 +396,11 @@ header when requesting a document from a URL:
418396
419397: List supported output formats, one per line.
420398
421−`--list-extensions`[`=`*FORMAT*]
399+`--list-extensions`
422400
423−: List supported extensions for *FORMAT*, one per line, preceded
401+: List supported Markdown extensions, one per line, followed
424402 by a `+` or `-` indicating whether it is enabled by default
425− in *FORMAT*. If *FORMAT* is not specified, defaults for
426− pandoc's Markdown are given.
403+ in pandoc's Markdown.
427404
428405`--list-highlight-languages`
429406
@@ -443,95 +420,12 @@ header when requesting a document from a URL:
443420
444421: Show usage message.
445422
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.
423+Reader options
424+--------------
522425
523426`--base-header-level=`*NUMBER*
524427
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
527− (defaults to 1).
528−
529−`--strip-empty-paragraphs`
530−
531−: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532− Ignore paragraphs with no content. This option is useful
533− for converting word processing documents where users have
534− used empty paragraphs to create inter-paragraph space.
428+: Specify the base level for headers (defaults to 1).
535429
536430`--indented-code-classes=`*CLASSES*
537431
@@ -554,7 +448,7 @@ header when requesting a document from a URL:
554448 footnotes and links will not work across files. Reading binary
555449 files (docx, odt, epub) implies `--file-scope`.
556450
557−`-F` *PROGRAM*, `--filter=`*PROGRAM*
451+`--filter=`*PROGRAM*
558452
559453: Specify an executable to be used as a filter transforming the
560454 pandoc AST after the input is parsed and before the output is
@@ -589,65 +483,47 @@ header when requesting a document from a URL:
589483
590484 3. `$PATH` (executable only)
591485
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*
486+`--lua-filter=`*SCRIPT*
596487
597488: Transform the document in a similar fashion as JSON filters (see
598− `--filter`), but use pandoc's built-in Lua filtering system. The given
599− Lua script is expected to return a list of Lua filters which will be
600− applied in order. Each Lua filter must contain element-transforming
489+ `--filter`), but use pandoc's build-in lua filtering system. The given
490+ lua script is expected to return a list of lua filters which will be
491+ applied in order. Each lua filter must contain element-transforming
601492 functions indexed by the name of the AST element on which the filter
602493 function should be applied.
603494
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.
495+ The `pandoc` lua module provides helper functions for element
496+ creation. It is always loaded into the script's lua environment.
608497
609− In order of preference, pandoc will look for Lua filters in
498+ The following is an example lua script for macro-expansion:
610499
611− 1. a specified full or relative path
500+ function expand_hello_world(inline)
501+ if inline.c == '{{helloworld}}' then
502+ return pandoc.Emph{ pandoc.Str "Hello, World" }
503+ else
504+ return inline
505+ end
506+ end
612507
613− 2. `$DATADIR/filters` where `$DATADIR` is the user data
614− directory (see `--data-dir`, above).
508+ return {{Str = expand_hello_world}}
615509
616− Filters, Lua filters, and citeproc processing are applied in
617− the order specified on the command line.
618510
619511`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620512
621513: Set the metadata field *KEY* to the value *VAL*. A value specified
622− on the command line overrides a value specified in the document
623− using [YAML metadata blocks][Extension: `yaml_metadata_block`].
514+ on the command line overrides a value specified in the document.
624515 Values will be parsed as YAML boolean or string values. If no value is
625516 specified, the value will be treated as Boolean true. Like
626517 `--variable`, `--metadata` causes template variables to be set.
627518 But unlike `--variable`, `--metadata` affects the metadata of the
628519 underlying document (which is accessible from filters and may be
629− printed in some output formats) and metadata values will be escaped
630− when inserted into the template.
631−
632−`--metadata-file=`*FILE*
633−
634−: Read metadata from the supplied YAML (or JSON) file. This
635− option can be used with every input format, but string scalars
636− in the YAML file will always be parsed as Markdown. Generally,
637− the input will be handled the same as in [YAML metadata
638− blocks][Extension: `yaml_metadata_block`]. This option can be
639− used repeatedly to include multiple metadata files; values in
640− files specified later on the command line will be preferred
641− over those specified in earlier files. Metadata values
642− specified inside the document, or by using `-M`, overwrite
643− values specified with this option.
520+ printed in some output formats).
644521
645522`-p`, `--preserve-tabs`
646523
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.
524+: Preserve tabs instead of converting them to spaces (the default).
525+ Note that this will only affect tabs in literal code spans and code
526+ blocks; tabs in regular text will be treated as spaces.
651527
652528`--tab-stop=`*NUMBER*
653529
@@ -657,30 +533,27 @@ header when requesting a document from a URL:
657533
658534: Specifies what to do with insertions, deletions, and comments
659535 produced by the MS Word "Track Changes" feature. `accept` (the
660− default) processes all the insertions and deletions.
661− `reject` ignores them. Both `accept` and `reject` ignore comments.
662− `all` includes all insertions, deletions, and comments, wrapped
663− in spans with `insertion`, `deletion`, `comment-start`, and
664− `comment-end` classes, respectively. The author and time of
665− change is included. `all` is useful for scripting: only
666− accepting changes from a certain reviewer, say, or before a
667− certain date. If a paragraph is inserted or deleted,
668− `track-changes=all` produces a span with the class
669− `paragraph-insertion`/`paragraph-deletion` before the
670− affected paragraph break. This option only affects the docx
671− reader.
536+ default), inserts all insertions, and ignores all
537+ deletions. `reject` inserts all deletions and ignores
538+ insertions. Both `accept` and `reject` ignore comments. `all` puts
539+ in insertions, deletions, and comments, wrapped in spans with
540+ `insertion`, `deletion`, `comment-start`, and `comment-end`
541+ classes, respectively. The author and time of change is
542+ included. `all` is useful for scripting: only accepting changes
543+ from a certain reviewer, say, or before a certain date. This
544+ option only affects the docx reader.
672545
673546`--extract-media=`*DIR*
674547
675548: Extract images and other media contained in or linked from
676549 the source document to the path *DIR*, creating it if
677550 necessary, and adjust the images references in the document
678− so they point to the extracted files. Media are downloaded,
679− read from the file system, or extracted from a binary
680− container (e.g. docx), as needed. The original file paths
681− are used if they are relative paths not containing `..`.
682− Otherwise filenames are constructed from the SHA1 hash of
683− the contents.
551+ so they point to the extracted files. If the source format is
552+ a binary container (docx, epub, or odt), the media is
553+ extracted from the container and the original
554+ filenames are used. Otherwise the media is read from the
555+ file system or downloaded, and new filenames are constructed
556+ based on SHA1 hashes of the contents.
684557
685558`--abbreviations=`*FILE*
686559
@@ -691,30 +564,29 @@ header when requesting a document from a URL:
691564 system default, use
692565 `pandoc --print-default-data-file=abbreviations`. The only
693566 use pandoc makes of this list is in the Markdown reader.
694− Strings found in this list will be followed by a nonbreaking
695− space, and the period will not produce sentence-ending space
696− in formats like LaTeX. The strings may not contain spaces.
567+ Strings ending in a period that are found in this list will
568+ be followed by a nonbreaking space, so that the period will
569+ not produce sentence-ending space in formats like LaTeX.
697570
698571[`pandocfilters`]: https://github.com/jgm/pandocfilters
699572[PHP]: https://github.com/vinai/pandocfilters-php
700573[perl]: https://metacpan.org/pod/Pandoc::Filter
701574[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703575
704−## General writer options {.options}
576+General writer options
577+----------------------
705578
706579`-s`, `--standalone`
707580
708581: Produce output with an appropriate header and footer (e.g. a
709582 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710583 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711− output. For `native` output, this option causes metadata to
712− be included; otherwise, metadata is suppressed.
584+ output.
713585
714−`--template=`*FILE*|*URL*
586+`--template=`*FILE*
715587
716−: Use the specified file as a custom template for the generated document.
717− Implies `--standalone`. See [Templates], below, for a description
588+: Use *FILE* as a custom template for the generated document. Implies
589+ `--standalone`. See [Templates], below, for a description
718590 of template syntax. If no extension is specified, an extension
719591 corresponding to the writer will be added, so that `--template=special`
720592 looks for `special.html` for HTML output. If the template is not
@@ -726,29 +598,22 @@ header when requesting a document from a URL:
726598`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727599
728600: Set the template variable *KEY* to the value *VAL* when rendering the
729− document in standalone mode. If no *VAL* is specified, the
730− key will be given the value `true`.
601+ document in standalone mode. This is generally only useful when the
602+ `--template` option is used to specify a custom template, since
603+ pandoc automatically sets the variables used in the default
604+ templates. If no *VAL* is specified, the key will be given the
605+ value `true`.
731606
732607`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733608
734609: Print the system default template for an output *FORMAT*. (See `-t`
735610 for a list of possible *FORMAT*s.) Templates in the user data
736− directory are ignored. This option may be used with
737− `-o`/`--output` to redirect output to a file, but
738− `-o`/`--output` must come before `--print-default-template`
739− on the command line.
740−
741− Note that some of the default templates use partials, for
742− example `styles.html`. To print the partials, use
743− `--print-default-data-file`: for example,
744− `--print-default-data-file=templates/styles.html`.
611+ directory are ignored.
745612
746613`--print-default-data-file=`*FILE*
747614
748615: Print a system default data file. Files in the user data directory
749− are ignored. This option may be used with `-o`/`--output` to
750− redirect output to a file, but `-o`/`--output` must come before
751− `--print-default-data-file` on the command line.
616+ are ignored.
752617
753618`--eol=crlf`|`lf`|`native`
754619
@@ -759,12 +624,9 @@ header when requesting a document from a URL:
759624
760625`--dpi`=*NUMBER*
761626
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.
627+: Specify the dpi (dots per inch) value for conversion from pixels
628+ to inch/centimeters and vice versa. The default is 96dpi.
629+ Technically, the correct term would be ppi (pixels per inch).
768630
769631`--wrap=auto`|`none`|`preserve`
770632
@@ -777,8 +639,6 @@ header when requesting a document from a URL:
777639 where there are nonsemantic newlines in the source, there
778640 will be nonsemantic newlines in the output as well).
779641 Automatic wrapping does not currently work in HTML output.
780− In `ipynb` output, this option affects wrapping of the
781− contents of markdown cells.
782642
783643`--columns=`*NUMBER*
784644
@@ -791,21 +651,14 @@ header when requesting a document from a URL:
791651: Include an automatically generated table of contents (or, in
792652 the case of `latex`, `context`, `docx`, `odt`,
793653 `opendocument`, `rst`, or `ms`, an instruction to create
794− one) in the output document. This option has no effect
795− unless `-s/--standalone` is used, and it has no effect
796− on `man`, `docbook4`, `docbook5`, or `jats` output.
797−
798− Note that if you are producing a PDF via `ms`, the table
799− of contents will appear at the beginning of the
800− document, before the title. If you would prefer it to
801− be at the end of the document, use the option
802− `--pdf-engine-opt=--no-toc-relocation`.
654+ one) in the output document. This option has no effect on
655+ `man`, `docbook4`, `docbook5`, or `jats` output.
803656
804657`--toc-depth=`*NUMBER*
805658
806659: Specify the number of section levels to include in the table
807− of contents. The default is 3 (which means that level-1, 2, and 3
808− headings will be listed in the contents).
660+ of contents. The default is 3 (which means that level 1, 2, and 3
661+ headers will be listed in the contents).
809662
810663`--strip-comments`
811664
@@ -832,19 +685,8 @@ header when requesting a document from a URL:
832685 Instead of a *STYLE* name, a JSON file with extension
833686 `.theme` may be supplied. This will be parsed as a KDE
834687 syntax highlighting theme and (if valid) used as the
835− highlighting style.
836−
837− To generate the JSON version of an existing style,
838− use `--print-highlight-style`.
839−
840−`--print-highlight-style=`*STYLE*|*FILE*
841−
842−: Prints a JSON version of a highlighting style, which can
843− be modified, saved with a `.theme` extension, and used
844− with `--highlight-style`. This option may be used with
845− `-o`/`--output` to redirect output to a file, but
846− `-o`/`--output` must come before `--print-highlight-style`
847− on the command line.
688+ highlighting style. To see a sample theme that can be
689+ modified, `pandoc --print-default-data-file default.theme`.
848690
849691`--syntax-definition=`*FILE*
850692
@@ -852,10 +694,9 @@ header when requesting a document from a URL:
852694 which will be used for syntax highlighting of appropriately
853695 marked code blocks. This can be used to add support for
854696 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
856− multiple syntax definitions.
697+ existing languages.
857698
858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
699+`-H` *FILE*, `--include-in-header=`*FILE*
859700
860701: Include contents of *FILE*, verbatim, at the end of the header.
861702 This can be used, for example, to include special
@@ -863,7 +704,7 @@ header when requesting a document from a URL:
863704 repeatedly to include multiple files in the header. They will be
864705 included in the order specified. Implies `--standalone`.
865706
866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
707+`-B` *FILE*, `--include-before-body=`*FILE*
867708
868709: Include contents of *FILE*, verbatim, at the beginning of the
869710 document body (e.g. after the `<body>` tag in HTML, or the
@@ -872,7 +713,7 @@ header when requesting a document from a URL:
872713 used repeatedly to include multiple files. They will be included in
873714 the order specified. Implies `--standalone`.
874715
875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
716+`-A` *FILE*, `--include-after-body=`*FILE*
876717
877718: Include contents of *FILE*, verbatim, at the end of the document
878719 body (before the `</body>` tag in HTML, or the
@@ -891,39 +732,28 @@ header when requesting a document from a URL:
891732 will not be searched. For example:
892733 `--resource-path=.:test` will search the working directory
893734 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`.
899735
900736`--request-header=`*NAME*`:`*VAL*
901737
902738: Set the request header *NAME* to the value *VAL* when making
903739 HTTP requests (for example, when a URL is given on the
904740 command line, or when resources used in a document must be
905− downloaded). If you're behind a proxy, you also need to set
906− the environment variable `http_proxy` to `http://...`.
907−
908−`--no-check-certificate`
741+ downloaded).
909742
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}
743+Options affecting specific writers
744+----------------------------------
915745
916746`--self-contained`
917747
918748: Produce a standalone HTML file with no external dependencies, using
919749 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
920− images, and videos. Implies `--standalone`. The resulting file should be
921− "self-contained," in the sense that it needs no external files and no net
922− access to be displayed properly by a browser. This option works only with
923− HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
924− `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
925− and stylesheets at absolute URLs will be downloaded; those at relative
926− URLs will be sought relative to the working directory (if the first source
750+ images, and videos. The resulting file should be "self-contained,"
751+ in the sense that it needs no external files and no net access to be
752+ displayed properly by a browser. This option works only with HTML output
753+ formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
754+ `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
755+ stylesheets at absolute URLs will be downloaded; those at relative URLs
756+ will be sought relative to the working directory (if the first source
927757 file is local) or relative to the base URL (if the first source
928758 file is remote). Elements with the attribute
929759 `data-external="1"` will be left alone; the documents they
@@ -936,18 +766,13 @@ header when requesting a document from a URL:
936766
937767`--html-q-tags`
938768
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.)
769+: Use `<q>` tags for quotes in HTML.
942770
943771`--ascii`
944772
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.
773+: Use only ASCII characters in output. Currently supported only for
774+ HTML and DocBook output (which uses numerical entities instead of
775+ UTF-8 when this option is selected).
951776
952777`--reference-links`
953778
@@ -956,45 +781,35 @@ header when requesting a document from a URL:
956781 placement of link references is affected by the
957782 `--reference-location` option.
958783
959−`--reference-location=block`|`section`|`document`
784+`--reference-location = block`|`section`|`document`
960785
961786: Specify whether footnotes (and references, if `reference-links` is
962787 set) are placed at the end of the current (top-level) block, the
963788 current section, or the document. The default is
964789 `document`. Currently only affects the markdown writer.
965790
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−
974791`--atx-headers`
975792
976−: *Deprecated synonym for `--markdown-headings=atx`.*
793+: Use ATX-style headers in Markdown and AsciiDoc output. The default is
794+ to use setext-style headers for levels 1-2, and then ATX headers.
977795
978−`--top-level-division=default`|`section`|`chapter`|`part`
796+`--top-level-division=[default|section|chapter|part]`
979797
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.
798+: Treat top-level headers as the given division type in LaTeX, ConTeXt,
799+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;
800+ all headers are shifted such that the top-level header becomes the specified
801+ type. The default behavior is to determine the best division type via
802+ heuristics: unless other conditions apply, `section` is chosen. When the
803+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the
804+ `article` option is specified), `chapter` is implied as the setting for this
805+ option. If `beamer` is the output format, specifying either `chapter` or
806+ `part` will cause top-level headers to become `\part{..}`, while
807+ second-level headers remain as their default type.
993808
994809`-N`, `--number-sections`
995810
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997− output. By default, sections are not numbered. Sections with class
811+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
812+ By default, sections are not numbered. Sections with class
998813 `unnumbered` will never be numbered, even if `--number-sections`
999814 is specified.
1000815
@@ -1002,19 +817,16 @@ header when requesting a document from a URL:
1002817
1003818: Offset for section headings in HTML output (ignored in other
1004819 output formats). The first number is added to the section number for
1005− top-level headings, the second for second-level headings, and so on.
1006− So, for example, if you want the first top-level heading in your
820+ top-level headers, the second for second-level headers, and so on.
821+ So, for example, if you want the first top-level header in your
1007822 document to be numbered "6", specify `--number-offset=5`.
1008− If your document starts with a level-2 heading which you want to
823+ If your document starts with a level-2 header which you want to
1009824 be numbered "1.5", specify `--number-offset=1,4`.
1010825 Offsets are 0 by default. Implies `--number-sections`.
1011826
1012827`--listings`
1013828
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].
829+: Use the [`listings`] package for LaTeX code blocks
1018830
1019831`-i`, `--incremental`
1020832
@@ -1023,22 +835,22 @@ header when requesting a document from a URL:
1023835
1024836`--slide-level=`*NUMBER*
1025837
1026−: Specifies that headings with the specified level create
1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
838+: Specifies that headers with the specified level create
839+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1028840 above this level in the hierarchy are used to divide the
1029− slide show into sections; headings below this level create
841+ slide show into sections; headers below this level create
1030842 subheads within a slide. Note that content that is
1031− not contained under slide-level headings will not appear in
843+ not contained under slide-level headers will not appear in
1032844 the slide show. The default is to set the slide level based
1033845 on the contents of the document; see [Structuring the slide
1034846 show].
1035847
1036848`--section-divs`
1037849
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.
850+: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
851+ and attach identifiers to the enclosing `<div>` (or `<section>`)
852+ rather than the header itself. See
853+ [Header identifiers], below.
1042854
1043855`--email-obfuscation=none`|`javascript`|`references`
1044856
@@ -1059,7 +871,8 @@ header when requesting a document from a URL:
1059871
1060872: Specify *STRING* as a prefix at the beginning of the title
1061873 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
874+ appears at the beginning of the HTML body). Implies
875+ `--standalone`.
1063876
1064877`-c` *URL*, `--css=`*URL*
1065878
@@ -1067,8 +880,8 @@ header when requesting a document from a URL:
1067880 include multiple files. They will be included in the order specified.
1068881
1069882 A stylesheet is required for generating EPUB. If none is
1070− provided using this option (or the `css` or `stylesheet`
1071− metadata fields), pandoc will look for a file `epub.css` in the
883+ provided using this option (or the `stylesheet` metadata
884+ field), pandoc will look for a file `epub.css` in the
1072885 user data directory (see `--data-dir`). If it is not
1073886 found there, sensible defaults will be used.
1074887
@@ -1091,56 +904,20 @@ header when requesting a document from a URL:
1091904
1092905 To produce a custom `reference.docx`, first get a copy of
1093906 the default `reference.docx`: `pandoc
1094− -o custom-reference.docx --print-default-data-file reference.docx`.
1095− Then open `custom-reference.docx` in Word, modify the
1096− styles as you wish, and save the file. For best
1097− results, do not make changes to this file other than
1098− modifying the styles used by pandoc:
1099−
1100− Paragraph styles:
1101−
1102− - Normal
1103− - Body Text
1104− - First Paragraph
1105− - Compact
1106− - Title
1107− - Subtitle
1108− - Author
1109− - Date
1110− - Abstract
1111− - Bibliography
1112− - Heading 1
1113− - Heading 2
1114− - Heading 3
1115− - Heading 4
1116− - Heading 5
1117− - Heading 6
1118− - Heading 7
1119− - Heading 8
1120− - Heading 9
1121− - Block Text
1122− - Footnote Text
1123− - Definition Term
1124− - Definition
1125− - Caption
1126− - Table Caption
1127− - Image Caption
1128− - Figure
1129− - Captioned Figure
1130− - TOC Heading
1131−
1132− Character styles:
1133−
1134− - Default Paragraph Font
1135− - Body Text Char
1136− - Verbatim Char
1137− - Footnote Reference
1138− - Hyperlink
1139− - Section Number
1140−
1141− Table style:
1142−
1143− - Table
907+ --print-default-data-file reference.docx >
908+ custom-reference.docx`. Then open `custom-reference.docx`
909+ in Word, modify the styles as you wish, and save the file.
910+ For best results, do not make changes to this file other
911+ than modifying the styles used by pandoc: [paragraph]
912+ Normal, Body Text, First Paragraph, Compact, Title,
913+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
914+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
915+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
916+ Definition Term, Definition, Caption, Table Caption,
917+ Image Caption, Figure, Captioned Figure, TOC Heading;
918+ [character] Default Paragraph Font, Body Text Char,
919+ Verbatim Char, Footnote Reference, Hyperlink; [table]
920+ Table.
1144921
1145922 ODT
1146923
@@ -1154,33 +931,10 @@ header when requesting a document from a URL:
1154931
1155932 To produce a custom `reference.odt`, first get a copy of
1156933 the default `reference.odt`: `pandoc
1157− -o custom-reference.odt --print-default-data-file reference.odt`.
1158− Then open `custom-reference.odt` in LibreOffice, modify
1159− the styles as you wish, and save the file.
1160−
1161− PowerPoint
1162−
1163− : Templates included with Microsoft PowerPoint 2013 (either with
1164− `.pptx` or `.potx` extension) are known to work, as are most
1165− templates derived from these.
1166−
1167− The specific requirement is that the template should begin with
1168− the following first four layouts:
1169−
1170− 1. Title Slide
1171− 2. Title and Content
1172− 3. Section Header
1173− 4. Two Content
1174−
1175− All templates included with a recent version of MS PowerPoint
1176− will fit these criteria. (You can click on `Layout` under the
1177− `Home` menu to check.)
1178−
1179− You can also modify the default `reference.pptx`: first run
1180− `pandoc -o custom-reference.pptx --print-default-data-file
1181− reference.pptx`, and then modify `custom-reference.pptx`
1182− in MS PowerPoint (pandoc will use the first four layout
1183− slides, as mentioned above).
934+ --print-default-data-file reference.odt >
935+ custom-reference.odt`. Then open `custom-reference.odt` in
936+ LibreOffice, modify the styles as you wish, and save the
937+ file.
1184938
1185939`--epub-cover-image=`*FILE*
1186940
@@ -1248,12 +1002,12 @@ header when requesting a document from a URL:
12481002
12491003`--epub-chapter-level=`*NUMBER*
12501004
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
1005+: Specify the header level at which to split the EPUB into separate
1006+ "chapter" files. The default is to split into chapters at level 1
1007+ headers. This option only affects the internal composition of the
12541008 EPUB, not the way chapters and sections are displayed to users. Some
12551009 readers may be slow if the chapter files are too large, so for large
1256− documents with few level-1 headings, one might want to use a chapter
1010+ documents with few level 1 headers, one might want to use a chapter
12571011 level of 2 or 3.
12581012
12591013`--epub-subdirectory=`*DIRNAME*
@@ -1262,145 +1016,111 @@ header when requesting a document from a URL:
12621016 the EPUB-specific contents. The default is `EPUB`. To put
12631017 the EPUB contents in the top level, use an empty string.
12641018
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*
1019+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
12751020
12761021: Use the specified engine when producing PDF output.
1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279− and `pdfroff`. If the engine is not in your PATH, the full
1280− path of the engine may be specified here. If this option
1281− is not specified, pandoc uses the following defaults
1282− depending on the output format specified using `-t/--to`:
1283−
1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285− `tectonic`, `latexmk`)
1286− - `-t context`: `context`
1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288− see [print-css.rocks](https://print-css.rocks) for a good
1289− introduction to PDF generation from HTML/CSS.)
1290− - `-t ms`: `pdfroff`
1022+ The default is `pdflatex`. If the engine is not in your PATH,
1023+ the full path of the engine may be specified here.
12911024
12921025`--pdf-engine-opt=`*STRING*
12931026
12941027: Use the given string as a command-line argument to the `pdf-engine`.
1295− For example, to use a persistent directory `foo` for `latexmk`'s
1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297− Note that no check for duplicate options is done.
1298−
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301−[Encoding issue with the listings package]:
1302− https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303−
1304−## Citation rendering {.options}
1305−
1306−`-C`, `--citeproc`
1307−
1308−: Process the citations in the file, replacing them with
1309− rendered citations and adding a bibliography.
1310− Citation processing will not take place unless bibliographic
1311− data is supplied, either through an external file specified
1312− using the `--bibliography` option or the `bibliography`
1313− field in metadata, or via a `references` section in metadata
1314− containing a list of citations in CSL YAML format with
1315− Markdown formatting. The style is controlled by a [CSL]
1316− stylesheet specified using the `--csl` option or the `csl`
1317− field in metadata. (If no stylesheet is specified,
1318− the `chicago-author-date` style will be used by default.)
1319− The citation processing transformation may be applied before
1320− or after filters or Lua filters (see `--filter`,
1321− `--lua-filter`): these transformations are applied in the
1322− order they appear on the command line. For more
1323− information, see the section on [Citations].
1028+ If used multiple times, the arguments are provided with spaces between
1029+ them. Note that no check for duplicate options is done.
1030+
1031+[Dublin Core elements]: http://dublincore.org/documents/dces/
1032+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1033+
1034+Citation rendering
1035+------------------
13241036
13251037`--bibliography=`*FILE*
13261038
13271039: Set the `bibliography` field in the document's metadata to *FILE*,
1328− overriding any value set in the metadata. If you supply
1329− this argument multiple times, each *FILE* will be added to
1330− bibliography. If *FILE* is a URL, it will be fetched
1331− via HTTP. If *FILE* is not found relative to the
1332− working directory, it will be sought in the resource path
1333− (see `--resource-path`).
1040+ overriding any value set in the metadata, and process citations
1041+ using `pandoc-citeproc`. (This is equivalent to
1042+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1043+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1044+ used, making this equivalent to `--metadata bibliography=FILE`.
1045+ If you supply this argument multiple times, each *FILE* will be added
1046+ to bibliography.
13341047
13351048`--csl=`*FILE*
13361049
13371050: Set the `csl` field in the document's metadata to *FILE*,
13381051 overriding any value set in the metadata. (This is equivalent to
1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340− fetched via HTTP. If *FILE* is not found relative to the
1341− working directory, it will be sought in the resource path
1342− (see `--resource-path`) and finally in the `csl`
1343− subdirectory of the pandoc user data directory.
1052+ `--metadata csl=FILE`.)
1053+ This option is only relevant with `pandoc-citeproc`.
13441054
13451055`--citation-abbreviations=`*FILE*
13461056
13471057: Set the `citation-abbreviations` field in the document's metadata to
13481058 *FILE*, overriding any value set in the metadata. (This is equivalent to
13491059 `--metadata citation-abbreviations=FILE`.)
1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351− found relative to the working directory, it will be sought
1352− in the resource path (see `--resource-path`) and finally in
1353− the `csl` subdirectory of the pandoc user data directory.
1060+ This option is only relevant with `pandoc-citeproc`.
13541061
13551062`--natbib`
13561063
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`].
1064+: Use [`natbib`] for citations in LaTeX output. This option is not for use
1065+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1066+ use in producing a LaTeX file that can be processed with [`bibtex`].
13611067
13621068`--biblatex`
13631069
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`].
1070+: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1071+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1072+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1073+
1074+Math rendering in HTML
1075+----------------------
1076+
1077+`-m` [*URL*], `--latexmathml`[`=`*URL*]
1078+
1079+: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1080+ To insert a link to a local copy of the `LaTeXMathML.js` script,
1081+ provide a *URL*. If no *URL* is provided, the contents of the
1082+ script will be inserted directly into the HTML header, preserving
1083+ portability at the price of efficiency. If you plan to use math on
1084+ several pages, it is much better to link to a copy of the script,
1085+ so it can be cached.
1086+
1087+`--mathml`
1088+
1089+: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1090+ `html4` and `html5`). This is the default in `odt` output.
13681091
1369−## Math rendering in HTML {.options}
1092+`--jsmath`[`=`*URL*]
13701093
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.
1094+: Use [jsMath] to display embedded TeX math in HTML output.
1095+ The *URL* should point to the jsMath load script (e.g.
1096+ `jsMath/easy/load.js`); if provided, it will be linked to in
1097+ the header of standalone HTML documents. If a *URL* is not provided,
1098+ no link to the jsMath load script will be inserted; it is then
1099+ up to the author to provide such a link in the HTML template.
13771100
13781101`--mathjax`[`=`*URL*]
13791102
13801103: Use [MathJax] to display embedded TeX math in HTML output.
1381− TeX math will be put between `\(...\)` (for inline math)
1382− or `\[...\]` (for display math) and wrapped in `<span>` tags
1383− with class `math`. Then the MathJax JavaScript will render it.
13841104 The *URL* should point to the `MathJax.js` load script.
1385− If a *URL* is not provided, a link to the Cloudflare CDN will
1105+ If a *URL* is not provided, a link to the MathJax CDN will
13861106 be inserted.
13871107
1388−`--mathml`
1108+`--gladtex`
1109+
1110+: Enclose TeX math in `<eq>` tags in HTML output. These can then
1111+ be processed by [gladTeX] to produce links to images of the typeset
1112+ formulas.
13891113
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.
1114+`--mimetex`[`=`*URL*]
1115+
1116+: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1117+ specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
13951118
13961119`--webtex`[`=`*URL*]
13971120
1398−: Convert TeX formulas to `<img>` tags that link to an external script
1399− that converts formulas to images. The formula will be URL-encoded
1400− and concatenated with the URL provided. For SVG images you can for
1401− example use `--webtex https://latex.codecogs.com/svg.latex?`.
1402− If no URL is specified, the CodeCogs URL generating PNGs
1403− will be used (`https://latex.codecogs.com/png.latex?`).
1121+: Render TeX formulas using an external script that converts TeX
1122+ formulas to images. The formula will be concatenated with the URL
1123+ provided. If *URL* is not specified, the CodeCogs will be used.
14041124 Note: the `--webtex` option will affect Markdown output
14051125 as well as HTML, which is useful if you're targeting a
14061126 version of Markdown without native math support.
@@ -1408,26 +1128,26 @@ results only for basic math, usually you will want to use
14081128`--katex`[`=`*URL*]
14091129
14101130: Use [KaTeX] to display embedded TeX math in HTML output.
1411− The *URL* is the base URL for the KaTeX library. That directory
1412− should contain a `katex.min.js` and a `katex.min.css` file.
1413− If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
1414−
1415−`--gladtex`
1131+ The *URL* is the base URL for the KaTeX library. If a *URL* is
1132+ not provided, a link to the KaTeX CDN will be inserted.
1133+ Note: [KaTeX] seems to work best with `html5` output.
14161134
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.
1135+`--katex-stylesheet=`*URL*
14201136
1421− pandoc -s --gladtex input.md -o myfile.htex
1422− gladtex -d image_dir myfile.htex
1423− # produces myfile.html and images in image_dir
1137+: The *URL* should point to the `katex.css` stylesheet. If this option is
1138+ not specified, a link to the KaTeX CDN will be inserted. Note that this
1139+ option does not imply `--katex`.
14241140
1425−[MathML]: https://www.w3.org/Math/
1141+[MathML]: http://www.w3.org/Math/
1142+[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1143+[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
14261144[MathJax]: https://www.mathjax.org
1145+[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1146+[mimeTeX]: http://www.forkosh.com/mimetex.html
14271147[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
14291148
1430−## Options for wrapper scripts {.options}
1149+Options for wrapper scripts
1150+---------------------------
14311151
14321152`--dump-args`
14331153
@@ -1451,277 +1171,8 @@ results only for basic math, usually you will want to use
14511171
14521172 pandoc -o foo.html -s
14531173
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
1174+Templates
1175+=========
17251176
17261177When the `-s/--standalone` option is used, pandoc uses a template to
17271178add header and footer material that is needed for a self-standing
@@ -1738,1430 +1189,482 @@ directory (see `--data-dir`, above). *Exceptions:*
17381189- For `odt` output, customize the `default.opendocument`
17391190 template.
17401191- For `pdf` output, customize the `default.latex` template
1741− (or the `default.context` template, if you use `-t context`,
1742− or the `default.ms` template, if you use `-t ms`, or the
1743− `default.html` template, if you use `-t html`).
1744−- `docx` and `pptx` have no template (however, you can use
1192+ (or the `default.beamer` template, if you use `-t beamer`,
1193+ or the `default.context` template, if you use `-t context`).
1194+- `docx` has no template (however, you can use
17451195 `--reference-doc` to customize the output).
17461196
17471197Templates contain *variables*, which allow for the inclusion of
1748−arbitrary information at any point in the file. They may be set at the
1749−command line using the `-V/--variable` option. If a variable is not set,
1750−pandoc will look for the key in the document's metadata, which can be set
1751−using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1752−or with the `-M/--metadata` option. In addition, some variables
1753−are given default values by pandoc. See [Variables] below for
1754−a list of variables used in pandoc's default templates.
1198+arbitrary information at any point in the file. Variables may be set
1199+within the document using [YAML metadata blocks][Extension:
1200+`yaml_metadata_block`]. They may also be set at the
1201+command line using the `-V/--variable` option: variables set in this
1202+way override metadata fields with the same name.
17551203
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.
1204+Variables set by pandoc
1205+-----------------------
17611206
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1207+Some variables are set automatically by pandoc. These vary somewhat
1208+depending on the output format, but include metadata fields as well
1209+as the following:
17631210
1764−## Template syntax
1211+`sourcefile`, `outputfile`
1212+: source and destination filenames, as given on the command line.
1213+ `sourcefile` can also be a list if input comes from multiple files, or empty
1214+ if input is from stdin. You can use the following snippet in your template
1215+ to distinguish them:
17651216
1766−### Comments
1217+ $if(sourcefile)$
1218+ $for(sourcefile)$
1219+ $sourcefile$
1220+ $endfor$
1221+ $else$
1222+ (stdin)
1223+ $endif$
17671224
1768−Anything between the sequence `$--` and the end of the
1769−line will be treated as a comment and omitted from the output.
1225+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17701226
1771−### Delimiters
1227+`title`, `author`, `date`
1228+: allow identification of basic aspects of the document. Included
1229+ in PDF metadata through LaTeX and ConTeXt. These can be set
1230+ through a [pandoc title block][Extension: `pandoc_title_block`],
1231+ which allows for multiple authors, or through a YAML metadata block:
17721232
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.
1233+ ---
1234+ author:
1235+ - Aristotle
1236+ - Peter Abelard
1237+ ...
17811238
1782−To include a literal `$` in the document, use `$$`.
1239+`subtitle`
1240+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1241+ renders in LaTeX only when using a document class that supports
1242+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1243+ `scrreprt`, `scrbook`).[^subtitle]
17831244
1784−### Interpolated variables
1245+`institute`
1246+: author affiliations (in LaTeX and Beamer only). Can be a
1247+ list, when there are multiple authors.
17851248
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:
1249+`abstract`
1250+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
17911251
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−```
1252+`keywords`
1253+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1254+ may be repeated as for `author`, above
18021255
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.
1256+`header-includes`
1257+: contents specified by `-H/--include-in-header` (may have multiple
1258+ values)
18071259
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.
1260+`toc`
1261+: non-null value if `--toc/--table-of-contents` was specified
18151262
1816−### Conditionals
1263+`toc-title`
1264+: title of table of contents (works only with EPUB,
1265+ opendocument, odt, docx)
18171266
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:
1267+`include-before`
1268+: contents specified by `-B/--include-before-body` (may have
1269+ multiple values)
18241270
1825−```
1826−$if(foo)$bar$endif$
1271+`include-after`
1272+: contents specified by `-A/--include-after-body` (may have
1273+ multiple values)
18271274
1828−$if(foo)$
1829− $foo$
1830−$endif$
1275+`body`
1276+: body of document
18311277
1832−$if(foo)$
1833−part one
1834−$else$
1835−part two
1836−$endif$
1278+`meta-json`
1279+: JSON representation of all of the document's metadata. Field
1280+ values are transformed to the selected output format.
18371281
1838−${if(foo)}bar${endif}
1282+[^subtitle]: To make `subtitle` work with other LaTeX
1283+ document classes, you can add the following to `header-includes`:
18391284
1840−${if(foo)}
1841− ${foo}
1842−${endif}
1285+ \providecommand{\subtitle}[1]{%
1286+ \usepackage{titling}
1287+ \posttitle{%
1288+ \par\large#1\end{center}}
1289+ }
18431290
1844−${if(foo)}
1845−${ foo.bar }
1846−${else}
1847−no foo!
1848−${endif}
1849−```
1291+Language variables
1292+------------------
18501293
1851−The keyword `elseif` may be used to simplify complex nested
1852−conditionals:
1294+`lang`
1295+: identifies the main language of the document,
1296+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1297+ For some output formats, pandoc will convert it to an appropriate
1298+ format stored in the additional variables `babel-lang`,
1299+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1300+
1301+ Native pandoc `span`s and `div`s with the lang attribute
1302+ (value in BCP 47) can be used to switch the language in
1303+ that range.
1304+
1305+`otherlangs`
1306+: a list of other languages used in the document
1307+ in the YAML metadata, according to [BCP 47]. For example:
1308+ `otherlangs: [en-GB, fr]`.
1309+ This is automatically generated from the `lang` attributes
1310+ in all `span`s and `div`s but can be overridden.
1311+ Currently only used by LaTeX through the generated
1312+ `babel-otherlangs` and `polyglossia-otherlangs` variables.
1313+ The LaTeX writer outputs polyglossia commands in the text but
1314+ the `babel-newcommands` variable contains mappings for them
1315+ to the corresponding babel.
18531316
1854−```
1855−$if(foo)$
1856−XXX
1857−$elseif(bar)$
1858−YYY
1859−$else$
1860−ZZZ
1861−$endif$
1862−```
1317+`dir`
1318+: the base direction of the document, either `rtl` (right-to-left)
1319+ or `ltr` (left-to-right).
18631320
1864−### For loops
1321+ For bidirectional documents, native pandoc `span`s and `div`s
1322+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1323+ override the base direction in some output formats.
1324+ This may not always be necessary if the final renderer
1325+ (e.g. the browser, when generating HTML) supports the
1326+ [Unicode Bidirectional Algorithm].
18651327
1866−A for loop begins with `for(variable)` (enclosed in
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1868−delimiters.
1328+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1329+ is fully supported (use `--pdf-engine=xelatex`).
18691330
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.
1331+[BCP 47]: https://tools.ietf.org/html/bcp47
1332+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
18771333
1878−Examples:
1334+Variables for slides
1335+--------------------
18791336
1880−```
1881−$for(foo)$$foo$$sep$, $endfor$
1337+Variables are available for [producing slide shows with pandoc],
1338+including all [reveal.js configuration options].
18821339
1883−$for(foo)$
1884− - $foo.last$, $foo.first$
1885−$endfor$
1340+`titlegraphic`
1341+: title graphic for Beamer documents
18861342
1887−${ for(foo.bar) }
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1889−${ endfor }
1343+`logo`
1344+: logo for Beamer documents
18901345
1891−$for(mymap)$
1892−$it.name$: $it.office$
1893−$endfor$
1894−```
1346+`slidy-url`
1347+: base URL for Slidy documents (defaults to
1348+ `https://www.w3.org/Talks/Tools/Slidy2`)
18951349
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.
1350+`slideous-url`
1351+: base URL for Slideous documents (defaults to `slideous`)
18991352
1900−```
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1902−```
1353+`s5-url`
1354+: base URL for S5 documents (defaults to `s5/default`)
19031355
1904−Instead of using `variable` inside the loop, the special
1905−anaphoric keyword `it` may be used.
1356+`revealjs-url`
1357+: base URL for reveal.js documents (defaults to `reveal.js`)
19061358
1907−```
1908−${ for(foo.bar) }
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1359+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1360+: themes for LaTeX [`beamer`] documents
19121361
1913−### Partials
1362+`themeoptions`
1363+: options for LaTeX beamer themes (a list).
19141364
1915−Partials (subtemplates stored in different files) may be
1916−included by using the name of the partial, followed
1917−by `()`, for example:
1365+`navigation`
1366+: controls navigation symbols in `beamer` documents
1367+ (default is `empty` for no navigation symbols; other valid values
1368+ are `frame`, `vertical`, and `horizontal`).
19181369
1919−```
1920−${ styles() }
1921−```
1370+`section-titles`
1371+: enables on "title pages" for new sections in `beamer`
1372+ documents (default = true).
19221373
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:
1374+`beamerarticle`
1375+: when true, the `beamerarticle` package is loaded (for
1376+ producing an article from beamer slides).
19281377
1929−```
1930−${ styles.html() }
1931−```
1378+`aspectratio`
1379+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1380+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1381+ default, and `32` for 3:2).
19321382
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.)
1383+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
19371384
1938−Partials may optionally be applied to variables using
1939−a colon:
1385+Variables for LaTeX
1386+-------------------
19401387
1941−```
1942−${ date:fancy() }
1388+LaTeX variables are used when [creating a PDF].
19431389
1944−${ articles:bibentry() }
1945−```
1390+`papersize`
1391+: paper size, e.g. `letter`, `a4`
19461392
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
1393+`fontsize`
1394+: font size for body text (e.g. `10pt`, `12pt`)
19501395
1951−```
1952−${ for(articles) }
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1956−
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`.
1961−
1962−Final newlines are omitted from included partials.
1963−
1964−Partials may include other partials.
1965−
1966−A separator between values of an array may be specified
1967−in square brackets, immediately after the variable name
1968−or partial:
1969−
1970−```
1971−${months[, ]}$
1972−
1973−${articles:bibentry()[; ]$
1974−```
1975−
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.
1979−
1980−### Nesting
1981−
1982−To ensure that content is "nested," that is, subsequent lines
1983−indented, use the `^` directive:
1984−
1985−```
1986−$item.number$ $^$$item.description$ ($item.price$)
1987−```
1988−
1989−In this example, if `item.description` has multiple lines,
1990−they will all be indented to line up with the first line:
1991−
1992−```
1993−00123 A fine bottle of 18-year old
1994− Oban whiskey. ($148)
1995−```
1996−
1997−To nest multiple lines to the same level, align them
1998−with the `^` directive in the template. For example:
1999−
2000−```
2001−$item.number$ $^$$item.description$ ($item.price$)
2002− (Available til $item.sellby$.)
2003−```
2004−
2005−will produce
2006−
2007−```
2008−00123 A fine bottle of 18-year old
2009− Oban whiskey. ($148)
2010− (Available til March 30, 2020.)
2011−```
2012−
2013−If a variable occurs by itself on a line, preceded by whitespace
2014−and not followed by further text or directives on the same line,
2015−and the variable's value contains multiple lines, it will be
2016−nested automatically.
2017−
2018−### Breakable spaces
2019−
2020−Normally, spaces in the template itself (as opposed to values of
2021−the interpolated variables) are not breakable, but they can be
2022−made breakable in part of the template by using the `~` keyword
2023−(ended with another `~`).
2024−
2025−```
2026−$~$This long line may break if the document is rendered
2027−with a short line length.$~$
2028−```
2029−
2030−### Pipes
2031−
2032−A pipe transforms the value of a variable or partial. Pipes are
2033−specified using a slash (`/`) between the variable name (or partial)
2034−and the pipe name. Example:
2035−
2036−```
2037−$for(name)$
2038−$name/uppercase$
2039−$endfor$
2040−
2041−$for(metadata/pairs)$
2042−- $it.key$: $it.value$
2043−$endfor$
2044−
2045−$employee:name()/uppercase$
2046−```
2047−
2048−Pipes may be chained:
2049−
2050−```
2051−$for(employees/pairs)$
2052−$it.key/alpha/uppercase$. $it.name$
2053−$endfor$
2054−```
2055−
2056−Some pipes take parameters:
2057−
2058−```
2059−|----------------------|------------|
2060−$for(employee)$
2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062−$endfor$
2063−|----------------------|------------|
2064−```
2065−
2066−Currently the following pipes are predefined:
2067−
2068−- `pairs`: Converts a map or array to an array of maps,
2069− each with `key` and `value` fields. If the original
2070− value was an array, the `key` will be the array index,
2071− starting with 1.
2072−
2073−- `uppercase`: Converts text to uppercase.
2074−
2075−- `lowercase`: Converts text to lowercase.
2076−
2077−- `length`: Returns the length of the value: number
2078− of characters for a textual value, number of elements
2079− for a map or array.
2080−
2081−- `reverse`: Reverses a textual value or array,
2082− and has no effect on other values.
2083−
2084−- `first`: Returns the first value of an array, if
2085− applied to a non-empty array; otherwise returns
2086− the original value.
2087−
2088−- `last`: Returns the last value of an array, if
2089− applied to a non-empty array; otherwise returns
2090− the original value.
2091−
2092−- `rest`: Returns all but the first value of an array, if
2093− applied to a non-empty array; otherwise returns
2094− the original value.
2095−
2096−- `allbutlast`: Returns all but the last value of an array, if
2097− applied to a non-empty array; otherwise returns
2098− the original value.
2099−
2100−- `chomp`: Removes trailing newlines (and breakable space).
2101−
2102−- `nowrap`: Disables line wrapping on breakable spaces.
2103−
2104−- `alpha`: Converts textual values that can be
2105− read as an integer into lowercase alphabetic
2106− characters `a..z` (mod 26). This can be used to get lettered
2107− enumeration from array indices. To get uppercase
2108− letters, chain with `uppercase`.
2109−
2110−- `roman`: Converts textual values that can be
2111− read as an integer into lowercase roman numerials.
2112− This can be used to get lettered enumeration from array indices.
2113− To get uppercase roman, chain with `uppercase`.
2114−
2115−- `left n "leftborder" "rightborder"`: Renders a textual value
2116− in a block of width `n`, aligned to the left, with an optional
2117− left and right border. Has no effect on other values. This
2118− can be used to align material in tables. Widths are positive
2119− integers indicating the number of characters. Borders
2120− are strings inside double quotes; literal `"` and `\` characters
2121− must be backslash-escaped.
2122−
2123−- `right n "leftborder" "rightborder"`: Renders a textual value
2124− in a block of width `n`, aligned to the right, and has no
2125− effect on other values.
2126−
2127−- `center n "leftborder" "rightborder"`: Renders a textual
2128− value in a block of width `n`, aligned to the center, and has
2129− no effect on other values.
2130−
2131−
2132−## Variables
2133−
2134−### Metadata variables
2135−
2136−`title`, `author`, `date`
2137−: allow identification of basic aspects of the document. Included
2138− in PDF metadata through LaTeX and ConTeXt. These can be set
2139− through a [pandoc title block][Extension: `pandoc_title_block`],
2140− which allows for multiple authors, or through a
2141− [YAML metadata block][Extension: `yaml_metadata_block`]:
2142−
2143− ---
2144− author:
2145− - Aristotle
2146− - Peter Abelard
2147− ...
2148−
2149− Note that if you just want to set PDF or HTML metadata, without
2150− including a title block in the document itself, you can
2151− set the `title-meta`, `author-meta`, and `date-meta`
2152− variables. (By default these are set automatically, based
2153− on `title`, `author`, and `date`.) The page title in HTML
2154− is set by `pagetitle`, which is equal to `title` by default.
2155−
2156−`subtitle`
2157−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158− documents
2159−
2160−`abstract`
2161−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162− documents
2163−
2164−`keywords`
2165−: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166− and AsciiDoc metadata; repeat as for `author`, above
2167−
2168−`subject`
2169−: document subject, included in ODT, PDF, docx and pptx metadata
2170−
2171−`description`
2172−: document description, included in ODT, docx and pptx metadata. Some
2173− applications show this as `Comments` metadata.
2174−
2175−`category`
2176−: document category, included in docx and pptx metadata
2177−
2178−Additionally,
2179−any root-level string metadata, not included in ODT, docx
2180−or pptx metadata is added as a *custom property*.
2181−The following [YAML] metadata block for instance:
2182−
2183− ---
2184− title: 'This is the title'
2185− subtitle: "This is the subtitle"
2186− author:
2187− - Author One
2188− - Author Two
2189− description: |
2190− This is a long
2191− description.
2192−
2193− It consists of two paragraphs
2194− ...
2195−
2196−will include `title`, `author` and `description` as standard document
2197−properties and `subtitle` as a custom property when converting to docx,
2198−ODT or pptx.
2199−
2200−### Language variables
2201−
2202−`lang`
2203−: identifies the main language of the document using IETF language
2204− tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205− The [Language subtag lookup] tool can look up or verify these tags.
2206− This affects most formats, and controls hyphenation in PDF output
2207− when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2208−
2209− Use native pandoc [Divs and Spans] with the `lang` attribute to
2210− switch the language:
2211−
2212− ---
2213− lang: en-GB
2214− ...
2215−
2216− Text in the main document language (British English).
2217−
2218− ::: {lang=fr-CA}
2219− > Cette citation est écrite en français canadien.
2220− :::
2221−
2222− More text in English. ['Zitat auf Deutsch.']{lang=de}
2223−
2224−`dir`
2225−: the base script direction, either `rtl` (right-to-left)
2226− or `ltr` (left-to-right).
2227−
2228− For bidirectional documents, native pandoc `span`s and
2229− `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230− be used to override the base direction in some output
2231− formats. This may not always be necessary if the final
2232− renderer (e.g. the browser, when generating HTML) supports
2233− the [Unicode Bidirectional Algorithm].
2234−
2235− When using LaTeX for bidirectional documents, only the
2236− `xelatex` engine is fully supported (use
2237− `--pdf-engine=xelatex`).
2238−
2239−[BCP 47]: https://tools.ietf.org/html/bcp47
2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2241−[Language subtag lookup]: https://r12a.github.io/app-subtags/
2242−
2243−### Variables for HTML
2244−
2245−`document-css`
2246−: Enables inclusion of most of the [CSS] in the `styles.html`
2247− [partial](#partials) (have a look with
2248− `pandoc --print-default-data-file=templates/styles.html`).
2249− Unless you use [`--css`](#option--css), this variable
2250− is set to `true` by default. You can disable it with
2251− e.g. `pandoc -M document-css=false`.
2252−
2253−`mainfont`
2254−: sets the CSS `font-family` property on the `html` element.
2255−
2256−`fontsize`
2257−: sets the base CSS `font-size`, which you'd usually set
2258− to e.g. `20px`, but it also accepts `pt`
2259− (12pt = 16px in most browsers).
2260−
2261−`fontcolor`
2262−: sets the CSS `color` property on the `html` element.
2263−
2264−`linkcolor`
2265−: sets the CSS `color` property on all links.
2266−
2267−`monofont`
2268−: sets the CSS `font-family` property on `code` elements.
2269−
2270−`monobackgroundcolor`
2271−: sets the CSS `background-color` property on `code` elements
2272− and adds extra padding.
2273−
2274−`linestretch`
2275−: sets the CSS `line-height` property on the `html` element,
2276− which is preferred to be unitless.
2277−
2278−`backgroundcolor`
2279−: sets the CSS `background-color` property on the `html` element.
2280−
2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282−: sets the corresponding CSS `padding` properties on the `body` element.
2283−
2284−To override or extend some [CSS] for just one document, include for example:
2285−
2286− ---
2287− header-includes: |
2288− <style>
2289− blockquote {
2290− font-style: italic;
2291− }
2292− tr.even {
2293− background-color: #f0f0f0;
2294− }
2295− td, th {
2296− padding: 0.5em 2em 0.5em 0.5em;
2297− }
2298− tbody {
2299− border-bottom: none;
2300− }
2301− </style>
2302− ---
2303−
2304−[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305−
2306−### Variables for HTML math
2307−
2308−`classoption`
2309−: when using [KaTeX](#option--katex), you can render display
2310−math equations flush left using [YAML metadata](#layout) or with
2311−`-M classoption=fleqn`.
2312−
2313−### Variables for HTML slides
2314−
2315−These affect HTML output when [producing slide shows with pandoc].
2316−
2317−`institute`
2318−: author affiliations: can be a list when there are multiple authors
2319−
2320−`revealjs-url`
2321−: base URL for reveal.js documents (defaults to
2322− `https://unpkg.com/reveal.js@^4/`)
2323−
2324−`s5-url`
2325−: base URL for S5 documents (defaults to `s5/default`)
2326−
2327−`slidy-url`
2328−: base URL for Slidy documents (defaults to
2329− `https://www.w3.org/Talks/Tools/Slidy2`)
2330−
2331−`slideous-url`
2332−: base URL for Slideous documents (defaults to `slideous`)
2333−
2334−`title-slide-attributes`
2335−: additional attributes for the title slide of reveal.js slide shows.
2336− See [background in reveal.js and beamer] for an example.
2337−
2338−All [reveal.js configuration options] are available as variables.
2339−To turn off boolean flags that default to true in reveal.js, use `0`.
2340−
2341−[reveal.js configuration options]: https://revealjs.com/config/
2342−
2343−### Variables for Beamer slides
2344−
2345−These variables change the appearance of PDF slides using [`beamer`].
2346−
2347−`aspectratio`
2348−: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349− `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350− `32` for 3:2)
2351−
2352−`beamerarticle`
2353−: produce an article from Beamer slides
2354−
2355−`beameroption`
2356−: add extra beamer option with `\setbeameroption{}`
2357−
2358−`institute`
2359−: author affiliations: can be a list when there are multiple authors
2360−
2361−`logo`
2362−: logo image for slides
2363−
2364−`navigation`
2365−: controls navigation symbols (default is `empty` for no navigation
2366− symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367−
2368−`section-titles`
2369−: enables "title pages" for new sections (default is true)
2370−
2371−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372−: beamer themes
2373−
2374−`themeoptions`
2375−: options for LaTeX beamer themes (a list).
2376−
2377−`titlegraphic`
2378−: image for title slide
2379−
2380−### Variables for PowerPoint
2381−
2382−These variables control the visual aspects of a slide show that
2383−are not easily controlled via templates.
2384−
2385−`monofont`
2386−: font to use for code.
2387−
2388−### Variables for LaTeX
2389−
2390−Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2391−
2392−#### Layout
2393−
2394−`block-headings`
2395−: make `\paragraph` and `\subparagraph` (fourth- and
2396− fifth-level headings, or fifth- and sixth-level with book
2397− classes) free-standing rather than run-in; requires further
2398− formatting to distinguish from `\subsubsection` (third- or
2399− fourth-level headings). Instead of using this option,
2400− [KOMA-Script] can adjust headings more extensively:
2401−
2402− ---
2403− documentclass: scrartcl
2404− header-includes: |
2405− \RedeclareSectionCommand[
2406− beforeskip=-10pt plus -2pt minus -1pt,
2407− afterskip=1sp plus -1sp minus 1sp,
2408− font=\normalfont\itshape]{paragraph}
2409− \RedeclareSectionCommand[
2410− beforeskip=-10pt plus -2pt minus -1pt,
2411− afterskip=1sp plus -1sp minus 1sp,
2412− font=\normalfont\scshape,
2413− indent=0pt]{subparagraph}
2414− ...
2415−
2416−`classoption`
2417−: option for document class, e.g. `oneside`; repeat for multiple options:
2418−
2419− ---
2420− classoption:
2421− - twocolumn
2422− - landscape
2423− ...
2424−
2425−`documentclass`
2426−: document class: usually one of the standard classes,
2427− [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428− equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429− default to smaller margins; or [`memoir`]
2430−
2431−`geometry`
2432−: option for [`geometry`] package, e.g. `margin=1in`;
2433− repeat for multiple options:
2434−
2435− ---
2436− geometry:
2437− - top=30mm
2438− - left=20mm
2439− - heightrounded
2440− ...
2441−
2442−`hyperrefoptions`
2443−: option for [`hyperref`] package, e.g. `linktoc=all`;
2444− repeat for multiple options:
2445−
2446− ---
2447− hyperrefoptions:
2448− - linktoc=all
2449− - pdfwindowui
2450− - pdfpagemode=FullScreen
2451− ...
2452−
2453−`indent`
2454−: if true, pandoc will use document class settings for
2455− indentation (the default LaTeX template otherwise removes
2456− indentation and adds space between paragraphs)
2457−
2458−`linestretch`
2459−: adjusts line spacing using the [`setspace`]
2460− package, e.g. `1.25`, `1.5`
2461−
2462−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463−: sets margins if `geometry` is not used (otherwise `geometry`
2464− overrides these)
2465−
2466−`pagestyle`
2467−: control `\pagestyle{}`: the default article class
2468− supports `plain` (default), `empty` (no running heads or page numbers),
2469− and `headings` (section titles in running heads)
2470−
2471−`papersize`
2472−: paper size, e.g. `letter`, `a4`
2473−
2474−`secnumdepth`
2475−: numbering depth for sections (with `--number-sections` option
2476− or `numbersections` variable)
2477−
2478−#### Fonts
2479−
2480−`fontenc`
2481−: allows font encoding to be specified through `fontenc` package (with
2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483−
2484−`fontfamily`
2485−: font package for use with `pdflatex`:
2486− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487− The default is [Latin Modern][`lm`].
2488−
2489−`fontfamilyoptions`
2490−: options for package used as `fontfamily`; repeat for multiple options.
2491− For example, to use the Libertine font with proportional lowercase
2492− (old-style) figures through the [`libertinus`] package:
2493−
2494− ---
2495− fontfamily: libertinus
2496− fontfamilyoptions:
2497− - osf
2498− - p
2499− ...
2500−
2501−`fontsize`
2502−: font size for body text. The standard classes allow 10pt, 11pt, and
2503− 12pt. To use another size, set `documentclass` to one of
2504− the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2505−
2506−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2507−: font families for use with `xelatex` or
2508− `lualatex`: take the name of any system font, using the
2509− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2510−
2511−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2512−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2513− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2514− choices available through [`fontspec`]; repeat for multiple
2515− options. For example, to use the [TeX Gyre] version of
2516− Palatino with lowercase figures:
2517−
2518− ---
2519− mainfont: TeX Gyre Pagella
2520− mainfontoptions:
2521− - Numbers=Lowercase
2522− - Numbers=Proportional
2523− ...
2524−
2525−`microtypeoptions`
2526−: options to pass to the microtype package
2527−
2528−#### Links
2529−
2530−`colorlinks`
2531−: add color to link text; automatically enabled if any of
2532− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533−
2534−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535−: color for internal links, external links, citation links, linked
2536− URLs, and links in table of contents, respectively: uses options
2537− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538− `x11names` lists
2539−
2540−`links-as-notes`
2541−: causes links to be printed as footnotes
2542−
2543−#### Front matter
2544−
2545−`lof`, `lot`
2546−: include list of figures, list of tables
2547−
2548−`thanks`
2549−: contents of acknowledgments footnote after document title
2550−
2551−`toc`
2552−: include table of contents (can also be set using
2553− `--toc/--table-of-contents`)
2554−
2555−`toc-depth`
2556−: level of section to include in table of contents
2557−
2558−#### BibLaTeX Bibliographies
2559−
2560−These variables function when using BibLaTeX for [citation rendering].
2561−
2562−`biblatexoptions`
2563−: list of options for biblatex
2564−
2565−`biblio-style`
2566−: bibliography style, when used with `--natbib` and `--biblatex`.
2567−
2568−`biblio-title`
2569−: bibliography title, when used with `--natbib` and `--biblatex`.
2570−
2571−`bibliography`
2572−: bibliography to use for resolving references
2573−
2574−`natbiboptions`
2575−: list of options for natbib
2576−
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
2586−
2587−### Variables for ConTeXt
2588−
2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590−
2591−`fontsize`
2592−: font size for body text (e.g. `10pt`, `12pt`)
2593−
2594−`headertext`, `footertext`
2595−: text to be placed in running header or footer (see [ConTeXt Headers and
2596− Footers]); repeat up to four times for different placement
2597−
2598−`indenting`
2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600− [ConTeXt Indentation]); repeat for multiple options
2601−
2602−`interlinespace`
2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604− repeat for multiple options
2605−
2606−`layout`
2607−: options for page margins and text arrangement (see [ConTeXt Layout]);
2608− repeat for multiple options
2609−
2610−`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
2613−
2614−`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
2617−
2618−`lof`, `lot`
2619−: include list of figures, list of tables
2620−
2621−`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
2624−
2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626−: sets margins, if `layout` is not used (otherwise `layout`
2627− overrides these)
2628−
2629−`pagenumbering`
2630−: page number style and location (using [`setuppagenumbering`]);
2631− repeat for multiple options
2632−
2633−`papersize`
2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635− repeat for multiple options
2636−
2637−`pdfa`
2638−: adds to the preamble the setup necessary to generate PDF/A
2639− of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640− specified (i.e. the value is set to True, by e.g.
2641− `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642− `1b:2005` will be used as default, for reasons of backwards
2643− compatibility. Using `--variable=pdfa` without specified value
2644− is not supported. To successfully generate PDF/A the required
2645− ICC color profiles have to be available and the content and all
2646− included files (such as images) have to be standard conforming.
2647− The ICC profiles and output intent may be specified using the
2648− variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649− PDFA] for more details.
2650−
2651−`pdfaiccprofile`
2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654− used as default. May be repeated to include multiple profiles. Note that
2655− the profiles have to be available on the system. They can be obtained
2656− from [ConTeXt ICC Profiles].
2657−
2658−`pdfaintent`
2659−: when used in conjunction with `pdfa`, specifies the output intent for
2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.
2662−
2663−`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
2666−
2667−`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
2670−
2671−`includesource`
2672−: include all source documents as file attachments in the PDF file
2673−
2674−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677−[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2685−
2686−### Variables for `wkhtmltopdf`
2687−
2688−Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689−The `--css` option also affects the output.
2690−
2691−`footer-html`, `header-html`
2692−: add information to the header and footer
2693−
2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695−: set the page margins
2696−
2697−`papersize`
2698−: sets the PDF paper size
2699−
2700−### Variables for man pages
2701−
2702−`adjusting`
2703−: adjusts text to left (`l`), right (`r`), center (`c`),
2704− or both (`b`) margins
2705−
2706−`footer`
2707−: footer in man pages
2708−
2709−`header`
2710−: header in man pages
2711−
2712−`hyphenate`
2713−: if `true` (the default), hyphenation will be used
2714−
2715−`section`
2716−: section number in man pages
2717−
2718−### Variables for ms
2719−
2720−`fontfamily`
2721−: font family (e.g. `T` or `P`)
2722−
2723−`indent`
2724−: paragraph indent (e.g. `2m`)
2725−
2726−`lineheight`
2727−: line height (e.g. `12p`)
2728−
2729−`pointsize`
2730−: point size (e.g. `10p`)
2731−
2732−### Variables set automatically
2733−
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:
2737−
2738−`body`
2739−: body of document
2740−
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`).
2750−
2751−`header-includes`
2752−: contents specified by `-H/--include-in-header` (may have multiple
2753− values)
2754−
2755−`include-before`
2756−: contents specified by `-B/--include-before-body` (may have
2757− multiple values)
2758−
2759−`include-after`
2760−: contents specified by `-A/--include-after-body` (may have
2761− multiple values)
2762−
2763−`meta-json`
2764−: JSON representation of all of the document's metadata. Field
2765− values are transformed to the selected output format.
2766−
2767−`numbersections`
2768−: non-null value if `-N/--number-sections` was specified
2769−
2770−`sourcefile`, `outputfile`
2771−: source and destination filenames, as given on the command line.
2772− `sourcefile` can also be a list if input comes from multiple files,
2773− or empty if input is from stdin. You can use the following snippet in
2774− your template to distinguish them:
2775−
2776− $if(sourcefile)$
2777− $for(sourcefile)$
2778− $sourcefile$
2779− $endfor$
2780− $else$
2781− (stdin)
2782− $endif$
2783−
2784− Similarly, `outputfile` can be `-` if output goes to the terminal.
2785−
2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787−
2788−`curdir`
2789−: working directory from which pandoc is run.
2790−
2791−`toc`
2792−: non-null value if `--toc/--table-of-contents` was specified
2793−
2794−`toc-title`
2795−: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2797−
2798−[pandoc-templates]: https://github.com/jgm/pandoc-templates
2799−
2800−# Extensions
2801−
2802−The behavior of some of the readers and writers can be adjusted by
2803−enabling or disabling various extensions.
2804−
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.
2810−
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.
2816−
2817−Note that markdown extensions added to the `ipynb` format
2818−affect Markdown cells in Jupyter notebooks (as do command-line
2819−options like `--atx-headers`).
2820−
2821−## Typography
2822−
2823−#### Extension: `smart` ####
2824−
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."
2828−
2829−This extension can be enabled/disabled for the following formats:
2830−
2831−input formats
2832−: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2833−
2834−output formats
2835−: `markdown`, `latex`, `context`, `rst`
2836−
2837−enabled by default in
2838−: `markdown`, `latex`, `context` (both input and output)
2839−
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.
2843−
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.
2852−
2853−## Headings and sections
2854−
2855−#### Extension: `auto_identifiers` ####
2856−
2857−A heading without an explicitly specified identifier will be
2858−automatically assigned a unique identifier based on the heading text.
2859−
2860−This extension can be enabled/disabled for the following formats:
2861−
2862−input formats
2863−: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2864−
2865−output formats
2866−: `markdown`, `muse`
2867−
2868−enabled by default in
2869−: `markdown`, `muse`
2870−
2871−The default algorithm used to derive the identifier from the
2872−heading text is:
2873−
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`.
2883−
2884−Thus, for example,
2885−
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`
2894−
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.
2900−
2901−(However, a different algorithm is used if
2902−`gfm_auto_identifiers` is enabled; see below.)
2903−
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:
2908−
2909− See the section on
2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2911−
2912−Note, however, that this method of providing links to sections works
2913−only in HTML, LaTeX, and ConTeXt formats.
2914−
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.
2921−
2922−#### Extension: `ascii_identifiers` ####
1396+`documentclass`
1397+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
29231398
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.
1399+`classoption`
1400+: option for document class, e.g. `oneside`; may be repeated
1401+ for multiple options
29271402
2928−#### Extension: `gfm_auto_identifiers` ####
1403+`geometry`
1404+: option for [`geometry`] package, e.g. `margin=1in`;
1405+ may be repeated for multiple options
29291406
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.
1407+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1408+: sets margins, if `geometry` is not used (otherwise `geometry`
1409+ overrides these)
29351410
2936−## Math Input
1411+`linestretch`
1412+: adjusts line spacing using the [`setspace`]
1413+ package, e.g. `1.25`, `1.5`
29371414
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.
1415+`fontfamily`
1416+: font package for use with `pdflatex`:
1417+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1418+ The default is [Latin Modern][`lm`].
29421419
2943−However, they can also be used with HTML input. This is handy for
2944−reading web pages formatted using MathJax, for example.
1420+`fontfamilyoptions`
1421+: options for package used as `fontfamily`: e.g. `osf,sc` with
1422+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1423+ figures and true small caps; may be repeated for multiple options
29451424
2946−## Raw HTML/TeX
1425+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1426+: font families for use with `xelatex` or
1427+ `lualatex`: take the name of any system font, using the
1428+ [`fontspec`] package. Note that if `CJKmainfont` is used,
1429+ the [`xecjk`] package must be available.
29471430
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
1431+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1432+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1433+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1434+ available through [`fontspec`], such as the OpenType features
1435+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
29501436
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.
1437+`fontenc`
1438+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1439+ default is `T1` (see guide to [LaTeX font encodings])
29541440
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`):
1441+`microtypeoptions`
1442+: options to pass to the microtype package
29581443
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
1444+`colorlinks`
1445+: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1446+ `urlcolor`, or `toccolor` are set
29621447
2963− output formats
2964− : `textile`, `commonmark`
1448+`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1449+: color for internal links, citation links, external links, and links in table of contents:
1450+ uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
29651451
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`.
1452+`links-as-notes`
1453+: causes links to be printed as footnotes
29731454
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`.
1455+`indent`
1456+: uses document class settings for indentation (the default LaTeX template
1457+ otherwise removes indentation and adds space between paragraphs)
29781458
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`.
1459+`subparagraph`
1460+: disables default behavior of LaTeX template that redefines (sub)paragraphs
1461+ as sections, changing the appearance of nested headings in some classes
29851462
2986−## Literate Haskell support
1463+`thanks`
1464+: specifies contents of acknowledgments footnote after document title.
29871465
2988−#### Extension: `literate_haskell` ####
1466+`toc`
1467+: include table of contents (can also be set using `--toc/--table-of-contents`)
29891468
2990−Treat the document as literate Haskell source.
1469+`toc-depth`
1470+: level of section to include in table of contents
29911471
2992−This extension can be enabled/disabled for the following formats:
1472+`secnumdepth`
1473+: numbering depth for sections, if sections are numbered
29931474
2994−input formats
2995−: `markdown`, `rst`, `latex`
1475+`lof`, `lot`
1476+: include list of figures, list of tables
29961477
2997−output formats
2998−: `markdown`, `rst`, `latex`, `html`
1478+`bibliography`
1479+: bibliography to use for resolving references
29991480
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
1481+`biblio-style`
1482+: bibliography style, when used with `--natbib` and `--biblatex`.
30031483
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 '#'.
1484+`biblio-title`
1485+: bibliography title, when used with `--natbib` and `--biblatex`.
30081486
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.)
1487+`biblatexoptions`
1488+: list of options for biblatex.
30151489
3016− - In restructured text input, "bird track" sections will be parsed
3017− as Haskell code.
1490+`natbiboptions`
1491+: list of options for natbib.
30181492
3019− - In restructured text output, code blocks with class `haskell` will
3020− be rendered using bird tracks.
1493+[`article`]: https://ctan.org/pkg/article
1494+[`report`]: https://ctan.org/pkg/report
1495+[`book`]: https://ctan.org/pkg/book
1496+[KOMA-Script]: https://ctan.org/pkg/koma-script
1497+[`memoir`]: https://ctan.org/pkg/memoir
1498+[`xcolor`]: https://ctan.org/pkg/xcolor
1499+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1500+[`mathpazo`]: https://ctan.org/pkg/mathpazo
1501+[LaTeX font encodings]: https://ctan.org/pkg/encguide
30211502
3022− - In LaTeX input, text in `code` environments will be parsed as
3023− Haskell code.
1503+Variables for ConTeXt
1504+---------------------
30241505
3025− - In LaTeX output, code blocks with class `haskell` will be rendered
3026− inside `code` environments.
1506+`papersize`
1507+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1508+ may be repeated for multiple options
30271509
3028− - In HTML output, code blocks with class `haskell` will be rendered
3029− with class `literatehaskell` and bird tracks.
1510+`layout`
1511+: options for page margins and text arrangement (see [ConTeXt Layout]);
1512+ may be repeated for multiple options
30301513
3031−Examples:
1514+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1515+: sets margins, if `layout` is not used (otherwise `layout`
1516+ overrides these)
30321517
3033− pandoc -f markdown+lhs -t html
1518+`fontsize`
1519+: font size for body text (e.g. `10pt`, `12pt`)
30341520
3035−reads literate Haskell source formatted with Markdown conventions and writes
3036−ordinary HTML (without bird tracks).
1521+`mainfont`, `sansfont`, `monofont`, `mathfont`
1522+: font families: take the name of any system font (see [ConTeXt Font Switching])
30371523
3038− pandoc -f markdown+lhs -t html+lhs
1524+`linkcolor`, `contrastcolor`
1525+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
30391526
3040−writes HTML with the Haskell code in bird tracks, so it can be copied
3041−and pasted as literate Haskell source.
1527+`linkstyle`
1528+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
30421529
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.
1530+`indenting`
1531+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1532+ may be repeated for multiple options
30461533
3047−## Other extensions
1534+`whitespace`
1535+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
30481536
3049−#### Extension: `empty_paragraphs` ####
1537+`interlinespace`
1538+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1539+ may be repeated for multiple options
30501540
3051−Allows empty paragraphs. By default empty paragraphs are
3052−omitted.
1541+`headertext`, `footertext`
1542+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1543+ may be repeated up to four times for different placement
30531544
3054−This extension can be enabled/disabled for the following formats:
1545+`pagenumbering`
1546+: page number style and location (using [`setuppagenumbering`]);
1547+ may be repeated for multiple options
30551548
3056−input formats
3057−: `docx`, `html`
1549+`toc`
1550+: include table of contents (can also be set using `--toc/--table-of-contents`)
30581551
3059−output formats
3060−: `docx`, `odt`, `opendocument`, `html`
1552+`lof`, `lot`
1553+: include list of figures, list of tables
30611554
3062−#### Extension: `native_numbering` ####
1555+[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1556+[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1557+[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1558+[ConTeXt Color]: http://wiki.contextgarden.net/Color
1559+[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1560+[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1561+[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1562+[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1563+[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
30631564
3064−Enables native numbering of figures and tables. Enumeration
3065−starts at 1.
1565+Variables for man pages
1566+-----------------------
30661567
3067−This extension can be enabled/disabled for the following formats:
1568+`section`
1569+: section number in man pages
30681570
3069−output formats
3070−: `odt`, `opendocument`
1571+`header`
1572+: header in man pages
30711573
3072−#### Extension: `xrefs_name` ####
1574+`footer`
1575+: footer in man pages
30731576
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.
1577+`adjusting`
1578+: adjusts text to left (`l`), right (`r`), center (`c`),
1579+ or both (`b`) margins
30801580
3081−Text in cross-references is only made consistent with the referenced
3082−item once the document has been refreshed.
1581+`hyphenate`
1582+: if `true` (the default), hyphenation will be used
30831583
3084−This extension can be enabled/disabled for the following formats:
1584+Variables for ms
1585+----------------
30851586
3086−output formats
3087−: `odt`, `opendocument`
1587+`pointsize`
1588+: point size (e.g. `10p`)
30881589
3089−#### Extension: `xrefs_number` ####
1590+`lineheight`
1591+: line height (e.g. `12p`)
30901592
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.
1593+`fontfamily`
1594+: font family (e.g. `T` or `P`)
30961595
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.
1596+`indent`
1597+: paragraph indent (e.g. `2m`)
31001598
3101−Numbers in cross-references are only visible in the final document once
3102−it has been refreshed.
1599+Using variables in templates
1600+----------------------------
31031601
3104−This extension can be enabled/disabled for the following formats:
1602+Variable names are sequences of alphanumerics, `-`, and `_`,
1603+starting with a letter. A variable name surrounded by `$` signs
1604+will be replaced by its value. For example, the string `$title$` in
31051605
3106−output formats
3107−: `odt`, `opendocument`
1606+ <title>$title$</title>
31081607
3109−#### Extension: `styles` #### {#ext-styles}
1608+will be replaced by the document title.
31101609
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.
1610+To write a literal `$` in a template, use `$$`.
31161611
3117−input formats
3118−: `docx`
1612+Templates may contain conditionals. The syntax is as follows:
31191613
3120−#### Extension: `amuse` ####
1614+ $if(variable)$
1615+ X
1616+ $else$
1617+ Y
1618+ $endif$
31211619
3122−In the `muse` input format, this enables Text::Amuse
3123−extensions to Emacs Muse markup.
1620+This will include `X` in the template if `variable` has a non-null
1621+value; otherwise it will include `Y`. `X` and `Y` are placeholders for
1622+any valid template text, and may include interpolated variables or other
1623+conditionals. The `$else$` section may be omitted.
31241624
3125−#### Extension: `raw_markdown` ####
1625+When variables can have multiple values (for example, `author` in
1626+a multi-author document), you can use the `$for$` keyword:
31261627
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.
1628+ $for(author)$
1629+ <meta name="author" content="$author$" />
1630+ $endfor$
31321631
3133−#### Extension: `citations` {#org-citations}
1632+You can optionally specify a separator to be used between
1633+consecutive items:
31341634
3135−Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136−are also accepted in `org` input.
1635+ $for(author)$$author$$sep$, $endfor$
31371636
3138−#### Extension: `element_citations` ####
1637+A dot can be used to select a field of a variable that takes
1638+an object as its value. So, for example:
31391639
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.
1640+ $author.name$ ($author.affiliation$)
31441641
3145−#### Extension: `ntb` ####
1642+If you use custom templates, you may need to revise them as pandoc
1643+changes. We recommend tracking the changes in the default templates,
1644+and modifying your custom templates accordingly. An easy way to do this
1645+is to fork the [pandoc-templates] repository and merge in changes after each
1646+pandoc release.
31461647
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.
1648+Templates may contain comments: anything on a line after `$--`
1649+will be treated as a comment and ignored.
31521650
1651+[pandoc-templates]: https://github.com/jgm/pandoc-templates
31531652
3154−# Pandoc's Markdown
1653+Pandoc's Markdown
1654+=================
31551655
31561656Pandoc understands an extended and slightly revised version of
31571657John Gruber's [Markdown] syntax. This document explains the syntax,
31581658noting differences from standard Markdown. Except where noted, these
31591659differences 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.
1660+of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1661+to the format name and disabled by adding `-EXTENSION`. For example,
1662+`markdown_strict+footnotes` is strict Markdown with footnotes
1663+enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1664+Markdown without footnotes or pipe tables.
31631665
3164−## Philosophy
1666+Philosophy
1667+----------
31651668
31661669Markdown is designed to be easy to write, and, even more importantly,
31671670easy to read:
@@ -3169,7 +1672,7 @@ easy to read:
31691672> A Markdown-formatted document should be publishable as-is, as plain
31701673> text, without looking like it's been marked up with tags or formatting
31711674> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
1675+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
31731676
31741677This principle has guided pandoc's decisions in finding syntax for
31751678tables, footnotes, and other extensions.
@@ -3182,7 +1685,8 @@ it discourages it, and provides other, non-HTMLish ways of representing
31821685important document elements like definition lists, tables, mathematics, and
31831686footnotes.
31841687
3185−## Paragraphs
1688+Paragraphs
1689+----------
31861690
31871691A paragraph is one or more lines of text followed by one or more blank lines.
31881692Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -3195,42 +1699,43 @@ Note: in multiline and grid table cells, this is the only way
31951699to create a hard line break, since trailing spaces in the cells
31961700are ignored.
31971701
3198−## Headings
1702+Headers
1703+-------
31991704
3200−There are two kinds of headings: Setext and ATX.
1705+There are two kinds of headers: Setext and ATX.
32011706
3202−### Setext-style headings ###
1707+### Setext-style headers ###
32031708
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):
1709+A setext-style header is a line of text "underlined" with a row of `=` signs
1710+(for a level one header) or `-` signs (for a level two header):
32061711
3207− A level-one heading
3208− ===================
1712+ A level-one header
1713+ ==================
32091714
3210− A level-two heading
3211− -------------------
1715+ A level-two header
1716+ ------------------
32121717
3213−The heading text can contain inline formatting, such as emphasis (see
1718+The header text can contain inline formatting, such as emphasis (see
32141719[Inline formatting], below).
32151720
32161721
3217−### ATX-style headings ###
1722+### ATX-style headers ###
32181723
3219−An ATX-style heading consists of one to six `#` signs and a line of
1724+An ATX-style header consists of one to six `#` signs and a line of
32201725text, optionally followed by any number of `#` signs. The number of
3221−`#` signs at the beginning of the line is the heading level:
1726+`#` signs at the beginning of the line is the header level:
32221727
3223− ## A level-two heading
1728+ ## A level-two header
32241729
3225− ### A level-three heading ###
1730+ ### A level-three header ###
32261731
3227−As with setext-style headings, the heading text can contain formatting:
1732+As with setext-style headers, the header text can contain formatting:
32281733
3229− # A level-one heading with a [link](/url) and *emphasis*
1734+ # A level-one header with a [link](/url) and *emphasis*
32301735
32311736#### Extension: `blank_before_header` ####
32321737
3233−Standard Markdown syntax does not require a blank line before a heading.
1738+Standard Markdown syntax does not require a blank line before a header.
32341739Pandoc does require this (except, of course, at the beginning of the
32351740document). The reason for the requirement is that it is all too easy for a
32361741`#` to end up at the beginning of a line by accident (perhaps through line
@@ -3242,30 +1747,27 @@ wrapping). Consider, for example:
32421747#### Extension: `space_in_atx_header` ####
32431748
32441749Many 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,
1750+opening `#`s of an ATX header and the header text, so that
1751+`#5 bolt` and `#hashtag` count as headers. With this extension,
32471752pandoc does require the space.
32481753
3249−### Heading identifiers ###
3250−
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
1754+### Header identifiers ###
32531755
32541756#### Extension: `header_attributes` ####
32551757
3256−Headings can be assigned attributes using this syntax at the end
3257−of the line containing the heading text:
1758+Headers can be assigned attributes using this syntax at the end
1759+of the line containing the header text:
32581760
32591761 {#identifier .class .class key=value key=value}
32601762
3261−Thus, for example, the following headings will all be assigned the identifier
1763+Thus, for example, the following headers will all be assigned the identifier
32621764`foo`:
32631765
3264− # My heading {#foo}
1766+ # My header {#foo}
32651767
3266− ## My heading ## {#foo}
1768+ ## My header ## {#foo}
32671769
3268− My other heading {#foo}
1770+ My other header {#foo}
32691771 ---------------
32701772
32711773(This syntax is compatible with [PHP Markdown Extra].)
@@ -3274,56 +1776,100 @@ Note that although this syntax allows assignment of classes and key/value
32741776attributes, writers generally don't use all of this information. Identifiers,
32751777classes, and key/value attributes are used in HTML and HTML-based formats such
32761778as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
1779+LaTeX, ConTeXt, Textile, and AsciiDoc writers.
32781780
3279−Headings with the class `unnumbered` will not be numbered, even if
1781+Headers with the class `unnumbered` will not be numbered, even if
32801782`--number-sections` is specified. A single hyphen (`-`) in an attribute
32811783context is equivalent to `.unnumbered`, and preferable in non-English
32821784documents. So,
32831785
3284− # My heading {-}
1786+ # My header {-}
32851787
32861788is just the same as
32871789
3288− # My heading {.unnumbered}
1790+ # My header {.unnumbered}
1791+
1792+#### Extension: `auto_identifiers` ####
1793+
1794+A header without an explicitly specified identifier will be
1795+automatically assigned a unique identifier based on the header text.
1796+To derive the identifier from the header text,
1797+
1798+ - Remove all formatting, links, etc.
1799+ - Remove all footnotes.
1800+ - Remove all punctuation, except underscores, hyphens, and periods.
1801+ - Replace all spaces and newlines with hyphens.
1802+ - Convert all alphabetic characters to lowercase.
1803+ - Remove everything up to the first letter (identifiers may
1804+ not begin with a number or punctuation mark).
1805+ - If nothing is left after this, use the identifier `section`.
1806+
1807+Thus, for example,
1808+
1809+ Header Identifier
1810+ ------------------------------- ----------------------------
1811+ `Header identifiers in HTML` `header-identifiers-in-html`
1812+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
1813+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1814+ `3. Applications` `applications`
1815+ `33` `section`
1816+
1817+These rules should, in most cases, allow one to determine the identifier
1818+from the header text. The exception is when several headers have the
1819+same text; in this case, the first will get an identifier as described
1820+above; the second will get the same identifier with `-1` appended; the
1821+third with `-2`; and so on.
1822+
1823+These identifiers are used to provide link targets in the table of
1824+contents generated by the `--toc|--table-of-contents` option. They
1825+also make it easy to provide links from one section of a document to
1826+another. A link to this section, for example, might look like this:
1827+
1828+ See the section on
1829+ [header identifiers](#header-identifiers-in-html-latex-and-context).
1830+
1831+Note, however, that this method of providing links to sections works
1832+only in HTML, LaTeX, and ConTeXt formats.
32891833
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.)
1834+If the `--section-divs` option is specified, then each section will
1835+be wrapped in a `div` (or a `section`, if `html5` was specified),
1836+and the identifier will be attached to the enclosing `<div>`
1837+(or `<section>`) tag rather than the header itself. This allows entire
1838+sections to be manipulated using JavaScript or treated differently in
1839+CSS.
32941840
32951841#### Extension: `implicit_header_references` ####
32961842
3297−Pandoc behaves as if reference links have been defined for each heading.
3298−So, to link to a heading
1843+Pandoc behaves as if reference links have been defined for each header.
1844+So, to link to a header
32991845
3300− # Heading identifiers in HTML
1846+ # Header identifiers in HTML
33011847
33021848you can simply write
33031849
3304− [Heading identifiers in HTML]
1850+ [Header identifiers in HTML]
33051851
33061852or
33071853
3308− [Heading identifiers in HTML][]
1854+ [Header identifiers in HTML][]
33091855
33101856or
33111857
3312− [the section on heading identifiers][heading identifiers in
1858+ [the section on header identifiers][header identifiers in
33131859 HTML]
33141860
33151861instead of giving the identifier explicitly:
33161862
3317− [Heading identifiers in HTML](#heading-identifiers-in-html)
1863+ [Header identifiers in HTML](#header-identifiers-in-html)
33181864
3319−If there are multiple headings with identical text, the corresponding
1865+If there are multiple headers with identical text, the corresponding
33201866reference will link to the first one only, and you will need to use explicit
33211867links to link to the others, as described above.
33221868
33231869Like regular reference links, these references are case-insensitive.
33241870
33251871Explicit link reference definitions always take priority over
3326−implicit heading references. So, in the following example, the
1872+implicit header references. So, in the following example, the
33271873link will point to `bar`, not to `#foo`:
33281874
33291875 # Foo
@@ -3332,11 +1878,12 @@ link will point to `bar`, not to `#foo`:
33321878
33331879 See [foo]
33341880
3335−## Block quotations
1881+Block quotations
1882+----------------
33361883
33371884Markdown uses email conventions for quoting blocks of text.
33381885A block quotation is one or more paragraphs or other block elements
3339−(such as lists or headings), with each line preceded by a `>` character
1886+(such as lists or headers), with each line preceded by a `>` character
33401887and an optional space. (The `>` need not start at the left margin, but
33411888it should not be indented more than three spaces.)
33421889
@@ -3371,19 +1918,19 @@ block in a block quote, you need five spaces after the `>`:
33711918
33721919#### Extension: `blank_before_blockquote` ####
33731920
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
1921+Standard Markdown syntax does not require a blank line before a block
1922+quote. Pandoc does require this (except, of course, at the beginning of the
1923+document). The reason for the requirement is that it is all too easy for a
1924+`>` to end up at the beginning of a line by accident (perhaps through line
1925+wrapping). So, unless the `markdown_strict` format is used, the following does
33801926not produce a nested block quote in pandoc:
33811927
33821928 > This is a block quote.
33831929 >> Nested.
33841930
33851931
3386−## Verbatim (code) blocks
1932+Verbatim (code) blocks
1933+----------------------
33871934
33881935### Indented code blocks ###
33891936
@@ -3445,16 +1992,14 @@ this syntax:
34451992 qsort (filter (>= x) xs)
34461993 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34471994
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:
1995+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
1996+`startFrom` is an attribute with value `100`. Some output formats can use this
1997+information to do syntax highlighting. Currently, the only output formats
1998+that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
1999+is supported for your output format and language, then the code block above
2000+will appear highlighted, with numbered lines. (To see which languages are
2001+supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
2002+block above will appear as follows:
34582003
34592004 <pre id="mycode" class="haskell numberLines" startFrom="100">
34602005 <code>
@@ -3462,12 +2007,6 @@ will appear as follows:
34622007 </code>
34632008 </pre>
34642009
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−
34712010A shortcut form can also be used for specifying the language of
34722011the code block:
34732012
@@ -3491,7 +2030,8 @@ To set the highlighting style, use `--highlight-style`.
34912030For more information on highlighting, see [Syntax highlighting],
34922031below.
34932032
3494−## Line blocks
2033+Line blocks
2034+-----------
34952035
34962036#### Extension: `line_blocks` ####
34972037
@@ -3517,12 +2057,10 @@ line must begin with a space.
35172057 | 200 Main St.
35182058 | Berkeley, CA 94718
35192059
3520−Inline formatting (such as emphasis) is allowed in the content,
3521−but not block-level formatting (such as block quotes or lists).
3522−
35232060This syntax is borrowed from [reStructuredText].
35242061
3525−## Lists
2062+Lists
2063+-----
35262064
35272065### Bullet lists ###
35282066
@@ -3692,12 +2230,6 @@ If default list markers are desired, use `#.`:
36922230 #. two
36932231 #. three
36942232
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
37012233
37022234### Definition lists ###
37032235
@@ -3723,12 +2255,11 @@ a blank line, and must be followed by one or more definitions.
37232255A definition begins with a colon or tilde, which may be indented one
37242256or two spaces.
37252257
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
2258+A term may have multiple definitions, and each definition may consist of one or
2259+more block elements (paragraph, code block, list, etc.), each indented four
2260+spaces or one tab stop. The body of the definition (including the first line,
2261+aside from the colon or tilde) should be indented four spaces. However,
2262+as with other Markdown lists, you can "lazily" omit indentation except
37322263at the beginning of a paragraph or other block element:
37332264
37342265 Term 1
@@ -3754,10 +2285,9 @@ definition:
37542285Note that space between items in a definition list is required.
37552286(A variant that loosens this requirement, but disallows "lazy"
37562287hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2288+[Non-pandoc extensions], below.)
37582289
3759−[^3]: I have been influenced by the suggestions of [David
3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2290+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
37612291
37622292### Numbered example lists ###
37632293
@@ -3786,12 +2316,30 @@ document:
37862316The label can be any string of alphanumeric characters, underscores,
37872317or hyphens.
37882318
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.
2319+
2320+### Compact and loose lists ###
2321+
2322+Pandoc behaves differently from `Markdown.pl` on some "edge
2323+cases" involving lists. Consider this source:
2324+
2325+ + First
2326+ + Second:
2327+ - Fee
2328+ - Fie
2329+ - Foe
2330+
2331+ + Third
2332+
2333+Pandoc transforms this into a "compact list" (with no `<p>` tags around
2334+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2335+"Second" and "Third" (but not "First"), because of the blank space
2336+around "Third". Pandoc follows a simple rule: if the text is followed by
2337+a blank line, it is treated as a paragraph. Since "Second" is followed
2338+by a list, and not a blank line, it isn't treated as a paragraph. The
2339+fact that the list is followed by a blank line is irrelevant. (Note:
2340+Pandoc works this way even when the `markdown_strict` format is specified. This
2341+behavior is consistent with the official Markdown syntax description,
2342+even though it is different from that of `Markdown.pl`.)
37952343
37962344
37972345### Ending a list ###
@@ -3831,7 +2379,8 @@ of one big list:
38312379 2. dos
38322380 3. tres
38332381
3834−## Horizontal rules
2382+Horizontal rules
2383+----------------
38352384
38362385A line containing a row of three or more `*`, `-`, or `_` characters
38372386(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +2390,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
38412390 ---------------
38422391
38432392
3844−## Tables
2393+Tables
2394+------
38452395
38462396Four kinds of tables may be used. The first three kinds presuppose the use of
38472397a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3866,7 +2416,7 @@ Simple tables look like this:
38662416
38672417 Table: Demonstration of simple table syntax.
38682418
3869−The header and table rows must each fit on one line. Column
2419+The headers and table rows must each fit on one line. Column
38702420alignments are determined by the position of the header text relative
38712421to the dashed line below it:[^4]
38722422
@@ -3885,7 +2435,7 @@ to the dashed line below it:[^4]
38852435The table must end with a blank line, or a line of dashes followed by
38862436a blank line.
38872437
3888−The column header row may be omitted, provided a dashed line is used
2438+The column headers may be omitted, provided a dashed line is used
38892439to end the table. For example:
38902440
38912441 ------- ------ ---------- -------
@@ -3894,13 +2444,13 @@ to end the table. For example:
38942444 1 1 1 1
38952445 ------- ------ ---------- -------
38962446
3897−When the header row is omitted, column alignments are determined on the basis
2447+When headers are omitted, column alignments are determined on the basis
38982448of the first line of the table body. So, in the tables above, the columns
38992449would be right, left, center, and right aligned, respectively.
39002450
39012451#### Extension: `multiline_tables` ####
39022452
3903−Multiline tables allow header and table rows to span multiple lines
2453+Multiline tables allow headers and table rows to span multiple lines
39042454of text (but cells that span multiple columns or rows of the table are
39052455not supported). Here is an example:
39062456
@@ -3922,7 +2472,7 @@ not supported). Here is an example:
39222472These work like simple tables, but with the following differences:
39232473
39242474 - They must begin with a row of dashes, before the header text
3925− (unless the header row is omitted).
2475+ (unless the headers are omitted).
39262476 - They must end with a row of dashes, then a blank line.
39272477 - The rows must be separated by blank lines.
39282478
@@ -3931,7 +2481,7 @@ the columns, and the writers try to reproduce these relative widths in
39312481the output. So, if you find that one of the columns is too narrow in the
39322482output, try widening it in the Markdown source.
39332483
3934−The header may be omitted in multiline tables as well as simple tables:
2484+Headers may be omitted in multiline tables as well as simple tables:
39352485
39362486 ----------- ------- --------------- -------------------------
39372487 First row 12.0 Example of a row that
@@ -3942,7 +2492,7 @@ The header may be omitted in multiline tables as well as simple tables:
39422492 rows.
39432493 ----------- ------- --------------- -------------------------
39442494
3945− : Here's a multiline table without a header.
2495+ : Here's a multiline table without headers.
39462496
39472497It is possible for a multiline table to have just one row, but the row
39482498should be followed by a blank line (and then the row of dashes that ends
@@ -3968,8 +2518,9 @@ The row of `=`s separates the header from the table body, and can be
39682518omitted for a headerless table. The cells of grid tables may contain
39692519arbitrary block elements (multiple paragraphs, code blocks, lists,
39702520etc.). 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`).
2521+supported. Grid tables can be created easily using [Emacs table mode].
2522+
2523+[Emacs table mode]: http://table.sourceforge.net/
39732524
39742525Alignments can be specified as with pipe tables, by putting
39752526colons at the boundaries of the separator line after the
@@ -3997,7 +2548,7 @@ and the same number of rows in each column. For example, the
39972548Docutils [sample grid tables] will not render as expected with
39982549Pandoc.
39992550
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2551+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
40012552
40022553
40032554#### Extension: `pipe_tables` ####
@@ -4030,15 +2581,10 @@ legal (though ugly) pipe table:
40302581
40312582The cells of pipe tables cannot contain block elements like paragraphs
40322583and 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.
2584+row whose printable content is wider than the column width (see
2585+`--columns`), then the cell contents will wrap, with the
2586+relative cell widths determined by the widths of the separator
2587+lines.
40422588
40432589Note: pandoc also recognizes pipe tables of the following
40442590form, as can be produced by Emacs' orgtbl-mode:
@@ -4054,7 +2600,8 @@ you'll need to add colons as above.
40542600
40552601[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
40562602
4057−## Metadata blocks
2603+Metadata blocks
2604+---------------
40582605
40592606#### Extension: `pandoc_title_block` ####
40602607
@@ -4070,42 +2617,30 @@ output.) The block may contain just a title, a title and an author,
40702617or all three elements. If you want to include an author but no
40712618title, or a title and a date but no author, you need a blank line:
40722619
4073−```
4074−%
4075−% Author
4076−```
2620+ %
2621+ % Author
40772622
4078−```
4079−% My title
4080−%
4081−% June 15, 2006
4082−```
2623+ % My title
2624+ %
2625+ % June 15, 2006
40832626
40842627The title may occupy multiple lines, but continuation lines must
40852628begin with leading space, thus:
40862629
4087−```
4088−% My title
4089− on multiple lines
4090−```
2630+ % My title
2631+ on multiple lines
40912632
40922633If a document has multiple authors, the authors may be put on
40932634separate lines with leading space, or separated by semicolons, or
40942635both. So, all of the following are equivalent:
40952636
4096−```
4097−% Author One
4098− Author Two
4099−```
2637+ % Author One
2638+ Author Two
41002639
4101−```
4102−% Author One; Author Two
4103−```
2640+ % Author One; Author Two
41042641
4105−```
4106−% Author One;
4107− Author Two
4108−```
2642+ % Author One;
2643+ Author Two
41092644
41102645The date must fit on one line.
41112646
@@ -4146,7 +2681,7 @@ will also have "Version 4.0" in the header.
41462681
41472682#### Extension: `yaml_metadata_block` ####
41482683
4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three
2684+A YAML metadata block is a valid YAML object, delimited by a line of three
41502685hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
41512686(`...`) at the bottom. A YAML metadata block may occur anywhere in the
41522687document, but if it is not at the beginning, it must be preceded by a blank
@@ -4157,53 +2692,41 @@ and pass it to pandoc as an argument, along with your Markdown files:
41572692 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
41582693
41592694Just 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.
2695+`...`.)
41632696
41642697Metadata will be taken from the fields of the YAML object and added to any
41652698existing document metadata. Metadata can contain lists and objects (nested
41662699arbitrarily), but all string scalars will be interpreted as Markdown. Fields
41672700with 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).
2701+given a role by external processors.)
41712702
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.
2703+A document may contain multiple metadata blocks. The metadata fields will
2704+be combined through a *left-biased union*: if two metadata blocks attempt
2705+to set the same field, the value from the first block will be taken.
41752706
41762707When pandoc is used with `-t markdown` to create a Markdown document,
41772708a YAML metadata block will be produced only if the `-s/--standalone`
41782709option is used. All of the metadata will appear in a single block
41792710at the beginning of the document.
41802711
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:
2712+Note that YAML escaping rules must be followed. Thus, for example,
2713+if a title contains a colon, it must be quoted. The pipe character
2714+(`|`) can be used to begin an indented block that will be interpreted
2715+literally, without need for escaping. This form is necessary
2716+when the field contains blank lines or block-level formatting:
41882717
41892718 ---
41902719 title: 'This is the title: it contains a colon'
41912720 author:
41922721 - Author One
41932722 - Author Two
4194− keywords: [nothing, nothingness]
2723+ tags: [nothing, nothingness]
41952724 abstract: |
41962725 This is the abstract.
41972726
41982727 It consists of two paragraphs.
41992728 ...
42002729
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−
42072730Template variables will be set automatically from the metadata. Thus, for
42082731example, in writing HTML, the variable `abstract` will be set to the HTML
42092732equivalent of the Markdown in the `abstract` field:
@@ -4237,38 +2760,9 @@ template:
42372760 $endif$
42382761 $endfor$
42392762
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:
42572763
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
2764+Backslash escapes
2765+-----------------
42722766
42732767#### Extension: `all_symbols_escapable` ####
42742768
@@ -4294,12 +2788,9 @@ which allows only the following characters to be backslash-escaped:
42942788(However, if the `markdown_strict` format is used, the standard Markdown rule
42952789will be used.)
42962790
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).
2791+A backslash-escaped space is parsed as a nonbreaking space. It will
2792+appear in TeX output as `~` and in HTML and XML as `\ ` or
2793+`\ `.
43032794
43042795A backslash-escaped newline (i.e. a backslash occurring at the end of
43052796a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +2800,8 @@ two trailing spaces on a line.
43092800
43102801Backslash escapes do not work in verbatim contexts.
43112802
4312−## Inline formatting
2803+Inline formatting
2804+-----------------
43132805
43142806### Emphasis ###
43152807
@@ -4357,13 +2849,12 @@ text by `~` characters. Thus, for example,
43572849
43582850 H~2~O is a liquid. 2^10^ is 1024.
43592851
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~`.
2852+If the superscripted or subscripted text contains spaces, these spaces
2853+must be escaped with backslashes. (This is to prevent accidental
2854+superscripting and subscripting through the ordinary use of `~` and `^`.)
2855+Thus, if you want the letter P with 'a cat' in subscripts, use
2856+`P~a\ cat~`, not `P~a cat~`.
2857+
43672858
43682859### Verbatim ###
43692860
@@ -4397,22 +2888,19 @@ Attributes can be attached to verbatim text, just as with
43972888
43982889### Small caps ###
43992890
4400−To write small caps, use the `smallcaps` class:
4401−
4402− [Small caps]{.smallcaps}
4403−
4404−Or, without the `bracketed_spans` extension:
4405−
4406− <span class="smallcaps">Small caps</span>
4407−
4408−For compatibility with other Markdown flavors, CSS is also supported:
2891+To write small caps, you can use an HTML span tag:
44092892
44102893 <span style="font-variant:small-caps;">Small caps</span>
44112894
4412−This will work in all output formats that support small caps.
2895+(The semicolon is optional and there may be space after the
2896+colon.) This will work in all output formats that support small caps.
44132897
2898+Alternatively, you can also use the new `bracketed_spans` syntax:
44142899
4415−## Math
2900+ [Small caps]{style="font-variant:small-caps;"}
2901+
2902+Math
2903+----
44162904
44172905#### Extension: `tex_math_dollars` ####
44182906
@@ -4424,38 +2912,22 @@ left, and must not be followed immediately by a digit. Thus,
44242912you need to enclose text in literal `$` characters, backslash-escape
44252913them and they won't be treated as math delimiters.
44262914
4427−For display math, use `$$` delimiters. (In this case, the delimiters
4428−may be separated from the formula by whitespace. However, there can be
4429−no blank lines betwen the opening and closing `$$` delimiters.)
4430−
44312915TeX math will be printed in all output formats. How it is rendered
44322916depends on the output format:
44332917
4434−LaTeX
4435− ~ It will appear verbatim surrounded by `\(...\)` (for inline
4436− math) or `\[...\]` (for display math).
4437−
4438−Markdown, Emacs Org mode, ConTeXt, ZimWiki
4439− ~ It will appear verbatim surrounded by `$...$` (for inline
4440− math) or `$$...$$` (for display math).
4441−
4442−XWiki
4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
2918+Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
2919+ ~ It will appear verbatim between `$` characters.
44442920
44452921reStructuredText
44462922 ~ It will be rendered using an [interpreted text role `:math:`].
44472923
44482924AsciiDoc
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.
2925+ ~ It will be rendered as `latexmath:[...]`.
44542926
44552927Texinfo
44562928 ~ It will be rendered inside a `@math` command.
44572929
4458−roff man, Jira markup
2930+groff man
44592931 ~ It will be rendered verbatim without `$`'s.
44602932
44612933MediaWiki, DokuWiki
@@ -4486,12 +2958,58 @@ FictionBook2
44862958
44872959HTML, Slidy, DZSlides, S5, EPUB
44882960 ~ The way math is rendered in HTML will depend on the
4489− command-line options selected. Therefore see [Math rendering in HTML]
4490− above.
4491−
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
4493−
4494−## Raw HTML
2961+ command-line options selected:
2962+
2963+ 1. The default is to render TeX math as far as possible using Unicode
2964+ characters, as with RTF, DocBook, and OpenDocument output. Formulas
2965+ are put inside a `span` with `class="math"`, so that they may be
2966+ styled differently from the surrounding text if needed.
2967+
2968+ 2. If the `--latexmathml` option is used, TeX math will be displayed
2969+ between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2970+ The [LaTeXMathML] script will be used to render it as formulas.
2971+ (This trick does not work in all browsers, but it works in Firefox.
2972+ In browsers that do not support LaTeXMathML, TeX math will appear
2973+ verbatim between `$` characters.)
2974+
2975+ 3. If the `--jsmath` option is used, TeX math will be put inside
2976+ `<span>` tags (for inline math) or `<div>` tags (for display math)
2977+ with class `math`. The [jsMath] script will be used to render
2978+ it.
2979+
2980+ 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2981+ be called to generate images for each TeX formula. This should
2982+ work in all browsers. The `--mimetex` option takes an optional URL
2983+ as argument. If no URL is specified, it will be assumed that the
2984+ mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2985+
2986+ 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2987+ in `<eq>` tags in the HTML output. The resulting `htex` file may then
2988+ be processed by [gladTeX], which will produce image files for each
2989+ formula and an HTML file with links to these images. So, the
2990+ procedure is:
2991+
2992+ pandoc -s --gladtex myfile.txt -o myfile.htex
2993+ gladtex -d myfile-images myfile.htex
2994+ # produces myfile.html and images in myfile-images
2995+
2996+ 6. If the `--webtex` option is used, TeX formulas will be converted
2997+ to `<img>` tags that link to an external script that converts
2998+ formulas to images. The formula will be URL-encoded and concatenated
2999+ with the URL provided. For SVG images you can for example use
3000+ `--webtex https://latex.codecogs.com/svg.latex?`.
3001+ If no URL is specified, the CodeCogs URL generating PNGs
3002+ will be used (`https://latex.codecogs.com/png.latex?`).
3003+
3004+ 7. If the `--mathjax` option is used, TeX math will be displayed
3005+ between `\(...\)` (for inline math) or `\[...\]` (for display
3006+ math) and put in `<span>` tags with class `math`.
3007+ The [MathJax] script will be used to render it as formulas.
3008+
3009+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
3010+
3011+Raw HTML
3012+--------
44953013
44963014#### Extension: `raw_html` ####
44973015
@@ -4502,17 +3020,8 @@ Markdown allows it, but it has been made an extension so that it can
45023020be disabled if desired.)
45033021
45043022The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4505−DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4506−output, and suppressed in other formats.
4507−
4508−For a more explicit way of including raw HTML in a Markdown
4509−document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4510−
4511−In the CommonMark format, if `raw_html` is enabled, superscripts,
4512−subscripts, strikeouts and small capitals will be represented as HTML.
4513−Otherwise, plain-text fallbacks will be used. Note that even if
4514−`raw_html` is disabled, tables will be rendered with HTML syntax if
4515−they cannot use pipe syntax.
3023+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3024+in other formats.
45163025
45173026#### Extension: `markdown_in_html_blocks` ####
45183027
@@ -4529,7 +3038,7 @@ Thus, for example, pandoc will turn
45293038 <table>
45303039 <tr>
45313040 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3041+ <td>[a link](http://google.com)</td>
45333042 </tr>
45343043 </table>
45353044
@@ -4538,14 +3047,14 @@ into
45383047 <table>
45393048 <tr>
45403049 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3050+ <td><a href="http://google.com">a link</a></td>
45423051 </tr>
45433052 </table>
45443053
45453054whereas `Markdown.pl` will preserve it as is.
45463055
4547−There is one exception to this rule: text between `<script>`,
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3056+There is one exception to this rule: text between `<script>` and
3057+`<style>` tags is not interpreted as Markdown.
45493058
45503059This departure from standard Markdown should make it easier to mix
45513060Markdown with HTML block elements. For example, one can surround
@@ -4554,17 +3063,50 @@ from being interpreted as Markdown.
45543063
45553064#### Extension: `native_divs` ####
45563065
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.
3066+Use native pandoc `Div` blocks for content inside `<div>` tags.
3067+For the most part this should give the same output as
3068+`markdown_in_html_blocks`, but it makes it easier to write pandoc
3069+filters to manipulate groups of blocks.
3070+
3071+#### Extension: `native_spans` ####
3072+
3073+Use native pandoc `Span` blocks for content inside `<span>` tags.
3074+For the most part this should give the same output as `raw_html`,
3075+but it makes it easier to write pandoc filters to manipulate groups
3076+of inlines.
3077+
3078+#### Extension: `fenced_divs` ####
3079+
3080+Allow special fenced syntax for native `Div` blocks. A Div
3081+starts with a fence containing at least three consecutive
3082+colons plus some attributes. The attributes may optionally
3083+be followed by another string of consecutive colons.
3084+The attribute syntax is exactly as in fenced code blocks (see
3085+[Extension-fenced_code_attributes], above). As with fenced
3086+code blocks, one can use either attributes in curly braces
3087+or a single unbraced word, which will be treated as a class
3088+name. The Div ends with another line containing a string of at
3089+least three consecutive colons. The fenced Div should be
3090+separated by blank lines from preceding and following blocks.
3091+
3092+Example:
3093+
3094+ ::::: {#special .sidebar}
3095+ Here is a paragraph.
3096+
3097+ And another.
3098+ :::::
3099+
3100+Fenced divs can be nested. Opening fences are distinguished
3101+because they *must* have attributes:
45613102
4562−#### Extension: `native_spans` ####
3103+ ::: Warning ::::::
3104+ This is a warning.
45633105
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.
3106+ ::: Danger
3107+ This is a warning within a warning.
3108+ :::
3109+ ::::::::::::::::::
45683110
45693111#### Extension: `raw_tex` ####
45703112
@@ -4587,10 +3129,6 @@ Note that in LaTeX environments, like
45873129the material between the begin and end tags will be interpreted as raw
45883130LaTeX, not as Markdown.
45893131
4590−For a more explicit and flexible way of including raw TeX in a
4591−Markdown document, see the [`raw_attribute`
4592−extension][Extension: `raw_attribute`].
4593−
45943132Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
45953133Emacs Org mode, and ConTeXt.
45963134
@@ -4601,7 +3139,7 @@ Emacs Org mode, and ConTeXt.
46013139Inline spans and fenced code blocks with a special
46023140kind of attribute will be parsed as raw content with the
46033141designated format. For example, the following produces a raw
4604−roff `ms` block:
3142+groff `ms` block:
46053143
46063144 ```{=ms}
46073145 .MYMACRO
@@ -4611,24 +3149,9 @@ And the following produces a raw `html` inline element:
46113149
46123150 This is `<a>html</a>`{=html}
46133151
4614−This can be useful to insert raw xml into `docx` documents, e.g.
4615−a pagebreak:
4616−
4617− ```{=openxml}
4618− <w:p>
4619− <w:r>
4620− <w:br w:type="page"/>
4621− </w:r>
4622− </w:p>
4623− ```
4624−
46253152The format name should match the target format name (see
46263153`-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`).
3154+--list-output-formats`).
46323155
46333156This extension presupposes that the relevant kind of
46343157inline code or fenced code block is enabled. Thus, for
@@ -4637,34 +3160,26 @@ example, to use a raw attribute with a backtick code block,
46373160
46383161The raw attribute cannot be combined with regular attributes.
46393162
4640−## LaTeX macros
3163+LaTeX macros
3164+------------
46413165
46423166#### Extension: `latex_macros` ####
46433167
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:
3168+For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
3169+`\renewcommand` definitions and apply the resulting macros to all LaTeX
3170+math. So, for example, the following will work in all output formats,
3171+not just LaTeX:
46483172
46493173 \newcommand{\tuple}[1]{\langle #1 \rangle}
46503174
46513175 $\tuple{a, b, c}$
46523176
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).
3177+In LaTeX output, the `\newcommand` definition will simply be passed
3178+unchanged to the output.
46563179
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.
46603180
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.
4666−
4667−## Links
3181+Links
3182+-----
46683183
46693184Markdown allows links to be specified in several ways.
46703185
@@ -4673,7 +3188,7 @@ Markdown allows links to be specified in several ways.
46733188If you enclose a URL or email address in pointy brackets, it
46743189will become a link:
46753190
4676− <https://google.com>
3191+ <http://google.com>
46773192 <sam@green.eggs.ham>
46783193
46793194### Inline links ###
@@ -4683,7 +3198,7 @@ followed by the URL in parentheses. (Optionally, the URL can
46833198be followed by a link title, in quotes.)
46843199
46853200 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3201+ a title](http://fsf.org "click here for a good time!").
46873202
46883203There can be no space between the bracketed part and the parenthesized part.
46893204The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3227,7 @@ Here are some examples:
47123227
47133228 [my label 1]: /foo/bar.html "My title, optional"
47143229 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3230+ [my label 3]: http://fsf.org (The free software foundation)
47163231 [my label 4]: /bar#special 'A title in single quotes'
47173232
47183233The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3236,7 @@ The URL may optionally be surrounded by angle brackets:
47213236
47223237The title may go on the next line:
47233238
4724− [my label 3]: https://fsf.org
3239+ [my label 3]: http://fsf.org
47253240 "The free software foundation"
47263241
47273242Note that link labels are not case sensitive. So, this will work:
@@ -4735,622 +3250,243 @@ empty:
47353250
47363251 See [my website][].
47373252
4738− [my website]: http://foo.bar.baz
4739−
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:
4745−
4746− > My block [quote].
4747− >
4748− > [quote]: /foo
4749−
4750−#### Extension: `shortcut_reference_links` ####
4751−
4752−In a *shortcut* reference link, the second pair of brackets may
4753−be omitted entirely:
4754−
4755− See [my website].
4756−
4757− [my website]: http://foo.bar.baz
4758−
4759−### Internal links ###
4760−
4761−To link to another section of the same document, use the automatically
4762−generated identifier (see [Heading identifiers]). For example:
4763−
4764− See the [Introduction](#introduction).
4765−
4766−or
4767−
4768− See the [Introduction].
4769−
4770− [Introduction]: #introduction
4771−
4772−Internal links are currently supported for HTML formats (including
4773−HTML slide shows and EPUB), LaTeX, and ConTeXt.
4774−
4775−## Images
4776−
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:
4779−
4780− 
4781−
4782− ![movie reel]
4783−
4784− [movie reel]: movie.gif
4785−
4786−#### Extension: `implicit_figures` ####
4787−
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.
4791−
4792− 
4793−
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.
4798−
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:
4802−
4803− \
4804−
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.
4808−
4809−#### Extension: `link_attributes` ####
4810−
4811−Attributes can be set on links and images:
4812−
4813− An inline {#id .class width=30 height=20px}
4814− and a reference ![image][ref] with attributes.
4815−
4816− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4817−
4818−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819−and `.class` are used.)
4820−
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.
4826−
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:
4832−
4833−```
4834−{ width=50% }
4835−```
4836−
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.
4856−
4857−## Divs and Spans
4858−
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:
4864−
4865−#### Extension: `fenced_divs` ####
4866−
4867−Allow special fenced syntax for native `Div` blocks. A Div
4868−starts with a fence containing at least three consecutive
4869−colons plus some attributes. The attributes may optionally
4870−be followed by another string of consecutive colons.
4871−The attribute syntax is exactly as in fenced code blocks (see
4872−[Extension: `fenced_code_attributes`]). As with fenced
4873−code blocks, one can use either attributes in curly braces
4874−or a single unbraced word, which will be treated as a class
4875−name. The Div ends with another line containing a string of at
4876−least three consecutive colons. The fenced Div should be
4877−separated by blank lines from preceding and following blocks.
4878−
4879−Example:
4880−
4881− ::::: {#special .sidebar}
4882− Here is a paragraph.
4883−
4884− And another.
4885− :::::
4886−
4887−Fenced divs can be nested. Opening fences are distinguished
4888−because they *must* have attributes:
4889−
4890− ::: Warning ::::::
4891− This is a warning.
4892−
4893− ::: Danger
4894− This is a warning within a warning.
4895− :::
4896− ::::::::::::::::::
4897−
4898−Fences without attributes are always closing fences. Unlike
4899−with fenced code blocks, the number of colons in the closing
4900−fence need not match the number in the opening fence. However,
4901−it can be helpful for visual clarity to use fences of different
4902−lengths to distinguish nested divs from their parents.
4903−
4904−
4905−#### Extension: `bracketed_spans` ####
4906−
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:
4910−
4911− [This is *some text*]{.class key="val"}
4912−
4913−## Footnotes
4914−
4915−#### Extension: `footnotes` ####
4916−
4917−Pandoc's Markdown allows footnotes, using the following syntax:
4918−
4919− Here is a footnote reference,[^1] and another.[^longnote]
4920−
4921− [^1]: Here is the footnote.
4922−
4923− [^longnote]: Here's one with multiple blocks.
4924−
4925− Subsequent paragraphs are indented to show that they
4926− belong to the previous footnote.
4927−
4928− { some.code }
4929−
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.
4933−
4934− This paragraph won't be part of the note, because it
4935− isn't indented.
4936−
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.
4941−
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.
4947−
4948−#### Extension: `inline_notes` ####
4949−
4950−Inline footnotes are also allowed (though, unlike regular notes,
4951−they cannot contain multiple paragraphs). The syntax is as follows:
4952−
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.]
4956−
4957−Inline and regular footnotes may be mixed freely.
4958−
4959−## Citation syntax
4960−
4961−#### Extension: `citations` ####
4962−
4963−To cite a bibliographic item with an identifier foo, use the
4964−syntax `@foo`. Normal citations should be included in square
4965−brackets, with semicolons separating distinct items:
4966−
4967− Blah blah [@doe99; @smith2000; @smith2004].
4968−
4969−How this is rendered depends on the citation style. In an
4970−author-date style, it might render as
4971−
4972− Blah blah (Doe 1999, Smith 2000, 2004).
4973−
4974−In a footnote style, it might render as
4975−
4976− Blah blah.[^1]
4977−
4978− [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4979− Susan Smith, "Flies," *Journal of Insects* (2000);
4980− Susan Smith, "Bees," *Journal of Insects* (2004).
4981−
4982−See the [CSL user documentation] for more information about CSL
4983−styles and how they affect rendering.
4984−
4985−Unless a citation key start with a letter, digit, or `_`,
4986−and contains only alphanumerics and internal punctuation
4987−characters (`:.#$%&-+?<>~/`), it must be surrounded
4988−by curly braces, which are not considered part of the key.
4989−In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final
4990−period is not *internal* punctuation, so it is not included in
4991−the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including
4992−the final period. The curly braces are recommended if you use URLs as
4993−keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.
4994−
4995−Citation items may optionally include a prefix, a locator, and
4996−a suffix. In
4997−
4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4999−
5000−The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
5001−and suffix `and *passim*`. The second item (`smith04`) has
5002−locator `chap. 1` and no prefix or suffix.
5003−
5004−Pandoc uses some heuristics to separate the locator from the
5005−rest of the subject. It is sensitive to the locator terms
5006−defined in the [CSL locale files]. Either abbreviated or
5007−unabbreviated forms are accepted. In the `en-US` locale, locator
5008−terms can be written in either singular or plural forms, as
5009−`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5010−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
5011−`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012−`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
5013−`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
5014−`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
5015−`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5016−locator term is used, "page" is assumed.
5017−
5018−In complex cases, you can force something to be treated as
5019−a locator by enclosing it in curly braces or prevent parsing
5020−the suffix as locator by prepending curly braces:
5021−
5022− [@smith{ii, A, D-Z}, with a suffix]
5023− [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024− [@smith{}, 99 years later]
5025−
5026−A minus sign (`-`) before the `@` will suppress mention of
5027−the author in the citation. This can be useful when the
5028−author is already mentioned in the text:
5029−
5030− Smith says blah [-@smith04].
5031−
5032−You can also write an author-in-text citation, by omitting the
5033−square brackets:
5034−
5035− @smith04 says blah.
5036−
5037− @smith04 [p. 33] says blah.
5038−
5039−This will cause the author's name to be rendered, followed by
5040−the bibliographical details. Use this form when you want to
5041−make the citation the subject of a sentence.
5042−
5043−When you are using a note style, it is usually better to let
5044−citeproc create the footnotes from citations rather than writing
5045−an explicit note. If you do write an explicit note that
5046−contains a citation, note that normal citations will be put in
5047−parentheses, while author-in-text citations will not. For
5048−this reason, it is sometimes preferable to use the
5049−author-in-text style inside notes when using a note style.
5050−
5051−[CSL user documentation]: https://citationstyles.org/authors/
5052−[CSL]: https://docs.citationstyles.org/en/stable/specification.html
5053−[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5054−[Chicago Manual of Style]: https://chicagomanualofstyle.org
5055−[Citation Style Language]: https://citationstyles.org
5056−[Zotero Style Repository]: https://www.zotero.org/styles
5057−[finding and editing styles]: https://citationstyles.org/authors/
5058−[CSL locale files]: https://github.com/citation-style-language/locales
5059−
5060−## Non-default extensions
5061−
5062−The following Markdown syntax extensions are not enabled by default
5063−in pandoc, but may be enabled by adding `+EXTENSION` to the format
5064−name, where `EXTENSION` is the name of the extension. Thus, for
5065−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5066−
5067−#### Extension: `rebase_relative_paths` ####
5068−
5069−Rewrite relative paths for Markdown links and images, depending
5070−on the path of the file containing the link or image link. For
5071−each link or image, pandoc will compute the directory of the
5072−containing file, relative to the working directory, and prepend
5073−the resulting path to the link or image path.
5074−
5075−The use of this extension is best understood by example.
5076−Suppose you have a a subdirectory for each chapter of a book,
5077−`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a
5078−number of images used in the chapter. You would like to have
5079−`` in `chap1/text.md` refer to
5080−`chap1/spider.jpg` and `` in `chap2/text.md`
5081−refer to `chap2/spider.jpg`. To do this, use
5082−
5083− pandoc chap*/*.md -f markdown+rebase_relative_paths
5084−
5085−Without this extension, you would have to use
5086−`` in `chap1/text.md` and
5087−`` in `chap2/text.md`. Links with
5088−relative paths will be rewritten in the same way as images.
5089−
5090−Absolute paths and URLs are not changed. Neither are empty
5091−paths or paths consisting entirely of a fragment, e.g., `#foo`.
5092−
5093−Note that relative paths in reference links and images will
5094−be rewritten relative to the file containing the link
5095−reference definition, not the file containing the reference link
5096−or image itself, if these differ.
5097−
5098−#### Extension: `attributes` ####
5099−
5100−Allows attributes to be attached to any inline or block-level
5101−element. The syntax for the attributes is the same as that
5102−used in [`header_attributes`][Extension: `header_attributes`].
5103−
5104−- Attributes that occur immediately after an inline
5105− element affect that element. If they follow a space, then they
5106− belong to the space. (Hence, this option subsumes
5107− `inline_code_attributes` and `link_attributes`.)
5108−- Attributes that occur immediately before a block
5109− element, on a line by themselves, affect that
5110− element.
5111−- Consecutive attribute specifiers may be used,
5112− either for blocks or for inlines. Their attributes
5113− will be combined.
5114−- Attributes that occur at the end of the text of
5115− a Setext or ATX heading (separated by whitespace
5116− from the text) affect the heading element. (Hence, this
5117− option subsumes `header_attributes`.)
5118−- Attributes that occur after the opening fence
5119− in a fenced code block affect the code block element. (Hence,
5120− this option subsumes `fenced_code_attributes`.)
5121−- Attributes that occur at the end of a reference
5122− link definition affect links that refer to that
5123− definition.
5124−
5125−Note that pandoc's AST does not currently allow attributes
5126−to be attached to arbitrary elements. Hence a Span or Div
5127−container will be added if needed.
5128−
5129−#### Extension: `old_dashes` ####
5130−
5131−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5132−`-` before a numeral is an en-dash, and `--` is an em-dash.
5133−This option only has an effect if `smart` is enabled. It is
5134−selected automatically for `textile` input.
5135−
5136−#### Extension: `angle_brackets_escapable` ####
3253+ [my website]: http://foo.bar.baz
51373254
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`.
3255+Note: In `Markdown.pl` and most other Markdown implementations,
3256+reference link definitions cannot occur in nested constructions
3257+such as list items or block quotes. Pandoc lifts this arbitrary
3258+seeming restriction. So the following is fine in pandoc, though
3259+not in most other implementations:
51413260
5142−#### Extension: `lists_without_preceding_blankline` ####
3261+ > My block [quote].
3262+ >
3263+ > [quote]: /foo
51433264
5144−Allow a list to occur right after a paragraph, with no intervening
5145−blank space.
3265+#### Extension: `shortcut_reference_links` ####
51463266
5147−#### Extension: `four_space_rule` ####
3267+In a *shortcut* reference link, the second pair of brackets may
3268+be omitted entirely:
51483269
5149−Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150−four spaces indent are needed for list item continuation
5151−paragraphs.
3270+ See [my website].
51523271
5153−#### Extension: `spaced_reference_links` ####
3272+ [my website]: http://foo.bar.baz
51543273
5155−Allow whitespace between the two components of a reference link,
5156−for example,
3274+### Internal links ###
51573275
5158− [foo] [bar].
3276+To link to another section of the same document, use the automatically
3277+generated identifier (see [Header identifiers]). For example:
51593278
5160−#### Extension: `hard_line_breaks` ####
3279+ See the [Introduction](#introduction).
51613280
5162−Causes all newlines within a paragraph to be interpreted as hard line
5163−breaks instead of spaces.
3281+or
51643282
5165−#### Extension: `ignore_line_breaks` ####
3283+ See the [Introduction].
51663284
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.
3285+ [Introduction]: #introduction
51713286
5172−#### Extension: `east_asian_line_breaks` ####
3287+Internal links are currently supported for HTML formats (including
3288+HTML slide shows and EPUB), LaTeX, and ConTeXt.
51733289
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.
3290+Images
3291+------
51793292
5180−#### Extension: `emoji` ####
3293+A link immediately preceded by a `!` will be treated as an image.
3294+The link text will be used as the image's alt text:
51813295
5182−Parses textual emojis like `:smile:` as Unicode emoticons.
3296+ 
51833297
5184−#### Extension: `tex_math_single_backslash` ####
3298+ ![movie reel]
51853299
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 `[`.
3300+ [movie reel]: movie.gif
51903301
5191−#### Extension: `tex_math_double_backslash` ####
3302+#### Extension: `implicit_figures` ####
51923303
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.
3304+An image with nonempty alt text, occurring by itself in a
3305+paragraph, will be rendered as a figure with a caption. The
3306+image's alt text will be used as the caption.
51963307
5197−#### Extension: `markdown_attribute` ####
3308+ 
51983309
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`.
3310+How this is rendered depends on the output format. Some output
3311+formats (e.g. RTF) do not yet support figures. In those
3312+formats, you'll just get an image in a paragraph by itself, with
3313+no caption.
52023314
5203−#### Extension: `mmd_title_block` ####
3315+If you just want a regular inline image, just make sure it is not
3316+the only thing in the paragraph. One way to do this is to insert a
3317+nonbreaking space after the image:
52043318
5205−Enables a [MultiMarkdown] style title block at the top of
5206−the document, for example:
3319+ \
52073320
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.
3321+Note that in reveal.js slide shows, an image in a paragraph
3322+by itself that has the `stretch` class will fill the screen,
3323+and the caption and figure tags will be omitted.
52133324
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`.
3325+#### Extension: `link_attributes` ####
52173326
5218−#### Extension: `abbreviations` ####
3327+Attributes can be set on links and images:
52193328
5220−Parses PHP Markdown Extra abbreviation keys, like
3329+ An inline {#id .class width=30 height=20px}
3330+ and a reference ![image][ref] with attributes.
52213331
5222− *[HTML]: Hypertext Markup Language
3332+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
52233333
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).
3334+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3335+and `.class` are used.)
52273336
5228−#### Extension: `autolink_bare_uris` ####
3337+For HTML and EPUB, all attributes except `width` and `height` (but
3338+including `srcset` and `sizes`) are passed through as is. The other
3339+writers ignore attributes that are not supported by their output
3340+format.
52293341
5230−Makes all absolute URIs into links, even when not surrounded by
5231−pointy braces `<...>`.
3342+The `width` and `height` attributes on images are treated specially. When
3343+used without a unit, the unit is assumed to be pixels. However, any of
3344+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3345+and `%`. There must not be any spaces between the number and the unit.
3346+For example:
52323347
5233−#### Extension: `mmd_link_attributes` ####
3348+```
3349+{ width=50% }
3350+```
52343351
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.
3352+- Dimensions are converted to inches for output in page-based formats like
3353+ LaTeX. Dimensions are converted to pixels for output in HTML-like
3354+ formats. Use the `--dpi` option to specify the number of pixels per
3355+ inch. The default is 96dpi.
3356+- The `%` unit is generally relative to some available space.
3357+ For example the above example will render to
3358+ `<img href="file.jpg" style="width: 50%;" />` (HTML),
3359+ `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3360+ `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3361+- Some output formats have a notion of a class
3362+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3363+ or a unique identifier (LaTeX `\caption`), or both (HTML).
3364+- When no `width` or `height` attributes are specified, the fallback
3365+ is to look at the image resolution and the dpi metadata embedded in
3366+ the image file.
52383367
5239− This is a reference ![image][ref] with multimarkdown attributes.
3368+Spans
3369+-----
52403370
5241− [ref]: https://path.to/image "Image title" width=20px height=30px
5242− id=myId class="myClass1 myClass2"
3371+#### Extension: `bracketed_spans` ####
52433372
5244−#### Extension: `mmd_header_identifiers` ####
3373+A bracketed sequence of inlines, as one would use to begin
3374+a link, will be treated as a span with attributes if it is
3375+followed immediately by attributes:
52453376
5246−Parses multimarkdown style heading identifiers (in square brackets,
5247−after the heading but before any trailing `#`s in an ATX heading).
3377+ [This is *some text*]{.class key="val"}
52483378
5249−#### Extension: `compact_definition_lists` ####
3379+Footnotes
3380+---------
52503381
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:
3382+#### Extension: `footnotes` ####
52543383
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]
3384+Pandoc's Markdown allows footnotes, using the following syntax:
52623385
5263−[^6]: To see why laziness is incompatible with relaxing the requirement
5264− of a blank line between items, consider the following example:
3386+ Here is a footnote reference,[^1] and another.[^longnote]
52653387
5266− bar
5267− : definition
5268− foo
5269− : definition
3388+ [^1]: Here is the footnote.
52703389
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.
3390+ [^longnote]: Here's one with multiple blocks.
3391+
3392+ Subsequent paragraphs are indented to show that they
3393+ belong to the previous footnote.
52753394
5276−#### Extension: `gutenberg` ####
3395+ { some.code }
52773396
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.
3397+ The whole paragraph can be indented, or just the first
3398+ line. In this way, multi-paragraph footnotes work like
3399+ multi-paragraph list items.
52813400
5282− [Project Gutenberg]: https://www.gutenberg.org
3401+ This paragraph won't be part of the note, because it
3402+ isn't indented.
52833403
5284−#### Extension: `sourcepos` ####
3404+The identifiers in footnote references may not contain spaces, tabs,
3405+or newlines. These identifiers are used only to correlate the
3406+footnote reference with the note itself; in the output, footnotes
3407+will be numbered sequentially.
52853408
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.
3409+The footnotes themselves need not be placed at the end of the
3410+document. They may appear anywhere except inside other block elements
3411+(lists, block quotes, tables, etc.). Each footnote should be
3412+separated from surrounding content (including other footnotes)
3413+by blank lines.
52903414
5291−## Markdown variants
3415+#### Extension: `inline_notes` ####
52923416
5293−In addition to pandoc's extended Markdown, the following Markdown
5294−variants are supported:
3417+Inline footnotes are also allowed (though, unlike regular notes,
3418+they cannot contain multiple paragraphs). The syntax is as follows:
52953419
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)
3420+ Here is an inline note.^[Inlines notes are easier to write, since
3421+ you don't have to pick an identifier and move down to type the
3422+ note.]
53033423
5304−To see which extensions are supported for a given format,
5305−and which are enabled by default, you can use the command
3424+Inline and regular footnotes may be mixed freely.
53063425
5307− pandoc --list-extensions=FORMAT
3426+Typography
3427+----------
53083428
5309−where `FORMAT` is replaced with the name of the format.
3429+#### Extension: `smart` ####
53103430
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.
3431+Interpret straight quotes as curly quotes, `---` as em-dashes,
3432+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
3433+inserted after certain abbreviations, such as "Mr." This
3434+option currently affects the input formats `markdown`,
3435+`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3436+and the output formats `markdown`, `latex`, and `context`.
53163437
5317−# Citations
3438+Note: If you are *writing* Markdown, then the `smart` extension
3439+has the reverse effect: what would have been curly quotes comes
3440+out straight.
53183441
5319−When the `--citeproc` option is used, pandoc can automatically generate
5320−citations and a bibliography in a number of styles. Basic usage is
3442+In LaTeX, `smart` means to use the standard TeX ligatures
3443+for quotation marks (` `` ` and ` '' ` for double quotes,
3444+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3445+en-dash and `---` for em-dash). If `smart` is disabled,
3446+then in reading LaTeX pandoc will parse these characters
3447+literally. In writing LaTeX, enabling `smart` tells pandoc
3448+to use the ligatures when possible; if `smart` is disabled
3449+pandoc will use unicode quotation mark and dash characters.
53213450
5322− pandoc --citeproc myinput.txt
3451+Citations
3452+---------
53233453
5324−To use this feature, you will need to have
3454+#### Extension: `citations` ####
53253455
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.
3456+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3457+citations and a bibliography in a number of styles. Basic usage is
53303458
5331−## Specifying bibliographic data
3459+ pandoc --filter pandoc-citeproc myinput.txt
53323460
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:
3461+In order to use this feature, you will need to specify a bibliography file
3462+using the `bibliography` metadata field in a YAML metadata section, or
3463+`--bibliography` command line argument. You can supply multiple `--bibliography`
3464+arguments or set `bibliography` metadata field to YAML array, if you want to
3465+use multiple bibliography files. The bibliography may have any of these
3466+formats:
53393467
53403468 Format File extension
53413469 ------------ --------------
53423470 BibLaTeX .bib
53433471 BibTeX .bibtex
3472+ Copac .copac
53443473 CSL JSON .json
53453474 CSL YAML .yaml
3475+ EndNote .enl
3476+ EndNote XML .xml
3477+ ISI .wos
3478+ MEDLINE .medline
3479+ MODS .mods
3480+ RIS .ris
53463481
53473482Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
3483+use `.bibtex` to force BibTeX.
3484+
3485+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3486+can produce `.json` and `.yaml` files from any of the supported formats.
53493487
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]:
3488+In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3489+a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
53543490
53553491`<i>...</i>`
53563492: italics
@@ -5370,11 +3506,14 @@ markup specs]:
53703506`<span class="nocase">...</span>`
53713507: prevent a phrase from being capitalized as title case
53723508
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:
3509+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3510+and CSL YAML formats as far as possible.
3511+
3512+As an alternative to specifying a bibliography file using `--bibliography`
3513+or the YAML metadata field `bibliography`, you can include
3514+the citation data directly in the `references` field of the
3515+document's YAML metadata. The field should contain an array of
3516+YAML-encoded references, for example:
53783517
53793518 ---
53803519 references:
@@ -5390,279 +3529,345 @@ array of YAML-encoded references, for example:
53903529 - - 1953
53913530 - 4
53923531 - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
5394− deoxyribose nucleic acid'
3532+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3533+ nucleic acid'
53953534 title-short: Molecular structure of nucleic acids
53963535 container-title: Nature
53973536 volume: 171
53983537 issue: 4356
53993538 page: 737-738
54003539 DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
3540+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
54023541 language: en-GB
54033542 ...
54043543
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.
3544+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3545+of the supported formats.)
3546+
3547+Citations and references can be formatted using any style supported by the
3548+[Citation Style Language], listed in the [Zotero Style Repository].
3549+These files are specified using the `--csl` option or the `csl` metadata field.
3550+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3551+format. The CSL project provides further information on [finding and editing styles].
3552+
3553+To make your citations hyperlinks to the corresponding bibliography
3554+entries, add `link-citations: true` to your YAML metadata.
3555+
3556+Citations go inside square brackets and are separated by semicolons.
3557+Each citation must have a key, composed of '@' + the citation
3558+identifier from the database, and may optionally have a prefix,
3559+a locator, and a suffix. The citation key must begin with a letter, digit,
3560+or `_`, and may contain alphanumerics, `_`, and internal punctuation
3561+characters (`:.#$%&-+?<>~/`). Here are some examples:
3562+
3563+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3564+
3565+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3566+
3567+ Blah blah [@smith04; @doe99].
3568+
3569+`pandoc-citeproc` detects locator terms in the [CSL locale files].
3570+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3571+locale, locator terms can be written in either singular or plural forms,
3572+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3573+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3574+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3575+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3576+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3577+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3578+locator term is used, "page" is assumed.
3579+
3580+A minus sign (`-`) before the `@` will suppress mention of
3581+the author in the citation. This can be useful when the
3582+author is already mentioned in the text:
3583+
3584+ Smith says blah [-@smith04].
3585+
3586+You can also write an in-text citation, as follows:
3587+
3588+ @smith04 says blah.
3589+
3590+ @smith04 [p. 33] says blah.
3591+
3592+If the style calls for a list of works cited, it will be placed
3593+at the end of the document. Normally, you will want to end your
3594+document with an appropriate header:
3595+
3596+ last paragraph...
3597+
3598+ # References
3599+
3600+The bibliography will be inserted after this header. Note that
3601+the `unnumbered` class will be added to this header, so that the
3602+section will not be numbered.
3603+
3604+If you want to include items in the bibliography without actually
3605+citing them in the body text, you can define a dummy `nocite` metadata
3606+field and put the citations there:
54083607
5409−Note that `pandoc` can be used to produce such a YAML metadata
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
3608+ ---
3609+ nocite: |
3610+ @item1, @item2
3611+ ...
54113612
5412− pandoc chem.bib -s -f biblatex -t markdown
5413− pandoc chem.json -s -f csljson -t markdown
3613+ @item3
54143614
5415−Indeed, `pandoc` can convert between any of these
5416−citation formats:
3615+In this example, the document will contain a citation for `item3`
3616+only, but the bibliography will contain entries for `item1`, `item2`, and
3617+`item3`.
54173618
5418− pandoc chem.bib -s -f biblatex -t csljson
5419− pandoc chem.yaml -s -f markdown -t biblatex
3619+It is possible to create a bibliography with all the citations,
3620+whether or not they appear in the document, by using a wildcard:
54203621
5421−Running pandoc on a bibliography file with the `--citeproc`
5422−option will create a formatted bibliography in the format
5423−of your choice:
3622+ ---
3623+ nocite: |
3624+ @*
3625+ ...
54243626
5425− pandoc chem.bib -s --citeproc -o chem.html
5426− pandoc chem.bib -s --citeproc -o chem.pdf
3627+For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3628+to render bibliography. In order to do so, specify bibliography files as
3629+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3630+invocation. Bear in mind that bibliography files have to be in respective
3631+format (either BibTeX or BibLaTeX).
54273632
5428−### Capitalization in titles
3633+For more information, see the [pandoc-citeproc man page].
54293634
5430−If you are using a bibtex or biblatex bibliography, then observe
5431−the following rules:
3635+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3636+[Chicago Manual of Style]: http://chicagomanualofstyle.org
3637+[Citation Style Language]: http://citationstyles.org
3638+[Zotero Style Repository]: https://www.zotero.org/styles
3639+[finding and editing styles]: http://citationstyles.org/styles/
3640+[CSL locale files]: https://github.com/citation-style-language/locales
3641+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
54323642
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`.)
3643+Non-pandoc extensions
3644+---------------------
54383645
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:
3646+The following Markdown syntax extensions are not enabled by default
3647+in pandoc, but may be enabled by adding `+EXTENSION` to the format
3648+name, where `EXTENSION` is the name of the extension. Thus, for
3649+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
54423650
5443− title = {My Dinner with {Andre}}
3651+#### Extension: `old_dashes` ####
54443652
5445− - In addition, words that should remain lowercase (or camelCase)
5446− should be protected:
3653+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3654+`-` before a numeral is an en-dash, and `--` is an em-dash.
3655+This option only has an effect if `smart` is enabled. It is
3656+selected automatically for `textile` input.
54473657
5448− title = {Spin Wave Dispersion on the {nm} Scale}
3658+#### Extension: `angle_brackets_escapable` ####
54493659
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.
3660+Allow `<` and `>` to be backslash-escaped, as they can be in
3661+GitHub flavored Markdown but not original Markdown. This is
3662+implied by pandoc's default `all_symbols_escapable`.
54543663
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
5456−the following rules:
3664+#### Extension: `lists_without_preceding_blankline` ####
54573665
5458− - All titles should be in sentence case.
3666+Allow a list to occur right after a paragraph, with no intervening
3667+blank space.
54593668
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.)
3669+#### Extension: `four_space_rule` ####
54633670
5464− - Protect words that should not be converted to title case using
5465− this syntax:
3671+Selects the pandoc <= 2.0 behavior for parsing lists, so that
3672+four spaces indent are needed for list item continuation
3673+paragraphs.
54663674
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
3675+#### Extension: `spaced_reference_links` ####
54683676
5469−### Conference Papers, Published vs. Unpublished
3677+Allow whitespace between the two components of a reference link,
3678+for example,
54703679
5471−For a formally published conference paper, use the biblatex entry type
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
3680+ [foo] [bar].
54733681
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`).
3682+#### Extension: `hard_line_breaks` ####
54773683
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.
3684+Causes all newlines within a paragraph to be interpreted as hard line
3685+breaks instead of spaces.
54873686
3687+#### Extension: `ignore_line_breaks` ####
54883688
5489−## Specifying a citation style
3689+Causes newlines within a paragraph to be ignored, rather than being
3690+treated as spaces or as hard line breaks. This option is intended for
3691+use with East Asian languages where spaces are not used between words,
3692+but text is divided into lines for readability.
54903693
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:
3694+#### Extension: `east_asian_line_breaks` ####
55073695
3696+Causes newlines within a paragraph to be ignored, rather than
3697+being treated as spaces or as hard line breaks, when they occur
3698+between two East Asian wide characters. This is a better choice
3699+than `ignore_line_breaks` for texts that include a mix of East
3700+Asian wide characters and other characters.
55083701
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− }
3702+##### Extension: `emoji` ####
55173703
3704+Parses textual emojis like `:smile:` as Unicode emoticons.
55183705
5519−## Citations in note styles
3706+#### Extension: `tex_math_single_backslash` ####
55203707
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,
3708+Causes anything between `\(` and `\)` to be interpreted as inline
3709+TeX math, and anything between `\[` and `\]` to be interpreted
3710+as display TeX math. Note: a drawback of this extension is that
3711+it precludes escaping `(` and `[`.
55273712
5528− Blah blah [@foo, p. 33].
3713+#### Extension: `tex_math_double_backslash` ####
55293714
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].
3715+Causes anything between `\\(` and `\\)` to be interpreted as inline
3716+TeX math, and anything between `\\[` and `\\]` to be interpreted
3717+as display TeX math.
55353718
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:
3719+#### Extension: `markdown_attribute` ####
55413720
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].
3721+By default, pandoc interprets material inside block-level tags as Markdown.
3722+This extension changes the behavior so that Markdown is only parsed
3723+inside block-level tags if the tags have the attribute `markdown=1`.
55453724
5546−## Raw content in a style
3725+#### Extension: `mmd_title_block` ####
55473726
5548−To include raw content in a prefix, suffix, delimiter, or term,
5549−surround it with these tags indicating the format:
3727+Enables a [MultiMarkdown] style title block at the top of
3728+the document, for example:
55503729
5551− {{jats}}<ref>{{/jats}}
3730+ Title: My title
3731+ Author: John Doe
3732+ Date: September 1, 2008
3733+ Comment: This is a sample mmd title block, with
3734+ a field spanning multiple lines.
55523735
5553−Without the tags, the string will be interpreted as a string
5554−and escaped in the output, rather than being passed through raw.
3736+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3737+`yaml_metadata_block` is enabled, it will take precedence over
3738+`mmd_title_block`.
55553739
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.
3740+#### Extension: `abbreviations` ####
55603741
3742+Parses PHP Markdown Extra abbreviation keys, like
55613743
3744+ *[HTML]: Hypertext Markup Language
55623745
5563−## Placement of the bibliography
3746+Note that the pandoc document model does not support
3747+abbreviations, so if this extension is enabled, abbreviation keys are
3748+simply skipped (as opposed to being parsed as paragraphs).
55643749
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:
3750+#### Extension: `autolink_bare_uris` ####
55673751
5568− ::: {#refs}
5569− :::
3752+Makes all absolute URIs into links, even when not surrounded by
3753+pointy braces `<...>`.
55703754
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.
3755+#### Extension: `ascii_identifiers` ####
55743756
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:
3757+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3758+Accents are stripped off of accented Latin letters, and non-Latin
3759+letters are omitted.
55793760
5580− last paragraph...
3761+#### Extension: `mmd_link_attributes` ####
55813762
5582− # References
3763+Parses multimarkdown style key-value attributes on link
3764+and image references. This extension should not be confused with the
3765+[`link_attributes`](#extension-link_attributes) extension.
55833766
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.
3767+ This is a reference ![image][ref] with multimarkdown attributes.
55873768
5588−## Including uncited items in the bibliography
3769+ [ref]: http://path.to/image "Image title" width=20px height=30px
3770+ id=myId class="myClass1 myClass2"
55893771
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:
3772+#### Extension: `mmd_header_identifiers` ####
55933773
5594− ---
5595− nocite: |
5596− @item1, @item2
5597− ...
3774+Parses multimarkdown style header identifiers (in square brackets,
3775+after the header but before any trailing `#`s in an ATX header).
55983776
5599− @item3
3777+#### Extension: `compact_definition_lists` ####
56003778
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`.
3779+Activates the definition list syntax of pandoc 1.12.x and earlier.
3780+This syntax differs from the one described above under [Definition lists]
3781+in several respects:
56043782
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:
3783+ - No blank line is required between consecutive items of the
3784+ definition list.
3785+ - To get a "tight" or "compact" list, omit space between consecutive
3786+ items; the space between a term and its definition does not affect
3787+ anything.
3788+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
3789+ be indented four spaces.[^6]
56073790
5608− ---
5609− nocite: |
5610− @*
5611− ...
3791+[^6]: To see why laziness is incompatible with relaxing the requirement
3792+ of a blank line between items, consider the following example:
56123793
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.
3794+ bar
3795+ : definition
3796+ foo
3797+ : definition
56193798
5620−## Other relevant metadata fields
3799+ Is this a single list item with two definitions of "bar," the first of
3800+ which is lazily wrapped, or two list items? To remove the ambiguity
3801+ we must either disallow lazy wrapping or require a blank line between
3802+ list items.
56213803
5622−A few other metadata fields affect bibliography formatting:
3804+Markdown variants
3805+-----------------
56233806
5624−`link-citations`
5625−: If true, citations will be
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
3807+In addition to pandoc's extended Markdown, the following Markdown
3808+variants are supported:
56283809
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
3810+`markdown_phpextra` (PHP Markdown Extra)
3811+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3812+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3813+ `header_attributes`, `link_attributes`, `abbreviations`,
3814+ `shortcut_reference_links`, `spaced_reference_links`.
3815+
3816+`markdown_github` (deprecated GitHub-Flavored Markdown)
3817+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
3818+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3819+ `space_in_atx_header`, `intraword_underscores`, `strikeout`,
3820+ `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
3821+ `lists_without_preceding_blankline`.
3822+
3823+`markdown_mmd` (MultiMarkdown)
3824+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
3825+ `tex_math_double_backslash`, `intraword_underscores`,
3826+ `mmd_title_block`, `footnotes`, `definition_lists`,
3827+ `all_symbols_escapable`, `implicit_header_references`,
3828+ `auto_identifiers`, `mmd_header_identifiers`,
3829+ `shortcut_reference_links`, `implicit_figures`,
3830+ `superscript`, `subscript`, `backtick_code_blocks`,
3831+ `spaced_reference_links`, `raw_attribute`.
3832+
3833+`markdown_strict` (Markdown.pl)
3834+: `raw_html`, `shortcut_reference_links`,
3835+ `spaced_reference_links`.
3836+
3837+We also support `gfm` (GitHub-Flavored Markdown) as a set of
3838+extensions on `commonmark`:
3839+
3840+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
3841+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
3842+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3843+ `shortcut_reference_links`, `angle_brackets_escapable`.
3844+
3845+ These can all be individually disabled. Note, however, that
3846+ `commonmark` and `gfm` have limited support for extensions:
3847+ extensions other than those listed above (and `smart`) will have
3848+ no effect on `commonmark` or `gfm`.
3849+
3850+Extensions with formats other than Markdown
3851+-------------------------------------------
3852+
3853+Some of the extensions discussed above can be used with formats
3854+other than Markdown:
3855+
3856+* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
3857+ and `textile` input (and is used by default).
3858+
3859+* `tex_math_dollars`, `tex_math_single_backslash`, and
3860+ `tex_math_double_backslash` can be used with `html` input.
3861+ (This is handy for reading web pages formatted using MathJax,
3862+ for example.)
3863+
3864+Producing slide shows with pandoc
3865+=================================
56603866
56613867You can use pandoc to produce an HTML + JavaScript slide presentation
56623868that can be viewed via a web browser. There are five ways to do this,
56633869using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5664−You can also produce a PDF slide show using LaTeX [`beamer`], or
5665−slides shows in Microsoft [PowerPoint] format.
3870+You can also produce a PDF slide show using LaTeX [`beamer`].
56663871
56673872Here's the Markdown source for a simple slide show, `habits.txt`:
56683873
@@ -5704,21 +3909,18 @@ To produce an HTML/JavaScript slide show, simply type
57043909
57053910where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
57063911
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.
3912+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3913+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3914+assumed to be available at the relative path `s5/default` (for S5), `slideous`
3915+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3916+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3917+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3918+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3919+the file by default.
3920+
3921+With all HTML slide formats, the `--self-contained` option can be used to
3922+produce a single file that contains all of the data necessary to display the
3923+slide show, including linked scripts, stylesheets, images, and videos.
57223924
57233925To produce a PDF slide show using beamer, type
57243926
@@ -5727,17 +3929,14 @@ To produce a PDF slide show using beamer, type
57273929Note that a reveal.js slide show can also be converted to a PDF
57283930by printing it to a file from the browser.
57293931
5730−To produce a Powerpoint slide show, type
5731−
5732− pandoc habits.txt -o habits.pptx
3932+Structuring the slide show
3933+--------------------------
57333934
5734−## Structuring the slide show
5735−
5736−By default, the *slide level* is the highest heading level in
3935+By default, the *slide level* is the highest header level in
57373936the hierarchy that is followed immediately by content, and not another
5738−heading, somewhere in the document. In the example above, level-1 headings
5739−are always followed by level-2 headings, which are followed by content,
5740−so the slide level is 2. This default can be overridden using
3937+header, somewhere in the document. In the example above, level 1 headers
3938+are always followed by level 2 headers, which are followed by content,
3939+so 2 is the slide level. This default can be overridden using
57413940the `--slide-level` option.
57423941
57433942The document is carved up into slides according to the following
@@ -5745,21 +3944,17 @@ rules:
57453944
57463945 * A horizontal rule always starts a new slide.
57473946
5748− * A heading at the slide level always starts a new slide.
3947+ * A header at the slide level always starts a new slide.
57493948
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.)
3949+ * Headers *below* the slide level in the hierarchy create
3950+ headers *within* a slide.
57563951
5757− * Headings *above* the slide level in the hierarchy create
3952+ * Headers *above* the slide level in the hierarchy create
57583953 "title slides," which just contain the section title
57593954 and help to break the slide show into sections.
5760− Non-slide content under these headings will be included
5761− on the title slide (for HTML slide shows) or in a
5762− subsequent slide with the same title (for beamer).
3955+
3956+ * Content *above* the slide level will not appear in the slide
3957+ show.
57633958
57643959 * A title page is constructed automatically from the document's title
57653960 block, if present. (In the case of beamer, this can be disabled
@@ -5767,57 +3962,32 @@ rules:
57673962
57683963These rules are designed to support many different styles of slide show. If
57693964you don't care about structuring your slides into sections and subsections,
5770−you can just use level-1 headings for all each slide. (In that case, level-1
3965+you can just use level 1 headers for all each slide. (In that case, level 1
57713966will be the slide level.) But you can also structure the slide show into
57723967sections, as in the example above.
57733968
57743969Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5775−layout will be produced, with level-1 headings building horizontally
5776−and level-2 headings building vertically. It is not recommended that
3970+layout will be produced, with level 1 headers building horizontally
3971+and level 2 headers building vertically. It is not recommended that
57773972you use deeper nesting of section levels with reveal.js.
57783973
5779−## Incremental lists
3974+Incremental lists
3975+-----------------
57803976
57813977By default, these writers produce lists that display "all at once."
57823978If you want your lists to display incrementally (one item at a time),
57833979use the `-i` option. If you want a particular list to depart from the
5784−default, put it in a `div` block with class `incremental` or
5785−`nonincremental`. So, for example, using the `fenced div` syntax, the
5786−following would be incremental regardless of the document default:
5787−
5788− ::: incremental
5789−
5790− - Eat spaghetti
5791− - Drink wine
5792−
5793− :::
5794−
5795−or
5796−
5797− ::: nonincremental
5798−
5799− - Eat spaghetti
5800− - Drink wine
5801−
5802− :::
5803−
5804−While using `incremental` and `nonincremental` divs are the
5805−recommended method of setting incremental lists on a per-case basis,
5806−an older method is also supported: putting lists inside a blockquote
5807−will depart from the document default (that is, it will display
5808−incrementally without the `-i` option and all at once with the `-i`
5809−option):
3980+default (that is, to display incrementally without the `-i` option and
3981+all at once with the `-i` option), put it in a block quote:
58103982
58113983 > - Eat spaghetti
58123984 > - Drink wine
58133985
5814−Both methods allow incremental and nonincremental lists to be mixed
5815−in a single document.
5816−
5817−Note: Neither the `-i/--incremental` option nor any of the
5818−methods described here currently works for PowerPoint output.
3986+In this way incremental and nonincremental lists can be mixed in
3987+a single document.
58193988
5820−## Inserting pauses
3989+Inserting pauses
3990+----------------
58213991
58223992You can add "pauses" within a slide by including a paragraph containing
58233993three dots, separated by spaces:
@@ -5830,9 +4000,8 @@ three dots, separated by spaces:
58304000
58314001 content after the pause
58324002
5833−Note: this feature is not yet implemented for PowerPoint output.
5834−
5835−## Styling the slides
4003+Styling the slides
4004+------------------
58364005
58374006You can change the style of HTML slides by putting customized CSS files
58384007in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5857,9 +4026,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
58574026
58584027 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
58594028
5860−Note that heading attributes will turn into slide attributes
4029+Note that header attributes will turn into slide attributes
58614030(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5862−to style individual slides. In beamer, the only heading attribute
4031+to style individual slides. In beamer, the only header attribute
58634032that affects slides is the `allowframebreaks` class, which sets the
58644033`allowframebreaks` option, causing multiple slides to be created
58654034if the content overfills the frame. This is recommended especially for
@@ -5867,82 +4036,30 @@ bibliographies:
58674036
58684037 # References {.allowframebreaks}
58694038
5870−## Speaker notes
5871−
5872−Speaker notes are supported in reveal.js and PowerPoint (pptx)
5873−output. You can add notes to your Markdown document thus:
4039+Speaker notes
4040+-------------
58744041
5875− ::: notes
4042+reveal.js has good support for speaker notes. You can add notes to your
4043+Markdown document thus:
58764044
4045+ <div class="notes">
58774046 This is my note.
58784047
58794048 - It can contain Markdown
58804049 - like this list
58814050
5882− :::
5883−
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.
4051+ </div>
58874052
4053+To show the notes window, press `s` while viewing the presentation.
58884054Notes are not yet supported for other slide formats, but the notes
58894055will not appear on the slides themselves.
58904056
5891−## Columns
5892−
5893−To put material in side by side columns, you can use a native
5894−div container with class `columns`, containing two or more div
5895−containers with class `column` and a `width` attribute:
5896−
5897− :::::::::::::: {.columns}
5898− ::: {.column width="40%"}
5899− contents...
5900− :::
5901− ::: {.column width="60%"}
5902− contents...
5903− :::
5904− ::::::::::::::
5905−
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
4057+Frame attributes in beamer
4058+--------------------------
59424059
59434060Sometimes it is necessary to add the LaTeX `[fragile]` option to
59444061a frame in beamer (for example, when using the `minted` environment).
5945−This can be forced by adding the `fragile` class to the heading
4062+This can be forced by adding the `fragile` class to the header
59464063introducing the slide:
59474064
59484065 # Fragile slide {.fragile}
@@ -5950,64 +4067,13 @@ introducing the slide:
59504067All of the other frame attributes described in Section 8.1 of
59514068the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
59524069`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5953−`shrink`, `standout`, `noframenumbering`.
5954−
5955−## Background in reveal.js and beamer
5956−
5957−Background images can be added to self-contained reveal.js slideshows and
5958−to beamer slideshows.
5959−
5960−For the same image on every slide, use the configuration
5961−option `background-image` either in the YAML metadata block
5962−or as a command-line variable. (There are no other options in
5963−beamer and the rest of this section concerns reveal.js slideshows.)
5964−
5965−For reveal.js, you can instead use the reveal.js-native option
5966−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967−and `parallaxBackgroundVertical` the same way and must also set
5968−`parallaxBackgroundSize` to have your values take effect.
5969−
5970−To set an image for a particular reveal.js slide, add
5971−`{data-background-image="/path/to/image"}`
5972−to the first slide-level heading on the slide (which may even be empty).
4070+`shrink`.
59734071
5974−In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975−only on the first slide.
4072+Creating EPUBs with pandoc
4073+==========================
59764074
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"}
6004−
6005−Slide 2 has a special image for its background, even though the heading has no content.
6006−```
6007−
6008−# EPUBs
6009−
6010−## EPUB Metadata
4075+EPUB Metadata
4076+-------------
60114077
60124078EPUB metadata may be specified using the `--epub-metadata` option, but
60134079if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,20 +4151,11 @@ The following fields are recognized:
60854151
60864152`rights`
60874153 ~ 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.
60974154
60984155`cover-image`
60994156 ~ A string value (path to cover image).
61004157
6101−`css` (or legacy: `stylesheet`)
4158+`stylesheet`
61024159 ~ A string value (path to CSS stylesheet).
61034160
61044161`page-progression-direction`
@@ -6115,200 +4172,83 @@ The following fields are recognized:
61154172 - `binding`: `true`|`false` (default `true`)
61164173 - `scroll-axis`: `vertical`|`horizontal`|`default`
61174174
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4175+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
61194176[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
61204177
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
4178+Linked media
4179+------------
4180+
4181+By default, pandoc will download linked media (including audio and
4182+video) and include it in the EPUB container, yielding a completely
61704183self-contained EPUB. If you want to link to external media resources
61714184instead, use raw HTML in your source and add `data-external="1"` to the tag
61724185with the `src` attribute. For example:
61734186
61744187 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
4188+ <source src="http://example.com/music/toccata.mp3"
61764189 data-external="1" type="audio/mpeg">
61774190 </source>
61784191 </audio>
61794192
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−```
4193+Literate Haskell support
4194+========================
62194195
6220−## Pyout
4196+If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4197+format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4198+`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4199+literate Haskell source. This means that
62214200
6222−``` code
6223−from IPython.display import HTML
6224−HTML("""
6225−<script>
6226−console.log("hello");
6227−</script>
6228−<b>HTML</b>
6229−""")
6230−```
4201+ - In Markdown input, "bird track" sections will be parsed as Haskell
4202+ code rather than block quotations. Text between `\begin{code}`
4203+ and `\end{code}` will also be treated as Haskell code. For
4204+ ATX-style headers the character '=' will be used instead of '#'.
4205+
4206+ - In Markdown output, code blocks with classes `haskell` and `literate`
4207+ will be rendered using bird tracks, and block quotations will be
4208+ indented one space, so they will not be treated as Haskell code.
4209+ In addition, headers will be rendered setext-style (with underlines)
4210+ rather than ATX-style (with '#' characters). (This is because ghc
4211+ treats '#' characters in column 1 as introducing line numbers.)
4212+
4213+ - In restructured text input, "bird track" sections will be parsed
4214+ as Haskell code.
62314215
6232−## Image
4216+ - In restructured text output, code blocks with class `haskell` will
4217+ be rendered using bird tracks.
4218+
4219+ - In LaTeX input, text in `code` environments will be parsed as
4220+ Haskell code.
62334221
6234−This image  will be
6235−included as a cell attachment.
6236−````
4222+ - In LaTeX output, code blocks with class `haskell` will be rendered
4223+ inside `code` environments.
62374224
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:
4225+ - In HTML output, code blocks with class `haskell` will be rendered
4226+ with class `literatehaskell` and bird tracks.
62434227
6244−````
6245−:::::: {.cell .markdown}
6246−# Lorem
4228+Examples:
62474229
6248−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249−bibendum felis dictum sodales.
6250−::::::
4230+ pandoc -f markdown+lhs -t html
62514231
6252−:::::: {.cell .code execution_count=1}
6253−``` {.python}
6254−print("hello")
6255−```
4232+reads literate Haskell source formatted with Markdown conventions and writes
4233+ordinary HTML (without bird tracks).
62564234
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−```
4235+ pandoc -f markdown+lhs -t html+lhs
62744236
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
4237+writes HTML with the Haskell code in bird tracks, so it can be copied
4238+and pasted as literate Haskell source.
4239+
4240+Note that GHC expects the bird tracks in the first column, so indentend literate
4241+code blocks (e.g. inside an itemized environment) will not be picked up by the
4242+Haskell compiler.
4243+
4244+Syntax highlighting
4245+===================
63064246
63074247Pandoc will automatically highlight syntax in [fenced code blocks] that
63084248are marked with a language name. The Haskell library [skylighting] is
6309−used for highlighting. Currently highlighting is supported only for
6310−HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6311−that pandoc will recognize, type `pandoc --list-highlight-languages`.
4249+used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4250+To see a list of language names that pandoc will recognize, type
4251+`pandoc --list-highlight-languages`.
63124252
63134253The color scheme can be selected using the `--highlight-style` option.
63144254The default color scheme is `pygments`, which imitates the default color
@@ -6316,36 +4256,15 @@ scheme used by the Python library pygments (though pygments is not actually
63164256used to do the highlighting). To see a list of highlight styles,
63174257type `pandoc --list-highlight-styles`.
63184258
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−
63374259To disable highlighting, use the `--no-highlight` option.
63384260
63394261[skylighting]: https://github.com/jgm/skylighting
63404262
6341−# Custom Styles
4263+Custom Styles in Docx Output
4264+============================
63424265
6343−Custom styles can be used in the docx and ICML formats.
6344−
6345−## Output
6346−
6347−By default, pandoc's docx and ICML output applies a predefined set of styles
6348−for blocks such as paragraphs and block quotes, and uses largely default
4266+By default, pandoc's docx output applies a predefined set of styles for
4267+blocks such as paragraphs and block quotes, and uses largely default
63494268formatting (italics, bold) for inlines. This will work for most
63504269purposes, especially alongside a `reference.docx` file. However, if you
63514270need to apply your own styles to blocks, or match a preexisting set of
@@ -6353,28 +4272,26 @@ styles, pandoc allows you to define custom styles for blocks and text
63534272using `div`s and `span`s, respectively.
63544273
63554274If you define a `div` or `span` with the attribute `custom-style`,
6356−pandoc will apply your specified style to the contained elements (with
6357−the exception of elements whose function depends on a style, like
6358−headings, code blocks, block quotes, or links). So, for example, using
6359−the `bracketed_spans` syntax,
4275+pandoc will apply your specified style to the contained elements. So,
4276+for example,
63604277
6361− [Get out]{custom-style="Emphatically"}, he said.
4278+ <span custom-style="Emphatically">Get out,</span> he said.
63624279
6363−would produce a docx file with "Get out" styled with character
6364−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4280+would produce a docx file with "Get out," styled with character
4281+style `Emphatically`. Similarly,
63654282
63664283 Dickinson starts the poem simply:
63674284
6368− ::: {custom-style="Poetry"}
4285+ <div custom-style="Poetry">
63694286 | A Bird came down the Walk---
63704287 | He did not know I saw---
6371− :::
4288+ </div>
63724289
63734290would style the two contained lines with the `Poetry` paragraph style.
63744291
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.
4292+If the styles are not yet in your reference.docx, they will be defined
4293+in the output file as inheriting from normal text. If they are already
4294+defined, pandoc will not alter the definition.
63784295
63794296This feature allows for greatest customization in conjunction with
63804297[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -6384,137 +4301,34 @@ want all italics to be transformed to the `Emphasis` character style
63844301transform all italicized inlines to inlines within an `Emphasis`
63854302custom-style `span`.
63864303
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.
4304+[pandoc filters]: http://pandoc.org/filters.html
64034305
6404−For example, using the `custom-style-reference.docx` file in the test
6405−directory, we have the following different outputs:
4306+Custom writers
4307+==============
64064308
6407−Without the `+styles` extension:
4309+Pandoc can be extended with custom writers written in [lua]. (Pandoc
4310+includes a lua interpreter, so lua need not be installed separately.)
64084311
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
4312+To use a custom writer, simply specify the path to the lua script
64454313in place of the output format. For example:
64464314
64474315 pandoc -t data/sample.lua
64484316
6449−Creating a custom writer requires writing a Lua function for each
4317+Creating a custom writer requires writing a lua function for each
64504318possible element in a pandoc document. To get a documented example
64514319which you can modify according to your needs, do
64524320
64534321 pandoc --print-default-data-file sample.lua
64544322
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
4323+[lua]: http://www.lua.org
4324+
4325+Authors
4326+=======
4327+
4328+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
65144329under the [GPL], version 2 or greater. This software carries no
65154330warranty of any kind. (See COPYRIGHT for full copyright and
65164331warranty notices.) For a full list of contributors, see the file
65174332AUTHORS.md in the pandoc source code.
65184333
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"
4334+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"