@@ -1,14 +1,14 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% April 5, 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])
@@ -329,10 +337,10 @@ General options {.options}
329337 - `tei` ([TEI Simple])
330338 - `xwiki` ([XWiki markup])
331339 - `zimwiki` ([ZimWiki markup])
332− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
333341 :::
334342
335− Note that `odt`, `docx`, and `epub` output will not be directed
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
336344 to *stdout* unless forced with `-o -`.
337345
338346 Extensions can be individually enabled or
@@ -353,15 +361,29 @@ General options {.options}
353361 will be used. On \*nix and macOS systems this will be the `pandoc`
354362 subdirectory of the XDG data directory (by default,
355363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
356− environment variable). If that directory does not exist,
357− `$HOME/.pandoc` will be used (for backwards compatibility).
358− In Windows the default user data directory is
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
359367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
360368 You can find the default user data directory on your system by
361369 looking at the output of `pandoc --version`.
362− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
363− `slidy`, `slideous`, or `s5` directory
364− 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.
365387
366388`--bash-completion`
367389
@@ -372,8 +394,7 @@ General options {.options}
372394
373395`--verbose`
374396
375−: Give verbose debugging output. Currently this only has an effect
376− with PDF output.
397+: Give verbose debugging output.
377398
378399`--quiet`
379400
@@ -399,7 +420,7 @@ General options {.options}
399420
400421`--list-extensions`[`=`*FORMAT*]
401422
402−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
403424 by a `+` or `-` indicating whether it is enabled by default
404425 in *FORMAT*. If *FORMAT* is not specified, defaults for
405426 pandoc's Markdown are given.
@@ -422,65 +443,88 @@ General options {.options}
422443
423444: Show usage message.
424445
425−[Markdown]: http://daringfireball.net/projects/markdown/
426−[CommonMark]: http://commonmark.org
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
427448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
428449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
429−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
430−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
431−[S5]: http://meyerweb.com/eric/tools/s5/
432−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
433−[Slideous]: http://goessner.net/articles/slideous/
434−[HTML]: http://www.w3.org/html/
435−[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/
436457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
437−[XHTML]: http://www.w3.org/TR/xhtml1/
438−[LaTeX]: http://latex-project.org
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
439460[`beamer`]: https://ctan.org/pkg/beamer
440461[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
441−[ConTeXt]: http://www.contextgarden.net/
442−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
443−[DocBook]: http://docbook.org
462+[ConTeXt]: https://www.contextgarden.net/
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464+[DocBook]: https://docbook.org
444465[JATS]: https://jats.nlm.nih.gov
445−[txt2tags]: http://txt2tags.org
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
446468[EPUB]: http://idpf.org/epub
447469[OPML]: http://dev.opml.org/spec2.html
448470[OpenDocument]: http://opendocument.xml.org
449−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
450−[Textile]: http://redcloth.org/textile
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
451473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
452474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
453−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
454476[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
455−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
456478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
457479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
458480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
459−[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
460−[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)
461484[Haskell]: https://www.haskell.org
462−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
463−[Emacs Org mode]: http://orgmode.org
464−[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/
465488[AsciiDoctor]: https://asciidoctor.org/
466−[DZSlides]: http://paulrouget.com/dzslides/
489+[DZSlides]: https://paulrouget.com/dzslides/
467490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
468491[PDF]: https://www.adobe.com/pdf/
469−[reveal.js]: http://lab.hakim.se/reveal-js/
492+[reveal.js]: https://revealjs.com/
470493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
471494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
472−[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
473496[TEI Simple]: https://github.com/TEIC/TEI-Simple
474497[Muse]: https://amusewiki.org/library/manual
475498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
476499[Vimwiki]: https://vimwiki.github.io
477−
478−Reader options {.options}
479−--------------
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.
480522
481523`--base-header-level=`*NUMBER*
482524
483−: Specify the base level for headings (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).
484528
485529`--strip-empty-paragraphs`
486530
@@ -545,41 +589,32 @@ Reader options {.options}
545589
546590 3. `$PATH` (executable only)
547591
548− Filters and lua-filters are applied in the order specified
549− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
550594
551−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
552596
553597: Transform the document in a similar fashion as JSON filters (see
554− `--filter`), but use pandoc's build-in lua filtering system. The given
555− lua script is expected to return a list of lua filters which will be
556− 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
557601 functions indexed by the name of the AST element on which the filter
558602 function should be applied.
559603
560− The `pandoc` lua module provides helper functions for element
561− 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.
562606
563− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
564608
565− function expand_hello_world(inline)
566− if inline.c == '{{helloworld}}' then
567− return pandoc.Emph{ pandoc.Str "Hello, World" }
568− else
569− return inline
570− end
571− end
609+ In order of preference, pandoc will look for Lua filters in
572610
573− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
574612
575− In order of preference, pandoc will look for lua filters in
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
576615
577− 1. a specified full or relative path (executable or
578− non-executable)
579−
580− 2. `$DATADIR/filters` (executable or non-executable)
581− where `$DATADIR` is the user data directory (see
582− `--data-dir`, above).
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
583618
584619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
585620
@@ -596,19 +631,23 @@ Reader options {.options}
596631
597632`--metadata-file=`*FILE*
598633
599−: Read metadata from the supplied YAML (or JSON) file.
600− This option can be used with every input format, but string
601− scalars in the YAML file will always be parsed as Markdown.
602− Generally, the input will be handled the same as in
603− [YAML metadata blocks][Extension: `yaml_metadata_block`].
604− Metadata values specified inside the document, or by using `-M`,
605− 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.
606644
607645`-p`, `--preserve-tabs`
608646
609−: Preserve tabs instead of converting them to spaces (the default).
610− Note that this will only affect tabs in literal code spans and code
611− 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.
612651
613652`--tab-stop=`*NUMBER*
614653
@@ -618,30 +657,30 @@ Reader options {.options}
618657
619658: Specifies what to do with insertions, deletions, and comments
620659 produced by the MS Word "Track Changes" feature. `accept` (the
621− default), inserts all insertions, and ignores all
622− deletions. `reject` inserts all deletions and ignores
623− insertions. Both `accept` and `reject` ignore comments. `all` puts
624− in insertions, deletions, and comments, wrapped in spans with
625− `insertion`, `deletion`, `comment-start`, and `comment-end`
626− classes, respectively. The author and time of change is
627− included. `all` is useful for scripting: only accepting changes
628− from a certain reviewer, say, or before a certain date. If a
629− paragraph is inserted or deleted, `track-changes=all` produces a
630− span with the class `paragraph-insertion`/`paragraph-deletion`
631− before the affected paragraph break. This option only affects the
632− 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.
633672
634673`--extract-media=`*DIR*
635674
636675: Extract images and other media contained in or linked from
637676 the source document to the path *DIR*, creating it if
638677 necessary, and adjust the images references in the document
639− so they point to the extracted files. If the source format is
640− a binary container (docx, epub, or odt), the media is
641− extracted from the container and the original
642− filenames are used. Otherwise the media is read from the
643− file system or downloaded, and new filenames are constructed
644− 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.
645684
646685`--abbreviations=`*FILE*
647686
@@ -652,17 +691,17 @@ Reader options {.options}
652691 system default, use
653692 `pandoc --print-default-data-file=abbreviations`. The only
654693 use pandoc makes of this list is in the Markdown reader.
655− Strings ending in a period that are found in this list will
656− be followed by a nonbreaking space, so that the period will
657− 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.
658697
659698[`pandocfilters`]: https://github.com/jgm/pandocfilters
660699[PHP]: https://github.com/vinai/pandocfilters-php
661700[perl]: https://metacpan.org/pod/Pandoc::Filter
662701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
663703
664−General writer options {.options}
665−----------------------
704+## General writer options {.options}
666705
667706`-s`, `--standalone`
668707
@@ -687,11 +726,8 @@ General writer options {.options}
687726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
688727
689728: Set the template variable *KEY* to the value *VAL* when rendering the
690− document in standalone mode. This is generally only useful when the
691− `--template` option is used to specify a custom template, since
692− pandoc automatically sets the variables used in the default
693− templates. If no *VAL* is specified, the key will be given the
694− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
695731
696732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
697733
@@ -702,6 +738,11 @@ General writer options {.options}
702738 `-o`/`--output` must come before `--print-default-template`
703739 on the command line.
704740
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`.
745+
705746`--print-default-data-file=`*FILE*
706747
707748: Print a system default data file. Files in the user data directory
@@ -718,9 +759,12 @@ General writer options {.options}
718759
719760`--dpi`=*NUMBER*
720761
721−: Specify the dpi (dots per inch) value for conversion from pixels
722− to inch/centimeters and vice versa. The default is 96dpi.
723− 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.
724768
725769`--wrap=auto`|`none`|`preserve`
726770
@@ -751,6 +795,12 @@ General writer options {.options}
751795 unless `-s/--standalone` is used, and it has no effect
752796 on `man`, `docbook4`, `docbook5`, or `jats` output.
753797
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+
754804`--toc-depth=`*NUMBER*
755805
756806: Specify the number of section levels to include in the table
@@ -802,7 +852,8 @@ General writer options {.options}
802852 which will be used for syntax highlighting of appropriately
803853 marked code blocks. This can be used to add support for
804854 new languages or to use altered syntax definitions for
805− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
806857
807858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
808859
@@ -840,11 +891,11 @@ General writer options {.options}
840891 will not be searched. For example:
841892 `--resource-path=.:test` will search the working directory
842893 and the `test` subdirectory, in that order.
843−
844− `--resource-path` only has an effect if (a) the output
845− format embeds images (for example, `docx`, `pdf`, or `html`
846− with `--self-contained`) or (b) it is used together with
847− `--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`.
848899
849900`--request-header=`*NAME*`:`*VAL*
850901
@@ -854,8 +905,13 @@ General writer options {.options}
854905 downloaded). If you're behind a proxy, you also need to set
855906 the environment variable `http_proxy` to `http://...`.
856907
857−Options affecting specific writers {.options}
858−----------------------------------
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}
859915
860916`--self-contained`
861917
@@ -880,7 +936,9 @@ Options affecting specific writers {.options}
880936
881937`--html-q-tags`
882938
883−: 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.)
884942
885943`--ascii`
886944
@@ -898,37 +956,45 @@ Options affecting specific writers {.options}
898956 placement of link references is affected by the
899957 `--reference-location` option.
900958
901−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
902960
903961: Specify whether footnotes (and references, if `reference-links` is
904962 set) are placed at the end of the current (top-level) block, the
905963 current section, or the document. The default is
906964 `document`. Currently only affects the markdown writer.
907965
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+
908974`--atx-headers`
909975
910−: Use ATX-style headings in Markdown output. The default is
911− to use setext-style headings for levels 1 to 2, and then ATX headings.
912− (Note: for `gfm` output, ATX headings are always used.)
913− This option also affects markdown cells in `ipynb` output.
976+: *Deprecated synonym for `--markdown-headings=atx`.*
914977
915−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
916979
917−: Treat top-level headings as the given division type in LaTeX, ConTeXt,
918− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
919− all headings are shifted such that the top-level heading becomes the specified
920− type. The default behavior is to determine the best division type via
921− heuristics: unless other conditions apply, `section` is chosen. When the
922− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
923− `article` option is specified), `chapter` is implied as the setting for this
924− option. If `beamer` is the output format, specifying either `chapter` or
925− `part` will cause top-level headings to become `\part{..}`, while
926− second-level headings 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.
927993
928994`-N`, `--number-sections`
929995
930−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
931− 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
932998 `unnumbered` will never be numbered, even if `--number-sections`
933999 is specified.
9341000
@@ -947,7 +1013,7 @@ Options affecting specific writers {.options}
9471013
9481014: Use the [`listings`] package for LaTeX code blocks. The package
9491015 does not support multi-byte encoding for source code. To handle UTF-8
950− 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
9511017 documented here: [Encoding issue with the listings package].
9521018
9531019`-i`, `--incremental`
@@ -993,8 +1059,7 @@ Options affecting specific writers {.options}
9931059
9941060: Specify *STRING* as a prefix at the beginning of the title
9951061 that appears in the HTML header (but not in the title as it
996− appears at the beginning of the HTML body). Implies
997− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
9981063
9991064`-c` *URL*, `--css=`*URL*
10001065
@@ -1071,6 +1136,7 @@ Options affecting specific writers {.options}
10711136 - Verbatim Char
10721137 - Footnote Reference
10731138 - Hyperlink
1139+ - Section Number
10741140
10751141 Table style:
10761142
@@ -1210,8 +1276,18 @@ Options affecting specific writers {.options}
12101276: Use the specified engine when producing PDF output.
12111277 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
12121278 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1213− and `pdfroff`. The default is `pdflatex`. If the engine is
1214− not in your PATH, the full path of the engine may be specified here.
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`
12151291
12161292`--pdf-engine-opt=`*STRING*
12171293
@@ -1220,59 +1296,84 @@ Options affecting specific writers {.options}
12201296 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
12211297 Note that no check for duplicate options is done.
12221298
1223−[Dublin Core elements]: http://dublincore.org/documents/dces/
1224−[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
12251301[Encoding issue with the listings package]:
12261302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
12271303
1228−Citation rendering {.options}
1229−------------------
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].
12301324
12311325`--bibliography=`*FILE*
12321326
12331327: Set the `bibliography` field in the document's metadata to *FILE*,
1234− overriding any value set in the metadata, and process citations
1235− using `pandoc-citeproc`. (This is equivalent to
1236− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1237− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1238− used, making this equivalent to `--metadata bibliography=FILE`.
1239− If you supply this argument multiple times, each *FILE* will be added
1240− 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`).
12411334
12421335`--csl=`*FILE*
12431336
12441337: Set the `csl` field in the document's metadata to *FILE*,
12451338 overriding any value set in the metadata. (This is equivalent to
1246− `--metadata csl=FILE`.)
1247− 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.
12481344
12491345`--citation-abbreviations=`*FILE*
12501346
12511347: Set the `citation-abbreviations` field in the document's metadata to
12521348 *FILE*, overriding any value set in the metadata. (This is equivalent to
12531349 `--metadata citation-abbreviations=FILE`.)
1254− 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.
12551354
12561355`--natbib`
12571356
1258−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1259− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1260− 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`].
12611361
12621362`--biblatex`
12631363
1264−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1265− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1266− 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`].
12671368
1268−Math rendering in HTML {.options}
1269−----------------------
1369+## Math rendering in HTML {.options}
12701370
1271−The default is to render TeX math as far as possible using Unicode characters.
1272−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1273−differently from the surrounding text if needed. However, this gives acceptable
1274−results only for basic math, usually you will want to use `--mathjax` or another
1275−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.
12761377
12771378`--mathjax`[`=`*URL*]
12781379
@@ -1286,10 +1387,11 @@ of the following options.
12861387
12871388`--mathml`
12881389
1289−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1290− `html4` and `html5`). This is the default in `odt` output. Note that
1291− currently only Firefox and Safari (and select e-book readers) natively
1292− 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.
12931395
12941396`--webtex`[`=`*URL*]
12951397
@@ -1313,21 +1415,19 @@ of the following options.
13131415`--gladtex`
13141416
13151417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1316− can then be processed by [GladTeX] to produce images of the typeset
1317− formulas and an HTML file with links to these images.
1318− 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.
13191420
13201421 pandoc -s --gladtex input.md -o myfile.htex
1321− gladtex -d myfile-images myfile.htex
1322− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
13231424
1324−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
13251426[MathJax]: https://www.mathjax.org
13261427[KaTeX]: https://github.com/Khan/KaTeX
1327−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
13281429
1329−Options for wrapper scripts {.options}
1330−---------------------------
1430+## Options for wrapper scripts {.options}
13311431
13321432`--dump-args`
13331433
@@ -1351,8 +1451,277 @@ Options for wrapper scripts {.options}
13511451
13521452 pandoc -o foo.html -s
13531453
1354−Templates
1355−=========
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
13561725
13571726When the `-s/--standalone` option is used, pandoc uses a template to
13581727add header and footer material that is needed for a self-standing
@@ -1378,18 +1747,398 @@ directory (see `--data-dir`, above). *Exceptions:*
13781747Templates contain *variables*, which allow for the inclusion of
13791748arbitrary information at any point in the file. They may be set at the
13801749command line using the `-V/--variable` option. If a variable is not set,
1381−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
13821751using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1383−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
13842006
1385−Metadata variables
1386−------------------
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
2012+
2013+If a variable occurs by itself on a line, preceded by whitespace
2014+and not followed by further text or directives on the same line,
2015+and the variable's value contains multiple lines, it will be
2016+nested automatically.
2017+
2018+### Breakable spaces
2019+
2020+Normally, spaces in the template itself (as opposed to values of
2021+the interpolated variables) are not breakable, but they can be
2022+made breakable in part of the template by using the `~` keyword
2023+(ended with another `~`).
2024+
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
2029+
2030+### Pipes
2031+
2032+A pipe transforms the value of a variable or partial. Pipes are
2033+specified using a slash (`/`) between the variable name (or partial)
2034+and the pipe name. Example:
2035+
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
2040+
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
2044+
2045+$employee:name()/uppercase$
2046+```
2047+
2048+Pipes may be chained:
2049+
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
2055+
2056+Some pipes take parameters:
2057+
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
2065+
2066+Currently the following pipes are predefined:
2067+
2068+- `pairs`: Converts a map or array to an array of maps,
2069+ each with `key` and `value` fields. If the original
2070+ value was an array, the `key` will be the array index,
2071+ starting with 1.
2072+
2073+- `uppercase`: Converts text to uppercase.
2074+
2075+- `lowercase`: Converts text to lowercase.
2076+
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
2080+
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2083+
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2087+
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
2091+
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
2095+
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
2099+
2100+- `chomp`: Removes trailing newlines (and breakable space).
2101+
2102+- `nowrap`: Disables line wrapping on breakable spaces.
2103+
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
2109+
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
2114+
2115+- `left n "leftborder" "rightborder"`: Renders a textual value
2116+ in a block of width `n`, aligned to the left, with an optional
2117+ left and right border. Has no effect on other values. This
2118+ can be used to align material in tables. Widths are positive
2119+ integers indicating the number of characters. Borders
2120+ are strings inside double quotes; literal `"` and `\` characters
2121+ must be backslash-escaped.
2122+
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
2126+
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
2130+
2131+
2132+## Variables
2133+
2134+### Metadata variables
13872135
13882136`title`, `author`, `date`
13892137: allow identification of basic aspects of the document. Included
13902138 in PDF metadata through LaTeX and ConTeXt. These can be set
13912139 through a [pandoc title block][Extension: `pandoc_title_block`],
1392− 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`]:
13932142
13942143 ---
13952144 author:
@@ -1397,6 +2146,13 @@ Metadata variables
13972146 - Peter Abelard
13982147 ...
13992148
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+
14002156`subtitle`
14012157: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
14022158 documents
@@ -1422,7 +2178,7 @@ Metadata variables
14222178Additionally,
14232179any root-level string metadata, not included in ODT, docx
14242180or pptx metadata is added as a *custom property*.
1425−The following YAML metadata block for instance:
2181+The following [YAML] metadata block for instance:
14262182
14272183 ---
14282184 title: 'This is the title'
@@ -1441,8 +2197,7 @@ will include `title`, `author` and `description` as standard document
14412197properties and `subtitle` as a custom property when converting to docx,
14422198ODT or pptx.
14432199
1444−Language variables
1445−------------------
2200+### Language variables
14462201
14472202`lang`
14482203: identifies the main language of the document using IETF language
@@ -1470,28 +2225,101 @@ Language variables
14702225: the base script direction, either `rtl` (right-to-left)
14712226 or `ltr` (left-to-right).
14722227
1473− For bidirectional documents, native pandoc `span`s and `div`s
1474− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1475− override the base direction in some output formats.
1476− This may not always be necessary if the final renderer
1477− (e.g. the browser, when generating HTML) supports the
1478− [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].
14792234
1480− When using LaTeX for bidirectional documents, only the `xelatex` engine
1481− 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`).
14822238
14832239[BCP 47]: https://tools.ietf.org/html/bcp47
1484−[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
14852241[Language subtag lookup]: https://r12a.github.io/app-subtags/
14862242
1487−Variables for HTML slides
1488−-------------------------
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
14892314
14902315These affect HTML output when [producing slide shows with pandoc].
1491−All [reveal.js configuration options] are available as variables.
2316+
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
14922319
14932320`revealjs-url`
1494−: 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/`)
14952323
14962324`s5-url`
14972325: base URL for S5 documents (defaults to `s5/default`)
@@ -1503,10 +2331,16 @@ All [reveal.js configuration options] are available as variables.
15032331`slideous-url`
15042332: base URL for Slideous documents (defaults to `slideous`)
15052333
1506−[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/
15072342
1508−Variables for Beamer slides
1509−---------------------------
2343+### Variables for Beamer slides
15102344
15112345These variables change the appearance of PDF slides using [`beamer`].
15122346
@@ -1535,7 +2369,7 @@ These variables change the appearance of PDF slides using [`beamer`].
15352369: enables "title pages" for new sections (default is true)
15362370
15372371`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1538−: beamer themes:
2372+: beamer themes
15392373
15402374`themeoptions`
15412375: options for LaTeX beamer themes (a list).
@@ -1543,19 +2377,27 @@ These variables change the appearance of PDF slides using [`beamer`].
15432377`titlegraphic`
15442378: image for title slide
15452379
1546−Variables for LaTeX
1547−-------------------
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
15482389
15492390Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15502391
1551−### Layout
2392+#### Layout
15522393
15532394`block-headings`
1554−: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or
1555− fifth- and sixth-level with book classes) free-standing rather than run-in;
1556− requires further formatting to distinguish from `\subsubsection` (third- or
1557− fourth-level headings). Instead of using this option, [KOMA-Script] can adjust
1558− headings more extensively:
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:
15592401
15602402 ---
15612403 documentclass: scrartcl
@@ -1581,9 +2423,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15812423 ...
15822424
15832425`documentclass`
1584−: document class: usually one of the standard classes, [`article`], [`book`],
1585− and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
1586− and `scrreprt`, 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`]
15872430
15882431`geometry`
15892432: option for [`geometry`] package, e.g. `margin=1in`;
@@ -1596,9 +2439,21 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
15962439 - heightrounded
15972440 ...
15982441
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2445+
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
2452+
15992453`indent`
1600−: uses document class settings for indentation (the default LaTeX template
1601− 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)
16022457
16032458`linestretch`
16042459: adjusts line spacing using the [`setspace`]
@@ -1620,11 +2475,11 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16202475: numbering depth for sections (with `--number-sections` option
16212476 or `numbersections` variable)
16222477
1623−### Fonts
2478+#### Fonts
16242479
16252480`fontenc`
1626−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1627− 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])
16282483
16292484`fontfamily`
16302485: font package for use with `pdflatex`:
@@ -1644,9 +2499,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16442499 ...
16452500
16462501`fontsize`
1647−: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1648− To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1649− 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`.
16502505
16512506`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
16522507: font families for use with `xelatex` or
@@ -1655,9 +2510,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16552510
16562511`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
16572512: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1658− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1659− available through [`fontspec`]; repeat for multiple options. For example,
1660− 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:
16612517
16622518 ---
16632519 mainfont: TeX Gyre Pagella
@@ -1669,7 +2525,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16692525`microtypeoptions`
16702526: options to pass to the microtype package
16712527
1672−### Links
2528+#### Links
16732529
16742530`colorlinks`
16752531: add color to link text; automatically enabled if any of
@@ -1684,7 +2540,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16842540`links-as-notes`
16852541: causes links to be printed as footnotes
16862542
1687−### Front matter
2543+#### Front matter
16882544
16892545`lof`, `lot`
16902546: include list of figures, list of tables
@@ -1693,12 +2549,13 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
16932549: contents of acknowledgments footnote after document title
16942550
16952551`toc`
1696−: 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`)
16972554
16982555`toc-depth`
16992556: level of section to include in table of contents
17002557
1701−### BibLaTeX Bibliographies
2558+#### BibLaTeX Bibliographies
17022559
17032560These variables function when using BibLaTeX for [citation rendering].
17042561
@@ -1718,7 +2575,7 @@ These variables function when using BibLaTeX for [citation rendering].
17182575: list of options for natbib
17192576
17202577[KOMA-Script]: https://ctan.org/pkg/koma-script
1721−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
17222579[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
17232580[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
17242581[`article`]: https://ctan.org/pkg/article
@@ -1727,8 +2584,7 @@ These variables function when using BibLaTeX for [citation rendering].
17272584[`memoir`]: https://ctan.org/pkg/memoir
17282585[`report`]: https://ctan.org/pkg/report
17292586
1730−Variables for ConTeXt
1731−---------------------
2587+### Variables for ConTeXt
17322588
17332589Pandoc uses these variables when [creating a PDF] with ConTeXt.
17342590
@@ -1736,12 +2592,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17362592: font size for body text (e.g. `10pt`, `12pt`)
17372593
17382594`headertext`, `footertext`
1739−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1740− 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
17412597
17422598`indenting`
1743−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1744− repeat for multiple options
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
17452601
17462602`interlinespace`
17472603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -1752,16 +2608,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17522608 repeat for multiple options
17532609
17542610`linkcolor`, `contrastcolor`
1755−: 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])
17562613
17572614`linkstyle`
1758−: 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`
17592617
17602618`lof`, `lot`
17612619: include list of figures, list of tables
17622620
17632621`mainfont`, `sansfont`, `monofont`, `mathfont`
1764−: 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])
17652624
17662625`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
17672626: sets margins, if `layout` is not used (otherwise `layout`
@@ -1776,18 +2635,41 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
17762635 repeat for multiple options
17772636
17782637`pdfa`
1779−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1780− To successfully generate PDF/A the required ICC color profiles have to
1781− be available and the content and all included files (such as images)
1782− have to be standard conforming. The ICC profiles can be obtained
1783− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1784− 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.
17852662
17862663`toc`
1787−: 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`)
17882666
17892667`whitespace`
1790−: 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
17912673
17922674[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
17932675[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
@@ -1801,8 +2683,7 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
18012683[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
18022684[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
18032685
1804−Variables for `wkhtmltopdf`
1805−---------------------------
2686+### Variables for `wkhtmltopdf`
18062687
18072688Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
18082689The `--css` option also affects the output.
@@ -1816,8 +2697,7 @@ The `--css` option also affects the output.
18162697`papersize`
18172698: sets the PDF paper size
18182699
1819−Variables for man pages
1820−-----------------------
2700+### Variables for man pages
18212701
18222702`adjusting`
18232703: adjusts text to left (`l`), right (`r`), center (`c`),
@@ -1835,8 +2715,7 @@ Variables for man pages
18352715`section`
18362716: section number in man pages
18372717
1838−Variables for ms
1839−----------------
2718+### Variables for ms
18402719
18412720`fontfamily`
18422721: font family (e.g. `T` or `P`)
@@ -1850,8 +2729,7 @@ Variables for ms
18502729`pointsize`
18512730: point size (e.g. `10p`)
18522731
1853−Structural variables
1854−--------------------
2732+### Variables set automatically
18552733
18562734Pandoc sets these variables automatically in response to [options] or
18572735document contents; users can also modify them. These vary depending
@@ -1891,9 +2769,9 @@ on the output format, and include the following:
18912769
18922770`sourcefile`, `outputfile`
18932771: source and destination filenames, as given on the command line.
1894− `sourcefile` can also be a list if input comes from multiple files, or empty
1895− if input is from stdin. You can use the following snippet in your template
1896− 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:
18972775
18982776 $if(sourcefile)$
18992777 $for(sourcefile)$
@@ -1915,82 +2793,11 @@ on the output format, and include the following:
19152793
19162794`toc-title`
19172795: title of table of contents (works only with EPUB,
1918− opendocument, odt, docx, pptx, beamer, LaTeX)
1919−
1920−Using variables in templates
1921−----------------------------
1922−
1923−Variable names are sequences of alphanumerics, `-`, and `_`,
1924−starting with a letter. A variable name surrounded by `$` signs
1925−will be replaced by its value. For example, the string `$title$` in
1926−
1927− <title>$title$</title>
1928−
1929−will be replaced by the document title.
1930−
1931−To write a literal `$` in a template, use `$$`.
1932−
1933−Templates may contain conditionals. The syntax is as follows:
1934−
1935− $if(variable)$
1936− X
1937− $else$
1938− Y
1939− $endif$
1940−
1941−This will include `X` in the template if `variable` has a truthy
1942−value; otherwise it will include `Y`. Here a truthy value is any
1943−of the following:
1944−
1945−- a string that is not entirely white space,
1946−- a non-empty array where the first value is truthy,
1947−- any number (including zero),
1948−- any object,
1949−- the boolean `true` (to specify the boolean `true`
1950− value using YAML metadata or the `--metadata` flag,
1951− use `true`, `True`, or `TRUE`; with the `--variable`
1952− flag, simply omit a value for the variable, e.g.
1953− `--variable draft`).
1954−
1955−`X` and `Y` are placeholders for any valid template text,
1956−and may include interpolated variables or other conditionals.
1957−The `$else$` section may be omitted.
1958−
1959−When variables can have multiple values (for example, `author` in
1960−a multi-author document), you can use the `$for$` keyword:
1961−
1962− $for(author)$
1963− <meta name="author" content="$author$" />
1964− $endfor$
1965−
1966−You can optionally specify a separator to be used between
1967−consecutive items:
1968−
1969− $for(author)$$author$$sep$, $endfor$
1970−
1971−Note that the separator needs to be specified immediately before the `$endfor`
1972−keyword.
1973−
1974−A dot can be used to select a field of a variable that takes
1975−an object as its value. So, for example:
1976−
1977− $author.name$ ($author.affiliation$)
1978−
1979−The value of a variable will be indented to the same level as the variable.
1980−
1981−If you use custom templates, you may need to revise them as pandoc
1982−changes. We recommend tracking the changes in the default templates,
1983−and modifying your custom templates accordingly. An easy way to do this
1984−is to fork the [pandoc-templates] repository and merge in changes after each
1985−pandoc release.
1986−
1987−Templates may contain comments: anything on a line after `$--`
1988−will be treated as a comment and ignored.
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
19892797
19902798[pandoc-templates]: https://github.com/jgm/pandoc-templates
19912799
1992−Extensions
1993−==========
2800+# Extensions
19942801
19952802The behavior of some of the readers and writers can be adjusted by
19962803enabling or disabling various extensions.
@@ -2011,8 +2818,7 @@ Note that markdown extensions added to the `ipynb` format
20112818affect Markdown cells in Jupyter notebooks (as do command-line
20122819options like `--atx-headers`).
20132820
2014−Typography
2015−----------
2821+## Typography
20162822
20172823#### Extension: `smart` ####
20182824
@@ -2044,8 +2850,7 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
20442850to use the ligatures when possible; if `smart` is disabled
20452851pandoc will use unicode quotation mark and dash characters.
20462852
2047−Headings and sections
2048−---------------------
2853+## Headings and sections
20492854
20502855#### Extension: `auto_identifiers` ####
20512856
@@ -2126,9 +2931,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
21262931GitHub's method. Spaces are converted to dashes (`-`),
21272932uppercase characters to lowercase characters, and punctuation
21282933characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
21292935
2130−Math Input
2131−----------
2936+## Math Input
21322937
21332938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
21342939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2138,59 +2943,47 @@ are described in the section about Pandoc's Markdown.
21382943However, they can also be used with HTML input. This is handy for
21392944reading web pages formatted using MathJax, for example.
21402945
2141−Raw HTML/TeX
2142−------------
2143−
2144−The following extensions (especially how they affect Markdown
2145−input/output) are also described in more detail in their respective
2146−sections of [Pandoc's Markdown].
2946+## Raw HTML/TeX
21472947
2148−#### Extension: `raw_html` {#raw_html}
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
21492950
2150−When converting from HTML, parse elements to raw HTML which are not
2151−representable in pandoc's AST.
2152−By default, this is disabled for HTML input.
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.
21532954
2154−#### Extension: `raw_tex` {#raw_tex}
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`):
21552958
2156−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
21572962
2158−This extension can be enabled/disabled for the following formats
2159−(in addition to `markdown`):
2963+ output formats
2964+ : `textile`, `commonmark`
21602965
2161−input formats
2162−: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2163− `\eqref` only), `ipynb`
2164−
2165−output formats
2166−: `textile`, `commonmark`
2167−
2168−Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2169−only raw TeX in markdown cells, but data with mime type
2170−`text/html` in output cells. Since the `ipynb` reader attempts
2171−to preserve the richest possible outputs when several options
2172−are given, you will get best results if you disable `raw_html`
2173−and `raw_tex` when converting to formats like `docx` which don't
2174−allow raw `html` or `tex`.
2175−
2176−#### Extension: `native_divs` {#native_divs}
2177−
2178−This extension is enabled by default for HTML input. This means that
2179−`div`s are parsed to pandoc native elements. (Alternatively, you
2180−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2181−
2182−When converting HTML to Markdown, for example, you may want to drop all
2183−`div`s and `span`s:
2184−
2185− pandoc -f html-native_divs-native_spans -t markdown
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`.
21862973
2187−#### Extension: `native_spans` {#native_spans}
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`.
21882978
2189−Analogous to `native_divs` above.
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`.
21902985
2191−
2192−Literate Haskell support
2193−------------------------
2986+## Literate Haskell support
21942987
21952988#### Extension: `literate_haskell` ####
21962989
@@ -2251,8 +3044,7 @@ Note that GHC expects the bird tracks in the first column, so indented
22513044literate code blocks (e.g. inside an itemized environment) will not be
22523045picked up by the Haskell compiler.
22533046
2254−Other extensions
2255−----------------
3047+## Other extensions
22563048
22573049#### Extension: `empty_paragraphs` ####
22583050
@@ -2267,15 +3059,62 @@ input formats
22673059output formats
22683060: `docx`, `odt`, `opendocument`, `html`
22693061
2270−#### Extension: `styles` #### {#ext-styles}
3062+#### Extension: `native_numbering` ####
22713063
2272−When converting from docx, read all docx styles as divs (for
2273−paragraph styles) and spans (for character styles) regardless
2274−of whether pandoc understands the meaning of these styles.
2275−This can be used with [docx custom styles](#custom-styles).
2276−Disabled by default.
3064+Enables native numbering of figures and tables. Enumeration
3065+starts at 1.
22773066
2278−input formats
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+
3109+#### Extension: `styles` #### {#ext-styles}
3110+
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.
3116+
3117+input formats
22793118: `docx`
22803119
22813120#### Extension: `amuse` ####
@@ -2283,22 +3122,36 @@ input formats
22833122In the `muse` input format, this enables Text::Amuse
22843123extensions to Emacs Muse markup.
22853124
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+
22863133#### Extension: `citations` {#org-citations}
22873134
2288−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2289−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.
22903144
22913145#### Extension: `ntb` ####
22923146
22933147In the `context` output format this enables the use of [Natural Tables
2294−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2295−[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).
22963150Natural tables allow more fine-grained global customization but come
22973151at a performance penalty compared to extreme tables.
22983152
22993153
2300−Pandoc's Markdown
2301−=================
3154+# Pandoc's Markdown
23023155
23033156Pandoc understands an extended and slightly revised version of
23043157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2308,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
23083161behavior more granularly. They are described in the following. See also
23093162[Extensions] above, for extensions that work also on other formats.
23103163
2311−Philosophy
2312−----------
3164+## Philosophy
23133165
23143166Markdown is designed to be easy to write, and, even more importantly,
23153167easy to read:
@@ -2317,7 +3169,7 @@ easy to read:
23173169> A Markdown-formatted document should be publishable as-is, as plain
23183170> text, without looking like it's been marked up with tags or formatting
23193171> instructions.
2320−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
23213173
23223174This principle has guided pandoc's decisions in finding syntax for
23233175tables, footnotes, and other extensions.
@@ -2330,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
23303182important document elements like definition lists, tables, mathematics, and
23313183footnotes.
23323184
2333−Paragraphs
2334−----------
3185+## Paragraphs
23353186
23363187A paragraph is one or more lines of text followed by one or more blank lines.
23373188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2344,8 +3195,7 @@ Note: in multiline and grid table cells, this is the only way
23443195to create a hard line break, since trailing spaces in the cells
23453196are ignored.
23463197
2347−Headings
2348−--------
3198+## Headings
23493199
23503200There are two kinds of headings: Setext and ATX.
23513201
@@ -2398,7 +3248,8 @@ pandoc does require the space.
23983248
23993249### Heading identifiers ###
24003250
2401−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
24023253
24033254#### Extension: `header_attributes` ####
24043255
@@ -2423,7 +3274,7 @@ Note that although this syntax allows assignment of classes and key/value
24233274attributes, writers generally don't use all of this information. Identifiers,
24243275classes, and key/value attributes are used in HTML and HTML-based formats such
24253276as EPUB and slidy. Identifiers are used for labels and link anchors in the
2426−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
24273278
24283279Headings with the class `unnumbered` will not be numbered, even if
24293280`--number-sections` is specified. A single hyphen (`-`) in an attribute
@@ -2436,6 +3287,11 @@ is just the same as
24363287
24373288 # My heading {.unnumbered}
24383289
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.)
3294+
24393295#### Extension: `implicit_header_references` ####
24403296
24413297Pandoc behaves as if reference links have been defined for each heading.
@@ -2476,8 +3332,7 @@ link will point to `bar`, not to `#foo`:
24763332
24773333 See [foo]
24783334
2479−Block quotations
2480−----------------
3335+## Block quotations
24813336
24823337Markdown uses email conventions for quoting blocks of text.
24833338A block quotation is one or more paragraphs or other block elements
@@ -2516,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
25163371
25173372#### Extension: `blank_before_blockquote` ####
25183373
2519−Standard Markdown syntax does not require a blank line before a block
2520−quote. Pandoc does require this (except, of course, at the beginning of the
2521−document). The reason for the requirement is that it is all too easy for a
2522−`>` to end up at the beginning of a line by accident (perhaps through line
2523−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
25243380not produce a nested block quote in pandoc:
25253381
25263382 > This is a block quote.
25273383 >> Nested.
25283384
25293385
2530−Verbatim (code) blocks
2531−----------------------
3386+## Verbatim (code) blocks
25323387
25333388### Indented code blocks ###
25343389
@@ -2590,14 +3445,16 @@ this syntax:
25903445 qsort (filter (>= x) xs)
25913446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25923447
2593−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2594−`startFrom` is an attribute with value `100`. Some output formats can use this
2595−information to do syntax highlighting. Currently, the only output formats
2596−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2597−highlighting is supported for your output format and language, then the code
2598−block above will appear highlighted, with numbered lines. (To see which
2599−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2600−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:
26013458
26023459 <pre id="mycode" class="haskell numberLines" startFrom="100">
26033460 <code>
@@ -2634,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
26343491For more information on highlighting, see [Syntax highlighting],
26353492below.
26363493
2637−Line blocks
2638−-----------
3494+## Line blocks
26393495
26403496#### Extension: `line_blocks` ####
26413497
@@ -2661,10 +3517,12 @@ line must begin with a space.
26613517 | 200 Main St.
26623518 | Berkeley, CA 94718
26633519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
26643523This syntax is borrowed from [reStructuredText].
26653524
2666−Lists
2667−-----
3525+## Lists
26683526
26693527### Bullet lists ###
26703528
@@ -2865,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
28653723A definition begins with a colon or tilde, which may be indented one
28663724or two spaces.
28673725
2868−A term may have multiple definitions, and each definition may consist of one or
2869−more block elements (paragraph, code block, list, etc.), each indented four
2870−spaces or one tab stop. The body of the definition (including the first line,
2871−aside from the colon or tilde) should be indented four spaces. However,
2872−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
28733732at the beginning of a paragraph or other block element:
28743733
28753734 Term 1
@@ -2895,9 +3754,10 @@ definition:
28953754Note that space between items in a definition list is required.
28963755(A variant that loosens this requirement, but disallows "lazy"
28973756hard wrapping, can be activated with `compact_definition_lists`: see
2898−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
28993758
2900−[^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/).
29013761
29023762### Numbered example lists ###
29033763
@@ -2933,30 +3793,6 @@ list marker. That is, example lists always behave as if the
29333793labels tend to be long, and indenting content to the
29343794first non-space character after the label would be awkward.
29353795
2936−### Compact and loose lists ###
2937−
2938−Pandoc behaves differently from `Markdown.pl` on some "edge
2939−cases" involving lists. Consider this source:
2940−
2941− + First
2942− + Second:
2943− - Fee
2944− - Fie
2945− - Foe
2946−
2947− + Third
2948−
2949−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2950−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2951−"Second" and "Third" (but not "First"), because of the blank space
2952−around "Third". Pandoc follows a simple rule: if the text is followed by
2953−a blank line, it is treated as a paragraph. Since "Second" is followed
2954−by a list, and not a blank line, it isn't treated as a paragraph. The
2955−fact that the list is followed by a blank line is irrelevant. (Note:
2956−Pandoc works this way even when the `markdown_strict` format is specified. This
2957−behavior is consistent with the official Markdown syntax description,
2958−even though it is different from that of `Markdown.pl`.)
2959−
29603796
29613797### Ending a list ###
29623798
@@ -2995,8 +3831,7 @@ of one big list:
29953831 2. dos
29963832 3. tres
29973833
2998−Horizontal rules
2999−----------------
3834+## Horizontal rules
30003835
30013836A line containing a row of three or more `*`, `-`, or `_` characters
30023837(optionally separated by spaces) produces a horizontal rule:
@@ -3006,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
30063841 ---------------
30073842
30083843
3009−Tables
3010−------
3844+## Tables
30113845
30123846Four kinds of tables may be used. The first three kinds presuppose the use of
30133847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3134,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
31343968omitted for a headerless table. The cells of grid tables may contain
31353969arbitrary block elements (multiple paragraphs, code blocks, lists,
31363970etc.). Cells that span multiple columns or rows are not
3137−supported. Grid tables can be created easily using [Emacs table mode].
3138−
3139−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
31403973
31413974Alignments can be specified as with pipe tables, by putting
31423975colons at the boundaries of the separator line after the
@@ -3164,7 +3997,7 @@ and the same number of rows in each column. For example, the
31643997Docutils [sample grid tables] will not render as expected with
31653998Pandoc.
31663999
3167−[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
31684001
31694002
31704003#### Extension: `pipe_tables` ####
@@ -3197,7 +4030,7 @@ legal (though ugly) pipe table:
31974030
31984031The cells of pipe tables cannot contain block elements like paragraphs
31994032and lists, and cannot span multiple lines. If a pipe table contains a
3200−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
32014034`--columns`), then the table will take up the full text width and
32024035the cell contents will wrap, with the relative cell widths determined
32034036by the number of dashes in the line separating the table header from
@@ -3221,8 +4054,7 @@ you'll need to add colons as above.
32214054
32224055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
32234056
3224−Metadata blocks
3225−---------------
4057+## Metadata blocks
32264058
32274059#### Extension: `pandoc_title_block` ####
32284060
@@ -3238,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
32384070or all three elements. If you want to include an author but no
32394071title, or a title and a date but no author, you need a blank line:
32404072
3241− %
3242− % Author
4073+```
4074+%
4075+% Author
4076+```
32434077
3244− % My title
3245− %
3246− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
32474083
32484084The title may occupy multiple lines, but continuation lines must
32494085begin with leading space, thus:
32504086
3251− % My title
3252− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
32534091
32544092If a document has multiple authors, the authors may be put on
32554093separate lines with leading space, or separated by semicolons, or
32564094both. So, all of the following are equivalent:
32574095
3258− % Author One
3259− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
32604100
3261− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
32624104
3263− % Author One;
3264− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
32654109
32664110The date must fit on one line.
32674111
@@ -3302,7 +4146,7 @@ will also have "Version 4.0" in the header.
33024146
33034147#### Extension: `yaml_metadata_block` ####
33044148
3305−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
33064150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
33074151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
33084152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3325,20 +4169,22 @@ given a role by external processors.) Field names must not be
33254169interpretable as YAML numbers or boolean values (so, for
33264170example, `yes`, `True`, and `15` cannot be used as field names).
33274171
3328−A document may contain multiple metadata blocks. The metadata fields will
3329−be combined through a *left-biased union*: if two metadata blocks attempt
3330−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.
33314175
33324176When pandoc is used with `-t markdown` to create a Markdown document,
33334177a YAML metadata block will be produced only if the `-s/--standalone`
33344178option is used. All of the metadata will appear in a single block
33354179at the beginning of the document.
33364180
3337−Note that YAML escaping rules must be followed. Thus, for example,
3338−if a title contains a colon, it must be quoted. The pipe character
3339−(`|`) can be used to begin an indented block that will be interpreted
3340−literally, without need for escaping. This form is necessary
3341−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:
33424188
33434189 ---
33444190 title: 'This is the title: it contains a colon'
@@ -3352,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
33524198 It consists of two paragraphs.
33534199 ...
33544200
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+
33554207Template variables will be set automatically from the metadata. Thus, for
33564208example, in writing HTML, the variable `abstract` will be set to the HTML
33574209equivalent of the Markdown in the `abstract` field:
@@ -3398,8 +4250,25 @@ will be interpreted as markdown. For example:
33984250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
33994251 ```
34004252
3401−Backslash escapes
3402−-----------------
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
34034272
34044273#### Extension: `all_symbols_escapable` ####
34054274
@@ -3425,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
34254294(However, if the `markdown_strict` format is used, the standard Markdown rule
34264295will be used.)
34274296
3428−A backslash-escaped space is parsed as a nonbreaking space. It will
3429−appear in TeX output as `~` and in HTML and XML as `\ ` or
3430−`\ `.
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).
34314303
34324304A backslash-escaped newline (i.e. a backslash occurring at the end of
34334305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3437,8 +4309,7 @@ two trailing spaces on a line.
34374309
34384310Backslash escapes do not work in verbatim contexts.
34394311
3440−Inline formatting
3441−-----------------
4312+## Inline formatting
34424313
34434314### Emphasis ###
34444315
@@ -3486,12 +4357,13 @@ text by `~` characters. Thus, for example,
34864357
34874358 H~2~O is a liquid. 2^10^ is 1024.
34884359
3489−If the superscripted or subscripted text contains spaces, these spaces
3490−must be escaped with backslashes. (This is to prevent accidental
3491−superscripting and subscripting through the ordinary use of `~` and `^`.)
3492−Thus, if you want the letter P with 'a cat' in subscripts, use
3493−`P~a\ cat~`, not `P~a cat~`.
3494−
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~`.
34954367
34964368### Verbatim ###
34974369
@@ -3540,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
35404412This will work in all output formats that support small caps.
35414413
35424414
3543−Math
3544−----
4415+## Math
35454416
35464417#### Extension: `tex_math_dollars` ####
35474418
@@ -3553,6 +4424,10 @@ left, and must not be followed immediately by a digit. Thus,
35534424you need to enclose text in literal `$` characters, backslash-escape
35544425them and they won't be treated as math delimiters.
35554426
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+
35564431TeX math will be printed in all output formats. How it is rendered
35574432depends on the output format:
35584433
@@ -3580,7 +4455,7 @@ AsciiDoc
35804455Texinfo
35814456 ~ It will be rendered inside a `@math` command.
35824457
3583−roff man
4458+roff man, Jira markup
35844459 ~ It will be rendered verbatim without `$`'s.
35854460
35864461MediaWiki, DokuWiki
@@ -3614,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
36144489 command-line options selected. Therefore see [Math rendering in HTML]
36154490 above.
36164491
3617−[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
36184493
3619−Raw HTML
3620−--------
4494+## Raw HTML
36214495
36224496#### Extension: `raw_html` ####
36234497
@@ -3655,7 +4529,7 @@ Thus, for example, pandoc will turn
36554529 <table>
36564530 <tr>
36574531 <td>*one*</td>
3658− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
36594533 </tr>
36604534 </table>
36614535
@@ -3664,14 +4538,14 @@ into
36644538 <table>
36654539 <tr>
36664540 <td><em>one</em></td>
3667− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
36684542 </tr>
36694543 </table>
36704544
36714545whereas `Markdown.pl` will preserve it as is.
36724546
3673−There is one exception to this rule: text between `<script>` and
3674−`<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.
36754549
36764550This departure from standard Markdown should make it easier to mix
36774551Markdown with HTML block elements. For example, one can surround
@@ -3763,8 +4637,7 @@ example, to use a raw attribute with a backtick code block,
37634637
37644638The raw attribute cannot be combined with regular attributes.
37654639
3766−LaTeX macros
3767−------------
4640+## LaTeX macros
37684641
37694642#### Extension: `latex_macros` ####
37704643
@@ -3785,11 +4658,13 @@ When `latex_macros` is disabled, the raw LaTeX and math will
37854658not have macros applied. This is usually a better approach when
37864659you are targeting LaTeX or PDF.
37874660
3788−Whether or not `latex_macros` is enabled, the macro definitions
3789−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.
37904666
3791−Links
3792−-----
4667+## Links
37934668
37944669Markdown allows links to be specified in several ways.
37954670
@@ -3798,7 +4673,7 @@ Markdown allows links to be specified in several ways.
37984673If you enclose a URL or email address in pointy brackets, it
37994674will become a link:
38004675
3801− <http://google.com>
4676+ <https://google.com>
38024677 <sam@green.eggs.ham>
38034678
38044679### Inline links ###
@@ -3808,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
38084683be followed by a link title, in quotes.)
38094684
38104685 This is an [inline link](/url), and here's [one with
3811− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
38124687
38134688There can be no space between the bracketed part and the parenthesized part.
38144689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3837,7 +4712,7 @@ Here are some examples:
38374712
38384713 [my label 1]: /foo/bar.html "My title, optional"
38394714 [my label 2]: /foo
3840− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
38414716 [my label 4]: /bar#special 'A title in single quotes'
38424717
38434718The URL may optionally be surrounded by angle brackets:
@@ -3846,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
38464721
38474722The title may go on the next line:
38484723
3849− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
38504725 "The free software foundation"
38514726
38524727Note that link labels are not case sensitive. So, this will work:
@@ -3897,8 +4772,7 @@ or
38974772Internal links are currently supported for HTML formats (including
38984773HTML slide shows and EPUB), LaTeX, and ConTeXt.
38994774
3900−Images
3901−------
4775+## Images
39024776
39034777A link immediately preceded by a `!` will be treated as an image.
39044778The link text will be used as the image's alt text:
@@ -3944,10 +4818,11 @@ Attributes can be set on links and images:
39444818(This syntax is compatible with [PHP Markdown Extra] when only `#id`
39454819and `.class` are used.)
39464820
3947−For HTML and EPUB, all attributes except `width` and `height` (but
3948−including `srcset` and `sizes`) are passed through as is. The other
3949−writers ignore attributes that are not supported by their output
3950−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.
39514826
39524827The `width` and `height` attributes on images are treated specially. When
39534828used without a unit, the unit is assumed to be pixels. However, any of
@@ -3959,10 +4834,12 @@ For example:
39594834{ width=50% }
39604835```
39614836
3962−- Dimensions are converted to inches for output in page-based formats like
3963− LaTeX. Dimensions are converted to pixels for output in HTML-like
3964− formats. Use the `--dpi` option to specify the number of pixels per
3965− 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).
39664843- The `%` unit is generally relative to some available space.
39674844 For example the above example will render to the following.
39684845 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -3971,14 +4848,13 @@ For example:
39714848 as in the default template.)
39724849 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
39734850- Some output formats have a notion of a class
3974− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
39754852 or a unique identifier (LaTeX `\caption`), or both (HTML).
39764853- When no `width` or `height` attributes are specified, the fallback
39774854 is to look at the image resolution and the dpi metadata embedded in
39784855 the image file.
39794856
3980−Divs and Spans
3981−--------------
4857+## Divs and Spans
39824858
39834859Using the `native_divs` and `native_spans` extensions
39844860(see [above][Extension: `native_divs`]), HTML syntax can
@@ -4034,8 +4910,7 @@ followed immediately by attributes:
40344910
40354911 [This is *some text*]{.class key="val"}
40364912
4037−Footnotes
4038−---------
4913+## Footnotes
40394914
40404915#### Extension: `footnotes` ####
40414916
@@ -4081,143 +4956,72 @@ they cannot contain multiple paragraphs). The syntax is as follows:
40814956
40824957Inline and regular footnotes may be mixed freely.
40834958
4084−Citations
4085−---------
4959+## Citation syntax
40864960
40874961#### Extension: `citations` ####
40884962
4089−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4090−citations and a bibliography in a number of styles. Basic usage is
4091−
4092− pandoc --filter pandoc-citeproc myinput.txt
4093−
4094−In order to use this feature, you will need to specify a bibliography file
4095−using the `bibliography` metadata field in a YAML metadata section, or
4096−`--bibliography` command line argument. You can supply multiple `--bibliography`
4097−arguments or set `bibliography` metadata field to YAML array, if you want to
4098−use multiple bibliography files. The bibliography may have any of these
4099−formats:
4100−
4101− Format File extension
4102− ------------ --------------
4103− BibLaTeX .bib
4104− BibTeX .bibtex
4105− Copac .copac
4106− CSL JSON .json
4107− CSL YAML .yaml
4108− EndNote .enl
4109− EndNote XML .xml
4110− ISI .wos
4111− MEDLINE .medline
4112− MODS .mods
4113− RIS .ris
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:
41144966
4115−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4116−use `.bibtex` to force BibTeX.
4967+ Blah blah [@doe99; @smith2000; @smith2004].
41174968
4118−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4119−can produce `.json` and `.yaml` files from any of the supported formats.
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
41204971
4121−In-field markup: In BibTeX and BibLaTeX databases,
4122−pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4123−databases, pandoc Markdown; and in CSL JSON databases, an
4124−[HTML-like markup][CSL markup specs]:
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
41254973
4126−`<i>...</i>`
4127−: italics
4974+In a footnote style, it might render as
41284975
4129−`<b>...</b>`
4130−: bold
4976+ Blah blah.[^1]
41314977
4132−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4133−: small capitals
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).
41344981
4135−`<sub>...</sub>`
4136−: subscript
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
41374984
4138−`<sup>...</sup>`
4139−: superscript
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]`.
41404994
4141−`<span class="nocase">...</span>`
4142−: prevent a phrase from being capitalized as title case
4995+Citation items may optionally include a prefix, a locator, and
4996+a suffix. In
41434997
4144−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4145−and CSL YAML formats as far as possible.
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
41464999
4147−As an alternative to specifying a bibliography file using `--bibliography`
4148−or the YAML metadata field `bibliography`, you can include
4149−the citation data directly in the `references` field of the
4150−document's YAML metadata. The field should contain an array of
4151−YAML-encoded references, for example:
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.
41525003
4153− ---
4154− references:
4155− - type: article-journal
4156− id: WatsonCrick1953
4157− author:
4158− - family: Watson
4159− given: J. D.
4160− - family: Crick
4161− given: F. H. C.
4162− issued:
4163− date-parts:
4164− - - 1953
4165− - 4
4166− - 25
4167− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4168− nucleic acid'
4169− title-short: Molecular structure of nucleic acids
4170− container-title: Nature
4171− volume: 171
4172− issue: 4356
4173− page: 737-738
4174− DOI: 10.1038/171737a0
4175− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4176− language: en-GB
4177− ...
4178−
4179−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4180−of the supported formats.)
4181−
4182−Citations and references can be formatted using any style supported by the
4183−[Citation Style Language], listed in the [Zotero Style Repository].
4184−These files are specified using the `--csl` option or the `csl` metadata field.
4185−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4186−format. The CSL project provides further information on [finding and editing styles].
4187−
4188−To make your citations hyperlinks to the corresponding bibliography
4189−entries, add `link-citations: true` to your YAML metadata.
4190−
4191−Citations go inside square brackets and are separated by semicolons.
4192−Each citation must have a key, composed of '@' + the citation
4193−identifier from the database, and may optionally have a prefix,
4194−a locator, and a suffix. The citation key must begin with a letter, digit,
4195−or `_`, and may contain alphanumerics, `_`, and internal punctuation
4196−characters (`:.#$%&-+?<>~/`). Here are some examples:
4197−
4198− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4199−
4200− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4201−
4202− Blah blah [@smith04; @doe99].
4203−
4204−`pandoc-citeproc` detects locator terms in the [CSL locale files].
4205−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4206−locale, locator terms can be written in either singular or plural forms,
4207−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4208−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4209−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4210−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4211−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4212−`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
42135016locator term is used, "page" is assumed.
42145017
4215−`pandoc-citeproc` will use heuristics to distinguish the locator
4216−from the suffix. In complex cases, the locator can be enclosed
4217−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:
42185021
42195022 [@smith{ii, A, D-Z}, with a suffix]
42205023 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
42215025
42225026A minus sign (`-`) before the `@` will suppress mention of
42235027the author in the citation. This can be useful when the
@@ -4225,83 +5029,103 @@ author is already mentioned in the text:
42255029
42265030 Smith says blah [-@smith04].
42275031
4228−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:
42295034
42305035 @smith04 says blah.
42315036
42325037 @smith04 [p. 33] says blah.
42335038
4234−If the style calls for a list of works cited, it will be placed
4235−in a div with id `refs`, if one exists:
4236−
4237− ::: {#refs}
4238− :::
4239−
4240−Otherwise, it will be placed at the end of the document.
4241−Generation of the bibliography can be suppressed by setting
4242−`suppress-bibliography: true` in the YAML metadata.
4243−
4244−If you wish the bibliography to have a section heading, you can
4245−set `reference-section-title` in the metadata, or put the heading
4246−at the beginning of the div with id `refs` (if you are using it)
4247−or at the end of your document:
4248−
4249− last paragraph...
4250−
4251− # References
4252−
4253−The bibliography will be inserted after this heading. Note that
4254−the `unnumbered` class will be added to this heading, so that the
4255−section will not be numbered.
4256−
4257−If you want to include items in the bibliography without actually
4258−citing them in the body text, you can define a dummy `nocite` metadata
4259−field and put the citations there:
4260−
4261− ---
4262− nocite: |
4263− @item1, @item2
4264− ...
4265−
4266− @item3
4267−
4268−In this example, the document will contain a citation for `item3`
4269−only, but the bibliography will contain entries for `item1`, `item2`, and
4270−`item3`.
4271−
4272−It is possible to create a bibliography with all the citations,
4273−whether or not they appear in the document, by using a wildcard:
4274−
4275− ---
4276− nocite: |
4277− @*
4278− ...
4279−
4280−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4281−render the bibliography. In order to do so, specify bibliography
4282−files as outlined above, and add `--natbib` or `--biblatex`
4283−argument to `pandoc` invocation. Bear in mind that bibliography
4284−files have to be in respective format (either BibTeX or
4285−BibLaTeX).
4286−
4287−For more information, see the [pandoc-citeproc man page].
4288−
4289−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4290−[Chicago Manual of Style]: http://chicagomanualofstyle.org
4291−[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
42925056[Zotero Style Repository]: https://www.zotero.org/styles
42935057[finding and editing styles]: https://citationstyles.org/authors/
42945058[CSL locale files]: https://github.com/citation-style-language/locales
4295−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
42965059
4297−Non-pandoc extensions
4298−---------------------
5060+## Non-default extensions
42995061
43005062The following Markdown syntax extensions are not enabled by default
43015063in pandoc, but may be enabled by adding `+EXTENSION` to the format
43025064name, where `EXTENSION` is the name of the extension. Thus, for
43035065example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
43045066
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+
43055129#### Extension: `old_dashes` ####
43065130
43075131Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -4414,7 +5238,7 @@ and image references. This extension should not be confused with the
44145238
44155239 This is a reference ![image][ref] with multimarkdown attributes.
44165240
4417− [ref]: http://path.to/image "Image title" width=20px height=30px
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
44185242 id=myId class="myClass1 myClass2"
44195243
44205244#### Extension: `mmd_header_identifiers` ####
@@ -4449,60 +5273,390 @@ in several respects:
44495273 we must either disallow lazy wrapping or require a blank line between
44505274 list items.
44515275
4452−Markdown variants
4453−-----------------
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
44545292
44555293In addition to pandoc's extended Markdown, the following Markdown
44565294variants are supported:
44575295
4458−`markdown_phpextra` (PHP Markdown Extra)
4459−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4460− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4461− `header_attributes`, `link_attributes`, `abbreviations`,
4462− `shortcut_reference_links`, `spaced_reference_links`.
4463−
4464−`markdown_github` (deprecated GitHub-Flavored Markdown)
4465−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4466− `gfm_auto_identifiers`, `backtick_code_blocks`,
4467− `autolink_bare_uris`, `space_in_atx_header`,
4468− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4469− `shortcut_reference_links`, `angle_brackets_escapable`,
4470− `lists_without_preceding_blankline`.
4471−
4472−`markdown_mmd` (MultiMarkdown)
4473−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4474− `tex_math_double_backslash`, `intraword_underscores`,
4475− `mmd_title_block`, `footnotes`, `definition_lists`,
4476− `all_symbols_escapable`, `implicit_header_references`,
4477− `auto_identifiers`, `mmd_header_identifiers`,
4478− `shortcut_reference_links`, `implicit_figures`,
4479− `superscript`, `subscript`, `backtick_code_blocks`,
4480− `spaced_reference_links`, `raw_attribute`.
4481−
4482−`markdown_strict` (Markdown.pl)
4483−: `raw_html`, `shortcut_reference_links`,
4484− `spaced_reference_links`.
4485−
4486−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4487−which is implemented as a set of extensions on `commonmark`).
4488−
4489−Note, however, that `commonmark` and `gfm` have limited support
4490−for extensions. Only those listed below (and `smart`,
4491−`raw_tex`, and `hard_line_breaks`) will work. The extensions
4492−can, however, all be individually disabled. Also, `raw_tex`
4493−only affects `gfm` output, not input.
4494−
4495−`gfm` (GitHub-Flavored Markdown)
4496−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4497− `gfm_auto_identifiers`, `backtick_code_blocks`,
4498− `autolink_bare_uris`, `space_in_atx_header`,
4499− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4500− `shortcut_reference_links`, `angle_brackets_escapable`,
4501− `lists_without_preceding_blankline`.
4502−
4503−
4504−Producing slide shows with pandoc
4505−=================================
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
45065660
45075661You can use pandoc to produce an HTML + JavaScript slide presentation
45085662that can be viewed via a web browser. There are five ways to do this,
@@ -4550,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
45505704
45515705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
45525706
4553−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4554−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4555−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4556−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4557−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4558−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4559−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4560−the file by default.
4561−
4562−With all HTML slide formats, the `--self-contained` option can be used to
4563−produce a single file that contains all of the data necessary to display the
4564−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.
45655722
45665723To produce a PDF slide show using beamer, type
45675724
@@ -4574,8 +5731,7 @@ To produce a Powerpoint slide show, type
45745731
45755732 pandoc habits.txt -o habits.pptx
45765733
4577−Structuring the slide show
4578−--------------------------
5734+## Structuring the slide show
45795735
45805736By default, the *slide level* is the highest heading level in
45815737the hierarchy that is followed immediately by content, and not another
@@ -4592,7 +5748,11 @@ rules:
45925748 * A heading at the slide level always starts a new slide.
45935749
45945750 * Headings *below* the slide level in the hierarchy create
4595− headings *within* a slide.
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
45965756
45975757 * Headings *above* the slide level in the hierarchy create
45985758 "title slides," which just contain the section title
@@ -4616,8 +5776,7 @@ layout will be produced, with level-1 headings building horizontally
46165776and level-2 headings building vertically. It is not recommended that
46175777you use deeper nesting of section levels with reveal.js.
46185778
4619−Incremental lists
4620−-----------------
5779+## Incremental lists
46215780
46225781By default, these writers produce lists that display "all at once."
46235782If you want your lists to display incrementally (one item at a time),
@@ -4655,8 +5814,10 @@ option):
46555814Both methods allow incremental and nonincremental lists to be mixed
46565815in a single document.
46575816
4658−Inserting pauses
4659−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
46605821
46615822You can add "pauses" within a slide by including a paragraph containing
46625823three dots, separated by spaces:
@@ -4669,8 +5830,9 @@ three dots, separated by spaces:
46695830
46705831 content after the pause
46715832
4672−Styling the slides
4673−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
46745836
46755837You can change the style of HTML slides by putting customized CSS files
46765838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4705,8 +5867,7 @@ bibliographies:
47055867
47065868 # References {.allowframebreaks}
47075869
4708−Speaker notes
4709−-------------
5870+## Speaker notes
47105871
47115872Speaker notes are supported in reveal.js and PowerPoint (pptx)
47125873output. You can add notes to your Markdown document thus:
@@ -4727,8 +5888,7 @@ in handouts and presenter view.
47275888Notes are not yet supported for other slide formats, but the notes
47285889will not appear on the slides themselves.
47295890
4730−Columns
4731−-------
5891+## Columns
47325892
47335893To put material in side by side columns, you can use a native
47345894div container with class `columns`, containing two or more div
@@ -4743,8 +5903,42 @@ containers with class `column` and a `width` attribute:
47435903 :::
47445904 ::::::::::::::
47455905
4746−Frame attributes in beamer
4747−--------------------------
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
47485942
47495943Sometimes it is necessary to add the LaTeX `[fragile]` option to
47505944a frame in beamer (for example, when using the `minted` environment).
@@ -4758,10 +5952,9 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
47585952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
47595953`shrink`, `standout`, `noframenumbering`.
47605954
4761−Background in reveal.js and beamer
4762−----------------------------------
5955+## Background in reveal.js and beamer
47635956
4764−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
47655958to beamer slideshows.
47665959
47675960For the same image on every slide, use the configuration
@@ -4769,9 +5962,9 @@ option `background-image` either in the YAML metadata block
47695962or as a command-line variable. (There are no other options in
47705963beamer and the rest of this section concerns reveal.js slideshows.)
47715964
4772−For reveal.js, you can instead use the reveal.js-native option
4773−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4774−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
47755968`parallaxBackgroundSize` to have your values take effect.
47765969
47775970To set an image for a particular reveal.js slide, add
@@ -4785,9 +5978,12 @@ Other reveal.js background settings also work on individual slides, including
47855978`data-background-size`, `data-background-repeat`, `data-background-color`,
47865979`data-transition`, and `data-transition-speed`.
47875980
4788−See the [reveal.js
4789−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4790−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.
47915987
47925988For example in reveal.js:
47935989
@@ -4795,6 +5991,9 @@ For example in reveal.js:
47955991---
47965992title: My Slideshow
47975993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
47985997---
47995998
48005999## Slide One
@@ -4806,11 +6005,9 @@ Slide 1 has background_image.png as its background.
48066005Slide 2 has a special image for its background, even though the heading has no content.
48076006```
48086007
4809−Creating EPUBs with pandoc
4810−==========================
6008+# EPUBs
48116009
4812−EPUB Metadata
4813−-------------
6010+## EPUB Metadata
48146011
48156012EPUB metadata may be specified using the `--epub-metadata` option, but
48166013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4888,6 +6085,15 @@ The following fields are recognized:
48886085
48896086`rights`
48906087 ~ 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.
48916097
48926098`cover-image`
48936099 ~ A string value (path to cover image).
@@ -4909,11 +6115,10 @@ The following fields are recognized:
49096115 - `binding`: `true`|`false` (default `true`)
49106116 - `scroll-axis`: `vertical`|`horizontal`|`default`
49116117
4912−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
49136119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
49146120
4915−The `epub:type` attribute
4916−-------------------------
6121+## The `epub:type` attribute
49176122
49186123For `epub3` output, you can mark up the heading that corresponds to an EPUB
49196124chapter using the [`epub:type` attribute][epub-type]. For example, to set
@@ -4938,22 +6143,26 @@ abstract frontmatter
49386143acknowledgments frontmatter
49396144copyright-page frontmatter
49406145dedication 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
49416156foreword frontmatter
4942−halftitle, frontmatter
4943−introduction frontmatter
49446157preface frontmatter
4945−seriespage frontmatter
4946−titlepage frontmatter
4947−afterword backmatter
49486158appendix backmatter
49496159colophon backmatter
4950−conclusion backmatter
4951−epigraph backmatter
6160+bibliography backmatter
6161+index backmatter
49526162
49536163[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
49546164
4955−Linked media
4956−------------
6165+## Linked media
49576166
49586167By default, pandoc will download media referenced from any `<img>`, `<audio>`,
49596168`<video>` or `<source>` element present in the generated EPUB,
@@ -4963,13 +6172,12 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
49636172with the `src` attribute. For example:
49646173
49656174 <audio controls="1">
4966− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
49676176 data-external="1" type="audio/mpeg">
49686177 </source>
49696178 </audio>
49706179
4971−Creating Jupyter notebooks with pandoc
4972−======================================
6180+# Jupyter notebooks
49736181
49746182When creating a [Jupyter notebook], pandoc will try to infer the
49756183notebook structure. Code blocks with the class `code` will be
@@ -5094,8 +6302,7 @@ soft line breaks in Markdown cells; `--atx-headers` will
50946302cause ATX-style headings to be used; and `--preserve-tabs` will
50956303prevent tabs from being turned to spaces.
50966304
5097−Syntax highlighting
5098−===================
6305+# Syntax highlighting
50996306
51006307Pandoc will automatically highlight syntax in [fenced code blocks] that
51016308are marked with a language name. The Haskell library [skylighting] is
@@ -5123,7 +6330,7 @@ Then edit `my.theme` and use it like this:
51236330If you are not satisfied with the built-in highlighting, or you
51246331want highlight a language that isn't supported, you can use the
51256332`--syntax-definition` option to load a [KDE-style XML syntax definition
5126−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
51276334Before writing your own, have a look at KDE's [repository of syntax
51286335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
51296336
@@ -5131,13 +6338,11 @@ To disable highlighting, use the `--no-highlight` option.
51316338
51326339[skylighting]: https://github.com/jgm/skylighting
51336340
5134−Custom Styles
5135−=============
6341+# Custom Styles
51366342
51376343Custom styles can be used in the docx and ICML formats.
51386344
5139−Output
5140−------
6345+## Output
51416346
51426347By default, pandoc's docx and ICML output applies a predefined set of styles
51436348for blocks such as paragraphs and block quotes, and uses largely default
@@ -5148,8 +6353,10 @@ styles, pandoc allows you to define custom styles for blocks and text
51486353using `div`s and `span`s, respectively.
51496354
51506355If you define a `div` or `span` with the attribute `custom-style`,
5151−pandoc will apply your specified style to the contained elements. So,
5152−for example using the `bracketed_spans` syntax,
6356+pandoc will apply your specified style to the contained elements (with
6357+the exception of elements whose function depends on a style, like
6358+headings, code blocks, block quotes, or links). So, for example, using
6359+the `bracketed_spans` syntax,
51536360
51546361 [Get out]{custom-style="Emphatically"}, he said.
51556362
@@ -5180,10 +6387,9 @@ custom-style `span`.
51806387For docx output, you don't need to enable any extensions for
51816388custom styles to work.
51826389
5183−[pandoc filters]: http://pandoc.org/filters.html
6390+[pandoc filters]: https://pandoc.org/filters.html
51846391
5185−Input
5186−-----
6392+## Input
51876393
51886394The docx reader, by default, only reads those styles that it can
51896395convert into pandoc elements, either by direct conversion or
@@ -5212,17 +6418,17 @@ And with the extension:
52126418
52136419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
52146420
5215− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
52166422 This is some text.
52176423 :::
52186424
5219− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
52206426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
52216427 And this is text with a [strengthened]{custom-style="Strengthened"}
52226428 text style.
52236429 :::
52246430
5225− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
52266432 > Here is a styled paragraph that inherits from Block Text.
52276433 :::
52286434
@@ -5230,27 +6436,47 @@ With these custom styles, you can use your input document as a
52306436reference-doc while creating docx output (see below), and maintain the
52316437same styles in your input and output files.
52326438
5233−Custom writers
5234−==============
6439+# Custom writers
52356440
5236−Pandoc can be extended with custom writers written in [lua]. (Pandoc
5237−includes a lua interpreter, so lua need not be installed separately.)
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
52386443
5239−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
52406445in place of the output format. For example:
52416446
52426447 pandoc -t data/sample.lua
52436448
5244−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
52456450possible element in a pandoc document. To get a documented example
52466451which you can modify according to your needs, do
52476452
52486453 pandoc --print-default-data-file sample.lua
52496454
5250−[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).
52516478
5252−A note on security
5253−==================
6479+# A note on security
52546480
52556481If you use pandoc to convert user-contributed content in a web
52566482application, here are some things to keep in mind:
@@ -5265,7 +6491,7 @@ application, here are some things to keep in mind:
52656491 shelling out to the executable), it is possible to use it in a mode
52666492 that fully isolates pandoc from your file system, by running the
52676493 pandoc operations in the `PandocPure` monad. See the document
5268− [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)
52696495 for more details.
52706496
527164973. Pandoc's parsers can exhibit pathological performance on some
@@ -5278,17 +6504,17 @@ application, here are some things to keep in mind:
527865044. The HTML generated by pandoc is not guaranteed to be safe.
52796505 If `raw_html` is enabled for the Markdown input, users can
52806506 inject arbitrary HTML. Even if `raw_html` is disabled,
5281− users can include dangerous content in attributes for
5282− headings, spans, and code blocks. To be safe, you should
5283− 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.
52846510
5285−Authors
5286−=======
6511+# Authors
52876512
5288−Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
52896514under the [GPL], version 2 or greater. This software carries no
52906515warranty of any kind. (See COPYRIGHT for full copyright and
52916516warranty notices.) For a full list of contributors, see the file
52926517AUTHORS.md in the pandoc source code.
52936518
5294−[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"