@@ -1,7 +1,7 @@
2title: Pandoc User's Guide
2title: Pandoc User's Guide
3author: John MacFarlane
3author: John MacFarlane
4−date: January 5, 2020
4+date: June 20, 2021
@@ -106,7 +106,7 @@ RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
106the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
107will only be included if you use the `-s/--standalone` option.
109−[`iconv`]: http://www.gnu.org/software/libiconv/
109+[`iconv`]: https://www.gnu.org/software/libiconv/
111## Creating a PDF
111## Creating a PDF
@@ -136,22 +136,22 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136When using LaTeX, the following packages need to be available
136When using LaTeX, the following packages need to be available
137(they are included with all recent versions of [TeX Live]):
137(they are included with all recent versions of [TeX Live]):
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
140`--listings` option is used), [`fancyvrb`], [`longtable`],
141[`booktabs`], [`graphicx`] (if the document
141[`booktabs`], [`graphicx`] (if the document
142contains images), [`hyperref`], [`xcolor`],
142contains images), [`hyperref`], [`xcolor`],
143[`ulem`], [`geometry`] (with the `geometry` variable set),
143[`ulem`], [`geometry`] (with the `geometry` variable set),
144[`setspace`] (with `linestretch`), and
144[`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146−the PDF engine requires [`fontspec`]. `xelatex` uses
146+the PDF engine requires [`fontspec`]. `lualatex` uses
147−[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
147+[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
148−`dir` variable set). If the `mathspec` variable is set,
148+[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
149−`xelatex` will use [`mathspec`] instead of [`unicode-math`].
149+`mathspec` variable is set, `xelatex` will use [`mathspec`]
150−The [`upquote`] and [`microtype`] packages are used if
150+instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
151−available, and [`csquotes`] will be used for [typography]
151+packages are used if available, and [`csquotes`] will be used
152−if the `csquotes` variable or metadata field is set to a
152+for [typography] if the `csquotes` variable or metadata field is
153−true value. The [`natbib`], [`biblatex`], [`bibtex`], and
153+set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
154−[`biber`] packages can optionally be used for [citation
154+and [`biber`] packages can optionally be used for [citation
155rendering]. The following packages will be used to improve
155rendering]. The following packages will be used to improve
156output quality if present, but pandoc does not require them to
156output quality if present, but pandoc does not require them to
157be present: [`upquote`] (for straight quotes in verbatim
157be present: [`upquote`] (for straight quotes in verbatim
@@ -161,7 +161,7 @@ better line breaks in URLs), [`bookmark`] (for better PDF
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
161bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
162footnotes in tables).
162footnotes in tables).
164−[TeX Live]: http://www.tug.org/texlive/
164+[TeX Live]: https://www.tug.org/texlive/
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
166[`amsmath`]: https://ctan.org/pkg/amsmath
167[`babel`]: https://ctan.org/pkg/babel
167[`babel`]: https://ctan.org/pkg/babel
@@ -180,8 +180,7 @@ footnotes in tables).
180[`graphicx`]: https://ctan.org/pkg/graphicx
180[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
181[`grffile`]: https://ctan.org/pkg/grffile
182[`hyperref`]: https://ctan.org/pkg/hyperref
182[`hyperref`]: https://ctan.org/pkg/hyperref
183−[`ifluatex`]: https://ctan.org/pkg/ifluatex
184−[`ifxetex`]: https://ctan.org/pkg/ifxetex
183+[`iftex`]: https://ctan.org/pkg/iftex
185[`listings`]: https://ctan.org/pkg/listings
184[`listings`]: https://ctan.org/pkg/listings
186[`lm`]: https://ctan.org/pkg/lm
185[`lm`]: https://ctan.org/pkg/lm
187[`longtable`]: https://ctan.org/pkg/longtable
186[`longtable`]: https://ctan.org/pkg/longtable
@@ -195,26 +194,27 @@ footnotes in tables).
195[`ulem`]: https://ctan.org/pkg/ulem
194[`ulem`]: https://ctan.org/pkg/ulem
196[`unicode-math`]: https://ctan.org/pkg/unicode-math
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
197[`upquote`]: https://ctan.org/pkg/upquote
196[`upquote`]: https://ctan.org/pkg/upquote
198−[`weasyprint`]: http://weasyprint.org
197+[`weasyprint`]: https://weasyprint.org
199[`wkhtmltopdf`]: https://wkhtmltopdf.org
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
200[`xcolor`]: https://ctan.org/pkg/xcolor
199[`xcolor`]: https://ctan.org/pkg/xcolor
201[`xecjk`]: https://ctan.org/pkg/xecjk
200[`xecjk`]: https://ctan.org/pkg/xecjk
202[`xurl`]: https://ctan.org/pkg/xurl
201[`xurl`]: https://ctan.org/pkg/xurl
202+[`selnolig`]: https://ctan.org/pkg/selnolig
206## Reading from the Web
206## Reading from the Web
208−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
209pandoc will fetch the content using HTTP:
209pandoc will fetch the content using HTTP:
211− pandoc -f html -t markdown http://www.fsf.org
211+ pandoc -f html -t markdown https://www.fsf.org
213It is possible to supply a custom User-Agent string or other
213It is possible to supply a custom User-Agent string or other
214header when requesting a document from a URL:
214header when requesting a document from a URL:
216 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" \
217− http://www.fsf.org
217+ https://www.fsf.org
@@ -225,8 +225,13 @@ header when requesting a document from a URL:
225: Specify input format. *FORMAT* can be:
225: Specify input format. *FORMAT* can be:
227 ::: {#input-formats}
227 ::: {#input-formats}
228+ - `bibtex` ([BibTeX] bibliography)
229+ - `biblatex` ([BibLaTeX] bibliography)
228 - `commonmark` ([CommonMark] Markdown)
230 - `commonmark` ([CommonMark] Markdown)
231+ - `commonmark_x` ([CommonMark] Markdown with extensions)
229 - `creole` ([Creole 1.0])
232 - `creole` ([Creole 1.0])
233+ - `csljson` ([CSL JSON] bibliography)
234+ - `csv` ([CSV] table)
230 - `docbook` ([DocBook])
235 - `docbook` ([DocBook])
231 - `docx` ([Word docx])
236 - `docx` ([Word docx])
232 - `dokuwiki` ([DokuWiki markup])
237 - `dokuwiki` ([DokuWiki markup])
@@ -240,7 +245,7 @@ header when requesting a document from a URL:
240 - `html` ([HTML])
245 - `html` ([HTML])
241 - `ipynb` ([Jupyter notebook])
246 - `ipynb` ([Jupyter notebook])
242 - `jats` ([JATS] XML)
247 - `jats` ([JATS] XML)
243− - `jira` ([Jira] wiki markup)
248+ - `jira` ([Jira]/Confluence wiki markup)
244 - `json` (JSON version of native AST)
249 - `json` (JSON version of native AST)
245 - `latex` ([LaTeX])
250 - `latex` ([LaTeX])
246 - `markdown` ([Pandoc's Markdown])
251 - `markdown` ([Pandoc's Markdown])
@@ -275,8 +280,12 @@ header when requesting a document from a URL:
275 ::: {#output-formats}
280 ::: {#output-formats}
276 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
277 - `beamer` ([LaTeX beamer][`beamer`] slide show)
282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
278 - `commonmark` ([CommonMark] Markdown)
285 - `commonmark` ([CommonMark] Markdown)
286+ - `commonmark_x` ([CommonMark] Markdown with extensions)
279 - `context` ([ConTeXt])
287 - `context` ([ConTeXt])
288+ - `csljson` ([CSL JSON] bibliography)
280 - `docbook` or `docbook4` ([DocBook] 4)
289 - `docbook` or `docbook4` ([DocBook] 4)
281 - `docbook5` (DocBook 5)
290 - `docbook5` (DocBook 5)
282 - `docx` ([Word docx])
291 - `docx` ([Word docx])
@@ -293,8 +302,11 @@ header when requesting a document from a URL:
293 - `html4` ([XHTML] 1.0 Transitional)
302 - `html4` ([XHTML] 1.0 Transitional)
294 - `icml` ([InDesign ICML])
303 - `icml` ([InDesign ICML])
295 - `ipynb` ([Jupyter notebook])
304 - `ipynb` ([Jupyter notebook])
296− - `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`)
297− - `jira` ([Jira] wiki markup)
309+ - `jira` ([Jira]/Confluence wiki markup)
298 - `json` (JSON version of native AST)
310 - `json` (JSON version of native AST)
299 - `latex` ([LaTeX])
311 - `latex` ([LaTeX])
300 - `man` ([roff man])
312 - `man` ([roff man])
@@ -325,7 +337,7 @@ header when requesting a document from a URL:
325 - `tei` ([TEI Simple])
337 - `tei` ([TEI Simple])
326 - `xwiki` ([XWiki markup])
338 - `xwiki` ([XWiki markup])
327 - `zimwiki` ([ZimWiki markup])
339 - `zimwiki` ([ZimWiki markup])
328− - the path of a custom lua writer, see [Custom writers] below
340+ - the path of a custom Lua writer, see [Custom writers] below
331 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
343 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
@@ -349,15 +361,15 @@ header when requesting a document from a URL:
349 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`
350 subdirectory of the XDG data directory (by default,
362 subdirectory of the XDG data directory (by default,
351 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
352− environment variable). If that directory does not exist,
364+ environment variable). If that directory does not exist and
353− `$HOME/.pandoc` will be used (for backwards compatibility).
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
354− In Windows the default user data directory is
366+ On Windows the default user data directory is
355 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
356 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
357 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`,
358− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
371+ `reference.docx`, `epub.css`, `templates`) will override
359− `slidy`, `slideous`, or `s5` directory
360− placed in this directory will override pandoc's normal defaults.
372+ pandoc's normal defaults.
362`-d` *FILE*, `--defaults=`*FILE*
374`-d` *FILE*, `--defaults=`*FILE*
@@ -382,8 +394,7 @@ header when requesting a document from a URL:
383`--verbose`
395`--verbose`
385−: Give verbose debugging output. Currently this only has an effect
397+: Give verbose debugging output.
@@ -432,59 +443,63 @@ header when requesting a document from a URL:
433: Show usage message.
444: Show usage message.
435−[Markdown]: http://daringfireball.net/projects/markdown/
446+[Markdown]: https://daringfireball.net/projects/markdown/
436−[CommonMark]: http://commonmark.org
447+[CommonMark]: https://commonmark.org
437[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
448[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
438[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
449[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
439−[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
450+[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
440−[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
451+[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
441−[S5]: http://meyerweb.com/eric/tools/s5/
452+[S5]: https://meyerweb.com/eric/tools/s5/
442−[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
453+[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
443−[Slideous]: http://goessner.net/articles/slideous/
454+[Slideous]: https://goessner.net/articles/slideous/
444−[HTML]: http://www.w3.org/html/
455+[HTML]: https://www.w3.org/html/
445−[HTML5]: http://www.w3.org/TR/html5/
456+[HTML5]: https://html.spec.whatwg.org/
446[polyglot markup]: https://www.w3.org/TR/html-polyglot/
457[polyglot markup]: https://www.w3.org/TR/html-polyglot/
447−[XHTML]: http://www.w3.org/TR/xhtml1/
458+[XHTML]: https://www.w3.org/TR/xhtml1/
448−[LaTeX]: http://latex-project.org
459+[LaTeX]: https://www.latex-project.org/
449[`beamer`]: https://ctan.org/pkg/beamer
460[`beamer`]: https://ctan.org/pkg/beamer
450[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
451−[ConTeXt]: http://www.contextgarden.net/
462+[ConTeXt]: https://www.contextgarden.net/
452−[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format
463+[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
453−[DocBook]: http://docbook.org
464+[DocBook]: https://docbook.org
454[JATS]: https://jats.nlm.nih.gov
465[JATS]: https://jats.nlm.nih.gov
455[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
466[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
456−[txt2tags]: http://txt2tags.org
467+[txt2tags]: https://txt2tags.org
457[EPUB]: http://idpf.org/epub
468[EPUB]: http://idpf.org/epub
458[OPML]: http://dev.opml.org/spec2.html
469[OPML]: http://dev.opml.org/spec2.html
459[OpenDocument]: http://opendocument.xml.org
470[OpenDocument]: http://opendocument.xml.org
460−[ODT]: http://en.wikipedia.org/wiki/OpenDocument
471+[ODT]: https://en.wikipedia.org/wiki/OpenDocument
461−[Textile]: http://redcloth.org/textile
472+[Textile]: https://www.promptworks.com/textile
462[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
473[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
463[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
474[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
464−[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
475+[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
465[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/
466−[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
477+[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
467[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
468[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
479[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
469[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
480[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
470−[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)
471−[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
483+[roff ms]: https://man.cx/groff_ms(7)
472[Haskell]: https://www.haskell.org
484[Haskell]: https://www.haskell.org
473−[GNU Texinfo]: http://www.gnu.org/software/texinfo/
485+[GNU Texinfo]: https://www.gnu.org/software/texinfo/
474−[Emacs Org mode]: http://orgmode.org
486+[Emacs Org mode]: https://orgmode.org
475−[AsciiDoc]: http://www.methods.co.nz/asciidoc/
487+[AsciiDoc]: https://www.methods.co.nz/asciidoc/
476[AsciiDoctor]: https://asciidoctor.org/
488[AsciiDoctor]: https://asciidoctor.org/
477−[DZSlides]: http://paulrouget.com/dzslides/
489+[DZSlides]: https://paulrouget.com/dzslides/
478[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
479[PDF]: https://www.adobe.com/pdf/
491[PDF]: https://www.adobe.com/pdf/
480−[reveal.js]: http://lab.hakim.se/reveal-js/
492+[reveal.js]: https://revealjs.com/
481[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
482[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
494[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/
483−[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
484[TEI Simple]: https://github.com/TEIC/TEI-Simple
496[TEI Simple]: https://github.com/TEIC/TEI-Simple
485[Muse]: https://amusewiki.org/library/manual
497[Muse]: https://amusewiki.org/library/manual
486[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
487[Vimwiki]: https://vimwiki.github.io
499[Vimwiki]: https://vimwiki.github.io
500+[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501+[BibTeX]: https://ctan.org/pkg/bibtex
502+[BibLaTeX]: https://ctan.org/pkg/biblatex
489## Reader options {.options}
504## Reader options {.options}
@@ -574,41 +589,32 @@ header when requesting a document from a URL:
575 3. `$PATH` (executable only)
590 3. `$PATH` (executable only)
577− Filters and lua-filters are applied in the order specified
592+ Filters, Lua-filters, and citeproc processing are applied in
578− on the command line.
593+ the order specified on the command line.
580`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
595`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
582: Transform the document in a similar fashion as JSON filters (see
597: Transform the document in a similar fashion as JSON filters (see
583− `--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
584− 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
585− applied in order. Each lua filter must contain element-transforming
600+ applied in order. Each Lua filter must contain element-transforming
586 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
587 function should be applied.
602 function should be applied.
589− The `pandoc` lua module provides helper functions for element
604+ The `pandoc` Lua module provides helper functions for element
590− creation. It is always loaded into the script's lua environment.
605+ creation. It is always loaded into the script's Lua environment.
592− The following is an example lua script for macro-expansion:
607+ See the [Lua filters documentation] for further details.
594− function expand_hello_world(inline)
609+ In order of preference, pandoc will look for Lua filters in
595− if inline.c == '{{helloworld}}' then
596− return pandoc.Emph{ pandoc.Str "Hello, World" }
602− return {{Str = expand_hello_world}}
611+ 1. a specified full or relative path
604− 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).
606− 1. a specified full or relative path (executable or
616+ Filters, Lua filters, and citeproc processing are applied in
607− non-executable)
617+ the order specified on the command line.
609− 2. `$DATADIR/filters` (executable or non-executable)
610− where `$DATADIR` is the user data directory (see
611− `--data-dir`, above).
613`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
@@ -651,30 +657,30 @@ header when requesting a document from a URL:
652: Specifies what to do with insertions, deletions, and comments
658: Specifies what to do with insertions, deletions, and comments
653 produced by the MS Word "Track Changes" feature. `accept` (the
659 produced by the MS Word "Track Changes" feature. `accept` (the
654− default), inserts all insertions, and ignores all
660+ default) processes all the insertions and deletions.
655− deletions. `reject` inserts all deletions and ignores
656− insertions. Both `accept` and `reject` ignore comments. `all` puts
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
657− in insertions, deletions, and comments, wrapped in spans with
662+ `all` includes all insertions, deletions, and comments, wrapped
658− `insertion`, `deletion`, `comment-start`, and `comment-end`
663+ in spans with `insertion`, `deletion`, `comment-start`, and
659− classes, respectively. The author and time of change is
664+ `comment-end` classes, respectively. The author and time of
660− included. `all` is useful for scripting: only accepting changes
665+ change is included. `all` is useful for scripting: only
661− from a certain reviewer, say, or before a certain date. If a
666+ accepting changes from a certain reviewer, say, or before a
662− 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
663− span with the class `paragraph-insertion`/`paragraph-deletion`
669+ `paragraph-insertion`/`paragraph-deletion` before the
664− before the affected paragraph break. This option only affects the
670+ affected paragraph break. This option only affects the docx
665− docx reader.
671+ reader.
667`--extract-media=`*DIR*
673`--extract-media=`*DIR*
669: Extract images and other media contained in or linked from
675: Extract images and other media contained in or linked from
670 the source document to the path *DIR*, creating it if
676 the source document to the path *DIR*, creating it if
671 necessary, and adjust the images references in the document
677 necessary, and adjust the images references in the document
672− so they point to the extracted files. If the source format is
678+ so they point to the extracted files. Media are downloaded,
673− a binary container (docx, epub, or odt), the media is
679+ read from the file system, or extracted from a binary
674− extracted from the container and the original
680+ container (e.g. docx), as needed. The original file paths
675− filenames are used. Otherwise the media is read from the
681+ are used if they are relative paths not containing `..`.
676− file system or downloaded, and new filenames are constructed
682+ Otherwise filenames are constructed from the SHA1 hash of
677− based on SHA1 hashes of the contents.
683+ the contents.
679`--abbreviations=`*FILE*
685`--abbreviations=`*FILE*
@@ -685,14 +691,15 @@ header when requesting a document from a URL:
685 system default, use
691 system default, use
686 `pandoc --print-default-data-file=abbreviations`. The only
692 `pandoc --print-default-data-file=abbreviations`. The only
687 use pandoc makes of this list is in the Markdown reader.
693 use pandoc makes of this list is in the Markdown reader.
688− Strings ending in a period that are found in this list will
694+ Strings found in this list will be followed by a nonbreaking
689− be followed by a nonbreaking space, so that the period will
690− 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.
692[`pandocfilters`]: https://github.com/jgm/pandocfilters
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
693[PHP]: https://github.com/vinai/pandocfilters-php
699[PHP]: https://github.com/vinai/pandocfilters-php
694[perl]: https://metacpan.org/pod/Pandoc::Filter
700[perl]: https://metacpan.org/pod/Pandoc::Filter
695[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
697## General writer options {.options}
704## General writer options {.options}
@@ -884,11 +891,11 @@ header when requesting a document from a URL:
884 will not be searched. For example:
891 will not be searched. For example:
885 `--resource-path=.:test` will search the working directory
892 `--resource-path=.:test` will search the working directory
886 and the `test` subdirectory, in that order.
893 and the `test` subdirectory, in that order.
887−
894+ This option can be used repeatedly. Search path components
888− `--resource-path` only has an effect if (a) the output
895+ that come later on the command line will be searched before
889− format embeds images (for example, `docx`, `pdf`, or `html`
896+ those that come earlier, so
890− with `--self-contained`) or (b) it is used together with
897+ `--resource-path foo:bar --resource-path baz:bim` is
891− `--extract-media`.
898+ equivalent to `--resource-path baz:bim:foo:bar`.
893`--request-header=`*NAME*`:`*VAL*
900`--request-header=`*NAME*`:`*VAL*
@@ -898,6 +905,12 @@ header when requesting a document from a URL:
898 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
899 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).
901## Options affecting specific writers {.options}
914## Options affecting specific writers {.options}
903`--self-contained`
916`--self-contained`
@@ -923,7 +936,9 @@ header when requesting a document from a URL:
924`--html-q-tags`
937`--html-q-tags`
926−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
@@ -941,37 +956,45 @@ header when requesting a document from a URL:
941 placement of link references is affected by the
956 placement of link references is affected by the
942 `--reference-location` option.
957 `--reference-location` option.
944−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
946: Specify whether footnotes (and references, if `reference-links` is
961: Specify whether footnotes (and references, if `reference-links` is
947 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
948 current section, or the document. The default is
963 current section, or the document. The default is
949 `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.
951`--atx-headers`
974`--atx-headers`
953−: Use ATX-style headings in Markdown output. The default is
976+: *Deprecated synonym for `--markdown-headings=atx`.*
954− to use setext-style headings for levels 1 to 2, and then ATX headings.
955− (Note: for `gfm` output, ATX headings are always used.)
956− This option also affects markdown cells in `ipynb` output.
958−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
960−: Treat top-level headings as the given division type in LaTeX, ConTeXt,
980+: Treat top-level headings as the given division type in
961− 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
962− all headings are shifted such that the top-level heading becomes the specified
983+ shifted such that the top-level heading becomes the
963− type. The default behavior is to determine the best division type via
984+ specified type. The default behavior is to determine the
964− 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`
965− `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
987+ variable is set to `report`, `book`, or `memoir` (unless the
966− `article` option is specified), `chapter` is implied as the setting for this
988+ `article` option is specified), `chapter` is implied as the
967− 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
968− `part` will cause top-level headings to become `\part{..}`, while
991+ headings to become `\part{..}`, while second-level headings
969− second-level headings remain as their default type.
992+ remain as their default type.
971`-N`, `--number-sections`
994`-N`, `--number-sections`
973−: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
974− By default, sections are not numbered. Sections with class
997+ output. By default, sections are not numbered. Sections with class
975 `unnumbered` will never be numbered, even if `--number-sections`
998 `unnumbered` will never be numbered, even if `--number-sections`
976 is specified.
999 is specified.
@@ -1113,6 +1136,7 @@ header when requesting a document from a URL:
1113 - Verbatim Char
1136 - Verbatim Char
1114 - Footnote Reference
1137 - Footnote Reference
1115 - Hyperlink
1138 - Hyperlink
1117 Table style:
1141 Table style:
@@ -1260,7 +1284,9 @@ header when requesting a document from a URL:
1260 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1284 - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,
1261 `tectonic`, `latexmk`)
1285 `tectonic`, `latexmk`)
1262 - `-t context`: `context`
1286 - `-t context`: `context`
1263− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`)
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.)
1264 - `-t ms`: `pdfroff`
1290 - `-t ms`: `pdfroff`
1266`--pdf-engine-opt=`*STRING*
1292`--pdf-engine-opt=`*STRING*
@@ -1270,57 +1296,84 @@ header when requesting a document from a URL:
1270 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1296 auxiliary files, use `--pdf-engine-opt=-outdir=foo`.
1271 Note that no check for duplicate options is done.
1297 Note that no check for duplicate options is done.
1273−[Dublin Core elements]: http://dublincore.org/documents/dces/
1299+[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1274−[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1300+[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1275[Encoding issue with the listings package]:
1301[Encoding issue with the listings package]:
1276 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1302 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1278## Citation rendering {.options}
1304## Citation rendering {.options}
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].
1280`--bibliography=`*FILE*
1325`--bibliography=`*FILE*
1282: Set the `bibliography` field in the document's metadata to *FILE*,
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1283− overriding any value set in the metadata, and process citations
1328+ overriding any value set in the metadata. If you supply
1284− using `pandoc-citeproc`. (This is equivalent to
1285− `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1286− If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1287− used, making this equivalent to `--metadata bibliography=FILE`.
1288− If you supply this argument multiple times, each *FILE* will be added
1329+ this argument multiple times, each *FILE* will be added to
1289− 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`).
1291`--csl=`*FILE*
1335`--csl=`*FILE*
1293: Set the `csl` field in the document's metadata to *FILE*,
1337: Set the `csl` field in the document's metadata to *FILE*,
1294 overriding any value set in the metadata. (This is equivalent to
1338 overriding any value set in the metadata. (This is equivalent to
1295− `--metadata csl=FILE`.)
1339+ `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1296− 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.
1298`--citation-abbreviations=`*FILE*
1345`--citation-abbreviations=`*FILE*
1300: Set the `citation-abbreviations` field in the document's metadata to
1347: Set the `citation-abbreviations` field in the document's metadata to
1301 *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
1302 `--metadata citation-abbreviations=FILE`.)
1349 `--metadata citation-abbreviations=FILE`.)
1303− 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.
1305`--natbib`
1355`--natbib`
1307−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1357+: Use [`natbib`] for citations in LaTeX output. This option
1308− 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
1309− use in producing a LaTeX file that can be processed with [`bibtex`].
1360+ that can be processed with [`bibtex`].
1311`--biblatex`
1362`--biblatex`
1313−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1314− 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
1315− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1367+ that can be processed with [`bibtex`] or [`biber`].
1317## Math rendering in HTML {.options}
1369## Math rendering in HTML {.options}
1319−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
1320−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
1321−differently from the surrounding text if needed. However, this gives acceptable
1374+surrounding text if needed. However, this gives acceptable
1322−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
1323−of the following options.
1376+`--mathjax` or another of the following options.
1325`--mathjax`[`=`*URL*]
1378`--mathjax`[`=`*URL*]
@@ -1334,10 +1387,11 @@ of the following options.
1335`--mathml`
1388`--mathml`
1337−: 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
1338− `html4` and `html5`). This is the default in `odt` output. Note that
1392+ default in `odt` output. Note that currently only Firefox
1339− currently only Firefox and Safari (and select e-book readers) natively
1393+ and Safari (and select e-book readers) natively support
1340− support MathML.
1394+ MathML.
1342`--webtex`[`=`*URL*]
1396`--webtex`[`=`*URL*]
@@ -1361,18 +1415,17 @@ of the following options.
1361`--gladtex`
1415`--gladtex`
1363: 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
1364− 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
1365− formulas and an HTML file with links to these images.
1419+ formulas and an HTML file with these images embedded.
1366− So, the procedure is:
1368 pandoc -s --gladtex input.md -o myfile.htex
1421 pandoc -s --gladtex input.md -o myfile.htex
1369− gladtex -d myfile-images myfile.htex
1422+ gladtex -d image_dir myfile.htex
1370− # produces myfile.html and images in myfile-images
1423+ # produces myfile.html and images in image_dir
1372−[MathML]: http://www.w3.org/Math/
1425+[MathML]: https://www.w3.org/Math/
1373[MathJax]: https://www.mathjax.org
1426[MathJax]: https://www.mathjax.org
1374[KaTeX]: https://github.com/Khan/KaTeX
1427[KaTeX]: https://github.com/Khan/KaTeX
1375−[GladTeX]: http://humenda.github.io/GladTeX/
1428+[GladTeX]: https://humenda.github.io/GladTeX/
1377## Options for wrapper scripts {.options}
1430## Options for wrapper scripts {.options}
@@ -1412,8 +1465,10 @@ Nonzero exit codes have the following meanings:
1412 21 PandocUnknownReaderError
1465 21 PandocUnknownReaderError
1413 22 PandocUnknownWriterError
1466 22 PandocUnknownWriterError
1414 23 PandocUnsupportedExtensionError
1467 23 PandocUnsupportedExtensionError
1468+ 24 PandocCiteprocError
1415 31 PandocEpubSubdirectoryError
1469 31 PandocEpubSubdirectoryError
1416 43 PandocPDFError
1470 43 PandocPDFError
1417 47 PandocPDFProgramNotFoundError
1472 47 PandocPDFProgramNotFoundError
1418 61 PandocHttpError
1473 61 PandocHttpError
1419 62 PandocShouldNeverHappenError
1474 62 PandocShouldNeverHappenError
@@ -1426,6 +1481,7 @@ Nonzero exit codes have the following meanings:
1426 91 PandocMacroLoop
1481 91 PandocMacroLoop
1427 92 PandocUTF8DecodingError
1482 92 PandocUTF8DecodingError
1428 93 PandocIpynbDecodingError
1483 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
1429 97 PandocCouldNotFindDataFileError
1485 97 PandocCouldNotFindDataFileError
1430 99 PandocResourceNotFound
1486 99 PandocResourceNotFound
1431----- ------------------------------------
1487----- ------------------------------------
@@ -1450,6 +1506,16 @@ input-files:
1450- content.md
1506- content.md
1451# or you may use input-file: with a single value
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.
1453template: letter
1519template: letter
1454standalone: true
1520standalone: true
1455self-contained: false
1521self-contained: false
@@ -1477,11 +1543,24 @@ include-after-body: []
1477include-in-header: []
1543include-in-header: []
1478resource-path: ["."]
1544resource-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
1480−# filters will be assumed to be lua filters if they have
1557+# Filters will be assumed to be Lua filters if they have
1481# the .lua extension, and json filters otherwise. But
1558# the .lua extension, and json filters otherwise. But
1482−# the filter type can also be specified explicitly, as shown:
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}`.
1485- wordcount.lua
1564- wordcount.lua
1486- type: json
1565- type: json
1487 path: foo.lua
1566 path: foo.lua
@@ -1494,8 +1573,11 @@ data-dir:
1494verbosity: INFO
1573verbosity: INFO
1495log-file: log.json
1574log-file: log.json
1497−# citeproc, natbib, or biblatex
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).
1498cite-method: citeproc
1579cite-method: citeproc
1499# part, chapter, section, or default:
1581# part, chapter, section, or default:
1500top-level-division: chapter
1582top-level-division: chapter
1501abbreviations:
1583abbreviations:
@@ -1564,7 +1646,7 @@ epub-cover-image: cover.jpg
1564reference-links: true
1646reference-links: true
1565# block, section, or document
1647# block, section, or document
1566reference-location: block
1648reference-location: block
1567−atx-headers: false
1649+markdown-headings: setext
1569# accept, reject, or all
1651# accept, reject, or all
1570track-changes: accept
1652track-changes: accept
@@ -1594,6 +1676,34 @@ one line:
1594verbosity: INFO
1676verbosity: INFO
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.
1597Default files can be placed in the `defaults` subdirectory of
1707Default files can be placed in the `defaults` subdirectory of
1598the user data directory and used from any directory. For
1708the user data directory and used from any directory. For
1599example, one could create a file specifying defaults for writing
1709example, one could create a file specifying defaults for writing
@@ -1803,17 +1913,26 @@ ${ endfor }
1803### Partials
1913### Partials
1805Partials (subtemplates stored in different files) may be
1915Partials (subtemplates stored in different files) may be
1806−included using the syntax
1916+included by using the name of the partial, followed
1917+by `()`, for example:
1809−${ boilerplate() }
1920+${ styles() }
1812Partials will be sought in the directory containing
1923Partials will be sought in the directory containing
1813−the main template, and will be assumed to have the
1924+the main template. The file name will be assumed to
1814−same extension as the main template if they lack
1925+have the same extension as the main template if it
1815−an explicit extension. (If the partials are not
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
1816−found here, they will also be sought in the `templates`
1935+path, it will also be sought in the `templates`
1817subdirectory of the user data directory.)
1936subdirectory of the user data directory.)
1819Partials may optionally be applied to variables using
1938Partials may optionally be applied to variables using
@@ -1962,6 +2081,22 @@ Currently the following pipes are predefined:
1962- `reverse`: Reverses a textual value or array,
2081- `reverse`: Reverses a textual value or array,
1963 and has no effect on other values.
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.
1965- `chomp`: Removes trailing newlines (and breakable space).
2100- `chomp`: Removes trailing newlines (and breakable space).
1967- `nowrap`: Disables line wrapping on breakable spaces.
2102- `nowrap`: Disables line wrapping on breakable spaces.
@@ -2015,7 +2150,8 @@ Currently the following pipes are predefined:
2015 including a title block in the document itself, you can
2150 including a title block in the document itself, you can
2016 set the `title-meta`, `author-meta`, and `date-meta`
2151 set the `title-meta`, `author-meta`, and `date-meta`
2017 variables. (By default these are set automatically, based
2152 variables. (By default these are set automatically, based
2018− 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.
2020`subtitle`
2156`subtitle`
2021: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
2157: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
@@ -2089,35 +2225,101 @@ ODT or pptx.
2089: the base script direction, either `rtl` (right-to-left)
2225: the base script direction, either `rtl` (right-to-left)
2090 or `ltr` (left-to-right).
2226 or `ltr` (left-to-right).
2092− For bidirectional documents, native pandoc `span`s and `div`s
2228+ For bidirectional documents, native pandoc `span`s and
2093− with the `dir` attribute (value `rtl` or `ltr`) can be used to
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2094− override the base direction in some output formats.
2230+ be used to override the base direction in some output
2095− This may not always be necessary if the final renderer
2231+ formats. This may not always be necessary if the final
2096− (e.g. the browser, when generating HTML) supports the
2232+ renderer (e.g. the browser, when generating HTML) supports
2097− [Unicode Bidirectional Algorithm].
2233+ the [Unicode Bidirectional Algorithm].
2099− 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
2100− is fully supported (use `--pdf-engine=xelatex`).
2237+ `--pdf-engine=xelatex`).
2102[BCP 47]: https://tools.ietf.org/html/bcp47
2239[BCP 47]: https://tools.ietf.org/html/bcp47
2103−[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
2104[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
2106### Variables for HTML math
2306### Variables for HTML math
2108`classoption`
2308`classoption`
2109−: when using [KaTeX](#option--katex), you can render display math equations
2309+: when using [KaTeX](#option--katex), you can render display
2110− flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
2112### Variables for HTML slides
2313### Variables for HTML slides
2114These affect HTML output when [producing slide shows with pandoc].
2315These affect HTML output when [producing slide shows with pandoc].
2116−All [reveal.js configuration options] are available as variables.
2317+`institute`
2117−To turn off boolean flags that default to true in reveal.js, use `0`.
2318+: author affiliations: can be a list when there are multiple authors
2119`revealjs-url`
2320`revealjs-url`
2120−: 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/`)
2123: base URL for S5 documents (defaults to `s5/default`)
2325: base URL for S5 documents (defaults to `s5/default`)
@@ -2133,7 +2335,10 @@ To turn off boolean flags that default to true in reveal.js, use `0`.
2133: additional attributes for the title slide of reveal.js slide shows.
2335: additional attributes for the title slide of reveal.js slide shows.
2134 See [background in reveal.js and beamer] for an example.
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`.
2136−[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
2341+[reveal.js configuration options]: https://revealjs.com/config/
2138### Variables for Beamer slides
2343### Variables for Beamer slides
@@ -2218,9 +2423,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2220`documentclass`
2425`documentclass`
2221−: 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]
2222− and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2223− and `scrreprt`, which default to smaller margins; or [`memoir`]
2429+ default to smaller margins; or [`memoir`]
2225`geometry`
2431`geometry`
2226: option for [`geometry`] package, e.g. `margin=1in`;
2432: option for [`geometry`] package, e.g. `margin=1in`;
@@ -2245,8 +2451,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2454+: if true, pandoc will use document class settings for
2248−: uses document class settings for indentation (the default LaTeX template
2455+ indentation (the default LaTeX template otherwise removes
2249− otherwise removes indentation and adds space between paragraphs)
2456+ indentation and adds space between paragraphs)
2251`linestretch`
2458`linestretch`
2252: adjusts line spacing using the [`setspace`]
2459: adjusts line spacing using the [`setspace`]
@@ -2271,8 +2478,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2271#### Fonts
2478#### Fonts
2273`fontenc`
2480`fontenc`
2274−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2481+: allows font encoding to be specified through `fontenc` package (with
2275− default is `T1` (see [LaTeX font encodings guide])
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
2277`fontfamily`
2484`fontfamily`
2278: font package for use with `pdflatex`:
2485: font package for use with `pdflatex`:
@@ -2342,7 +2549,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
2342: contents of acknowledgments footnote after document title
2549: contents of acknowledgments footnote after document title
2345−: 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`)
2347`toc-depth`
2555`toc-depth`
2348: level of section to include in table of contents
2556: level of section to include in table of contents
@@ -2367,7 +2575,7 @@ These variables function when using BibLaTeX for [citation rendering].
2367: list of options for natbib
2575: list of options for natbib
2369[KOMA-Script]: https://ctan.org/pkg/koma-script
2577[KOMA-Script]: https://ctan.org/pkg/koma-script
2370−[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
2578+[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/
2371[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2579[LaTeX font encodings guide]: https://ctan.org/pkg/encguide
2372[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
2373[`article`]: https://ctan.org/pkg/article
2581[`article`]: https://ctan.org/pkg/article
@@ -2384,12 +2592,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
2384: font size for body text (e.g. `10pt`, `12pt`)
2592: font size for body text (e.g. `10pt`, `12pt`)
2386`headertext`, `footertext`
2594`headertext`, `footertext`
2387−: 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
2388− repeat up to four times for different placement
2596+ Footers]); repeat up to four times for different placement
2390`indenting`
2598`indenting`
2391−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2392− repeat for multiple options
2600+ [ConTeXt Indentation]); repeat for multiple options
2394`interlinespace`
2602`interlinespace`
2395: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -2400,16 +2608,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
2400 repeat for multiple options
2608 repeat for multiple options
2402`linkcolor`, `contrastcolor`
2610`linkcolor`, `contrastcolor`
2403−: 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
2405`linkstyle`
2614`linkstyle`
2406−: 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`
2408`lof`, `lot`
2618`lof`, `lot`
2409: include list of figures, list of tables
2619: include list of figures, list of tables
2411`mainfont`, `sansfont`, `monofont`, `mathfont`
2621`mainfont`, `sansfont`, `monofont`, `mathfont`
2412−: 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])
2414`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2625`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2415: sets margins, if `layout` is not used (otherwise `layout`
2626: sets margins, if `layout` is not used (otherwise `layout`
@@ -2424,16 +2635,18 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
2424 repeat for multiple options
2635 repeat for multiple options
2427−: adds to the preamble the setup necessary to generate PDF/A of the type
2638+: adds to the preamble the setup necessary to generate PDF/A
2428− specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
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.
2429− is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2641+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2430− block), `1b:2005` will be used as default, for reasons of backwards
2642+ `1b:2005` will be used as default, for reasons of backwards
2431− compatibility. Using `--variable=pdfa` without specified value is not supported.
2643+ compatibility. Using `--variable=pdfa` without specified value
2432− To successfully generate PDF/A the required ICC color profiles have to
2644+ is not supported. To successfully generate PDF/A the required
2433− 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
2646+ included files (such as images) have to be standard conforming.
2434− have to be standard conforming. The ICC profiles and output intent
2647+ The ICC profiles and output intent may be specified using the
2435− may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2436− See also [ConTeXt PDFA] for more details.
2649+ PDFA] for more details.
2438`pdfaiccprofile`
2651`pdfaiccprofile`
2439: when used in conjunction with `pdfa`, specifies the ICC profile to use
2652: when used in conjunction with `pdfa`, specifies the ICC profile to use
@@ -2448,10 +2661,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
2448 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2661 If left unspecified, `sRGB IEC61966-2.1` is used as default.
2451−: 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`)
2453`whitespace`
2667`whitespace`
2454−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
2456`includesource`
2671`includesource`
2457: include all source documents as file attachments in the PDF file
2672: include all source documents as file attachments in the PDF file
@@ -2730,53 +2945,43 @@ reading web pages formatted using MathJax, for example.
2731## Raw HTML/TeX
2946## Raw HTML/TeX
2733−The following extensions (especially how they affect Markdown
2734−input/output) are also described in more detail in their respective
2948+The following extensions are described in more detail in
2735−sections of [Pandoc's Markdown].
2949+their respective sections of [Pandoc's Markdown]:
2737−#### Extension: `raw_html` {#raw_html}
2739−When converting from HTML, parse elements to raw HTML which are not
2740−representable in pandoc's AST.
2741−By default, this is disabled for HTML input.
2743−#### Extension: `raw_tex` {#raw_tex}
2745−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
2747−This extension can be enabled/disabled for the following formats
2956+ to be included in a document. This extension can be enabled/disabled
2748−(in addition to `markdown`):
2957+ for the following formats (in addition to `markdown`):
2750−input formats
2959+ input formats
2751−: `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
2752− `\eqref` only), `ipynb`
2961+ `\eqref` only), `ipynb`
2755−: `textile`, `commonmark`
2757−Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2758−only raw TeX in markdown cells, but data with mime type
2759−`text/html` in output cells. Since the `ipynb` reader attempts
2760−to preserve the richest possible outputs when several options
2761−are given, you will get best results if you disable `raw_html`
2762−and `raw_tex` when converting to formats like `docx` which don't
2763−allow raw `html` or `tex`.
2765−#### Extension: `native_divs` {#native_divs}
2767−This extension is enabled by default for HTML input. This means that
2768−`div`s are parsed to pandoc native elements. (Alternatively, you
2769−can parse them to raw HTML using `-f html-native_divs+raw_html`.)
2771−When converting HTML to Markdown, for example, you may want to drop all
2774− pandoc -f html-native_divs-native_spans -t markdown
2963+ output formats
2964+ : `textile`, `commonmark`
2776−#### Extension: `native_spans` {#native_spans}
2966+ Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967+ only raw TeX in markdown cells, but data with mime type
2968+ `text/html` in output cells. Since the `ipynb` reader attempts
2969+ to preserve the richest possible outputs when several options
2970+ are given, you will get best results if you disable `raw_html`
2971+ and `raw_tex` when converting to formats like `docx` which don't
2972+ allow raw `html` or `tex`.
2974+- [`native_divs`](#extension-native_divs) causes HTML `div`
2975+ elements to be parsed as native pandoc Div blocks.
2976+ If you want them to be parsed as raw HTML, use
2778−Analogous to `native_divs` above.
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
2984+ can use `pandoc -f html-native_divs-native_spans -t markdown`.
2781## Literate Haskell support
2986## Literate Haskell support
@@ -2864,6 +3069,43 @@ This extension can be enabled/disabled for the following formats:
2864output formats
3069output formats
2865: `odt`, `opendocument`
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`
2867#### Extension: `styles` #### {#ext-styles}
3109#### Extension: `styles` #### {#ext-styles}
2869When converting from docx, read all docx styles as divs (for
3111When converting from docx, read all docx styles as divs (for
@@ -2880,16 +3122,31 @@ input formats
2880In the `muse` input format, this enables Text::Amuse
3122In the `muse` input format, this enables Text::Amuse
2881extensions 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
2883#### Extension: `citations` {#org-citations}
3133#### Extension: `citations` {#org-citations}
2885−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
2886−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.
2888#### Extension: `ntb` ####
3145#### Extension: `ntb` ####
2890In the `context` output format this enables the use of [Natural Tables
3147In the `context` output format this enables the use of [Natural Tables
2891−(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default
3148+(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
2892−[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).
3149+[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
2893Natural tables allow more fine-grained global customization but come
3150Natural tables allow more fine-grained global customization but come
2894at a performance penalty compared to extreme tables.
3151at a performance penalty compared to extreme tables.
@@ -2912,7 +3169,7 @@ easy to read:
2912> A Markdown-formatted document should be publishable as-is, as plain
3169> A Markdown-formatted document should be publishable as-is, as plain
2913> 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
2914> instructions.
3171> instructions.
2915−> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
3172+> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
2917This principle has guided pandoc's decisions in finding syntax for
3174This principle has guided pandoc's decisions in finding syntax for
2918tables, footnotes, and other extensions.
3175tables, footnotes, and other extensions.
@@ -2991,7 +3248,8 @@ pandoc does require the space.
2992### Heading identifiers ###
3249### Heading identifiers ###
3251+See also the [`auto_identifiers`
2994−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3252+extension](#extension-auto_identifiers) above.
2996#### Extension: `header_attributes` ####
3254#### Extension: `header_attributes` ####
@@ -3113,11 +3371,12 @@ block in a block quote, you need five spaces after the `>`:
3114#### Extension: `blank_before_blockquote` ####
3372#### Extension: `blank_before_blockquote` ####
3116−Standard Markdown syntax does not require a blank line before a block
3374+Standard Markdown syntax does not require a blank line before a
3117−quote. Pandoc does require this (except, of course, at the beginning of the
3375+block quote. Pandoc does require this (except, of course, at
3118−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
3119−`>` 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,
3120−wrapping). So, unless the `markdown_strict` format is used, the following does
3379+unless the `markdown_strict` format is used, the following does
3121not produce a nested block quote in pandoc:
3380not produce a nested block quote in pandoc:
3123 > This is a block quote.
3382 > This is a block quote.
@@ -3186,14 +3445,16 @@ this syntax:
3186 qsort (filter (>= x) xs)
3445 qsort (filter (>= x) xs)
3187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3189−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
3190−`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
3191−information to do syntax highlighting. Currently, the only output formats
3451+highlighting. Currently, the only output formats that uses this
3192−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3193−highlighting is supported for your output format and language, then the code
3453+highlighting is supported for your output format and language,
3194−block above will appear highlighted, with numbered lines. (To see which
3454+then the code block above will appear highlighted, with numbered
3195−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
3196−the code block above will appear as follows:
3457+will appear as follows:
3198 <pre id="mycode" class="haskell numberLines" startFrom="100">
3459 <pre id="mycode" class="haskell numberLines" startFrom="100">
@@ -3256,6 +3517,9 @@ line must begin with a space.
3256 | 200 Main St.
3517 | 200 Main St.
3257 | 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).
3259This syntax is borrowed from [reStructuredText].
3523This syntax is borrowed from [reStructuredText].
@@ -3459,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
3459A 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
3460or two spaces.
3724or two spaces.
3462−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
3463−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
3464−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
3465−aside from the colon or tilde) should be indented four spaces. However,
3730+colon or tilde) should be indented four spaces. However, as with
3466−as with other Markdown lists, you can "lazily" omit indentation except
3731+other Markdown lists, you can "lazily" omit indentation except
3467at the beginning of a paragraph or other block element:
3732at the beginning of a paragraph or other block element:
@@ -3489,9 +3754,10 @@ definition:
3489Note that space between items in a definition list is required.
3754Note that space between items in a definition list is required.
3490(A variant that loosens this requirement, but disallows "lazy"
3755(A variant that loosens this requirement, but disallows "lazy"
3491hard wrapping, can be activated with `compact_definition_lists`: see
3756hard wrapping, can be activated with `compact_definition_lists`: see
3492−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
3494−[^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/).
3496### Numbered example lists ###
3762### Numbered example lists ###
@@ -3527,30 +3793,6 @@ list marker. That is, example lists always behave as if the
3527labels tend to be long, and indenting content to the
3793labels tend to be long, and indenting content to the
3528first non-space character after the label would be awkward.
3794first non-space character after the label would be awkward.
3530−### Compact and loose lists ###
3532−Pandoc behaves differently from `Markdown.pl` on some "edge
3533−cases" involving lists. Consider this source:
3543−Pandoc transforms this into a "compact list" (with no `<p>` tags around
3544−"First", "Second", or "Third"), while Markdown puts `<p>` tags around
3545−"Second" and "Third" (but not "First"), because of the blank space
3546−around "Third". Pandoc follows a simple rule: if the text is followed by
3547−a blank line, it is treated as a paragraph. Since "Second" is followed
3548−by a list, and not a blank line, it isn't treated as a paragraph. The
3549−fact that the list is followed by a blank line is irrelevant. (Note:
3550−Pandoc works this way even when the `markdown_strict` format is specified. This
3551−behavior is consistent with the official Markdown syntax description,
3552−even though it is different from that of `Markdown.pl`.)
3555### Ending a list ###
3797### Ending a list ###
@@ -3755,7 +3997,7 @@ and the same number of rows in each column. For example, the
3755Docutils [sample grid tables] will not render as expected with
3997Docutils [sample grid tables] will not render as expected with
3758−[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
3761#### Extension: `pipe_tables` ####
4003#### Extension: `pipe_tables` ####
@@ -3788,7 +4030,7 @@ legal (though ugly) pipe table:
3789The cells of pipe tables cannot contain block elements like paragraphs
4031The cells of pipe tables cannot contain block elements like paragraphs
3790and 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
3791−row whose printable content is wider than the column width (see
4033+row whose Markdown content is wider than the column width (see
3792`--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
3793the cell contents will wrap, with the relative cell widths determined
4035the cell contents will wrap, with the relative cell widths determined
3794by 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
@@ -3828,30 +4070,42 @@ output.) The block may contain just a title, a title and an author,
3828or 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
3829title, 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:
3832− % Author
4075+% Author
3834− % My title
4079+% My title
3836− % June 15, 2006
4081+% June 15, 2006
3838The title may occupy multiple lines, but continuation lines must
4084The title may occupy multiple lines, but continuation lines must
3839begin with leading space, thus:
4085begin with leading space, thus:
3841− % My title
4088+% My title
3842− on multiple lines
4089+ on multiple lines
3844If a document has multiple authors, the authors may be put on
4092If a document has multiple authors, the authors may be put on
3845separate lines with leading space, or separated by semicolons, or
4093separate lines with leading space, or separated by semicolons, or
3846both. So, all of the following are equivalent:
4094both. So, all of the following are equivalent:
3848− % Author One
4097+% Author One
3849− Author Two
4098+ Author Two
3851− % Author One; Author Two
4102+% Author One; Author Two
3853− % Author One;
4106+% Author One;
3854− Author Two
4107+ Author Two
3856The date must fit on one line.
4110The date must fit on one line.
@@ -3925,10 +4179,12 @@ option is used. All of the metadata will appear in a single block
3925at the beginning of the document.
4179at the beginning of the document.
3927Note that [YAML] escaping rules must be followed. Thus, for example,
4181Note that [YAML] escaping rules must be followed. Thus, for example,
3928−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
3929−(`|`) can be used to begin an indented block that will be interpreted
4185+an indented block that will be interpreted literally, without need for
3930−literally, without need for escaping. This form is necessary
4186+escaping. This form is necessary when the field contains blank lines
3931−when the field contains blank lines or block-level formatting:
4187+or block-level formatting:
3934 title: 'This is the title: it contains a colon'
4190 title: 'This is the title: it contains a colon'
@@ -3942,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
3942 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
3945Template variables will be set automatically from the metadata. Thus, for
4207Template variables will be set automatically from the metadata. Thus, for
3946example, 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
3947equivalent of the Markdown in the `abstract` field:
4209equivalent of the Markdown in the `abstract` field:
@@ -3988,6 +4250,24 @@ will be interpreted as markdown. For example:
3988 \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
3991## Backslash escapes
4271## Backslash escapes
3993#### Extension: `all_symbols_escapable` ####
4273#### Extension: `all_symbols_escapable` ####
@@ -4014,9 +4294,12 @@ which allows only the following characters to be backslash-escaped:
4014(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
4015will be used.)
4295will be used.)
4017−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,
4018−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
4019−`\ `.
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
4021A 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
4022a 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
@@ -4142,7 +4425,8 @@ you need to enclose text in literal `$` characters, backslash-escape
4142them and they won't be treated as math delimiters.
4425them and they won't be treated as math delimiters.
4144For display math, use `$$` delimiters. (In this case, the delimiters
4427For display math, use `$$` delimiters. (In this case, the delimiters
4145−may be separated from the formula by whitespace.)
4428+may be separated from the formula by whitespace. However, there can be
4429+no blank lines betwen the opening and closing `$$` delimiters.)
4147TeX 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
4148depends on the output format:
4432depends on the output format:
@@ -4205,7 +4489,7 @@ HTML, Slidy, DZSlides, S5, EPUB
4205 command-line options selected. Therefore see [Math rendering in HTML]
4489 command-line options selected. Therefore see [Math rendering in HTML]
4208−[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
4210## Raw HTML
4494## Raw HTML
@@ -4245,7 +4529,7 @@ Thus, for example, pandoc will turn
4247 <td>*one*</td>
4531 <td>*one*</td>
4248− <td>[a link](http://google.com)</td>
4532+ <td>[a link](https://google.com)</td>
4250 </table>
4534 </table>
@@ -4254,14 +4538,14 @@ into
4256 <td><em>one</em></td>
4540 <td><em>one</em></td>
4257− <td><a href="http://google.com">a link</a></td>
4541+ <td><a href="https://google.com">a link</a></td>
4259 </table>
4543 </table>
4261whereas `Markdown.pl` will preserve it as is.
4545whereas `Markdown.pl` will preserve it as is.
4263−There is one exception to this rule: text between `<script>` and
4547+There is one exception to this rule: text between `<script>`,
4264−`<style>` tags is not interpreted as Markdown.
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
4266This departure from standard Markdown should make it easier to mix
4550This departure from standard Markdown should make it easier to mix
4267Markdown with HTML block elements. For example, one can surround
4551Markdown with HTML block elements. For example, one can surround
@@ -4389,7 +4673,7 @@ Markdown allows links to be specified in several ways.
4389If you enclose a URL or email address in pointy brackets, it
4673If you enclose a URL or email address in pointy brackets, it
4390will become a link:
4674will become a link:
4392− <http://google.com>
4676+ <https://google.com>
4393 <sam@green.eggs.ham>
4677 <sam@green.eggs.ham>
4395### Inline links ###
4679### Inline links ###
@@ -4399,7 +4683,7 @@ followed by the URL in parentheses. (Optionally, the URL can
4399be followed by a link title, in quotes.)
4683be followed by a link title, in quotes.)
4401 This is an [inline link](/url), and here's [one with
4685 This is an [inline link](/url), and here's [one with
4402− a title](http://fsf.org "click here for a good time!").
4686+ a title](https://fsf.org "click here for a good time!").
4404There 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.
4405The 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.
@@ -4428,7 +4712,7 @@ Here are some examples:
4429 [my label 1]: /foo/bar.html "My title, optional"
4713 [my label 1]: /foo/bar.html "My title, optional"
4430 [my label 2]: /foo
4714 [my label 2]: /foo
4431− [my label 3]: http://fsf.org (The free software foundation)
4715+ [my label 3]: https://fsf.org (The free software foundation)
4432 [my label 4]: /bar#special 'A title in single quotes'
4716 [my label 4]: /bar#special 'A title in single quotes'
4434The URL may optionally be surrounded by angle brackets:
4718The URL may optionally be surrounded by angle brackets:
@@ -4437,7 +4721,7 @@ The URL may optionally be surrounded by angle brackets:
4438The title may go on the next line:
4722The title may go on the next line:
4440− [my label 3]: http://fsf.org
4724+ [my label 3]: https://fsf.org
4441 "The free software foundation"
4725 "The free software foundation"
4443Note that link labels are not case sensitive. So, this will work:
4727Note that link labels are not case sensitive. So, this will work:
@@ -4550,10 +4834,12 @@ For example:
4550{ width=50% }
4834{ width=50% }
4553−- Dimensions are converted to inches for output in page-based formats like
4837+- Dimensions may be converted to a form that is compatible with
4554− LaTeX. Dimensions are converted to pixels for output in HTML-like
4838+ the output format (for example, dimensions given in pixels will
4555− formats. Use the `--dpi` option to specify the number of pixels per
4839+ be converted to inches when converting HTML to LaTeX). Conversion
4556− 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).
4557- The `%` unit is generally relative to some available space.
4843- The `%` unit is generally relative to some available space.
4558 For example the above example will render to the following.
4844 For example the above example will render to the following.
4559 - HTML: `<img href="file.jpg" style="width: 50%;" />`
4845 - HTML: `<img href="file.jpg" style="width: 50%;" />`
@@ -4562,7 +4848,7 @@ For example:
4562 as in the default template.)
4848 as in the default template.)
4563 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4849 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`
4564- Some output formats have a notion of a class
4850- Some output formats have a notion of a class
4565− ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4851+ ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4566 or a unique identifier (LaTeX `\caption`), or both (HTML).
4852 or a unique identifier (LaTeX `\caption`), or both (HTML).
4567- When no `width` or `height` attributes are specified, the fallback
4853- When no `width` or `height` attributes are specified, the fallback
4568 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
@@ -4670,142 +4956,72 @@ they cannot contain multiple paragraphs). The syntax is as follows:
4671Inline and regular footnotes may be mixed freely.
4957Inline and regular footnotes may be mixed freely.
4673−## Citations
4959+## Citation syntax
4675#### Extension: `citations` ####
4961#### Extension: `citations` ####
4677−Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
4963+To cite a bibliographic item with an identifier foo, use the
4678−citations and a bibliography in a number of styles. Basic usage is
4964+syntax `@foo`. Normal citations should be included in square
4965+brackets, with semicolons separating distinct items:
4680− pandoc --filter pandoc-citeproc myinput.txt
4967+ Blah blah [@doe99; @smith2000; @smith2004].
4682−In order to use this feature, you will need to specify a bibliography file
4969+How this is rendered depends on the citation style. In an
4683−using the `bibliography` metadata field in a YAML metadata section, or
4970+author-date style, it might render as
4684−`--bibliography` command line argument. You can supply multiple `--bibliography`
4685−arguments or set `bibliography` metadata field to YAML array, if you want to
4686−use multiple bibliography files. The bibliography may have any of these
4689− Format File extension
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
4690− ------------ --------------
4703−Note that `.bib` can be used with both BibTeX and BibLaTeX files;
4974+In a footnote style, it might render as
4704−use `.bibtex` to force BibTeX.
4706−Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
4976+ Blah blah.[^1]
4707−can produce `.json` and `.yaml` files from any of the supported formats.
4709−In-field markup: In BibTeX and BibLaTeX databases,
4978+ [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4710−pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML
4979+ Susan Smith, "Flies," *Journal of Insects* (2000);
4711−databases, pandoc Markdown; and in CSL JSON databases, an
4980+ Susan Smith, "Bees," *Journal of Insects* (2004).
4712−[HTML-like markup][CSL markup specs]:
4714−`<i>...</i>`
4982+See the [CSL user documentation] for more information about CSL
4715−: italics
4983+styles and how they affect rendering.
4717−`<b>...</b>`
4985+Unless a citation key start with a letter, digit, or `_`,
4718−: bold
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]`.
4720−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`
4995+Citation items may optionally include a prefix, a locator, and
4721−: small capitals
4996+a suffix. In
4723−`<sub>...</sub>`
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4726−`<sup>...</sup>`
5000+The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
4727−: superscript
5001+and suffix `and *passim*`. The second item (`smith04`) has
4728−
5002+locator `chap. 1` and no prefix or suffix.
4729−`<span class="nocase">...</span>`
4730−: prevent a phrase from being capitalized as title case
4732−`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
5004+Pandoc uses some heuristics to separate the locator from the
4733−and CSL YAML formats as far as possible.
5005+rest of the subject. It is sensitive to the locator terms
4734−
5006+defined in the [CSL locale files]. Either abbreviated or
4735−As an alternative to specifying a bibliography file using `--bibliography`
4736−or the YAML metadata field `bibliography`, you can include
4737−the citation data directly in the `references` field of the
4738−document's YAML metadata. The field should contain an array of
4739−YAML-encoded references, for example:
4743− - type: article-journal
4744− id: WatsonCrick1953
4755− title: 'Molecular structure of nucleic acids: a structure for deoxyribose
4757− title-short: Molecular structure of nucleic acids
4758− container-title: Nature
4762− DOI: 10.1038/171737a0
4763− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
4767−(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
4768−of the supported formats.)
4770−Citations and references can be formatted using any style supported by the
4771−[Citation Style Language], listed in the [Zotero Style Repository].
4772−These files are specified using the `--csl` option or the `csl` metadata field.
4773−By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
4774−format. The CSL project provides further information on [finding and editing styles].
4776−To make your citations hyperlinks to the corresponding bibliography
4777−entries, add `link-citations: true` to your YAML metadata.
4779−Citations go inside square brackets and are separated by semicolons.
4780−Each citation must have a key, composed of '@' + the citation
4781−identifier from the database, and may optionally have a prefix,
4782−a locator, and a suffix. The citation key must begin with a letter, digit,
4783−or `_`, and may contain alphanumerics, `_`, and internal punctuation
4784−characters (`:.#$%&-+?<>~/`). Here are some examples:
4786− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4788− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4790− Blah blah [@smith04; @doe99].
4792−`pandoc-citeproc` detects locator terms in the [CSL locale files].
4793−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
5007+unabbreviated forms are accepted. In the `en-US` locale, locator
4794−locale, locator terms can be written in either singular or plural forms,
5008+terms can be written in either singular or plural forms, as
4795−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5009+`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4796−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
5010+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
4797−`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.`;
4798−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
5013+`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
4799−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
5014+`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
4800−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
5015+`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4801locator term is used, "page" is assumed.
5016locator term is used, "page" is assumed.
4803−`pandoc-citeproc` will use heuristics to distinguish the locator
5018+In complex cases, you can force something to be treated as
4804−from the suffix. In complex cases, the locator can be enclosed
5019+a locator by enclosing it in curly braces or prevent parsing
4805−in curly braces (using `pandoc-citeproc` 0.15 and higher only):
5020+the suffix as locator by prepending curly braces:
4807 [@smith{ii, A, D-Z}, with a suffix]
5022 [@smith{ii, A, D-Z}, with a suffix]
4808 [@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]
4810A minus sign (`-`) before the `@` will suppress mention of
5026A minus sign (`-`) before the `@` will suppress mention of
4811the author in the citation. This can be useful when the
5027the author in the citation. This can be useful when the
@@ -4813,82 +5029,103 @@ author is already mentioned in the text:
4814 Smith says blah [-@smith04].
5030 Smith says blah [-@smith04].
4816−You can also write an in-text citation, as follows:
5032+You can also write an author-in-text citation, by omitting the
4818 @smith04 says blah.
5035 @smith04 says blah.
4820 @smith04 [p. 33] says blah.
5037 @smith04 [p. 33] says blah.
4822−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
4823−in a div with id `refs`, if one exists:
5040+the bibliographical details. Use this form when you want to
4824−
5041+make the citation the subject of a sentence.
4826− :::
5043+When you are using a note style, it is usually better to let
4827−
5044+citeproc create the footnotes from citations rather than writing
4828−Otherwise, it will be placed at the end of the document.
5045+an explicit note. If you do write an explicit note that
4829−Generation of the bibliography can be suppressed by setting
5046+contains a citation, note that normal citations will be put in
4830−`suppress-bibliography: true` in the YAML metadata.
5047+parentheses, while author-in-text citations will not. For
4831−
5048+this reason, it is sometimes preferable to use the
4832−If you wish the bibliography to have a section heading, you can
5049+author-in-text style inside notes when using a note style.
4833−set `reference-section-title` in the metadata, or put the heading
5050+
4834−at the beginning of the div with id `refs` (if you are using it)
5051+[CSL user documentation]: https://citationstyles.org/authors/
4835−or at the end of your document:
5052+[CSL]: https://docs.citationstyles.org/en/stable/specification.html
4841−The bibliography will be inserted after this heading. Note that
4842−the `unnumbered` class will be added to this heading, so that the
4843−section will not be numbered.
4845−If you want to include items in the bibliography without actually
4846−citing them in the body text, you can define a dummy `nocite` metadata
4847−field and put the citations there:
4856−In this example, the document will contain a citation for `item3`
4857−only, but the bibliography will contain entries for `item1`, `item2`, and
4860−It is possible to create a bibliography with all the citations,
4861−whether or not they appear in the document, by using a wildcard:
4868−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
4869−render the bibliography. In order to do so, specify bibliography
4870−files as outlined above, and add `--natbib` or `--biblatex`
4871−argument to `pandoc` invocation. Bear in mind that bibliography
4872−files have to be in respective format (either BibTeX or
4875−For more information, see the [pandoc-citeproc man page].
4877−[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
4878−[Chicago Manual of Style]: http://chicagomanualofstyle.org
5054+[Chicago Manual of Style]: https://chicagomanualofstyle.org
4879−[Citation Style Language]: http://citationstyles.org
5055+[Citation Style Language]: https://citationstyles.org
4880[Zotero Style Repository]: https://www.zotero.org/styles
5056[Zotero Style Repository]: https://www.zotero.org/styles
4881[finding and editing styles]: https://citationstyles.org/authors/
5057[finding and editing styles]: https://citationstyles.org/authors/
4882[CSL locale files]: https://github.com/citation-style-language/locales
5058[CSL locale files]: https://github.com/citation-style-language/locales
4883−[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
4885−## Non-pandoc extensions
5060+## Non-default extensions
4887The following Markdown syntax extensions are not enabled by default
5062The following Markdown syntax extensions are not enabled by default
4888in pandoc, but may be enabled by adding `+EXTENSION` to the format
5063in pandoc, but may be enabled by adding `+EXTENSION` to the format
4889name, where `EXTENSION` is the name of the extension. Thus, for
5064name, where `EXTENSION` is the name of the extension. Thus, for
4890example, `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.
4892#### Extension: `old_dashes` ####
5129#### Extension: `old_dashes` ####
4894Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5131Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -5001,7 +5238,7 @@ and image references. This extension should not be confused with the
5002 This is a reference ![image][ref] with multimarkdown attributes.
5239 This is a reference ![image][ref] with multimarkdown attributes.
5004− [ref]: http://path.to/image "Image title" width=20px height=30px
5241+ [ref]: https://path.to/image "Image title" width=20px height=30px
5005 id=myId class="myClass1 myClass2"
5242 id=myId class="myClass1 myClass2"
5007#### Extension: `mmd_header_identifiers` ####
5244#### Extension: `mmd_header_identifiers` ####
@@ -5044,58 +5281,382 @@ for regular emphasis, add extra blank space around headings.
5045 [Project Gutenberg]: https://www.gutenberg.org
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.
5047## Markdown variants
5291## Markdown variants
5049In addition to pandoc's extended Markdown, the following Markdown
5293In addition to pandoc's extended Markdown, the following Markdown
5050variants are supported:
5294variants are supported:
5052−`markdown_phpextra` (PHP Markdown Extra)
5296+- `markdown_phpextra` (PHP Markdown Extra)
5053−: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
5054− `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
5055− `header_attributes`, `link_attributes`, `abbreviations`,
5056− `shortcut_reference_links`, `spaced_reference_links`.
5058−`markdown_github` (deprecated GitHub-Flavored Markdown)
5297+- `markdown_github` (deprecated GitHub-Flavored Markdown)
5059−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5060− `gfm_auto_identifiers`, `backtick_code_blocks`,
5061− `autolink_bare_uris`, `space_in_atx_header`,
5062− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5063− `shortcut_reference_links`, `angle_brackets_escapable`,
5064− `lists_without_preceding_blankline`.
5066−`markdown_mmd` (MultiMarkdown)
5298+- `markdown_mmd` (MultiMarkdown)
5067−: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5068− `tex_math_double_backslash`, `intraword_underscores`,
5069− `mmd_title_block`, `footnotes`, `definition_lists`,
5070− `all_symbols_escapable`, `implicit_header_references`,
5071− `auto_identifiers`, `mmd_header_identifiers`,
5072− `shortcut_reference_links`, `implicit_figures`,
5073− `superscript`, `subscript`, `backtick_code_blocks`,
5074− `spaced_reference_links`, `raw_attribute`.
5076−`markdown_strict` (Markdown.pl)
5299+- `markdown_strict` (Markdown.pl)
5077−: `raw_html`, `shortcut_reference_links`,
5300+- `commonmark` (CommonMark)
5078− `spaced_reference_links`.
5301+- `gfm` (Github-Flavored Markdown)
5079−
5302+- `commonmark_x` (CommonMark with many pandoc extensions)
5080−We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,
5303+
5081−which is implemented as a set of extensions on `commonmark`).
5304+To see which extensions are supported for a given format,
5082−
5305+and which are enabled by default, you can use the command
5083−Note, however, that `commonmark` and `gfm` have limited support
5306+
5084−for extensions. Only those listed below (and `smart`,
5307+ pandoc --list-extensions=FORMAT
5085−`raw_tex`, and `hard_line_breaks`) will work. The extensions
5308+
5086−can, however, all be individually disabled. Also, `raw_tex`
5309+where `FORMAT` is replaced with the name of the format.
5087−only affects `gfm` output, not input.
5310+
5088−
5311+Note that the list of extensions for `commonmark`,
5089−`gfm` (GitHub-Flavored Markdown)
5312+`gfm`, and `commonmark_x` are defined relative to default
5090−: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5313+commonmark. So, for example, `backtick_code_blocks`
5091− `gfm_auto_identifiers`, `backtick_code_blocks`,
5314+does not appear as an extension, since it is enabled by
5092− `autolink_bare_uris`, `space_in_atx_header`,
5315+default and cannot be disabled.
5093− `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,
5316+
5094− `shortcut_reference_links`, `angle_brackets_escapable`,
5317+# Citations
5095− `lists_without_preceding_blankline`.
5318+
5096−
5319+When the `--citeproc` option is used, pandoc can automatically generate
5097−
5320+citations and a bibliography in a number of styles. Basic usage is
5098−# Producing slide shows with pandoc
5321+
5322+ pandoc --citeproc myinput.txt
5324+To use this feature, you will need to have
5326+- a document containing citations (see [Extension: `citations`]);
5327+- a source of bibliographic data: either an external bibliography
5328+ file or a list of `references` in the document's YAML metadata
5329+- optionally, a [CSL] citation style.
5331+## Specifying bibliographic data
5333+You can specify an external bibliography using the
5334+`bibliography` metadata field in a YAML metadata section or the
5335+`--bibliography` command line argument. If you want to use
5336+multiple bibliography files, you can supply multiple
5337+`--bibliography` arguments or set `bibliography` metadata field
5338+to YAML array. A bibliography may have any of these formats:
5340+ Format File extension
5341+ ------------ --------------
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
5100You can use pandoc to produce an HTML + JavaScript slide presentation
5661You can use pandoc to produce an HTML + JavaScript slide presentation
5101that 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,
@@ -5143,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
5144where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5146−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
5147−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5148−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5710+the relative path `s5/default` (for S5), `slideous` (for
5149−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5150−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5151−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5714+variables; see [Variables for HTML slides], above.) For
5152−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5153−the file by default.
5716+in the file by default.
5155−With all HTML slide formats, the `--self-contained` option can be used to
5718+With all HTML slide formats, the `--self-contained` option can
5156−produce a single file that contains all of the data necessary to display the
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5157−slide show, including linked scripts, stylesheets, images, and videos.
5721+stylesheets, images, and videos.
5159To produce a PDF slide show using beamer, type
5723To produce a PDF slide show using beamer, type
@@ -5184,7 +5748,11 @@ rules:
5184 * A heading at the slide level always starts a new slide.
5748 * A heading at the slide level always starts a new slide.
5186 * Headings *below* the slide level in the hierarchy create
5750 * Headings *below* the slide level in the hierarchy create
5187− 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.)
5189 * Headings *above* the slide level in the hierarchy create
5757 * Headings *above* the slide level in the hierarchy create
5190 "title slides," which just contain the section title
5758 "title slides," which just contain the section title
@@ -5335,6 +5903,41 @@ containers with class `column` and a `width` attribute:
5336 ::::::::::::::
5904 ::::::::::::::
5906+### Additional columns attributes in beamer
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.
5338## Frame attributes in beamer
5941## Frame attributes in beamer
5340Sometimes it is necessary to add the LaTeX `[fragile]` option to
5943Sometimes it is necessary to add the LaTeX `[fragile]` option to
@@ -5379,9 +5982,8 @@ To add a background image to the automatically generated title slide, use the
5379`title-slide-attributes` variable in the YAML metadata block. It must contain
5982`title-slide-attributes` variable in the YAML metadata block. It must contain
5380a map of attribute names and values.
5983a map of attribute names and values.
5383−documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)
5985+See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5384−for more details.
5986+details.
5386For example in reveal.js:
5988For example in reveal.js:
@@ -5403,7 +6005,7 @@ Slide 1 has background_image.png as its background.
5403Slide 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.
5406−# Creating EPUBs with pandoc
6008+# EPUBs
5408## EPUB Metadata
6010## EPUB Metadata
@@ -5483,6 +6085,15 @@ The following fields are recognized:
5485 ~ 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.
5487`cover-image`
6098`cover-image`
5488 ~ A string value (path to cover image).
6099 ~ A string value (path to cover image).
@@ -5504,7 +6115,7 @@ The following fields are recognized:
5504 - `binding`: `true`|`false` (default `true`)
6115 - `binding`: `true`|`false` (default `true`)
5505 - `scroll-axis`: `vertical`|`horizontal`|`default`
6116 - `scroll-axis`: `vertical`|`horizontal`|`default`
5507−[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6118+[MARC relators]: https://loc.gov/marc/relators/relaterm.html
5508[`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
5510## The `epub:type` attribute
6121## The `epub:type` attribute
@@ -5544,8 +6155,6 @@ halftitlepage frontmatter
5544seriespage frontmatter
6155seriespage frontmatter
5545foreword frontmatter
6156foreword frontmatter
5546preface frontmatter
6157preface frontmatter
5547−seriespage frontmatter
5548−titlepage frontmatter
5549appendix backmatter
6158appendix backmatter
5550colophon backmatter
6159colophon backmatter
5551bibliography backmatter
6160bibliography backmatter
@@ -5563,12 +6172,12 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag
5563with the `src` attribute. For example:
6172with the `src` attribute. For example:
5565 <audio controls="1">
6174 <audio controls="1">
5566− <source src="http://example.com/music/toccata.mp3"
6175+ <source src="https://example.com/music/toccata.mp3"
5567 data-external="1" type="audio/mpeg">
6176 data-external="1" type="audio/mpeg">
5568 </source>
6177 </source>
5569 </audio>
6178 </audio>
5571−# Creating Jupyter notebooks with pandoc
6180+# Jupyter notebooks
5573When creating a [Jupyter notebook], pandoc will try to infer the
6182When creating a [Jupyter notebook], pandoc will try to infer the
5574notebook structure. Code blocks with the class `code` will be
6183notebook structure. Code blocks with the class `code` will be
@@ -5721,7 +6330,7 @@ Then edit `my.theme` and use it like this:
5721If you are not satisfied with the built-in highlighting, or you
6330If you are not satisfied with the built-in highlighting, or you
5722want highlight a language that isn't supported, you can use the
6331want highlight a language that isn't supported, you can use the
5723`--syntax-definition` option to load a [KDE-style XML syntax definition
6332`--syntax-definition` option to load a [KDE-style XML syntax definition
5724−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
5725Before 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
5726definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
6335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
@@ -5778,7 +6387,7 @@ custom-style `span`.
5778For docx output, you don't need to enable any extensions for
6387For docx output, you don't need to enable any extensions for
5779custom styles to work.
6388custom styles to work.
5781−[pandoc filters]: http://pandoc.org/filters.html
6390+[pandoc filters]: https://pandoc.org/filters.html
@@ -5829,15 +6438,15 @@ same styles in your input and output files.
5830# Custom writers
6439# Custom writers
5832−Pandoc can be extended with custom writers written in [lua]. (Pandoc
6441+Pandoc can be extended with custom writers written in [Lua]. (Pandoc
5833−includes a lua interpreter, so lua need not be installed separately.)
6442+includes a Lua interpreter, so Lua need not be installed separately.)
5835−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
5836in place of the output format. For example:
6445in place of the output format. For example:
5838 pandoc -t data/sample.lua
6447 pandoc -t data/sample.lua
5840−Creating a custom writer requires writing a lua function for each
6449+Creating a custom writer requires writing a Lua function for each
5841possible element in a pandoc document. To get a documented example
6450possible element in a pandoc document. To get a documented example
5842which you can modify according to your needs, do
6451which you can modify according to your needs, do
@@ -5850,7 +6459,22 @@ default template with the name
5850`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
6459`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`
5851subdirectory of your user data directory (see [Templates]).
6460subdirectory of your user data directory (see [Templates]).
5853−[lua]: http://www.lua.org
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).
5855# A note on security
6479# A note on security
@@ -5867,7 +6491,7 @@ application, here are some things to keep in mind:
5867 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
5868 that fully isolates pandoc from your file system, by running the
6492 that fully isolates pandoc from your file system, by running the
5869 pandoc operations in the `PandocPure` monad. See the document
6493 pandoc operations in the `PandocPure` monad. See the document
5870− [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)
5871 for more details.
6495 for more details.
58733. Pandoc's parsers can exhibit pathological performance on some
64973. Pandoc's parsers can exhibit pathological performance on some
@@ -5880,17 +6504,17 @@ application, here are some things to keep in mind:
58804. The HTML generated by pandoc is not guaranteed to be safe.
65044. The HTML generated by pandoc is not guaranteed to be safe.
5881 If `raw_html` is enabled for the Markdown input, users can
6505 If `raw_html` is enabled for the Markdown input, users can
5882 inject arbitrary HTML. Even if `raw_html` is disabled,
6506 inject arbitrary HTML. Even if `raw_html` is disabled,
5883− users can include dangerous content in attributes for
6507+ users can include dangerous content in URLs and attributes.
5884− headings, spans, and code blocks. To be safe, you should
5885− run all the generated HTML through an HTML sanitizer.
6508+ To be safe, you should run all the generated HTML through
5887# Authors
6511# Authors
5889−Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
5890under the [GPL], version 2 or greater. This software carries no
6514under the [GPL], version 2 or greater. This software carries no
5891warranty of any kind. (See COPYRIGHT for full copyright and
6515warranty of any kind. (See COPYRIGHT for full copyright and
5892warranty notices.) For a full list of contributors, see the file
6516warranty notices.) For a full list of contributors, see the file
5893AUTHORS.md in the pandoc source code.
6517AUTHORS.md in the pandoc source code.
5895−[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"
5896[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"
6520[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"