@@ -1,14 +1,14 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% November 25, 2018
1+---
2+title: Pandoc User's Guide
3+author: John MacFarlane
4+date: June 20, 2021
5+---
46
5−Synopsis
6−========
7+# Synopsis
78
89`pandoc` [*options*] [*input-file*]...
910
10−Description
11−===========
11+# Description
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
1414another, and a command-line tool that uses this library.
@@ -40,8 +40,7 @@ model. While conversions from pandoc's Markdown to all formats aspire
4040to be perfect, conversions from formats more expressive than pandoc's
4141Markdown can be expected to be lossy.
4242
43−Using pandoc
44−------------
43+## Using pandoc
4544
4645If no *input-files* are specified, input is read from *stdin*.
4746Output goes to *stdout* by default. For output to a file,
@@ -62,8 +61,7 @@ If multiple input files are given, `pandoc` will concatenate them all (with
6261blank lines between them) before parsing. (Use `--file-scope` to parse files
6362individually.)
6463
65−Specifying formats
66−------------------
64+## Specifying formats
6765
6866The format of the input and output can be specified explicitly using
6967command-line options. The input format can be specified using the
@@ -95,8 +93,7 @@ If no input file is specified (so that input comes from *stdin*), or
9593if the input files' extensions are unknown, the input format will
9694be assumed to be Markdown.
9795
98−Character encoding
99−------------------
96+## Character encoding
10097
10198Pandoc uses the UTF-8 character encoding for both input and output.
10299If your local character encoding is not UTF-8, you
@@ -109,10 +106,9 @@ RTF, OPML, DocBook, and Texinfo), information about
109106the character encoding is included in the document header, which
110107will only be included if you use the `-s/--standalone` option.
111108
112−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
113110
114−Creating a PDF
115−--------------
111+## Creating a PDF
116112
117113To produce a PDF, specify an output file with a `.pdf` extension:
118114
@@ -120,20 +116,18 @@ To produce a PDF, specify an output file with a `.pdf` extension:
120116
121117By default, pandoc will use LaTeX to create the PDF, which requires
122118that a LaTeX engine be installed (see `--pdf-engine` below).
123−
124−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126−[`weasyprint`] or [`prince`].
127−To do this, specify an output file with a `.pdf` extension, as before,
128−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
130−
131−PDF output can be controlled using [variables for LaTeX] (if
132−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
133−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
134−If `wkhtmltopdf` is used, then the variables `margin-left`,
135−`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
136−`header-html` and `papersize` will affect the output.
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`.
137131
138132To debug the PDF creation, it can be useful to look at the intermediate
139133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -142,33 +136,32 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
142136When using LaTeX, the following packages need to be available
143137(they are included with all recent versions of [TeX Live]):
144138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
145−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
146140`--listings` option is used), [`fancyvrb`], [`longtable`],
147−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141+[`booktabs`], [`graphicx`] (if the document
148142contains images), [`hyperref`], [`xcolor`],
149143[`ulem`], [`geometry`] (with the `geometry` variable set),
150144[`setspace`] (with `linestretch`), and
151145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
152−the PDF engine requires [`fontspec`]. `xelatex` uses
153−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
154−`dir` variable set). If the `mathspec` variable is set,
155−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
156−The [`upquote`] and [`microtype`] packages are used if
157−available, and [`csquotes`] will be used for [typography]
158−if `\usepackage{csquotes}` is present in the template or
159−included via `/H/--include-in-header`. The [`natbib`],
160−[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
161−be used for [citation rendering]. The following packages
162−will be used to improve output quality if present, but
163−pandoc does not require them to be present:
164−[`upquote`] (for straight quotes in verbatim environments),
165−[`microtype`] (for better spacing adjustments),
166−[`parskip`] (for better inter-paragraph spaces),
167−[`xurl`] (for better line breaks in URLs),
168−[`bookmark`] (for better PDF bookmarks),
169−and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
170−
171−[TeX Live]: http://www.tug.org/texlive/
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/
172165[`amsfonts`]: https://ctan.org/pkg/amsfonts
173166[`amsmath`]: https://ctan.org/pkg/amsmath
174167[`babel`]: https://ctan.org/pkg/babel
@@ -187,8 +180,7 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
187180[`graphicx`]: https://ctan.org/pkg/graphicx
188181[`grffile`]: https://ctan.org/pkg/grffile
189182[`hyperref`]: https://ctan.org/pkg/hyperref
190−[`ifluatex`]: https://ctan.org/pkg/ifluatex
191−[`ifxetex`]: https://ctan.org/pkg/ifxetex
183+[`iftex`]: https://ctan.org/pkg/iftex
192184[`listings`]: https://ctan.org/pkg/listings
193185[`lm`]: https://ctan.org/pkg/lm
194186[`longtable`]: https://ctan.org/pkg/longtable
@@ -202,41 +194,44 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
202194[`ulem`]: https://ctan.org/pkg/ulem
203195[`unicode-math`]: https://ctan.org/pkg/unicode-math
204196[`upquote`]: https://ctan.org/pkg/upquote
205−[`weasyprint`]: http://weasyprint.org
197+[`weasyprint`]: https://weasyprint.org
206198[`wkhtmltopdf`]: https://wkhtmltopdf.org
207199[`xcolor`]: https://ctan.org/pkg/xcolor
208200[`xecjk`]: https://ctan.org/pkg/xecjk
209201[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
210203
211204
212205
213−Reading from the Web
214−--------------------
206+## Reading from the Web
215207
216−Instead of an input file, an absolute URI may be given. In this case
208+Instead of an input file, an absolute URI may be given. In this case
217209pandoc will fetch the content using HTTP:
218210
219− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
220212
221213It is possible to supply a custom User-Agent string or other
222214header when requesting a document from a URL:
223215
224216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
225− http://www.fsf.org
217+ https://www.fsf.org
226218
227−Options
228−=======
219+# Options
229220
230−General options {.options}
231−---------------
221+## General options {.options}
232222
233223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
234224
235225: Specify input format. *FORMAT* can be:
236226
237227 ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
238230 - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
239232 - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
240235 - `docbook` ([DocBook])
241236 - `docx` ([Word docx])
242237 - `dokuwiki` ([DokuWiki markup])
@@ -248,7 +243,9 @@ General options {.options}
248243 if you need extensions not supported in [`gfm`](#markdown-variants).
249244 - `haddock` ([Haddock markup])
250245 - `html` ([HTML])
246+ - `ipynb` ([Jupyter notebook])
251247 - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
252249 - `json` (JSON version of native AST)
253250 - `latex` ([LaTeX])
254251 - `markdown` ([Pandoc's Markdown])
@@ -281,10 +278,14 @@ General options {.options}
281278: Specify output format. *FORMAT* can be:
282279
283280 ::: {#output-formats}
284− - `asciidoc` ([AsciiDoc])
281+ - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
285282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
286285 - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
287287 - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
288289 - `docbook` or `docbook4` ([DocBook] 4)
289290 - `docbook5` (DocBook 5)
290291 - `docx` ([Word docx])
@@ -300,7 +301,12 @@ General options {.options}
300301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
301302 - `html4` ([XHTML] 1.0 Transitional)
302303 - `icml` ([InDesign ICML])
303− - `jats` ([JATS] XML)
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)
304310 - `json` (JSON version of native AST)
305311 - `latex` ([LaTeX])
306312 - `man` ([roff man])
@@ -316,6 +322,7 @@ General options {.options}
316322 - `opml` ([OPML])
317323 - `opendocument` ([OpenDocument])
318324 - `org` ([Emacs Org mode])
325+ - `pdf` ([PDF])
319326 - `plain` (plain text),
320327 - `pptx` ([PowerPoint] slide show)
321328 - `rst` ([reStructuredText])
@@ -328,11 +335,12 @@ General options {.options}
328335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
329336 - `s5` ([S5] HTML and JavaScript slide show)
330337 - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
331339 - `zimwiki` ([ZimWiki markup])
332− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
333341 :::
334342
335− Note that `odt`, `docx`, and `epub` output will not be directed
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
336344 to *stdout* unless forced with `-o -`.
337345
338346 Extensions can be individually enabled or
@@ -350,23 +358,32 @@ General options {.options}
350358
351359: Specify the user data directory to search for pandoc data files.
352360 If this option is not specified, the default user data directory
353− will be used. This is, in UNIX:
354−
355− $HOME/.pandoc
356−
357− in Windows XP:
358−
359− C:\Documents And Settings\USERNAME\Application Data\pandoc
360−
361− and in Windows Vista or later:
362−
363− C:\Users\USERNAME\AppData\Roaming\pandoc
364−
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`.
365368 You can find the default user data directory on your system by
366369 looking at the output of `pandoc --version`.
367− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
368− `slidy`, `slideous`, or `s5` directory
369− placed in this directory will override pandoc's normal defaults.
370+ Data files placed in this directory (for example, `reference.odt`,
371+ `reference.docx`, `epub.css`, `templates`) will override
372+ pandoc's normal defaults.
373+
374+`-d` *FILE*, `--defaults=`*FILE*
375+
376+: Specify a set of default option settings. *FILE* is a YAML
377+ file whose fields correspond to command-line option
378+ settings. All options for document conversion, including input
379+ and output files, can be set using a defaults file. The file will
380+ be searched for first in the working directory, and then in
381+ the `defaults` subdirectory of the user data directory
382+ (see `--data-dir`). The `.yaml` extension may be omitted.
383+ See the section [Default files] for more information on the
384+ file format. Settings from the defaults file may be
385+ overridden or extended by subsequent options on the command
386+ line.
370387
371388`--bash-completion`
372389
@@ -377,8 +394,7 @@ General options {.options}
377394
378395`--verbose`
379396
380−: Give verbose debugging output. Currently this only has an effect
381− with PDF output.
397+: Give verbose debugging output.
382398
383399`--quiet`
384400
@@ -404,7 +420,7 @@ General options {.options}
404420
405421`--list-extensions`[`=`*FORMAT*]
406422
407−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
408424 by a `+` or `-` indicating whether it is enabled by default
409425 in *FORMAT*. If *FORMAT* is not specified, defaults for
410426 pandoc's Markdown are given.
@@ -427,62 +443,88 @@ General options {.options}
427443
428444: Show usage message.
429445
430−[Markdown]: http://daringfireball.net/projects/markdown/
431−[CommonMark]: http://commonmark.org
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
432448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
433449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
434−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
435−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
436−[S5]: http://meyerweb.com/eric/tools/s5/
437−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
438−[Slideous]: http://goessner.net/articles/slideous/
439−[HTML]: http://www.w3.org/html/
440−[HTML5]: http://www.w3.org/TR/html5/
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/
441457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
442−[XHTML]: http://www.w3.org/TR/xhtml1/
443−[LaTeX]: http://latex-project.org
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
444460[`beamer`]: https://ctan.org/pkg/beamer
445−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
446−[ConTeXt]: http://www.contextgarden.net/
447−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
448−[DocBook]: http://docbook.org
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
449465[JATS]: https://jats.nlm.nih.gov
450−[txt2tags]: http://txt2tags.org
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
451468[EPUB]: http://idpf.org/epub
452469[OPML]: http://dev.opml.org/spec2.html
453470[OpenDocument]: http://opendocument.xml.org
454−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
455−[Textile]: http://redcloth.org/textile
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
456473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
457474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
458−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
459−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
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
460478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
461479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
462480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
463−[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
464−[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
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)
465484[Haskell]: https://www.haskell.org
466−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
467−[Emacs Org mode]: http://orgmode.org
468−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
469−[DZSlides]: http://paulrouget.com/dzslides/
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/
470490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
471491[PDF]: https://www.adobe.com/pdf/
472−[reveal.js]: http://lab.hakim.se/reveal-js/
492+[reveal.js]: https://revealjs.com/
473493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
474−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
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
475496[TEI Simple]: https://github.com/TEIC/TEI-Simple
476497[Muse]: https://amusewiki.org/library/manual
477498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
478499[Vimwiki]: https://vimwiki.github.io
479−
480−Reader options {.options}
481−--------------
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.
482522
483523`--base-header-level=`*NUMBER*
484524
485−: Specify the base level for headers (defaults to 1).
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
526+ where X = NUMBER - 1.* Specify the base level for headings
527+ (defaults to 1).
486528
487529`--strip-empty-paragraphs`
488530
@@ -547,41 +589,32 @@ Reader options {.options}
547589
548590 3. `$PATH` (executable only)
549591
550− Filters and lua-filters are applied in the order specified
551− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
552594
553−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
554596
555597: Transform the document in a similar fashion as JSON filters (see
556− `--filter`), but use pandoc's build-in lua filtering system. The given
557− lua script is expected to return a list of lua filters which will be
558− applied in order. Each lua filter must contain element-transforming
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
599+ Lua script is expected to return a list of Lua filters which will be
600+ applied in order. Each Lua filter must contain element-transforming
559601 functions indexed by the name of the AST element on which the filter
560602 function should be applied.
561603
562− The `pandoc` lua module provides helper functions for element
563− creation. It is always loaded into the script's lua environment.
604+ The `pandoc` Lua module provides helper functions for element
605+ creation. It is always loaded into the script's Lua environment.
564606
565− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
566608
567− function expand_hello_world(inline)
568− if inline.c == '{{helloworld}}' then
569− return pandoc.Emph{ pandoc.Str "Hello, World" }
570− else
571− return inline
572− end
573− end
609+ In order of preference, pandoc will look for Lua filters in
574610
575− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
576612
577− In order of preference, pandoc will look for lua filters in
578−
579− 1. a specified full or relative path (executable or
580− non-executable)
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
581615
582− 2. `$DATADIR/filters` (executable or non-executable)
583− where `$DATADIR` is the user data directory (see
584− `--data-dir`, above).
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
585618
586619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
587620
@@ -598,19 +631,23 @@ Reader options {.options}
598631
599632`--metadata-file=`*FILE*
600633
601−: Read metadata from the supplied YAML (or JSON) file.
602− This option can be used with every input format, but string
603− scalars in the YAML file will always be parsed as Markdown.
604− Generally, the input will be handled the same as in
605− [YAML metadata blocks][Extension: `yaml_metadata_block`].
606− Metadata values specified inside the document, or by using `-M`,
607− overwrite values specified with this option.
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.
608644
609645`-p`, `--preserve-tabs`
610646
611−: Preserve tabs instead of converting them to spaces (the default).
612− Note that this will only affect tabs in literal code spans and code
613− blocks; tabs in regular text will be treated as spaces.
647+: Preserve tabs instead of converting them to spaces. (By default, pandoc
648+ converts tabs to spaces before parsing its input.) Note that this will
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
650+ text are always treated as spaces.
614651
615652`--tab-stop=`*NUMBER*
616653
@@ -620,30 +657,30 @@ Reader options {.options}
620657
621658: Specifies what to do with insertions, deletions, and comments
622659 produced by the MS Word "Track Changes" feature. `accept` (the
623− default), inserts all insertions, and ignores all
624− deletions. `reject` inserts all deletions and ignores
625− insertions. Both `accept` and `reject` ignore comments. `all` puts
626− in insertions, deletions, and comments, wrapped in spans with
627− `insertion`, `deletion`, `comment-start`, and `comment-end`
628− classes, respectively. The author and time of change is
629− included. `all` is useful for scripting: only accepting changes
630− from a certain reviewer, say, or before a certain date. If a
631− paragraph is inserted or deleted, `track-changes=all` produces a
632− span with the class `paragraph-insertion`/`paragraph-deletion`
633− before the affected paragraph break. This option only affects the
634− docx reader.
660+ default) processes all the insertions and deletions.
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
662+ `all` includes all insertions, deletions, and comments, wrapped
663+ in spans with `insertion`, `deletion`, `comment-start`, and
664+ `comment-end` classes, respectively. The author and time of
665+ change is included. `all` is useful for scripting: only
666+ accepting changes from a certain reviewer, say, or before a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
669+ `paragraph-insertion`/`paragraph-deletion` before the
670+ affected paragraph break. This option only affects the docx
671+ reader.
635672
636673`--extract-media=`*DIR*
637674
638675: Extract images and other media contained in or linked from
639676 the source document to the path *DIR*, creating it if
640677 necessary, and adjust the images references in the document
641− so they point to the extracted files. If the source format is
642− a binary container (docx, epub, or odt), the media is
643− extracted from the container and the original
644− filenames are used. Otherwise the media is read from the
645− file system or downloaded, and new filenames are constructed
646− based on SHA1 hashes of the contents.
678+ so they point to the extracted files. Media are downloaded,
679+ read from the file system, or extracted from a binary
680+ container (e.g. docx), as needed. The original file paths
681+ are used if they are relative paths not containing `..`.
682+ Otherwise filenames are constructed from the SHA1 hash of
683+ the contents.
647684
648685`--abbreviations=`*FILE*
649686
@@ -654,17 +691,17 @@ Reader options {.options}
654691 system default, use
655692 `pandoc --print-default-data-file=abbreviations`. The only
656693 use pandoc makes of this list is in the Markdown reader.
657− Strings ending in a period that are found in this list will
658− be followed by a nonbreaking space, so that the period will
659− not produce sentence-ending space in formats like LaTeX.
694+ Strings found in this list will be followed by a nonbreaking
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
660697
661698[`pandocfilters`]: https://github.com/jgm/pandocfilters
662699[PHP]: https://github.com/vinai/pandocfilters-php
663700[perl]: https://metacpan.org/pod/Pandoc::Filter
664701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
665703
666−General writer options {.options}
667−----------------------
704+## General writer options {.options}
668705
669706`-s`, `--standalone`
670707
@@ -689,22 +726,29 @@ General writer options {.options}
689726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
690727
691728: Set the template variable *KEY* to the value *VAL* when rendering the
692− document in standalone mode. This is generally only useful when the
693− `--template` option is used to specify a custom template, since
694− pandoc automatically sets the variables used in the default
695− templates. If no *VAL* is specified, the key will be given the
696− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
697731
698732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
699733
700734: Print the system default template for an output *FORMAT*. (See `-t`
701735 for a list of possible *FORMAT*s.) Templates in the user data
702− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
740+
741+ Note that some of the default templates use partials, for
742+ example `styles.html`. To print the partials, use
743+ `--print-default-data-file`: for example,
744+ `--print-default-data-file=templates/styles.html`.
703745
704746`--print-default-data-file=`*FILE*
705747
706748: Print a system default data file. Files in the user data directory
707− are ignored.
749+ are ignored. This option may be used with `-o`/`--output` to
750+ redirect output to a file, but `-o`/`--output` must come before
751+ `--print-default-data-file` on the command line.
708752
709753`--eol=crlf`|`lf`|`native`
710754
@@ -715,9 +759,12 @@ General writer options {.options}
715759
716760`--dpi`=*NUMBER*
717761
718−: Specify the dpi (dots per inch) value for conversion from pixels
719− to inch/centimeters and vice versa. The default is 96dpi.
720− Technically, the correct term would be ppi (pixels per inch).
762+: Specify the default dpi (dots per inch) value for conversion
763+ from pixels to inch/centimeters and vice versa. (Technically,
764+ the correct term would be ppi: pixels per inch.) The default
765+ is 96dpi. When images contain information about dpi
766+ internally, the encoded value is used instead of the default
767+ specified by this option.
721768
722769`--wrap=auto`|`none`|`preserve`
723770
@@ -730,6 +777,8 @@ General writer options {.options}
730777 where there are nonsemantic newlines in the source, there
731778 will be nonsemantic newlines in the output as well).
732779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
733782
734783`--columns=`*NUMBER*
735784
@@ -746,11 +795,17 @@ General writer options {.options}
746795 unless `-s/--standalone` is used, and it has no effect
747796 on `man`, `docbook4`, `docbook5`, or `jats` output.
748797
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`.
803+
749804`--toc-depth=`*NUMBER*
750805
751806: Specify the number of section levels to include in the table
752− of contents. The default is 3 (which means that level 1, 2, and 3
753− headers will be listed in the contents).
807+ of contents. The default is 3 (which means that level-1, 2, and 3
808+ headings will be listed in the contents).
754809
755810`--strip-comments`
756811
@@ -786,7 +841,10 @@ General writer options {.options}
786841
787842: Prints a JSON version of a highlighting style, which can
788843 be modified, saved with a `.theme` extension, and used
789− with `--highlight-style`.
844+ with `--highlight-style`. This option may be used with
845+ `-o`/`--output` to redirect output to a file, but
846+ `-o`/`--output` must come before `--print-highlight-style`
847+ on the command line.
790848
791849`--syntax-definition=`*FILE*
792850
@@ -794,9 +852,10 @@ General writer options {.options}
794852 which will be used for syntax highlighting of appropriately
795853 marked code blocks. This can be used to add support for
796854 new languages or to use altered syntax definitions for
797− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
798857
799−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
800859
801860: Include contents of *FILE*, verbatim, at the end of the header.
802861 This can be used, for example, to include special
@@ -804,7 +863,7 @@ General writer options {.options}
804863 repeatedly to include multiple files in the header. They will be
805864 included in the order specified. Implies `--standalone`.
806865
807−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
808867
809868: Include contents of *FILE*, verbatim, at the beginning of the
810869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -813,7 +872,7 @@ General writer options {.options}
813872 used repeatedly to include multiple files. They will be included in
814873 the order specified. Implies `--standalone`.
815874
816−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
817876
818877: Include contents of *FILE*, verbatim, at the end of the document
819878 body (before the `</body>` tag in HTML, or the
@@ -832,11 +891,11 @@ General writer options {.options}
832891 will not be searched. For example:
833892 `--resource-path=.:test` will search the working directory
834893 and the `test` subdirectory, in that order.
835−
836− `--resource-path` only has an effect if (a) the output
837− format embeds images (for example, `docx`, `pdf`, or `html`
838− with `--self-contained`) or (b) it is used together with
839− `--extract-media`.
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`.
840899
841900`--request-header=`*NAME*`:`*VAL*
842901
@@ -846,8 +905,13 @@ General writer options {.options}
846905 downloaded). If you're behind a proxy, you also need to set
847906 the environment variable `http_proxy` to `http://...`.
848907
849−Options affecting specific writers {.options}
850−----------------------------------
908+`--no-check-certificate`
909+
910+: Disable the certificate verification to allow access to
911+ unsecure HTTP resources (for example when the certificate
912+ is no longer valid or self signed).
913+
914+## Options affecting specific writers {.options}
851915
852916`--self-contained`
853917
@@ -872,7 +936,9 @@ Options affecting specific writers {.options}
872936
873937`--html-q-tags`
874938
875−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
941+ format used.)
876942
877943`--ascii`
878944
@@ -890,36 +956,45 @@ Options affecting specific writers {.options}
890956 placement of link references is affected by the
891957 `--reference-location` option.
892958
893−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
894960
895961: Specify whether footnotes (and references, if `reference-links` is
896962 set) are placed at the end of the current (top-level) block, the
897963 current section, or the document. The default is
898964 `document`. Currently only affects the markdown writer.
899965
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+
900974`--atx-headers`
901975
902−: Use ATX-style headers in Markdown output. The default is
903− to use setext-style headers for levels 1-2, and then ATX headers.
904− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
905977
906−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
907979
908−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
909− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
910− all headers are shifted such that the top-level header becomes the specified
911− type. The default behavior is to determine the best division type via
912− heuristics: unless other conditions apply, `section` is chosen. When the
913− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
914− `article` option is specified), `chapter` is implied as the setting for this
915− option. If `beamer` is the output format, specifying either `chapter` or
916− `part` will cause top-level headers to become `\part{..}`, while
917− second-level headers remain as their default type.
980+: Treat top-level headings as the given division type in
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
983+ shifted such that the top-level heading becomes the
984+ specified type. The default behavior is to determine the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
987+ variable is set to `report`, `book`, or `memoir` (unless the
988+ `article` option is specified), `chapter` is implied as the
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
992+ remain as their default type.
918993
919994`-N`, `--number-sections`
920995
921−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
922− By default, sections are not numbered. Sections with class
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997+ output. By default, sections are not numbered. Sections with class
923998 `unnumbered` will never be numbered, even if `--number-sections`
924999 is specified.
9251000
@@ -927,10 +1002,10 @@ Options affecting specific writers {.options}
9271002
9281003: Offset for section headings in HTML output (ignored in other
9291004 output formats). The first number is added to the section number for
930− top-level headers, the second for second-level headers, and so on.
931− So, for example, if you want the first top-level header in your
1005+ top-level headings, the second for second-level headings, and so on.
1006+ So, for example, if you want the first top-level heading in your
9321007 document to be numbered "6", specify `--number-offset=5`.
933− If your document starts with a level-2 header which you want to
1008+ If your document starts with a level-2 heading which you want to
9341009 be numbered "1.5", specify `--number-offset=1,4`.
9351010 Offsets are 0 by default. Implies `--number-sections`.
9361011
@@ -938,7 +1013,7 @@ Options affecting specific writers {.options}
9381013
9391014: Use the [`listings`] package for LaTeX code blocks. The package
9401015 does not support multi-byte encoding for source code. To handle UTF-8
941− you would need to use a custom template. This issue is fully
1016+ you would need to use a custom template. This issue is fully
9421017 documented here: [Encoding issue with the listings package].
9431018
9441019`-i`, `--incremental`
@@ -948,12 +1023,12 @@ Options affecting specific writers {.options}
9481023
9491024`--slide-level=`*NUMBER*
9501025
951−: Specifies that headers with the specified level create
952− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1026+: Specifies that headings with the specified level create
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
9531028 above this level in the hierarchy are used to divide the
954− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
9551030 subheads within a slide. Note that content that is
956− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
9571032 the slide show. The default is to set the slide level based
9581033 on the contents of the document; see [Structuring the slide
9591034 show].
@@ -962,8 +1037,8 @@ Options affecting specific writers {.options}
9621037
9631038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
9641039 and attach identifiers to the enclosing `<section>` (or `<div>`)
965− rather than the header itself. See
966− [Header identifiers], below.
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
9671042
9681043`--email-obfuscation=none`|`javascript`|`references`
9691044
@@ -984,8 +1059,7 @@ Options affecting specific writers {.options}
9841059
9851060: Specify *STRING* as a prefix at the beginning of the title
9861061 that appears in the HTML header (but not in the title as it
987− appears at the beginning of the HTML body). Implies
988− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
9891063
9901064`-c` *URL*, `--css=`*URL*
9911065
@@ -1017,20 +1091,56 @@ Options affecting specific writers {.options}
10171091
10181092 To produce a custom `reference.docx`, first get a copy of
10191093 the default `reference.docx`: `pandoc
1020− --print-default-data-file reference.docx >
1021− custom-reference.docx`. Then open `custom-reference.docx`
1022− in Word, modify the styles as you wish, and save the file.
1023− For best results, do not make changes to this file other
1024− than modifying the styles used by pandoc: [paragraph]
1025− Normal, Body Text, First Paragraph, Compact, Title,
1026− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1027− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
1028− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1029− Definition Term, Definition, Caption, Table Caption,
1030− Image Caption, Figure, Captioned Figure, TOC Heading;
1031− [character] Default Paragraph Font, Body Text Char,
1032− Verbatim Char, Footnote Reference, Hyperlink; [table]
1033− Table.
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
1095+ Then open `custom-reference.docx` in Word, modify the
1096+ styles as you wish, and save the file. For best
1097+ results, do not make changes to this file other than
1098+ modifying the styles used by pandoc:
1099+
1100+ Paragraph styles:
1101+
1102+ - Normal
1103+ - Body Text
1104+ - First Paragraph
1105+ - Compact
1106+ - Title
1107+ - Subtitle
1108+ - Author
1109+ - Date
1110+ - Abstract
1111+ - Bibliography
1112+ - Heading 1
1113+ - Heading 2
1114+ - Heading 3
1115+ - Heading 4
1116+ - Heading 5
1117+ - Heading 6
1118+ - Heading 7
1119+ - Heading 8
1120+ - Heading 9
1121+ - Block Text
1122+ - Footnote Text
1123+ - Definition Term
1124+ - Definition
1125+ - Caption
1126+ - Table Caption
1127+ - Image Caption
1128+ - Figure
1129+ - Captioned Figure
1130+ - TOC Heading
1131+
1132+ Character styles:
1133+
1134+ - Default Paragraph Font
1135+ - Body Text Char
1136+ - Verbatim Char
1137+ - Footnote Reference
1138+ - Hyperlink
1139+ - Section Number
1140+
1141+ Table style:
1142+
1143+ - Table
10341144
10351145 ODT
10361146
@@ -1044,19 +1154,18 @@ Options affecting specific writers {.options}
10441154
10451155 To produce a custom `reference.odt`, first get a copy of
10461156 the default `reference.odt`: `pandoc
1047− --print-default-data-file reference.odt >
1048− custom-reference.odt`. Then open `custom-reference.odt` in
1049− LibreOffice, modify the styles as you wish, and save the
1050− file.
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
1158+ Then open `custom-reference.odt` in LibreOffice, modify
1159+ the styles as you wish, and save the file.
10511160
10521161 PowerPoint
10531162
1054− : Any template included with a recent install of Microsoft
1055− PowerPoint (either with `.pptx` or `.potx` extension) should
1056− work, as will most templates derived from these.
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.
10571166
1058− The specific requirement is that the template should contain
1059− the following four layouts as its first four layouts:
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
10601169
10611170 1. Title Slide
10621171 2. Title and Content
@@ -1068,10 +1177,10 @@ Options affecting specific writers {.options}
10681177 `Home` menu to check.)
10691178
10701179 You can also modify the default `reference.pptx`: first run
1071− `pandoc --print-default-data-file reference.pptx >
1072− custom-reference.pptx`, and then modify
1073− `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1074− first four layout slides, as mentioned above).
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).
10751184
10761185`--epub-cover-image=`*FILE*
10771186
@@ -1139,12 +1248,12 @@ Options affecting specific writers {.options}
11391248
11401249`--epub-chapter-level=`*NUMBER*
11411250
1142−: Specify the header level at which to split the EPUB into separate
1143− "chapter" files. The default is to split into chapters at level 1
1144− headers. This option only affects the internal composition of the
1251+: Specify the heading level at which to split the EPUB into separate
1252+ "chapter" files. The default is to split into chapters at level-1
1253+ headings. This option only affects the internal composition of the
11451254 EPUB, not the way chapters and sections are displayed to users. Some
11461255 readers may be slow if the chapter files are too large, so for large
1147− documents with few level 1 headers, one might want to use a chapter
1256+ documents with few level-1 headings, one might want to use a chapter
11481257 level of 2 or 3.
11491258
11501259`--epub-subdirectory=`*DIRNAME*
@@ -1153,71 +1262,118 @@ Options affecting specific writers {.options}
11531262 the EPUB-specific contents. The default is `EPUB`. To put
11541263 the EPUB contents in the top level, use an empty string.
11551264
1156−`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1265+`--ipynb-output=all|none|best`
1266+
1267+: Determines how ipynb output cells are treated. `all` means
1268+ that all of the data formats included in the original are
1269+ preserved. `none` means that the contents of data cells
1270+ are omitted. `best` causes pandoc to try to pick the
1271+ richest data block in each output cell that is compatible
1272+ with the output format. The default is `best`.
1273+
1274+`--pdf-engine=`*PROGRAM*
11571275
11581276: Use the specified engine when producing PDF output.
1159− The default is `pdflatex`. If the engine is not in your PATH,
1160− the full path of the engine may be specified here.
1277+ Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278+ `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1280+ path of the engine may be specified here. If this option
1281+ is not specified, pandoc uses the following defaults
1282+ depending on the output format specified using `-t/--to`:
1283+
1284+ - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285+ `tectonic`, `latexmk`)
1286+ - `-t context`: `context`
1287+ - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288+ see [print-css.rocks](https://print-css.rocks) for a good
1289+ introduction to PDF generation from HTML/CSS.)
1290+ - `-t ms`: `pdfroff`
11611291
11621292`--pdf-engine-opt=`*STRING*
11631293
11641294: Use the given string as a command-line argument to the `pdf-engine`.
1165− If used multiple times, the arguments are provided with spaces between
1166− them. Note that no check for duplicate options is done.
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.
11671298
1168−[Dublin Core elements]: http://dublincore.org/documents/dces/
1169−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
11701301[Encoding issue with the listings package]:
11711302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
11721303
1173−Citation rendering {.options}
1174−------------------
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].
11751324
11761325`--bibliography=`*FILE*
11771326
11781327: Set the `bibliography` field in the document's metadata to *FILE*,
1179− overriding any value set in the metadata, and process citations
1180− using `pandoc-citeproc`. (This is equivalent to
1181− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1182− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1183− used, making this equivalent to `--metadata bibliography=FILE`.
1184− If you supply this argument multiple times, each *FILE* will be added
1185− to bibliography.
1328+ overriding any value set in the metadata. If you supply
1329+ this argument multiple times, each *FILE* will be added to
1330+ bibliography. If *FILE* is a URL, it will be fetched
1331+ via HTTP. If *FILE* is not found relative to the
1332+ working directory, it will be sought in the resource path
1333+ (see `--resource-path`).
11861334
11871335`--csl=`*FILE*
11881336
11891337: Set the `csl` field in the document's metadata to *FILE*,
11901338 overriding any value set in the metadata. (This is equivalent to
1191− `--metadata csl=FILE`.)
1192− This option is only relevant with `pandoc-citeproc`.
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340+ fetched via HTTP. If *FILE* is not found relative to the
1341+ working directory, it will be sought in the resource path
1342+ (see `--resource-path`) and finally in the `csl`
1343+ subdirectory of the pandoc user data directory.
11931344
11941345`--citation-abbreviations=`*FILE*
11951346
11961347: Set the `citation-abbreviations` field in the document's metadata to
11971348 *FILE*, overriding any value set in the metadata. (This is equivalent to
11981349 `--metadata citation-abbreviations=FILE`.)
1199− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
12001354
12011355`--natbib`
12021356
1203−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1204− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1205− use in producing a LaTeX file that can be processed with [`bibtex`].
1357+: Use [`natbib`] for citations in LaTeX output. This option
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1360+ that can be processed with [`bibtex`].
12061361
12071362`--biblatex`
12081363
1209−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1210− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1211− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1367+ that can be processed with [`bibtex`] or [`biber`].
12121368
1213−Math rendering in HTML {.options}
1214−----------------------
1369+## Math rendering in HTML {.options}
12151370
1216−The default is to render TeX math as far as possible using Unicode characters.
1217−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1218−differently from the surrounding text if needed. However, this gives acceptable
1219−results only for basic math, usually you will want to use `--mathjax` or another
1220−of the following options.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1373+`class="math"`, so that they may be styled differently from the
1374+surrounding text if needed. However, this gives acceptable
1375+results only for basic math, usually you will want to use
1376+`--mathjax` or another of the following options.
12211377
12221378`--mathjax`[`=`*URL*]
12231379
@@ -1231,10 +1387,11 @@ of the following options.
12311387
12321388`--mathml`
12331389
1234−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1235− `html4` and `html5`). This is the default in `odt` output. Note that
1236− currently only Firefox and Safari (and select e-book readers) natively
1237− support MathML.
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1392+ default in `odt` output. Note that currently only Firefox
1393+ and Safari (and select e-book readers) natively support
1394+ MathML.
12381395
12391396`--webtex`[`=`*URL*]
12401397
@@ -1258,21 +1415,19 @@ of the following options.
12581415`--gladtex`
12591416
12601417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1261− can then be processed by [GladTeX] to produce images of the typeset
1262− formulas and an HTML file with links to these images.
1263− So, the procedure is:
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
12641420
12651421 pandoc -s --gladtex input.md -o myfile.htex
1266− gladtex -d myfile-images myfile.htex
1267− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
12681424
1269−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
12701426[MathJax]: https://www.mathjax.org
12711427[KaTeX]: https://github.com/Khan/KaTeX
1272−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
12731429
1274−Options for wrapper scripts {.options}
1275−---------------------------
1430+## Options for wrapper scripts {.options}
12761431
12771432`--dump-args`
12781433
@@ -1296,8 +1451,277 @@ Options for wrapper scripts {.options}
12961451
12971452 pandoc -o foo.html -s
12981453
1299−Templates
1300−=========
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
13011725
13021726When the `-s/--standalone` option is used, pandoc uses a template to
13031727add header and footer material that is needed for a self-standing
@@ -1317,400 +1741,981 @@ directory (see `--data-dir`, above). *Exceptions:*
13171741 (or the `default.context` template, if you use `-t context`,
13181742 or the `default.ms` template, if you use `-t ms`, or the
13191743 `default.html` template, if you use `-t html`).
1320−- `docx` has no template (however, you can use
1744+- `docx` and `pptx` have no template (however, you can use
13211745 `--reference-doc` to customize the output).
13221746
13231747Templates contain *variables*, which allow for the inclusion of
13241748arbitrary information at any point in the file. They may be set at the
13251749command line using the `-V/--variable` option. If a variable is not set,
1326−pandoc will look for the key in the document's metadata – which can be set
1750+pandoc will look for the key in the document's metadata, which can be set
13271751using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1328−or with the `--metadata` option.
1329−
1330−Variables set by pandoc
1331−-----------------------
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.
13321755
1333−Some variables are set automatically by pandoc. These vary somewhat
1334−depending on the output format, but include the following:
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.
13351761
1336−`sourcefile`, `outputfile`
1337−: source and destination filenames, as given on the command line.
1338− `sourcefile` can also be a list if input comes from multiple files, or empty
1339− if input is from stdin. You can use the following snippet in your template
1340− to distinguish them:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
13411763
1342− $if(sourcefile)$
1343− $for(sourcefile)$
1344− $sourcefile$
1345− $endfor$
1346− $else$
1347− (stdin)
1348− $endif$
1764+## Template syntax
13491765
1350− Similarly, `outputfile` can be `-` if output goes to the terminal.
1766+### Comments
13511767
1352−`title`, `author`, `date`
1353−: allow identification of basic aspects of the document. Included
1354− in PDF metadata through LaTeX and ConTeXt. These can be set
1355− through a [pandoc title block][Extension: `pandoc_title_block`],
1356− which allows for multiple authors, or through a YAML metadata block:
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
13571770
1358− ---
1359− author:
1360− - Aristotle
1361− - Peter Abelard
1362− ...
1771+### Delimiters
13631772
1364−`subtitle`
1365−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx
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.
13661781
1367−`institute`
1368−: author affiliations (in LaTeX and Beamer only). Can be a
1369− list, when there are multiple authors.
1782+To include a literal `$` in the document, use `$$`.
13701783
1371−`abstract`
1372−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
1784+### Interpolated variables
13731785
1374−`keywords`
1375−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1376− may be repeated as for `author`, above
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:
13771791
1378−`header-includes`
1379−: contents specified by `-H/--include-in-header` (may have multiple
1380− values)
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+```
13811802
1382−`toc`
1383−: non-null value if `--toc/--table-of-contents` was specified
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.
13841807
1385−`toc-title`
1386−: title of table of contents (works only with EPUB,
1387− opendocument, odt, docx, pptx, beamer, LaTeX)
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.
13881815
1389−`include-before`
1390−: contents specified by `-B/--include-before-body` (may have
1391− multiple values)
1816+### Conditionals
13921817
1393−`include-after`
1394−: contents specified by `-A/--include-after-body` (may have
1395− multiple values)
1818+A conditional begins with `if(variable)` (enclosed in
1819+matched delimiters) and ends with `endif` (enclosed in matched
1820+delimiters). It may optionally contain an `else` (enclosed in
1821+matched delimiters). The `if` section is used if
1822+`variable` has a non-empty value, otherwise the `else`
1823+section is used (if present). Examples:
13961824
1397−`body`
1398−: body of document
1825+```
1826+$if(foo)$bar$endif$
13991827
1400−`meta-json`
1401−: JSON representation of all of the document's metadata. Field
1402− values are transformed to the selected output format.
1828+$if(foo)$
1829+ $foo$
1830+$endif$
14031831
1404−Language variables
1405−------------------
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
14061837
1407−`lang`
1408−: identifies the main language of the document,
1409− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1410− For some output formats, pandoc will convert it to an appropriate
1411− format stored in the additional variables `babel-lang`,
1412− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1413−
1414− Native pandoc Spans and Divs with the lang attribute
1415− (value in BCP 47) can be used to switch the language in
1416− that range. In LaTeX output, `babel-otherlangs` and
1417− `polyglossia-otherlangs` variables will be generated
1418− automatically based on the `lang` attributes of Spans
1419− and Divs in the document.
1838+${if(foo)}bar${endif}
14201839
1421−`dir`
1422−: the base direction of the document, either `rtl` (right-to-left)
1423− or `ltr` (left-to-right).
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
14241843
1425− For bidirectional documents, native pandoc `span`s and `div`s
1426− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1427− override the base direction in some output formats.
1428− This may not always be necessary if the final renderer
1429− (e.g. the browser, when generating HTML) supports the
1430− [Unicode Bidirectional Algorithm].
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
14311850
1432− When using LaTeX for bidirectional documents, only the `xelatex` engine
1433− is fully supported (use `--pdf-engine=xelatex`).
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
14341853
1435−[BCP 47]: https://tools.ietf.org/html/bcp47
1436−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
14371863
1438−Variables for slides
1439−--------------------
1864+### For loops
14401865
1441−Variables are available for [producing slide shows with pandoc],
1442−including all [reveal.js configuration options].
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
14431869
1444−`titlegraphic`
1445−: title graphic for Beamer documents
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.
14461877
1447−`logo`
1448−: logo for Beamer documents
1878+Examples:
14491879
1450−`slidy-url`
1451−: base URL for Slidy documents (defaults to
1452− `https://www.w3.org/Talks/Tools/Slidy2`)
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
14531882
1454−`slideous-url`
1455−: base URL for Slideous documents (defaults to `slideous`)
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
14561886
1457−`s5-url`
1458−: base URL for S5 documents (defaults to `s5/default`)
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
14591890
1460−`revealjs-url`
1461−: base URL for reveal.js documents (defaults to `reveal.js`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
14621895
1463−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1464−: themes for LaTeX [`beamer`] documents
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.
14651899
1466−`themeoptions`
1467−: options for LaTeX beamer themes (a list).
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
14681903
1469−`navigation`
1470−: controls navigation symbols in `beamer` documents
1471− (default is `empty` for no navigation symbols; other valid values
1472− are `frame`, `vertical`, and `horizontal`).
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
14731906
1474−`section-titles`
1475−: enables on "title pages" for new sections in `beamer`
1476− documents (default = true).
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
14771912
1478−`beamerarticle`
1479−: when true, the `beamerarticle` package is loaded (for
1480− producing an article from beamer slides).
1913+### Partials
14811914
1482−`aspectratio`
1483−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1484− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1485− default, and `32` for 3:2).
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
14861918
1487−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1919+```
1920+${ styles() }
1921+```
14881922
1489−Variables for LaTeX
1490−-------------------
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:
14911928
1492−LaTeX variables are used when [creating a PDF].
1929+```
1930+${ styles.html() }
1931+```
14931932
1494−`papersize`
1495−: paper size, e.g. `letter`, `a4`
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.)
14961937
1497−`fontsize`
1498−: font size for body text (e.g. `10pt`, `12pt`)
1938+Partials may optionally be applied to variables using
1939+a colon:
14991940
1500−`documentclass`
1501−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1941+```
1942+${ date:fancy() }
15021943
1503−`classoption`
1504−: option for document class, e.g. `oneside`; may be repeated
1505− for multiple options
1944+${ articles:bibentry() }
1945+```
15061946
1507−`beameroption`
1508−: In beamer, add extra beamer option with `\setbeameroption{}`
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
15091950
1510−`geometry`
1511−: option for [`geometry`] package, e.g. `margin=1in`;
1512− may be repeated for multiple options
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
15131956
1514−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1515−: sets margins, if `geometry` is not used (otherwise `geometry`
1516− overrides these)
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`.
15171961
1518−`linestretch`
1519−: adjusts line spacing using the [`setspace`]
1520− package, e.g. `1.25`, `1.5`
1962+Final newlines are omitted from included partials.
15211963
1522−`fontfamily`
1523−: font package for use with `pdflatex`:
1524− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1525− The default is [Latin Modern][`lm`].
1964+Partials may include other partials.
15261965
1527−`fontfamilyoptions`
1528−: options for package used as `fontfamily`: e.g. `osf,sc` with
1529− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1530− figures and true small caps; may be repeated for multiple options
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
15311969
1532−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1533−: font families for use with `xelatex` or
1534− `lualatex`: take the name of any system font, using the
1535− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
1970+```
1971+${months[, ]}$
15361972
1537−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1538−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1539− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1540− available through [`fontspec`], such as the OpenType features
1541− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1973+${articles:bibentry()[; ]$
1974+```
15421975
1543−`fontenc`
1544−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1545− default is `T1` (see guide to [LaTeX font encodings])
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.
15461979
1547−`microtypeoptions`
1548−: options to pass to the microtype package
1980+### Nesting
15491981
1550−`colorlinks`
1551−: add color to link text; automatically enabled if any of
1552− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
15531984
1554−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1555−: color for internal links, external links, citation links, linked
1556− URLs, and links in table of contents, respectively: uses options
1557− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1558− `x11names` lists
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
15591988
1560−`links-as-notes`
1561−: causes links to be printed as footnotes
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
15621991
1563−`indent`
1564−: uses document class settings for indentation (the default LaTeX template
1565− otherwise removes indentation and adds space between paragraphs)
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
15661996
1567−`subparagraph`
1568−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1569− as sections, changing the appearance of nested headings in some classes
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
15701999
1571−`thanks`
1572−: specifies contents of acknowledgments footnote after document title.
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
15732004
1574−`toc`
1575−: include table of contents (can also be set using `--toc/--table-of-contents`)
2005+will produce
15762006
1577−`toc-depth`
1578−: level of section to include in table of contents
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
15792012
1580−`secnumdepth`
1581−: numbering depth for sections, if sections are numbered
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.
15822017
1583−`lof`, `lot`
1584−: include list of figures, list of tables
2018+### Breakable spaces
15852019
1586−`bibliography`
1587−: bibliography to use for resolving references
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 `~`).
15882024
1589−`biblio-style`
1590−: bibliography style, when used with `--natbib` and `--biblatex`.
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
15912029
1592−`biblio-title`
1593−: bibliography title, when used with `--natbib` and `--biblatex`.
2030+### Pipes
15942031
1595−`biblatexoptions`
1596−: list of options for biblatex.
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
15972035
1598−`natbiboptions`
1599−: list of options for natbib.
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
16002040
1601−`pagestyle`
1602−: An option for LaTeX's `\pagestyle{}`. The default article class
1603− supports 'plain' (default), 'empty', and 'headings'; headings puts
1604− section titles in the header.
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
16052044
1606−[`article`]: https://ctan.org/pkg/article
1607−[`report`]: https://ctan.org/pkg/report
1608−[`book`]: https://ctan.org/pkg/book
1609−[KOMA-Script]: https://ctan.org/pkg/koma-script
1610−[`memoir`]: https://ctan.org/pkg/memoir
1611−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1612−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1613−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2045+$employee:name()/uppercase$
2046+```
16142047
1615−Variables for ConTeXt
1616−---------------------
2048+Pipes may be chained:
16172049
1618−`papersize`
1619−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1620− may be repeated for multiple options
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
16212055
1622−`layout`
1623−: options for page margins and text arrangement (see [ConTeXt Layout]);
1624− may be repeated for multiple options
2056+Some pipes take parameters:
16252057
1626−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1627−: sets margins, if `layout` is not used (otherwise `layout`
1628− overrides these)
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
16292065
1630−`fontsize`
1631−: font size for body text (e.g. `10pt`, `12pt`)
2066+Currently the following pipes are predefined:
16322067
1633−`mainfont`, `sansfont`, `monofont`, `mathfont`
1634−: font families: take the name of any system font (see [ConTeXt Font Switching])
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.
16352072
1636−`linkcolor`, `contrastcolor`
1637−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2073+- `uppercase`: Converts text to uppercase.
16382074
1639−`linkstyle`
1640−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2075+- `lowercase`: Converts text to lowercase.
16412076
1642−`indenting`
1643−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1644− may be repeated for multiple options
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.
16452080
1646−`whitespace`
1647−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
16482083
1649−`interlinespace`
1650−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1651− may be repeated for multiple options
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
16522087
1653−`headertext`, `footertext`
1654−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1655− may be repeated up to four times for different placement
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
16562091
1657−`pagenumbering`
1658−: page number style and location (using [`setuppagenumbering`]);
1659− may be repeated for multiple options
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
16602095
1661−`toc`
1662−: include table of contents (can also be set using `--toc/--table-of-contents`)
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.
16632099
1664−`lof`, `lot`
1665−: include list of figures, list of tables
2100+- `chomp`: Removes trailing newlines (and breakable space).
16662101
1667−`pdfa`
1668−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1669− To successfully generate PDF/A the required ICC color profiles have to
1670− be available and the content and all included files (such as images)
1671− have to be standard conforming. The ICC profiles can be obtained
1672− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1673− details.
2102+- `nowrap`: Disables line wrapping on breakable spaces.
16742103
1675−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1676−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
1677−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
1678−[ConTeXt Color]: https://wiki.contextgarden.net/Color
1679−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
1680−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
1681−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
1682−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
1683−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
1684−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1685−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
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`.
16862109
1687−Variables for man pages
1688−-----------------------
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`.
16892114
1690−`section`
1691−: section number in man pages
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.
16922122
1693−`header`
1694−: header in man pages
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
16952126
1696−`footer`
1697−: footer in man pages
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
16982130
1699−`adjusting`
1700−: adjusts text to left (`l`), right (`r`), center (`c`),
1701− or both (`b`) margins
17022131
1703−`hyphenate`
1704−: if `true` (the default), hyphenation will be used
2132+## Variables
17052133
1706−Variables for ms
1707−----------------
2134+### Metadata variables
17082135
1709−`pointsize`
1710−: point size (e.g. `10p`)
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`]:
17112142
1712−`lineheight`
1713−: line height (e.g. `12p`)
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
17142719
17152720`fontfamily`
17162721: font family (e.g. `T` or `P`)
@@ -1718,78 +2723,81 @@ Variables for ms
17182723`indent`
17192724: paragraph indent (e.g. `2m`)
17202725
1721−Using variables in templates
1722−----------------------------
1723−
1724−Variable names are sequences of alphanumerics, `-`, and `_`,
1725−starting with a letter. A variable name surrounded by `$` signs
1726−will be replaced by its value. For example, the string `$title$` in
2726+`lineheight`
2727+: line height (e.g. `12p`)
17272728
1728− <title>$title$</title>
2729+`pointsize`
2730+: point size (e.g. `10p`)
17292731
1730−will be replaced by the document title.
2732+### Variables set automatically
17312733
1732−To write a literal `$` in a template, use `$$`.
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:
17332737
1734−Templates may contain conditionals. The syntax is as follows:
2738+`body`
2739+: body of document
17352740
1736− $if(variable)$
1737− X
1738− $else$
1739− Y
1740− $endif$
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`).
17412750
1742−This will include `X` in the template if `variable` has a truthy
1743−value; otherwise it will include `Y`. Here a truthy value is any
1744−of the following:
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
17452754
1746−- a string that is not entirely white space,
1747−- a non-empty array where the first value is truthy,
1748−- any number (including zero),
1749−- any object,
1750−- the boolean `true` (to specify the boolean `true`
1751− value using YAML metadata or the `--metadata` flag,
1752− use `true`, `True`, or `TRUE`; with the `--variable`
1753− flag, simply omit a value for the variable, e.g.
1754− `--variable draft`).
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
17552758
1756−`X` and `Y` are placeholders for any valid template text,
1757−and may include interpolated variables or other conditionals.
1758−The `$else$` section may be omitted.
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
17592762
1760−When variables can have multiple values (for example, `author` in
1761−a multi-author document), you can use the `$for$` keyword:
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
17622766
1763− $for(author)$
1764− <meta name="author" content="$author$" />
1765− $endfor$
2767+`numbersections`
2768+: non-null value if `-N/--number-sections` was specified
17662769
1767−You can optionally specify a separator to be used between
1768−consecutive items:
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:
17692775
1770− $for(author)$$author$$sep$, $endfor$
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
17712783
1772−Note that the separator needs to be specified immediately before the `$endfor`
1773−keyword.
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17742785
1775−A dot can be used to select a field of a variable that takes
1776−an object as its value. So, for example:
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
17772787
1778− $author.name$ ($author.affiliation$)
2788+`curdir`
2789+: working directory from which pandoc is run.
17792790
1780−If you use custom templates, you may need to revise them as pandoc
1781−changes. We recommend tracking the changes in the default templates,
1782−and modifying your custom templates accordingly. An easy way to do this
1783−is to fork the [pandoc-templates] repository and merge in changes after each
1784−pandoc release.
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
17852793
1786−Templates may contain comments: anything on a line after `$--`
1787−will be treated as a comment and ignored.
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
17882797
17892798[pandoc-templates]: https://github.com/jgm/pandoc-templates
17902799
1791−Extensions
1792−==========
2800+# Extensions
17932801
17942802The behavior of some of the readers and writers can be adjusted by
17952803enabling or disabling various extensions.
@@ -1806,8 +2814,11 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
18062814`commonmark` and `gfm`.) In the following, extensions that also work
18072815for other formats are covered.
18082816
1809−Typography
1810−----------
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
18112822
18122823#### Extension: `smart` ####
18132824
@@ -1839,13 +2850,12 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
18392850to use the ligatures when possible; if `smart` is disabled
18402851pandoc will use unicode quotation mark and dash characters.
18412852
1842−Headers and sections
1843−--------------------
2853+## Headings and sections
18442854
18452855#### Extension: `auto_identifiers` ####
18462856
1847−A header without an explicitly specified identifier will be
1848−automatically assigned a unique identifier based on the header text.
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
18492859
18502860This extension can be enabled/disabled for the following formats:
18512861
@@ -1859,7 +2869,7 @@ enabled by default in
18592869: `markdown`, `muse`
18602870
18612871The default algorithm used to derive the identifier from the
1862−header text is:
2872+heading text is:
18632873
18642874 - Remove all formatting, links, etc.
18652875 - Remove all footnotes.
@@ -1873,9 +2883,9 @@ header text is:
18732883
18742884Thus, for example,
18752885
1876− Header Identifier
2886+ Heading Identifier
18772887 ------------------------------- ----------------------------
1878− `Header identifiers in HTML` `header-identifiers-in-html`
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
18792889 `Maître d'hôtel` `maître-dhôtel`
18802890 `*Dogs*?--in *my* house?` `dogs--in-my-house`
18812891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
@@ -1883,7 +2893,7 @@ Thus, for example,
18832893 `33` `section`
18842894
18852895These rules should, in most cases, allow one to determine the identifier
1886−from the header text. The exception is when several headers have the
2896+from the heading text. The exception is when several headings have the
18872897same text; in this case, the first will get an identifier as described
18882898above; the second will get the same identifier with `-1` appended; the
18892899third with `-2`; and so on.
@@ -1897,7 +2907,7 @@ also make it easy to provide links from one section of a document to
18972907another. A link to this section, for example, might look like this:
18982908
18992909 See the section on
1900− [header identifiers](#header-identifiers-in-html-latex-and-context).
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
19012911
19022912Note, however, that this method of providing links to sections works
19032913only in HTML, LaTeX, and ConTeXt formats.
@@ -1905,7 +2915,7 @@ only in HTML, LaTeX, and ConTeXt formats.
19052915If the `--section-divs` option is specified, then each section will
19062916be wrapped in a `section` (or a `div`, if `html4` was specified),
19072917and the identifier will be attached to the enclosing `<section>`
1908−(or `<div>`) tag rather than the header itself. This allows entire
2918+(or `<div>`) tag rather than the heading itself. This allows entire
19092919sections to be manipulated using JavaScript or treated differently in
19102920CSS.
19112921
@@ -1921,9 +2931,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
19212931GitHub's method. Spaces are converted to dashes (`-`),
19222932uppercase characters to lowercase characters, and punctuation
19232933characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
19242935
1925−Math Input
1926−----------
2936+## Math Input
19272937
19282938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
19292939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -1933,51 +2943,47 @@ are described in the section about Pandoc's Markdown.
19332943However, they can also be used with HTML input. This is handy for
19342944reading web pages formatted using MathJax, for example.
19352945
1936−Raw HTML/TeX
1937−------------
1938−
1939−The following extensions (especially how they affect Markdown
1940−input/output) are also described in more detail in their respective
1941−sections of [Pandoc's Markdown].
1942−
1943−#### Extension: `raw_html` {#raw_html}
2946+## Raw HTML/TeX
19442947
1945−When converting from HTML, parse elements to raw HTML which are not
1946−representable in pandoc's AST.
1947−By default, this is disabled for HTML input.
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
19482950
1949−#### Extension: `raw_tex` {#raw_tex}
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.
19502954
1951−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
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`):
19522958
1953−This extension can be enabled/disabled for the following formats
1954−(in addition to `markdown`):
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
19552962
1956−input formats
1957−: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
1958− `\eqref` only)
1959−
1960−output formats
1961−: `textile`, `commonmark`
2963+ output formats
2964+ : `textile`, `commonmark`
19622965
1963−#### Extension: `native_divs` {#native_divs}
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`.
19642973
1965−This extension is enabled by default for HTML input. This means that
1966−`div`s are parsed to pandoc native elements. (Alternatively, you
1967−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
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`.
19682978
1969−When converting HTML to Markdown, for example, you may want to drop all
1970−`div`s and `span`s:
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`.
19712985
1972− pandoc -f html-native_divs-native_spans -t markdown
1973−
1974−#### Extension: `native_spans` {#native_spans}
1975−
1976−Analogous to `native_divs` above.
1977−
1978−
1979−Literate Haskell support
1980−------------------------
2986+## Literate Haskell support
19812987
19822988#### Extension: `literate_haskell` ####
19832989
@@ -1998,12 +3004,12 @@ This means that
19983004 - In Markdown input, "bird track" sections will be parsed as Haskell
19993005 code rather than block quotations. Text between `\begin{code}`
20003006 and `\end{code}` will also be treated as Haskell code. For
2001− ATX-style headers the character '=' will be used instead of '#'.
3007+ ATX-style headings the character '=' will be used instead of '#'.
20023008
20033009 - In Markdown output, code blocks with classes `haskell` and `literate`
20043010 will be rendered using bird tracks, and block quotations will be
20053011 indented one space, so they will not be treated as Haskell code.
2006− In addition, headers will be rendered setext-style (with underlines)
3012+ In addition, headings will be rendered setext-style (with underlines)
20073013 rather than ATX-style (with '#' characters). (This is because ghc
20083014 treats '#' characters in column 1 as introducing line numbers.)
20093015
@@ -2038,8 +3044,7 @@ Note that GHC expects the bird tracks in the first column, so indented
20383044literate code blocks (e.g. inside an itemized environment) will not be
20393045picked up by the Haskell compiler.
20403046
2041−Other extensions
2042−----------------
3047+## Other extensions
20433048
20443049#### Extension: `empty_paragraphs` ####
20453050
@@ -2054,12 +3059,60 @@ input formats
20543059output formats
20553060: `docx`, `odt`, `opendocument`, `html`
20563061
3062+#### Extension: `native_numbering` ####
3063+
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
3066+
3067+This extension can be enabled/disabled for the following formats:
3068+
3069+output formats
3070+: `odt`, `opendocument`
3071+
3072+#### Extension: `xrefs_name` ####
3073+
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3079+name.
3080+
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3083+
3084+This extension can be enabled/disabled for the following formats:
3085+
3086+output formats
3087+: `odt`, `opendocument`
3088+
3089+#### Extension: `xrefs_number` ####
3090+
3091+Links to headings, figures and tables inside the document are
3092+substituted with cross-references that will use the number
3093+of the referenced item. The original link text is discarded.
3094+This extension can be combined with `xrefs_name` in which case
3095+the name or caption numbers will appear after the number.
3096+
3097+For the `xrefs_number` to be useful heading numbers must be enabled
3098+in the generated document, also table and figure captions must be enabled
3099+using for example the `native_numbering` extension.
3100+
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3103+
3104+This extension can be enabled/disabled for the following formats:
3105+
3106+output formats
3107+: `odt`, `opendocument`
3108+
20573109#### Extension: `styles` #### {#ext-styles}
20583110
2059−Read all docx styles as divs (for paragraph styles) and spans (for
2060−character styles) regardless of whether pandoc understands the meaning
2061−of these styles. This can be used with [docx custom
2062−styles](#custom-styles). Disabled by default.
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.
20633116
20643117input formats
20653118: `docx`
@@ -2069,22 +3122,36 @@ input formats
20693122In the `muse` input format, this enables Text::Amuse
20703123extensions to Emacs Muse markup.
20713124
3125+#### Extension: `raw_markdown` ####
3126+
3127+In the `ipynb` input format, this causes Markdown cells
3128+to be included as raw Markdown blocks (allowing lossless
3129+round-tripping) rather than being parsed. Use this only
3130+when you are targeting `ipynb` or a markdown-based
3131+output format.
3132+
20723133#### Extension: `citations` {#org-citations}
20733134
2074−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2075−in `org` input.
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
3137+
3138+#### Extension: `element_citations` ####
3139+
3140+In the `jats` output formats, this causes reference items to
3141+be replaced with `<element-citation>` elements. These
3142+elements are not influenced by CSL styles, but all information
3143+on the item is included in tags.
20763144
20773145#### Extension: `ntb` ####
20783146
20793147In the `context` output format this enables the use of [Natural Tables
2080−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2081−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
20823150Natural tables allow more fine-grained global customization but come
20833151at a performance penalty compared to extreme tables.
20843152
20853153
2086−Pandoc's Markdown
2087−=================
3154+# Pandoc's Markdown
20883155
20893156Pandoc understands an extended and slightly revised version of
20903157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2094,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
20943161behavior more granularly. They are described in the following. See also
20953162[Extensions] above, for extensions that work also on other formats.
20963163
2097−Philosophy
2098−----------
3164+## Philosophy
20993165
21003166Markdown is designed to be easy to write, and, even more importantly,
21013167easy to read:
@@ -2103,7 +3169,7 @@ easy to read:
21033169> A Markdown-formatted document should be publishable as-is, as plain
21043170> text, without looking like it's been marked up with tags or formatting
21053171> instructions.
2106−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
21073173
21083174This principle has guided pandoc's decisions in finding syntax for
21093175tables, footnotes, and other extensions.
@@ -2116,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
21163182important document elements like definition lists, tables, mathematics, and
21173183footnotes.
21183184
2119−Paragraphs
2120−----------
3185+## Paragraphs
21213186
21223187A paragraph is one or more lines of text followed by one or more blank lines.
21233188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2130,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
21303195to create a hard line break, since trailing spaces in the cells
21313196are ignored.
21323197
2133−Headers
2134−-------
3198+## Headings
21353199
2136−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
21373201
2138−### Setext-style headers ###
3202+### Setext-style headings ###
21393203
2140−A setext-style header is a line of text "underlined" with a row of `=` signs
2141−(for a level one header) or `-` signs (for a level two header):
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):
21423206
2143− A level-one header
2144− ==================
3207+ A level-one heading
3208+ ===================
21453209
2146− A level-two header
2147− ------------------
3210+ A level-two heading
3211+ -------------------
21483212
2149−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
21503214[Inline formatting], below).
21513215
21523216
2153−### ATX-style headers ###
3217+### ATX-style headings ###
21543218
2155−An ATX-style header consists of one to six `#` signs and a line of
3219+An ATX-style heading consists of one to six `#` signs and a line of
21563220text, optionally followed by any number of `#` signs. The number of
2157−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
21583222
2159− ## A level-two header
3223+ ## A level-two heading
21603224
2161− ### A level-three header ###
3225+ ### A level-three heading ###
21623226
2163−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
21643228
2165− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
21663230
21673231#### Extension: `blank_before_header` ####
21683232
2169−Standard Markdown syntax does not require a blank line before a header.
3233+Standard Markdown syntax does not require a blank line before a heading.
21703234Pandoc does require this (except, of course, at the beginning of the
21713235document). The reason for the requirement is that it is all too easy for a
21723236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -2178,29 +3242,30 @@ wrapping). Consider, for example:
21783242#### Extension: `space_in_atx_header` ####
21793243
21803244Many Markdown implementations do not require a space between the
2181−opening `#`s of an ATX header and the header text, so that
2182−`#5 bolt` and `#hashtag` count as headers. With this extension,
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
21833247pandoc does require the space.
21843248
2185−### Header identifiers ###
3249+### Heading identifiers ###
21863250
2187−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
21883253
21893254#### Extension: `header_attributes` ####
21903255
2191−Headers can be assigned attributes using this syntax at the end
2192−of the line containing the header text:
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
21933258
21943259 {#identifier .class .class key=value key=value}
21953260
2196−Thus, for example, the following headers will all be assigned the identifier
3261+Thus, for example, the following headings will all be assigned the identifier
21973262`foo`:
21983263
2199− # My header {#foo}
3264+ # My heading {#foo}
22003265
2201− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
22023267
2203− My other header {#foo}
3268+ My other heading {#foo}
22043269 ---------------
22053270
22063271(This syntax is compatible with [PHP Markdown Extra].)
@@ -2209,51 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
22093274attributes, writers generally don't use all of this information. Identifiers,
22103275classes, and key/value attributes are used in HTML and HTML-based formats such
22113276as EPUB and slidy. Identifiers are used for labels and link anchors in the
2212−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
22133278
2214−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
22153280`--number-sections` is specified. A single hyphen (`-`) in an attribute
22163281context is equivalent to `.unnumbered`, and preferable in non-English
22173282documents. So,
22183283
2219− # My header {-}
3284+ # My heading {-}
22203285
22213286is just the same as
22223287
2223− # My header {.unnumbered}
3288+ # My heading {.unnumbered}
3289+
3290+If the `unlisted` class is present in addition to `unnumbered`,
3291+the heading will not be included in a table of contents.
3292+(Currently this feature is only implemented for certain
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
22243294
22253295#### Extension: `implicit_header_references` ####
22263296
2227−Pandoc behaves as if reference links have been defined for each header.
2228−So, to link to a header
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
22293299
2230− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
22313301
22323302you can simply write
22333303
2234− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
22353305
22363306or
22373307
2238− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
22393309
22403310or
22413311
2242− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
22433313 HTML]
22443314
22453315instead of giving the identifier explicitly:
22463316
2247− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
22483318
2249−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
22503320reference will link to the first one only, and you will need to use explicit
22513321links to link to the others, as described above.
22523322
22533323Like regular reference links, these references are case-insensitive.
22543324
22553325Explicit link reference definitions always take priority over
2256−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
22573327link will point to `bar`, not to `#foo`:
22583328
22593329 # Foo
@@ -2262,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
22623332
22633333 See [foo]
22643334
2265−Block quotations
2266−----------------
3335+## Block quotations
22673336
22683337Markdown uses email conventions for quoting blocks of text.
22693338A block quotation is one or more paragraphs or other block elements
2270−(such as lists or headers), with each line preceded by a `>` character
3339+(such as lists or headings), with each line preceded by a `>` character
22713340and an optional space. (The `>` need not start at the left margin, but
22723341it should not be indented more than three spaces.)
22733342
@@ -2302,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
23023371
23033372#### Extension: `blank_before_blockquote` ####
23043373
2305−Standard Markdown syntax does not require a blank line before a block
2306−quote. Pandoc does require this (except, of course, at the beginning of the
2307−document). The reason for the requirement is that it is all too easy for a
2308−`>` to end up at the beginning of a line by accident (perhaps through line
2309−wrapping). So, unless the `markdown_strict` format is used, the following does
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
23103380not produce a nested block quote in pandoc:
23113381
23123382 > This is a block quote.
23133383 >> Nested.
23143384
23153385
2316−Verbatim (code) blocks
2317−----------------------
3386+## Verbatim (code) blocks
23183387
23193388### Indented code blocks ###
23203389
@@ -2376,14 +3445,16 @@ this syntax:
23763445 qsort (filter (>= x) xs)
23773446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23783447
2379−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2380−`startFrom` is an attribute with value `100`. Some output formats can use this
2381−information to do syntax highlighting. Currently, the only output formats
2382−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2383−highlighting is supported for your output format and language, then the code
2384−block above will appear highlighted, with numbered lines. (To see which
2385−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2386−the code block above will appear as follows:
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:
23873458
23883459 <pre id="mycode" class="haskell numberLines" startFrom="100">
23893460 <code>
@@ -2420,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
24203491For more information on highlighting, see [Syntax highlighting],
24213492below.
24223493
2423−Line blocks
2424−-----------
3494+## Line blocks
24253495
24263496#### Extension: `line_blocks` ####
24273497
@@ -2447,10 +3517,12 @@ line must begin with a space.
24473517 | 200 Main St.
24483518 | Berkeley, CA 94718
24493519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
24503523This syntax is borrowed from [reStructuredText].
24513524
2452−Lists
2453−-----
3525+## Lists
24543526
24553527### Bullet lists ###
24563528
@@ -2651,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
26513723A definition begins with a colon or tilde, which may be indented one
26523724or two spaces.
26533725
2654−A term may have multiple definitions, and each definition may consist of one or
2655−more block elements (paragraph, code block, list, etc.), each indented four
2656−spaces or one tab stop. The body of the definition (including the first line,
2657−aside from the colon or tilde) should be indented four spaces. However,
2658−as with other Markdown lists, you can "lazily" omit indentation except
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
26593732at the beginning of a paragraph or other block element:
26603733
26613734 Term 1
@@ -2681,9 +3754,10 @@ definition:
26813754Note that space between items in a definition list is required.
26823755(A variant that loosens this requirement, but disallows "lazy"
26833756hard wrapping, can be activated with `compact_definition_lists`: see
2684−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
26853758
2686−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
26873761
26883762### Numbered example lists ###
26893763
@@ -2719,30 +3793,6 @@ list marker. That is, example lists always behave as if the
27193793labels tend to be long, and indenting content to the
27203794first non-space character after the label would be awkward.
27213795
2722−### Compact and loose lists ###
2723−
2724−Pandoc behaves differently from `Markdown.pl` on some "edge
2725−cases" involving lists. Consider this source:
2726−
2727− + First
2728− + Second:
2729− - Fee
2730− - Fie
2731− - Foe
2732−
2733− + Third
2734−
2735−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2736−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2737−"Second" and "Third" (but not "First"), because of the blank space
2738−around "Third". Pandoc follows a simple rule: if the text is followed by
2739−a blank line, it is treated as a paragraph. Since "Second" is followed
2740−by a list, and not a blank line, it isn't treated as a paragraph. The
2741−fact that the list is followed by a blank line is irrelevant. (Note:
2742−Pandoc works this way even when the `markdown_strict` format is specified. This
2743−behavior is consistent with the official Markdown syntax description,
2744−even though it is different from that of `Markdown.pl`.)
2745−
27463796
27473797### Ending a list ###
27483798
@@ -2781,8 +3831,7 @@ of one big list:
27813831 2. dos
27823832 3. tres
27833833
2784−Horizontal rules
2785−----------------
3834+## Horizontal rules
27863835
27873836A line containing a row of three or more `*`, `-`, or `_` characters
27883837(optionally separated by spaces) produces a horizontal rule:
@@ -2792,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
27923841 ---------------
27933842
27943843
2795−Tables
2796−------
3844+## Tables
27973845
27983846Four kinds of tables may be used. The first three kinds presuppose the use of
27993847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2818,7 +3866,7 @@ Simple tables look like this:
28183866
28193867 Table: Demonstration of simple table syntax.
28203868
2821−The headers and table rows must each fit on one line. Column
3869+The header and table rows must each fit on one line. Column
28223870alignments are determined by the position of the header text relative
28233871to the dashed line below it:[^4]
28243872
@@ -2837,7 +3885,7 @@ to the dashed line below it:[^4]
28373885The table must end with a blank line, or a line of dashes followed by
28383886a blank line.
28393887
2840−The column headers may be omitted, provided a dashed line is used
3888+The column header row may be omitted, provided a dashed line is used
28413889to end the table. For example:
28423890
28433891 ------- ------ ---------- -------
@@ -2846,13 +3894,13 @@ to end the table. For example:
28463894 1 1 1 1
28473895 ------- ------ ---------- -------
28483896
2849−When headers are omitted, column alignments are determined on the basis
3897+When the header row is omitted, column alignments are determined on the basis
28503898of the first line of the table body. So, in the tables above, the columns
28513899would be right, left, center, and right aligned, respectively.
28523900
28533901#### Extension: `multiline_tables` ####
28543902
2855−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
28563904of text (but cells that span multiple columns or rows of the table are
28573905not supported). Here is an example:
28583906
@@ -2874,7 +3922,7 @@ not supported). Here is an example:
28743922These work like simple tables, but with the following differences:
28753923
28763924 - They must begin with a row of dashes, before the header text
2877− (unless the headers are omitted).
3925+ (unless the header row is omitted).
28783926 - They must end with a row of dashes, then a blank line.
28793927 - The rows must be separated by blank lines.
28803928
@@ -2883,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
28833931the output. So, if you find that one of the columns is too narrow in the
28843932output, try widening it in the Markdown source.
28853933
2886−Headers may be omitted in multiline tables as well as simple tables:
3934+The header may be omitted in multiline tables as well as simple tables:
28873935
28883936 ----------- ------- --------------- -------------------------
28893937 First row 12.0 Example of a row that
@@ -2894,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
28943942 rows.
28953943 ----------- ------- --------------- -------------------------
28963944
2897− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
28983946
28993947It is possible for a multiline table to have just one row, but the row
29003948should be followed by a blank line (and then the row of dashes that ends
@@ -2920,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
29203968omitted for a headerless table. The cells of grid tables may contain
29213969arbitrary block elements (multiple paragraphs, code blocks, lists,
29223970etc.). Cells that span multiple columns or rows are not
2923−supported. Grid tables can be created easily using [Emacs table mode].
2924−
2925−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
29263973
29273974Alignments can be specified as with pipe tables, by putting
29283975colons at the boundaries of the separator line after the
@@ -2950,7 +3997,7 @@ and the same number of rows in each column. For example, the
29503997Docutils [sample grid tables] will not render as expected with
29513998Pandoc.
29523999
2953−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
29544001
29554002
29564003#### Extension: `pipe_tables` ####
@@ -2983,7 +4030,7 @@ legal (though ugly) pipe table:
29834030
29844031The cells of pipe tables cannot contain block elements like paragraphs
29854032and lists, and cannot span multiple lines. If a pipe table contains a
2986−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
29874034`--columns`), then the table will take up the full text width and
29884035the cell contents will wrap, with the relative cell widths determined
29894036by the number of dashes in the line separating the table header from
@@ -3007,8 +4054,7 @@ you'll need to add colons as above.
30074054
30084055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
30094056
3010−Metadata blocks
3011−---------------
4057+## Metadata blocks
30124058
30134059#### Extension: `pandoc_title_block` ####
30144060
@@ -3024,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
30244070or all three elements. If you want to include an author but no
30254071title, or a title and a date but no author, you need a blank line:
30264072
3027− %
3028− % Author
4073+```
4074+%
4075+% Author
4076+```
30294077
3030− % My title
3031− %
3032− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
30334083
30344084The title may occupy multiple lines, but continuation lines must
30354085begin with leading space, thus:
30364086
3037− % My title
3038− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
30394091
30404092If a document has multiple authors, the authors may be put on
30414093separate lines with leading space, or separated by semicolons, or
30424094both. So, all of the following are equivalent:
30434095
3044− % Author One
3045− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
30464100
3047− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
30484104
3049− % Author One;
3050− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
30514109
30524110The date must fit on one line.
30534111
@@ -3088,7 +4146,7 @@ will also have "Version 4.0" in the header.
30884146
30894147#### Extension: `yaml_metadata_block` ####
30904148
3091−A YAML metadata block is a valid YAML object, delimited by a line of three
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
30924150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
30934151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
30944152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3111,20 +4169,22 @@ given a role by external processors.) Field names must not be
31114169interpretable as YAML numbers or boolean values (so, for
31124170example, `yes`, `True`, and `15` cannot be used as field names).
31134171
3114−A document may contain multiple metadata blocks. The metadata fields will
3115−be combined through a *left-biased union*: if two metadata blocks attempt
3116−to set the same field, the value from the first block will be taken.
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.
31174175
31184176When pandoc is used with `-t markdown` to create a Markdown document,
31194177a YAML metadata block will be produced only if the `-s/--standalone`
31204178option is used. All of the metadata will appear in a single block
31214179at the beginning of the document.
31224180
3123−Note that YAML escaping rules must be followed. Thus, for example,
3124−if a title contains a colon, it must be quoted. The pipe character
3125−(`|`) can be used to begin an indented block that will be interpreted
3126−literally, without need for escaping. This form is necessary
3127−when the field contains blank lines or block-level formatting:
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:
31284188
31294189 ---
31304190 title: 'This is the title: it contains a colon'
@@ -3138,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
31384198 It consists of two paragraphs.
31394199 ...
31404200
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+
31414207Template variables will be set automatically from the metadata. Thus, for
31424208example, in writing HTML, the variable `abstract` will be set to the HTML
31434209equivalent of the Markdown in the `abstract` field:
@@ -3184,8 +4250,25 @@ will be interpreted as markdown. For example:
31844250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
31854251 ```
31864252
3187−Backslash escapes
3188−-----------------
4253+Note: the `yaml_metadata_block` extension works with
4254+`commonmark` as well as `markdown` (and it is enabled by default
4255+in `gfm` and `commonmark_x`). However, in these formats the
4256+following restrictions apply:
4257+
4258+- The YAML metadata block must occur at the beginning of the
4259+ document (and there can be only one). If multiple files are
4260+ given as arguments to pandoc, only the first can be a YAML
4261+ metadata block.
4262+
4263+- The leaf nodes of the YAML structure are parsed in isolation from
4264+ each other and from the rest of the document. So, for
4265+ example, you can't use a reference link in these contexts
4266+ if the link definition is somewhere else in the document.
4267+
4268+[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
4269+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
4270+
4271+## Backslash escapes
31894272
31904273#### Extension: `all_symbols_escapable` ####
31914274
@@ -3211,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
32114294(However, if the `markdown_strict` format is used, the standard Markdown rule
32124295will be used.)
32134296
3214−A backslash-escaped space is parsed as a nonbreaking space. It will
3215−appear in TeX output as `~` and in HTML and XML as `\ ` or
3216−`\ `.
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).
32174303
32184304A backslash-escaped newline (i.e. a backslash occurring at the end of
32194305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3223,8 +4309,7 @@ two trailing spaces on a line.
32234309
32244310Backslash escapes do not work in verbatim contexts.
32254311
3226−Inline formatting
3227−-----------------
4312+## Inline formatting
32284313
32294314### Emphasis ###
32304315
@@ -3272,12 +4357,13 @@ text by `~` characters. Thus, for example,
32724357
32734358 H~2~O is a liquid. 2^10^ is 1024.
32744359
3275−If the superscripted or subscripted text contains spaces, these spaces
3276−must be escaped with backslashes. (This is to prevent accidental
3277−superscripting and subscripting through the ordinary use of `~` and `^`.)
3278−Thus, if you want the letter P with 'a cat' in subscripts, use
3279−`P~a\ cat~`, not `P~a cat~`.
3280−
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~`.
32814367
32824368### Verbatim ###
32834369
@@ -3326,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
33264412This will work in all output formats that support small caps.
33274413
33284414
3329−Math
3330−----
4415+## Math
33314416
33324417#### Extension: `tex_math_dollars` ####
33334418
@@ -3339,6 +4424,10 @@ left, and must not be followed immediately by a digit. Thus,
33394424you need to enclose text in literal `$` characters, backslash-escape
33404425them and they won't be treated as math delimiters.
33414426
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+
33424431TeX math will be printed in all output formats. How it is rendered
33434432depends on the output format:
33444433
@@ -3350,16 +4439,23 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki
33504439 ~ It will appear verbatim surrounded by `$...$` (for inline
33514440 math) or `$$...$$` (for display math).
33524441
4442+XWiki
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4444+
33534445reStructuredText
33544446 ~ It will be rendered using an [interpreted text role `:math:`].
33554447
33564448AsciiDoc
3357− ~ It will be rendered as `latexmath:[...]`.
4449+ ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4450+ surrounded by `latexmath:[$...$]` (for inline math) or
4451+ `[latexmath]++++\[...\]+++` (for display math).
4452+ For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4453+ (`$..$` and `\[..\]`) are omitted.
33584454
33594455Texinfo
33604456 ~ It will be rendered inside a `@math` command.
33614457
3362−roff man
4458+roff man, Jira markup
33634459 ~ It will be rendered verbatim without `$`'s.
33644460
33654461MediaWiki, DokuWiki
@@ -3393,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
33934489 command-line options selected. Therefore see [Math rendering in HTML]
33944490 above.
33954491
3396−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
33974493
3398−Raw HTML
3399−--------
4494+## Raw HTML
34004495
34014496#### Extension: `raw_html` ####
34024497
@@ -3434,7 +4529,7 @@ Thus, for example, pandoc will turn
34344529 <table>
34354530 <tr>
34364531 <td>*one*</td>
3437− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
34384533 </tr>
34394534 </table>
34404535
@@ -3443,14 +4538,14 @@ into
34434538 <table>
34444539 <tr>
34454540 <td><em>one</em></td>
3446− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
34474542 </tr>
34484543 </table>
34494544
34504545whereas `Markdown.pl` will preserve it as is.
34514546
3452−There is one exception to this rule: text between `<script>` and
3453−`<style>` tags is not interpreted as Markdown.
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
34544549
34554550This departure from standard Markdown should make it easier to mix
34564551Markdown with HTML block elements. For example, one can surround
@@ -3542,8 +4637,7 @@ example, to use a raw attribute with a backtick code block,
35424637
35434638The raw attribute cannot be combined with regular attributes.
35444639
3545−LaTeX macros
3546−------------
4640+## LaTeX macros
35474641
35484642#### Extension: `latex_macros` ####
35494643
@@ -3557,18 +4651,20 @@ all output formats, not just LaTeX:
35574651 $\tuple{a, b, c}$
35584652
35594653Note that LaTeX macros will not be applied if they occur
3560−inside inside a raw span or block marked with the
4654+inside a raw span or block marked with the
35614655[`raw_attribute` extension](#extension-raw_attribute).
35624656
35634657When `latex_macros` is disabled, the raw LaTeX and math will
35644658not have macros applied. This is usually a better approach when
35654659you are targeting LaTeX or PDF.
35664660
3567−Whether or not `latex_macros` is enabled, the macro definitions
3568−will still be passed through as raw LaTeX.
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
4665+enabled.
35694666
3570−Links
3571−-----
4667+## Links
35724668
35734669Markdown allows links to be specified in several ways.
35744670
@@ -3577,7 +4673,7 @@ Markdown allows links to be specified in several ways.
35774673If you enclose a URL or email address in pointy brackets, it
35784674will become a link:
35794675
3580− <http://google.com>
4676+ <https://google.com>
35814677 <sam@green.eggs.ham>
35824678
35834679### Inline links ###
@@ -3587,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
35874683be followed by a link title, in quotes.)
35884684
35894685 This is an [inline link](/url), and here's [one with
3590− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
35914687
35924688There can be no space between the bracketed part and the parenthesized part.
35934689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3616,7 +4712,7 @@ Here are some examples:
36164712
36174713 [my label 1]: /foo/bar.html "My title, optional"
36184714 [my label 2]: /foo
3619− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
36204716 [my label 4]: /bar#special 'A title in single quotes'
36214717
36224718The URL may optionally be surrounded by angle brackets:
@@ -3625,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
36254721
36264722The title may go on the next line:
36274723
3628− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
36294725 "The free software foundation"
36304726
36314727Note that link labels are not case sensitive. So, this will work:
@@ -3663,7 +4759,7 @@ be omitted entirely:
36634759### Internal links ###
36644760
36654761To link to another section of the same document, use the automatically
3666−generated identifier (see [Header identifiers]). For example:
4762+generated identifier (see [Heading identifiers]). For example:
36674763
36684764 See the [Introduction](#introduction).
36694765
@@ -3676,8 +4772,7 @@ or
36764772Internal links are currently supported for HTML formats (including
36774773HTML slide shows and EPUB), LaTeX, and ConTeXt.
36784774
3679−Images
3680−------
4775+## Images
36814776
36824777A link immediately preceded by a `!` will be treated as an image.
36834778The link text will be used as the image's alt text:
@@ -3701,206 +4796,561 @@ formats (e.g. RTF) do not yet support figures. In those
37014796formats, you'll just get an image in a paragraph by itself, with
37024797no caption.
37034798
3704−If you just want a regular inline image, just make sure it is not
3705−the only thing in the paragraph. One way to do this is to insert a
3706−nonbreaking space after the image:
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` ####
5137+
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`.
5141+
5142+#### Extension: `lists_without_preceding_blankline` ####
5143+
5144+Allow a list to occur right after a paragraph, with no intervening
5145+blank space.
5146+
5147+#### Extension: `four_space_rule` ####
5148+
5149+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150+four spaces indent are needed for list item continuation
5151+paragraphs.
5152+
5153+#### Extension: `spaced_reference_links` ####
5154+
5155+Allow whitespace between the two components of a reference link,
5156+for example,
5157+
5158+ [foo] [bar].
5159+
5160+#### Extension: `hard_line_breaks` ####
5161+
5162+Causes all newlines within a paragraph to be interpreted as hard line
5163+breaks instead of spaces.
5164+
5165+#### Extension: `ignore_line_breaks` ####
5166+
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.
5171+
5172+#### Extension: `east_asian_line_breaks` ####
5173+
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.
5179+
5180+#### Extension: `emoji` ####
37075181
3708− \
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
37095183
3710−Note that in reveal.js slide shows, an image in a paragraph
3711−by itself that has the `stretch` class will fill the screen,
3712−and the caption and figure tags will be omitted.
5184+#### Extension: `tex_math_single_backslash` ####
37135185
3714−#### Extension: `link_attributes` ####
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 `[`.
37155190
3716−Attributes can be set on links and images:
5191+#### Extension: `tex_math_double_backslash` ####
37175192
3718− An inline {#id .class width=30 height=20px}
3719− and a reference ![image][ref] with attributes.
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.
37205196
3721− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5197+#### Extension: `markdown_attribute` ####
37225198
3723−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3724−and `.class` are used.)
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`.
37255202
3726−For HTML and EPUB, all attributes except `width` and `height` (but
3727−including `srcset` and `sizes`) are passed through as is. The other
3728−writers ignore attributes that are not supported by their output
3729−format.
5203+#### Extension: `mmd_title_block` ####
37305204
3731−The `width` and `height` attributes on images are treated specially. When
3732−used without a unit, the unit is assumed to be pixels. However, any of
3733−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3734−and `%`. There must not be any spaces between the number and the unit.
3735−For example:
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
37365207
3737−```
3738−{ width=50% }
3739−```
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.
37405213
3741−- Dimensions are converted to inches for output in page-based formats like
3742− LaTeX. Dimensions are converted to pixels for output in HTML-like
3743− formats. Use the `--dpi` option to specify the number of pixels per
3744− inch. The default is 96dpi.
3745−- The `%` unit is generally relative to some available space.
3746− For example the above example will render to the following.
3747− - HTML: `<img href="file.jpg" style="width: 50%;" />`
3748− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
3749− (If you're using a custom template, you need to configure `graphicx`
3750− as in the default template.)
3751− - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3752−- Some output formats have a notion of a class
3753− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3754− or a unique identifier (LaTeX `\caption`), or both (HTML).
3755−- When no `width` or `height` attributes are specified, the fallback
3756− is to look at the image resolution and the dpi metadata embedded in
3757− the image file.
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`.
37585217
3759−Divs and Spans
3760−--------------
5218+#### Extension: `abbreviations` ####
37615219
3762−Using the `native_divs` and `native_spans` extensions
3763−(see [above][Extension: `native_divs`]), HTML syntax can
3764−be used as part of markdown to create native `Div` and `Span`
3765−elements in the pandoc AST (as opposed to raw HTML).
3766−However, there is also nicer syntax available:
5220+Parses PHP Markdown Extra abbreviation keys, like
37675221
3768−#### Extension: `fenced_divs` ####
5222+ *[HTML]: Hypertext Markup Language
37695223
3770−Allow special fenced syntax for native `Div` blocks. A Div
3771−starts with a fence containing at least three consecutive
3772−colons plus some attributes. The attributes may optionally
3773−be followed by another string of consecutive colons.
3774−The attribute syntax is exactly as in fenced code blocks (see
3775−[Extension: `fenced_code_attributes`]). As with fenced
3776−code blocks, one can use either attributes in curly braces
3777−or a single unbraced word, which will be treated as a class
3778−name. The Div ends with another line containing a string of at
3779−least three consecutive colons. The fenced Div should be
3780−separated by blank lines from preceding and following blocks.
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).
37815227
3782−Example:
5228+#### Extension: `autolink_bare_uris` ####
37835229
3784− ::::: {#special .sidebar}
3785− Here is a paragraph.
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
37865232
3787− And another.
3788− :::::
5233+#### Extension: `mmd_link_attributes` ####
37895234
3790−Fenced divs can be nested. Opening fences are distinguished
3791−because they *must* have attributes:
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.
37925238
3793− ::: Warning ::::::
3794− This is a warning.
5239+ This is a reference ![image][ref] with multimarkdown attributes.
37955240
3796− ::: Danger
3797− This is a warning within a warning.
3798− :::
3799− ::::::::::::::::::
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
38005243
3801−Fences without attributes are always closing fences. Unlike
3802−with fenced code blocks, the number of colons in the closing
3803−fence need not match the number in the opening fence. However,
3804−it can be helpful for visual clarity to use fences of different
3805−lengths to distinguish nested divs from their parents.
5244+#### Extension: `mmd_header_identifiers` ####
38065245
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
38075248
3808−#### Extension: `bracketed_spans` ####
5249+#### Extension: `compact_definition_lists` ####
38095250
3810−A bracketed sequence of inlines, as one would use to begin
3811−a link, will be treated as a `Span` with attributes if it is
3812−followed immediately by attributes:
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:
38135254
3814− [This is *some text*]{.class key="val"}
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]
5262+
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
38155265
3816−Footnotes
3817−---------
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
38185270
3819−#### Extension: `footnotes` ####
5271+ Is this a single list item with two definitions of "bar," the first of
5272+ which is lazily wrapped, or two list items? To remove the ambiguity
5273+ we must either disallow lazy wrapping or require a blank line between
5274+ list items.
38205275
3821−Pandoc's Markdown allows footnotes, using the following syntax:
5276+#### Extension: `gutenberg` ####
38225277
3823− Here is a footnote reference,[^1] and another.[^longnote]
5278+Use [Project Gutenberg] conventions for `plain` output:
5279+all-caps for strong emphasis, surround by underscores
5280+for regular emphasis, add extra blank space around headings.
38245281
3825− [^1]: Here is the footnote.
5282+ [Project Gutenberg]: https://www.gutenberg.org
38265283
3827− [^longnote]: Here's one with multiple blocks.
5284+#### Extension: `sourcepos` ####
38285285
3829− Subsequent paragraphs are indented to show that they
3830− belong to the previous footnote.
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
38315290
3832− { some.code }
5291+## Markdown variants
38335292
3834− The whole paragraph can be indented, or just the first
3835− line. In this way, multi-paragraph footnotes work like
3836− multi-paragraph list items.
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
38375295
3838− This paragraph won't be part of the note, because it
3839− isn't indented.
5296+- `markdown_phpextra` (PHP Markdown Extra)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
38405303
3841−The identifiers in footnote references may not contain spaces, tabs,
3842−or newlines. These identifiers are used only to correlate the
3843−footnote reference with the note itself; in the output, footnotes
3844−will be numbered sequentially.
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
38455306
3846−The footnotes themselves need not be placed at the end of the
3847−document. They may appear anywhere except inside other block elements
3848−(lists, block quotes, tables, etc.). Each footnote should be
3849−separated from surrounding content (including other footnotes)
3850−by blank lines.
5307+ pandoc --list-extensions=FORMAT
38515308
3852−#### Extension: `inline_notes` ####
5309+where `FORMAT` is replaced with the name of the format.
38535310
3854−Inline footnotes are also allowed (though, unlike regular notes,
3855−they cannot contain multiple paragraphs). The syntax is as follows:
5311+Note that the list of extensions for `commonmark`,
5312+`gfm`, and `commonmark_x` are defined relative to default
5313+commonmark. So, for example, `backtick_code_blocks`
5314+does not appear as an extension, since it is enabled by
5315+default and cannot be disabled.
38565316
3857− Here is an inline note.^[Inlines notes are easier to write, since
3858− you don't have to pick an identifier and move down to type the
3859− note.]
5317+# Citations
38605318
3861−Inline and regular footnotes may be mixed freely.
5319+When the `--citeproc` option is used, pandoc can automatically generate
5320+citations and a bibliography in a number of styles. Basic usage is
38625321
3863−Citations
3864−---------
5322+ pandoc --citeproc myinput.txt
38655323
3866−#### Extension: `citations` ####
5324+To use this feature, you will need to have
38675325
3868−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3869−citations and a bibliography in a number of styles. Basic usage is
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
38705330
3871− pandoc --filter pandoc-citeproc myinput.txt
5331+## Specifying bibliographic data
38725332
3873−In order to use this feature, you will need to specify a bibliography file
3874−using the `bibliography` metadata field in a YAML metadata section, or
3875−`--bibliography` command line argument. You can supply multiple `--bibliography`
3876−arguments or set `bibliography` metadata field to YAML array, if you want to
3877−use multiple bibliography files. The bibliography may have any of these
3878−formats:
5333+You can specify an external bibliography using the
5334+`bibliography` metadata field in a YAML metadata section or the
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
5337+`--bibliography` arguments or set `bibliography` metadata field
5338+to YAML array. A bibliography may have any of these formats:
38795339
38805340 Format File extension
38815341 ------------ --------------
38825342 BibLaTeX .bib
38835343 BibTeX .bibtex
3884− Copac .copac
38855344 CSL JSON .json
38865345 CSL YAML .yaml
3887− EndNote .enl
3888− EndNote XML .xml
3889− ISI .wos
3890− MEDLINE .medline
3891− MODS .mods
3892− RIS .ris
38935346
38945347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3895−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
38965349
3897−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3898−can produce `.json` and `.yaml` files from any of the supported formats.
3899−
3900−In-field markup: In BibTeX and BibLaTeX databases,
3901−pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
3902−databases, pandoc Markdown; and in CSL JSON databases, an
3903−[HTML-like markup][CSL markup specs]:
5350+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351+inside fields such as `title`; in CSL YAML databases, pandoc
5352+Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5353+markup specs]:
39045354
39055355`<i>...</i>`
39065356: italics
@@ -3920,14 +5370,11 @@ databases, pandoc Markdown; and in CSL JSON databases, an
39205370`<span class="nocase">...</span>`
39215371: prevent a phrase from being capitalized as title case
39225372
3923−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3924−and CSL YAML formats as far as possible.
3925−
3926−As an alternative to specifying a bibliography file using `--bibliography`
3927−or the YAML metadata field `bibliography`, you can include
3928−the citation data directly in the `references` field of the
3929−document's YAML metadata. The field should contain an array of
3930−YAML-encoded references, for example:
5373+As an alternative to specifying a bibliography file using
5374+`--bibliography` or the YAML metadata field `bibliography`, you
5375+can include the citation data directly in the `references` field
5376+of the document's YAML metadata. The field should contain an
5377+array of YAML-encoded references, for example:
39315378
39325379 ---
39335380 references:
@@ -3943,345 +5390,273 @@ YAML-encoded references, for example:
39435390 - - 1953
39445391 - 4
39455392 - 25
3946− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3947− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
39485395 title-short: Molecular structure of nucleic acids
39495396 container-title: Nature
39505397 volume: 171
39515398 issue: 4356
39525399 page: 737-738
39535400 DOI: 10.1038/171737a0
3954− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
39555402 language: en-GB
39565403 ...
39575404
3958−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3959−of the supported formats.)
3960−
3961−Citations and references can be formatted using any style supported by the
3962−[Citation Style Language], listed in the [Zotero Style Repository].
3963−These files are specified using the `--csl` option or the `csl` metadata field.
3964−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3965−format. The CSL project provides further information on [finding and editing styles].
3966−
3967−To make your citations hyperlinks to the corresponding bibliography
3968−entries, add `link-citations: true` to your YAML metadata.
3969−
3970−Citations go inside square brackets and are separated by semicolons.
3971−Each citation must have a key, composed of '@' + the citation
3972−identifier from the database, and may optionally have a prefix,
3973−a locator, and a suffix. The citation key must begin with a letter, digit,
3974−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3975−characters (`:.#$%&-+?<>~/`). Here are some examples:
3976−
3977− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3978−
3979− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3980−
3981− Blah blah [@smith04; @doe99].
3982−
3983−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3984−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3985−locale, locator terms can be written in either singular or plural forms,
3986−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3987−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3988−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3989−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3990−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3991−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3992−locator term is used, "page" is assumed.
3993−
3994−`pandoc-citeproc` will use heuristics to distinguish the locator
3995−from the suffix. In complex cases, the locator can be enclosed
3996−in curly braces (using `pandoc-citeproc` 0.15 and higher only):
3997−
3998− [@smith{ii, A, D-Z}, with a suffix]
3999− [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4000−
4001−A minus sign (`-`) before the `@` will suppress mention of
4002−the author in the citation. This can be useful when the
4003−author is already mentioned in the text:
4004−
4005− Smith says blah [-@smith04].
4006−
4007−You can also write an in-text citation, as follows:
4008−
4009− @smith04 says blah.
4010−
4011− @smith04 [p. 33] says blah.
4012−
4013−If the style calls for a list of works cited, it will be placed
4014−in a div with id `refs`, if one exists:
4015−
4016− ::: {#refs}
4017− :::
4018−
4019−Otherwise, it will be placed at the end of the document.
4020−Generation of the bibliography can be suppressed by setting
4021−`suppress-bibliography: true` in the YAML metadata.
4022−
4023−If you wish the bibliography to have a section header, you can
4024−set `reference-section-title` in the metadata, or put the header
4025−at the beginning of the div with id `refs` (if you are using it)
4026−or at the end of your document:
4027−
4028− last paragraph...
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.
40295408
4030− # References
4031−
4032−The bibliography will be inserted after this header. Note that
4033−the `unnumbered` class will be added to this header, so that the
4034−section will not be numbered.
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
40355411
4036−If you want to include items in the bibliography without actually
4037−citing them in the body text, you can define a dummy `nocite` metadata
4038−field and put the citations there:
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
40395414
4040− ---
4041− nocite: |
4042− @item1, @item2
4043− ...
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
40445417
4045− @item3
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
40465420
4047−In this example, the document will contain a citation for `item3`
4048−only, but the bibliography will contain entries for `item1`, `item2`, and
4049−`item3`.
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
40505424
4051−It is possible to create a bibliography with all the citations,
4052−whether or not they appear in the document, by using a wildcard:
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
40535427
4054− ---
4055− nocite: |
4056− @*
4057− ...
5428+### Capitalization in titles
40585429
4059−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4060−render the bibliography. In order to do so, specify bibliography
4061−files as outlined above, and add `--natbib` or `--biblatex`
4062−argument to `pandoc` invocation. Bear in mind that bibliography
4063−files have to be in respective format (either BibTeX or
4064−BibLaTeX).
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
40655432
4066−For more information, see the [pandoc-citeproc man page].
5433+ - English titles should be in title case. Non-English titles should
5434+ be in sentence case, and the `langid` field in biblatex should be
5435+ set to the relevant language. (The following values are treated
5436+ as English: `american`, `british`, `canadian`, `english`,
5437+ `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
40675438
4068−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4069−[Chicago Manual of Style]: http://chicagomanualofstyle.org
4070−[Citation Style Language]: http://citationstyles.org
4071−[Zotero Style Repository]: https://www.zotero.org/styles
4072−[finding and editing styles]: https://citationstyles.org/authors/
4073−[CSL locale files]: https://github.com/citation-style-language/locales
4074−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5439+ - As is standard with bibtex/biblatex, proper names should be
5440+ protected with curly braces so that they won't be lowercased
5441+ in styles that call for sentence case. For example:
40755442
4076−Non-pandoc extensions
4077−---------------------
5443+ title = {My Dinner with {Andre}}
40785444
4079−The following Markdown syntax extensions are not enabled by default
4080−in pandoc, but may be enabled by adding `+EXTENSION` to the format
4081−name, where `EXTENSION` is the name of the extension. Thus, for
4082−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
40835447
4084−#### Extension: `old_dashes` ####
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
40855449
4086−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4087−`-` before a numeral is an en-dash, and `--` is an em-dash.
4088−This option only has an effect if `smart` is enabled. It is
4089−selected automatically for `textile` input.
5450+ Though this is not necessary in bibtex/biblatex, it is necessary
5451+ with citeproc, which stores titles internally in sentence case,
5452+ and converts to title case in styles that require it. Here we
5453+ protect "nm" so that it doesn't get converted to "Nm" at this stage.
40905454
4091−#### Extension: `angle_brackets_escapable` ####
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
40925457
4093−Allow `<` and `>` to be backslash-escaped, as they can be in
4094−GitHub flavored Markdown but not original Markdown. This is
4095−implied by pandoc's default `all_symbols_escapable`.
5458+ - All titles should be in sentence case.
40965459
4097−#### Extension: `lists_without_preceding_blankline` ####
5460+ - Use the `language` field for non-English titles to prevent their
5461+ conversion to title case in styles that call for this. (Conversion
5462+ happens only if `language` begins with `en` or is left empty.)
40985463
4099−Allow a list to occur right after a paragraph, with no intervening
4100−blank space.
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
41015466
4102−#### Extension: `four_space_rule` ####
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
41035468
4104−Selects the pandoc <= 2.0 behavior for parsing lists, so that
4105−four spaces indent are needed for list item continuation
4106−paragraphs.
5469+### Conference Papers, Published vs. Unpublished
41075470
4108−#### Extension: `spaced_reference_links` ####
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
41095473
4110−Allow whitespace between the two components of a reference link,
4111−for example,
5474+For an unpublished manuscript, use the biblatex entry type
5475+`unpublished` without an `eventtitle` field (this entry type
5476+will be mapped to CSL `manuscript`).
41125477
4113− [foo] [bar].
5478+For a talk, an unpublished conference paper, or a poster
5479+presentation, use the biblatex entry type `unpublished` with an
5480+`eventtitle` field (this entry type will be mapped to CSL
5481+`speech`). Use the biblatex `type` field to indicate the type,
5482+e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5483+too, though `eventdate` will not be rendered by most CSL styles.
5484+Note that `venue` is for the event's venue, unlike `location`
5485+which describes the publisher's location; do not use the latter
5486+for an unpublished conference paper.
41145487
4115−#### Extension: `hard_line_breaks` ####
41165488
4117−Causes all newlines within a paragraph to be interpreted as hard line
4118−breaks instead of spaces.
5489+## Specifying a citation style
41195490
4120−#### Extension: `ignore_line_breaks` ####
5491+Citations and references can be formatted using any style supported by the
5492+[Citation Style Language], listed in the [Zotero Style Repository].
5493+These files are specified using the `--csl` option or the `csl`
5494+(or `citation-style`) metadata field. By default, pandoc will
5495+use the [Chicago Manual of Style] author-date format. (You can
5496+override this default by copying a CSL style of your choice
5497+to `default.csl` in your user data directory.)
5498+The CSL project provides further information on [finding and
5499+editing styles].
5500+
5501+The `--citation-abbreviations` option (or the
5502+`citation-abbreviations` metadata field) may be used to specify
5503+a JSON file containing abbreviations of journals that should be
5504+used in formatted bibliographies when `form="short"` is
5505+specified. The format of the file can be illustrated with an
5506+example:
41215507
4122−Causes newlines within a paragraph to be ignored, rather than being
4123−treated as spaces or as hard line breaks. This option is intended for
4124−use with East Asian languages where spaces are not used between words,
4125−but text is divided into lines for readability.
41265508
4127−#### Extension: `east_asian_line_breaks` ####
5509+ { "default": {
5510+ "container-title": {
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
5512+ "Estates Gazette": "EG",
5513+ "Scots Law Times": "SLT"
5514+ }
5515+ }
5516+ }
41285517
4129−Causes newlines within a paragraph to be ignored, rather than
4130−being treated as spaces or as hard line breaks, when they occur
4131−between two East Asian wide characters. This is a better choice
4132−than `ignore_line_breaks` for texts that include a mix of East
4133−Asian wide characters and other characters.
41345518
4135−#### Extension: `emoji` ####
5519+## Citations in note styles
41365520
4137−Parses textual emojis like `:smile:` as Unicode emoticons.
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
5526+example,
41385527
4139−#### Extension: `tex_math_single_backslash` ####
5528+ Blah blah [@foo, p. 33].
41405529
4141−Causes anything between `\(` and `\)` to be interpreted as inline
4142−TeX math, and anything between `\[` and `\]` to be interpreted
4143−as display TeX math. Note: a drawback of this extension is that
4144−it precludes escaping `(` and `[`.
5530+The footnote will be created automatically. Pandoc will take
5531+care of removing the space and moving the note before or
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
5534+metadata fields].
41455535
4146−#### Extension: `tex_math_double_backslash` ####
5536+In some cases you may need to put a citation inside a regular
5537+footnote. Normal citations in footnotes (such as `[@foo, p.
5538+33]`) will be rendered in parentheses. In-text citations (such
5539+as `@foo [p. 33]`) will be rendered without parentheses. (A
5540+comma will be added if appropriate.) Thus:
41475541
4148−Causes anything between `\\(` and `\\)` to be interpreted as inline
4149−TeX math, and anything between `\\[` and `\\]` to be interpreted
4150−as display TeX math.
5542+ [^1]: Some studies [@foo; @bar, p. 33] show that
5543+ frubulicious zoosnaps are quantical. For a survey
5544+ of the literature, see @baz [chap. 1].
41515545
4152−#### Extension: `markdown_attribute` ####
5546+## Raw content in a style
41535547
4154−By default, pandoc interprets material inside block-level tags as Markdown.
4155−This extension changes the behavior so that Markdown is only parsed
4156−inside block-level tags if the tags have the attribute `markdown=1`.
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
41575550
4158−#### Extension: `mmd_title_block` ####
5551+ {{jats}}<ref>{{/jats}}
41595552
4160−Enables a [MultiMarkdown] style title block at the top of
4161−the document, for example:
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
41625555
4163− Title: My title
4164− Author: John Doe
4165− Date: September 1, 2008
4166− Comment: This is a sample mmd title block, with
4167− a field spanning multiple lines.
5556+This feature allows stylesheets to be customized to give
5557+different output for different output formats. However,
5558+stylesheets customized in this way will not be usable
5559+by other CSL implementations.
41685560
4169−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4170−`yaml_metadata_block` is enabled, it will take precedence over
4171−`mmd_title_block`.
41725561
4173−#### Extension: `abbreviations` ####
41745562
4175−Parses PHP Markdown Extra abbreviation keys, like
5563+## Placement of the bibliography
41765564
4177− *[HTML]: Hypertext Markup Language
5565+If the style calls for a list of works cited, it will be placed
5566+in a div with id `refs`, if one exists:
41785567
4179−Note that the pandoc document model does not support
4180−abbreviations, so if this extension is enabled, abbreviation keys are
4181−simply skipped (as opposed to being parsed as paragraphs).
5568+ ::: {#refs}
5569+ :::
41825570
4183−#### Extension: `autolink_bare_uris` ####
5571+Otherwise, it will be placed at the end of the document.
5572+Generation of the bibliography can be suppressed by setting
5573+`suppress-bibliography: true` in the YAML metadata.
41845574
4185−Makes all absolute URIs into links, even when not surrounded by
4186−pointy braces `<...>`.
5575+If you wish the bibliography to have a section heading, you can
5576+set `reference-section-title` in the metadata, or put the heading
5577+at the beginning of the div with id `refs` (if you are using it)
5578+or at the end of your document:
41875579
4188−#### Extension: `mmd_link_attributes` ####
5580+ last paragraph...
41895581
4190−Parses multimarkdown style key-value attributes on link
4191−and image references. This extension should not be confused with the
4192−[`link_attributes`](#extension-link_attributes) extension.
5582+ # References
41935583
4194− This is a reference ![image][ref] with multimarkdown attributes.
5584+The bibliography will be inserted after this heading. Note that
5585+the `unnumbered` class will be added to this heading, so that the
5586+section will not be numbered.
41955587
4196− [ref]: http://path.to/image "Image title" width=20px height=30px
4197− id=myId class="myClass1 myClass2"
5588+## Including uncited items in the bibliography
41985589
4199−#### Extension: `mmd_header_identifiers` ####
5590+If you want to include items in the bibliography without actually
5591+citing them in the body text, you can define a dummy `nocite` metadata
5592+field and put the citations there:
42005593
4201−Parses multimarkdown style header identifiers (in square brackets,
4202−after the header but before any trailing `#`s in an ATX header).
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
42035598
4204−#### Extension: `compact_definition_lists` ####
5599+ @item3
42055600
4206−Activates the definition list syntax of pandoc 1.12.x and earlier.
4207−This syntax differs from the one described above under [Definition lists]
4208−in several respects:
5601+In this example, the document will contain a citation for `item3`
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
5603+`item3`.
42095604
4210− - No blank line is required between consecutive items of the
4211− definition list.
4212− - To get a "tight" or "compact" list, omit space between consecutive
4213− items; the space between a term and its definition does not affect
4214− anything.
4215− - Lazy wrapping of paragraphs is not allowed: the entire definition must
4216− be indented four spaces.[^6]
5605+It is possible to create a bibliography with all the citations,
5606+whether or not they appear in the document, by using a wildcard:
42175607
4218−[^6]: To see why laziness is incompatible with relaxing the requirement
4219− of a blank line between items, consider the following example:
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
42205612
4221− bar
4222− : definition
4223− foo
4224− : definition
5613+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5614+render the bibliography. In order to do so, specify bibliography
5615+files as outlined above, and add `--natbib` or `--biblatex`
5616+argument to `pandoc` invocation. Bear in mind that bibliography
5617+files have to be in either BibTeX (for `--natbib`)
5618+or BibLaTeX (for `--biblatex`) format.
42255619
4226− Is this a single list item with two definitions of "bar," the first of
4227− which is lazily wrapped, or two list items? To remove the ambiguity
4228− we must either disallow lazy wrapping or require a blank line between
4229− list items.
5620+## Other relevant metadata fields
42305621
4231−Markdown variants
4232−-----------------
5622+A few other metadata fields affect bibliography formatting:
42335623
4234−In addition to pandoc's extended Markdown, the following Markdown
4235−variants are supported:
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
42365628
4237−`markdown_phpextra` (PHP Markdown Extra)
4238−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4239− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4240− `header_attributes`, `link_attributes`, `abbreviations`,
4241− `shortcut_reference_links`, `spaced_reference_links`.
4242−
4243−`markdown_github` (deprecated GitHub-Flavored Markdown)
4244−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4245− `gfm_auto_identifiers`, `backtick_code_blocks`,
4246− `autolink_bare_uris`, `space_in_atx_header`,
4247− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4248− `shortcut_reference_links`, `angle_brackets_escapable`,
4249− `lists_without_preceding_blankline`.
4250−
4251−`markdown_mmd` (MultiMarkdown)
4252−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4253− `tex_math_double_backslash`, `intraword_underscores`,
4254− `mmd_title_block`, `footnotes`, `definition_lists`,
4255− `all_symbols_escapable`, `implicit_header_references`,
4256− `auto_identifiers`, `mmd_header_identifiers`,
4257− `shortcut_reference_links`, `implicit_figures`,
4258− `superscript`, `subscript`, `backtick_code_blocks`,
4259− `spaced_reference_links`, `raw_attribute`.
4260−
4261−`markdown_strict` (Markdown.pl)
4262−: `raw_html`, `shortcut_reference_links`,
4263− `spaced_reference_links`.
4264−
4265−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4266−which is implemented as a set of extensions on `commonmark`).
4267−
4268−Note, however, that `commonmark` and `gfm` have limited support
4269−for extensions. Only those listed below (and `smart`,
4270−`raw_tex`, and `hard_line_breaks`) will work. The extensions
4271−can, however, all be individually disabled. Also, `raw_tex`
4272−only affects `gfm` output, not input.
4273−
4274−`gfm` (GitHub-Flavored Markdown)
4275−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4276− `gfm_auto_identifiers`, `backtick_code_blocks`,
4277− `autolink_bare_uris`, `space_in_atx_header`,
4278− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4279− `shortcut_reference_links`, `angle_brackets_escapable`,
4280− `lists_without_preceding_blankline`.
4281−
4282−
4283−Producing slide shows with pandoc
4284−=================================
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
42855660
42865661You can use pandoc to produce an HTML + JavaScript slide presentation
42875662that can be viewed via a web browser. There are five ways to do this,
@@ -4329,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
43295704
43305705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
43315706
4332−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4333−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4334−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4335−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4336−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4337−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4338−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4339−the file by default.
4340−
4341−With all HTML slide formats, the `--self-contained` option can be used to
4342−produce a single file that contains all of the data necessary to display the
4343−slide show, including linked scripts, stylesheets, images, and videos.
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5710+the relative path `s5/default` (for S5), `slideous` (for
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5714+variables; see [Variables for HTML slides], above.) For
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5716+in the file by default.
5717+
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
43445722
43455723To produce a PDF slide show using beamer, type
43465724
@@ -4353,14 +5731,13 @@ To produce a Powerpoint slide show, type
43535731
43545732 pandoc habits.txt -o habits.pptx
43555733
4356−Structuring the slide show
4357−--------------------------
5734+## Structuring the slide show
43585735
4359−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
43605737the hierarchy that is followed immediately by content, and not another
4361−header, somewhere in the document. In the example above, level 1 headers
4362−are always followed by level 2 headers, which are followed by content,
4363−so 2 is the slide level. This default can be overridden using
5738+heading, somewhere in the document. In the example above, level-1 headings
5739+are always followed by level-2 headings, which are followed by content,
5740+so the slide level is 2. This default can be overridden using
43645741the `--slide-level` option.
43655742
43665743The document is carved up into slides according to the following
@@ -4368,17 +5745,21 @@ rules:
43685745
43695746 * A horizontal rule always starts a new slide.
43705747
4371− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
43725749
4373− * Headers *below* the slide level in the hierarchy create
4374− headers *within* a slide.
5750+ * Headings *below* the slide level in the hierarchy create
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
43755756
4376− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
43775758 "title slides," which just contain the section title
43785759 and help to break the slide show into sections.
4379−
4380− * Content *above* the slide level will not appear in the slide
4381− show.
5760+ Non-slide content under these headings will be included
5761+ on the title slide (for HTML slide shows) or in a
5762+ subsequent slide with the same title (for beamer).
43825763
43835764 * A title page is constructed automatically from the document's title
43845765 block, if present. (In the case of beamer, this can be disabled
@@ -4386,17 +5767,16 @@ rules:
43865767
43875768These rules are designed to support many different styles of slide show. If
43885769you don't care about structuring your slides into sections and subsections,
4389−you can just use level 1 headers for all each slide. (In that case, level 1
5770+you can just use level-1 headings for all each slide. (In that case, level-1
43905771will be the slide level.) But you can also structure the slide show into
43915772sections, as in the example above.
43925773
43935774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4394−layout will be produced, with level 1 headers building horizontally
4395−and level 2 headers building vertically. It is not recommended that
5775+layout will be produced, with level-1 headings building horizontally
5776+and level-2 headings building vertically. It is not recommended that
43965777you use deeper nesting of section levels with reveal.js.
43975778
4398−Incremental lists
4399−-----------------
5779+## Incremental lists
44005780
44015781By default, these writers produce lists that display "all at once."
44025782If you want your lists to display incrementally (one item at a time),
@@ -4434,8 +5814,10 @@ option):
44345814Both methods allow incremental and nonincremental lists to be mixed
44355815in a single document.
44365816
4437−Inserting pauses
4438−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
44395821
44405822You can add "pauses" within a slide by including a paragraph containing
44415823three dots, separated by spaces:
@@ -4448,8 +5830,9 @@ three dots, separated by spaces:
44485830
44495831 content after the pause
44505832
4451−Styling the slides
4452−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
44535836
44545837You can change the style of HTML slides by putting customized CSS files
44555838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4474,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
44745857
44755858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
44765859
4477−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
44785861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4479−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
44805863that affects slides is the `allowframebreaks` class, which sets the
44815864`allowframebreaks` option, causing multiple slides to be created
44825865if the content overfills the frame. This is recommended especially for
@@ -4484,8 +5867,7 @@ bibliographies:
44845867
44855868 # References {.allowframebreaks}
44865869
4487−Speaker notes
4488−-------------
5870+## Speaker notes
44895871
44905872Speaker notes are supported in reveal.js and PowerPoint (pptx)
44915873output. You can add notes to your Markdown document thus:
@@ -4506,8 +5888,7 @@ in handouts and presenter view.
45065888Notes are not yet supported for other slide formats, but the notes
45075889will not appear on the slides themselves.
45085890
4509−Columns
4510−-------
5891+## Columns
45115892
45125893To put material in side by side columns, you can use a native
45135894div container with class `columns`, containing two or more div
@@ -4522,12 +5903,46 @@ containers with class `column` and a `width` attribute:
45225903 :::
45235904 ::::::::::::::
45245905
4525−Frame attributes in beamer
4526−--------------------------
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
45275942
45285943Sometimes it is necessary to add the LaTeX `[fragile]` option to
45295944a frame in beamer (for example, when using the `minted` environment).
4530−This can be forced by adding the `fragile` class to the header
5945+This can be forced by adding the `fragile` class to the heading
45315946introducing the slide:
45325947
45335948 # Fragile slide {.fragile}
@@ -4537,10 +5952,9 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
45375952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
45385953`shrink`, `standout`, `noframenumbering`.
45395954
4540−Background in reveal.js and beamer
4541−----------------------------------
5955+## Background in reveal.js and beamer
45425956
4543−Background images can be added to self-contained reveal.js slideshows and
5957+Background images can be added to self-contained reveal.js slideshows and
45445958to beamer slideshows.
45455959
45465960For the same image on every slide, use the configuration
@@ -4548,14 +5962,14 @@ option `background-image` either in the YAML metadata block
45485962or as a command-line variable. (There are no other options in
45495963beamer and the rest of this section concerns reveal.js slideshows.)
45505964
4551−For reveal.js, you can instead use the reveal.js-native option
4552−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4553−and `parallaxBackgroundVertical` the same way and must also set
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
45545968`parallaxBackgroundSize` to have your values take effect.
45555969
45565970To set an image for a particular reveal.js slide, add
45575971`{data-background-image="/path/to/image"}`
4558−to the first slide-level header on the slide (which may even be empty).
5972+to the first slide-level heading on the slide (which may even be empty).
45595973
45605974In reveal.js's overview mode, the parallaxBackgroundImage will show up
45615975only on the first slide.
@@ -4564,9 +5978,12 @@ Other reveal.js background settings also work on individual slides, including
45645978`data-background-size`, `data-background-repeat`, `data-background-color`,
45655979`data-transition`, and `data-transition-speed`.
45665980
4567−See the [reveal.js
4568−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4569−for more details.
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.
45705987
45715988For example in reveal.js:
45725989
@@ -4574,6 +5991,9 @@ For example in reveal.js:
45745991---
45755992title: My Slideshow
45765993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
45775997---
45785998
45795999## Slide One
@@ -4582,14 +6002,12 @@ Slide 1 has background_image.png as its background.
45826002
45836003## {data-background-image="/path/to/special_image.jpg"}
45846004
4585−Slide 2 has a special image for its background, even though the header has no content.
6005+Slide 2 has a special image for its background, even though the heading has no content.
45866006```
45876007
4588−Creating EPUBs with pandoc
4589−==========================
6008+# EPUBs
45906009
4591−EPUB Metadata
4592−-------------
6010+## EPUB Metadata
45936011
45946012EPUB metadata may be specified using the `--epub-metadata` option, but
45956013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4667,6 +6085,15 @@ The following fields are recognized:
46676085
46686086`rights`
46696087 ~ 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.
46706097
46716098`cover-image`
46726099 ~ A string value (path to cover image).
@@ -4688,13 +6115,12 @@ The following fields are recognized:
46886115 - `binding`: `true`|`false` (default `true`)
46896116 - `scroll-axis`: `vertical`|`horizontal`|`default`
46906117
4691−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
46926119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
46936120
4694−The `epub:type` attribute
4695−-------------------------
6121+## The `epub:type` attribute
46966122
4697−For `epub3` output, you can mark up the header that corresponds to an EPUB
6123+For `epub3` output, you can mark up the heading that corresponds to an EPUB
46986124chapter using the [`epub:type` attribute][epub-type]. For example, to set
46996125the attribute to the value `prologue`, use this markdown:
47006126
@@ -4717,22 +6143,26 @@ abstract frontmatter
47176143acknowledgments frontmatter
47186144copyright-page frontmatter
47196145dedication 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
47206156foreword frontmatter
4721−halftitle, frontmatter
4722−introduction frontmatter
47236157preface frontmatter
4724−seriespage frontmatter
4725−titlepage frontmatter
4726−afterword backmatter
47276158appendix backmatter
47286159colophon backmatter
4729−conclusion backmatter
4730−epigraph backmatter
6160+bibliography backmatter
6161+index backmatter
47316162
47326163[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
47336164
4734−Linked media
4735−------------
6165+## Linked media
47366166
47376167By default, pandoc will download media referenced from any `<img>`, `<audio>`,
47386168`<video>` or `<source>` element present in the generated EPUB,
@@ -4742,13 +6172,137 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
47426172with the `src` attribute. For example:
47436173
47446174 <audio controls="1">
4745− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
47466176 data-external="1" type="audio/mpeg">
47476177 </source>
47486178 </audio>
47496179
4750−Syntax highlighting
4751−===================
6180+# Jupyter notebooks
6181+
6182+When creating a [Jupyter notebook], pandoc will try to infer the
6183+notebook structure. Code blocks with the class `code` will be
6184+taken as code cells, and intervening content will be taken as
6185+Markdown cells. Attachments will automatically be created for
6186+images in Markdown cells. Metadata will be taken from the
6187+`jupyter` metadata field. For example:
6188+
6189+````
6190+---
6191+title: My notebook
6192+jupyter:
6193+ nbformat: 4
6194+ nbformat_minor: 5
6195+ kernelspec:
6196+ display_name: Python 2
6197+ language: python
6198+ name: python2
6199+ language_info:
6200+ codemirror_mode:
6201+ name: ipython
6202+ version: 2
6203+ file_extension: ".py"
6204+ mimetype: "text/x-python"
6205+ name: "python"
6206+ nbconvert_exporter: "python"
6207+ pygments_lexer: "ipython2"
6208+ version: "2.7.15"
6209+---
6210+
6211+# Lorem ipsum
6212+
6213+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6214+bibendum felis dictum sodales.
6215+
6216+``` code
6217+print("hello")
6218+```
6219+
6220+## Pyout
6221+
6222+``` code
6223+from IPython.display import HTML
6224+HTML("""
6225+<script>
6226+console.log("hello");
6227+</script>
6228+<b>HTML</b>
6229+""")
6230+```
6231+
6232+## Image
6233+
6234+This image  will be
6235+included as a cell attachment.
6236+````
6237+
6238+If you want to add cell attributes, group cells differently, or
6239+add output to code cells, then you need to include divs to
6240+indicate the structure. You can use either [fenced
6241+divs][Extension: `fenced_divs`] or [native divs][Extension:
6242+`native_divs`] for this. Here is an example:
6243+
6244+````
6245+:::::: {.cell .markdown}
6246+# Lorem
6247+
6248+**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249+bibendum felis dictum sodales.
6250+::::::
6251+
6252+:::::: {.cell .code execution_count=1}
6253+``` {.python}
6254+print("hello")
6255+```
6256+
6257+::: {.output .stream .stdout}
6258+```
6259+hello
6260+```
6261+:::
6262+::::::
6263+
6264+:::::: {.cell .code execution_count=2}
6265+``` {.python}
6266+from IPython.display import HTML
6267+HTML("""
6268+<script>
6269+console.log("hello");
6270+</script>
6271+<b>HTML</b>
6272+""")
6273+```
6274+
6275+::: {.output .execute_result execution_count=2}
6276+```{=html}
6277+<script>
6278+console.log("hello");
6279+</script>
6280+<b>HTML</b>
6281+hello
6282+```
6283+:::
6284+::::::
6285+````
6286+
6287+If you include raw HTML or TeX in an output cell, use the
6288+[raw attribute][Extension: `fenced_attribute`], as shown
6289+in the last cell of the example above. Although pandoc can
6290+process "bare" raw HTML and TeX, the result is often
6291+interspersed raw elements and normal textual elements, and
6292+in an output cell pandoc expects a single, connected raw
6293+block. To avoid using raw HTML or TeX except when
6294+marked explicitly using raw attributes, we recommend
6295+specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6296+translating between Markdown and ipynb notebooks.
6297+
6298+Note that options and extensions that affect reading and
6299+writing of Markdown will also affect Markdown cells in ipynb
6300+notebooks. For example, `--wrap=preserve` will preserve
6301+soft line breaks in Markdown cells; `--atx-headers` will
6302+cause ATX-style headings to be used; and `--preserve-tabs` will
6303+prevent tabs from being turned to spaces.
6304+
6305+# Syntax highlighting
47526306
47536307Pandoc will automatically highlight syntax in [fenced code blocks] that
47546308are marked with a language name. The Haskell library [skylighting] is
@@ -4776,7 +6330,7 @@ Then edit `my.theme` and use it like this:
47766330If you are not satisfied with the built-in highlighting, or you
47776331want highlight a language that isn't supported, you can use the
47786332`--syntax-definition` option to load a [KDE-style XML syntax definition
4779−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
47806334Before writing your own, have a look at KDE's [repository of syntax
47816335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
47826336
@@ -4784,13 +6338,58 @@ To disable highlighting, use the `--no-highlight` option.
47846338
47856339[skylighting]: https://github.com/jgm/skylighting
47866340
4787−Custom Styles
4788−=============
6341+# Custom Styles
47896342
47906343Custom styles can be used in the docx and ICML formats.
47916344
4792−Input
4793−-----
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
6349+formatting (italics, bold) for inlines. This will work for most
6350+purposes, especially alongside a `reference.docx` file. However, if you
6351+need to apply your own styles to blocks, or match a preexisting set of
6352+styles, pandoc allows you to define custom styles for blocks and text
6353+using `div`s and `span`s, respectively.
6354+
6355+If you define a `div` or `span` with the attribute `custom-style`,
6356+pandoc will apply your specified style to the contained elements (with
6357+the exception of elements whose function depends on a style, like
6358+headings, code blocks, block quotes, or links). So, for example, using
6359+the `bracketed_spans` syntax,
6360+
6361+ [Get out]{custom-style="Emphatically"}, he said.
6362+
6363+would produce a docx file with "Get out" styled with character
6364+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6365+
6366+ Dickinson starts the poem simply:
6367+
6368+ ::: {custom-style="Poetry"}
6369+ | A Bird came down the Walk---
6370+ | He did not know I saw---
6371+ :::
6372+
6373+would style the two contained lines with the `Poetry` paragraph style.
6374+
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.
6378+
6379+This feature allows for greatest customization in conjunction with
6380+[pandoc filters]. If you want all paragraphs after block quotes to be
6381+indented, you can write a filter to apply the styles necessary. If you
6382+want all italics to be transformed to the `Emphasis` character style
6383+(perhaps to change their color), you can write a filter which will
6384+transform all italicized inlines to inlines within an `Emphasis`
6385+custom-style `span`.
6386+
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
47946393
47956394The docx reader, by default, only reads those styles that it can
47966395convert into pandoc elements, either by direct conversion or
@@ -4819,17 +6418,17 @@ And with the extension:
48196418
48206419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
48216420
4822− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
48236422 This is some text.
48246423 :::
48256424
4826− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
48276426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
48286427 And this is text with a [strengthened]{custom-style="Strengthened"}
48296428 text style.
48306429 :::
48316430
4832− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
48336432 > Here is a styled paragraph that inherits from Block Text.
48346433 :::
48356434
@@ -4837,70 +6436,47 @@ With these custom styles, you can use your input document as a
48376436reference-doc while creating docx output (see below), and maintain the
48386437same styles in your input and output files.
48396438
4840−Output
4841−------
4842−
4843−By default, pandoc's docx and ICML output applies a predefined set of styles
4844−for blocks such as paragraphs and block quotes, and uses largely default
4845−formatting (italics, bold) for inlines. This will work for most
4846−purposes, especially alongside a `reference.docx` file. However, if you
4847−need to apply your own styles to blocks, or match a preexisting set of
4848−styles, pandoc allows you to define custom styles for blocks and text
4849−using `div`s and `span`s, respectively.
4850−
4851−If you define a `div` or `span` with the attribute `custom-style`,
4852−pandoc will apply your specified style to the contained elements. So,
4853−for example using the `bracketed_spans` syntax,
4854−
4855− [Get out]{custom-style="Emphatically"}, he said.
4856−
4857−would produce a docx file with "Get out" styled with character
4858−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4859−
4860− Dickinson starts the poem simply:
4861−
4862− ::: {custom-style="Poetry"}
4863− | A Bird came down the Walk---
4864− | He did not know I saw---
4865− :::
4866−
4867−would style the two contained lines with the `Poetry` paragraph style.
4868−
4869−For docx output, styles will be defined in the output file as inheriting
4870−from normal text, if the styles are not yet in your reference.docx.
4871−If they are already defined, pandoc will not alter the definition.
4872−
4873−This feature allows for greatest customization in conjunction with
4874−[pandoc filters]. If you want all paragraphs after block quotes to be
4875−indented, you can write a filter to apply the styles necessary. If you
4876−want all italics to be transformed to the `Emphasis` character style
4877−(perhaps to change their color), you can write a filter which will
4878−transform all italicized inlines to inlines within an `Emphasis`
4879−custom-style `span`.
4880−
4881−[pandoc filters]: http://pandoc.org/filters.html
4882−
4883−Custom writers
4884−==============
6439+# Custom writers
48856440
4886−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4887−includes a lua interpreter, so lua need not be installed separately.)
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
48886443
4889−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
48906445in place of the output format. For example:
48916446
48926447 pandoc -t data/sample.lua
48936448
4894−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
48956450possible element in a pandoc document. To get a documented example
48966451which you can modify according to your needs, do
48976452
48986453 pandoc --print-default-data-file sample.lua
48996454
4900−[lua]: http://www.lua.org
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).
49016478
4902−A note on security
4903−==================
6479+# A note on security
49046480
49056481If you use pandoc to convert user-contributed content in a web
49066482application, here are some things to keep in mind:
@@ -4915,7 +6491,7 @@ application, here are some things to keep in mind:
49156491 shelling out to the executable), it is possible to use it in a mode
49166492 that fully isolates pandoc from your file system, by running the
49176493 pandoc operations in the `PandocPure` monad. See the document
4918− [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
6494+ [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
49196495 for more details.
49206496
492164973. Pandoc's parsers can exhibit pathological performance on some
@@ -4928,17 +6504,17 @@ application, here are some things to keep in mind:
492865044. The HTML generated by pandoc is not guaranteed to be safe.
49296505 If `raw_html` is enabled for the Markdown input, users can
49306506 inject arbitrary HTML. Even if `raw_html` is disabled,
4931− users can include dangerous content in attributes for
4932− headers, spans, and code blocks. To be safe, you should
4933− run all the generated HTML through an HTML sanitizer.
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.
49346510
4935−Authors
4936−=======
6511+# Authors
49376512
4938−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
49396514under the [GPL], version 2 or greater. This software carries no
49406515warranty of any kind. (See COPYRIGHT for full copyright and
49416516warranty notices.) For a full list of contributors, see the file
49426517AUTHORS.md in the pandoc source code.
49436518
4944−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6519+[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6520+[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"