@@ -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+% July 6, 2019
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,17 @@ 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 uses [variables for LaTeX] (with a LaTeX engine);
132+[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
133+(an HTML/CSS-to-PDF engine; `--css` also affects the output).
131134
132135To debug the PDF creation, it can be useful to look at the intermediate
133136representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -136,22 +139,22 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136139When using LaTeX, the following packages need to be available
137140(they are included with all recent versions of [TeX Live]):
138141[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`iftex`], [`listings`] (if the
142+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140143`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
144+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
142145contains images), [`hyperref`], [`xcolor`],
143146[`ulem`], [`geometry`] (with the `geometry` variable set),
144147[`setspace`] (with `linestretch`), and
145148[`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
149+the PDF engine requires [`fontspec`]. `xelatex` uses
150+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
151+`dir` variable set). If the `mathspec` variable is set,
152+`xelatex` will use [`mathspec`] instead of [`unicode-math`].
153+The [`upquote`] and [`microtype`] packages are used if
154+available, and [`csquotes`] will be used for [typography]
155+if the `csquotes` variable or metadata field is set to a
156+true value. The [`natbib`], [`biblatex`], [`bibtex`], and
157+[`biber`] packages can optionally be used for [citation
155158rendering]. The following packages will be used to improve
156159output quality if present, but pandoc does not require them to
157160be present: [`upquote`] (for straight quotes in verbatim
@@ -161,7 +164,7 @@ better line breaks in URLs), [`bookmark`] (for better PDF
161164bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162165footnotes in tables).
163166
164−[TeX Live]: https://www.tug.org/texlive/
167+[TeX Live]: http://www.tug.org/texlive/
165168[`amsfonts`]: https://ctan.org/pkg/amsfonts
166169[`amsmath`]: https://ctan.org/pkg/amsmath
167170[`babel`]: https://ctan.org/pkg/babel
@@ -180,7 +183,8 @@ footnotes in tables).
180183[`graphicx`]: https://ctan.org/pkg/graphicx
181184[`grffile`]: https://ctan.org/pkg/grffile
182185[`hyperref`]: https://ctan.org/pkg/hyperref
183−[`iftex`]: https://ctan.org/pkg/iftex
186+[`ifluatex`]: https://ctan.org/pkg/ifluatex
187+[`ifxetex`]: https://ctan.org/pkg/ifxetex
184188[`listings`]: https://ctan.org/pkg/listings
185189[`lm`]: https://ctan.org/pkg/lm
186190[`longtable`]: https://ctan.org/pkg/longtable
@@ -194,44 +198,41 @@ footnotes in tables).
194198[`ulem`]: https://ctan.org/pkg/ulem
195199[`unicode-math`]: https://ctan.org/pkg/unicode-math
196200[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
201+[`weasyprint`]: http://weasyprint.org
198202[`wkhtmltopdf`]: https://wkhtmltopdf.org
199203[`xcolor`]: https://ctan.org/pkg/xcolor
200204[`xecjk`]: https://ctan.org/pkg/xecjk
201205[`xurl`]: https://ctan.org/pkg/xurl
202−[`selnolig`]: https://ctan.org/pkg/selnolig
203206
204207
205208
206−## Reading from the Web
209+Reading from the Web
210+--------------------
207211
208−Instead of an input file, an absolute URI may be given. In this case
212+Instead of an input file, an absolute URI may be given. In this case
209213pandoc will fetch the content using HTTP:
210214
211− pandoc -f html -t markdown https://www.fsf.org
215+ pandoc -f html -t markdown http://www.fsf.org
212216
213217It is possible to supply a custom User-Agent string or other
214218header when requesting a document from a URL:
215219
216220 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217− https://www.fsf.org
221+ http://www.fsf.org
218222
219−# Options
223+Options
224+=======
220225
221−## General options {.options}
226+General options {.options}
227+---------------
222228
223229`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224230
225231: Specify input format. *FORMAT* can be:
226232
227233 ::: {#input-formats}
228− - `bibtex` ([BibTeX] bibliography)
229− - `biblatex` ([BibLaTeX] bibliography)
230234 - `commonmark` ([CommonMark] Markdown)
231− - `commonmark_x` ([CommonMark] Markdown with extensions)
232235 - `creole` ([Creole 1.0])
233− - `csljson` ([CSL JSON] bibliography)
234− - `csv` ([CSV] table)
235236 - `docbook` ([DocBook])
236237 - `docx` ([Word docx])
237238 - `dokuwiki` ([DokuWiki markup])
@@ -245,7 +246,6 @@ header when requesting a document from a URL:
245246 - `html` ([HTML])
246247 - `ipynb` ([Jupyter notebook])
247248 - `jats` ([JATS] XML)
248− - `jira` ([Jira]/Confluence wiki markup)
249249 - `json` (JSON version of native AST)
250250 - `latex` ([LaTeX])
251251 - `markdown` ([Pandoc's Markdown])
@@ -280,12 +280,8 @@ header when requesting a document from a URL:
280280 ::: {#output-formats}
281281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283− - `bibtex` ([BibTeX] bibliography)
284− - `biblatex` ([BibLaTeX] bibliography)
285283 - `commonmark` ([CommonMark] Markdown)
286− - `commonmark_x` ([CommonMark] Markdown with extensions)
287284 - `context` ([ConTeXt])
288− - `csljson` ([CSL JSON] bibliography)
289285 - `docbook` or `docbook4` ([DocBook] 4)
290286 - `docbook5` (DocBook 5)
291287 - `docx` ([Word docx])
@@ -302,11 +298,8 @@ header when requesting a document from a URL:
302298 - `html4` ([XHTML] 1.0 Transitional)
303299 - `icml` ([InDesign ICML])
304300 - `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)
301+ - `jats` ([JATS] XML)
302+ - `jira` ([Jira] wiki markup)
310303 - `json` (JSON version of native AST)
311304 - `latex` ([LaTeX])
312305 - `man` ([roff man])
@@ -322,7 +315,6 @@ header when requesting a document from a URL:
322315 - `opml` ([OPML])
323316 - `opendocument` ([OpenDocument])
324317 - `org` ([Emacs Org mode])
325− - `pdf` ([PDF])
326318 - `plain` (plain text),
327319 - `pptx` ([PowerPoint] slide show)
328320 - `rst` ([reStructuredText])
@@ -337,10 +329,10 @@ header when requesting a document from a URL:
337329 - `tei` ([TEI Simple])
338330 - `xwiki` ([XWiki markup])
339331 - `zimwiki` ([ZimWiki markup])
340− - the path of a custom Lua writer, see [Custom writers] below
332+ - the path of a custom lua writer, see [Custom writers] below
341333 :::
342334
343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
335+ Note that `odt`, `docx`, and `epub` output will not be directed
344336 to *stdout* unless forced with `-o -`.
345337
346338 Extensions can be individually enabled or
@@ -361,29 +353,15 @@ header when requesting a document from a URL:
361353 will be used. On \*nix and macOS systems this will be the `pandoc`
362354 subdirectory of the XDG data directory (by default,
363355 `$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
356+ environment variable). If that directory does not exist,
357+ `$HOME/.pandoc` will be used (for backwards compatibility).
358+ In Windows the default user data directory is
367359 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
368360 You can find the default user data directory on your system by
369361 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.
362+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
363+ `slidy`, `slideous`, or `s5` directory
364+ placed in this directory will override pandoc's normal defaults.
387365
388366`--bash-completion`
389367
@@ -394,7 +372,8 @@ header when requesting a document from a URL:
394372
395373`--verbose`
396374
397−: Give verbose debugging output.
375+: Give verbose debugging output. Currently this only has an effect
376+ with PDF output.
398377
399378`--quiet`
400379
@@ -420,7 +399,7 @@ header when requesting a document from a URL:
420399
421400`--list-extensions`[`=`*FORMAT*]
422401
423−: List supported extensions for *FORMAT*, one per line, preceded
402+: List supported extensions, one per line, preceded
424403 by a `+` or `-` indicating whether it is enabled by default
425404 in *FORMAT*. If *FORMAT* is not specified, defaults for
426405 pandoc's Markdown are given.
@@ -443,88 +422,83 @@ header when requesting a document from a URL:
443422
444423: Show usage message.
445424
446−[Markdown]: https://daringfireball.net/projects/markdown/
447−[CommonMark]: https://commonmark.org
425+[Markdown]: http://daringfireball.net/projects/markdown/
426+[CommonMark]: http://commonmark.org
448427[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449428[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/
429+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
430+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
431+[S5]: http://meyerweb.com/eric/tools/s5/
432+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
433+[Slideous]: http://goessner.net/articles/slideous/
434+[HTML]: http://www.w3.org/html/
435+[HTML5]: http://www.w3.org/TR/html5/
457436[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458−[XHTML]: https://www.w3.org/TR/xhtml1/
459−[LaTeX]: https://www.latex-project.org/
437+[XHTML]: http://www.w3.org/TR/xhtml1/
438+[LaTeX]: http://latex-project.org
460439[`beamer`]: https://ctan.org/pkg/beamer
461440[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
441+[ConTeXt]: http://www.contextgarden.net/
442+[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
443+[DocBook]: http://docbook.org
465444[JATS]: https://jats.nlm.nih.gov
466445[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467−[txt2tags]: https://txt2tags.org
446+[txt2tags]: http://txt2tags.org
468447[EPUB]: http://idpf.org/epub
469448[OPML]: http://dev.opml.org/spec2.html
470449[OpenDocument]: http://opendocument.xml.org
471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472−[Textile]: https://www.promptworks.com/textile
450+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
451+[Textile]: http://redcloth.org/textile
473452[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474453[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
454+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
476455[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
456+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478457[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
479458[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
480459[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)
460+[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
461+[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
484462[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/
463+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
464+[Emacs Org mode]: http://orgmode.org
465+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
488466[AsciiDoctor]: https://asciidoctor.org/
489−[DZSlides]: https://paulrouget.com/dzslides/
467+[DZSlides]: http://paulrouget.com/dzslides/
490468[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491469[PDF]: https://www.adobe.com/pdf/
492−[reveal.js]: https://revealjs.com/
470+[reveal.js]: http://lab.hakim.se/reveal-js/
493471[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
494472[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
473+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
496474[TEI Simple]: https://github.com/TEIC/TEI-Simple
497475[Muse]: https://amusewiki.org/library/manual
498476[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499477[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
503478
504−## Reader options {.options}
479+Reader options {.options}
480+--------------
505481
506482`--shift-heading-level-by=`*NUMBER*
507483
508−: Shift heading levels by a positive or negative integer.
484+ Shift heading levels by a positive or negative integer.
509485 For example, with `--shift-heading-level-by=-1`, level 2
510486 headings become level 1 headings, and level 3 headings
511487 become level 2 headings. Headings cannot have a level
512488 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`
489+ becomes a regular paragraph. Exception: with a shift of -1,
490+ a level-1 heading at the beginning of the document
491+ replaces the metadata title. Conversely, with a shift
492+ of +1, a nonempty metadata title becomes a level-1 heading at
493+ the beginning of the document. `--shift-heading-level-by=-1`
516494 is a good choice when converting HTML or Markdown documents that
517495 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.
496+ level-2+ headings for sections.
522497
523498`--base-header-level=`*NUMBER*
524499
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
527− (defaults to 1).
500+: *Deprecated. Use `--shift-heading-level-by` instead.*
501+ Specify the base level for headings (defaults to 1).
528502
529503`--strip-empty-paragraphs`
530504
@@ -589,32 +563,41 @@ header when requesting a document from a URL:
589563
590564 3. `$PATH` (executable only)
591565
592− Filters, Lua-filters, and citeproc processing are applied in
593− the order specified on the command line.
566+ Filters and lua-filters are applied in the order specified
567+ on the command line.
594568
595569`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
596570
597571: 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
572+ `--filter`), but use pandoc's build-in lua filtering system. The given
573+ lua script is expected to return a list of lua filters which will be
574+ applied in order. Each lua filter must contain element-transforming
601575 functions indexed by the name of the AST element on which the filter
602576 function should be applied.
603577
604− The `pandoc` Lua module provides helper functions for element
605− creation. It is always loaded into the script's Lua environment.
578+ The `pandoc` lua module provides helper functions for element
579+ creation. It is always loaded into the script's lua environment.
580+
581+ The following is an example lua script for macro-expansion:
606582
607− See the [Lua filters documentation] for further details.
583+ function expand_hello_world(inline)
584+ if inline.c == '{{helloworld}}' then
585+ return pandoc.Emph{ pandoc.Str "Hello, World" }
586+ else
587+ return inline
588+ end
589+ end
608590
609− In order of preference, pandoc will look for Lua filters in
591+ return {{Str = expand_hello_world}}
610592
611− 1. a specified full or relative path
593+ In order of preference, pandoc will look for lua filters in
612594
613− 2. `$DATADIR/filters` where `$DATADIR` is the user data
614− directory (see `--data-dir`, above).
595+ 1. a specified full or relative path (executable or
596+ non-executable)
615597
616− Filters, Lua filters, and citeproc processing are applied in
617− the order specified on the command line.
598+ 2. `$DATADIR/filters` (executable or non-executable)
599+ where `$DATADIR` is the user data directory (see
600+ `--data-dir`, above).
618601
619602`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620603
@@ -631,23 +614,20 @@ header when requesting a document from a URL:
631614
632615`--metadata-file=`*FILE*
633616
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.
617+: Read metadata from the supplied YAML (or JSON) file. This option can be used
618+ with every input format, but string scalars in the YAML file will always be
619+ parsed as Markdown. Generally, the input will be handled the same as in
620+ [YAML metadata blocks][Extension: `yaml_metadata_block`]. This option can be
621+ used repeatedly to include multiple metadata files; values in files specified
622+ first will be preferred over those specified in later files. Metadata values
623+ specified inside the document, or by using `-M`, overwrite values specified
624+ with this option.
644625
645626`-p`, `--preserve-tabs`
646627
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.
628+: Preserve tabs instead of converting them to spaces (the default).
629+ Note that this will only affect tabs in literal code spans and code
630+ blocks; tabs in regular text will be treated as spaces.
651631
652632`--tab-stop=`*NUMBER*
653633
@@ -657,30 +637,30 @@ header when requesting a document from a URL:
657637
658638: Specifies what to do with insertions, deletions, and comments
659639 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.
640+ default), inserts all insertions, and ignores all
641+ deletions. `reject` inserts all deletions and ignores
642+ insertions. Both `accept` and `reject` ignore comments. `all` puts
643+ in insertions, deletions, and comments, wrapped in spans with
644+ `insertion`, `deletion`, `comment-start`, and `comment-end`
645+ classes, respectively. The author and time of change is
646+ included. `all` is useful for scripting: only accepting changes
647+ from a certain reviewer, say, or before a certain date. If a
648+ paragraph is inserted or deleted, `track-changes=all` produces a
649+ span with the class `paragraph-insertion`/`paragraph-deletion`
650+ before the affected paragraph break. This option only affects the
651+ docx reader.
672652
673653`--extract-media=`*DIR*
674654
675655: Extract images and other media contained in or linked from
676656 the source document to the path *DIR*, creating it if
677657 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.
658+ so they point to the extracted files. If the source format is
659+ a binary container (docx, epub, or odt), the media is
660+ extracted from the container and the original
661+ filenames are used. Otherwise the media is read from the
662+ file system or downloaded, and new filenames are constructed
663+ based on SHA1 hashes of the contents.
684664
685665`--abbreviations=`*FILE*
686666
@@ -691,17 +671,17 @@ header when requesting a document from a URL:
691671 system default, use
692672 `pandoc --print-default-data-file=abbreviations`. The only
693673 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.
674+ Strings ending in a period that are found in this list will
675+ be followed by a nonbreaking space, so that the period will
676+ not produce sentence-ending space in formats like LaTeX.
697677
698678[`pandocfilters`]: https://github.com/jgm/pandocfilters
699679[PHP]: https://github.com/vinai/pandocfilters-php
700680[perl]: https://metacpan.org/pod/Pandoc::Filter
701681[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703682
704−## General writer options {.options}
683+General writer options {.options}
684+----------------------
705685
706686`-s`, `--standalone`
707687
@@ -726,8 +706,11 @@ header when requesting a document from a URL:
726706`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727707
728708: 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`.
709+ document in standalone mode. This is generally only useful when the
710+ `--template` option is used to specify a custom template, since
711+ pandoc automatically sets the variables used in the default
712+ templates. If no *VAL* is specified, the key will be given the
713+ value `true`.
731714
732715`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733716
@@ -738,11 +721,6 @@ header when requesting a document from a URL:
738721 `-o`/`--output` must come before `--print-default-template`
739722 on the command line.
740723
741− Note that some of the default templates use partials, for
742− example `styles.html`. To print the partials, use
743− `--print-default-data-file`: for example,
744− `--print-default-data-file=templates/styles.html`.
745−
746724`--print-default-data-file=`*FILE*
747725
748726: Print a system default data file. Files in the user data directory
@@ -759,12 +737,9 @@ header when requesting a document from a URL:
759737
760738`--dpi`=*NUMBER*
761739
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.
740+: Specify the dpi (dots per inch) value for conversion from pixels
741+ to inch/centimeters and vice versa. The default is 96dpi.
742+ Technically, the correct term would be ppi (pixels per inch).
768743
769744`--wrap=auto`|`none`|`preserve`
770745
@@ -852,8 +827,7 @@ header when requesting a document from a URL:
852827 which will be used for syntax highlighting of appropriately
853828 marked code blocks. This can be used to add support for
854829 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
856− multiple syntax definitions.
830+ existing languages.
857831
858832`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
859833
@@ -891,11 +865,11 @@ header when requesting a document from a URL:
891865 will not be searched. For example:
892866 `--resource-path=.:test` will search the working directory
893867 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`.
868+
869+ `--resource-path` only has an effect if (a) the output
870+ format embeds images (for example, `docx`, `pdf`, or `html`
871+ with `--self-contained`) or (b) it is used together with
872+ `--extract-media`.
899873
900874`--request-header=`*NAME*`:`*VAL*
901875
@@ -905,13 +879,8 @@ header when requesting a document from a URL:
905879 downloaded). If you're behind a proxy, you also need to set
906880 the environment variable `http_proxy` to `http://...`.
907881
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}
882+Options affecting specific writers {.options}
883+----------------------------------
915884
916885`--self-contained`
917886
@@ -936,9 +905,7 @@ header when requesting a document from a URL:
936905
937906`--html-q-tags`
938907
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.)
908+: Use `<q>` tags for quotes in HTML.
942909
943910`--ascii`
944911
@@ -956,45 +923,37 @@ header when requesting a document from a URL:
956923 placement of link references is affected by the
957924 `--reference-location` option.
958925
959−`--reference-location=block`|`section`|`document`
926+`--reference-location = block`|`section`|`document`
960927
961928: Specify whether footnotes (and references, if `reference-links` is
962929 set) are placed at the end of the current (top-level) block, the
963930 current section, or the document. The default is
964931 `document`. Currently only affects the markdown writer.
965932
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−
974933`--atx-headers`
975934
976−: *Deprecated synonym for `--markdown-headings=atx`.*
935+: Use ATX-style headings in Markdown output. The default is
936+ to use setext-style headings for levels 1 to 2, and then ATX headings.
937+ (Note: for `gfm` output, ATX headings are always used.)
938+ This option also affects markdown cells in `ipynb` output.
977939
978−`--top-level-division=default`|`section`|`chapter`|`part`
940+`--top-level-division=[default|section|chapter|part]`
979941
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.
942+: Treat top-level headings as the given division type in LaTeX, ConTeXt,
943+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;
944+ all headings are shifted such that the top-level heading becomes the specified
945+ type. The default behavior is to determine the best division type via
946+ heuristics: unless other conditions apply, `section` is chosen. When the
947+ `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
948+ `article` option is specified), `chapter` is implied as the setting for this
949+ option. If `beamer` is the output format, specifying either `chapter` or
950+ `part` will cause top-level headings to become `\part{..}`, while
951+ second-level headings remain as their default type.
993952
994953`-N`, `--number-sections`
995954
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997− output. By default, sections are not numbered. Sections with class
955+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
956+ By default, sections are not numbered. Sections with class
998957 `unnumbered` will never be numbered, even if `--number-sections`
999958 is specified.
1000959
@@ -1013,7 +972,7 @@ header when requesting a document from a URL:
1013972
1014973: Use the [`listings`] package for LaTeX code blocks. The package
1015974 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
975+ you would need to use a custom template. This issue is fully
1017976 documented here: [Encoding issue with the listings package].
1018977
1019978`-i`, `--incremental`
@@ -1059,7 +1018,8 @@ header when requesting a document from a URL:
10591018
10601019: Specify *STRING* as a prefix at the beginning of the title
10611020 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
1021+ appears at the beginning of the HTML body). Implies
1022+ `--standalone`.
10631023
10641024`-c` *URL*, `--css=`*URL*
10651025
@@ -1136,7 +1096,6 @@ header when requesting a document from a URL:
11361096 - Verbatim Char
11371097 - Footnote Reference
11381098 - Hyperlink
1139− - Section Number
11401099
11411100 Table style:
11421101
@@ -1276,18 +1235,8 @@ header when requesting a document from a URL:
12761235: Use the specified engine when producing PDF output.
12771236 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
12781237 `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`
1238+ and `pdfroff`. The default is `pdflatex`. If the engine is
1239+ not in your PATH, the full path of the engine may be specified here.
12911240
12921241`--pdf-engine-opt=`*STRING*
12931242
@@ -1296,84 +1245,59 @@ header when requesting a document from a URL:
12961245 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
12971246 Note that no check for duplicate options is done.
12981247
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1248+[Dublin Core elements]: http://dublincore.org/documents/dces/
1249+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
13011250[Encoding issue with the listings package]:
13021251 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
13031252
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].
1253+Citation rendering {.options}
1254+------------------
13241255
13251256`--bibliography=`*FILE*
13261257
13271258: 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`).
1259+ overriding any value set in the metadata, and process citations
1260+ using `pandoc-citeproc`. (This is equivalent to
1261+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1262+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1263+ used, making this equivalent to `--metadata bibliography=FILE`.
1264+ If you supply this argument multiple times, each *FILE* will be added
1265+ to bibliography.
13341266
13351267`--csl=`*FILE*
13361268
13371269: Set the `csl` field in the document's metadata to *FILE*,
13381270 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.
1271+ `--metadata csl=FILE`.)
1272+ This option is only relevant with `pandoc-citeproc`.
13441273
13451274`--citation-abbreviations=`*FILE*
13461275
13471276: Set the `citation-abbreviations` field in the document's metadata to
13481277 *FILE*, overriding any value set in the metadata. (This is equivalent to
13491278 `--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.
1279+ This option is only relevant with `pandoc-citeproc`.
13541280
13551281`--natbib`
13561282
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`].
1283+: Use [`natbib`] for citations in LaTeX output. This option is not for use
1284+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1285+ use in producing a LaTeX file that can be processed with [`bibtex`].
13611286
13621287`--biblatex`
13631288
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`].
1289+: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1290+ with the `pandoc-citeproc` filter or with PDF output. It is intended for
1291+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
13681292
1369−## Math rendering in HTML {.options}
1293+Math rendering in HTML {.options}
1294+----------------------
13701295
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.
1296+The default is to render TeX math as far as possible using Unicode characters.
1297+Formulas are put inside a `span` with `class="math"`, so that they may be styled
1298+differently from the surrounding text if needed. However, this gives acceptable
1299+results only for basic math, usually you will want to use `--mathjax` or another
1300+of the following options.
13771301
13781302`--mathjax`[`=`*URL*]
13791303
@@ -1387,11 +1311,10 @@ results only for basic math, usually you will want to use
13871311
13881312`--mathml`
13891313
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.
1314+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1315+ `html4` and `html5`). This is the default in `odt` output. Note that
1316+ currently only Firefox and Safari (and select e-book readers) natively
1317+ support MathML.
13951318
13961319`--webtex`[`=`*URL*]
13971320
@@ -1415,19 +1338,21 @@ results only for basic math, usually you will want to use
14151338`--gladtex`
14161339
14171340: 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.
1341+ can then be processed by [GladTeX] to produce images of the typeset
1342+ formulas and an HTML file with links to these images.
1343+ So, the procedure is:
14201344
14211345 pandoc -s --gladtex input.md -o myfile.htex
1422− gladtex -d image_dir myfile.htex
1423− # produces myfile.html and images in image_dir
1346+ gladtex -d myfile-images myfile.htex
1347+ # produces myfile.html and images in myfile-images
14241348
1425−[MathML]: https://www.w3.org/Math/
1349+[MathML]: http://www.w3.org/Math/
14261350[MathJax]: https://www.mathjax.org
14271351[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
1352+[GladTeX]: http://humenda.github.io/GladTeX/
14291353
1430−## Options for wrapper scripts {.options}
1354+Options for wrapper scripts {.options}
1355+---------------------------
14311356
14321357`--dump-args`
14331358
@@ -1451,277 +1376,8 @@ results only for basic math, usually you will want to use
14511376
14521377 pandoc -o foo.html -s
14531378
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
1379+Templates
1380+=========
17251381
17261382When the `-s/--standalone` option is used, pandoc uses a template to
17271383add header and footer material that is needed for a self-standing
@@ -1747,391 +1403,12 @@ directory (see `--data-dir`, above). *Exceptions:*
17471403Templates contain *variables*, which allow for the inclusion of
17481404arbitrary information at any point in the file. They may be set at the
17491405command 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
1406+pandoc will look for the key in the document's metadata – which can be set
17511407using 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.
1755−
1756−If you use custom templates, you may need to revise them as pandoc
1757−changes. We recommend tracking the changes in the default templates,
1758−and modifying your custom templates accordingly. An easy way to do this
1759−is to fork the [pandoc-templates] repository and merge in
1760−changes after each pandoc release.
1761−
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1763−
1764−## Template syntax
1765−
1766−### Comments
1767−
1768−Anything between the sequence `$--` and the end of the
1769−line will be treated as a comment and omitted from the output.
1770−
1771−### Delimiters
1772−
1773−To mark variables and control structures in the template,
1774−either `$`...`$` or `${`...`}` may be used as delimiters.
1775−The styles may also be mixed in the same template, but the
1776−opening and closing delimiter must match in each case. The
1777−opening delimiter may be followed by one or more spaces
1778−or tabs, which will be ignored. The closing delimiter may
1779−be followed by one or more spaces or tabs, which will be
1780−ignored.
1781−
1782−To include a literal `$` in the document, use `$$`.
1783−
1784−### Interpolated variables
1785−
1786−A slot for an interpolated variable is a variable name surrounded
1787−by matched delimiters. Variable names must begin with a letter
1788−and can contain letters, numbers, `_`, `-`, and `.`. The
1789−keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may
1790−not be used as variable names. Examples:
1791−
1792−```
1793−$foo$
1794−$foo.bar.baz$
1795−$foo_bar.baz-bim$
1796−$ foo $
1797−${foo}
1798−${foo.bar.baz}
1799−${foo_bar.baz-bim}
1800−${ foo }
1801−```
1802−
1803−Variable names with periods are used to get at structured
1804−variable values. So, for example, `employee.salary` will return the
1805−value of the `salary` field of the object that is the value of
1806−the `employee` field.
1807−
1808−- If the value of the variable is simple value, it will be
1809− rendered verbatim. (Note that no escaping is done;
1810− the assumption is that the calling program will escape
1811− the strings appropriately for the output format.)
1812−- If the value is a list, the values will be concatenated.
1813−- If the value is a map, the string `true` will be rendered.
1814−- Every other value will be rendered as the empty string.
1815−
1816−### Conditionals
1817−
1818−A conditional begins with `if(variable)` (enclosed in
1819−matched delimiters) and ends with `endif` (enclosed in matched
1820−delimiters). It may optionally contain an `else` (enclosed in
1821−matched delimiters). The `if` section is used if
1822−`variable` has a non-empty value, otherwise the `else`
1823−section is used (if present). Examples:
1824−
1825−```
1826−$if(foo)$bar$endif$
1827−
1828−$if(foo)$
1829− $foo$
1830−$endif$
1831−
1832−$if(foo)$
1833−part one
1834−$else$
1835−part two
1836−$endif$
1837−
1838−${if(foo)}bar${endif}
1839−
1840−${if(foo)}
1841− ${foo}
1842−${endif}
1843−
1844−${if(foo)}
1845−${ foo.bar }
1846−${else}
1847−no foo!
1848−${endif}
1849−```
1850−
1851−The keyword `elseif` may be used to simplify complex nested
1852−conditionals:
1853−
1854−```
1855−$if(foo)$
1856−XXX
1857−$elseif(bar)$
1858−YYY
1859−$else$
1860−ZZZ
1861−$endif$
1862−```
1863−
1864−### For loops
1865−
1866−A for loop begins with `for(variable)` (enclosed in
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1868−delimiters.
1869−
1870−- If `variable` is an array, the material inside the loop will
1871− be evaluated repeatedly, with `variable` being set to each
1872− value of the array in turn, and concatenated.
1873−- If `variable` is a map, the material inside will be set to
1874− the map.
1875−- If the value of the associated variable is not an array or
1876− a map, a single iteration will be performed on its value.
1877−
1878−Examples:
1879−
1880−```
1881−$for(foo)$$foo$$sep$, $endfor$
1882−
1883−$for(foo)$
1884− - $foo.last$, $foo.first$
1885−$endfor$
1886−
1887−${ for(foo.bar) }
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1889−${ endfor }
1890−
1891−$for(mymap)$
1892−$it.name$: $it.office$
1893−$endfor$
1894−```
1895−
1896−You may optionally specify a separator between consecutive
1897−values using `sep` (enclosed in matched delimiters). The
1898−material between `sep` and the `endfor` is the separator.
1899−
1900−```
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1902−```
1903−
1904−Instead of using `variable` inside the loop, the special
1905−anaphoric keyword `it` may be used.
1906−
1907−```
1908−${ for(foo.bar) }
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1912−
1913−### Partials
1914−
1915−Partials (subtemplates stored in different files) may be
1916−included by using the name of the partial, followed
1917−by `()`, for example:
1918−
1919−```
1920−${ styles() }
1921−```
1922−
1923−Partials will be sought in the directory containing
1924−the main template. The file name will be assumed to
1925−have the same extension as the main template if it
1926−lacks an extension. When calling the partial, the
1927−full name including file extension can also be used:
1928−
1929−```
1930−${ styles.html() }
1931−```
1932−
1933−(If a partial is not found in the directory of the
1934−template and the template path is given as a relative
1935−path, it will also be sought in the `templates`
1936−subdirectory of the user data directory.)
1937−
1938−Partials may optionally be applied to variables using
1939−a colon:
1940−
1941−```
1942−${ date:fancy() }
1943−
1944−${ articles:bibentry() }
1945−```
1946−
1947−If `articles` is an array, this will iterate over its
1948−values, applying the partial `bibentry()` to each one. So the
1949−second example above is equivalent to
1950−
1951−```
1952−${ for(articles) }
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1956−
1957−Note that the anaphoric keyword `it` must be used when
1958−iterating over partials. In the above examples,
1959−the `bibentry` partial should contain `it.title`
1960−(and so on) instead of `articles.title`.
1961−
1962−Final newlines are omitted from included partials.
1963−
1964−Partials may include other partials.
1965−
1966−A separator between values of an array may be specified
1967−in square brackets, immediately after the variable name
1968−or partial:
1969−
1970−```
1971−${months[, ]}$
1972−
1973−${articles:bibentry()[; ]$
1974−```
1975−
1976−The separator in this case is literal and (unlike with `sep`
1977−in an explicit `for` loop) cannot contain interpolated
1978−variables or other template directives.
1979−
1980−### Nesting
1981−
1982−To ensure that content is "nested," that is, subsequent lines
1983−indented, use the `^` directive:
1984−
1985−```
1986−$item.number$ $^$$item.description$ ($item.price$)
1987−```
1988−
1989−In this example, if `item.description` has multiple lines,
1990−they will all be indented to line up with the first line:
1991−
1992−```
1993−00123 A fine bottle of 18-year old
1994− Oban whiskey. ($148)
1995−```
1996−
1997−To nest multiple lines to the same level, align them
1998−with the `^` directive in the template. For example:
1999−
2000−```
2001−$item.number$ $^$$item.description$ ($item.price$)
2002− (Available til $item.sellby$.)
2003−```
2004−
2005−will produce
2006−
2007−```
2008−00123 A fine bottle of 18-year old
2009− Oban whiskey. ($148)
2010− (Available til March 30, 2020.)
2011−```
2012−
2013−If a variable occurs by itself on a line, preceded by whitespace
2014−and not followed by further text or directives on the same line,
2015−and the variable's value contains multiple lines, it will be
2016−nested automatically.
2017−
2018−### Breakable spaces
2019−
2020−Normally, spaces in the template itself (as opposed to values of
2021−the interpolated variables) are not breakable, but they can be
2022−made breakable in part of the template by using the `~` keyword
2023−(ended with another `~`).
2024−
2025−```
2026−$~$This long line may break if the document is rendered
2027−with a short line length.$~$
2028−```
2029−
2030−### Pipes
2031−
2032−A pipe transforms the value of a variable or partial. Pipes are
2033−specified using a slash (`/`) between the variable name (or partial)
2034−and the pipe name. Example:
2035−
2036−```
2037−$for(name)$
2038−$name/uppercase$
2039−$endfor$
2040−
2041−$for(metadata/pairs)$
2042−- $it.key$: $it.value$
2043−$endfor$
2044−
2045−$employee:name()/uppercase$
2046−```
2047−
2048−Pipes may be chained:
2049−
2050−```
2051−$for(employees/pairs)$
2052−$it.key/alpha/uppercase$. $it.name$
2053−$endfor$
2054−```
2055−
2056−Some pipes take parameters:
2057−
2058−```
2059−|----------------------|------------|
2060−$for(employee)$
2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062−$endfor$
2063−|----------------------|------------|
2064−```
2065−
2066−Currently the following pipes are predefined:
2067−
2068−- `pairs`: Converts a map or array to an array of maps,
2069− each with `key` and `value` fields. If the original
2070− value was an array, the `key` will be the array index,
2071− starting with 1.
2072−
2073−- `uppercase`: Converts text to uppercase.
2074−
2075−- `lowercase`: Converts text to lowercase.
2076−
2077−- `length`: Returns the length of the value: number
2078− of characters for a textual value, number of elements
2079− for a map or array.
2080−
2081−- `reverse`: Reverses a textual value or array,
2082− and has no effect on other values.
2083−
2084−- `first`: Returns the first value of an array, if
2085− applied to a non-empty array; otherwise returns
2086− the original value.
2087−
2088−- `last`: Returns the last value of an array, if
2089− applied to a non-empty array; otherwise returns
2090− the original value.
2091−
2092−- `rest`: Returns all but the first value of an array, if
2093− applied to a non-empty array; otherwise returns
2094− the original value.
2095−
2096−- `allbutlast`: Returns all but the last value of an array, if
2097− applied to a non-empty array; otherwise returns
2098− the original value.
1408+or with the `-M/--metadata` option.
20991409
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
1410+Metadata variables
1411+------------------
21351412
21361413`title`, `author`, `date`
21371414: allow identification of basic aspects of the document. Included
@@ -2150,8 +1427,7 @@ Currently the following pipes are predefined:
21501427 including a title block in the document itself, you can
21511428 set the `title-meta`, `author-meta`, and `date-meta`
21521429 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.
1430+ on `title`, `author`, and `date`.)
21551431
21561432`subtitle`
21571433: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
@@ -2197,7 +1473,8 @@ will include `title`, `author` and `description` as standard document
21971473properties and `subtitle` as a custom property when converting to docx,
21981474ODT or pptx.
21991475
2200−### Language variables
1476+Language variables
1477+------------------
22011478
22021479`lang`
22031480: identifies the main language of the document using IETF language
@@ -2225,101 +1502,30 @@ ODT or pptx.
22251502: the base script direction, either `rtl` (right-to-left)
22261503 or `ltr` (left-to-right).
22271504
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].
1505+ For bidirectional documents, native pandoc `span`s and `div`s
1506+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1507+ override the base direction in some output formats.
1508+ This may not always be necessary if the final renderer
1509+ (e.g. the browser, when generating HTML) supports the
1510+ [Unicode Bidirectional Algorithm].
22341511
2235− When using LaTeX for bidirectional documents, only the
2236− `xelatex` engine is fully supported (use
2237− `--pdf-engine=xelatex`).
1512+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1513+ is fully supported (use `--pdf-engine=xelatex`).
22381514
22391515[BCP 47]: https://tools.ietf.org/html/bcp47
2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1516+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
22411517[Language subtag lookup]: https://r12a.github.io/app-subtags/
22421518
2243−### Variables for HTML
2244−
2245−`document-css`
2246−: Enables inclusion of most of the [CSS] in the `styles.html`
2247− [partial](#partials) (have a look with
2248− `pandoc --print-default-data-file=templates/styles.html`).
2249− Unless you use [`--css`](#option--css), this variable
2250− is set to `true` by default. You can disable it with
2251− e.g. `pandoc -M document-css=false`.
2252−
2253−`mainfont`
2254−: sets the CSS `font-family` property on the `html` element.
2255−
2256−`fontsize`
2257−: sets the base CSS `font-size`, which you'd usually set
2258− to e.g. `20px`, but it also accepts `pt`
2259− (12pt = 16px in most browsers).
2260−
2261−`fontcolor`
2262−: sets the CSS `color` property on the `html` element.
2263−
2264−`linkcolor`
2265−: sets the CSS `color` property on all links.
2266−
2267−`monofont`
2268−: sets the CSS `font-family` property on `code` elements.
2269−
2270−`monobackgroundcolor`
2271−: sets the CSS `background-color` property on `code` elements
2272− and adds extra padding.
2273−
2274−`linestretch`
2275−: sets the CSS `line-height` property on the `html` element,
2276− which is preferred to be unitless.
2277−
2278−`backgroundcolor`
2279−: sets the CSS `background-color` property on the `html` element.
2280−
2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282−: sets the corresponding CSS `padding` properties on the `body` element.
2283−
2284−To override or extend some [CSS] for just one document, include for example:
2285−
2286− ---
2287− header-includes: |
2288− <style>
2289− blockquote {
2290− font-style: italic;
2291− }
2292− tr.even {
2293− background-color: #f0f0f0;
2294− }
2295− td, th {
2296− padding: 0.5em 2em 0.5em 0.5em;
2297− }
2298− tbody {
2299− border-bottom: none;
2300− }
2301− </style>
2302− ---
2303−
2304−[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305−
2306−### Variables for HTML math
2307−
2308−`classoption`
2309−: when using [KaTeX](#option--katex), you can render display
2310−math equations flush left using [YAML metadata](#layout) or with
2311−`-M classoption=fleqn`.
2312−
2313−### Variables for HTML slides
1519+Variables for HTML slides
1520+-------------------------
23141521
23151522These affect HTML output when [producing slide shows with pandoc].
23161523
2317−`institute`
2318−: author affiliations: can be a list when there are multiple authors
1524+All [reveal.js configuration options] are available as variables.
1525+To turn off boolean flags that default to true in reveal.js, use `0`.
23191526
23201527`revealjs-url`
2321−: base URL for reveal.js documents (defaults to
2322− `https://unpkg.com/reveal.js@^4/`)
1528+: base URL for reveal.js documents (defaults to `reveal.js`)
23231529
23241530`s5-url`
23251531: base URL for S5 documents (defaults to `s5/default`)
@@ -2331,16 +1537,10 @@ These affect HTML output when [producing slide shows with pandoc].
23311537`slideous-url`
23321538: base URL for Slideous documents (defaults to `slideous`)
23331539
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/
1540+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
23421541
2343−### Variables for Beamer slides
1542+Variables for Beamer slides
1543+---------------------------
23441544
23451545These variables change the appearance of PDF slides using [`beamer`].
23461546
@@ -2369,7 +1569,7 @@ These variables change the appearance of PDF slides using [`beamer`].
23691569: enables "title pages" for new sections (default is true)
23701570
23711571`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2372−: beamer themes
1572+: beamer themes:
23731573
23741574`themeoptions`
23751575: options for LaTeX beamer themes (a list).
@@ -2377,27 +1577,28 @@ These variables change the appearance of PDF slides using [`beamer`].
23771577`titlegraphic`
23781578: image for title slide
23791579
2380−### Variables for PowerPoint
1580+Variables for PowerPoint slide shows
1581+--------------------------------------
23811582
2382−These variables control the visual aspects of a slide show that
2383−are not easily controlled via templates.
1583+These variables control the visual aspects of a slide show that are not easily
1584+controled via templates.
23841585
23851586`monofont`
23861587: font to use for code.
23871588
2388−### Variables for LaTeX
1589+Variables for LaTeX
1590+-------------------
23891591
23901592Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23911593
2392−#### Layout
1594+### Layout
23931595
23941596`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:
1597+: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or
1598+ fifth- and sixth-level with book classes) free-standing rather than run-in;
1599+ requires further formatting to distinguish from `\subsubsection` (third- or
1600+ fourth-level headings). Instead of using this option, [KOMA-Script] can adjust
1601+ headings more extensively:
24011602
24021603 ---
24031604 documentclass: scrartcl
@@ -2423,10 +1624,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24231624 ...
24241625
24251626`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`]
1627+: document class: usually one of the standard classes, [`article`], [`book`],
1628+ and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
1629+ and `scrreprt`, which default to smaller margins; or [`memoir`]
24301630
24311631`geometry`
24321632: option for [`geometry`] package, e.g. `margin=1in`;
@@ -2439,21 +1639,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24391639 - heightrounded
24401640 ...
24411641
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−
24531642`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)
1643+: uses document class settings for indentation (the default LaTeX template
1644+ otherwise removes indentation and adds space between paragraphs)
24571645
24581646`linestretch`
24591647: adjusts line spacing using the [`setspace`]
@@ -2475,11 +1663,11 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24751663: numbering depth for sections (with `--number-sections` option
24761664 or `numbersections` variable)
24771665
2478−#### Fonts
1666+### Fonts
24791667
24801668`fontenc`
2481−: allows font encoding to be specified through `fontenc` package (with
2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
1669+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1670+ default is `T1` (see [LaTeX font encodings guide])
24831671
24841672`fontfamily`
24851673: font package for use with `pdflatex`:
@@ -2499,9 +1687,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24991687 ...
25001688
25011689`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`.
1690+: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
1691+ To use another size, set `documentclass` to one of the [KOMA-Script] classes,
1692+ such as `scrartcl` or `scrbook`.
25051693
25061694`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
25071695: font families for use with `xelatex` or
@@ -2510,10 +1698,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
25101698
25111699`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
25121700: 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:
1701+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1702+ available through [`fontspec`]; repeat for multiple options. For example,
1703+ to use the [TeX Gyre] version of Palatino with lowercase figures:
25171704
25181705 ---
25191706 mainfont: TeX Gyre Pagella
@@ -2525,7 +1712,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
25251712`microtypeoptions`
25261713: options to pass to the microtype package
25271714
2528−#### Links
1715+### Links
25291716
25301717`colorlinks`
25311718: add color to link text; automatically enabled if any of
@@ -2540,7 +1727,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
25401727`links-as-notes`
25411728: causes links to be printed as footnotes
25421729
2543−#### Front matter
1730+### Front matter
25441731
25451732`lof`, `lot`
25461733: include list of figures, list of tables
@@ -2549,13 +1736,12 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
25491736: contents of acknowledgments footnote after document title
25501737
25511738`toc`
2552−: include table of contents (can also be set using
2553− `--toc/--table-of-contents`)
1739+: include table of contents (can also be set using `--toc/--table-of-contents`)
25541740
25551741`toc-depth`
25561742: level of section to include in table of contents
25571743
2558−#### BibLaTeX Bibliographies
1744+### BibLaTeX Bibliographies
25591745
25601746These variables function when using BibLaTeX for [citation rendering].
25611747
@@ -2575,7 +1761,7 @@ These variables function when using BibLaTeX for [citation rendering].
25751761: list of options for natbib
25761762
25771763[KOMA-Script]: https://ctan.org/pkg/koma-script
2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
1764+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
25791765[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
25801766[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
25811767[`article`]: https://ctan.org/pkg/article
@@ -2584,7 +1770,8 @@ These variables function when using BibLaTeX for [citation rendering].
25841770[`memoir`]: https://ctan.org/pkg/memoir
25851771[`report`]: https://ctan.org/pkg/report
25861772
2587−### Variables for ConTeXt
1773+Variables for ConTeXt
1774+---------------------
25881775
25891776Pandoc uses these variables when [creating a PDF] with ConTeXt.
25901777
@@ -2592,12 +1779,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25921779: font size for body text (e.g. `10pt`, `12pt`)
25931780
25941781`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
1782+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
1783+ repeat up to four times for different placement
25971784
25981785`indenting`
2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600− [ConTeXt Indentation]); repeat for multiple options
1786+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
1787+ repeat for multiple options
26011788
26021789`interlinespace`
26031790: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -2608,19 +1795,16 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
26081795 repeat for multiple options
26091796
26101797`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
1798+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
26131799
26141800`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
1801+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
26171802
26181803`lof`, `lot`
26191804: include list of figures, list of tables
26201805
26211806`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
1807+: font families: take the name of any system font (see [ConTeXt Font Switching])
26241808
26251809`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
26261810: sets margins, if `layout` is not used (otherwise `layout`
@@ -2635,38 +1819,34 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
26351819 repeat for multiple options
26361820
26371821`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.
1822+: adds to the preamble the setup necessary to generate PDF/A of the type
1823+ specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
1824+ is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
1825+ block), `1b:2005` will be used as default, for reasons of backwards
1826+ compatibility. Using `--variable=pdfa` without specified value is not supported.
1827+ To successfully generate PDF/A the required ICC color profiles have to
1828+ be available and the content and all included files (such as images)
1829+ have to be standard conforming. The ICC profiles and output intent
1830+ may be specified using the variables `pdfaiccprofile` and `pdfaintent'.
1831+ See also [ConTeXt PDFA] for more details.
26501832
26511833`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
1834+: when used in conjunction with `pdfa', specifies the ICC profile to use
1835+ in the PDF, e.g. `default.cmyk'. If left unspecified, `sRGB.icc' is
26541836 used as default. May be repeated to include multiple profiles. Note that
26551837 the profiles have to be available on the system. They can be obtained
26561838 from [ConTeXt ICC Profiles].
26571839
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.
1840+`pdfaintent'
1841+: when used in conjunction with `pdfa', specifies the output intent for
1842+ the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)'
1843+ If left unspecified, `sRGB IEC61966-2.1' is used as default.
26621844
26631845`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
1846+: include table of contents (can also be set using `--toc/--table-of-contents`)
26661847
26671848`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
1849+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
26701850
26711851`includesource`
26721852: include all source documents as file attachments in the PDF file
@@ -2683,7 +1863,8 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
26831863[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
26841864[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
26851865
2686−### Variables for `wkhtmltopdf`
1866+Variables for `wkhtmltopdf`
1867+---------------------------
26871868
26881869Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
26891870The `--css` option also affects the output.
@@ -2697,7 +1878,8 @@ The `--css` option also affects the output.
26971878`papersize`
26981879: sets the PDF paper size
26991880
2700−### Variables for man pages
1881+Variables for man pages
1882+-----------------------
27011883
27021884`adjusting`
27031885: adjusts text to left (`l`), right (`r`), center (`c`),
@@ -2715,7 +1897,8 @@ The `--css` option also affects the output.
27151897`section`
27161898: section number in man pages
27171899
2718−### Variables for ms
1900+Variables for ms
1901+----------------
27191902
27201903`fontfamily`
27211904: font family (e.g. `T` or `P`)
@@ -2729,7 +1912,8 @@ The `--css` option also affects the output.
27291912`pointsize`
27301913: point size (e.g. `10p`)
27311914
2732−### Variables set automatically
1915+Structural variables
1916+--------------------
27331917
27341918Pandoc sets these variables automatically in response to [options] or
27351919document contents; users can also modify them. These vary depending
@@ -2769,9 +1953,9 @@ on the output format, and include the following:
27691953
27701954`sourcefile`, `outputfile`
27711955: 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:
1956+ `sourcefile` can also be a list if input comes from multiple files, or empty
1957+ if input is from stdin. You can use the following snippet in your template
1958+ to distinguish them:
27751959
27761960 $if(sourcefile)$
27771961 $for(sourcefile)$
@@ -2793,11 +1977,82 @@ on the output format, and include the following:
27931977
27941978`toc-title`
27951979: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
1980+ opendocument, odt, docx, pptx, beamer, LaTeX)
1981+
1982+Using variables in templates
1983+----------------------------
1984+
1985+Variable names are sequences of alphanumerics, `-`, and `_`,
1986+starting with a letter. A variable name surrounded by `$` signs
1987+will be replaced by its value. For example, the string `$title$` in
1988+
1989+ <title>$title$</title>
1990+
1991+will be replaced by the document title.
1992+
1993+To write a literal `$` in a template, use `$$`.
1994+
1995+Templates may contain conditionals. The syntax is as follows:
1996+
1997+ $if(variable)$
1998+ X
1999+ $else$
2000+ Y
2001+ $endif$
2002+
2003+This will include `X` in the template if `variable` has a truthy
2004+value; otherwise it will include `Y`. Here a truthy value is any
2005+of the following:
2006+
2007+- a string that is not entirely white space,
2008+- a non-empty array where the first value is truthy,
2009+- any number (including zero),
2010+- any object,
2011+- the boolean `true` (to specify the boolean `true`
2012+ value using YAML metadata or the `--metadata` flag,
2013+ use `true`, `True`, or `TRUE`; with the `--variable`
2014+ flag, simply omit a value for the variable, e.g.
2015+ `--variable draft`).
2016+
2017+`X` and `Y` are placeholders for any valid template text,
2018+and may include interpolated variables or other conditionals.
2019+The `$else$` section may be omitted.
2020+
2021+When variables can have multiple values (for example, `author` in
2022+a multi-author document), you can use the `$for$` keyword:
2023+
2024+ $for(author)$
2025+ <meta name="author" content="$author$" />
2026+ $endfor$
2027+
2028+You can optionally specify a separator to be used between
2029+consecutive items:
2030+
2031+ $for(author)$$author$$sep$, $endfor$
2032+
2033+Note that the separator needs to be specified immediately before the `$endfor`
2034+keyword.
2035+
2036+A dot can be used to select a field of a variable that takes
2037+an object as its value. So, for example:
2038+
2039+ $author.name$ ($author.affiliation$)
2040+
2041+The value of a variable will be indented to the same level as the variable.
2042+
2043+If you use custom templates, you may need to revise them as pandoc
2044+changes. We recommend tracking the changes in the default templates,
2045+and modifying your custom templates accordingly. An easy way to do this
2046+is to fork the [pandoc-templates] repository and merge in changes after each
2047+pandoc release.
2048+
2049+Templates may contain comments: anything on a line after `$--`
2050+will be treated as a comment and ignored.
27972051
27982052[pandoc-templates]: https://github.com/jgm/pandoc-templates
27992053
2800−# Extensions
2054+Extensions
2055+==========
28012056
28022057The behavior of some of the readers and writers can be adjusted by
28032058enabling or disabling various extensions.
@@ -2818,7 +2073,8 @@ Note that markdown extensions added to the `ipynb` format
28182073affect Markdown cells in Jupyter notebooks (as do command-line
28192074options like `--atx-headers`).
28202075
2821−## Typography
2076+Typography
2077+----------
28222078
28232079#### Extension: `smart` ####
28242080
@@ -2850,7 +2106,8 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
28502106to use the ligatures when possible; if `smart` is disabled
28512107pandoc will use unicode quotation mark and dash characters.
28522108
2853−## Headings and sections
2109+Headings and sections
2110+---------------------
28542111
28552112#### Extension: `auto_identifiers` ####
28562113
@@ -2931,9 +2188,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
29312188GitHub's method. Spaces are converted to dashes (`-`),
29322189uppercase characters to lowercase characters, and punctuation
29332190characters other than `-` and `_` are removed.
2934−Emojis are replaced by their names.
29352191
2936−## Math Input
2192+Math Input
2193+----------
29372194
29382195The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
29392196[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2943,47 +2200,59 @@ are described in the section about Pandoc's Markdown.
29432200However, they can also be used with HTML input. This is handy for
29442201reading web pages formatted using MathJax, for example.
29452202
2946−## Raw HTML/TeX
2203+Raw HTML/TeX
2204+------------
2205+
2206+The following extensions (especially how they affect Markdown
2207+input/output) are also described in more detail in their respective
2208+sections of [Pandoc's Markdown].
2209+
2210+#### Extension: `raw_html` {#raw_html}
2211+
2212+When converting from HTML, parse elements to raw HTML which are not
2213+representable in pandoc's AST.
2214+By default, this is disabled for HTML input.
2215+
2216+#### Extension: `raw_tex` {#raw_tex}
2217+
2218+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
2219+
2220+This extension can be enabled/disabled for the following formats
2221+(in addition to `markdown`):
29472222
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
2223+input formats
2224+: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2225+ `\eqref` only), `ipynb`
2226+
2227+output formats
2228+: `textile`, `commonmark`
2229+
2230+Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2231+only raw TeX in markdown cells, but data with mime type
2232+`text/html` in output cells. Since the `ipynb` reader attempts
2233+to preserve the richest possible outputs when several options
2234+are given, you will get best results if you disable `raw_html`
2235+and `raw_tex` when converting to formats like `docx` which don't
2236+allow raw `html` or `tex`.
29502237
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.
2238+#### Extension: `native_divs` {#native_divs}
29542239
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`):
2240+This extension is enabled by default for HTML input. This means that
2241+`div`s are parsed to pandoc native elements. (Alternatively, you
2242+can parse them to raw HTML using `-f html-native_divs+raw_html`.)
29582243
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
2244+When converting HTML to Markdown, for example, you may want to drop all
2245+`div`s and `span`s:
29622246
2963− output formats
2964− : `textile`, `commonmark`
2247+ pandoc -f html-native_divs-native_spans -t markdown
29652248
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`.
2249+#### Extension: `native_spans` {#native_spans}
29732250
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`.
2251+Analogous to `native_divs` above.
29782252
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`.
29852253
2986−## Literate Haskell support
2254+Literate Haskell support
2255+------------------------
29872256
29882257#### Extension: `literate_haskell` ####
29892258
@@ -3044,7 +2313,8 @@ Note that GHC expects the bird tracks in the first column, so indented
30442313literate code blocks (e.g. inside an itemized environment) will not be
30452314picked up by the Haskell compiler.
30462315
3047−## Other extensions
2316+Other extensions
2317+----------------
30482318
30492319#### Extension: `empty_paragraphs` ####
30502320
@@ -3059,99 +2329,38 @@ input formats
30592329output formats
30602330: `docx`, `odt`, `opendocument`, `html`
30612331
3062−#### Extension: `native_numbering` ####
3063−
3064−Enables native numbering of figures and tables. Enumeration
3065−starts at 1.
2332+#### Extension: `styles` #### {#ext-styles}
30662333
3067−This extension can be enabled/disabled for the following formats:
2334+When converting from docx, read all docx styles as divs (for
2335+paragraph styles) and spans (for character styles) regardless
2336+of whether pandoc understands the meaning of these styles.
2337+This can be used with [docx custom styles](#custom-styles).
2338+Disabled by default.
30682339
3069−output formats
3070−: `odt`, `opendocument`
2340+input formats
2341+: `docx`
30712342
3072−#### Extension: `xrefs_name` ####
3073−
3074−Links to headings, figures and tables inside the document are
3075−substituted with cross-references that will use the name or caption
3076−of the referenced item. The original link text is replaced once
3077−the generated document is refreshed. This extension can be combined
3078−with `xrefs_number` in which case numbers will appear before the
3079−name.
3080−
3081−Text in cross-references is only made consistent with the referenced
3082−item once the document has been refreshed.
3083−
3084−This extension can be enabled/disabled for the following formats:
3085−
3086−output formats
3087−: `odt`, `opendocument`
3088−
3089−#### Extension: `xrefs_number` ####
3090−
3091−Links to headings, figures and tables inside the document are
3092−substituted with cross-references that will use the number
3093−of the referenced item. The original link text is discarded.
3094−This extension can be combined with `xrefs_name` in which case
3095−the name or caption numbers will appear after the number.
3096−
3097−For the `xrefs_number` to be useful heading numbers must be enabled
3098−in the generated document, also table and figure captions must be enabled
3099−using for example the `native_numbering` extension.
3100−
3101−Numbers in cross-references are only visible in the final document once
3102−it has been refreshed.
3103−
3104−This extension can be enabled/disabled for the following formats:
3105−
3106−output formats
3107−: `odt`, `opendocument`
3108−
3109−#### Extension: `styles` #### {#ext-styles}
3110−
3111−When converting from docx, read all docx styles as divs (for
3112−paragraph styles) and spans (for character styles) regardless
3113−of whether pandoc understands the meaning of these styles.
3114−This can be used with [docx custom styles](#custom-styles).
3115−Disabled by default.
3116−
3117−input formats
3118−: `docx`
3119−
3120−#### Extension: `amuse` ####
2343+#### Extension: `amuse` ####
31212344
31222345In the `muse` input format, this enables Text::Amuse
31232346extensions to Emacs Muse markup.
31242347
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−
31332348#### Extension: `citations` {#org-citations}
31342349
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.
2350+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
2351+in `org` input.
31442352
31452353#### Extension: `ntb` ####
31462354
31472355In 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).
2356+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
2357+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
31502358Natural tables allow more fine-grained global customization but come
31512359at a performance penalty compared to extreme tables.
31522360
31532361
3154−# Pandoc's Markdown
2362+Pandoc's Markdown
2363+=================
31552364
31562365Pandoc understands an extended and slightly revised version of
31572366John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -3161,7 +2370,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the
31612370behavior more granularly. They are described in the following. See also
31622371[Extensions] above, for extensions that work also on other formats.
31632372
3164−## Philosophy
2373+Philosophy
2374+----------
31652375
31662376Markdown is designed to be easy to write, and, even more importantly,
31672377easy to read:
@@ -3169,7 +2379,7 @@ easy to read:
31692379> A Markdown-formatted document should be publishable as-is, as plain
31702380> text, without looking like it's been marked up with tags or formatting
31712381> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2382+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
31732383
31742384This principle has guided pandoc's decisions in finding syntax for
31752385tables, footnotes, and other extensions.
@@ -3182,7 +2392,8 @@ it discourages it, and provides other, non-HTMLish ways of representing
31822392important document elements like definition lists, tables, mathematics, and
31832393footnotes.
31842394
3185−## Paragraphs
2395+Paragraphs
2396+----------
31862397
31872398A paragraph is one or more lines of text followed by one or more blank lines.
31882399Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -3195,7 +2406,8 @@ Note: in multiline and grid table cells, this is the only way
31952406to create a hard line break, since trailing spaces in the cells
31962407are ignored.
31972408
3198−## Headings
2409+Headings
2410+--------
31992411
32002412There are two kinds of headings: Setext and ATX.
32012413
@@ -3248,8 +2460,7 @@ pandoc does require the space.
32482460
32492461### Heading identifiers ###
32502462
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
2463+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
32532464
32542465#### Extension: `header_attributes` ####
32552466
@@ -3287,11 +2498,6 @@ is just the same as
32872498
32882499 # My heading {.unnumbered}
32892500
3290−If the `unlisted` class is present in addition to `unnumbered`,
3291−the heading will not be included in a table of contents.
3292−(Currently this feature is only implemented for certain
3293−formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3294−
32952501#### Extension: `implicit_header_references` ####
32962502
32972503Pandoc behaves as if reference links have been defined for each heading.
@@ -3332,7 +2538,8 @@ link will point to `bar`, not to `#foo`:
33322538
33332539 See [foo]
33342540
3335−## Block quotations
2541+Block quotations
2542+----------------
33362543
33372544Markdown uses email conventions for quoting blocks of text.
33382545A block quotation is one or more paragraphs or other block elements
@@ -3371,19 +2578,19 @@ block in a block quote, you need five spaces after the `>`:
33712578
33722579#### Extension: `blank_before_blockquote` ####
33732580
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
2581+Standard Markdown syntax does not require a blank line before a block
2582+quote. Pandoc does require this (except, of course, at the beginning of the
2583+document). The reason for the requirement is that it is all too easy for a
2584+`>` to end up at the beginning of a line by accident (perhaps through line
2585+wrapping). So, unless the `markdown_strict` format is used, the following does
33802586not produce a nested block quote in pandoc:
33812587
33822588 > This is a block quote.
33832589 >> Nested.
33842590
33852591
3386−## Verbatim (code) blocks
2592+Verbatim (code) blocks
2593+----------------------
33872594
33882595### Indented code blocks ###
33892596
@@ -3445,16 +2652,14 @@ this syntax:
34452652 qsort (filter (>= x) xs)
34462653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34472654
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:
2655+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
2656+`startFrom` is an attribute with value `100`. Some output formats can use this
2657+information to do syntax highlighting. Currently, the only output formats
2658+that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2659+highlighting is supported for your output format and language, then the code
2660+block above will appear highlighted, with numbered lines. (To see which
2661+languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
2662+the code block above will appear as follows:
34582663
34592664 <pre id="mycode" class="haskell numberLines" startFrom="100">
34602665 <code>
@@ -3491,7 +2696,8 @@ To set the highlighting style, use `--highlight-style`.
34912696For more information on highlighting, see [Syntax highlighting],
34922697below.
34932698
3494−## Line blocks
2699+Line blocks
2700+-----------
34952701
34962702#### Extension: `line_blocks` ####
34972703
@@ -3517,12 +2723,10 @@ line must begin with a space.
35172723 | 200 Main St.
35182724 | Berkeley, CA 94718
35192725
3520−Inline formatting (such as emphasis) is allowed in the content,
3521−but not block-level formatting (such as block quotes or lists).
3522−
35232726This syntax is borrowed from [reStructuredText].
35242727
3525−## Lists
2728+Lists
2729+-----
35262730
35272731### Bullet lists ###
35282732
@@ -3723,12 +2927,11 @@ a blank line, and must be followed by one or more definitions.
37232927A definition begins with a colon or tilde, which may be indented one
37242928or two spaces.
37252929
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
2930+A term may have multiple definitions, and each definition may consist of one or
2931+more block elements (paragraph, code block, list, etc.), each indented four
2932+spaces or one tab stop. The body of the definition (including the first line,
2933+aside from the colon or tilde) should be indented four spaces. However,
2934+as with other Markdown lists, you can "lazily" omit indentation except
37322935at the beginning of a paragraph or other block element:
37332936
37342937 Term 1
@@ -3754,10 +2957,9 @@ definition:
37542957Note that space between items in a definition list is required.
37552958(A variant that loosens this requirement, but disallows "lazy"
37562959hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2960+[Non-pandoc extensions], below.)
37582961
3759−[^3]: I have been influenced by the suggestions of [David
3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2962+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
37612963
37622964### Numbered example lists ###
37632965
@@ -3793,6 +2995,30 @@ list marker. That is, example lists always behave as if the
37932995labels tend to be long, and indenting content to the
37942996first non-space character after the label would be awkward.
37952997
2998+### Compact and loose lists ###
2999+
3000+Pandoc behaves differently from `Markdown.pl` on some "edge
3001+cases" involving lists. Consider this source:
3002+
3003+ + First
3004+ + Second:
3005+ - Fee
3006+ - Fie
3007+ - Foe
3008+
3009+ + Third
3010+
3011+Pandoc transforms this into a "compact list" (with no `<p>` tags around
3012+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3013+"Second" and "Third" (but not "First"), because of the blank space
3014+around "Third". Pandoc follows a simple rule: if the text is followed by
3015+a blank line, it is treated as a paragraph. Since "Second" is followed
3016+by a list, and not a blank line, it isn't treated as a paragraph. The
3017+fact that the list is followed by a blank line is irrelevant. (Note:
3018+Pandoc works this way even when the `markdown_strict` format is specified. This
3019+behavior is consistent with the official Markdown syntax description,
3020+even though it is different from that of `Markdown.pl`.)
3021+
37963022
37973023### Ending a list ###
37983024
@@ -3831,7 +3057,8 @@ of one big list:
38313057 2. dos
38323058 3. tres
38333059
3834−## Horizontal rules
3060+Horizontal rules
3061+----------------
38353062
38363063A line containing a row of three or more `*`, `-`, or `_` characters
38373064(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +3068,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
38413068 ---------------
38423069
38433070
3844−## Tables
3071+Tables
3072+------
38453073
38463074Four kinds of tables may be used. The first three kinds presuppose the use of
38473075a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3968,8 +3196,9 @@ The row of `=`s separates the header from the table body, and can be
39683196omitted for a headerless table. The cells of grid tables may contain
39693197arbitrary block elements (multiple paragraphs, code blocks, lists,
39703198etc.). 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`).
3199+supported. Grid tables can be created easily using [Emacs table mode].
3200+
3201+[Emacs table mode]: http://table.sourceforge.net/
39733202
39743203Alignments can be specified as with pipe tables, by putting
39753204colons at the boundaries of the separator line after the
@@ -3997,7 +3226,7 @@ and the same number of rows in each column. For example, the
39973226Docutils [sample grid tables] will not render as expected with
39983227Pandoc.
39993228
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3229+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
40013230
40023231
40033232#### Extension: `pipe_tables` ####
@@ -4030,7 +3259,7 @@ legal (though ugly) pipe table:
40303259
40313260The cells of pipe tables cannot contain block elements like paragraphs
40323261and lists, and cannot span multiple lines. If a pipe table contains a
4033−row whose Markdown content is wider than the column width (see
3262+row whose printable content is wider than the column width (see
40343263`--columns`), then the table will take up the full text width and
40353264the cell contents will wrap, with the relative cell widths determined
40363265by the number of dashes in the line separating the table header from
@@ -4054,7 +3283,8 @@ you'll need to add colons as above.
40543283
40553284[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
40563285
4057−## Metadata blocks
3286+Metadata blocks
3287+---------------
40583288
40593289#### Extension: `pandoc_title_block` ####
40603290
@@ -4070,42 +3300,30 @@ output.) The block may contain just a title, a title and an author,
40703300or all three elements. If you want to include an author but no
40713301title, or a title and a date but no author, you need a blank line:
40723302
4073−```
4074−%
4075−% Author
4076−```
3303+ %
3304+ % Author
40773305
4078−```
4079−% My title
4080−%
4081−% June 15, 2006
4082−```
3306+ % My title
3307+ %
3308+ % June 15, 2006
40833309
40843310The title may occupy multiple lines, but continuation lines must
40853311begin with leading space, thus:
40863312
4087−```
4088−% My title
4089− on multiple lines
4090−```
3313+ % My title
3314+ on multiple lines
40913315
40923316If a document has multiple authors, the authors may be put on
40933317separate lines with leading space, or separated by semicolons, or
40943318both. So, all of the following are equivalent:
40953319
4096−```
4097−% Author One
4098− Author Two
4099−```
3320+ % Author One
3321+ Author Two
41003322
4101−```
4102−% Author One; Author Two
4103−```
3323+ % Author One; Author Two
41043324
4105−```
4106−% Author One;
4107− Author Two
4108−```
3325+ % Author One;
3326+ Author Two
41093327
41103328The date must fit on one line.
41113329
@@ -4169,9 +3387,9 @@ given a role by external processors.) Field names must not be
41693387interpretable as YAML numbers or boolean values (so, for
41703388example, `yes`, `True`, and `15` cannot be used as field names).
41713389
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.
3390+A document may contain multiple metadata blocks. The metadata fields will
3391+be combined through a *left-biased union*: if two metadata blocks attempt
3392+to set the same field, the value from the first block will be taken.
41753393
41763394When pandoc is used with `-t markdown` to create a Markdown document,
41773395a YAML metadata block will be produced only if the `-s/--standalone`
@@ -4179,12 +3397,10 @@ option is used. All of the metadata will appear in a single block
41793397at the beginning of the document.
41803398
41813399Note 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:
3400+if a title contains a colon, it must be quoted. The pipe character
3401+(`|`) can be used to begin an indented block that will be interpreted
3402+literally, without need for escaping. This form is necessary
3403+when the field contains blank lines or block-level formatting:
41883404
41893405 ---
41903406 title: 'This is the title: it contains a colon'
@@ -4198,12 +3414,6 @@ or block-level formatting:
41983414 It consists of two paragraphs.
41993415 ...
42003416
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−
42073417Template variables will be set automatically from the metadata. Thus, for
42083418example, in writing HTML, the variable `abstract` will be set to the HTML
42093419equivalent of the Markdown in the `abstract` field:
@@ -4250,25 +3460,8 @@ will be interpreted as markdown. For example:
42503460 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
42513461 ```
42523462
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
3463+Backslash escapes
3464+-----------------
42723465
42733466#### Extension: `all_symbols_escapable` ####
42743467
@@ -4294,12 +3487,9 @@ which allows only the following characters to be backslash-escaped:
42943487(However, if the `markdown_strict` format is used, the standard Markdown rule
42953488will be used.)
42963489
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).
3490+A backslash-escaped space is parsed as a nonbreaking space. It will
3491+appear in TeX output as `~` and in HTML and XML as `\ ` or
3492+`\ `.
43033493
43043494A backslash-escaped newline (i.e. a backslash occurring at the end of
43053495a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +3499,8 @@ two trailing spaces on a line.
43093499
43103500Backslash escapes do not work in verbatim contexts.
43113501
4312−## Inline formatting
3502+Inline formatting
3503+-----------------
43133504
43143505### Emphasis ###
43153506
@@ -4357,13 +3548,12 @@ text by `~` characters. Thus, for example,
43573548
43583549 H~2~O is a liquid. 2^10^ is 1024.
43593550
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~`.
3551+If the superscripted or subscripted text contains spaces, these spaces
3552+must be escaped with backslashes. (This is to prevent accidental
3553+superscripting and subscripting through the ordinary use of `~` and `^`.)
3554+Thus, if you want the letter P with 'a cat' in subscripts, use
3555+`P~a\ cat~`, not `P~a cat~`.
3556+
43673557
43683558### Verbatim ###
43693559
@@ -4412,7 +3602,8 @@ For compatibility with other Markdown flavors, CSS is also supported:
44123602This will work in all output formats that support small caps.
44133603
44143604
4415−## Math
3605+Math
3606+----
44163607
44173608#### Extension: `tex_math_dollars` ####
44183609
@@ -4424,10 +3615,6 @@ left, and must not be followed immediately by a digit. Thus,
44243615you need to enclose text in literal `$` characters, backslash-escape
44253616them and they won't be treated as math delimiters.
44263617
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−
44313618TeX math will be printed in all output formats. How it is rendered
44323619depends on the output format:
44333620
@@ -4489,9 +3676,10 @@ HTML, Slidy, DZSlides, S5, EPUB
44893676 command-line options selected. Therefore see [Math rendering in HTML]
44903677 above.
44913678
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3679+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
44933680
4494−## Raw HTML
3681+Raw HTML
3682+--------
44953683
44963684#### Extension: `raw_html` ####
44973685
@@ -4529,7 +3717,7 @@ Thus, for example, pandoc will turn
45293717 <table>
45303718 <tr>
45313719 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3720+ <td>[a link](http://google.com)</td>
45333721 </tr>
45343722 </table>
45353723
@@ -4538,14 +3726,14 @@ into
45383726 <table>
45393727 <tr>
45403728 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3729+ <td><a href="http://google.com">a link</a></td>
45423730 </tr>
45433731 </table>
45443732
45453733whereas `Markdown.pl` will preserve it as is.
45463734
4547−There is one exception to this rule: text between `<script>`,
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3735+There is one exception to this rule: text between `<script>` and
3736+`<style>` tags is not interpreted as Markdown.
45493737
45503738This departure from standard Markdown should make it easier to mix
45513739Markdown with HTML block elements. For example, one can surround
@@ -4637,7 +3825,8 @@ example, to use a raw attribute with a backtick code block,
46373825
46383826The raw attribute cannot be combined with regular attributes.
46393827
4640−## LaTeX macros
3828+LaTeX macros
3829+------------
46413830
46423831#### Extension: `latex_macros` ####
46433832
@@ -4658,13 +3847,11 @@ When `latex_macros` is disabled, the raw LaTeX and math will
46583847not have macros applied. This is usually a better approach when
46593848you are targeting LaTeX or PDF.
46603849
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.
3850+Whether or not `latex_macros` is enabled, the macro definitions
3851+will still be passed through as raw LaTeX.
46663852
4667−## Links
3853+Links
3854+-----
46683855
46693856Markdown allows links to be specified in several ways.
46703857
@@ -4673,7 +3860,7 @@ Markdown allows links to be specified in several ways.
46733860If you enclose a URL or email address in pointy brackets, it
46743861will become a link:
46753862
4676− <https://google.com>
3863+ <http://google.com>
46773864 <sam@green.eggs.ham>
46783865
46793866### Inline links ###
@@ -4683,7 +3870,7 @@ followed by the URL in parentheses. (Optionally, the URL can
46833870be followed by a link title, in quotes.)
46843871
46853872 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3873+ a title](http://fsf.org "click here for a good time!").
46873874
46883875There can be no space between the bracketed part and the parenthesized part.
46893876The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3899,7 @@ Here are some examples:
47123899
47133900 [my label 1]: /foo/bar.html "My title, optional"
47143901 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3902+ [my label 3]: http://fsf.org (The free software foundation)
47163903 [my label 4]: /bar#special 'A title in single quotes'
47173904
47183905The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3908,7 @@ The URL may optionally be surrounded by angle brackets:
47213908
47223909The title may go on the next line:
47233910
4724− [my label 3]: https://fsf.org
3911+ [my label 3]: http://fsf.org
47253912 "The free software foundation"
47263913
47273914Note that link labels are not case sensitive. So, this will work:
@@ -4772,7 +3959,8 @@ or
47723959Internal links are currently supported for HTML formats (including
47733960HTML slide shows and EPUB), LaTeX, and ConTeXt.
47743961
4775−## Images
3962+Images
3963+------
47763964
47773965A link immediately preceded by a `!` will be treated as an image.
47783966The link text will be used as the image's alt text:
@@ -4834,12 +4022,10 @@ For example:
48344022{ width=50% }
48354023```
48364024
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).
4025+- Dimensions are converted to inches for output in page-based formats like
4026+ LaTeX. Dimensions are converted to pixels for output in HTML-like
4027+ formats. Use the `--dpi` option to specify the number of pixels per
4028+ inch. The default is 96dpi.
48434029- The `%` unit is generally relative to some available space.
48444030 For example the above example will render to the following.
48454031 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -4848,13 +4034,14 @@ For example:
48484034 as in the default template.)
48494035 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
48504036- Some output formats have a notion of a class
4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4037+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
48524038 or a unique identifier (LaTeX `\caption`), or both (HTML).
48534039- When no `width` or `height` attributes are specified, the fallback
48544040 is to look at the image resolution and the dpi metadata embedded in
48554041 the image file.
48564042
4857−## Divs and Spans
4043+Divs and Spans
4044+--------------
48584045
48594046Using the `native_divs` and `native_spans` extensions
48604047(see [above][Extension: `native_divs`]), HTML syntax can
@@ -4910,7 +4097,8 @@ followed immediately by attributes:
49104097
49114098 [This is *some text*]{.class key="val"}
49124099
4913−## Footnotes
4100+Footnotes
4101+---------
49144102
49154103#### Extension: `footnotes` ####
49164104
@@ -4956,72 +4144,143 @@ they cannot contain multiple paragraphs). The syntax is as follows:
49564144
49574145Inline and regular footnotes may be mixed freely.
49584146
4959−## Citation syntax
4147+Citations
4148+---------
49604149
49614150#### Extension: `citations` ####
49624151
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:
4152+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4153+citations and a bibliography in a number of styles. Basic usage is
4154+
4155+ pandoc --filter pandoc-citeproc myinput.txt
4156+
4157+In order to use this feature, you will need to specify a bibliography file
4158+using the `bibliography` metadata field in a YAML metadata section, or
4159+`--bibliography` command line argument. You can supply multiple `--bibliography`
4160+arguments or set `bibliography` metadata field to YAML array, if you want to
4161+use multiple bibliography files. The bibliography may have any of these
4162+formats:
4163+
4164+ Format File extension
4165+ ------------ --------------
4166+ BibLaTeX .bib
4167+ BibTeX .bibtex
4168+ Copac .copac
4169+ CSL JSON .json
4170+ CSL YAML .yaml
4171+ EndNote .enl
4172+ EndNote XML .xml
4173+ ISI .wos
4174+ MEDLINE .medline
4175+ MODS .mods
4176+ RIS .ris
49664177
4967− Blah blah [@doe99; @smith2000; @smith2004].
4178+Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4179+use `.bibtex` to force BibTeX.
49684180
4969−How this is rendered depends on the citation style. In an
4970−author-date style, it might render as
4181+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4182+can produce `.json` and `.yaml` files from any of the supported formats.
49714183
4972− Blah blah (Doe 1999, Smith 2000, 2004).
4184+In-field markup: In BibTeX and BibLaTeX databases,
4185+pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4186+databases, pandoc Markdown; and in CSL JSON databases, an
4187+[HTML-like markup][CSL markup specs]:
49734188
4974−In a footnote style, it might render as
4189+`<i>...</i>`
4190+: italics
49754191
4976− Blah blah.[^1]
4192+`<b>...</b>`
4193+: bold
49774194
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).
4195+`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4196+: small capitals
49814197
4982−See the [CSL user documentation] for more information about CSL
4983−styles and how they affect rendering.
4198+`<sub>...</sub>`
4199+: subscript
49844200
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]`.
4201+`<sup>...</sup>`
4202+: superscript
49944203
4995−Citation items may optionally include a prefix, a locator, and
4996−a suffix. In
4204+`<span class="nocase">...</span>`
4205+: prevent a phrase from being capitalized as title case
49974206
4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4207+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4208+and CSL YAML formats as far as possible.
49994209
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.
4210+As an alternative to specifying a bibliography file using `--bibliography`
4211+or the YAML metadata field `bibliography`, you can include
4212+the citation data directly in the `references` field of the
4213+document's YAML metadata. The field should contain an array of
4214+YAML-encoded references, for example:
50034215
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
4216+ ---
4217+ references:
4218+ - type: article-journal
4219+ id: WatsonCrick1953
4220+ author:
4221+ - family: Watson
4222+ given: J. D.
4223+ - family: Crick
4224+ given: F. H. C.
4225+ issued:
4226+ date-parts:
4227+ - - 1953
4228+ - 4
4229+ - 25
4230+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4231+ nucleic acid'
4232+ title-short: Molecular structure of nucleic acids
4233+ container-title: Nature
4234+ volume: 171
4235+ issue: 4356
4236+ page: 737-738
4237+ DOI: 10.1038/171737a0
4238+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4239+ language: en-GB
4240+ ...
4241+
4242+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4243+of the supported formats.)
4244+
4245+Citations and references can be formatted using any style supported by the
4246+[Citation Style Language], listed in the [Zotero Style Repository].
4247+These files are specified using the `--csl` option or the `csl` metadata field.
4248+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4249+format. The CSL project provides further information on [finding and editing styles].
4250+
4251+To make your citations hyperlinks to the corresponding bibliography
4252+entries, add `link-citations: true` to your YAML metadata.
4253+
4254+Citations go inside square brackets and are separated by semicolons.
4255+Each citation must have a key, composed of '@' + the citation
4256+identifier from the database, and may optionally have a prefix,
4257+a locator, and a suffix. The citation key must begin with a letter, digit,
4258+or `_`, and may contain alphanumerics, `_`, and internal punctuation
4259+characters (`:.#$%&-+?<>~/`). Here are some examples:
4260+
4261+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4262+
4263+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4264+
4265+ Blah blah [@smith04; @doe99].
4266+
4267+`pandoc-citeproc` detects locator terms in the [CSL locale files].
4268+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4269+locale, locator terms can be written in either singular or plural forms,
4270+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4271+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4272+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4273+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4274+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4275+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
50164276locator term is used, "page" is assumed.
50174277
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:
4278+`pandoc-citeproc` will use heuristics to distinguish the locator
4279+from the suffix. In complex cases, the locator can be enclosed
4280+in curly braces (using `pandoc-citeproc` 0.15 and higher only):
50214281
50224282 [@smith{ii, A, D-Z}, with a suffix]
50234283 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024− [@smith{}, 99 years later]
50254284
50264285A minus sign (`-`) before the `@` will suppress mention of
50274286the author in the citation. This can be useful when the
@@ -5029,103 +4288,83 @@ author is already mentioned in the text:
50294288
50304289 Smith says blah [-@smith04].
50314290
5032−You can also write an author-in-text citation, by omitting the
5033−square brackets:
4291+You can also write an in-text citation, as follows:
50344292
50354293 @smith04 says blah.
50364294
50374295 @smith04 [p. 33] says blah.
50384296
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
4297+If the style calls for a list of works cited, it will be placed
4298+in a div with id `refs`, if one exists:
4299+
4300+ ::: {#refs}
4301+ :::
4302+
4303+Otherwise, it will be placed at the end of the document.
4304+Generation of the bibliography can be suppressed by setting
4305+`suppress-bibliography: true` in the YAML metadata.
4306+
4307+If you wish the bibliography to have a section heading, you can
4308+set `reference-section-title` in the metadata, or put the heading
4309+at the beginning of the div with id `refs` (if you are using it)
4310+or at the end of your document:
4311+
4312+ last paragraph...
4313+
4314+ # References
4315+
4316+The bibliography will be inserted after this heading. Note that
4317+the `unnumbered` class will be added to this heading, so that the
4318+section will not be numbered.
4319+
4320+If you want to include items in the bibliography without actually
4321+citing them in the body text, you can define a dummy `nocite` metadata
4322+field and put the citations there:
4323+
4324+ ---
4325+ nocite: |
4326+ @item1, @item2
4327+ ...
4328+
4329+ @item3
4330+
4331+In this example, the document will contain a citation for `item3`
4332+only, but the bibliography will contain entries for `item1`, `item2`, and
4333+`item3`.
4334+
4335+It is possible to create a bibliography with all the citations,
4336+whether or not they appear in the document, by using a wildcard:
4337+
4338+ ---
4339+ nocite: |
4340+ @*
4341+ ...
4342+
4343+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4344+render the bibliography. In order to do so, specify bibliography
4345+files as outlined above, and add `--natbib` or `--biblatex`
4346+argument to `pandoc` invocation. Bear in mind that bibliography
4347+files have to be in respective format (either BibTeX or
4348+BibLaTeX).
4349+
4350+For more information, see the [pandoc-citeproc man page].
4351+
4352+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4353+[Chicago Manual of Style]: http://chicagomanualofstyle.org
4354+[Citation Style Language]: http://citationstyles.org
50564355[Zotero Style Repository]: https://www.zotero.org/styles
50574356[finding and editing styles]: https://citationstyles.org/authors/
50584357[CSL locale files]: https://github.com/citation-style-language/locales
4358+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
50594359
5060−## Non-default extensions
4360+Non-pandoc extensions
4361+---------------------
50614362
50624363The following Markdown syntax extensions are not enabled by default
50634364in pandoc, but may be enabled by adding `+EXTENSION` to the format
50644365name, where `EXTENSION` is the name of the extension. Thus, for
50654366example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
50664367
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−
51294368#### Extension: `old_dashes` ####
51304369
51314370Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -5238,7 +4477,7 @@ and image references. This extension should not be confused with the
52384477
52394478 This is a reference ![image][ref] with multimarkdown attributes.
52404479
5241− [ref]: https://path.to/image "Image title" width=20px height=30px
4480+ [ref]: http://path.to/image "Image title" width=20px height=30px
52424481 id=myId class="myClass1 myClass2"
52434482
52444483#### Extension: `mmd_header_identifiers` ####
@@ -5273,390 +4512,60 @@ in several respects:
52734512 we must either disallow lazy wrapping or require a blank line between
52744513 list items.
52754514
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
4515+Markdown variants
4516+-----------------
52924517
52934518In addition to pandoc's extended Markdown, the following Markdown
52944519variants are supported:
52954520
5296−- `markdown_phpextra` (PHP Markdown Extra)
5297−- `markdown_github` (deprecated GitHub-Flavored Markdown)
5298−- `markdown_mmd` (MultiMarkdown)
5299−- `markdown_strict` (Markdown.pl)
5300−- `commonmark` (CommonMark)
5301−- `gfm` (Github-Flavored Markdown)
5302−- `commonmark_x` (CommonMark with many pandoc extensions)
5303−
5304−To see which extensions are supported for a given format,
5305−and which are enabled by default, you can use the command
5306−
5307− pandoc --list-extensions=FORMAT
5308−
5309−where `FORMAT` is replaced with the name of the format.
5310−
5311−Note that the list of extensions for `commonmark`,
5312−`gfm`, and `commonmark_x` are defined relative to default
5313−commonmark. So, for example, `backtick_code_blocks`
5314−does not appear as an extension, since it is enabled by
5315−default and cannot be disabled.
5316−
5317−# Citations
5318−
5319−When the `--citeproc` option is used, pandoc can automatically generate
5320−citations and a bibliography in a number of styles. Basic usage is
5321−
5322− pandoc --citeproc myinput.txt
5323−
5324−To use this feature, you will need to have
5325−
5326−- a document containing citations (see [Extension: `citations`]);
5327−- a source of bibliographic data: either an external bibliography
5328− file or a list of `references` in the document's YAML metadata
5329−- optionally, a [CSL] citation style.
5330−
5331−## Specifying bibliographic data
5332−
5333−You can specify an external bibliography using the
5334−`bibliography` metadata field in a YAML metadata section or the
5335−`--bibliography` command line argument. If you want to use
5336−multiple bibliography files, you can supply multiple
5337−`--bibliography` arguments or set `bibliography` metadata field
5338−to YAML array. A bibliography may have any of these formats:
5339−
5340− Format File extension
5341− ------------ --------------
5342− BibLaTeX .bib
5343− BibTeX .bibtex
5344− CSL JSON .json
5345− CSL YAML .yaml
5346−
5347−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
5349−
5350−In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
5351−inside fields such as `title`; in CSL YAML databases, pandoc
5352−Markdown; and in CSL JSON databases, an [HTML-like markup][CSL
5353−markup specs]:
5354−
5355−`<i>...</i>`
5356−: italics
5357−
5358−`<b>...</b>`
5359−: bold
5360−
5361−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5362−: small capitals
5363−
5364−`<sub>...</sub>`
5365−: subscript
5366−
5367−`<sup>...</sup>`
5368−: superscript
5369−
5370−`<span class="nocase">...</span>`
5371−: prevent a phrase from being capitalized as title case
5372−
5373−As an alternative to specifying a bibliography file using
5374−`--bibliography` or the YAML metadata field `bibliography`, you
5375−can include the citation data directly in the `references` field
5376−of the document's YAML metadata. The field should contain an
5377−array of YAML-encoded references, for example:
5378−
5379− ---
5380− references:
5381− - type: article-journal
5382− id: WatsonCrick1953
5383− author:
5384− - family: Watson
5385− given: J. D.
5386− - family: Crick
5387− given: F. H. C.
5388− issued:
5389− date-parts:
5390− - - 1953
5391− - 4
5392− - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
5394− deoxyribose nucleic acid'
5395− title-short: Molecular structure of nucleic acids
5396− container-title: Nature
5397− volume: 171
5398− issue: 4356
5399− page: 737-738
5400− DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
5402− language: en-GB
5403− ...
5404−
5405−If both an external bibliography and inline (YAML metadata)
5406−references are provided, both will be used. In case of
5407−conflicting `id`s, the inline references will take precedence.
5408−
5409−Note that `pandoc` can be used to produce such a YAML metadata
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5411−
5412− pandoc chem.bib -s -f biblatex -t markdown
5413− pandoc chem.json -s -f csljson -t markdown
5414−
5415−Indeed, `pandoc` can convert between any of these
5416−citation formats:
5417−
5418− pandoc chem.bib -s -f biblatex -t csljson
5419− pandoc chem.yaml -s -f markdown -t biblatex
5420−
5421−Running pandoc on a bibliography file with the `--citeproc`
5422−option will create a formatted bibliography in the format
5423−of your choice:
5424−
5425− pandoc chem.bib -s --citeproc -o chem.html
5426− pandoc chem.bib -s --citeproc -o chem.pdf
5427−
5428−### Capitalization in titles
5429−
5430−If you are using a bibtex or biblatex bibliography, then observe
5431−the following rules:
5432−
5433− - English titles should be in title case. Non-English titles should
5434− be in sentence case, and the `langid` field in biblatex should be
5435− set to the relevant language. (The following values are treated
5436− as English: `american`, `british`, `canadian`, `english`,
5437− `australian`, `newzealand`, `USenglish`, or `UKenglish`.)
5438−
5439− - As is standard with bibtex/biblatex, proper names should be
5440− protected with curly braces so that they won't be lowercased
5441− in styles that call for sentence case. For example:
5442−
5443− title = {My Dinner with {Andre}}
5444−
5445− - In addition, words that should remain lowercase (or camelCase)
5446− should be protected:
5447−
5448− title = {Spin Wave Dispersion on the {nm} Scale}
5449−
5450− Though this is not necessary in bibtex/biblatex, it is necessary
5451− with citeproc, which stores titles internally in sentence case,
5452− and converts to title case in styles that require it. Here we
5453− protect "nm" so that it doesn't get converted to "Nm" at this stage.
5454−
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
5456−the following rules:
5457−
5458− - All titles should be in sentence case.
5459−
5460− - Use the `language` field for non-English titles to prevent their
5461− conversion to title case in styles that call for this. (Conversion
5462− happens only if `language` begins with `en` or is left empty.)
5463−
5464− - Protect words that should not be converted to title case using
5465− this syntax:
5466−
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
5468−
5469−### Conference Papers, Published vs. Unpublished
5470−
5471−For a formally published conference paper, use the biblatex entry type
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
5473−
5474−For an unpublished manuscript, use the biblatex entry type
5475−`unpublished` without an `eventtitle` field (this entry type
5476−will be mapped to CSL `manuscript`).
5477−
5478−For a talk, an unpublished conference paper, or a poster
5479−presentation, use the biblatex entry type `unpublished` with an
5480−`eventtitle` field (this entry type will be mapped to CSL
5481−`speech`). Use the biblatex `type` field to indicate the type,
5482−e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful
5483−too, though `eventdate` will not be rendered by most CSL styles.
5484−Note that `venue` is for the event's venue, unlike `location`
5485−which describes the publisher's location; do not use the latter
5486−for an unpublished conference paper.
5487−
5488−
5489−## Specifying a citation style
5490−
5491−Citations and references can be formatted using any style supported by the
5492−[Citation Style Language], listed in the [Zotero Style Repository].
5493−These files are specified using the `--csl` option or the `csl`
5494−(or `citation-style`) metadata field. By default, pandoc will
5495−use the [Chicago Manual of Style] author-date format. (You can
5496−override this default by copying a CSL style of your choice
5497−to `default.csl` in your user data directory.)
5498−The CSL project provides further information on [finding and
5499−editing styles].
5500−
5501−The `--citation-abbreviations` option (or the
5502−`citation-abbreviations` metadata field) may be used to specify
5503−a JSON file containing abbreviations of journals that should be
5504−used in formatted bibliographies when `form="short"` is
5505−specified. The format of the file can be illustrated with an
5506−example:
5507−
5508−
5509− { "default": {
5510− "container-title": {
5511− "Lloyd's Law Reports": "Lloyd's Rep",
5512− "Estates Gazette": "EG",
5513− "Scots Law Times": "SLT"
5514− }
5515− }
5516− }
5517−
5518−
5519−## Citations in note styles
5520−
5521−Pandoc's citation processing is designed to allow you to
5522−move between author-date, numerical, and note styles without
5523−modifying the markdown source. When you're using a note
5524−style, avoid inserting footnotes manually. Instead, insert
5525−citations just as you would in an author-date style---for
5526−example,
5527−
5528− Blah blah [@foo, p. 33].
5529−
5530−The footnote will be created automatically. Pandoc will take
5531−care of removing the space and moving the note before or
5532−after the period, depending on the setting of
5533−`notes-after-punctuation`, as described below in [Other relevant
5534−metadata fields].
5535−
5536−In some cases you may need to put a citation inside a regular
5537−footnote. Normal citations in footnotes (such as `[@foo, p.
5538−33]`) will be rendered in parentheses. In-text citations (such
5539−as `@foo [p. 33]`) will be rendered without parentheses. (A
5540−comma will be added if appropriate.) Thus:
5541−
5542− [^1]: Some studies [@foo; @bar, p. 33] show that
5543− frubulicious zoosnaps are quantical. For a survey
5544− of the literature, see @baz [chap. 1].
5545−
5546−## Raw content in a style
5547−
5548−To include raw content in a prefix, suffix, delimiter, or term,
5549−surround it with these tags indicating the format:
5550−
5551− {{jats}}<ref>{{/jats}}
5552−
5553−Without the tags, the string will be interpreted as a string
5554−and escaped in the output, rather than being passed through raw.
5555−
5556−This feature allows stylesheets to be customized to give
5557−different output for different output formats. However,
5558−stylesheets customized in this way will not be usable
5559−by other CSL implementations.
5560−
5561−
5562−
5563−## Placement of the bibliography
5564−
5565−If the style calls for a list of works cited, it will be placed
5566−in a div with id `refs`, if one exists:
5567−
5568− ::: {#refs}
5569− :::
5570−
5571−Otherwise, it will be placed at the end of the document.
5572−Generation of the bibliography can be suppressed by setting
5573−`suppress-bibliography: true` in the YAML metadata.
5574−
5575−If you wish the bibliography to have a section heading, you can
5576−set `reference-section-title` in the metadata, or put the heading
5577−at the beginning of the div with id `refs` (if you are using it)
5578−or at the end of your document:
5579−
5580− last paragraph...
5581−
5582− # References
5583−
5584−The bibliography will be inserted after this heading. Note that
5585−the `unnumbered` class will be added to this heading, so that the
5586−section will not be numbered.
5587−
5588−## Including uncited items in the bibliography
5589−
5590−If you want to include items in the bibliography without actually
5591−citing them in the body text, you can define a dummy `nocite` metadata
5592−field and put the citations there:
5593−
5594− ---
5595− nocite: |
5596− @item1, @item2
5597− ...
5598−
5599− @item3
5600−
5601−In this example, the document will contain a citation for `item3`
5602−only, but the bibliography will contain entries for `item1`, `item2`, and
5603−`item3`.
5604−
5605−It is possible to create a bibliography with all the citations,
5606−whether or not they appear in the document, by using a wildcard:
5607−
5608− ---
5609− nocite: |
5610− @*
5611− ...
5612−
5613−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
5614−render the bibliography. In order to do so, specify bibliography
5615−files as outlined above, and add `--natbib` or `--biblatex`
5616−argument to `pandoc` invocation. Bear in mind that bibliography
5617−files have to be in either BibTeX (for `--natbib`)
5618−or BibLaTeX (for `--biblatex`) format.
5619−
5620−## Other relevant metadata fields
5621−
5622−A few other metadata fields affect bibliography formatting:
5623−
5624−`link-citations`
5625−: If true, citations will be
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
5628−
5629−`lang`
5630−: The `lang` field will affect how the style is localized,
5631− for example in the translation of labels, the use
5632− of quotation marks, and the way items are sorted.
5633− (For backwards compatibility, `locale` may be used instead
5634− of `lang`, but this use is deprecated.)
5635−
5636− A BCP 47 language tag is expected: for example, `en`,
5637− `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
5638− syntax (after `-u-`) may be used to specify options for
5639− collation (sorting) more precisely. Here are some examples:
5640−
5641− - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642− - `es-u-co-trad` -- Spanish with the traditional collation
5643− (with `Ch` sorting after `C`).
5644− - `fr-u-kb` -- French with "backwards" accent sorting
5645− (with `coté` sorting after `côte`).
5646− - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647− before lower (default is lower before upper).
5648−
5649−`notes-after-punctuation`
5650−: If true (the default), pandoc will put footnote citations
5651− after following punctuation. For example, if the source
5652− contains `blah blah [@jones99].`, the result will look like
5653− `blah blah.[^1]`, with the note moved after the period and
5654− the space collapsed. If false, the space will still be
5655− collapsed, but the footnote will not be moved after the
5656− punctuation.
5657−
5658−
5659−# Slide shows
4521+`markdown_phpextra` (PHP Markdown Extra)
4522+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
4523+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
4524+ `header_attributes`, `link_attributes`, `abbreviations`,
4525+ `shortcut_reference_links`, `spaced_reference_links`.
4526+
4527+`markdown_github` (deprecated GitHub-Flavored Markdown)
4528+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4529+ `gfm_auto_identifiers`, `backtick_code_blocks`,
4530+ `autolink_bare_uris`, `space_in_atx_header`,
4531+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4532+ `shortcut_reference_links`, `angle_brackets_escapable`,
4533+ `lists_without_preceding_blankline`.
4534+
4535+`markdown_mmd` (MultiMarkdown)
4536+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
4537+ `tex_math_double_backslash`, `intraword_underscores`,
4538+ `mmd_title_block`, `footnotes`, `definition_lists`,
4539+ `all_symbols_escapable`, `implicit_header_references`,
4540+ `auto_identifiers`, `mmd_header_identifiers`,
4541+ `shortcut_reference_links`, `implicit_figures`,
4542+ `superscript`, `subscript`, `backtick_code_blocks`,
4543+ `spaced_reference_links`, `raw_attribute`.
4544+
4545+`markdown_strict` (Markdown.pl)
4546+: `raw_html`, `shortcut_reference_links`,
4547+ `spaced_reference_links`.
4548+
4549+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
4550+which is implemented as a set of extensions on `commonmark`).
4551+
4552+Note, however, that `commonmark` and `gfm` have limited support
4553+for extensions. Only those listed below (and `smart`,
4554+`raw_tex`, and `hard_line_breaks`) will work. The extensions
4555+can, however, all be individually disabled. Also, `raw_tex`
4556+only affects `gfm` output, not input.
4557+
4558+`gfm` (GitHub-Flavored Markdown)
4559+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
4560+ `gfm_auto_identifiers`, `backtick_code_blocks`,
4561+ `autolink_bare_uris`, `space_in_atx_header`,
4562+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
4563+ `shortcut_reference_links`, `angle_brackets_escapable`,
4564+ `lists_without_preceding_blankline`.
4565+
4566+
4567+Producing slide shows with pandoc
4568+=================================
56604569
56614570You can use pandoc to produce an HTML + JavaScript slide presentation
56624571that can be viewed via a web browser. There are five ways to do this,
@@ -5704,21 +4613,18 @@ To produce an HTML/JavaScript slide show, simply type
57044613
57054614where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
57064615
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.
4616+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
4617+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
4618+assumed to be available at the relative path `s5/default` (for S5), `slideous`
4619+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
4620+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
4621+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
4622+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
4623+the file by default.
4624+
4625+With all HTML slide formats, the `--self-contained` option can be used to
4626+produce a single file that contains all of the data necessary to display the
4627+slide show, including linked scripts, stylesheets, images, and videos.
57224628
57234629To produce a PDF slide show using beamer, type
57244630
@@ -5731,7 +4637,8 @@ To produce a Powerpoint slide show, type
57314637
57324638 pandoc habits.txt -o habits.pptx
57334639
5734−## Structuring the slide show
4640+Structuring the slide show
4641+--------------------------
57354642
57364643By default, the *slide level* is the highest heading level in
57374644the hierarchy that is followed immediately by content, and not another
@@ -5748,11 +4655,7 @@ rules:
57484655 * A heading at the slide level always starts a new slide.
57494656
57504657 * 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.)
4658+ headings *within* a slide.
57564659
57574660 * Headings *above* the slide level in the hierarchy create
57584661 "title slides," which just contain the section title
@@ -5776,7 +4679,8 @@ layout will be produced, with level-1 headings building horizontally
57764679and level-2 headings building vertically. It is not recommended that
57774680you use deeper nesting of section levels with reveal.js.
57784681
5779−## Incremental lists
4682+Incremental lists
4683+-----------------
57804684
57814685By default, these writers produce lists that display "all at once."
57824686If you want your lists to display incrementally (one item at a time),
@@ -5817,7 +4721,8 @@ in a single document.
58174721Note: Neither the `-i/--incremental` option nor any of the
58184722methods described here currently works for PowerPoint output.
58194723
5820−## Inserting pauses
4724+Inserting pauses
4725+----------------
58214726
58224727You can add "pauses" within a slide by including a paragraph containing
58234728three dots, separated by spaces:
@@ -5832,7 +4737,8 @@ three dots, separated by spaces:
58324737
58334738Note: this feature is not yet implemented for PowerPoint output.
58344739
5835−## Styling the slides
4740+Styling the slides
4741+------------------
58364742
58374743You can change the style of HTML slides by putting customized CSS files
58384744in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5867,7 +4773,8 @@ bibliographies:
58674773
58684774 # References {.allowframebreaks}
58694775
5870−## Speaker notes
4776+Speaker notes
4777+-------------
58714778
58724779Speaker notes are supported in reveal.js and PowerPoint (pptx)
58734780output. You can add notes to your Markdown document thus:
@@ -5888,7 +4795,8 @@ in handouts and presenter view.
58884795Notes are not yet supported for other slide formats, but the notes
58894796will not appear on the slides themselves.
58904797
5891−## Columns
4798+Columns
4799+-------
58924800
58934801To put material in side by side columns, you can use a native
58944802div container with class `columns`, containing two or more div
@@ -5903,42 +4811,8 @@ containers with class `column` and a `width` attribute:
59034811 :::
59044812 ::::::::::::::
59054813
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
4814+Frame attributes in beamer
4815+--------------------------
59424816
59434817Sometimes it is necessary to add the LaTeX `[fragile]` option to
59444818a frame in beamer (for example, when using the `minted` environment).
@@ -5952,9 +4826,10 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
59524826`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
59534827`shrink`, `standout`, `noframenumbering`.
59544828
5955−## Background in reveal.js and beamer
4829+Background in reveal.js and beamer
4830+----------------------------------
59564831
5957−Background images can be added to self-contained reveal.js slideshows and
4832+Background images can be added to self-contained reveal.js slideshows and
59584833to beamer slideshows.
59594834
59604835For the same image on every slide, use the configuration
@@ -5962,9 +4837,9 @@ option `background-image` either in the YAML metadata block
59624837or as a command-line variable. (There are no other options in
59634838beamer and the rest of this section concerns reveal.js slideshows.)
59644839
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
4840+For reveal.js, you can instead use the reveal.js-native option
4841+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4842+and `parallaxBackgroundVertical` the same way and must also set
59684843`parallaxBackgroundSize` to have your values take effect.
59694844
59704845To set an image for a particular reveal.js slide, add
@@ -5978,12 +4853,9 @@ Other reveal.js background settings also work on individual slides, including
59784853`data-background-size`, `data-background-repeat`, `data-background-color`,
59794854`data-transition`, and `data-transition-speed`.
59804855
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.
4856+See the [reveal.js
4857+documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
4858+for more details.
59874859
59884860For example in reveal.js:
59894861
@@ -5991,9 +4863,6 @@ For example in reveal.js:
59914863---
59924864title: My Slideshow
59934865parallaxBackgroundImage: /path/to/my/background_image.png
5994−title-slide-attributes:
5995− data-background-image: /path/to/title_image.png
5996− data-background-size: contain
59974866---
59984867
59994868## Slide One
@@ -6005,9 +4874,11 @@ Slide 1 has background_image.png as its background.
60054874Slide 2 has a special image for its background, even though the heading has no content.
60064875```
60074876
6008−# EPUBs
4877+Creating EPUBs with pandoc
4878+==========================
60094879
6010−## EPUB Metadata
4880+EPUB Metadata
4881+-------------
60114882
60124883EPUB metadata may be specified using the `--epub-metadata` option, but
60134884if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,15 +4956,6 @@ The following fields are recognized:
60854956
60864957`rights`
60874958 ~ 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.
60974959
60984960`cover-image`
60994961 ~ A string value (path to cover image).
@@ -6115,10 +4977,11 @@ The following fields are recognized:
61154977 - `binding`: `true`|`false` (default `true`)
61164978 - `scroll-axis`: `vertical`|`horizontal`|`default`
61174979
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4980+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
61194981[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
61204982
6121−## The `epub:type` attribute
4983+The `epub:type` attribute
4984+-------------------------
61224985
61234986For `epub3` output, you can mark up the heading that corresponds to an EPUB
61244987chapter using the [`epub:type` attribute][epub-type]. For example, to set
@@ -6155,6 +5018,8 @@ halftitlepage frontmatter
61555018seriespage frontmatter
61565019foreword frontmatter
61575020preface frontmatter
5021+seriespage frontmatter
5022+titlepage frontmatter
61585023appendix backmatter
61595024colophon backmatter
61605025bibliography backmatter
@@ -6162,7 +5027,8 @@ index backmatter
61625027
61635028[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
61645029
6165−## Linked media
5030+Linked media
5031+------------
61665032
61675033By default, pandoc will download media referenced from any `<img>`, `<audio>`,
61685034`<video>` or `<source>` element present in the generated EPUB,
@@ -6172,12 +5038,13 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
61725038with the `src` attribute. For example:
61735039
61745040 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
5041+ <source src="http://example.com/music/toccata.mp3"
61765042 data-external="1" type="audio/mpeg">
61775043 </source>
61785044 </audio>
61795045
6180−# Jupyter notebooks
5046+Creating Jupyter notebooks with pandoc
5047+======================================
61815048
61825049When creating a [Jupyter notebook], pandoc will try to infer the
61835050notebook structure. Code blocks with the class `code` will be
@@ -6302,7 +5169,8 @@ soft line breaks in Markdown cells; `--atx-headers` will
63025169cause ATX-style headings to be used; and `--preserve-tabs` will
63035170prevent tabs from being turned to spaces.
63045171
6305−# Syntax highlighting
5172+Syntax highlighting
5173+===================
63065174
63075175Pandoc will automatically highlight syntax in [fenced code blocks] that
63085176are marked with a language name. The Haskell library [skylighting] is
@@ -6330,7 +5198,7 @@ Then edit `my.theme` and use it like this:
63305198If you are not satisfied with the built-in highlighting, or you
63315199want highlight a language that isn't supported, you can use the
63325200`--syntax-definition` option to load a [KDE-style XML syntax definition
6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
5201+file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
63345202Before writing your own, have a look at KDE's [repository of syntax
63355203definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
63365204
@@ -6338,11 +5206,13 @@ To disable highlighting, use the `--no-highlight` option.
63385206
63395207[skylighting]: https://github.com/jgm/skylighting
63405208
6341−# Custom Styles
5209+Custom Styles
5210+=============
63425211
63435212Custom styles can be used in the docx and ICML formats.
63445213
6345−## Output
5214+Output
5215+------
63465216
63475217By default, pandoc's docx and ICML output applies a predefined set of styles
63485218for blocks such as paragraphs and block quotes, and uses largely default
@@ -6353,10 +5223,8 @@ styles, pandoc allows you to define custom styles for blocks and text
63535223using `div`s and `span`s, respectively.
63545224
63555225If 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,
5226+pandoc will apply your specified style to the contained elements. So,
5227+for example using the `bracketed_spans` syntax,
63605228
63615229 [Get out]{custom-style="Emphatically"}, he said.
63625230
@@ -6387,9 +5255,10 @@ custom-style `span`.
63875255For docx output, you don't need to enable any extensions for
63885256custom styles to work.
63895257
6390−[pandoc filters]: https://pandoc.org/filters.html
5258+[pandoc filters]: http://pandoc.org/filters.html
63915259
6392−## Input
5260+Input
5261+-----
63935262
63945263The docx reader, by default, only reads those styles that it can
63955264convert into pandoc elements, either by direct conversion or
@@ -6418,17 +5287,17 @@ And with the extension:
64185287
64195288 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
64205289
6421− ::: {custom-style="First Paragraph"}
5290+ ::: {custom-style="FirstParagraph"}
64225291 This is some text.
64235292 :::
64245293
6425− ::: {custom-style="Body Text"}
5294+ ::: {custom-style="BodyText"}
64265295 This is text with an [emphasized]{custom-style="Emphatic"} text style.
64275296 And this is text with a [strengthened]{custom-style="Strengthened"}
64285297 text style.
64295298 :::
64305299
6431− ::: {custom-style="My Block Style"}
5300+ ::: {custom-style="MyBlockStyle"}
64325301 > Here is a styled paragraph that inherits from Block Text.
64335302 :::
64345303
@@ -6436,47 +5305,27 @@ With these custom styles, you can use your input document as a
64365305reference-doc while creating docx output (see below), and maintain the
64375306same styles in your input and output files.
64385307
6439−# Custom writers
5308+Custom writers
5309+==============
64405310
6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442−includes a Lua interpreter, so Lua need not be installed separately.)
5311+Pandoc can be extended with custom writers written in [lua]. (Pandoc
5312+includes a lua interpreter, so lua need not be installed separately.)
64435313
6444−To use a custom writer, simply specify the path to the Lua script
5314+To use a custom writer, simply specify the path to the lua script
64455315in place of the output format. For example:
64465316
64475317 pandoc -t data/sample.lua
64485318
6449−Creating a custom writer requires writing a Lua function for each
5319+Creating a custom writer requires writing a lua function for each
64505320possible element in a pandoc document. To get a documented example
64515321which you can modify according to your needs, do
64525322
64535323 pandoc --print-default-data-file sample.lua
64545324
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).
5325+[lua]: http://www.lua.org
64785326
6479−# A note on security
5327+A note on security
5328+==================
64805329
64815330If you use pandoc to convert user-contributed content in a web
64825331application, here are some things to keep in mind:
@@ -6491,7 +5340,7 @@ application, here are some things to keep in mind:
64915340 shelling out to the executable), it is possible to use it in a mode
64925341 that fully isolates pandoc from your file system, by running the
64935342 pandoc operations in the `PandocPure` monad. See the document
6494− [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
5343+ [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
64955344 for more details.
64965345
649753463. Pandoc's parsers can exhibit pathological performance on some
@@ -6504,17 +5353,18 @@ application, here are some things to keep in mind:
650453534. The HTML generated by pandoc is not guaranteed to be safe.
65055354 If `raw_html` is enabled for the Markdown input, users can
65065355 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.
5356+ users can include dangerous content in attributes for
5357+ headings, spans, and code blocks. To be safe, you should
5358+ run all the generated HTML through an HTML sanitizer.
65105359
6511−# Authors
5360+Authors
5361+=======
65125362
6513−Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
5363+Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
65145364under the [GPL], version 2 or greater. This software carries no
65155365warranty of any kind. (See COPYRIGHT for full copyright and
65165366warranty notices.) For a full list of contributors, see the file
65175367AUTHORS.md in the pandoc source code.
65185368
6519−[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
5369+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
65205370[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"