@@ -1,14 +1,14 @@
1−---
2−title: Pandoc User's Guide
3−author: John MacFarlane
4−date: June 20, 2021
5−---
1+% Pandoc User's Guide
2+% John MacFarlane
3+% November 25, 2018
64
7−# Synopsis
5+Synopsis
6+========
87
98`pandoc` [*options*] [*input-file*]...
109
11−# Description
10+Description
11+===========
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
1414another, and a command-line tool that uses this library.
@@ -40,7 +40,8 @@ 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
43+Using pandoc
44+------------
4445
4546If no *input-files* are specified, input is read from *stdin*.
4647Output goes to *stdout* by default. For output to a file,
@@ -61,7 +62,8 @@ If multiple input files are given, `pandoc` will concatenate them all (with
6162blank lines between them) before parsing. (Use `--file-scope` to parse files
6263individually.)
6364
64−## Specifying formats
65+Specifying formats
66+------------------
6567
6668The format of the input and output can be specified explicitly using
6769command-line options. The input format can be specified using the
@@ -93,7 +95,8 @@ If no input file is specified (so that input comes from *stdin*), or
9395if the input files' extensions are unknown, the input format will
9496be assumed to be Markdown.
9597
96−## Character encoding
98+Character encoding
99+------------------
97100
98101Pandoc uses the UTF-8 character encoding for both input and output.
99102If your local character encoding is not UTF-8, you
@@ -106,9 +109,10 @@ RTF, OPML, DocBook, and Texinfo), information about
106109the character encoding is included in the document header, which
107110will only be included if you use the `-s/--standalone` option.
108111
109−[`iconv`]: https://www.gnu.org/software/libiconv/
112+[`iconv`]: http://www.gnu.org/software/libiconv/
110113
111−## Creating a PDF
114+Creating a PDF
115+--------------
112116
113117To produce a PDF, specify an output file with a `.pdf` extension:
114118
@@ -116,18 +120,20 @@ To produce a PDF, specify an output file with a `.pdf` extension:
116120
117121By default, pandoc will use LaTeX to create the PDF, which requires
118122that a LaTeX engine be installed (see `--pdf-engine` below).
119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120−intermediate format. To do this, specify an output file with a
121−`.pdf` extension, as before, but add the `--pdf-engine` option
122−or `-t context`, `-t html`, or `-t ms` to the command line.
123−The tool used to generate the PDF from the intermediate format
124−may be specified using `--pdf-engine`.
125−
126−You can control the PDF style using variables, depending on
127−the intermediate format used: see [variables for LaTeX],
128−[variables for ConTeXt], [variables for `wkhtmltopdf`],
129−[variables for ms]. When HTML is used as an intermediate
130−format, the output can be styled using `--css`.
123+
124+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126+[`weasyprint`] or [`prince`].
127+To do this, specify an output file with a `.pdf` extension, as before,
128+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
130+
131+PDF output can be controlled using [variables for LaTeX] (if
132+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
133+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
134+If `wkhtmltopdf` is used, then the variables `margin-left`,
135+`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
136+`header-html` and `papersize` will affect the output.
131137
132138To debug the PDF creation, it can be useful to look at the intermediate
133139representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -136,32 +142,33 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136142When using LaTeX, the following packages need to be available
137143(they are included with all recent versions of [TeX Live]):
138144[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`iftex`], [`listings`] (if the
145+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140146`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
147+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
142148contains images), [`hyperref`], [`xcolor`],
143149[`ulem`], [`geometry`] (with the `geometry` variable set),
144150[`setspace`] (with `linestretch`), and
145151[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146−the PDF engine requires [`fontspec`]. `lualatex` uses
147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149−`mathspec` variable is set, `xelatex` will use [`mathspec`]
150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151−packages are used if available, and [`csquotes`] will be used
152−for [typography] if the `csquotes` variable or metadata field is
153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154−and [`biber`] packages can optionally be used for [citation
155−rendering]. The following packages will be used to improve
156−output quality if present, but pandoc does not require them to
157−be present: [`upquote`] (for straight quotes in verbatim
158−environments), [`microtype`] (for better spacing adjustments),
159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160−better line breaks in URLs), [`bookmark`] (for better PDF
161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162−footnotes in tables).
163−
164−[TeX Live]: https://www.tug.org/texlive/
152+the PDF engine requires [`fontspec`]. `xelatex` uses
153+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
154+`dir` variable set). If the `mathspec` variable is set,
155+`xelatex` will use [`mathspec`] instead of [`unicode-math`].
156+The [`upquote`] and [`microtype`] packages are used if
157+available, and [`csquotes`] will be used for [typography]
158+if `\usepackage{csquotes}` is present in the template or
159+included via `/H/--include-in-header`. The [`natbib`],
160+[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
161+be used for [citation rendering]. The following packages
162+will be used to improve output quality if present, but
163+pandoc does not require them to be present:
164+[`upquote`] (for straight quotes in verbatim environments),
165+[`microtype`] (for better spacing adjustments),
166+[`parskip`] (for better inter-paragraph spaces),
167+[`xurl`] (for better line breaks in URLs),
168+[`bookmark`] (for better PDF bookmarks),
169+and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
170+
171+[TeX Live]: http://www.tug.org/texlive/
165172[`amsfonts`]: https://ctan.org/pkg/amsfonts
166173[`amsmath`]: https://ctan.org/pkg/amsmath
167174[`babel`]: https://ctan.org/pkg/babel
@@ -180,7 +187,8 @@ footnotes in tables).
180187[`graphicx`]: https://ctan.org/pkg/graphicx
181188[`grffile`]: https://ctan.org/pkg/grffile
182189[`hyperref`]: https://ctan.org/pkg/hyperref
183−[`iftex`]: https://ctan.org/pkg/iftex
190+[`ifluatex`]: https://ctan.org/pkg/ifluatex
191+[`ifxetex`]: https://ctan.org/pkg/ifxetex
184192[`listings`]: https://ctan.org/pkg/listings
185193[`lm`]: https://ctan.org/pkg/lm
186194[`longtable`]: https://ctan.org/pkg/longtable
@@ -194,44 +202,41 @@ footnotes in tables).
194202[`ulem`]: https://ctan.org/pkg/ulem
195203[`unicode-math`]: https://ctan.org/pkg/unicode-math
196204[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
205+[`weasyprint`]: http://weasyprint.org
198206[`wkhtmltopdf`]: https://wkhtmltopdf.org
199207[`xcolor`]: https://ctan.org/pkg/xcolor
200208[`xecjk`]: https://ctan.org/pkg/xecjk
201209[`xurl`]: https://ctan.org/pkg/xurl
202−[`selnolig`]: https://ctan.org/pkg/selnolig
203210
204211
205212
206−## Reading from the Web
213+Reading from the Web
214+--------------------
207215
208−Instead of an input file, an absolute URI may be given. In this case
216+Instead of an input file, an absolute URI may be given. In this case
209217pandoc will fetch the content using HTTP:
210218
211− pandoc -f html -t markdown https://www.fsf.org
219+ pandoc -f html -t markdown http://www.fsf.org
212220
213221It is possible to supply a custom User-Agent string or other
214222header when requesting a document from a URL:
215223
216224 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217− https://www.fsf.org
225+ http://www.fsf.org
218226
219−# Options
227+Options
228+=======
220229
221−## General options {.options}
230+General options {.options}
231+---------------
222232
223233`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224234
225235: Specify input format. *FORMAT* can be:
226236
227237 ::: {#input-formats}
228− - `bibtex` ([BibTeX] bibliography)
229− - `biblatex` ([BibLaTeX] bibliography)
230238 - `commonmark` ([CommonMark] Markdown)
231− - `commonmark_x` ([CommonMark] Markdown with extensions)
232239 - `creole` ([Creole 1.0])
233− - `csljson` ([CSL JSON] bibliography)
234− - `csv` ([CSV] table)
235240 - `docbook` ([DocBook])
236241 - `docx` ([Word docx])
237242 - `dokuwiki` ([DokuWiki markup])
@@ -243,9 +248,7 @@ header when requesting a document from a URL:
243248 if you need extensions not supported in [`gfm`](#markdown-variants).
244249 - `haddock` ([Haddock markup])
245250 - `html` ([HTML])
246− - `ipynb` ([Jupyter notebook])
247251 - `jats` ([JATS] XML)
248− - `jira` ([Jira]/Confluence wiki markup)
249252 - `json` (JSON version of native AST)
250253 - `latex` ([LaTeX])
251254 - `markdown` ([Pandoc's Markdown])
@@ -278,14 +281,10 @@ header when requesting a document from a URL:
278281: Specify output format. *FORMAT* can be:
279282
280283 ::: {#output-formats}
281− - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
284+ - `asciidoc` ([AsciiDoc])
282285 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283− - `bibtex` ([BibTeX] bibliography)
284− - `biblatex` ([BibLaTeX] bibliography)
285286 - `commonmark` ([CommonMark] Markdown)
286− - `commonmark_x` ([CommonMark] Markdown with extensions)
287287 - `context` ([ConTeXt])
288− - `csljson` ([CSL JSON] bibliography)
289288 - `docbook` or `docbook4` ([DocBook] 4)
290289 - `docbook5` (DocBook 5)
291290 - `docx` ([Word docx])
@@ -301,12 +300,7 @@ header when requesting a document from a URL:
301300 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302301 - `html4` ([XHTML] 1.0 Transitional)
303302 - `icml` ([InDesign ICML])
304− - `ipynb` ([Jupyter notebook])
305− - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306− - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307− - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308− - `jats` (alias for `jats_archiving`)
309− - `jira` ([Jira]/Confluence wiki markup)
303+ - `jats` ([JATS] XML)
310304 - `json` (JSON version of native AST)
311305 - `latex` ([LaTeX])
312306 - `man` ([roff man])
@@ -322,7 +316,6 @@ header when requesting a document from a URL:
322316 - `opml` ([OPML])
323317 - `opendocument` ([OpenDocument])
324318 - `org` ([Emacs Org mode])
325− - `pdf` ([PDF])
326319 - `plain` (plain text),
327320 - `pptx` ([PowerPoint] slide show)
328321 - `rst` ([reStructuredText])
@@ -335,12 +328,11 @@ header when requesting a document from a URL:
335328 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336329 - `s5` ([S5] HTML and JavaScript slide show)
337330 - `tei` ([TEI Simple])
338− - `xwiki` ([XWiki markup])
339331 - `zimwiki` ([ZimWiki markup])
340− - the path of a custom Lua writer, see [Custom writers] below
332+ - the path of a custom lua writer, see [Custom writers] below
341333 :::
342334
343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
335+ Note that `odt`, `docx`, and `epub` output will not be directed
344336 to *stdout* unless forced with `-o -`.
345337
346338 Extensions can be individually enabled or
@@ -358,32 +350,23 @@ header when requesting a document from a URL:
358350
359351: Specify the user data directory to search for pandoc data files.
360352 If this option is not specified, the default user data directory
361− will be used. On \*nix and macOS systems this will be the `pandoc`
362− subdirectory of the XDG data directory (by default,
363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364− environment variable). If that directory does not exist and
365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366− On Windows the default user data directory is
367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.
353+ will be used. This is, in UNIX:
354+
355+ $HOME/.pandoc
356+
357+ in Windows XP:
358+
359+ C:\Documents And Settings\USERNAME\Application Data\pandoc
360+
361+ and in Windows Vista or later:
362+
363+ C:\Users\USERNAME\AppData\Roaming\pandoc
364+
368365 You can find the default user data directory on your system by
369366 looking at the output of `pandoc --version`.
370− Data files placed in this directory (for example, `reference.odt`,
371− `reference.docx`, `epub.css`, `templates`) will override
372− pandoc's normal defaults.
373−
374−`-d` *FILE*, `--defaults=`*FILE*
375−
376−: Specify a set of default option settings. *FILE* is a YAML
377− file whose fields correspond to command-line option
378− settings. All options for document conversion, including input
379− and output files, can be set using a defaults file. The file will
380− be searched for first in the working directory, and then in
381− the `defaults` subdirectory of the user data directory
382− (see `--data-dir`). The `.yaml` extension may be omitted.
383− See the section [Default files] for more information on the
384− file format. Settings from the defaults file may be
385− overridden or extended by subsequent options on the command
386− line.
367+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
368+ `slidy`, `slideous`, or `s5` directory
369+ placed in this directory will override pandoc's normal defaults.
387370
388371`--bash-completion`
389372
@@ -394,7 +377,8 @@ header when requesting a document from a URL:
394377
395378`--verbose`
396379
397−: Give verbose debugging output.
380+: Give verbose debugging output. Currently this only has an effect
381+ with PDF output.
398382
399383`--quiet`
400384
@@ -420,7 +404,7 @@ header when requesting a document from a URL:
420404
421405`--list-extensions`[`=`*FORMAT*]
422406
423−: List supported extensions for *FORMAT*, one per line, preceded
407+: List supported extensions, one per line, preceded
424408 by a `+` or `-` indicating whether it is enabled by default
425409 in *FORMAT*. If *FORMAT* is not specified, defaults for
426410 pandoc's Markdown are given.
@@ -443,88 +427,62 @@ header when requesting a document from a URL:
443427
444428: Show usage message.
445429
446−[Markdown]: https://daringfireball.net/projects/markdown/
447−[CommonMark]: https://commonmark.org
430+[Markdown]: http://daringfireball.net/projects/markdown/
431+[CommonMark]: http://commonmark.org
448432[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449433[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450−[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451−[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452−[S5]: https://meyerweb.com/eric/tools/s5/
453−[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454−[Slideous]: https://goessner.net/articles/slideous/
455−[HTML]: https://www.w3.org/html/
456−[HTML5]: https://html.spec.whatwg.org/
434+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
435+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
436+[S5]: http://meyerweb.com/eric/tools/s5/
437+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
438+[Slideous]: http://goessner.net/articles/slideous/
439+[HTML]: http://www.w3.org/html/
440+[HTML5]: http://www.w3.org/TR/html5/
457441[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458−[XHTML]: https://www.w3.org/TR/xhtml1/
459−[LaTeX]: https://www.latex-project.org/
442+[XHTML]: http://www.w3.org/TR/xhtml1/
443+[LaTeX]: http://latex-project.org
460444[`beamer`]: https://ctan.org/pkg/beamer
461−[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462−[ConTeXt]: https://www.contextgarden.net/
463−[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464−[DocBook]: https://docbook.org
445+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
446+[ConTeXt]: http://www.contextgarden.net/
447+[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
448+[DocBook]: http://docbook.org
465449[JATS]: https://jats.nlm.nih.gov
466−[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467−[txt2tags]: https://txt2tags.org
450+[txt2tags]: http://txt2tags.org
468451[EPUB]: http://idpf.org/epub
469452[OPML]: http://dev.opml.org/spec2.html
470453[OpenDocument]: http://opendocument.xml.org
471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472−[Textile]: https://www.promptworks.com/textile
454+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
455+[Textile]: http://redcloth.org/textile
473456[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474457[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476−[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
458+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
459+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478460[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479461[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480462[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481−[CSV]: https://tools.ietf.org/html/rfc4180
482−[roff man]: https://man.cx/groff_man(7)
483−[roff ms]: https://man.cx/groff_ms(7)
463+[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
464+[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
484465[Haskell]: https://www.haskell.org
485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486−[Emacs Org mode]: https://orgmode.org
487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488−[AsciiDoctor]: https://asciidoctor.org/
489−[DZSlides]: https://paulrouget.com/dzslides/
466+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
467+[Emacs Org mode]: http://orgmode.org
468+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
469+[DZSlides]: http://paulrouget.com/dzslides/
490470[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491471[PDF]: https://www.adobe.com/pdf/
492−[reveal.js]: https://revealjs.com/
472+[reveal.js]: http://lab.hakim.se/reveal-js/
493473[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494−[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495−[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
474+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496475[TEI Simple]: https://github.com/TEIC/TEI-Simple
497476[Muse]: https://amusewiki.org/library/manual
498477[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499478[Vimwiki]: https://vimwiki.github.io
500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501−[BibTeX]: https://ctan.org/pkg/bibtex
502−[BibLaTeX]: https://ctan.org/pkg/biblatex
503−
504−## Reader options {.options}
505−
506−`--shift-heading-level-by=`*NUMBER*
507−
508−: Shift heading levels by a positive or negative integer.
509− For example, with `--shift-heading-level-by=-1`, level 2
510− headings become level 1 headings, and level 3 headings
511− become level 2 headings. Headings cannot have a level
512− less than 1, so a heading that would be shifted below level 1
513− becomes a regular paragraph. Exception: with a shift of -N,
514− a level-N heading at the beginning of the document
515− replaces the metadata title. `--shift-heading-level-by=-1`
516− is a good choice when converting HTML or Markdown documents that
517− use an initial level-1 heading for the document title and
518− level-2+ headings for sections. `--shift-heading-level-by=1`
519− may be a good choice for converting Markdown documents that
520− use level-1 headings for sections to HTML, since pandoc uses
521− a level-1 heading to render the document title.
479+
480+Reader options {.options}
481+--------------
522482
523483`--base-header-level=`*NUMBER*
524484
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
527− (defaults to 1).
485+: Specify the base level for headers (defaults to 1).
528486
529487`--strip-empty-paragraphs`
530488
@@ -589,32 +547,41 @@ header when requesting a document from a URL:
589547
590548 3. `$PATH` (executable only)
591549
592− Filters, Lua-filters, and citeproc processing are applied in
593− the order specified on the command line.
550+ Filters and lua-filters are applied in the order specified
551+ on the command line.
594552
595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
553+`--lua-filter=`*SCRIPT*
596554
597555: Transform the document in a similar fashion as JSON filters (see
598− `--filter`), but use pandoc's built-in Lua filtering system. The given
599− Lua script is expected to return a list of Lua filters which will be
600− applied in order. Each Lua filter must contain element-transforming
556+ `--filter`), but use pandoc's build-in lua filtering system. The given
557+ lua script is expected to return a list of lua filters which will be
558+ applied in order. Each lua filter must contain element-transforming
601559 functions indexed by the name of the AST element on which the filter
602560 function should be applied.
603561
604− The `pandoc` Lua module provides helper functions for element
605− creation. It is always loaded into the script's Lua environment.
562+ The `pandoc` lua module provides helper functions for element
563+ creation. It is always loaded into the script's lua environment.
606564
607− See the [Lua filters documentation] for further details.
565+ The following is an example lua script for macro-expansion:
608566
609− In order of preference, pandoc will look for Lua filters in
567+ function expand_hello_world(inline)
568+ if inline.c == '{{helloworld}}' then
569+ return pandoc.Emph{ pandoc.Str "Hello, World" }
570+ else
571+ return inline
572+ end
573+ end
610574
611− 1. a specified full or relative path
575+ return {{Str = expand_hello_world}}
612576
613− 2. `$DATADIR/filters` where `$DATADIR` is the user data
614− directory (see `--data-dir`, above).
577+ In order of preference, pandoc will look for lua filters in
578+
579+ 1. a specified full or relative path (executable or
580+ non-executable)
615581
616− Filters, Lua filters, and citeproc processing are applied in
617− the order specified on the command line.
582+ 2. `$DATADIR/filters` (executable or non-executable)
583+ where `$DATADIR` is the user data directory (see
584+ `--data-dir`, above).
618585
619586`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620587
@@ -631,23 +598,19 @@ header when requesting a document from a URL:
631598
632599`--metadata-file=`*FILE*
633600
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.
601+: Read metadata from the supplied YAML (or JSON) file.
602+ This option can be used with every input format, but string
603+ scalars in the YAML file will always be parsed as Markdown.
604+ Generally, the input will be handled the same as in
605+ [YAML metadata blocks][Extension: `yaml_metadata_block`].
606+ Metadata values specified inside the document, or by using `-M`,
607+ overwrite values specified with this option.
644608
645609`-p`, `--preserve-tabs`
646610
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.
611+: Preserve tabs instead of converting them to spaces (the default).
612+ Note that this will only affect tabs in literal code spans and code
613+ blocks; tabs in regular text will be treated as spaces.
651614
652615`--tab-stop=`*NUMBER*
653616
@@ -657,30 +620,30 @@ header when requesting a document from a URL:
657620
658621: Specifies what to do with insertions, deletions, and comments
659622 produced by the MS Word "Track Changes" feature. `accept` (the
660− default) processes all the insertions and deletions.
661− `reject` ignores them. Both `accept` and `reject` ignore comments.
662− `all` includes all insertions, deletions, and comments, wrapped
663− in spans with `insertion`, `deletion`, `comment-start`, and
664− `comment-end` classes, respectively. The author and time of
665− change is included. `all` is useful for scripting: only
666− accepting changes from a certain reviewer, say, or before a
667− certain date. If a paragraph is inserted or deleted,
668− `track-changes=all` produces a span with the class
669− `paragraph-insertion`/`paragraph-deletion` before the
670− affected paragraph break. This option only affects the docx
671− reader.
623+ default), inserts all insertions, and ignores all
624+ deletions. `reject` inserts all deletions and ignores
625+ insertions. Both `accept` and `reject` ignore comments. `all` puts
626+ in insertions, deletions, and comments, wrapped in spans with
627+ `insertion`, `deletion`, `comment-start`, and `comment-end`
628+ classes, respectively. The author and time of change is
629+ included. `all` is useful for scripting: only accepting changes
630+ from a certain reviewer, say, or before a certain date. If a
631+ paragraph is inserted or deleted, `track-changes=all` produces a
632+ span with the class `paragraph-insertion`/`paragraph-deletion`
633+ before the affected paragraph break. This option only affects the
634+ docx reader.
672635
673636`--extract-media=`*DIR*
674637
675638: Extract images and other media contained in or linked from
676639 the source document to the path *DIR*, creating it if
677640 necessary, and adjust the images references in the document
678− so they point to the extracted files. Media are downloaded,
679− read from the file system, or extracted from a binary
680− container (e.g. docx), as needed. The original file paths
681− are used if they are relative paths not containing `..`.
682− Otherwise filenames are constructed from the SHA1 hash of
683− the contents.
641+ so they point to the extracted files. If the source format is
642+ a binary container (docx, epub, or odt), the media is
643+ extracted from the container and the original
644+ filenames are used. Otherwise the media is read from the
645+ file system or downloaded, and new filenames are constructed
646+ based on SHA1 hashes of the contents.
684647
685648`--abbreviations=`*FILE*
686649
@@ -691,17 +654,17 @@ header when requesting a document from a URL:
691654 system default, use
692655 `pandoc --print-default-data-file=abbreviations`. The only
693656 use pandoc makes of this list is in the Markdown reader.
694− Strings found in this list will be followed by a nonbreaking
695− space, and the period will not produce sentence-ending space
696− in formats like LaTeX. The strings may not contain spaces.
657+ Strings ending in a period that are found in this list will
658+ be followed by a nonbreaking space, so that the period will
659+ not produce sentence-ending space in formats like LaTeX.
697660
698661[`pandocfilters`]: https://github.com/jgm/pandocfilters
699662[PHP]: https://github.com/vinai/pandocfilters-php
700663[perl]: https://metacpan.org/pod/Pandoc::Filter
701664[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703665
704−## General writer options {.options}
666+General writer options {.options}
667+----------------------
705668
706669`-s`, `--standalone`
707670
@@ -726,29 +689,22 @@ header when requesting a document from a URL:
726689`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727690
728691: Set the template variable *KEY* to the value *VAL* when rendering the
729− document in standalone mode. If no *VAL* is specified, the
730− key will be given the value `true`.
692+ document in standalone mode. This is generally only useful when the
693+ `--template` option is used to specify a custom template, since
694+ pandoc automatically sets the variables used in the default
695+ templates. If no *VAL* is specified, the key will be given the
696+ value `true`.
731697
732698`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733699
734700: Print the system default template for an output *FORMAT*. (See `-t`
735701 for a list of possible *FORMAT*s.) Templates in the user data
736− directory are ignored. This option may be used with
737− `-o`/`--output` to redirect output to a file, but
738− `-o`/`--output` must come before `--print-default-template`
739− on the command line.
740−
741− Note that some of the default templates use partials, for
742− example `styles.html`. To print the partials, use
743− `--print-default-data-file`: for example,
744− `--print-default-data-file=templates/styles.html`.
702+ directory are ignored.
745703
746704`--print-default-data-file=`*FILE*
747705
748706: Print a system default data file. Files in the user data directory
749− are ignored. This option may be used with `-o`/`--output` to
750− redirect output to a file, but `-o`/`--output` must come before
751− `--print-default-data-file` on the command line.
707+ are ignored.
752708
753709`--eol=crlf`|`lf`|`native`
754710
@@ -759,12 +715,9 @@ header when requesting a document from a URL:
759715
760716`--dpi`=*NUMBER*
761717
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.
718+: Specify the dpi (dots per inch) value for conversion from pixels
719+ to inch/centimeters and vice versa. The default is 96dpi.
720+ Technically, the correct term would be ppi (pixels per inch).
768721
769722`--wrap=auto`|`none`|`preserve`
770723
@@ -777,8 +730,6 @@ header when requesting a document from a URL:
777730 where there are nonsemantic newlines in the source, there
778731 will be nonsemantic newlines in the output as well).
779732 Automatic wrapping does not currently work in HTML output.
780− In `ipynb` output, this option affects wrapping of the
781− contents of markdown cells.
782733
783734`--columns=`*NUMBER*
784735
@@ -795,17 +746,11 @@ header when requesting a document from a URL:
795746 unless `-s/--standalone` is used, and it has no effect
796747 on `man`, `docbook4`, `docbook5`, or `jats` output.
797748
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−
804749`--toc-depth=`*NUMBER*
805750
806751: Specify the number of section levels to include in the table
807− of contents. The default is 3 (which means that level-1, 2, and 3
808− headings will be listed in the contents).
752+ of contents. The default is 3 (which means that level 1, 2, and 3
753+ headers will be listed in the contents).
809754
810755`--strip-comments`
811756
@@ -841,10 +786,7 @@ header when requesting a document from a URL:
841786
842787: Prints a JSON version of a highlighting style, which can
843788 be modified, saved with a `.theme` extension, and used
844− with `--highlight-style`. This option may be used with
845− `-o`/`--output` to redirect output to a file, but
846− `-o`/`--output` must come before `--print-highlight-style`
847− on the command line.
789+ with `--highlight-style`.
848790
849791`--syntax-definition=`*FILE*
850792
@@ -852,10 +794,9 @@ header when requesting a document from a URL:
852794 which will be used for syntax highlighting of appropriately
853795 marked code blocks. This can be used to add support for
854796 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
856− multiple syntax definitions.
797+ existing languages.
857798
858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
799+`-H` *FILE*, `--include-in-header=`*FILE*
859800
860801: Include contents of *FILE*, verbatim, at the end of the header.
861802 This can be used, for example, to include special
@@ -863,7 +804,7 @@ header when requesting a document from a URL:
863804 repeatedly to include multiple files in the header. They will be
864805 included in the order specified. Implies `--standalone`.
865806
866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
807+`-B` *FILE*, `--include-before-body=`*FILE*
867808
868809: Include contents of *FILE*, verbatim, at the beginning of the
869810 document body (e.g. after the `<body>` tag in HTML, or the
@@ -872,7 +813,7 @@ header when requesting a document from a URL:
872813 used repeatedly to include multiple files. They will be included in
873814 the order specified. Implies `--standalone`.
874815
875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
816+`-A` *FILE*, `--include-after-body=`*FILE*
876817
877818: Include contents of *FILE*, verbatim, at the end of the document
878819 body (before the `</body>` tag in HTML, or the
@@ -891,11 +832,11 @@ header when requesting a document from a URL:
891832 will not be searched. For example:
892833 `--resource-path=.:test` will search the working directory
893834 and the `test` subdirectory, in that order.
894− This option can be used repeatedly. Search path components
895− that come later on the command line will be searched before
896− those that come earlier, so
897− `--resource-path foo:bar --resource-path baz:bim` is
898− equivalent to `--resource-path baz:bim:foo:bar`.
835+
836+ `--resource-path` only has an effect if (a) the output
837+ format embeds images (for example, `docx`, `pdf`, or `html`
838+ with `--self-contained`) or (b) it is used together with
839+ `--extract-media`.
899840
900841`--request-header=`*NAME*`:`*VAL*
901842
@@ -905,13 +846,8 @@ header when requesting a document from a URL:
905846 downloaded). If you're behind a proxy, you also need to set
906847 the environment variable `http_proxy` to `http://...`.
907848
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}
849+Options affecting specific writers {.options}
850+----------------------------------
915851
916852`--self-contained`
917853
@@ -936,9 +872,7 @@ header when requesting a document from a URL:
936872
937873`--html-q-tags`
938874
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.)
875+: Use `<q>` tags for quotes in HTML.
942876
943877`--ascii`
944878
@@ -956,45 +890,36 @@ header when requesting a document from a URL:
956890 placement of link references is affected by the
957891 `--reference-location` option.
958892
959−`--reference-location=block`|`section`|`document`
893+`--reference-location = block`|`section`|`document`
960894
961895: Specify whether footnotes (and references, if `reference-links` is
962896 set) are placed at the end of the current (top-level) block, the
963897 current section, or the document. The default is
964898 `document`. Currently only affects the markdown writer.
965899
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−
974900`--atx-headers`
975901
976−: *Deprecated synonym for `--markdown-headings=atx`.*
902+: Use ATX-style headers in Markdown output. The default is
903+ to use setext-style headers for levels 1-2, and then ATX headers.
904+ (Note: for `gfm` output, ATX headers are always used.)
977905
978−`--top-level-division=default`|`section`|`chapter`|`part`
906+`--top-level-division=[default|section|chapter|part]`
979907
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.
908+: Treat top-level headers as the given division type in LaTeX, ConTeXt,
909+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;
910+ all headers are shifted such that the top-level header becomes the specified
911+ type. The default behavior is to determine the best division type via
912+ heuristics: unless other conditions apply, `section` is chosen. When the
913+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the
914+ `article` option is specified), `chapter` is implied as the setting for this
915+ option. If `beamer` is the output format, specifying either `chapter` or
916+ `part` will cause top-level headers to become `\part{..}`, while
917+ second-level headers remain as their default type.
993918
994919`-N`, `--number-sections`
995920
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997− output. By default, sections are not numbered. Sections with class
921+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
922+ By default, sections are not numbered. Sections with class
998923 `unnumbered` will never be numbered, even if `--number-sections`
999924 is specified.
1000925
@@ -1002,10 +927,10 @@ header when requesting a document from a URL:
1002927
1003928: Offset for section headings in HTML output (ignored in other
1004929 output formats). The first number is added to the section number for
1005− top-level headings, the second for second-level headings, and so on.
1006− So, for example, if you want the first top-level heading in your
930+ top-level headers, the second for second-level headers, and so on.
931+ So, for example, if you want the first top-level header in your
1007932 document to be numbered "6", specify `--number-offset=5`.
1008− If your document starts with a level-2 heading which you want to
933+ If your document starts with a level-2 header which you want to
1009934 be numbered "1.5", specify `--number-offset=1,4`.
1010935 Offsets are 0 by default. Implies `--number-sections`.
1011936
@@ -1013,7 +938,7 @@ header when requesting a document from a URL:
1013938
1014939: Use the [`listings`] package for LaTeX code blocks. The package
1015940 does not support multi-byte encoding for source code. To handle UTF-8
1016− you would need to use a custom template. This issue is fully
941+ you would need to use a custom template. This issue is fully
1017942 documented here: [Encoding issue with the listings package].
1018943
1019944`-i`, `--incremental`
@@ -1023,12 +948,12 @@ header when requesting a document from a URL:
1023948
1024949`--slide-level=`*NUMBER*
1025950
1026−: Specifies that headings with the specified level create
1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
951+: Specifies that headers with the specified level create
952+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1028953 above this level in the hierarchy are used to divide the
1029− slide show into sections; headings below this level create
954+ slide show into sections; headers below this level create
1030955 subheads within a slide. Note that content that is
1031− not contained under slide-level headings will not appear in
956+ not contained under slide-level headers will not appear in
1032957 the slide show. The default is to set the slide level based
1033958 on the contents of the document; see [Structuring the slide
1034959 show].
@@ -1037,8 +962,8 @@ header when requesting a document from a URL:
1037962
1038963: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039964 and attach identifiers to the enclosing `<section>` (or `<div>`)
1040− rather than the heading itself. See
1041− [Heading identifiers], below.
965+ rather than the header itself. See
966+ [Header identifiers], below.
1042967
1043968`--email-obfuscation=none`|`javascript`|`references`
1044969
@@ -1059,7 +984,8 @@ header when requesting a document from a URL:
1059984
1060985: Specify *STRING* as a prefix at the beginning of the title
1061986 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
987+ appears at the beginning of the HTML body). Implies
988+ `--standalone`.
1063989
1064990`-c` *URL*, `--css=`*URL*
1065991
@@ -1091,56 +1017,20 @@ header when requesting a document from a URL:
10911017
10921018 To produce a custom `reference.docx`, first get a copy of
10931019 the default `reference.docx`: `pandoc
1094− -o custom-reference.docx --print-default-data-file reference.docx`.
1095− Then open `custom-reference.docx` in Word, modify the
1096− styles as you wish, and save the file. For best
1097− results, do not make changes to this file other than
1098− modifying the styles used by pandoc:
1099−
1100− Paragraph styles:
1101−
1102− - Normal
1103− - Body Text
1104− - First Paragraph
1105− - Compact
1106− - Title
1107− - Subtitle
1108− - Author
1109− - Date
1110− - Abstract
1111− - Bibliography
1112− - Heading 1
1113− - Heading 2
1114− - Heading 3
1115− - Heading 4
1116− - Heading 5
1117− - Heading 6
1118− - Heading 7
1119− - Heading 8
1120− - Heading 9
1121− - Block Text
1122− - Footnote Text
1123− - Definition Term
1124− - Definition
1125− - Caption
1126− - Table Caption
1127− - Image Caption
1128− - Figure
1129− - Captioned Figure
1130− - TOC Heading
1131−
1132− Character styles:
1133−
1134− - Default Paragraph Font
1135− - Body Text Char
1136− - Verbatim Char
1137− - Footnote Reference
1138− - Hyperlink
1139− - Section Number
1140−
1141− Table style:
1142−
1143− - Table
1020+ --print-default-data-file reference.docx >
1021+ custom-reference.docx`. Then open `custom-reference.docx`
1022+ in Word, modify the styles as you wish, and save the file.
1023+ For best results, do not make changes to this file other
1024+ than modifying the styles used by pandoc: [paragraph]
1025+ Normal, Body Text, First Paragraph, Compact, Title,
1026+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1027+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
1028+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1029+ Definition Term, Definition, Caption, Table Caption,
1030+ Image Caption, Figure, Captioned Figure, TOC Heading;
1031+ [character] Default Paragraph Font, Body Text Char,
1032+ Verbatim Char, Footnote Reference, Hyperlink; [table]
1033+ Table.
11441034
11451035 ODT
11461036
@@ -1154,18 +1044,19 @@ header when requesting a document from a URL:
11541044
11551045 To produce a custom `reference.odt`, first get a copy of
11561046 the default `reference.odt`: `pandoc
1157− -o custom-reference.odt --print-default-data-file reference.odt`.
1158− Then open `custom-reference.odt` in LibreOffice, modify
1159− the styles as you wish, and save the file.
1047+ --print-default-data-file reference.odt >
1048+ custom-reference.odt`. Then open `custom-reference.odt` in
1049+ LibreOffice, modify the styles as you wish, and save the
1050+ file.
11601051
11611052 PowerPoint
11621053
1163− : Templates included with Microsoft PowerPoint 2013 (either with
1164− `.pptx` or `.potx` extension) are known to work, as are most
1165− templates derived from these.
1054+ : Any template included with a recent install of Microsoft
1055+ PowerPoint (either with `.pptx` or `.potx` extension) should
1056+ work, as will most templates derived from these.
11661057
1167− The specific requirement is that the template should begin with
1168− the following first four layouts:
1058+ The specific requirement is that the template should contain
1059+ the following four layouts as its first four layouts:
11691060
11701061 1. Title Slide
11711062 2. Title and Content
@@ -1177,10 +1068,10 @@ header when requesting a document from a URL:
11771068 `Home` menu to check.)
11781069
11791070 You can also modify the default `reference.pptx`: first run
1180− `pandoc -o custom-reference.pptx --print-default-data-file
1181− reference.pptx`, and then modify `custom-reference.pptx`
1182− in MS PowerPoint (pandoc will use the first four layout
1183− slides, as mentioned above).
1071+ `pandoc --print-default-data-file reference.pptx >
1072+ custom-reference.pptx`, and then modify
1073+ `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1074+ first four layout slides, as mentioned above).
11841075
11851076`--epub-cover-image=`*FILE*
11861077
@@ -1248,12 +1139,12 @@ header when requesting a document from a URL:
12481139
12491140`--epub-chapter-level=`*NUMBER*
12501141
1251−: Specify the heading level at which to split the EPUB into separate
1252− "chapter" files. The default is to split into chapters at level-1
1253− headings. This option only affects the internal composition of the
1142+: Specify the header level at which to split the EPUB into separate
1143+ "chapter" files. The default is to split into chapters at level 1
1144+ headers. This option only affects the internal composition of the
12541145 EPUB, not the way chapters and sections are displayed to users. Some
12551146 readers may be slow if the chapter files are too large, so for large
1256− documents with few level-1 headings, one might want to use a chapter
1147+ documents with few level 1 headers, one might want to use a chapter
12571148 level of 2 or 3.
12581149
12591150`--epub-subdirectory=`*DIRNAME*
@@ -1262,118 +1153,71 @@ header when requesting a document from a URL:
12621153 the EPUB-specific contents. The default is `EPUB`. To put
12631154 the EPUB contents in the top level, use an empty string.
12641155
1265−`--ipynb-output=all|none|best`
1266−
1267−: Determines how ipynb output cells are treated. `all` means
1268− that all of the data formats included in the original are
1269− preserved. `none` means that the contents of data cells
1270− are omitted. `best` causes pandoc to try to pick the
1271− richest data block in each output cell that is compatible
1272− with the output format. The default is `best`.
1273−
1274−`--pdf-engine=`*PROGRAM*
1156+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
12751157
12761158: Use the specified engine when producing PDF output.
1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279− and `pdfroff`. If the engine is not in your PATH, the full
1280− path of the engine may be specified here. If this option
1281− is not specified, pandoc uses the following defaults
1282− depending on the output format specified using `-t/--to`:
1283−
1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285− `tectonic`, `latexmk`)
1286− - `-t context`: `context`
1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288− see [print-css.rocks](https://print-css.rocks) for a good
1289− introduction to PDF generation from HTML/CSS.)
1290− - `-t ms`: `pdfroff`
1159+ The default is `pdflatex`. If the engine is not in your PATH,
1160+ the full path of the engine may be specified here.
12911161
12921162`--pdf-engine-opt=`*STRING*
12931163
12941164: Use the given string as a command-line argument to the `pdf-engine`.
1295− For example, to use a persistent directory `foo` for `latexmk`'s
1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297− Note that no check for duplicate options is done.
1165+ If used multiple times, the arguments are provided with spaces between
1166+ them. Note that no check for duplicate options is done.
12981167
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1168+[Dublin Core elements]: http://dublincore.org/documents/dces/
1169+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
13011170[Encoding issue with the listings package]:
13021171 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
13031172
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].
1173+Citation rendering {.options}
1174+------------------
13241175
13251176`--bibliography=`*FILE*
13261177
13271178: Set the `bibliography` field in the document's metadata to *FILE*,
1328− overriding any value set in the metadata. If you supply
1329− this argument multiple times, each *FILE* will be added to
1330− bibliography. If *FILE* is a URL, it will be fetched
1331− via HTTP. If *FILE* is not found relative to the
1332− working directory, it will be sought in the resource path
1333− (see `--resource-path`).
1179+ overriding any value set in the metadata, and process citations
1180+ using `pandoc-citeproc`. (This is equivalent to
1181+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1182+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1183+ used, making this equivalent to `--metadata bibliography=FILE`.
1184+ If you supply this argument multiple times, each *FILE* will be added
1185+ to bibliography.
13341186
13351187`--csl=`*FILE*
13361188
13371189: Set the `csl` field in the document's metadata to *FILE*,
13381190 overriding any value set in the metadata. (This is equivalent to
1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340− fetched via HTTP. If *FILE* is not found relative to the
1341− working directory, it will be sought in the resource path
1342− (see `--resource-path`) and finally in the `csl`
1343− subdirectory of the pandoc user data directory.
1191+ `--metadata csl=FILE`.)
1192+ This option is only relevant with `pandoc-citeproc`.
13441193
13451194`--citation-abbreviations=`*FILE*
13461195
13471196: Set the `citation-abbreviations` field in the document's metadata to
13481197 *FILE*, overriding any value set in the metadata. (This is equivalent to
13491198 `--metadata citation-abbreviations=FILE`.)
1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351− found relative to the working directory, it will be sought
1352− in the resource path (see `--resource-path`) and finally in
1353− the `csl` subdirectory of the pandoc user data directory.
1199+ This option is only relevant with `pandoc-citeproc`.
13541200
13551201`--natbib`
13561202
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`].
1203+: Use [`natbib`] for citations in LaTeX output. This option is not for use
1204+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1205+ use in producing a LaTeX file that can be processed with [`bibtex`].
13611206
13621207`--biblatex`
13631208
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`].
1209+: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1210+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1211+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
13681212
1369−## Math rendering in HTML {.options}
1213+Math rendering in HTML {.options}
1214+----------------------
13701215
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.
1216+The default is to render TeX math as far as possible using Unicode characters.
1217+Formulas are put inside a `span` with `class="math"`, so that they may be styled
1218+differently from the surrounding text if needed. However, this gives acceptable
1219+results only for basic math, usually you will want to use `--mathjax` or another
1220+of the following options.
13771221
13781222`--mathjax`[`=`*URL*]
13791223
@@ -1387,11 +1231,10 @@ results only for basic math, usually you will want to use
13871231
13881232`--mathml`
13891233
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.
1234+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1235+ `html4` and `html5`). This is the default in `odt` output. Note that
1236+ currently only Firefox and Safari (and select e-book readers) natively
1237+ support MathML.
13951238
13961239`--webtex`[`=`*URL*]
13971240
@@ -1415,19 +1258,21 @@ results only for basic math, usually you will want to use
14151258`--gladtex`
14161259
14171260: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418− can then be processed by [GladTeX] to produce SVG images of the typeset
1419− formulas and an HTML file with these images embedded.
1261+ can then be processed by [GladTeX] to produce images of the typeset
1262+ formulas and an HTML file with links to these images.
1263+ So, the procedure is:
14201264
14211265 pandoc -s --gladtex input.md -o myfile.htex
1422− gladtex -d image_dir myfile.htex
1423− # produces myfile.html and images in image_dir
1266+ gladtex -d myfile-images myfile.htex
1267+ # produces myfile.html and images in myfile-images
14241268
1425−[MathML]: https://www.w3.org/Math/
1269+[MathML]: http://www.w3.org/Math/
14261270[MathJax]: https://www.mathjax.org
14271271[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
1272+[GladTeX]: http://humenda.github.io/GladTeX/
14291273
1430−## Options for wrapper scripts {.options}
1274+Options for wrapper scripts {.options}
1275+---------------------------
14311276
14321277`--dump-args`
14331278
@@ -1451,277 +1296,8 @@ results only for basic math, usually you will want to use
14511296
14521297 pandoc -o foo.html -s
14531298
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
1299+Templates
1300+=========
17251301
17261302When the `-s/--standalone` option is used, pandoc uses a template to
17271303add header and footer material that is needed for a self-standing
@@ -1741,981 +1317,400 @@ directory (see `--data-dir`, above). *Exceptions:*
17411317 (or the `default.context` template, if you use `-t context`,
17421318 or the `default.ms` template, if you use `-t ms`, or the
17431319 `default.html` template, if you use `-t html`).
1744−- `docx` and `pptx` have no template (however, you can use
1320+- `docx` has no template (however, you can use
17451321 `--reference-doc` to customize the output).
17461322
17471323Templates contain *variables*, which allow for the inclusion of
17481324arbitrary information at any point in the file. They may be set at the
17491325command line using the `-V/--variable` option. If a variable is not set,
1750−pandoc will look for the key in the document's metadata, which can be set
1326+pandoc will look for the key in the document's metadata – which can be set
17511327using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1752−or with the `-M/--metadata` option. In addition, some variables
1753−are given default values by pandoc. See [Variables] below for
1754−a list of variables used in pandoc's default templates.
1328+or with the `--metadata` option.
17551329
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.
1330+Variables set by pandoc
1331+-----------------------
17611332
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1333+Some variables are set automatically by pandoc. These vary somewhat
1334+depending on the output format, but include the following:
17631335
1764−## Template syntax
1336+`sourcefile`, `outputfile`
1337+: source and destination filenames, as given on the command line.
1338+ `sourcefile` can also be a list if input comes from multiple files, or empty
1339+ if input is from stdin. You can use the following snippet in your template
1340+ to distinguish them:
17651341
1766−### Comments
1342+ $if(sourcefile)$
1343+ $for(sourcefile)$
1344+ $sourcefile$
1345+ $endfor$
1346+ $else$
1347+ (stdin)
1348+ $endif$
17671349
1768−Anything between the sequence `$--` and the end of the
1769−line will be treated as a comment and omitted from the output.
1350+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17701351
1771−### Delimiters
1352+`title`, `author`, `date`
1353+: allow identification of basic aspects of the document. Included
1354+ in PDF metadata through LaTeX and ConTeXt. These can be set
1355+ through a [pandoc title block][Extension: `pandoc_title_block`],
1356+ which allows for multiple authors, or through a YAML metadata block:
17721357
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.
1358+ ---
1359+ author:
1360+ - Aristotle
1361+ - Peter Abelard
1362+ ...
17811363
1782−To include a literal `$` in the document, use `$$`.
1364+`subtitle`
1365+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx
17831366
1784−### Interpolated variables
1367+`institute`
1368+: author affiliations (in LaTeX and Beamer only). Can be a
1369+ list, when there are multiple authors.
17851370
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:
1371+`abstract`
1372+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
17911373
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−```
1374+`keywords`
1375+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1376+ may be repeated as for `author`, above
18021377
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.
1378+`header-includes`
1379+: contents specified by `-H/--include-in-header` (may have multiple
1380+ values)
18071381
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.
1382+`toc`
1383+: non-null value if `--toc/--table-of-contents` was specified
18151384
1816−### Conditionals
1385+`toc-title`
1386+: title of table of contents (works only with EPUB,
1387+ opendocument, odt, docx, pptx, beamer, LaTeX)
18171388
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:
1389+`include-before`
1390+: contents specified by `-B/--include-before-body` (may have
1391+ multiple values)
18241392
1825−```
1826−$if(foo)$bar$endif$
1393+`include-after`
1394+: contents specified by `-A/--include-after-body` (may have
1395+ multiple values)
18271396
1828−$if(foo)$
1829− $foo$
1830−$endif$
1397+`body`
1398+: body of document
18311399
1832−$if(foo)$
1833−part one
1834−$else$
1835−part two
1836−$endif$
1400+`meta-json`
1401+: JSON representation of all of the document's metadata. Field
1402+ values are transformed to the selected output format.
18371403
1838−${if(foo)}bar${endif}
1404+Language variables
1405+------------------
18391406
1840−${if(foo)}
1841− ${foo}
1842−${endif}
1407+`lang`
1408+: identifies the main language of the document,
1409+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1410+ For some output formats, pandoc will convert it to an appropriate
1411+ format stored in the additional variables `babel-lang`,
1412+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1413+
1414+ Native pandoc Spans and Divs with the lang attribute
1415+ (value in BCP 47) can be used to switch the language in
1416+ that range. In LaTeX output, `babel-otherlangs` and
1417+ `polyglossia-otherlangs` variables will be generated
1418+ automatically based on the `lang` attributes of Spans
1419+ and Divs in the document.
18431420
1844−${if(foo)}
1845−${ foo.bar }
1846−${else}
1847−no foo!
1848−${endif}
1849−```
1421+`dir`
1422+: the base direction of the document, either `rtl` (right-to-left)
1423+ or `ltr` (left-to-right).
18501424
1851−The keyword `elseif` may be used to simplify complex nested
1852−conditionals:
1425+ For bidirectional documents, native pandoc `span`s and `div`s
1426+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1427+ override the base direction in some output formats.
1428+ This may not always be necessary if the final renderer
1429+ (e.g. the browser, when generating HTML) supports the
1430+ [Unicode Bidirectional Algorithm].
18531431
1854−```
1855−$if(foo)$
1856−XXX
1857−$elseif(bar)$
1858−YYY
1859−$else$
1860−ZZZ
1861−$endif$
1862−```
1432+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1433+ is fully supported (use `--pdf-engine=xelatex`).
18631434
1864−### For loops
1435+[BCP 47]: https://tools.ietf.org/html/bcp47
1436+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
18651437
1866−A for loop begins with `for(variable)` (enclosed in
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1868−delimiters.
1438+Variables for slides
1439+--------------------
18691440
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.
1441+Variables are available for [producing slide shows with pandoc],
1442+including all [reveal.js configuration options].
18771443
1878−Examples:
1444+`titlegraphic`
1445+: title graphic for Beamer documents
18791446
1880−```
1881−$for(foo)$$foo$$sep$, $endfor$
1447+`logo`
1448+: logo for Beamer documents
18821449
1883−$for(foo)$
1884− - $foo.last$, $foo.first$
1885−$endfor$
1450+`slidy-url`
1451+: base URL for Slidy documents (defaults to
1452+ `https://www.w3.org/Talks/Tools/Slidy2`)
18861453
1887−${ for(foo.bar) }
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1889−${ endfor }
1454+`slideous-url`
1455+: base URL for Slideous documents (defaults to `slideous`)
18901456
1891−$for(mymap)$
1892−$it.name$: $it.office$
1893−$endfor$
1894−```
1457+`s5-url`
1458+: base URL for S5 documents (defaults to `s5/default`)
18951459
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.
1460+`revealjs-url`
1461+: base URL for reveal.js documents (defaults to `reveal.js`)
18991462
1900−```
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1902−```
1463+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1464+: themes for LaTeX [`beamer`] documents
19031465
1904−Instead of using `variable` inside the loop, the special
1905−anaphoric keyword `it` may be used.
1466+`themeoptions`
1467+: options for LaTeX beamer themes (a list).
19061468
1907−```
1908−${ for(foo.bar) }
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1469+`navigation`
1470+: controls navigation symbols in `beamer` documents
1471+ (default is `empty` for no navigation symbols; other valid values
1472+ are `frame`, `vertical`, and `horizontal`).
19121473
1913−### Partials
1474+`section-titles`
1475+: enables on "title pages" for new sections in `beamer`
1476+ documents (default = true).
19141477
1915−Partials (subtemplates stored in different files) may be
1916−included by using the name of the partial, followed
1917−by `()`, for example:
1478+`beamerarticle`
1479+: when true, the `beamerarticle` package is loaded (for
1480+ producing an article from beamer slides).
19181481
1919−```
1920−${ styles() }
1921−```
1482+`aspectratio`
1483+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1484+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1485+ default, and `32` for 3:2).
19221486
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:
1487+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
19281488
1929−```
1930−${ styles.html() }
1931−```
1489+Variables for LaTeX
1490+-------------------
19321491
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.)
1492+LaTeX variables are used when [creating a PDF].
19371493
1938−Partials may optionally be applied to variables using
1939−a colon:
1494+`papersize`
1495+: paper size, e.g. `letter`, `a4`
19401496
1941−```
1942−${ date:fancy() }
1497+`fontsize`
1498+: font size for body text (e.g. `10pt`, `12pt`)
19431499
1944−${ articles:bibentry() }
1945−```
1500+`documentclass`
1501+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
19461502
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
1503+`classoption`
1504+: option for document class, e.g. `oneside`; may be repeated
1505+ for multiple options
19501506
1951−```
1952−${ for(articles) }
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1507+`beameroption`
1508+: In beamer, add extra beamer option with `\setbeameroption{}`
19561509
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`.
1510+`geometry`
1511+: option for [`geometry`] package, e.g. `margin=1in`;
1512+ may be repeated for multiple options
19611513
1962−Final newlines are omitted from included partials.
1514+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1515+: sets margins, if `geometry` is not used (otherwise `geometry`
1516+ overrides these)
19631517
1964−Partials may include other partials.
1518+`linestretch`
1519+: adjusts line spacing using the [`setspace`]
1520+ package, e.g. `1.25`, `1.5`
19651521
1966−A separator between values of an array may be specified
1967−in square brackets, immediately after the variable name
1968−or partial:
1522+`fontfamily`
1523+: font package for use with `pdflatex`:
1524+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1525+ The default is [Latin Modern][`lm`].
19691526
1970−```
1971−${months[, ]}$
1527+`fontfamilyoptions`
1528+: options for package used as `fontfamily`: e.g. `osf,sc` with
1529+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1530+ figures and true small caps; may be repeated for multiple options
19721531
1973−${articles:bibentry()[; ]$
1974−```
1532+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1533+: font families for use with `xelatex` or
1534+ `lualatex`: take the name of any system font, using the
1535+ [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
19751536
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.
1537+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1538+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1539+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1540+ available through [`fontspec`], such as the OpenType features
1541+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
19791542
1980−### Nesting
1543+`fontenc`
1544+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1545+ default is `T1` (see guide to [LaTeX font encodings])
19811546
1982−To ensure that content is "nested," that is, subsequent lines
1983−indented, use the `^` directive:
1547+`microtypeoptions`
1548+: options to pass to the microtype package
19841549
1985−```
1986−$item.number$ $^$$item.description$ ($item.price$)
1987−```
1550+`colorlinks`
1551+: add color to link text; automatically enabled if any of
1552+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
19881553
1989−In this example, if `item.description` has multiple lines,
1990−they will all be indented to line up with the first line:
1554+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1555+: color for internal links, external links, citation links, linked
1556+ URLs, and links in table of contents, respectively: uses options
1557+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1558+ `x11names` lists
19911559
1992−```
1993−00123 A fine bottle of 18-year old
1994− Oban whiskey. ($148)
1995−```
1560+`links-as-notes`
1561+: causes links to be printed as footnotes
19961562
1997−To nest multiple lines to the same level, align them
1998−with the `^` directive in the template. For example:
1563+`indent`
1564+: uses document class settings for indentation (the default LaTeX template
1565+ otherwise removes indentation and adds space between paragraphs)
19991566
2000−```
2001−$item.number$ $^$$item.description$ ($item.price$)
2002− (Available til $item.sellby$.)
2003−```
1567+`subparagraph`
1568+: disables default behavior of LaTeX template that redefines (sub)paragraphs
1569+ as sections, changing the appearance of nested headings in some classes
20041570
2005−will produce
1571+`thanks`
1572+: specifies contents of acknowledgments footnote after document title.
20061573
2007−```
2008−00123 A fine bottle of 18-year old
2009− Oban whiskey. ($148)
2010− (Available til March 30, 2020.)
2011−```
1574+`toc`
1575+: include table of contents (can also be set using `--toc/--table-of-contents`)
20121576
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.
1577+`toc-depth`
1578+: level of section to include in table of contents
20171579
2018−### Breakable spaces
1580+`secnumdepth`
1581+: numbering depth for sections, if sections are numbered
20191582
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 `~`).
1583+`lof`, `lot`
1584+: include list of figures, list of tables
20241585
2025−```
2026−$~$This long line may break if the document is rendered
2027−with a short line length.$~$
2028−```
1586+`bibliography`
1587+: bibliography to use for resolving references
20291588
2030−### Pipes
1589+`biblio-style`
1590+: bibliography style, when used with `--natbib` and `--biblatex`.
20311591
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:
1592+`biblio-title`
1593+: bibliography title, when used with `--natbib` and `--biblatex`.
20351594
2036−```
2037−$for(name)$
2038−$name/uppercase$
2039−$endfor$
1595+`biblatexoptions`
1596+: list of options for biblatex.
20401597
2041−$for(metadata/pairs)$
2042−- $it.key$: $it.value$
2043−$endfor$
1598+`natbiboptions`
1599+: list of options for natbib.
20441600
2045−$employee:name()/uppercase$
2046−```
1601+`pagestyle`
1602+: An option for LaTeX's `\pagestyle{}`. The default article class
1603+ supports 'plain' (default), 'empty', and 'headings'; headings puts
1604+ section titles in the header.
20471605
2048−Pipes may be chained:
1606+[`article`]: https://ctan.org/pkg/article
1607+[`report`]: https://ctan.org/pkg/report
1608+[`book`]: https://ctan.org/pkg/book
1609+[KOMA-Script]: https://ctan.org/pkg/koma-script
1610+[`memoir`]: https://ctan.org/pkg/memoir
1611+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1612+[`mathpazo`]: https://ctan.org/pkg/mathpazo
1613+[LaTeX font encodings]: https://ctan.org/pkg/encguide
20491614
2050−```
2051−$for(employees/pairs)$
2052−$it.key/alpha/uppercase$. $it.name$
2053−$endfor$
2054−```
1615+Variables for ConTeXt
1616+---------------------
20551617
2056−Some pipes take parameters:
1618+`papersize`
1619+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1620+ may be repeated for multiple options
20571621
2058−```
2059−|----------------------|------------|
2060−$for(employee)$
2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062−$endfor$
2063−|----------------------|------------|
2064−```
1622+`layout`
1623+: options for page margins and text arrangement (see [ConTeXt Layout]);
1624+ may be repeated for multiple options
20651625
2066−Currently the following pipes are predefined:
1626+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1627+: sets margins, if `layout` is not used (otherwise `layout`
1628+ overrides these)
20671629
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.
1630+`fontsize`
1631+: font size for body text (e.g. `10pt`, `12pt`)
20721632
2073−- `uppercase`: Converts text to uppercase.
1633+`mainfont`, `sansfont`, `monofont`, `mathfont`
1634+: font families: take the name of any system font (see [ConTeXt Font Switching])
20741635
2075−- `lowercase`: Converts text to lowercase.
1636+`linkcolor`, `contrastcolor`
1637+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
20761638
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.
1639+`linkstyle`
1640+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
20801641
2081−- `reverse`: Reverses a textual value or array,
2082− and has no effect on other values.
1642+`indenting`
1643+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1644+ may be repeated for multiple options
20831645
2084−- `first`: Returns the first value of an array, if
2085− applied to a non-empty array; otherwise returns
2086− the original value.
1646+`whitespace`
1647+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
20871648
2088−- `last`: Returns the last value of an array, if
2089− applied to a non-empty array; otherwise returns
2090− the original value.
1649+`interlinespace`
1650+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1651+ may be repeated for multiple options
20911652
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.
1653+`headertext`, `footertext`
1654+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1655+ may be repeated up to four times for different placement
20951656
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.
1657+`pagenumbering`
1658+: page number style and location (using [`setuppagenumbering`]);
1659+ may be repeated for multiple options
20991660
2100−- `chomp`: Removes trailing newlines (and breakable space).
1661+`toc`
1662+: include table of contents (can also be set using `--toc/--table-of-contents`)
21011663
2102−- `nowrap`: Disables line wrapping on breakable spaces.
1664+`lof`, `lot`
1665+: include list of figures, list of tables
21031666
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`.
1667+`pdfa`
1668+: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1669+ To successfully generate PDF/A the required ICC color profiles have to
1670+ be available and the content and all included files (such as images)
1671+ have to be standard conforming. The ICC profiles can be obtained
1672+ from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1673+ details.
21091674
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`.
1675+[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1676+[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
1677+[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
1678+[ConTeXt Color]: https://wiki.contextgarden.net/Color
1679+[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
1680+[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
1681+[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
1682+[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
1683+[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
1684+[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1685+[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
21141686
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.
1687+Variables for man pages
1688+-----------------------
21221689
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.
1690+`section`
1691+: section number in man pages
21261692
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.
1693+`header`
1694+: header in man pages
21301695
1696+`footer`
1697+: footer in man pages
21311698
2132−## Variables
1699+`adjusting`
1700+: adjusts text to left (`l`), right (`r`), center (`c`),
1701+ or both (`b`) margins
21331702
2134−### Metadata variables
1703+`hyphenate`
1704+: if `true` (the default), hyphenation will be used
21351705
2136−`title`, `author`, `date`
2137−: allow identification of basic aspects of the document. Included
2138− in PDF metadata through LaTeX and ConTeXt. These can be set
2139− through a [pandoc title block][Extension: `pandoc_title_block`],
2140− which allows for multiple authors, or through a
2141− [YAML metadata block][Extension: `yaml_metadata_block`]:
2142−
2143− ---
2144− author:
2145− - Aristotle
2146− - Peter Abelard
2147− ...
2148−
2149− Note that if you just want to set PDF or HTML metadata, without
2150− including a title block in the document itself, you can
2151− set the `title-meta`, `author-meta`, and `date-meta`
2152− variables. (By default these are set automatically, based
2153− on `title`, `author`, and `date`.) The page title in HTML
2154− is set by `pagetitle`, which is equal to `title` by default.
2155−
2156−`subtitle`
2157−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158− documents
2159−
2160−`abstract`
2161−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162− documents
2163−
2164−`keywords`
2165−: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166− and AsciiDoc metadata; repeat as for `author`, above
2167−
2168−`subject`
2169−: document subject, included in ODT, PDF, docx and pptx metadata
2170−
2171−`description`
2172−: document description, included in ODT, docx and pptx metadata. Some
2173− applications show this as `Comments` metadata.
2174−
2175−`category`
2176−: document category, included in docx and pptx metadata
2177−
2178−Additionally,
2179−any root-level string metadata, not included in ODT, docx
2180−or pptx metadata is added as a *custom property*.
2181−The following [YAML] metadata block for instance:
2182−
2183− ---
2184− title: 'This is the title'
2185− subtitle: "This is the subtitle"
2186− author:
2187− - Author One
2188− - Author Two
2189− description: |
2190− This is a long
2191− description.
2192−
2193− It consists of two paragraphs
2194− ...
2195−
2196−will include `title`, `author` and `description` as standard document
2197−properties and `subtitle` as a custom property when converting to docx,
2198−ODT or pptx.
2199−
2200−### Language variables
2201−
2202−`lang`
2203−: identifies the main language of the document using IETF language
2204− tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205− The [Language subtag lookup] tool can look up or verify these tags.
2206− This affects most formats, and controls hyphenation in PDF output
2207− when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2208−
2209− Use native pandoc [Divs and Spans] with the `lang` attribute to
2210− switch the language:
2211−
2212− ---
2213− lang: en-GB
2214− ...
2215−
2216− Text in the main document language (British English).
2217−
2218− ::: {lang=fr-CA}
2219− > Cette citation est écrite en français canadien.
2220− :::
2221−
2222− More text in English. ['Zitat auf Deutsch.']{lang=de}
2223−
2224−`dir`
2225−: the base script direction, either `rtl` (right-to-left)
2226− or `ltr` (left-to-right).
2227−
2228− For bidirectional documents, native pandoc `span`s and
2229− `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230− be used to override the base direction in some output
2231− formats. This may not always be necessary if the final
2232− renderer (e.g. the browser, when generating HTML) supports
2233− the [Unicode Bidirectional Algorithm].
2234−
2235− When using LaTeX for bidirectional documents, only the
2236− `xelatex` engine is fully supported (use
2237− `--pdf-engine=xelatex`).
2238−
2239−[BCP 47]: https://tools.ietf.org/html/bcp47
2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2241−[Language subtag lookup]: https://r12a.github.io/app-subtags/
2242−
2243−### Variables for HTML
2244−
2245−`document-css`
2246−: Enables inclusion of most of the [CSS] in the `styles.html`
2247− [partial](#partials) (have a look with
2248− `pandoc --print-default-data-file=templates/styles.html`).
2249− Unless you use [`--css`](#option--css), this variable
2250− is set to `true` by default. You can disable it with
2251− e.g. `pandoc -M document-css=false`.
2252−
2253−`mainfont`
2254−: sets the CSS `font-family` property on the `html` element.
2255−
2256−`fontsize`
2257−: sets the base CSS `font-size`, which you'd usually set
2258− to e.g. `20px`, but it also accepts `pt`
2259− (12pt = 16px in most browsers).
2260−
2261−`fontcolor`
2262−: sets the CSS `color` property on the `html` element.
2263−
2264−`linkcolor`
2265−: sets the CSS `color` property on all links.
2266−
2267−`monofont`
2268−: sets the CSS `font-family` property on `code` elements.
2269−
2270−`monobackgroundcolor`
2271−: sets the CSS `background-color` property on `code` elements
2272− and adds extra padding.
2273−
2274−`linestretch`
2275−: sets the CSS `line-height` property on the `html` element,
2276− which is preferred to be unitless.
2277−
2278−`backgroundcolor`
2279−: sets the CSS `background-color` property on the `html` element.
2280−
2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282−: sets the corresponding CSS `padding` properties on the `body` element.
2283−
2284−To override or extend some [CSS] for just one document, include for example:
2285−
2286− ---
2287− header-includes: |
2288− <style>
2289− blockquote {
2290− font-style: italic;
2291− }
2292− tr.even {
2293− background-color: #f0f0f0;
2294− }
2295− td, th {
2296− padding: 0.5em 2em 0.5em 0.5em;
2297− }
2298− tbody {
2299− border-bottom: none;
2300− }
2301− </style>
2302− ---
2303−
2304−[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305−
2306−### Variables for HTML math
2307−
2308−`classoption`
2309−: when using [KaTeX](#option--katex), you can render display
2310−math equations flush left using [YAML metadata](#layout) or with
2311−`-M classoption=fleqn`.
2312−
2313−### Variables for HTML slides
2314−
2315−These affect HTML output when [producing slide shows with pandoc].
2316−
2317−`institute`
2318−: author affiliations: can be a list when there are multiple authors
2319−
2320−`revealjs-url`
2321−: base URL for reveal.js documents (defaults to
2322− `https://unpkg.com/reveal.js@^4/`)
2323−
2324−`s5-url`
2325−: base URL for S5 documents (defaults to `s5/default`)
2326−
2327−`slidy-url`
2328−: base URL for Slidy documents (defaults to
2329− `https://www.w3.org/Talks/Tools/Slidy2`)
2330−
2331−`slideous-url`
2332−: base URL for Slideous documents (defaults to `slideous`)
2333−
2334−`title-slide-attributes`
2335−: additional attributes for the title slide of reveal.js slide shows.
2336− See [background in reveal.js and beamer] for an example.
2337−
2338−All [reveal.js configuration options] are available as variables.
2339−To turn off boolean flags that default to true in reveal.js, use `0`.
2340−
2341−[reveal.js configuration options]: https://revealjs.com/config/
2342−
2343−### Variables for Beamer slides
2344−
2345−These variables change the appearance of PDF slides using [`beamer`].
2346−
2347−`aspectratio`
2348−: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349− `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350− `32` for 3:2)
2351−
2352−`beamerarticle`
2353−: produce an article from Beamer slides
2354−
2355−`beameroption`
2356−: add extra beamer option with `\setbeameroption{}`
2357−
2358−`institute`
2359−: author affiliations: can be a list when there are multiple authors
2360−
2361−`logo`
2362−: logo image for slides
2363−
2364−`navigation`
2365−: controls navigation symbols (default is `empty` for no navigation
2366− symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367−
2368−`section-titles`
2369−: enables "title pages" for new sections (default is true)
2370−
2371−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372−: beamer themes
2373−
2374−`themeoptions`
2375−: options for LaTeX beamer themes (a list).
2376−
2377−`titlegraphic`
2378−: image for title slide
2379−
2380−### Variables for PowerPoint
2381−
2382−These variables control the visual aspects of a slide show that
2383−are not easily controlled via templates.
2384−
2385−`monofont`
2386−: font to use for code.
2387−
2388−### Variables for LaTeX
2389−
2390−Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2391−
2392−#### Layout
2393−
2394−`block-headings`
2395−: make `\paragraph` and `\subparagraph` (fourth- and
2396− fifth-level headings, or fifth- and sixth-level with book
2397− classes) free-standing rather than run-in; requires further
2398− formatting to distinguish from `\subsubsection` (third- or
2399− fourth-level headings). Instead of using this option,
2400− [KOMA-Script] can adjust headings more extensively:
2401−
2402− ---
2403− documentclass: scrartcl
2404− header-includes: |
2405− \RedeclareSectionCommand[
2406− beforeskip=-10pt plus -2pt minus -1pt,
2407− afterskip=1sp plus -1sp minus 1sp,
2408− font=\normalfont\itshape]{paragraph}
2409− \RedeclareSectionCommand[
2410− beforeskip=-10pt plus -2pt minus -1pt,
2411− afterskip=1sp plus -1sp minus 1sp,
2412− font=\normalfont\scshape,
2413− indent=0pt]{subparagraph}
2414− ...
2415−
2416−`classoption`
2417−: option for document class, e.g. `oneside`; repeat for multiple options:
2418−
2419− ---
2420− classoption:
2421− - twocolumn
2422− - landscape
2423− ...
2424−
2425−`documentclass`
2426−: document class: usually one of the standard classes,
2427− [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428− equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429− default to smaller margins; or [`memoir`]
2430−
2431−`geometry`
2432−: option for [`geometry`] package, e.g. `margin=1in`;
2433− repeat for multiple options:
2434−
2435− ---
2436− geometry:
2437− - top=30mm
2438− - left=20mm
2439− - heightrounded
2440− ...
2441−
2442−`hyperrefoptions`
2443−: option for [`hyperref`] package, e.g. `linktoc=all`;
2444− repeat for multiple options:
2445−
2446− ---
2447− hyperrefoptions:
2448− - linktoc=all
2449− - pdfwindowui
2450− - pdfpagemode=FullScreen
2451− ...
2452−
2453−`indent`
2454−: if true, pandoc will use document class settings for
2455− indentation (the default LaTeX template otherwise removes
2456− indentation and adds space between paragraphs)
2457−
2458−`linestretch`
2459−: adjusts line spacing using the [`setspace`]
2460− package, e.g. `1.25`, `1.5`
2461−
2462−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463−: sets margins if `geometry` is not used (otherwise `geometry`
2464− overrides these)
2465−
2466−`pagestyle`
2467−: control `\pagestyle{}`: the default article class
2468− supports `plain` (default), `empty` (no running heads or page numbers),
2469− and `headings` (section titles in running heads)
2470−
2471−`papersize`
2472−: paper size, e.g. `letter`, `a4`
2473−
2474−`secnumdepth`
2475−: numbering depth for sections (with `--number-sections` option
2476− or `numbersections` variable)
2477−
2478−#### Fonts
2479−
2480−`fontenc`
2481−: allows font encoding to be specified through `fontenc` package (with
2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483−
2484−`fontfamily`
2485−: font package for use with `pdflatex`:
2486− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487− The default is [Latin Modern][`lm`].
2488−
2489−`fontfamilyoptions`
2490−: options for package used as `fontfamily`; repeat for multiple options.
2491− For example, to use the Libertine font with proportional lowercase
2492− (old-style) figures through the [`libertinus`] package:
2493−
2494− ---
2495− fontfamily: libertinus
2496− fontfamilyoptions:
2497− - osf
2498− - p
2499− ...
2500−
2501−`fontsize`
2502−: font size for body text. The standard classes allow 10pt, 11pt, and
2503− 12pt. To use another size, set `documentclass` to one of
2504− the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2505−
2506−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2507−: font families for use with `xelatex` or
2508− `lualatex`: take the name of any system font, using the
2509− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2510−
2511−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2512−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2513− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2514− choices available through [`fontspec`]; repeat for multiple
2515− options. For example, to use the [TeX Gyre] version of
2516− Palatino with lowercase figures:
2517−
2518− ---
2519− mainfont: TeX Gyre Pagella
2520− mainfontoptions:
2521− - Numbers=Lowercase
2522− - Numbers=Proportional
2523− ...
2524−
2525−`microtypeoptions`
2526−: options to pass to the microtype package
2527−
2528−#### Links
2529−
2530−`colorlinks`
2531−: add color to link text; automatically enabled if any of
2532− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533−
2534−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535−: color for internal links, external links, citation links, linked
2536− URLs, and links in table of contents, respectively: uses options
2537− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538− `x11names` lists
2539−
2540−`links-as-notes`
2541−: causes links to be printed as footnotes
2542−
2543−#### Front matter
2544−
2545−`lof`, `lot`
2546−: include list of figures, list of tables
1706+Variables for ms
1707+----------------
25471708
2548−`thanks`
2549−: contents of acknowledgments footnote after document title
2550−
2551−`toc`
2552−: include table of contents (can also be set using
2553− `--toc/--table-of-contents`)
2554−
2555−`toc-depth`
2556−: level of section to include in table of contents
2557−
2558−#### BibLaTeX Bibliographies
2559−
2560−These variables function when using BibLaTeX for [citation rendering].
2561−
2562−`biblatexoptions`
2563−: list of options for biblatex
2564−
2565−`biblio-style`
2566−: bibliography style, when used with `--natbib` and `--biblatex`.
2567−
2568−`biblio-title`
2569−: bibliography title, when used with `--natbib` and `--biblatex`.
2570−
2571−`bibliography`
2572−: bibliography to use for resolving references
2573−
2574−`natbiboptions`
2575−: list of options for natbib
2576−
2577−[KOMA-Script]: https://ctan.org/pkg/koma-script
2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579−[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580−[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581−[`article`]: https://ctan.org/pkg/article
2582−[`book`]: https://ctan.org/pkg/book
2583−[`libertinus`]: https://ctan.org/pkg/libertinus
2584−[`memoir`]: https://ctan.org/pkg/memoir
2585−[`report`]: https://ctan.org/pkg/report
2586−
2587−### Variables for ConTeXt
2588−
2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590−
2591−`fontsize`
2592−: font size for body text (e.g. `10pt`, `12pt`)
2593−
2594−`headertext`, `footertext`
2595−: text to be placed in running header or footer (see [ConTeXt Headers and
2596− Footers]); repeat up to four times for different placement
2597−
2598−`indenting`
2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600− [ConTeXt Indentation]); repeat for multiple options
2601−
2602−`interlinespace`
2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604− repeat for multiple options
2605−
2606−`layout`
2607−: options for page margins and text arrangement (see [ConTeXt Layout]);
2608− repeat for multiple options
2609−
2610−`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
2613−
2614−`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
2617−
2618−`lof`, `lot`
2619−: include list of figures, list of tables
2620−
2621−`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
2624−
2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626−: sets margins, if `layout` is not used (otherwise `layout`
2627− overrides these)
2628−
2629−`pagenumbering`
2630−: page number style and location (using [`setuppagenumbering`]);
2631− repeat for multiple options
2632−
2633−`papersize`
2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635− repeat for multiple options
2636−
2637−`pdfa`
2638−: adds to the preamble the setup necessary to generate PDF/A
2639− of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640− specified (i.e. the value is set to True, by e.g.
2641− `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642− `1b:2005` will be used as default, for reasons of backwards
2643− compatibility. Using `--variable=pdfa` without specified value
2644− is not supported. To successfully generate PDF/A the required
2645− ICC color profiles have to be available and the content and all
2646− included files (such as images) have to be standard conforming.
2647− The ICC profiles and output intent may be specified using the
2648− variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649− PDFA] for more details.
2650−
2651−`pdfaiccprofile`
2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654− used as default. May be repeated to include multiple profiles. Note that
2655− the profiles have to be available on the system. They can be obtained
2656− from [ConTeXt ICC Profiles].
2657−
2658−`pdfaintent`
2659−: when used in conjunction with `pdfa`, specifies the output intent for
2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.
2662−
2663−`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
2666−
2667−`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
2670−
2671−`includesource`
2672−: include all source documents as file attachments in the PDF file
2673−
2674−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2675−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2676−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching
2677−[ConTeXt Color]: https://wiki.contextgarden.net/Color
2678−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers
2679−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation
2680−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles
2681−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A
2682−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace
2683−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2684−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2685−
2686−### Variables for `wkhtmltopdf`
2687−
2688−Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2689−The `--css` option also affects the output.
2690−
2691−`footer-html`, `header-html`
2692−: add information to the header and footer
2693−
2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695−: set the page margins
2696−
2697−`papersize`
2698−: sets the PDF paper size
2699−
2700−### Variables for man pages
2701−
2702−`adjusting`
2703−: adjusts text to left (`l`), right (`r`), center (`c`),
2704− or both (`b`) margins
2705−
2706−`footer`
2707−: footer in man pages
2708−
2709−`header`
2710−: header in man pages
2711−
2712−`hyphenate`
2713−: if `true` (the default), hyphenation will be used
2714−
2715−`section`
2716−: section number in man pages
1709+`pointsize`
1710+: point size (e.g. `10p`)
27171711
2718−### Variables for ms
1712+`lineheight`
1713+: line height (e.g. `12p`)
27191714
27201715`fontfamily`
27211716: font family (e.g. `T` or `P`)
@@ -2723,81 +1718,78 @@ The `--css` option also affects the output.
27231718`indent`
27241719: paragraph indent (e.g. `2m`)
27251720
2726−`lineheight`
2727−: line height (e.g. `12p`)
1721+Using variables in templates
1722+----------------------------
27281723
2729−`pointsize`
2730−: point size (e.g. `10p`)
1724+Variable names are sequences of alphanumerics, `-`, and `_`,
1725+starting with a letter. A variable name surrounded by `$` signs
1726+will be replaced by its value. For example, the string `$title$` in
27311727
2732−### Variables set automatically
1728+ <title>$title$</title>
27331729
2734−Pandoc sets these variables automatically in response to [options] or
2735−document contents; users can also modify them. These vary depending
2736−on the output format, and include the following:
1730+will be replaced by the document title.
27371731
2738−`body`
2739−: body of document
1732+To write a literal `$` in a template, use `$$`.
27401733
2741−`date-meta`
2742−: the `date` variable converted to ISO 8601 YYYY-MM-DD,
2743− included in all HTML based formats (dzslides, epub,
2744− html, html4, html5, revealjs, s5, slideous, slidy).
2745− The recognized formats for `date` are: `mm/dd/yyyy`,
2746− `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`
2747− (e.g. either `02 Apr 2018` or `02 April 2018`),
2748− `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),
2749− `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).
1734+Templates may contain conditionals. The syntax is as follows:
27501735
2751−`header-includes`
2752−: contents specified by `-H/--include-in-header` (may have multiple
2753− values)
1736+ $if(variable)$
1737+ X
1738+ $else$
1739+ Y
1740+ $endif$
27541741
2755−`include-before`
2756−: contents specified by `-B/--include-before-body` (may have
2757− multiple values)
1742+This will include `X` in the template if `variable` has a truthy
1743+value; otherwise it will include `Y`. Here a truthy value is any
1744+of the following:
27581745
2759−`include-after`
2760−: contents specified by `-A/--include-after-body` (may have
2761− multiple values)
1746+- a string that is not entirely white space,
1747+- a non-empty array where the first value is truthy,
1748+- any number (including zero),
1749+- any object,
1750+- the boolean `true` (to specify the boolean `true`
1751+ value using YAML metadata or the `--metadata` flag,
1752+ use `true`, `True`, or `TRUE`; with the `--variable`
1753+ flag, simply omit a value for the variable, e.g.
1754+ `--variable draft`).
27621755
2763−`meta-json`
2764−: JSON representation of all of the document's metadata. Field
2765− values are transformed to the selected output format.
1756+`X` and `Y` are placeholders for any valid template text,
1757+and may include interpolated variables or other conditionals.
1758+The `$else$` section may be omitted.
27661759
2767−`numbersections`
2768−: non-null value if `-N/--number-sections` was specified
1760+When variables can have multiple values (for example, `author` in
1761+a multi-author document), you can use the `$for$` keyword:
27691762
2770−`sourcefile`, `outputfile`
2771−: source and destination filenames, as given on the command line.
2772− `sourcefile` can also be a list if input comes from multiple files,
2773− or empty if input is from stdin. You can use the following snippet in
2774− your template to distinguish them:
1763+ $for(author)$
1764+ <meta name="author" content="$author$" />
1765+ $endfor$
27751766
2776− $if(sourcefile)$
2777− $for(sourcefile)$
2778− $sourcefile$
2779− $endfor$
2780− $else$
2781− (stdin)
2782− $endif$
1767+You can optionally specify a separator to be used between
1768+consecutive items:
27831769
2784− Similarly, `outputfile` can be `-` if output goes to the terminal.
1770+ $for(author)$$author$$sep$, $endfor$
27851771
2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
1772+Note that the separator needs to be specified immediately before the `$endfor`
1773+keyword.
27871774
2788−`curdir`
2789−: working directory from which pandoc is run.
1775+A dot can be used to select a field of a variable that takes
1776+an object as its value. So, for example:
27901777
2791−`toc`
2792−: non-null value if `--toc/--table-of-contents` was specified
1778+ $author.name$ ($author.affiliation$)
27931779
2794−`toc-title`
2795−: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
1780+If you use custom templates, you may need to revise them as pandoc
1781+changes. We recommend tracking the changes in the default templates,
1782+and modifying your custom templates accordingly. An easy way to do this
1783+is to fork the [pandoc-templates] repository and merge in changes after each
1784+pandoc release.
1785+
1786+Templates may contain comments: anything on a line after `$--`
1787+will be treated as a comment and ignored.
27971788
27981789[pandoc-templates]: https://github.com/jgm/pandoc-templates
27991790
2800−# Extensions
1791+Extensions
1792+==========
28011793
28021794The behavior of some of the readers and writers can be adjusted by
28031795enabling or disabling various extensions.
@@ -2814,11 +1806,8 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
28141806`commonmark` and `gfm`.) In the following, extensions that also work
28151807for other formats are covered.
28161808
2817−Note that markdown extensions added to the `ipynb` format
2818−affect Markdown cells in Jupyter notebooks (as do command-line
2819−options like `--atx-headers`).
2820−
2821−## Typography
1809+Typography
1810+----------
28221811
28231812#### Extension: `smart` ####
28241813
@@ -2850,12 +1839,13 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
28501839to use the ligatures when possible; if `smart` is disabled
28511840pandoc will use unicode quotation mark and dash characters.
28521841
2853−## Headings and sections
1842+Headers and sections
1843+--------------------
28541844
28551845#### Extension: `auto_identifiers` ####
28561846
2857−A heading without an explicitly specified identifier will be
2858−automatically assigned a unique identifier based on the heading text.
1847+A header without an explicitly specified identifier will be
1848+automatically assigned a unique identifier based on the header text.
28591849
28601850This extension can be enabled/disabled for the following formats:
28611851
@@ -2869,7 +1859,7 @@ enabled by default in
28691859: `markdown`, `muse`
28701860
28711861The default algorithm used to derive the identifier from the
2872−heading text is:
1862+header text is:
28731863
28741864 - Remove all formatting, links, etc.
28751865 - Remove all footnotes.
@@ -2883,9 +1873,9 @@ heading text is:
28831873
28841874Thus, for example,
28851875
2886− Heading Identifier
1876+ Header Identifier
28871877 ------------------------------- ----------------------------
2888− `Heading identifiers in HTML` `heading-identifiers-in-html`
1878+ `Header identifiers in HTML` `header-identifiers-in-html`
28891879 `Maître d'hôtel` `maître-dhôtel`
28901880 `*Dogs*?--in *my* house?` `dogs--in-my-house`
28911881 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
@@ -2893,7 +1883,7 @@ Thus, for example,
28931883 `33` `section`
28941884
28951885These rules should, in most cases, allow one to determine the identifier
2896−from the heading text. The exception is when several headings have the
1886+from the header text. The exception is when several headers have the
28971887same text; in this case, the first will get an identifier as described
28981888above; the second will get the same identifier with `-1` appended; the
28991889third with `-2`; and so on.
@@ -2907,7 +1897,7 @@ also make it easy to provide links from one section of a document to
29071897another. A link to this section, for example, might look like this:
29081898
29091899 See the section on
2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).
1900+ [header identifiers](#header-identifiers-in-html-latex-and-context).
29111901
29121902Note, however, that this method of providing links to sections works
29131903only in HTML, LaTeX, and ConTeXt formats.
@@ -2915,7 +1905,7 @@ only in HTML, LaTeX, and ConTeXt formats.
29151905If the `--section-divs` option is specified, then each section will
29161906be wrapped in a `section` (or a `div`, if `html4` was specified),
29171907and the identifier will be attached to the enclosing `<section>`
2918−(or `<div>`) tag rather than the heading itself. This allows entire
1908+(or `<div>`) tag rather than the header itself. This allows entire
29191909sections to be manipulated using JavaScript or treated differently in
29201910CSS.
29211911
@@ -2931,9 +1921,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
29311921GitHub's method. Spaces are converted to dashes (`-`),
29321922uppercase characters to lowercase characters, and punctuation
29331923characters other than `-` and `_` are removed.
2934−Emojis are replaced by their names.
29351924
2936−## Math Input
1925+Math Input
1926+----------
29371927
29381928The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
29391929[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2943,47 +1933,51 @@ are described in the section about Pandoc's Markdown.
29431933However, they can also be used with HTML input. This is handy for
29441934reading web pages formatted using MathJax, for example.
29451935
2946−## Raw HTML/TeX
1936+Raw HTML/TeX
1937+------------
1938+
1939+The following extensions (especially how they affect Markdown
1940+input/output) are also described in more detail in their respective
1941+sections of [Pandoc's Markdown].
1942+
1943+#### Extension: `raw_html` {#raw_html}
29471944
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
1945+When converting from HTML, parse elements to raw HTML which are not
1946+representable in pandoc's AST.
1947+By default, this is disabled for HTML input.
29501948
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.
1949+#### Extension: `raw_tex` {#raw_tex}
29541950
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`):
1951+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
29581952
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
1953+This extension can be enabled/disabled for the following formats
1954+(in addition to `markdown`):
29621955
2963− output formats
2964− : `textile`, `commonmark`
1956+input formats
1957+: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
1958+ `\eqref` only)
1959+
1960+output formats
1961+: `textile`, `commonmark`
1962+
1963+#### Extension: `native_divs` {#native_divs}
1964+
1965+This extension is enabled by default for HTML input. This means that
1966+`div`s are parsed to pandoc native elements. (Alternatively, you
1967+can parse them to raw HTML using `-f html-native_divs+raw_html`.)
1968+
1969+When converting HTML to Markdown, for example, you may want to drop all
1970+`div`s and `span`s:
1971+
1972+ pandoc -f html-native_divs-native_spans -t markdown
29651973
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`.
1974+#### Extension: `native_spans` {#native_spans}
29731975
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`.
1976+Analogous to `native_divs` above.
29781977
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`.
29851978
2986−## Literate Haskell support
1979+Literate Haskell support
1980+------------------------
29871981
29881982#### Extension: `literate_haskell` ####
29891983
@@ -3004,12 +1998,12 @@ This means that
30041998 - In Markdown input, "bird track" sections will be parsed as Haskell
30051999 code rather than block quotations. Text between `\begin{code}`
30062000 and `\end{code}` will also be treated as Haskell code. For
3007− ATX-style headings the character '=' will be used instead of '#'.
2001+ ATX-style headers the character '=' will be used instead of '#'.
30082002
30092003 - In Markdown output, code blocks with classes `haskell` and `literate`
30102004 will be rendered using bird tracks, and block quotations will be
30112005 indented one space, so they will not be treated as Haskell code.
3012− In addition, headings will be rendered setext-style (with underlines)
2006+ In addition, headers will be rendered setext-style (with underlines)
30132007 rather than ATX-style (with '#' characters). (This is because ghc
30142008 treats '#' characters in column 1 as introducing line numbers.)
30152009
@@ -3044,7 +2038,8 @@ Note that GHC expects the bird tracks in the first column, so indented
30442038literate code blocks (e.g. inside an itemized environment) will not be
30452039picked up by the Haskell compiler.
30462040
3047−## Other extensions
2041+Other extensions
2042+----------------
30482043
30492044#### Extension: `empty_paragraphs` ####
30502045
@@ -3059,60 +2054,12 @@ input formats
30592054output formats
30602055: `docx`, `odt`, `opendocument`, `html`
30612056
3062−#### Extension: `native_numbering` ####
3063−
3064−Enables native numbering of figures and tables. Enumeration
3065−starts at 1.
3066−
3067−This extension can be enabled/disabled for the following formats:
3068−
3069−output formats
3070−: `odt`, `opendocument`
3071−
3072−#### Extension: `xrefs_name` ####
3073−
3074−Links to headings, figures and tables inside the document are
3075−substituted with cross-references that will use the name or caption
3076−of the referenced item. The original link text is replaced once
3077−the generated document is refreshed. This extension can be combined
3078−with `xrefs_number` in which case numbers will appear before the
3079−name.
3080−
3081−Text in cross-references is only made consistent with the referenced
3082−item once the document has been refreshed.
3083−
3084−This extension can be enabled/disabled for the following formats:
3085−
3086−output formats
3087−: `odt`, `opendocument`
3088−
3089−#### Extension: `xrefs_number` ####
3090−
3091−Links to headings, figures and tables inside the document are
3092−substituted with cross-references that will use the number
3093−of the referenced item. The original link text is discarded.
3094−This extension can be combined with `xrefs_name` in which case
3095−the name or caption numbers will appear after the number.
3096−
3097−For the `xrefs_number` to be useful heading numbers must be enabled
3098−in the generated document, also table and figure captions must be enabled
3099−using for example the `native_numbering` extension.
3100−
3101−Numbers in cross-references are only visible in the final document once
3102−it has been refreshed.
3103−
3104−This extension can be enabled/disabled for the following formats:
3105−
3106−output formats
3107−: `odt`, `opendocument`
3108−
31092057#### Extension: `styles` #### {#ext-styles}
31102058
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.
2059+Read all docx styles as divs (for paragraph styles) and spans (for
2060+character styles) regardless of whether pandoc understands the meaning
2061+of these styles. This can be used with [docx custom
2062+styles](#custom-styles). Disabled by default.
31162063
31172064input formats
31182065: `docx`
@@ -3122,36 +2069,22 @@ input formats
31222069In the `muse` input format, this enables Text::Amuse
31232070extensions to Emacs Muse markup.
31242071
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−
31332072#### Extension: `citations` {#org-citations}
31342073
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.
2074+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2075+in `org` input.
31442076
31452077#### Extension: `ntb` ####
31462078
31472079In the `context` output format this enables the use of [Natural Tables
3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2080+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2081+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
31502082Natural tables allow more fine-grained global customization but come
31512083at a performance penalty compared to extreme tables.
31522084
31532085
3154−# Pandoc's Markdown
2086+Pandoc's Markdown
2087+=================
31552088
31562089Pandoc understands an extended and slightly revised version of
31572090John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -3161,7 +2094,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the
31612094behavior more granularly. They are described in the following. See also
31622095[Extensions] above, for extensions that work also on other formats.
31632096
3164−## Philosophy
2097+Philosophy
2098+----------
31652099
31662100Markdown is designed to be easy to write, and, even more importantly,
31672101easy to read:
@@ -3169,7 +2103,7 @@ easy to read:
31692103> A Markdown-formatted document should be publishable as-is, as plain
31702104> text, without looking like it's been marked up with tags or formatting
31712105> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2106+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
31732107
31742108This principle has guided pandoc's decisions in finding syntax for
31752109tables, footnotes, and other extensions.
@@ -3182,7 +2116,8 @@ it discourages it, and provides other, non-HTMLish ways of representing
31822116important document elements like definition lists, tables, mathematics, and
31832117footnotes.
31842118
3185−## Paragraphs
2119+Paragraphs
2120+----------
31862121
31872122A paragraph is one or more lines of text followed by one or more blank lines.
31882123Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -3195,42 +2130,43 @@ Note: in multiline and grid table cells, this is the only way
31952130to create a hard line break, since trailing spaces in the cells
31962131are ignored.
31972132
3198−## Headings
2133+Headers
2134+-------
31992135
3200−There are two kinds of headings: Setext and ATX.
2136+There are two kinds of headers: Setext and ATX.
32012137
3202−### Setext-style headings ###
2138+### Setext-style headers ###
32032139
3204−A setext-style heading is a line of text "underlined" with a row of `=` signs
3205−(for a level-one heading) or `-` signs (for a level-two heading):
2140+A setext-style header is a line of text "underlined" with a row of `=` signs
2141+(for a level one header) or `-` signs (for a level two header):
32062142
3207− A level-one heading
3208− ===================
2143+ A level-one header
2144+ ==================
32092145
3210− A level-two heading
3211− -------------------
2146+ A level-two header
2147+ ------------------
32122148
3213−The heading text can contain inline formatting, such as emphasis (see
2149+The header text can contain inline formatting, such as emphasis (see
32142150[Inline formatting], below).
32152151
32162152
3217−### ATX-style headings ###
2153+### ATX-style headers ###
32182154
3219−An ATX-style heading consists of one to six `#` signs and a line of
2155+An ATX-style header consists of one to six `#` signs and a line of
32202156text, optionally followed by any number of `#` signs. The number of
3221−`#` signs at the beginning of the line is the heading level:
2157+`#` signs at the beginning of the line is the header level:
32222158
3223− ## A level-two heading
2159+ ## A level-two header
32242160
3225− ### A level-three heading ###
2161+ ### A level-three header ###
32262162
3227−As with setext-style headings, the heading text can contain formatting:
2163+As with setext-style headers, the header text can contain formatting:
32282164
3229− # A level-one heading with a [link](/url) and *emphasis*
2165+ # A level-one header with a [link](/url) and *emphasis*
32302166
32312167#### Extension: `blank_before_header` ####
32322168
3233−Standard Markdown syntax does not require a blank line before a heading.
2169+Standard Markdown syntax does not require a blank line before a header.
32342170Pandoc does require this (except, of course, at the beginning of the
32352171document). The reason for the requirement is that it is all too easy for a
32362172`#` to end up at the beginning of a line by accident (perhaps through line
@@ -3242,30 +2178,29 @@ wrapping). Consider, for example:
32422178#### Extension: `space_in_atx_header` ####
32432179
32442180Many Markdown implementations do not require a space between the
3245−opening `#`s of an ATX heading and the heading text, so that
3246−`#5 bolt` and `#hashtag` count as headings. With this extension,
2181+opening `#`s of an ATX header and the header text, so that
2182+`#5 bolt` and `#hashtag` count as headers. With this extension,
32472183pandoc does require the space.
32482184
3249−### Heading identifiers ###
2185+### Header identifiers ###
32502186
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
2187+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
32532188
32542189#### Extension: `header_attributes` ####
32552190
3256−Headings can be assigned attributes using this syntax at the end
3257−of the line containing the heading text:
2191+Headers can be assigned attributes using this syntax at the end
2192+of the line containing the header text:
32582193
32592194 {#identifier .class .class key=value key=value}
32602195
3261−Thus, for example, the following headings will all be assigned the identifier
2196+Thus, for example, the following headers will all be assigned the identifier
32622197`foo`:
32632198
3264− # My heading {#foo}
2199+ # My header {#foo}
32652200
3266− ## My heading ## {#foo}
2201+ ## My header ## {#foo}
32672202
3268− My other heading {#foo}
2203+ My other header {#foo}
32692204 ---------------
32702205
32712206(This syntax is compatible with [PHP Markdown Extra].)
@@ -3274,56 +2209,51 @@ Note that although this syntax allows assignment of classes and key/value
32742209attributes, writers generally don't use all of this information. Identifiers,
32752210classes, and key/value attributes are used in HTML and HTML-based formats such
32762211as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
2212+LaTeX, ConTeXt, Textile, and AsciiDoc writers.
32782213
3279−Headings with the class `unnumbered` will not be numbered, even if
2214+Headers with the class `unnumbered` will not be numbered, even if
32802215`--number-sections` is specified. A single hyphen (`-`) in an attribute
32812216context is equivalent to `.unnumbered`, and preferable in non-English
32822217documents. So,
32832218
3284− # My heading {-}
2219+ # My header {-}
32852220
32862221is just the same as
32872222
3288− # My heading {.unnumbered}
3289−
3290−If the `unlisted` class is present in addition to `unnumbered`,
3291−the heading will not be included in a table of contents.
3292−(Currently this feature is only implemented for certain
3293−formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
2223+ # My header {.unnumbered}
32942224
32952225#### Extension: `implicit_header_references` ####
32962226
3297−Pandoc behaves as if reference links have been defined for each heading.
3298−So, to link to a heading
2227+Pandoc behaves as if reference links have been defined for each header.
2228+So, to link to a header
32992229
3300− # Heading identifiers in HTML
2230+ # Header identifiers in HTML
33012231
33022232you can simply write
33032233
3304− [Heading identifiers in HTML]
2234+ [Header identifiers in HTML]
33052235
33062236or
33072237
3308− [Heading identifiers in HTML][]
2238+ [Header identifiers in HTML][]
33092239
33102240or
33112241
3312− [the section on heading identifiers][heading identifiers in
2242+ [the section on header identifiers][header identifiers in
33132243 HTML]
33142244
33152245instead of giving the identifier explicitly:
33162246
3317− [Heading identifiers in HTML](#heading-identifiers-in-html)
2247+ [Header identifiers in HTML](#header-identifiers-in-html)
33182248
3319−If there are multiple headings with identical text, the corresponding
2249+If there are multiple headers with identical text, the corresponding
33202250reference will link to the first one only, and you will need to use explicit
33212251links to link to the others, as described above.
33222252
33232253Like regular reference links, these references are case-insensitive.
33242254
33252255Explicit link reference definitions always take priority over
3326−implicit heading references. So, in the following example, the
2256+implicit header references. So, in the following example, the
33272257link will point to `bar`, not to `#foo`:
33282258
33292259 # Foo
@@ -3332,11 +2262,12 @@ link will point to `bar`, not to `#foo`:
33322262
33332263 See [foo]
33342264
3335−## Block quotations
2265+Block quotations
2266+----------------
33362267
33372268Markdown uses email conventions for quoting blocks of text.
33382269A block quotation is one or more paragraphs or other block elements
3339−(such as lists or headings), with each line preceded by a `>` character
2270+(such as lists or headers), with each line preceded by a `>` character
33402271and an optional space. (The `>` need not start at the left margin, but
33412272it should not be indented more than three spaces.)
33422273
@@ -3371,19 +2302,19 @@ block in a block quote, you need five spaces after the `>`:
33712302
33722303#### Extension: `blank_before_blockquote` ####
33732304
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
2305+Standard Markdown syntax does not require a blank line before a block
2306+quote. Pandoc does require this (except, of course, at the beginning of the
2307+document). The reason for the requirement is that it is all too easy for a
2308+`>` to end up at the beginning of a line by accident (perhaps through line
2309+wrapping). So, unless the `markdown_strict` format is used, the following does
33802310not produce a nested block quote in pandoc:
33812311
33822312 > This is a block quote.
33832313 >> Nested.
33842314
33852315
3386−## Verbatim (code) blocks
2316+Verbatim (code) blocks
2317+----------------------
33872318
33882319### Indented code blocks ###
33892320
@@ -3445,16 +2376,14 @@ this syntax:
34452376 qsort (filter (>= x) xs)
34462377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34472378
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:
2379+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2380+`startFrom` is an attribute with value `100`. Some output formats can use this
2381+information to do syntax highlighting. Currently, the only output formats
2382+that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2383+highlighting is supported for your output format and language, then the code
2384+block above will appear highlighted, with numbered lines. (To see which
2385+languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2386+the code block above will appear as follows:
34582387
34592388 <pre id="mycode" class="haskell numberLines" startFrom="100">
34602389 <code>
@@ -3491,7 +2420,8 @@ To set the highlighting style, use `--highlight-style`.
34912420For more information on highlighting, see [Syntax highlighting],
34922421below.
34932422
3494−## Line blocks
2423+Line blocks
2424+-----------
34952425
34962426#### Extension: `line_blocks` ####
34972427
@@ -3517,12 +2447,10 @@ line must begin with a space.
35172447 | 200 Main St.
35182448 | Berkeley, CA 94718
35192449
3520−Inline formatting (such as emphasis) is allowed in the content,
3521−but not block-level formatting (such as block quotes or lists).
3522−
35232450This syntax is borrowed from [reStructuredText].
35242451
3525−## Lists
2452+Lists
2453+-----
35262454
35272455### Bullet lists ###
35282456
@@ -3723,12 +2651,11 @@ a blank line, and must be followed by one or more definitions.
37232651A definition begins with a colon or tilde, which may be indented one
37242652or two spaces.
37252653
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
2654+A term may have multiple definitions, and each definition may consist of one or
2655+more block elements (paragraph, code block, list, etc.), each indented four
2656+spaces or one tab stop. The body of the definition (including the first line,
2657+aside from the colon or tilde) should be indented four spaces. However,
2658+as with other Markdown lists, you can "lazily" omit indentation except
37322659at the beginning of a paragraph or other block element:
37332660
37342661 Term 1
@@ -3754,10 +2681,9 @@ definition:
37542681Note that space between items in a definition list is required.
37552682(A variant that loosens this requirement, but disallows "lazy"
37562683hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2684+[Non-pandoc extensions], below.)
37582685
3759−[^3]: I have been influenced by the suggestions of [David
3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2686+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
37612687
37622688### Numbered example lists ###
37632689
@@ -3793,6 +2719,30 @@ list marker. That is, example lists always behave as if the
37932719labels tend to be long, and indenting content to the
37942720first non-space character after the label would be awkward.
37952721
2722+### Compact and loose lists ###
2723+
2724+Pandoc behaves differently from `Markdown.pl` on some "edge
2725+cases" involving lists. Consider this source:
2726+
2727+ + First
2728+ + Second:
2729+ - Fee
2730+ - Fie
2731+ - Foe
2732+
2733+ + Third
2734+
2735+Pandoc transforms this into a "compact list" (with no `<p>` tags around
2736+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2737+"Second" and "Third" (but not "First"), because of the blank space
2738+around "Third". Pandoc follows a simple rule: if the text is followed by
2739+a blank line, it is treated as a paragraph. Since "Second" is followed
2740+by a list, and not a blank line, it isn't treated as a paragraph. The
2741+fact that the list is followed by a blank line is irrelevant. (Note:
2742+Pandoc works this way even when the `markdown_strict` format is specified. This
2743+behavior is consistent with the official Markdown syntax description,
2744+even though it is different from that of `Markdown.pl`.)
2745+
37962746
37972747### Ending a list ###
37982748
@@ -3831,7 +2781,8 @@ of one big list:
38312781 2. dos
38322782 3. tres
38332783
3834−## Horizontal rules
2784+Horizontal rules
2785+----------------
38352786
38362787A line containing a row of three or more `*`, `-`, or `_` characters
38372788(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +2792,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
38412792 ---------------
38422793
38432794
3844−## Tables
2795+Tables
2796+------
38452797
38462798Four kinds of tables may be used. The first three kinds presuppose the use of
38472799a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3866,7 +2818,7 @@ Simple tables look like this:
38662818
38672819 Table: Demonstration of simple table syntax.
38682820
3869−The header and table rows must each fit on one line. Column
2821+The headers and table rows must each fit on one line. Column
38702822alignments are determined by the position of the header text relative
38712823to the dashed line below it:[^4]
38722824
@@ -3885,7 +2837,7 @@ to the dashed line below it:[^4]
38852837The table must end with a blank line, or a line of dashes followed by
38862838a blank line.
38872839
3888−The column header row may be omitted, provided a dashed line is used
2840+The column headers may be omitted, provided a dashed line is used
38892841to end the table. For example:
38902842
38912843 ------- ------ ---------- -------
@@ -3894,13 +2846,13 @@ to end the table. For example:
38942846 1 1 1 1
38952847 ------- ------ ---------- -------
38962848
3897−When the header row is omitted, column alignments are determined on the basis
2849+When headers are omitted, column alignments are determined on the basis
38982850of the first line of the table body. So, in the tables above, the columns
38992851would be right, left, center, and right aligned, respectively.
39002852
39012853#### Extension: `multiline_tables` ####
39022854
3903−Multiline tables allow header and table rows to span multiple lines
2855+Multiline tables allow headers and table rows to span multiple lines
39042856of text (but cells that span multiple columns or rows of the table are
39052857not supported). Here is an example:
39062858
@@ -3922,7 +2874,7 @@ not supported). Here is an example:
39222874These work like simple tables, but with the following differences:
39232875
39242876 - They must begin with a row of dashes, before the header text
3925− (unless the header row is omitted).
2877+ (unless the headers are omitted).
39262878 - They must end with a row of dashes, then a blank line.
39272879 - The rows must be separated by blank lines.
39282880
@@ -3931,7 +2883,7 @@ the columns, and the writers try to reproduce these relative widths in
39312883the output. So, if you find that one of the columns is too narrow in the
39322884output, try widening it in the Markdown source.
39332885
3934−The header may be omitted in multiline tables as well as simple tables:
2886+Headers may be omitted in multiline tables as well as simple tables:
39352887
39362888 ----------- ------- --------------- -------------------------
39372889 First row 12.0 Example of a row that
@@ -3942,7 +2894,7 @@ The header may be omitted in multiline tables as well as simple tables:
39422894 rows.
39432895 ----------- ------- --------------- -------------------------
39442896
3945− : Here's a multiline table without a header.
2897+ : Here's a multiline table without headers.
39462898
39472899It is possible for a multiline table to have just one row, but the row
39482900should be followed by a blank line (and then the row of dashes that ends
@@ -3968,8 +2920,9 @@ The row of `=`s separates the header from the table body, and can be
39682920omitted for a headerless table. The cells of grid tables may contain
39692921arbitrary block elements (multiple paragraphs, code blocks, lists,
39702922etc.). Cells that span multiple columns or rows are not
3971−supported. Grid tables can be created easily using Emacs' table-mode
3972−(`M-x table-insert`).
2923+supported. Grid tables can be created easily using [Emacs table mode].
2924+
2925+[Emacs table mode]: http://table.sourceforge.net/
39732926
39742927Alignments can be specified as with pipe tables, by putting
39752928colons at the boundaries of the separator line after the
@@ -3997,7 +2950,7 @@ and the same number of rows in each column. For example, the
39972950Docutils [sample grid tables] will not render as expected with
39982951Pandoc.
39992952
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2953+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
40012954
40022955
40032956#### Extension: `pipe_tables` ####
@@ -4030,7 +2983,7 @@ legal (though ugly) pipe table:
40302983
40312984The cells of pipe tables cannot contain block elements like paragraphs
40322985and lists, and cannot span multiple lines. If a pipe table contains a
4033−row whose Markdown content is wider than the column width (see
2986+row whose printable content is wider than the column width (see
40342987`--columns`), then the table will take up the full text width and
40352988the cell contents will wrap, with the relative cell widths determined
40362989by the number of dashes in the line separating the table header from
@@ -4054,7 +3007,8 @@ you'll need to add colons as above.
40543007
40553008[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
40563009
4057−## Metadata blocks
3010+Metadata blocks
3011+---------------
40583012
40593013#### Extension: `pandoc_title_block` ####
40603014
@@ -4070,42 +3024,30 @@ output.) The block may contain just a title, a title and an author,
40703024or all three elements. If you want to include an author but no
40713025title, or a title and a date but no author, you need a blank line:
40723026
4073−```
4074−%
4075−% Author
4076−```
3027+ %
3028+ % Author
40773029
4078−```
4079−% My title
4080−%
4081−% June 15, 2006
4082−```
3030+ % My title
3031+ %
3032+ % June 15, 2006
40833033
40843034The title may occupy multiple lines, but continuation lines must
40853035begin with leading space, thus:
40863036
4087−```
4088−% My title
4089− on multiple lines
4090−```
3037+ % My title
3038+ on multiple lines
40913039
40923040If a document has multiple authors, the authors may be put on
40933041separate lines with leading space, or separated by semicolons, or
40943042both. So, all of the following are equivalent:
40953043
4096−```
4097−% Author One
4098− Author Two
4099−```
3044+ % Author One
3045+ Author Two
41003046
4101−```
4102−% Author One; Author Two
4103−```
3047+ % Author One; Author Two
41043048
4105−```
4106−% Author One;
4107− Author Two
4108−```
3049+ % Author One;
3050+ Author Two
41093051
41103052The date must fit on one line.
41113053
@@ -4146,7 +3088,7 @@ will also have "Version 4.0" in the header.
41463088
41473089#### Extension: `yaml_metadata_block` ####
41483090
4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three
3091+A YAML metadata block is a valid YAML object, delimited by a line of three
41503092hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
41513093(`...`) at the bottom. A YAML metadata block may occur anywhere in the
41523094document, but if it is not at the beginning, it must be preceded by a blank
@@ -4169,22 +3111,20 @@ given a role by external processors.) Field names must not be
41693111interpretable as YAML numbers or boolean values (so, for
41703112example, `yes`, `True`, and `15` cannot be used as field names).
41713113
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.
3114+A document may contain multiple metadata blocks. The metadata fields will
3115+be combined through a *left-biased union*: if two metadata blocks attempt
3116+to set the same field, the value from the first block will be taken.
41753117
41763118When pandoc is used with `-t markdown` to create a Markdown document,
41773119a YAML metadata block will be produced only if the `-s/--standalone`
41783120option is used. All of the metadata will appear in a single block
41793121at the beginning of the document.
41803122
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:
3123+Note that YAML escaping rules must be followed. Thus, for example,
3124+if a title contains a colon, it must be quoted. The pipe character
3125+(`|`) can be used to begin an indented block that will be interpreted
3126+literally, without need for escaping. This form is necessary
3127+when the field contains blank lines or block-level formatting:
41883128
41893129 ---
41903130 title: 'This is the title: it contains a colon'
@@ -4198,12 +3138,6 @@ or block-level formatting:
41983138 It consists of two paragraphs.
41993139 ...
42003140
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−
42073141Template variables will be set automatically from the metadata. Thus, for
42083142example, in writing HTML, the variable `abstract` will be set to the HTML
42093143equivalent of the Markdown in the `abstract` field:
@@ -4250,25 +3184,8 @@ will be interpreted as markdown. For example:
42503184 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
42513185 ```
42523186
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
3187+Backslash escapes
3188+-----------------
42723189
42733190#### Extension: `all_symbols_escapable` ####
42743191
@@ -4294,12 +3211,9 @@ which allows only the following characters to be backslash-escaped:
42943211(However, if the `markdown_strict` format is used, the standard Markdown rule
42953212will be used.)
42963213
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).
3214+A backslash-escaped space is parsed as a nonbreaking space. It will
3215+appear in TeX output as `~` and in HTML and XML as `\ ` or
3216+`\ `.
43033217
43043218A backslash-escaped newline (i.e. a backslash occurring at the end of
43053219a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +3223,8 @@ two trailing spaces on a line.
43093223
43103224Backslash escapes do not work in verbatim contexts.
43113225
4312−## Inline formatting
3226+Inline formatting
3227+-----------------
43133228
43143229### Emphasis ###
43153230
@@ -4357,13 +3272,12 @@ text by `~` characters. Thus, for example,
43573272
43583273 H~2~O is a liquid. 2^10^ is 1024.
43593274
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~`.
3275+If the superscripted or subscripted text contains spaces, these spaces
3276+must be escaped with backslashes. (This is to prevent accidental
3277+superscripting and subscripting through the ordinary use of `~` and `^`.)
3278+Thus, if you want the letter P with 'a cat' in subscripts, use
3279+`P~a\ cat~`, not `P~a cat~`.
3280+
43673281
43683282### Verbatim ###
43693283
@@ -4412,7 +3326,8 @@ For compatibility with other Markdown flavors, CSS is also supported:
44123326This will work in all output formats that support small caps.
44133327
44143328
4415−## Math
3329+Math
3330+----
44163331
44173332#### Extension: `tex_math_dollars` ####
44183333
@@ -4424,10 +3339,6 @@ left, and must not be followed immediately by a digit. Thus,
44243339you need to enclose text in literal `$` characters, backslash-escape
44253340them and they won't be treated as math delimiters.
44263341
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−
44313342TeX math will be printed in all output formats. How it is rendered
44323343depends on the output format:
44333344
@@ -4439,23 +3350,16 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki
44393350 ~ It will appear verbatim surrounded by `$...$` (for inline
44403351 math) or `$$...$$` (for display math).
44413352
4442−XWiki
4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4444−
44453353reStructuredText
44463354 ~ It will be rendered using an [interpreted text role `:math:`].
44473355
44483356AsciiDoc
4449− ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4450− surrounded by `latexmath:[$...$]` (for inline math) or
4451− `[latexmath]++++\[...\]+++` (for display math).
4452− For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4453− (`$..$` and `\[..\]`) are omitted.
3357+ ~ It will be rendered as `latexmath:[...]`.
44543358
44553359Texinfo
44563360 ~ It will be rendered inside a `@math` command.
44573361
4458−roff man, Jira markup
3362+roff man
44593363 ~ It will be rendered verbatim without `$`'s.
44603364
44613365MediaWiki, DokuWiki
@@ -4489,9 +3393,10 @@ HTML, Slidy, DZSlides, S5, EPUB
44893393 command-line options selected. Therefore see [Math rendering in HTML]
44903394 above.
44913395
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3396+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
44933397
4494−## Raw HTML
3398+Raw HTML
3399+--------
44953400
44963401#### Extension: `raw_html` ####
44973402
@@ -4529,7 +3434,7 @@ Thus, for example, pandoc will turn
45293434 <table>
45303435 <tr>
45313436 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3437+ <td>[a link](http://google.com)</td>
45333438 </tr>
45343439 </table>
45353440
@@ -4538,14 +3443,14 @@ into
45383443 <table>
45393444 <tr>
45403445 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3446+ <td><a href="http://google.com">a link</a></td>
45423447 </tr>
45433448 </table>
45443449
45453450whereas `Markdown.pl` will preserve it as is.
45463451
4547−There is one exception to this rule: text between `<script>`,
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3452+There is one exception to this rule: text between `<script>` and
3453+`<style>` tags is not interpreted as Markdown.
45493454
45503455This departure from standard Markdown should make it easier to mix
45513456Markdown with HTML block elements. For example, one can surround
@@ -4637,7 +3542,8 @@ example, to use a raw attribute with a backtick code block,
46373542
46383543The raw attribute cannot be combined with regular attributes.
46393544
4640−## LaTeX macros
3545+LaTeX macros
3546+------------
46413547
46423548#### Extension: `latex_macros` ####
46433549
@@ -4651,20 +3557,18 @@ all output formats, not just LaTeX:
46513557 $\tuple{a, b, c}$
46523558
46533559Note that LaTeX macros will not be applied if they occur
4654−inside a raw span or block marked with the
3560+inside inside a raw span or block marked with the
46553561[`raw_attribute` extension](#extension-raw_attribute).
46563562
46573563When `latex_macros` is disabled, the raw LaTeX and math will
46583564not have macros applied. This is usually a better approach when
46593565you are targeting LaTeX or PDF.
46603566
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.
3567+Whether or not `latex_macros` is enabled, the macro definitions
3568+will still be passed through as raw LaTeX.
46663569
4667−## Links
3570+Links
3571+-----
46683572
46693573Markdown allows links to be specified in several ways.
46703574
@@ -4673,7 +3577,7 @@ Markdown allows links to be specified in several ways.
46733577If you enclose a URL or email address in pointy brackets, it
46743578will become a link:
46753579
4676− <https://google.com>
3580+ <http://google.com>
46773581 <sam@green.eggs.ham>
46783582
46793583### Inline links ###
@@ -4683,7 +3587,7 @@ followed by the URL in parentheses. (Optionally, the URL can
46833587be followed by a link title, in quotes.)
46843588
46853589 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3590+ a title](http://fsf.org "click here for a good time!").
46873591
46883592There can be no space between the bracketed part and the parenthesized part.
46893593The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3616,7 @@ Here are some examples:
47123616
47133617 [my label 1]: /foo/bar.html "My title, optional"
47143618 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3619+ [my label 3]: http://fsf.org (The free software foundation)
47163620 [my label 4]: /bar#special 'A title in single quotes'
47173621
47183622The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3625,7 @@ The URL may optionally be surrounded by angle brackets:
47213625
47223626The title may go on the next line:
47233627
4724− [my label 3]: https://fsf.org
3628+ [my label 3]: http://fsf.org
47253629 "The free software foundation"
47263630
47273631Note that link labels are not case sensitive. So, this will work:
@@ -4759,7 +3663,7 @@ be omitted entirely:
47593663### Internal links ###
47603664
47613665To link to another section of the same document, use the automatically
4762−generated identifier (see [Heading identifiers]). For example:
3666+generated identifier (see [Header identifiers]). For example:
47633667
47643668 See the [Introduction](#introduction).
47653669
@@ -4772,7 +3676,8 @@ or
47723676Internal links are currently supported for HTML formats (including
47733677HTML slide shows and EPUB), LaTeX, and ConTeXt.
47743678
4775−## Images
3679+Images
3680+------
47763681
47773682A link immediately preceded by a `!` will be treated as an image.
47783683The link text will be used as the image's alt text:
@@ -4793,564 +3698,209 @@ image's alt text will be used as the caption.
47933698
47943699How this is rendered depends on the output format. Some output
47953700formats (e.g. RTF) do not yet support figures. In those
4796−formats, you'll just get an image in a paragraph by itself, with
4797−no caption.
4798−
4799−If you just want a regular inline image, just make sure it is not
4800−the only thing in the paragraph. One way to do this is to insert a
4801−nonbreaking space after the image:
4802−
4803− \
4804−
4805−Note that in reveal.js slide shows, an image in a paragraph
4806−by itself that has the `stretch` class will fill the screen,
4807−and the caption and figure tags will be omitted.
4808−
4809−#### Extension: `link_attributes` ####
4810−
4811−Attributes can be set on links and images:
4812−
4813− An inline {#id .class width=30 height=20px}
4814− and a reference ![image][ref] with attributes.
4815−
4816− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4817−
4818−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819−and `.class` are used.)
4820−
4821−For HTML and EPUB, all known HTML5 attributes except `width` and
4822−`height` (but including `srcset` and `sizes`) are passed through
4823−as is. Unknown attributes are passed through as custom
4824−attributes, with `data-` prepended. The other writers ignore
4825−attributes that are not specifically supported by their output format.
4826−
4827−The `width` and `height` attributes on images are treated specially. When
4828−used without a unit, the unit is assumed to be pixels. However, any of
4829−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4830−and `%`. There must not be any spaces between the number and the unit.
4831−For example:
4832−
4833−```
4834−{ width=50% }
4835−```
4836−
4837−- Dimensions may be converted to a form that is compatible with
4838− the output format (for example, dimensions given in pixels will
4839− be converted to inches when converting HTML to LaTeX). Conversion
4840− between pixels and physical measurements is affected by the
4841− `--dpi` option (by default, 96 dpi is assumed, unless the image
4842− itself contains dpi information).
4843−- The `%` unit is generally relative to some available space.
4844− For example the above example will render to the following.
4845− - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847− (If you're using a custom template, you need to configure `graphicx`
4848− as in the default template.)
4849− - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4850−- Some output formats have a notion of a class
4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4852− or a unique identifier (LaTeX `\caption`), or both (HTML).
4853−- When no `width` or `height` attributes are specified, the fallback
4854− is to look at the image resolution and the dpi metadata embedded in
4855− the image file.
4856−
4857−## Divs and Spans
4858−
4859−Using the `native_divs` and `native_spans` extensions
4860−(see [above][Extension: `native_divs`]), HTML syntax can
4861−be used as part of markdown to create native `Div` and `Span`
4862−elements in the pandoc AST (as opposed to raw HTML).
4863−However, there is also nicer syntax available:
4864−
4865−#### Extension: `fenced_divs` ####
4866−
4867−Allow special fenced syntax for native `Div` blocks. A Div
4868−starts with a fence containing at least three consecutive
4869−colons plus some attributes. The attributes may optionally
4870−be followed by another string of consecutive colons.
4871−The attribute syntax is exactly as in fenced code blocks (see
4872−[Extension: `fenced_code_attributes`]). As with fenced
4873−code blocks, one can use either attributes in curly braces
4874−or a single unbraced word, which will be treated as a class
4875−name. The Div ends with another line containing a string of at
4876−least three consecutive colons. The fenced Div should be
4877−separated by blank lines from preceding and following blocks.
4878−
4879−Example:
4880−
4881− ::::: {#special .sidebar}
4882− Here is a paragraph.
4883−
4884− And another.
4885− :::::
4886−
4887−Fenced divs can be nested. Opening fences are distinguished
4888−because they *must* have attributes:
4889−
4890− ::: Warning ::::::
4891− This is a warning.
4892−
4893− ::: Danger
4894− This is a warning within a warning.
4895− :::
4896− ::::::::::::::::::
4897−
4898−Fences without attributes are always closing fences. Unlike
4899−with fenced code blocks, the number of colons in the closing
4900−fence need not match the number in the opening fence. However,
4901−it can be helpful for visual clarity to use fences of different
4902−lengths to distinguish nested divs from their parents.
4903−
4904−
4905−#### Extension: `bracketed_spans` ####
4906−
4907−A bracketed sequence of inlines, as one would use to begin
4908−a link, will be treated as a `Span` with attributes if it is
4909−followed immediately by attributes:
4910−
4911− [This is *some text*]{.class key="val"}
4912−
4913−## Footnotes
4914−
4915−#### Extension: `footnotes` ####
4916−
4917−Pandoc's Markdown allows footnotes, using the following syntax:
4918−
4919− Here is a footnote reference,[^1] and another.[^longnote]
4920−
4921− [^1]: Here is the footnote.
4922−
4923− [^longnote]: Here's one with multiple blocks.
4924−
4925− Subsequent paragraphs are indented to show that they
4926− belong to the previous footnote.
4927−
4928− { some.code }
4929−
4930− The whole paragraph can be indented, or just the first
4931− line. In this way, multi-paragraph footnotes work like
4932− multi-paragraph list items.
4933−
4934− This paragraph won't be part of the note, because it
4935− isn't indented.
4936−
4937−The identifiers in footnote references may not contain spaces, tabs,
4938−or newlines. These identifiers are used only to correlate the
4939−footnote reference with the note itself; in the output, footnotes
4940−will be numbered sequentially.
4941−
4942−The footnotes themselves need not be placed at the end of the
4943−document. They may appear anywhere except inside other block elements
4944−(lists, block quotes, tables, etc.). Each footnote should be
4945−separated from surrounding content (including other footnotes)
4946−by blank lines.
4947−
4948−#### Extension: `inline_notes` ####
4949−
4950−Inline footnotes are also allowed (though, unlike regular notes,
4951−they cannot contain multiple paragraphs). The syntax is as follows:
4952−
4953− Here is an inline note.^[Inlines notes are easier to write, since
4954− you don't have to pick an identifier and move down to type the
4955− note.]
4956−
4957−Inline and regular footnotes may be mixed freely.
4958−
4959−## Citation syntax
4960−
4961−#### Extension: `citations` ####
4962−
4963−To cite a bibliographic item with an identifier foo, use the
4964−syntax `@foo`. Normal citations should be included in square
4965−brackets, with semicolons separating distinct items:
4966−
4967− Blah blah [@doe99; @smith2000; @smith2004].
4968−
4969−How this is rendered depends on the citation style. In an
4970−author-date style, it might render as
4971−
4972− Blah blah (Doe 1999, Smith 2000, 2004).
4973−
4974−In a footnote style, it might render as
4975−
4976− Blah blah.[^1]
4977−
4978− [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4979− Susan Smith, "Flies," *Journal of Insects* (2000);
4980− Susan Smith, "Bees," *Journal of Insects* (2004).
4981−
4982−See the [CSL user documentation] for more information about CSL
4983−styles and how they affect rendering.
4984−
4985−Unless a citation key start with a letter, digit, or `_`,
4986−and contains only alphanumerics and internal punctuation
4987−characters (`:.#$%&-+?<>~/`), it must be surrounded
4988−by curly braces, which are not considered part of the key.
4989−In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final
4990−period is not *internal* punctuation, so it is not included in
4991−the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including
4992−the final period. The curly braces are recommended if you use URLs as
4993−keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.
4994−
4995−Citation items may optionally include a prefix, a locator, and
4996−a suffix. In
4997−
4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4999−
5000−The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
5001−and suffix `and *passim*`. The second item (`smith04`) has
5002−locator `chap. 1` and no prefix or suffix.
5003−
5004−Pandoc uses some heuristics to separate the locator from the
5005−rest of the subject. It is sensitive to the locator terms
5006−defined in the [CSL locale files]. Either abbreviated or
5007−unabbreviated forms are accepted. In the `en-US` locale, locator
5008−terms can be written in either singular or plural forms, as
5009−`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5010−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
5011−`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012−`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
5013−`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
5014−`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
5015−`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5016−locator term is used, "page" is assumed.
5017−
5018−In complex cases, you can force something to be treated as
5019−a locator by enclosing it in curly braces or prevent parsing
5020−the suffix as locator by prepending curly braces:
5021−
5022− [@smith{ii, A, D-Z}, with a suffix]
5023− [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024− [@smith{}, 99 years later]
5025−
5026−A minus sign (`-`) before the `@` will suppress mention of
5027−the author in the citation. This can be useful when the
5028−author is already mentioned in the text:
5029−
5030− Smith says blah [-@smith04].
5031−
5032−You can also write an author-in-text citation, by omitting the
5033−square brackets:
5034−
5035− @smith04 says blah.
5036−
5037− @smith04 [p. 33] says blah.
5038−
5039−This will cause the author's name to be rendered, followed by
5040−the bibliographical details. Use this form when you want to
5041−make the citation the subject of a sentence.
5042−
5043−When you are using a note style, it is usually better to let
5044−citeproc create the footnotes from citations rather than writing
5045−an explicit note. If you do write an explicit note that
5046−contains a citation, note that normal citations will be put in
5047−parentheses, while author-in-text citations will not. For
5048−this reason, it is sometimes preferable to use the
5049−author-in-text style inside notes when using a note style.
5050−
5051−[CSL user documentation]: https://citationstyles.org/authors/
5052−[CSL]: https://docs.citationstyles.org/en/stable/specification.html
5053−[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5054−[Chicago Manual of Style]: https://chicagomanualofstyle.org
5055−[Citation Style Language]: https://citationstyles.org
5056−[Zotero Style Repository]: https://www.zotero.org/styles
5057−[finding and editing styles]: https://citationstyles.org/authors/
5058−[CSL locale files]: https://github.com/citation-style-language/locales
5059−
5060−## Non-default extensions
5061−
5062−The following Markdown syntax extensions are not enabled by default
5063−in pandoc, but may be enabled by adding `+EXTENSION` to the format
5064−name, where `EXTENSION` is the name of the extension. Thus, for
5065−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5066−
5067−#### Extension: `rebase_relative_paths` ####
5068−
5069−Rewrite relative paths for Markdown links and images, depending
5070−on the path of the file containing the link or image link. For
5071−each link or image, pandoc will compute the directory of the
5072−containing file, relative to the working directory, and prepend
5073−the resulting path to the link or image path.
5074−
5075−The use of this extension is best understood by example.
5076−Suppose you have a a subdirectory for each chapter of a book,
5077−`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a
5078−number of images used in the chapter. You would like to have
5079−`` in `chap1/text.md` refer to
5080−`chap1/spider.jpg` and `` in `chap2/text.md`
5081−refer to `chap2/spider.jpg`. To do this, use
5082−
5083− pandoc chap*/*.md -f markdown+rebase_relative_paths
5084−
5085−Without this extension, you would have to use
5086−`` in `chap1/text.md` and
5087−`` in `chap2/text.md`. Links with
5088−relative paths will be rewritten in the same way as images.
5089−
5090−Absolute paths and URLs are not changed. Neither are empty
5091−paths or paths consisting entirely of a fragment, e.g., `#foo`.
5092−
5093−Note that relative paths in reference links and images will
5094−be rewritten relative to the file containing the link
5095−reference definition, not the file containing the reference link
5096−or image itself, if these differ.
5097−
5098−#### Extension: `attributes` ####
5099−
5100−Allows attributes to be attached to any inline or block-level
5101−element. The syntax for the attributes is the same as that
5102−used in [`header_attributes`][Extension: `header_attributes`].
5103−
5104−- Attributes that occur immediately after an inline
5105− element affect that element. If they follow a space, then they
5106− belong to the space. (Hence, this option subsumes
5107− `inline_code_attributes` and `link_attributes`.)
5108−- Attributes that occur immediately before a block
5109− element, on a line by themselves, affect that
5110− element.
5111−- Consecutive attribute specifiers may be used,
5112− either for blocks or for inlines. Their attributes
5113− will be combined.
5114−- Attributes that occur at the end of the text of
5115− a Setext or ATX heading (separated by whitespace
5116− from the text) affect the heading element. (Hence, this
5117− option subsumes `header_attributes`.)
5118−- Attributes that occur after the opening fence
5119− in a fenced code block affect the code block element. (Hence,
5120− this option subsumes `fenced_code_attributes`.)
5121−- Attributes that occur at the end of a reference
5122− link definition affect links that refer to that
5123− definition.
5124−
5125−Note that pandoc's AST does not currently allow attributes
5126−to be attached to arbitrary elements. Hence a Span or Div
5127−container will be added if needed.
5128−
5129−#### Extension: `old_dashes` ####
5130−
5131−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5132−`-` before a numeral is an en-dash, and `--` is an em-dash.
5133−This option only has an effect if `smart` is enabled. It is
5134−selected automatically for `textile` input.
5135−
5136−#### Extension: `angle_brackets_escapable` ####
5137−
5138−Allow `<` and `>` to be backslash-escaped, as they can be in
5139−GitHub flavored Markdown but not original Markdown. This is
5140−implied by pandoc's default `all_symbols_escapable`.
5141−
5142−#### Extension: `lists_without_preceding_blankline` ####
5143−
5144−Allow a list to occur right after a paragraph, with no intervening
5145−blank space.
5146−
5147−#### Extension: `four_space_rule` ####
5148−
5149−Selects the pandoc <= 2.0 behavior for parsing lists, so that
5150−four spaces indent are needed for list item continuation
5151−paragraphs.
5152−
5153−#### Extension: `spaced_reference_links` ####
5154−
5155−Allow whitespace between the two components of a reference link,
5156−for example,
5157−
5158− [foo] [bar].
5159−
5160−#### Extension: `hard_line_breaks` ####
5161−
5162−Causes all newlines within a paragraph to be interpreted as hard line
5163−breaks instead of spaces.
5164−
5165−#### Extension: `ignore_line_breaks` ####
5166−
5167−Causes newlines within a paragraph to be ignored, rather than being
5168−treated as spaces or as hard line breaks. This option is intended for
5169−use with East Asian languages where spaces are not used between words,
5170−but text is divided into lines for readability.
5171−
5172−#### Extension: `east_asian_line_breaks` ####
5173−
5174−Causes newlines within a paragraph to be ignored, rather than
5175−being treated as spaces or as hard line breaks, when they occur
5176−between two East Asian wide characters. This is a better choice
5177−than `ignore_line_breaks` for texts that include a mix of East
5178−Asian wide characters and other characters.
5179−
5180−#### Extension: `emoji` ####
3701+formats, you'll just get an image in a paragraph by itself, with
3702+no caption.
51813703
5182−Parses textual emojis like `:smile:` as Unicode emoticons.
3704+If you just want a regular inline image, just make sure it is not
3705+the only thing in the paragraph. One way to do this is to insert a
3706+nonbreaking space after the image:
51833707
5184−#### Extension: `tex_math_single_backslash` ####
3708+ \
51853709
5186−Causes anything between `\(` and `\)` to be interpreted as inline
5187−TeX math, and anything between `\[` and `\]` to be interpreted
5188−as display TeX math. Note: a drawback of this extension is that
5189−it precludes escaping `(` and `[`.
3710+Note that in reveal.js slide shows, an image in a paragraph
3711+by itself that has the `stretch` class will fill the screen,
3712+and the caption and figure tags will be omitted.
51903713
5191−#### Extension: `tex_math_double_backslash` ####
3714+#### Extension: `link_attributes` ####
51923715
5193−Causes anything between `\\(` and `\\)` to be interpreted as inline
5194−TeX math, and anything between `\\[` and `\\]` to be interpreted
5195−as display TeX math.
3716+Attributes can be set on links and images:
51963717
5197−#### Extension: `markdown_attribute` ####
3718+ An inline {#id .class width=30 height=20px}
3719+ and a reference ![image][ref] with attributes.
51983720
5199−By default, pandoc interprets material inside block-level tags as Markdown.
5200−This extension changes the behavior so that Markdown is only parsed
5201−inside block-level tags if the tags have the attribute `markdown=1`.
3721+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
52023722
5203−#### Extension: `mmd_title_block` ####
3723+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3724+and `.class` are used.)
52043725
5205−Enables a [MultiMarkdown] style title block at the top of
5206−the document, for example:
3726+For HTML and EPUB, all attributes except `width` and `height` (but
3727+including `srcset` and `sizes`) are passed through as is. The other
3728+writers ignore attributes that are not supported by their output
3729+format.
52073730
5208− Title: My title
5209− Author: John Doe
5210− Date: September 1, 2008
5211− Comment: This is a sample mmd title block, with
5212− a field spanning multiple lines.
3731+The `width` and `height` attributes on images are treated specially. When
3732+used without a unit, the unit is assumed to be pixels. However, any of
3733+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3734+and `%`. There must not be any spaces between the number and the unit.
3735+For example:
52133736
5214−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5215−`yaml_metadata_block` is enabled, it will take precedence over
5216−`mmd_title_block`.
3737+```
3738+{ width=50% }
3739+```
52173740
5218−#### Extension: `abbreviations` ####
3741+- Dimensions are converted to inches for output in page-based formats like
3742+ LaTeX. Dimensions are converted to pixels for output in HTML-like
3743+ formats. Use the `--dpi` option to specify the number of pixels per
3744+ inch. The default is 96dpi.
3745+- The `%` unit is generally relative to some available space.
3746+ For example the above example will render to the following.
3747+ - HTML: `<img href="file.jpg" style="width: 50%;" />`
3748+ - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
3749+ (If you're using a custom template, you need to configure `graphicx`
3750+ as in the default template.)
3751+ - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3752+- Some output formats have a notion of a class
3753+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3754+ or a unique identifier (LaTeX `\caption`), or both (HTML).
3755+- When no `width` or `height` attributes are specified, the fallback
3756+ is to look at the image resolution and the dpi metadata embedded in
3757+ the image file.
52193758
5220−Parses PHP Markdown Extra abbreviation keys, like
3759+Divs and Spans
3760+--------------
52213761
5222− *[HTML]: Hypertext Markup Language
3762+Using the `native_divs` and `native_spans` extensions
3763+(see [above][Extension: `native_divs`]), HTML syntax can
3764+be used as part of markdown to create native `Div` and `Span`
3765+elements in the pandoc AST (as opposed to raw HTML).
3766+However, there is also nicer syntax available:
52233767
5224−Note that the pandoc document model does not support
5225−abbreviations, so if this extension is enabled, abbreviation keys are
5226−simply skipped (as opposed to being parsed as paragraphs).
3768+#### Extension: `fenced_divs` ####
52273769
5228−#### Extension: `autolink_bare_uris` ####
3770+Allow special fenced syntax for native `Div` blocks. A Div
3771+starts with a fence containing at least three consecutive
3772+colons plus some attributes. The attributes may optionally
3773+be followed by another string of consecutive colons.
3774+The attribute syntax is exactly as in fenced code blocks (see
3775+[Extension: `fenced_code_attributes`]). As with fenced
3776+code blocks, one can use either attributes in curly braces
3777+or a single unbraced word, which will be treated as a class
3778+name. The Div ends with another line containing a string of at
3779+least three consecutive colons. The fenced Div should be
3780+separated by blank lines from preceding and following blocks.
52293781
5230−Makes all absolute URIs into links, even when not surrounded by
5231−pointy braces `<...>`.
3782+Example:
52323783
5233−#### Extension: `mmd_link_attributes` ####
3784+ ::::: {#special .sidebar}
3785+ Here is a paragraph.
52343786
5235−Parses multimarkdown style key-value attributes on link
5236−and image references. This extension should not be confused with the
5237−[`link_attributes`](#extension-link_attributes) extension.
3787+ And another.
3788+ :::::
52383789
5239− This is a reference ![image][ref] with multimarkdown attributes.
3790+Fenced divs can be nested. Opening fences are distinguished
3791+because they *must* have attributes:
52403792
5241− [ref]: https://path.to/image "Image title" width=20px height=30px
5242− id=myId class="myClass1 myClass2"
3793+ ::: Warning ::::::
3794+ This is a warning.
52433795
5244−#### Extension: `mmd_header_identifiers` ####
3796+ ::: Danger
3797+ This is a warning within a warning.
3798+ :::
3799+ ::::::::::::::::::
52453800
5246−Parses multimarkdown style heading identifiers (in square brackets,
5247−after the heading but before any trailing `#`s in an ATX heading).
3801+Fences without attributes are always closing fences. Unlike
3802+with fenced code blocks, the number of colons in the closing
3803+fence need not match the number in the opening fence. However,
3804+it can be helpful for visual clarity to use fences of different
3805+lengths to distinguish nested divs from their parents.
52483806
5249−#### Extension: `compact_definition_lists` ####
52503807
5251−Activates the definition list syntax of pandoc 1.12.x and earlier.
5252−This syntax differs from the one described above under [Definition lists]
5253−in several respects:
3808+#### Extension: `bracketed_spans` ####
52543809
5255− - No blank line is required between consecutive items of the
5256− definition list.
5257− - To get a "tight" or "compact" list, omit space between consecutive
5258− items; the space between a term and its definition does not affect
5259− anything.
5260− - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261− be indented four spaces.[^6]
3810+A bracketed sequence of inlines, as one would use to begin
3811+a link, will be treated as a `Span` with attributes if it is
3812+followed immediately by attributes:
52623813
5263−[^6]: To see why laziness is incompatible with relaxing the requirement
5264− of a blank line between items, consider the following example:
3814+ [This is *some text*]{.class key="val"}
52653815
5266− bar
5267− : definition
5268− foo
5269− : definition
3816+Footnotes
3817+---------
52703818
5271− Is this a single list item with two definitions of "bar," the first of
5272− which is lazily wrapped, or two list items? To remove the ambiguity
5273− we must either disallow lazy wrapping or require a blank line between
5274− list items.
3819+#### Extension: `footnotes` ####
52753820
5276−#### Extension: `gutenberg` ####
3821+Pandoc's Markdown allows footnotes, using the following syntax:
52773822
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.
3823+ Here is a footnote reference,[^1] and another.[^longnote]
52813824
5282− [Project Gutenberg]: https://www.gutenberg.org
3825+ [^1]: Here is the footnote.
52833826
5284−#### Extension: `sourcepos` ####
3827+ [^longnote]: Here's one with multiple blocks.
52853828
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.
3829+ Subsequent paragraphs are indented to show that they
3830+ belong to the previous footnote.
52903831
5291−## Markdown variants
3832+ { some.code }
52923833
5293−In addition to pandoc's extended Markdown, the following Markdown
5294−variants are supported:
3834+ The whole paragraph can be indented, or just the first
3835+ line. In this way, multi-paragraph footnotes work like
3836+ multi-paragraph list items.
52953837
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)
3838+ This paragraph won't be part of the note, because it
3839+ isn't indented.
53033840
5304−To see which extensions are supported for a given format,
5305−and which are enabled by default, you can use the command
3841+The identifiers in footnote references may not contain spaces, tabs,
3842+or newlines. These identifiers are used only to correlate the
3843+footnote reference with the note itself; in the output, footnotes
3844+will be numbered sequentially.
53063845
5307− pandoc --list-extensions=FORMAT
3846+The footnotes themselves need not be placed at the end of the
3847+document. They may appear anywhere except inside other block elements
3848+(lists, block quotes, tables, etc.). Each footnote should be
3849+separated from surrounding content (including other footnotes)
3850+by blank lines.
53083851
5309−where `FORMAT` is replaced with the name of the format.
3852+#### Extension: `inline_notes` ####
53103853
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.
3854+Inline footnotes are also allowed (though, unlike regular notes,
3855+they cannot contain multiple paragraphs). The syntax is as follows:
53163856
5317−# Citations
3857+ Here is an inline note.^[Inlines notes are easier to write, since
3858+ you don't have to pick an identifier and move down to type the
3859+ note.]
53183860
5319−When the `--citeproc` option is used, pandoc can automatically generate
5320−citations and a bibliography in a number of styles. Basic usage is
3861+Inline and regular footnotes may be mixed freely.
53213862
5322− pandoc --citeproc myinput.txt
3863+Citations
3864+---------
53233865
5324−To use this feature, you will need to have
3866+#### Extension: `citations` ####
53253867
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.
3868+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
3869+citations and a bibliography in a number of styles. Basic usage is
53303870
5331−## Specifying bibliographic data
3871+ pandoc --filter pandoc-citeproc myinput.txt
53323872
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:
3873+In order to use this feature, you will need to specify a bibliography file
3874+using the `bibliography` metadata field in a YAML metadata section, or
3875+`--bibliography` command line argument. You can supply multiple `--bibliography`
3876+arguments or set `bibliography` metadata field to YAML array, if you want to
3877+use multiple bibliography files. The bibliography may have any of these
3878+formats:
53393879
53403880 Format File extension
53413881 ------------ --------------
53423882 BibLaTeX .bib
53433883 BibTeX .bibtex
3884+ Copac .copac
53443885 CSL JSON .json
53453886 CSL YAML .yaml
3887+ EndNote .enl
3888+ EndNote XML .xml
3889+ ISI .wos
3890+ MEDLINE .medline
3891+ MODS .mods
3892+ RIS .ris
53463893
53473894Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
3895+use `.bibtex` to force BibTeX.
53493896
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]:
3897+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3898+can produce `.json` and `.yaml` files from any of the supported formats.
3899+
3900+In-field markup: In BibTeX and BibLaTeX databases,
3901+pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
3902+databases, pandoc Markdown; and in CSL JSON databases, an
3903+[HTML-like markup][CSL markup specs]:
53543904
53553905`<i>...</i>`
53563906: italics
@@ -5370,11 +3920,14 @@ markup specs]:
53703920`<span class="nocase">...</span>`
53713921: prevent a phrase from being capitalized as title case
53723922
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:
3923+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3924+and CSL YAML formats as far as possible.
3925+
3926+As an alternative to specifying a bibliography file using `--bibliography`
3927+or the YAML metadata field `bibliography`, you can include
3928+the citation data directly in the `references` field of the
3929+document's YAML metadata. The field should contain an array of
3930+YAML-encoded references, for example:
53783931
53793932 ---
53803933 references:
@@ -5390,273 +3943,345 @@ array of YAML-encoded references, for example:
53903943 - - 1953
53913944 - 4
53923945 - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
5394− deoxyribose nucleic acid'
3946+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3947+ nucleic acid'
53953948 title-short: Molecular structure of nucleic acids
53963949 container-title: Nature
53973950 volume: 171
53983951 issue: 4356
53993952 page: 737-738
54003953 DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
3954+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
54023955 language: en-GB
54033956 ...
54043957
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.
3958+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3959+of the supported formats.)
3960+
3961+Citations and references can be formatted using any style supported by the
3962+[Citation Style Language], listed in the [Zotero Style Repository].
3963+These files are specified using the `--csl` option or the `csl` metadata field.
3964+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3965+format. The CSL project provides further information on [finding and editing styles].
3966+
3967+To make your citations hyperlinks to the corresponding bibliography
3968+entries, add `link-citations: true` to your YAML metadata.
3969+
3970+Citations go inside square brackets and are separated by semicolons.
3971+Each citation must have a key, composed of '@' + the citation
3972+identifier from the database, and may optionally have a prefix,
3973+a locator, and a suffix. The citation key must begin with a letter, digit,
3974+or `_`, and may contain alphanumerics, `_`, and internal punctuation
3975+characters (`:.#$%&-+?<>~/`). Here are some examples:
3976+
3977+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3978+
3979+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3980+
3981+ Blah blah [@smith04; @doe99].
3982+
3983+`pandoc-citeproc` detects locator terms in the [CSL locale files].
3984+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3985+locale, locator terms can be written in either singular or plural forms,
3986+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3987+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3988+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3989+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3990+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3991+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3992+locator term is used, "page" is assumed.
3993+
3994+`pandoc-citeproc` will use heuristics to distinguish the locator
3995+from the suffix. In complex cases, the locator can be enclosed
3996+in curly braces (using `pandoc-citeproc` 0.15 and higher only):
3997+
3998+ [@smith{ii, A, D-Z}, with a suffix]
3999+ [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
4000+
4001+A minus sign (`-`) before the `@` will suppress mention of
4002+the author in the citation. This can be useful when the
4003+author is already mentioned in the text:
4004+
4005+ Smith says blah [-@smith04].
4006+
4007+You can also write an in-text citation, as follows:
4008+
4009+ @smith04 says blah.
4010+
4011+ @smith04 [p. 33] says blah.
4012+
4013+If the style calls for a list of works cited, it will be placed
4014+in a div with id `refs`, if one exists:
4015+
4016+ ::: {#refs}
4017+ :::
4018+
4019+Otherwise, it will be placed at the end of the document.
4020+Generation of the bibliography can be suppressed by setting
4021+`suppress-bibliography: true` in the YAML metadata.
4022+
4023+If you wish the bibliography to have a section header, you can
4024+set `reference-section-title` in the metadata, or put the header
4025+at the beginning of the div with id `refs` (if you are using it)
4026+or at the end of your document:
4027+
4028+ last paragraph...
54084029
5409−Note that `pandoc` can be used to produce such a YAML metadata
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
4030+ # References
4031+
4032+The bibliography will be inserted after this header. Note that
4033+the `unnumbered` class will be added to this header, so that the
4034+section will not be numbered.
54114035
5412− pandoc chem.bib -s -f biblatex -t markdown
5413− pandoc chem.json -s -f csljson -t markdown
4036+If you want to include items in the bibliography without actually
4037+citing them in the body text, you can define a dummy `nocite` metadata
4038+field and put the citations there:
54144039
5415−Indeed, `pandoc` can convert between any of these
5416−citation formats:
4040+ ---
4041+ nocite: |
4042+ @item1, @item2
4043+ ...
54174044
5418− pandoc chem.bib -s -f biblatex -t csljson
5419− pandoc chem.yaml -s -f markdown -t biblatex
4045+ @item3
54204046
5421−Running pandoc on a bibliography file with the `--citeproc`
5422−option will create a formatted bibliography in the format
5423−of your choice:
4047+In this example, the document will contain a citation for `item3`
4048+only, but the bibliography will contain entries for `item1`, `item2`, and
4049+`item3`.
54244050
5425− pandoc chem.bib -s --citeproc -o chem.html
5426− pandoc chem.bib -s --citeproc -o chem.pdf
4051+It is possible to create a bibliography with all the citations,
4052+whether or not they appear in the document, by using a wildcard:
54274053
5428−### Capitalization in titles
4054+ ---
4055+ nocite: |
4056+ @*
4057+ ...
54294058
5430−If you are using a bibtex or biblatex bibliography, then observe
5431−the following rules:
4059+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4060+render the bibliography. In order to do so, specify bibliography
4061+files as outlined above, and add `--natbib` or `--biblatex`
4062+argument to `pandoc` invocation. Bear in mind that bibliography
4063+files have to be in respective format (either BibTeX or
4064+BibLaTeX).
54324065
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`.)
4066+For more information, see the [pandoc-citeproc man page].
54384067
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:
4068+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4069+[Chicago Manual of Style]: http://chicagomanualofstyle.org
4070+[Citation Style Language]: http://citationstyles.org
4071+[Zotero Style Repository]: https://www.zotero.org/styles
4072+[finding and editing styles]: https://citationstyles.org/authors/
4073+[CSL locale files]: https://github.com/citation-style-language/locales
4074+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
54424075
5443− title = {My Dinner with {Andre}}
4076+Non-pandoc extensions
4077+---------------------
54444078
5445− - In addition, words that should remain lowercase (or camelCase)
5446− should be protected:
4079+The following Markdown syntax extensions are not enabled by default
4080+in pandoc, but may be enabled by adding `+EXTENSION` to the format
4081+name, where `EXTENSION` is the name of the extension. Thus, for
4082+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
54474083
5448− title = {Spin Wave Dispersion on the {nm} Scale}
4084+#### Extension: `old_dashes` ####
54494085
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.
4086+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4087+`-` before a numeral is an en-dash, and `--` is an em-dash.
4088+This option only has an effect if `smart` is enabled. It is
4089+selected automatically for `textile` input.
54544090
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
5456−the following rules:
4091+#### Extension: `angle_brackets_escapable` ####
54574092
5458− - All titles should be in sentence case.
4093+Allow `<` and `>` to be backslash-escaped, as they can be in
4094+GitHub flavored Markdown but not original Markdown. This is
4095+implied by pandoc's default `all_symbols_escapable`.
54594096
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.)
4097+#### Extension: `lists_without_preceding_blankline` ####
54634098
5464− - Protect words that should not be converted to title case using
5465− this syntax:
4099+Allow a list to occur right after a paragraph, with no intervening
4100+blank space.
54664101
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
4102+#### Extension: `four_space_rule` ####
54684103
5469−### Conference Papers, Published vs. Unpublished
4104+Selects the pandoc <= 2.0 behavior for parsing lists, so that
4105+four spaces indent are needed for list item continuation
4106+paragraphs.
54704107
5471−For a formally published conference paper, use the biblatex entry type
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
4108+#### Extension: `spaced_reference_links` ####
54734109
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`).
4110+Allow whitespace between the two components of a reference link,
4111+for example,
54774112
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.
4113+ [foo] [bar].
54874114
4115+#### Extension: `hard_line_breaks` ####
54884116
5489−## Specifying a citation style
4117+Causes all newlines within a paragraph to be interpreted as hard line
4118+breaks instead of spaces.
54904119
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:
4120+#### Extension: `ignore_line_breaks` ####
55074121
4122+Causes newlines within a paragraph to be ignored, rather than being
4123+treated as spaces or as hard line breaks. This option is intended for
4124+use with East Asian languages where spaces are not used between words,
4125+but text is divided into lines for readability.
55084126
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− }
4127+#### Extension: `east_asian_line_breaks` ####
55174128
4129+Causes newlines within a paragraph to be ignored, rather than
4130+being treated as spaces or as hard line breaks, when they occur
4131+between two East Asian wide characters. This is a better choice
4132+than `ignore_line_breaks` for texts that include a mix of East
4133+Asian wide characters and other characters.
55184134
5519−## Citations in note styles
4135+#### Extension: `emoji` ####
55204136
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,
4137+Parses textual emojis like `:smile:` as Unicode emoticons.
55274138
5528− Blah blah [@foo, p. 33].
4139+#### Extension: `tex_math_single_backslash` ####
55294140
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].
4141+Causes anything between `\(` and `\)` to be interpreted as inline
4142+TeX math, and anything between `\[` and `\]` to be interpreted
4143+as display TeX math. Note: a drawback of this extension is that
4144+it precludes escaping `(` and `[`.
55354145
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:
4146+#### Extension: `tex_math_double_backslash` ####
55414147
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].
4148+Causes anything between `\\(` and `\\)` to be interpreted as inline
4149+TeX math, and anything between `\\[` and `\\]` to be interpreted
4150+as display TeX math.
55454151
5546−## Raw content in a style
4152+#### Extension: `markdown_attribute` ####
55474153
5548−To include raw content in a prefix, suffix, delimiter, or term,
5549−surround it with these tags indicating the format:
4154+By default, pandoc interprets material inside block-level tags as Markdown.
4155+This extension changes the behavior so that Markdown is only parsed
4156+inside block-level tags if the tags have the attribute `markdown=1`.
55504157
5551− {{jats}}<ref>{{/jats}}
4158+#### Extension: `mmd_title_block` ####
55524159
5553−Without the tags, the string will be interpreted as a string
5554−and escaped in the output, rather than being passed through raw.
4160+Enables a [MultiMarkdown] style title block at the top of
4161+the document, for example:
55554162
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.
4163+ Title: My title
4164+ Author: John Doe
4165+ Date: September 1, 2008
4166+ Comment: This is a sample mmd title block, with
4167+ a field spanning multiple lines.
55604168
4169+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4170+`yaml_metadata_block` is enabled, it will take precedence over
4171+`mmd_title_block`.
55614172
4173+#### Extension: `abbreviations` ####
55624174
5563−## Placement of the bibliography
4175+Parses PHP Markdown Extra abbreviation keys, like
55644176
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:
4177+ *[HTML]: Hypertext Markup Language
55674178
5568− ::: {#refs}
5569− :::
4179+Note that the pandoc document model does not support
4180+abbreviations, so if this extension is enabled, abbreviation keys are
4181+simply skipped (as opposed to being parsed as paragraphs).
55704182
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.
4183+#### Extension: `autolink_bare_uris` ####
55744184
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:
4185+Makes all absolute URIs into links, even when not surrounded by
4186+pointy braces `<...>`.
55794187
5580− last paragraph...
4188+#### Extension: `mmd_link_attributes` ####
55814189
5582− # References
4190+Parses multimarkdown style key-value attributes on link
4191+and image references. This extension should not be confused with the
4192+[`link_attributes`](#extension-link_attributes) extension.
55834193
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.
4194+ This is a reference ![image][ref] with multimarkdown attributes.
55874195
5588−## Including uncited items in the bibliography
4196+ [ref]: http://path.to/image "Image title" width=20px height=30px
4197+ id=myId class="myClass1 myClass2"
55894198
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:
4199+#### Extension: `mmd_header_identifiers` ####
55934200
5594− ---
5595− nocite: |
5596− @item1, @item2
5597− ...
4201+Parses multimarkdown style header identifiers (in square brackets,
4202+after the header but before any trailing `#`s in an ATX header).
55984203
5599− @item3
4204+#### Extension: `compact_definition_lists` ####
56004205
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`.
4206+Activates the definition list syntax of pandoc 1.12.x and earlier.
4207+This syntax differs from the one described above under [Definition lists]
4208+in several respects:
56044209
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:
4210+ - No blank line is required between consecutive items of the
4211+ definition list.
4212+ - To get a "tight" or "compact" list, omit space between consecutive
4213+ items; the space between a term and its definition does not affect
4214+ anything.
4215+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
4216+ be indented four spaces.[^6]
56074217
5608− ---
5609− nocite: |
5610− @*
5611− ...
4218+[^6]: To see why laziness is incompatible with relaxing the requirement
4219+ of a blank line between items, consider the following example:
56124220
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.
4221+ bar
4222+ : definition
4223+ foo
4224+ : definition
56194225
5620−## Other relevant metadata fields
4226+ Is this a single list item with two definitions of "bar," the first of
4227+ which is lazily wrapped, or two list items? To remove the ambiguity
4228+ we must either disallow lazy wrapping or require a blank line between
4229+ list items.
56214230
5622−A few other metadata fields affect bibliography formatting:
4231+Markdown variants
4232+-----------------
56234233
5624−`link-citations`
5625−: If true, citations will be
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
4234+In addition to pandoc's extended Markdown, the following Markdown
4235+variants are supported:
56284236
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
4237+`markdown_phpextra` (PHP Markdown Extra)
4238+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4239+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4240+ `header_attributes`, `link_attributes`, `abbreviations`,
4241+ `shortcut_reference_links`, `spaced_reference_links`.
4242+
4243+`markdown_github` (deprecated GitHub-Flavored Markdown)
4244+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4245+ `gfm_auto_identifiers`, `backtick_code_blocks`,
4246+ `autolink_bare_uris`, `space_in_atx_header`,
4247+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4248+ `shortcut_reference_links`, `angle_brackets_escapable`,
4249+ `lists_without_preceding_blankline`.
4250+
4251+`markdown_mmd` (MultiMarkdown)
4252+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4253+ `tex_math_double_backslash`, `intraword_underscores`,
4254+ `mmd_title_block`, `footnotes`, `definition_lists`,
4255+ `all_symbols_escapable`, `implicit_header_references`,
4256+ `auto_identifiers`, `mmd_header_identifiers`,
4257+ `shortcut_reference_links`, `implicit_figures`,
4258+ `superscript`, `subscript`, `backtick_code_blocks`,
4259+ `spaced_reference_links`, `raw_attribute`.
4260+
4261+`markdown_strict` (Markdown.pl)
4262+: `raw_html`, `shortcut_reference_links`,
4263+ `spaced_reference_links`.
4264+
4265+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4266+which is implemented as a set of extensions on `commonmark`).
4267+
4268+Note, however, that `commonmark` and `gfm` have limited support
4269+for extensions. Only those listed below (and `smart`,
4270+`raw_tex`, and `hard_line_breaks`) will work. The extensions
4271+can, however, all be individually disabled. Also, `raw_tex`
4272+only affects `gfm` output, not input.
4273+
4274+`gfm` (GitHub-Flavored Markdown)
4275+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4276+ `gfm_auto_identifiers`, `backtick_code_blocks`,
4277+ `autolink_bare_uris`, `space_in_atx_header`,
4278+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4279+ `shortcut_reference_links`, `angle_brackets_escapable`,
4280+ `lists_without_preceding_blankline`.
4281+
4282+
4283+Producing slide shows with pandoc
4284+=================================
56604285
56614286You can use pandoc to produce an HTML + JavaScript slide presentation
56624287that can be viewed via a web browser. There are five ways to do this,
@@ -5704,21 +4329,18 @@ To produce an HTML/JavaScript slide show, simply type
57044329
57054330where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
57064331
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.
4332+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4333+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4334+assumed to be available at the relative path `s5/default` (for S5), `slideous`
4335+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4336+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4337+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4338+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4339+the file by default.
4340+
4341+With all HTML slide formats, the `--self-contained` option can be used to
4342+produce a single file that contains all of the data necessary to display the
4343+slide show, including linked scripts, stylesheets, images, and videos.
57224344
57234345To produce a PDF slide show using beamer, type
57244346
@@ -5731,13 +4353,14 @@ To produce a Powerpoint slide show, type
57314353
57324354 pandoc habits.txt -o habits.pptx
57334355
5734−## Structuring the slide show
4356+Structuring the slide show
4357+--------------------------
57354358
5736−By default, the *slide level* is the highest heading level in
4359+By default, the *slide level* is the highest header level in
57374360the hierarchy that is followed immediately by content, and not another
5738−heading, somewhere in the document. In the example above, level-1 headings
5739−are always followed by level-2 headings, which are followed by content,
5740−so the slide level is 2. This default can be overridden using
4361+header, somewhere in the document. In the example above, level 1 headers
4362+are always followed by level 2 headers, which are followed by content,
4363+so 2 is the slide level. This default can be overridden using
57414364the `--slide-level` option.
57424365
57434366The document is carved up into slides according to the following
@@ -5745,21 +4368,17 @@ rules:
57454368
57464369 * A horizontal rule always starts a new slide.
57474370
5748− * A heading at the slide level always starts a new slide.
4371+ * A header at the slide level always starts a new slide.
57494372
5750− * Headings *below* the slide level in the hierarchy create
5751− headings *within* a slide. (In beamer, a "block" will be
5752− created. If the heading has the class `example`, an
5753− `exampleblock` environment will be used; if it has the class
5754− `alert`, an `alertblock` will be used; otherwise a regular
5755− `block` will be used.)
4373+ * Headers *below* the slide level in the hierarchy create
4374+ headers *within* a slide.
57564375
5757− * Headings *above* the slide level in the hierarchy create
4376+ * Headers *above* the slide level in the hierarchy create
57584377 "title slides," which just contain the section title
57594378 and help to break the slide show into sections.
5760− Non-slide content under these headings will be included
5761− on the title slide (for HTML slide shows) or in a
5762− subsequent slide with the same title (for beamer).
4379+
4380+ * Content *above* the slide level will not appear in the slide
4381+ show.
57634382
57644383 * A title page is constructed automatically from the document's title
57654384 block, if present. (In the case of beamer, this can be disabled
@@ -5767,16 +4386,17 @@ rules:
57674386
57684387These rules are designed to support many different styles of slide show. If
57694388you don't care about structuring your slides into sections and subsections,
5770−you can just use level-1 headings for all each slide. (In that case, level-1
4389+you can just use level 1 headers for all each slide. (In that case, level 1
57714390will be the slide level.) But you can also structure the slide show into
57724391sections, as in the example above.
57734392
57744393Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5775−layout will be produced, with level-1 headings building horizontally
5776−and level-2 headings building vertically. It is not recommended that
4394+layout will be produced, with level 1 headers building horizontally
4395+and level 2 headers building vertically. It is not recommended that
57774396you use deeper nesting of section levels with reveal.js.
57784397
5779−## Incremental lists
4398+Incremental lists
4399+-----------------
57804400
57814401By default, these writers produce lists that display "all at once."
57824402If you want your lists to display incrementally (one item at a time),
@@ -5814,10 +4434,8 @@ option):
58144434Both methods allow incremental and nonincremental lists to be mixed
58154435in a single document.
58164436
5817−Note: Neither the `-i/--incremental` option nor any of the
5818−methods described here currently works for PowerPoint output.
5819−
5820−## Inserting pauses
4437+Inserting pauses
4438+----------------
58214439
58224440You can add "pauses" within a slide by including a paragraph containing
58234441three dots, separated by spaces:
@@ -5830,9 +4448,8 @@ three dots, separated by spaces:
58304448
58314449 content after the pause
58324450
5833−Note: this feature is not yet implemented for PowerPoint output.
5834−
5835−## Styling the slides
4451+Styling the slides
4452+------------------
58364453
58374454You can change the style of HTML slides by putting customized CSS files
58384455in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5857,9 +4474,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
58574474
58584475 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
58594476
5860−Note that heading attributes will turn into slide attributes
4477+Note that header attributes will turn into slide attributes
58614478(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5862−to style individual slides. In beamer, the only heading attribute
4479+to style individual slides. In beamer, the only header attribute
58634480that affects slides is the `allowframebreaks` class, which sets the
58644481`allowframebreaks` option, causing multiple slides to be created
58654482if the content overfills the frame. This is recommended especially for
@@ -5867,7 +4484,8 @@ bibliographies:
58674484
58684485 # References {.allowframebreaks}
58694486
5870−## Speaker notes
4487+Speaker notes
4488+-------------
58714489
58724490Speaker notes are supported in reveal.js and PowerPoint (pptx)
58734491output. You can add notes to your Markdown document thus:
@@ -5888,7 +4506,8 @@ in handouts and presenter view.
58884506Notes are not yet supported for other slide formats, but the notes
58894507will not appear on the slides themselves.
58904508
5891−## Columns
4509+Columns
4510+-------
58924511
58934512To put material in side by side columns, you can use a native
58944513div container with class `columns`, containing two or more div
@@ -5903,46 +4522,12 @@ containers with class `column` and a `width` attribute:
59034522 :::
59044523 ::::::::::::::
59054524
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
4525+Frame attributes in beamer
4526+--------------------------
59424527
59434528Sometimes it is necessary to add the LaTeX `[fragile]` option to
59444529a frame in beamer (for example, when using the `minted` environment).
5945−This can be forced by adding the `fragile` class to the heading
4530+This can be forced by adding the `fragile` class to the header
59464531introducing the slide:
59474532
59484533 # Fragile slide {.fragile}
@@ -5952,9 +4537,10 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
59524537`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
59534538`shrink`, `standout`, `noframenumbering`.
59544539
5955−## Background in reveal.js and beamer
4540+Background in reveal.js and beamer
4541+----------------------------------
59564542
5957−Background images can be added to self-contained reveal.js slideshows and
4543+Background images can be added to self-contained reveal.js slideshows and
59584544to beamer slideshows.
59594545
59604546For the same image on every slide, use the configuration
@@ -5962,14 +4548,14 @@ option `background-image` either in the YAML metadata block
59624548or as a command-line variable. (There are no other options in
59634549beamer and the rest of this section concerns reveal.js slideshows.)
59644550
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
4551+For reveal.js, you can instead use the reveal.js-native option
4552+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4553+and `parallaxBackgroundVertical` the same way and must also set
59684554`parallaxBackgroundSize` to have your values take effect.
59694555
59704556To set an image for a particular reveal.js slide, add
59714557`{data-background-image="/path/to/image"}`
5972−to the first slide-level heading on the slide (which may even be empty).
4558+to the first slide-level header on the slide (which may even be empty).
59734559
59744560In reveal.js's overview mode, the parallaxBackgroundImage will show up
59754561only on the first slide.
@@ -5978,12 +4564,9 @@ Other reveal.js background settings also work on individual slides, including
59784564`data-background-size`, `data-background-repeat`, `data-background-color`,
59794565`data-transition`, and `data-transition-speed`.
59804566
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.
4567+See the [reveal.js
4568+documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4569+for more details.
59874570
59884571For example in reveal.js:
59894572
@@ -5991,9 +4574,6 @@ For example in reveal.js:
59914574---
59924575title: My Slideshow
59934576parallaxBackgroundImage: /path/to/my/background_image.png
5994−title-slide-attributes:
5995− data-background-image: /path/to/title_image.png
5996− data-background-size: contain
59974577---
59984578
59994579## Slide One
@@ -6002,12 +4582,14 @@ Slide 1 has background_image.png as its background.
60024582
60034583## {data-background-image="/path/to/special_image.jpg"}
60044584
6005−Slide 2 has a special image for its background, even though the heading has no content.
4585+Slide 2 has a special image for its background, even though the header has no content.
60064586```
60074587
6008−# EPUBs
4588+Creating EPUBs with pandoc
4589+==========================
60094590
6010−## EPUB Metadata
4591+EPUB Metadata
4592+-------------
60114593
60124594EPUB metadata may be specified using the `--epub-metadata` option, but
60134595if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,15 +4667,6 @@ The following fields are recognized:
60854667
60864668`rights`
60874669 ~ 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.
60974670
60984671`cover-image`
60994672 ~ A string value (path to cover image).
@@ -6115,12 +4688,13 @@ The following fields are recognized:
61154688 - `binding`: `true`|`false` (default `true`)
61164689 - `scroll-axis`: `vertical`|`horizontal`|`default`
61174690
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4691+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
61194692[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
61204693
6121−## The `epub:type` attribute
4694+The `epub:type` attribute
4695+-------------------------
61224696
6123−For `epub3` output, you can mark up the heading that corresponds to an EPUB
4697+For `epub3` output, you can mark up the header that corresponds to an EPUB
61244698chapter using the [`epub:type` attribute][epub-type]. For example, to set
61254699the attribute to the value `prologue`, use this markdown:
61264700
@@ -6143,26 +4717,22 @@ abstract frontmatter
61434717acknowledgments frontmatter
61444718copyright-page frontmatter
61454719dedication 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
61564720foreword frontmatter
4721+halftitle, frontmatter
4722+introduction frontmatter
61574723preface frontmatter
4724+seriespage frontmatter
4725+titlepage frontmatter
4726+afterword backmatter
61584727appendix backmatter
61594728colophon backmatter
6160−bibliography backmatter
6161−index backmatter
4729+conclusion backmatter
4730+epigraph backmatter
61624731
61634732[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
61644733
6165−## Linked media
4734+Linked media
4735+------------
61664736
61674737By default, pandoc will download media referenced from any `<img>`, `<audio>`,
61684738`<video>` or `<source>` element present in the generated EPUB,
@@ -6172,137 +4742,13 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
61724742with the `src` attribute. For example:
61734743
61744744 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
4745+ <source src="http://example.com/music/toccata.mp3"
61764746 data-external="1" type="audio/mpeg">
61774747 </source>
61784748 </audio>
61794749
6180−# Jupyter notebooks
6181−
6182−When creating a [Jupyter notebook], pandoc will try to infer the
6183−notebook structure. Code blocks with the class `code` will be
6184−taken as code cells, and intervening content will be taken as
6185−Markdown cells. Attachments will automatically be created for
6186−images in Markdown cells. Metadata will be taken from the
6187−`jupyter` metadata field. For example:
6188−
6189−````
6190−---
6191−title: My notebook
6192−jupyter:
6193− nbformat: 4
6194− nbformat_minor: 5
6195− kernelspec:
6196− display_name: Python 2
6197− language: python
6198− name: python2
6199− language_info:
6200− codemirror_mode:
6201− name: ipython
6202− version: 2
6203− file_extension: ".py"
6204− mimetype: "text/x-python"
6205− name: "python"
6206− nbconvert_exporter: "python"
6207− pygments_lexer: "ipython2"
6208− version: "2.7.15"
6209−---
6210−
6211−# Lorem ipsum
6212−
6213−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6214−bibendum felis dictum sodales.
6215−
6216−``` code
6217−print("hello")
6218−```
6219−
6220−## Pyout
6221−
6222−``` code
6223−from IPython.display import HTML
6224−HTML("""
6225−<script>
6226−console.log("hello");
6227−</script>
6228−<b>HTML</b>
6229−""")
6230−```
6231−
6232−## Image
6233−
6234−This image  will be
6235−included as a cell attachment.
6236−````
6237−
6238−If you want to add cell attributes, group cells differently, or
6239−add output to code cells, then you need to include divs to
6240−indicate the structure. You can use either [fenced
6241−divs][Extension: `fenced_divs`] or [native divs][Extension:
6242−`native_divs`] for this. Here is an example:
6243−
6244−````
6245−:::::: {.cell .markdown}
6246−# Lorem
6247−
6248−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
6249−bibendum felis dictum sodales.
6250−::::::
6251−
6252−:::::: {.cell .code execution_count=1}
6253−``` {.python}
6254−print("hello")
6255−```
6256−
6257−::: {.output .stream .stdout}
6258−```
6259−hello
6260−```
6261−:::
6262−::::::
6263−
6264−:::::: {.cell .code execution_count=2}
6265−``` {.python}
6266−from IPython.display import HTML
6267−HTML("""
6268−<script>
6269−console.log("hello");
6270−</script>
6271−<b>HTML</b>
6272−""")
6273−```
6274−
6275−::: {.output .execute_result execution_count=2}
6276−```{=html}
6277−<script>
6278−console.log("hello");
6279−</script>
6280−<b>HTML</b>
6281−hello
6282−```
6283−:::
6284−::::::
6285−````
6286−
6287−If you include raw HTML or TeX in an output cell, use the
6288−[raw attribute][Extension: `fenced_attribute`], as shown
6289−in the last cell of the example above. Although pandoc can
6290−process "bare" raw HTML and TeX, the result is often
6291−interspersed raw elements and normal textual elements, and
6292−in an output cell pandoc expects a single, connected raw
6293−block. To avoid using raw HTML or TeX except when
6294−marked explicitly using raw attributes, we recommend
6295−specifying the extensions `-raw_html-raw_tex+raw_attribute` when
6296−translating between Markdown and ipynb notebooks.
6297−
6298−Note that options and extensions that affect reading and
6299−writing of Markdown will also affect Markdown cells in ipynb
6300−notebooks. For example, `--wrap=preserve` will preserve
6301−soft line breaks in Markdown cells; `--atx-headers` will
6302−cause ATX-style headings to be used; and `--preserve-tabs` will
6303−prevent tabs from being turned to spaces.
6304−
6305−# Syntax highlighting
4750+Syntax highlighting
4751+===================
63064752
63074753Pandoc will automatically highlight syntax in [fenced code blocks] that
63084754are marked with a language name. The Haskell library [skylighting] is
@@ -6330,7 +4776,7 @@ Then edit `my.theme` and use it like this:
63304776If you are not satisfied with the built-in highlighting, or you
63314777want highlight a language that isn't supported, you can use the
63324778`--syntax-definition` option to load a [KDE-style XML syntax definition
6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
4779+file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
63344780Before writing your own, have a look at KDE's [repository of syntax
63354781definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
63364782
@@ -6338,58 +4784,13 @@ To disable highlighting, use the `--no-highlight` option.
63384784
63394785[skylighting]: https://github.com/jgm/skylighting
63404786
6341−# Custom Styles
4787+Custom Styles
4788+=============
63424789
63434790Custom styles can be used in the docx and ICML formats.
63444791
6345−## Output
6346−
6347−By default, pandoc's docx and ICML output applies a predefined set of styles
6348−for blocks such as paragraphs and block quotes, and uses largely default
6349−formatting (italics, bold) for inlines. This will work for most
6350−purposes, especially alongside a `reference.docx` file. However, if you
6351−need to apply your own styles to blocks, or match a preexisting set of
6352−styles, pandoc allows you to define custom styles for blocks and text
6353−using `div`s and `span`s, respectively.
6354−
6355−If you define a `div` or `span` with the attribute `custom-style`,
6356−pandoc will apply your specified style to the contained elements (with
6357−the exception of elements whose function depends on a style, like
6358−headings, code blocks, block quotes, or links). So, for example, using
6359−the `bracketed_spans` syntax,
6360−
6361− [Get out]{custom-style="Emphatically"}, he said.
6362−
6363−would produce a docx file with "Get out" styled with character
6364−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
6365−
6366− Dickinson starts the poem simply:
6367−
6368− ::: {custom-style="Poetry"}
6369− | A Bird came down the Walk---
6370− | He did not know I saw---
6371− :::
6372−
6373−would style the two contained lines with the `Poetry` paragraph style.
6374−
6375−For docx output, styles will be defined in the output file as inheriting
6376−from normal text, if the styles are not yet in your reference.docx.
6377−If they are already defined, pandoc will not alter the definition.
6378−
6379−This feature allows for greatest customization in conjunction with
6380−[pandoc filters]. If you want all paragraphs after block quotes to be
6381−indented, you can write a filter to apply the styles necessary. If you
6382−want all italics to be transformed to the `Emphasis` character style
6383−(perhaps to change their color), you can write a filter which will
6384−transform all italicized inlines to inlines within an `Emphasis`
6385−custom-style `span`.
6386−
6387−For docx output, you don't need to enable any extensions for
6388−custom styles to work.
6389−
6390−[pandoc filters]: https://pandoc.org/filters.html
6391−
6392−## Input
4792+Input
4793+-----
63934794
63944795The docx reader, by default, only reads those styles that it can
63954796convert into pandoc elements, either by direct conversion or
@@ -6418,17 +4819,17 @@ And with the extension:
64184819
64194820 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
64204821
6421− ::: {custom-style="First Paragraph"}
4822+ ::: {custom-style="FirstParagraph"}
64224823 This is some text.
64234824 :::
64244825
6425− ::: {custom-style="Body Text"}
4826+ ::: {custom-style="BodyText"}
64264827 This is text with an [emphasized]{custom-style="Emphatic"} text style.
64274828 And this is text with a [strengthened]{custom-style="Strengthened"}
64284829 text style.
64294830 :::
64304831
6431− ::: {custom-style="My Block Style"}
4832+ ::: {custom-style="MyBlockStyle"}
64324833 > Here is a styled paragraph that inherits from Block Text.
64334834 :::
64344835
@@ -6436,47 +4837,70 @@ With these custom styles, you can use your input document as a
64364837reference-doc while creating docx output (see below), and maintain the
64374838same styles in your input and output files.
64384839
6439−# Custom writers
4840+Output
4841+------
4842+
4843+By default, pandoc's docx and ICML output applies a predefined set of styles
4844+for blocks such as paragraphs and block quotes, and uses largely default
4845+formatting (italics, bold) for inlines. This will work for most
4846+purposes, especially alongside a `reference.docx` file. However, if you
4847+need to apply your own styles to blocks, or match a preexisting set of
4848+styles, pandoc allows you to define custom styles for blocks and text
4849+using `div`s and `span`s, respectively.
4850+
4851+If you define a `div` or `span` with the attribute `custom-style`,
4852+pandoc will apply your specified style to the contained elements. So,
4853+for example using the `bracketed_spans` syntax,
4854+
4855+ [Get out]{custom-style="Emphatically"}, he said.
4856+
4857+would produce a docx file with "Get out" styled with character
4858+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4859+
4860+ Dickinson starts the poem simply:
4861+
4862+ ::: {custom-style="Poetry"}
4863+ | A Bird came down the Walk---
4864+ | He did not know I saw---
4865+ :::
4866+
4867+would style the two contained lines with the `Poetry` paragraph style.
4868+
4869+For docx output, styles will be defined in the output file as inheriting
4870+from normal text, if the styles are not yet in your reference.docx.
4871+If they are already defined, pandoc will not alter the definition.
4872+
4873+This feature allows for greatest customization in conjunction with
4874+[pandoc filters]. If you want all paragraphs after block quotes to be
4875+indented, you can write a filter to apply the styles necessary. If you
4876+want all italics to be transformed to the `Emphasis` character style
4877+(perhaps to change their color), you can write a filter which will
4878+transform all italicized inlines to inlines within an `Emphasis`
4879+custom-style `span`.
4880+
4881+[pandoc filters]: http://pandoc.org/filters.html
4882+
4883+Custom writers
4884+==============
64404885
6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442−includes a Lua interpreter, so Lua need not be installed separately.)
4886+Pandoc can be extended with custom writers written in [lua]. (Pandoc
4887+includes a lua interpreter, so lua need not be installed separately.)
64434888
6444−To use a custom writer, simply specify the path to the Lua script
4889+To use a custom writer, simply specify the path to the lua script
64454890in place of the output format. For example:
64464891
64474892 pandoc -t data/sample.lua
64484893
6449−Creating a custom writer requires writing a Lua function for each
4894+Creating a custom writer requires writing a lua function for each
64504895possible element in a pandoc document. To get a documented example
64514896which you can modify according to your needs, do
64524897
64534898 pandoc --print-default-data-file sample.lua
64544899
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).
4900+[lua]: http://www.lua.org
64784901
6479−# A note on security
4902+A note on security
4903+==================
64804904
64814905If you use pandoc to convert user-contributed content in a web
64824906application, here are some things to keep in mind:
@@ -6491,7 +4915,7 @@ application, here are some things to keep in mind:
64914915 shelling out to the executable), it is possible to use it in a mode
64924916 that fully isolates pandoc from your file system, by running the
64934917 pandoc operations in the `PandocPure` monad. See the document
6494− [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
4918+ [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
64954919 for more details.
64964920
649749213. Pandoc's parsers can exhibit pathological performance on some
@@ -6504,17 +4928,17 @@ application, here are some things to keep in mind:
650449284. The HTML generated by pandoc is not guaranteed to be safe.
65054929 If `raw_html` is enabled for the Markdown input, users can
65064930 inject arbitrary HTML. Even if `raw_html` is disabled,
6507− users can include dangerous content in URLs and attributes.
6508− To be safe, you should run all the generated HTML through
6509− an HTML sanitizer.
4931+ users can include dangerous content in attributes for
4932+ headers, spans, and code blocks. To be safe, you should
4933+ run all the generated HTML through an HTML sanitizer.
65104934
6511−# Authors
4935+Authors
4936+=======
65124937
6513−Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
4938+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
65144939under the [GPL], version 2 or greater. This software carries no
65154940warranty of any kind. (See COPYRIGHT for full copyright and
65164941warranty notices.) For a full list of contributors, see the file
65174942AUTHORS.md in the pandoc source code.
65184943
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"
4944+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"