@@ -1,14 +1,14 @@
1−% Pandoc User's Guide
2+title: Pandoc User's Guide
2−% John MacFarlane
3+author: John MacFarlane
3−% April 5, 2019
4+date: June 20, 2021
8`pandoc` [*options*] [*input-file*]...
9`pandoc` [*options*] [*input-file*]...
10−Description
11+# Description
13Pandoc is a [Haskell] library for converting from one markup format to
13Pandoc is a [Haskell] library for converting from one markup format to
14another, and a command-line tool that uses this library.
14another, and a command-line tool that uses this library.
@@ -40,8 +40,7 @@ model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
40to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
41Markdown can be expected to be lossy.
43−Using pandoc
43+## Using pandoc
46If no *input-files* are specified, input is read from *stdin*.
45If no *input-files* are specified, input is read from *stdin*.
47Output goes to *stdout* by default. For output to a file,
46Output goes to *stdout* by default. For output to a file,
@@ -62,8 +61,7 @@ If multiple input files are given, `pandoc` will concatenate them all (with
62blank lines between them) before parsing. (Use `--file-scope` to parse files
61blank lines between them) before parsing. (Use `--file-scope` to parse files
63individually.)
62individually.)
65−Specifying formats
64+## Specifying formats
68The format of the input and output can be specified explicitly using
66The format of the input and output can be specified explicitly using
69command-line options. The input format can be specified using the
67command-line options. The input format can be specified using the
@@ -95,8 +93,7 @@ If no input file is specified (so that input comes from *stdin*), or
95if the input files' extensions are unknown, the input format will
93if the input files' extensions are unknown, the input format will
96be assumed to be Markdown.
94be assumed to be Markdown.
98−Character encoding
96+## Character encoding
101Pandoc uses the UTF-8 character encoding for both input and output.
98Pandoc uses the UTF-8 character encoding for both input and output.
102If your local character encoding is not UTF-8, you
99If your local character encoding is not UTF-8, you
@@ -109,10 +106,9 @@ RTF, OPML, DocBook, and Texinfo), information about
109the character encoding is included in the document header, which
106the character encoding is included in the document header, which
110will only be included if you use the `-s/--standalone` option.
107will only be included if you use the `-s/--standalone` option.
112−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
114−Creating a PDF
111+## Creating a PDF
117To produce a PDF, specify an output file with a `.pdf` extension:
113To produce a PDF, specify an output file with a `.pdf` extension:
@@ -120,17 +116,18 @@ To produce a PDF, specify an output file with a `.pdf` extension:
121By default, pandoc will use LaTeX to create the PDF, which requires
117By default, pandoc will use LaTeX to create the PDF, which requires
122that a LaTeX engine be installed (see `--pdf-engine` below).
118that a LaTeX engine be installed (see `--pdf-engine` below).
124−Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
119+Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
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,
120+intermediate format. To do this, specify an output file with a
128−but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
121+`.pdf` extension, as before, but add the `--pdf-engine` option
129−to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
122+or `-t context`, `-t html`, or `-t ms` to the command line.
130−
123+The tool used to generate the PDF from the intermediate format
131−PDF output uses [variables for LaTeX] (with a LaTeX engine);
124+may be specified using `--pdf-engine`.
126+You can control the PDF style using variables, depending on
127+the intermediate format used: see [variables for LaTeX],
132−[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]
128+[variables for ConTeXt], [variables for `wkhtmltopdf`],
133−(an HTML/CSS-to-PDF engine; `--css` also affects the output).
129+[variables for ms]. When HTML is used as an intermediate
130+format, the output can be styled using `--css`.
135To debug the PDF creation, it can be useful to look at the intermediate
132To debug the PDF creation, it can be useful to look at the intermediate
136representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
133representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
@@ -139,33 +136,32 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
139When using LaTeX, the following packages need to be available
136When using LaTeX, the following packages need to be available
140(they are included with all recent versions of [TeX Live]):
137(they are included with all recent versions of [TeX Live]):
141[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
142−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
143`--listings` option is used), [`fancyvrb`], [`longtable`],
140`--listings` option is used), [`fancyvrb`], [`longtable`],
144−[`booktabs`], [`graphicx`] and [`grffile`] (if the document
141+[`booktabs`], [`graphicx`] (if the document
145contains images), [`hyperref`], [`xcolor`],
142contains images), [`hyperref`], [`xcolor`],
146[`ulem`], [`geometry`] (with the `geometry` variable set),
143[`ulem`], [`geometry`] (with the `geometry` variable set),
147[`setspace`] (with `linestretch`), and
144[`setspace`] (with `linestretch`), and
148[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
149−the PDF engine requires [`fontspec`]. `xelatex` uses
146+the PDF engine requires [`fontspec`]. `lualatex` uses
150−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
151−`dir` variable set). If the `mathspec` variable is set,
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
152−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
153−The [`upquote`] and [`microtype`] packages are used if
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
154−available, and [`csquotes`] will be used for [typography]
151+packages are used if available, and [`csquotes`] will be used
155−if `\usepackage{csquotes}` is present in the template or
152+for [typography] if the `csquotes` variable or metadata field is
156−included via `/H/--include-in-header`. The [`natbib`],
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
157−[`biblatex`], [`bibtex`], and [`biber`] packages can optionally
154+and [`biber`] packages can optionally be used for [citation
158−be used for [citation rendering]. The following packages
155+rendering]. The following packages will be used to improve
159−will be used to improve output quality if present, but
160−pandoc does not require them to be present:
156+output quality if present, but pandoc does not require them to
161−[`upquote`] (for straight quotes in verbatim environments),
157+be present: [`upquote`] (for straight quotes in verbatim
162−[`microtype`] (for better spacing adjustments),
158+environments), [`microtype`] (for better spacing adjustments),
163−[`parskip`] (for better inter-paragraph spaces),
159+[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
164−[`xurl`] (for better line breaks in URLs),
160+better line breaks in URLs), [`bookmark`] (for better PDF
165−[`bookmark`] (for better PDF bookmarks),
166−and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
161+bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
167−
162+footnotes in tables).
168−[TeX Live]: http://www.tug.org/texlive/
164+[TeX Live]: https://www.tug.org/texlive/
169[`amsfonts`]: https://ctan.org/pkg/amsfonts
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
170[`amsmath`]: https://ctan.org/pkg/amsmath
166[`amsmath`]: https://ctan.org/pkg/amsmath
171[`babel`]: https://ctan.org/pkg/babel
167[`babel`]: https://ctan.org/pkg/babel
@@ -184,8 +180,7 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
184[`graphicx`]: https://ctan.org/pkg/graphicx
180[`graphicx`]: https://ctan.org/pkg/graphicx
185[`grffile`]: https://ctan.org/pkg/grffile
181[`grffile`]: https://ctan.org/pkg/grffile
186[`hyperref`]: https://ctan.org/pkg/hyperref
182[`hyperref`]: https://ctan.org/pkg/hyperref
187−[`ifluatex`]: https://ctan.org/pkg/ifluatex
188−[`ifxetex`]: https://ctan.org/pkg/ifxetex
183+[`iftex`]: https://ctan.org/pkg/iftex
189[`listings`]: https://ctan.org/pkg/listings
184[`listings`]: https://ctan.org/pkg/listings
190[`lm`]: https://ctan.org/pkg/lm
185[`lm`]: https://ctan.org/pkg/lm
191[`longtable`]: https://ctan.org/pkg/longtable
186[`longtable`]: https://ctan.org/pkg/longtable
@@ -199,41 +194,44 @@ and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).
199[`ulem`]: https://ctan.org/pkg/ulem
194[`ulem`]: https://ctan.org/pkg/ulem
200[`unicode-math`]: https://ctan.org/pkg/unicode-math
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
201[`upquote`]: https://ctan.org/pkg/upquote
196[`upquote`]: https://ctan.org/pkg/upquote
202−[`weasyprint`]: http://weasyprint.org
197+[`weasyprint`]: https://weasyprint.org
203[`wkhtmltopdf`]: https://wkhtmltopdf.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
204[`xcolor`]: https://ctan.org/pkg/xcolor
199[`xcolor`]: https://ctan.org/pkg/xcolor
205[`xecjk`]: https://ctan.org/pkg/xecjk
200[`xecjk`]: https://ctan.org/pkg/xecjk
206[`xurl`]: https://ctan.org/pkg/xurl
201[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
210−Reading from the Web
206+## Reading from the Web
213−Instead of an input file, an absolute URI may be given. In this case
208+Instead of an input file, an absolute URI may be given. In this case
214pandoc will fetch the content using HTTP:
209pandoc will fetch the content using HTTP:
216− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
218It is possible to supply a custom User-Agent string or other
213It is possible to supply a custom User-Agent string or other
219header when requesting a document from a URL:
214header when requesting a document from a URL:
221 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
216 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
222− http://www.fsf.org
217+ https://www.fsf.org
227−General options {.options}
221+## General options {.options}
230`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
232: Specify input format. *FORMAT* can be:
225: Specify input format. *FORMAT* can be:
234 ::: {#input-formats}
227 ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
235 - `commonmark` ([CommonMark] Markdown)
230 - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
236 - `creole` ([Creole 1.0])
232 - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
237 - `docbook` ([DocBook])
235 - `docbook` ([DocBook])
238 - `docx` ([Word docx])
236 - `docx` ([Word docx])
239 - `dokuwiki` ([DokuWiki markup])
237 - `dokuwiki` ([DokuWiki markup])
@@ -247,6 +245,7 @@ General options {.options}
247 - `html` ([HTML])
245 - `html` ([HTML])
248 - `ipynb` ([Jupyter notebook])
246 - `ipynb` ([Jupyter notebook])
249 - `jats` ([JATS] XML)
247 - `jats` ([JATS] XML)
248+ - `jira` ([Jira]/Confluence wiki markup)
250 - `json` (JSON version of native AST)
249 - `json` (JSON version of native AST)
251 - `latex` ([LaTeX])
250 - `latex` ([LaTeX])
252 - `markdown` ([Pandoc's Markdown])
251 - `markdown` ([Pandoc's Markdown])
@@ -281,8 +280,12 @@ General options {.options}
281 ::: {#output-formats}
280 ::: {#output-formats}
282 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283 - `beamer` ([LaTeX beamer][`beamer`] slide show)
282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
284 - `commonmark` ([CommonMark] Markdown)
285 - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
285 - `context` ([ConTeXt])
287 - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
286 - `docbook` or `docbook4` ([DocBook] 4)
289 - `docbook` or `docbook4` ([DocBook] 4)
287 - `docbook5` (DocBook 5)
290 - `docbook5` (DocBook 5)
288 - `docx` ([Word docx])
291 - `docx` ([Word docx])
@@ -299,8 +302,11 @@ General options {.options}
299 - `html4` ([XHTML] 1.0 Transitional)
302 - `html4` ([XHTML] 1.0 Transitional)
300 - `icml` ([InDesign ICML])
303 - `icml` ([InDesign ICML])
301 - `ipynb` ([Jupyter notebook])
304 - `ipynb` ([Jupyter notebook])
302− - `jats` ([JATS] XML)
305+ - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306+ - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307+ - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308+ - `jats` (alias for `jats_archiving`)
303− - `jira` ([Jira] wiki markup)
309+ - `jira` ([Jira]/Confluence wiki markup)
304 - `json` (JSON version of native AST)
310 - `json` (JSON version of native AST)
305 - `latex` ([LaTeX])
311 - `latex` ([LaTeX])
306 - `man` ([roff man])
312 - `man` ([roff man])
@@ -316,6 +322,7 @@ General options {.options}
316 - `opml` ([OPML])
322 - `opml` ([OPML])
317 - `opendocument` ([OpenDocument])
323 - `opendocument` ([OpenDocument])
318 - `org` ([Emacs Org mode])
324 - `org` ([Emacs Org mode])
319 - `plain` (plain text),
326 - `plain` (plain text),
320 - `pptx` ([PowerPoint] slide show)
327 - `pptx` ([PowerPoint] slide show)
321 - `rst` ([reStructuredText])
328 - `rst` ([reStructuredText])
@@ -330,10 +337,10 @@ General options {.options}
330 - `tei` ([TEI Simple])
337 - `tei` ([TEI Simple])
331 - `xwiki` ([XWiki markup])
338 - `xwiki` ([XWiki markup])
332 - `zimwiki` ([ZimWiki markup])
339 - `zimwiki` ([ZimWiki markup])
333− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
336− Note that `odt`, `docx`, and `epub` output will not be directed
343+ Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
337 to *stdout* unless forced with `-o -`.
344 to *stdout* unless forced with `-o -`.
339 Extensions can be individually enabled or
346 Extensions can be individually enabled or
@@ -354,15 +361,29 @@ General options {.options}
354 will be used. On \*nix and macOS systems this will be the `pandoc`
361 will be used. On \*nix and macOS systems this will be the `pandoc`
355 subdirectory of the XDG data directory (by default,
362 subdirectory of the XDG data directory (by default,
356 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
357− environment variable). If that directory does not exist,
364+ environment variable). If that directory does not exist and
358− `$HOME/.pandoc` will be used (for backwards compatibility).
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
359− In Windows the default user data directory is
366+ On Windows the default user data directory is
360 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
361 You can find the default user data directory on your system by
368 You can find the default user data directory on your system by
362 looking at the output of `pandoc --version`.
369 looking at the output of `pandoc --version`.
370+ Data files placed in this directory (for example, `reference.odt`,
363− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371+ `reference.docx`, `epub.css`, `templates`) will override
364− `slidy`, `slideous`, or `s5` directory
365− placed in this directory will override pandoc's normal defaults.
372+ pandoc's normal defaults.
374+`-d` *FILE*, `--defaults=`*FILE*
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
367`--bash-completion`
388`--bash-completion`
@@ -373,8 +394,7 @@ General options {.options}
374`--verbose`
395`--verbose`
376−: Give verbose debugging output. Currently this only has an effect
397+: Give verbose debugging output.
@@ -400,7 +420,7 @@ General options {.options}
401`--list-extensions`[`=`*FORMAT*]
421`--list-extensions`[`=`*FORMAT*]
403−: List supported extensions, one per line, preceded
423+: List supported extensions for *FORMAT*, one per line, preceded
404 by a `+` or `-` indicating whether it is enabled by default
424 by a `+` or `-` indicating whether it is enabled by default
405 in *FORMAT*. If *FORMAT* is not specified, defaults for
425 in *FORMAT*. If *FORMAT* is not specified, defaults for
406 pandoc's Markdown are given.
426 pandoc's Markdown are given.
@@ -423,66 +443,88 @@ General options {.options}
424: Show usage message.
444: Show usage message.
426−[Markdown]: http://daringfireball.net/projects/markdown/
446+[Markdown]: https://daringfireball.net/projects/markdown/
427−[CommonMark]: http://commonmark.org
447+[CommonMark]: https://commonmark.org
428[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
429[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
430−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
450+[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
431−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
451+[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
432−[S5]: http://meyerweb.com/eric/tools/s5/
452+[S5]: https://meyerweb.com/eric/tools/s5/
433−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
453+[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
434−[Slideous]: http://goessner.net/articles/slideous/
454+[Slideous]: https://goessner.net/articles/slideous/
435−[HTML]: http://www.w3.org/html/
455+[HTML]: https://www.w3.org/html/
436−[HTML5]: http://www.w3.org/TR/html5/
456+[HTML5]: https://html.spec.whatwg.org/
437[polyglot markup]: https://www.w3.org/TR/html-polyglot/
457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
438−[XHTML]: http://www.w3.org/TR/xhtml1/
458+[XHTML]: https://www.w3.org/TR/xhtml1/
439−[LaTeX]: http://latex-project.org
459+[LaTeX]: https://www.latex-project.org/
440[`beamer`]: https://ctan.org/pkg/beamer
460[`beamer`]: https://ctan.org/pkg/beamer
441[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
461[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
442−[ConTeXt]: http://www.contextgarden.net/
462+[ConTeXt]: https://www.contextgarden.net/
443−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
444−[DocBook]: http://docbook.org
464+[DocBook]: https://docbook.org
445[JATS]: https://jats.nlm.nih.gov
465[JATS]: https://jats.nlm.nih.gov
446[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
466[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
447−[txt2tags]: http://txt2tags.org
467+[txt2tags]: https://txt2tags.org
448[EPUB]: http://idpf.org/epub
468[EPUB]: http://idpf.org/epub
449[OPML]: http://dev.opml.org/spec2.html
469[OPML]: http://dev.opml.org/spec2.html
450[OpenDocument]: http://opendocument.xml.org
470[OpenDocument]: http://opendocument.xml.org
451−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
452−[Textile]: http://redcloth.org/textile
472+[Textile]: https://www.promptworks.com/textile
453[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
454[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
455−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
456[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
476[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
457−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
458[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
478[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
459[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
460[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
461−[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
481+[CSV]: https://tools.ietf.org/html/rfc4180
482+[roff man]: https://man.cx/groff_man(7)
462−[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
483+[roff ms]: https://man.cx/groff_ms(7)
463[Haskell]: https://www.haskell.org
484[Haskell]: https://www.haskell.org
464−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
465−[Emacs Org mode]: http://orgmode.org
486+[Emacs Org mode]: https://orgmode.org
466−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
467[AsciiDoctor]: https://asciidoctor.org/
488[AsciiDoctor]: https://asciidoctor.org/
468−[DZSlides]: http://paulrouget.com/dzslides/
489+[DZSlides]: https://paulrouget.com/dzslides/
469[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
470[PDF]: https://www.adobe.com/pdf/
491[PDF]: https://www.adobe.com/pdf/
471−[reveal.js]: http://lab.hakim.se/reveal-js/
492+[reveal.js]: https://revealjs.com/
472[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
473[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
474−[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
495+[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf
475[TEI Simple]: https://github.com/TEIC/TEI-Simple
496[TEI Simple]: https://github.com/TEIC/TEI-Simple
476[Muse]: https://amusewiki.org/library/manual
497[Muse]: https://amusewiki.org/library/manual
477[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
478[Vimwiki]: https://vimwiki.github.io
499[Vimwiki]: https://vimwiki.github.io
479−
500+[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501+[BibTeX]: https://ctan.org/pkg/bibtex
502+[BibLaTeX]: https://ctan.org/pkg/biblatex
480−Reader options {.options}
504+## Reader options {.options}
506+`--shift-heading-level-by=`*NUMBER*
508+: Shift heading levels by a positive or negative integer.
509+ For example, with `--shift-heading-level-by=-1`, level 2
510+ headings become level 1 headings, and level 3 headings
511+ become level 2 headings. Headings cannot have a level
512+ less than 1, so a heading that would be shifted below level 1
513+ becomes a regular paragraph. Exception: with a shift of -N,
514+ a level-N heading at the beginning of the document
515+ replaces the metadata title. `--shift-heading-level-by=-1`
516+ is a good choice when converting HTML or Markdown documents that
517+ use an initial level-1 heading for the document title and
518+ level-2+ headings for sections. `--shift-heading-level-by=1`
519+ may be a good choice for converting Markdown documents that
520+ use level-1 headings for sections to HTML, since pandoc uses
521+ a level-1 heading to render the document title.
483`--base-header-level=`*NUMBER*
523`--base-header-level=`*NUMBER*
525+: *Deprecated. Use `--shift-heading-level-by`=X instead,
485−: Specify the base level for headings (defaults to 1).
526+ where X = NUMBER - 1.* Specify the base level for headings
487`--strip-empty-paragraphs`
529`--strip-empty-paragraphs`
@@ -547,41 +589,32 @@ Reader options {.options}
548 3. `$PATH` (executable only)
590 3. `$PATH` (executable only)
550− Filters and lua-filters are applied in the order specified
592+ Filters, Lua-filters, and citeproc processing are applied in
551− on the command line.
593+ the order specified on the command line.
553−`--lua-filter=`*SCRIPT*
595+`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
555: Transform the document in a similar fashion as JSON filters (see
597: Transform the document in a similar fashion as JSON filters (see
556− `--filter`), but use pandoc's build-in lua filtering system. The given
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
557− lua script is expected to return a list of lua filters which will be
599+ Lua script is expected to return a list of Lua filters which will be
558− applied in order. Each lua filter must contain element-transforming
600+ applied in order. Each Lua filter must contain element-transforming
559 functions indexed by the name of the AST element on which the filter
601 functions indexed by the name of the AST element on which the filter
560 function should be applied.
602 function should be applied.
562− The `pandoc` lua module provides helper functions for element
604+ The `pandoc` Lua module provides helper functions for element
563− creation. It is always loaded into the script's lua environment.
605+ creation. It is always loaded into the script's Lua environment.
565− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
567− function expand_hello_world(inline)
609+ In order of preference, pandoc will look for Lua filters in
568− if inline.c == '{{helloworld}}' then
569− return pandoc.Emph{ pandoc.Str "Hello, World" }
575− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
577− In order of preference, pandoc will look for lua filters in
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
579− 1. a specified full or relative path (executable or
616+ Filters, Lua filters, and citeproc processing are applied in
580− non-executable)
617+ the order specified on the command line.
582− 2. `$DATADIR/filters` (executable or non-executable)
583− where `$DATADIR` is the user data directory (see
584− `--data-dir`, above).
586`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
@@ -598,19 +631,23 @@ Reader options {.options}
599`--metadata-file=`*FILE*
632`--metadata-file=`*FILE*
601−: Read metadata from the supplied YAML (or JSON) file.
634+: Read metadata from the supplied YAML (or JSON) file. This
602− This option can be used with every input format, but string
635+ option can be used with every input format, but string scalars
603− scalars in the YAML file will always be parsed as Markdown.
636+ in the YAML file will always be parsed as Markdown. Generally,
604− Generally, the input will be handled the same as in
637+ the input will be handled the same as in [YAML metadata
605− [YAML metadata blocks][Extension: `yaml_metadata_block`].
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
606− Metadata values specified inside the document, or by using `-M`,
642+ specified inside the document, or by using `-M`, overwrite
607− overwrite values specified with this option.
643+ values specified with this option.
609`-p`, `--preserve-tabs`
645`-p`, `--preserve-tabs`
611−: Preserve tabs instead of converting them to spaces (the default).
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
612− Note that this will only affect tabs in literal code spans and code
649+ only affect tabs in literal code spans and code blocks. Tabs in regular
613− blocks; tabs in regular text will be treated as spaces.
650+ text are always treated as spaces.
615`--tab-stop=`*NUMBER*
652`--tab-stop=`*NUMBER*
@@ -620,30 +657,30 @@ Reader options {.options}
621: Specifies what to do with insertions, deletions, and comments
658: Specifies what to do with insertions, deletions, and comments
622 produced by the MS Word "Track Changes" feature. `accept` (the
659 produced by the MS Word "Track Changes" feature. `accept` (the
623− default), inserts all insertions, and ignores all
660+ default) processes all the insertions and deletions.
624− deletions. `reject` inserts all deletions and ignores
625− insertions. Both `accept` and `reject` ignore comments. `all` puts
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
626− in insertions, deletions, and comments, wrapped in spans with
662+ `all` includes all insertions, deletions, and comments, wrapped
627− `insertion`, `deletion`, `comment-start`, and `comment-end`
663+ in spans with `insertion`, `deletion`, `comment-start`, and
628− classes, respectively. The author and time of change is
664+ `comment-end` classes, respectively. The author and time of
629− included. `all` is useful for scripting: only accepting changes
665+ change is included. `all` is useful for scripting: only
630− from a certain reviewer, say, or before a certain date. If a
666+ accepting changes from a certain reviewer, say, or before a
631− paragraph is inserted or deleted, `track-changes=all` produces a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
632− span with the class `paragraph-insertion`/`paragraph-deletion`
669+ `paragraph-insertion`/`paragraph-deletion` before the
633− before the affected paragraph break. This option only affects the
670+ affected paragraph break. This option only affects the docx
634− docx reader.
671+ reader.
636`--extract-media=`*DIR*
673`--extract-media=`*DIR*
638: Extract images and other media contained in or linked from
675: Extract images and other media contained in or linked from
639 the source document to the path *DIR*, creating it if
676 the source document to the path *DIR*, creating it if
640 necessary, and adjust the images references in the document
677 necessary, and adjust the images references in the document
641− so they point to the extracted files. If the source format is
678+ so they point to the extracted files. Media are downloaded,
642− a binary container (docx, epub, or odt), the media is
679+ read from the file system, or extracted from a binary
643− extracted from the container and the original
680+ container (e.g. docx), as needed. The original file paths
644− filenames are used. Otherwise the media is read from the
681+ are used if they are relative paths not containing `..`.
645− file system or downloaded, and new filenames are constructed
682+ Otherwise filenames are constructed from the SHA1 hash of
646− based on SHA1 hashes of the contents.
683+ the contents.
648`--abbreviations=`*FILE*
685`--abbreviations=`*FILE*
@@ -654,17 +691,17 @@ Reader options {.options}
654 system default, use
691 system default, use
655 `pandoc --print-default-data-file=abbreviations`. The only
692 `pandoc --print-default-data-file=abbreviations`. The only
656 use pandoc makes of this list is in the Markdown reader.
693 use pandoc makes of this list is in the Markdown reader.
657− Strings ending in a period that are found in this list will
694+ Strings found in this list will be followed by a nonbreaking
658− be followed by a nonbreaking space, so that the period will
659− not produce sentence-ending space in formats like LaTeX.
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
661[`pandocfilters`]: https://github.com/jgm/pandocfilters
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
662[PHP]: https://github.com/vinai/pandocfilters-php
699[PHP]: https://github.com/vinai/pandocfilters-php
663[perl]: https://metacpan.org/pod/Pandoc::Filter
700[perl]: https://metacpan.org/pod/Pandoc::Filter
664[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
666−General writer options {.options}
704+## General writer options {.options}
667−----------------------
669`-s`, `--standalone`
706`-s`, `--standalone`
@@ -689,11 +726,8 @@ General writer options {.options}
689`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
691: Set the template variable *KEY* to the value *VAL* when rendering the
728: Set the template variable *KEY* to the value *VAL* when rendering the
692− document in standalone mode. This is generally only useful when the
729+ document in standalone mode. If no *VAL* is specified, the
693− `--template` option is used to specify a custom template, since
694− pandoc automatically sets the variables used in the default
695− templates. If no *VAL* is specified, the key will be given the
696− value `true`.
730+ key will be given the value `true`.
698`-D` *FORMAT*, `--print-default-template=`*FORMAT*
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
@@ -704,6 +738,11 @@ General writer options {.options}
704 `-o`/`--output` must come before `--print-default-template`
738 `-o`/`--output` must come before `--print-default-template`
705 on the command line.
739 on the command line.
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`.
707`--print-default-data-file=`*FILE*
746`--print-default-data-file=`*FILE*
709: Print a system default data file. Files in the user data directory
748: Print a system default data file. Files in the user data directory
@@ -720,9 +759,12 @@ General writer options {.options}
721`--dpi`=*NUMBER*
760`--dpi`=*NUMBER*
723−: Specify the dpi (dots per inch) value for conversion from pixels
762+: Specify the default dpi (dots per inch) value for conversion
724− to inch/centimeters and vice versa. The default is 96dpi.
763+ from pixels to inch/centimeters and vice versa. (Technically,
725− Technically, the correct term would be ppi (pixels per inch).
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.
727`--wrap=auto`|`none`|`preserve`
769`--wrap=auto`|`none`|`preserve`
@@ -810,7 +852,8 @@ General writer options {.options}
810 which will be used for syntax highlighting of appropriately
852 which will be used for syntax highlighting of appropriately
811 marked code blocks. This can be used to add support for
853 marked code blocks. This can be used to add support for
812 new languages or to use altered syntax definitions for
854 new languages or to use altered syntax definitions for
813− existing languages.
855+ existing languages. This option may be repeated to add
856+ multiple syntax definitions.
815`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
858`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
@@ -848,11 +891,11 @@ General writer options {.options}
848 will not be searched. For example:
891 will not be searched. For example:
849 `--resource-path=.:test` will search the working directory
892 `--resource-path=.:test` will search the working directory
850 and the `test` subdirectory, in that order.
893 and the `test` subdirectory, in that order.
851−
894+ This option can be used repeatedly. Search path components
852− `--resource-path` only has an effect if (a) the output
895+ that come later on the command line will be searched before
853− format embeds images (for example, `docx`, `pdf`, or `html`
896+ those that come earlier, so
854− with `--self-contained`) or (b) it is used together with
897+ `--resource-path foo:bar --resource-path baz:bim` is
855− `--extract-media`.
898+ equivalent to `--resource-path baz:bim:foo:bar`.
857`--request-header=`*NAME*`:`*VAL*
900`--request-header=`*NAME*`:`*VAL*
@@ -862,8 +905,13 @@ General writer options {.options}
862 downloaded). If you're behind a proxy, you also need to set
905 downloaded). If you're behind a proxy, you also need to set
863 the environment variable `http_proxy` to `http://...`.
906 the environment variable `http_proxy` to `http://...`.
908+`--no-check-certificate`
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).
865−Options affecting specific writers {.options}
914+## Options affecting specific writers {.options}
866−----------------------------------
868`--self-contained`
916`--self-contained`
@@ -888,7 +936,9 @@ Options affecting specific writers {.options}
889`--html-q-tags`
937`--html-q-tags`
891−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
@@ -906,37 +956,45 @@ Options affecting specific writers {.options}
906 placement of link references is affected by the
956 placement of link references is affected by the
907 `--reference-location` option.
957 `--reference-location` option.
909−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
911: Specify whether footnotes (and references, if `reference-links` is
961: Specify whether footnotes (and references, if `reference-links` is
912 set) are placed at the end of the current (top-level) block, the
962 set) are placed at the end of the current (top-level) block, the
913 current section, or the document. The default is
963 current section, or the document. The default is
914 `document`. Currently only affects the markdown writer.
964 `document`. Currently only affects the markdown writer.
966+`--markdown-headings=setext`|`atx`
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.
916`--atx-headers`
974`--atx-headers`
918−: Use ATX-style headings in Markdown output. The default is
976+: *Deprecated synonym for `--markdown-headings=atx`.*
919− to use setext-style headings for levels 1 to 2, and then ATX headings.
920− (Note: for `gfm` output, ATX headings are always used.)
921− This option also affects markdown cells in `ipynb` output.
923−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
925−: Treat top-level headings as the given division type in LaTeX, ConTeXt,
980+: Treat top-level headings as the given division type in
926− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
927− all headings are shifted such that the top-level heading becomes the specified
983+ shifted such that the top-level heading becomes the
928− type. The default behavior is to determine the best division type via
984+ specified type. The default behavior is to determine the
929− heuristics: unless other conditions apply, `section` is chosen. When the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
930− LaTeX document class is set to `report`, `book`, or `memoir` (unless the
987+ variable is set to `report`, `book`, or `memoir` (unless the
931− `article` option is specified), `chapter` is implied as the setting for this
988+ `article` option is specified), `chapter` is implied as the
932− option. If `beamer` is the output format, specifying either `chapter` or
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
933− `part` will cause top-level headings to become `\part{..}`, while
991+ headings to become `\part{..}`, while second-level headings
934− second-level headings remain as their default type.
992+ remain as their default type.
936`-N`, `--number-sections`
994`-N`, `--number-sections`
938−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
939− By default, sections are not numbered. Sections with class
997+ output. By default, sections are not numbered. Sections with class
940 `unnumbered` will never be numbered, even if `--number-sections`
998 `unnumbered` will never be numbered, even if `--number-sections`
941 is specified.
999 is specified.
@@ -955,7 +1013,7 @@ Options affecting specific writers {.options}
956: Use the [`listings`] package for LaTeX code blocks. The package
1014: Use the [`listings`] package for LaTeX code blocks. The package
957 does not support multi-byte encoding for source code. To handle UTF-8
1015 does not support multi-byte encoding for source code. To handle UTF-8
958− you would need to use a custom template. This issue is fully
1016+ you would need to use a custom template. This issue is fully
959 documented here: [Encoding issue with the listings package].
1017 documented here: [Encoding issue with the listings package].
961`-i`, `--incremental`
1019`-i`, `--incremental`
@@ -1001,8 +1059,7 @@ Options affecting specific writers {.options}
1002: Specify *STRING* as a prefix at the beginning of the title
1060: Specify *STRING* as a prefix at the beginning of the title
1003 that appears in the HTML header (but not in the title as it
1061 that appears in the HTML header (but not in the title as it
1004− appears at the beginning of the HTML body). Implies
1062+ appears at the beginning of the HTML body). Implies `--standalone`.
1007`-c` *URL*, `--css=`*URL*
1064`-c` *URL*, `--css=`*URL*
@@ -1079,6 +1136,7 @@ Options affecting specific writers {.options}
1079 - Verbatim Char
1136 - Verbatim Char
1080 - Footnote Reference
1137 - Footnote Reference
1081 - Hyperlink
1138 - Hyperlink
1083 Table style:
1141 Table style:
@@ -1218,8 +1276,18 @@ Options affecting specific writers {.options}
1218: Use the specified engine when producing PDF output.
1276: Use the specified engine when producing PDF output.
1219 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1277 Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,
1220 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1278 `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,
1221− and `pdfroff`. The default is `pdflatex`. If the engine is
1279+ and `pdfroff`. If the engine is not in your PATH, the full
1222− not in your PATH, the full path of the engine may be specified here.
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`:
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`
1224`--pdf-engine-opt=`*STRING*
1292`--pdf-engine-opt=`*STRING*
@@ -1228,59 +1296,84 @@ Options affecting specific writers {.options}
1228 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1296 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1229 Note that no check for duplicate options is done.
1297 Note that no check for duplicate options is done.
1231−[Dublin Core elements]: http://dublincore.org/documents/dces/
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1232−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1233[Encoding issue with the listings package]:
1301[Encoding issue with the listings package]:
1234 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1236−Citation rendering {.options}
1304+## Citation rendering {.options}
1237−------------------
1305+
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].
1239`--bibliography=`*FILE*
1325`--bibliography=`*FILE*
1241: Set the `bibliography` field in the document's metadata to *FILE*,
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1242− overriding any value set in the metadata, and process citations
1328+ overriding any value set in the metadata. If you supply
1243− using `pandoc-citeproc`. (This is equivalent to
1244− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1245− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1246− used, making this equivalent to `--metadata bibliography=FILE`.
1247− If you supply this argument multiple times, each *FILE* will be added
1329+ this argument multiple times, each *FILE* will be added to
1248− to bibliography.
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`).
1250`--csl=`*FILE*
1335`--csl=`*FILE*
1252: Set the `csl` field in the document's metadata to *FILE*,
1337: Set the `csl` field in the document's metadata to *FILE*,
1253 overriding any value set in the metadata. (This is equivalent to
1338 overriding any value set in the metadata. (This is equivalent to
1254− `--metadata csl=FILE`.)
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1255− This option is only relevant with `pandoc-citeproc`.
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.
1257`--citation-abbreviations=`*FILE*
1345`--citation-abbreviations=`*FILE*
1259: Set the `citation-abbreviations` field in the document's metadata to
1347: Set the `citation-abbreviations` field in the document's metadata to
1260 *FILE*, overriding any value set in the metadata. (This is equivalent to
1348 *FILE*, overriding any value set in the metadata. (This is equivalent to
1261 `--metadata citation-abbreviations=FILE`.)
1349 `--metadata citation-abbreviations=FILE`.)
1262− This option is only relevant with `pandoc-citeproc`.
1350+ If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1351+ found relative to the working directory, it will be sought
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
1264`--natbib`
1355`--natbib`
1266−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1357+: Use [`natbib`] for citations in LaTeX output. This option
1267− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1268− use in producing a LaTeX file that can be processed with [`bibtex`].
1360+ that can be processed with [`bibtex`].
1270`--biblatex`
1362`--biblatex`
1272−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1273− with the `pandoc-citeproc` filter or with PDF output. It is intended for
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1274− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1367+ that can be processed with [`bibtex`] or [`biber`].
1276−Math rendering in HTML {.options}
1369+## Math rendering in HTML {.options}
1277−----------------------
1279−The default is to render TeX math as far as possible using Unicode characters.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1280−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1373+`class="math"`, so that they may be styled differently from the
1281−differently from the surrounding text if needed. However, this gives acceptable
1374+surrounding text if needed. However, this gives acceptable
1282−results only for basic math, usually you will want to use `--mathjax` or another
1375+results only for basic math, usually you will want to use
1283−of the following options.
1376+`--mathjax` or another of the following options.
1285`--mathjax`[`=`*URL*]
1378`--mathjax`[`=`*URL*]
@@ -1294,10 +1387,11 @@ of the following options.
1295`--mathml`
1388`--mathml`
1297−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1298− `html4` and `html5`). This is the default in `odt` output. Note that
1392+ default in `odt` output. Note that currently only Firefox
1299− currently only Firefox and Safari (and select e-book readers) natively
1393+ and Safari (and select e-book readers) natively support
1300− support MathML.
1394+ MathML.
1302`--webtex`[`=`*URL*]
1396`--webtex`[`=`*URL*]
@@ -1321,21 +1415,19 @@ of the following options.
1321`--gladtex`
1415`--gladtex`
1323: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1324− can then be processed by [GladTeX] to produce images of the typeset
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1325− formulas and an HTML file with links to these images.
1419+ formulas and an HTML file with these images embedded.
1326− So, the procedure is:
1328 pandoc -s --gladtex input.md -o myfile.htex
1421 pandoc -s --gladtex input.md -o myfile.htex
1329− gladtex -d myfile-images myfile.htex
1422+ gladtex -d image_dir myfile.htex
1330− # produces myfile.html and images in myfile-images
1423+ # produces myfile.html and images in image_dir
1332−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
1333[MathJax]: https://www.mathjax.org
1426[MathJax]: https://www.mathjax.org
1334[KaTeX]: https://github.com/Khan/KaTeX
1427[KaTeX]: https://github.com/Khan/KaTeX
1335−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
1337−Options for wrapper scripts {.options}
1430+## Options for wrapper scripts {.options}
1338−---------------------------
1340`--dump-args`
1432`--dump-args`
@@ -1359,8 +1451,277 @@ Options for wrapper scripts {.options}
1360 pandoc -o foo.html -s
1452 pandoc -o foo.html -s
1456+If pandoc completes successfully, it will return exit code 0.
1457+Nonzero exit codes have the following meanings:
1460+----- ------------------------------------
1461+ 3 PandocFailOnWarningError
1463+ 5 PandocTemplateError
1464+ 6 PandocOptionError
1465+ 21 PandocUnknownReaderError
1466+ 22 PandocUnknownWriterError
1467+ 23 PandocUnsupportedExtensionError
1468+ 24 PandocCiteprocError
1469+ 31 PandocEpubSubdirectoryError
1472+ 47 PandocPDFProgramNotFoundError
1474+ 62 PandocShouldNeverHappenError
1476+ 64 PandocParseError
1477+ 65 PandocParsecError
1478+ 66 PandocMakePDFError
1479+ 67 PandocSyntaxMapError
1480+ 83 PandocFilterError
1482+ 92 PandocUTF8DecodingError
1483+ 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
1485+ 97 PandocCouldNotFindDataFileError
1486+ 99 PandocResourceNotFound
1487+----- ------------------------------------
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:
1496+from: markdown+emoji
1497+# reader: may be used instead of from:
1499+# writer: may be used instead of to:
1501+# leave blank for output to stdout:
1503+# leave blank for input from stdin, use [] for no input:
1507+# or you may use input-file: with a single value
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.
1521+self-contained: false
1523+# note that structured variables may be specified:
1525+ documentclass: book
1530+# metadata values specified here are parsed as literal
1531+# string text, not markdown:
1538+# or you may use metadata-file: with a single value
1540+# Note that these take files, not their contents:
1541+include-before-body: []
1542+include-after-body: []
1543+include-in-header: []
1544+resource-path: ["."]
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).
1555+citation-abbreviations: abbrevs.json
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}`.
1572+# ERROR, WARNING, or INFO
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
1581+# part, chapter, section, or default:
1582+top-level-division: chapter
1585+pdf-engine: pdflatex
1588+# you may also use pdf-engine-opt: with a single option
1589+# pdf-engine-opt: "-shell-escape"
1591+# auto, preserve, or none
1596+extract-media: mediadir
1598+table-of-contents: true
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
1606+identifier-prefix: foo
1608+strip-empty-paragraphs: true
1609+# lf, crlf, or native
1611+strip-comments: false
1612+indented-code-classes: []
1614+default-image-extension: ".jpg"
1616+# either a style name of a style definition file:
1617+highlight-style: pygments
1620+# or you may use syntax-definition: with a single value
1623+reference-doc: myref.docx
1625+# method is plain, webtex, gladtex, mathml, mathjax, katex
1626+# you may specify a url with webtex, mathjax, katex
1629+ url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
1630+# none, references, or javascript
1631+email-obfuscation: javascript
1639+epub-subdirectory: EPUB
1640+epub-metadata: meta.xml
1643+epub-chapter-level: 1
1644+epub-cover-image: cover.jpg
1646+reference-links: true
1647+# block, section, or document
1648+reference-location: block
1649+markdown-headings: setext
1651+# accept, reject, or all
1652+track-changes: accept
1658+# none, all, or best
1661+# A list of two-element lists
1663+- ["User-Agent", "Mozilla/5.0"]
1665+fail-if-warnings: false
1671+Fields that are omitted will just have their regular
1672+default values. So a defaults file can be as simple as
1679+In fields that expect a file path (or list of file paths), the
1680+following syntax may be used to interpolate environment variables:
1683+csl: ${HOME}/mycsldir/special.csl
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`.
1691+`${.}` will resolve to the directory containing the default
1692+file itself. This allows you to refer to resources contained
1696+epub-cover-image: ${.}/cover.jpg
1697+epub-metadata: ${.}/meta.xml
1699+- . # the working directory from which pandoc is run
1700+- ${.}/images # the images subdirectory of the directory
1701+ # containing this defaults file
1704+This environment variable interpolation syntax *only* works in
1705+fields that expect file paths.
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`.
1715+When multiple defaults are used, their contents will be combined.
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.
1362−Templates
1724+# Templates
1365When the `-s/--standalone` option is used, pandoc uses a template to
1726When the `-s/--standalone` option is used, pandoc uses a template to
1366add header and footer material that is needed for a self-standing
1727add header and footer material that is needed for a self-standing
@@ -1386,18 +1747,398 @@ directory (see `--data-dir`, above). *Exceptions:*
1386Templates contain *variables*, which allow for the inclusion of
1747Templates contain *variables*, which allow for the inclusion of
1387arbitrary information at any point in the file. They may be set at the
1748arbitrary information at any point in the file. They may be set at the
1388command line using the `-V/--variable` option. If a variable is not set,
1749command line using the `-V/--variable` option. If a variable is not set,
1389−pandoc will look for the key in the document's metadata – which can be set
1750+pandoc will look for the key in the document's metadata, which can be set
1390using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1751using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1391−or with the `-M/--metadata` option.
1752+or with the `-M/--metadata` option. In addition, some variables
1753+are given default values by pandoc. See [Variables] below for
1754+a list of variables used in pandoc's default templates.
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.
1762+ [pandoc-templates]: https://github.com/jgm/pandoc-templates
1768+Anything between the sequence `$--` and the end of the
1769+line will be treated as a comment and omitted from the output.
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
1782+To include a literal `$` in the document, use `$$`.
1784+### Interpolated variables
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:
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.
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.
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:
1838+${if(foo)}bar${endif}
1851+The keyword `elseif` may be used to simplify complex nested
1866+A for loop begins with `for(variable)` (enclosed in
1867+matched delimiters) and ends with `endfor` (enclosed in matched
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
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.
1881+$for(foo)$$foo$$sep$, $endfor$
1884+ - $foo.last$, $foo.first$
1888+ - ${ foo.bar.last }, ${ foo.bar.first }
1892+$it.name$: $it.office$
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.
1901+${ for(foo) }${ foo }${ sep }, ${ endfor }
1904+Instead of using `variable` inside the loop, the special
1905+anaphoric keyword `it` may be used.
1909+ - ${ it.last }, ${ it.first }
1915+Partials (subtemplates stored in different files) may be
1916+included by using the name of the partial, followed
1917+by `()`, for example:
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:
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.)
1938+Partials may optionally be applied to variables using
1944+${ articles:bibentry() }
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
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`.
1962+Final newlines are omitted from included partials.
1964+Partials may include other partials.
1966+A separator between values of an array may be specified
1967+in square brackets, immediately after the variable name
1973+${articles:bibentry()[; ]$
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.
1982+To ensure that content is "nested," that is, subsequent lines
1983+indented, use the `^` directive:
1986+$item.number$ $^$$item.description$ ($item.price$)
1989+In this example, if `item.description` has multiple lines,
1990+they will all be indented to line up with the first line:
1993+00123 A fine bottle of 18-year old
1994+ Oban whiskey. ($148)
1997+To nest multiple lines to the same level, align them
1998+with the `^` directive in the template. For example:
2001+$item.number$ $^$$item.description$ ($item.price$)
2002+ (Available til $item.sellby$.)
2008+00123 A fine bottle of 18-year old
2009+ Oban whiskey. ($148)
2010+ (Available til March 30, 2020.)
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.
2018+### Breakable spaces
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 `~`).
2026+$~$This long line may break if the document is rendered
2027+with a short line length.$~$
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:
2041+$for(metadata/pairs)$
2042+- $it.key$: $it.value$
2045+$employee:name()/uppercase$
2048+Pipes may be chained:
2051+$for(employees/pairs)$
2052+$it.key/alpha/uppercase$. $it.name$
2056+Some pipes take parameters:
2059+|----------------------|------------|
2061+$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2063+|----------------------|------------|
2066+Currently the following pipes are predefined:
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,
2073+- `uppercase`: Converts text to uppercase.
2075+- `lowercase`: Converts text to lowercase.
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.
2081+- `reverse`: Reverses a textual value or array,
2082+ and has no effect on other values.
2084+- `first`: Returns the first value of an array, if
2085+ applied to a non-empty array; otherwise returns
2086+ the original value.
2088+- `last`: Returns the last value of an array, if
2089+ applied to a non-empty array; otherwise returns
2090+ the original value.
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.
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.
2100+- `chomp`: Removes trailing newlines (and breakable space).
2102+- `nowrap`: Disables line wrapping on breakable spaces.
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`.
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`.
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.
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.
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.
1393−Metadata variables
2134+### Metadata variables
1396`title`, `author`, `date`
2136`title`, `author`, `date`
1397: allow identification of basic aspects of the document. Included
2137: allow identification of basic aspects of the document. Included
1398 in PDF metadata through LaTeX and ConTeXt. These can be set
2138 in PDF metadata through LaTeX and ConTeXt. These can be set
1399 through a [pandoc title block][Extension: `pandoc_title_block`],
2139 through a [pandoc title block][Extension: `pandoc_title_block`],
1400− which allows for multiple authors, or through a YAML metadata block:
2140+ which allows for multiple authors, or through a
2141+ [YAML metadata block][Extension: `yaml_metadata_block`]:
@@ -1409,7 +2150,8 @@ Metadata variables
1409 including a title block in the document itself, you can
2150 including a title block in the document itself, you can
1410 set the `title-meta`, `author-meta`, and `date-meta`
2151 set the `title-meta`, `author-meta`, and `date-meta`
1411 variables. (By default these are set automatically, based
2152 variables. (By default these are set automatically, based
1412− on `title`, `author`, and `date`.)
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
1414`subtitle`
2156`subtitle`
1415: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2157: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
@@ -1436,7 +2178,7 @@ Metadata variables
1436Additionally,
2178Additionally,
1437any root-level string metadata, not included in ODT, docx
2179any root-level string metadata, not included in ODT, docx
1438or pptx metadata is added as a *custom property*.
2180or pptx metadata is added as a *custom property*.
1439−The following YAML metadata block for instance:
2181+The following [YAML] metadata block for instance:
1442 title: 'This is the title'
2184 title: 'This is the title'
@@ -1455,8 +2197,7 @@ will include `title`, `author` and `description` as standard document
1455properties and `subtitle` as a custom property when converting to docx,
2197properties and `subtitle` as a custom property when converting to docx,
1456ODT or pptx.
2198ODT or pptx.
1458−Language variables
2200+### Language variables
1462: identifies the main language of the document using IETF language
2203: identifies the main language of the document using IETF language
@@ -1484,28 +2225,101 @@ Language variables
1484: the base script direction, either `rtl` (right-to-left)
2225: the base script direction, either `rtl` (right-to-left)
1485 or `ltr` (left-to-right).
2226 or `ltr` (left-to-right).
1487− For bidirectional documents, native pandoc `span`s and `div`s
2228+ For bidirectional documents, native pandoc `span`s and
1488− with the `dir` attribute (value `rtl` or `ltr`) can be used to
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
1489− override the base direction in some output formats.
2230+ be used to override the base direction in some output
1490− This may not always be necessary if the final renderer
2231+ formats. This may not always be necessary if the final
1491− (e.g. the browser, when generating HTML) supports the
2232+ renderer (e.g. the browser, when generating HTML) supports
1492− [Unicode Bidirectional Algorithm].
2233+ the [Unicode Bidirectional Algorithm].
1494− When using LaTeX for bidirectional documents, only the `xelatex` engine
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
1495− is fully supported (use `--pdf-engine=xelatex`).
2237+ `--pdf-engine=xelatex`).
1497[BCP 47]: https://tools.ietf.org/html/bcp47
2239[BCP 47]: https://tools.ietf.org/html/bcp47
1498−[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
2240+[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1499[Language subtag lookup]: https://r12a.github.io/app-subtags/
2241[Language subtag lookup]: https://r12a.github.io/app-subtags/
2243+### Variables for HTML
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`.
2254+: sets the CSS `font-family` property on the `html` element.
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).
2262+: sets the CSS `color` property on the `html` element.
2265+: sets the CSS `color` property on all links.
2268+: sets the CSS `font-family` property on `code` elements.
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2275+: sets the CSS `line-height` property on the `html` element,
2276+ which is preferred to be unitless.
2279+: sets the CSS `background-color` property on the `html` element.
2281+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2282+: sets the corresponding CSS `padding` properties on the `body` element.
2284+To override or extend some [CSS] for just one document, include for example:
2290+ font-style: italic;
2293+ background-color: #f0f0f0;
2296+ padding: 0.5em 2em 0.5em 0.5em;
2299+ border-bottom: none;
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2306+### Variables for HTML math
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`.
1501−Variables for HTML slides
2313+### Variables for HTML slides
1502−-------------------------
1504These affect HTML output when [producing slide shows with pandoc].
2315These affect HTML output when [producing slide shows with pandoc].
1505−All [reveal.js configuration options] are available as variables.
2316+
2318+: author affiliations: can be a list when there are multiple authors
1507`revealjs-url`
2320`revealjs-url`
1508−: base URL for reveal.js documents (defaults to `reveal.js`)
2321+: base URL for reveal.js documents (defaults to
2322+ `https://unpkg.com/reveal.js@^4/`)
1511: base URL for S5 documents (defaults to `s5/default`)
2325: base URL for S5 documents (defaults to `s5/default`)
@@ -1517,10 +2331,16 @@ All [reveal.js configuration options] are available as variables.
1517`slideous-url`
2331`slideous-url`
1518: base URL for Slideous documents (defaults to `slideous`)
2332: base URL for Slideous documents (defaults to `slideous`)
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.
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`.
1520−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2341+[reveal.js configuration options]: https://revealjs.com/config/
1522−Variables for Beamer slides
2343+### Variables for Beamer slides
1523−---------------------------
1525These variables change the appearance of PDF slides using [`beamer`].
2345These variables change the appearance of PDF slides using [`beamer`].
@@ -1549,7 +2369,7 @@ These variables change the appearance of PDF slides using [`beamer`].
1549: enables "title pages" for new sections (default is true)
2369: enables "title pages" for new sections (default is true)
1551`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
2371`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1552−: beamer themes:
2372+: beamer themes
1554`themeoptions`
2374`themeoptions`
1555: options for LaTeX beamer themes (a list).
2375: options for LaTeX beamer themes (a list).
@@ -1557,19 +2377,27 @@ These variables change the appearance of PDF slides using [`beamer`].
1557`titlegraphic`
2377`titlegraphic`
1558: image for title slide
2378: image for title slide
2380+### Variables for PowerPoint
2382+These variables control the visual aspects of a slide show that
2383+are not easily controlled via templates.
2386+: font to use for code.
1560−Variables for LaTeX
2388+### Variables for LaTeX
1563Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2390Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1565−### Layout
2392+#### Layout
1567`block-headings`
2394`block-headings`
1568−: make `\paragraph` and `\subparagraph` (fourth- and fifth-level headings, or
2395+: make `\paragraph` and `\subparagraph` (fourth- and
2396+ fifth-level headings, or fifth- and sixth-level with book
1569− fifth- and sixth-level with book classes) free-standing rather than run-in;
2397+ classes) free-standing rather than run-in; requires further
1570− requires further formatting to distinguish from `\subsubsection` (third- or
2398+ formatting to distinguish from `\subsubsection` (third- or
1571− fourth-level headings). Instead of using this option, [KOMA-Script] can adjust
2399+ fourth-level headings). Instead of using this option,
1572− headings more extensively:
2400+ [KOMA-Script] can adjust headings more extensively:
1575 documentclass: scrartcl
2403 documentclass: scrartcl
@@ -1595,9 +2423,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1597`documentclass`
2425`documentclass`
1598−: document class: usually one of the standard classes, [`article`], [`book`],
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
1599− and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
1600− and `scrreprt`, which default to smaller margins; or [`memoir`]
2429+ default to smaller margins; or [`memoir`]
1602`geometry`
2431`geometry`
1603: option for [`geometry`] package, e.g. `margin=1in`;
2432: option for [`geometry`] package, e.g. `margin=1in`;
@@ -1610,9 +2439,21 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1610 - heightrounded
2439 - heightrounded
2443+: option for [`hyperref`] package, e.g. `linktoc=all`;
2444+ repeat for multiple options:
2450+ - pdfpagemode=FullScreen
2454+: if true, pandoc will use document class settings for
1614−: uses document class settings for indentation (the default LaTeX template
2455+ indentation (the default LaTeX template otherwise removes
1615− otherwise removes indentation and adds space between paragraphs)
2456+ indentation and adds space between paragraphs)
1617`linestretch`
2458`linestretch`
1618: adjusts line spacing using the [`setspace`]
2459: adjusts line spacing using the [`setspace`]
@@ -1634,11 +2475,11 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1634: numbering depth for sections (with `--number-sections` option
2475: numbering depth for sections (with `--number-sections` option
1635 or `numbersections` variable)
2476 or `numbersections` variable)
1637−### Fonts
2478+#### Fonts
1639`fontenc`
2480`fontenc`
1640−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2481+: allows font encoding to be specified through `fontenc` package (with
1641− default is `T1` (see [LaTeX font encodings guide])
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
1643`fontfamily`
2484`fontfamily`
1644: font package for use with `pdflatex`:
2485: font package for use with `pdflatex`:
@@ -1658,9 +2499,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1660`fontsize`
2501`fontsize`
1661−: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.
2502+: font size for body text. The standard classes allow 10pt, 11pt, and
1662− To use another size, set `documentclass` to one of the [KOMA-Script] classes,
2503+ 12pt. To use another size, set `documentclass` to one of
1663− such as `scrartcl` or `scrbook`.
2504+ the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.
1665`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
2506`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1666: font families for use with `xelatex` or
2507: font families for use with `xelatex` or
@@ -1669,9 +2510,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1670`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
2511`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1671: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
2512: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1672− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
2513+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any
1673− available through [`fontspec`]; repeat for multiple options. For example,
2514+ choices available through [`fontspec`]; repeat for multiple
2515+ options. For example, to use the [TeX Gyre] version of
1674− to use the [TeX Gyre] version of Palatino with lowercase figures:
2516+ Palatino with lowercase figures:
1677 mainfont: TeX Gyre Pagella
2519 mainfont: TeX Gyre Pagella
@@ -1683,7 +2525,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1683`microtypeoptions`
2525`microtypeoptions`
1684: options to pass to the microtype package
2526: options to pass to the microtype package
1686−### Links
2528+#### Links
1688`colorlinks`
2530`colorlinks`
1689: add color to link text; automatically enabled if any of
2531: add color to link text; automatically enabled if any of
@@ -1698,7 +2540,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1698`links-as-notes`
2540`links-as-notes`
1699: causes links to be printed as footnotes
2541: causes links to be printed as footnotes
1701−### Front matter
2543+#### Front matter
1703`lof`, `lot`
2545`lof`, `lot`
1704: include list of figures, list of tables
2546: include list of figures, list of tables
@@ -1707,12 +2549,13 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1707: contents of acknowledgments footnote after document title
2549: contents of acknowledgments footnote after document title
1710−: include table of contents (can also be set using `--toc/--table-of-contents`)
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
1712`toc-depth`
2555`toc-depth`
1713: level of section to include in table of contents
2556: level of section to include in table of contents
1715−### BibLaTeX Bibliographies
2558+#### BibLaTeX Bibliographies
1717These variables function when using BibLaTeX for [citation rendering].
2560These variables function when using BibLaTeX for [citation rendering].
@@ -1732,7 +2575,7 @@ These variables function when using BibLaTeX for [citation rendering].
1732: list of options for natbib
2575: list of options for natbib
1734[KOMA-Script]: https://ctan.org/pkg/koma-script
2577[KOMA-Script]: https://ctan.org/pkg/koma-script
1735−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
1736[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2579[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
1737[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
2580[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre
1738[`article`]: https://ctan.org/pkg/article
2581[`article`]: https://ctan.org/pkg/article
@@ -1741,8 +2584,7 @@ These variables function when using BibLaTeX for [citation rendering].
1741[`memoir`]: https://ctan.org/pkg/memoir
2584[`memoir`]: https://ctan.org/pkg/memoir
1742[`report`]: https://ctan.org/pkg/report
2585[`report`]: https://ctan.org/pkg/report
1744−Variables for ConTeXt
2587+### Variables for ConTeXt
1745−---------------------
1747Pandoc uses these variables when [creating a PDF] with ConTeXt.
2589Pandoc uses these variables when [creating a PDF] with ConTeXt.
@@ -1750,12 +2592,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
1750: font size for body text (e.g. `10pt`, `12pt`)
2592: font size for body text (e.g. `10pt`, `12pt`)
1752`headertext`, `footertext`
2594`headertext`, `footertext`
1753−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
1754− repeat up to four times for different placement
2596+ Footers]); repeat up to four times for different placement
1756`indenting`
2598`indenting`
1757−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
1758− repeat for multiple options
2600+ [ConTeXt Indentation]); repeat for multiple options
1760`interlinespace`
2602`interlinespace`
1761: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -1766,16 +2608,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
1766 repeat for multiple options
2608 repeat for multiple options
1768`linkcolor`, `contrastcolor`
2610`linkcolor`, `contrastcolor`
1769−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
1771`linkstyle`
2614`linkstyle`
1772−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
1774`lof`, `lot`
2618`lof`, `lot`
1775: include list of figures, list of tables
2619: include list of figures, list of tables
1777`mainfont`, `sansfont`, `monofont`, `mathfont`
2621`mainfont`, `sansfont`, `monofont`, `mathfont`
1778−: font families: take the name of any system font (see [ConTeXt Font Switching])
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
1780`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2625`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1781: sets margins, if `layout` is not used (otherwise `layout`
2626: sets margins, if `layout` is not used (otherwise `layout`
@@ -1790,18 +2635,41 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
1790 repeat for multiple options
2635 repeat for multiple options
1793−: adds to the preamble the setup necessary to generate PDF/A-1b:2005.
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
1794− To successfully generate PDF/A the required ICC color profiles have to
2644+ is not supported. To successfully generate PDF/A the required
1795− be available and the content and all included files (such as images)
2645+ ICC color profiles have to be available and the content and all
1796− have to be standard conforming. The ICC profiles can be obtained
2646+ included files (such as images) have to be standard conforming.
1797− from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more
2647+ The ICC profiles and output intent may be specified using the
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
1798− details.
2649+ PDFA] for more details.
2652+: when used in conjunction with `pdfa`, specifies the ICC profile to use
2653+ in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is
2654+ used as default. May be repeated to include multiple profiles. Note that
2655+ the profiles have to be available on the system. They can be obtained
2656+ from [ConTeXt ICC Profiles].
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.
1801−: include table of contents (can also be set using `--toc/--table-of-contents`)
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
1803`whitespace`
2667`whitespace`
1804−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
2672+: include all source documents as file attachments in the PDF file
1806[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
2674[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup
1807[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
2675[ConTeXt Layout]: https://wiki.contextgarden.net/Layout
@@ -1815,8 +2683,7 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
1815[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
2683[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace
1816[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
2684[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering
1818−Variables for `wkhtmltopdf`
2686+### Variables for `wkhtmltopdf`
1819−---------------------------
1821Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
2688Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].
1822The `--css` option also affects the output.
2689The `--css` option also affects the output.
@@ -1830,8 +2697,7 @@ The `--css` option also affects the output.
1830`papersize`
2697`papersize`
1831: sets the PDF paper size
2698: sets the PDF paper size
1833−Variables for man pages
2700+### Variables for man pages
1834−-----------------------
1836`adjusting`
2702`adjusting`
1837: adjusts text to left (`l`), right (`r`), center (`c`),
2703: adjusts text to left (`l`), right (`r`), center (`c`),
@@ -1849,8 +2715,7 @@ Variables for man pages
1849`section`
2715`section`
1850: section number in man pages
2716: section number in man pages
1852−Variables for ms
2718+### Variables for ms
1855`fontfamily`
2720`fontfamily`
1856: font family (e.g. `T` or `P`)
2721: font family (e.g. `T` or `P`)
@@ -1864,8 +2729,7 @@ Variables for ms
1864`pointsize`
2729`pointsize`
1865: point size (e.g. `10p`)
2730: point size (e.g. `10p`)
1867−Structural variables
2732+### Variables set automatically
1868−--------------------
1870Pandoc sets these variables automatically in response to [options] or
2734Pandoc sets these variables automatically in response to [options] or
1871document contents; users can also modify them. These vary depending
2735document contents; users can also modify them. These vary depending
@@ -1905,9 +2769,9 @@ on the output format, and include the following:
1906`sourcefile`, `outputfile`
2770`sourcefile`, `outputfile`
1907: source and destination filenames, as given on the command line.
2771: source and destination filenames, as given on the command line.
1908− `sourcefile` can also be a list if input comes from multiple files, or empty
2772+ `sourcefile` can also be a list if input comes from multiple files,
1909− if input is from stdin. You can use the following snippet in your template
2773+ or empty if input is from stdin. You can use the following snippet in
1910− to distinguish them:
2774+ your template to distinguish them:
1912 $if(sourcefile)$
2776 $if(sourcefile)$
1913 $for(sourcefile)$
2777 $for(sourcefile)$
@@ -1929,82 +2793,11 @@ on the output format, and include the following:
1930`toc-title`
2794`toc-title`
1931: title of table of contents (works only with EPUB,
2795: title of table of contents (works only with EPUB,
1932− opendocument, odt, docx, pptx, beamer, LaTeX)
2796+ HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
1934−Using variables in templates
1935−----------------------------
1937−Variable names are sequences of alphanumerics, `-`, and `_`,
1938−starting with a letter. A variable name surrounded by `$` signs
1939−will be replaced by its value. For example, the string `$title$` in
1941− <title>$title$</title>
1943−will be replaced by the document title.
1945−To write a literal `$` in a template, use `$$`.
1947−Templates may contain conditionals. The syntax is as follows:
1955−This will include `X` in the template if `variable` has a truthy
1956−value; otherwise it will include `Y`. Here a truthy value is any
1959−- a string that is not entirely white space,
1960−- a non-empty array where the first value is truthy,
1961−- any number (including zero),
1963−- the boolean `true` (to specify the boolean `true`
1964− value using YAML metadata or the `--metadata` flag,
1965− use `true`, `True`, or `TRUE`; with the `--variable`
1966− flag, simply omit a value for the variable, e.g.
1967− `--variable draft`).
1969−`X` and `Y` are placeholders for any valid template text,
1970−and may include interpolated variables or other conditionals.
1971−The `$else$` section may be omitted.
1973−When variables can have multiple values (for example, `author` in
1974−a multi-author document), you can use the `$for$` keyword:
1977− <meta name="author" content="$author$" />
1980−You can optionally specify a separator to be used between
1983− $for(author)$$author$$sep$, $endfor$
1985−Note that the separator needs to be specified immediately before the `$endfor`
1988−A dot can be used to select a field of a variable that takes
1989−an object as its value. So, for example:
1991− $author.name$ ($author.affiliation$)
1993−The value of a variable will be indented to the same level as the variable.
1995−If you use custom templates, you may need to revise them as pandoc
1996−changes. We recommend tracking the changes in the default templates,
1997−and modifying your custom templates accordingly. An easy way to do this
1998−is to fork the [pandoc-templates] repository and merge in changes after each
2001−Templates may contain comments: anything on a line after `$--`
2002−will be treated as a comment and ignored.
2004[pandoc-templates]: https://github.com/jgm/pandoc-templates
2798[pandoc-templates]: https://github.com/jgm/pandoc-templates
2006−Extensions
2800+# Extensions
2009The behavior of some of the readers and writers can be adjusted by
2802The behavior of some of the readers and writers can be adjusted by
2010enabling or disabling various extensions.
2803enabling or disabling various extensions.
@@ -2025,8 +2818,7 @@ Note that markdown extensions added to the `ipynb` format
2025affect Markdown cells in Jupyter notebooks (as do command-line
2818affect Markdown cells in Jupyter notebooks (as do command-line
2026options like `--atx-headers`).
2819options like `--atx-headers`).
2028−Typography
2821+## Typography
2031#### Extension: `smart` ####
2823#### Extension: `smart` ####
@@ -2058,8 +2850,7 @@ literally. In writing LaTeX, enabling `smart` tells pandoc
2058to use the ligatures when possible; if `smart` is disabled
2850to use the ligatures when possible; if `smart` is disabled
2059pandoc will use unicode quotation mark and dash characters.
2851pandoc will use unicode quotation mark and dash characters.
2061−Headings and sections
2853+## Headings and sections
2062−---------------------
2064#### Extension: `auto_identifiers` ####
2855#### Extension: `auto_identifiers` ####
@@ -2140,9 +2931,9 @@ Changes the algorithm used by `auto_identifiers` to conform to
2140GitHub's method. Spaces are converted to dashes (`-`),
2931GitHub's method. Spaces are converted to dashes (`-`),
2141uppercase characters to lowercase characters, and punctuation
2932uppercase characters to lowercase characters, and punctuation
2142characters other than `-` and `_` are removed.
2933characters other than `-` and `_` are removed.
2934+Emojis are replaced by their names.
2144−Math Input
2936+## Math Input
2147The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2148[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
@@ -2152,59 +2943,47 @@ are described in the section about Pandoc's Markdown.
2152However, they can also be used with HTML input. This is handy for
2943However, they can also be used with HTML input. This is handy for
2153reading web pages formatted using MathJax, for example.
2944reading web pages formatted using MathJax, for example.
2155−Raw HTML/TeX
2946+## Raw HTML/TeX
2158−The following extensions (especially how they affect Markdown
2159−input/output) are also described in more detail in their respective
2160−sections of [Pandoc's Markdown].
2162−#### Extension: `raw_html` {#raw_html}
2164−When converting from HTML, parse elements to raw HTML which are not
2165−representable in pandoc's AST.
2166−By default, this is disabled for HTML input.
2168−#### Extension: `raw_tex` {#raw_tex}
2948+The following extensions are described in more detail in
2949+their respective sections of [Pandoc's Markdown]:
2170−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
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.
2955+- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2172−This extension can be enabled/disabled for the following formats
2956+ to be included in a document. This extension can be enabled/disabled
2173−(in addition to `markdown`):
2957+ for the following formats (in addition to `markdown`):
2175−input formats
2959+ input formats
2176−: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2177− `\eqref` only), `ipynb`
2961+ `\eqref` only), `ipynb`
2180−: `textile`, `commonmark`
2182−Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2183−only raw TeX in markdown cells, but data with mime type
2184−`text/html` in output cells. Since the `ipynb` reader attempts
2185−to preserve the richest possible outputs when several options
2186−are given, you will get best results if you disable `raw_html`
2187−and `raw_tex` when converting to formats like `docx` which don't
2188−allow raw `html` or `tex`.
2190−#### Extension: `native_divs` {#native_divs}
2963+ output formats
2964+ : `textile`, `commonmark`
2192−This extension is enabled by default for HTML input. This means that
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2193−`div`s are parsed to pandoc native elements. (Alternatively, you
2967+ only raw TeX in markdown cells, but data with mime type
2194−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
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`.
2196−When converting HTML to Markdown, for example, you may want to drop all
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2197−`div`s and `span`s:
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`.
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
2199− pandoc -f html-native_divs-native_spans -t markdown
2984+ can use `pandoc -f html-native_divs-native_spans -t markdown`.
2201−#### Extension: `native_spans` {#native_spans}
2203−Analogous to `native_divs` above.
2206−Literate Haskell support
2986+## Literate Haskell support
2207−------------------------
2209#### Extension: `literate_haskell` ####
2988#### Extension: `literate_haskell` ####
@@ -2265,8 +3044,7 @@ Note that GHC expects the bird tracks in the first column, so indented
2265literate code blocks (e.g. inside an itemized environment) will not be
3044literate code blocks (e.g. inside an itemized environment) will not be
2266picked up by the Haskell compiler.
3045picked up by the Haskell compiler.
2268−Other extensions
3047+## Other extensions
2271#### Extension: `empty_paragraphs` ####
3049#### Extension: `empty_paragraphs` ####
@@ -2281,38 +3059,99 @@ input formats
2281output formats
3059output formats
2282: `docx`, `odt`, `opendocument`, `html`
3060: `docx`, `odt`, `opendocument`, `html`
2284−#### Extension: `styles` #### {#ext-styles}
3062+#### Extension: `native_numbering` ####
2286−When converting from docx, read all docx styles as divs (for
3064+Enables native numbering of figures and tables. Enumeration
2287−paragraph styles) and spans (for character styles) regardless
3065+starts at 1.
2288−of whether pandoc understands the meaning of these styles.
2289−This can be used with [docx custom styles](#custom-styles).
2290−Disabled by default.
3067+This extension can be enabled/disabled for the following formats:
3070+: `odt`, `opendocument`
3072+#### Extension: `xrefs_name` ####
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
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3084+This extension can be enabled/disabled for the following formats:
3087+: `odt`, `opendocument`
3089+#### Extension: `xrefs_number` ####
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.
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.
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3104+This extension can be enabled/disabled for the following formats:
3107+: `odt`, `opendocument`
3109+#### Extension: `styles` #### {#ext-styles}
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.
2292−input formats
3117+input formats
2293−: `docx`
3118+: `docx`
2295#### Extension: `amuse` ####
3120#### Extension: `amuse` ####
2297In the `muse` input format, this enables Text::Amuse
3122In the `muse` input format, this enables Text::Amuse
2298extensions to Emacs Muse markup.
3123extensions to Emacs Muse markup.
3125+#### Extension: `raw_markdown` ####
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
2300#### Extension: `citations` {#org-citations}
3133#### Extension: `citations` {#org-citations}
2302−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
2303−in `org` input.
3136+are also accepted in `org` input.
3138+#### Extension: `element_citations` ####
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.
2305#### Extension: `ntb` ####
3145#### Extension: `ntb` ####
2307In the `context` output format this enables the use of [Natural Tables
3147In the `context` output format this enables the use of [Natural Tables
2308−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2309−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2310Natural tables allow more fine-grained global customization but come
3150Natural tables allow more fine-grained global customization but come
2311at a performance penalty compared to extreme tables.
3151at a performance penalty compared to extreme tables.
2314−Pandoc's Markdown
3154+# Pandoc's Markdown
2317Pandoc understands an extended and slightly revised version of
3156Pandoc understands an extended and slightly revised version of
2318John Gruber's [Markdown] syntax. This document explains the syntax,
3157John Gruber's [Markdown] syntax. This document explains the syntax,
@@ -2322,8 +3161,7 @@ of `markdown`. Extensions can be enabled or disabled to specify the
2322behavior more granularly. They are described in the following. See also
3161behavior more granularly. They are described in the following. See also
2323[Extensions] above, for extensions that work also on other formats.
3162[Extensions] above, for extensions that work also on other formats.
2325−Philosophy
3164+## Philosophy
2328Markdown is designed to be easy to write, and, even more importantly,
3166Markdown is designed to be easy to write, and, even more importantly,
2329easy to read:
3167easy to read:
@@ -2331,7 +3169,7 @@ easy to read:
2331> A Markdown-formatted document should be publishable as-is, as plain
3169> A Markdown-formatted document should be publishable as-is, as plain
2332> text, without looking like it's been marked up with tags or formatting
3170> text, without looking like it's been marked up with tags or formatting
2333> instructions.
3171> instructions.
2334−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2336This principle has guided pandoc's decisions in finding syntax for
3174This principle has guided pandoc's decisions in finding syntax for
2337tables, footnotes, and other extensions.
3175tables, footnotes, and other extensions.
@@ -2344,8 +3182,7 @@ it discourages it, and provides other, non-HTMLish ways of representing
2344important document elements like definition lists, tables, mathematics, and
3182important document elements like definition lists, tables, mathematics, and
2345footnotes.
3183footnotes.
2347−Paragraphs
3185+## Paragraphs
2350A paragraph is one or more lines of text followed by one or more blank lines.
3187A paragraph is one or more lines of text followed by one or more blank lines.
2351Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3188Newlines are treated as spaces, so you can reflow your paragraphs as you like.
@@ -2358,8 +3195,7 @@ Note: in multiline and grid table cells, this is the only way
2358to create a hard line break, since trailing spaces in the cells
3195to create a hard line break, since trailing spaces in the cells
2359are ignored.
3196are ignored.
2361−Headings
3198+## Headings
2364There are two kinds of headings: Setext and ATX.
3200There are two kinds of headings: Setext and ATX.
@@ -2412,7 +3248,8 @@ pandoc does require the space.
2413### Heading identifiers ###
3249### Heading identifiers ###
3251+See also the [`auto_identifiers`
2415−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3252+extension](#extension-auto_identifiers) above.
2417#### Extension: `header_attributes` ####
3254#### Extension: `header_attributes` ####
@@ -2450,6 +3287,11 @@ is just the same as
2451 # My heading {.unnumbered}
3288 # My heading {.unnumbered}
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.)
2453#### Extension: `implicit_header_references` ####
3295#### Extension: `implicit_header_references` ####
2455Pandoc behaves as if reference links have been defined for each heading.
3297Pandoc behaves as if reference links have been defined for each heading.
@@ -2490,8 +3332,7 @@ link will point to `bar`, not to `#foo`:
2491 See [foo]
3333 See [foo]
2493−Block quotations
3335+## Block quotations
2496Markdown uses email conventions for quoting blocks of text.
3337Markdown uses email conventions for quoting blocks of text.
2497A block quotation is one or more paragraphs or other block elements
3338A block quotation is one or more paragraphs or other block elements
@@ -2530,19 +3371,19 @@ block in a block quote, you need five spaces after the `>`:
2531#### Extension: `blank_before_blockquote` ####
3372#### Extension: `blank_before_blockquote` ####
2533−Standard Markdown syntax does not require a blank line before a block
3374+Standard Markdown syntax does not require a blank line before a
2534−quote. Pandoc does require this (except, of course, at the beginning of the
3375+block quote. Pandoc does require this (except, of course, at
2535−document). The reason for the requirement is that it is all too easy for a
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
2536−`>` to end up at the beginning of a line by accident (perhaps through line
3378+of a line by accident (perhaps through line wrapping). So,
2537−wrapping). So, unless the `markdown_strict` format is used, the following does
3379+unless the `markdown_strict` format is used, the following does
2538not produce a nested block quote in pandoc:
3380not produce a nested block quote in pandoc:
2540 > This is a block quote.
3382 > This is a block quote.
2541 >> Nested.
3383 >> Nested.
2544−Verbatim (code) blocks
3386+## Verbatim (code) blocks
2545−----------------------
2547### Indented code blocks ###
3388### Indented code blocks ###
@@ -2604,14 +3445,16 @@ this syntax:
2604 qsort (filter (>= x) xs)
3445 qsort (filter (>= x) xs)
2605 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2607−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
2608−`startFrom` is an attribute with value `100`. Some output formats can use this
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
2609−information to do syntax highlighting. Currently, the only output formats
3451+highlighting. Currently, the only output formats that uses this
2610−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
2611−highlighting is supported for your output format and language, then the code
3453+highlighting is supported for your output format and language,
2612−block above will appear highlighted, with numbered lines. (To see which
3454+then the code block above will appear highlighted, with numbered
2613−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
2614−the code block above will appear as follows:
3457+will appear as follows:
2616 <pre id="mycode" class="haskell numberLines" startFrom="100">
3459 <pre id="mycode" class="haskell numberLines" startFrom="100">
@@ -2648,8 +3491,7 @@ To set the highlighting style, use `--highlight-style`.
2648For more information on highlighting, see [Syntax highlighting],
3491For more information on highlighting, see [Syntax highlighting],
2651−Line blocks
3494+## Line blocks
2654#### Extension: `line_blocks` ####
3496#### Extension: `line_blocks` ####
@@ -2675,10 +3517,12 @@ line must begin with a space.
2675 | 200 Main St.
3517 | 200 Main St.
2676 | Berkeley, CA 94718
3518 | Berkeley, CA 94718
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
2678This syntax is borrowed from [reStructuredText].
3523This syntax is borrowed from [reStructuredText].
2683### Bullet lists ###
3527### Bullet lists ###
@@ -2879,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
2879A definition begins with a colon or tilde, which may be indented one
3723A definition begins with a colon or tilde, which may be indented one
2880or two spaces.
3724or two spaces.
2882−A term may have multiple definitions, and each definition may consist of one or
3726+A term may have multiple definitions, and each definition may
2883−more block elements (paragraph, code block, list, etc.), each indented four
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
2884−spaces or one tab stop. The body of the definition (including the first line,
3729+body of the definition (including the first line, aside from the
2885−aside from the colon or tilde) should be indented four spaces. However,
3730+colon or tilde) should be indented four spaces. However, as with
2886−as with other Markdown lists, you can "lazily" omit indentation except
3731+other Markdown lists, you can "lazily" omit indentation except
2887at the beginning of a paragraph or other block element:
3732at the beginning of a paragraph or other block element:
@@ -2909,9 +3754,10 @@ definition:
2909Note that space between items in a definition list is required.
3754Note that space between items in a definition list is required.
2910(A variant that loosens this requirement, but disallows "lazy"
3755(A variant that loosens this requirement, but disallows "lazy"
2911hard wrapping, can be activated with `compact_definition_lists`: see
3756hard wrapping, can be activated with `compact_definition_lists`: see
2912−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
2914−[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
2916### Numbered example lists ###
3762### Numbered example lists ###
@@ -2947,30 +3793,6 @@ list marker. That is, example lists always behave as if the
2947labels tend to be long, and indenting content to the
3793labels tend to be long, and indenting content to the
2948first non-space character after the label would be awkward.
3794first non-space character after the label would be awkward.
2950−### Compact and loose lists ###
2952−Pandoc behaves differently from `Markdown.pl` on some "edge
2953−cases" involving lists. Consider this source:
2963−Pandoc transforms this into a "compact list" (with no `<p>` tags around
2964−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2965−"Second" and "Third" (but not "First"), because of the blank space
2966−around "Third". Pandoc follows a simple rule: if the text is followed by
2967−a blank line, it is treated as a paragraph. Since "Second" is followed
2968−by a list, and not a blank line, it isn't treated as a paragraph. The
2969−fact that the list is followed by a blank line is irrelevant. (Note:
2970−Pandoc works this way even when the `markdown_strict` format is specified. This
2971−behavior is consistent with the official Markdown syntax description,
2972−even though it is different from that of `Markdown.pl`.)
2975### Ending a list ###
3797### Ending a list ###
@@ -3009,8 +3831,7 @@ of one big list:
3012−Horizontal rules
3834+## Horizontal rules
3015A line containing a row of three or more `*`, `-`, or `_` characters
3836A line containing a row of three or more `*`, `-`, or `_` characters
3016(optionally separated by spaces) produces a horizontal rule:
3837(optionally separated by spaces) produces a horizontal rule:
@@ -3020,8 +3841,7 @@ A line containing a row of three or more `*`, `-`, or `_` characters
3020 ---------------
3841 ---------------
3023−Tables
3844+## Tables
3026Four kinds of tables may be used. The first three kinds presuppose the use of
3846Four kinds of tables may be used. The first three kinds presuppose the use of
3027a fixed-width font, such as Courier. The fourth kind can be used with
3847a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3148,9 +3968,8 @@ The row of `=`s separates the header from the table body, and can be
3148omitted for a headerless table. The cells of grid tables may contain
3968omitted for a headerless table. The cells of grid tables may contain
3149arbitrary block elements (multiple paragraphs, code blocks, lists,
3969arbitrary block elements (multiple paragraphs, code blocks, lists,
3150etc.). Cells that span multiple columns or rows are not
3970etc.). Cells that span multiple columns or rows are not
3151−supported. Grid tables can be created easily using [Emacs table mode].
3971+supported. Grid tables can be created easily using Emacs' table-mode
3152−
3972+(`M-x table-insert`).
3153−[Emacs table mode]: http://table.sourceforge.net/
3155Alignments can be specified as with pipe tables, by putting
3974Alignments can be specified as with pipe tables, by putting
3156colons at the boundaries of the separator line after the
3975colons at the boundaries of the separator line after the
@@ -3178,7 +3997,7 @@ and the same number of rows in each column. For example, the
3178Docutils [sample grid tables] will not render as expected with
3997Docutils [sample grid tables] will not render as expected with
3181−[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4000+[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
3184#### Extension: `pipe_tables` ####
4003#### Extension: `pipe_tables` ####
@@ -3211,7 +4030,7 @@ legal (though ugly) pipe table:
3212The cells of pipe tables cannot contain block elements like paragraphs
4031The cells of pipe tables cannot contain block elements like paragraphs
3213and lists, and cannot span multiple lines. If a pipe table contains a
4032and lists, and cannot span multiple lines. If a pipe table contains a
3214−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
3215`--columns`), then the table will take up the full text width and
4034`--columns`), then the table will take up the full text width and
3216the cell contents will wrap, with the relative cell widths determined
4035the cell contents will wrap, with the relative cell widths determined
3217by the number of dashes in the line separating the table header from
4036by the number of dashes in the line separating the table header from
@@ -3235,8 +4054,7 @@ you'll need to add colons as above.
3236[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
3238−Metadata blocks
4057+## Metadata blocks
3241#### Extension: `pandoc_title_block` ####
4059#### Extension: `pandoc_title_block` ####
@@ -3252,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
3252or all three elements. If you want to include an author but no
4070or all three elements. If you want to include an author but no
3253title, or a title and a date but no author, you need a blank line:
4071title, or a title and a date but no author, you need a blank line:
3256− % Author
4075+% Author
3258− % My title
4079+% My title
3260− % June 15, 2006
4081+% June 15, 2006
3262The title may occupy multiple lines, but continuation lines must
4084The title may occupy multiple lines, but continuation lines must
3263begin with leading space, thus:
4085begin with leading space, thus:
3265− % My title
4088+% My title
3266− on multiple lines
4089+ on multiple lines
3268If a document has multiple authors, the authors may be put on
4092If a document has multiple authors, the authors may be put on
3269separate lines with leading space, or separated by semicolons, or
4093separate lines with leading space, or separated by semicolons, or
3270both. So, all of the following are equivalent:
4094both. So, all of the following are equivalent:
3272− % Author One
4097+% Author One
3273− Author Two
4098+ Author Two
3275− % Author One; Author Two
4102+% Author One; Author Two
3277− % Author One;
4106+% Author One;
3278− Author Two
4107+ Author Two
3280The date must fit on one line.
4110The date must fit on one line.
@@ -3316,7 +4146,7 @@ will also have "Version 4.0" in the header.
3317#### Extension: `yaml_metadata_block` ####
4147#### Extension: `yaml_metadata_block` ####
3319−A YAML metadata block is a valid YAML object, delimited by a line of three
4149+A [YAML] metadata block is a valid YAML object, delimited by a line of three
3320hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
4150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots
3321(`...`) at the bottom. A YAML metadata block may occur anywhere in the
4151(`...`) at the bottom. A YAML metadata block may occur anywhere in the
3322document, but if it is not at the beginning, it must be preceded by a blank
4152document, but if it is not at the beginning, it must be preceded by a blank
@@ -3339,20 +4169,22 @@ given a role by external processors.) Field names must not be
3339interpretable as YAML numbers or boolean values (so, for
4169interpretable as YAML numbers or boolean values (so, for
3340example, `yes`, `True`, and `15` cannot be used as field names).
4170example, `yes`, `True`, and `15` cannot be used as field names).
3342−A document may contain multiple metadata blocks. The metadata fields will
4172+A document may contain multiple metadata blocks. If two
3343−be combined through a *left-biased union*: if two metadata blocks attempt
3344−to set the same field, the value from the first block will be taken.
4173+metadata blocks attempt to set the same field, the value from
4174+the second block will be taken.
3346When pandoc is used with `-t markdown` to create a Markdown document,
4176When pandoc is used with `-t markdown` to create a Markdown document,
3347a YAML metadata block will be produced only if the `-s/--standalone`
4177a YAML metadata block will be produced only if the `-s/--standalone`
3348option is used. All of the metadata will appear in a single block
4178option is used. All of the metadata will appear in a single block
3349at the beginning of the document.
4179at the beginning of the document.
3351−Note that YAML escaping rules must be followed. Thus, for example,
4181+Note that [YAML] escaping rules must be followed. Thus, for example,
3352−if a title contains a colon, it must be quoted. The pipe character
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
3353−(`|`) can be used to begin an indented block that will be interpreted
4185+an indented block that will be interpreted literally, without need for
3354−literally, without need for escaping. This form is necessary
4186+escaping. This form is necessary when the field contains blank lines
3355−when the field contains blank lines or block-level formatting:
4187+or block-level formatting:
3358 title: 'This is the title: it contains a colon'
4190 title: 'This is the title: it contains a colon'
@@ -3366,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
3366 It consists of two paragraphs.
4198 It consists of two paragraphs.
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
3369Template variables will be set automatically from the metadata. Thus, for
4207Template variables will be set automatically from the metadata. Thus, for
3370example, in writing HTML, the variable `abstract` will be set to the HTML
4208example, in writing HTML, the variable `abstract` will be set to the HTML
3371equivalent of the Markdown in the `abstract` field:
4209equivalent of the Markdown in the `abstract` field:
@@ -3412,8 +4250,25 @@ will be interpreted as markdown. For example:
3412 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
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:
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
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.
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
3415−Backslash escapes
4271+## Backslash escapes
3418#### Extension: `all_symbols_escapable` ####
4273#### Extension: `all_symbols_escapable` ####
@@ -3439,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
3439(However, if the `markdown_strict` format is used, the standard Markdown rule
4294(However, if the `markdown_strict` format is used, the standard Markdown rule
3440will be used.)
4295will be used.)
3442−A backslash-escaped space is parsed as a nonbreaking space. It will
4297+A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
3443−appear in TeX output as `~` and in HTML and XML as `\ ` or
4298+it will appear as `~`. In HTML and XML output, it will appear as a
3444−`\ `.
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
3446A backslash-escaped newline (i.e. a backslash occurring at the end of
4304A backslash-escaped newline (i.e. a backslash occurring at the end of
3447a line) is parsed as a hard line break. It will appear in TeX output as
4305a line) is parsed as a hard line break. It will appear in TeX output as
@@ -3451,8 +4309,7 @@ two trailing spaces on a line.
3452Backslash escapes do not work in verbatim contexts.
4310Backslash escapes do not work in verbatim contexts.
3454−Inline formatting
4312+## Inline formatting
3457### Emphasis ###
4314### Emphasis ###
@@ -3500,12 +4357,13 @@ text by `~` characters. Thus, for example,
3501 H~2~O is a liquid. 2^10^ is 1024.
4358 H~2~O is a liquid. 2^10^ is 1024.
4360+The text between `^...^` or `~...~` may not contain spaces or
3503−If the superscripted or subscripted text contains spaces, these spaces
4361+newlines. If the superscripted or subscripted text contains
3504−must be escaped with backslashes. (This is to prevent accidental
4362+spaces, these spaces must be escaped with backslashes. (This is
3505−superscripting and subscripting through the ordinary use of `~` and `^`.)
4363+to prevent accidental superscripting and subscripting through
4364+the ordinary use of `~` and `^`, and also bad interactions with
3506−Thus, if you want the letter P with 'a cat' in subscripts, use
4365+footnotes.) Thus, if you want the letter P with 'a cat' in
3507−`P~a\ cat~`, not `P~a cat~`.
4366+subscripts, use `P~a\ cat~`, not `P~a cat~`.
3510### Verbatim ###
4368### Verbatim ###
@@ -3554,8 +4412,7 @@ For compatibility with other Markdown flavors, CSS is also supported:
3554This will work in all output formats that support small caps.
4412This will work in all output formats that support small caps.
3560#### Extension: `tex_math_dollars` ####
4417#### Extension: `tex_math_dollars` ####
@@ -3567,6 +4424,10 @@ left, and must not be followed immediately by a digit. Thus,
3567you need to enclose text in literal `$` characters, backslash-escape
4424you need to enclose text in literal `$` characters, backslash-escape
3568them and they won't be treated as math delimiters.
4425them and they won't be treated as math delimiters.
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.)
3570TeX math will be printed in all output formats. How it is rendered
4431TeX math will be printed in all output formats. How it is rendered
3571depends on the output format:
4432depends on the output format:
@@ -3628,10 +4489,9 @@ HTML, Slidy, DZSlides, S5, EPUB
3628 command-line options selected. Therefore see [Math rendering in HTML]
4489 command-line options selected. Therefore see [Math rendering in HTML]
3631−[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4492+[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3633−Raw HTML
4494+## Raw HTML
3636#### Extension: `raw_html` ####
4496#### Extension: `raw_html` ####
@@ -3669,7 +4529,7 @@ Thus, for example, pandoc will turn
3671 <td>*one*</td>
4531 <td>*one*</td>
3672− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
3674 </table>
4534 </table>
@@ -3678,14 +4538,14 @@ into
3680 <td><em>one</em></td>
4540 <td><em>one</em></td>
3681− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
3683 </table>
4543 </table>
3685whereas `Markdown.pl` will preserve it as is.
4545whereas `Markdown.pl` will preserve it as is.
3687−There is one exception to this rule: text between `<script>` and
4547+There is one exception to this rule: text between `<script>`,
3688−`<style>` tags is not interpreted as Markdown.
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3690This departure from standard Markdown should make it easier to mix
4550This departure from standard Markdown should make it easier to mix
3691Markdown with HTML block elements. For example, one can surround
4551Markdown with HTML block elements. For example, one can surround
@@ -3777,8 +4637,7 @@ example, to use a raw attribute with a backtick code block,
3778The raw attribute cannot be combined with regular attributes.
4638The raw attribute cannot be combined with regular attributes.
3780−LaTeX macros
4640+## LaTeX macros
3783#### Extension: `latex_macros` ####
4642#### Extension: `latex_macros` ####
@@ -3799,11 +4658,13 @@ When `latex_macros` is disabled, the raw LaTeX and math will
3799not have macros applied. This is usually a better approach when
4658not have macros applied. This is usually a better approach when
3800you are targeting LaTeX or PDF.
4659you are targeting LaTeX or PDF.
3802−Whether or not `latex_macros` is enabled, the macro definitions
3803−will still be passed through as raw LaTeX.
4661+Macro definitions in LaTeX will be passed through as raw LaTeX
4662+only if `latex_macros` is not enabled. Macro definitions in
4663+Markdown source (or other formats allowing `raw_tex`) will
4664+be passed through regardless of whether `latex_macros` is
3808Markdown allows links to be specified in several ways.
4669Markdown allows links to be specified in several ways.
@@ -3812,7 +4673,7 @@ Markdown allows links to be specified in several ways.
3812If you enclose a URL or email address in pointy brackets, it
4673If you enclose a URL or email address in pointy brackets, it
3813will become a link:
4674will become a link:
3815− <http://google.com>
4676+ <https://google.com>
3816 <sam@green.eggs.ham>
4677 <sam@green.eggs.ham>
3818### Inline links ###
4679### Inline links ###
@@ -3822,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
3822be followed by a link title, in quotes.)
4683be followed by a link title, in quotes.)
3824 This is an [inline link](/url), and here's [one with
4685 This is an [inline link](/url), and here's [one with
3825− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
3827There can be no space between the bracketed part and the parenthesized part.
4688There can be no space between the bracketed part and the parenthesized part.
3828The link text can contain formatting (such as emphasis), but the title cannot.
4689The link text can contain formatting (such as emphasis), but the title cannot.
@@ -3851,7 +4712,7 @@ Here are some examples:
3852 [my label 1]: /foo/bar.html "My title, optional"
4713 [my label 1]: /foo/bar.html "My title, optional"
3853 [my label 2]: /foo
4714 [my label 2]: /foo
3854− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
3855 [my label 4]: /bar#special 'A title in single quotes'
4716 [my label 4]: /bar#special 'A title in single quotes'
3857The URL may optionally be surrounded by angle brackets:
4718The URL may optionally be surrounded by angle brackets:
@@ -3860,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
3861The title may go on the next line:
4722The title may go on the next line:
3863− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
3864 "The free software foundation"
4725 "The free software foundation"
3866Note that link labels are not case sensitive. So, this will work:
4727Note that link labels are not case sensitive. So, this will work:
@@ -3911,8 +4772,7 @@ or
3911Internal links are currently supported for HTML formats (including
4772Internal links are currently supported for HTML formats (including
3912HTML slide shows and EPUB), LaTeX, and ConTeXt.
4773HTML slide shows and EPUB), LaTeX, and ConTeXt.
3914−Images
4775+## Images
3917A link immediately preceded by a `!` will be treated as an image.
4777A link immediately preceded by a `!` will be treated as an image.
3918The link text will be used as the image's alt text:
4778The link text will be used as the image's alt text:
@@ -3958,10 +4818,11 @@ Attributes can be set on links and images:
3958(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4818(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3959and `.class` are used.)
4819and `.class` are used.)
3961−For HTML and EPUB, all attributes except `width` and `height` (but
4821+For HTML and EPUB, all known HTML5 attributes except `width` and
3962−including `srcset` and `sizes`) are passed through as is. The other
4822+`height` (but including `srcset` and `sizes`) are passed through
4823+as is. Unknown attributes are passed through as custom
4824+attributes, with `data-` prepended. The other writers ignore
3963−writers ignore attributes that are not supported by their output
4825+attributes that are not specifically supported by their output format.
3966The `width` and `height` attributes on images are treated specially. When
4827The `width` and `height` attributes on images are treated specially. When
3967used without a unit, the unit is assumed to be pixels. However, any of
4828used without a unit, the unit is assumed to be pixels. However, any of
@@ -3973,10 +4834,12 @@ For example:
3973{ width=50% }
4834{ width=50% }
3976−- Dimensions are converted to inches for output in page-based formats like
4837+- Dimensions may be converted to a form that is compatible with
3977− LaTeX. Dimensions are converted to pixels for output in HTML-like
4838+ the output format (for example, dimensions given in pixels will
3978− formats. Use the `--dpi` option to specify the number of pixels per
4839+ be converted to inches when converting HTML to LaTeX). Conversion
3979− inch. The default is 96dpi.
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).
3980- The `%` unit is generally relative to some available space.
4843- The `%` unit is generally relative to some available space.
3981 For example the above example will render to the following.
4844 For example the above example will render to the following.
3982 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4845 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -3985,14 +4848,13 @@ For example:
3985 as in the default template.)
4848 as in the default template.)
3986 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4849 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
3987- Some output formats have a notion of a class
4850- Some output formats have a notion of a class
3988− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3989 or a unique identifier (LaTeX `\caption`), or both (HTML).
4852 or a unique identifier (LaTeX `\caption`), or both (HTML).
3990- When no `width` or `height` attributes are specified, the fallback
4853- When no `width` or `height` attributes are specified, the fallback
3991 is to look at the image resolution and the dpi metadata embedded in
4854 is to look at the image resolution and the dpi metadata embedded in
3992 the image file.
4855 the image file.
3994−Divs and Spans
4857+## Divs and Spans
3997Using the `native_divs` and `native_spans` extensions
4859Using the `native_divs` and `native_spans` extensions
3998(see [above][Extension: `native_divs`]), HTML syntax can
4860(see [above][Extension: `native_divs`]), HTML syntax can
@@ -4048,8 +4910,7 @@ followed immediately by attributes:
4049 [This is *some text*]{.class key="val"}
4911 [This is *some text*]{.class key="val"}
4051−Footnotes
4913+## Footnotes
4054#### Extension: `footnotes` ####
4915#### Extension: `footnotes` ####
@@ -4095,143 +4956,72 @@ they cannot contain multiple paragraphs). The syntax is as follows:
4096Inline and regular footnotes may be mixed freely.
4957Inline and regular footnotes may be mixed freely.
4098−Citations
4959+## Citation syntax
4101#### Extension: `citations` ####
4961#### Extension: `citations` ####
4103−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4963+To cite a bibliographic item with an identifier foo, use the
4104−citations and a bibliography in a number of styles. Basic usage is
4964+syntax `@foo`. Normal citations should be included in square
4105−
4965+brackets, with semicolons separating distinct items:
4106− pandoc --filter pandoc-citeproc myinput.txt
4108−In order to use this feature, you will need to specify a bibliography file
4109−using the `bibliography` metadata field in a YAML metadata section, or
4110−`--bibliography` command line argument. You can supply multiple `--bibliography`
4111−arguments or set `bibliography` metadata field to YAML array, if you want to
4112−use multiple bibliography files. The bibliography may have any of these
4115− Format File extension
4116− ------------ --------------
4129−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4130−use `.bibtex` to force BibTeX.
4132−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4967+ Blah blah [@doe99; @smith2000; @smith2004].
4133−can produce `.json` and `.yaml` files from any of the supported formats.
4135−In-field markup: In BibTeX and BibLaTeX databases,
4969+How this is rendered depends on the citation style. In an
4136−pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4970+author-date style, it might render as
4137−databases, pandoc Markdown; and in CSL JSON databases, an
4138−[HTML-like markup][CSL markup specs]:
4140−`<i>...</i>`
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
4143−`<b>...</b>`
4974+In a footnote style, it might render as
4146−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4976+ Blah blah.[^1]
4149−`<sub>...</sub>`
4978+ [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4150−: subscript
4979+ Susan Smith, "Flies," *Journal of Insects* (2000);
4980+ Susan Smith, "Bees," *Journal of Insects* (2004).
4152−`<sup>...</sup>`
4982+See the [CSL user documentation] for more information about CSL
4153−: superscript
4983+styles and how they affect rendering.
4155−`<span class="nocase">...</span>`
4156−: prevent a phrase from being capitalized as title case
4158−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
4985+Unless a citation key start with a letter, digit, or `_`,
4159−and CSL YAML formats as far as possible.
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]`.
4161−As an alternative to specifying a bibliography file using `--bibliography`
4995+Citation items may optionally include a prefix, a locator, and
4162−or the YAML metadata field `bibliography`, you can include
4996+a suffix. In
4163−the citation data directly in the `references` field of the
4164−document's YAML metadata. The field should contain an array of
4165−YAML-encoded references, for example:
4167− ---
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4169− - type: article-journal
4170− id: WatsonCrick1953
4181− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4183− title-short: Molecular structure of nucleic acids
4184− container-title: Nature
4188− DOI: 10.1038/171737a0
4189− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4193−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
5000+The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
4194−of the supported formats.)
5001+and suffix `and *passim*`. The second item (`smith04`) has
5002+locator `chap. 1` and no prefix or suffix.
4196−Citations and references can be formatted using any style supported by the
5004+Pandoc uses some heuristics to separate the locator from the
4197−[Citation Style Language], listed in the [Zotero Style Repository].
5005+rest of the subject. It is sensitive to the locator terms
4198−These files are specified using the `--csl` option or the `csl` metadata field.
5006+defined in the [CSL locale files]. Either abbreviated or
4199−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4200−format. The CSL project provides further information on [finding and editing styles].
4202−To make your citations hyperlinks to the corresponding bibliography
4203−entries, add `link-citations: true` to your YAML metadata.
4205−Citations go inside square brackets and are separated by semicolons.
4206−Each citation must have a key, composed of '@' + the citation
4207−identifier from the database, and may optionally have a prefix,
4208−a locator, and a suffix. The citation key must begin with a letter, digit,
4209−or `_`, and may contain alphanumerics, `_`, and internal punctuation
4210−characters (`:.#$%&-+?<>~/`). Here are some examples:
4212− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4214− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4216− Blah blah [@smith04; @doe99].
4218−`pandoc-citeproc` detects locator terms in the [CSL locale files].
4219−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
5007+unabbreviated forms are accepted. In the `en-US` locale, locator
4220−locale, locator terms can be written in either singular or plural forms,
5008+terms can be written in either singular or plural forms, as
4221−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5009+`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4222−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
5010+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
4223−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
5011+`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012+`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
4224−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
5013+`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
4225−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
5014+`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
4226−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5015+`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4227locator term is used, "page" is assumed.
5016locator term is used, "page" is assumed.
4229−`pandoc-citeproc` will use heuristics to distinguish the locator
5018+In complex cases, you can force something to be treated as
4230−from the suffix. In complex cases, the locator can be enclosed
5019+a locator by enclosing it in curly braces or prevent parsing
4231−in curly braces (using `pandoc-citeproc` 0.15 and higher only):
5020+the suffix as locator by prepending curly braces:
4233 [@smith{ii, A, D-Z}, with a suffix]
5022 [@smith{ii, A, D-Z}, with a suffix]
4234 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5023 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
4236A minus sign (`-`) before the `@` will suppress mention of
5026A minus sign (`-`) before the `@` will suppress mention of
4237the author in the citation. This can be useful when the
5027the author in the citation. This can be useful when the
@@ -4239,83 +5029,103 @@ author is already mentioned in the text:
4240 Smith says blah [-@smith04].
5030 Smith says blah [-@smith04].
4242−You can also write an in-text citation, as follows:
5032+You can also write an author-in-text citation, by omitting the
4244 @smith04 says blah.
5035 @smith04 says blah.
4246 @smith04 [p. 33] says blah.
5037 @smith04 [p. 33] says blah.
4248−If the style calls for a list of works cited, it will be placed
5039+This will cause the author's name to be rendered, followed by
4249−in a div with id `refs`, if one exists:
5040+the bibliographical details. Use this form when you want to
4250−
5041+make the citation the subject of a sentence.
4252− :::
5043+When you are using a note style, it is usually better to let
4253−
5044+citeproc create the footnotes from citations rather than writing
4254−Otherwise, it will be placed at the end of the document.
5045+an explicit note. If you do write an explicit note that
4255−Generation of the bibliography can be suppressed by setting
5046+contains a citation, note that normal citations will be put in
4256−`suppress-bibliography: true` in the YAML metadata.
5047+parentheses, while author-in-text citations will not. For
4257−
5048+this reason, it is sometimes preferable to use the
4258−If you wish the bibliography to have a section heading, you can
5049+author-in-text style inside notes when using a note style.
4259−set `reference-section-title` in the metadata, or put the heading
5050+
4260−at the beginning of the div with id `refs` (if you are using it)
5051+[CSL user documentation]: https://citationstyles.org/authors/
4261−or at the end of your document:
5052+[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4267−The bibliography will be inserted after this heading. Note that
4268−the `unnumbered` class will be added to this heading, so that the
4269−section will not be numbered.
4271−If you want to include items in the bibliography without actually
4272−citing them in the body text, you can define a dummy `nocite` metadata
4273−field and put the citations there:
4282−In this example, the document will contain a citation for `item3`
4283−only, but the bibliography will contain entries for `item1`, `item2`, and
4286−It is possible to create a bibliography with all the citations,
4287−whether or not they appear in the document, by using a wildcard:
4294−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4295−render the bibliography. In order to do so, specify bibliography
4296−files as outlined above, and add `--natbib` or `--biblatex`
4297−argument to `pandoc` invocation. Bear in mind that bibliography
4298−files have to be in respective format (either BibTeX or
4301−For more information, see the [pandoc-citeproc man page].
4303−[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5053+[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
4304−[Chicago Manual of Style]: http://chicagomanualofstyle.org
5054+[Chicago Manual of Style]: https://chicagomanualofstyle.org
4305−[Citation Style Language]: http://citationstyles.org
5055+[Citation Style Language]: https://citationstyles.org
4306[Zotero Style Repository]: https://www.zotero.org/styles
5056[Zotero Style Repository]: https://www.zotero.org/styles
4307[finding and editing styles]: https://citationstyles.org/authors/
5057[finding and editing styles]: https://citationstyles.org/authors/
4308[CSL locale files]: https://github.com/citation-style-language/locales
5058[CSL locale files]: https://github.com/citation-style-language/locales
4309−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4311−Non-pandoc extensions
5060+## Non-default extensions
4312−---------------------
4314The following Markdown syntax extensions are not enabled by default
5062The following Markdown syntax extensions are not enabled by default
4315in pandoc, but may be enabled by adding `+EXTENSION` to the format
5063in pandoc, but may be enabled by adding `+EXTENSION` to the format
4316name, where `EXTENSION` is the name of the extension. Thus, for
5064name, where `EXTENSION` is the name of the extension. Thus, for
4317example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5065example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5067+#### Extension: `rebase_relative_paths` ####
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.
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
5083+ pandoc chap*/*.md -f markdown+rebase_relative_paths
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.
5090+Absolute paths and URLs are not changed. Neither are empty
5091+paths or paths consisting entirely of a fragment, e.g., `#foo`.
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.
5098+#### Extension: `attributes` ####
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`].
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
5111+- Consecutive attribute specifiers may be used,
5112+ either for blocks or for inlines. Their attributes
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
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.
4319#### Extension: `old_dashes` ####
5129#### Extension: `old_dashes` ####
4321Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5131Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -4428,7 +5238,7 @@ and image references. This extension should not be confused with the
4429 This is a reference ![image][ref] with multimarkdown attributes.
5239 This is a reference ![image][ref] with multimarkdown attributes.
4431− [ref]: http://path.to/image "Image title" width=20px height=30px
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
4432 id=myId class="myClass1 myClass2"
5242 id=myId class="myClass1 myClass2"
4434#### Extension: `mmd_header_identifiers` ####
5244#### Extension: `mmd_header_identifiers` ####
@@ -4463,60 +5273,390 @@ in several respects:
4463 we must either disallow lazy wrapping or require a blank line between
5273 we must either disallow lazy wrapping or require a blank line between
4464 list items.
5274 list items.
5276+#### Extension: `gutenberg` ####
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.
5282+ [Project Gutenberg]: https://www.gutenberg.org
5284+#### Extension: `sourcepos` ####
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.
4466−Markdown variants
5291+## Markdown variants
4469In addition to pandoc's extended Markdown, the following Markdown
5293In addition to pandoc's extended Markdown, the following Markdown
4470variants are supported:
5294variants are supported:
4472−`markdown_phpextra` (PHP Markdown Extra)
5296+- `markdown_phpextra` (PHP Markdown Extra)
4473−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
4474− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5298+- `markdown_mmd` (MultiMarkdown)
4475− `header_attributes`, `link_attributes`, `abbreviations`,
5299+- `markdown_strict` (Markdown.pl)
4476− `shortcut_reference_links`, `spaced_reference_links`.
5300+- `commonmark` (CommonMark)
4477−
5301+- `gfm` (Github-Flavored Markdown)
4478−`markdown_github` (deprecated GitHub-Flavored Markdown)
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
4479−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5303+
4480− `gfm_auto_identifiers`, `backtick_code_blocks`,
5304+To see which extensions are supported for a given format,
4481− `autolink_bare_uris`, `space_in_atx_header`,
5305+and which are enabled by default, you can use the command
4482− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5306+
4483− `shortcut_reference_links`, `angle_brackets_escapable`,
5307+ pandoc --list-extensions=FORMAT
4484− `lists_without_preceding_blankline`.
5308+
4485−
5309+where `FORMAT` is replaced with the name of the format.
4486−`markdown_mmd` (MultiMarkdown)
5310+
4487−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5311+Note that the list of extensions for `commonmark`,
4488− `tex_math_double_backslash`, `intraword_underscores`,
5312+`gfm`, and `commonmark_x` are defined relative to default
4489− `mmd_title_block`, `footnotes`, `definition_lists`,
5313+commonmark. So, for example, `backtick_code_blocks`
4490− `all_symbols_escapable`, `implicit_header_references`,
5314+does not appear as an extension, since it is enabled by
4491− `auto_identifiers`, `mmd_header_identifiers`,
5315+default and cannot be disabled.
4492− `shortcut_reference_links`, `implicit_figures`,
5316+
4493− `superscript`, `subscript`, `backtick_code_blocks`,
5317+# Citations
4494− `spaced_reference_links`, `raw_attribute`.
5318+
4495−
5319+When the `--citeproc` option is used, pandoc can automatically generate
4496−`markdown_strict` (Markdown.pl)
5320+citations and a bibliography in a number of styles. Basic usage is
4497−: `raw_html`, `shortcut_reference_links`,
5321+
4498− `spaced_reference_links`.
5322+ pandoc --citeproc myinput.txt
4500−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5324+To use this feature, you will need to have
4501−which is implemented as a set of extensions on `commonmark`).
5325+
4502−
5326+- a document containing citations (see [Extension: `citations`]);
4503−Note, however, that `commonmark` and `gfm` have limited support
5327+- a source of bibliographic data: either an external bibliography
4504−for extensions. Only those listed below (and `smart`,
5328+ file or a list of `references` in the document's YAML metadata
4505−`raw_tex`, and `hard_line_breaks`) will work. The extensions
5329+- optionally, a [CSL] citation style.
4506−can, however, all be individually disabled. Also, `raw_tex`
5330+
4507−only affects `gfm` output, not input.
5331+## Specifying bibliographic data
4509−`gfm` (GitHub-Flavored Markdown)
5333+You can specify an external bibliography using the
4510−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5334+`bibliography` metadata field in a YAML metadata section or the
4511− `gfm_auto_identifiers`, `backtick_code_blocks`,
5335+`--bibliography` command line argument. If you want to use
4512− `autolink_bare_uris`, `space_in_atx_header`,
5336+multiple bibliography files, you can supply multiple
4513− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5337+`--bibliography` arguments or set `bibliography` metadata field
4514− `shortcut_reference_links`, `angle_brackets_escapable`,
5338+to YAML array. A bibliography may have any of these formats:
4515− `lists_without_preceding_blankline`.
5339+
4516−
5340+ Format File extension
4517−
5341+ ------------ --------------
4518−Producing slide shows with pandoc
5342+ BibLaTeX .bib
4519−=================================
5343+ BibTeX .bibtex
5347+Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348+use the extension `.bibtex` to force interpretation as BibTeX.
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
5361+`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
5370+`<span class="nocase">...</span>`
5371+: prevent a phrase from being capitalized as title case
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:
5381+ - type: article-journal
5382+ id: WatsonCrick1953
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
5400+ DOI: 10.1038/171737a0
5401+ URL: https://www.nature.com/articles/171737a0
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.
5409+Note that `pandoc` can be used to produce such a YAML metadata
5410+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
5415+Indeed, `pandoc` can convert between any of these
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
5421+Running pandoc on a bibliography file with the `--citeproc`
5422+option will create a formatted bibliography in the format
5425+ pandoc chem.bib -s --citeproc -o chem.html
5426+ pandoc chem.bib -s --citeproc -o chem.pdf
5428+### Capitalization in titles
5430+If you are using a bibtex or biblatex bibliography, then observe
5431+the following rules:
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`.)
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:
5443+ title = {My Dinner with {Andre}}
5445+ - In addition, words that should remain lowercase (or camelCase)
5446+ should be protected:
5448+ title = {Spin Wave Dispersion on the {nm} Scale}
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.
5455+If you are using a CSL bibliography (either JSON or YAML), then observe
5456+the following rules:
5458+ - All titles should be in sentence case.
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.)
5464+ - Protect words that should not be converted to title case using
5467+ Spin wave dispersion on the <span class="nocase">nm</span> scale
5469+### Conference Papers, Published vs. Unpublished
5471+For a formally published conference paper, use the biblatex entry type
5472+`inproceedings` (which will be mapped to CSL `paper-conference`).
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`).
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.
5489+## Specifying a citation style
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
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
5510+ "container-title": {
5511+ "Lloyd's Law Reports": "Lloyd's Rep",
5512+ "Estates Gazette": "EG",
5513+ "Scots Law Times": "SLT"
5519+## Citations in note styles
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
5528+ Blah blah [@foo, p. 33].
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
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:
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].
5546+## Raw content in a style
5548+To include raw content in a prefix, suffix, delimiter, or term,
5549+surround it with these tags indicating the format:
5551+ {{jats}}<ref>{{/jats}}
5553+Without the tags, the string will be interpreted as a string
5554+and escaped in the output, rather than being passed through raw.
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.
5563+## Placement of the bibliography
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:
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.
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:
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.
5588+## Including uncited items in the bibliography
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:
5601+In this example, the document will contain a citation for `item3`
5602+only, but the bibliography will contain entries for `item1`, `item2`, and
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:
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.
5620+## Other relevant metadata fields
5622+A few other metadata fields affect bibliography formatting:
5625+: If true, citations will be
5626+ hyperlinked to the corresponding bibliography entries
5627+ (for author-date and numerical styles only).
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.)
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:
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).
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
4521You can use pandoc to produce an HTML + JavaScript slide presentation
5661You can use pandoc to produce an HTML + JavaScript slide presentation
4522that can be viewed via a web browser. There are five ways to do this,
5662that can be viewed via a web browser. There are five ways to do this,
@@ -4564,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
4565where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
4567−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
4568−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5708+pandoc with the `-s/--standalone` option embeds a link to
4569−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5709+JavaScript and CSS files, which are assumed to be available at
4570−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5710+the relative path `s5/default` (for S5), `slideous` (for
4571−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
4572−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
4573−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
4574−the file by default.
5714+variables; see [Variables for HTML slides], above.) For
4575−
5715+DZSlides, the (relatively short) JavaScript and CSS are included
4576−With all HTML slide formats, the `--self-contained` option can be used to
5716+in the file by default.
4577−produce a single file that contains all of the data necessary to display the
5717+
4578−slide show, including linked scripts, stylesheets, images, and videos.
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.
4580To produce a PDF slide show using beamer, type
5723To produce a PDF slide show using beamer, type
@@ -4588,8 +5731,7 @@ To produce a Powerpoint slide show, type
4589 pandoc habits.txt -o habits.pptx
5732 pandoc habits.txt -o habits.pptx
4591−Structuring the slide show
5734+## Structuring the slide show
4592−--------------------------
4594By default, the *slide level* is the highest heading level in
5736By default, the *slide level* is the highest heading level in
4595the hierarchy that is followed immediately by content, and not another
5737the hierarchy that is followed immediately by content, and not another
@@ -4606,7 +5748,11 @@ rules:
4606 * A heading at the slide level always starts a new slide.
5748 * A heading at the slide level always starts a new slide.
4608 * Headings *below* the slide level in the hierarchy create
5750 * Headings *below* the slide level in the hierarchy create
4609− headings *within* a slide.
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
4611 * Headings *above* the slide level in the hierarchy create
5757 * Headings *above* the slide level in the hierarchy create
4612 "title slides," which just contain the section title
5758 "title slides," which just contain the section title
@@ -4630,8 +5776,7 @@ layout will be produced, with level-1 headings building horizontally
4630and level-2 headings building vertically. It is not recommended that
5776and level-2 headings building vertically. It is not recommended that
4631you use deeper nesting of section levels with reveal.js.
5777you use deeper nesting of section levels with reveal.js.
4633−Incremental lists
5779+## Incremental lists
4636By default, these writers produce lists that display "all at once."
5781By default, these writers produce lists that display "all at once."
4637If you want your lists to display incrementally (one item at a time),
5782If you want your lists to display incrementally (one item at a time),
@@ -4669,8 +5814,10 @@ option):
4669Both methods allow incremental and nonincremental lists to be mixed
5814Both methods allow incremental and nonincremental lists to be mixed
4670in a single document.
5815in a single document.
4672−Inserting pauses
5817+Note: Neither the `-i/--incremental` option nor any of the
4673−----------------
5818+methods described here currently works for PowerPoint output.
4675You can add "pauses" within a slide by including a paragraph containing
5822You can add "pauses" within a slide by including a paragraph containing
4676three dots, separated by spaces:
5823three dots, separated by spaces:
@@ -4683,8 +5830,9 @@ three dots, separated by spaces:
4684 content after the pause
5831 content after the pause
4686−Styling the slides
5833+Note: this feature is not yet implemented for PowerPoint output.
4687−------------------
5834+
5835+## Styling the slides
4689You can change the style of HTML slides by putting customized CSS files
5837You can change the style of HTML slides by putting customized CSS files
4690in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
5838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -4719,8 +5867,7 @@ bibliographies:
4720 # References {.allowframebreaks}
5868 # References {.allowframebreaks}
4722−Speaker notes
5870+## Speaker notes
4725Speaker notes are supported in reveal.js and PowerPoint (pptx)
5872Speaker notes are supported in reveal.js and PowerPoint (pptx)
4726output. You can add notes to your Markdown document thus:
5873output. You can add notes to your Markdown document thus:
@@ -4741,8 +5888,7 @@ in handouts and presenter view.
4741Notes are not yet supported for other slide formats, but the notes
5888Notes are not yet supported for other slide formats, but the notes
4742will not appear on the slides themselves.
5889will not appear on the slides themselves.
4744−Columns
5891+## Columns
4747To put material in side by side columns, you can use a native
5893To put material in side by side columns, you can use a native
4748div container with class `columns`, containing two or more div
5894div container with class `columns`, containing two or more div
@@ -4757,8 +5903,42 @@ containers with class `column` and a `width` attribute:
4758 ::::::::::::::
5904 ::::::::::::::
4760−Frame attributes in beamer
5906+### Additional columns attributes in beamer
4761−--------------------------
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.
5913+ :::::::::::::: {.columns align=center totalwidth=8em}
5914+ ::: {.column width="40%"}
5917+ ::: {.column width="60%" align=bottom}
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`.
5926+The `totalwidth` attribute limits the width of the columns to the given value.
5928+ :::::::::::::: {.columns align=top .onlytextwidth}
5929+ ::: {.column width="40%" align=center}
5932+ ::: {.column width="60%"}
5937+The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.
5939+See Section 12.7 of the [Beamer User's Guide] for more details.
5941+## Frame attributes in beamer
4763Sometimes it is necessary to add the LaTeX `[fragile]` option to
5943Sometimes it is necessary to add the LaTeX `[fragile]` option to
4764a frame in beamer (for example, when using the `minted` environment).
5944a frame in beamer (for example, when using the `minted` environment).
@@ -4772,10 +5952,9 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4772`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4773`shrink`, `standout`, `noframenumbering`.
5953`shrink`, `standout`, `noframenumbering`.
4775−Background in reveal.js and beamer
5955+## Background in reveal.js and beamer
4776−----------------------------------
4778−Background images can be added to self-contained reveal.js slideshows and
5957+Background images can be added to self-contained reveal.js slideshows and
4779to beamer slideshows.
5958to beamer slideshows.
4781For the same image on every slide, use the configuration
5960For the same image on every slide, use the configuration
@@ -4783,9 +5962,9 @@ option `background-image` either in the YAML metadata block
4783or as a command-line variable. (There are no other options in
5962or as a command-line variable. (There are no other options in
4784beamer and the rest of this section concerns reveal.js slideshows.)
5963beamer and the rest of this section concerns reveal.js slideshows.)
4786−For reveal.js, you can instead use the reveal.js-native option
5965+For reveal.js, you can instead use the reveal.js-native option
4787−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
5966+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`
4788−and `parallaxBackgroundVertical` the same way and must also set
5967+and `parallaxBackgroundVertical` the same way and must also set
4789`parallaxBackgroundSize` to have your values take effect.
5968`parallaxBackgroundSize` to have your values take effect.
4791To set an image for a particular reveal.js slide, add
5970To set an image for a particular reveal.js slide, add
@@ -4799,9 +5978,12 @@ Other reveal.js background settings also work on individual slides, including
4799`data-background-size`, `data-background-repeat`, `data-background-color`,
5978`data-background-size`, `data-background-repeat`, `data-background-color`,
4800`data-transition`, and `data-transition-speed`.
5979`data-transition`, and `data-transition-speed`.
4802−See the [reveal.js
5981+To add a background image to the automatically generated title slide, use the
4803−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5982+`title-slide-attributes` variable in the YAML metadata block. It must contain
4804−for more details.
5983+a map of attribute names and values.
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
4806For example in reveal.js:
5988For example in reveal.js:
@@ -4809,6 +5991,9 @@ For example in reveal.js:
4810title: My Slideshow
5992title: My Slideshow
4811parallaxBackgroundImage: /path/to/my/background_image.png
5993parallaxBackgroundImage: /path/to/my/background_image.png
5994+title-slide-attributes:
5995+ data-background-image: /path/to/title_image.png
5996+ data-background-size: contain
4814## Slide One
5999## Slide One
@@ -4820,11 +6005,9 @@ Slide 1 has background_image.png as its background.
4820Slide 2 has a special image for its background, even though the heading has no content.
6005Slide 2 has a special image for its background, even though the heading has no content.
4823−Creating EPUBs with pandoc
6008+# EPUBs
4824−==========================
4826−EPUB Metadata
6010+## EPUB Metadata
4829EPUB metadata may be specified using the `--epub-metadata` option, but
6012EPUB metadata may be specified using the `--epub-metadata` option, but
4830if the source document is Markdown, it is better to use a [YAML metadata
6013if the source document is Markdown, it is better to use a [YAML metadata
@@ -4902,6 +6085,15 @@ The following fields are recognized:
4904 ~ A string value.
6087 ~ A string value.
6089+`belongs-to-collection`
6090+ ~ A string value. identifies the name of a collection to which
6091+ the EPUB Publication belongs.
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.
4906`cover-image`
6098`cover-image`
4907 ~ A string value (path to cover image).
6099 ~ A string value (path to cover image).
@@ -4923,11 +6115,10 @@ The following fields are recognized:
4923 - `binding`: `true`|`false` (default `true`)
6115 - `binding`: `true`|`false` (default `true`)
4924 - `scroll-axis`: `vertical`|`horizontal`|`default`
6116 - `scroll-axis`: `vertical`|`horizontal`|`default`
4926−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4927[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
6119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4929−The `epub:type` attribute
6121+## The `epub:type` attribute
4930−-------------------------
4932For `epub3` output, you can mark up the heading that corresponds to an EPUB
6123For `epub3` output, you can mark up the heading that corresponds to an EPUB
4933chapter using the [`epub:type` attribute][epub-type]. For example, to set
6124chapter using the [`epub:type` attribute][epub-type]. For example, to set
@@ -4964,8 +6155,6 @@ halftitlepage frontmatter
4964seriespage frontmatter
6155seriespage frontmatter
4965foreword frontmatter
6156foreword frontmatter
4966preface frontmatter
6157preface frontmatter
4967−seriespage frontmatter
4968−titlepage frontmatter
4969appendix backmatter
6158appendix backmatter
4970colophon backmatter
6159colophon backmatter
4971bibliography backmatter
6160bibliography backmatter
@@ -4973,8 +6162,7 @@ index backmatter
4974[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
6163[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute
4976−Linked media
6165+## Linked media
4979By default, pandoc will download media referenced from any `<img>`, `<audio>`,
6167By default, pandoc will download media referenced from any `<img>`, `<audio>`,
4980`<video>` or `<source>` element present in the generated EPUB,
6168`<video>` or `<source>` element present in the generated EPUB,
@@ -4984,13 +6172,12 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
4984with the `src` attribute. For example:
6172with the `src` attribute. For example:
4986 <audio controls="1">
6174 <audio controls="1">
4987− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
4988 data-external="1" type="audio/mpeg">
6176 data-external="1" type="audio/mpeg">
4989 </source>
6177 </source>
4990 </audio>
6178 </audio>
4992−Creating Jupyter notebooks with pandoc
6180+# Jupyter notebooks
4993−======================================
4995When creating a [Jupyter notebook], pandoc will try to infer the
6182When creating a [Jupyter notebook], pandoc will try to infer the
4996notebook structure. Code blocks with the class `code` will be
6183notebook structure. Code blocks with the class `code` will be
@@ -5115,8 +6302,7 @@ soft line breaks in Markdown cells; `--atx-headers` will
5115cause ATX-style headings to be used; and `--preserve-tabs` will
6302cause ATX-style headings to be used; and `--preserve-tabs` will
5116prevent tabs from being turned to spaces.
6303prevent tabs from being turned to spaces.
5118−Syntax highlighting
6305+# Syntax highlighting
5121Pandoc will automatically highlight syntax in [fenced code blocks] that
6307Pandoc will automatically highlight syntax in [fenced code blocks] that
5122are marked with a language name. The Haskell library [skylighting] is
6308are marked with a language name. The Haskell library [skylighting] is
@@ -5144,7 +6330,7 @@ Then edit `my.theme` and use it like this:
5144If you are not satisfied with the built-in highlighting, or you
6330If you are not satisfied with the built-in highlighting, or you
5145want highlight a language that isn't supported, you can use the
6331want highlight a language that isn't supported, you can use the
5146`--syntax-definition` option to load a [KDE-style XML syntax definition
6332`--syntax-definition` option to load a [KDE-style XML syntax definition
5147−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
5148Before writing your own, have a look at KDE's [repository of syntax
6334Before writing your own, have a look at KDE's [repository of syntax
5149definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
@@ -5152,13 +6338,11 @@ To disable highlighting, use the `--no-highlight` option.
5153[skylighting]: https://github.com/jgm/skylighting
6339[skylighting]: https://github.com/jgm/skylighting
5155−Custom Styles
6341+# Custom Styles
5158Custom styles can be used in the docx and ICML formats.
6343Custom styles can be used in the docx and ICML formats.
5160−Output
6345+## Output
5163By default, pandoc's docx and ICML output applies a predefined set of styles
6347By default, pandoc's docx and ICML output applies a predefined set of styles
5164for blocks such as paragraphs and block quotes, and uses largely default
6348for blocks such as paragraphs and block quotes, and uses largely default
@@ -5169,8 +6353,10 @@ styles, pandoc allows you to define custom styles for blocks and text
5169using `div`s and `span`s, respectively.
6353using `div`s and `span`s, respectively.
5171If you define a `div` or `span` with the attribute `custom-style`,
6355If you define a `div` or `span` with the attribute `custom-style`,
5172−pandoc will apply your specified style to the contained elements. So,
6356+pandoc will apply your specified style to the contained elements (with
5173−for example using the `bracketed_spans` syntax,
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,
5175 [Get out]{custom-style="Emphatically"}, he said.
6361 [Get out]{custom-style="Emphatically"}, he said.
@@ -5201,10 +6387,9 @@ custom-style `span`.
5201For docx output, you don't need to enable any extensions for
6387For docx output, you don't need to enable any extensions for
5202custom styles to work.
6388custom styles to work.
5204−[pandoc filters]: http://pandoc.org/filters.html
6390+[pandoc filters]: https://pandoc.org/filters.html
5209The docx reader, by default, only reads those styles that it can
6394The docx reader, by default, only reads those styles that it can
5210convert into pandoc elements, either by direct conversion or
6395convert into pandoc elements, either by direct conversion or
@@ -5233,17 +6418,17 @@ And with the extension:
5234 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
5236− ::: {custom-style="FirstParagraph"}
6421+ ::: {custom-style="First Paragraph"}
5237 This is some text.
6422 This is some text.
5240− ::: {custom-style="BodyText"}
6425+ ::: {custom-style="Body Text"}
5241 This is text with an [emphasized]{custom-style="Emphatic"} text style.
6426 This is text with an [emphasized]{custom-style="Emphatic"} text style.
5242 And this is text with a [strengthened]{custom-style="Strengthened"}
6427 And this is text with a [strengthened]{custom-style="Strengthened"}
5243 text style.
6428 text style.
5246− ::: {custom-style="MyBlockStyle"}
6431+ ::: {custom-style="My Block Style"}
5247 > Here is a styled paragraph that inherits from Block Text.
6432 > Here is a styled paragraph that inherits from Block Text.
@@ -5251,27 +6436,47 @@ With these custom styles, you can use your input document as a
5251reference-doc while creating docx output (see below), and maintain the
6436reference-doc while creating docx output (see below), and maintain the
5252same styles in your input and output files.
6437same styles in your input and output files.
5254−Custom writers
6439+# Custom writers
5257−Pandoc can be extended with custom writers written in [lua]. (Pandoc
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
5258−includes a lua interpreter, so lua need not be installed separately.)
6442+includes a Lua interpreter, so Lua need not be installed separately.)
5260−To use a custom writer, simply specify the path to the lua script
6444+To use a custom writer, simply specify the path to the Lua script
5261in place of the output format. For example:
6445in place of the output format. For example:
5263 pandoc -t data/sample.lua
6447 pandoc -t data/sample.lua
5265−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
5266possible element in a pandoc document. To get a documented example
6450possible element in a pandoc document. To get a documented example
5267which you can modify according to your needs, do
6451which you can modify according to your needs, do
5269 pandoc --print-default-data-file sample.lua
6453 pandoc --print-default-data-file sample.lua
5271−[lua]: http://www.lua.org
6455+Note that custom writers have no default template. If you want
6456+to use `--standalone` with a custom writer, you will need to
6457+specify a template manually using `--template` or add a new
6458+default template with the name
6459+`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6460+subdirectory of your user data directory (see [Templates]).
6462+[Lua]: https://www.lua.org
6464+# Reproducible builds
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).
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).
5273−A note on security
6479+# A note on security
5276If you use pandoc to convert user-contributed content in a web
6481If you use pandoc to convert user-contributed content in a web
5277application, here are some things to keep in mind:
6482application, here are some things to keep in mind:
@@ -5286,7 +6491,7 @@ application, here are some things to keep in mind:
5286 shelling out to the executable), it is possible to use it in a mode
6491 shelling out to the executable), it is possible to use it in a mode
5287 that fully isolates pandoc from your file system, by running the
6492 that fully isolates pandoc from your file system, by running the
5288 pandoc operations in the `PandocPure` monad. See the document
6493 pandoc operations in the `PandocPure` monad. See the document
5289− [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)
6494+ [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)
5290 for more details.
6495 for more details.
52923. Pandoc's parsers can exhibit pathological performance on some
64973. Pandoc's parsers can exhibit pathological performance on some
@@ -5299,17 +6504,17 @@ application, here are some things to keep in mind:
52994. The HTML generated by pandoc is not guaranteed to be safe.
65044. The HTML generated by pandoc is not guaranteed to be safe.
5300 If `raw_html` is enabled for the Markdown input, users can
6505 If `raw_html` is enabled for the Markdown input, users can
5301 inject arbitrary HTML. Even if `raw_html` is disabled,
6506 inject arbitrary HTML. Even if `raw_html` is disabled,
5302− users can include dangerous content in attributes for
6507+ users can include dangerous content in URLs and attributes.
5303− headings, spans, and code blocks. To be safe, you should
6508+ To be safe, you should run all the generated HTML through
5304− run all the generated HTML through an HTML sanitizer.
6509+ an HTML sanitizer.
5306−Authors
6511+# Authors
5309−Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
5310under the [GPL], version 2 or greater. This software carries no
6514under the [GPL], version 2 or greater. This software carries no
5311warranty of any kind. (See COPYRIGHT for full copyright and
6515warranty of any kind. (See COPYRIGHT for full copyright and
5312warranty notices.) For a full list of contributors, see the file
6516warranty notices.) For a full list of contributors, see the file
5313AUTHORS.md in the pandoc source code.
6517AUTHORS.md in the pandoc source code.
5315−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6519+[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
6520+[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"