@@ -1,14 +1,14 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% January 30, 2019
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,17 +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 uses [variables for LaTeX] (with a LaTeX engine);
132−[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
133−(an HTML/CSS-to-PDF engine; `--css` also affects 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`.
134131
135132To debug the PDF creation, it can be useful to look at the intermediate
136133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -139,33 +136,32 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
139136When using LaTeX, the following packages need to be available
140137(they are included with all recent versions of [TeX Live]):
141138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
142−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
143140`--listings` option is used), [`fancyvrb`], [`longtable`],
144−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141+[`booktabs`], [`graphicx`] (if the document
145142contains images), [`hyperref`], [`xcolor`],
146143[`ulem`], [`geometry`] (with the `geometry` variable set),
147144[`setspace`] (with `linestretch`), and
148145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
149−the PDF engine requires [`fontspec`]. `xelatex` uses
150−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
151−`dir` variable set). If the `mathspec` variable is set,
152−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
153−The [`upquote`] and [`microtype`] packages are used if
154−available, and [`csquotes`] will be used for [typography]
155−if `\usepackage{csquotes}` is present in the template or
156−included via `/H/--include-in-header`. The [`natbib`],
157−[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
158−be used for [citation rendering]. The following packages
159−will be used to improve output quality if present, but
160−pandoc does not require them to be present:
161−[`upquote`] (for straight quotes in verbatim environments),
162−[`microtype`] (for better spacing adjustments),
163−[`parskip`] (for better inter-paragraph spaces),
164−[`xurl`] (for better line breaks in URLs),
165−[`bookmark`] (for better PDF bookmarks),
166−and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
167−
168−[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/
169165[`amsfonts`]: https://ctan.org/pkg/amsfonts
170166[`amsmath`]: https://ctan.org/pkg/amsmath
171167[`babel`]: https://ctan.org/pkg/babel
@@ -184,8 +180,7 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
184180[`graphicx`]: https://ctan.org/pkg/graphicx
185181[`grffile`]: https://ctan.org/pkg/grffile
186182[`hyperref`]: https://ctan.org/pkg/hyperref
187−[`ifluatex`]: https://ctan.org/pkg/ifluatex
188−[`ifxetex`]: https://ctan.org/pkg/ifxetex
183+[`iftex`]: https://ctan.org/pkg/iftex
189184[`listings`]: https://ctan.org/pkg/listings
190185[`lm`]: https://ctan.org/pkg/lm
191186[`longtable`]: https://ctan.org/pkg/longtable
@@ -199,41 +194,44 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
199194[`ulem`]: https://ctan.org/pkg/ulem
200195[`unicode-math`]: https://ctan.org/pkg/unicode-math
201196[`upquote`]: https://ctan.org/pkg/upquote
202−[`weasyprint`]: http://weasyprint.org
197+[`weasyprint`]: https://weasyprint.org
203198[`wkhtmltopdf`]: https://wkhtmltopdf.org
204199[`xcolor`]: https://ctan.org/pkg/xcolor
205200[`xecjk`]: https://ctan.org/pkg/xecjk
206201[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
207203
208204
209205
210−Reading from the Web
211−--------------------
206+## Reading from the Web
212207
213−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
214209pandoc will fetch the content using HTTP:
215210
216− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
217212
218213It is possible to supply a custom User-Agent string or other
219214header when requesting a document from a URL:
220215
221216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
222− http://www.fsf.org
217+ https://www.fsf.org
223218
224−Options
225−=======
219+# Options
226220
227−General options {.options}
228−---------------
221+## General options {.options}
229222
230223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
231224
232225: Specify input format. *FORMAT* can be:
233226
234227 ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
235230 - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
236232 - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
237235 - `docbook` ([DocBook])
238236 - `docx` ([Word docx])
239237 - `dokuwiki` ([DokuWiki markup])
@@ -247,6 +245,7 @@ General options {.options}
247245 - `html` ([HTML])
248246 - `ipynb` ([Jupyter notebook])
249247 - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
250249 - `json` (JSON version of native AST)
251250 - `latex` ([LaTeX])
252251 - `markdown` ([Pandoc's Markdown])
@@ -281,8 +280,12 @@ General options {.options}
281280 ::: {#output-formats}
282281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
284285 - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
285287 - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
286289 - `docbook` or `docbook4` ([DocBook] 4)
287290 - `docbook5` (DocBook 5)
288291 - `docx` ([Word docx])
@@ -299,7 +302,11 @@ General options {.options}
299302 - `html4` ([XHTML] 1.0 Transitional)
300303 - `icml` ([InDesign ICML])
301304 - `ipynb` ([Jupyter notebook])
302− - `jats` ([JATS] XML)
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)
303310 - `json` (JSON version of native AST)
304311 - `latex` ([LaTeX])
305312 - `man` ([roff man])
@@ -315,6 +322,7 @@ General options {.options}
315322 - `opml` ([OPML])
316323 - `opendocument` ([OpenDocument])
317324 - `org` ([Emacs Org mode])
325+ - `pdf` ([PDF])
318326 - `plain` (plain text),
319327 - `pptx` ([PowerPoint] slide show)
320328 - `rst` ([reStructuredText])
@@ -327,11 +335,12 @@ General options {.options}
327335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
328336 - `s5` ([S5] HTML and JavaScript slide show)
329337 - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
330339 - `zimwiki` ([ZimWiki markup])
331− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
332341 :::
333342
334− Note that `odt`, `docx`, and `epub` output will not be directed
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
335344 to *stdout* unless forced with `-o -`.
336345
337346 Extensions can be individually enabled or
@@ -349,23 +358,32 @@ General options {.options}
349358
350359: Specify the user data directory to search for pandoc data files.
351360 If this option is not specified, the default user data directory
352− will be used. This is, in UNIX:
353−
354− $HOME/.pandoc
355−
356− in Windows XP:
357−
358− C:\Documents And Settings\USERNAME\Application Data\pandoc
359−
360− and in Windows Vista or later:
361−
362− C:\Users\USERNAME\AppData\Roaming\pandoc
363−
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`.
364368 You can find the default user data directory on your system by
365369 looking at the output of `pandoc --version`.
366− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
367− `slidy`, `slideous`, or `s5` directory
368− 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.
369387
370388`--bash-completion`
371389
@@ -376,8 +394,7 @@ General options {.options}
376394
377395`--verbose`
378396
379−: Give verbose debugging output. Currently this only has an effect
380− with PDF output.
397+: Give verbose debugging output.
381398
382399`--quiet`
383400
@@ -403,7 +420,7 @@ General options {.options}
403420
404421`--list-extensions`[`=`*FORMAT*]
405422
406−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
407424 by a `+` or `-` indicating whether it is enabled by default
408425 in *FORMAT*. If *FORMAT* is not specified, defaults for
409426 pandoc's Markdown are given.
@@ -426,64 +443,88 @@ General options {.options}
426443
427444: Show usage message.
428445
429−[Markdown]: http://daringfireball.net/projects/markdown/
430−[CommonMark]: http://commonmark.org
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
431448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
432449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
433−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
434−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
435−[S5]: http://meyerweb.com/eric/tools/s5/
436−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
437−[Slideous]: http://goessner.net/articles/slideous/
438−[HTML]: http://www.w3.org/html/
439−[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/
440457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
441−[XHTML]: http://www.w3.org/TR/xhtml1/
442−[LaTeX]: http://latex-project.org
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
443460[`beamer`]: https://ctan.org/pkg/beamer
444−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
445−[ConTeXt]: http://www.contextgarden.net/
446−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
447−[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
448465[JATS]: https://jats.nlm.nih.gov
449−[txt2tags]: http://txt2tags.org
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
450468[EPUB]: http://idpf.org/epub
451469[OPML]: http://dev.opml.org/spec2.html
452470[OpenDocument]: http://opendocument.xml.org
453−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
454−[Textile]: http://redcloth.org/textile
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
455473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
456474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
457−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
458−[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
459478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
460479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
461480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
462−[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
463−[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)
464484[Haskell]: https://www.haskell.org
465−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
466−[Emacs Org mode]: http://orgmode.org
467−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486+[Emacs Org mode]: https://orgmode.org
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
468488[AsciiDoctor]: https://asciidoctor.org/
469−[DZSlides]: http://paulrouget.com/dzslides/
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
474494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
475−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
495+[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
476496[TEI Simple]: https://github.com/TEIC/TEI-Simple
477497[Muse]: https://amusewiki.org/library/manual
478498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
479499[Vimwiki]: https://vimwiki.github.io
480−
481−Reader options {.options}
482−--------------
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.
483522
484523`--base-header-level=`*NUMBER*
485524
486−: 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).
487528
488529`--strip-empty-paragraphs`
489530
@@ -548,41 +589,32 @@ Reader options {.options}
548589
549590 3. `$PATH` (executable only)
550591
551− Filters and lua-filters are applied in the order specified
552− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
553594
554−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
555596
556597: Transform the document in a similar fashion as JSON filters (see
557− `--filter`), but use pandoc's build-in lua filtering system. The given
558− lua script is expected to return a list of lua filters which will be
559− 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
560601 functions indexed by the name of the AST element on which the filter
561602 function should be applied.
562603
563− The `pandoc` lua module provides helper functions for element
564− 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.
565606
566− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
567608
568− function expand_hello_world(inline)
569− if inline.c == '{{helloworld}}' then
570− return pandoc.Emph{ pandoc.Str "Hello, World" }
571− else
572− return inline
573− end
574− end
609+ In order of preference, pandoc will look for Lua filters in
575610
576− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
577612
578− In order of preference, pandoc will look for lua filters in
579−
580− 1. a specified full or relative path (executable or
581− non-executable)
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
582615
583− 2. `$DATADIR/filters` (executable or non-executable)
584− where `$DATADIR` is the user data directory (see
585− `--data-dir`, above).
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
586618
587619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
588620
@@ -599,19 +631,23 @@ Reader options {.options}
599631
600632`--metadata-file=`*FILE*
601633
602−: Read metadata from the supplied YAML (or JSON) file.
603− This option can be used with every input format, but string
604− scalars in the YAML file will always be parsed as Markdown.
605− Generally, the input will be handled the same as in
606− [YAML metadata blocks][Extension: `yaml_metadata_block`].
607− Metadata values specified inside the document, or by using `-M`,
608− 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.
609644
610645`-p`, `--preserve-tabs`
611646
612−: Preserve tabs instead of converting them to spaces (the default).
613− Note that this will only affect tabs in literal code spans and code
614− 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.
615651
616652`--tab-stop=`*NUMBER*
617653
@@ -621,30 +657,30 @@ Reader options {.options}
621657
622658: Specifies what to do with insertions, deletions, and comments
623659 produced by the MS Word "Track Changes" feature. `accept` (the
624− default), inserts all insertions, and ignores all
625− deletions. `reject` inserts all deletions and ignores
626− insertions. Both `accept` and `reject` ignore comments. `all` puts
627− in insertions, deletions, and comments, wrapped in spans with
628− `insertion`, `deletion`, `comment-start`, and `comment-end`
629− classes, respectively. The author and time of change is
630− included. `all` is useful for scripting: only accepting changes
631− from a certain reviewer, say, or before a certain date. If a
632− paragraph is inserted or deleted, `track-changes=all` produces a
633− span with the class `paragraph-insertion`/`paragraph-deletion`
634− before the affected paragraph break. This option only affects the
635− 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.
636672
637673`--extract-media=`*DIR*
638674
639675: Extract images and other media contained in or linked from
640676 the source document to the path *DIR*, creating it if
641677 necessary, and adjust the images references in the document
642− so they point to the extracted files. If the source format is
643− a binary container (docx, epub, or odt), the media is
644− extracted from the container and the original
645− filenames are used. Otherwise the media is read from the
646− file system or downloaded, and new filenames are constructed
647− 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.
648684
649685`--abbreviations=`*FILE*
650686
@@ -655,17 +691,17 @@ Reader options {.options}
655691 system default, use
656692 `pandoc --print-default-data-file=abbreviations`. The only
657693 use pandoc makes of this list is in the Markdown reader.
658− Strings ending in a period that are found in this list will
659− be followed by a nonbreaking space, so that the period will
660− 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.
661697
662698[`pandocfilters`]: https://github.com/jgm/pandocfilters
663699[PHP]: https://github.com/vinai/pandocfilters-php
664700[perl]: https://metacpan.org/pod/Pandoc::Filter
665701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
666703
667−General writer options {.options}
668−----------------------
704+## General writer options {.options}
669705
670706`-s`, `--standalone`
671707
@@ -690,22 +726,29 @@ General writer options {.options}
690726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
691727
692728: Set the template variable *KEY* to the value *VAL* when rendering the
693− document in standalone mode. This is generally only useful when the
694− `--template` option is used to specify a custom template, since
695− pandoc automatically sets the variables used in the default
696− templates. If no *VAL* is specified, the key will be given the
697− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
698731
699732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
700733
701734: Print the system default template for an output *FORMAT*. (See `-t`
702735 for a list of possible *FORMAT*s.) Templates in the user data
703− 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`.
704745
705746`--print-default-data-file=`*FILE*
706747
707748: Print a system default data file. Files in the user data directory
708− 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.
709752
710753`--eol=crlf`|`lf`|`native`
711754
@@ -716,9 +759,12 @@ General writer options {.options}
716759
717760`--dpi`=*NUMBER*
718761
719−: Specify the dpi (dots per inch) value for conversion from pixels
720− to inch/centimeters and vice versa. The default is 96dpi.
721− 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.
722768
723769`--wrap=auto`|`none`|`preserve`
724770
@@ -749,11 +795,17 @@ General writer options {.options}
749795 unless `-s/--standalone` is used, and it has no effect
750796 on `man`, `docbook4`, `docbook5`, or `jats` output.
751797
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+
752804`--toc-depth=`*NUMBER*
753805
754806: Specify the number of section levels to include in the table
755− of contents. The default is 3 (which means that level 1, 2, and 3
756− 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).
757809
758810`--strip-comments`
759811
@@ -789,7 +841,10 @@ General writer options {.options}
789841
790842: Prints a JSON version of a highlighting style, which can
791843 be modified, saved with a `.theme` extension, and used
792− 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.
793848
794849`--syntax-definition=`*FILE*
795850
@@ -797,7 +852,8 @@ General writer options {.options}
797852 which will be used for syntax highlighting of appropriately
798853 marked code blocks. This can be used to add support for
799854 new languages or to use altered syntax definitions for
800− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
801857
802858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
803859
@@ -835,11 +891,11 @@ General writer options {.options}
835891 will not be searched. For example:
836892 `--resource-path=.:test` will search the working directory
837893 and the `test` subdirectory, in that order.
838−
839− `--resource-path` only has an effect if (a) the output
840− format embeds images (for example, `docx`, `pdf`, or `html`
841− with `--self-contained`) or (b) it is used together with
842− `--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`.
843899
844900`--request-header=`*NAME*`:`*VAL*
845901
@@ -849,8 +905,13 @@ General writer options {.options}
849905 downloaded). If you're behind a proxy, you also need to set
850906 the environment variable `http_proxy` to `http://...`.
851907
852−Options affecting specific writers {.options}
853−----------------------------------
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}
854915
855916`--self-contained`
856917
@@ -875,7 +936,9 @@ Options affecting specific writers {.options}
875936
876937`--html-q-tags`
877938
878−: 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.)
879942
880943`--ascii`
881944
@@ -893,37 +956,45 @@ Options affecting specific writers {.options}
893956 placement of link references is affected by the
894957 `--reference-location` option.
895958
896−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
897960
898961: Specify whether footnotes (and references, if `reference-links` is
899962 set) are placed at the end of the current (top-level) block, the
900963 current section, or the document. The default is
901964 `document`. Currently only affects the markdown writer.
902965
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+
903974`--atx-headers`
904975
905−: Use ATX-style headers in Markdown output. The default is
906− to use setext-style headers for levels 1-2, and then ATX headers.
907− (Note: for `gfm` output, ATX headers are always used.)
908− This option also affects markdown cells in `ipynb` output.
976+: *Deprecated synonym for `--markdown-headings=atx`.*
909977
910−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
911979
912−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
913− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
914− all headers are shifted such that the top-level header becomes the specified
915− type. The default behavior is to determine the best division type via
916− heuristics: unless other conditions apply, `section` is chosen. When the
917− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
918− `article` option is specified), `chapter` is implied as the setting for this
919− option. If `beamer` is the output format, specifying either `chapter` or
920− `part` will cause top-level headers to become `\part{..}`, while
921− 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.
922993
923994`-N`, `--number-sections`
924995
925−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
926− 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
927998 `unnumbered` will never be numbered, even if `--number-sections`
928999 is specified.
9291000
@@ -931,10 +1002,10 @@ Options affecting specific writers {.options}
9311002
9321003: Offset for section headings in HTML output (ignored in other
9331004 output formats). The first number is added to the section number for
934− top-level headers, the second for second-level headers, and so on.
935− 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
9361007 document to be numbered "6", specify `--number-offset=5`.
937− 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
9381009 be numbered "1.5", specify `--number-offset=1,4`.
9391010 Offsets are 0 by default. Implies `--number-sections`.
9401011
@@ -942,7 +1013,7 @@ Options affecting specific writers {.options}
9421013
9431014: Use the [`listings`] package for LaTeX code blocks. The package
9441015 does not support multi-byte encoding for source code. To handle UTF-8
945− 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
9461017 documented here: [Encoding issue with the listings package].
9471018
9481019`-i`, `--incremental`
@@ -952,12 +1023,12 @@ Options affecting specific writers {.options}
9521023
9531024`--slide-level=`*NUMBER*
9541025
955−: Specifies that headers with the specified level create
956− 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
9571028 above this level in the hierarchy are used to divide the
958− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
9591030 subheads within a slide. Note that content that is
960− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
9611032 the slide show. The default is to set the slide level based
9621033 on the contents of the document; see [Structuring the slide
9631034 show].
@@ -966,8 +1037,8 @@ Options affecting specific writers {.options}
9661037
9671038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
9681039 and attach identifiers to the enclosing `<section>` (or `<div>`)
969− rather than the header itself. See
970− [Header identifiers], below.
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
9711042
9721043`--email-obfuscation=none`|`javascript`|`references`
9731044
@@ -988,8 +1059,7 @@ Options affecting specific writers {.options}
9881059
9891060: Specify *STRING* as a prefix at the beginning of the title
9901061 that appears in the HTML header (but not in the title as it
991− appears at the beginning of the HTML body). Implies
992− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
9931063
9941064`-c` *URL*, `--css=`*URL*
9951065
@@ -1021,14 +1091,14 @@ Options affecting specific writers {.options}
10211091
10221092 To produce a custom `reference.docx`, first get a copy of
10231093 the default `reference.docx`: `pandoc
1024− --print-default-data-file reference.docx >
1025− custom-reference.docx`. Then open `custom-reference.docx`
1026− in Word, modify the styles as you wish, and save the file.
1027− For best results, do not make changes to this file other
1028− than modifying the styles used by pandoc:
1029−
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+
10301100 Paragraph styles:
1031−
1101+
10321102 - Normal
10331103 - Body Text
10341104 - First Paragraph
@@ -1058,17 +1128,18 @@ Options affecting specific writers {.options}
10581128 - Figure
10591129 - Captioned Figure
10601130 - TOC Heading
1061−
1131+
10621132 Character styles:
1063−
1133+
10641134 - Default Paragraph Font
10651135 - Body Text Char
10661136 - Verbatim Char
10671137 - Footnote Reference
10681138 - Hyperlink
1069−
1139+ - Section Number
1140+
10701141 Table style:
1071−
1142+
10721143 - Table
10731144
10741145 ODT
@@ -1083,19 +1154,18 @@ Options affecting specific writers {.options}
10831154
10841155 To produce a custom `reference.odt`, first get a copy of
10851156 the default `reference.odt`: `pandoc
1086− --print-default-data-file reference.odt >
1087− custom-reference.odt`. Then open `custom-reference.odt` in
1088− LibreOffice, modify the styles as you wish, and save the
1089− 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.
10901160
10911161 PowerPoint
10921162
1093− : Any template included with a recent install of Microsoft
1094− PowerPoint (either with `.pptx` or `.potx` extension) should
1095− 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.
10961166
1097− The specific requirement is that the template should contain
1098− 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:
10991169
11001170 1. Title Slide
11011171 2. Title and Content
@@ -1107,10 +1177,10 @@ Options affecting specific writers {.options}
11071177 `Home` menu to check.)
11081178
11091179 You can also modify the default `reference.pptx`: first run
1110− `pandoc --print-default-data-file reference.pptx >
1111− custom-reference.pptx`, and then modify
1112− `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1113− 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).
11141184
11151185`--epub-cover-image=`*FILE*
11161186
@@ -1178,12 +1248,12 @@ Options affecting specific writers {.options}
11781248
11791249`--epub-chapter-level=`*NUMBER*
11801250
1181−: Specify the header level at which to split the EPUB into separate
1182− "chapter" files. The default is to split into chapters at level 1
1183− 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
11841254 EPUB, not the way chapters and sections are displayed to users. Some
11851255 readers may be slow if the chapter files are too large, so for large
1186− 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
11871257 level of 2 or 3.
11881258
11891259`--epub-subdirectory=`*DIRNAME*
@@ -1192,71 +1262,118 @@ Options affecting specific writers {.options}
11921262 the EPUB-specific contents. The default is `EPUB`. To put
11931263 the EPUB contents in the top level, use an empty string.
11941264
1195−`--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*
11961275
11971276: Use the specified engine when producing PDF output.
1198− The default is `pdflatex`. If the engine is not in your PATH,
1199− 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`
12001291
12011292`--pdf-engine-opt=`*STRING*
12021293
12031294: Use the given string as a command-line argument to the `pdf-engine`.
1204− If used multiple times, the arguments are provided with spaces between
1205− 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.
12061298
1207−[Dublin Core elements]: http://dublincore.org/documents/dces/
1208−[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
12091301[Encoding issue with the listings package]:
12101302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
12111303
1212−Citation rendering {.options}
1213−------------------
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].
12141324
12151325`--bibliography=`*FILE*
12161326
12171327: Set the `bibliography` field in the document's metadata to *FILE*,
1218− overriding any value set in the metadata, and process citations
1219− using `pandoc-citeproc`. (This is equivalent to
1220− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1221− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1222− used, making this equivalent to `--metadata bibliography=FILE`.
1223− If you supply this argument multiple times, each *FILE* will be added
1224− 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`).
12251334
12261335`--csl=`*FILE*
12271336
12281337: Set the `csl` field in the document's metadata to *FILE*,
12291338 overriding any value set in the metadata. (This is equivalent to
1230− `--metadata csl=FILE`.)
1231− 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.
12321344
12331345`--citation-abbreviations=`*FILE*
12341346
12351347: Set the `citation-abbreviations` field in the document's metadata to
12361348 *FILE*, overriding any value set in the metadata. (This is equivalent to
12371349 `--metadata citation-abbreviations=FILE`.)
1238− 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.
12391354
12401355`--natbib`
12411356
1242−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1243− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1244− 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`].
12451361
12461362`--biblatex`
12471363
1248−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1249− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1250− 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`].
12511368
1252−Math rendering in HTML {.options}
1253−----------------------
1369+## Math rendering in HTML {.options}
12541370
1255−The default is to render TeX math as far as possible using Unicode characters.
1256−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1257−differently from the surrounding text if needed. However, this gives acceptable
1258−results only for basic math, usually you will want to use `--mathjax` or another
1259−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.
12601377
12611378`--mathjax`[`=`*URL*]
12621379
@@ -1270,10 +1387,11 @@ of the following options.
12701387
12711388`--mathml`
12721389
1273−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1274− `html4` and `html5`). This is the default in `odt` output. Note that
1275− currently only Firefox and Safari (and select e-book readers) natively
1276− 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.
12771395
12781396`--webtex`[`=`*URL*]
12791397
@@ -1297,21 +1415,19 @@ of the following options.
12971415`--gladtex`
12981416
12991417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1300− can then be processed by [GladTeX] to produce images of the typeset
1301− formulas and an HTML file with links to these images.
1302− 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.
13031420
13041421 pandoc -s --gladtex input.md -o myfile.htex
1305− gladtex -d myfile-images myfile.htex
1306− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
13071424
1308−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
13091426[MathJax]: https://www.mathjax.org
13101427[KaTeX]: https://github.com/Khan/KaTeX
1311−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
13121429
1313−Options for wrapper scripts {.options}
1314−---------------------------
1430+## Options for wrapper scripts {.options}
13151431
13161432`--dump-args`
13171433
@@ -1335,8 +1451,277 @@ Options for wrapper scripts {.options}
13351451
13361452 pandoc -o foo.html -s
13371453
1338−Templates
1339−=========
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
13401725
13411726When the `-s/--standalone` option is used, pandoc uses a template to
13421727add header and footer material that is needed for a self-standing
@@ -1362,18 +1747,398 @@ directory (see `--data-dir`, above). *Exceptions:*
13621747Templates contain *variables*, which allow for the inclusion of
13631748arbitrary information at any point in the file. They may be set at the
13641749command line using the `-V/--variable` option. If a variable is not set,
1365−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
13661751using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1367−or with the `-M/--metadata` option.
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.
1755+
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.
1761+
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
1763+
1764+## Template syntax
1765+
1766+### Comments
1767+
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
1770+
1771+### Delimiters
1772+
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.
1781+
1782+To include a literal `$` in the document, use `$$`.
1783+
1784+### Interpolated variables
1785+
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:
1791+
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+```
1802+
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.
1807+
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.
1815+
1816+### Conditionals
1817+
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:
1824+
1825+```
1826+$if(foo)$bar$endif$
1827+
1828+$if(foo)$
1829+ $foo$
1830+$endif$
1831+
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
1837+
1838+${if(foo)}bar${endif}
1839+
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
1843+
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
1850+
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
1853+
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
1863+
1864+### For loops
1865+
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
1869+
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.
1877+
1878+Examples:
1879+
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
1882+
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
1886+
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
1890+
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
1895+
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.
1899+
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
1903+
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
1906+
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
1912+
1913+### Partials
1914+
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
1918+
1919+```
1920+${ styles() }
1921+```
1922+
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:
1928+
1929+```
1930+${ styles.html() }
1931+```
1932+
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.)
1937+
1938+Partials may optionally be applied to variables using
1939+a colon:
1940+
1941+```
1942+${ date:fancy() }
1943+
1944+${ articles:bibentry() }
1945+```
1946+
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
1950+
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
1956+
1957+Note that the anaphoric keyword `it` must be used when
1958+iterating over partials. In the above examples,
1959+the `bibentry` partial should contain `it.title`
1960+(and so on) instead of `articles.title`.
1961+
1962+Final newlines are omitted from included partials.
1963+
1964+Partials may include other partials.
1965+
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
1969+
1970+```
1971+${months[, ]}$
1972+
1973+${articles:bibentry()[; ]$
1974+```
1975+
1976+The separator in this case is literal and (unlike with `sep`
1977+in an explicit `for` loop) cannot contain interpolated
1978+variables or other template directives.
1979+
1980+### Nesting
1981+
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
1984+
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
1988+
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
1991+
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
1996+
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
1999+
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
2004+
2005+will produce
2006+
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
2012+
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
2017+
2018+### Breakable spaces
2019+
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
2024+
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
2029+
2030+### Pipes
2031+
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
2035+
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
2040+
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
2044+
2045+$employee:name()/uppercase$
2046+```
13682047
1369−Metadata variables
1370−------------------
2048+Pipes may be chained:
2049+
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
2055+
2056+Some pipes take parameters:
2057+
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
2065+
2066+Currently the following pipes are predefined:
2067+
2068+- `pairs`: Converts a map or array to an array of maps,
2069+ each with `key` and `value` fields. If the original
2070+ value was an array, the `key` will be the array index,
2071+ starting with 1.
2072+
2073+- `uppercase`: Converts text to uppercase.
2074+
2075+- `lowercase`: Converts text to lowercase.
2076+
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
2080+
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2083+
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2087+
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
2091+
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
2095+
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
2099+
2100+- `chomp`: Removes trailing newlines (and breakable space).
2101+
2102+- `nowrap`: Disables line wrapping on breakable spaces.
2103+
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
2109+
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
2114+
2115+- `left n "leftborder" "rightborder"`: Renders a textual value
2116+ in a block of width `n`, aligned to the left, with an optional
2117+ left and right border. Has no effect on other values. This
2118+ can be used to align material in tables. Widths are positive
2119+ integers indicating the number of characters. Borders
2120+ are strings inside double quotes; literal `"` and `\` characters
2121+ must be backslash-escaped.
2122+
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
2126+
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
2130+
2131+
2132+## Variables
2133+
2134+### Metadata variables
13712135
13722136`title`, `author`, `date`
13732137: allow identification of basic aspects of the document. Included
13742138 in PDF metadata through LaTeX and ConTeXt. These can be set
13752139 through a [pandoc title block][Extension: `pandoc_title_block`],
1376− which allows for multiple authors, or through a YAML metadata block:
2140+ which allows for multiple authors, or through a
2141+ [YAML metadata block][Extension: `yaml_metadata_block`]:
13772142
13782143 ---
13792144 author:
@@ -1381,6 +2146,13 @@ Metadata variables
13812146 - Peter Abelard
13822147 ...
13832148
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+
13842156`subtitle`
13852157: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
13862158 documents
@@ -1406,7 +2178,7 @@ Metadata variables
14062178Additionally,
14072179any root-level string metadata, not included in ODT, docx
14082180or pptx metadata is added as a *custom property*.
1409−The following YAML metadata block for instance:
2181+The following [YAML] metadata block for instance:
14102182
14112183 ---
14122184 title: 'This is the title'
@@ -1425,8 +2197,7 @@ will include `title`, `author` and `description` as standard document
14252197properties and `subtitle` as a custom property when converting to docx,
14262198ODT or pptx.
14272199
1428−Language variables
1429−------------------
2200+### Language variables
14302201
14312202`lang`
14322203: identifies the main language of the document using IETF language
@@ -1434,10 +2205,10 @@ Language variables
14342205 The [Language subtag lookup] tool can look up or verify these tags.
14352206 This affects most formats, and controls hyphenation in PDF output
14362207 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
1437−
2208+
14382209 Use native pandoc [Divs and Spans] with the `lang` attribute to
14392210 switch the language:
1440−
2211+
14412212 ---
14422213 lang: en-GB
14432214 ...
@@ -1449,33 +2220,106 @@ Language variables
14492220 :::
14502221
14512222 More text in English. ['Zitat auf Deutsch.']{lang=de}
1452−
2223+
14532224`dir`
14542225: the base script direction, either `rtl` (right-to-left)
14552226 or `ltr` (left-to-right).
14562227
1457− For bidirectional documents, native pandoc `span`s and `div`s
1458− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1459− override the base direction in some output formats.
1460− This may not always be necessary if the final renderer
1461− (e.g. the browser, when generating HTML) supports the
1462− [Unicode Bidirectional Algorithm].
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].
14632234
1464− When using LaTeX for bidirectional documents, only the `xelatex` engine
1465− is fully supported (use `--pdf-engine=xelatex`).
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
14662238
14672239[BCP 47]: https://tools.ietf.org/html/bcp47
1468−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2240+[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
14692241[Language subtag lookup]: https://r12a.github.io/app-subtags/
14702242
1471−Variables for HTML slides
1472−-------------------------
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
14732314
14742315These affect HTML output when [producing slide shows with pandoc].
1475−All [reveal.js configuration options] are available as variables.
2316+
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
14762319
14772320`revealjs-url`
1478−: base URL for reveal.js documents (defaults to `reveal.js`)
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
14792323
14802324`s5-url`
14812325: base URL for S5 documents (defaults to `s5/default`)
@@ -1487,10 +2331,16 @@ All [reveal.js configuration options] are available as variables.
14872331`slideous-url`
14882332: base URL for Slideous documents (defaults to `slideous`)
14892333
1490−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
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/
14912342
1492−Variables for Beamer slides
1493−---------------------------
2343+### Variables for Beamer slides
14942344
14952345These variables change the appearance of PDF slides using [`beamer`].
14962346
@@ -1519,7 +2369,7 @@ These variables change the appearance of PDF slides using [`beamer`].
15192369: enables "title pages" for new sections (default is true)
15202370
15212371`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1522−: beamer themes:
2372+: beamer themes
15232373
15242374`themeoptions`
15252375: options for LaTeX beamer themes (a list).
@@ -1527,28 +2377,83 @@ These variables change the appearance of PDF slides using [`beamer`].
15272377`titlegraphic`
15282378: image for title slide
15292379
1530−Variables for LaTeX
1531−-------------------
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
15322389
15332390Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15342391
1535−### Layout
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+ ...
15362415
15372416`classoption`
1538−: option for document class, e.g. `oneside`; repeat for multiple options
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
2418+
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
15392424
15402425`documentclass`
1541−: document class: usually one of the standard classes, [`article`], [`report`],
1542− and [`book`]; the [KOMA-Script] equivalents, `scrartcl`, `scrreprt`,
1543− and `scrbook`, which default to smaller margins; or [`memoir`]
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`]
15442430
15452431`geometry`
15462432: option for [`geometry`] package, e.g. `margin=1in`;
1547− repeat for multiple options
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+ ...
15482452
15492453`indent`
1550−: uses document class settings for indentation (the default LaTeX template
1551− otherwise removes indentation and adds space between paragraphs)
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)
15522457
15532458`linestretch`
15542459: adjusts line spacing using the [`setspace`]
@@ -1570,15 +2475,11 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15702475: numbering depth for sections (with `--number-sections` option
15712476 or `numbersections` variable)
15722477
1573−`subparagraph`
1574−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1575− as sections, changing the appearance of nested headings in some classes
1576−
1577−### Fonts
2478+#### Fonts
15782479
15792480`fontenc`
1580−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1581− default is `T1` (see [LaTeX font encodings guide])
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
15822483
15832484`fontfamily`
15842485: font package for use with `pdflatex`:
@@ -1589,7 +2490,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15892490: options for package used as `fontfamily`; repeat for multiple options.
15902491 For example, to use the Libertine font with proportional lowercase
15912492 (old-style) figures through the [`libertinus`] package:
1592−
2493+
15932494 ---
15942495 fontfamily: libertinus
15952496 fontfamilyoptions:
@@ -1598,9 +2499,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15982499 ...
15992500
16002501`fontsize`
1601−: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1602− To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1603− such as `scrartcl` or `scrbook`.
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`.
16042505
16052506`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
16062507: font families for use with `xelatex` or
@@ -1609,9 +2510,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16092510
16102511`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
16112512: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1612− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1613− available through [`fontspec`]; repeat for multiple options. For example,
1614− to use the [TeX Gyre] version of Palatino with lowercase figures:
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:
16152517
16162518 ---
16172519 mainfont: TeX Gyre Pagella
@@ -1623,7 +2525,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16232525`microtypeoptions`
16242526: options to pass to the microtype package
16252527
1626−### Links
2528+#### Links
16272529
16282530`colorlinks`
16292531: add color to link text; automatically enabled if any of
@@ -1638,7 +2540,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16382540`links-as-notes`
16392541: causes links to be printed as footnotes
16402542
1641−### Front matter
2543+#### Front matter
16422544
16432545`lof`, `lot`
16442546: include list of figures, list of tables
@@ -1647,12 +2549,13 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16472549: contents of acknowledgments footnote after document title
16482550
16492551`toc`
1650−: include table of contents (can also be set using `--toc/--table-of-contents`)
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
16512554
16522555`toc-depth`
16532556: level of section to include in table of contents
16542557
1655−### BibLaTeX Bibliographies
2558+#### BibLaTeX Bibliographies
16562559
16572560These variables function when using BibLaTeX for [citation rendering].
16582561
@@ -1672,7 +2575,7 @@ These variables function when using BibLaTeX for [citation rendering].
16722575: list of options for natbib
16732576
16742577[KOMA-Script]: https://ctan.org/pkg/koma-script
1675−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
16762579[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
16772580[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
16782581[`article`]: https://ctan.org/pkg/article
@@ -1681,8 +2584,7 @@ These variables function when using BibLaTeX for [citation rendering].
16812584[`memoir`]: https://ctan.org/pkg/memoir
16822585[`report`]: https://ctan.org/pkg/report
16832586
1684−Variables for ConTeXt
1685−---------------------
2587+### Variables for ConTeXt
16862588
16872589Pandoc uses these variables when [creating a PDF] with ConTeXt.
16882590
@@ -1690,12 +2592,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
16902592: font size for body text (e.g. `10pt`, `12pt`)
16912593
16922594`headertext`, `footertext`
1693−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1694− repeat up to four times for different placement
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
16952597
16962598`indenting`
1697−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1698− repeat for multiple options
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
16992601
17002602`interlinespace`
17012603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -1706,16 +2608,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17062608 repeat for multiple options
17072609
17082610`linkcolor`, `contrastcolor`
1709−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
17102613
17112614`linkstyle`
1712−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
17132617
17142618`lof`, `lot`
17152619: include list of figures, list of tables
17162620
17172621`mainfont`, `sansfont`, `monofont`, `mathfont`
1718−: font families: take the name of any system font (see [ConTeXt Font Switching])
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
17192624
17202625`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
17212626: sets margins, if `layout` is not used (otherwise `layout`
@@ -1730,18 +2635,41 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17302635 repeat for multiple options
17312636
17322637`pdfa`
1733−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1734− To successfully generate PDF/A the required ICC color profiles have to
1735− be available and the content and all included files (such as images)
1736− have to be standard conforming. The ICC profiles can be obtained
1737− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1738− details.
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.
17392662
17402663`toc`
1741−: include table of contents (can also be set using `--toc/--table-of-contents`)
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
17422666
17432667`whitespace`
1744−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
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
17452673
17462674[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
17472675[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
@@ -1755,8 +2683,7 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17552683[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
17562684[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
17572685
1758−Variables for `wkhtmltopdf`
1759−---------------------------
2686+### Variables for `wkhtmltopdf`
17602687
17612688Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
17622689The `--css` option also affects the output.
@@ -1770,8 +2697,7 @@ The `--css` option also affects the output.
17702697`papersize`
17712698: sets the PDF paper size
17722699
1773−Variables for man pages
1774−-----------------------
2700+### Variables for man pages
17752701
17762702`adjusting`
17772703: adjusts text to left (`l`), right (`r`), center (`c`),
@@ -1789,8 +2715,7 @@ Variables for man pages
17892715`section`
17902716: section number in man pages
17912717
1792−Variables for ms
1793−----------------
2718+### Variables for ms
17942719
17952720`fontfamily`
17962721: font family (e.g. `T` or `P`)
@@ -1804,8 +2729,7 @@ Variables for ms
18042729`pointsize`
18052730: point size (e.g. `10p`)
18062731
1807−Structural variables
1808−--------------------
2732+### Variables set automatically
18092733
18102734Pandoc sets these variables automatically in response to [options] or
18112735document contents; users can also modify them. These vary depending
@@ -1845,9 +2769,9 @@ on the output format, and include the following:
18452769
18462770`sourcefile`, `outputfile`
18472771: source and destination filenames, as given on the command line.
1848− `sourcefile` can also be a list if input comes from multiple files, or empty
1849− if input is from stdin. You can use the following snippet in your template
1850− to distinguish them:
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:
18512775
18522776 $if(sourcefile)$
18532777 $for(sourcefile)$
@@ -1859,94 +2783,30 @@ on the output format, and include the following:
18592783
18602784 Similarly, `outputfile` can be `-` if output goes to the terminal.
18612785
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787+
2788+`curdir`
2789+: working directory from which pandoc is run.
2790+
18622791`toc`
18632792: non-null value if `--toc/--table-of-contents` was specified
18642793
18652794`toc-title`
18662795: title of table of contents (works only with EPUB,
1867− opendocument, odt, docx, pptx, beamer, LaTeX)
1868−
1869−Using variables in templates
1870−----------------------------
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
18712797
1872−Variable names are sequences of alphanumerics, `-`, and `_`,
1873−starting with a letter. A variable name surrounded by `$` signs
1874−will be replaced by its value. For example, the string `$title$` in
1875−
1876− <title>$title$</title>
2798+[pandoc-templates]: https://github.com/jgm/pandoc-templates
18772799
1878−will be replaced by the document title.
2800+# Extensions
18792801
1880−To write a literal `$` in a template, use `$$`.
2802+The behavior of some of the readers and writers can be adjusted by
2803+enabling or disabling various extensions.
18812804
1882−Templates may contain conditionals. The syntax is as follows:
1883−
1884− $if(variable)$
1885− X
1886− $else$
1887− Y
1888− $endif$
1889−
1890−This will include `X` in the template if `variable` has a truthy
1891−value; otherwise it will include `Y`. Here a truthy value is any
1892−of the following:
1893−
1894−- a string that is not entirely white space,
1895−- a non-empty array where the first value is truthy,
1896−- any number (including zero),
1897−- any object,
1898−- the boolean `true` (to specify the boolean `true`
1899− value using YAML metadata or the `--metadata` flag,
1900− use `true`, `True`, or `TRUE`; with the `--variable`
1901− flag, simply omit a value for the variable, e.g.
1902− `--variable draft`).
1903−
1904−`X` and `Y` are placeholders for any valid template text,
1905−and may include interpolated variables or other conditionals.
1906−The `$else$` section may be omitted.
1907−
1908−When variables can have multiple values (for example, `author` in
1909−a multi-author document), you can use the `$for$` keyword:
1910−
1911− $for(author)$
1912− <meta name="author" content="$author$" />
1913− $endfor$
1914−
1915−You can optionally specify a separator to be used between
1916−consecutive items:
1917−
1918− $for(author)$$author$$sep$, $endfor$
1919−
1920−Note that the separator needs to be specified immediately before the `$endfor`
1921−keyword.
1922−
1923−A dot can be used to select a field of a variable that takes
1924−an object as its value. So, for example:
1925−
1926− $author.name$ ($author.affiliation$)
1927−
1928−If you use custom templates, you may need to revise them as pandoc
1929−changes. We recommend tracking the changes in the default templates,
1930−and modifying your custom templates accordingly. An easy way to do this
1931−is to fork the [pandoc-templates] repository and merge in changes after each
1932−pandoc release.
1933−
1934−Templates may contain comments: anything on a line after `$--`
1935−will be treated as a comment and ignored.
1936−
1937−[pandoc-templates]: https://github.com/jgm/pandoc-templates
1938−
1939−Extensions
1940−==========
1941−
1942−The behavior of some of the readers and writers can be adjusted by
1943−enabling or disabling various extensions.
1944−
1945−An extension can be enabled by adding `+EXTENSION`
1946−to the format name and disabled by adding `-EXTENSION`. For example,
1947−`--from markdown_strict+footnotes` is strict Markdown with footnotes
1948−enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
1949−Markdown without footnotes or pipe tables.
2805+An extension can be enabled by adding `+EXTENSION`
2806+to the format name and disabled by adding `-EXTENSION`. For example,
2807+`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809+Markdown without footnotes or pipe tables.
19502810
19512811The markdown reader and writer make by far the most use of extensions.
19522812Extensions only used by them are therefore covered in the
@@ -1958,8 +2818,7 @@ Note that markdown extensions added to the `ipynb` format
19582818affect Markdown cells in Jupyter notebooks (as do command-line
19592819options like `--atx-headers`).
19602820
1961−Typography
1962−----------
2821+## Typography
19632822
19642823#### Extension: `smart` ####
19652824
@@ -1991,13 +2850,12 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
19912850to use the ligatures when possible; if `smart` is disabled
19922851pandoc will use unicode quotation mark and dash characters.
19932852
1994−Headers and sections
1995−--------------------
2853+## Headings and sections
19962854
19972855#### Extension: `auto_identifiers` ####
19982856
1999−A header without an explicitly specified identifier will be
2000−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.
20012859
20022860This extension can be enabled/disabled for the following formats:
20032861
@@ -2011,7 +2869,7 @@ enabled by default in
20112869: `markdown`, `muse`
20122870
20132871The default algorithm used to derive the identifier from the
2014−header text is:
2872+heading text is:
20152873
20162874 - Remove all formatting, links, etc.
20172875 - Remove all footnotes.
@@ -2025,9 +2883,9 @@ header text is:
20252883
20262884Thus, for example,
20272885
2028− Header Identifier
2886+ Heading Identifier
20292887 ------------------------------- ----------------------------
2030− `Header identifiers in HTML` `header-identifiers-in-html`
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
20312889 `Maître d'hôtel` `maître-dhôtel`
20322890 `*Dogs*?--in *my* house?` `dogs--in-my-house`
20332891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
@@ -2035,7 +2893,7 @@ Thus, for example,
20352893 `33` `section`
20362894
20372895These rules should, in most cases, allow one to determine the identifier
2038−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
20392897same text; in this case, the first will get an identifier as described
20402898above; the second will get the same identifier with `-1` appended; the
20412899third with `-2`; and so on.
@@ -2049,7 +2907,7 @@ also make it easy to provide links from one section of a document to
20492907another. A link to this section, for example, might look like this:
20502908
20512909 See the section on
2052− [header identifiers](#header-identifiers-in-html-latex-and-context).
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
20532911
20542912Note, however, that this method of providing links to sections works
20552913only in HTML, LaTeX, and ConTeXt formats.
@@ -2057,7 +2915,7 @@ only in HTML, LaTeX, and ConTeXt formats.
20572915If the `--section-divs` option is specified, then each section will
20582916be wrapped in a `section` (or a `div`, if `html4` was specified),
20592917and the identifier will be attached to the enclosing `<section>`
2060−(or `<div>`) tag rather than the header itself. This allows entire
2918+(or `<div>`) tag rather than the heading itself. This allows entire
20612919sections to be manipulated using JavaScript or treated differently in
20622920CSS.
20632921
@@ -2073,9 +2931,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
20732931GitHub's method. Spaces are converted to dashes (`-`),
20742932uppercase characters to lowercase characters, and punctuation
20752933characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
20762935
2077−Math Input
2078−----------
2936+## Math Input
20792937
20802938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
20812939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2085,59 +2943,47 @@ are described in the section about Pandoc's Markdown.
20852943However, they can also be used with HTML input. This is handy for
20862944reading web pages formatted using MathJax, for example.
20872945
2088−Raw HTML/TeX
2089−------------
2090−
2091−The following extensions (especially how they affect Markdown
2092−input/output) are also described in more detail in their respective
2093−sections of [Pandoc's Markdown].
2094−
2095−#### Extension: `raw_html` {#raw_html}
2096−
2097−When converting from HTML, parse elements to raw HTML which are not
2098−representable in pandoc's AST.
2099−By default, this is disabled for HTML input.
2946+## Raw HTML/TeX
21002947
2101−#### Extension: `raw_tex` {#raw_tex}
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
21022950
2103−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
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.
21042954
2105−This extension can be enabled/disabled for the following formats
2106−(in addition to `markdown`):
2107−
2108−input formats
2109−: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2110− `\eqref` only), `ipynb`
2111−
2112−output formats
2113−: `textile`, `commonmark`
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`):
21142958
2115−Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2116−only raw TeX in markdown cells, but data with mime type
2117−`text/html` in output cells. Since the `ipynb` reader attempts
2118−to preserve the richest possible outputs when several options
2119−are given, you will get best results if you disable `raw_html`
2120−and `raw_tex` when converting to formats like `docx` which don't
2121−allow raw `html` or `tex`.
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
21222962
2123−#### Extension: `native_divs` {#native_divs}
2963+ output formats
2964+ : `textile`, `commonmark`
21242965
2125−This extension is enabled by default for HTML input. This means that
2126−`div`s are parsed to pandoc native elements. (Alternatively, you
2127−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
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`.
21282973
2129−When converting HTML to Markdown, for example, you may want to drop all
2130−`div`s and `span`s:
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`.
21312978
2132− pandoc -f html-native_divs-native_spans -t markdown
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`.
21332985
2134−#### Extension: `native_spans` {#native_spans}
2135−
2136−Analogous to `native_divs` above.
2137−
2138−
2139−Literate Haskell support
2140−------------------------
2986+## Literate Haskell support
21412987
21422988#### Extension: `literate_haskell` ####
21432989
@@ -2158,12 +3004,12 @@ This means that
21583004 - In Markdown input, "bird track" sections will be parsed as Haskell
21593005 code rather than block quotations. Text between `\begin{code}`
21603006 and `\end{code}` will also be treated as Haskell code. For
2161− ATX-style headers the character '=' will be used instead of '#'.
3007+ ATX-style headings the character '=' will be used instead of '#'.
21623008
21633009 - In Markdown output, code blocks with classes `haskell` and `literate`
21643010 will be rendered using bird tracks, and block quotations will be
21653011 indented one space, so they will not be treated as Haskell code.
2166− In addition, headers will be rendered setext-style (with underlines)
3012+ In addition, headings will be rendered setext-style (with underlines)
21673013 rather than ATX-style (with '#' characters). (This is because ghc
21683014 treats '#' characters in column 1 as introducing line numbers.)
21693015
@@ -2198,8 +3044,7 @@ Note that GHC expects the bird tracks in the first column, so indented
21983044literate code blocks (e.g. inside an itemized environment) will not be
21993045picked up by the Haskell compiler.
22003046
2201−Other extensions
2202−----------------
3047+## Other extensions
22033048
22043049#### Extension: `empty_paragraphs` ####
22053050
@@ -2214,12 +3059,60 @@ input formats
22143059output formats
22153060: `docx`, `odt`, `opendocument`, `html`
22163061
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+
22173109#### Extension: `styles` #### {#ext-styles}
22183110
2219−Read all docx styles as divs (for paragraph styles) and spans (for
2220−character styles) regardless of whether pandoc understands the meaning
2221−of these styles. This can be used with [docx custom
2222−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.
22233116
22243117input formats
22253118: `docx`
@@ -2229,22 +3122,36 @@ input formats
22293122In the `muse` input format, this enables Text::Amuse
22303123extensions to Emacs Muse markup.
22313124
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+
22323133#### Extension: `citations` {#org-citations}
22333134
2234−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2235−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.
22363144
22373145#### Extension: `ntb` ####
22383146
22393147In the `context` output format this enables the use of [Natural Tables
2240−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2241−[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).
22423150Natural tables allow more fine-grained global customization but come
22433151at a performance penalty compared to extreme tables.
22443152
22453153
2246−Pandoc's Markdown
2247−=================
3154+# Pandoc's Markdown
22483155
22493156Pandoc understands an extended and slightly revised version of
22503157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2254,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
22543161behavior more granularly. They are described in the following. See also
22553162[Extensions] above, for extensions that work also on other formats.
22563163
2257−Philosophy
2258−----------
3164+## Philosophy
22593165
22603166Markdown is designed to be easy to write, and, even more importantly,
22613167easy to read:
@@ -2263,7 +3169,7 @@ easy to read:
22633169> A Markdown-formatted document should be publishable as-is, as plain
22643170> text, without looking like it's been marked up with tags or formatting
22653171> instructions.
2266−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
22673173
22683174This principle has guided pandoc's decisions in finding syntax for
22693175tables, footnotes, and other extensions.
@@ -2276,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
22763182important document elements like definition lists, tables, mathematics, and
22773183footnotes.
22783184
2279−Paragraphs
2280−----------
3185+## Paragraphs
22813186
22823187A paragraph is one or more lines of text followed by one or more blank lines.
22833188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2290,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
22903195to create a hard line break, since trailing spaces in the cells
22913196are ignored.
22923197
2293−Headers
2294−-------
3198+## Headings
22953199
2296−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
22973201
2298−### Setext-style headers ###
3202+### Setext-style headings ###
22993203
2300−A setext-style header is a line of text "underlined" with a row of `=` signs
2301−(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):
23023206
2303− A level-one header
2304− ==================
3207+ A level-one heading
3208+ ===================
23053209
2306− A level-two header
2307− ------------------
3210+ A level-two heading
3211+ -------------------
23083212
2309−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
23103214[Inline formatting], below).
23113215
23123216
2313−### ATX-style headers ###
3217+### ATX-style headings ###
23143218
2315−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
23163220text, optionally followed by any number of `#` signs. The number of
2317−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
23183222
2319− ## A level-two header
3223+ ## A level-two heading
23203224
2321− ### A level-three header ###
3225+ ### A level-three heading ###
23223226
2323−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
23243228
2325− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
23263230
23273231#### Extension: `blank_before_header` ####
23283232
2329−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.
23303234Pandoc does require this (except, of course, at the beginning of the
23313235document). The reason for the requirement is that it is all too easy for a
23323236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -2338,29 +3242,30 @@ wrapping). Consider, for example:
23383242#### Extension: `space_in_atx_header` ####
23393243
23403244Many Markdown implementations do not require a space between the
2341−opening `#`s of an ATX header and the header text, so that
2342−`#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,
23433247pandoc does require the space.
23443248
2345−### Header identifiers ###
3249+### Heading identifiers ###
23463250
2347−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
23483253
23493254#### Extension: `header_attributes` ####
23503255
2351−Headers can be assigned attributes using this syntax at the end
2352−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:
23533258
23543259 {#identifier .class .class key=value key=value}
23553260
2356−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
23573262`foo`:
23583263
2359− # My header {#foo}
3264+ # My heading {#foo}
23603265
2361− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
23623267
2363− My other header {#foo}
3268+ My other heading {#foo}
23643269 ---------------
23653270
23663271(This syntax is compatible with [PHP Markdown Extra].)
@@ -2369,51 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
23693274attributes, writers generally don't use all of this information. Identifiers,
23703275classes, and key/value attributes are used in HTML and HTML-based formats such
23713276as EPUB and slidy. Identifiers are used for labels and link anchors in the
2372−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
23733278
2374−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
23753280`--number-sections` is specified. A single hyphen (`-`) in an attribute
23763281context is equivalent to `.unnumbered`, and preferable in non-English
23773282documents. So,
23783283
2379− # My header {-}
3284+ # My heading {-}
23803285
23813286is just the same as
23823287
2383− # 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.)
23843294
23853295#### Extension: `implicit_header_references` ####
23863296
2387−Pandoc behaves as if reference links have been defined for each header.
2388−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
23893299
2390− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
23913301
23923302you can simply write
23933303
2394− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
23953305
23963306or
23973307
2398− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
23993309
24003310or
24013311
2402− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
24033313 HTML]
24043314
24053315instead of giving the identifier explicitly:
24063316
2407− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
24083318
2409−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
24103320reference will link to the first one only, and you will need to use explicit
24113321links to link to the others, as described above.
24123322
24133323Like regular reference links, these references are case-insensitive.
24143324
24153325Explicit link reference definitions always take priority over
2416−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
24173327link will point to `bar`, not to `#foo`:
24183328
24193329 # Foo
@@ -2422,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
24223332
24233333 See [foo]
24243334
2425−Block quotations
2426−----------------
3335+## Block quotations
24273336
24283337Markdown uses email conventions for quoting blocks of text.
24293338A block quotation is one or more paragraphs or other block elements
2430−(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
24313340and an optional space. (The `>` need not start at the left margin, but
24323341it should not be indented more than three spaces.)
24333342
@@ -2462,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
24623371
24633372#### Extension: `blank_before_blockquote` ####
24643373
2465−Standard Markdown syntax does not require a blank line before a block
2466−quote. Pandoc does require this (except, of course, at the beginning of the
2467−document). The reason for the requirement is that it is all too easy for a
2468−`>` to end up at the beginning of a line by accident (perhaps through line
2469−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
24703380not produce a nested block quote in pandoc:
24713381
24723382 > This is a block quote.
24733383 >> Nested.
24743384
24753385
2476−Verbatim (code) blocks
2477−----------------------
3386+## Verbatim (code) blocks
24783387
24793388### Indented code blocks ###
24803389
@@ -2536,14 +3445,16 @@ this syntax:
25363445 qsort (filter (>= x) xs)
25373446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25383447
2539−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2540−`startFrom` is an attribute with value `100`. Some output formats can use this
2541−information to do syntax highlighting. Currently, the only output formats
2542−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2543−highlighting is supported for your output format and language, then the code
2544−block above will appear highlighted, with numbered lines. (To see which
2545−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2546−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:
25473458
25483459 <pre id="mycode" class="haskell numberLines" startFrom="100">
25493460 <code>
@@ -2580,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
25803491For more information on highlighting, see [Syntax highlighting],
25813492below.
25823493
2583−Line blocks
2584−-----------
3494+## Line blocks
25853495
25863496#### Extension: `line_blocks` ####
25873497
@@ -2607,10 +3517,12 @@ line must begin with a space.
26073517 | 200 Main St.
26083518 | Berkeley, CA 94718
26093519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
26103523This syntax is borrowed from [reStructuredText].
26113524
2612−Lists
2613−-----
3525+## Lists
26143526
26153527### Bullet lists ###
26163528
@@ -2811,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
28113723A definition begins with a colon or tilde, which may be indented one
28123724or two spaces.
28133725
2814−A term may have multiple definitions, and each definition may consist of one or
2815−more block elements (paragraph, code block, list, etc.), each indented four
2816−spaces or one tab stop. The body of the definition (including the first line,
2817−aside from the colon or tilde) should be indented four spaces. However,
2818−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
28193732at the beginning of a paragraph or other block element:
28203733
28213734 Term 1
@@ -2841,9 +3754,10 @@ definition:
28413754Note that space between items in a definition list is required.
28423755(A variant that loosens this requirement, but disallows "lazy"
28433756hard wrapping, can be activated with `compact_definition_lists`: see
2844−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
28453758
2846−[^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/).
28473761
28483762### Numbered example lists ###
28493763
@@ -2879,30 +3793,6 @@ list marker. That is, example lists always behave as if the
28793793labels tend to be long, and indenting content to the
28803794first non-space character after the label would be awkward.
28813795
2882−### Compact and loose lists ###
2883−
2884−Pandoc behaves differently from `Markdown.pl` on some "edge
2885−cases" involving lists. Consider this source:
2886−
2887− + First
2888− + Second:
2889− - Fee
2890− - Fie
2891− - Foe
2892−
2893− + Third
2894−
2895−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2896−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2897−"Second" and "Third" (but not "First"), because of the blank space
2898−around "Third". Pandoc follows a simple rule: if the text is followed by
2899−a blank line, it is treated as a paragraph. Since "Second" is followed
2900−by a list, and not a blank line, it isn't treated as a paragraph. The
2901−fact that the list is followed by a blank line is irrelevant. (Note:
2902−Pandoc works this way even when the `markdown_strict` format is specified. This
2903−behavior is consistent with the official Markdown syntax description,
2904−even though it is different from that of `Markdown.pl`.)
2905−
29063796
29073797### Ending a list ###
29083798
@@ -2941,8 +3831,7 @@ of one big list:
29413831 2. dos
29423832 3. tres
29433833
2944−Horizontal rules
2945−----------------
3834+## Horizontal rules
29463835
29473836A line containing a row of three or more `*`, `-`, or `_` characters
29483837(optionally separated by spaces) produces a horizontal rule:
@@ -2952,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
29523841 ---------------
29533842
29543843
2955−Tables
2956−------
3844+## Tables
29573845
29583846Four kinds of tables may be used. The first three kinds presuppose the use of
29593847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2978,7 +3866,7 @@ Simple tables look like this:
29783866
29793867 Table: Demonstration of simple table syntax.
29803868
2981−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
29823870alignments are determined by the position of the header text relative
29833871to the dashed line below it:[^4]
29843872
@@ -2997,7 +3885,7 @@ to the dashed line below it:[^4]
29973885The table must end with a blank line, or a line of dashes followed by
29983886a blank line.
29993887
3000−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
30013889to end the table. For example:
30023890
30033891 ------- ------ ---------- -------
@@ -3006,13 +3894,13 @@ to end the table. For example:
30063894 1 1 1 1
30073895 ------- ------ ---------- -------
30083896
3009−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
30103898of the first line of the table body. So, in the tables above, the columns
30113899would be right, left, center, and right aligned, respectively.
30123900
30133901#### Extension: `multiline_tables` ####
30143902
3015−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
30163904of text (but cells that span multiple columns or rows of the table are
30173905not supported). Here is an example:
30183906
@@ -3034,7 +3922,7 @@ not supported). Here is an example:
30343922These work like simple tables, but with the following differences:
30353923
30363924 - They must begin with a row of dashes, before the header text
3037− (unless the headers are omitted).
3925+ (unless the header row is omitted).
30383926 - They must end with a row of dashes, then a blank line.
30393927 - The rows must be separated by blank lines.
30403928
@@ -3043,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
30433931the output. So, if you find that one of the columns is too narrow in the
30443932output, try widening it in the Markdown source.
30453933
3046−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:
30473935
30483936 ----------- ------- --------------- -------------------------
30493937 First row 12.0 Example of a row that
@@ -3054,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
30543942 rows.
30553943 ----------- ------- --------------- -------------------------
30563944
3057− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
30583946
30593947It is possible for a multiline table to have just one row, but the row
30603948should be followed by a blank line (and then the row of dashes that ends
@@ -3080,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
30803968omitted for a headerless table. The cells of grid tables may contain
30813969arbitrary block elements (multiple paragraphs, code blocks, lists,
30823970etc.). Cells that span multiple columns or rows are not
3083−supported. Grid tables can be created easily using [Emacs table mode].
3084−
3085−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
30863973
30873974Alignments can be specified as with pipe tables, by putting
30883975colons at the boundaries of the separator line after the
@@ -3110,7 +3997,7 @@ and the same number of rows in each column. For example, the
31103997Docutils [sample grid tables] will not render as expected with
31113998Pandoc.
31123999
3113−[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
31144001
31154002
31164003#### Extension: `pipe_tables` ####
@@ -3143,7 +4030,7 @@ legal (though ugly) pipe table:
31434030
31444031The cells of pipe tables cannot contain block elements like paragraphs
31454032and lists, and cannot span multiple lines. If a pipe table contains a
3146−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
31474034`--columns`), then the table will take up the full text width and
31484035the cell contents will wrap, with the relative cell widths determined
31494036by the number of dashes in the line separating the table header from
@@ -3167,8 +4054,7 @@ you'll need to add colons as above.
31674054
31684055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
31694056
3170−Metadata blocks
3171−---------------
4057+## Metadata blocks
31724058
31734059#### Extension: `pandoc_title_block` ####
31744060
@@ -3184,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
31844070or all three elements. If you want to include an author but no
31854071title, or a title and a date but no author, you need a blank line:
31864072
3187− %
3188− % Author
4073+```
4074+%
4075+% Author
4076+```
31894077
3190− % My title
3191− %
3192− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
31934083
31944084The title may occupy multiple lines, but continuation lines must
31954085begin with leading space, thus:
31964086
3197− % My title
3198− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
31994091
32004092If a document has multiple authors, the authors may be put on
32014093separate lines with leading space, or separated by semicolons, or
32024094both. So, all of the following are equivalent:
32034095
3204− % Author One
3205− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
32064100
3207− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
32084104
3209− % Author One;
3210− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
32114109
32124110The date must fit on one line.
32134111
@@ -3248,7 +4146,7 @@ will also have "Version 4.0" in the header.
32484146
32494147#### Extension: `yaml_metadata_block` ####
32504148
3251−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
32524150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
32534151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
32544152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3271,20 +4169,22 @@ given a role by external processors.) Field names must not be
32714169interpretable as YAML numbers or boolean values (so, for
32724170example, `yes`, `True`, and `15` cannot be used as field names).
32734171
3274−A document may contain multiple metadata blocks. The metadata fields will
3275−be combined through a *left-biased union*: if two metadata blocks attempt
3276−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.
32774175
32784176When pandoc is used with `-t markdown` to create a Markdown document,
32794177a YAML metadata block will be produced only if the `-s/--standalone`
32804178option is used. All of the metadata will appear in a single block
32814179at the beginning of the document.
32824180
3283−Note that YAML escaping rules must be followed. Thus, for example,
3284−if a title contains a colon, it must be quoted. The pipe character
3285−(`|`) can be used to begin an indented block that will be interpreted
3286−literally, without need for escaping. This form is necessary
3287−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:
32884188
32894189 ---
32904190 title: 'This is the title: it contains a colon'
@@ -3298,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
32984198 It consists of two paragraphs.
32994199 ...
33004200
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+
33014207Template variables will be set automatically from the metadata. Thus, for
33024208example, in writing HTML, the variable `abstract` will be set to the HTML
33034209equivalent of the Markdown in the `abstract` field:
@@ -3344,8 +4250,25 @@ will be interpreted as markdown. For example:
33444250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
33454251 ```
33464252
3347−Backslash escapes
3348−-----------------
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
33494272
33504273#### Extension: `all_symbols_escapable` ####
33514274
@@ -3371,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
33714294(However, if the `markdown_strict` format is used, the standard Markdown rule
33724295will be used.)
33734296
3374−A backslash-escaped space is parsed as a nonbreaking space. It will
3375−appear in TeX output as `~` and in HTML and XML as `\ ` or
3376−`\ `.
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).
33774303
33784304A backslash-escaped newline (i.e. a backslash occurring at the end of
33794305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3383,8 +4309,7 @@ two trailing spaces on a line.
33834309
33844310Backslash escapes do not work in verbatim contexts.
33854311
3386−Inline formatting
3387−-----------------
4312+## Inline formatting
33884313
33894314### Emphasis ###
33904315
@@ -3432,12 +4357,13 @@ text by `~` characters. Thus, for example,
34324357
34334358 H~2~O is a liquid. 2^10^ is 1024.
34344359
3435−If the superscripted or subscripted text contains spaces, these spaces
3436−must be escaped with backslashes. (This is to prevent accidental
3437−superscripting and subscripting through the ordinary use of `~` and `^`.)
3438−Thus, if you want the letter P with 'a cat' in subscripts, use
3439−`P~a\ cat~`, not `P~a cat~`.
3440−
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~`.
34414367
34424368### Verbatim ###
34434369
@@ -3486,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
34864412This will work in all output formats that support small caps.
34874413
34884414
3489−Math
3490−----
4415+## Math
34914416
34924417#### Extension: `tex_math_dollars` ####
34934418
@@ -3499,6 +4424,10 @@ left, and must not be followed immediately by a digit. Thus,
34994424you need to enclose text in literal `$` characters, backslash-escape
35004425them and they won't be treated as math delimiters.
35014426
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+
35024431TeX math will be printed in all output formats. How it is rendered
35034432depends on the output format:
35044433
@@ -3510,6 +4439,9 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki
35104439 ~ It will appear verbatim surrounded by `$...$` (for inline
35114440 math) or `$$...$$` (for display math).
35124441
4442+XWiki
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4444+
35134445reStructuredText
35144446 ~ It will be rendered using an [interpreted text role `:math:`].
35154447
@@ -3523,7 +4455,7 @@ AsciiDoc
35234455Texinfo
35244456 ~ It will be rendered inside a `@math` command.
35254457
3526−roff man
4458+roff man, Jira markup
35274459 ~ It will be rendered verbatim without `$`'s.
35284460
35294461MediaWiki, DokuWiki
@@ -3557,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
35574489 command-line options selected. Therefore see [Math rendering in HTML]
35584490 above.
35594491
3560−[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
35614493
3562−Raw HTML
3563−--------
4494+## Raw HTML
35644495
35654496#### Extension: `raw_html` ####
35664497
@@ -3598,7 +4529,7 @@ Thus, for example, pandoc will turn
35984529 <table>
35994530 <tr>
36004531 <td>*one*</td>
3601− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
36024533 </tr>
36034534 </table>
36044535
@@ -3607,14 +4538,14 @@ into
36074538 <table>
36084539 <tr>
36094540 <td><em>one</em></td>
3610− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
36114542 </tr>
36124543 </table>
36134544
36144545whereas `Markdown.pl` will preserve it as is.
36154546
3616−There is one exception to this rule: text between `<script>` and
3617−`<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.
36184549
36194550This departure from standard Markdown should make it easier to mix
36204551Markdown with HTML block elements. For example, one can surround
@@ -3706,8 +4637,7 @@ example, to use a raw attribute with a backtick code block,
37064637
37074638The raw attribute cannot be combined with regular attributes.
37084639
3709−LaTeX macros
3710−------------
4640+## LaTeX macros
37114641
37124642#### Extension: `latex_macros` ####
37134643
@@ -3721,18 +4651,20 @@ all output formats, not just LaTeX:
37214651 $\tuple{a, b, c}$
37224652
37234653Note that LaTeX macros will not be applied if they occur
3724−inside inside a raw span or block marked with the
4654+inside a raw span or block marked with the
37254655[`raw_attribute` extension](#extension-raw_attribute).
37264656
37274657When `latex_macros` is disabled, the raw LaTeX and math will
37284658not have macros applied. This is usually a better approach when
37294659you are targeting LaTeX or PDF.
37304660
3731−Whether or not `latex_macros` is enabled, the macro definitions
3732−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.
37334666
3734−Links
3735−-----
4667+## Links
37364668
37374669Markdown allows links to be specified in several ways.
37384670
@@ -3741,7 +4673,7 @@ Markdown allows links to be specified in several ways.
37414673If you enclose a URL or email address in pointy brackets, it
37424674will become a link:
37434675
3744− <http://google.com>
4676+ <https://google.com>
37454677 <sam@green.eggs.ham>
37464678
37474679### Inline links ###
@@ -3751,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
37514683be followed by a link title, in quotes.)
37524684
37534685 This is an [inline link](/url), and here's [one with
3754− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
37554687
37564688There can be no space between the bracketed part and the parenthesized part.
37574689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3780,7 +4712,7 @@ Here are some examples:
37804712
37814713 [my label 1]: /foo/bar.html "My title, optional"
37824714 [my label 2]: /foo
3783− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
37844716 [my label 4]: /bar#special 'A title in single quotes'
37854717
37864718The URL may optionally be surrounded by angle brackets:
@@ -3789,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
37894721
37904722The title may go on the next line:
37914723
3792− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
37934725 "The free software foundation"
37944726
37954727Note that link labels are not case sensitive. So, this will work:
@@ -3827,7 +4759,7 @@ be omitted entirely:
38274759### Internal links ###
38284760
38294761To link to another section of the same document, use the automatically
3830−generated identifier (see [Header identifiers]). For example:
4762+generated identifier (see [Heading identifiers]). For example:
38314763
38324764 See the [Introduction](#introduction).
38334765
@@ -3840,8 +4772,7 @@ or
38404772Internal links are currently supported for HTML formats (including
38414773HTML slide shows and EPUB), LaTeX, and ConTeXt.
38424774
3843−Images
3844−------
4775+## Images
38454776
38464777A link immediately preceded by a `!` will be treated as an image.
38474778The link text will be used as the image's alt text:
@@ -3887,10 +4818,11 @@ Attributes can be set on links and images:
38874818(This syntax is compatible with [PHP Markdown Extra] when only `#id`
38884819and `.class` are used.)
38894820
3890−For HTML and EPUB, all attributes except `width` and `height` (but
3891−including `srcset` and `sizes`) are passed through as is. The other
3892−writers ignore attributes that are not supported by their output
3893−format.
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.
38944826
38954827The `width` and `height` attributes on images are treated specially. When
38964828used without a unit, the unit is assumed to be pixels. However, any of
@@ -3902,10 +4834,12 @@ For example:
39024834{ width=50% }
39034835```
39044836
3905−- Dimensions are converted to inches for output in page-based formats like
3906− LaTeX. Dimensions are converted to pixels for output in HTML-like
3907− formats. Use the `--dpi` option to specify the number of pixels per
3908− inch. The default is 96dpi.
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).
39094843- The `%` unit is generally relative to some available space.
39104844 For example the above example will render to the following.
39114845 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -3914,14 +4848,13 @@ For example:
39144848 as in the default template.)
39154849 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
39164850- Some output formats have a notion of a class
3917− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
39184852 or a unique identifier (LaTeX `\caption`), or both (HTML).
39194853- When no `width` or `height` attributes are specified, the fallback
39204854 is to look at the image resolution and the dpi metadata embedded in
39214855 the image file.
39224856
3923−Divs and Spans
3924−--------------
4857+## Divs and Spans
39254858
39264859Using the `native_divs` and `native_spans` extensions
39274860(see [above][Extension: `native_divs`]), HTML syntax can
@@ -3977,8 +4910,7 @@ followed immediately by attributes:
39774910
39784911 [This is *some text*]{.class key="val"}
39794912
3980−Footnotes
3981−---------
4913+## Footnotes
39824914
39834915#### Extension: `footnotes` ####
39844916
@@ -4024,143 +4956,72 @@ they cannot contain multiple paragraphs). The syntax is as follows:
40244956
40254957Inline and regular footnotes may be mixed freely.
40264958
4027−Citations
4028−---------
4959+## Citation syntax
40294960
40304961#### Extension: `citations` ####
40314962
4032−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4033−citations and a bibliography in a number of styles. Basic usage is
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:
40344966
4035− pandoc --filter pandoc-citeproc myinput.txt
4967+ Blah blah [@doe99; @smith2000; @smith2004].
40364968
4037−In order to use this feature, you will need to specify a bibliography file
4038−using the `bibliography` metadata field in a YAML metadata section, or
4039−`--bibliography` command line argument. You can supply multiple `--bibliography`
4040−arguments or set `bibliography` metadata field to YAML array, if you want to
4041−use multiple bibliography files. The bibliography may have any of these
4042−formats:
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
40434971
4044− Format File extension
4045− ------------ --------------
4046− BibLaTeX .bib
4047− BibTeX .bibtex
4048− Copac .copac
4049− CSL JSON .json
4050− CSL YAML .yaml
4051− EndNote .enl
4052− EndNote XML .xml
4053− ISI .wos
4054− MEDLINE .medline
4055− MODS .mods
4056− RIS .ris
4057−
4058−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4059−use `.bibtex` to force BibTeX.
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
40604973
4061−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4062−can produce `.json` and `.yaml` files from any of the supported formats.
4974+In a footnote style, it might render as
40634975
4064−In-field markup: In BibTeX and BibLaTeX databases,
4065−pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4066−databases, pandoc Markdown; and in CSL JSON databases, an
4067−[HTML-like markup][CSL markup specs]:
4976+ Blah blah.[^1]
40684977
4069−`<i>...</i>`
4070−: italics
4071−
4072−`<b>...</b>`
4073−: bold
4074−
4075−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4076−: small capitals
4077−
4078−`<sub>...</sub>`
4079−: subscript
4080−
4081−`<sup>...</sup>`
4082−: superscript
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).
40834981
4084−`<span class="nocase">...</span>`
4085−: prevent a phrase from being capitalized as title case
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
40864984
4087−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4088−and CSL YAML formats as far as possible.
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]`.
40894994
4090−As an alternative to specifying a bibliography file using `--bibliography`
4091−or the YAML metadata field `bibliography`, you can include
4092−the citation data directly in the `references` field of the
4093−document's YAML metadata. The field should contain an array of
4094−YAML-encoded references, for example:
4995+Citation items may optionally include a prefix, a locator, and
4996+a suffix. In
40954997
4096− ---
4097− references:
4098− - type: article-journal
4099− id: WatsonCrick1953
4100− author:
4101− - family: Watson
4102− given: J. D.
4103− - family: Crick
4104− given: F. H. C.
4105− issued:
4106− date-parts:
4107− - - 1953
4108− - 4
4109− - 25
4110− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4111− nucleic acid'
4112− title-short: Molecular structure of nucleic acids
4113− container-title: Nature
4114− volume: 171
4115− issue: 4356
4116− page: 737-738
4117− DOI: 10.1038/171737a0
4118− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4119− language: en-GB
4120− ...
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
41214999
4122−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4123−of the supported formats.)
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.
41245003
4125−Citations and references can be formatted using any style supported by the
4126−[Citation Style Language], listed in the [Zotero Style Repository].
4127−These files are specified using the `--csl` option or the `csl` metadata field.
4128−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4129−format. The CSL project provides further information on [finding and editing styles].
4130−
4131−To make your citations hyperlinks to the corresponding bibliography
4132−entries, add `link-citations: true` to your YAML metadata.
4133−
4134−Citations go inside square brackets and are separated by semicolons.
4135−Each citation must have a key, composed of '@' + the citation
4136−identifier from the database, and may optionally have a prefix,
4137−a locator, and a suffix. The citation key must begin with a letter, digit,
4138−or `_`, and may contain alphanumerics, `_`, and internal punctuation
4139−characters (`:.#$%&-+?<>~/`). Here are some examples:
4140−
4141− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4142−
4143− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4144−
4145− Blah blah [@smith04; @doe99].
4146−
4147−`pandoc-citeproc` detects locator terms in the [CSL locale files].
4148−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4149−locale, locator terms can be written in either singular or plural forms,
4150−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4151−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4152−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4153−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4154−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4155−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
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
41565016locator term is used, "page" is assumed.
41575017
4158−`pandoc-citeproc` will use heuristics to distinguish the locator
4159−from the suffix. In complex cases, the locator can be enclosed
4160−in curly braces (using `pandoc-citeproc` 0.15 and higher only):
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:
41615021
41625022 [@smith{ii, A, D-Z}, with a suffix]
41635023 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
41645025
41655026A minus sign (`-`) before the `@` will suppress mention of
41665027the author in the citation. This can be useful when the
@@ -4168,83 +5029,103 @@ author is already mentioned in the text:
41685029
41695030 Smith says blah [-@smith04].
41705031
4171−You can also write an in-text citation, as follows:
5032+You can also write an author-in-text citation, by omitting the
5033+square brackets:
41725034
41735035 @smith04 says blah.
41745036
41755037 @smith04 [p. 33] says blah.
41765038
4177−If the style calls for a list of works cited, it will be placed
4178−in a div with id `refs`, if one exists:
4179−
4180− ::: {#refs}
4181− :::
4182−
4183−Otherwise, it will be placed at the end of the document.
4184−Generation of the bibliography can be suppressed by setting
4185−`suppress-bibliography: true` in the YAML metadata.
4186−
4187−If you wish the bibliography to have a section header, you can
4188−set `reference-section-title` in the metadata, or put the header
4189−at the beginning of the div with id `refs` (if you are using it)
4190−or at the end of your document:
4191−
4192− last paragraph...
4193−
4194− # References
4195−
4196−The bibliography will be inserted after this header. Note that
4197−the `unnumbered` class will be added to this header, so that the
4198−section will not be numbered.
4199−
4200−If you want to include items in the bibliography without actually
4201−citing them in the body text, you can define a dummy `nocite` metadata
4202−field and put the citations there:
4203−
4204− ---
4205− nocite: |
4206− @item1, @item2
4207− ...
4208−
4209− @item3
4210−
4211−In this example, the document will contain a citation for `item3`
4212−only, but the bibliography will contain entries for `item1`, `item2`, and
4213−`item3`.
4214−
4215−It is possible to create a bibliography with all the citations,
4216−whether or not they appear in the document, by using a wildcard:
4217−
4218− ---
4219− nocite: |
4220− @*
4221− ...
4222−
4223−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4224−render the bibliography. In order to do so, specify bibliography
4225−files as outlined above, and add `--natbib` or `--biblatex`
4226−argument to `pandoc` invocation. Bear in mind that bibliography
4227−files have to be in respective format (either BibTeX or
4228−BibLaTeX).
4229−
4230−For more information, see the [pandoc-citeproc man page].
4231−
4232−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4233−[Chicago Manual of Style]: http://chicagomanualofstyle.org
4234−[Citation Style Language]: http://citationstyles.org
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
42355056[Zotero Style Repository]: https://www.zotero.org/styles
42365057[finding and editing styles]: https://citationstyles.org/authors/
42375058[CSL locale files]: https://github.com/citation-style-language/locales
4238−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
42395059
4240−Non-pandoc extensions
4241−---------------------
5060+## Non-default extensions
42425061
42435062The following Markdown syntax extensions are not enabled by default
42445063in pandoc, but may be enabled by adding `+EXTENSION` to the format
42455064name, where `EXTENSION` is the name of the extension. Thus, for
42465065example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
42475066
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+
42485129#### Extension: `old_dashes` ####
42495130
42505131Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -4357,13 +5238,13 @@ and image references. This extension should not be confused with the
43575238
43585239 This is a reference ![image][ref] with multimarkdown attributes.
43595240
4360− [ref]: http://path.to/image "Image title" width=20px height=30px
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
43615242 id=myId class="myClass1 myClass2"
43625243
43635244#### Extension: `mmd_header_identifiers` ####
43645245
4365−Parses multimarkdown style header identifiers (in square brackets,
4366−after the header but before any trailing `#`s in an ATX header).
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
43675248
43685249#### Extension: `compact_definition_lists` ####
43695250
@@ -4392,60 +5273,390 @@ in several respects:
43925273 we must either disallow lazy wrapping or require a blank line between
43935274 list items.
43945275
4395−Markdown variants
4396−-----------------
5276+#### Extension: `gutenberg` ####
5277+
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.
5281+
5282+ [Project Gutenberg]: https://www.gutenberg.org
5283+
5284+#### Extension: `sourcepos` ####
5285+
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.
5290+
5291+## Markdown variants
43975292
43985293In addition to pandoc's extended Markdown, the following Markdown
43995294variants are supported:
44005295
4401−`markdown_phpextra` (PHP Markdown Extra)
4402−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4403− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4404− `header_attributes`, `link_attributes`, `abbreviations`,
4405− `shortcut_reference_links`, `spaced_reference_links`.
4406−
4407−`markdown_github` (deprecated GitHub-Flavored Markdown)
4408−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4409− `gfm_auto_identifiers`, `backtick_code_blocks`,
4410− `autolink_bare_uris`, `space_in_atx_header`,
4411− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4412− `shortcut_reference_links`, `angle_brackets_escapable`,
4413− `lists_without_preceding_blankline`.
4414−
4415−`markdown_mmd` (MultiMarkdown)
4416−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4417− `tex_math_double_backslash`, `intraword_underscores`,
4418− `mmd_title_block`, `footnotes`, `definition_lists`,
4419− `all_symbols_escapable`, `implicit_header_references`,
4420− `auto_identifiers`, `mmd_header_identifiers`,
4421− `shortcut_reference_links`, `implicit_figures`,
4422− `superscript`, `subscript`, `backtick_code_blocks`,
4423− `spaced_reference_links`, `raw_attribute`.
4424−
4425−`markdown_strict` (Markdown.pl)
4426−: `raw_html`, `shortcut_reference_links`,
4427− `spaced_reference_links`.
4428−
4429−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4430−which is implemented as a set of extensions on `commonmark`).
4431−
4432−Note, however, that `commonmark` and `gfm` have limited support
4433−for extensions. Only those listed below (and `smart`,
4434−`raw_tex`, and `hard_line_breaks`) will work. The extensions
4435−can, however, all be individually disabled. Also, `raw_tex`
4436−only affects `gfm` output, not input.
4437−
4438−`gfm` (GitHub-Flavored Markdown)
4439−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4440− `gfm_auto_identifiers`, `backtick_code_blocks`,
4441− `autolink_bare_uris`, `space_in_atx_header`,
4442− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4443− `shortcut_reference_links`, `angle_brackets_escapable`,
4444− `lists_without_preceding_blankline`.
4445−
4446−
4447−Producing slide shows with pandoc
4448−=================================
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)
5303+
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
5306+
5307+ pandoc --list-extensions=FORMAT
5308+
5309+where `FORMAT` is replaced with the name of the format.
5310+
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.
5316+
5317+# Citations
5318+
5319+When the `--citeproc` option is used, pandoc can automatically generate
5320+citations and a bibliography in a number of styles. Basic usage is
5321+
5322+ pandoc --citeproc myinput.txt
5323+
5324+To use this feature, you will need to have
5325+
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.
5330+
5331+## Specifying bibliographic data
5332+
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:
5339+
5340+ Format File extension
5341+ ------------ --------------
5342+ BibLaTeX .bib
5343+ BibTeX .bibtex
5344+ CSL JSON .json
5345+ CSL YAML .yaml
5346+
5347+Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348+use the extension `.bibtex` to force interpretation as BibTeX.
5349+
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]:
5354+
5355+`<i>...</i>`
5356+: italics
5357+
5358+`<b>...</b>`
5359+: bold
5360+
5361+`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5362+: small capitals
5363+
5364+`<sub>...</sub>`
5365+: subscript
5366+
5367+`<sup>...</sup>`
5368+: superscript
5369+
5370+`<span class="nocase">...</span>`
5371+: prevent a phrase from being capitalized as title case
5372+
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:
5378+
5379+ ---
5380+ references:
5381+ - type: article-journal
5382+ id: WatsonCrick1953
5383+ author:
5384+ - family: Watson
5385+ given: J. D.
5386+ - family: Crick
5387+ given: F. H. C.
5388+ issued:
5389+ date-parts:
5390+ - - 1953
5391+ - 4
5392+ - 25
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
5395+ title-short: Molecular structure of nucleic acids
5396+ container-title: Nature
5397+ volume: 171
5398+ issue: 4356
5399+ page: 737-738
5400+ DOI: 10.1038/171737a0
5401+ URL: https://www.nature.com/articles/171737a0
5402+ language: en-GB
5403+ ...
5404+
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.
5408+
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5411+
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
5414+
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
5417+
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
5420+
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
5424+
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
5427+
5428+### Capitalization in titles
5429+
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
5432+
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`.)
5438+
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:
5442+
5443+ title = {My Dinner with {Andre}}
5444+
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
5447+
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
5449+
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.
5454+
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
5457+
5458+ - All titles should be in sentence case.
5459+
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.)
5463+
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
5466+
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
5468+
5469+### Conference Papers, Published vs. Unpublished
5470+
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
5473+
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`).
5477+
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.
5487+
5488+
5489+## Specifying a citation style
5490+
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:
5507+
5508+
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+ }
5517+
5518+
5519+## Citations in note styles
5520+
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,
5527+
5528+ Blah blah [@foo, p. 33].
5529+
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].
5535+
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:
5541+
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].
5545+
5546+## Raw content in a style
5547+
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
5550+
5551+ {{jats}}<ref>{{/jats}}
5552+
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
5555+
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.
5560+
5561+
5562+
5563+## Placement of the bibliography
5564+
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:
5567+
5568+ ::: {#refs}
5569+ :::
5570+
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.
5574+
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:
5579+
5580+ last paragraph...
5581+
5582+ # References
5583+
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.
5587+
5588+## Including uncited items in the bibliography
5589+
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:
5593+
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
5598+
5599+ @item3
5600+
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`.
5604+
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:
5607+
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
5612+
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.
5619+
5620+## Other relevant metadata fields
5621+
5622+A few other metadata fields affect bibliography formatting:
5623+
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
5628+
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
44495660
44505661You can use pandoc to produce an HTML + JavaScript slide presentation
44515662that can be viewed via a web browser. There are five ways to do this,
@@ -4493,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
44935704
44945705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
44955706
4496−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4497−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4498−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4499−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4500−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4501−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4502−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4503−the file by default.
4504−
4505−With all HTML slide formats, the `--self-contained` option can be used to
4506−produce a single file that contains all of the data necessary to display the
4507−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.
45085722
45095723To produce a PDF slide show using beamer, type
45105724
@@ -4517,14 +5731,13 @@ To produce a Powerpoint slide show, type
45175731
45185732 pandoc habits.txt -o habits.pptx
45195733
4520−Structuring the slide show
4521−--------------------------
5734+## Structuring the slide show
45225735
4523−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
45245737the hierarchy that is followed immediately by content, and not another
4525−header, somewhere in the document. In the example above, level 1 headers
4526−are always followed by level 2 headers, which are followed by content,
4527−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
45285741the `--slide-level` option.
45295742
45305743The document is carved up into slides according to the following
@@ -4532,17 +5745,21 @@ rules:
45325745
45335746 * A horizontal rule always starts a new slide.
45345747
4535− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
45365749
4537− * Headers *below* the slide level in the hierarchy create
4538− 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.)
45395756
4540− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
45415758 "title slides," which just contain the section title
45425759 and help to break the slide show into sections.
4543−
4544− * Content *above* the slide level will not appear in the slide
4545− 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).
45465763
45475764 * A title page is constructed automatically from the document's title
45485765 block, if present. (In the case of beamer, this can be disabled
@@ -4550,17 +5767,16 @@ rules:
45505767
45515768These rules are designed to support many different styles of slide show. If
45525769you don't care about structuring your slides into sections and subsections,
4553−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
45545771will be the slide level.) But you can also structure the slide show into
45555772sections, as in the example above.
45565773
45575774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4558−layout will be produced, with level 1 headers building horizontally
4559−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
45605777you use deeper nesting of section levels with reveal.js.
45615778
4562−Incremental lists
4563−-----------------
5779+## Incremental lists
45645780
45655781By default, these writers produce lists that display "all at once."
45665782If you want your lists to display incrementally (one item at a time),
@@ -4598,8 +5814,10 @@ option):
45985814Both methods allow incremental and nonincremental lists to be mixed
45995815in a single document.
46005816
4601−Inserting pauses
4602−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
46035821
46045822You can add "pauses" within a slide by including a paragraph containing
46055823three dots, separated by spaces:
@@ -4612,8 +5830,9 @@ three dots, separated by spaces:
46125830
46135831 content after the pause
46145832
4615−Styling the slides
4616−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
46175836
46185837You can change the style of HTML slides by putting customized CSS files
46195838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4638,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
46385857
46395858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
46405859
4641−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
46425861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4643−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
46445863that affects slides is the `allowframebreaks` class, which sets the
46455864`allowframebreaks` option, causing multiple slides to be created
46465865if the content overfills the frame. This is recommended especially for
@@ -4648,8 +5867,7 @@ bibliographies:
46485867
46495868 # References {.allowframebreaks}
46505869
4651−Speaker notes
4652−-------------
5870+## Speaker notes
46535871
46545872Speaker notes are supported in reveal.js and PowerPoint (pptx)
46555873output. You can add notes to your Markdown document thus:
@@ -4670,8 +5888,7 @@ in handouts and presenter view.
46705888Notes are not yet supported for other slide formats, but the notes
46715889will not appear on the slides themselves.
46725890
4673−Columns
4674−-------
5891+## Columns
46755892
46765893To put material in side by side columns, you can use a native
46775894div container with class `columns`, containing two or more div
@@ -4686,12 +5903,46 @@ containers with class `column` and a `width` attribute:
46865903 :::
46875904 ::::::::::::::
46885905
4689−Frame attributes in beamer
4690−--------------------------
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
46915942
46925943Sometimes it is necessary to add the LaTeX `[fragile]` option to
46935944a frame in beamer (for example, when using the `minted` environment).
4694−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
46955946introducing the slide:
46965947
46975948 # Fragile slide {.fragile}
@@ -4701,10 +5952,9 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
47015952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
47025953`shrink`, `standout`, `noframenumbering`.
47035954
4704−Background in reveal.js and beamer
4705−----------------------------------
5955+## Background in reveal.js and beamer
47065956
4707−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
47085958to beamer slideshows.
47095959
47105960For the same image on every slide, use the configuration
@@ -4712,14 +5962,14 @@ option `background-image` either in the YAML metadata block
47125962or as a command-line variable. (There are no other options in
47135963beamer and the rest of this section concerns reveal.js slideshows.)
47145964
4715−For reveal.js, you can instead use the reveal.js-native option
4716−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4717−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
47185968`parallaxBackgroundSize` to have your values take effect.
47195969
47205970To set an image for a particular reveal.js slide, add
47215971`{data-background-image="/path/to/image"}`
4722−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).
47235973
47245974In reveal.js's overview mode, the parallaxBackgroundImage will show up
47255975only on the first slide.
@@ -4728,9 +5978,12 @@ Other reveal.js background settings also work on individual slides, including
47285978`data-background-size`, `data-background-repeat`, `data-background-color`,
47295979`data-transition`, and `data-transition-speed`.
47305980
4731−See the [reveal.js
4732−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4733−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.
47345987
47355988For example in reveal.js:
47365989
@@ -4738,6 +5991,9 @@ For example in reveal.js:
47385991---
47395992title: My Slideshow
47405993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
47415997---
47425998
47435999## Slide One
@@ -4746,14 +6002,12 @@ Slide 1 has background_image.png as its background.
47466002
47476003## {data-background-image="/path/to/special_image.jpg"}
47486004
4749−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.
47506006```
47516007
4752−Creating EPUBs with pandoc
4753−==========================
6008+# EPUBs
47546009
4755−EPUB Metadata
4756−-------------
6010+## EPUB Metadata
47576011
47586012EPUB metadata may be specified using the `--epub-metadata` option, but
47596013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4831,6 +6085,15 @@ The following fields are recognized:
48316085
48326086`rights`
48336087 ~ 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.
48346097
48356098`cover-image`
48366099 ~ A string value (path to cover image).
@@ -4852,13 +6115,12 @@ The following fields are recognized:
48526115 - `binding`: `true`|`false` (default `true`)
48536116 - `scroll-axis`: `vertical`|`horizontal`|`default`
48546117
4855−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
48566119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
48576120
4858−The `epub:type` attribute
4859−-------------------------
6121+## The `epub:type` attribute
48606122
4861−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
48626124chapter using the [`epub:type` attribute][epub-type]. For example, to set
48636125the attribute to the value `prologue`, use this markdown:
48646126
@@ -4881,22 +6143,26 @@ abstract frontmatter
48816143acknowledgments frontmatter
48826144copyright-page frontmatter
48836145dedication 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
48846156foreword frontmatter
4885−halftitle, frontmatter
4886−introduction frontmatter
48876157preface frontmatter
4888−seriespage frontmatter
4889−titlepage frontmatter
4890−afterword backmatter
48916158appendix backmatter
48926159colophon backmatter
4893−conclusion backmatter
4894−epigraph backmatter
6160+bibliography backmatter
6161+index backmatter
48956162
48966163[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
48976164
4898−Linked media
4899−------------
6165+## Linked media
49006166
49016167By default, pandoc will download media referenced from any `<img>`, `<audio>`,
49026168`<video>` or `<source>` element present in the generated EPUB,
@@ -4906,13 +6172,12 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
49066172with the `src` attribute. For example:
49076173
49086174 <audio controls="1">
4909− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
49106176 data-external="1" type="audio/mpeg">
49116177 </source>
49126178 </audio>
49136179
4914−Creating Jupyter notebooks with pandoc
4915−======================================
6180+# Jupyter notebooks
49166181
49176182When creating a [Jupyter notebook], pandoc will try to infer the
49186183notebook structure. Code blocks with the class `code` will be
@@ -5019,8 +6284,25 @@ hello
50196284::::::
50206285````
50216286
5022−Syntax highlighting
5023−===================
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
50246306
50256307Pandoc will automatically highlight syntax in [fenced code blocks] that
50266308are marked with a language name. The Haskell library [skylighting] is
@@ -5048,7 +6330,7 @@ Then edit `my.theme` and use it like this:
50486330If you are not satisfied with the built-in highlighting, or you
50496331want highlight a language that isn't supported, you can use the
50506332`--syntax-definition` option to load a [KDE-style XML syntax definition
5051−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
50526334Before writing your own, have a look at KDE's [repository of syntax
50536335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
50546336
@@ -5056,13 +6338,58 @@ To disable highlighting, use the `--no-highlight` option.
50566338
50576339[skylighting]: https://github.com/jgm/skylighting
50586340
5059−Custom Styles
5060−=============
6341+# Custom Styles
50616342
50626343Custom styles can be used in the docx and ICML formats.
50636344
5064−Input
5065−-----
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
50666393
50676394The docx reader, by default, only reads those styles that it can
50686395convert into pandoc elements, either by direct conversion or
@@ -5091,17 +6418,17 @@ And with the extension:
50916418
50926419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
50936420
5094− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
50956422 This is some text.
50966423 :::
50976424
5098− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
50996426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
51006427 And this is text with a [strengthened]{custom-style="Strengthened"}
51016428 text style.
51026429 :::
51036430
5104− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
51056432 > Here is a styled paragraph that inherits from Block Text.
51066433 :::
51076434
@@ -5109,70 +6436,47 @@ With these custom styles, you can use your input document as a
51096436reference-doc while creating docx output (see below), and maintain the
51106437same styles in your input and output files.
51116438
5112−Output
5113−------
6439+# Custom writers
51146440
5115−By default, pandoc's docx and ICML output applies a predefined set of styles
5116−for blocks such as paragraphs and block quotes, and uses largely default
5117−formatting (italics, bold) for inlines. This will work for most
5118−purposes, especially alongside a `reference.docx` file. However, if you
5119−need to apply your own styles to blocks, or match a preexisting set of
5120−styles, pandoc allows you to define custom styles for blocks and text
5121−using `div`s and `span`s, respectively.
5122−
5123−If you define a `div` or `span` with the attribute `custom-style`,
5124−pandoc will apply your specified style to the contained elements. So,
5125−for example using the `bracketed_spans` syntax,
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
51266443
5127− [Get out]{custom-style="Emphatically"}, he said.
5128−
5129−would produce a docx file with "Get out" styled with character
5130−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
5131−
5132− Dickinson starts the poem simply:
5133−
5134− ::: {custom-style="Poetry"}
5135− | A Bird came down the Walk---
5136− | He did not know I saw---
5137− :::
5138−
5139−would style the two contained lines with the `Poetry` paragraph style.
5140−
5141−For docx output, styles will be defined in the output file as inheriting
5142−from normal text, if the styles are not yet in your reference.docx.
5143−If they are already defined, pandoc will not alter the definition.
5144−
5145−This feature allows for greatest customization in conjunction with
5146−[pandoc filters]. If you want all paragraphs after block quotes to be
5147−indented, you can write a filter to apply the styles necessary. If you
5148−want all italics to be transformed to the `Emphasis` character style
5149−(perhaps to change their color), you can write a filter which will
5150−transform all italicized inlines to inlines within an `Emphasis`
5151−custom-style `span`.
5152−
5153−[pandoc filters]: http://pandoc.org/filters.html
5154−
5155−Custom writers
5156−==============
5157−
5158−Pandoc can be extended with custom writers written in [lua]. (Pandoc
5159−includes a lua interpreter, so lua need not be installed separately.)
5160−
5161−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
51626445in place of the output format. For example:
51636446
51646447 pandoc -t data/sample.lua
51656448
5166−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
51676450possible element in a pandoc document. To get a documented example
51686451which you can modify according to your needs, do
51696452
51706453 pandoc --print-default-data-file sample.lua
51716454
5172−[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).
51736478
5174−A note on security
5175−==================
6479+# A note on security
51766480
51776481If you use pandoc to convert user-contributed content in a web
51786482application, here are some things to keep in mind:
@@ -5187,7 +6491,7 @@ application, here are some things to keep in mind:
51876491 shelling out to the executable), it is possible to use it in a mode
51886492 that fully isolates pandoc from your file system, by running the
51896493 pandoc operations in the `PandocPure` monad. See the document
5190− [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)
51916495 for more details.
51926496
519364973. Pandoc's parsers can exhibit pathological performance on some
@@ -5200,17 +6504,17 @@ application, here are some things to keep in mind:
520065044. The HTML generated by pandoc is not guaranteed to be safe.
52016505 If `raw_html` is enabled for the Markdown input, users can
52026506 inject arbitrary HTML. Even if `raw_html` is disabled,
5203− users can include dangerous content in attributes for
5204− headers, spans, and code blocks. To be safe, you should
5205− 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.
52066510
5207−Authors
5208−=======
6511+# Authors
52096512
5210−Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
52116514under the [GPL], version 2 or greater. This software carries no
52126515warranty of any kind. (See COPYRIGHT for full copyright and
52136516warranty notices.) For a full list of contributors, see the file
52146517AUTHORS.md in the pandoc source code.
52156518
5216−[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"