@@ -1,14 +1,14 @@
1−% Pandoc User's Guide
2−% John MacFarlane
3−% May 10, 2018
1+---
2+title: Pandoc User's Guide
3+author: John MacFarlane
4+date: June 20, 2021
5+---
46
5−Synopsis
6−========
7+# Synopsis
78
89`pandoc` [*options*] [*input-file*]...
910
10−Description
11−===========
11+# Description
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
1414another, and a command-line tool that uses this library.
@@ -40,8 +40,7 @@ model. While conversions from pandoc's Markdown to all formats aspire
4040to be perfect, conversions from formats more expressive than pandoc's
4141Markdown can be expected to be lossy.
4242
43−Using `pandoc`
44−--------------
43+## Using pandoc
4544
4645If no *input-files* are specified, input is read from *stdin*.
4746Output goes to *stdout* by default. For output to a file,
@@ -62,8 +61,7 @@ If multiple input files are given, `pandoc` will concatenate them all (with
6261blank lines between them) before parsing. (Use `--file-scope` to parse files
6362individually.)
6463
65−Specifying formats
66−------------------
64+## Specifying formats
6765
6866The format of the input and output can be specified explicitly using
6967command-line options. The input format can be specified using the
@@ -95,8 +93,7 @@ If no input file is specified (so that input comes from *stdin*), or
9593if the input files' extensions are unknown, the input format will
9694be assumed to be Markdown.
9795
98−Character encoding
99−------------------
96+## Character encoding
10097
10198Pandoc uses the UTF-8 character encoding for both input and output.
10299If your local character encoding is not UTF-8, you
@@ -109,10 +106,9 @@ RTF, OPML, DocBook, and Texinfo), information about
109106the character encoding is included in the document header, which
110107will only be included if you use the `-s/--standalone` option.
111108
112−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
113110
114−Creating a PDF
115−--------------
111+## Creating a PDF
116112
117113To produce a PDF, specify an output file with a `.pdf` extension:
118114
@@ -120,20 +116,18 @@ To produce a PDF, specify an output file with a `.pdf` extension:
120116
121117By default, pandoc will use LaTeX to create the PDF, which requires
122118that a LaTeX engine be installed (see `--pdf-engine` below).
123−
124−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125−following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126−[`weasyprint`] or [`prince`].
127−To do this, specify an output file with a `.pdf` extension, as before,
128−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
130−
131−PDF output can be controlled using [variables for LaTeX] (if
132−LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
133−When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
134−If `wkhtmltopdf` is used, then the variables `margin-left`,
135−`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
136−`header-html` and `papersize` will affect the output.
119+Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120+intermediate format. To do this, specify an output file with a
121+`.pdf` extension, as before, but add the `--pdf-engine` option
122+or `-t context`, `-t html`, or `-t ms` to the command line.
123+The tool used to generate the PDF from the intermediate format
124+may be specified using `--pdf-engine`.
125+
126+You can control the PDF style using variables, depending on
127+the intermediate format used: see [variables for LaTeX],
128+[variables for ConTeXt], [variables for `wkhtmltopdf`],
129+[variables for ms]. When HTML is used as an intermediate
130+format, the output can be styled using `--css`.
137131
138132To debug the PDF creation, it can be useful to look at the intermediate
139133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -142,95 +136,116 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
142136When using LaTeX, the following packages need to be available
143137(they are included with all recent versions of [TeX Live]):
144138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
145−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
146140`--listings` option is used), [`fancyvrb`], [`longtable`],
147−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
148−contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),
141+[`booktabs`], [`graphicx`] (if the document
142+contains images), [`hyperref`], [`xcolor`],
149143[`ulem`], [`geometry`] (with the `geometry` variable set),
150144[`setspace`] (with `linestretch`), and
151145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
152−the LaTeX 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 added to the template or included in any header file. The
159−[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
160−optionally be used for [citation rendering].
161−
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/
162165[`amsfonts`]: https://ctan.org/pkg/amsfonts
163166[`amsmath`]: https://ctan.org/pkg/amsmath
164−[`lm`]: https://ctan.org/pkg/lm
165−[`ifxetex`]: https://ctan.org/pkg/ifxetex
166−[`ifluatex`]: https://ctan.org/pkg/ifluatex
167−[`listings`]: https://ctan.org/pkg/listings
168−[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
169−[`longtable`]: https://ctan.org/pkg/longtable
167+[`babel`]: https://ctan.org/pkg/babel
168+[`biber`]: https://ctan.org/pkg/biber
169+[`biblatex`]: https://ctan.org/pkg/biblatex
170+[`bibtex`]: https://ctan.org/pkg/bibtex
171+[`bidi`]: https://ctan.org/pkg/bidi
172+[`bookmark`]: https://ctan.org/pkg/bookmark
170173[`booktabs`]: https://ctan.org/pkg/booktabs
174+[`csquotes`]: https://ctan.org/pkg/csquotes
175+[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176+[`fontspec`]: https://ctan.org/pkg/fontspec
177+[`footnote`]: https://ctan.org/pkg/footnote
178+[`footnotehyper`]: https://ctan.org/pkg/footnotehyper
179+[`geometry`]: https://ctan.org/pkg/geometry
171180[`graphicx`]: https://ctan.org/pkg/graphicx
172181[`grffile`]: https://ctan.org/pkg/grffile
173−[`geometry`]: https://ctan.org/pkg/geometry
174−[`setspace`]: https://ctan.org/pkg/setspace
175−[`xecjk`]: https://ctan.org/pkg/xecjk
176182[`hyperref`]: https://ctan.org/pkg/hyperref
177−[`ulem`]: https://ctan.org/pkg/ulem
178−[`babel`]: https://ctan.org/pkg/babel
179−[`bidi`]: https://ctan.org/pkg/bidi
183+[`iftex`]: https://ctan.org/pkg/iftex
184+[`listings`]: https://ctan.org/pkg/listings
185+[`lm`]: https://ctan.org/pkg/lm
186+[`longtable`]: https://ctan.org/pkg/longtable
180187[`mathspec`]: https://ctan.org/pkg/mathspec
181−[`unicode-math`]: https://ctan.org/pkg/unicode-math
182−[`polyglossia`]: https://ctan.org/pkg/polyglossia
183−[`fontspec`]: https://ctan.org/pkg/fontspec
184−[`upquote`]: https://ctan.org/pkg/upquote
185188[`microtype`]: https://ctan.org/pkg/microtype
186−[`csquotes`]: https://ctan.org/pkg/csquotes
187189[`natbib`]: https://ctan.org/pkg/natbib
188−[`biblatex`]: https://ctan.org/pkg/biblatex
189−[`bibtex`]: https://ctan.org/pkg/bibtex
190−[`biber`]: https://ctan.org/pkg/biber
191−[TeX Live]: http://www.tug.org/texlive/
192−[`wkhtmltopdf`]: https://wkhtmltopdf.org
193−[`weasyprint`]: http://weasyprint.org
190+[`parskip`]: https://ctan.org/pkg/parskip
191+[`polyglossia`]: https://ctan.org/pkg/polyglossia
194192[`prince`]: https://www.princexml.com/
193+[`setspace`]: https://ctan.org/pkg/setspace
194+[`ulem`]: https://ctan.org/pkg/ulem
195+[`unicode-math`]: https://ctan.org/pkg/unicode-math
196+[`upquote`]: https://ctan.org/pkg/upquote
197+[`weasyprint`]: https://weasyprint.org
198+[`wkhtmltopdf`]: https://wkhtmltopdf.org
199+[`xcolor`]: https://ctan.org/pkg/xcolor
200+[`xecjk`]: https://ctan.org/pkg/xecjk
201+[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
195203
196−Reading from the Web
197−--------------------
198204
199−Instead of an input file, an absolute URI may be given. In this case
205+
206+## Reading from the Web
207+
208+Instead of an input file, an absolute URI may be given. In this case
200209pandoc will fetch the content using HTTP:
201210
202− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
203212
204213It is possible to supply a custom User-Agent string or other
205214header when requesting a document from a URL:
206215
207216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
208− http://www.fsf.org
217+ https://www.fsf.org
209218
210−Options
211−=======
219+# Options
212220
213−General options
214−---------------
221+## General options {.options}
215222
216223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
217224
218225: Specify input format. *FORMAT* can be:
219226
220227 ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
221230 - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
222232 - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
223235 - `docbook` ([DocBook])
224236 - `docx` ([Word docx])
237+ - `dokuwiki` ([DokuWiki markup])
225238 - `epub` ([EPUB])
226239 - `fb2` ([FictionBook2] e-book)
227240 - `gfm` ([GitHub-Flavored Markdown]),
228− or `markdown_github`, which provides deprecated and less accurate
229− support for Github-Flavored Markdown; please use `gfm` instead,
230− unless you need to use extensions other than `smart`.
241+ or the deprecated and less accurate `markdown_github`;
242+ use [`markdown_github`](#markdown-variants) only
243+ if you need extensions not supported in [`gfm`](#markdown-variants).
231244 - `haddock` ([Haddock markup])
232245 - `html` ([HTML])
246+ - `ipynb` ([Jupyter notebook])
233247 - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
234249 - `json` (JSON version of native AST)
235250 - `latex` ([LaTeX])
236251 - `markdown` ([Pandoc's Markdown])
@@ -238,6 +253,7 @@ General options
238253 - `markdown_phpextra` ([PHP Markdown Extra])
239254 - `markdown_strict` (original unextended [Markdown])
240255 - `mediawiki` ([MediaWiki markup])
256+ - `man` ([roff man])
241257 - `muse` ([Muse])
242258 - `native` (native Haskell)
243259 - `odt` ([ODT])
@@ -262,10 +278,14 @@ General options
262278: Specify output format. *FORMAT* can be:
263279
264280 ::: {#output-formats}
265− - `asciidoc` ([AsciiDoc])
281+ - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
266282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
267285 - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
268287 - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
269289 - `docbook` or `docbook4` ([DocBook] 4)
270290 - `docbook5` (DocBook 5)
271291 - `docx` ([Word docx])
@@ -274,29 +294,35 @@ General options
274294 - `epub2` (EPUB v2)
275295 - `fb2` ([FictionBook2] e-book)
276296 - `gfm` ([GitHub-Flavored Markdown]),
277− or `markdown_github`, which provides deprecated and less accurate
278− support for Github-Flavored Markdown; please use `gfm` instead,
279− unless you use extensions that do not work with `gfm`.
297+ or the deprecated and less accurate `markdown_github`;
298+ use [`markdown_github`](#markdown-variants) only
299+ if you need extensions not supported in [`gfm`](#markdown-variants).
280300 - `haddock` ([Haddock markup])
281301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
282302 - `html4` ([XHTML] 1.0 Transitional)
283303 - `icml` ([InDesign ICML])
284− - `jats` ([JATS] XML)
304+ - `ipynb` ([Jupyter notebook])
305+ - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306+ - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307+ - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308+ - `jats` (alias for `jats_archiving`)
309+ - `jira` ([Jira]/Confluence wiki markup)
285310 - `json` (JSON version of native AST)
286311 - `latex` ([LaTeX])
287− - `man` ([groff man])
312+ - `man` ([roff man])
288313 - `markdown` ([Pandoc's Markdown])
289314 - `markdown_mmd` ([MultiMarkdown])
290315 - `markdown_phpextra` ([PHP Markdown Extra])
291316 - `markdown_strict` (original unextended [Markdown])
292317 - `mediawiki` ([MediaWiki markup])
293− - `ms` ([groff ms])
318+ - `ms` ([roff ms])
294319 - `muse` ([Muse]),
295320 - `native` (native Haskell),
296321 - `odt` ([OpenOffice text document][ODT])
297322 - `opml` ([OPML])
298323 - `opendocument` ([OpenDocument])
299324 - `org` ([Emacs Org mode])
325+ - `pdf` ([PDF])
300326 - `plain` (plain text),
301327 - `pptx` ([PowerPoint] slide show)
302328 - `rst` ([reStructuredText])
@@ -309,11 +335,12 @@ General options
309335 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
310336 - `s5` ([S5] HTML and JavaScript slide show)
311337 - `tei` ([TEI Simple])
338+ - `xwiki` ([XWiki markup])
312339 - `zimwiki` ([ZimWiki markup])
313− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
314341 :::
315342
316− Note that `odt`, `docx`, and `epub` output will not be directed
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
317344 to *stdout* unless forced with `-o -`.
318345
319346 Extensions can be individually enabled or
@@ -331,23 +358,32 @@ General options
331358
332359: Specify the user data directory to search for pandoc data files.
333360 If this option is not specified, the default user data directory
334− will be used. This is, in UNIX:
335−
336− $HOME/.pandoc
337−
338− in Windows XP:
339−
340− C:\Documents And Settings\USERNAME\Application Data\pandoc
341−
342− and in Windows Vista or later:
343−
344− C:\Users\USERNAME\AppData\Roaming\pandoc
345−
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`.
346368 You can find the default user data directory on your system by
347369 looking at the output of `pandoc --version`.
348− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
349− `slidy`, `slideous`, or `s5` directory
350− placed in this directory will override pandoc's normal defaults.
370+ Data files placed in this directory (for example, `reference.odt`,
371+ `reference.docx`, `epub.css`, `templates`) will override
372+ pandoc's normal defaults.
373+
374+`-d` *FILE*, `--defaults=`*FILE*
375+
376+: Specify a set of default option settings. *FILE* is a YAML
377+ file whose fields correspond to command-line option
378+ settings. All options for document conversion, including input
379+ and output files, can be set using a defaults file. The file will
380+ be searched for first in the working directory, and then in
381+ the `defaults` subdirectory of the user data directory
382+ (see `--data-dir`). The `.yaml` extension may be omitted.
383+ See the section [Default files] for more information on the
384+ file format. Settings from the defaults file may be
385+ overridden or extended by subsequent options on the command
386+ line.
351387
352388`--bash-completion`
353389
@@ -358,8 +394,7 @@ General options
358394
359395`--verbose`
360396
361−: Give verbose debugging output. Currently this only has an effect
362− with PDF output.
397+: Give verbose debugging output.
363398
364399`--quiet`
365400
@@ -385,7 +420,7 @@ General options
385420
386421`--list-extensions`[`=`*FORMAT*]
387422
388−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
389424 by a `+` or `-` indicating whether it is enabled by default
390425 in *FORMAT*. If *FORMAT* is not specified, defaults for
391426 pandoc's Markdown are given.
@@ -408,62 +443,88 @@ General options
408443
409444: Show usage message.
410445
411−[Markdown]: http://daringfireball.net/projects/markdown/
412−[CommonMark]: http://commonmark.org
446+[Markdown]: https://daringfireball.net/projects/markdown/
447+[CommonMark]: https://commonmark.org
413448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
414449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
415−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
416−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
417−[S5]: http://meyerweb.com/eric/tools/s5/
418−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
419−[Slideous]: http://goessner.net/articles/slideous/
420−[HTML]: http://www.w3.org/html/
421−[HTML5]: http://www.w3.org/TR/html5/
450+[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451+[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452+[S5]: https://meyerweb.com/eric/tools/s5/
453+[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454+[Slideous]: https://goessner.net/articles/slideous/
455+[HTML]: https://www.w3.org/html/
456+[HTML5]: https://html.spec.whatwg.org/
422457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
423−[XHTML]: http://www.w3.org/TR/xhtml1/
424−[LaTeX]: http://latex-project.org
458+[XHTML]: https://www.w3.org/TR/xhtml1/
459+[LaTeX]: https://www.latex-project.org/
425460[`beamer`]: https://ctan.org/pkg/beamer
426−[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
427−[ConTeXt]: http://www.contextgarden.net/
428−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
429−[DocBook]: http://docbook.org
461+[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462+[ConTeXt]: https://www.contextgarden.net/
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464+[DocBook]: https://docbook.org
430465[JATS]: https://jats.nlm.nih.gov
431−[txt2tags]: http://txt2tags.org
466+[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467+[txt2tags]: https://txt2tags.org
432468[EPUB]: http://idpf.org/epub
433469[OPML]: http://dev.opml.org/spec2.html
434470[OpenDocument]: http://opendocument.xml.org
435−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
436−[Textile]: http://redcloth.org/textile
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472+[Textile]: https://www.promptworks.com/textile
437473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
438474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
439−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
440−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476+[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
441478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
442479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
443480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
444−[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
445−[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
481+[CSV]: https://tools.ietf.org/html/rfc4180
482+[roff man]: https://man.cx/groff_man(7)
483+[roff ms]: https://man.cx/groff_ms(7)
446484[Haskell]: https://www.haskell.org
447−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
448−[Emacs Org mode]: http://orgmode.org
449−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
450−[DZSlides]: http://paulrouget.com/dzslides/
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486+[Emacs Org mode]: https://orgmode.org
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488+[AsciiDoctor]: https://asciidoctor.org/
489+[DZSlides]: https://paulrouget.com/dzslides/
451490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
452491[PDF]: https://www.adobe.com/pdf/
453−[reveal.js]: http://lab.hakim.se/reveal-js/
492+[reveal.js]: https://revealjs.com/
454493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
455−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
494+[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495+[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
456496[TEI Simple]: https://github.com/TEIC/TEI-Simple
457497[Muse]: https://amusewiki.org/library/manual
458498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
459499[Vimwiki]: https://vimwiki.github.io
460−
461−Reader options
462−--------------
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.
463522
464523`--base-header-level=`*NUMBER*
465524
466−: Specify the base level for headers (defaults to 1).
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
526+ where X = NUMBER - 1.* Specify the base level for headings
527+ (defaults to 1).
467528
468529`--strip-empty-paragraphs`
469530
@@ -528,41 +589,32 @@ Reader options
528589
529590 3. `$PATH` (executable only)
530591
531− Filters and lua-filters are applied in the order specified
532− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
533594
534−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
535596
536597: Transform the document in a similar fashion as JSON filters (see
537− `--filter`), but use pandoc's build-in lua filtering system. The given
538− lua script is expected to return a list of lua filters which will be
539− applied in order. Each lua filter must contain element-transforming
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
599+ Lua script is expected to return a list of Lua filters which will be
600+ applied in order. Each Lua filter must contain element-transforming
540601 functions indexed by the name of the AST element on which the filter
541602 function should be applied.
542603
543− The `pandoc` lua module provides helper functions for element
544− creation. It is always loaded into the script's lua environment.
545−
546− The following is an example lua script for macro-expansion:
604+ The `pandoc` Lua module provides helper functions for element
605+ creation. It is always loaded into the script's Lua environment.
547606
548− function expand_hello_world(inline)
549− if inline.c == '{{helloworld}}' then
550− return pandoc.Emph{ pandoc.Str "Hello, World" }
551− else
552− return inline
553− end
554− end
607+ See the [Lua filters documentation] for further details.
555608
556− return {{Str = expand_hello_world}}
609+ In order of preference, pandoc will look for Lua filters in
557610
558− In order of preference, pandoc will look for lua filters in
611+ 1. a specified full or relative path
559612
560− 1. a specified full or relative path (executable or
561− non-executable)
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
562615
563− 2. `$DATADIR/filters` (executable or non-executable)
564− where `$DATADIR` is the user data directory (see
565− `--data-dir`, above).
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
566618
567619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
568620
@@ -577,11 +629,25 @@ Reader options
577629 printed in some output formats) and metadata values will be escaped
578630 when inserted into the template.
579631
632+`--metadata-file=`*FILE*
633+
634+: Read metadata from the supplied YAML (or JSON) file. This
635+ option can be used with every input format, but string scalars
636+ in the YAML file will always be parsed as Markdown. Generally,
637+ the input will be handled the same as in [YAML metadata
638+ blocks][Extension: `yaml_metadata_block`]. This option can be
639+ used repeatedly to include multiple metadata files; values in
640+ files specified later on the command line will be preferred
641+ over those specified in earlier files. Metadata values
642+ specified inside the document, or by using `-M`, overwrite
643+ values specified with this option.
644+
580645`-p`, `--preserve-tabs`
581646
582−: Preserve tabs instead of converting them to spaces (the default).
583− Note that this will only affect tabs in literal code spans and code
584− blocks; tabs in regular text will be treated as spaces.
647+: Preserve tabs instead of converting them to spaces. (By default, pandoc
648+ converts tabs to spaces before parsing its input.) Note that this will
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
650+ text are always treated as spaces.
585651
586652`--tab-stop=`*NUMBER*
587653
@@ -591,30 +657,30 @@ Reader options
591657
592658: Specifies what to do with insertions, deletions, and comments
593659 produced by the MS Word "Track Changes" feature. `accept` (the
594− default), inserts all insertions, and ignores all
595− deletions. `reject` inserts all deletions and ignores
596− insertions. Both `accept` and `reject` ignore comments. `all` puts
597− in insertions, deletions, and comments, wrapped in spans with
598− `insertion`, `deletion`, `comment-start`, and `comment-end`
599− classes, respectively. The author and time of change is
600− included. `all` is useful for scripting: only accepting changes
601− from a certain reviewer, say, or before a certain date. If a
602− paragraph is inserted or deleted, `track-changes=all` produces a
603− span with the class `paragraph-insertion`/`paragraph-deletion`
604− before the affected paragraph break. This option only affects the
605− docx reader.
660+ default) processes all the insertions and deletions.
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
662+ `all` includes all insertions, deletions, and comments, wrapped
663+ in spans with `insertion`, `deletion`, `comment-start`, and
664+ `comment-end` classes, respectively. The author and time of
665+ change is included. `all` is useful for scripting: only
666+ accepting changes from a certain reviewer, say, or before a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
669+ `paragraph-insertion`/`paragraph-deletion` before the
670+ affected paragraph break. This option only affects the docx
671+ reader.
606672
607673`--extract-media=`*DIR*
608674
609675: Extract images and other media contained in or linked from
610676 the source document to the path *DIR*, creating it if
611677 necessary, and adjust the images references in the document
612− so they point to the extracted files. If the source format is
613− a binary container (docx, epub, or odt), the media is
614− extracted from the container and the original
615− filenames are used. Otherwise the media is read from the
616− file system or downloaded, and new filenames are constructed
617− based on SHA1 hashes of the contents.
678+ so they point to the extracted files. Media are downloaded,
679+ read from the file system, or extracted from a binary
680+ container (e.g. docx), as needed. The original file paths
681+ are used if they are relative paths not containing `..`.
682+ Otherwise filenames are constructed from the SHA1 hash of
683+ the contents.
618684
619685`--abbreviations=`*FILE*
620686
@@ -625,17 +691,17 @@ Reader options
625691 system default, use
626692 `pandoc --print-default-data-file=abbreviations`. The only
627693 use pandoc makes of this list is in the Markdown reader.
628− Strings ending in a period that are found in this list will
629− be followed by a nonbreaking space, so that the period will
630− not produce sentence-ending space in formats like LaTeX.
694+ Strings found in this list will be followed by a nonbreaking
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
631697
632698[`pandocfilters`]: https://github.com/jgm/pandocfilters
633699[PHP]: https://github.com/vinai/pandocfilters-php
634700[perl]: https://metacpan.org/pod/Pandoc::Filter
635701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
636703
637−General writer options
638−----------------------
704+## General writer options {.options}
639705
640706`-s`, `--standalone`
641707
@@ -660,22 +726,29 @@ General writer options
660726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
661727
662728: Set the template variable *KEY* to the value *VAL* when rendering the
663− document in standalone mode. This is generally only useful when the
664− `--template` option is used to specify a custom template, since
665− pandoc automatically sets the variables used in the default
666− templates. If no *VAL* is specified, the key will be given the
667− value `true`.
729+ document in standalone mode. If no *VAL* is specified, the
730+ key will be given the value `true`.
668731
669732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
670733
671734: Print the system default template for an output *FORMAT*. (See `-t`
672735 for a list of possible *FORMAT*s.) Templates in the user data
673− directory are ignored.
736+ directory are ignored. This option may be used with
737+ `-o`/`--output` to redirect output to a file, but
738+ `-o`/`--output` must come before `--print-default-template`
739+ on the command line.
740+
741+ Note that some of the default templates use partials, for
742+ example `styles.html`. To print the partials, use
743+ `--print-default-data-file`: for example,
744+ `--print-default-data-file=templates/styles.html`.
674745
675746`--print-default-data-file=`*FILE*
676747
677748: Print a system default data file. Files in the user data directory
678− are ignored.
749+ are ignored. This option may be used with `-o`/`--output` to
750+ redirect output to a file, but `-o`/`--output` must come before
751+ `--print-default-data-file` on the command line.
679752
680753`--eol=crlf`|`lf`|`native`
681754
@@ -686,9 +759,12 @@ General writer options
686759
687760`--dpi`=*NUMBER*
688761
689−: Specify the dpi (dots per inch) value for conversion from pixels
690− to inch/centimeters and vice versa. The default is 96dpi.
691− Technically, the correct term would be ppi (pixels per inch).
762+: Specify the default dpi (dots per inch) value for conversion
763+ from pixels to inch/centimeters and vice versa. (Technically,
764+ the correct term would be ppi: pixels per inch.) The default
765+ is 96dpi. When images contain information about dpi
766+ internally, the encoded value is used instead of the default
767+ specified by this option.
692768
693769`--wrap=auto`|`none`|`preserve`
694770
@@ -701,6 +777,8 @@ General writer options
701777 where there are nonsemantic newlines in the source, there
702778 will be nonsemantic newlines in the output as well).
703779 Automatic wrapping does not currently work in HTML output.
780+ In `ipynb` output, this option affects wrapping of the
781+ contents of markdown cells.
704782
705783`--columns=`*NUMBER*
706784
@@ -717,11 +795,17 @@ General writer options
717795 unless `-s/--standalone` is used, and it has no effect
718796 on `man`, `docbook4`, `docbook5`, or `jats` output.
719797
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+
720804`--toc-depth=`*NUMBER*
721805
722806: Specify the number of section levels to include in the table
723− of contents. The default is 3 (which means that level 1, 2, and 3
724− headers will be listed in the contents).
807+ of contents. The default is 3 (which means that level-1, 2, and 3
808+ headings will be listed in the contents).
725809
726810`--strip-comments`
727811
@@ -757,7 +841,10 @@ General writer options
757841
758842: Prints a JSON version of a highlighting style, which can
759843 be modified, saved with a `.theme` extension, and used
760− with `--highlight-style`.
844+ with `--highlight-style`. This option may be used with
845+ `-o`/`--output` to redirect output to a file, but
846+ `-o`/`--output` must come before `--print-highlight-style`
847+ on the command line.
761848
762849`--syntax-definition=`*FILE*
763850
@@ -765,9 +852,10 @@ General writer options
765852 which will be used for syntax highlighting of appropriately
766853 marked code blocks. This can be used to add support for
767854 new languages or to use altered syntax definitions for
768− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
769857
770−`-H` *FILE*, `--include-in-header=`*FILE*
858+`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
771859
772860: Include contents of *FILE*, verbatim, at the end of the header.
773861 This can be used, for example, to include special
@@ -775,7 +863,7 @@ General writer options
775863 repeatedly to include multiple files in the header. They will be
776864 included in the order specified. Implies `--standalone`.
777865
778−`-B` *FILE*, `--include-before-body=`*FILE*
866+`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
779867
780868: Include contents of *FILE*, verbatim, at the beginning of the
781869 document body (e.g. after the `<body>` tag in HTML, or the
@@ -784,7 +872,7 @@ General writer options
784872 used repeatedly to include multiple files. They will be included in
785873 the order specified. Implies `--standalone`.
786874
787−`-A` *FILE*, `--include-after-body=`*FILE*
875+`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
788876
789877: Include contents of *FILE*, verbatim, at the end of the document
790878 body (before the `</body>` tag in HTML, or the
@@ -803,6 +891,11 @@ General writer options
803891 will not be searched. For example:
804892 `--resource-path=.:test` will search the working directory
805893 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`.
806899
807900`--request-header=`*NAME*`:`*VAL*
808901
@@ -812,8 +905,13 @@ General writer options
812905 downloaded). If you're behind a proxy, you also need to set
813906 the environment variable `http_proxy` to `http://...`.
814907
815−Options affecting specific writers
816−----------------------------------
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}
817915
818916`--self-contained`
819917
@@ -838,14 +936,18 @@ Options affecting specific writers
838936
839937`--html-q-tags`
840938
841−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
941+ format used.)
842942
843943`--ascii`
844944
845−: Use only ASCII characters in output. Currently supported for
846− XML and HTML formats (which use numerical entities instead of
847− UTF-8 when this option is selected) and for groff ms and man
848− (which use hexadecimal escapes).
945+: Use only ASCII characters in output. Currently supported for XML
946+ and HTML formats (which use entities instead of UTF-8 when this
947+ option is selected), CommonMark, gfm, and Markdown (which use
948+ entities), roff ms (which use hexadecimal escapes), and to a
949+ limited degree LaTeX (which uses standard commands for accented
950+ characters when possible). roff man output uses ASCII by default.
849951
850952`--reference-links`
851953
@@ -854,36 +956,45 @@ Options affecting specific writers
854956 placement of link references is affected by the
855957 `--reference-location` option.
856958
857−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
858960
859961: Specify whether footnotes (and references, if `reference-links` is
860962 set) are placed at the end of the current (top-level) block, the
861963 current section, or the document. The default is
862964 `document`. Currently only affects the markdown writer.
863965
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+
864974`--atx-headers`
865975
866−: Use ATX-style headers in Markdown and AsciiDoc output. The default is
867− to use setext-style headers for levels 1-2, and then ATX headers.
868− (Note: for `gfm` output, ATX headers are always used.)
976+: *Deprecated synonym for `--markdown-headings=atx`.*
869977
870−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
871979
872−: Treat top-level headers as the given division type in LaTeX, ConTeXt,
873− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
874− all headers are shifted such that the top-level header becomes the specified
875− type. The default behavior is to determine the best division type via
876− heuristics: unless other conditions apply, `section` is chosen. When the
877− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
878− `article` option is specified), `chapter` is implied as the setting for this
879− option. If `beamer` is the output format, specifying either `chapter` or
880− `part` will cause top-level headers to become `\part{..}`, while
881− second-level headers remain as their default type.
980+: Treat top-level headings as the given division type in
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
983+ shifted such that the top-level heading becomes the
984+ specified type. The default behavior is to determine the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
987+ variable is set to `report`, `book`, or `memoir` (unless the
988+ `article` option is specified), `chapter` is implied as the
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
992+ remain as their default type.
882993
883994`-N`, `--number-sections`
884995
885−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
886− By default, sections are not numbered. Sections with class
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997+ output. By default, sections are not numbered. Sections with class
887998 `unnumbered` will never be numbered, even if `--number-sections`
888999 is specified.
8891000
@@ -891,16 +1002,19 @@ Options affecting specific writers
8911002
8921003: Offset for section headings in HTML output (ignored in other
8931004 output formats). The first number is added to the section number for
894− top-level headers, the second for second-level headers, and so on.
895− So, for example, if you want the first top-level header in your
1005+ top-level headings, the second for second-level headings, and so on.
1006+ So, for example, if you want the first top-level heading in your
8961007 document to be numbered "6", specify `--number-offset=5`.
897− If your document starts with a level-2 header which you want to
1008+ If your document starts with a level-2 heading which you want to
8981009 be numbered "1.5", specify `--number-offset=1,4`.
8991010 Offsets are 0 by default. Implies `--number-sections`.
9001011
9011012`--listings`
9021013
903−: Use the [`listings`] package for LaTeX code blocks
1014+: Use the [`listings`] package for LaTeX code blocks. The package
1015+ does not support multi-byte encoding for source code. To handle UTF-8
1016+ you would need to use a custom template. This issue is fully
1017+ documented here: [Encoding issue with the listings package].
9041018
9051019`-i`, `--incremental`
9061020
@@ -909,12 +1023,12 @@ Options affecting specific writers
9091023
9101024`--slide-level=`*NUMBER*
9111025
912−: Specifies that headers with the specified level create
913− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1026+: Specifies that headings with the specified level create
1027+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
9141028 above this level in the hierarchy are used to divide the
915− slide show into sections; headers below this level create
1029+ slide show into sections; headings below this level create
9161030 subheads within a slide. Note that content that is
917− not contained under slide-level headers will not appear in
1031+ not contained under slide-level headings will not appear in
9181032 the slide show. The default is to set the slide level based
9191033 on the contents of the document; see [Structuring the slide
9201034 show].
@@ -923,8 +1037,8 @@ Options affecting specific writers
9231037
9241038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
9251039 and attach identifiers to the enclosing `<section>` (or `<div>`)
926− rather than the header itself. See
927− [Header identifiers], below.
1040+ rather than the heading itself. See
1041+ [Heading identifiers], below.
9281042
9291043`--email-obfuscation=none`|`javascript`|`references`
9301044
@@ -945,8 +1059,7 @@ Options affecting specific writers
9451059
9461060: Specify *STRING* as a prefix at the beginning of the title
9471061 that appears in the HTML header (but not in the title as it
948− appears at the beginning of the HTML body). Implies
949− `--standalone`.
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
9501063
9511064`-c` *URL*, `--css=`*URL*
9521065
@@ -954,8 +1067,8 @@ Options affecting specific writers
9541067 include multiple files. They will be included in the order specified.
9551068
9561069 A stylesheet is required for generating EPUB. If none is
957− provided using this option (or the `stylesheet` metadata
958− field), pandoc will look for a file `epub.css` in the
1070+ provided using this option (or the `css` or `stylesheet`
1071+ metadata fields), pandoc will look for a file `epub.css` in the
9591072 user data directory (see `--data-dir`). If it is not
9601073 found there, sensible defaults will be used.
9611074
@@ -978,20 +1091,56 @@ Options affecting specific writers
9781091
9791092 To produce a custom `reference.docx`, first get a copy of
9801093 the default `reference.docx`: `pandoc
981− --print-default-data-file reference.docx >
982− custom-reference.docx`. Then open `custom-reference.docx`
983− in Word, modify the styles as you wish, and save the file.
984− For best results, do not make changes to this file other
985− than modifying the styles used by pandoc: [paragraph]
986− Normal, Body Text, First Paragraph, Compact, Title,
987− Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
988− Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
989− Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
990− Definition Term, Definition, Caption, Table Caption,
991− Image Caption, Figure, Captioned Figure, TOC Heading;
992− [character] Default Paragraph Font, Body Text Char,
993− Verbatim Char, Footnote Reference, Hyperlink; [table]
994− Table.
1094+ -o custom-reference.docx --print-default-data-file reference.docx`.
1095+ Then open `custom-reference.docx` in Word, modify the
1096+ styles as you wish, and save the file. For best
1097+ results, do not make changes to this file other than
1098+ modifying the styles used by pandoc:
1099+
1100+ Paragraph styles:
1101+
1102+ - Normal
1103+ - Body Text
1104+ - First Paragraph
1105+ - Compact
1106+ - Title
1107+ - Subtitle
1108+ - Author
1109+ - Date
1110+ - Abstract
1111+ - Bibliography
1112+ - Heading 1
1113+ - Heading 2
1114+ - Heading 3
1115+ - Heading 4
1116+ - Heading 5
1117+ - Heading 6
1118+ - Heading 7
1119+ - Heading 8
1120+ - Heading 9
1121+ - Block Text
1122+ - Footnote Text
1123+ - Definition Term
1124+ - Definition
1125+ - Caption
1126+ - Table Caption
1127+ - Image Caption
1128+ - Figure
1129+ - Captioned Figure
1130+ - TOC Heading
1131+
1132+ Character styles:
1133+
1134+ - Default Paragraph Font
1135+ - Body Text Char
1136+ - Verbatim Char
1137+ - Footnote Reference
1138+ - Hyperlink
1139+ - Section Number
1140+
1141+ Table style:
1142+
1143+ - Table
9951144
9961145 ODT
9971146
@@ -1005,19 +1154,18 @@ Options affecting specific writers
10051154
10061155 To produce a custom `reference.odt`, first get a copy of
10071156 the default `reference.odt`: `pandoc
1008− --print-default-data-file reference.odt >
1009− custom-reference.odt`. Then open `custom-reference.odt` in
1010− LibreOffice, modify the styles as you wish, and save the
1011− file.
1157+ -o custom-reference.odt --print-default-data-file reference.odt`.
1158+ Then open `custom-reference.odt` in LibreOffice, modify
1159+ the styles as you wish, and save the file.
10121160
10131161 PowerPoint
10141162
1015− : Any template included with a recent install of Microsoft
1016− PowerPoint (either with `.pptx` or `.potx` extension) should
1017− work, as will most templates derived from these.
1163+ : Templates included with Microsoft PowerPoint 2013 (either with
1164+ `.pptx` or `.potx` extension) are known to work, as are most
1165+ templates derived from these.
10181166
1019− The specific requirement is that the template should contain
1020− the following four layouts as its first four layouts:
1167+ The specific requirement is that the template should begin with
1168+ the following first four layouts:
10211169
10221170 1. Title Slide
10231171 2. Title and Content
@@ -1029,10 +1177,10 @@ Options affecting specific writers
10291177 `Home` menu to check.)
10301178
10311179 You can also modify the default `reference.pptx`: first run
1032− `pandoc --print-default-data-file reference.pptx >
1033− custom-reference.pptx`, and then modify
1034− `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1035− first four layout slides, as mentioned above).
1180+ `pandoc -o custom-reference.pptx --print-default-data-file
1181+ reference.pptx`, and then modify `custom-reference.pptx`
1182+ in MS PowerPoint (pandoc will use the first four layout
1183+ slides, as mentioned above).
10361184
10371185`--epub-cover-image=`*FILE*
10381186
@@ -1100,12 +1248,12 @@ Options affecting specific writers
11001248
11011249`--epub-chapter-level=`*NUMBER*
11021250
1103−: Specify the header level at which to split the EPUB into separate
1104− "chapter" files. The default is to split into chapters at level 1
1105− headers. This option only affects the internal composition of the
1251+: Specify the heading level at which to split the EPUB into separate
1252+ "chapter" files. The default is to split into chapters at level-1
1253+ headings. This option only affects the internal composition of the
11061254 EPUB, not the way chapters and sections are displayed to users. Some
11071255 readers may be slow if the chapter files are too large, so for large
1108− documents with few level 1 headers, one might want to use a chapter
1256+ documents with few level-1 headings, one might want to use a chapter
11091257 level of 2 or 3.
11101258
11111259`--epub-subdirectory=`*DIRNAME*
@@ -1114,69 +1262,118 @@ Options affecting specific writers
11141262 the EPUB-specific contents. The default is `EPUB`. To put
11151263 the EPUB contents in the top level, use an empty string.
11161264
1117−`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
1265+`--ipynb-output=all|none|best`
1266+
1267+: Determines how ipynb output cells are treated. `all` means
1268+ that all of the data formats included in the original are
1269+ preserved. `none` means that the contents of data cells
1270+ are omitted. `best` causes pandoc to try to pick the
1271+ richest data block in each output cell that is compatible
1272+ with the output format. The default is `best`.
1273+
1274+`--pdf-engine=`*PROGRAM*
11181275
11191276: Use the specified engine when producing PDF output.
1120− The default is `pdflatex`. If the engine is not in your PATH,
1121− the full path of the engine may be specified here.
1277+ Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278+ `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1280+ path of the engine may be specified here. If this option
1281+ is not specified, pandoc uses the following defaults
1282+ depending on the output format specified using `-t/--to`:
1283+
1284+ - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285+ `tectonic`, `latexmk`)
1286+ - `-t context`: `context`
1287+ - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288+ see [print-css.rocks](https://print-css.rocks) for a good
1289+ introduction to PDF generation from HTML/CSS.)
1290+ - `-t ms`: `pdfroff`
11221291
11231292`--pdf-engine-opt=`*STRING*
11241293
11251294: Use the given string as a command-line argument to the `pdf-engine`.
1126− If used multiple times, the arguments are provided with spaces between
1127− them. Note that no check for duplicate options is done.
1128−
1129−[Dublin Core elements]: http://dublincore.org/documents/dces/
1130−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1131−
1132−Citation rendering
1133−------------------
1295+ For example, to use a persistent directory `foo` for `latexmk`'s
1296+ auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297+ Note that no check for duplicate options is done.
1298+
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1301+[Encoding issue with the listings package]:
1302+ https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303+
1304+## Citation rendering {.options}
1305+
1306+`-C`, `--citeproc`
1307+
1308+: Process the citations in the file, replacing them with
1309+ rendered citations and adding a bibliography.
1310+ Citation processing will not take place unless bibliographic
1311+ data is supplied, either through an external file specified
1312+ using the `--bibliography` option or the `bibliography`
1313+ field in metadata, or via a `references` section in metadata
1314+ containing a list of citations in CSL YAML format with
1315+ Markdown formatting. The style is controlled by a [CSL]
1316+ stylesheet specified using the `--csl` option or the `csl`
1317+ field in metadata. (If no stylesheet is specified,
1318+ the `chicago-author-date` style will be used by default.)
1319+ The citation processing transformation may be applied before
1320+ or after filters or Lua filters (see `--filter`,
1321+ `--lua-filter`): these transformations are applied in the
1322+ order they appear on the command line. For more
1323+ information, see the section on [Citations].
11341324
11351325`--bibliography=`*FILE*
11361326
11371327: Set the `bibliography` field in the document's metadata to *FILE*,
1138− overriding any value set in the metadata, and process citations
1139− using `pandoc-citeproc`. (This is equivalent to
1140− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1141− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1142− used, making this equivalent to `--metadata bibliography=FILE`.
1143− If you supply this argument multiple times, each *FILE* will be added
1144− to bibliography.
1328+ overriding any value set in the metadata. If you supply
1329+ this argument multiple times, each *FILE* will be added to
1330+ bibliography. If *FILE* is a URL, it will be fetched
1331+ via HTTP. If *FILE* is not found relative to the
1332+ working directory, it will be sought in the resource path
1333+ (see `--resource-path`).
11451334
11461335`--csl=`*FILE*
11471336
11481337: Set the `csl` field in the document's metadata to *FILE*,
11491338 overriding any value set in the metadata. (This is equivalent to
1150− `--metadata csl=FILE`.)
1151− This option is only relevant with `pandoc-citeproc`.
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340+ fetched via HTTP. If *FILE* is not found relative to the
1341+ working directory, it will be sought in the resource path
1342+ (see `--resource-path`) and finally in the `csl`
1343+ subdirectory of the pandoc user data directory.
11521344
11531345`--citation-abbreviations=`*FILE*
11541346
11551347: Set the `citation-abbreviations` field in the document's metadata to
11561348 *FILE*, overriding any value set in the metadata. (This is equivalent to
11571349 `--metadata citation-abbreviations=FILE`.)
1158− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
11591354
11601355`--natbib`
11611356
1162−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1163− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1164− use in producing a LaTeX file that can be processed with [`bibtex`].
1357+: Use [`natbib`] for citations in LaTeX output. This option
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1360+ that can be processed with [`bibtex`].
11651361
11661362`--biblatex`
11671363
1168−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1169− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1170− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1367+ that can be processed with [`bibtex`] or [`biber`].
11711368
1172−Math rendering in HTML
1173−----------------------
1369+## Math rendering in HTML {.options}
11741370
1175−The default is to render TeX math as far as possible using Unicode characters.
1176−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1177−differently from the surrounding text if needed. However, this gives acceptable
1178−results only for basic math, usually you will want to use `--mathjax` or another
1179−of the following options.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1373+`class="math"`, so that they may be styled differently from the
1374+surrounding text if needed. However, this gives acceptable
1375+results only for basic math, usually you will want to use
1376+`--mathjax` or another of the following options.
11801377
11811378`--mathjax`[`=`*URL*]
11821379
@@ -1190,10 +1387,11 @@ of the following options.
11901387
11911388`--mathml`
11921389
1193−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1194− `html4` and `html5`). This is the default in `odt` output. Note that
1195− currently only Firefox and Safari (and select e-book readers) natively
1196− support MathML.
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1392+ default in `odt` output. Note that currently only Firefox
1393+ and Safari (and select e-book readers) natively support
1394+ MathML.
11971395
11981396`--webtex`[`=`*URL*]
11991397
@@ -1210,33 +1408,26 @@ of the following options.
12101408`--katex`[`=`*URL*]
12111409
12121410: Use [KaTeX] to display embedded TeX math in HTML output.
1213− The *URL* is the base URL for the KaTeX library. If a *URL* is
1214− not provided, a link to the KaTeX CDN will be inserted.
1215−
1216−`--katex-stylesheet=`*URL*
1217−
1218−: The *URL* should point to the `katex.css` stylesheet. If this option is
1219− not specified, a link to the KaTeX CDN will be inserted. Note that this
1220− option does not imply `--katex`.
1411+ The *URL* is the base URL for the KaTeX library. That directory
1412+ should contain a `katex.min.js` and a `katex.min.css` file.
1413+ If a *URL* is not provided, a link to the KaTeX CDN will be inserted.
12211414
12221415`--gladtex`
12231416
12241417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1225− can then be processed by [GladTeX] to produce images of the typeset
1226− formulas and an HTML file with links to these images.
1227− So, the procedure is:
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
12281420
12291421 pandoc -s --gladtex input.md -o myfile.htex
1230− gladtex -d myfile-images myfile.htex
1231− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
12321424
1233−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
12341426[MathJax]: https://www.mathjax.org
12351427[KaTeX]: https://github.com/Khan/KaTeX
1236−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
12371429
1238−Options for wrapper scripts
1239−---------------------------
1430+## Options for wrapper scripts {.options}
12401431
12411432`--dump-args`
12421433
@@ -1260,8 +1451,277 @@ Options for wrapper scripts
12601451
12611452 pandoc -o foo.html -s
12621453
1263−Templates
1264−=========
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
12651725
12661726When the `-s/--standalone` option is used, pandoc uses a template to
12671727add header and footer material that is needed for a self-standing
@@ -1281,412 +1741,981 @@ directory (see `--data-dir`, above). *Exceptions:*
12811741 (or the `default.context` template, if you use `-t context`,
12821742 or the `default.ms` template, if you use `-t ms`, or the
12831743 `default.html` template, if you use `-t html`).
1284−- `docx` has no template (however, you can use
1744+- `docx` and `pptx` have no template (however, you can use
12851745 `--reference-doc` to customize the output).
12861746
12871747Templates contain *variables*, which allow for the inclusion of
12881748arbitrary information at any point in the file. They may be set at the
12891749command line using the `-V/--variable` option. If a variable is not set,
1290−pandoc will look for the key in the document's metadata – which can be set
1750+pandoc will look for the key in the document's metadata, which can be set
12911751using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1292−or with the `--metadata` option.
1752+or with the `-M/--metadata` option. In addition, some variables
1753+are given default values by pandoc. See [Variables] below for
1754+a list of variables used in pandoc's default templates.
12931755
1294−Variables set by pandoc
1295−-----------------------
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.
12961761
1297−Some variables are set automatically by pandoc. These vary somewhat
1298−depending on the output format, but include the following:
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
12991763
1300−`sourcefile`, `outputfile`
1301−: source and destination filenames, as given on the command line.
1302− `sourcefile` can also be a list if input comes from multiple files, or empty
1303− if input is from stdin. You can use the following snippet in your template
1304− to distinguish them:
1764+## Template syntax
13051765
1306− $if(sourcefile)$
1307− $for(sourcefile)$
1308− $sourcefile$
1309− $endfor$
1310− $else$
1311− (stdin)
1312− $endif$
1766+### Comments
13131767
1314− Similarly, `outputfile` can be `-` if output goes to the terminal.
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
13151770
1316−`title`, `author`, `date`
1317−: allow identification of basic aspects of the document. Included
1318− in PDF metadata through LaTeX and ConTeXt. These can be set
1319− through a [pandoc title block][Extension: `pandoc_title_block`],
1320− which allows for multiple authors, or through a YAML metadata block:
1771+### Delimiters
13211772
1322− ---
1323− author:
1324− - Aristotle
1325− - Peter Abelard
1326− ...
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.
13271781
1328−`subtitle`
1329−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1330− renders in LaTeX only when using a document class that supports
1331− `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1332− `scrreprt`, `scrbook`).[^subtitle]
1782+To include a literal `$` in the document, use `$$`.
13331783
1334−`institute`
1335−: author affiliations (in LaTeX and Beamer only). Can be a
1336− list, when there are multiple authors.
1784+### Interpolated variables
13371785
1338−`abstract`
1339−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
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:
13401791
1341−`keywords`
1342−: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1343− may be repeated as for `author`, above
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+```
13441802
1345−`header-includes`
1346−: contents specified by `-H/--include-in-header` (may have multiple
1347− values)
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.
13481807
1349−`toc`
1350−: non-null value if `--toc/--table-of-contents` was specified
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.
13511815
1352−`toc-title`
1353−: title of table of contents (works only with EPUB,
1354− opendocument, odt, docx, pptx)
1816+### Conditionals
13551817
1356−`include-before`
1357−: contents specified by `-B/--include-before-body` (may have
1358− multiple values)
1818+A conditional begins with `if(variable)` (enclosed in
1819+matched delimiters) and ends with `endif` (enclosed in matched
1820+delimiters). It may optionally contain an `else` (enclosed in
1821+matched delimiters). The `if` section is used if
1822+`variable` has a non-empty value, otherwise the `else`
1823+section is used (if present). Examples:
13591824
1360−`include-after`
1361−: contents specified by `-A/--include-after-body` (may have
1362− multiple values)
1825+```
1826+$if(foo)$bar$endif$
13631827
1364−`body`
1365−: body of document
1828+$if(foo)$
1829+ $foo$
1830+$endif$
13661831
1367−`meta-json`
1368−: JSON representation of all of the document's metadata. Field
1369− values are transformed to the selected output format.
1832+$if(foo)$
1833+part one
1834+$else$
1835+part two
1836+$endif$
13701837
1371−[^subtitle]: To make `subtitle` work with other LaTeX
1372− document classes, you can add the following to `header-includes`:
1838+${if(foo)}bar${endif}
13731839
1374− \providecommand{\subtitle}[1]{%
1375− \usepackage{titling}
1376− \posttitle{%
1377− \par\large#1\end{center}}
1378− }
1840+${if(foo)}
1841+ ${foo}
1842+${endif}
13791843
1380−Language variables
1381−------------------
1844+${if(foo)}
1845+${ foo.bar }
1846+${else}
1847+no foo!
1848+${endif}
1849+```
13821850
1383−`lang`
1384−: identifies the main language of the document,
1385− using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1386− For some output formats, pandoc will convert it to an appropriate
1387− format stored in the additional variables `babel-lang`,
1388− `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1389−
1390− Native pandoc Spans and Divs with the lang attribute
1391− (value in BCP 47) can be used to switch the language in
1392− that range. In LaTeX output, `babel-otherlangs` and
1393− `polyglossia-otherlangs` variables will be generated
1394− automatically based on the `lang` attributes of Spans
1395− and Divs in the document.
1851+The keyword `elseif` may be used to simplify complex nested
1852+conditionals:
13961853
1397−`dir`
1398−: the base direction of the document, either `rtl` (right-to-left)
1399− or `ltr` (left-to-right).
1854+```
1855+$if(foo)$
1856+XXX
1857+$elseif(bar)$
1858+YYY
1859+$else$
1860+ZZZ
1861+$endif$
1862+```
14001863
1401− For bidirectional documents, native pandoc `span`s and `div`s
1402− with the `dir` attribute (value `rtl` or `ltr`) can be used to
1403− override the base direction in some output formats.
1404− This may not always be necessary if the final renderer
1405− (e.g. the browser, when generating HTML) supports the
1406− [Unicode Bidirectional Algorithm].
1864+### For loops
14071865
1408− When using LaTeX for bidirectional documents, only the `xelatex` engine
1409− is fully supported (use `--pdf-engine=xelatex`).
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
1868+delimiters.
14101869
1411−[BCP 47]: https://tools.ietf.org/html/bcp47
1412−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
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.
14131877
1414−Variables for slides
1415−--------------------
1878+Examples:
14161879
1417−Variables are available for [producing slide shows with pandoc],
1418−including all [reveal.js configuration options].
1880+```
1881+$for(foo)$$foo$$sep$, $endfor$
14191882
1420−`titlegraphic`
1421−: title graphic for Beamer documents
1883+$for(foo)$
1884+ - $foo.last$, $foo.first$
1885+$endfor$
14221886
1423−`logo`
1424−: logo for Beamer documents
1887+${ for(foo.bar) }
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1889+${ endfor }
14251890
1426−`slidy-url`
1427−: base URL for Slidy documents (defaults to
1428− `https://www.w3.org/Talks/Tools/Slidy2`)
1891+$for(mymap)$
1892+$it.name$: $it.office$
1893+$endfor$
1894+```
14291895
1430−`slideous-url`
1431−: base URL for Slideous documents (defaults to `slideous`)
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.
14321899
1433−`s5-url`
1434−: base URL for S5 documents (defaults to `s5/default`)
1900+```
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1902+```
14351903
1436−`revealjs-url`
1437−: base URL for reveal.js documents (defaults to `reveal.js`)
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
14381906
1439−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1440−: themes for LaTeX [`beamer`] documents
1907+```
1908+${ for(foo.bar) }
1909+ - ${ it.last }, ${ it.first }
1910+${ endfor }
1911+```
14411912
1442−`themeoptions`
1443−: options for LaTeX beamer themes (a list).
1913+### Partials
14441914
1445−`navigation`
1446−: controls navigation symbols in `beamer` documents
1447− (default is `empty` for no navigation symbols; other valid values
1448− are `frame`, `vertical`, and `horizontal`).
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
14491918
1450−`section-titles`
1451−: enables on "title pages" for new sections in `beamer`
1452− documents (default = true).
1919+```
1920+${ styles() }
1921+```
14531922
1454−`beamerarticle`
1455−: when true, the `beamerarticle` package is loaded (for
1456− producing an article from beamer slides).
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:
14571928
1458−`aspectratio`
1459−: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1460− `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1461− default, and `32` for 3:2).
1929+```
1930+${ styles.html() }
1931+```
14621932
1463−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
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.)
14641937
1465−Variables for LaTeX
1466−-------------------
1938+Partials may optionally be applied to variables using
1939+a colon:
14671940
1468−LaTeX variables are used when [creating a PDF].
1941+```
1942+${ date:fancy() }
14691943
1470−`papersize`
1471−: paper size, e.g. `letter`, `a4`
1944+${ articles:bibentry() }
1945+```
14721946
1473−`fontsize`
1474−: font size for body text (e.g. `10pt`, `12pt`)
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
14751950
1476−`documentclass`
1477−: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
1951+```
1952+${ for(articles) }
1953+${ it:bibentry() }
1954+${ endfor }
1955+```
14781956
1479−`classoption`
1480−: option for document class, e.g. `oneside`; may be repeated
1481− for multiple options
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`.
14821961
1483−`beameroption`
1484−: In beamer, add extra beamer option with `\setbeameroption{}`
1962+Final newlines are omitted from included partials.
14851963
1486−`geometry`
1487−: option for [`geometry`] package, e.g. `margin=1in`;
1488− may be repeated for multiple options
1964+Partials may include other partials.
14891965
1490−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1491−: sets margins, if `geometry` is not used (otherwise `geometry`
1492− overrides these)
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1968+or partial:
14931969
1494−`linestretch`
1495−: adjusts line spacing using the [`setspace`]
1496− package, e.g. `1.25`, `1.5`
1970+```
1971+${months[, ]}$
14971972
1498−`fontfamily`
1499−: font package for use with `pdflatex`:
1500− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1501− The default is [Latin Modern][`lm`].
1973+${articles:bibentry()[; ]$
1974+```
15021975
1503−`fontfamilyoptions`
1504−: options for package used as `fontfamily`: e.g. `osf,sc` with
1505− `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1506− figures and true small caps; may be repeated for multiple options
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.
15071979
1508−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1509−: font families for use with `xelatex` or
1510− `lualatex`: take the name of any system font, using the
1511− [`fontspec`] package. Note that if `CJKmainfont` is used,
1512− the [`xecjk`] package must be available.
1980+### Nesting
15131981
1514−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1515−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1516− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1517− available through [`fontspec`], such as the OpenType features
1518− `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
15191984
1520−`fontenc`
1521−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1522− default is `T1` (see guide to [LaTeX font encodings])
1985+```
1986+$item.number$ $^$$item.description$ ($item.price$)
1987+```
15231988
1524−`microtypeoptions`
1525−: options to pass to the microtype package
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
15261991
1527−`colorlinks`
1528−: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1529− `urlcolor`, or `toccolor` are set
1992+```
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1995+```
15301996
1531−`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1532−: color for internal links, citation links, external links, and links in table of contents:
1533− uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
15341999
1535−`links-as-notes`
1536−: causes links to be printed as footnotes
2000+```
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2003+```
15372004
1538−`indent`
1539−: uses document class settings for indentation (the default LaTeX template
1540− otherwise removes indentation and adds space between paragraphs)
2005+will produce
15412006
1542−`subparagraph`
1543−: disables default behavior of LaTeX template that redefines (sub)paragraphs
1544− as sections, changing the appearance of nested headings in some classes
2007+```
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
2011+```
15452012
1546−`thanks`
1547−: specifies contents of acknowledgments footnote after document title.
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.
15482017
1549−`toc`
1550−: include table of contents (can also be set using `--toc/--table-of-contents`)
2018+### Breakable spaces
15512019
1552−`toc-depth`
1553−: level of section to include in table of contents
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 `~`).
15542024
1555−`secnumdepth`
1556−: numbering depth for sections, if sections are numbered
2025+```
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
2028+```
15572029
1558−`lof`, `lot`
1559−: include list of figures, list of tables
2030+### Pipes
15602031
1561−`bibliography`
1562−: bibliography to use for resolving references
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:
15632035
1564−`biblio-style`
1565−: bibliography style, when used with `--natbib` and `--biblatex`.
2036+```
2037+$for(name)$
2038+$name/uppercase$
2039+$endfor$
15662040
1567−`biblio-title`
1568−: bibliography title, when used with `--natbib` and `--biblatex`.
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2043+$endfor$
15692044
1570−`biblatexoptions`
1571−: list of options for biblatex.
2045+$employee:name()/uppercase$
2046+```
15722047
1573−`natbiboptions`
1574−: list of options for natbib.
2048+Pipes may be chained:
15752049
1576−`pagestyle`
1577−: An option for LaTeX's `\pagestyle{}`. The default article class
1578− supports 'plain' (default), 'empty', and 'headings'; headings puts
1579− section titles in the header.
2050+```
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2053+$endfor$
2054+```
15802055
1581−[`article`]: https://ctan.org/pkg/article
1582−[`report`]: https://ctan.org/pkg/report
1583−[`book`]: https://ctan.org/pkg/book
1584−[KOMA-Script]: https://ctan.org/pkg/koma-script
1585−[`memoir`]: https://ctan.org/pkg/memoir
1586−[`xcolor`]: https://ctan.org/pkg/xcolor
1587−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1588−[`mathpazo`]: https://ctan.org/pkg/mathpazo
1589−[LaTeX font encodings]: https://ctan.org/pkg/encguide
2056+Some pipes take parameters:
15902057
1591−Variables for ConTeXt
1592−---------------------
2058+```
2059+|----------------------|------------|
2060+$for(employee)$
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062+$endfor$
2063+|----------------------|------------|
2064+```
15932065
1594−`papersize`
1595−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1596− may be repeated for multiple options
2066+Currently the following pipes are predefined:
15972067
1598−`layout`
1599−: options for page margins and text arrangement (see [ConTeXt Layout]);
1600− may be repeated for multiple options
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.
16012072
1602−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1603−: sets margins, if `layout` is not used (otherwise `layout`
2073+- `uppercase`: Converts text to uppercase.
2074+
2075+- `lowercase`: Converts text to lowercase.
2076+
2077+- `length`: Returns the length of the value: number
2078+ of characters for a textual value, number of elements
2079+ for a map or array.
2080+
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2083+
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2087+
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
2091+
2092+- `rest`: Returns all but the first value of an array, if
2093+ applied to a non-empty array; otherwise returns
2094+ the original value.
2095+
2096+- `allbutlast`: Returns all but the last value of an array, if
2097+ applied to a non-empty array; otherwise returns
2098+ the original value.
2099+
2100+- `chomp`: Removes trailing newlines (and breakable space).
2101+
2102+- `nowrap`: Disables line wrapping on breakable spaces.
2103+
2104+- `alpha`: Converts textual values that can be
2105+ read as an integer into lowercase alphabetic
2106+ characters `a..z` (mod 26). This can be used to get lettered
2107+ enumeration from array indices. To get uppercase
2108+ letters, chain with `uppercase`.
2109+
2110+- `roman`: Converts textual values that can be
2111+ read as an integer into lowercase roman numerials.
2112+ This can be used to get lettered enumeration from array indices.
2113+ To get uppercase roman, chain with `uppercase`.
2114+
2115+- `left n "leftborder" "rightborder"`: Renders a textual value
2116+ in a block of width `n`, aligned to the left, with an optional
2117+ left and right border. Has no effect on other values. This
2118+ can be used to align material in tables. Widths are positive
2119+ integers indicating the number of characters. Borders
2120+ are strings inside double quotes; literal `"` and `\` characters
2121+ must be backslash-escaped.
2122+
2123+- `right n "leftborder" "rightborder"`: Renders a textual value
2124+ in a block of width `n`, aligned to the right, and has no
2125+ effect on other values.
2126+
2127+- `center n "leftborder" "rightborder"`: Renders a textual
2128+ value in a block of width `n`, aligned to the center, and has
2129+ no effect on other values.
2130+
2131+
2132+## Variables
2133+
2134+### Metadata variables
2135+
2136+`title`, `author`, `date`
2137+: allow identification of basic aspects of the document. Included
2138+ in PDF metadata through LaTeX and ConTeXt. These can be set
2139+ through a [pandoc title block][Extension: `pandoc_title_block`],
2140+ which allows for multiple authors, or through a
2141+ [YAML metadata block][Extension: `yaml_metadata_block`]:
2142+
2143+ ---
2144+ author:
2145+ - Aristotle
2146+ - Peter Abelard
2147+ ...
2148+
2149+ Note that if you just want to set PDF or HTML metadata, without
2150+ including a title block in the document itself, you can
2151+ set the `title-meta`, `author-meta`, and `date-meta`
2152+ variables. (By default these are set automatically, based
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
2155+
2156+`subtitle`
2157+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2158+ documents
2159+
2160+`abstract`
2161+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
2162+ documents
2163+
2164+`keywords`
2165+: list of keywords to be included in HTML, PDF, ODT, pptx, docx
2166+ and AsciiDoc metadata; repeat as for `author`, above
2167+
2168+`subject`
2169+: document subject, included in ODT, PDF, docx and pptx metadata
2170+
2171+`description`
2172+: document description, included in ODT, docx and pptx metadata. Some
2173+ applications show this as `Comments` metadata.
2174+
2175+`category`
2176+: document category, included in docx and pptx metadata
2177+
2178+Additionally,
2179+any root-level string metadata, not included in ODT, docx
2180+or pptx metadata is added as a *custom property*.
2181+The following [YAML] metadata block for instance:
2182+
2183+ ---
2184+ title: 'This is the title'
2185+ subtitle: "This is the subtitle"
2186+ author:
2187+ - Author One
2188+ - Author Two
2189+ description: |
2190+ This is a long
2191+ description.
2192+
2193+ It consists of two paragraphs
2194+ ...
2195+
2196+will include `title`, `author` and `description` as standard document
2197+properties and `subtitle` as a custom property when converting to docx,
2198+ODT or pptx.
2199+
2200+### Language variables
2201+
2202+`lang`
2203+: identifies the main language of the document using IETF language
2204+ tags (following the [BCP 47] standard), such as `en` or `en-GB`.
2205+ The [Language subtag lookup] tool can look up or verify these tags.
2206+ This affects most formats, and controls hyphenation in PDF output
2207+ when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.
2208+
2209+ Use native pandoc [Divs and Spans] with the `lang` attribute to
2210+ switch the language:
2211+
2212+ ---
2213+ lang: en-GB
2214+ ...
2215+
2216+ Text in the main document language (British English).
2217+
2218+ ::: {lang=fr-CA}
2219+ > Cette citation est écrite en français canadien.
2220+ :::
2221+
2222+ More text in English. ['Zitat auf Deutsch.']{lang=de}
2223+
2224+`dir`
2225+: the base script direction, either `rtl` (right-to-left)
2226+ or `ltr` (left-to-right).
2227+
2228+ For bidirectional documents, native pandoc `span`s and
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230+ be used to override the base direction in some output
2231+ formats. This may not always be necessary if the final
2232+ renderer (e.g. the browser, when generating HTML) supports
2233+ the [Unicode Bidirectional Algorithm].
2234+
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
2238+
2239+[BCP 47]: https://tools.ietf.org/html/bcp47
2240+[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2241+[Language subtag lookup]: https://r12a.github.io/app-subtags/
2242+
2243+### Variables for HTML
2244+
2245+`document-css`
2246+: Enables inclusion of most of the [CSS] in the `styles.html`
2247+ [partial](#partials) (have a look with
2248+ `pandoc --print-default-data-file=templates/styles.html`).
2249+ Unless you use [`--css`](#option--css), this variable
2250+ is set to `true` by default. You can disable it with
2251+ e.g. `pandoc -M document-css=false`.
2252+
2253+`mainfont`
2254+: sets the CSS `font-family` property on the `html` element.
2255+
2256+`fontsize`
2257+: sets the base CSS `font-size`, which you'd usually set
2258+ to e.g. `20px`, but it also accepts `pt`
2259+ (12pt = 16px in most browsers).
2260+
2261+`fontcolor`
2262+: sets the CSS `color` property on the `html` element.
2263+
2264+`linkcolor`
2265+: sets the CSS `color` property on all links.
2266+
2267+`monofont`
2268+: sets the CSS `font-family` property on `code` elements.
2269+
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2273+
2274+`linestretch`
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
2277+
2278+`backgroundcolor`
2279+: sets the CSS `background-color` property on the `html` element.
2280+
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
2283+
2284+To override or extend some [CSS] for just one document, include for example:
2285+
2286+ ---
2287+ header-includes: |
2288+ <style>
2289+ blockquote {
2290+ font-style: italic;
2291+ }
2292+ tr.even {
2293+ background-color: #f0f0f0;
2294+ }
2295+ td, th {
2296+ padding: 0.5em 2em 0.5em 0.5em;
2297+ }
2298+ tbody {
2299+ border-bottom: none;
2300+ }
2301+ </style>
2302+ ---
2303+
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305+
2306+### Variables for HTML math
2307+
2308+`classoption`
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
2312+
2313+### Variables for HTML slides
2314+
2315+These affect HTML output when [producing slide shows with pandoc].
2316+
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
2319+
2320+`revealjs-url`
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
2323+
2324+`s5-url`
2325+: base URL for S5 documents (defaults to `s5/default`)
2326+
2327+`slidy-url`
2328+: base URL for Slidy documents (defaults to
2329+ `https://www.w3.org/Talks/Tools/Slidy2`)
2330+
2331+`slideous-url`
2332+: base URL for Slideous documents (defaults to `slideous`)
2333+
2334+`title-slide-attributes`
2335+: additional attributes for the title slide of reveal.js slide shows.
2336+ See [background in reveal.js and beamer] for an example.
2337+
2338+All [reveal.js configuration options] are available as variables.
2339+To turn off boolean flags that default to true in reveal.js, use `0`.
2340+
2341+[reveal.js configuration options]: https://revealjs.com/config/
2342+
2343+### Variables for Beamer slides
2344+
2345+These variables change the appearance of PDF slides using [`beamer`].
2346+
2347+`aspectratio`
2348+: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,
2349+ `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,
2350+ `32` for 3:2)
2351+
2352+`beamerarticle`
2353+: produce an article from Beamer slides
2354+
2355+`beameroption`
2356+: add extra beamer option with `\setbeameroption{}`
2357+
2358+`institute`
2359+: author affiliations: can be a list when there are multiple authors
2360+
2361+`logo`
2362+: logo image for slides
2363+
2364+`navigation`
2365+: controls navigation symbols (default is `empty` for no navigation
2366+ symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367+
2368+`section-titles`
2369+: enables "title pages" for new sections (default is true)
2370+
2371+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372+: beamer themes
2373+
2374+`themeoptions`
2375+: options for LaTeX beamer themes (a list).
2376+
2377+`titlegraphic`
2378+: image for title slide
2379+
2380+### Variables for PowerPoint
2381+
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
2384+
2385+`monofont`
2386+: font to use for code.
2387+
2388+### Variables for LaTeX
2389+
2390+Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2391+
2392+#### Layout
2393+
2394+`block-headings`
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
2397+ classes) free-standing rather than run-in; requires further
2398+ formatting to distinguish from `\subsubsection` (third- or
2399+ fourth-level headings). Instead of using this option,
2400+ [KOMA-Script] can adjust headings more extensively:
2401+
2402+ ---
2403+ documentclass: scrartcl
2404+ header-includes: |
2405+ \RedeclareSectionCommand[
2406+ beforeskip=-10pt plus -2pt minus -1pt,
2407+ afterskip=1sp plus -1sp minus 1sp,
2408+ font=\normalfont\itshape]{paragraph}
2409+ \RedeclareSectionCommand[
2410+ beforeskip=-10pt plus -2pt minus -1pt,
2411+ afterskip=1sp plus -1sp minus 1sp,
2412+ font=\normalfont\scshape,
2413+ indent=0pt]{subparagraph}
2414+ ...
2415+
2416+`classoption`
2417+: option for document class, e.g. `oneside`; repeat for multiple options:
2418+
2419+ ---
2420+ classoption:
2421+ - twocolumn
2422+ - landscape
2423+ ...
2424+
2425+`documentclass`
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429+ default to smaller margins; or [`memoir`]
2430+
2431+`geometry`
2432+: option for [`geometry`] package, e.g. `margin=1in`;
2433+ repeat for multiple options:
2434+
2435+ ---
2436+ geometry:
2437+ - top=30mm
2438+ - left=20mm
2439+ - heightrounded
2440+ ...
2441+
2442+`hyperrefoptions`
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2445+
2446+ ---
2447+ hyperrefoptions:
2448+ - linktoc=all
2449+ - pdfwindowui
2450+ - pdfpagemode=FullScreen
2451+ ...
2452+
2453+`indent`
2454+: if true, pandoc will use document class settings for
2455+ indentation (the default LaTeX template otherwise removes
2456+ indentation and adds space between paragraphs)
2457+
2458+`linestretch`
2459+: adjusts line spacing using the [`setspace`]
2460+ package, e.g. `1.25`, `1.5`
2461+
2462+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2463+: sets margins if `geometry` is not used (otherwise `geometry`
16042464 overrides these)
16052465
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+
16062501`fontsize`
1607−: font size for body text (e.g. `10pt`, `12pt`)
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`.
16082505
1609−`mainfont`, `sansfont`, `monofont`, `mathfont`
1610−: font families: take the name of any system font (see [ConTeXt Font Switching])
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.
16112510
1612−`linkcolor`, `contrastcolor`
1613−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
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:
16142517
1615−`linkstyle`
1616−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2518+ ---
2519+ mainfont: TeX Gyre Pagella
2520+ mainfontoptions:
2521+ - Numbers=Lowercase
2522+ - Numbers=Proportional
2523+ ...
16172524
1618−`indenting`
1619−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1620− may be repeated for multiple options
2525+`microtypeoptions`
2526+: options to pass to the microtype package
16212527
1622−`whitespace`
1623−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2528+#### Links
2529+
2530+`colorlinks`
2531+: add color to link text; automatically enabled if any of
2532+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533+
2534+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535+: color for internal links, external links, citation links, linked
2536+ URLs, and links in table of contents, respectively: uses options
2537+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538+ `x11names` lists
2539+
2540+`links-as-notes`
2541+: causes links to be printed as footnotes
2542+
2543+#### Front matter
2544+
2545+`lof`, `lot`
2546+: include list of figures, list of tables
2547+
2548+`thanks`
2549+: contents of acknowledgments footnote after document title
2550+
2551+`toc`
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
2554+
2555+`toc-depth`
2556+: level of section to include in table of contents
2557+
2558+#### BibLaTeX Bibliographies
2559+
2560+These variables function when using BibLaTeX for [citation rendering].
2561+
2562+`biblatexoptions`
2563+: list of options for biblatex
2564+
2565+`biblio-style`
2566+: bibliography style, when used with `--natbib` and `--biblatex`.
2567+
2568+`biblio-title`
2569+: bibliography title, when used with `--natbib` and `--biblatex`.
2570+
2571+`bibliography`
2572+: bibliography to use for resolving references
2573+
2574+`natbiboptions`
2575+: list of options for natbib
2576+
2577+[KOMA-Script]: https://ctan.org/pkg/koma-script
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579+[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580+[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581+[`article`]: https://ctan.org/pkg/article
2582+[`book`]: https://ctan.org/pkg/book
2583+[`libertinus`]: https://ctan.org/pkg/libertinus
2584+[`memoir`]: https://ctan.org/pkg/memoir
2585+[`report`]: https://ctan.org/pkg/report
2586+
2587+### Variables for ConTeXt
2588+
2589+Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590+
2591+`fontsize`
2592+: font size for body text (e.g. `10pt`, `12pt`)
2593+
2594+`headertext`, `footertext`
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
2597+
2598+`indenting`
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
16242601
16252602`interlinespace`
16262603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1627− may be repeated for multiple options
2604+ repeat for multiple options
16282605
1629−`headertext`, `footertext`
1630−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1631− may be repeated up to four times for different placement
2606+`layout`
2607+: options for page margins and text arrangement (see [ConTeXt Layout]);
2608+ repeat for multiple options
16322609
1633−`pagenumbering`
1634−: page number style and location (using [`setuppagenumbering`]);
1635− may be repeated for multiple options
2610+`linkcolor`, `contrastcolor`
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
16362613
1637−`toc`
1638−: include table of contents (can also be set using `--toc/--table-of-contents`)
2614+`linkstyle`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
16392617
16402618`lof`, `lot`
16412619: include list of figures, list of tables
16422620
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+
16432637`pdfa`
1644−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1645− To successfully generate PDF/A the required ICC color profiles have to
1646− be available and the content and all included files (such as images)
1647− have to be standard conforming. The ICC profiles can be obtained
1648− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1649− details.
1650−
1651−[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
1652−[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
1653−[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
1654−[ConTeXt Color]: http://wiki.contextgarden.net/Color
1655−[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1656−[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1657−[ConTeXt ICC Profiles]: http://wiki.contextgarden.net/PDFX#ICC_profiles
1658−[ConTeXt PDFA]: http://wiki.contextgarden.net/PDF/A
1659−[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1660−[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1661−[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
1662−
1663−Variables for man pages
1664−-----------------------
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.
16652662
1666−`section`
1667−: section number in man pages
2663+`toc`
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
16682666
1669−`header`
1670−: header in man pages
2667+`whitespace`
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
16712670
1672−`footer`
1673−: footer in man pages
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
16742701
16752702`adjusting`
16762703: adjusts text to left (`l`), right (`r`), center (`c`),
16772704 or both (`b`) margins
16782705
2706+`footer`
2707+: footer in man pages
2708+
2709+`header`
2710+: header in man pages
2711+
16792712`hyphenate`
16802713: if `true` (the default), hyphenation will be used
16812714
1682−Variables for ms
1683−----------------
1684−
1685−`pointsize`
1686−: point size (e.g. `10p`)
2715+`section`
2716+: section number in man pages
16872717
1688−`lineheight`
1689−: line height (e.g. `12p`)
2718+### Variables for ms
16902719
16912720`fontfamily`
16922721: font family (e.g. `T` or `P`)
@@ -1694,75 +2723,81 @@ Variables for ms
16942723`indent`
16952724: paragraph indent (e.g. `2m`)
16962725
1697−Using variables in templates
1698−----------------------------
2726+`lineheight`
2727+: line height (e.g. `12p`)
16992728
1700−Variable names are sequences of alphanumerics, `-`, and `_`,
1701−starting with a letter. A variable name surrounded by `$` signs
1702−will be replaced by its value. For example, the string `$title$` in
2729+`pointsize`
2730+: point size (e.g. `10p`)
17032731
1704− <title>$title$</title>
2732+### Variables set automatically
17052733
1706−will be replaced by the document title.
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:
17072737
1708−To write a literal `$` in a template, use `$$`.
2738+`body`
2739+: body of document
17092740
1710−Templates may contain conditionals. The syntax is as follows:
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`).
17112750
1712− $if(variable)$
1713− X
1714− $else$
1715− Y
1716− $endif$
2751+`header-includes`
2752+: contents specified by `-H/--include-in-header` (may have multiple
2753+ values)
17172754
1718−This will include `X` in the template if `variable` has a truthy
1719−value; otherwise it will include `Y`. Here a truthy value is any
1720−of the following:
2755+`include-before`
2756+: contents specified by `-B/--include-before-body` (may have
2757+ multiple values)
17212758
1722−- a string that is not entirely white space,
1723−- a non-empty array where the first value is truthy,
1724−- any number (including zero),
1725−- any object,
1726−- the boolean `true` (to specify the boolean `true`
1727− value using YAML metadata or the `--metadata` flag,
1728− use `true`, `True`, or `TRUE`; with the `--variable`
1729− flag, simply omit a value for the variable, e.g.
1730− `--variable draft`).
2759+`include-after`
2760+: contents specified by `-A/--include-after-body` (may have
2761+ multiple values)
17312762
1732−`X` and `Y` are placeholders for any valid template text,
1733−and may include interpolated variables or other conditionals.
1734−The `$else$` section may be omitted.
2763+`meta-json`
2764+: JSON representation of all of the document's metadata. Field
2765+ values are transformed to the selected output format.
17352766
1736−When variables can have multiple values (for example, `author` in
1737−a multi-author document), you can use the `$for$` keyword:
2767+`numbersections`
2768+: non-null value if `-N/--number-sections` was specified
17382769
1739− $for(author)$
1740− <meta name="author" content="$author$" />
1741− $endfor$
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:
17422775
1743−You can optionally specify a separator to be used between
1744−consecutive items:
2776+ $if(sourcefile)$
2777+ $for(sourcefile)$
2778+ $sourcefile$
2779+ $endfor$
2780+ $else$
2781+ (stdin)
2782+ $endif$
17452783
1746− $for(author)$$author$$sep$, $endfor$
2784+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17472785
1748−A dot can be used to select a field of a variable that takes
1749−an object as its value. So, for example:
2786+ If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
17502787
1751− $author.name$ ($author.affiliation$)
2788+`curdir`
2789+: working directory from which pandoc is run.
17522790
1753−If you use custom templates, you may need to revise them as pandoc
1754−changes. We recommend tracking the changes in the default templates,
1755−and modifying your custom templates accordingly. An easy way to do this
1756−is to fork the [pandoc-templates] repository and merge in changes after each
1757−pandoc release.
2791+`toc`
2792+: non-null value if `--toc/--table-of-contents` was specified
17582793
1759−Templates may contain comments: anything on a line after `$--`
1760−will be treated as a comment and ignored.
2794+`toc-title`
2795+: title of table of contents (works only with EPUB,
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
17612797
17622798[pandoc-templates]: https://github.com/jgm/pandoc-templates
17632799
1764−Extensions
1765−==========
2800+# Extensions
17662801
17672802The behavior of some of the readers and writers can be adjusted by
17682803enabling or disabling various extensions.
@@ -1779,8 +2814,11 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
17792814`commonmark` and `gfm`.) In the following, extensions that also work
17802815for other formats are covered.
17812816
1782−Typography
1783−----------
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
17842822
17852823#### Extension: `smart` ####
17862824
@@ -1812,13 +2850,12 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
18122850to use the ligatures when possible; if `smart` is disabled
18132851pandoc will use unicode quotation mark and dash characters.
18142852
1815−Headers and sections
1816−--------------------
2853+## Headings and sections
18172854
18182855#### Extension: `auto_identifiers` ####
18192856
1820−A header without an explicitly specified identifier will be
1821−automatically assigned a unique identifier based on the header text.
2857+A heading without an explicitly specified identifier will be
2858+automatically assigned a unique identifier based on the heading text.
18222859
18232860This extension can be enabled/disabled for the following formats:
18242861
@@ -1831,11 +2868,13 @@ output formats
18312868enabled by default in
18322869: `markdown`, `muse`
18332870
1834−The algorithm used to derive the identifier from the header text is:
2871+The default algorithm used to derive the identifier from the
2872+heading text is:
18352873
18362874 - Remove all formatting, links, etc.
18372875 - Remove all footnotes.
1838− - Remove all punctuation, except underscores, hyphens, and periods.
2876+ - Remove all non-alphanumeric characters,
2877+ except underscores, hyphens, and periods.
18392878 - Replace all spaces and newlines with hyphens.
18402879 - Convert all alphabetic characters to lowercase.
18412880 - Remove everything up to the first letter (identifiers may
@@ -1844,27 +2883,31 @@ The algorithm used to derive the identifier from the header text is:
18442883
18452884Thus, for example,
18462885
1847− Header Identifier
2886+ Heading Identifier
18482887 ------------------------------- ----------------------------
1849− `Header identifiers in HTML` `header-identifiers-in-html`
2888+ `Heading identifiers in HTML` `heading-identifiers-in-html`
2889+ `Maître d'hôtel` `maître-dhôtel`
18502890 `*Dogs*?--in *my* house?` `dogs--in-my-house`
18512891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
18522892 `3. Applications` `applications`
18532893 `33` `section`
18542894
18552895These rules should, in most cases, allow one to determine the identifier
1856−from the header text. The exception is when several headers have the
2896+from the heading text. The exception is when several headings have the
18572897same text; in this case, the first will get an identifier as described
18582898above; the second will get the same identifier with `-1` appended; the
18592899third with `-2`; and so on.
18602900
2901+(However, a different algorithm is used if
2902+`gfm_auto_identifiers` is enabled; see below.)
2903+
18612904These identifiers are used to provide link targets in the table of
18622905contents generated by the `--toc|--table-of-contents` option. They
18632906also make it easy to provide links from one section of a document to
18642907another. A link to this section, for example, might look like this:
18652908
18662909 See the section on
1867− [header identifiers](#header-identifiers-in-html-latex-and-context).
2910+ [heading identifiers](#heading-identifiers-in-html-latex-and-context).
18682911
18692912Note, however, that this method of providing links to sections works
18702913only in HTML, LaTeX, and ConTeXt formats.
@@ -1872,7 +2915,7 @@ only in HTML, LaTeX, and ConTeXt formats.
18722915If the `--section-divs` option is specified, then each section will
18732916be wrapped in a `section` (or a `div`, if `html4` was specified),
18742917and the identifier will be attached to the enclosing `<section>`
1875−(or `<div>`) tag rather than the header itself. This allows entire
2918+(or `<div>`) tag rather than the heading itself. This allows entire
18762919sections to be manipulated using JavaScript or treated differently in
18772920CSS.
18782921
@@ -1882,8 +2925,15 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
18822925Accents are stripped off of accented Latin letters, and non-Latin
18832926letters are omitted.
18842927
1885−Math Input
1886−----------
2928+#### Extension: `gfm_auto_identifiers` ####
2929+
2930+Changes the algorithm used by `auto_identifiers` to conform to
2931+GitHub's method. Spaces are converted to dashes (`-`),
2932+uppercase characters to lowercase characters, and punctuation
2933+characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
2935+
2936+## Math Input
18872937
18882938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
18892939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -1893,50 +2943,47 @@ are described in the section about Pandoc's Markdown.
18932943However, they can also be used with HTML input. This is handy for
18942944reading web pages formatted using MathJax, for example.
18952945
1896−Raw HTML/TeX
1897−------------
2946+## Raw HTML/TeX
18982947
1899−The following extensions (especially how they affect Markdown
1900−input/output) are also described in more detail in their respective
1901−sections of [Pandoc's Markdown].
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
19022950
1903−#### [Extension: `raw_html`] {#raw_html}
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.
19042954
1905−When converting from HTML, parse elements to raw HTML which are not
1906−representable in pandoc's AST.
1907−By default, this is disabled for HTML input.
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`):
19082958
1909−#### [Extension: `raw_tex`] {#raw_tex}
2959+ input formats
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2961+ `\eqref` only), `ipynb`
19102962
1911−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2963+ output formats
2964+ : `textile`, `commonmark`
19122965
1913−This extension can be enabled/disabled for the following formats
1914−(in addition to `markdown`):
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967+ only raw TeX in markdown cells, but data with mime type
2968+ `text/html` in output cells. Since the `ipynb` reader attempts
2969+ to preserve the richest possible outputs when several options
2970+ are given, you will get best results if you disable `raw_html`
2971+ and `raw_tex` when converting to formats like `docx` which don't
2972+ allow raw `html` or `tex`.
19152973
1916−input formats
1917−: `latex`, `org`, `textile`
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`.
19182978
1919−output formats
1920−: `textile`
1921−
1922−#### [Extension: `native_divs`] {#native_divs}
1923−
1924−This extension is enabled by default for HTML input. This means that
1925−`div`s are parsed to pandoc native elements. (Alternatively, you
1926−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
1927−
1928−When converting HTML to Markdown, for example, you may want to drop all
1929−`div`s and `span`s:
1930−
1931− pandoc -f html-native_divs-native_spans -t markdown
1932−
1933−#### [Extension: `native_spans`] {#native_spans}
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`.
19342985
1935−Analogous to `native_divs` above.
1936−
1937−
1938−Literate Haskell support
1939−------------------------
2986+## Literate Haskell support
19402987
19412988#### Extension: `literate_haskell` ####
19422989
@@ -1957,12 +3004,12 @@ This means that
19573004 - In Markdown input, "bird track" sections will be parsed as Haskell
19583005 code rather than block quotations. Text between `\begin{code}`
19593006 and `\end{code}` will also be treated as Haskell code. For
1960− ATX-style headers the character '=' will be used instead of '#'.
3007+ ATX-style headings the character '=' will be used instead of '#'.
19613008
19623009 - In Markdown output, code blocks with classes `haskell` and `literate`
19633010 will be rendered using bird tracks, and block quotations will be
19643011 indented one space, so they will not be treated as Haskell code.
1965− In addition, headers will be rendered setext-style (with underlines)
3012+ In addition, headings will be rendered setext-style (with underlines)
19663013 rather than ATX-style (with '#' characters). (This is because ghc
19673014 treats '#' characters in column 1 as introducing line numbers.)
19683015
@@ -1997,8 +3044,7 @@ Note that GHC expects the bird tracks in the first column, so indented
19973044literate code blocks (e.g. inside an itemized environment) will not be
19983045picked up by the Haskell compiler.
19993046
2000−Other extensions
2001−----------------
3047+## Other extensions
20023048
20033049#### Extension: `empty_paragraphs` ####
20043050
@@ -2013,12 +3059,60 @@ input formats
20133059output formats
20143060: `docx`, `odt`, `opendocument`, `html`
20153061
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+
20163109#### Extension: `styles` #### {#ext-styles}
20173110
2018−Read all docx styles as divs (for paragraph styles) and spans (for
2019−character styles) regardless of whether pandoc understands the meaning
2020−of these styles. This can be used with [docx custom
2021−styles](#custom-styles-in-docx). Disabled by default.
3111+When converting from docx, read all docx styles as divs (for
3112+paragraph styles) and spans (for character styles) regardless
3113+of whether pandoc understands the meaning of these styles.
3114+This can be used with [docx custom styles](#custom-styles).
3115+Disabled by default.
20223116
20233117input formats
20243118: `docx`
@@ -2028,22 +3122,36 @@ input formats
20283122In the `muse` input format, this enables Text::Amuse
20293123extensions to Emacs Muse markup.
20303124
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+
20313133#### Extension: `citations` {#org-citations}
20323134
2033−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2034−in `org` input.
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
3137+
3138+#### Extension: `element_citations` ####
3139+
3140+In the `jats` output formats, this causes reference items to
3141+be replaced with `<element-citation>` elements. These
3142+elements are not influenced by CSL styles, but all information
3143+on the item is included in tags.
20353144
20363145#### Extension: `ntb` ####
20373146
20383147In the `context` output format this enables the use of [Natural Tables
2039−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2040−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
20413150Natural tables allow more fine-grained global customization but come
20423151at a performance penalty compared to extreme tables.
20433152
20443153
2045−Pandoc's Markdown
2046−=================
3154+# Pandoc's Markdown
20473155
20483156Pandoc understands an extended and slightly revised version of
20493157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2053,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
20533161behavior more granularly. They are described in the following. See also
20543162[Extensions] above, for extensions that work also on other formats.
20553163
2056−Philosophy
2057−----------
3164+## Philosophy
20583165
20593166Markdown is designed to be easy to write, and, even more importantly,
20603167easy to read:
@@ -2062,7 +3169,7 @@ easy to read:
20623169> A Markdown-formatted document should be publishable as-is, as plain
20633170> text, without looking like it's been marked up with tags or formatting
20643171> instructions.
2065−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
20663173
20673174This principle has guided pandoc's decisions in finding syntax for
20683175tables, footnotes, and other extensions.
@@ -2075,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
20753182important document elements like definition lists, tables, mathematics, and
20763183footnotes.
20773184
2078−Paragraphs
2079−----------
3185+## Paragraphs
20803186
20813187A paragraph is one or more lines of text followed by one or more blank lines.
20823188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2089,43 +3195,42 @@ Note: in multiline and grid table cells, this is the only way
20893195to create a hard line break, since trailing spaces in the cells
20903196are ignored.
20913197
2092−Headers
2093−-------
3198+## Headings
20943199
2095−There are two kinds of headers: Setext and ATX.
3200+There are two kinds of headings: Setext and ATX.
20963201
2097−### Setext-style headers ###
3202+### Setext-style headings ###
20983203
2099−A setext-style header is a line of text "underlined" with a row of `=` signs
2100−(for a level one header) or `-` signs (for a level two header):
3204+A setext-style heading is a line of text "underlined" with a row of `=` signs
3205+(for a level-one heading) or `-` signs (for a level-two heading):
21013206
2102− A level-one header
2103− ==================
3207+ A level-one heading
3208+ ===================
21043209
2105− A level-two header
2106− ------------------
3210+ A level-two heading
3211+ -------------------
21073212
2108−The header text can contain inline formatting, such as emphasis (see
3213+The heading text can contain inline formatting, such as emphasis (see
21093214[Inline formatting], below).
21103215
21113216
2112−### ATX-style headers ###
3217+### ATX-style headings ###
21133218
2114−An ATX-style header consists of one to six `#` signs and a line of
3219+An ATX-style heading consists of one to six `#` signs and a line of
21153220text, optionally followed by any number of `#` signs. The number of
2116−`#` signs at the beginning of the line is the header level:
3221+`#` signs at the beginning of the line is the heading level:
21173222
2118− ## A level-two header
3223+ ## A level-two heading
21193224
2120− ### A level-three header ###
3225+ ### A level-three heading ###
21213226
2122−As with setext-style headers, the header text can contain formatting:
3227+As with setext-style headings, the heading text can contain formatting:
21233228
2124− # A level-one header with a [link](/url) and *emphasis*
3229+ # A level-one heading with a [link](/url) and *emphasis*
21253230
21263231#### Extension: `blank_before_header` ####
21273232
2128−Standard Markdown syntax does not require a blank line before a header.
3233+Standard Markdown syntax does not require a blank line before a heading.
21293234Pandoc does require this (except, of course, at the beginning of the
21303235document). The reason for the requirement is that it is all too easy for a
21313236`#` to end up at the beginning of a line by accident (perhaps through line
@@ -2137,29 +3242,30 @@ wrapping). Consider, for example:
21373242#### Extension: `space_in_atx_header` ####
21383243
21393244Many Markdown implementations do not require a space between the
2140−opening `#`s of an ATX header and the header text, so that
2141−`#5 bolt` and `#hashtag` count as headers. With this extension,
3245+opening `#`s of an ATX heading and the heading text, so that
3246+`#5 bolt` and `#hashtag` count as headings. With this extension,
21423247pandoc does require the space.
21433248
2144−### Header identifiers ###
3249+### Heading identifiers ###
21453250
2146−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
21473253
21483254#### Extension: `header_attributes` ####
21493255
2150−Headers can be assigned attributes using this syntax at the end
2151−of the line containing the header text:
3256+Headings can be assigned attributes using this syntax at the end
3257+of the line containing the heading text:
21523258
21533259 {#identifier .class .class key=value key=value}
21543260
2155−Thus, for example, the following headers will all be assigned the identifier
3261+Thus, for example, the following headings will all be assigned the identifier
21563262`foo`:
21573263
2158− # My header {#foo}
3264+ # My heading {#foo}
21593265
2160− ## My header ## {#foo}
3266+ ## My heading ## {#foo}
21613267
2162− My other header {#foo}
3268+ My other heading {#foo}
21633269 ---------------
21643270
21653271(This syntax is compatible with [PHP Markdown Extra].)
@@ -2168,51 +3274,56 @@ Note that although this syntax allows assignment of classes and key/value
21683274attributes, writers generally don't use all of this information. Identifiers,
21693275classes, and key/value attributes are used in HTML and HTML-based formats such
21703276as EPUB and slidy. Identifiers are used for labels and link anchors in the
2171−LaTeX, ConTeXt, Textile, and AsciiDoc writers.
3277+LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
21723278
2173−Headers with the class `unnumbered` will not be numbered, even if
3279+Headings with the class `unnumbered` will not be numbered, even if
21743280`--number-sections` is specified. A single hyphen (`-`) in an attribute
21753281context is equivalent to `.unnumbered`, and preferable in non-English
21763282documents. So,
21773283
2178− # My header {-}
3284+ # My heading {-}
21793285
21803286is just the same as
21813287
2182− # My header {.unnumbered}
3288+ # My heading {.unnumbered}
3289+
3290+If the `unlisted` class is present in addition to `unnumbered`,
3291+the heading will not be included in a table of contents.
3292+(Currently this feature is only implemented for certain
3293+formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
21833294
21843295#### Extension: `implicit_header_references` ####
21853296
2186−Pandoc behaves as if reference links have been defined for each header.
2187−So, to link to a header
3297+Pandoc behaves as if reference links have been defined for each heading.
3298+So, to link to a heading
21883299
2189− # Header identifiers in HTML
3300+ # Heading identifiers in HTML
21903301
21913302you can simply write
21923303
2193− [Header identifiers in HTML]
3304+ [Heading identifiers in HTML]
21943305
21953306or
21963307
2197− [Header identifiers in HTML][]
3308+ [Heading identifiers in HTML][]
21983309
21993310or
22003311
2201− [the section on header identifiers][header identifiers in
3312+ [the section on heading identifiers][heading identifiers in
22023313 HTML]
22033314
22043315instead of giving the identifier explicitly:
22053316
2206− [Header identifiers in HTML](#header-identifiers-in-html)
3317+ [Heading identifiers in HTML](#heading-identifiers-in-html)
22073318
2208−If there are multiple headers with identical text, the corresponding
3319+If there are multiple headings with identical text, the corresponding
22093320reference will link to the first one only, and you will need to use explicit
22103321links to link to the others, as described above.
22113322
22123323Like regular reference links, these references are case-insensitive.
22133324
22143325Explicit link reference definitions always take priority over
2215−implicit header references. So, in the following example, the
3326+implicit heading references. So, in the following example, the
22163327link will point to `bar`, not to `#foo`:
22173328
22183329 # Foo
@@ -2221,12 +3332,11 @@ link will point to `bar`, not to `#foo`:
22213332
22223333 See [foo]
22233334
2224−Block quotations
2225−----------------
3335+## Block quotations
22263336
22273337Markdown uses email conventions for quoting blocks of text.
22283338A block quotation is one or more paragraphs or other block elements
2229−(such as lists or headers), with each line preceded by a `>` character
3339+(such as lists or headings), with each line preceded by a `>` character
22303340and an optional space. (The `>` need not start at the left margin, but
22313341it should not be indented more than three spaces.)
22323342
@@ -2261,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
22613371
22623372#### Extension: `blank_before_blockquote` ####
22633373
2264−Standard Markdown syntax does not require a blank line before a block
2265−quote. Pandoc does require this (except, of course, at the beginning of the
2266−document). The reason for the requirement is that it is all too easy for a
2267−`>` to end up at the beginning of a line by accident (perhaps through line
2268−wrapping). So, unless the `markdown_strict` format is used, the following does
3374+Standard Markdown syntax does not require a blank line before a
3375+block quote. Pandoc does require this (except, of course, at
3376+the beginning of the document). The reason for the requirement
3377+is that it is all too easy for a `>` to end up at the beginning
3378+of a line by accident (perhaps through line wrapping). So,
3379+unless the `markdown_strict` format is used, the following does
22693380not produce a nested block quote in pandoc:
22703381
22713382 > This is a block quote.
22723383 >> Nested.
22733384
22743385
2275−Verbatim (code) blocks
2276−----------------------
3386+## Verbatim (code) blocks
22773387
22783388### Indented code blocks ###
22793389
@@ -2335,14 +3445,16 @@ this syntax:
23353445 qsort (filter (>= x) xs)
23363446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23373447
2338−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2339−`startFrom` is an attribute with value `100`. Some output formats can use this
2340−information to do syntax highlighting. Currently, the only output formats
2341−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2342−highlighting is supported for your output format and language, then the code
2343−block above will appear highlighted, with numbered lines. (To see which
2344−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2345−the code block above will appear as follows:
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
3451+highlighting. Currently, the only output formats that uses this
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3453+highlighting is supported for your output format and language,
3454+then the code block above will appear highlighted, with numbered
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
3457+will appear as follows:
23463458
23473459 <pre id="mycode" class="haskell numberLines" startFrom="100">
23483460 <code>
@@ -2379,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
23793491For more information on highlighting, see [Syntax highlighting],
23803492below.
23813493
2382−Line blocks
2383−-----------
3494+## Line blocks
23843495
23853496#### Extension: `line_blocks` ####
23863497
@@ -2406,10 +3517,12 @@ line must begin with a space.
24063517 | 200 Main St.
24073518 | Berkeley, CA 94718
24083519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
24093523This syntax is borrowed from [reStructuredText].
24103524
2411−Lists
2412−-----
3525+## Lists
24133526
24143527### Bullet lists ###
24153528
@@ -2579,6 +3692,12 @@ If default list markers are desired, use `#.`:
25793692 #. two
25803693 #. three
25813694
3695+#### Extension: `task_lists` ####
3696+
3697+Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.
3698+
3699+ - [ ] an unchecked task list item
3700+ - [x] checked item
25823701
25833702### Definition lists ###
25843703
@@ -2604,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
26043723A definition begins with a colon or tilde, which may be indented one
26053724or two spaces.
26063725
2607−A term may have multiple definitions, and each definition may consist of one or
2608−more block elements (paragraph, code block, list, etc.), each indented four
2609−spaces or one tab stop. The body of the definition (including the first line,
2610−aside from the colon or tilde) should be indented four spaces. However,
2611−as with other Markdown lists, you can "lazily" omit indentation except
3726+A term may have multiple definitions, and each definition may
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
3729+body of the definition (including the first line, aside from the
3730+colon or tilde) should be indented four spaces. However, as with
3731+other Markdown lists, you can "lazily" omit indentation except
26123732at the beginning of a paragraph or other block element:
26133733
26143734 Term 1
@@ -2634,9 +3754,10 @@ definition:
26343754Note that space between items in a definition list is required.
26353755(A variant that loosens this requirement, but disallows "lazy"
26363756hard wrapping, can be activated with `compact_definition_lists`: see
2637−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
26383758
2639−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
26403761
26413762### Numbered example lists ###
26423763
@@ -2672,30 +3793,6 @@ list marker. That is, example lists always behave as if the
26723793labels tend to be long, and indenting content to the
26733794first non-space character after the label would be awkward.
26743795
2675−### Compact and loose lists ###
2676−
2677−Pandoc behaves differently from `Markdown.pl` on some "edge
2678−cases" involving lists. Consider this source:
2679−
2680− + First
2681− + Second:
2682− - Fee
2683− - Fie
2684− - Foe
2685−
2686− + Third
2687−
2688−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2689−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2690−"Second" and "Third" (but not "First"), because of the blank space
2691−around "Third". Pandoc follows a simple rule: if the text is followed by
2692−a blank line, it is treated as a paragraph. Since "Second" is followed
2693−by a list, and not a blank line, it isn't treated as a paragraph. The
2694−fact that the list is followed by a blank line is irrelevant. (Note:
2695−Pandoc works this way even when the `markdown_strict` format is specified. This
2696−behavior is consistent with the official Markdown syntax description,
2697−even though it is different from that of `Markdown.pl`.)
2698−
26993796
27003797### Ending a list ###
27013798
@@ -2734,8 +3831,7 @@ of one big list:
27343831 2. dos
27353832 3. tres
27363833
2737−Horizontal rules
2738−----------------
3834+## Horizontal rules
27393835
27403836A line containing a row of three or more `*`, `-`, or `_` characters
27413837(optionally separated by spaces) produces a horizontal rule:
@@ -2745,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
27453841 ---------------
27463842
27473843
2748−Tables
2749−------
3844+## Tables
27503845
27513846Four kinds of tables may be used. The first three kinds presuppose the use of
27523847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -2771,7 +3866,7 @@ Simple tables look like this:
27713866
27723867 Table: Demonstration of simple table syntax.
27733868
2774−The headers and table rows must each fit on one line. Column
3869+The header and table rows must each fit on one line. Column
27753870alignments are determined by the position of the header text relative
27763871to the dashed line below it:[^4]
27773872
@@ -2790,7 +3885,7 @@ to the dashed line below it:[^4]
27903885The table must end with a blank line, or a line of dashes followed by
27913886a blank line.
27923887
2793−The column headers may be omitted, provided a dashed line is used
3888+The column header row may be omitted, provided a dashed line is used
27943889to end the table. For example:
27953890
27963891 ------- ------ ---------- -------
@@ -2799,13 +3894,13 @@ to end the table. For example:
27993894 1 1 1 1
28003895 ------- ------ ---------- -------
28013896
2802−When headers are omitted, column alignments are determined on the basis
3897+When the header row is omitted, column alignments are determined on the basis
28033898of the first line of the table body. So, in the tables above, the columns
28043899would be right, left, center, and right aligned, respectively.
28053900
28063901#### Extension: `multiline_tables` ####
28073902
2808−Multiline tables allow headers and table rows to span multiple lines
3903+Multiline tables allow header and table rows to span multiple lines
28093904of text (but cells that span multiple columns or rows of the table are
28103905not supported). Here is an example:
28113906
@@ -2827,7 +3922,7 @@ not supported). Here is an example:
28273922These work like simple tables, but with the following differences:
28283923
28293924 - They must begin with a row of dashes, before the header text
2830− (unless the headers are omitted).
3925+ (unless the header row is omitted).
28313926 - They must end with a row of dashes, then a blank line.
28323927 - The rows must be separated by blank lines.
28333928
@@ -2836,7 +3931,7 @@ the columns, and the writers try to reproduce these relative widths in
28363931the output. So, if you find that one of the columns is too narrow in the
28373932output, try widening it in the Markdown source.
28383933
2839−Headers may be omitted in multiline tables as well as simple tables:
3934+The header may be omitted in multiline tables as well as simple tables:
28403935
28413936 ----------- ------- --------------- -------------------------
28423937 First row 12.0 Example of a row that
@@ -2847,7 +3942,7 @@ Headers may be omitted in multiline tables as well as simple tables:
28473942 rows.
28483943 ----------- ------- --------------- -------------------------
28493944
2850− : Here's a multiline table without headers.
3945+ : Here's a multiline table without a header.
28513946
28523947It is possible for a multiline table to have just one row, but the row
28533948should be followed by a blank line (and then the row of dashes that ends
@@ -2873,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
28733968omitted for a headerless table. The cells of grid tables may contain
28743969arbitrary block elements (multiple paragraphs, code blocks, lists,
28753970etc.). Cells that span multiple columns or rows are not
2876−supported. Grid tables can be created easily using [Emacs table mode].
2877−
2878−[Emacs table mode]: http://table.sourceforge.net/
3971+supported. Grid tables can be created easily using Emacs' table-mode
3972+(`M-x table-insert`).
28793973
28803974Alignments can be specified as with pipe tables, by putting
28813975colons at the boundaries of the separator line after the
@@ -2903,7 +3997,7 @@ and the same number of rows in each column. For example, the
29033997Docutils [sample grid tables] will not render as expected with
29043998Pandoc.
29053999
2906−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
29074001
29084002
29094003#### Extension: `pipe_tables` ####
@@ -2936,7 +4030,7 @@ legal (though ugly) pipe table:
29364030
29374031The cells of pipe tables cannot contain block elements like paragraphs
29384032and lists, and cannot span multiple lines. If a pipe table contains a
2939−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
29404034`--columns`), then the table will take up the full text width and
29414035the cell contents will wrap, with the relative cell widths determined
29424036by the number of dashes in the line separating the table header from
@@ -2960,8 +4054,7 @@ you'll need to add colons as above.
29604054
29614055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
29624056
2963−Metadata blocks
2964−---------------
4057+## Metadata blocks
29654058
29664059#### Extension: `pandoc_title_block` ####
29674060
@@ -2977,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
29774070or all three elements. If you want to include an author but no
29784071title, or a title and a date but no author, you need a blank line:
29794072
2980− %
2981− % Author
4073+```
4074+%
4075+% Author
4076+```
29824077
2983− % My title
2984− %
2985− % June 15, 2006
4078+```
4079+% My title
4080+%
4081+% June 15, 2006
4082+```
29864083
29874084The title may occupy multiple lines, but continuation lines must
29884085begin with leading space, thus:
29894086
2990− % My title
2991− on multiple lines
4087+```
4088+% My title
4089+ on multiple lines
4090+```
29924091
29934092If a document has multiple authors, the authors may be put on
29944093separate lines with leading space, or separated by semicolons, or
29954094both. So, all of the following are equivalent:
29964095
2997− % Author One
2998− Author Two
4096+```
4097+% Author One
4098+ Author Two
4099+```
29994100
3000− % Author One; Author Two
4101+```
4102+% Author One; Author Two
4103+```
30014104
3002− % Author One;
3003− Author Two
4105+```
4106+% Author One;
4107+ Author Two
4108+```
30044109
30054110The date must fit on one line.
30064111
@@ -3041,7 +4146,7 @@ will also have "Version 4.0" in the header.
30414146
30424147#### Extension: `yaml_metadata_block` ####
30434148
3044−A YAML metadata block is a valid YAML object, delimited by a line of three
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
30454150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
30464151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
30474152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3052,7 +4157,9 @@ and pass it to pandoc as an argument, along with your Markdown files:
30524157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
30534158
30544159Just be sure that the YAML file begins with `---` and ends with `---` or
3055−`...`.)
4160+`...`.) Alternatively, you can use the `--metadata-file` option. Using
4161+that approach however, you cannot reference content (like footnotes)
4162+from the main markdown input document.
30564163
30574164Metadata will be taken from the fields of the YAML object and added to any
30584165existing document metadata. Metadata can contain lists and objects (nested
@@ -3062,33 +4169,41 @@ given a role by external processors.) Field names must not be
30624169interpretable as YAML numbers or boolean values (so, for
30634170example, `yes`, `True`, and `15` cannot be used as field names).
30644171
3065−A document may contain multiple metadata blocks. The metadata fields will
3066−be combined through a *left-biased union*: if two metadata blocks attempt
3067−to set the same field, the value from the first block will be taken.
4172+A document may contain multiple metadata blocks. If two
4173+metadata blocks attempt to set the same field, the value from
4174+the second block will be taken.
30684175
30694176When pandoc is used with `-t markdown` to create a Markdown document,
30704177a YAML metadata block will be produced only if the `-s/--standalone`
30714178option is used. All of the metadata will appear in a single block
30724179at the beginning of the document.
30734180
3074−Note that YAML escaping rules must be followed. Thus, for example,
3075−if a title contains a colon, it must be quoted. The pipe character
3076−(`|`) can be used to begin an indented block that will be interpreted
3077−literally, without need for escaping. This form is necessary
3078−when the field contains blank lines or block-level formatting:
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
4182+if a title contains a colon, it must be quoted, and if it contains a
4183+backslash escape, then it must be ensured that it is not treated as a
4184+[YAML escape sequence]. The pipe character (`|`) can be used to begin
4185+an indented block that will be interpreted literally, without need for
4186+escaping. This form is necessary when the field contains blank lines
4187+or block-level formatting:
30794188
30804189 ---
30814190 title: 'This is the title: it contains a colon'
30824191 author:
30834192 - Author One
30844193 - Author Two
3085− tags: [nothing, nothingness]
4194+ keywords: [nothing, nothingness]
30864195 abstract: |
30874196 This is the abstract.
30884197
30894198 It consists of two paragraphs.
30904199 ...
30914200
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+
30924207Template variables will be set automatically from the metadata. Thus, for
30934208example, in writing HTML, the variable `abstract` will be set to the HTML
30944209equivalent of the Markdown in the `abstract` field:
@@ -3135,8 +4250,25 @@ will be interpreted as markdown. For example:
31354250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
31364251 ```
31374252
3138−Backslash escapes
3139−-----------------
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
31404272
31414273#### Extension: `all_symbols_escapable` ####
31424274
@@ -3162,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
31624294(However, if the `markdown_strict` format is used, the standard Markdown rule
31634295will be used.)
31644296
3165−A backslash-escaped space is parsed as a nonbreaking space. It will
3166−appear in TeX output as `~` and in HTML and XML as `\ ` or
3167−`\ `.
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).
31684303
31694304A backslash-escaped newline (i.e. a backslash occurring at the end of
31704305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3174,8 +4309,7 @@ two trailing spaces on a line.
31744309
31754310Backslash escapes do not work in verbatim contexts.
31764311
3177−Inline formatting
3178−-----------------
4312+## Inline formatting
31794313
31804314### Emphasis ###
31814315
@@ -3223,12 +4357,13 @@ text by `~` characters. Thus, for example,
32234357
32244358 H~2~O is a liquid. 2^10^ is 1024.
32254359
3226−If the superscripted or subscripted text contains spaces, these spaces
3227−must be escaped with backslashes. (This is to prevent accidental
3228−superscripting and subscripting through the ordinary use of `~` and `^`.)
3229−Thus, if you want the letter P with 'a cat' in subscripts, use
3230−`P~a\ cat~`, not `P~a cat~`.
3231−
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~`.
32324367
32334368### Verbatim ###
32344369
@@ -3277,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
32774412This will work in all output formats that support small caps.
32784413
32794414
3280−Math
3281−----
4415+## Math
32824416
32834417#### Extension: `tex_math_dollars` ####
32844418
@@ -3290,6 +4424,10 @@ left, and must not be followed immediately by a digit. Thus,
32904424you need to enclose text in literal `$` characters, backslash-escape
32914425them and they won't be treated as math delimiters.
32924426
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+
32934431TeX math will be printed in all output formats. How it is rendered
32944432depends on the output format:
32954433
@@ -3301,16 +4439,23 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki
33014439 ~ It will appear verbatim surrounded by `$...$` (for inline
33024440 math) or `$$...$$` (for display math).
33034441
4442+XWiki
4443+ ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4444+
33044445reStructuredText
33054446 ~ It will be rendered using an [interpreted text role `:math:`].
33064447
33074448AsciiDoc
3308− ~ It will be rendered as `latexmath:[...]`.
4449+ ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
4450+ surrounded by `latexmath:[$...$]` (for inline math) or
4451+ `[latexmath]++++\[...\]+++` (for display math).
4452+ For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters
4453+ (`$..$` and `\[..\]`) are omitted.
33094454
33104455Texinfo
33114456 ~ It will be rendered inside a `@math` command.
33124457
3313−groff man
4458+roff man, Jira markup
33144459 ~ It will be rendered verbatim without `$`'s.
33154460
33164461MediaWiki, DokuWiki
@@ -3344,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
33444489 command-line options selected. Therefore see [Math rendering in HTML]
33454490 above.
33464491
3347−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
33484493
3349−Raw HTML
3350−--------
4494+## Raw HTML
33514495
33524496#### Extension: `raw_html` ####
33534497
@@ -3358,8 +4502,17 @@ Markdown allows it, but it has been made an extension so that it can
33584502be disabled if desired.)
33594503
33604504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3361−DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
3362−in other formats.
4505+DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
4506+output, and suppressed in other formats.
4507+
4508+For a more explicit way of including raw HTML in a Markdown
4509+document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4510+
4511+In the CommonMark format, if `raw_html` is enabled, superscripts,
4512+subscripts, strikeouts and small capitals will be represented as HTML.
4513+Otherwise, plain-text fallbacks will be used. Note that even if
4514+`raw_html` is disabled, tables will be rendered with HTML syntax if
4515+they cannot use pipe syntax.
33634516
33644517#### Extension: `markdown_in_html_blocks` ####
33654518
@@ -3376,7 +4529,7 @@ Thus, for example, pandoc will turn
33764529 <table>
33774530 <tr>
33784531 <td>*one*</td>
3379− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
33804533 </tr>
33814534 </table>
33824535
@@ -3385,14 +4538,14 @@ into
33854538 <table>
33864539 <tr>
33874540 <td><em>one</em></td>
3388− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
33894542 </tr>
33904543 </table>
33914544
33924545whereas `Markdown.pl` will preserve it as is.
33934546
3394−There is one exception to this rule: text between `<script>` and
3395−`<style>` tags is not interpreted as Markdown.
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
33964549
33974550This departure from standard Markdown should make it easier to mix
33984551Markdown with HTML block elements. For example, one can surround
@@ -3434,6 +4587,10 @@ Note that in LaTeX environments, like
34344587the material between the begin and end tags will be interpreted as raw
34354588LaTeX, not as Markdown.
34364589
4590+For a more explicit and flexible way of including raw TeX in a
4591+Markdown document, see the [`raw_attribute`
4592+extension][Extension: `raw_attribute`].
4593+
34374594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
34384595Emacs Org mode, and ConTeXt.
34394596
@@ -3444,7 +4601,7 @@ Emacs Org mode, and ConTeXt.
34444601Inline spans and fenced code blocks with a special
34454602kind of attribute will be parsed as raw content with the
34464603designated format. For example, the following produces a raw
3447−groff `ms` block:
4604+roff `ms` block:
34484605
34494606 ```{=ms}
34504607 .MYMACRO
@@ -3480,12 +4637,11 @@ example, to use a raw attribute with a backtick code block,
34804637
34814638The raw attribute cannot be combined with regular attributes.
34824639
3483−LaTeX macros
3484−------------
4640+## LaTeX macros
34854641
34864642#### Extension: `latex_macros` ####
34874643
3488−For output formats other than LaTeX, pandoc will parse LaTeX
4644+When this extension is enabled, pandoc will parse LaTeX
34894645macro definitions and apply the resulting macros to all LaTeX
34904646math and raw LaTeX. So, for example, the following will work in
34914647all output formats, not just LaTeX:
@@ -3495,18 +4651,20 @@ all output formats, not just LaTeX:
34954651 $\tuple{a, b, c}$
34964652
34974653Note that LaTeX macros will not be applied if they occur
3498−inside inside a raw span or block marked with the
4654+inside a raw span or block marked with the
34994655[`raw_attribute` extension](#extension-raw_attribute).
35004656
35014657When `latex_macros` is disabled, the raw LaTeX and math will
35024658not have macros applied. This is usually a better approach when
35034659you are targeting LaTeX or PDF.
35044660
3505−Whether or not `latex_macros` is enabled, the macro definitions
3506−will still be passed through as raw LaTeX.
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
4665+enabled.
35074666
3508−Links
3509−-----
4667+## Links
35104668
35114669Markdown allows links to be specified in several ways.
35124670
@@ -3515,7 +4673,7 @@ Markdown allows links to be specified in several ways.
35154673If you enclose a URL or email address in pointy brackets, it
35164674will become a link:
35174675
3518− <http://google.com>
4676+ <https://google.com>
35194677 <sam@green.eggs.ham>
35204678
35214679### Inline links ###
@@ -3525,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
35254683be followed by a link title, in quotes.)
35264684
35274685 This is an [inline link](/url), and here's [one with
3528− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
35294687
35304688There can be no space between the bracketed part and the parenthesized part.
35314689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3554,7 +4712,7 @@ Here are some examples:
35544712
35554713 [my label 1]: /foo/bar.html "My title, optional"
35564714 [my label 2]: /foo
3557− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
35584716 [my label 4]: /bar#special 'A title in single quotes'
35594717
35604718The URL may optionally be surrounded by angle brackets:
@@ -3563,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
35634721
35644722The title may go on the next line:
35654723
3566− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
35674725 "The free software foundation"
35684726
35694727Note that link labels are not case sensitive. So, this will work:
@@ -3601,7 +4759,7 @@ be omitted entirely:
36014759### Internal links ###
36024760
36034761To link to another section of the same document, use the automatically
3604−generated identifier (see [Header identifiers]). For example:
4762+generated identifier (see [Heading identifiers]). For example:
36054763
36064764 See the [Introduction](#introduction).
36074765
@@ -3614,8 +4772,7 @@ or
36144772Internal links are currently supported for HTML formats (including
36154773HTML slide shows and EPUB), LaTeX, and ConTeXt.
36164774
3617−Images
3618−------
4775+## Images
36194776
36204777A link immediately preceded by a `!` will be treated as an image.
36214778The link text will be used as the image's alt text:
@@ -3661,10 +4818,11 @@ Attributes can be set on links and images:
36614818(This syntax is compatible with [PHP Markdown Extra] when only `#id`
36624819and `.class` are used.)
36634820
3664−For HTML and EPUB, all attributes except `width` and `height` (but
3665−including `srcset` and `sizes`) are passed through as is. The other
3666−writers ignore attributes that are not supported by their output
3667−format.
4821+For HTML and EPUB, all known HTML5 attributes except `width` and
4822+`height` (but including `srcset` and `sizes`) are passed through
4823+as is. Unknown attributes are passed through as custom
4824+attributes, with `data-` prepended. The other writers ignore
4825+attributes that are not specifically supported by their output format.
36684826
36694827The `width` and `height` attributes on images are treated specially. When
36704828used without a unit, the unit is assumed to be pixels. However, any of
@@ -3676,24 +4834,27 @@ For example:
36764834{ width=50% }
36774835```
36784836
3679−- Dimensions are converted to inches for output in page-based formats like
3680− LaTeX. Dimensions are converted to pixels for output in HTML-like
3681− formats. Use the `--dpi` option to specify the number of pixels per
3682− inch. The default is 96dpi.
4837+- Dimensions may be converted to a form that is compatible with
4838+ the output format (for example, dimensions given in pixels will
4839+ be converted to inches when converting HTML to LaTeX). Conversion
4840+ between pixels and physical measurements is affected by the
4841+ `--dpi` option (by default, 96 dpi is assumed, unless the image
4842+ itself contains dpi information).
36834843- The `%` unit is generally relative to some available space.
3684− For example the above example will render to
3685− `<img href="file.jpg" style="width: 50%;" />` (HTML),
3686− `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3687− `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
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]`
36884850- Some output formats have a notion of a class
3689− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
36904852 or a unique identifier (LaTeX `\caption`), or both (HTML).
36914853- When no `width` or `height` attributes are specified, the fallback
36924854 is to look at the image resolution and the dpi metadata embedded in
36934855 the image file.
36944856
3695−Divs and Spans
3696−--------------
4857+## Divs and Spans
36974858
36984859Using the `native_divs` and `native_spans` extensions
36994860(see [above][Extension: `native_divs`]), HTML syntax can
@@ -3749,8 +4910,7 @@ followed immediately by attributes:
37494910
37504911 [This is *some text*]{.class key="val"}
37514912
3752−Footnotes
3753−---------
4913+## Footnotes
37544914
37554915#### Extension: `footnotes` ####
37564916
@@ -3796,45 +4956,401 @@ they cannot contain multiple paragraphs). The syntax is as follows:
37964956
37974957Inline and regular footnotes may be mixed freely.
37984958
3799−Citations
3800−---------
4959+## Citation syntax
38014960
38024961#### Extension: `citations` ####
38034962
3804−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
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` ####
5181+
5182+Parses textual emojis like `:smile:` as Unicode emoticons.
5183+
5184+#### Extension: `tex_math_single_backslash` ####
5185+
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 `[`.
5190+
5191+#### Extension: `tex_math_double_backslash` ####
5192+
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.
5196+
5197+#### Extension: `markdown_attribute` ####
5198+
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`.
5202+
5203+#### Extension: `mmd_title_block` ####
5204+
5205+Enables a [MultiMarkdown] style title block at the top of
5206+the document, for example:
5207+
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.
5213+
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`.
5217+
5218+#### Extension: `abbreviations` ####
5219+
5220+Parses PHP Markdown Extra abbreviation keys, like
5221+
5222+ *[HTML]: Hypertext Markup Language
5223+
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).
5227+
5228+#### Extension: `autolink_bare_uris` ####
5229+
5230+Makes all absolute URIs into links, even when not surrounded by
5231+pointy braces `<...>`.
5232+
5233+#### Extension: `mmd_link_attributes` ####
5234+
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.
5238+
5239+ This is a reference ![image][ref] with multimarkdown attributes.
5240+
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5242+ id=myId class="myClass1 myClass2"
5243+
5244+#### Extension: `mmd_header_identifiers` ####
5245+
5246+Parses multimarkdown style heading identifiers (in square brackets,
5247+after the heading but before any trailing `#`s in an ATX heading).
5248+
5249+#### Extension: `compact_definition_lists` ####
5250+
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:
5254+
5255+ - No blank line is required between consecutive items of the
5256+ definition list.
5257+ - To get a "tight" or "compact" list, omit space between consecutive
5258+ items; the space between a term and its definition does not affect
5259+ anything.
5260+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
5261+ be indented four spaces.[^6]
5262+
5263+[^6]: To see why laziness is incompatible with relaxing the requirement
5264+ of a blank line between items, consider the following example:
5265+
5266+ bar
5267+ : definition
5268+ foo
5269+ : definition
5270+
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.
5275+
5276+#### Extension: `gutenberg` ####
5277+
5278+Use [Project Gutenberg] conventions for `plain` output:
5279+all-caps for strong emphasis, surround by underscores
5280+for regular emphasis, add extra blank space around headings.
5281+
5282+ [Project Gutenberg]: https://www.gutenberg.org
5283+
5284+#### Extension: `sourcepos` ####
5285+
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
5290+
5291+## Markdown variants
5292+
5293+In addition to pandoc's extended Markdown, the following Markdown
5294+variants are supported:
5295+
5296+- `markdown_phpextra` (PHP Markdown Extra)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298+- `markdown_mmd` (MultiMarkdown)
5299+- `markdown_strict` (Markdown.pl)
5300+- `commonmark` (CommonMark)
5301+- `gfm` (Github-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
5303+
5304+To see which extensions are supported for a given format,
5305+and which are enabled by default, you can use the command
5306+
5307+ pandoc --list-extensions=FORMAT
5308+
5309+where `FORMAT` is replaced with the name of the format.
5310+
5311+Note that the list of extensions for `commonmark`,
5312+`gfm`, and `commonmark_x` are defined relative to default
5313+commonmark. So, for example, `backtick_code_blocks`
5314+does not appear as an extension, since it is enabled by
5315+default and cannot be disabled.
5316+
5317+# Citations
5318+
5319+When the `--citeproc` option is used, pandoc can automatically generate
38055320citations and a bibliography in a number of styles. Basic usage is
38065321
3807− pandoc --filter pandoc-citeproc myinput.txt
5322+ pandoc --citeproc myinput.txt
5323+
5324+To use this feature, you will need to have
38085325
3809−In order to use this feature, you will need to specify a bibliography file
3810−using the `bibliography` metadata field in a YAML metadata section, or
3811−`--bibliography` command line argument. You can supply multiple `--bibliography`
3812−arguments or set `bibliography` metadata field to YAML array, if you want to
3813−use multiple bibliography files. The bibliography may have any of these
3814−formats:
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
5330+
5331+## Specifying bibliographic data
5332+
5333+You can specify an external bibliography using the
5334+`bibliography` metadata field in a YAML metadata section or the
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
5337+`--bibliography` arguments or set `bibliography` metadata field
5338+to YAML array. A bibliography may have any of these formats:
38155339
38165340 Format File extension
38175341 ------------ --------------
38185342 BibLaTeX .bib
38195343 BibTeX .bibtex
3820− Copac .copac
38215344 CSL JSON .json
38225345 CSL YAML .yaml
3823− EndNote .enl
3824− EndNote XML .xml
3825− ISI .wos
3826− MEDLINE .medline
3827− MODS .mods
3828− RIS .ris
38295346
38305347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3831−use `.bibtex` to force BibTeX.
5348+use the extension `.bibtex` to force interpretation as BibTeX.
38325349
3833−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3834−can produce `.json` and `.yaml` files from any of the supported formats.
3835−
3836−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3837−a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
5350+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351+inside fields such as `title`; in CSL YAML databases, pandoc
5352+Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5353+markup specs]:
38385354
38395355`<i>...</i>`
38405356: italics
@@ -3854,14 +5370,11 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
38545370`<span class="nocase">...</span>`
38555371: prevent a phrase from being capitalized as title case
38565372
3857−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3858−and CSL YAML formats as far as possible.
3859−
3860−As an alternative to specifying a bibliography file using `--bibliography`
3861−or the YAML metadata field `bibliography`, you can include
3862−the citation data directly in the `references` field of the
3863−document's YAML metadata. The field should contain an array of
3864−YAML-encoded references, for example:
5373+As an alternative to specifying a bibliography file using
5374+`--bibliography` or the YAML metadata field `bibliography`, you
5375+can include the citation data directly in the `references` field
5376+of the document's YAML metadata. The field should contain an
5377+array of YAML-encoded references, for example:
38655378
38665379 ---
38675380 references:
@@ -3877,322 +5390,273 @@ YAML-encoded references, for example:
38775390 - - 1953
38785391 - 4
38795392 - 25
3880− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3881− nucleic acid'
5393+ title: 'Molecular structure of nucleic acids: a structure for
5394+ deoxyribose nucleic acid'
38825395 title-short: Molecular structure of nucleic acids
38835396 container-title: Nature
38845397 volume: 171
38855398 issue: 4356
38865399 page: 737-738
38875400 DOI: 10.1038/171737a0
3888− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5401+ URL: https://www.nature.com/articles/171737a0
38895402 language: en-GB
38905403 ...
38915404
3892−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3893−of the supported formats.)
3894−
3895−Citations and references can be formatted using any style supported by the
3896−[Citation Style Language], listed in the [Zotero Style Repository].
3897−These files are specified using the `--csl` option or the `csl` metadata field.
3898−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3899−format. The CSL project provides further information on [finding and editing styles].
3900−
3901−To make your citations hyperlinks to the corresponding bibliography
3902−entries, add `link-citations: true` to your YAML metadata.
3903−
3904−Citations go inside square brackets and are separated by semicolons.
3905−Each citation must have a key, composed of '@' + the citation
3906−identifier from the database, and may optionally have a prefix,
3907−a locator, and a suffix. The citation key must begin with a letter, digit,
3908−or `_`, and may contain alphanumerics, `_`, and internal punctuation
3909−characters (`:.#$%&-+?<>~/`). Here are some examples:
3910−
3911− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3912−
3913− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3914−
3915− Blah blah [@smith04; @doe99].
3916−
3917−`pandoc-citeproc` detects locator terms in the [CSL locale files].
3918−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3919−locale, locator terms can be written in either singular or plural forms,
3920−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3921−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3922−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3923−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3924−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3925−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3926−locator term is used, "page" is assumed.
3927−
3928−A minus sign (`-`) before the `@` will suppress mention of
3929−the author in the citation. This can be useful when the
3930−author is already mentioned in the text:
3931−
3932− Smith says blah [-@smith04].
3933−
3934−You can also write an in-text citation, as follows:
3935−
3936− @smith04 says blah.
3937−
3938− @smith04 [p. 33] says blah.
3939−
3940−If the style calls for a list of works cited, it will be placed
3941−at the end of the document. Normally, you will want to end your
3942−document with an appropriate header:
3943−
3944− last paragraph...
3945−
3946− # References
3947−
3948−The bibliography will be inserted after this header. Note that
3949−the `unnumbered` class will be added to this header, so that the
3950−section will not be numbered.
3951−
3952−If you want to include items in the bibliography without actually
3953−citing them in the body text, you can define a dummy `nocite` metadata
3954−field and put the citations there:
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.
39555408
3956− ---
3957− nocite: |
3958− @item1, @item2
3959− ...
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
39605411
3961− @item3
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
39625414
3963−In this example, the document will contain a citation for `item3`
3964−only, but the bibliography will contain entries for `item1`, `item2`, and
3965−`item3`.
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
39665417
3967−It is possible to create a bibliography with all the citations,
3968−whether or not they appear in the document, by using a wildcard:
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
39695420
3970− ---
3971− nocite: |
3972− @*
3973− ...
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5423+of your choice:
39745424
3975−For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3976−to render bibliography. In order to do so, specify bibliography files as
3977−outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3978−invocation. Bear in mind that bibliography files have to be in respective
3979−format (either BibTeX or BibLaTeX).
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
39805427
3981−For more information, see the [pandoc-citeproc man page].
5428+### Capitalization in titles
39825429
3983−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
3984−[Chicago Manual of Style]: http://chicagomanualofstyle.org
3985−[Citation Style Language]: http://citationstyles.org
3986−[Zotero Style Repository]: https://www.zotero.org/styles
3987−[finding and editing styles]: https://citationstyles.org/authors/
3988−[CSL locale files]: https://github.com/citation-style-language/locales
3989−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
39905432
3991−Non-pandoc extensions
3992−---------------------
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`.)
39935438
3994−The following Markdown syntax extensions are not enabled by default
3995−in pandoc, but may be enabled by adding `+EXTENSION` to the format
3996−name, where `EXTENSION` is the name of the extension. Thus, for
3997−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
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:
39985442
3999−#### Extension: `old_dashes` ####
5443+ title = {My Dinner with {Andre}}
40005444
4001−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4002−`-` before a numeral is an en-dash, and `--` is an em-dash.
4003−This option only has an effect if `smart` is enabled. It is
4004−selected automatically for `textile` input.
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
40055447
4006−#### Extension: `angle_brackets_escapable` ####
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
40075449
4008−Allow `<` and `>` to be backslash-escaped, as they can be in
4009−GitHub flavored Markdown but not original Markdown. This is
4010−implied by pandoc's default `all_symbols_escapable`.
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.
40115454
4012−#### Extension: `lists_without_preceding_blankline` ####
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
40135457
4014−Allow a list to occur right after a paragraph, with no intervening
4015−blank space.
5458+ - All titles should be in sentence case.
40165459
4017−#### Extension: `four_space_rule` ####
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.)
40185463
4019−Selects the pandoc <= 2.0 behavior for parsing lists, so that
4020−four spaces indent are needed for list item continuation
4021−paragraphs.
5464+ - Protect words that should not be converted to title case using
5465+ this syntax:
40225466
4023−#### Extension: `spaced_reference_links` ####
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
40245468
4025−Allow whitespace between the two components of a reference link,
4026−for example,
5469+### Conference Papers, Published vs. Unpublished
40275470
4028− [foo] [bar].
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
40295473
4030−#### Extension: `hard_line_breaks` ####
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`).
40315477
4032−Causes all newlines within a paragraph to be interpreted as hard line
4033−breaks instead of spaces.
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.
40345487
4035−#### Extension: `ignore_line_breaks` ####
40365488
4037−Causes newlines within a paragraph to be ignored, rather than being
4038−treated as spaces or as hard line breaks. This option is intended for
4039−use with East Asian languages where spaces are not used between words,
4040−but text is divided into lines for readability.
5489+## Specifying a citation style
40415490
4042−#### Extension: `east_asian_line_breaks` ####
5491+Citations and references can be formatted using any style supported by the
5492+[Citation Style Language], listed in the [Zotero Style Repository].
5493+These files are specified using the `--csl` option or the `csl`
5494+(or `citation-style`) metadata field. By default, pandoc will
5495+use the [Chicago Manual of Style] author-date format. (You can
5496+override this default by copying a CSL style of your choice
5497+to `default.csl` in your user data directory.)
5498+The CSL project provides further information on [finding and
5499+editing styles].
5500+
5501+The `--citation-abbreviations` option (or the
5502+`citation-abbreviations` metadata field) may be used to specify
5503+a JSON file containing abbreviations of journals that should be
5504+used in formatted bibliographies when `form="short"` is
5505+specified. The format of the file can be illustrated with an
5506+example:
40435507
4044−Causes newlines within a paragraph to be ignored, rather than
4045−being treated as spaces or as hard line breaks, when they occur
4046−between two East Asian wide characters. This is a better choice
4047−than `ignore_line_breaks` for texts that include a mix of East
4048−Asian wide characters and other characters.
40495508
4050−#### Extension: `emoji` ####
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+ }
40515517
4052−Parses textual emojis like `:smile:` as Unicode emoticons.
40535518
4054−#### Extension: `tex_math_single_backslash` ####
5519+## Citations in note styles
40555520
4056−Causes anything between `\(` and `\)` to be interpreted as inline
4057−TeX math, and anything between `\[` and `\]` to be interpreted
4058−as display TeX math. Note: a drawback of this extension is that
4059−it precludes escaping `(` and `[`.
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,
40605527
4061−#### Extension: `tex_math_double_backslash` ####
5528+ Blah blah [@foo, p. 33].
40625529
4063−Causes anything between `\\(` and `\\)` to be interpreted as inline
4064−TeX math, and anything between `\\[` and `\\]` to be interpreted
4065−as display TeX math.
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].
40665535
4067−#### Extension: `markdown_attribute` ####
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:
40685541
4069−By default, pandoc interprets material inside block-level tags as Markdown.
4070−This extension changes the behavior so that Markdown is only parsed
4071−inside block-level tags if the tags have the attribute `markdown=1`.
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].
40725545
4073−#### Extension: `mmd_title_block` ####
5546+## Raw content in a style
40745547
4075−Enables a [MultiMarkdown] style title block at the top of
4076−the document, for example:
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
40775550
4078− Title: My title
4079− Author: John Doe
4080− Date: September 1, 2008
4081− Comment: This is a sample mmd title block, with
4082− a field spanning multiple lines.
5551+ {{jats}}<ref>{{/jats}}
40835552
4084−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4085−`yaml_metadata_block` is enabled, it will take precedence over
4086−`mmd_title_block`.
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
40875555
4088−#### Extension: `abbreviations` ####
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.
40895560
4090−Parses PHP Markdown Extra abbreviation keys, like
40915561
4092− *[HTML]: Hypertext Markup Language
40935562
4094−Note that the pandoc document model does not support
4095−abbreviations, so if this extension is enabled, abbreviation keys are
4096−simply skipped (as opposed to being parsed as paragraphs).
5563+## Placement of the bibliography
40975564
4098−#### Extension: `autolink_bare_uris` ####
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:
40995567
4100−Makes all absolute URIs into links, even when not surrounded by
4101−pointy braces `<...>`.
5568+ ::: {#refs}
5569+ :::
41025570
4103−#### Extension: `mmd_link_attributes` ####
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.
41045574
4105−Parses multimarkdown style key-value attributes on link
4106−and image references. This extension should not be confused with the
4107−[`link_attributes`](#extension-link_attributes) extension.
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:
41085579
4109− This is a reference ![image][ref] with multimarkdown attributes.
5580+ last paragraph...
41105581
4111− [ref]: http://path.to/image "Image title" width=20px height=30px
4112− id=myId class="myClass1 myClass2"
5582+ # References
41135583
4114−#### Extension: `mmd_header_identifiers` ####
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.
41155587
4116−Parses multimarkdown style header identifiers (in square brackets,
4117−after the header but before any trailing `#`s in an ATX header).
5588+## Including uncited items in the bibliography
41185589
4119−#### Extension: `compact_definition_lists` ####
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:
41205593
4121−Activates the definition list syntax of pandoc 1.12.x and earlier.
4122−This syntax differs from the one described above under [Definition lists]
4123−in several respects:
5594+ ---
5595+ nocite: |
5596+ @item1, @item2
5597+ ...
41245598
4125− - No blank line is required between consecutive items of the
4126− definition list.
4127− - To get a "tight" or "compact" list, omit space between consecutive
4128− items; the space between a term and its definition does not affect
4129− anything.
4130− - Lazy wrapping of paragraphs is not allowed: the entire definition must
4131− be indented four spaces.[^6]
5599+ @item3
41325600
4133−[^6]: To see why laziness is incompatible with relaxing the requirement
4134− of a blank line between items, consider the following example:
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`.
41355604
4136− bar
4137− : definition
4138− foo
4139− : definition
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:
41405607
4141− Is this a single list item with two definitions of "bar," the first of
4142− which is lazily wrapped, or two list items? To remove the ambiguity
4143− we must either disallow lazy wrapping or require a blank line between
4144− list items.
5608+ ---
5609+ nocite: |
5610+ @*
5611+ ...
41455612
4146−Markdown variants
4147−-----------------
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.
41485619
4149−In addition to pandoc's extended Markdown, the following Markdown
4150−variants are supported:
5620+## Other relevant metadata fields
5621+
5622+A few other metadata fields affect bibliography formatting:
5623+
5624+`link-citations`
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
41515628
4152−`markdown_phpextra` (PHP Markdown Extra)
4153−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4154− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4155− `header_attributes`, `link_attributes`, `abbreviations`,
4156− `shortcut_reference_links`, `spaced_reference_links`.
4157−
4158−`markdown_github` (deprecated GitHub-Flavored Markdown)
4159−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4160− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4161− `space_in_atx_header`, `intraword_underscores`, `strikeout`,
4162− `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
4163− `lists_without_preceding_blankline`.
4164−
4165−`markdown_mmd` (MultiMarkdown)
4166−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4167− `tex_math_double_backslash`, `intraword_underscores`,
4168− `mmd_title_block`, `footnotes`, `definition_lists`,
4169− `all_symbols_escapable`, `implicit_header_references`,
4170− `auto_identifiers`, `mmd_header_identifiers`,
4171− `shortcut_reference_links`, `implicit_figures`,
4172− `superscript`, `subscript`, `backtick_code_blocks`,
4173− `spaced_reference_links`, `raw_attribute`.
4174−
4175−`markdown_strict` (Markdown.pl)
4176−: `raw_html`, `shortcut_reference_links`,
4177− `spaced_reference_links`.
4178−
4179−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4180−which is implemented as a set of extensions on `commonmark`).
4181−
4182−Note, however, that `commonmark` and `gfm` have limited support
4183−for extensions. Only those listed below (and `smart` and
4184−`raw_tex`) will work. The extensions can, however, all be
4185−individually disabled.
4186−Also, `raw_tex` only affects `gfm` output, not input.
4187−
4188−`gfm` (GitHub-Flavored Markdown)
4189−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4190− `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4191− `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4192− `shortcut_reference_links`, `angle_brackets_escapable`.
4193−
4194−Producing slide shows with pandoc
4195−=================================
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
41965660
41975661You can use pandoc to produce an HTML + JavaScript slide presentation
41985662that can be viewed via a web browser. There are five ways to do this,
@@ -4240,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
42405704
42415705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
42425706
4243−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4244−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4245−assumed to be available at the relative path `s5/default` (for S5), `slideous`
4246−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4247−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4248−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4249−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4250−the file by default.
4251−
4252−With all HTML slide formats, the `--self-contained` option can be used to
4253−produce a single file that contains all of the data necessary to display the
4254−slide show, including linked scripts, stylesheets, images, and videos.
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5710+the relative path `s5/default` (for S5), `slideous` (for
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5714+variables; see [Variables for HTML slides], above.) For
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5716+in the file by default.
5717+
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
42555722
42565723To produce a PDF slide show using beamer, type
42575724
@@ -4264,14 +5731,13 @@ To produce a Powerpoint slide show, type
42645731
42655732 pandoc habits.txt -o habits.pptx
42665733
4267−Structuring the slide show
4268−--------------------------
5734+## Structuring the slide show
42695735
4270−By default, the *slide level* is the highest header level in
5736+By default, the *slide level* is the highest heading level in
42715737the hierarchy that is followed immediately by content, and not another
4272−header, somewhere in the document. In the example above, level 1 headers
4273−are always followed by level 2 headers, which are followed by content,
4274−so 2 is the slide level. This default can be overridden using
5738+heading, somewhere in the document. In the example above, level-1 headings
5739+are always followed by level-2 headings, which are followed by content,
5740+so the slide level is 2. This default can be overridden using
42755741the `--slide-level` option.
42765742
42775743The document is carved up into slides according to the following
@@ -4279,17 +5745,21 @@ rules:
42795745
42805746 * A horizontal rule always starts a new slide.
42815747
4282− * A header at the slide level always starts a new slide.
5748+ * A heading at the slide level always starts a new slide.
42835749
4284− * Headers *below* the slide level in the hierarchy create
4285− headers *within* a slide.
5750+ * Headings *below* the slide level in the hierarchy create
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
42865756
4287− * Headers *above* the slide level in the hierarchy create
5757+ * Headings *above* the slide level in the hierarchy create
42885758 "title slides," which just contain the section title
42895759 and help to break the slide show into sections.
4290−
4291− * Content *above* the slide level will not appear in the slide
4292− show.
5760+ Non-slide content under these headings will be included
5761+ on the title slide (for HTML slide shows) or in a
5762+ subsequent slide with the same title (for beamer).
42935763
42945764 * A title page is constructed automatically from the document's title
42955765 block, if present. (In the case of beamer, this can be disabled
@@ -4297,17 +5767,16 @@ rules:
42975767
42985768These rules are designed to support many different styles of slide show. If
42995769you don't care about structuring your slides into sections and subsections,
4300−you can just use level 1 headers for all each slide. (In that case, level 1
5770+you can just use level-1 headings for all each slide. (In that case, level-1
43015771will be the slide level.) But you can also structure the slide show into
43025772sections, as in the example above.
43035773
43045774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
4305−layout will be produced, with level 1 headers building horizontally
4306−and level 2 headers building vertically. It is not recommended that
5775+layout will be produced, with level-1 headings building horizontally
5776+and level-2 headings building vertically. It is not recommended that
43075777you use deeper nesting of section levels with reveal.js.
43085778
4309−Incremental lists
4310−-----------------
5779+## Incremental lists
43115780
43125781By default, these writers produce lists that display "all at once."
43135782If you want your lists to display incrementally (one item at a time),
@@ -4345,8 +5814,10 @@ option):
43455814Both methods allow incremental and nonincremental lists to be mixed
43465815in a single document.
43475816
4348−Inserting pauses
4349−----------------
5817+Note: Neither the `-i/--incremental` option nor any of the
5818+methods described here currently works for PowerPoint output.
5819+
5820+## Inserting pauses
43505821
43515822You can add "pauses" within a slide by including a paragraph containing
43525823three dots, separated by spaces:
@@ -4359,8 +5830,9 @@ three dots, separated by spaces:
43595830
43605831 content after the pause
43615832
4362−Styling the slides
4363−------------------
5833+Note: this feature is not yet implemented for PowerPoint output.
5834+
5835+## Styling the slides
43645836
43655837You can change the style of HTML slides by putting customized CSS files
43665838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4385,9 +5857,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
43855857
43865858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
43875859
4388−Note that header attributes will turn into slide attributes
5860+Note that heading attributes will turn into slide attributes
43895861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
4390−to style individual slides. In beamer, the only header attribute
5862+to style individual slides. In beamer, the only heading attribute
43915863that affects slides is the `allowframebreaks` class, which sets the
43925864`allowframebreaks` option, causing multiple slides to be created
43935865if the content overfills the frame. This is recommended especially for
@@ -4395,8 +5867,7 @@ bibliographies:
43955867
43965868 # References {.allowframebreaks}
43975869
4398−Speaker notes
4399−-------------
5870+## Speaker notes
44005871
44015872Speaker notes are supported in reveal.js and PowerPoint (pptx)
44025873output. You can add notes to your Markdown document thus:
@@ -4417,8 +5888,7 @@ in handouts and presenter view.
44175888Notes are not yet supported for other slide formats, but the notes
44185889will not appear on the slides themselves.
44195890
4420−Columns
4421−-------
5891+## Columns
44225892
44235893To put material in side by side columns, you can use a native
44245894div container with class `columns`, containing two or more div
@@ -4433,12 +5903,46 @@ containers with class `column` and a `width` attribute:
44335903 :::
44345904 ::::::::::::::
44355905
4436−Frame attributes in beamer
4437−--------------------------
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
44385942
44395943Sometimes it is necessary to add the LaTeX `[fragile]` option to
44405944a frame in beamer (for example, when using the `minted` environment).
4441−This can be forced by adding the `fragile` class to the header
5945+This can be forced by adding the `fragile` class to the heading
44425946introducing the slide:
44435947
44445948 # Fragile slide {.fragile}
@@ -4448,39 +5952,48 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
44485952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
44495953`shrink`, `standout`, `noframenumbering`.
44505954
4451−Background in reveal.js
4452−-----------------------
5955+## Background in reveal.js and beamer
5956+
5957+Background images can be added to self-contained reveal.js slideshows and
5958+to beamer slideshows.
44535959
4454−Background images can be added to self-contained reveal.js slideshows.
5960+For the same image on every slide, use the configuration
5961+option `background-image` either in the YAML metadata block
5962+or as a command-line variable. (There are no other options in
5963+beamer and the rest of this section concerns reveal.js slideshows.)
44555964
4456−For the same image on every slide, use the reveal.js configuration
4457−option `parallaxBackgroundImage` either in the YAML metadata block
4458−or as a command-line variable. You can also set
4459−`parallaxBackgroundHorizontal` and `parallaxBackgroundVertical` the same
4460−way and must also set `parallaxBackgroundSize` to have your values
4461−take effect.
5965+For reveal.js, you can instead use the reveal.js-native option
5966+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5967+and `parallaxBackgroundVertical` the same way and must also set
5968+`parallaxBackgroundSize` to have your values take effect.
44625969
4463−To set an image for a particular slide, add
5970+To set an image for a particular reveal.js slide, add
44645971`{data-background-image="/path/to/image"}`
4465−to the first slide-level header on the slide (which may even be empty).
5972+to the first slide-level heading on the slide (which may even be empty).
44665973
44675974In reveal.js's overview mode, the parallaxBackgroundImage will show up
44685975only on the first slide.
44695976
4470−Other background settings also work on individual slides, including
5977+Other reveal.js background settings also work on individual slides, including
44715978`data-background-size`, `data-background-repeat`, `data-background-color`,
44725979`data-transition`, and `data-transition-speed`.
44735980
4474−See the [reveal.js
4475−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4476−for more details.
5981+To add a background image to the automatically generated title slide, use the
5982+`title-slide-attributes` variable in the YAML metadata block. It must contain
5983+a map of attribute names and values.
44775984
4478−For example:
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986+details.
5987+
5988+For example in reveal.js:
44795989
44805990```
44815991---
44825992title: My Slideshow
44835993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
44845997---
44855998
44865999## Slide One
@@ -4489,14 +6002,12 @@ Slide 1 has background_image.png as its background.
44896002
44906003## {data-background-image="/path/to/special_image.jpg"}
44916004
4492−Slide 2 has a special image for its background, even though the header has no content.
6005+Slide 2 has a special image for its background, even though the heading has no content.
44936006```
44946007
4495−Creating EPUBs with pandoc
4496−==========================
6008+# EPUBs
44976009
4498−EPUB Metadata
4499−-------------
6010+## EPUB Metadata
45006011
45016012EPUB metadata may be specified using the `--epub-metadata` option, but
45026013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4574,11 +6085,20 @@ The following fields are recognized:
45746085
45756086`rights`
45766087 ~ 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.
45776097
45786098`cover-image`
45796099 ~ A string value (path to cover image).
45806100
4581−`stylesheet`
6101+`css` (or legacy: `stylesheet`)
45826102 ~ A string value (path to CSS stylesheet).
45836103
45846104`page-progression-direction`
@@ -4595,11 +6115,54 @@ The following fields are recognized:
45956115 - `binding`: `true`|`false` (default `true`)
45966116 - `scroll-axis`: `vertical`|`horizontal`|`default`
45976117
4598−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
45996119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
46006120
4601−Linked media
4602−------------
6121+## The `epub:type` attribute
6122+
6123+For `epub3` output, you can mark up the heading that corresponds to an EPUB
6124+chapter using the [`epub:type` attribute][epub-type]. For example, to set
6125+the attribute to the value `prologue`, use this markdown:
6126+
6127+ # My chapter {epub:type=prologue}
6128+
6129+Which will result in:
6130+
6131+ <body epub:type="frontmatter">
6132+ <section epub:type="prologue">
6133+ <h1>My chapter</h1>
6134+
6135+Pandoc will output `<body epub:type="bodymatter">`, unless
6136+you use one of the following values, in which case either
6137+`frontmatter` or `backmatter` will be output.
6138+
6139+`epub:type` of first section `epub:type` of body
6140+---------------------------- ------------------
6141+prologue frontmatter
6142+abstract frontmatter
6143+acknowledgments frontmatter
6144+copyright-page frontmatter
6145+dedication frontmatter
6146+credits frontmatter
6147+keywords frontmatter
6148+imprint frontmatter
6149+contributors frontmatter
6150+other-credits frontmatter
6151+errata frontmatter
6152+revision-history frontmatter
6153+titlepage frontmatter
6154+halftitlepage frontmatter
6155+seriespage frontmatter
6156+foreword frontmatter
6157+preface frontmatter
6158+appendix backmatter
6159+colophon backmatter
6160+bibliography backmatter
6161+index backmatter
6162+
6163+[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6164+
6165+## Linked media
46036166
46046167By default, pandoc will download media referenced from any `<img>`, `<audio>`,
46056168`<video>` or `<source>` element present in the generated EPUB,
@@ -4609,19 +6172,143 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
46096172with the `src` attribute. For example:
46106173
46116174 <audio controls="1">
4612− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
46136176 data-external="1" type="audio/mpeg">
46146177 </source>
46156178 </audio>
46166179
4617−Syntax highlighting
4618−===================
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
46196306
46206307Pandoc will automatically highlight syntax in [fenced code blocks] that
46216308are marked with a language name. The Haskell library [skylighting] is
4622−used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4623−To see a list of language names that pandoc will recognize, type
4624−`pandoc --list-highlight-languages`.
6309+used for highlighting. Currently highlighting is supported only for
6310+HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
6311+that pandoc will recognize, type `pandoc --list-highlight-languages`.
46256312
46266313The color scheme can be selected using the `--highlight-style` option.
46276314The default color scheme is `pygments`, which imitates the default color
@@ -4629,15 +6316,80 @@ scheme used by the Python library pygments (though pygments is not actually
46296316used to do the highlighting). To see a list of highlight styles,
46306317type `pandoc --list-highlight-styles`.
46316318
6319+If you are not satisfied with the predefined styles, you can
6320+use `--print-highlight-style` to generate a JSON `.theme` file which
6321+can be modified and used as the argument to `--highlight-style`. To
6322+get a JSON version of the `pygments` style, for example:
6323+
6324+ pandoc --print-highlight-style pygments > my.theme
6325+
6326+Then edit `my.theme` and use it like this:
6327+
6328+ pandoc --highlight-style my.theme
6329+
6330+If you are not satisfied with the built-in highlighting, or you
6331+want highlight a language that isn't supported, you can use the
6332+`--syntax-definition` option to load a [KDE-style XML syntax definition
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
6334+Before writing your own, have a look at KDE's [repository of syntax
6335+definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6336+
46326337To disable highlighting, use the `--no-highlight` option.
46336338
46346339[skylighting]: https://github.com/jgm/skylighting
46356340
4636−Custom Styles in Docx
4637−=====================
6341+# Custom Styles
6342+
6343+Custom styles can be used in the docx and ICML formats.
6344+
6345+## Output
6346+
6347+By default, pandoc's docx and ICML output applies a predefined set of styles
6348+for blocks such as paragraphs and block quotes, and uses largely default
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.
46386389
4639−Input
4640−-----
6390+[pandoc filters]: https://pandoc.org/filters.html
6391+
6392+## Input
46416393
46426394The docx reader, by default, only reads those styles that it can
46436395convert into pandoc elements, either by direct conversion or
@@ -4666,17 +6418,17 @@ And with the extension:
46666418
46676419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
46686420
4669− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
46706422 This is some text.
46716423 :::
46726424
4673− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
46746426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
46756427 And this is text with a [strengthened]{custom-style="Strengthened"}
46766428 text style.
46776429 :::
46786430
4679− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
46806432 > Here is a styled paragraph that inherits from Block Text.
46816433 :::
46826434
@@ -4684,75 +6436,85 @@ With these custom styles, you can use your input document as a
46846436reference-doc while creating docx output (see below), and maintain the
46856437same styles in your input and output files.
46866438
4687−Output
4688−------
4689−
4690−By default, pandoc's docx output applies a predefined set of styles for
4691−blocks such as paragraphs and block quotes, and uses largely default
4692−formatting (italics, bold) for inlines. This will work for most
4693−purposes, especially alongside a `reference.docx` file. However, if you
4694−need to apply your own styles to blocks, or match a preexisting set of
4695−styles, pandoc allows you to define custom styles for blocks and text
4696−using `div`s and `span`s, respectively.
4697−
4698−If you define a `div` or `span` with the attribute `custom-style`,
4699−pandoc will apply your specified style to the contained elements. So,
4700−for example using the `bracketed_spans` syntax,
4701−
4702− [Get out]{custom-style="Emphatically"}, he said.
4703−
4704−would produce a docx file with "Get out" styled with character
4705−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4706−
4707− Dickinson starts the poem simply:
4708−
4709− ::: {custom-style="Poetry"}
4710− | A Bird came down the Walk---
4711− | He did not know I saw---
4712− :::
4713−
4714−would style the two contained lines with the `Poetry` paragraph style.
4715−
4716−If the styles are not yet in your reference.docx, they will be defined
4717−in the output file as inheriting from normal text. If they are already
4718−defined, pandoc will not alter the definition.
4719−
4720−This feature allows for greatest customization in conjunction with
4721−[pandoc filters]. If you want all paragraphs after block quotes to be
4722−indented, you can write a filter to apply the styles necessary. If you
4723−want all italics to be transformed to the `Emphasis` character style
4724−(perhaps to change their color), you can write a filter which will
4725−transform all italicized inlines to inlines within an `Emphasis`
4726−custom-style `span`.
4727−
4728−[pandoc filters]: http://pandoc.org/filters.html
4729−
4730−Custom writers
4731−==============
6439+# Custom writers
47326440
4733−Pandoc can be extended with custom writers written in [lua]. (Pandoc
4734−includes a lua interpreter, so lua need not be installed separately.)
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442+includes a Lua interpreter, so Lua need not be installed separately.)
47356443
4736−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
47376445in place of the output format. For example:
47386446
47396447 pandoc -t data/sample.lua
47406448
4741−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
47426450possible element in a pandoc document. To get a documented example
47436451which you can modify according to your needs, do
47446452
47456453 pandoc --print-default-data-file sample.lua
47466454
4747−[lua]: http://www.lua.org
4748−
4749−Authors
4750−=======
4751−
4752−Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6455+Note that custom writers have no default template. If you want
6456+to use `--standalone` with a custom writer, you will need to
6457+specify a template manually using `--template` or add a new
6458+default template with the name
6459+`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6460+subdirectory of your user data directory (see [Templates]).
6461+
6462+[Lua]: https://www.lua.org
6463+
6464+# Reproducible builds
6465+
6466+Some of the document formats pandoc targets (such as EPUB,
6467+docx, and ODT) include build timestamps in the generated document.
6468+That means that the files generated on successive builds will
6469+differ, even if the source does not. To avoid this, set the
6470+`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6471+be taken from it instead of the current time.
6472+`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6473+(specifying the number of second since midnight UTC January 1, 1970).
6474+
6475+Some document formats also include a unique identifier. For
6476+EPUB, this can be set explicitly by setting the `identifier`
6477+metadata field (see [EPUB Metadata], above).
6478+
6479+# A note on security
6480+
6481+If you use pandoc to convert user-contributed content in a web
6482+application, here are some things to keep in mind:
6483+
6484+1. Although pandoc itself will not create or modify any files other
6485+ than those you explicitly ask it create (with the exception
6486+ of temporary files used in producing PDFs), a filter or custom
6487+ writer could in principle do anything on your file system. Please
6488+ audit filters and custom writers very carefully before using them.
6489+
6490+2. If your application uses pandoc as a Haskell library (rather than
6491+ shelling out to the executable), it is possible to use it in a mode
6492+ that fully isolates pandoc from your file system, by running the
6493+ pandoc operations in the `PandocPure` monad. See the document
6494+ [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
6495+ for more details.
6496+
6497+3. Pandoc's parsers can exhibit pathological performance on some
6498+ corner cases. It is wise to put any pandoc operations under
6499+ a timeout, to avoid DOS attacks that exploit these issues.
6500+ If you are using the pandoc executable, you can add the
6501+ command line options `+RTS -M512M -RTS` (for example) to limit
6502+ the heap size to 512MB.
6503+
6504+4. The HTML generated by pandoc is not guaranteed to be safe.
6505+ If `raw_html` is enabled for the Markdown input, users can
6506+ inject arbitrary HTML. Even if `raw_html` is disabled,
6507+ users can include dangerous content in URLs and attributes.
6508+ To be safe, you should run all the generated HTML through
6509+ an HTML sanitizer.
6510+
6511+# Authors
6512+
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
47536514under the [GPL], version 2 or greater. This software carries no
47546515warranty of any kind. (See COPYRIGHT for full copyright and
47556516warranty notices.) For a full list of contributors, see the file
47566517AUTHORS.md in the pandoc source code.
47576518
4758−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6519+[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6520+[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"