@@ -1,14 +1,14 @@
1−---
2−title: Pandoc User's Guide
3−author: John MacFarlane
4−date: June 20, 2021
5−---
1+% Pandoc User's Guide
2+% John MacFarlane
3+% November 01, 2018
64
7−# Synopsis
5+Synopsis
6+========
87
98`pandoc` [*options*] [*input-file*]...
109
11−# Description
10+Description
11+===========
1212
1313Pandoc is a [Haskell] library for converting from one markup format to
1414another, and a command-line tool that uses this library.
@@ -40,7 +40,8 @@ model. While conversions from pandoc's Markdown to all formats aspire
4040to be perfect, conversions from formats more expressive than pandoc's
4141Markdown can be expected to be lossy.
4242
43−## Using pandoc
43+Using `pandoc`
44+--------------
4445
4546If no *input-files* are specified, input is read from *stdin*.
4647Output goes to *stdout* by default. For output to a file,
@@ -61,7 +62,8 @@ If multiple input files are given, `pandoc` will concatenate them all (with
6162blank lines between them) before parsing. (Use `--file-scope` to parse files
6263individually.)
6364
64−## Specifying formats
65+Specifying formats
66+------------------
6567
6668The format of the input and output can be specified explicitly using
6769command-line options. The input format can be specified using the
@@ -93,7 +95,8 @@ If no input file is specified (so that input comes from *stdin*), or
9395if the input files' extensions are unknown, the input format will
9496be assumed to be Markdown.
9597
96−## Character encoding
98+Character encoding
99+------------------
97100
98101Pandoc uses the UTF-8 character encoding for both input and output.
99102If your local character encoding is not UTF-8, you
@@ -106,9 +109,10 @@ RTF, OPML, DocBook, and Texinfo), information about
106109the character encoding is included in the document header, which
107110will only be included if you use the `-s/--standalone` option.
108111
109−[`iconv`]: https://www.gnu.org/software/libiconv/
112+[`iconv`]: http://www.gnu.org/software/libiconv/
110113
111−## Creating a PDF
114+Creating a PDF
115+--------------
112116
113117To produce a PDF, specify an output file with a `.pdf` extension:
114118
@@ -116,18 +120,20 @@ To produce a PDF, specify an output file with a `.pdf` extension:
116120
117121By default, pandoc will use LaTeX to create the PDF, which requires
118122that a LaTeX engine be installed (see `--pdf-engine` below).
119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
120−intermediate format. To do this, specify an output file with a
121−`.pdf` extension, as before, but add the `--pdf-engine` option
122−or `-t context`, `-t html`, or `-t ms` to the command line.
123−The tool used to generate the PDF from the intermediate format
124−may be specified using `--pdf-engine`.
125−
126−You can control the PDF style using variables, depending on
127−the intermediate format used: see [variables for LaTeX],
128−[variables for ConTeXt], [variables for `wkhtmltopdf`],
129−[variables for ms]. When HTML is used as an intermediate
130−format, the output can be styled using `--css`.
123+
124+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
125+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
126+[`weasyprint`] or [`prince`].
127+To do this, specify an output file with a `.pdf` extension, as before,
128+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
129+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
130+
131+PDF output can be controlled using [variables for LaTeX] (if
132+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
133+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
134+If `wkhtmltopdf` is used, then the variables `margin-left`,
135+`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,
136+`header-html` and `papersize` will affect the output.
131137
132138To debug the PDF creation, it can be useful to look at the intermediate
133139representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -136,105 +142,87 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136142When using LaTeX, the following packages need to be available
137143(they are included with all recent versions of [TeX Live]):
138144[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`iftex`], [`listings`] (if the
145+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140146`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
142−contains images), [`hyperref`], [`xcolor`],
147+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
148+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),
143149[`ulem`], [`geometry`] (with the `geometry` variable set),
144150[`setspace`] (with `linestretch`), and
145151[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146−the PDF engine requires [`fontspec`]. `lualatex` uses
147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149−`mathspec` variable is set, `xelatex` will use [`mathspec`]
150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151−packages are used if available, and [`csquotes`] will be used
152−for [typography] if the `csquotes` variable or metadata field is
153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154−and [`biber`] packages can optionally be used for [citation
155−rendering]. The following packages will be used to improve
156−output quality if present, but pandoc does not require them to
157−be present: [`upquote`] (for straight quotes in verbatim
158−environments), [`microtype`] (for better spacing adjustments),
159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
160−better line breaks in URLs), [`bookmark`] (for better PDF
161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162−footnotes in tables).
163−
164−[TeX Live]: https://www.tug.org/texlive/
152+the 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 `\usepackage{csquotes}` is present in the template or
159+included via `/H/--include-in-header`. The [`natbib`],
160+[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
161+be used for [citation rendering].
162+
165163[`amsfonts`]: https://ctan.org/pkg/amsfonts
166164[`amsmath`]: https://ctan.org/pkg/amsmath
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
173−[`booktabs`]: https://ctan.org/pkg/booktabs
174−[`csquotes`]: https://ctan.org/pkg/csquotes
165+[`lm`]: https://ctan.org/pkg/lm
166+[`ifxetex`]: https://ctan.org/pkg/ifxetex
167+[`ifluatex`]: https://ctan.org/pkg/ifluatex
168+[`listings`]: https://ctan.org/pkg/listings
175169[`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
170+[`longtable`]: https://ctan.org/pkg/longtable
171+[`booktabs`]: https://ctan.org/pkg/booktabs
180172[`graphicx`]: https://ctan.org/pkg/graphicx
181173[`grffile`]: https://ctan.org/pkg/grffile
182−[`hyperref`]: https://ctan.org/pkg/hyperref
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
187−[`mathspec`]: https://ctan.org/pkg/mathspec
188−[`microtype`]: https://ctan.org/pkg/microtype
189−[`natbib`]: https://ctan.org/pkg/natbib
190−[`parskip`]: https://ctan.org/pkg/parskip
191−[`polyglossia`]: https://ctan.org/pkg/polyglossia
192−[`prince`]: https://www.princexml.com/
174+[`geometry`]: https://ctan.org/pkg/geometry
193175[`setspace`]: https://ctan.org/pkg/setspace
176+[`xecjk`]: https://ctan.org/pkg/xecjk
177+[`hyperref`]: https://ctan.org/pkg/hyperref
194178[`ulem`]: https://ctan.org/pkg/ulem
179+[`babel`]: https://ctan.org/pkg/babel
180+[`bidi`]: https://ctan.org/pkg/bidi
181+[`mathspec`]: https://ctan.org/pkg/mathspec
195182[`unicode-math`]: https://ctan.org/pkg/unicode-math
183+[`polyglossia`]: https://ctan.org/pkg/polyglossia
184+[`fontspec`]: https://ctan.org/pkg/fontspec
196185[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
186+[`microtype`]: https://ctan.org/pkg/microtype
187+[`csquotes`]: https://ctan.org/pkg/csquotes
188+[`natbib`]: https://ctan.org/pkg/natbib
189+[`biblatex`]: https://ctan.org/pkg/biblatex
190+[`bibtex`]: https://ctan.org/pkg/bibtex
191+[`biber`]: https://ctan.org/pkg/biber
192+[TeX Live]: http://www.tug.org/texlive/
198193[`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
203−
204−
194+[`weasyprint`]: http://weasyprint.org
195+[`prince`]: https://www.princexml.com/
205196
206−## Reading from the Web
197+Reading from the Web
198+--------------------
207199
208−Instead of an input file, an absolute URI may be given. In this case
200+Instead of an input file, an absolute URI may be given. In this case
209201pandoc will fetch the content using HTTP:
210202
211− pandoc -f html -t markdown https://www.fsf.org
203+ pandoc -f html -t markdown http://www.fsf.org
212204
213205It is possible to supply a custom User-Agent string or other
214206header when requesting a document from a URL:
215207
216208 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217− https://www.fsf.org
209+ http://www.fsf.org
218210
219−# Options
211+Options
212+=======
220213
221−## General options {.options}
214+General options {.options}
215+---------------
222216
223217`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224218
225219: Specify input format. *FORMAT* can be:
226220
227221 ::: {#input-formats}
228− - `bibtex` ([BibTeX] bibliography)
229− - `biblatex` ([BibLaTeX] bibliography)
230222 - `commonmark` ([CommonMark] Markdown)
231− - `commonmark_x` ([CommonMark] Markdown with extensions)
232223 - `creole` ([Creole 1.0])
233− - `csljson` ([CSL JSON] bibliography)
234− - `csv` ([CSV] table)
235224 - `docbook` ([DocBook])
236225 - `docx` ([Word docx])
237− - `dokuwiki` ([DokuWiki markup])
238226 - `epub` ([EPUB])
239227 - `fb2` ([FictionBook2] e-book)
240228 - `gfm` ([GitHub-Flavored Markdown]),
@@ -243,9 +231,7 @@ header when requesting a document from a URL:
243231 if you need extensions not supported in [`gfm`](#markdown-variants).
244232 - `haddock` ([Haddock markup])
245233 - `html` ([HTML])
246− - `ipynb` ([Jupyter notebook])
247234 - `jats` ([JATS] XML)
248− - `jira` ([Jira]/Confluence wiki markup)
249235 - `json` (JSON version of native AST)
250236 - `latex` ([LaTeX])
251237 - `markdown` ([Pandoc's Markdown])
@@ -278,14 +264,10 @@ header when requesting a document from a URL:
278264: Specify output format. *FORMAT* can be:
279265
280266 ::: {#output-formats}
281− - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
267+ - `asciidoc` ([AsciiDoc])
282268 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283− - `bibtex` ([BibTeX] bibliography)
284− - `biblatex` ([BibLaTeX] bibliography)
285269 - `commonmark` ([CommonMark] Markdown)
286− - `commonmark_x` ([CommonMark] Markdown with extensions)
287270 - `context` ([ConTeXt])
288− - `csljson` ([CSL JSON] bibliography)
289271 - `docbook` or `docbook4` ([DocBook] 4)
290272 - `docbook5` (DocBook 5)
291273 - `docx` ([Word docx])
@@ -301,12 +283,7 @@ header when requesting a document from a URL:
301283 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302284 - `html4` ([XHTML] 1.0 Transitional)
303285 - `icml` ([InDesign ICML])
304− - `ipynb` ([Jupyter notebook])
305− - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306− - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307− - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308− - `jats` (alias for `jats_archiving`)
309− - `jira` ([Jira]/Confluence wiki markup)
286+ - `jats` ([JATS] XML)
310287 - `json` (JSON version of native AST)
311288 - `latex` ([LaTeX])
312289 - `man` ([roff man])
@@ -322,7 +299,6 @@ header when requesting a document from a URL:
322299 - `opml` ([OPML])
323300 - `opendocument` ([OpenDocument])
324301 - `org` ([Emacs Org mode])
325− - `pdf` ([PDF])
326302 - `plain` (plain text),
327303 - `pptx` ([PowerPoint] slide show)
328304 - `rst` ([reStructuredText])
@@ -335,12 +311,11 @@ header when requesting a document from a URL:
335311 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
336312 - `s5` ([S5] HTML and JavaScript slide show)
337313 - `tei` ([TEI Simple])
338− - `xwiki` ([XWiki markup])
339314 - `zimwiki` ([ZimWiki markup])
340− - the path of a custom Lua writer, see [Custom writers] below
315+ - the path of a custom lua writer, see [Custom writers] below
341316 :::
342317
343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
318+ Note that `odt`, `docx`, and `epub` output will not be directed
344319 to *stdout* unless forced with `-o -`.
345320
346321 Extensions can be individually enabled or
@@ -358,32 +333,23 @@ header when requesting a document from a URL:
358333
359334: Specify the user data directory to search for pandoc data files.
360335 If this option is not specified, the default user data directory
361− will be used. On \*nix and macOS systems this will be the `pandoc`
362− subdirectory of the XDG data directory (by default,
363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
364− environment variable). If that directory does not exist and
365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366− On Windows the default user data directory is
367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.
336+ will be used. This is, in UNIX:
337+
338+ $HOME/.pandoc
339+
340+ in Windows XP:
341+
342+ C:\Documents And Settings\USERNAME\Application Data\pandoc
343+
344+ and in Windows Vista or later:
345+
346+ C:\Users\USERNAME\AppData\Roaming\pandoc
347+
368348 You can find the default user data directory on your system by
369349 looking at the output of `pandoc --version`.
370− Data files placed in this directory (for example, `reference.odt`,
371− `reference.docx`, `epub.css`, `templates`) will override
372− pandoc's normal defaults.
373−
374−`-d` *FILE*, `--defaults=`*FILE*
375−
376−: Specify a set of default option settings. *FILE* is a YAML
377− file whose fields correspond to command-line option
378− settings. All options for document conversion, including input
379− and output files, can be set using a defaults file. The file will
380− be searched for first in the working directory, and then in
381− the `defaults` subdirectory of the user data directory
382− (see `--data-dir`). The `.yaml` extension may be omitted.
383− See the section [Default files] for more information on the
384− file format. Settings from the defaults file may be
385− overridden or extended by subsequent options on the command
386− line.
350+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
351+ `slidy`, `slideous`, or `s5` directory
352+ placed in this directory will override pandoc's normal defaults.
387353
388354`--bash-completion`
389355
@@ -394,7 +360,8 @@ header when requesting a document from a URL:
394360
395361`--verbose`
396362
397−: Give verbose debugging output.
363+: Give verbose debugging output. Currently this only has an effect
364+ with PDF output.
398365
399366`--quiet`
400367
@@ -420,7 +387,7 @@ header when requesting a document from a URL:
420387
421388`--list-extensions`[`=`*FORMAT*]
422389
423−: List supported extensions for *FORMAT*, one per line, preceded
390+: List supported extensions, one per line, preceded
424391 by a `+` or `-` indicating whether it is enabled by default
425392 in *FORMAT*. If *FORMAT* is not specified, defaults for
426393 pandoc's Markdown are given.
@@ -443,88 +410,62 @@ header when requesting a document from a URL:
443410
444411: Show usage message.
445412
446−[Markdown]: https://daringfireball.net/projects/markdown/
447−[CommonMark]: https://commonmark.org
413+[Markdown]: http://daringfireball.net/projects/markdown/
414+[CommonMark]: http://commonmark.org
448415[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449416[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450−[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451−[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452−[S5]: https://meyerweb.com/eric/tools/s5/
453−[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454−[Slideous]: https://goessner.net/articles/slideous/
455−[HTML]: https://www.w3.org/html/
456−[HTML5]: https://html.spec.whatwg.org/
417+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
418+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
419+[S5]: http://meyerweb.com/eric/tools/s5/
420+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
421+[Slideous]: http://goessner.net/articles/slideous/
422+[HTML]: http://www.w3.org/html/
423+[HTML5]: http://www.w3.org/TR/html5/
457424[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458−[XHTML]: https://www.w3.org/TR/xhtml1/
459−[LaTeX]: https://www.latex-project.org/
425+[XHTML]: http://www.w3.org/TR/xhtml1/
426+[LaTeX]: http://latex-project.org
460427[`beamer`]: https://ctan.org/pkg/beamer
461−[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462−[ConTeXt]: https://www.contextgarden.net/
463−[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464−[DocBook]: https://docbook.org
428+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
429+[ConTeXt]: http://www.contextgarden.net/
430+[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
431+[DocBook]: http://docbook.org
465432[JATS]: https://jats.nlm.nih.gov
466−[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467−[txt2tags]: https://txt2tags.org
433+[txt2tags]: http://txt2tags.org
468434[EPUB]: http://idpf.org/epub
469435[OPML]: http://dev.opml.org/spec2.html
470436[OpenDocument]: http://opendocument.xml.org
471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472−[Textile]: https://www.promptworks.com/textile
437+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
438+[Textile]: http://redcloth.org/textile
473439[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474440[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476−[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
441+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
442+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478443[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479444[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480445[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481−[CSV]: https://tools.ietf.org/html/rfc4180
482−[roff man]: https://man.cx/groff_man(7)
483−[roff ms]: https://man.cx/groff_ms(7)
446+[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
447+[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
484448[Haskell]: https://www.haskell.org
485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486−[Emacs Org mode]: https://orgmode.org
487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488−[AsciiDoctor]: https://asciidoctor.org/
489−[DZSlides]: https://paulrouget.com/dzslides/
449+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
450+[Emacs Org mode]: http://orgmode.org
451+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
452+[DZSlides]: http://paulrouget.com/dzslides/
490453[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491454[PDF]: https://www.adobe.com/pdf/
492−[reveal.js]: https://revealjs.com/
455+[reveal.js]: http://lab.hakim.se/reveal-js/
493456[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494−[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
495−[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
457+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496458[TEI Simple]: https://github.com/TEIC/TEI-Simple
497459[Muse]: https://amusewiki.org/library/manual
498460[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499461[Vimwiki]: https://vimwiki.github.io
500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501−[BibTeX]: https://ctan.org/pkg/bibtex
502−[BibLaTeX]: https://ctan.org/pkg/biblatex
503−
504−## Reader options {.options}
505−
506−`--shift-heading-level-by=`*NUMBER*
507−
508−: Shift heading levels by a positive or negative integer.
509− For example, with `--shift-heading-level-by=-1`, level 2
510− headings become level 1 headings, and level 3 headings
511− become level 2 headings. Headings cannot have a level
512− less than 1, so a heading that would be shifted below level 1
513− becomes a regular paragraph. Exception: with a shift of -N,
514− a level-N heading at the beginning of the document
515− replaces the metadata title. `--shift-heading-level-by=-1`
516− is a good choice when converting HTML or Markdown documents that
517− use an initial level-1 heading for the document title and
518− level-2+ headings for sections. `--shift-heading-level-by=1`
519− may be a good choice for converting Markdown documents that
520− use level-1 headings for sections to HTML, since pandoc uses
521− a level-1 heading to render the document title.
462+
463+Reader options {.options}
464+--------------
522465
523466`--base-header-level=`*NUMBER*
524467
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
527− (defaults to 1).
468+: Specify the base level for headers (defaults to 1).
528469
529470`--strip-empty-paragraphs`
530471
@@ -589,32 +530,41 @@ header when requesting a document from a URL:
589530
590531 3. `$PATH` (executable only)
591532
592− Filters, Lua-filters, and citeproc processing are applied in
593− the order specified on the command line.
533+ Filters and lua-filters are applied in the order specified
534+ on the command line.
594535
595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
536+`--lua-filter=`*SCRIPT*
596537
597538: Transform the document in a similar fashion as JSON filters (see
598− `--filter`), but use pandoc's built-in Lua filtering system. The given
599− Lua script is expected to return a list of Lua filters which will be
600− applied in order. Each Lua filter must contain element-transforming
539+ `--filter`), but use pandoc's build-in lua filtering system. The given
540+ lua script is expected to return a list of lua filters which will be
541+ applied in order. Each lua filter must contain element-transforming
601542 functions indexed by the name of the AST element on which the filter
602543 function should be applied.
603544
604− The `pandoc` Lua module provides helper functions for element
605− creation. It is always loaded into the script's Lua environment.
545+ The `pandoc` lua module provides helper functions for element
546+ creation. It is always loaded into the script's lua environment.
547+
548+ The following is an example lua script for macro-expansion:
606549
607− See the [Lua filters documentation] for further details.
550+ function expand_hello_world(inline)
551+ if inline.c == '{{helloworld}}' then
552+ return pandoc.Emph{ pandoc.Str "Hello, World" }
553+ else
554+ return inline
555+ end
556+ end
608557
609− In order of preference, pandoc will look for Lua filters in
558+ return {{Str = expand_hello_world}}
610559
611− 1. a specified full or relative path
560+ In order of preference, pandoc will look for lua filters in
612561
613− 2. `$DATADIR/filters` where `$DATADIR` is the user data
614− directory (see `--data-dir`, above).
562+ 1. a specified full or relative path (executable or
563+ non-executable)
615564
616− Filters, Lua filters, and citeproc processing are applied in
617− the order specified on the command line.
565+ 2. `$DATADIR/filters` (executable or non-executable)
566+ where `$DATADIR` is the user data directory (see
567+ `--data-dir`, above).
618568
619569`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620570
@@ -631,23 +581,19 @@ header when requesting a document from a URL:
631581
632582`--metadata-file=`*FILE*
633583
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.
584+: Read metadata from the supplied YAML (or JSON) file.
585+ This option can be used with every input format, but string
586+ scalars in the YAML file will always be parsed as Markdown.
587+ Generally, the input will be handled the same as in
588+ [YAML metadata blocks][Extension: `yaml_metadata_block`].
589+ Metadata values specified inside the document, or by using `-M`,
590+ overwrite values specified with this option.
644591
645592`-p`, `--preserve-tabs`
646593
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.
594+: Preserve tabs instead of converting them to spaces (the default).
595+ Note that this will only affect tabs in literal code spans and code
596+ blocks; tabs in regular text will be treated as spaces.
651597
652598`--tab-stop=`*NUMBER*
653599
@@ -657,30 +603,30 @@ header when requesting a document from a URL:
657603
658604: Specifies what to do with insertions, deletions, and comments
659605 produced by the MS Word "Track Changes" feature. `accept` (the
660− default) processes all the insertions and deletions.
661− `reject` ignores them. Both `accept` and `reject` ignore comments.
662− `all` includes all insertions, deletions, and comments, wrapped
663− in spans with `insertion`, `deletion`, `comment-start`, and
664− `comment-end` classes, respectively. The author and time of
665− change is included. `all` is useful for scripting: only
666− accepting changes from a certain reviewer, say, or before a
667− certain date. If a paragraph is inserted or deleted,
668− `track-changes=all` produces a span with the class
669− `paragraph-insertion`/`paragraph-deletion` before the
670− affected paragraph break. This option only affects the docx
671− reader.
606+ default), inserts all insertions, and ignores all
607+ deletions. `reject` inserts all deletions and ignores
608+ insertions. Both `accept` and `reject` ignore comments. `all` puts
609+ in insertions, deletions, and comments, wrapped in spans with
610+ `insertion`, `deletion`, `comment-start`, and `comment-end`
611+ classes, respectively. The author and time of change is
612+ included. `all` is useful for scripting: only accepting changes
613+ from a certain reviewer, say, or before a certain date. If a
614+ paragraph is inserted or deleted, `track-changes=all` produces a
615+ span with the class `paragraph-insertion`/`paragraph-deletion`
616+ before the affected paragraph break. This option only affects the
617+ docx reader.
672618
673619`--extract-media=`*DIR*
674620
675621: Extract images and other media contained in or linked from
676622 the source document to the path *DIR*, creating it if
677623 necessary, and adjust the images references in the document
678− so they point to the extracted files. Media are downloaded,
679− read from the file system, or extracted from a binary
680− container (e.g. docx), as needed. The original file paths
681− are used if they are relative paths not containing `..`.
682− Otherwise filenames are constructed from the SHA1 hash of
683− the contents.
624+ so they point to the extracted files. If the source format is
625+ a binary container (docx, epub, or odt), the media is
626+ extracted from the container and the original
627+ filenames are used. Otherwise the media is read from the
628+ file system or downloaded, and new filenames are constructed
629+ based on SHA1 hashes of the contents.
684630
685631`--abbreviations=`*FILE*
686632
@@ -691,17 +637,17 @@ header when requesting a document from a URL:
691637 system default, use
692638 `pandoc --print-default-data-file=abbreviations`. The only
693639 use pandoc makes of this list is in the Markdown reader.
694− Strings found in this list will be followed by a nonbreaking
695− space, and the period will not produce sentence-ending space
696− in formats like LaTeX. The strings may not contain spaces.
640+ Strings ending in a period that are found in this list will
641+ be followed by a nonbreaking space, so that the period will
642+ not produce sentence-ending space in formats like LaTeX.
697643
698644[`pandocfilters`]: https://github.com/jgm/pandocfilters
699645[PHP]: https://github.com/vinai/pandocfilters-php
700646[perl]: https://metacpan.org/pod/Pandoc::Filter
701647[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703648
704−## General writer options {.options}
649+General writer options {.options}
650+----------------------
705651
706652`-s`, `--standalone`
707653
@@ -726,29 +672,22 @@ header when requesting a document from a URL:
726672`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727673
728674: Set the template variable *KEY* to the value *VAL* when rendering the
729− document in standalone mode. If no *VAL* is specified, the
730− key will be given the value `true`.
675+ document in standalone mode. This is generally only useful when the
676+ `--template` option is used to specify a custom template, since
677+ pandoc automatically sets the variables used in the default
678+ templates. If no *VAL* is specified, the key will be given the
679+ value `true`.
731680
732681`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733682
734683: Print the system default template for an output *FORMAT*. (See `-t`
735684 for a list of possible *FORMAT*s.) Templates in the user data
736− directory are ignored. This option may be used with
737− `-o`/`--output` to redirect output to a file, but
738− `-o`/`--output` must come before `--print-default-template`
739− on the command line.
740−
741− Note that some of the default templates use partials, for
742− example `styles.html`. To print the partials, use
743− `--print-default-data-file`: for example,
744− `--print-default-data-file=templates/styles.html`.
685+ directory are ignored.
745686
746687`--print-default-data-file=`*FILE*
747688
748689: Print a system default data file. Files in the user data directory
749− are ignored. This option may be used with `-o`/`--output` to
750− redirect output to a file, but `-o`/`--output` must come before
751− `--print-default-data-file` on the command line.
690+ are ignored.
752691
753692`--eol=crlf`|`lf`|`native`
754693
@@ -759,12 +698,9 @@ header when requesting a document from a URL:
759698
760699`--dpi`=*NUMBER*
761700
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.
701+: Specify the dpi (dots per inch) value for conversion from pixels
702+ to inch/centimeters and vice versa. The default is 96dpi.
703+ Technically, the correct term would be ppi (pixels per inch).
768704
769705`--wrap=auto`|`none`|`preserve`
770706
@@ -777,8 +713,6 @@ header when requesting a document from a URL:
777713 where there are nonsemantic newlines in the source, there
778714 will be nonsemantic newlines in the output as well).
779715 Automatic wrapping does not currently work in HTML output.
780− In `ipynb` output, this option affects wrapping of the
781− contents of markdown cells.
782716
783717`--columns=`*NUMBER*
784718
@@ -795,17 +729,11 @@ header when requesting a document from a URL:
795729 unless `-s/--standalone` is used, and it has no effect
796730 on `man`, `docbook4`, `docbook5`, or `jats` output.
797731
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−
804732`--toc-depth=`*NUMBER*
805733
806734: Specify the number of section levels to include in the table
807− of contents. The default is 3 (which means that level-1, 2, and 3
808− headings will be listed in the contents).
735+ of contents. The default is 3 (which means that level 1, 2, and 3
736+ headers will be listed in the contents).
809737
810738`--strip-comments`
811739
@@ -841,10 +769,7 @@ header when requesting a document from a URL:
841769
842770: Prints a JSON version of a highlighting style, which can
843771 be modified, saved with a `.theme` extension, and used
844− with `--highlight-style`. This option may be used with
845− `-o`/`--output` to redirect output to a file, but
846− `-o`/`--output` must come before `--print-highlight-style`
847− on the command line.
772+ with `--highlight-style`.
848773
849774`--syntax-definition=`*FILE*
850775
@@ -852,10 +777,9 @@ header when requesting a document from a URL:
852777 which will be used for syntax highlighting of appropriately
853778 marked code blocks. This can be used to add support for
854779 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
856− multiple syntax definitions.
780+ existing languages.
857781
858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
782+`-H` *FILE*, `--include-in-header=`*FILE*
859783
860784: Include contents of *FILE*, verbatim, at the end of the header.
861785 This can be used, for example, to include special
@@ -863,7 +787,7 @@ header when requesting a document from a URL:
863787 repeatedly to include multiple files in the header. They will be
864788 included in the order specified. Implies `--standalone`.
865789
866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
790+`-B` *FILE*, `--include-before-body=`*FILE*
867791
868792: Include contents of *FILE*, verbatim, at the beginning of the
869793 document body (e.g. after the `<body>` tag in HTML, or the
@@ -872,7 +796,7 @@ header when requesting a document from a URL:
872796 used repeatedly to include multiple files. They will be included in
873797 the order specified. Implies `--standalone`.
874798
875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
799+`-A` *FILE*, `--include-after-body=`*FILE*
876800
877801: Include contents of *FILE*, verbatim, at the end of the document
878802 body (before the `</body>` tag in HTML, or the
@@ -891,11 +815,11 @@ header when requesting a document from a URL:
891815 will not be searched. For example:
892816 `--resource-path=.:test` will search the working directory
893817 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`.
818+
819+ `--resource-path` only has an effect if (a) the output
820+ format embeds images (for example, `docx`, `pdf`, or `html`
821+ with `--self-contained`) or (b) it is used together with
822+ `--extract-media`.
899823
900824`--request-header=`*NAME*`:`*VAL*
901825
@@ -905,13 +829,8 @@ header when requesting a document from a URL:
905829 downloaded). If you're behind a proxy, you also need to set
906830 the environment variable `http_proxy` to `http://...`.
907831
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}
832+Options affecting specific writers {.options}
833+----------------------------------
915834
916835`--self-contained`
917836
@@ -936,18 +855,17 @@ header when requesting a document from a URL:
936855
937856`--html-q-tags`
938857
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.)
858+: Use `<q>` tags for quotes in HTML.
942859
943860`--ascii`
944861
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.
862+: Use only ASCII characters in output. Currently supported for
863+ XML and HTML formats (which use entities instead of
864+ UTF-8 when this option is selected), Markdown (which uses
865+ entities), roff ms (which use hexadecimal escapes), and to
866+ a limited degree LaTeX (which uses standard commands for
867+ accented characters when possible). roff man output uses
868+ ASCII by default.
951869
952870`--reference-links`
953871
@@ -956,45 +874,36 @@ header when requesting a document from a URL:
956874 placement of link references is affected by the
957875 `--reference-location` option.
958876
959−`--reference-location=block`|`section`|`document`
877+`--reference-location = block`|`section`|`document`
960878
961879: Specify whether footnotes (and references, if `reference-links` is
962880 set) are placed at the end of the current (top-level) block, the
963881 current section, or the document. The default is
964882 `document`. Currently only affects the markdown writer.
965883
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−
974884`--atx-headers`
975885
976−: *Deprecated synonym for `--markdown-headings=atx`.*
886+: Use ATX-style headers in Markdown output. The default is
887+ to use setext-style headers for levels 1-2, and then ATX headers.
888+ (Note: for `gfm` output, ATX headers are always used.)
977889
978−`--top-level-division=default`|`section`|`chapter`|`part`
890+`--top-level-division=[default|section|chapter|part]`
979891
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.
892+: Treat top-level headers as the given division type in LaTeX, ConTeXt,
893+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;
894+ all headers are shifted such that the top-level header becomes the specified
895+ type. The default behavior is to determine the best division type via
896+ heuristics: unless other conditions apply, `section` is chosen. When the
897+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the
898+ `article` option is specified), `chapter` is implied as the setting for this
899+ option. If `beamer` is the output format, specifying either `chapter` or
900+ `part` will cause top-level headers to become `\part{..}`, while
901+ second-level headers remain as their default type.
993902
994903`-N`, `--number-sections`
995904
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997− output. By default, sections are not numbered. Sections with class
905+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
906+ By default, sections are not numbered. Sections with class
998907 `unnumbered` will never be numbered, even if `--number-sections`
999908 is specified.
1000909
@@ -1002,10 +911,10 @@ header when requesting a document from a URL:
1002911
1003912: Offset for section headings in HTML output (ignored in other
1004913 output formats). The first number is added to the section number for
1005− top-level headings, the second for second-level headings, and so on.
1006− So, for example, if you want the first top-level heading in your
914+ top-level headers, the second for second-level headers, and so on.
915+ So, for example, if you want the first top-level header in your
1007916 document to be numbered "6", specify `--number-offset=5`.
1008− If your document starts with a level-2 heading which you want to
917+ If your document starts with a level-2 header which you want to
1009918 be numbered "1.5", specify `--number-offset=1,4`.
1010919 Offsets are 0 by default. Implies `--number-sections`.
1011920
@@ -1013,7 +922,7 @@ header when requesting a document from a URL:
1013922
1014923: Use the [`listings`] package for LaTeX code blocks. The package
1015924 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
925+ you would need to use a custom template. This issue is fully
1017926 documented here: [Encoding issue with the listings package].
1018927
1019928`-i`, `--incremental`
@@ -1023,12 +932,12 @@ header when requesting a document from a URL:
1023932
1024933`--slide-level=`*NUMBER*
1025934
1026−: Specifies that headings with the specified level create
1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
935+: Specifies that headers with the specified level create
936+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1028937 above this level in the hierarchy are used to divide the
1029− slide show into sections; headings below this level create
938+ slide show into sections; headers below this level create
1030939 subheads within a slide. Note that content that is
1031− not contained under slide-level headings will not appear in
940+ not contained under slide-level headers will not appear in
1032941 the slide show. The default is to set the slide level based
1033942 on the contents of the document; see [Structuring the slide
1034943 show].
@@ -1037,8 +946,8 @@ header when requesting a document from a URL:
1037946
1038947: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
1039948 and attach identifiers to the enclosing `<section>` (or `<div>`)
1040− rather than the heading itself. See
1041− [Heading identifiers], below.
949+ rather than the header itself. See
950+ [Header identifiers], below.
1042951
1043952`--email-obfuscation=none`|`javascript`|`references`
1044953
@@ -1059,7 +968,8 @@ header when requesting a document from a URL:
1059968
1060969: Specify *STRING* as a prefix at the beginning of the title
1061970 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
971+ appears at the beginning of the HTML body). Implies
972+ `--standalone`.
1063973
1064974`-c` *URL*, `--css=`*URL*
1065975
@@ -1091,56 +1001,20 @@ header when requesting a document from a URL:
10911001
10921002 To produce a custom `reference.docx`, first get a copy of
10931003 the default `reference.docx`: `pandoc
1094− -o custom-reference.docx --print-default-data-file reference.docx`.
1095− Then open `custom-reference.docx` in Word, modify the
1096− styles as you wish, and save the file. For best
1097− results, do not make changes to this file other than
1098− modifying the styles used by pandoc:
1099−
1100− Paragraph styles:
1101−
1102− - Normal
1103− - Body Text
1104− - First Paragraph
1105− - Compact
1106− - Title
1107− - Subtitle
1108− - Author
1109− - Date
1110− - Abstract
1111− - Bibliography
1112− - Heading 1
1113− - Heading 2
1114− - Heading 3
1115− - Heading 4
1116− - Heading 5
1117− - Heading 6
1118− - Heading 7
1119− - Heading 8
1120− - Heading 9
1121− - Block Text
1122− - Footnote Text
1123− - Definition Term
1124− - Definition
1125− - Caption
1126− - Table Caption
1127− - Image Caption
1128− - Figure
1129− - Captioned Figure
1130− - TOC Heading
1131−
1132− Character styles:
1133−
1134− - Default Paragraph Font
1135− - Body Text Char
1136− - Verbatim Char
1137− - Footnote Reference
1138− - Hyperlink
1139− - Section Number
1140−
1141− Table style:
1142−
1143− - Table
1004+ --print-default-data-file reference.docx >
1005+ custom-reference.docx`. Then open `custom-reference.docx`
1006+ in Word, modify the styles as you wish, and save the file.
1007+ For best results, do not make changes to this file other
1008+ than modifying the styles used by pandoc: [paragraph]
1009+ Normal, Body Text, First Paragraph, Compact, Title,
1010+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1011+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,
1012+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1013+ Definition Term, Definition, Caption, Table Caption,
1014+ Image Caption, Figure, Captioned Figure, TOC Heading;
1015+ [character] Default Paragraph Font, Body Text Char,
1016+ Verbatim Char, Footnote Reference, Hyperlink; [table]
1017+ Table.
11441018
11451019 ODT
11461020
@@ -1154,18 +1028,19 @@ header when requesting a document from a URL:
11541028
11551029 To produce a custom `reference.odt`, first get a copy of
11561030 the default `reference.odt`: `pandoc
1157− -o custom-reference.odt --print-default-data-file reference.odt`.
1158− Then open `custom-reference.odt` in LibreOffice, modify
1159− the styles as you wish, and save the file.
1031+ --print-default-data-file reference.odt >
1032+ custom-reference.odt`. Then open `custom-reference.odt` in
1033+ LibreOffice, modify the styles as you wish, and save the
1034+ file.
11601035
11611036 PowerPoint
11621037
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.
1038+ : Any template included with a recent install of Microsoft
1039+ PowerPoint (either with `.pptx` or `.potx` extension) should
1040+ work, as will most templates derived from these.
11661041
1167− The specific requirement is that the template should begin with
1168− the following first four layouts:
1042+ The specific requirement is that the template should contain
1043+ the following four layouts as its first four layouts:
11691044
11701045 1. Title Slide
11711046 2. Title and Content
@@ -1177,10 +1052,10 @@ header when requesting a document from a URL:
11771052 `Home` menu to check.)
11781053
11791054 You can also modify the default `reference.pptx`: first run
1180− `pandoc -o custom-reference.pptx --print-default-data-file
1181− reference.pptx`, and then modify `custom-reference.pptx`
1182− in MS PowerPoint (pandoc will use the first four layout
1183− slides, as mentioned above).
1055+ `pandoc --print-default-data-file reference.pptx >
1056+ custom-reference.pptx`, and then modify
1057+ `custom-reference.pptx` in MS PowerPoint (pandoc will use the
1058+ first four layout slides, as mentioned above).
11841059
11851060`--epub-cover-image=`*FILE*
11861061
@@ -1248,12 +1123,12 @@ header when requesting a document from a URL:
12481123
12491124`--epub-chapter-level=`*NUMBER*
12501125
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
1126+: Specify the header level at which to split the EPUB into separate
1127+ "chapter" files. The default is to split into chapters at level 1
1128+ headers. This option only affects the internal composition of the
12541129 EPUB, not the way chapters and sections are displayed to users. Some
12551130 readers may be slow if the chapter files are too large, so for large
1256− documents with few level-1 headings, one might want to use a chapter
1131+ documents with few level 1 headers, one might want to use a chapter
12571132 level of 2 or 3.
12581133
12591134`--epub-subdirectory=`*DIRNAME*
@@ -1262,118 +1137,71 @@ header when requesting a document from a URL:
12621137 the EPUB-specific contents. The default is `EPUB`. To put
12631138 the EPUB contents in the top level, use an empty string.
12641139
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*
1140+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
12751141
12761142: Use the specified engine when producing PDF output.
1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1279− and `pdfroff`. If the engine is not in your PATH, the full
1280− path of the engine may be specified here. If this option
1281− is not specified, pandoc uses the following defaults
1282− depending on the output format specified using `-t/--to`:
1283−
1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1285− `tectonic`, `latexmk`)
1286− - `-t context`: `context`
1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;
1288− see [print-css.rocks](https://print-css.rocks) for a good
1289− introduction to PDF generation from HTML/CSS.)
1290− - `-t ms`: `pdfroff`
1143+ The default is `pdflatex`. If the engine is not in your PATH,
1144+ the full path of the engine may be specified here.
12911145
12921146`--pdf-engine-opt=`*STRING*
12931147
12941148: Use the given string as a command-line argument to the `pdf-engine`.
1295− For example, to use a persistent directory `foo` for `latexmk`'s
1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1297− Note that no check for duplicate options is done.
1149+ If used multiple times, the arguments are provided with spaces between
1150+ them. Note that no check for duplicate options is done.
12981151
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1152+[Dublin Core elements]: http://dublincore.org/documents/dces/
1153+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
13011154[Encoding issue with the listings package]:
13021155 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
13031156
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].
1157+Citation rendering {.options}
1158+------------------
13241159
13251160`--bibliography=`*FILE*
13261161
13271162: Set the `bibliography` field in the document's metadata to *FILE*,
1328− overriding any value set in the metadata. If you supply
1329− this argument multiple times, each *FILE* will be added to
1330− bibliography. If *FILE* is a URL, it will be fetched
1331− via HTTP. If *FILE* is not found relative to the
1332− working directory, it will be sought in the resource path
1333− (see `--resource-path`).
1163+ overriding any value set in the metadata, and process citations
1164+ using `pandoc-citeproc`. (This is equivalent to
1165+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1166+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1167+ used, making this equivalent to `--metadata bibliography=FILE`.
1168+ If you supply this argument multiple times, each *FILE* will be added
1169+ to bibliography.
13341170
13351171`--csl=`*FILE*
13361172
13371173: Set the `csl` field in the document's metadata to *FILE*,
13381174 overriding any value set in the metadata. (This is equivalent to
1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1340− fetched via HTTP. If *FILE* is not found relative to the
1341− working directory, it will be sought in the resource path
1342− (see `--resource-path`) and finally in the `csl`
1343− subdirectory of the pandoc user data directory.
1175+ `--metadata csl=FILE`.)
1176+ This option is only relevant with `pandoc-citeproc`.
13441177
13451178`--citation-abbreviations=`*FILE*
13461179
13471180: Set the `citation-abbreviations` field in the document's metadata to
13481181 *FILE*, overriding any value set in the metadata. (This is equivalent to
13491182 `--metadata citation-abbreviations=FILE`.)
1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351− found relative to the working directory, it will be sought
1352− in the resource path (see `--resource-path`) and finally in
1353− the `csl` subdirectory of the pandoc user data directory.
1183+ This option is only relevant with `pandoc-citeproc`.
13541184
13551185`--natbib`
13561186
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`].
1187+: Use [`natbib`] for citations in LaTeX output. This option is not for use
1188+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1189+ use in producing a LaTeX file that can be processed with [`bibtex`].
13611190
13621191`--biblatex`
13631192
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`].
1193+: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1194+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1195+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
13681196
1369−## Math rendering in HTML {.options}
1197+Math rendering in HTML {.options}
1198+----------------------
13701199
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.
1200+The default is to render TeX math as far as possible using Unicode characters.
1201+Formulas are put inside a `span` with `class="math"`, so that they may be styled
1202+differently from the surrounding text if needed. However, this gives acceptable
1203+results only for basic math, usually you will want to use `--mathjax` or another
1204+of the following options.
13771205
13781206`--mathjax`[`=`*URL*]
13791207
@@ -1387,11 +1215,10 @@ results only for basic math, usually you will want to use
13871215
13881216`--mathml`
13891217
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.
1218+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1219+ `html4` and `html5`). This is the default in `odt` output. Note that
1220+ currently only Firefox and Safari (and select e-book readers) natively
1221+ support MathML.
13951222
13961223`--webtex`[`=`*URL*]
13971224
@@ -1415,19 +1242,21 @@ results only for basic math, usually you will want to use
14151242`--gladtex`
14161243
14171244: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1418− can then be processed by [GladTeX] to produce SVG images of the typeset
1419− formulas and an HTML file with these images embedded.
1245+ can then be processed by [GladTeX] to produce images of the typeset
1246+ formulas and an HTML file with links to these images.
1247+ So, the procedure is:
14201248
14211249 pandoc -s --gladtex input.md -o myfile.htex
1422− gladtex -d image_dir myfile.htex
1423− # produces myfile.html and images in image_dir
1250+ gladtex -d myfile-images myfile.htex
1251+ # produces myfile.html and images in myfile-images
14241252
1425−[MathML]: https://www.w3.org/Math/
1253+[MathML]: http://www.w3.org/Math/
14261254[MathJax]: https://www.mathjax.org
14271255[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
1256+[GladTeX]: http://humenda.github.io/GladTeX/
14291257
1430−## Options for wrapper scripts {.options}
1258+Options for wrapper scripts {.options}
1259+---------------------------
14311260
14321261`--dump-args`
14331262
@@ -1451,277 +1280,8 @@ results only for basic math, usually you will want to use
14511280
14521281 pandoc -o foo.html -s
14531282
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
1283+Templates
1284+=========
17251285
17261286When the `-s/--standalone` option is used, pandoc uses a template to
17271287add header and footer material that is needed for a self-standing
@@ -1741,935 +1301,374 @@ directory (see `--data-dir`, above). *Exceptions:*
17411301 (or the `default.context` template, if you use `-t context`,
17421302 or the `default.ms` template, if you use `-t ms`, or the
17431303 `default.html` template, if you use `-t html`).
1744−- `docx` and `pptx` have no template (however, you can use
1304+- `docx` has no template (however, you can use
17451305 `--reference-doc` to customize the output).
17461306
17471307Templates contain *variables*, which allow for the inclusion of
17481308arbitrary information at any point in the file. They may be set at the
17491309command line using the `-V/--variable` option. If a variable is not set,
1750−pandoc will look for the key in the document's metadata, which can be set
1310+pandoc will look for the key in the document's metadata – which can be set
17511311using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1752−or with the `-M/--metadata` option. In addition, some variables
1753−are given default values by pandoc. See [Variables] below for
1754−a list of variables used in pandoc's default templates.
1312+or with the `--metadata` option.
17551313
1756−If you use custom templates, you may need to revise them as pandoc
1757−changes. We recommend tracking the changes in the default templates,
1758−and modifying your custom templates accordingly. An easy way to do this
1759−is to fork the [pandoc-templates] repository and merge in
1760−changes after each pandoc release.
1761−
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1314+Variables set by pandoc
1315+-----------------------
17631316
1764−## Template syntax
1317+Some variables are set automatically by pandoc. These vary somewhat
1318+depending on the output format, but include the following:
17651319
1766−### Comments
1320+`sourcefile`, `outputfile`
1321+: source and destination filenames, as given on the command line.
1322+ `sourcefile` can also be a list if input comes from multiple files, or empty
1323+ if input is from stdin. You can use the following snippet in your template
1324+ to distinguish them:
17671325
1768−Anything between the sequence `$--` and the end of the
1769−line will be treated as a comment and omitted from the output.
1326+ $if(sourcefile)$
1327+ $for(sourcefile)$
1328+ $sourcefile$
1329+ $endfor$
1330+ $else$
1331+ (stdin)
1332+ $endif$
17701333
1771−### Delimiters
1334+ Similarly, `outputfile` can be `-` if output goes to the terminal.
17721335
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.
1336+`title`, `author`, `date`
1337+: allow identification of basic aspects of the document. Included
1338+ in PDF metadata through LaTeX and ConTeXt. These can be set
1339+ through a [pandoc title block][Extension: `pandoc_title_block`],
1340+ which allows for multiple authors, or through a YAML metadata block:
17811341
1782−To include a literal `$` in the document, use `$$`.
1342+ ---
1343+ author:
1344+ - Aristotle
1345+ - Peter Abelard
1346+ ...
17831347
1784−### Interpolated variables
1348+`subtitle`
1349+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1350+ renders in LaTeX only when using a document class that supports
1351+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1352+ `scrreprt`, `scrbook`).[^subtitle]
17851353
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:
1354+`institute`
1355+: author affiliations (in LaTeX and Beamer only). Can be a
1356+ list, when there are multiple authors.
17911357
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−```
1358+`abstract`
1359+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx
18021360
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.
1361+`keywords`
1362+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;
1363+ may be repeated as for `author`, above
18071364
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.
1365+`header-includes`
1366+: contents specified by `-H/--include-in-header` (may have multiple
1367+ values)
18151368
1816−### Conditionals
1369+`toc`
1370+: non-null value if `--toc/--table-of-contents` was specified
18171371
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:
1372+`toc-title`
1373+: title of table of contents (works only with EPUB,
1374+ opendocument, odt, docx, pptx, beamer, LaTeX)
18241375
1825−```
1826−$if(foo)$bar$endif$
1376+`include-before`
1377+: contents specified by `-B/--include-before-body` (may have
1378+ multiple values)
18271379
1828−$if(foo)$
1829− $foo$
1830−$endif$
1380+`include-after`
1381+: contents specified by `-A/--include-after-body` (may have
1382+ multiple values)
18311383
1832−$if(foo)$
1833−part one
1834−$else$
1835−part two
1836−$endif$
1384+`body`
1385+: body of document
18371386
1838−${if(foo)}bar${endif}
1387+`meta-json`
1388+: JSON representation of all of the document's metadata. Field
1389+ values are transformed to the selected output format.
18391390
1840−${if(foo)}
1841− ${foo}
1842−${endif}
1391+[^subtitle]: To make `subtitle` work with other LaTeX
1392+ document classes, you can add the following to `header-includes`:
18431393
1844−${if(foo)}
1845−${ foo.bar }
1846−${else}
1847−no foo!
1848−${endif}
1849−```
1394+ \providecommand{\subtitle}[1]{%
1395+ \usepackage{titling}
1396+ \posttitle{%
1397+ \par\large#1\end{center}}
1398+ }
18501399
1851−The keyword `elseif` may be used to simplify complex nested
1852−conditionals:
1400+Language variables
1401+------------------
18531402
1854−```
1855−$if(foo)$
1856−XXX
1857−$elseif(bar)$
1858−YYY
1859−$else$
1860−ZZZ
1861−$endif$
1862−```
1403+`lang`
1404+: identifies the main language of the document,
1405+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1406+ For some output formats, pandoc will convert it to an appropriate
1407+ format stored in the additional variables `babel-lang`,
1408+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1409+
1410+ Native pandoc Spans and Divs with the lang attribute
1411+ (value in BCP 47) can be used to switch the language in
1412+ that range. In LaTeX output, `babel-otherlangs` and
1413+ `polyglossia-otherlangs` variables will be generated
1414+ automatically based on the `lang` attributes of Spans
1415+ and Divs in the document.
18631416
1864−### For loops
1417+`dir`
1418+: the base direction of the document, either `rtl` (right-to-left)
1419+ or `ltr` (left-to-right).
18651420
1866−A for loop begins with `for(variable)` (enclosed in
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1868−delimiters.
1421+ For bidirectional documents, native pandoc `span`s and `div`s
1422+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1423+ override the base direction in some output formats.
1424+ This may not always be necessary if the final renderer
1425+ (e.g. the browser, when generating HTML) supports the
1426+ [Unicode Bidirectional Algorithm].
18691427
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.
1428+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1429+ is fully supported (use `--pdf-engine=xelatex`).
18771430
1878−Examples:
1431+[BCP 47]: https://tools.ietf.org/html/bcp47
1432+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
18791433
1880−```
1881−$for(foo)$$foo$$sep$, $endfor$
1434+Variables for slides
1435+--------------------
18821436
1883−$for(foo)$
1884− - $foo.last$, $foo.first$
1885−$endfor$
1437+Variables are available for [producing slide shows with pandoc],
1438+including all [reveal.js configuration options].
18861439
1887−${ for(foo.bar) }
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1889−${ endfor }
1440+`titlegraphic`
1441+: title graphic for Beamer documents
18901442
1891−$for(mymap)$
1892−$it.name$: $it.office$
1893−$endfor$
1894−```
1443+`logo`
1444+: logo for Beamer documents
18951445
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.
1446+`slidy-url`
1447+: base URL for Slidy documents (defaults to
1448+ `https://www.w3.org/Talks/Tools/Slidy2`)
18991449
1900−```
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1902−```
1450+`slideous-url`
1451+: base URL for Slideous documents (defaults to `slideous`)
19031452
1904−Instead of using `variable` inside the loop, the special
1905−anaphoric keyword `it` may be used.
1453+`s5-url`
1454+: base URL for S5 documents (defaults to `s5/default`)
19061455
1907−```
1908−${ for(foo.bar) }
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1456+`revealjs-url`
1457+: base URL for reveal.js documents (defaults to `reveal.js`)
19121458
1913−### Partials
1459+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1460+: themes for LaTeX [`beamer`] documents
19141461
1915−Partials (subtemplates stored in different files) may be
1916−included by using the name of the partial, followed
1917−by `()`, for example:
1462+`themeoptions`
1463+: options for LaTeX beamer themes (a list).
19181464
1919−```
1920−${ styles() }
1921−```
1465+`navigation`
1466+: controls navigation symbols in `beamer` documents
1467+ (default is `empty` for no navigation symbols; other valid values
1468+ are `frame`, `vertical`, and `horizontal`).
19221469
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:
1470+`section-titles`
1471+: enables on "title pages" for new sections in `beamer`
1472+ documents (default = true).
19281473
1929−```
1930−${ styles.html() }
1931−```
1474+`beamerarticle`
1475+: when true, the `beamerarticle` package is loaded (for
1476+ producing an article from beamer slides).
19321477
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.)
1478+`aspectratio`
1479+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,
1480+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the
1481+ default, and `32` for 3:2).
19371482
1938−Partials may optionally be applied to variables using
1939−a colon:
1483+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
19401484
1941−```
1942−${ date:fancy() }
1485+Variables for LaTeX
1486+-------------------
19431487
1944−${ articles:bibentry() }
1945−```
1488+LaTeX variables are used when [creating a PDF].
19461489
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
1490+`papersize`
1491+: paper size, e.g. `letter`, `a4`
19501492
1951−```
1952−${ for(articles) }
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1493+`fontsize`
1494+: font size for body text (e.g. `10pt`, `12pt`)
19561495
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`.
1496+`documentclass`
1497+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]
19611498
1962−Final newlines are omitted from included partials.
1499+`classoption`
1500+: option for document class, e.g. `oneside`; may be repeated
1501+ for multiple options
19631502
1964−Partials may include other partials.
1503+`beameroption`
1504+: In beamer, add extra beamer option with `\setbeameroption{}`
19651505
1966−A separator between values of an array may be specified
1967−in square brackets, immediately after the variable name
1968−or partial:
1506+`geometry`
1507+: option for [`geometry`] package, e.g. `margin=1in`;
1508+ may be repeated for multiple options
19691509
1970−```
1971−${months[, ]}$
1510+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1511+: sets margins, if `geometry` is not used (otherwise `geometry`
1512+ overrides these)
19721513
1973−${articles:bibentry()[; ]$
1974−```
1514+`linestretch`
1515+: adjusts line spacing using the [`setspace`]
1516+ package, e.g. `1.25`, `1.5`
19751517
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.
1518+`fontfamily`
1519+: font package for use with `pdflatex`:
1520+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1521+ The default is [Latin Modern][`lm`].
19791522
1980−### Nesting
1523+`fontfamilyoptions`
1524+: options for package used as `fontfamily`: e.g. `osf,sc` with
1525+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1526+ figures and true small caps; may be repeated for multiple options
19811527
1982−To ensure that content is "nested," that is, subsequent lines
1983−indented, use the `^` directive:
1528+`mainfont`, `romanfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1529+: font families for use with `xelatex` or
1530+ `lualatex`: take the name of any system font, using the
1531+ [`fontspec`] package. Note that if `CJKmainfont` is used,
1532+ the [`xecjk`] package must be available.
19841533
1985−```
1986−$item.number$ $^$$item.description$ ($item.price$)
1987−```
1534+`mainfontoptions`, `romanfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1535+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1536+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1537+ available through [`fontspec`], such as the OpenType features
1538+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
19881539
1989−In this example, if `item.description` has multiple lines,
1990−they will all be indented to line up with the first line:
1540+`fontenc`
1541+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1542+ default is `T1` (see guide to [LaTeX font encodings])
19911543
1992−```
1993−00123 A fine bottle of 18-year old
1994− Oban whiskey. ($148)
1995−```
1544+`microtypeoptions`
1545+: options to pass to the microtype package
19961546
1997−To nest multiple lines to the same level, align them
1998−with the `^` directive in the template. For example:
1547+`colorlinks`
1548+: add color to link text; automatically enabled if any of
1549+ `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
19991550
2000−```
2001−$item.number$ $^$$item.description$ ($item.price$)
2002− (Available til $item.sellby$.)
2003−```
1551+`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
1552+: color for internal links, external links, citation links, linked
1553+ URLs, and links in table of contents, respectively: uses options
1554+ allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
1555+ `x11names` lists
20041556
2005−will produce
1557+`links-as-notes`
1558+: causes links to be printed as footnotes
20061559
2007−```
2008−00123 A fine bottle of 18-year old
2009− Oban whiskey. ($148)
2010− (Available til March 30, 2020.)
2011−```
1560+`indent`
1561+: uses document class settings for indentation (the default LaTeX template
1562+ otherwise removes indentation and adds space between paragraphs)
20121563
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.
1564+`subparagraph`
1565+: disables default behavior of LaTeX template that redefines (sub)paragraphs
1566+ as sections, changing the appearance of nested headings in some classes
20171567
2018−### Breakable spaces
1568+`thanks`
1569+: specifies contents of acknowledgments footnote after document title.
20191570
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 `~`).
1571+`toc`
1572+: include table of contents (can also be set using `--toc/--table-of-contents`)
20241573
2025−```
2026−$~$This long line may break if the document is rendered
2027−with a short line length.$~$
2028−```
1574+`toc-depth`
1575+: level of section to include in table of contents
20291576
2030−### Pipes
1577+`secnumdepth`
1578+: numbering depth for sections, if sections are numbered
20311579
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:
1580+`lof`, `lot`
1581+: include list of figures, list of tables
20351582
2036−```
2037−$for(name)$
2038−$name/uppercase$
2039−$endfor$
1583+`bibliography`
1584+: bibliography to use for resolving references
20401585
2041−$for(metadata/pairs)$
2042−- $it.key$: $it.value$
2043−$endfor$
1586+`biblio-style`
1587+: bibliography style, when used with `--natbib` and `--biblatex`.
20441588
2045−$employee:name()/uppercase$
2046−```
1589+`biblio-title`
1590+: bibliography title, when used with `--natbib` and `--biblatex`.
20471591
2048−Pipes may be chained:
1592+`biblatexoptions`
1593+: list of options for biblatex.
20491594
2050−```
2051−$for(employees/pairs)$
2052−$it.key/alpha/uppercase$. $it.name$
2053−$endfor$
2054−```
1595+`natbiboptions`
1596+: list of options for natbib.
20551597
2056−Some pipes take parameters:
1598+`pagestyle`
1599+: An option for LaTeX's `\pagestyle{}`. The default article class
1600+ supports 'plain' (default), 'empty', and 'headings'; headings puts
1601+ section titles in the header.
20571602
2058−```
2059−|----------------------|------------|
2060−$for(employee)$
2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062−$endfor$
2063−|----------------------|------------|
2064−```
1603+[`article`]: https://ctan.org/pkg/article
1604+[`report`]: https://ctan.org/pkg/report
1605+[`book`]: https://ctan.org/pkg/book
1606+[KOMA-Script]: https://ctan.org/pkg/koma-script
1607+[`memoir`]: https://ctan.org/pkg/memoir
1608+[`xcolor`]: https://ctan.org/pkg/xcolor
1609+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1610+[`mathpazo`]: https://ctan.org/pkg/mathpazo
1611+[LaTeX font encodings]: https://ctan.org/pkg/encguide
20651612
2066−Currently the following pipes are predefined:
1613+Variables for ConTeXt
1614+---------------------
20671615
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.
1616+`papersize`
1617+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
1618+ may be repeated for multiple options
20721619
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.
1620+`layout`
1621+: options for page margins and text arrangement (see [ConTeXt Layout]);
1622+ may be repeated for multiple options
22801623
22811624`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`
1625+: sets margins, if `layout` is not used (otherwise `layout`
24641626 overrides these)
24651627
2466−`pagestyle`
2467−: control `\pagestyle{}`: the default article class
2468− supports `plain` (default), `empty` (no running heads or page numbers),
2469− and `headings` (section titles in running heads)
2470−
2471−`papersize`
2472−: paper size, e.g. `letter`, `a4`
2473−
2474−`secnumdepth`
2475−: numbering depth for sections (with `--number-sections` option
2476− or `numbersections` variable)
2477−
2478−#### Fonts
2479−
2480−`fontenc`
2481−: allows font encoding to be specified through `fontenc` package (with
2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2483−
2484−`fontfamily`
2485−: font package for use with `pdflatex`:
2486− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
2487− The default is [Latin Modern][`lm`].
2488−
2489−`fontfamilyoptions`
2490−: options for package used as `fontfamily`; repeat for multiple options.
2491− For example, to use the Libertine font with proportional lowercase
2492− (old-style) figures through the [`libertinus`] package:
2493−
2494− ---
2495− fontfamily: libertinus
2496− fontfamilyoptions:
2497− - osf
2498− - p
2499− ...
2500−
2501−`fontsize`
2502−: font size for body text. The standard classes allow 10pt, 11pt, and
2503− 12pt. To use another size, set `documentclass` to one of
2504− the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
2505−
2506−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2507−: font families for use with `xelatex` or
2508− `lualatex`: take the name of any system font, using the
2509− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.
2510−
2511−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2512−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2513− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
2514− choices available through [`fontspec`]; repeat for multiple
2515− options. For example, to use the [TeX Gyre] version of
2516− Palatino with lowercase figures:
2517−
2518− ---
2519− mainfont: TeX Gyre Pagella
2520− mainfontoptions:
2521− - Numbers=Lowercase
2522− - Numbers=Proportional
2523− ...
2524−
2525−`microtypeoptions`
2526−: options to pass to the microtype package
2527−
2528−#### Links
2529−
2530−`colorlinks`
2531−: add color to link text; automatically enabled if any of
2532− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set
2533−
2534−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`
2535−: color for internal links, external links, citation links, linked
2536− URLs, and links in table of contents, respectively: uses options
2537− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and
2538− `x11names` lists
2539−
2540−`links-as-notes`
2541−: causes links to be printed as footnotes
2542−
2543−#### Front matter
2544−
2545−`lof`, `lot`
2546−: include list of figures, list of tables
2547−
2548−`thanks`
2549−: contents of acknowledgments footnote after document title
2550−
2551−`toc`
2552−: include table of contents (can also be set using
2553− `--toc/--table-of-contents`)
2554−
2555−`toc-depth`
2556−: level of section to include in table of contents
2557−
2558−#### BibLaTeX Bibliographies
2559−
2560−These variables function when using BibLaTeX for [citation rendering].
2561−
2562−`biblatexoptions`
2563−: list of options for biblatex
2564−
2565−`biblio-style`
2566−: bibliography style, when used with `--natbib` and `--biblatex`.
2567−
2568−`biblio-title`
2569−: bibliography title, when used with `--natbib` and `--biblatex`.
2570−
2571−`bibliography`
2572−: bibliography to use for resolving references
2573−
2574−`natbiboptions`
2575−: list of options for natbib
2576−
2577−[KOMA-Script]: https://ctan.org/pkg/koma-script
2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2579−[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2580−[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2581−[`article`]: https://ctan.org/pkg/article
2582−[`book`]: https://ctan.org/pkg/book
2583−[`libertinus`]: https://ctan.org/pkg/libertinus
2584−[`memoir`]: https://ctan.org/pkg/memoir
2585−[`report`]: https://ctan.org/pkg/report
2586−
2587−### Variables for ConTeXt
2588−
2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.
2590−
25911628`fontsize`
25921629: font size for body text (e.g. `10pt`, `12pt`)
25931630
2594−`headertext`, `footertext`
2595−: text to be placed in running header or footer (see [ConTeXt Headers and
2596− Footers]); repeat up to four times for different placement
2597−
2598−`indenting`
2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600− [ConTeXt Indentation]); repeat for multiple options
2601−
2602−`interlinespace`
2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2604− repeat for multiple options
2605−
2606−`layout`
2607−: options for page margins and text arrangement (see [ConTeXt Layout]);
2608− repeat for multiple options
1631+`mainfont`, `sansfont`, `monofont`, `mathfont`
1632+: font families: take the name of any system font (see [ConTeXt Font Switching])
26091633
26101634`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
1635+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
26131636
26141637`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
1638+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
26171639
2618−`lof`, `lot`
2619−: include list of figures, list of tables
1640+`indenting`
1641+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1642+ may be repeated for multiple options
26201643
2621−`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
1644+`whitespace`
1645+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
26241646
2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626−: sets margins, if `layout` is not used (otherwise `layout`
2627− overrides these)
1647+`interlinespace`
1648+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
1649+ may be repeated for multiple options
1650+
1651+`headertext`, `footertext`
1652+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1653+ may be repeated up to four times for different placement
26281654
26291655`pagenumbering`
26301656: page number style and location (using [`setuppagenumbering`]);
2631− repeat for multiple options
2632−
2633−`papersize`
2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2635− repeat for multiple options
2636−
2637−`pdfa`
2638−: adds to the preamble the setup necessary to generate PDF/A
2639− of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640− specified (i.e. the value is set to True, by e.g.
2641− `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642− `1b:2005` will be used as default, for reasons of backwards
2643− compatibility. Using `--variable=pdfa` without specified value
2644− is not supported. To successfully generate PDF/A the required
2645− ICC color profiles have to be available and the content and all
2646− included files (such as images) have to be standard conforming.
2647− The ICC profiles and output intent may be specified using the
2648− variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649− PDFA] for more details.
2650−
2651−`pdfaiccprofile`
2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654− used as default. May be repeated to include multiple profiles. Note that
2655− the profiles have to be available on the system. They can be obtained
2656− from [ConTeXt ICC Profiles].
2657−
2658−`pdfaintent`
2659−: when used in conjunction with `pdfa`, specifies the output intent for
2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`
2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.
1657+ may be repeated for multiple options
26621658
26631659`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
1660+: include table of contents (can also be set using `--toc/--table-of-contents`)
26661661
2667−`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
1662+`lof`, `lot`
1663+: include list of figures, list of tables
26701664
2671−`includesource`
2672−: include all source documents as file attachments in the PDF file
1665+`pdfa`
1666+: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
1667+ To successfully generate PDF/A the required ICC color profiles have to
1668+ be available and the content and all included files (such as images)
1669+ have to be standard conforming. The ICC profiles can be obtained
1670+ from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
1671+ details.
26731672
26741673[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
26751674[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
@@ -2683,39 +1682,33 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
26831682[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
26841683[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
26851684
2686−### Variables for `wkhtmltopdf`
1685+Variables for man pages
1686+-----------------------
26871687
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
1688+`section`
1689+: section number in man pages
26961690
2697−`papersize`
2698−: sets the PDF paper size
1691+`header`
1692+: header in man pages
26991693
2700−### Variables for man pages
1694+`footer`
1695+: footer in man pages
27011696
27021697`adjusting`
27031698: adjusts text to left (`l`), right (`r`), center (`c`),
27041699 or both (`b`) margins
27051700
2706−`footer`
2707−: footer in man pages
2708−
2709−`header`
2710−: header in man pages
2711−
27121701`hyphenate`
27131702: if `true` (the default), hyphenation will be used
27141703
2715−`section`
2716−: section number in man pages
1704+Variables for ms
1705+----------------
1706+
1707+`pointsize`
1708+: point size (e.g. `10p`)
27171709
2718−### Variables for ms
1710+`lineheight`
1711+: line height (e.g. `12p`)
27191712
27201713`fontfamily`
27211714: font family (e.g. `T` or `P`)
@@ -2723,81 +1716,75 @@ The `--css` option also affects the output.
27231716`indent`
27241717: paragraph indent (e.g. `2m`)
27251718
2726−`lineheight`
2727−: line height (e.g. `12p`)
1719+Using variables in templates
1720+----------------------------
27281721
2729−`pointsize`
2730−: point size (e.g. `10p`)
1722+Variable names are sequences of alphanumerics, `-`, and `_`,
1723+starting with a letter. A variable name surrounded by `$` signs
1724+will be replaced by its value. For example, the string `$title$` in
27311725
2732−### Variables set automatically
1726+ <title>$title$</title>
27331727
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:
1728+will be replaced by the document title.
27371729
2738−`body`
2739−: body of document
1730+To write a literal `$` in a template, use `$$`.
27401731
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`).
1732+Templates may contain conditionals. The syntax is as follows:
27501733
2751−`header-includes`
2752−: contents specified by `-H/--include-in-header` (may have multiple
2753− values)
1734+ $if(variable)$
1735+ X
1736+ $else$
1737+ Y
1738+ $endif$
27541739
2755−`include-before`
2756−: contents specified by `-B/--include-before-body` (may have
2757− multiple values)
1740+This will include `X` in the template if `variable` has a truthy
1741+value; otherwise it will include `Y`. Here a truthy value is any
1742+of the following:
27581743
2759−`include-after`
2760−: contents specified by `-A/--include-after-body` (may have
2761− multiple values)
1744+- a string that is not entirely white space,
1745+- a non-empty array where the first value is truthy,
1746+- any number (including zero),
1747+- any object,
1748+- the boolean `true` (to specify the boolean `true`
1749+ value using YAML metadata or the `--metadata` flag,
1750+ use `true`, `True`, or `TRUE`; with the `--variable`
1751+ flag, simply omit a value for the variable, e.g.
1752+ `--variable draft`).
27621753
2763−`meta-json`
2764−: JSON representation of all of the document's metadata. Field
2765− values are transformed to the selected output format.
1754+`X` and `Y` are placeholders for any valid template text,
1755+and may include interpolated variables or other conditionals.
1756+The `$else$` section may be omitted.
27661757
2767−`numbersections`
2768−: non-null value if `-N/--number-sections` was specified
1758+When variables can have multiple values (for example, `author` in
1759+a multi-author document), you can use the `$for$` keyword:
27691760
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:
1761+ $for(author)$
1762+ <meta name="author" content="$author$" />
1763+ $endfor$
27751764
2776− $if(sourcefile)$
2777− $for(sourcefile)$
2778− $sourcefile$
2779− $endfor$
2780− $else$
2781− (stdin)
2782− $endif$
1765+You can optionally specify a separator to be used between
1766+consecutive items:
27831767
2784− Similarly, `outputfile` can be `-` if output goes to the terminal.
1768+ $for(author)$$author$$sep$, $endfor$
27851769
2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
1770+A dot can be used to select a field of a variable that takes
1771+an object as its value. So, for example:
27871772
2788−`curdir`
2789−: working directory from which pandoc is run.
1773+ $author.name$ ($author.affiliation$)
27901774
2791−`toc`
2792−: non-null value if `--toc/--table-of-contents` was specified
1775+If you use custom templates, you may need to revise them as pandoc
1776+changes. We recommend tracking the changes in the default templates,
1777+and modifying your custom templates accordingly. An easy way to do this
1778+is to fork the [pandoc-templates] repository and merge in changes after each
1779+pandoc release.
27931780
2794−`toc-title`
2795−: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
1781+Templates may contain comments: anything on a line after `$--`
1782+will be treated as a comment and ignored.
27971783
27981784[pandoc-templates]: https://github.com/jgm/pandoc-templates
27991785
2800−# Extensions
1786+Extensions
1787+==========
28011788
28021789The behavior of some of the readers and writers can be adjusted by
28031790enabling or disabling various extensions.
@@ -2814,11 +1801,8 @@ section [Pandoc's Markdown] below (See [Markdown variants] for
28141801`commonmark` and `gfm`.) In the following, extensions that also work
28151802for other formats are covered.
28161803
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
1804+Typography
1805+----------
28221806
28231807#### Extension: `smart` ####
28241808
@@ -2850,12 +1834,13 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
28501834to use the ligatures when possible; if `smart` is disabled
28511835pandoc will use unicode quotation mark and dash characters.
28521836
2853−## Headings and sections
1837+Headers and sections
1838+--------------------
28541839
28551840#### Extension: `auto_identifiers` ####
28561841
2857−A heading without an explicitly specified identifier will be
2858−automatically assigned a unique identifier based on the heading text.
1842+A header without an explicitly specified identifier will be
1843+automatically assigned a unique identifier based on the header text.
28591844
28601845This extension can be enabled/disabled for the following formats:
28611846
@@ -2868,13 +1853,11 @@ output formats
28681853enabled by default in
28691854: `markdown`, `muse`
28701855
2871−The default algorithm used to derive the identifier from the
2872−heading text is:
1856+The algorithm used to derive the identifier from the header text is:
28731857
28741858 - Remove all formatting, links, etc.
28751859 - Remove all footnotes.
2876− - Remove all non-alphanumeric characters,
2877− except underscores, hyphens, and periods.
1860+ - Remove all punctuation, except underscores, hyphens, and periods.
28781861 - Replace all spaces and newlines with hyphens.
28791862 - Convert all alphabetic characters to lowercase.
28801863 - Remove everything up to the first letter (identifiers may
@@ -2883,31 +1866,27 @@ heading text is:
28831866
28841867Thus, for example,
28851868
2886− Heading Identifier
1869+ Header Identifier
28871870 ------------------------------- ----------------------------
2888− `Heading identifiers in HTML` `heading-identifiers-in-html`
2889− `Maître d'hôtel` `maître-dhôtel`
1871+ `Header identifiers in HTML` `header-identifiers-in-html`
28901872 `*Dogs*?--in *my* house?` `dogs--in-my-house`
28911873 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
28921874 `3. Applications` `applications`
28931875 `33` `section`
28941876
28951877These rules should, in most cases, allow one to determine the identifier
2896−from the heading text. The exception is when several headings have the
1878+from the header text. The exception is when several headers have the
28971879same text; in this case, the first will get an identifier as described
28981880above; the second will get the same identifier with `-1` appended; the
28991881third with `-2`; and so on.
29001882
2901−(However, a different algorithm is used if
2902−`gfm_auto_identifiers` is enabled; see below.)
2903−
29041883These identifiers are used to provide link targets in the table of
29051884contents generated by the `--toc|--table-of-contents` option. They
29061885also make it easy to provide links from one section of a document to
29071886another. A link to this section, for example, might look like this:
29081887
29091888 See the section on
2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).
1889+ [header identifiers](#header-identifiers-in-html-latex-and-context).
29111890
29121891Note, however, that this method of providing links to sections works
29131892only in HTML, LaTeX, and ConTeXt formats.
@@ -2915,7 +1894,7 @@ only in HTML, LaTeX, and ConTeXt formats.
29151894If the `--section-divs` option is specified, then each section will
29161895be wrapped in a `section` (or a `div`, if `html4` was specified),
29171896and the identifier will be attached to the enclosing `<section>`
2918−(or `<div>`) tag rather than the heading itself. This allows entire
1897+(or `<div>`) tag rather than the header itself. This allows entire
29191898sections to be manipulated using JavaScript or treated differently in
29201899CSS.
29211900
@@ -2925,15 +1904,8 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
29251904Accents are stripped off of accented Latin letters, and non-Latin
29261905letters are omitted.
29271906
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
1907+Math Input
1908+----------
29371909
29381910The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
29391911[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2943,47 +1915,51 @@ are described in the section about Pandoc's Markdown.
29431915However, they can also be used with HTML input. This is handy for
29441916reading web pages formatted using MathJax, for example.
29451917
2946−## Raw HTML/TeX
1918+Raw HTML/TeX
1919+------------
29471920
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
1921+The following extensions (especially how they affect Markdown
1922+input/output) are also described in more detail in their respective
1923+sections of [Pandoc's Markdown].
29501924
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.
1925+#### [Extension: `raw_html`] {#raw_html}
29541926
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`):
1927+When converting from HTML, parse elements to raw HTML which are not
1928+representable in pandoc's AST.
1929+By default, this is disabled for HTML input.
29581930
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
1931+#### [Extension: `raw_tex`] {#raw_tex}
29621932
2963− output formats
2964− : `textile`, `commonmark`
1933+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
29651934
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`.
1935+This extension can be enabled/disabled for the following formats
1936+(in addition to `markdown`):
29731937
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`.
1938+input formats
1939+: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
1940+ `\eqref` only)
29781941
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`.
1942+output formats
1943+: `textile`, `commonmark`
1944+
1945+#### [Extension: `native_divs`] {#native_divs}
1946+
1947+This extension is enabled by default for HTML input. This means that
1948+`div`s are parsed to pandoc native elements. (Alternatively, you
1949+can parse them to raw HTML using `-f html-native_divs+raw_html`.)
1950+
1951+When converting HTML to Markdown, for example, you may want to drop all
1952+`div`s and `span`s:
1953+
1954+ pandoc -f html-native_divs-native_spans -t markdown
1955+
1956+#### [Extension: `native_spans`] {#native_spans}
29851957
2986−## Literate Haskell support
1958+Analogous to `native_divs` above.
1959+
1960+
1961+Literate Haskell support
1962+------------------------
29871963
29881964#### Extension: `literate_haskell` ####
29891965
@@ -3004,12 +1980,12 @@ This means that
30041980 - In Markdown input, "bird track" sections will be parsed as Haskell
30051981 code rather than block quotations. Text between `\begin{code}`
30061982 and `\end{code}` will also be treated as Haskell code. For
3007− ATX-style headings the character '=' will be used instead of '#'.
1983+ ATX-style headers the character '=' will be used instead of '#'.
30081984
30091985 - In Markdown output, code blocks with classes `haskell` and `literate`
30101986 will be rendered using bird tracks, and block quotations will be
30111987 indented one space, so they will not be treated as Haskell code.
3012− In addition, headings will be rendered setext-style (with underlines)
1988+ In addition, headers will be rendered setext-style (with underlines)
30131989 rather than ATX-style (with '#' characters). (This is because ghc
30141990 treats '#' characters in column 1 as introducing line numbers.)
30151991
@@ -3044,7 +2020,8 @@ Note that GHC expects the bird tracks in the first column, so indented
30442020literate code blocks (e.g. inside an itemized environment) will not be
30452021picked up by the Haskell compiler.
30462022
3047−## Other extensions
2023+Other extensions
2024+----------------
30482025
30492026#### Extension: `empty_paragraphs` ####
30502027
@@ -3059,60 +2036,12 @@ input formats
30592036output formats
30602037: `docx`, `odt`, `opendocument`, `html`
30612038
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−
31092039#### Extension: `styles` #### {#ext-styles}
31102040
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.
2041+Read all docx styles as divs (for paragraph styles) and spans (for
2042+character styles) regardless of whether pandoc understands the meaning
2043+of these styles. This can be used with [docx custom
2044+styles](#custom-styles-in-docx). Disabled by default.
31162045
31172046input formats
31182047: `docx`
@@ -3122,36 +2051,22 @@ input formats
31222051In the `muse` input format, this enables Text::Amuse
31232052extensions to Emacs Muse markup.
31242053
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−
31332054#### Extension: `citations` {#org-citations}
31342055
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.
2056+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2057+in `org` input.
31442058
31452059#### Extension: `ntb` ####
31462060
31472061In the `context` output format this enables the use of [Natural Tables
3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2062+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2063+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
31502064Natural tables allow more fine-grained global customization but come
31512065at a performance penalty compared to extreme tables.
31522066
31532067
3154−# Pandoc's Markdown
2068+Pandoc's Markdown
2069+=================
31552070
31562071Pandoc understands an extended and slightly revised version of
31572072John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -3161,7 +2076,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the
31612076behavior more granularly. They are described in the following. See also
31622077[Extensions] above, for extensions that work also on other formats.
31632078
3164−## Philosophy
2079+Philosophy
2080+----------
31652081
31662082Markdown is designed to be easy to write, and, even more importantly,
31672083easy to read:
@@ -3169,7 +2085,7 @@ easy to read:
31692085> A Markdown-formatted document should be publishable as-is, as plain
31702086> text, without looking like it's been marked up with tags or formatting
31712087> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2088+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
31732089
31742090This principle has guided pandoc's decisions in finding syntax for
31752091tables, footnotes, and other extensions.
@@ -3182,7 +2098,8 @@ it discourages it, and provides other, non-HTMLish ways of representing
31822098important document elements like definition lists, tables, mathematics, and
31832099footnotes.
31842100
3185−## Paragraphs
2101+Paragraphs
2102+----------
31862103
31872104A paragraph is one or more lines of text followed by one or more blank lines.
31882105Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -3195,42 +2112,43 @@ Note: in multiline and grid table cells, this is the only way
31952112to create a hard line break, since trailing spaces in the cells
31962113are ignored.
31972114
3198−## Headings
2115+Headers
2116+-------
31992117
3200−There are two kinds of headings: Setext and ATX.
2118+There are two kinds of headers: Setext and ATX.
32012119
3202−### Setext-style headings ###
2120+### Setext-style headers ###
32032121
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):
2122+A setext-style header is a line of text "underlined" with a row of `=` signs
2123+(for a level one header) or `-` signs (for a level two header):
32062124
3207− A level-one heading
3208− ===================
2125+ A level-one header
2126+ ==================
32092127
3210− A level-two heading
3211− -------------------
2128+ A level-two header
2129+ ------------------
32122130
3213−The heading text can contain inline formatting, such as emphasis (see
2131+The header text can contain inline formatting, such as emphasis (see
32142132[Inline formatting], below).
32152133
32162134
3217−### ATX-style headings ###
2135+### ATX-style headers ###
32182136
3219−An ATX-style heading consists of one to six `#` signs and a line of
2137+An ATX-style header consists of one to six `#` signs and a line of
32202138text, optionally followed by any number of `#` signs. The number of
3221−`#` signs at the beginning of the line is the heading level:
2139+`#` signs at the beginning of the line is the header level:
32222140
3223− ## A level-two heading
2141+ ## A level-two header
32242142
3225− ### A level-three heading ###
2143+ ### A level-three header ###
32262144
3227−As with setext-style headings, the heading text can contain formatting:
2145+As with setext-style headers, the header text can contain formatting:
32282146
3229− # A level-one heading with a [link](/url) and *emphasis*
2147+ # A level-one header with a [link](/url) and *emphasis*
32302148
32312149#### Extension: `blank_before_header` ####
32322150
3233−Standard Markdown syntax does not require a blank line before a heading.
2151+Standard Markdown syntax does not require a blank line before a header.
32342152Pandoc does require this (except, of course, at the beginning of the
32352153document). The reason for the requirement is that it is all too easy for a
32362154`#` to end up at the beginning of a line by accident (perhaps through line
@@ -3242,30 +2160,29 @@ wrapping). Consider, for example:
32422160#### Extension: `space_in_atx_header` ####
32432161
32442162Many Markdown implementations do not require a space between the
3245−opening `#`s of an ATX heading and the heading text, so that
3246−`#5 bolt` and `#hashtag` count as headings. With this extension,
2163+opening `#`s of an ATX header and the header text, so that
2164+`#5 bolt` and `#hashtag` count as headers. With this extension,
32472165pandoc does require the space.
32482166
3249−### Heading identifiers ###
2167+### Header identifiers ###
32502168
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
2169+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
32532170
32542171#### Extension: `header_attributes` ####
32552172
3256−Headings can be assigned attributes using this syntax at the end
3257−of the line containing the heading text:
2173+Headers can be assigned attributes using this syntax at the end
2174+of the line containing the header text:
32582175
32592176 {#identifier .class .class key=value key=value}
32602177
3261−Thus, for example, the following headings will all be assigned the identifier
2178+Thus, for example, the following headers will all be assigned the identifier
32622179`foo`:
32632180
3264− # My heading {#foo}
2181+ # My header {#foo}
32652182
3266− ## My heading ## {#foo}
2183+ ## My header ## {#foo}
32672184
3268− My other heading {#foo}
2185+ My other header {#foo}
32692186 ---------------
32702187
32712188(This syntax is compatible with [PHP Markdown Extra].)
@@ -3274,56 +2191,51 @@ Note that although this syntax allows assignment of classes and key/value
32742191attributes, writers generally don't use all of this information. Identifiers,
32752192classes, and key/value attributes are used in HTML and HTML-based formats such
32762193as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
2194+LaTeX, ConTeXt, Textile, and AsciiDoc writers.
32782195
3279−Headings with the class `unnumbered` will not be numbered, even if
2196+Headers with the class `unnumbered` will not be numbered, even if
32802197`--number-sections` is specified. A single hyphen (`-`) in an attribute
32812198context is equivalent to `.unnumbered`, and preferable in non-English
32822199documents. So,
32832200
3284− # My heading {-}
2201+ # My header {-}
32852202
32862203is just the same as
32872204
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.)
2205+ # My header {.unnumbered}
32942206
32952207#### Extension: `implicit_header_references` ####
32962208
3297−Pandoc behaves as if reference links have been defined for each heading.
3298−So, to link to a heading
2209+Pandoc behaves as if reference links have been defined for each header.
2210+So, to link to a header
32992211
3300− # Heading identifiers in HTML
2212+ # Header identifiers in HTML
33012213
33022214you can simply write
33032215
3304− [Heading identifiers in HTML]
2216+ [Header identifiers in HTML]
33052217
33062218or
33072219
3308− [Heading identifiers in HTML][]
2220+ [Header identifiers in HTML][]
33092221
33102222or
33112223
3312− [the section on heading identifiers][heading identifiers in
2224+ [the section on header identifiers][header identifiers in
33132225 HTML]
33142226
33152227instead of giving the identifier explicitly:
33162228
3317− [Heading identifiers in HTML](#heading-identifiers-in-html)
2229+ [Header identifiers in HTML](#header-identifiers-in-html)
33182230
3319−If there are multiple headings with identical text, the corresponding
2231+If there are multiple headers with identical text, the corresponding
33202232reference will link to the first one only, and you will need to use explicit
33212233links to link to the others, as described above.
33222234
33232235Like regular reference links, these references are case-insensitive.
33242236
33252237Explicit link reference definitions always take priority over
3326−implicit heading references. So, in the following example, the
2238+implicit header references. So, in the following example, the
33272239link will point to `bar`, not to `#foo`:
33282240
33292241 # Foo
@@ -3332,11 +2244,12 @@ link will point to `bar`, not to `#foo`:
33322244
33332245 See [foo]
33342246
3335−## Block quotations
2247+Block quotations
2248+----------------
33362249
33372250Markdown uses email conventions for quoting blocks of text.
33382251A block quotation is one or more paragraphs or other block elements
3339−(such as lists or headings), with each line preceded by a `>` character
2252+(such as lists or headers), with each line preceded by a `>` character
33402253and an optional space. (The `>` need not start at the left margin, but
33412254it should not be indented more than three spaces.)
33422255
@@ -3371,19 +2284,19 @@ block in a block quote, you need five spaces after the `>`:
33712284
33722285#### Extension: `blank_before_blockquote` ####
33732286
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
2287+Standard Markdown syntax does not require a blank line before a block
2288+quote. Pandoc does require this (except, of course, at the beginning of the
2289+document). The reason for the requirement is that it is all too easy for a
2290+`>` to end up at the beginning of a line by accident (perhaps through line
2291+wrapping). So, unless the `markdown_strict` format is used, the following does
33802292not produce a nested block quote in pandoc:
33812293
33822294 > This is a block quote.
33832295 >> Nested.
33842296
33852297
3386−## Verbatim (code) blocks
2298+Verbatim (code) blocks
2299+----------------------
33872300
33882301### Indented code blocks ###
33892302
@@ -3445,16 +2358,14 @@ this syntax:
34452358 qsort (filter (>= x) xs)
34462359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34472360
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:
2361+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2362+`startFrom` is an attribute with value `100`. Some output formats can use this
2363+information to do syntax highlighting. Currently, the only output formats
2364+that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2365+highlighting is supported for your output format and language, then the code
2366+block above will appear highlighted, with numbered lines. (To see which
2367+languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2368+the code block above will appear as follows:
34582369
34592370 <pre id="mycode" class="haskell numberLines" startFrom="100">
34602371 <code>
@@ -3491,7 +2402,8 @@ To set the highlighting style, use `--highlight-style`.
34912402For more information on highlighting, see [Syntax highlighting],
34922403below.
34932404
3494−## Line blocks
2405+Line blocks
2406+-----------
34952407
34962408#### Extension: `line_blocks` ####
34972409
@@ -3517,12 +2429,10 @@ line must begin with a space.
35172429 | 200 Main St.
35182430 | Berkeley, CA 94718
35192431
3520−Inline formatting (such as emphasis) is allowed in the content,
3521−but not block-level formatting (such as block quotes or lists).
3522−
35232432This syntax is borrowed from [reStructuredText].
35242433
3525−## Lists
2434+Lists
2435+-----
35262436
35272437### Bullet lists ###
35282438
@@ -3692,12 +2602,6 @@ If default list markers are desired, use `#.`:
36922602 #. two
36932603 #. three
36942604
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
37012605
37022606### Definition lists ###
37032607
@@ -3723,12 +2627,11 @@ a blank line, and must be followed by one or more definitions.
37232627A definition begins with a colon or tilde, which may be indented one
37242628or two spaces.
37252629
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
2630+A term may have multiple definitions, and each definition may consist of one or
2631+more block elements (paragraph, code block, list, etc.), each indented four
2632+spaces or one tab stop. The body of the definition (including the first line,
2633+aside from the colon or tilde) should be indented four spaces. However,
2634+as with other Markdown lists, you can "lazily" omit indentation except
37322635at the beginning of a paragraph or other block element:
37332636
37342637 Term 1
@@ -3754,10 +2657,9 @@ definition:
37542657Note that space between items in a definition list is required.
37552658(A variant that loosens this requirement, but disallows "lazy"
37562659hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2660+[Non-pandoc extensions], below.)
37582661
3759−[^3]: I have been influenced by the suggestions of [David
3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2662+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
37612663
37622664### Numbered example lists ###
37632665
@@ -3793,6 +2695,30 @@ list marker. That is, example lists always behave as if the
37932695labels tend to be long, and indenting content to the
37942696first non-space character after the label would be awkward.
37952697
2698+### Compact and loose lists ###
2699+
2700+Pandoc behaves differently from `Markdown.pl` on some "edge
2701+cases" involving lists. Consider this source:
2702+
2703+ + First
2704+ + Second:
2705+ - Fee
2706+ - Fie
2707+ - Foe
2708+
2709+ + Third
2710+
2711+Pandoc transforms this into a "compact list" (with no `<p>` tags around
2712+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2713+"Second" and "Third" (but not "First"), because of the blank space
2714+around "Third". Pandoc follows a simple rule: if the text is followed by
2715+a blank line, it is treated as a paragraph. Since "Second" is followed
2716+by a list, and not a blank line, it isn't treated as a paragraph. The
2717+fact that the list is followed by a blank line is irrelevant. (Note:
2718+Pandoc works this way even when the `markdown_strict` format is specified. This
2719+behavior is consistent with the official Markdown syntax description,
2720+even though it is different from that of `Markdown.pl`.)
2721+
37962722
37972723### Ending a list ###
37982724
@@ -3831,7 +2757,8 @@ of one big list:
38312757 2. dos
38322758 3. tres
38332759
3834−## Horizontal rules
2760+Horizontal rules
2761+----------------
38352762
38362763A line containing a row of three or more `*`, `-`, or `_` characters
38372764(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +2768,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
38412768 ---------------
38422769
38432770
3844−## Tables
2771+Tables
2772+------
38452773
38462774Four kinds of tables may be used. The first three kinds presuppose the use of
38472775a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3866,7 +2794,7 @@ Simple tables look like this:
38662794
38672795 Table: Demonstration of simple table syntax.
38682796
3869−The header and table rows must each fit on one line. Column
2797+The headers and table rows must each fit on one line. Column
38702798alignments are determined by the position of the header text relative
38712799to the dashed line below it:[^4]
38722800
@@ -3885,7 +2813,7 @@ to the dashed line below it:[^4]
38852813The table must end with a blank line, or a line of dashes followed by
38862814a blank line.
38872815
3888−The column header row may be omitted, provided a dashed line is used
2816+The column headers may be omitted, provided a dashed line is used
38892817to end the table. For example:
38902818
38912819 ------- ------ ---------- -------
@@ -3894,13 +2822,13 @@ to end the table. For example:
38942822 1 1 1 1
38952823 ------- ------ ---------- -------
38962824
3897−When the header row is omitted, column alignments are determined on the basis
2825+When headers are omitted, column alignments are determined on the basis
38982826of the first line of the table body. So, in the tables above, the columns
38992827would be right, left, center, and right aligned, respectively.
39002828
39012829#### Extension: `multiline_tables` ####
39022830
3903−Multiline tables allow header and table rows to span multiple lines
2831+Multiline tables allow headers and table rows to span multiple lines
39042832of text (but cells that span multiple columns or rows of the table are
39052833not supported). Here is an example:
39062834
@@ -3922,7 +2850,7 @@ not supported). Here is an example:
39222850These work like simple tables, but with the following differences:
39232851
39242852 - They must begin with a row of dashes, before the header text
3925− (unless the header row is omitted).
2853+ (unless the headers are omitted).
39262854 - They must end with a row of dashes, then a blank line.
39272855 - The rows must be separated by blank lines.
39282856
@@ -3931,7 +2859,7 @@ the columns, and the writers try to reproduce these relative widths in
39312859the output. So, if you find that one of the columns is too narrow in the
39322860output, try widening it in the Markdown source.
39332861
3934−The header may be omitted in multiline tables as well as simple tables:
2862+Headers may be omitted in multiline tables as well as simple tables:
39352863
39362864 ----------- ------- --------------- -------------------------
39372865 First row 12.0 Example of a row that
@@ -3942,7 +2870,7 @@ The header may be omitted in multiline tables as well as simple tables:
39422870 rows.
39432871 ----------- ------- --------------- -------------------------
39442872
3945− : Here's a multiline table without a header.
2873+ : Here's a multiline table without headers.
39462874
39472875It is possible for a multiline table to have just one row, but the row
39482876should be followed by a blank line (and then the row of dashes that ends
@@ -3968,8 +2896,9 @@ The row of `=`s separates the header from the table body, and can be
39682896omitted for a headerless table. The cells of grid tables may contain
39692897arbitrary block elements (multiple paragraphs, code blocks, lists,
39702898etc.). Cells that span multiple columns or rows are not
3971−supported. Grid tables can be created easily using Emacs' table-mode
3972−(`M-x table-insert`).
2899+supported. Grid tables can be created easily using [Emacs table mode].
2900+
2901+[Emacs table mode]: http://table.sourceforge.net/
39732902
39742903Alignments can be specified as with pipe tables, by putting
39752904colons at the boundaries of the separator line after the
@@ -3997,7 +2926,7 @@ and the same number of rows in each column. For example, the
39972926Docutils [sample grid tables] will not render as expected with
39982927Pandoc.
39992928
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2929+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
40012930
40022931
40032932#### Extension: `pipe_tables` ####
@@ -4030,7 +2959,7 @@ legal (though ugly) pipe table:
40302959
40312960The cells of pipe tables cannot contain block elements like paragraphs
40322961and lists, and cannot span multiple lines. If a pipe table contains a
4033−row whose Markdown content is wider than the column width (see
2962+row whose printable content is wider than the column width (see
40342963`--columns`), then the table will take up the full text width and
40352964the cell contents will wrap, with the relative cell widths determined
40362965by the number of dashes in the line separating the table header from
@@ -4054,7 +2983,8 @@ you'll need to add colons as above.
40542983
40552984[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
40562985
4057−## Metadata blocks
2986+Metadata blocks
2987+---------------
40582988
40592989#### Extension: `pandoc_title_block` ####
40602990
@@ -4070,42 +3000,30 @@ output.) The block may contain just a title, a title and an author,
40703000or all three elements. If you want to include an author but no
40713001title, or a title and a date but no author, you need a blank line:
40723002
4073−```
4074−%
4075−% Author
4076−```
3003+ %
3004+ % Author
40773005
4078−```
4079−% My title
4080−%
4081−% June 15, 2006
4082−```
3006+ % My title
3007+ %
3008+ % June 15, 2006
40833009
40843010The title may occupy multiple lines, but continuation lines must
40853011begin with leading space, thus:
40863012
4087−```
4088−% My title
4089− on multiple lines
4090−```
3013+ % My title
3014+ on multiple lines
40913015
40923016If a document has multiple authors, the authors may be put on
40933017separate lines with leading space, or separated by semicolons, or
40943018both. So, all of the following are equivalent:
40953019
4096−```
4097−% Author One
4098− Author Two
4099−```
3020+ % Author One
3021+ Author Two
41003022
4101−```
4102−% Author One; Author Two
4103−```
3023+ % Author One; Author Two
41043024
4105−```
4106−% Author One;
4107− Author Two
4108−```
3025+ % Author One;
3026+ Author Two
41093027
41103028The date must fit on one line.
41113029
@@ -4146,7 +3064,7 @@ will also have "Version 4.0" in the header.
41463064
41473065#### Extension: `yaml_metadata_block` ####
41483066
4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three
3067+A YAML metadata block is a valid YAML object, delimited by a line of three
41503068hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
41513069(`...`) at the bottom. A YAML metadata block may occur anywhere in the
41523070document, but if it is not at the beginning, it must be preceded by a blank
@@ -4169,22 +3087,20 @@ given a role by external processors.) Field names must not be
41693087interpretable as YAML numbers or boolean values (so, for
41703088example, `yes`, `True`, and `15` cannot be used as field names).
41713089
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.
3090+A document may contain multiple metadata blocks. The metadata fields will
3091+be combined through a *left-biased union*: if two metadata blocks attempt
3092+to set the same field, the value from the first block will be taken.
41753093
41763094When pandoc is used with `-t markdown` to create a Markdown document,
41773095a YAML metadata block will be produced only if the `-s/--standalone`
41783096option is used. All of the metadata will appear in a single block
41793097at the beginning of the document.
41803098
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:
3099+Note that YAML escaping rules must be followed. Thus, for example,
3100+if a title contains a colon, it must be quoted. The pipe character
3101+(`|`) can be used to begin an indented block that will be interpreted
3102+literally, without need for escaping. This form is necessary
3103+when the field contains blank lines or block-level formatting:
41883104
41893105 ---
41903106 title: 'This is the title: it contains a colon'
@@ -4198,12 +3114,6 @@ or block-level formatting:
41983114 It consists of two paragraphs.
41993115 ...
42003116
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−
42073117Template variables will be set automatically from the metadata. Thus, for
42083118example, in writing HTML, the variable `abstract` will be set to the HTML
42093119equivalent of the Markdown in the `abstract` field:
@@ -4250,25 +3160,8 @@ will be interpreted as markdown. For example:
42503160 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
42513161 ```
42523162
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
3163+Backslash escapes
3164+-----------------
42723165
42733166#### Extension: `all_symbols_escapable` ####
42743167
@@ -4294,12 +3187,9 @@ which allows only the following characters to be backslash-escaped:
42943187(However, if the `markdown_strict` format is used, the standard Markdown rule
42953188will be used.)
42963189
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).
3190+A backslash-escaped space is parsed as a nonbreaking space. It will
3191+appear in TeX output as `~` and in HTML and XML as `\ ` or
3192+`\ `.
43033193
43043194A backslash-escaped newline (i.e. a backslash occurring at the end of
43053195a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +3199,8 @@ two trailing spaces on a line.
43093199
43103200Backslash escapes do not work in verbatim contexts.
43113201
4312−## Inline formatting
3202+Inline formatting
3203+-----------------
43133204
43143205### Emphasis ###
43153206
@@ -4357,13 +3248,12 @@ text by `~` characters. Thus, for example,
43573248
43583249 H~2~O is a liquid. 2^10^ is 1024.
43593250
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~`.
3251+If the superscripted or subscripted text contains spaces, these spaces
3252+must be escaped with backslashes. (This is to prevent accidental
3253+superscripting and subscripting through the ordinary use of `~` and `^`.)
3254+Thus, if you want the letter P with 'a cat' in subscripts, use
3255+`P~a\ cat~`, not `P~a cat~`.
3256+
43673257
43683258### Verbatim ###
43693259
@@ -4412,7 +3302,8 @@ For compatibility with other Markdown flavors, CSS is also supported:
44123302This will work in all output formats that support small caps.
44133303
44143304
4415−## Math
3305+Math
3306+----
44163307
44173308#### Extension: `tex_math_dollars` ####
44183309
@@ -4424,10 +3315,6 @@ left, and must not be followed immediately by a digit. Thus,
44243315you need to enclose text in literal `$` characters, backslash-escape
44253316them and they won't be treated as math delimiters.
44263317
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−
44313318TeX math will be printed in all output formats. How it is rendered
44323319depends on the output format:
44333320
@@ -4439,23 +3326,16 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki
44393326 ~ It will appear verbatim surrounded by `$...$` (for inline
44403327 math) or `$$...$$` (for display math).
44413328
4442−XWiki
4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.
4444−
44453329reStructuredText
44463330 ~ It will be rendered using an [interpreted text role `:math:`].
44473331
44483332AsciiDoc
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.
3333+ ~ It will be rendered as `latexmath:[...]`.
44543334
44553335Texinfo
44563336 ~ It will be rendered inside a `@math` command.
44573337
4458−roff man, Jira markup
3338+roff man
44593339 ~ It will be rendered verbatim without `$`'s.
44603340
44613341MediaWiki, DokuWiki
@@ -4489,9 +3369,10 @@ HTML, Slidy, DZSlides, S5, EPUB
44893369 command-line options selected. Therefore see [Math rendering in HTML]
44903370 above.
44913371
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3372+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
44933373
4494−## Raw HTML
3374+Raw HTML
3375+--------
44953376
44963377#### Extension: `raw_html` ####
44973378
@@ -4505,9 +3386,6 @@ The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
45053386DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
45063387output, and suppressed in other formats.
45073388
4508−For a more explicit way of including raw HTML in a Markdown
4509−document, see the [`raw_attribute` extension][Extension: `raw_attribute`].
4510−
45113389In the CommonMark format, if `raw_html` is enabled, superscripts,
45123390subscripts, strikeouts and small capitals will be represented as HTML.
45133391Otherwise, plain-text fallbacks will be used. Note that even if
@@ -4529,7 +3407,7 @@ Thus, for example, pandoc will turn
45293407 <table>
45303408 <tr>
45313409 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3410+ <td>[a link](http://google.com)</td>
45333411 </tr>
45343412 </table>
45353413
@@ -4538,14 +3416,14 @@ into
45383416 <table>
45393417 <tr>
45403418 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3419+ <td><a href="http://google.com">a link</a></td>
45423420 </tr>
45433421 </table>
45443422
45453423whereas `Markdown.pl` will preserve it as is.
45463424
4547−There is one exception to this rule: text between `<script>`,
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3425+There is one exception to this rule: text between `<script>` and
3426+`<style>` tags is not interpreted as Markdown.
45493427
45503428This departure from standard Markdown should make it easier to mix
45513429Markdown with HTML block elements. For example, one can surround
@@ -4587,10 +3465,6 @@ Note that in LaTeX environments, like
45873465the material between the begin and end tags will be interpreted as raw
45883466LaTeX, not as Markdown.
45893467
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−
45943468Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
45953469Emacs Org mode, and ConTeXt.
45963470
@@ -4637,11 +3511,12 @@ example, to use a raw attribute with a backtick code block,
46373511
46383512The raw attribute cannot be combined with regular attributes.
46393513
4640−## LaTeX macros
3514+LaTeX macros
3515+------------
46413516
46423517#### Extension: `latex_macros` ####
46433518
4644−When this extension is enabled, pandoc will parse LaTeX
3519+For output formats other than LaTeX, pandoc will parse LaTeX
46453520macro definitions and apply the resulting macros to all LaTeX
46463521math and raw LaTeX. So, for example, the following will work in
46473522all output formats, not just LaTeX:
@@ -4651,20 +3526,18 @@ all output formats, not just LaTeX:
46513526 $\tuple{a, b, c}$
46523527
46533528Note that LaTeX macros will not be applied if they occur
4654−inside a raw span or block marked with the
3529+inside inside a raw span or block marked with the
46553530[`raw_attribute` extension](#extension-raw_attribute).
46563531
46573532When `latex_macros` is disabled, the raw LaTeX and math will
46583533not have macros applied. This is usually a better approach when
46593534you are targeting LaTeX or PDF.
46603535
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.
3536+Whether or not `latex_macros` is enabled, the macro definitions
3537+will still be passed through as raw LaTeX.
46663538
4667−## Links
3539+Links
3540+-----
46683541
46693542Markdown allows links to be specified in several ways.
46703543
@@ -4673,7 +3546,7 @@ Markdown allows links to be specified in several ways.
46733546If you enclose a URL or email address in pointy brackets, it
46743547will become a link:
46753548
4676− <https://google.com>
3549+ <http://google.com>
46773550 <sam@green.eggs.ham>
46783551
46793552### Inline links ###
@@ -4683,7 +3556,7 @@ followed by the URL in parentheses. (Optionally, the URL can
46833556be followed by a link title, in quotes.)
46843557
46853558 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3559+ a title](http://fsf.org "click here for a good time!").
46873560
46883561There can be no space between the bracketed part and the parenthesized part.
46893562The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3585,7 @@ Here are some examples:
47123585
47133586 [my label 1]: /foo/bar.html "My title, optional"
47143587 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3588+ [my label 3]: http://fsf.org (The free software foundation)
47163589 [my label 4]: /bar#special 'A title in single quotes'
47173590
47183591The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3594,7 @@ The URL may optionally be surrounded by angle brackets:
47213594
47223595The title may go on the next line:
47233596
4724− [my label 3]: https://fsf.org
3597+ [my label 3]: http://fsf.org
47253598 "The free software foundation"
47263599
47273600Note that link labels are not case sensitive. So, this will work:
@@ -4759,7 +3632,7 @@ be omitted entirely:
47593632### Internal links ###
47603633
47613634To link to another section of the same document, use the automatically
4762−generated identifier (see [Heading identifiers]). For example:
3635+generated identifier (see [Header identifiers]). For example:
47633636
47643637 See the [Introduction](#introduction).
47653638
@@ -4772,7 +3645,8 @@ or
47723645Internal links are currently supported for HTML formats (including
47733646HTML slide shows and EPUB), LaTeX, and ConTeXt.
47743647
4775−## Images
3648+Images
3649+------
47763650
47773651A link immediately preceded by a `!` will be treated as an image.
47783652The link text will be used as the image's alt text:
@@ -4818,11 +3692,10 @@ Attributes can be set on links and images:
48183692(This syntax is compatible with [PHP Markdown Extra] when only `#id`
48193693and `.class` are used.)
48203694
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.
3695+For HTML and EPUB, all attributes except `width` and `height` (but
3696+including `srcset` and `sizes`) are passed through as is. The other
3697+writers ignore attributes that are not supported by their output
3698+format.
48263699
48273700The `width` and `height` attributes on images are treated specially. When
48283701used without a unit, the unit is assumed to be pixels. However, any of
@@ -4834,12 +3707,10 @@ For example:
48343707{ width=50% }
48353708```
48363709
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).
3710+- Dimensions are converted to inches for output in page-based formats like
3711+ LaTeX. Dimensions are converted to pixels for output in HTML-like
3712+ formats. Use the `--dpi` option to specify the number of pixels per
3713+ inch. The default is 96dpi.
48433714- The `%` unit is generally relative to some available space.
48443715 For example the above example will render to the following.
48453716 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -4848,13 +3719,14 @@ For example:
48483719 as in the default template.)
48493720 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
48503721- Some output formats have a notion of a class
4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3722+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
48523723 or a unique identifier (LaTeX `\caption`), or both (HTML).
48533724- When no `width` or `height` attributes are specified, the fallback
48543725 is to look at the image resolution and the dpi metadata embedded in
48553726 the image file.
48563727
4857−## Divs and Spans
3728+Divs and Spans
3729+--------------
48583730
48593731Using the `native_divs` and `native_spans` extensions
48603732(see [above][Extension: `native_divs`]), HTML syntax can
@@ -4910,7 +3782,8 @@ followed immediately by attributes:
49103782
49113783 [This is *some text*]{.class key="val"}
49123784
4913−## Footnotes
3785+Footnotes
3786+---------
49143787
49153788#### Extension: `footnotes` ####
49163789
@@ -4956,401 +3829,45 @@ they cannot contain multiple paragraphs). The syntax is as follows:
49563829
49573830Inline and regular footnotes may be mixed freely.
49583831
4959−## Citation syntax
3832+Citations
3833+---------
49603834
49613835#### Extension: `citations` ####
49623836
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
3837+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
53203838citations and a bibliography in a number of styles. Basic usage is
53213839
5322− pandoc --citeproc myinput.txt
5323−
5324−To use this feature, you will need to have
5325−
5326−- a document containing citations (see [Extension: `citations`]);
5327−- a source of bibliographic data: either an external bibliography
5328− file or a list of `references` in the document's YAML metadata
5329−- optionally, a [CSL] citation style.
3840+ pandoc --filter pandoc-citeproc myinput.txt
53303841
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:
3842+In order to use this feature, you will need to specify a bibliography file
3843+using the `bibliography` metadata field in a YAML metadata section, or
3844+`--bibliography` command line argument. You can supply multiple `--bibliography`
3845+arguments or set `bibliography` metadata field to YAML array, if you want to
3846+use multiple bibliography files. The bibliography may have any of these
3847+formats:
53393848
53403849 Format File extension
53413850 ------------ --------------
53423851 BibLaTeX .bib
53433852 BibTeX .bibtex
3853+ Copac .copac
53443854 CSL JSON .json
53453855 CSL YAML .yaml
3856+ EndNote .enl
3857+ EndNote XML .xml
3858+ ISI .wos
3859+ MEDLINE .medline
3860+ MODS .mods
3861+ RIS .ris
53463862
53473863Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
3864+use `.bibtex` to force BibTeX.
3865+
3866+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3867+can produce `.json` and `.yaml` files from any of the supported formats.
53493868
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]:
3869+In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses
3870+a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:
53543871
53553872`<i>...</i>`
53563873: italics
@@ -5370,11 +3887,14 @@ markup specs]:
53703887`<span class="nocase">...</span>`
53713888: prevent a phrase from being capitalized as title case
53723889
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:
3890+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3891+and CSL YAML formats as far as possible.
3892+
3893+As an alternative to specifying a bibliography file using `--bibliography`
3894+or the YAML metadata field `bibliography`, you can include
3895+the citation data directly in the `references` field of the
3896+document's YAML metadata. The field should contain an array of
3897+YAML-encoded references, for example:
53783898
53793899 ---
53803900 references:
@@ -5390,273 +3910,323 @@ array of YAML-encoded references, for example:
53903910 - - 1953
53913911 - 4
53923912 - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
5394− deoxyribose nucleic acid'
3913+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
3914+ nucleic acid'
53953915 title-short: Molecular structure of nucleic acids
53963916 container-title: Nature
53973917 volume: 171
53983918 issue: 4356
53993919 page: 737-738
54003920 DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
3921+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
54023922 language: en-GB
54033923 ...
54043924
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.
3925+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
3926+of the supported formats.)
3927+
3928+Citations and references can be formatted using any style supported by the
3929+[Citation Style Language], listed in the [Zotero Style Repository].
3930+These files are specified using the `--csl` option or the `csl` metadata field.
3931+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3932+format. The CSL project provides further information on [finding and editing styles].
3933+
3934+To make your citations hyperlinks to the corresponding bibliography
3935+entries, add `link-citations: true` to your YAML metadata.
3936+
3937+Citations go inside square brackets and are separated by semicolons.
3938+Each citation must have a key, composed of '@' + the citation
3939+identifier from the database, and may optionally have a prefix,
3940+a locator, and a suffix. The citation key must begin with a letter, digit,
3941+or `_`, and may contain alphanumerics, `_`, and internal punctuation
3942+characters (`:.#$%&-+?<>~/`). Here are some examples:
3943+
3944+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3945+
3946+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3947+
3948+ Blah blah [@smith04; @doe99].
3949+
3950+`pandoc-citeproc` detects locator terms in the [CSL locale files].
3951+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3952+locale, locator terms can be written in either singular or plural forms,
3953+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3954+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3955+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3956+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3957+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3958+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3959+locator term is used, "page" is assumed.
3960+
3961+A minus sign (`-`) before the `@` will suppress mention of
3962+the author in the citation. This can be useful when the
3963+author is already mentioned in the text:
3964+
3965+ Smith says blah [-@smith04].
3966+
3967+You can also write an in-text citation, as follows:
3968+
3969+ @smith04 says blah.
3970+
3971+ @smith04 [p. 33] says blah.
3972+
3973+If the style calls for a list of works cited, it will be placed
3974+at the end of the document. Normally, you will want to end your
3975+document with an appropriate header:
3976+
3977+ last paragraph...
3978+
3979+ # References
54083980
5409−Note that `pandoc` can be used to produce such a YAML metadata
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
3981+The bibliography will be inserted after this header. Note that
3982+the `unnumbered` class will be added to this header, so that the
3983+section will not be numbered.
54113984
5412− pandoc chem.bib -s -f biblatex -t markdown
5413− pandoc chem.json -s -f csljson -t markdown
3985+If you want to include items in the bibliography without actually
3986+citing them in the body text, you can define a dummy `nocite` metadata
3987+field and put the citations there:
54143988
5415−Indeed, `pandoc` can convert between any of these
5416−citation formats:
3989+ ---
3990+ nocite: |
3991+ @item1, @item2
3992+ ...
54173993
5418− pandoc chem.bib -s -f biblatex -t csljson
5419− pandoc chem.yaml -s -f markdown -t biblatex
3994+ @item3
54203995
5421−Running pandoc on a bibliography file with the `--citeproc`
5422−option will create a formatted bibliography in the format
5423−of your choice:
3996+In this example, the document will contain a citation for `item3`
3997+only, but the bibliography will contain entries for `item1`, `item2`, and
3998+`item3`.
54243999
5425− pandoc chem.bib -s --citeproc -o chem.html
5426− pandoc chem.bib -s --citeproc -o chem.pdf
4000+It is possible to create a bibliography with all the citations,
4001+whether or not they appear in the document, by using a wildcard:
54274002
5428−### Capitalization in titles
4003+ ---
4004+ nocite: |
4005+ @*
4006+ ...
54294007
5430−If you are using a bibtex or biblatex bibliography, then observe
5431−the following rules:
4008+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4009+render the bibliography. In order to do so, specify bibliography
4010+files as outlined above, and add `--natbib` or `--biblatex`
4011+argument to `pandoc` invocation. Bear in mind that bibliography
4012+files have to be in respective format (either BibTeX or
4013+BibLaTeX).
54324014
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`.)
4015+For more information, see the [pandoc-citeproc man page].
54384016
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:
4017+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4018+[Chicago Manual of Style]: http://chicagomanualofstyle.org
4019+[Citation Style Language]: http://citationstyles.org
4020+[Zotero Style Repository]: https://www.zotero.org/styles
4021+[finding and editing styles]: https://citationstyles.org/authors/
4022+[CSL locale files]: https://github.com/citation-style-language/locales
4023+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
54424024
5443− title = {My Dinner with {Andre}}
4025+Non-pandoc extensions
4026+---------------------
54444027
5445− - In addition, words that should remain lowercase (or camelCase)
5446− should be protected:
4028+The following Markdown syntax extensions are not enabled by default
4029+in pandoc, but may be enabled by adding `+EXTENSION` to the format
4030+name, where `EXTENSION` is the name of the extension. Thus, for
4031+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
54474032
5448− title = {Spin Wave Dispersion on the {nm} Scale}
4033+#### Extension: `old_dashes` ####
54494034
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.
4035+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
4036+`-` before a numeral is an en-dash, and `--` is an em-dash.
4037+This option only has an effect if `smart` is enabled. It is
4038+selected automatically for `textile` input.
54544039
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
5456−the following rules:
4040+#### Extension: `angle_brackets_escapable` ####
54574041
5458− - All titles should be in sentence case.
4042+Allow `<` and `>` to be backslash-escaped, as they can be in
4043+GitHub flavored Markdown but not original Markdown. This is
4044+implied by pandoc's default `all_symbols_escapable`.
54594045
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.)
4046+#### Extension: `lists_without_preceding_blankline` ####
54634047
5464− - Protect words that should not be converted to title case using
5465− this syntax:
4048+Allow a list to occur right after a paragraph, with no intervening
4049+blank space.
54664050
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
4051+#### Extension: `four_space_rule` ####
54684052
5469−### Conference Papers, Published vs. Unpublished
4053+Selects the pandoc <= 2.0 behavior for parsing lists, so that
4054+four spaces indent are needed for list item continuation
4055+paragraphs.
54704056
5471−For a formally published conference paper, use the biblatex entry type
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
4057+#### Extension: `spaced_reference_links` ####
54734058
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`).
4059+Allow whitespace between the two components of a reference link,
4060+for example,
54774061
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.
4062+ [foo] [bar].
54874063
4064+#### Extension: `hard_line_breaks` ####
54884065
5489−## Specifying a citation style
4066+Causes all newlines within a paragraph to be interpreted as hard line
4067+breaks instead of spaces.
54904068
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:
4069+#### Extension: `ignore_line_breaks` ####
55074070
4071+Causes newlines within a paragraph to be ignored, rather than being
4072+treated as spaces or as hard line breaks. This option is intended for
4073+use with East Asian languages where spaces are not used between words,
4074+but text is divided into lines for readability.
55084075
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− }
4076+#### Extension: `east_asian_line_breaks` ####
55174077
4078+Causes newlines within a paragraph to be ignored, rather than
4079+being treated as spaces or as hard line breaks, when they occur
4080+between two East Asian wide characters. This is a better choice
4081+than `ignore_line_breaks` for texts that include a mix of East
4082+Asian wide characters and other characters.
55184083
5519−## Citations in note styles
4084+#### Extension: `emoji` ####
55204085
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,
4086+Parses textual emojis like `:smile:` as Unicode emoticons.
55274087
5528− Blah blah [@foo, p. 33].
4088+#### Extension: `tex_math_single_backslash` ####
55294089
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].
4090+Causes anything between `\(` and `\)` to be interpreted as inline
4091+TeX math, and anything between `\[` and `\]` to be interpreted
4092+as display TeX math. Note: a drawback of this extension is that
4093+it precludes escaping `(` and `[`.
55354094
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:
4095+#### Extension: `tex_math_double_backslash` ####
55414096
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].
4097+Causes anything between `\\(` and `\\)` to be interpreted as inline
4098+TeX math, and anything between `\\[` and `\\]` to be interpreted
4099+as display TeX math.
55454100
5546−## Raw content in a style
4101+#### Extension: `markdown_attribute` ####
55474102
5548−To include raw content in a prefix, suffix, delimiter, or term,
5549−surround it with these tags indicating the format:
4103+By default, pandoc interprets material inside block-level tags as Markdown.
4104+This extension changes the behavior so that Markdown is only parsed
4105+inside block-level tags if the tags have the attribute `markdown=1`.
55504106
5551− {{jats}}<ref>{{/jats}}
4107+#### Extension: `mmd_title_block` ####
55524108
5553−Without the tags, the string will be interpreted as a string
5554−and escaped in the output, rather than being passed through raw.
4109+Enables a [MultiMarkdown] style title block at the top of
4110+the document, for example:
55554111
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.
4112+ Title: My title
4113+ Author: John Doe
4114+ Date: September 1, 2008
4115+ Comment: This is a sample mmd title block, with
4116+ a field spanning multiple lines.
55604117
4118+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
4119+`yaml_metadata_block` is enabled, it will take precedence over
4120+`mmd_title_block`.
55614121
4122+#### Extension: `abbreviations` ####
55624123
5563−## Placement of the bibliography
4124+Parses PHP Markdown Extra abbreviation keys, like
55644125
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:
4126+ *[HTML]: Hypertext Markup Language
55674127
5568− ::: {#refs}
5569− :::
4128+Note that the pandoc document model does not support
4129+abbreviations, so if this extension is enabled, abbreviation keys are
4130+simply skipped (as opposed to being parsed as paragraphs).
55704131
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.
4132+#### Extension: `autolink_bare_uris` ####
55744133
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:
4134+Makes all absolute URIs into links, even when not surrounded by
4135+pointy braces `<...>`.
55794136
5580− last paragraph...
4137+#### Extension: `mmd_link_attributes` ####
55814138
5582− # References
4139+Parses multimarkdown style key-value attributes on link
4140+and image references. This extension should not be confused with the
4141+[`link_attributes`](#extension-link_attributes) extension.
55834142
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.
4143+ This is a reference ![image][ref] with multimarkdown attributes.
55874144
5588−## Including uncited items in the bibliography
4145+ [ref]: http://path.to/image "Image title" width=20px height=30px
4146+ id=myId class="myClass1 myClass2"
55894147
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:
4148+#### Extension: `mmd_header_identifiers` ####
55934149
5594− ---
5595− nocite: |
5596− @item1, @item2
5597− ...
4150+Parses multimarkdown style header identifiers (in square brackets,
4151+after the header but before any trailing `#`s in an ATX header).
55984152
5599− @item3
4153+#### Extension: `compact_definition_lists` ####
56004154
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`.
4155+Activates the definition list syntax of pandoc 1.12.x and earlier.
4156+This syntax differs from the one described above under [Definition lists]
4157+in several respects:
56044158
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:
4159+ - No blank line is required between consecutive items of the
4160+ definition list.
4161+ - To get a "tight" or "compact" list, omit space between consecutive
4162+ items; the space between a term and its definition does not affect
4163+ anything.
4164+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
4165+ be indented four spaces.[^6]
56074166
5608− ---
5609− nocite: |
5610− @*
5611− ...
4167+[^6]: To see why laziness is incompatible with relaxing the requirement
4168+ of a blank line between items, consider the following example:
56124169
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.
4170+ bar
4171+ : definition
4172+ foo
4173+ : definition
56194174
5620−## Other relevant metadata fields
4175+ Is this a single list item with two definitions of "bar," the first of
4176+ which is lazily wrapped, or two list items? To remove the ambiguity
4177+ we must either disallow lazy wrapping or require a blank line between
4178+ list items.
56214179
5622−A few other metadata fields affect bibliography formatting:
4180+Markdown variants
4181+-----------------
56234182
5624−`link-citations`
5625−: If true, citations will be
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
4183+In addition to pandoc's extended Markdown, the following Markdown
4184+variants are supported:
56284185
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
4186+`markdown_phpextra` (PHP Markdown Extra)
4187+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4188+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4189+ `header_attributes`, `link_attributes`, `abbreviations`,
4190+ `shortcut_reference_links`, `spaced_reference_links`.
4191+
4192+`markdown_github` (deprecated GitHub-Flavored Markdown)
4193+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4194+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4195+ `space_in_atx_header`, `intraword_underscores`, `strikeout`,
4196+ `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,
4197+ `lists_without_preceding_blankline`.
4198+
4199+`markdown_mmd` (MultiMarkdown)
4200+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4201+ `tex_math_double_backslash`, `intraword_underscores`,
4202+ `mmd_title_block`, `footnotes`, `definition_lists`,
4203+ `all_symbols_escapable`, `implicit_header_references`,
4204+ `auto_identifiers`, `mmd_header_identifiers`,
4205+ `shortcut_reference_links`, `implicit_figures`,
4206+ `superscript`, `subscript`, `backtick_code_blocks`,
4207+ `spaced_reference_links`, `raw_attribute`.
4208+
4209+`markdown_strict` (Markdown.pl)
4210+: `raw_html`, `shortcut_reference_links`,
4211+ `spaced_reference_links`.
4212+
4213+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4214+which is implemented as a set of extensions on `commonmark`).
4215+
4216+Note, however, that `commonmark` and `gfm` have limited support
4217+for extensions. Only those listed below (and `smart` and
4218+`raw_tex`) will work. The extensions can, however, all be
4219+individually disabled.
4220+Also, `raw_tex` only affects `gfm` output, not input.
4221+
4222+`gfm` (GitHub-Flavored Markdown)
4223+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,
4224+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
4225+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
4226+ `shortcut_reference_links`, `angle_brackets_escapable`.
4227+
4228+Producing slide shows with pandoc
4229+=================================
56604230
56614231You can use pandoc to produce an HTML + JavaScript slide presentation
56624232that can be viewed via a web browser. There are five ways to do this,
@@ -5704,21 +4274,18 @@ To produce an HTML/JavaScript slide show, simply type
57044274
57054275where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
57064276
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.
4277+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4278+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4279+assumed to be available at the relative path `s5/default` (for S5), `slideous`
4280+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4281+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4282+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
4283+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4284+the file by default.
4285+
4286+With all HTML slide formats, the `--self-contained` option can be used to
4287+produce a single file that contains all of the data necessary to display the
4288+slide show, including linked scripts, stylesheets, images, and videos.
57224289
57234290To produce a PDF slide show using beamer, type
57244291
@@ -5731,13 +4298,14 @@ To produce a Powerpoint slide show, type
57314298
57324299 pandoc habits.txt -o habits.pptx
57334300
5734−## Structuring the slide show
4301+Structuring the slide show
4302+--------------------------
57354303
5736−By default, the *slide level* is the highest heading level in
4304+By default, the *slide level* is the highest header level in
57374305the hierarchy that is followed immediately by content, and not another
5738−heading, somewhere in the document. In the example above, level-1 headings
5739−are always followed by level-2 headings, which are followed by content,
5740−so the slide level is 2. This default can be overridden using
4306+header, somewhere in the document. In the example above, level 1 headers
4307+are always followed by level 2 headers, which are followed by content,
4308+so 2 is the slide level. This default can be overridden using
57414309the `--slide-level` option.
57424310
57434311The document is carved up into slides according to the following
@@ -5745,21 +4313,17 @@ rules:
57454313
57464314 * A horizontal rule always starts a new slide.
57474315
5748− * A heading at the slide level always starts a new slide.
4316+ * A header at the slide level always starts a new slide.
57494317
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.)
4318+ * Headers *below* the slide level in the hierarchy create
4319+ headers *within* a slide.
57564320
5757− * Headings *above* the slide level in the hierarchy create
4321+ * Headers *above* the slide level in the hierarchy create
57584322 "title slides," which just contain the section title
57594323 and help to break the slide show into sections.
5760− Non-slide content under these headings will be included
5761− on the title slide (for HTML slide shows) or in a
5762− subsequent slide with the same title (for beamer).
4324+
4325+ * Content *above* the slide level will not appear in the slide
4326+ show.
57634327
57644328 * A title page is constructed automatically from the document's title
57654329 block, if present. (In the case of beamer, this can be disabled
@@ -5767,16 +4331,17 @@ rules:
57674331
57684332These rules are designed to support many different styles of slide show. If
57694333you don't care about structuring your slides into sections and subsections,
5770−you can just use level-1 headings for all each slide. (In that case, level-1
4334+you can just use level 1 headers for all each slide. (In that case, level 1
57714335will be the slide level.) But you can also structure the slide show into
57724336sections, as in the example above.
57734337
57744338Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5775−layout will be produced, with level-1 headings building horizontally
5776−and level-2 headings building vertically. It is not recommended that
4339+layout will be produced, with level 1 headers building horizontally
4340+and level 2 headers building vertically. It is not recommended that
57774341you use deeper nesting of section levels with reveal.js.
57784342
5779−## Incremental lists
4343+Incremental lists
4344+-----------------
57804345
57814346By default, these writers produce lists that display "all at once."
57824347If you want your lists to display incrementally (one item at a time),
@@ -5814,10 +4379,8 @@ option):
58144379Both methods allow incremental and nonincremental lists to be mixed
58154380in a single document.
58164381
5817−Note: Neither the `-i/--incremental` option nor any of the
5818−methods described here currently works for PowerPoint output.
5819−
5820−## Inserting pauses
4382+Inserting pauses
4383+----------------
58214384
58224385You can add "pauses" within a slide by including a paragraph containing
58234386three dots, separated by spaces:
@@ -5830,9 +4393,8 @@ three dots, separated by spaces:
58304393
58314394 content after the pause
58324395
5833−Note: this feature is not yet implemented for PowerPoint output.
5834−
5835−## Styling the slides
4396+Styling the slides
4397+------------------
58364398
58374399You can change the style of HTML slides by putting customized CSS files
58384400in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5857,9 +4419,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
58574419
58584420 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
58594421
5860−Note that heading attributes will turn into slide attributes
4422+Note that header attributes will turn into slide attributes
58614423(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5862−to style individual slides. In beamer, the only heading attribute
4424+to style individual slides. In beamer, the only header attribute
58634425that affects slides is the `allowframebreaks` class, which sets the
58644426`allowframebreaks` option, causing multiple slides to be created
58654427if the content overfills the frame. This is recommended especially for
@@ -5867,7 +4429,8 @@ bibliographies:
58674429
58684430 # References {.allowframebreaks}
58694431
5870−## Speaker notes
4432+Speaker notes
4433+-------------
58714434
58724435Speaker notes are supported in reveal.js and PowerPoint (pptx)
58734436output. You can add notes to your Markdown document thus:
@@ -5888,7 +4451,8 @@ in handouts and presenter view.
58884451Notes are not yet supported for other slide formats, but the notes
58894452will not appear on the slides themselves.
58904453
5891−## Columns
4454+Columns
4455+-------
58924456
58934457To put material in side by side columns, you can use a native
58944458div container with class `columns`, containing two or more div
@@ -5903,46 +4467,12 @@ containers with class `column` and a `width` attribute:
59034467 :::
59044468 ::::::::::::::
59054469
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
4470+Frame attributes in beamer
4471+--------------------------
59424472
59434473Sometimes it is necessary to add the LaTeX `[fragile]` option to
59444474a frame in beamer (for example, when using the `minted` environment).
5945−This can be forced by adding the `fragile` class to the heading
4475+This can be forced by adding the `fragile` class to the header
59464476introducing the slide:
59474477
59484478 # Fragile slide {.fragile}
@@ -5952,9 +4482,10 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
59524482`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
59534483`shrink`, `standout`, `noframenumbering`.
59544484
5955−## Background in reveal.js and beamer
4485+Background in reveal.js and beamer
4486+----------------------------------
59564487
5957−Background images can be added to self-contained reveal.js slideshows and
4488+Background images can be added to self-contained reveal.js slideshows and
59584489to beamer slideshows.
59594490
59604491For the same image on every slide, use the configuration
@@ -5962,14 +4493,14 @@ option `background-image` either in the YAML metadata block
59624493or as a command-line variable. (There are no other options in
59634494beamer and the rest of this section concerns reveal.js slideshows.)
59644495
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
4496+For reveal.js, you can instead use the reveal.js-native option
4497+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4498+and `parallaxBackgroundVertical` the same way and must also set
59684499`parallaxBackgroundSize` to have your values take effect.
59694500
59704501To set an image for a particular reveal.js slide, add
59714502`{data-background-image="/path/to/image"}`
5972−to the first slide-level heading on the slide (which may even be empty).
4503+to the first slide-level header on the slide (which may even be empty).
59734504
59744505In reveal.js's overview mode, the parallaxBackgroundImage will show up
59754506only on the first slide.
@@ -5978,12 +4509,9 @@ Other reveal.js background settings also work on individual slides, including
59784509`data-background-size`, `data-background-repeat`, `data-background-color`,
59794510`data-transition`, and `data-transition-speed`.
59804511
5981−To add a background image to the automatically generated title slide, use the
5982−`title-slide-attributes` variable in the YAML metadata block. It must contain
5983−a map of attribute names and values.
5984−
5985−See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986−details.
4512+See the [reveal.js
4513+documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4514+for more details.
59874515
59884516For example in reveal.js:
59894517
@@ -5991,9 +4519,6 @@ For example in reveal.js:
59914519---
59924520title: My Slideshow
59934521parallaxBackgroundImage: /path/to/my/background_image.png
5994−title-slide-attributes:
5995− data-background-image: /path/to/title_image.png
5996− data-background-size: contain
59974522---
59984523
59994524## Slide One
@@ -6002,12 +4527,14 @@ Slide 1 has background_image.png as its background.
60024527
60034528## {data-background-image="/path/to/special_image.jpg"}
60044529
6005−Slide 2 has a special image for its background, even though the heading has no content.
4530+Slide 2 has a special image for its background, even though the header has no content.
60064531```
60074532
6008−# EPUBs
4533+Creating EPUBs with pandoc
4534+==========================
60094535
6010−## EPUB Metadata
4536+EPUB Metadata
4537+-------------
60114538
60124539EPUB metadata may be specified using the `--epub-metadata` option, but
60134540if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,15 +4612,6 @@ The following fields are recognized:
60854612
60864613`rights`
60874614 ~ 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.
60974615
60984616`cover-image`
60994617 ~ A string value (path to cover image).
@@ -6115,12 +4633,13 @@ The following fields are recognized:
61154633 - `binding`: `true`|`false` (default `true`)
61164634 - `scroll-axis`: `vertical`|`horizontal`|`default`
61174635
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4636+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
61194637[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
61204638
6121−## The `epub:type` attribute
4639+The `epub:type` attribute
4640+-------------------------
61224641
6123−For `epub3` output, you can mark up the heading that corresponds to an EPUB
4642+For `epub3` output, you can mark up the header that corresponds to an EPUB
61244643chapter using the [`epub:type` attribute][epub-type]. For example, to set
61254644the attribute to the value `prologue`, use this markdown:
61264645
@@ -6143,26 +4662,22 @@ abstract frontmatter
61434662acknowledgments frontmatter
61444663copyright-page frontmatter
61454664dedication 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
61564665foreword frontmatter
4666+halftitle, frontmatter
4667+introduction frontmatter
61574668preface frontmatter
4669+seriespage frontmatter
4670+titlepage frontmatter
4671+afterword backmatter
61584672appendix backmatter
61594673colophon backmatter
6160−bibliography backmatter
6161−index backmatter
4674+conclusion backmatter
4675+epigraph backmatter
61624676
61634677[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
61644678
6165−## Linked media
4679+Linked media
4680+------------
61664681
61674682By default, pandoc will download media referenced from any `<img>`, `<audio>`,
61684683`<video>` or `<source>` element present in the generated EPUB,
@@ -6172,137 +4687,13 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
61724687with the `src` attribute. For example:
61734688
61744689 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
4690+ <source src="http://example.com/music/toccata.mp3"
61764691 data-external="1" type="audio/mpeg">
61774692 </source>
61784693 </audio>
61794694
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
4695+Syntax highlighting
4696+===================
63064697
63074698Pandoc will automatically highlight syntax in [fenced code blocks] that
63084699are marked with a language name. The Haskell library [skylighting] is
@@ -6330,7 +4721,7 @@ Then edit `my.theme` and use it like this:
63304721If you are not satisfied with the built-in highlighting, or you
63314722want highlight a language that isn't supported, you can use the
63324723`--syntax-definition` option to load a [KDE-style XML syntax definition
6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
4724+file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
63344725Before writing your own, have a look at KDE's [repository of syntax
63354726definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
63364727
@@ -6338,58 +4729,11 @@ To disable highlighting, use the `--no-highlight` option.
63384729
63394730[skylighting]: https://github.com/jgm/skylighting
63404731
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.
4732+Custom Styles in Docx
4733+=====================
63894734
6390−[pandoc filters]: https://pandoc.org/filters.html
6391−
6392−## Input
4735+Input
4736+-----
63934737
63944738The docx reader, by default, only reads those styles that it can
63954739convert into pandoc elements, either by direct conversion or
@@ -6418,17 +4762,17 @@ And with the extension:
64184762
64194763 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
64204764
6421− ::: {custom-style="First Paragraph"}
4765+ ::: {custom-style="FirstParagraph"}
64224766 This is some text.
64234767 :::
64244768
6425− ::: {custom-style="Body Text"}
4769+ ::: {custom-style="BodyText"}
64264770 This is text with an [emphasized]{custom-style="Emphatic"} text style.
64274771 And this is text with a [strengthened]{custom-style="Strengthened"}
64284772 text style.
64294773 :::
64304774
6431− ::: {custom-style="My Block Style"}
4775+ ::: {custom-style="MyBlockStyle"}
64324776 > Here is a styled paragraph that inherits from Block Text.
64334777 :::
64344778
@@ -6436,85 +4780,75 @@ With these custom styles, you can use your input document as a
64364780reference-doc while creating docx output (see below), and maintain the
64374781same styles in your input and output files.
64384782
6439−# Custom writers
4783+Output
4784+------
4785+
4786+By default, pandoc's docx output applies a predefined set of styles for
4787+blocks such as paragraphs and block quotes, and uses largely default
4788+formatting (italics, bold) for inlines. This will work for most
4789+purposes, especially alongside a `reference.docx` file. However, if you
4790+need to apply your own styles to blocks, or match a preexisting set of
4791+styles, pandoc allows you to define custom styles for blocks and text
4792+using `div`s and `span`s, respectively.
4793+
4794+If you define a `div` or `span` with the attribute `custom-style`,
4795+pandoc will apply your specified style to the contained elements. So,
4796+for example using the `bracketed_spans` syntax,
4797+
4798+ [Get out]{custom-style="Emphatically"}, he said.
4799+
4800+would produce a docx file with "Get out" styled with character
4801+style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4802+
4803+ Dickinson starts the poem simply:
4804+
4805+ ::: {custom-style="Poetry"}
4806+ | A Bird came down the Walk---
4807+ | He did not know I saw---
4808+ :::
4809+
4810+would style the two contained lines with the `Poetry` paragraph style.
4811+
4812+If the styles are not yet in your reference.docx, they will be defined
4813+in the output file as inheriting from normal text. If they are already
4814+defined, pandoc will not alter the definition.
4815+
4816+This feature allows for greatest customization in conjunction with
4817+[pandoc filters]. If you want all paragraphs after block quotes to be
4818+indented, you can write a filter to apply the styles necessary. If you
4819+want all italics to be transformed to the `Emphasis` character style
4820+(perhaps to change their color), you can write a filter which will
4821+transform all italicized inlines to inlines within an `Emphasis`
4822+custom-style `span`.
4823+
4824+[pandoc filters]: http://pandoc.org/filters.html
4825+
4826+Custom writers
4827+==============
64404828
6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442−includes a Lua interpreter, so Lua need not be installed separately.)
4829+Pandoc can be extended with custom writers written in [lua]. (Pandoc
4830+includes a lua interpreter, so lua need not be installed separately.)
64434831
6444−To use a custom writer, simply specify the path to the Lua script
4832+To use a custom writer, simply specify the path to the lua script
64454833in place of the output format. For example:
64464834
64474835 pandoc -t data/sample.lua
64484836
6449−Creating a custom writer requires writing a Lua function for each
4837+Creating a custom writer requires writing a lua function for each
64504838possible element in a pandoc document. To get a documented example
64514839which you can modify according to your needs, do
64524840
64534841 pandoc --print-default-data-file sample.lua
64544842
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
4843+[lua]: http://www.lua.org
4844+
4845+Authors
4846+=======
4847+
4848+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
65144849under the [GPL], version 2 or greater. This software carries no
65154850warranty of any kind. (See COPYRIGHT for full copyright and
65164851warranty notices.) For a full list of contributors, see the file
65174852AUTHORS.md in the pandoc source code.
65184853
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"
4854+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"