@@ -1,13 +1,13 @@
2−.\" Automatically generated by Pandoc 2.9.1
2+.\" Automatically generated by Pandoc 2.14.0.1
4−.TH "Pandoc User\[aq]s Guide" "" "January 5, 2020" "pandoc 2.9.1.1" ""
4+.TH "Pandoc User\[cq]s Guide" "" "June 20, 2021" "pandoc 2.14.0.3" ""
7pandoc - general markup converter
7pandoc - general markup converter
8.SH SYNOPSIS
8.SH SYNOPSIS
10−\f[C]pandoc\f[R] [\f[I]options\f[R]] [\f[I]input-file\f[R]]...
10+\f[C]pandoc\f[R] [\f[I]options\f[R]] [\f[I]input-file\f[R]]\&...
11.SH DESCRIPTION
11.SH DESCRIPTION
13Pandoc is a Haskell library for converting from one markup format to
13Pandoc is a Haskell library for converting from one markup format to
@@ -20,10 +20,10 @@ For the full lists of input and output formats, see the \f[C]--from\f[R]
20and \f[C]--to\f[R] options below.
20and \f[C]--to\f[R] options below.
21Pandoc can also produce PDF output: see creating a PDF, below.
21Pandoc can also produce PDF output: see creating a PDF, below.
23−Pandoc\[aq]s enhanced version of Markdown includes syntax for tables,
23+Pandoc\[cq]s enhanced version of Markdown includes syntax for tables,
24definition lists, metadata blocks, footnotes, citations, math, and much
24definition lists, metadata blocks, footnotes, citations, math, and much
26−See below under Pandoc\[aq]s Markdown.
26+See below under Pandoc\[cq]s Markdown.
28Pandoc has a modular design: it consists of a set of readers, which
28Pandoc has a modular design: it consists of a set of readers, which
29parse text in a given format and produce a native representation of the
29parse text in a given format and produce a native representation of the
@@ -33,15 +33,15 @@ Thus, adding an input or output format requires only adding a reader or
34Users can also run custom pandoc filters to modify the intermediate AST.
34Users can also run custom pandoc filters to modify the intermediate AST.
36−Because pandoc\[aq]s intermediate representation of a document is less
36+Because pandoc\[cq]s intermediate representation of a document is less
37expressive than many of the formats it converts between, one should not
37expressive than many of the formats it converts between, one should not
38expect perfect conversions between every format and every other.
38expect perfect conversions between every format and every other.
39Pandoc attempts to preserve the structural elements of a document, but
39Pandoc attempts to preserve the structural elements of a document, but
40not formatting details such as margin size.
40not formatting details such as margin size.
41And some document elements, such as complex tables, may not fit into
41And some document elements, such as complex tables, may not fit into
42−pandoc\[aq]s simple document model.
42+pandoc\[cq]s simple document model.
43−While conversions from pandoc\[aq]s Markdown to all formats aspire to be
43+While conversions from pandoc\[cq]s Markdown to all formats aspire to be
44−perfect, conversions from formats more expressive than pandoc\[aq]s
44+perfect, conversions from formats more expressive than pandoc\[cq]s
45Markdown can be expected to be lossy.
45Markdown can be expected to be lossy.
46.SS Using pandoc
46.SS Using pandoc
@@ -57,9 +57,9 @@ pandoc -o output.html input.txt
59By default, pandoc produces a document fragment.
59By default, pandoc produces a document fragment.
60−To produce a standalone document (e.g.
60+To produce a standalone document (e.g.\ a valid HTML file including
61−a valid HTML file including \f[C]<head>\f[R] and \f[C]<body>\f[R]), use
61+\f[C]<head>\f[R] and \f[C]<body>\f[R]), use the \f[C]-s\f[R] or
62−the \f[C]-s\f[R] or \f[C]--standalone\f[R] flag:
62+\f[C]--standalone\f[R] flag:
@@ -115,10 +115,10 @@ pandoc -o hello.tex hello.txt
116will convert \f[C]hello.txt\f[R] from Markdown to LaTeX.
116will convert \f[C]hello.txt\f[R] from Markdown to LaTeX.
117If no output file is specified (so that output goes to
117If no output file is specified (so that output goes to
118−\f[I]stdout\f[R]), or if the output file\[aq]s extension is unknown, the
118+\f[I]stdout\f[R]), or if the output file\[cq]s extension is unknown, the
119output format will default to HTML.
119output format will default to HTML.
120If no input file is specified (so that input comes from
120If no input file is specified (so that input comes from
121−\f[I]stdin\f[R]), or if the input files\[aq] extensions are unknown, the
121+\f[I]stdin\f[R]), or if the input files\[cq] extensions are unknown, the
122input format will be assumed to be Markdown.
122input format will be assumed to be Markdown.
123.SS Character encoding
123.SS Character encoding
@@ -172,15 +172,15 @@ You can then test it with \f[C]pdflatex test.tex\f[R].
172When using LaTeX, the following packages need to be available (they are
172When using LaTeX, the following packages need to be available (they are
173included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
173included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
174\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
174\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
175−\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the
175+\f[C]iftex\f[R], \f[C]listings\f[R] (if the \f[C]--listings\f[R] option
176−\f[C]--listings\f[R] option is used), \f[C]fancyvrb\f[R],
177−\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] (if the
176+is used), \f[C]fancyvrb\f[R], \f[C]longtable\f[R], \f[C]booktabs\f[R],
178−document contains images), \f[C]hyperref\f[R], \f[C]xcolor\f[R],
177+\f[C]graphicx\f[R] (if the document contains images),
178+\f[C]hyperref\f[R], \f[C]xcolor\f[R], \f[C]ulem\f[R], \f[C]geometry\f[R]
179−\f[C]ulem\f[R], \f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable
179+(with the \f[C]geometry\f[R] variable set), \f[C]setspace\f[R] (with
180−set), \f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and
181−\f[C]babel\f[R] (with \f[C]lang\f[R]).
180+\f[C]linestretch\f[R]), and \f[C]babel\f[R] (with \f[C]lang\f[R]).
182The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
181The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
183requires \f[C]fontspec\f[R].
182requires \f[C]fontspec\f[R].
183+\f[C]lualatex\f[R] uses \f[C]selnolig\f[R].
184\f[C]xelatex\f[R] uses \f[C]polyglossia\f[R] (with \f[C]lang\f[R]),
184\f[C]xelatex\f[R] uses \f[C]polyglossia\f[R] (with \f[C]lang\f[R]),
185\f[C]xecjk\f[R], and \f[C]bidi\f[R] (with the \f[C]dir\f[R] variable
185\f[C]xecjk\f[R], and \f[C]bidi\f[R] (with the \f[C]dir\f[R] variable
@@ -206,7 +206,7 @@ In this case pandoc will fetch the content using HTTP:
209−pandoc -f html -t markdown http://www.fsf.org
209+pandoc -f html -t markdown https://www.fsf.org
@@ -216,7 +216,7 @@ requesting a document from a URL:
218pandoc -f html -t markdown --request-header User-Agent:\[dq]Mozilla/5.0\[dq] \[rs]
218pandoc -f html -t markdown --request-header User-Agent:\[dq]Mozilla/5.0\[dq] \[rs]
219− http://www.fsf.org
219+ https://www.fsf.org
222.SH OPTIONS
222.SH OPTIONS
@@ -227,10 +227,20 @@ Specify input format.
227\f[I]FORMAT\f[R] can be:
227\f[I]FORMAT\f[R] can be:
229.IP \[bu] 2
229.IP \[bu] 2
230+\f[C]bibtex\f[R] (BibTeX bibliography)
232+\f[C]biblatex\f[R] (BibLaTeX bibliography)
230\f[C]commonmark\f[R] (CommonMark Markdown)
234\f[C]commonmark\f[R] (CommonMark Markdown)
231.IP \[bu] 2
235.IP \[bu] 2
236+\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
232\f[C]creole\f[R] (Creole 1.0)
238\f[C]creole\f[R] (Creole 1.0)
233.IP \[bu] 2
239.IP \[bu] 2
240+\f[C]csljson\f[R] (CSL JSON bibliography)
242+\f[C]csv\f[R] (CSV table)
234\f[C]docbook\f[R] (DocBook)
244\f[C]docbook\f[R] (DocBook)
235.IP \[bu] 2
245.IP \[bu] 2
236\f[C]docx\f[R] (Word docx)
246\f[C]docx\f[R] (Word docx)
@@ -253,13 +263,13 @@ if you need extensions not supported in \f[C]gfm\f[R].
253.IP \[bu] 2
263.IP \[bu] 2
254\f[C]jats\f[R] (JATS XML)
264\f[C]jats\f[R] (JATS XML)
255.IP \[bu] 2
265.IP \[bu] 2
256−\f[C]jira\f[R] (Jira wiki markup)
266+\f[C]jira\f[R] (Jira/Confluence wiki markup)
257.IP \[bu] 2
267.IP \[bu] 2
258\f[C]json\f[R] (JSON version of native AST)
268\f[C]json\f[R] (JSON version of native AST)
259.IP \[bu] 2
269.IP \[bu] 2
260\f[C]latex\f[R] (LaTeX)
270\f[C]latex\f[R] (LaTeX)
261.IP \[bu] 2
271.IP \[bu] 2
262−\f[C]markdown\f[R] (Pandoc\[aq]s Markdown)
272+\f[C]markdown\f[R] (Pandoc\[cq]s Markdown)
263.IP \[bu] 2
273.IP \[bu] 2
264\f[C]markdown_mmd\f[R] (MultiMarkdown)
274\f[C]markdown_mmd\f[R] (MultiMarkdown)
265.IP \[bu] 2
275.IP \[bu] 2
@@ -309,10 +319,18 @@ Specify output format.
309.IP \[bu] 2
319.IP \[bu] 2
310\f[C]beamer\f[R] (LaTeX beamer slide show)
320\f[C]beamer\f[R] (LaTeX beamer slide show)
311.IP \[bu] 2
321.IP \[bu] 2
322+\f[C]bibtex\f[R] (BibTeX bibliography)
324+\f[C]biblatex\f[R] (BibLaTeX bibliography)
312\f[C]commonmark\f[R] (CommonMark Markdown)
326\f[C]commonmark\f[R] (CommonMark Markdown)
313.IP \[bu] 2
327.IP \[bu] 2
328+\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
314\f[C]context\f[R] (ConTeXt)
330\f[C]context\f[R] (ConTeXt)
315.IP \[bu] 2
331.IP \[bu] 2
332+\f[C]csljson\f[R] (CSL JSON bibliography)
316\f[C]docbook\f[R] or \f[C]docbook4\f[R] (DocBook 4)
334\f[C]docbook\f[R] or \f[C]docbook4\f[R] (DocBook 4)
317.IP \[bu] 2
335.IP \[bu] 2
318\f[C]docbook5\f[R] (DocBook 5)
336\f[C]docbook5\f[R] (DocBook 5)
@@ -333,8 +351,8 @@ if you need extensions not supported in \f[C]gfm\f[R].
333.IP \[bu] 2
351.IP \[bu] 2
334\f[C]haddock\f[R] (Haddock markup)
352\f[C]haddock\f[R] (Haddock markup)
335.IP \[bu] 2
353.IP \[bu] 2
336−\f[C]html\f[R] or \f[C]html5\f[R] (HTML, i.e.
354+\f[C]html\f[R] or \f[C]html5\f[R] (HTML, i.e.\ HTML5/XHTML polyglot
337−HTML5/XHTML polyglot markup)
355+markup)
338.IP \[bu] 2
356.IP \[bu] 2
339\f[C]html4\f[R] (XHTML 1.0 Transitional)
357\f[C]html4\f[R] (XHTML 1.0 Transitional)
340.IP \[bu] 2
358.IP \[bu] 2
@@ -342,9 +360,15 @@ HTML5/XHTML polyglot markup)
342.IP \[bu] 2
360.IP \[bu] 2
343\f[C]ipynb\f[R] (Jupyter notebook)
361\f[C]ipynb\f[R] (Jupyter notebook)
344.IP \[bu] 2
362.IP \[bu] 2
345−\f[C]jats\f[R] (JATS XML)
363+\f[C]jats_archiving\f[R] (JATS XML, Archiving and Interchange Tag Set)
365+\f[C]jats_articleauthoring\f[R] (JATS XML, Article Authoring Tag Set)
367+\f[C]jats_publishing\f[R] (JATS XML, Journal Publishing Tag Set)
346.IP \[bu] 2
368.IP \[bu] 2
369+\f[C]jats\f[R] (alias for \f[C]jats_archiving\f[R])
347−\f[C]jira\f[R] (Jira wiki markup)
371+\f[C]jira\f[R] (Jira/Confluence wiki markup)
348.IP \[bu] 2
372.IP \[bu] 2
349\f[C]json\f[R] (JSON version of native AST)
373\f[C]json\f[R] (JSON version of native AST)
350.IP \[bu] 2
374.IP \[bu] 2
@@ -352,7 +376,7 @@ HTML5/XHTML polyglot markup)
352.IP \[bu] 2
376.IP \[bu] 2
353\f[C]man\f[R] (roff man)
377\f[C]man\f[R] (roff man)
354.IP \[bu] 2
378.IP \[bu] 2
355−\f[C]markdown\f[R] (Pandoc\[aq]s Markdown)
379+\f[C]markdown\f[R] (Pandoc\[cq]s Markdown)
356.IP \[bu] 2
380.IP \[bu] 2
357\f[C]markdown_mmd\f[R] (MultiMarkdown)
381\f[C]markdown_mmd\f[R] (MultiMarkdown)
358.IP \[bu] 2
382.IP \[bu] 2
@@ -406,7 +430,7 @@ HTML5/XHTML polyglot markup)
406.IP \[bu] 2
430.IP \[bu] 2
407\f[C]zimwiki\f[R] (ZimWiki markup)
431\f[C]zimwiki\f[R] (ZimWiki markup)
408.IP \[bu] 2
432.IP \[bu] 2
409−the path of a custom lua writer, see Custom writers below
433+the path of a custom Lua writer, see Custom writers below
411Note that \f[C]odt\f[R], \f[C]docx\f[R], \f[C]epub\f[R], and
435Note that \f[C]odt\f[R], \f[C]docx\f[R], \f[C]epub\f[R], and
412\f[C]pdf\f[R] output will not be directed to \f[I]stdout\f[R] unless
436\f[C]pdf\f[R] output will not be directed to \f[I]stdout\f[R] unless
@@ -433,16 +457,15 @@ On *nix and macOS systems this will be the \f[C]pandoc\f[R] subdirectory
433of the XDG data directory (by default, \f[C]$HOME/.local/share\f[R],
457of the XDG data directory (by default, \f[C]$HOME/.local/share\f[R],
434overridable by setting the \f[C]XDG_DATA_HOME\f[R] environment
458overridable by setting the \f[C]XDG_DATA_HOME\f[R] environment
435variable).
459variable).
436−If that directory does not exist, \f[C]$HOME/.pandoc\f[R] will be used
460+If that directory does not exist and \f[C]$HOME/.pandoc\f[R] exists, it
437−(for backwards compatibility).
461+will be used (for backwards compatibility).
438−In Windows the default user data directory is
462+On Windows the default user data directory is
439\f[C]C:\[rs]Users\[rs]USERNAME\[rs]AppData\[rs]Roaming\[rs]pandoc\f[R].
463\f[C]C:\[rs]Users\[rs]USERNAME\[rs]AppData\[rs]Roaming\[rs]pandoc\f[R].
440You can find the default user data directory on your system by looking
464You can find the default user data directory on your system by looking
441at the output of \f[C]pandoc --version\f[R].
465at the output of \f[C]pandoc --version\f[R].
466+Data files placed in this directory (for example,
442−A \f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R],
467+\f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R],
443−\f[C]templates\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], or
444−\f[C]s5\f[R] directory placed in this directory will override
445−pandoc\[aq]s normal defaults.
468+\f[C]templates\f[R]) will override pandoc\[cq]s normal defaults.
447\f[B]\f[CB]-d\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--defaults=\f[B]\f[R]\f[I]FILE\f[R]
470\f[B]\f[CB]-d\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--defaults=\f[B]\f[R]\f[I]FILE\f[R]
448Specify a set of default option settings.
471Specify a set of default option settings.
@@ -473,7 +496,6 @@ eval \[dq]$(pandoc --bash-completion)\[dq]
474\f[B]\f[CB]--verbose\f[B]\f[R]
497\f[B]\f[CB]--verbose\f[B]\f[R]
475Give verbose debugging output.
498Give verbose debugging output.
476−Currently this only has an effect with PDF output.
478\f[B]\f[CB]--quiet\f[B]\f[R]
500\f[B]\f[CB]--quiet\f[B]\f[R]
479Suppress warning messages.
501Suppress warning messages.
@@ -496,7 +518,7 @@ List supported output formats, one per line.
496List supported extensions for \f[I]FORMAT\f[R], one per line, preceded
518List supported extensions for \f[I]FORMAT\f[R], one per line, preceded
497by a \f[C]+\f[R] or \f[C]-\f[R] indicating whether it is enabled by
519by a \f[C]+\f[R] or \f[C]-\f[R] indicating whether it is enabled by
498default in \f[I]FORMAT\f[R].
520default in \f[I]FORMAT\f[R].
499−If \f[I]FORMAT\f[R] is not specified, defaults for pandoc\[aq]s Markdown
521+If \f[I]FORMAT\f[R] is not specified, defaults for pandoc\[cq]s Markdown
500are given.
522are given.
502\f[B]\f[CB]--list-highlight-languages\f[B]\f[R]
524\f[B]\f[CB]--list-highlight-languages\f[B]\f[R]
@@ -541,7 +563,7 @@ This option is useful for converting word processing documents where
541users have used empty paragraphs to create inter-paragraph space.
563users have used empty paragraphs to create inter-paragraph space.
543\f[B]\f[CB]--indented-code-classes=\f[B]\f[R]\f[I]CLASSES\f[R]
565\f[B]\f[CB]--indented-code-classes=\f[B]\f[R]\f[I]CLASSES\f[R]
544−Specify classes to use for indented code blocks--for example,
566+Specify classes to use for indented code blocks\[en]for example,
545\f[C]perl,numberLines\f[R] or \f[C]haskell\f[R].
567\f[C]perl,numberLines\f[R] or \f[C]haskell\f[R].
546Multiple classes may be separated by spaces or commas.
568Multiple classes may be separated by spaces or commas.
@@ -563,7 +585,7 @@ Reading binary files (docx, odt, epub) implies \f[C]--file-scope\f[R].
563Specify an executable to be used as a filter transforming the pandoc AST
585Specify an executable to be used as a filter transforming the pandoc AST
564after the input is parsed and before the output is written.
586after the input is parsed and before the output is written.
565The executable should read JSON from stdin and write JSON to stdout.
587The executable should read JSON from stdin and write JSON to stdout.
566−The JSON must be formatted like pandoc\[aq]s own JSON input and output.
588+The JSON must be formatted like pandoc\[cq]s own JSON input and output.
567The name of the output format will be passed to the filter as the first
589The name of the output format will be passed to the filter as the first
@@ -603,47 +625,35 @@ above).
603.IP "3." 3
625.IP "3." 3
604\f[C]$PATH\f[R] (executable only)
626\f[C]$PATH\f[R] (executable only)
606−Filters and lua-filters are applied in the order specified on the
628+Filters, Lua-filters, and citeproc processing are applied in the order
607−command line.
629+specified on the command line.
610\f[B]\f[CB]-L\f[B]\f[R] \f[I]SCRIPT\f[R], \f[B]\f[CB]--lua-filter=\f[B]\f[R]\f[I]SCRIPT\f[R]
632\f[B]\f[CB]-L\f[B]\f[R] \f[I]SCRIPT\f[R], \f[B]\f[CB]--lua-filter=\f[B]\f[R]\f[I]SCRIPT\f[R]
611Transform the document in a similar fashion as JSON filters (see
633Transform the document in a similar fashion as JSON filters (see
612−\f[C]--filter\f[R]), but use pandoc\[aq]s build-in lua filtering system.
634+\f[C]--filter\f[R]), but use pandoc\[cq]s built-in Lua filtering system.
613−The given lua script is expected to return a list of lua filters which
635+The given Lua script is expected to return a list of Lua filters which
614will be applied in order.
636will be applied in order.
615−Each lua filter must contain element-transforming functions indexed by
637+Each Lua filter must contain element-transforming functions indexed by
616the name of the AST element on which the filter function should be
638the name of the AST element on which the filter function should be
620−The \f[C]pandoc\f[R] lua module provides helper functions for element
642+The \f[C]pandoc\f[R] Lua module provides helper functions for element
622−It is always loaded into the script\[aq]s lua environment.
644+It is always loaded into the script\[cq]s Lua environment.
624−The following is an example lua script for macro-expansion:
646+See the Lua filters documentation for further details.
628−function expand_hello_world(inline)
629− if inline.c == \[aq]{{helloworld}}\[aq] then
630− return pandoc.Emph{ pandoc.Str \[dq]Hello, World\[dq] }
636−return {{Str = expand_hello_world}}
640−In order of preference, pandoc will look for lua filters in
648+In order of preference, pandoc will look for Lua filters in
641.IP "1." 3
649.IP "1." 3
642−a specified full or relative path (executable or non-executable)
650+a specified full or relative path
643.IP "2." 3
651.IP "2." 3
644−\f[C]$DATADIR/filters\f[R] (executable or non-executable) where
652+\f[C]$DATADIR/filters\f[R] where \f[C]$DATADIR\f[R] is the user data
645−\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
653+directory (see \f[C]--data-dir\f[R], above).
655+Filters, Lua filters, and citeproc processing are applied in the order
656+specified on the command line.
649\f[B]\f[CB]-M\f[B]\f[R] \f[I]KEY\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]VAL\f[R]], \f[B]\f[CB]--metadata=\f[B]\f[R]\f[I]KEY\f[R][\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]]
659\f[B]\f[CB]-M\f[B]\f[R] \f[I]KEY\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]VAL\f[R]], \f[B]\f[CB]--metadata=\f[B]\f[R]\f[I]KEY\f[R][\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]]
@@ -683,13 +693,13 @@ Specify the number of spaces per tab (default is 4).
684\f[B]\f[CB]--track-changes=accept\f[B]\f[R]|\f[B]\f[CB]reject\f[B]\f[R]|\f[B]\f[CB]all\f[B]\f[R]
694\f[B]\f[CB]--track-changes=accept\f[B]\f[R]|\f[B]\f[CB]reject\f[B]\f[R]|\f[B]\f[CB]all\f[B]\f[R]
685Specifies what to do with insertions, deletions, and comments produced
695Specifies what to do with insertions, deletions, and comments produced
686−by the MS Word \[dq]Track Changes\[dq] feature.
696+by the MS Word \[lq]Track Changes\[rq] feature.
687−\f[C]accept\f[R] (the default), inserts all insertions, and ignores all
697+\f[C]accept\f[R] (the default) processes all the insertions and
688deletions.
698deletions.
689−\f[C]reject\f[R] inserts all deletions and ignores insertions.
699+\f[C]reject\f[R] ignores them.
690Both \f[C]accept\f[R] and \f[C]reject\f[R] ignore comments.
700Both \f[C]accept\f[R] and \f[C]reject\f[R] ignore comments.
691−\f[C]all\f[R] puts in insertions, deletions, and comments, wrapped in
701+\f[C]all\f[R] includes all insertions, deletions, and comments, wrapped
692−spans with \f[C]insertion\f[R], \f[C]deletion\f[R],
702+in spans with \f[C]insertion\f[R], \f[C]deletion\f[R],
693\f[C]comment-start\f[R], and \f[C]comment-end\f[R] classes,
703\f[C]comment-start\f[R], and \f[C]comment-end\f[R] classes,
694respectively.
704respectively.
695The author and time of change is included.
705The author and time of change is included.
@@ -706,11 +716,11 @@ Extract images and other media contained in or linked from the source
706document to the path \f[I]DIR\f[R], creating it if necessary, and adjust
716document to the path \f[I]DIR\f[R], creating it if necessary, and adjust
707the images references in the document so they point to the extracted
717the images references in the document so they point to the extracted
719+Media are downloaded, read from the file system, or extracted from a
709−If the source format is a binary container (docx, epub, or odt), the
720+binary container (e.g.\ docx), as needed.
710−media is extracted from the container and the original filenames are
721+The original file paths are used if they are relative paths not
711−used.
722+containing \f[C]..\f[R].
712−Otherwise the media is read from the file system or downloaded, and new
713−filenames are constructed based on SHA1 hashes of the contents.
723+Otherwise filenames are constructed from the SHA1 hash of the contents.
715\f[B]\f[CB]--abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
725\f[B]\f[CB]--abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
716Specifies a custom abbreviations file, with abbreviations one to a line.
726Specifies a custom abbreviations file, with abbreviations one to a line.
@@ -720,14 +730,14 @@ system default.
720To see the system default, use
730To see the system default, use
721\f[C]pandoc --print-default-data-file=abbreviations\f[R].
731\f[C]pandoc --print-default-data-file=abbreviations\f[R].
722The only use pandoc makes of this list is in the Markdown reader.
732The only use pandoc makes of this list is in the Markdown reader.
723−Strings ending in a period that are found in this list will be followed
733+Strings found in this list will be followed by a nonbreaking space, and
724−by a nonbreaking space, so that the period will not produce
725−sentence-ending space in formats like LaTeX.
734+the period will not produce sentence-ending space in formats like LaTeX.
735+The strings may not contain spaces.
726.SS General writer options
736.SS General writer options
728\f[B]\f[CB]-s\f[B]\f[R], \f[B]\f[CB]--standalone\f[B]\f[R]
738\f[B]\f[CB]-s\f[B]\f[R], \f[B]\f[CB]--standalone\f[B]\f[R]
729−Produce output with an appropriate header and footer (e.g.
739+Produce output with an appropriate header and footer (e.g.\ a standalone
730−a standalone HTML, LaTeX, TEI, or RTF file, not a fragment).
740+HTML, LaTeX, TEI, or RTF file, not a fragment).
731This option is set automatically for \f[C]pdf\f[R], \f[C]epub\f[R],
741This option is set automatically for \f[C]pdf\f[R], \f[C]epub\f[R],
732\f[C]epub3\f[R], \f[C]fb2\f[R], \f[C]docx\f[R], and \f[C]odt\f[R]
742\f[C]epub3\f[R], \f[C]fb2\f[R], \f[C]docx\f[R], and \f[C]odt\f[R]
@@ -887,8 +897,7 @@ Implies \f[C]--standalone\f[R].
888\f[B]\f[CB]-B\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--include-before-body=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
898\f[B]\f[CB]-B\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--include-before-body=\f[B]\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R]
889Include contents of \f[I]FILE\f[R], verbatim, at the beginning of the
899Include contents of \f[I]FILE\f[R], verbatim, at the beginning of the
891−after the \f[C]<body>\f[R] tag in HTML, or the
900+document body (e.g.\ after the \f[C]<body>\f[R] tag in HTML, or the
892\f[C]\[rs]begin{document}\f[R] command in LaTeX).
901\f[C]\[rs]begin{document}\f[R] command in LaTeX).
893This can be used to include navigation bars or banners in HTML
902This can be used to include navigation bars or banners in HTML
894documents.
903documents.
@@ -914,20 +923,23 @@ Note that, if \f[C]--resource-path\f[R] is specified, the working
914directory must be explicitly listed or it will not be searched.
923directory must be explicitly listed or it will not be searched.
915For example: \f[C]--resource-path=.:test\f[R] will search the working
924For example: \f[C]--resource-path=.:test\f[R] will search the working
916directory and the \f[C]test\f[R] subdirectory, in that order.
925directory and the \f[C]test\f[R] subdirectory, in that order.
917−.RS
926+This option can be used repeatedly.
918−.PP
927+Search path components that come later on the command line will be
919−\f[C]--resource-path\f[R] only has an effect if (a) the output format
928+searched before those that come earlier, so
920−embeds images (for example, \f[C]docx\f[R], \f[C]pdf\f[R], or
929+\f[C]--resource-path foo:bar --resource-path baz:bim\f[R] is equivalent
921−\f[C]html\f[R] with \f[C]--self-contained\f[R]) or (b) it is used
930+to \f[C]--resource-path baz:bim:foo:bar\f[R].
922−together with \f[C]--extract-media\f[R].
925\f[B]\f[CB]--request-header=\f[B]\f[R]\f[I]NAME\f[R]\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]
932\f[B]\f[CB]--request-header=\f[B]\f[R]\f[I]NAME\f[R]\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]
926Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when
933Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when
927making HTTP requests (for example, when a URL is given on the command
934making HTTP requests (for example, when a URL is given on the command
928line, or when resources used in a document must be downloaded).
935line, or when resources used in a document must be downloaded).
929−If you\[aq]re behind a proxy, you also need to set the environment
936+If you\[cq]re behind a proxy, you also need to set the environment
930variable \f[C]http_proxy\f[R] to \f[C]http://...\f[R].
937variable \f[C]http_proxy\f[R] to \f[C]http://...\f[R].
939+\f[B]\f[CB]--no-check-certificate\f[B]\f[R]
940+Disable the certificate verification to allow access to unsecure HTTP
941+resources (for example when the certificate is no longer valid or self
931.SS Options affecting specific writers
943.SS Options affecting specific writers
933\f[B]\f[CB]--self-contained\f[B]\f[R]
945\f[B]\f[CB]--self-contained\f[B]\f[R]
@@ -935,7 +947,7 @@ Produce a standalone HTML file with no external dependencies, using
935\f[C]data:\f[R] URIs to incorporate the contents of linked scripts,
947\f[C]data:\f[R] URIs to incorporate the contents of linked scripts,
936stylesheets, images, and videos.
948stylesheets, images, and videos.
937Implies \f[C]--standalone\f[R].
949Implies \f[C]--standalone\f[R].
938−The resulting file should be \[dq]self-contained,\[dq] in the sense that
950+The resulting file should be \[lq]self-contained,\[rq] in the sense that
939it needs no external files and no net access to be displayed properly by
951it needs no external files and no net access to be displayed properly by
940a browser.
952a browser.
941This option works only with HTML output formats, including
953This option works only with HTML output formats, including
@@ -951,12 +963,14 @@ left alone; the documents they link to will not be incorporated in the
952Limitation: resources that are loaded dynamically through JavaScript
964Limitation: resources that are loaded dynamically through JavaScript
953cannot be incorporated; as a result, \f[C]--self-contained\f[R] does not
965cannot be incorporated; as a result, \f[C]--self-contained\f[R] does not
954−work with \f[C]--mathjax\f[R], and some advanced features (e.g.
966+work with \f[C]--mathjax\f[R], and some advanced features (e.g.\ zoom or
955−zoom or speaker notes) may not work in an offline
967+speaker notes) may not work in an offline \[lq]self-contained\[rq]
956−\[dq]self-contained\[dq] \f[C]reveal.js\f[R] slide show.
968+\f[C]reveal.js\f[R] slide show.
958\f[B]\f[CB]--html-q-tags\f[B]\f[R]
970\f[B]\f[CB]--html-q-tags\f[B]\f[R]
959Use \f[C]<q>\f[R] tags for quotes in HTML.
971Use \f[C]<q>\f[R] tags for quotes in HTML.
972+(This option only has an effect if the \f[C]smart\f[R] extension is
973+enabled for the input format used.)
961\f[B]\f[CB]--ascii\f[B]\f[R]
975\f[B]\f[CB]--ascii\f[B]\f[R]
962Use only ASCII characters in output.
976Use only ASCII characters in output.
@@ -974,21 +988,24 @@ By default inline links are used.
974The placement of link references is affected by the
988The placement of link references is affected by the
975\f[C]--reference-location\f[R] option.
989\f[C]--reference-location\f[R] option.
977−\f[B]\f[CB]--reference-location = block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
991+\f[B]\f[CB]--reference-location=block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
978Specify whether footnotes (and references, if \f[C]reference-links\f[R]
992Specify whether footnotes (and references, if \f[C]reference-links\f[R]
979is set) are placed at the end of the current (top-level) block, the
993is set) are placed at the end of the current (top-level) block, the
980current section, or the document.
994current section, or the document.
981The default is \f[C]document\f[R].
995The default is \f[C]document\f[R].
982Currently only affects the markdown writer.
996Currently only affects the markdown writer.
998+\f[B]\f[CB]--markdown-headings=setext\f[B]\f[R]|\f[B]\f[CB]atx\f[B]\f[R]
999+Specify whether to use ATX-style (\f[C]#\f[R]-prefixed) or Setext-style
1000+(underlined) headings for level 1 and 2 headings in Markdown output.
1001+(The default is \f[C]atx\f[R].) ATX-style headings are always used for
1003+This option also affects Markdown cells in \f[C]ipynb\f[R] output.
984\f[B]\f[CB]--atx-headers\f[B]\f[R]
1005\f[B]\f[CB]--atx-headers\f[B]\f[R]
985−Use ATX-style headings in Markdown output.
1006+\f[I]Deprecated synonym for \f[CI]--markdown-headings=atx\f[I].\f[R]
986−The default is to use setext-style headings for levels 1 to 2, and then
988−(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This
989−option also affects markdown cells in \f[C]ipynb\f[R] output.
991−\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R]
1008+\f[B]\f[CB]--top-level-division=default\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]chapter\f[B]\f[R]|\f[B]\f[CB]part\f[B]\f[R]
992Treat top-level headings as the given division type in LaTeX, ConTeXt,
1009Treat top-level headings as the given division type in LaTeX, ConTeXt,
993DocBook, and TEI output.
1010DocBook, and TEI output.
994The hierarchy order is part, chapter, then section; all headings are
1011The hierarchy order is part, chapter, then section; all headings are
@@ -1005,21 +1022,22 @@ become \f[C]\[rs]part{..}\f[R], while second-level headings remain as
1005their default type.
1022their default type.
1007\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
1024\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
1008−Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
1025+Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
1009By default, sections are not numbered.
1027By default, sections are not numbered.
1010Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
1028Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
1011\f[C]--number-sections\f[R] is specified.
1029\f[C]--number-sections\f[R] is specified.
1013−\f[B]\f[CB]--number-offset=\f[B]\f[R]\f[I]NUMBER\f[R][\f[B]\f[CB],\f[B]\f[R]\f[I]NUMBER\f[R]\f[B]\f[CB],\f[B]\f[R]\f[I]...\f[R]]
1031+\f[B]\f[CB]--number-offset=\f[B]\f[R]\f[I]NUMBER\f[R][\f[B]\f[CB],\f[B]\f[R]\f[I]NUMBER\f[R]\f[B]\f[CB],\f[B]\f[R]\f[I]\&...\f[R]]
1014Offset for section headings in HTML output (ignored in other output
1032Offset for section headings in HTML output (ignored in other output
1015formats).
1033formats).
1016The first number is added to the section number for top-level headings,
1034The first number is added to the section number for top-level headings,
1017the second for second-level headings, and so on.
1035the second for second-level headings, and so on.
1018So, for example, if you want the first top-level heading in your
1036So, for example, if you want the first top-level heading in your
1019−document to be numbered \[dq]6\[dq], specify
1037+document to be numbered \[lq]6\[rq], specify
1020\f[C]--number-offset=5\f[R].
1038\f[C]--number-offset=5\f[R].
1021If your document starts with a level-2 heading which you want to be
1039If your document starts with a level-2 heading which you want to be
1022−numbered \[dq]1.5\[dq], specify \f[C]--number-offset=1,4\f[R].
1040+numbered \[lq]1.5\[rq], specify \f[C]--number-offset=1,4\f[R].
1023Offsets are 0 by default.
1041Offsets are 0 by default.
1024Implies \f[C]--number-sections\f[R].
1042Implies \f[C]--number-sections\f[R].
@@ -1184,6 +1202,8 @@ Verbatim Char
1184Footnote Reference
1202Footnote Reference
1185.IP \[bu] 2
1203.IP \[bu] 2
1186Hyperlink
1204Hyperlink
1188Table style:
1208Table style:
1189.IP \[bu] 2
1209.IP \[bu] 2
@@ -1316,7 +1336,7 @@ body { font-family: \[dq]DejaVuSans\[dq]; }
1317\f[B]\f[CB]--epub-chapter-level=\f[B]\f[R]\f[I]NUMBER\f[R]
1337\f[B]\f[CB]--epub-chapter-level=\f[B]\f[R]\f[I]NUMBER\f[R]
1318Specify the heading level at which to split the EPUB into separate
1338Specify the heading level at which to split the EPUB into separate
1319−\[dq]chapter\[dq] files.
1339+\[lq]chapter\[rq] files.
1320The default is to split into chapters at level-1 headings.
1340The default is to split into chapters at level-1 headings.
1321This option only affects the internal composition of the EPUB, not the
1341This option only affects the internal composition of the EPUB, not the
1322way chapters and sections are displayed to users.
1342way chapters and sections are displayed to users.
@@ -1358,7 +1378,8 @@ depending on the output format specified using \f[C]-t/--to\f[R]:
1358\f[C]-t context\f[R]: \f[C]context\f[R]
1378\f[C]-t context\f[R]: \f[C]context\f[R]
1359.IP \[bu] 2
1379.IP \[bu] 2
1360\f[C]-t html\f[R]: \f[C]wkhtmltopdf\f[R] (other options:
1380\f[C]-t html\f[R]: \f[C]wkhtmltopdf\f[R] (other options:
1361−\f[C]prince\f[R], \f[C]weasyprint\f[R])
1381+\f[C]prince\f[R], \f[C]weasyprint\f[R]; see print-css.rocks for a good
1382+introduction to PDF generation from HTML/CSS.)
1362.IP \[bu] 2
1383.IP \[bu] 2
1363\f[C]-t ms\f[R]: \f[C]pdfroff\f[R]
1384\f[C]-t ms\f[R]: \f[C]pdfroff\f[R]
@@ -1367,47 +1388,69 @@ depending on the output format specified using \f[C]-t/--to\f[R]:
1367Use the given string as a command-line argument to the
1388Use the given string as a command-line argument to the
1368\f[C]pdf-engine\f[R].
1389\f[C]pdf-engine\f[R].
1369For example, to use a persistent directory \f[C]foo\f[R] for
1390For example, to use a persistent directory \f[C]foo\f[R] for
1370−\f[C]latexmk\f[R]\[aq]s auxiliary files, use
1391+\f[C]latexmk\f[R]\[cq]s auxiliary files, use
1371\f[C]--pdf-engine-opt=-outdir=foo\f[R].
1392\f[C]--pdf-engine-opt=-outdir=foo\f[R].
1372Note that no check for duplicate options is done.
1393Note that no check for duplicate options is done.
1373.SS Citation rendering
1394.SS Citation rendering
1396+\f[B]\f[CB]-C\f[B]\f[R], \f[B]\f[CB]--citeproc\f[B]\f[R]
1397+Process the citations in the file, replacing them with rendered
1398+citations and adding a bibliography.
1399+Citation processing will not take place unless bibliographic data is
1400+supplied, either through an external file specified using the
1401+\f[C]--bibliography\f[R] option or the \f[C]bibliography\f[R] field in
1402+metadata, or via a \f[C]references\f[R] section in metadata containing a
1403+list of citations in CSL YAML format with Markdown formatting.
1404+The style is controlled by a CSL stylesheet specified using the
1405+\f[C]--csl\f[R] option or the \f[C]csl\f[R] field in metadata.
1406+(If no stylesheet is specified, the \f[C]chicago-author-date\f[R] style
1407+will be used by default.) The citation processing transformation may be
1408+applied before or after filters or Lua filters (see \f[C]--filter\f[R],
1409+\f[C]--lua-filter\f[R]): these transformations are applied in the order
1410+they appear on the command line.
1411+For more information, see the section on Citations.
1375\f[B]\f[CB]--bibliography=\f[B]\f[R]\f[I]FILE\f[R]
1413\f[B]\f[CB]--bibliography=\f[B]\f[R]\f[I]FILE\f[R]
1376−Set the \f[C]bibliography\f[R] field in the document\[aq]s metadata to
1414+Set the \f[C]bibliography\f[R] field in the document\[cq]s metadata to
1377−\f[I]FILE\f[R], overriding any value set in the metadata, and process
1415+\f[I]FILE\f[R], overriding any value set in the metadata.
1378−citations using \f[C]pandoc-citeproc\f[R].
1379−(This is equivalent to
1380−\f[C]--metadata bibliography=FILE --filter pandoc-citeproc\f[R].) If
1381−\f[C]--natbib\f[R] or \f[C]--biblatex\f[R] is also supplied,
1382−\f[C]pandoc-citeproc\f[R] is not used, making this equivalent to
1383−\f[C]--metadata bibliography=FILE\f[R].
1384If you supply this argument multiple times, each \f[I]FILE\f[R] will be
1416If you supply this argument multiple times, each \f[I]FILE\f[R] will be
1385added to bibliography.
1417added to bibliography.
1418+If \f[I]FILE\f[R] is a URL, it will be fetched via HTTP.
1419+If \f[I]FILE\f[R] is not found relative to the working directory, it
1420+will be sought in the resource path (see \f[C]--resource-path\f[R]).
1387\f[B]\f[CB]--csl=\f[B]\f[R]\f[I]FILE\f[R]
1422\f[B]\f[CB]--csl=\f[B]\f[R]\f[I]FILE\f[R]
1388−Set the \f[C]csl\f[R] field in the document\[aq]s metadata to
1423+Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
1389\f[I]FILE\f[R], overriding any value set in the metadata.
1424\f[I]FILE\f[R], overriding any value set in the metadata.
1390−(This is equivalent to \f[C]--metadata csl=FILE\f[R].) This option is
1425+(This is equivalent to \f[C]--metadata csl=FILE\f[R].) If \f[I]FILE\f[R]
1391−only relevant with \f[C]pandoc-citeproc\f[R].
1426+is a URL, it will be fetched via HTTP.
1427+If \f[I]FILE\f[R] is not found relative to the working directory, it
1428+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1429+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1393\f[B]\f[CB]--citation-abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
1432\f[B]\f[CB]--citation-abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
1394−Set the \f[C]citation-abbreviations\f[R] field in the document\[aq]s
1433+Set the \f[C]citation-abbreviations\f[R] field in the document\[cq]s
1395metadata to \f[I]FILE\f[R], overriding any value set in the metadata.
1434metadata to \f[I]FILE\f[R], overriding any value set in the metadata.
1396(This is equivalent to
1435(This is equivalent to
1397−\f[C]--metadata citation-abbreviations=FILE\f[R].) This option is only
1436+\f[C]--metadata citation-abbreviations=FILE\f[R].) If \f[I]FILE\f[R] is
1398−relevant with \f[C]pandoc-citeproc\f[R].
1437+a URL, it will be fetched via HTTP.
1438+If \f[I]FILE\f[R] is not found relative to the working directory, it
1439+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1440+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1400\f[B]\f[CB]--natbib\f[B]\f[R]
1443\f[B]\f[CB]--natbib\f[B]\f[R]
1401Use \f[C]natbib\f[R] for citations in LaTeX output.
1444Use \f[C]natbib\f[R] for citations in LaTeX output.
1402−This option is not for use with the \f[C]pandoc-citeproc\f[R] filter or
1445+This option is not for use with the \f[C]--citeproc\f[R] option or with
1403−with PDF output.
1446+PDF output.
1404It is intended for use in producing a LaTeX file that can be processed
1447It is intended for use in producing a LaTeX file that can be processed
1405with \f[C]bibtex\f[R].
1448with \f[C]bibtex\f[R].
1407\f[B]\f[CB]--biblatex\f[B]\f[R]
1450\f[B]\f[CB]--biblatex\f[B]\f[R]
1408Use \f[C]biblatex\f[R] for citations in LaTeX output.
1451Use \f[C]biblatex\f[R] for citations in LaTeX output.
1409−This option is not for use with the \f[C]pandoc-citeproc\f[R] filter or
1452+This option is not for use with the \f[C]--citeproc\f[R] option or with
1410−with PDF output.
1453+PDF output.
1411It is intended for use in producing a LaTeX file that can be processed
1454It is intended for use in producing a LaTeX file that can be processed
1412with \f[C]bibtex\f[R] or \f[C]biber\f[R].
1455with \f[C]bibtex\f[R] or \f[C]biber\f[R].
1413.SS Math rendering in HTML
1456.SS Math rendering in HTML
@@ -1448,7 +1491,7 @@ For SVG images you can for example use
1448If no URL is specified, the CodeCogs URL generating PNGs will be used
1491If no URL is specified, the CodeCogs URL generating PNGs will be used
1449(\f[C]https://latex.codecogs.com/png.latex?\f[R]).
1492(\f[C]https://latex.codecogs.com/png.latex?\f[R]).
1450Note: the \f[C]--webtex\f[R] option will affect Markdown output as well
1493Note: the \f[C]--webtex\f[R] option will affect Markdown output as well
1451−as HTML, which is useful if you\[aq]re targeting a version of Markdown
1494+as HTML, which is useful if you\[cq]re targeting a version of Markdown
1452without native math support.
1495without native math support.
1454\f[B]\f[CB]--katex\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]URL\f[R]]
1497\f[B]\f[CB]--katex\f[B]\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]URL\f[R]]
@@ -1461,16 +1504,16 @@ inserted.
1462\f[B]\f[CB]--gladtex\f[B]\f[R]
1505\f[B]\f[CB]--gladtex\f[B]\f[R]
1463Enclose TeX math in \f[C]<eq>\f[R] tags in HTML output.
1506Enclose TeX math in \f[C]<eq>\f[R] tags in HTML output.
1464−The resulting HTML can then be processed by GladTeX to produce images of
1507+The resulting HTML can then be processed by GladTeX to produce SVG
1465−the typeset formulas and an HTML file with links to these images.
1508+images of the typeset formulas and an HTML file with these images
1466−So, the procedure is:
1509+embedded.
1471pandoc -s --gladtex input.md -o myfile.htex
1514pandoc -s --gladtex input.md -o myfile.htex
1472−gladtex -d myfile-images myfile.htex
1515+gladtex -d image_dir myfile.htex
1473−# produces myfile.html and images in myfile-images
1516+# produces myfile.html and images in image_dir
@@ -1559,6 +1602,11 @@ T}@T{
1559PandocUnsupportedExtensionError
1602PandocUnsupportedExtensionError
1564PandocEpubSubdirectoryError
1612PandocEpubSubdirectoryError
@@ -1569,6 +1617,11 @@ T}@T{
1569PandocPDFError
1617PandocPDFError
1574PandocPDFProgramNotFoundError
1627PandocPDFProgramNotFoundError
@@ -1629,6 +1682,11 @@ T}@T{
1629PandocIpynbDecodingError
1682PandocIpynbDecodingError
1687+PandocUnsupportedCharsetError
1634PandocCouldNotFindDataFileError
1692PandocCouldNotFindDataFileError
@@ -1661,6 +1719,16 @@ input-files:
1661- content.md
1719- content.md
1662# or you may use input-file: with a single value
1720# or you may use input-file: with a single value
1722+# Include options from the specified defaults files.
1723+# The files will be searched for first in the working directory
1724+# and then in the defaults subdirectory of the user data directory.
1725+# The files are included in the same order in which they appear in
1726+# the list. Options specified in this defaults file always have
1727+# priority over the included ones.
1664template: letter
1732template: letter
1665standalone: true
1733standalone: true
1666self-contained: false
1734self-contained: false
@@ -1688,11 +1756,24 @@ include-after-body: []
1688include-in-header: []
1756include-in-header: []
1689resource-path: [\[dq].\[dq]]
1757resource-path: [\[dq].\[dq]]
1759+# turn on built-in citation processing. Note that if you need
1760+# control over when the citeproc processing is done relative
1761+# to other filters, you should instead use \[ga]citeproc\[ga] in the
1762+# list of \[ga]filters\[ga] (see below).
1768+citation-abbreviations: abbrevs.json
1691−# filters will be assumed to be lua filters if they have
1770+# Filters will be assumed to be Lua filters if they have
1692# the .lua extension, and json filters otherwise. But
1771# the .lua extension, and json filters otherwise. But
1693−# the filter type can also be specified explicitly, as shown:
1772+# the filter type can also be specified explicitly, as shown.
1773+# Filters are run in the order specified.
1774+# To include the built-in citeproc filter, use either \[ga]citeproc\[ga]
1775+# or \[ga]{type: citeproc}\[ga].
1696- wordcount.lua
1777- wordcount.lua
1697- type: json
1778- type: json
1698 path: foo.lua
1779 path: foo.lua
@@ -1705,8 +1786,11 @@ data-dir:
1705verbosity: INFO
1786verbosity: INFO
1706log-file: log.json
1787log-file: log.json
1708−# citeproc, natbib, or biblatex
1789+# citeproc, natbib, or biblatex. This only affects LaTeX
1790+# output. If you want to use citeproc to format citations,
1791+# you should also set \[aq]citeproc: true\[aq] (see above).
1709cite-method: citeproc
1792cite-method: citeproc
1710# part, chapter, section, or default:
1794# part, chapter, section, or default:
1711top-level-division: chapter
1795top-level-division: chapter
1712abbreviations:
1796abbreviations:
@@ -1775,7 +1859,7 @@ epub-cover-image: cover.jpg
1775reference-links: true
1859reference-links: true
1776# block, section, or document
1860# block, section, or document
1777reference-location: block
1861reference-location: block
1778−atx-headers: false
1862+markdown-headings: setext
1780# accept, reject, or all
1864# accept, reject, or all
1781track-changes: accept
1865track-changes: accept
@@ -1807,6 +1891,38 @@ verbosity: INFO
1894+In fields that expect a file path (or list of file paths), the following
1895+syntax may be used to interpolate environment variables:
1899+csl: ${HOME}/mycsldir/special.csl
1903+\f[C]${USERDATA}\f[R] may also be used; this will always resolve to the
1904+user data directory that is current when the defaults file is parsed,
1905+regardless of the setting of the environment variable
1908+\f[C]${.}\f[R] will resolve to the directory containing the default file
1910+This allows you to refer to resources contained in that directory:
1914+epub-cover-image: ${.}/cover.jpg
1915+epub-metadata: ${.}/meta.xml
1917+- . # the working directory from which pandoc is run
1918+- ${.}/images # the images subdirectory of the directory
1919+ # containing this defaults file
1923+This environment variable interpolation syntax \f[I]only\f[R] works in
1924+fields that expect file paths.
1810Default files can be placed in the \f[C]defaults\f[R] subdirectory of
1926Default files can be placed in the \f[C]defaults\f[R] subdirectory of
1811the user data directory and used from any directory.
1927the user data directory and used from any directory.
1812For example, one could create a file specifying defaults for writing
1928For example, one could create a file specifying defaults for writing
@@ -1863,10 +1979,10 @@ arbitrary information at any point in the file.
1863They may be set at the command line using the \f[C]-V/--variable\f[R]
1979They may be set at the command line using the \f[C]-V/--variable\f[R]
1865If a variable is not set, pandoc will look for the key in the
1981If a variable is not set, pandoc will look for the key in the
1866−document\[aq]s metadata, which can be set using either YAML metadata
1982+document\[cq]s metadata, which can be set using either YAML metadata
1867blocks or with the \f[C]-M/--metadata\f[R] option.
1983blocks or with the \f[C]-M/--metadata\f[R] option.
1868In addition, some variables are given default values by pandoc.
1984In addition, some variables are given default values by pandoc.
1869−See Variables below for a list of variables used in pandoc\[aq]s default
1985+See Variables below for a list of variables used in pandoc\[cq]s default
1870templates.
1986templates.
1872If you use custom templates, you may need to revise them as pandoc
1988If you use custom templates, you may need to revise them as pandoc
@@ -1883,8 +1999,8 @@ be treated as a comment and omitted from the output.
1883.SS Delimiters
1999.SS Delimiters
1885To mark variables and control structures in the template, either
2001To mark variables and control structures in the template, either
1886−\f[C]$\f[R]...\f[C]$\f[R] or \f[C]${\f[R]...\f[C]}\f[R] may be used as
2002+\f[C]$\f[R]\&...\f[C]$\f[R] or \f[C]${\f[R]\&...\f[C]}\f[R] may be used
1887−delimiters.
2003+as delimiters.
1888The styles may also be mixed in the same template, but the opening and
2004The styles may also be mixed in the same template, but the opening and
1889closing delimiter must match in each case.
2005closing delimiter must match in each case.
1890The opening delimiter may be followed by one or more spaces or tabs,
2006The opening delimiter may be followed by one or more spaces or tabs,
@@ -2045,19 +2161,29 @@ ${ endfor }
2046.SS Partials
2162.SS Partials
2048−Partials (subtemplates stored in different files) may be included using
2164+Partials (subtemplates stored in different files) may be included by
2049−the syntax
2165+using the name of the partial, followed by \f[C]()\f[R], for example:
2053−${ boilerplate() }
2169+${ styles() }
2057−Partials will be sought in the directory containing the main template,
2173+Partials will be sought in the directory containing the main template.
2058−and will be assumed to have the same extension as the main template if
2174+The file name will be assumed to have the same extension as the main
2059−they lack an explicit extension.
2175+template if it lacks an extension.
2060−(If the partials are not found here, they will also be sought in the
2176+When calling the partial, the full name including file extension can
2185+(If a partial is not found in the directory of the template and the
2186+template path is given as a relative path, it will also be sought in the
2061\f[C]templates\f[R] subdirectory of the user data directory.)
2187\f[C]templates\f[R] subdirectory of the user data directory.)
2063Partials may optionally be applied to variables using a colon:
2189Partials may optionally be applied to variables using a colon:
@@ -2107,7 +2233,7 @@ an explicit \f[C]for\f[R] loop) cannot contain interpolated variables or
2107other template directives.
2233other template directives.
2108.SS Nesting
2234.SS Nesting
2110−To ensure that content is \[dq]nested,\[dq] that is, subsequent lines
2236+To ensure that content is \[lq]nested,\[rq] that is, subsequent lines
2111indented, use the \f[C]\[ha]\f[R] directive:
2237indented, use the \f[C]\[ha]\f[R] directive:
@@ -2149,7 +2275,7 @@ will produce
2150If a variable occurs by itself on a line, preceded by whitespace and not
2276If a variable occurs by itself on a line, preceded by whitespace and not
2151followed by further text or directives on the same line, and the
2277followed by further text or directives on the same line, and the
2152−variable\[aq]s value contains multiple lines, it will be nested
2278+variable\[cq]s value contains multiple lines, it will be nested
2153automatically.
2279automatically.
2154.SS Breakable spaces
2280.SS Breakable spaces
@@ -2224,6 +2350,18 @@ for a textual value, number of elements for a map or array.
2224\f[C]reverse\f[R]: Reverses a textual value or array, and has no effect
2350\f[C]reverse\f[R]: Reverses a textual value or array, and has no effect
2225on other values.
2351on other values.
2226.IP \[bu] 2
2352.IP \[bu] 2
2353+\f[C]first\f[R]: Returns the first value of an array, if applied to a
2354+non-empty array; otherwise returns the original value.
2356+\f[C]last\f[R]: Returns the last value of an array, if applied to a
2357+non-empty array; otherwise returns the original value.
2359+\f[C]rest\f[R]: Returns all but the first value of an array, if applied
2360+to a non-empty array; otherwise returns the original value.
2362+\f[C]allbutlast\f[R]: Returns all but the last value of an array, if
2363+applied to a non-empty array; otherwise returns the original value.
2227\f[C]chomp\f[R]: Removes trailing newlines (and breakable space).
2365\f[C]chomp\f[R]: Removes trailing newlines (and breakable space).
2228.IP \[bu] 2
2366.IP \[bu] 2
2229\f[C]nowrap\f[R]: Disables line wrapping on breakable spaces.
2367\f[C]nowrap\f[R]: Disables line wrapping on breakable spaces.
@@ -2279,7 +2417,8 @@ including a title block in the document itself, you can set the
2279\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
2417\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
2280variables.
2418variables.
2281(By default these are set automatically, based on \f[C]title\f[R],
2419(By default these are set automatically, based on \f[C]title\f[R],
2282−\f[C]author\f[R], and \f[C]date\f[R].)
2420+\f[C]author\f[R], and \f[C]date\f[R].) The page title in HTML is set by
2421+\f[C]pagetitle\f[R], which is equal to \f[C]title\f[R] by default.
2285\f[B]\f[CB]subtitle\f[B]\f[R]
2424\f[B]\f[CB]subtitle\f[B]\f[R]
@@ -2369,13 +2508,81 @@ For bidirectional documents, native pandoc \f[C]span\f[R]s and
2369\f[C]div\f[R]s with the \f[C]dir\f[R] attribute (value \f[C]rtl\f[R] or
2508\f[C]div\f[R]s with the \f[C]dir\f[R] attribute (value \f[C]rtl\f[R] or
2370\f[C]ltr\f[R]) can be used to override the base direction in some output
2509\f[C]ltr\f[R]) can be used to override the base direction in some output
2372−This may not always be necessary if the final renderer (e.g.
2511+This may not always be necessary if the final renderer (e.g.\ the
2373−the browser, when generating HTML) supports the Unicode Bidirectional
2512+browser, when generating HTML) supports the Unicode Bidirectional
2374Algorithm.
2513Algorithm.
2376When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[R]
2515When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[R]
2377engine is fully supported (use \f[C]--pdf-engine=xelatex\f[R]).
2516engine is fully supported (use \f[C]--pdf-engine=xelatex\f[R]).
2518+.SS Variables for HTML
2520+\f[B]\f[CB]document-css\f[B]\f[R]
2521+Enables inclusion of most of the CSS in the \f[C]styles.html\f[R]
2522+partial (have a look with
2523+\f[C]pandoc --print-default-data-file=templates/styles.html\f[R]).
2524+Unless you use \f[C]--css\f[R], this variable is set to \f[C]true\f[R]
2526+You can disable it with e.g.\ \f[C]pandoc -M document-css=false\f[R].
2528+\f[B]\f[CB]mainfont\f[B]\f[R]
2529+sets the CSS \f[C]font-family\f[R] property on the \f[C]html\f[R]
2532+\f[B]\f[CB]fontsize\f[B]\f[R]
2533+sets the base CSS \f[C]font-size\f[R], which you\[cq]d usually set to
2534+e.g.\ \f[C]20px\f[R], but it also accepts \f[C]pt\f[R] (12pt = 16px in
2537+\f[B]\f[CB]fontcolor\f[B]\f[R]
2538+sets the CSS \f[C]color\f[R] property on the \f[C]html\f[R] element.
2540+\f[B]\f[CB]linkcolor\f[B]\f[R]
2541+sets the CSS \f[C]color\f[R] property on all links.
2543+\f[B]\f[CB]monofont\f[B]\f[R]
2544+sets the CSS \f[C]font-family\f[R] property on \f[C]code\f[R] elements.
2546+\f[B]\f[CB]monobackgroundcolor\f[B]\f[R]
2547+sets the CSS \f[C]background-color\f[R] property on \f[C]code\f[R]
2548+elements and adds extra padding.
2550+\f[B]\f[CB]linestretch\f[B]\f[R]
2551+sets the CSS \f[C]line-height\f[R] property on the \f[C]html\f[R]
2552+element, which is preferred to be unitless.
2554+\f[B]\f[CB]backgroundcolor\f[B]\f[R]
2555+sets the CSS \f[C]background-color\f[R] property on the \f[C]html\f[R]
2558+\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2559+sets the corresponding CSS \f[C]padding\f[R] properties on the
2560+\f[C]body\f[R] element.
2562+To override or extend some CSS for just one document, include for
2571+ font-style: italic;
2574+ background-color: #f0f0f0;
2577+ padding: 0.5em 2em 0.5em 0.5em;
2580+ border-bottom: none;
2379.SS Variables for HTML math
2586.SS Variables for HTML math
2381\f[B]\f[CB]classoption\f[B]\f[R]
2588\f[B]\f[CB]classoption\f[B]\f[R]
@@ -2383,14 +2590,14 @@ when using KaTeX, you can render display math equations flush left using
2383YAML metadata or with \f[C]-M classoption=fleqn\f[R].
2590YAML metadata or with \f[C]-M classoption=fleqn\f[R].
2384.SS Variables for HTML slides
2591.SS Variables for HTML slides
2386−These affect HTML output when producing slide shows with pandoc.
2593+These affect HTML output when [producing slide shows with pandoc].
2388−All reveal.js configuration options are available as variables.
2595+\f[B]\f[CB]institute\f[B]\f[R]
2389−To turn off boolean flags that default to true in reveal.js, use
2596+author affiliations: can be a list when there are multiple authors
2392\f[B]\f[CB]revealjs-url\f[B]\f[R]
2598\f[B]\f[CB]revealjs-url\f[B]\f[R]
2393−base URL for reveal.js documents (defaults to \f[C]reveal.js\f[R])
2599+base URL for reveal.js documents (defaults to
2600+\f[C]https://unpkg.com/reveal.js\[at]\[ha]4/\f[R])
2395\f[B]\f[CB]s5-url\f[B]\f[R]
2602\f[B]\f[CB]s5-url\f[B]\f[R]
2396base URL for S5 documents (defaults to \f[C]s5/default\f[R])
2603base URL for S5 documents (defaults to \f[C]s5/default\f[R])
@@ -2405,6 +2612,10 @@ base URL for Slideous documents (defaults to \f[C]slideous\f[R])
2405\f[B]\f[CB]title-slide-attributes\f[B]\f[R]
2612\f[B]\f[CB]title-slide-attributes\f[B]\f[R]
2406additional attributes for the title slide of reveal.js slide shows.
2613additional attributes for the title slide of reveal.js slide shows.
2407See background in reveal.js and beamer for an example.
2614See background in reveal.js and beamer for an example.
2616+All reveal.js configuration options are available as variables.
2617+To turn off boolean flags that default to true in reveal.js, use
2408.SS Variables for Beamer slides
2619.SS Variables for Beamer slides
2410These variables change the appearance of PDF slides using
2621These variables change the appearance of PDF slides using
@@ -2433,7 +2644,7 @@ navigation symbols; other valid values are \f[C]frame\f[R],
2433\f[C]vertical\f[R], and \f[C]horizontal\f[R])
2644\f[C]vertical\f[R], and \f[C]horizontal\f[R])
2435\f[B]\f[CB]section-titles\f[B]\f[R]
2646\f[B]\f[CB]section-titles\f[B]\f[R]
2436−enables \[dq]title pages\[dq] for new sections (default is true)
2647+enables \[lq]title pages\[rq] for new sections (default is true)
2438\f[B]\f[CB]theme\f[B]\f[R], \f[B]\f[CB]colortheme\f[B]\f[R], \f[B]\f[CB]fonttheme\f[B]\f[R], \f[B]\f[CB]innertheme\f[B]\f[R], \f[B]\f[CB]outertheme\f[B]\f[R]
2649\f[B]\f[CB]theme\f[B]\f[R], \f[B]\f[CB]colortheme\f[B]\f[R], \f[B]\f[CB]fonttheme\f[B]\f[R], \f[B]\f[CB]innertheme\f[B]\f[R], \f[B]\f[CB]outertheme\f[B]\f[R]
2439beamer themes
2650beamer themes
@@ -2485,8 +2696,8 @@ header-includes: |
2487\f[B]\f[CB]classoption\f[B]\f[R]
2698\f[B]\f[CB]classoption\f[B]\f[R]
2488−option for document class, e.g.
2489−\f[C]oneside\f[R]; repeat for multiple options:
2699+option for document class, e.g.\ \f[C]oneside\f[R]; repeat for multiple
@@ -2507,8 +2718,8 @@ document class: usually one of the standard classes, \f[C]article\f[R],
2507default to smaller margins; or \f[C]memoir\f[R]
2718default to smaller margins; or \f[C]memoir\f[R]
2509\f[B]\f[CB]geometry\f[B]\f[R]
2720\f[B]\f[CB]geometry\f[B]\f[R]
2510−option for \f[C]geometry\f[R] package, e.g.
2721+option for \f[C]geometry\f[R] package, e.g.\ \f[C]margin=1in\f[R];
2511−\f[C]margin=1in\f[R]; repeat for multiple options:
2722+repeat for multiple options:
@@ -2524,8 +2735,8 @@ geometry:
2526\f[B]\f[CB]hyperrefoptions\f[B]\f[R]
2737\f[B]\f[CB]hyperrefoptions\f[B]\f[R]
2527−option for \f[C]hyperref\f[R] package, e.g.
2738+option for \f[C]hyperref\f[R] package, e.g.\ \f[C]linktoc=all\f[R];
2528−\f[C]linktoc=all\f[R]; repeat for multiple options:
2739+repeat for multiple options:
@@ -2541,12 +2752,13 @@ hyperrefoptions:
2543\f[B]\f[CB]indent\f[B]\f[R]
2754\f[B]\f[CB]indent\f[B]\f[R]
2544−uses document class settings for indentation (the default LaTeX template
2755+if true, pandoc will use document class settings for indentation (the
2545−otherwise removes indentation and adds space between paragraphs)
2756+default LaTeX template otherwise removes indentation and adds space
2547\f[B]\f[CB]linestretch\f[B]\f[R]
2759\f[B]\f[CB]linestretch\f[B]\f[R]
2548−adjusts line spacing using the \f[C]setspace\f[R] package, e.g.
2760+adjusts line spacing using the \f[C]setspace\f[R] package,
2549−\f[C]1.25\f[R], \f[C]1.5\f[R]
2761+e.g.\ \f[C]1.25\f[R], \f[C]1.5\f[R]
2551\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2763\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
2552sets margins if \f[C]geometry\f[R] is not used (otherwise
2764sets margins if \f[C]geometry\f[R] is not used (otherwise
@@ -2558,8 +2770,7 @@ control \f[C]\[rs]pagestyle{}\f[R]: the default article class supports
2558numbers), and \f[C]headings\f[R] (section titles in running heads)
2770numbers), and \f[C]headings\f[R] (section titles in running heads)
2560\f[B]\f[CB]papersize\f[B]\f[R]
2772\f[B]\f[CB]papersize\f[B]\f[R]
2562−\f[C]letter\f[R], \f[C]a4\f[R]
2773+paper size, e.g.\ \f[C]letter\f[R], \f[C]a4\f[R]
2564\f[B]\f[CB]secnumdepth\f[B]\f[R]
2775\f[B]\f[CB]secnumdepth\f[B]\f[R]
2565numbering depth for sections (with \f[C]--number-sections\f[R] option or
2776numbering depth for sections (with \f[C]--number-sections\f[R] option or
@@ -2684,35 +2895,32 @@ list of options for natbib
2684Pandoc uses these variables when creating a PDF with ConTeXt.
2895Pandoc uses these variables when creating a PDF with ConTeXt.
2686\f[B]\f[CB]fontsize\f[B]\f[R]
2897\f[B]\f[CB]fontsize\f[B]\f[R]
2687−font size for body text (e.g.
2898+font size for body text (e.g.\ \f[C]10pt\f[R], \f[C]12pt\f[R])
2688−\f[C]10pt\f[R], \f[C]12pt\f[R])
2690\f[B]\f[CB]headertext\f[B]\f[R], \f[B]\f[CB]footertext\f[B]\f[R]
2900\f[B]\f[CB]headertext\f[B]\f[R], \f[B]\f[CB]footertext\f[B]\f[R]
2691text to be placed in running header or footer (see ConTeXt Headers and
2901text to be placed in running header or footer (see ConTeXt Headers and
2692Footers); repeat up to four times for different placement
2902Footers); repeat up to four times for different placement
2694\f[B]\f[CB]indenting\f[B]\f[R]
2904\f[B]\f[CB]indenting\f[B]\f[R]
2695−controls indentation of paragraphs, e.g.
2905+controls indentation of paragraphs, e.g.\ \f[C]yes,small,next\f[R] (see
2696−\f[C]yes,small,next\f[R] (see ConTeXt Indentation); repeat for multiple
2906+ConTeXt Indentation); repeat for multiple options
2699\f[B]\f[CB]interlinespace\f[B]\f[R]
2908\f[B]\f[CB]interlinespace\f[B]\f[R]
2700−adjusts line spacing, e.g.
2909+adjusts line spacing, e.g.\ \f[C]4ex\f[R] (using
2701−\f[C]4ex\f[R] (using \f[C]setupinterlinespace\f[R]); repeat for multiple
2910+\f[C]setupinterlinespace\f[R]); repeat for multiple options
2704\f[B]\f[CB]layout\f[B]\f[R]
2912\f[B]\f[CB]layout\f[B]\f[R]
2705options for page margins and text arrangement (see ConTeXt Layout);
2913options for page margins and text arrangement (see ConTeXt Layout);
2706repeat for multiple options
2914repeat for multiple options
2708\f[B]\f[CB]linkcolor\f[B]\f[R], \f[B]\f[CB]contrastcolor\f[B]\f[R]
2916\f[B]\f[CB]linkcolor\f[B]\f[R], \f[B]\f[CB]contrastcolor\f[B]\f[R]
2709−color for links outside and inside a page, e.g.
2917+color for links outside and inside a page, e.g.\ \f[C]red\f[R],
2710−\f[C]red\f[R], \f[C]blue\f[R] (see ConTeXt Color)
2918+\f[C]blue\f[R] (see ConTeXt Color)
2712\f[B]\f[CB]linkstyle\f[B]\f[R]
2920\f[B]\f[CB]linkstyle\f[B]\f[R]
2713−typeface style for links, e.g.
2921+typeface style for links, e.g.\ \f[C]normal\f[R], \f[C]bold\f[R],
2714−\f[C]normal\f[R], \f[C]bold\f[R], \f[C]slanted\f[R],
2715−\f[C]boldslanted\f[R], \f[C]type\f[R], \f[C]cap\f[R], \f[C]small\f[R]
2922+\f[C]slanted\f[R], \f[C]boldslanted\f[R], \f[C]type\f[R], \f[C]cap\f[R],
2717\f[B]\f[CB]lof\f[B]\f[R], \f[B]\f[CB]lot\f[B]\f[R]
2925\f[B]\f[CB]lof\f[B]\f[R], \f[B]\f[CB]lot\f[B]\f[R]
2718include list of figures, list of tables
2926include list of figures, list of tables
@@ -2730,16 +2938,13 @@ page number style and location (using \f[C]setuppagenumbering\f[R]);
2730repeat for multiple options
2938repeat for multiple options
2732\f[B]\f[CB]papersize\f[B]\f[R]
2940\f[B]\f[CB]papersize\f[B]\f[R]
2734−\f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R] (see ConTeXt Paper
2941+paper size, e.g.\ \f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R]
2735−Setup); repeat for multiple options
2942+(see ConTeXt Paper Setup); repeat for multiple options
2737\f[B]\f[CB]pdfa\f[B]\f[R]
2944\f[B]\f[CB]pdfa\f[B]\f[R]
2738adds to the preamble the setup necessary to generate PDF/A of the type
2945adds to the preamble the setup necessary to generate PDF/A of the type
2740−\f[C]1a:2005\f[R], \f[C]2a\f[R].
2946+specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R].
2741−If no type is specified (i.e.
2742−the value is set to True, by e.g.
2947+If no type is specified (i.e.\ the value is set to True, by e.g.
2743\f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata
2948\f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata
2744block), \f[C]1b:2005\f[R] will be used as default, for reasons of
2949block), \f[C]1b:2005\f[R] will be used as default, for reasons of
2745backwards compatibility.
2950backwards compatibility.
@@ -2754,8 +2959,7 @@ See also ConTeXt PDFA for more details.
2755\f[B]\f[CB]pdfaiccprofile\f[B]\f[R]
2960\f[B]\f[CB]pdfaiccprofile\f[B]\f[R]
2756when used in conjunction with \f[C]pdfa\f[R], specifies the ICC profile
2961when used in conjunction with \f[C]pdfa\f[R], specifies the ICC profile
2757−to use in the PDF, e.g.
2962+to use in the PDF, e.g.\ \f[C]default.cmyk\f[R].
2758−\f[C]default.cmyk\f[R].
2759If left unspecified, \f[C]sRGB.icc\f[R] is used as default.
2963If left unspecified, \f[C]sRGB.icc\f[R] is used as default.
2760May be repeated to include multiple profiles.
2964May be repeated to include multiple profiles.
2761Note that the profiles have to be available on the system.
2965Note that the profiles have to be available on the system.
@@ -2763,17 +2967,17 @@ They can be obtained from ConTeXt ICC Profiles.
2764\f[B]\f[CB]pdfaintent\f[B]\f[R]
2968\f[B]\f[CB]pdfaintent\f[B]\f[R]
2765when used in conjunction with \f[C]pdfa\f[R], specifies the output
2969when used in conjunction with \f[C]pdfa\f[R], specifies the output
2766−intent for the colors, e.g.
2970+intent for the colors,
2767−\f[C]ISO coated v2 300\[rs]letterpercent\[rs]space (ECI)\f[R] If left
2971+e.g.\ \f[C]ISO coated v2 300\[rs]letterpercent\[rs]space (ECI)\f[R] If
2768−unspecified, \f[C]sRGB IEC61966-2.1\f[R] is used as default.
2972+left unspecified, \f[C]sRGB IEC61966-2.1\f[R] is used as default.
2770\f[B]\f[CB]toc\f[B]\f[R]
2974\f[B]\f[CB]toc\f[B]\f[R]
2771include table of contents (can also be set using
2975include table of contents (can also be set using
2772\f[C]--toc/--table-of-contents\f[R])
2976\f[C]--toc/--table-of-contents\f[R])
2774\f[B]\f[CB]whitespace\f[B]\f[R]
2978\f[B]\f[CB]whitespace\f[B]\f[R]
2775−spacing between paragraphs, e.g.
2979+spacing between paragraphs, e.g.\ \f[C]none\f[R], \f[C]small\f[R] (using
2776−\f[C]none\f[R], \f[C]small\f[R] (using \f[C]setupwhitespace\f[R])
2980+\f[C]setupwhitespace\f[R])
2778\f[B]\f[CB]includesource\f[B]\f[R]
2982\f[B]\f[CB]includesource\f[B]\f[R]
2779include all source documents as file attachments in the PDF file
2983include all source documents as file attachments in the PDF file
@@ -2811,20 +3015,16 @@ section number in man pages
2811.SS Variables for ms
3015.SS Variables for ms
2813\f[B]\f[CB]fontfamily\f[B]\f[R]
3017\f[B]\f[CB]fontfamily\f[B]\f[R]
2814−font family (e.g.
3018+font family (e.g.\ \f[C]T\f[R] or \f[C]P\f[R])
2815−\f[C]T\f[R] or \f[C]P\f[R])
2817\f[B]\f[CB]indent\f[B]\f[R]
3020\f[B]\f[CB]indent\f[B]\f[R]
2818−paragraph indent (e.g.
3021+paragraph indent (e.g.\ \f[C]2m\f[R])
2821\f[B]\f[CB]lineheight\f[B]\f[R]
3023\f[B]\f[CB]lineheight\f[B]\f[R]
2822−line height (e.g.
3024+line height (e.g.\ \f[C]12p\f[R])
2825\f[B]\f[CB]pointsize\f[B]\f[R]
3026\f[B]\f[CB]pointsize\f[B]\f[R]
2826−point size (e.g.
3027+point size (e.g.\ \f[C]10p\f[R])
2828.SS Variables set automatically
3028.SS Variables set automatically
2830Pandoc sets these variables automatically in response to options or
3030Pandoc sets these variables automatically in response to options or
@@ -2840,10 +3040,9 @@ in all HTML based formats (dzslides, epub, html, html4, html5, revealjs,
2840s5, slideous, slidy).
3040s5, slideous, slidy).
2841The recognized formats for \f[C]date\f[R] are: \f[C]mm/dd/yyyy\f[R],
3041The recognized formats for \f[C]date\f[R] are: \f[C]mm/dd/yyyy\f[R],
2842\f[C]mm/dd/yy\f[R], \f[C]yyyy-mm-dd\f[R] (ISO 8601),
3042\f[C]mm/dd/yy\f[R], \f[C]yyyy-mm-dd\f[R] (ISO 8601),
2843−\f[C]dd MM yyyy\f[R] (e.g.
2844−either \f[C]02 Apr 2018\f[R] or \f[C]02 April 2018\f[R]),
3043+\f[C]dd MM yyyy\f[R] (e.g.\ either \f[C]02 Apr 2018\f[R] or
2845−\f[C]MM dd, yyyy\f[R] (e.g.
3044+\f[C]02 April 2018\f[R]), \f[C]MM dd, yyyy\f[R]
2846−\f[C]Apr. 02, 2018\f[R] or
3045+(e.g.\ \f[C]Apr. 02, 2018\f[R] or
2847\f[C]April 02, 2018),\f[R]yyyy[mm[dd]]]\f[C](e.g.\f[R]20180402,
3046\f[C]April 02, 2018),\f[R]yyyy[mm[dd]]]\f[C](e.g.\f[R]20180402,
2848\f[C]201804\f[R] or \f[C]2018\f[R]).
3047\f[C]201804\f[R] or \f[C]2018\f[R]).
@@ -2860,7 +3059,7 @@ contents specified by \f[C]-A/--include-after-body\f[R] (may have
2860multiple values)
3059multiple values)
2862\f[B]\f[CB]meta-json\f[B]\f[R]
3061\f[B]\f[CB]meta-json\f[B]\f[R]
2863−JSON representation of all of the document\[aq]s metadata.
3062+JSON representation of all of the document\[cq]s metadata.
2864Field values are transformed to the selected output format.
3063Field values are transformed to the selected output format.
2866\f[B]\f[CB]numbersections\f[B]\f[R]
3065\f[B]\f[CB]numbersections\f[B]\f[R]
@@ -2888,8 +3087,7 @@ $endif$
2888Similarly, \f[C]outputfile\f[R] can be \f[C]-\f[R] if output goes to the
3087Similarly, \f[C]outputfile\f[R] can be \f[C]-\f[R] if output goes to the
2889terminal.
3088terminal.
2891−If you need absolute paths, use e.g.
3090+If you need absolute paths, use e.g.\ \f[C]$curdir$/$sourcefile$\f[R].
2892−\f[C]$curdir$/$sourcefile$\f[R].
2895\f[B]\f[CB]curdir\f[B]\f[R]
3093\f[B]\f[CB]curdir\f[B]\f[R]
@@ -2910,12 +3108,12 @@ An extension can be enabled by adding \f[C]+EXTENSION\f[R] to the format
2910name and disabled by adding \f[C]-EXTENSION\f[R].
3108name and disabled by adding \f[C]-EXTENSION\f[R].
2911For example, \f[C]--from markdown_strict+footnotes\f[R] is strict
3109For example, \f[C]--from markdown_strict+footnotes\f[R] is strict
2912Markdown with footnotes enabled, while
3110Markdown with footnotes enabled, while
2913−\f[C]--from markdown-footnotes-pipe_tables\f[R] is pandoc\[aq]s Markdown
3111+\f[C]--from markdown-footnotes-pipe_tables\f[R] is pandoc\[cq]s Markdown
2914without footnotes or pipe tables.
3112without footnotes or pipe tables.
2916The markdown reader and writer make by far the most use of extensions.
3114The markdown reader and writer make by far the most use of extensions.
2917Extensions only used by them are therefore covered in the section
3115Extensions only used by them are therefore covered in the section
2918−Pandoc\[aq]s Markdown below (See Markdown variants for
3116+Pandoc\[cq]s Markdown below (See Markdown variants for
2919\f[C]commonmark\f[R] and \f[C]gfm\f[R].) In the following, extensions
3117\f[C]commonmark\f[R] and \f[C]gfm\f[R].) In the following, extensions
2920that also work for other formats are covered.
3118that also work for other formats are covered.
@@ -2928,7 +3126,7 @@ Markdown cells in Jupyter notebooks (as do command-line options like
2928Interpret straight quotes as curly quotes, \f[C]---\f[R] as em-dashes,
3126Interpret straight quotes as curly quotes, \f[C]---\f[R] as em-dashes,
2929\f[C]--\f[R] as en-dashes, and \f[C]...\f[R] as ellipses.
3127\f[C]--\f[R] as en-dashes, and \f[C]...\f[R] as ellipses.
2930Nonbreaking spaces are inserted after certain abbreviations, such as
3128Nonbreaking spaces are inserted after certain abbreviations, such as
2931−\[dq]Mr.\[dq]
3129+\[lq]Mr.\[rq]
2933This extension can be enabled/disabled for the following formats:
3131This extension can be enabled/disabled for the following formats:
@@ -3078,7 +3276,7 @@ letters are omitted.
3078.SS Extension: \f[C]gfm_auto_identifiers\f[R]
3276.SS Extension: \f[C]gfm_auto_identifiers\f[R]
3080Changes the algorithm used by \f[C]auto_identifiers\f[R] to conform to
3278Changes the algorithm used by \f[C]auto_identifiers\f[R] to conform to
3081−GitHub\[aq]s method.
3279+GitHub\[cq]s method.
3082Spaces are converted to dashes (\f[C]-\f[R]), uppercase characters to
3280Spaces are converted to dashes (\f[C]-\f[R]), uppercase characters to
3083lowercase characters, and punctuation characters other than \f[C]-\f[R]
3281lowercase characters, and punctuation characters other than \f[C]-\f[R]
3084and \f[C]_\f[R] are removed.
3282and \f[C]_\f[R] are removed.
@@ -3088,32 +3286,29 @@ Emojis are replaced by their names.
3088The extensions \f[C]tex_math_dollars\f[R],
3286The extensions \f[C]tex_math_dollars\f[R],
3089\f[C]tex_math_single_backslash\f[R], and
3287\f[C]tex_math_single_backslash\f[R], and
3090\f[C]tex_math_double_backslash\f[R] are described in the section about
3288\f[C]tex_math_double_backslash\f[R] are described in the section about
3091−Pandoc\[aq]s Markdown.
3289+Pandoc\[cq]s Markdown.
3093However, they can also be used with HTML input.
3291However, they can also be used with HTML input.
3094This is handy for reading web pages formatted using MathJax, for
3292This is handy for reading web pages formatted using MathJax, for
3096.SS Raw HTML/TeX
3294.SS Raw HTML/TeX
3098−The following extensions (especially how they affect Markdown
3099−input/output) are also described in more detail in their respective
3296+The following extensions are described in more detail in their
3100−sections of Pandoc\[aq]s Markdown.
3297+respective sections of Pandoc\[cq]s Markdown:
3101−.SS Extension: \f[C]raw_html\f[R]
3298+.IP \[bu] 2
3103−When converting from HTML, parse elements to raw HTML which are not
3299+\f[C]raw_html\f[R] allows HTML elements which are not representable in
3104−representable in pandoc\[aq]s AST.
3300+pandoc\[cq]s AST to be parsed as raw HTML.
3105By default, this is disabled for HTML input.
3301By default, this is disabled for HTML input.
3106−.SS Extension: \f[C]raw_tex\f[R]
3302+.IP \[bu] 2
3108−Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
3303+\f[C]raw_tex\f[R] allows raw LaTeX, TeX, and ConTeXt to be included in a
3110This extension can be enabled/disabled for the following formats (in
3305This extension can be enabled/disabled for the following formats (in
3111addition to \f[C]markdown\f[R]):
3306addition to \f[C]markdown\f[R]):
3113input formats
3309input formats
3114−\f[C]latex\f[R], \f[C]org\f[R], \f[C]textile\f[R], \f[C]html\f[R]
3310+\f[C]latex\f[R], \f[C]textile\f[R], \f[C]html\f[R] (environments,
3115−(environments, \f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only),
3311+\f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only), \f[C]ipynb\f[R]
3118output formats
3313output formats
3119\f[C]textile\f[R], \f[C]commonmark\f[R]
3314\f[C]textile\f[R], \f[C]commonmark\f[R]
@@ -3124,26 +3319,22 @@ with mime type \f[C]text/html\f[R] in output cells.
3124Since the \f[C]ipynb\f[R] reader attempts to preserve the richest
3319Since the \f[C]ipynb\f[R] reader attempts to preserve the richest
3125possible outputs when several options are given, you will get best
3320possible outputs when several options are given, you will get best
3126results if you disable \f[C]raw_html\f[R] and \f[C]raw_tex\f[R] when
3321results if you disable \f[C]raw_html\f[R] and \f[C]raw_tex\f[R] when
3127−converting to formats like \f[C]docx\f[R] which don\[aq]t allow raw
3322+converting to formats like \f[C]docx\f[R] which don\[cq]t allow raw
3128\f[C]html\f[R] or \f[C]tex\f[R].
3323\f[C]html\f[R] or \f[C]tex\f[R].
3129−.SS Extension: \f[C]native_divs\f[R]
3324+.RE
3131−This extension is enabled by default for HTML input.
3326+\f[C]native_divs\f[R] causes HTML \f[C]div\f[R] elements to be parsed as
3132−This means that \f[C]div\f[R]s are parsed to pandoc native elements.
3327+native pandoc Div blocks.
3133−(Alternatively, you can parse them to raw HTML using
3328+If you want them to be parsed as raw HTML, use
3134−\f[C]-f html-native_divs+raw_html\f[R].)
3329+\f[C]-f html-native_divs+raw_html\f[R].
3136−When converting HTML to Markdown, for example, you may want to drop all
3331+\f[C]native_spans\f[R] causes HTML \f[C]span\f[R] elements to be parsed
3332+as native pandoc Span inlines.
3333+If you want them to be parsed as raw HTML, use
3334+\f[C]-f html-native_spans+raw_html\f[R].
3137−\f[C]div\f[R]s and \f[C]span\f[R]s:
3335+If you want to drop all \f[C]div\f[R]s and \f[C]span\f[R]s when
3138−.IP
3336+converting HTML to Markdown, you can use
3141−pandoc -f html-native_divs-native_spans -t markdown
3337+\f[C]pandoc -f html-native_divs-native_spans -t markdown\f[R].
3144−.SS Extension: \f[C]native_spans\f[R]
3146−Analogous to \f[C]native_divs\f[R] above.
3147.SS Literate Haskell support
3338.SS Literate Haskell support
3148.SS Extension: \f[C]literate_haskell\f[R]
3339.SS Extension: \f[C]literate_haskell\f[R]
@@ -3162,23 +3353,22 @@ the formats above, pandoc will treat the document as literate Haskell
3163This means that
3354This means that
3164.IP \[bu] 2
3355.IP \[bu] 2
3165−In Markdown input, \[dq]bird track\[dq] sections will be parsed as
3356+In Markdown input, \[lq]bird track\[rq] sections will be parsed as
3166Haskell code rather than block quotations.
3357Haskell code rather than block quotations.
3167Text between \f[C]\[rs]begin{code}\f[R] and \f[C]\[rs]end{code}\f[R]
3358Text between \f[C]\[rs]begin{code}\f[R] and \f[C]\[rs]end{code}\f[R]
3168will also be treated as Haskell code.
3359will also be treated as Haskell code.
3169−For ATX-style headings the character \[aq]=\[aq] will be used instead of
3360+For ATX-style headings the character `=' will be used instead of `#'.
3171.IP \[bu] 2
3361.IP \[bu] 2
3172In Markdown output, code blocks with classes \f[C]haskell\f[R] and
3362In Markdown output, code blocks with classes \f[C]haskell\f[R] and
3173\f[C]literate\f[R] will be rendered using bird tracks, and block
3363\f[C]literate\f[R] will be rendered using bird tracks, and block
3174quotations will be indented one space, so they will not be treated as
3364quotations will be indented one space, so they will not be treated as
3175Haskell code.
3365Haskell code.
3176In addition, headings will be rendered setext-style (with underlines)
3366In addition, headings will be rendered setext-style (with underlines)
3177−rather than ATX-style (with \[aq]#\[aq] characters).
3367+rather than ATX-style (with `#' characters).
3178−(This is because ghc treats \[aq]#\[aq] characters in column 1 as
3368+(This is because ghc treats `#' characters in column 1 as introducing
3179−introducing line numbers.)
3369+line numbers.)
3180.IP \[bu] 2
3370.IP \[bu] 2
3181−In restructured text input, \[dq]bird track\[dq] sections will be parsed
3371+In restructured text input, \[lq]bird track\[rq] sections will be parsed
3182as Haskell code.
3372as Haskell code.
3183.IP \[bu] 2
3373.IP \[bu] 2
3184In restructured text output, code blocks with class \f[C]haskell\f[R]
3374In restructured text output, code blocks with class \f[C]haskell\f[R]
@@ -3214,9 +3404,8 @@ writes HTML with the Haskell code in bird tracks, so it can be copied
3214and pasted as literate Haskell source.
3404and pasted as literate Haskell source.
3216Note that GHC expects the bird tracks in the first column, so indented
3406Note that GHC expects the bird tracks in the first column, so indented
3217−literate code blocks (e.g.
3218−inside an itemized environment) will not be picked up by the Haskell
3407+literate code blocks (e.g.\ inside an itemized environment) will not be
3219−compiler.
3408+picked up by the Haskell compiler.
3220.SS Other extensions
3409.SS Other extensions
3221.SS Extension: \f[C]empty_paragraphs\f[R]
3410.SS Extension: \f[C]empty_paragraphs\f[R]
@@ -3239,6 +3428,43 @@ This extension can be enabled/disabled for the following formats:
3240output formats
3429output formats
3241\f[C]odt\f[R], \f[C]opendocument\f[R]
3430\f[C]odt\f[R], \f[C]opendocument\f[R]
3431+.SS Extension: \f[C]xrefs_name\f[R]
3433+Links to headings, figures and tables inside the document are
3434+substituted with cross-references that will use the name or caption of
3435+the referenced item.
3436+The original link text is replaced once the generated document is
3438+This extension can be combined with \f[C]xrefs_number\f[R] in which case
3439+numbers will appear before the name.
3441+Text in cross-references is only made consistent with the referenced
3442+item once the document has been refreshed.
3444+This extension can be enabled/disabled for the following formats:
3447+\f[C]odt\f[R], \f[C]opendocument\f[R]
3448+.SS Extension: \f[C]xrefs_number\f[R]
3450+Links to headings, figures and tables inside the document are
3451+substituted with cross-references that will use the number of the
3453+The original link text is discarded.
3454+This extension can be combined with \f[C]xrefs_name\f[R] in which case
3455+the name or caption numbers will appear after the number.
3457+For the \f[C]xrefs_number\f[R] to be useful heading numbers must be
3458+enabled in the generated document, also table and figure captions must
3459+be enabled using for example the \f[C]native_numbering\f[R] extension.
3461+Numbers in cross-references are only visible in the final document once
3462+it has been refreshed.
3464+This extension can be enabled/disabled for the following formats:
3467+\f[C]odt\f[R], \f[C]opendocument\f[R]
3242.SS Extension: \f[C]styles\f[R]
3468.SS Extension: \f[C]styles\f[R]
3244When converting from docx, read all docx styles as divs (for paragraph
3470When converting from docx, read all docx styles as divs (for paragraph
@@ -3253,20 +3479,33 @@ input formats
3254In the \f[C]muse\f[R] input format, this enables Text::Amuse extensions
3480In the \f[C]muse\f[R] input format, this enables Text::Amuse extensions
3255to Emacs Muse markup.
3481to Emacs Muse markup.
3482+.SS Extension: \f[C]raw_markdown\f[R]
3484+In the \f[C]ipynb\f[R] input format, this causes Markdown cells to be
3485+included as raw Markdown blocks (allowing lossless round-tripping)
3486+rather than being parsed.
3487+Use this only when you are targeting \f[C]ipynb\f[R] or a markdown-based
3256.SS Extension: \f[C]citations\f[R]
3489.SS Extension: \f[C]citations\f[R]
3258−Some aspects of Pandoc\[aq]s Markdown citation syntax are also accepted
3491+Some aspects of Pandoc\[cq]s Markdown citation syntax are also accepted
3259in \f[C]org\f[R] input.
3492in \f[C]org\f[R] input.
3493+.SS Extension: \f[C]element_citations\f[R]
3495+In the \f[C]jats\f[R] output formats, this causes reference items to be
3496+replaced with \f[C]<element-citation>\f[R] elements.
3497+These elements are not influenced by CSL styles, but all information on
3498+the item is included in tags.
3260.SS Extension: \f[C]ntb\f[R]
3499.SS Extension: \f[C]ntb\f[R]
3262In the \f[C]context\f[R] output format this enables the use of Natural
3501In the \f[C]context\f[R] output format this enables the use of Natural
3263Tables (TABLE) instead of the default Extreme Tables (xtables).
3502Tables (TABLE) instead of the default Extreme Tables (xtables).
3264Natural tables allow more fine-grained global customization but come at
3503Natural tables allow more fine-grained global customization but come at
3265a performance penalty compared to extreme tables.
3504a performance penalty compared to extreme tables.
3266−.SH PANDOC\[aq]S MARKDOWN
3505+.SH PANDOC\[cq]S MARKDOWN
3268Pandoc understands an extended and slightly revised version of John
3507Pandoc understands an extended and slightly revised version of John
3269−Gruber\[aq]s Markdown syntax.
3508+Gruber\[cq]s Markdown syntax.
3270This document explains the syntax, noting differences from standard
3509This document explains the syntax, noting differences from standard
3271Markdown.
3510Markdown.
3272Except where noted, these differences can be suppressed by using the
3511Except where noted, these differences can be suppressed by using the
@@ -3283,15 +3522,15 @@ easy to read:
3285A Markdown-formatted document should be publishable as-is, as plain
3524A Markdown-formatted document should be publishable as-is, as plain
3286−text, without looking like it\[aq]s been marked up with tags or
3525+text, without looking like it\[cq]s been marked up with tags or
3287formatting instructions.
3526formatting instructions.
3288−-- John Gruber
3527+\[en] John Gruber
3291−This principle has guided pandoc\[aq]s decisions in finding syntax for
3530+This principle has guided pandoc\[cq]s decisions in finding syntax for
3292tables, footnotes, and other extensions.
3531tables, footnotes, and other extensions.
3294−There is, however, one respect in which pandoc\[aq]s aims are different
3533+There is, however, one respect in which pandoc\[cq]s aims are different
3295from the original aims of Markdown.
3534from the original aims of Markdown.
3296Whereas Markdown was originally designed with HTML generation in mind,
3535Whereas Markdown was originally designed with HTML generation in mind,
3297pandoc is designed for multiple output formats.
3536pandoc is designed for multiple output formats.
@@ -3316,7 +3555,7 @@ a hard line break, since trailing spaces in the cells are ignored.
3316There are two kinds of headings: Setext and ATX.
3555There are two kinds of headings: Setext and ATX.
3317.SS Setext-style headings
3556.SS Setext-style headings
3319−A setext-style heading is a line of text \[dq]underlined\[dq] with a row
3558+A setext-style heading is a line of text \[lq]underlined\[rq] with a row
3320of \f[C]=\f[R] signs (for a level-one heading) or \f[C]-\f[R] signs (for
3559of \f[C]=\f[R] signs (for a level-one heading) or \f[C]-\f[R] signs (for
3321a level-two heading):
3560a level-two heading):
@@ -3407,7 +3646,7 @@ My other heading {#foo}
3407(This syntax is compatible with PHP Markdown Extra.)
3646(This syntax is compatible with PHP Markdown Extra.)
3409Note that although this syntax allows assignment of classes and
3648Note that although this syntax allows assignment of classes and
3410−key/value attributes, writers generally don\[aq]t use all of this
3649+key/value attributes, writers generally don\[cq]t use all of this
3411information.
3650information.
3412Identifiers, classes, and key/value attributes are used in HTML and
3651Identifiers, classes, and key/value attributes are used in HTML and
3413HTML-based formats such as EPUB and slidy.
3652HTML-based formats such as EPUB and slidy.
@@ -3522,7 +3761,7 @@ indented more than three spaces.)
3525−A \[dq]lazy\[dq] form, which requires the \f[C]>\f[R] character only on
3764+A \[lq]lazy\[rq] form, which requires the \f[C]>\f[R] character only on
3526the first line of each block, is also allowed:
3765the first line of each block, is also allowed:
@@ -3740,6 +3979,9 @@ begin with a space.
3982+Inline formatting (such as emphasis) is allowed in the content, but not
3983+block-level formatting (such as block quotes or lists).
3743This syntax is borrowed from reStructuredText.
3985This syntax is borrowed from reStructuredText.
3744.SS Lists
3986.SS Lists
3745.SS Bullet lists
3987.SS Bullet lists
@@ -3757,8 +3999,8 @@ Here is a simple example:
3760−This will produce a \[dq]compact\[dq] list.
4002+This will produce a \[lq]compact\[rq] list.
3761−If you want a \[dq]loose\[dq] list, in which each item is formatted as a
4003+If you want a \[lq]loose\[rq] list, in which each item is formatted as a
3762paragraph, put spaces between the items:
4004paragraph, put spaces between the items:
@@ -3786,7 +4028,7 @@ List items look best if subsequent lines are flush with the first line
3789−But Markdown also allows a \[dq]lazy\[dq] format:
4031+But Markdown also allows a \[lq]lazy\[rq] format:
@@ -3849,7 +4091,7 @@ character after the list marker of the containing list item.
3851As noted above, Markdown allows you to write list items
4093As noted above, Markdown allows you to write list items
3852−\[dq]lazily,\[dq] instead of indenting continuation lines.
4094+\[lq]lazily,\[rq] instead of indenting continuation lines.
3853However, if there are multiple paragraphs or other blocks in a list
4095However, if there are multiple paragraphs or other blocks in a list
3854item, the first line of each must be indented.
4096item, the first line of each must be indented.
@@ -3903,8 +4145,8 @@ They must be separated from the text that follows by at least one space,
3903and, if the list marker is a capital letter with a period, by at least
4145and, if the list marker is a capital letter with a period, by at least
3904two spaces.
4146two spaces.
3906−The \f[C]fancy_lists\f[R] extension also allows \[aq]\f[C]#\f[R]\[aq] to
4148+The \f[C]fancy_lists\f[R] extension also allows `\f[C]#\f[R]' to be used
3907−be used as an ordered list marker in place of a numeral:
4149+as an ordered list marker in place of a numeral:
@@ -3997,7 +4239,7 @@ one or more block elements (paragraph, code block, list, etc.), each
3997indented four spaces or one tab stop.
4239indented four spaces or one tab stop.
3998The body of the definition (including the first line, aside from the
4240The body of the definition (including the first line, aside from the
3999colon or tilde) should be indented four spaces.
4241colon or tilde) should be indented four spaces.
4000−However, as with other Markdown lists, you can \[dq]lazily\[dq] omit
4242+However, as with other Markdown lists, you can \[lq]lazily\[rq] omit
4001indentation except at the beginning of a paragraph or other block
4243indentation except at the beginning of a paragraph or other block
@@ -4031,16 +4273,16 @@ Term 2
4033Note that space between items in a definition list is required.
4275Note that space between items in a definition list is required.
4034−(A variant that loosens this requirement, but disallows \[dq]lazy\[dq]
4276+(A variant that loosens this requirement, but disallows \[lq]lazy\[rq]
4035hard wrapping, can be activated with \f[C]compact_definition_lists\f[R]:
4277hard wrapping, can be activated with \f[C]compact_definition_lists\f[R]:
4036−see Non-pandoc extensions, below.)
4278+see Non-default extensions, below.)
4037.SS Numbered example lists
4279.SS Numbered example lists
4038.SS Extension: \f[C]example_lists\f[R]
4280.SS Extension: \f[C]example_lists\f[R]
4040The special list marker \f[C]\[at]\f[R] can be used for sequentially
4282The special list marker \f[C]\[at]\f[R] can be used for sequentially
4041numbered examples.
4283numbered examples.
4042−The first list item with a \f[C]\[at]\f[R] marker will be numbered
4284+The first list item with a \f[C]\[at]\f[R] marker will be numbered `1',
4043−\[aq]1\[aq], the next \[aq]2\[aq], and so on, throughout the document.
4285+the next `2', and so on, throughout the document.
4044The numbered examples need not occur in a single list; each new list
4286The numbered examples need not occur in a single list; each new list
4045using \f[C]\[at]\f[R] will take up where the last stopped.
4287using \f[C]\[at]\f[R] will take up where the last stopped.
4046So, for example:
4288So, for example:
@@ -4076,39 +4318,6 @@ That is, example lists always behave as if the \f[C]four_space_rule\f[R]
4076extension is set.
4318extension is set.
4077This is because example labels tend to be long, and indenting content to
4319This is because example labels tend to be long, and indenting content to
4078the first non-space character after the label would be awkward.
4320the first non-space character after the label would be awkward.
4079−.SS Compact and loose lists
4081−Pandoc behaves differently from \f[C]Markdown.pl\f[R] on some \[dq]edge
4082−cases\[dq] involving lists.
4083−Consider this source:
4097−Pandoc transforms this into a \[dq]compact list\[dq] (with no
4098−\f[C]<p>\f[R] tags around \[dq]First\[dq], \[dq]Second\[dq], or
4099−\[dq]Third\[dq]), while Markdown puts \f[C]<p>\f[R] tags around
4100−\[dq]Second\[dq] and \[dq]Third\[dq] (but not \[dq]First\[dq]), because
4101−of the blank space around \[dq]Third\[dq].
4102−Pandoc follows a simple rule: if the text is followed by a blank line,
4103−it is treated as a paragraph.
4104−Since \[dq]Second\[dq] is followed by a list, and not a blank line, it
4105−isn\[aq]t treated as a paragraph.
4106−The fact that the list is followed by a blank line is irrelevant.
4107−(Note: Pandoc works this way even when the \f[C]markdown_strict\f[R]
4108−format is specified.
4109−This behavior is consistent with the official Markdown syntax
4110−description, even though it is different from that of
4111−\f[C]Markdown.pl\f[R].)
4112.SS Ending a list
4321.SS Ending a list
4114What if you want to put an indented code block after a list?
4323What if you want to put an indented code block after a list?
@@ -4126,8 +4335,8 @@ Trouble! Here pandoc (like other Markdown implementations) will treat
4126\f[C]{ my code block }\f[R] as the second paragraph of item two, and not
4335\f[C]{ my code block }\f[R] as the second paragraph of item two, and not
4127as a code block.
4336as a code block.
4129−To \[dq]cut off\[dq] the list after item two, you can insert some
4338+To \[lq]cut off\[rq] the list after item two, you can insert some
4130−non-indented content, like an HTML comment, which won\[aq]t produce
4339+non-indented content, like an HTML comment, which won\[cq]t produce
4131visible output in any format:
4340visible output in any format:
@@ -4323,7 +4532,7 @@ can be omitted for a headerless table.
4323The cells of grid tables may contain arbitrary block elements (multiple
4532The cells of grid tables may contain arbitrary block elements (multiple
4324paragraphs, code blocks, lists, etc.).
4533paragraphs, code blocks, lists, etc.).
4325Cells that span multiple columns or rows are not supported.
4534Cells that span multiple columns or rows are not supported.
4326−Grid tables can be created easily using Emacs\[aq] table-mode
4535+Grid tables can be created easily using Emacs\[cq] table-mode
4327(\f[C]M-x table-insert\f[R]).
4536(\f[C]M-x table-insert\f[R]).
4329Alignments can be specified as with pipe tables, by putting colons at
4538Alignments can be specified as with pipe tables, by putting colons at
@@ -4396,7 +4605,7 @@ orange|3.09
4397The cells of pipe tables cannot contain block elements like paragraphs
4606The cells of pipe tables cannot contain block elements like paragraphs
4398and lists, and cannot span multiple lines.
4607and lists, and cannot span multiple lines.
4399−If a pipe table contains a row whose printable content is wider than the
4608+If a pipe table contains a row whose Markdown content is wider than the
4400column width (see \f[C]--columns\f[R]), then the table will take up the
4609column width (see \f[C]--columns\f[R]), then the table will take up the
4401full text width and the cell contents will wrap, with the relative cell
4610full text width and the cell contents will wrap, with the relative cell
4402widths determined by the number of dashes in the line separating the
4611widths determined by the number of dashes in the line separating the
@@ -4407,7 +4616,7 @@ lines are wider than column width, then cell contents will not be
4407wrapped, and the cells will be sized to their contents.
4616wrapped, and the cells will be sized to their contents.
4409Note: pandoc also recognizes pipe tables of the following form, as can
4618Note: pandoc also recognizes pipe tables of the following form, as can
4410−be produced by Emacs\[aq] orgtbl-mode:
4619+be produced by Emacs\[cq] orgtbl-mode:
@@ -4420,7 +4629,7 @@ be produced by Emacs\[aq] orgtbl-mode:
4421The difference is that \f[C]+\f[R] is used instead of \f[C]|\f[R].
4630The difference is that \f[C]+\f[R] is used instead of \f[C]|\f[R].
4422Other orgtbl features are not supported.
4631Other orgtbl features are not supported.
4423−In particular, to get non-default column alignment, you\[aq]ll need to
4632+In particular, to get non-default column alignment, you\[cq]ll need to
4424add colons as above.
4633add colons as above.
4425.SS Metadata blocks
4634.SS Metadata blocks
4426.SS Extension: \f[C]pandoc_title_block\f[R]
4635.SS Extension: \f[C]pandoc_title_block\f[R]
@@ -4446,7 +4655,11 @@ no author, you need a blank line:
4450% My title
4663% My title
4452% June 15, 2006
4665% June 15, 2006
@@ -4471,9 +4684,17 @@ So, all of the following are equivalent:
4472% Author One
4685% Author One
4473 Author Two
4686 Author Two
4475% Author One; Author Two
4692% Author One; Author Two
4477% Author One;
4698% Author One;
4478 Author Two
4699 Author Two
@@ -4486,13 +4707,13 @@ All three metadata fields may contain standard inline formatting
4487Title blocks will always be parsed, but they will affect the output only
4708Title blocks will always be parsed, but they will affect the output only
4488when the \f[C]--standalone\f[R] (\f[C]-s\f[R]) option is chosen.
4709when the \f[C]--standalone\f[R] (\f[C]-s\f[R]) option is chosen.
4489−In HTML output, titles will appear twice: once in the document head --
4710+In HTML output, titles will appear twice: once in the document head
4490−this is the title that will appear at the top of the window in a browser
4711+\[en] this is the title that will appear at the top of the window in a
4491−-- and once at the beginning of the document body.
4712+browser \[en] and once at the beginning of the document body.
4492The title in the document head can have an optional prefix attached
4713The title in the document head can have an optional prefix attached
4493(\f[C]--title-prefix\f[R] or \f[C]-T\f[R] option).
4714(\f[C]--title-prefix\f[R] or \f[C]-T\f[R] option).
4494The title in the body appears as an H1 element with class
4715The title in the body appears as an H1 element with class
4495−\[dq]title\[dq], so it can be suppressed or reformatted with CSS.
4716+\[lq]title\[rq], so it can be suppressed or reformatted with CSS.
4496If a title prefix is specified with \f[C]-T\f[R] and no title block
4717If a title prefix is specified with \f[C]-T\f[R] and no title block
4497appears in the document, the title prefix will be used by itself as the
4718appears in the document, the title prefix will be used by itself as the
4498HTML title.
4719HTML title.
@@ -4521,7 +4742,7 @@ will yield a man page with the title \f[C]PANDOC\f[R] and section 1.
4524−will also have \[dq]Pandoc User Manuals\[dq] in the footer.
4745+will also have \[lq]Pandoc User Manuals\[rq] in the footer.
@@ -4529,7 +4750,7 @@ will also have \[dq]Pandoc User Manuals\[dq] in the footer.
4532−will also have \[dq]Version 4.0\[dq] in the header.
4753+will also have \[lq]Version 4.0\[rq] in the header.
4533.SS Extension: \f[C]yaml_metadata_block\f[R]
4754.SS Extension: \f[C]yaml_metadata_block\f[R]
4535A YAML metadata block is a valid YAML object, delimited by a line of
4756A YAML metadata block is a valid YAML object, delimited by a line of
@@ -4575,7 +4796,9 @@ All of the metadata will appear in a single block at the beginning of
4575the document.
4796the document.
4577Note that YAML escaping rules must be followed.
4798Note that YAML escaping rules must be followed.
4578−Thus, for example, if a title contains a colon, it must be quoted.
4799+Thus, for example, if a title contains a colon, it must be quoted, and
4800+if it contains a backslash escape, then it must be ensured that it is
4801+not treated as a YAML escape sequence.
4579The pipe character (\f[C]|\f[R]) can be used to begin an indented block
4802The pipe character (\f[C]|\f[R]) can be used to begin an indented block
4580that will be interpreted literally, without need for escaping.
4803that will be interpreted literally, without need for escaping.
4581This form is necessary when the field contains blank lines or
4804This form is necessary when the field contains blank lines or
@@ -4597,6 +4820,13 @@ abstract: |
4823+The literal block after the \f[C]|\f[R] must be indented relative to the
4824+line containing the \f[C]|\f[R].
4825+If it is not, the YAML will be invalid and pandoc will not interpret it
4827+For an overview of the complex rules governing YAML, see the Wikipedia
4828+entry on YAML syntax.
4600Template variables will be set automatically from the metadata.
4830Template variables will be set automatically from the metadata.
4601Thus, for example, in writing HTML, the variable \f[C]abstract\f[R] will
4831Thus, for example, in writing HTML, the variable \f[C]abstract\f[R] will
4602be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[R]
4832be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[R]
@@ -4645,7 +4875,7 @@ $endfor$
4648−Raw content to include in the document\[aq]s header may be specified
4878+Raw content to include in the document\[cq]s header may be specified
4649using \f[C]header-includes\f[R]; however, it is important to mark up
4879using \f[C]header-includes\f[R]; however, it is important to mark up
4650this content as raw code for a particular output format, using the
4880this content as raw code for a particular output format, using the
4651\f[C]raw_attribute\f[R] extension), or it will be interpreted as
4881\f[C]raw_attribute\f[R] extension), or it will be interpreted as
@@ -4662,6 +4892,21 @@ header-includes:
4662 \[ga]\[ga]\[ga]
4892 \[ga]\[ga]\[ga]
4896+Note: the \f[C]yaml_metadata_block\f[R] extension works with
4897+\f[C]commonmark\f[R] as well as \f[C]markdown\f[R] (and it is enabled by
4898+default in \f[C]gfm\f[R] and \f[C]commonmark_x\f[R]).
4899+However, in these formats the following restrictions apply:
4901+The YAML metadata block must occur at the beginning of the document (and
4902+there can be only one).
4903+If multiple files are given as arguments to pandoc, only the first can
4904+be a YAML metadata block.
4906+The leaf nodes of the YAML structure are parsed in isolation from each
4907+other and from the rest of the document.
4908+So, for example, you can\[cq]t use a reference link in these contexts if
4909+the link definition is somewhere else in the document.
4665.SS Backslash escapes
4910.SS Backslash escapes
4666.SS Extension: \f[C]all_symbols_escapable\f[R]
4911.SS Extension: \f[C]all_symbols_escapable\f[R]
@@ -4692,7 +4937,7 @@ instead of
4695−This rule is easier to remember than standard Markdown\[aq]s rule, which
4940+This rule is easier to remember than standard Markdown\[cq]s rule, which
4696allows only the following characters to be backslash-escaped:
4941allows only the following characters to be backslash-escaped:
@@ -4705,15 +4950,18 @@ allows only the following characters to be backslash-escaped:
4705Markdown rule will be used.)
4950Markdown rule will be used.)
4707A backslash-escaped space is parsed as a nonbreaking space.
4952A backslash-escaped space is parsed as a nonbreaking space.
4708−It will appear in TeX output as \f[C]\[ti]\f[R] and in HTML and XML as
4953+In TeX output, it will appear as \f[C]\[ti]\f[R].
4709−\f[C]\[rs] \f[R] or \f[C]\[rs] \f[R].
4954+In HTML and XML output, it will appear as a literal unicode nonbreaking
4955+space character (note that it will thus actually look
4956+\[lq]invisible\[rq] in the generated HTML source; you can still use the
4957+\f[C]--ascii\f[R] command-line option to make it appear as an explicit
4711−A backslash-escaped newline (i.e.
4960+A backslash-escaped newline (i.e.\ a backslash occurring at the end of a
4712−a backslash occurring at the end of a line) is parsed as a hard line
4961+line) is parsed as a hard line break.
4714It will appear in TeX output as \f[C]\[rs]\[rs]\f[R] and in HTML as
4962It will appear in TeX output as \f[C]\[rs]\[rs]\f[R] and in HTML as
4715\f[C]<br />\f[R].
4963\f[C]<br />\f[R].
4716−This is a nice alternative to Markdown\[aq]s \[dq]invisible\[dq] way of
4964+This is a nice alternative to Markdown\[cq]s \[lq]invisible\[rq] way of
4717indicating hard line breaks using two trailing spaces on a line.
4965indicating hard line breaks using two trailing spaces on a line.
4719Backslash escapes do not work in verbatim contexts.
4967Backslash escapes do not work in verbatim contexts.
@@ -4790,8 +5038,8 @@ If the superscripted or subscripted text contains spaces, these spaces
4790must be escaped with backslashes.
5038must be escaped with backslashes.
4791(This is to prevent accidental superscripting and subscripting through
5039(This is to prevent accidental superscripting and subscripting through
4792the ordinary use of \f[C]\[ti]\f[R] and \f[C]\[ha]\f[R], and also bad
5040the ordinary use of \f[C]\[ti]\f[R] and \f[C]\[ha]\f[R], and also bad
4793−interactions with footnotes.) Thus, if you want the letter P with \[aq]a
5041+interactions with footnotes.) Thus, if you want the letter P with `a
4794−cat\[aq] in subscripts, use \f[C]P\[ti]a\[rs] cat\[ti]\f[R], not
5042+cat' in subscripts, use \f[C]P\[ti]a\[rs] cat\[ti]\f[R], not
4795\f[C]P\[ti]a cat\[ti]\f[R].
5043\f[C]P\[ti]a cat\[ti]\f[R].
4796.SS Verbatim
5044.SS Verbatim
@@ -4871,14 +5119,16 @@ The opening \f[C]$\f[R] must have a non-space character immediately to
4871its right, while the closing \f[C]$\f[R] must have a non-space character
5119its right, while the closing \f[C]$\f[R] must have a non-space character
4872immediately to its left, and must not be followed immediately by a
5120immediately to its left, and must not be followed immediately by a
4874−Thus, \f[C]$20,000 and $30,000\f[R] won\[aq]t parse as math.
5122+Thus, \f[C]$20,000 and $30,000\f[R] won\[cq]t parse as math.
4875If for some reason you need to enclose text in literal \f[C]$\f[R]
5123If for some reason you need to enclose text in literal \f[C]$\f[R]
4876−characters, backslash-escape them and they won\[aq]t be treated as math
5124+characters, backslash-escape them and they won\[cq]t be treated as math
4877delimiters.
5125delimiters.
4879For display math, use \f[C]$$\f[R] delimiters.
5127For display math, use \f[C]$$\f[R] delimiters.
4880(In this case, the delimiters may be separated from the formula by
5128(In this case, the delimiters may be separated from the formula by
4881−whitespace.)
5129+whitespace.
5130+However, there can be no blank lines betwen the opening and closing
5131+\f[C]$$\f[R] delimiters.)
4883TeX math will be printed in all output formats.
5133TeX math will be printed in all output formats.
4884How it is rendered depends on the output format:
5134How it is rendered depends on the output format:
@@ -4909,7 +5159,7 @@ Texinfo
4909It will be rendered inside a \f[C]\[at]math\f[R] command.
5159It will be rendered inside a \f[C]\[at]math\f[R] command.
4911roff man, Jira markup
5161roff man, Jira markup
4912−It will be rendered verbatim without \f[C]$\f[R]\[aq]s.
5162+It will be rendered verbatim without \f[C]$\f[R]\[cq]s.
4914MediaWiki, DokuWiki
5164MediaWiki, DokuWiki
4915It will be rendered inside \f[C]<math>\f[R] tags.
5165It will be rendered inside \f[C]<math>\f[R] tags.
@@ -4967,7 +5217,7 @@ Note that even if \f[C]raw_html\f[R] is disabled, tables will be
4967rendered with HTML syntax if they cannot use pipe syntax.
5217rendered with HTML syntax if they cannot use pipe syntax.
4968.SS Extension: \f[C]markdown_in_html_blocks\f[R]
5218.SS Extension: \f[C]markdown_in_html_blocks\f[R]
4970−Standard Markdown allows you to include HTML \[dq]blocks\[dq]: blocks of
5220+Standard Markdown allows you to include HTML \[lq]blocks\[rq]: blocks of
4971HTML between balanced tags that are separated from the surrounding text
5221HTML between balanced tags that are separated from the surrounding text
4972with blank lines, and start and end at the left margin.
5222with blank lines, and start and end at the left margin.
4973Within these blocks, everything is interpreted as HTML, not Markdown; so
5223Within these blocks, everything is interpreted as HTML, not Markdown; so
@@ -4983,7 +5233,7 @@ Thus, for example, pandoc will turn
4985<td>*one*</td>
5235<td>*one*</td>
4986−<td>[a link](http://google.com)</td>
5236+<td>[a link](https://google.com)</td>
@@ -4996,7 +5246,7 @@ into
4998<td><em>one</em></td>
5248<td><em>one</em></td>
4999−<td><a href=\[dq]http://google.com\[dq]>a link</a></td>
5249+<td><a href=\[dq]https://google.com\[dq]>a link</a></td>
@@ -5004,8 +5254,9 @@ into
5005whereas \f[C]Markdown.pl\f[R] will preserve it as is.
5255whereas \f[C]Markdown.pl\f[R] will preserve it as is.
5007−There is one exception to this rule: text between \f[C]<script>\f[R] and
5257+There is one exception to this rule: text between \f[C]<script>\f[R],
5008−\f[C]<style>\f[R] tags is not interpreted as Markdown.
5258+\f[C]<style>\f[R], and \f[C]<textarea>\f[R] tags is not interpreted as
5010This departure from standard Markdown should make it easier to mix
5261This departure from standard Markdown should make it easier to mix
5011Markdown with HTML block elements.
5262Markdown with HTML block elements.
@@ -5154,7 +5405,7 @@ a link:
5157−<http://google.com>
5408+<https://google.com>
5158<sam\[at]green.eggs.ham>
5409<sam\[at]green.eggs.ham>
@@ -5167,7 +5418,7 @@ the URL in parentheses.
5169This is an [inline link](/url), and here\[aq]s [one with
5420This is an [inline link](/url), and here\[aq]s [one with
5170−a title](http://fsf.org \[dq]click here for a good time!\[dq]).
5421+a title](https://fsf.org \[dq]click here for a good time!\[dq]).
@@ -5207,7 +5458,7 @@ Here are some examples:
5208[my label 1]: /foo/bar.html \[dq]My title, optional\[dq]
5459[my label 1]: /foo/bar.html \[dq]My title, optional\[dq]
5209[my label 2]: /foo
5460[my label 2]: /foo
5210−[my label 3]: http://fsf.org (The free software foundation)
5461+[my label 3]: https://fsf.org (The free software foundation)
5211[my label 4]: /bar#special \[aq]A title in single quotes\[aq]
5462[my label 4]: /bar#special \[aq]A title in single quotes\[aq]
@@ -5224,7 +5475,7 @@ The title may go on the next line:
5227−[my label 3]: http://fsf.org
5478+[my label 3]: https://fsf.org
5228 \[dq]The free software foundation\[dq]
5479 \[dq]The free software foundation\[dq]
@@ -5305,7 +5556,7 @@ slide shows and EPUB), LaTeX, and ConTeXt.
5306A link immediately preceded by a \f[C]!\f[R] will be treated as an
5557A link immediately preceded by a \f[C]!\f[R] will be treated as an
5308−The link text will be used as the image\[aq]s alt text:
5559+The link text will be used as the image\[cq]s alt text:
@@ -5320,7 +5571,7 @@ The link text will be used as the image\[aq]s alt text:
5321An image with nonempty alt text, occurring by itself in a paragraph,
5572An image with nonempty alt text, occurring by itself in a paragraph,
5322will be rendered as a figure with a caption.
5573will be rendered as a figure with a caption.
5323−The image\[aq]s alt text will be used as the caption.
5574+The image\[cq]s alt text will be used as the caption.
@@ -5329,9 +5580,8 @@ The image\[aq]s alt text will be used as the caption.
5331How this is rendered depends on the output format.
5582How this is rendered depends on the output format.
5332−Some output formats (e.g.
5333−RTF) do not yet support figures.
5583+Some output formats (e.g.\ RTF) do not yet support figures.
5334−In those formats, you\[aq]ll just get an image in a paragraph by itself,
5584+In those formats, you\[cq]ll just get an image in a paragraph by itself,
5335with no caption.
5585with no caption.
5337If you just want a regular inline image, just make sure it is not the
5587If you just want a regular inline image, just make sure it is not the
@@ -5386,11 +5636,12 @@ For example:
5388.IP \[bu] 2
5638.IP \[bu] 2
5389−Dimensions are converted to inches for output in page-based formats like
5639+Dimensions may be converted to a form that is compatible with the output
5390−LaTeX.
5640+format (for example, dimensions given in pixels will be converted to
5391−Dimensions are converted to pixels for output in HTML-like formats.
5641+inches when converting HTML to LaTeX).
5392−Use the \f[C]--dpi\f[R] option to specify the number of pixels per inch.
5642+Conversion between pixels and physical measurements is affected by the
5393−The default is 96dpi.
5643+\f[C]--dpi\f[R] option (by default, 96 dpi is assumed, unless the image
5644+itself contains dpi information).
5394.IP \[bu] 2
5645.IP \[bu] 2
5395The \f[C]%\f[R] unit is generally relative to some available space.
5646The \f[C]%\f[R] unit is generally relative to some available space.
5396For example the above example will render to the following.
5647For example the above example will render to the following.
@@ -5401,7 +5652,7 @@ HTML:
5401.IP \[bu] 2
5652.IP \[bu] 2
5403\f[C]\[rs]includegraphics[width=0.5\[rs]textwidth,height=\[rs]textheight]{file.jpg}\f[R]
5654\f[C]\[rs]includegraphics[width=0.5\[rs]textwidth,height=\[rs]textheight]{file.jpg}\f[R]
5404−(If you\[aq]re using a custom template, you need to configure
5655+(If you\[cq]re using a custom template, you need to configure
5405\f[C]graphicx\f[R] as in the default template.)
5656\f[C]graphicx\f[R] as in the default template.)
5406.IP \[bu] 2
5657.IP \[bu] 2
@@ -5484,7 +5735,7 @@ immediately by attributes:
5484.SS Footnotes
5735.SS Footnotes
5485.SS Extension: \f[C]footnotes\f[R]
5736.SS Extension: \f[C]footnotes\f[R]
5487−Pandoc\[aq]s Markdown allows footnotes, using the following syntax:
5738+Pandoc\[cq]s Markdown allows footnotes, using the following syntax:
@@ -5533,198 +5784,73 @@ note.]
5535Inline and regular footnotes may be mixed freely.
5786Inline and regular footnotes may be mixed freely.
5536−.SS Citations
5787+.SS Citation syntax
5537.SS Extension: \f[C]citations\f[R]
5788.SS Extension: \f[C]citations\f[R]
5539−Using an external filter, \f[C]pandoc-citeproc\f[R], pandoc can
5790+To cite a bibliographic item with an identifier foo, use the syntax
5540−automatically generate citations and a bibliography in a number of
5791+\f[C]\[at]foo\f[R].
5541−styles.
5792+Normal citations should be included in square brackets, with semicolons
5542−Basic usage is
5793+separating distinct items:
5546−pandoc --filter pandoc-citeproc myinput.txt
5797+Blah blah [\[at]doe99; \[at]smith2000; \[at]smith2004].
5550−In order to use this feature, you will need to specify a bibliography
5801+How this is rendered depends on the citation style.
5551−file using the \f[C]bibliography\f[R] metadata field in a YAML metadata
5802+In an author-date style, it might render as
5552−section, or \f[C]--bibliography\f[R] command line argument.
5803+.IP
5553−You can supply multiple \f[C]--bibliography\f[R] arguments or set
5804+.nf
5554−\f[C]bibliography\f[R] metadata field to YAML array, if you want to use
5805+\f[C]
5555−multiple bibliography files.
5806+Blah blah (Doe 1999, Smith 2000, 2004).
5556−The bibliography may have any of these formats:
5807+\f[R]
5558−.TS
5810+In a footnote style, it might render as
5562−Format
5814+Blah blah.[\[ha]1]
5564−File extension
5816+[\[ha]1]: John Doe, \[dq]Frogs,\[dq] *Journal of Amphibians* 44 (1999);
5565−T}
5817+Susan Smith, \[dq]Flies,\[dq] *Journal of Insects* (2000);
5566−_
5818+Susan Smith, \[dq]Bees,\[dq] *Journal of Insects* (2004).
5624−Note that \f[C].bib\f[R] can be used with both BibTeX and BibLaTeX
5822+See the CSL user documentation for more information about CSL styles and
5625−files; use \f[C].bibtex\f[R] to force BibTeX.
5823+how they affect rendering.
5627−Note that \f[C]pandoc-citeproc --bib2json\f[R] and
5825+Unless a citation key start with a letter, digit, or \f[C]_\f[R], and
5628−\f[C]pandoc-citeproc --bib2yaml\f[R] can produce \f[C].json\f[R] and
5826+contains only alphanumerics and internal punctuation characters
5629−\f[C].yaml\f[R] files from any of the supported formats.
5827+(\f[C]:.#$%&-+?<>\[ti]/\f[R]), it must be surrounded by curly braces,
5828+which are not considered part of the key.
5829+In \f[C]\[at]Foo_bar.baz.\f[R], the key is \f[C]Foo_bar.baz\f[R].
5830+The final period is not \f[I]internal\f[R] punctuation, so it is not
5831+included in the key.
5832+In \f[C]\[at]{Foo_bar.baz.}\f[R], the key is \f[C]Foo_bar.baz.\f[R],
5833+including the final period.
5834+The curly braces are recommended if you use URLs as keys:
5835+\f[C][\[at]{https://example.com/bib?name=foobar&date=2000}, p. 33]\f[R].
5631−In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc
5837+Citation items may optionally include a prefix, a locator, and a suffix.
5632−parses a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown;
5838+In
5633−and in CSL JSON databases, an HTML-like markup:
5635−\f[B]\f[CB]<i>...</i>\f[B]\f[R]
5638−\f[B]\f[CB]<b>...</b>\f[B]\f[R]
5641−\f[B]\f[CB]<span style=\[dq]font-variant:small-caps;\[dq]>...</span>\f[B]\f[R] or \f[B]\f[CB]<sc>...</sc>\f[B]\f[R]
5644−\f[B]\f[CB]<sub>...</sub>\f[B]\f[R]
5647−\f[B]\f[CB]<sup>...</sup>\f[B]\f[R]
5650−\f[B]\f[CB]<span class=\[dq]nocase\[dq]>...</span>\f[B]\f[R]
5651−prevent a phrase from being capitalized as title case
5653−\f[C]pandoc-citeproc -j\f[R] and \f[C]-y\f[R] interconvert the CSL JSON
5654−and CSL YAML formats as far as possible.
5656−As an alternative to specifying a bibliography file using
5657−\f[C]--bibliography\f[R] or the YAML metadata field
5658−\f[C]bibliography\f[R], you can include the citation data directly in
5659−the \f[C]references\f[R] field of the document\[aq]s YAML metadata.
5660−The field should contain an array of YAML-encoded references, for
5665−---
5842+Blah blah [see \[at]doe99, pp. 33-35 and *passim*; \[at]smith04, chap. 1].
5667−- type: article-journal
5668− id: WatsonCrick1953
5679− title: \[aq]Molecular structure of nucleic acids: a structure for deoxyribose
5681− title-short: Molecular structure of nucleic acids
5682− container-title: Nature
5686− DOI: 10.1038/171737a0
5687− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5693−(\f[C]pandoc-citeproc --bib2yaml\f[R] can produce these from a
5846+The first item (\f[C]doe99\f[R]) has prefix \f[C]see\f[R], locator
5694−bibliography file in one of the supported formats.)
5847+\f[C]pp. 33-35\f[R], and suffix \f[C]and *passim*\f[R].
5848+The second item (\f[C]smith04\f[R]) has locator \f[C]chap. 1\f[R] and no
5696−Citations and references can be formatted using any style supported by
5851+Pandoc uses some heuristics to separate the locator from the rest of the
5697−the Citation Style Language, listed in the Zotero Style Repository.
5852+subject.
5698−These files are specified using the \f[C]--csl\f[R] option or the
5699−\f[C]csl\f[R] metadata field.
5700−By default, \f[C]pandoc-citeproc\f[R] will use the Chicago Manual of
5701−Style author-date format.
5702−The CSL project provides further information on finding and editing
5705−To make your citations hyperlinks to the corresponding bibliography
5706−entries, add \f[C]link-citations: true\f[R] to your YAML metadata.
5708−Citations go inside square brackets and are separated by semicolons.
5709−Each citation must have a key, composed of \[aq]\[at]\[aq] + the
5710−citation identifier from the database, and may optionally have a prefix,
5711−a locator, and a suffix.
5712−The citation key must begin with a letter, digit, or \f[C]_\f[R], and
5713−may contain alphanumerics, \f[C]_\f[R], and internal punctuation
5714−characters (\f[C]:.#$%&-+?<>\[ti]/\f[R]).
5715−Here are some examples:
5719−Blah blah [see \[at]doe99, pp. 33-35; also \[at]smith04, chap. 1].
5721−Blah blah [\[at]doe99, pp. 33-35, 38-39 and *passim*].
5723−Blah blah [\[at]smith04; \[at]doe99].
5727−\f[C]pandoc-citeproc\f[R] detects locator terms in the CSL locale files.
5853+It is sensitive to the locator terms defined in the CSL locale files.
5728Either abbreviated or unabbreviated forms are accepted.
5854Either abbreviated or unabbreviated forms are accepted.
5729In the \f[C]en-US\f[R] locale, locator terms can be written in either
5855In the \f[C]en-US\f[R] locale, locator terms can be written in either
5730singular or plural forms, as \f[C]book\f[R],
5856singular or plural forms, as \f[C]book\f[R],
@@ -5744,17 +5870,17 @@ singular or plural forms, as \f[C]book\f[R],
5744\f[C]v.\f[R]/\f[C]vv.\f[R]; \f[C]volume\f[R],
5870\f[C]v.\f[R]/\f[C]vv.\f[R]; \f[C]volume\f[R],
5745\f[C]vol.\f[R]/\f[C]vols.\f[R]; \f[C]\[ps]\f[R]/\f[C]\[ps]\[ps]\f[R];
5871\f[C]vol.\f[R]/\f[C]vols.\f[R]; \f[C]\[ps]\f[R]/\f[C]\[ps]\[ps]\f[R];
5746\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R].
5872\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R].
5747−If no locator term is used, \[dq]page\[dq] is assumed.
5873+If no locator term is used, \[lq]page\[rq] is assumed.
5749−\f[C]pandoc-citeproc\f[R] will use heuristics to distinguish the locator
5875+In complex cases, you can force something to be treated as a locator by
5750−from the suffix.
5876+enclosing it in curly braces or prevent parsing the suffix as locator by
5751−In complex cases, the locator can be enclosed in curly braces (using
5877+prepending curly braces:
5752−\f[C]pandoc-citeproc\f[R] 0.15 and higher only):
5756[\[at]smith{ii, A, D-Z}, with a suffix]
5881[\[at]smith{ii, A, D-Z}, with a suffix]
5757[\[at]smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5882[\[at]smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5883+[\[at]smith{}, 99 years later]
@@ -5768,7 +5894,8 @@ Smith says blah [-\[at]smith04].
5771−You can also write an in-text citation, as follows:
5897+You can also write an author-in-text citation, by omitting the square
@@ -5778,84 +5905,96 @@ You can also write an in-text citation, as follows:
5781−If the style calls for a list of works cited, it will be placed in a div
5908+This will cause the author\[cq]s name to be rendered, followed by the
5782−with id \f[C]refs\f[R], if one exists:
5909+bibliographical details.
5783−.IP
5910+Use this form when you want to make the citation the subject of a
5791−Otherwise, it will be placed at the end of the document.
5913+When you are using a note style, it is usually better to let citeproc
5792−Generation of the bibliography can be suppressed by setting
5914+create the footnotes from citations rather than writing an explicit
5793−\f[C]suppress-bibliography: true\f[R] in the YAML metadata.
5915+note.
5916+If you do write an explicit note that contains a citation, note that
5917+normal citations will be put in parentheses, while author-in-text
5919+For this reason, it is sometimes preferable to use the author-in-text
5920+style inside notes when using a note style.
5921+.SS Non-default extensions
5795−If you wish the bibliography to have a section heading, you can set
5923+The following Markdown syntax extensions are not enabled by default in
5796−\f[C]reference-section-title\f[R] in the metadata, or put the heading at
5924+pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format
5797−the beginning of the div with id \f[C]refs\f[R] (if you are using it) or
5925+name, where \f[C]EXTENSION\f[R] is the name of the extension.
5798−at the end of your document:
5926+Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with
5799−.IP
5927+hard line breaks.
5800−.nf
5928+.SS Extension: \f[C]rebase_relative_paths\f[R]
5808−The bibliography will be inserted after this heading.
5930+Rewrite relative paths for Markdown links and images, depending on the
5809−Note that the \f[C]unnumbered\f[R] class will be added to this heading,
5931+path of the file containing the link or image link.
5810−so that the section will not be numbered.
5932+For each link or image, pandoc will compute the directory of the
5933+containing file, relative to the working directory, and prepend the
5934+resulting path to the link or image path.
5812−If you want to include items in the bibliography without actually citing
5936+The use of this extension is best understood by example.
5813−them in the body text, you can define a dummy \f[C]nocite\f[R] metadata
5937+Suppose you have a a subdirectory for each chapter of a book,
5814−field and put the citations there:
5938+\f[C]chap1\f[R], \f[C]chap2\f[R], \f[C]chap3\f[R].
5939+Each contains a file \f[C]text.md\f[R] and a number of images used in
5941+You would like to have \f[C]\f[R] in
5942+\f[C]chap1/text.md\f[R] refer to \f[C]chap1/spider.jpg\f[R] and
5943+\f[C]\f[R] in \f[C]chap2/text.md\f[R] refer to
5944+\f[C]chap2/spider.jpg\f[R].
5818−---
5949+pandoc chap*/*.md -f markdown+rebase_relative_paths
5820− \[at]item1, \[at]item2
5827−In this example, the document will contain a citation for
5953+Without this extension, you would have to use
5828−\f[C]item3\f[R] only, but the bibliography will contain entries for
5954+\f[C]\f[R] in \f[C]chap1/text.md\f[R] and
5829−\f[C]item1\f[R], \f[C]item2\f[R], and \f[C]item3\f[R].
5955+\f[C]\f[R] in \f[C]chap2/text.md\f[R].
5956+Links with relative paths will be rewritten in the same way as images.
5831−It is possible to create a bibliography with all the citations, whether
5958+Absolute paths and URLs are not changed.
5832−or not they appear in the document, by using a wildcard:
5959+Neither are empty paths or paths consisting entirely of a fragment,
5833−.IP
5960+e.g., \f[C]#foo\f[R].
5843−For LaTeX output, you can also use \f[C]natbib\f[R] or
5962+Note that relative paths in reference links and images will be rewritten
5844−\f[C]biblatex\f[R] to render the bibliography.
5963+relative to the file containing the link reference definition, not the
5845−In order to do so, specify bibliography files as outlined above, and add
5964+file containing the reference link or image itself, if these differ.
5846−\f[C]--natbib\f[R] or \f[C]--biblatex\f[R] argument to \f[C]pandoc\f[R]
5965+.SS Extension: \f[C]attributes\f[R]
5848−Bear in mind that bibliography files have to be in respective format
5849−(either BibTeX or BibLaTeX).
5851−For more information, see the pandoc-citeproc man page.
5967+Allows attributes to be attached to any inline or block-level element.
5852−.SS Non-pandoc extensions
5968+The syntax for the attributes is the same as that used in
5969+\f[C]header_attributes\f[R].
5971+Attributes that occur immediately after an inline element affect that
5973+If they follow a space, then they belong to the space.
5974+(Hence, this option subsumes \f[C]inline_code_attributes\f[R] and
5975+\f[C]link_attributes\f[R].)
5977+Attributes that occur immediately before a block element, on a line by
5978+themselves, affect that element.
5980+Consecutive attribute specifiers may be used, either for blocks or for
5982+Their attributes will be combined.
5984+Attributes that occur at the end of the text of a Setext or ATX heading
5985+(separated by whitespace from the text) affect the heading element.
5986+(Hence, this option subsumes \f[C]header_attributes\f[R].)
5988+Attributes that occur after the opening fence in a fenced code block
5989+affect the code block element.
5990+(Hence, this option subsumes \f[C]fenced_code_attributes\f[R].)
5992+Attributes that occur at the end of a reference link definition affect
5993+links that refer to that definition.
5854−The following Markdown syntax extensions are not enabled by default in
5995+Note that pandoc\[cq]s AST does not currently allow attributes to be
5855−pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format
5996+attached to arbitrary elements.
5856−name, where \f[C]EXTENSION\f[R] is the name of the extension.
5997+Hence a Span or Div container will be added if needed.
5857−Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with
5859.SS Extension: \f[C]old_dashes\f[R]
5998.SS Extension: \f[C]old_dashes\f[R]
5861Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
6000Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -5867,7 +6006,7 @@ It is selected automatically for \f[C]textile\f[R] input.
5868Allow \f[C]<\f[R] and \f[C]>\f[R] to be backslash-escaped, as they can
6007Allow \f[C]<\f[R] and \f[C]>\f[R] to be backslash-escaped, as they can
5869be in GitHub flavored Markdown but not original Markdown.
6008be in GitHub flavored Markdown but not original Markdown.
5870−This is implied by pandoc\[aq]s default \f[C]all_symbols_escapable\f[R].
6009+This is implied by pandoc\[cq]s default \f[C]all_symbols_escapable\f[R].
5871.SS Extension: \f[C]lists_without_preceding_blankline\f[R]
6010.SS Extension: \f[C]lists_without_preceding_blankline\f[R]
5873Allow a list to occur right after a paragraph, with no intervening blank
6012Allow a list to occur right after a paragraph, with no intervening blank
@@ -5973,7 +6112,7 @@ extension.
5974This is a reference ![image][ref] with multimarkdown attributes.
6113This is a reference ![image][ref] with multimarkdown attributes.
5976−[ref]: http://path.to/image \[dq]Image title\[dq] width=20px height=30px
6115+[ref]: https://path.to/image \[dq]Image title\[dq] width=20px height=30px
5977 id=myId class=\[dq]myClass1 myClass2\[dq]
6116 id=myId class=\[dq]myClass1 myClass2\[dq]
@@ -5991,7 +6130,7 @@ in several respects:
5991No blank line is required between consecutive items of the definition
6130No blank line is required between consecutive items of the definition
5993.IP \[bu] 2
6132.IP \[bu] 2
5994−To get a \[dq]tight\[dq] or \[dq]compact\[dq] list, omit space between
6133+To get a \[lq]tight\[rq] or \[lq]compact\[rq] list, omit space between
5995consecutive items; the space between a term and its definition does not
6134consecutive items; the space between a term and its definition does not
5996affect anything.
6135affect anything.
5997.IP \[bu] 2
6136.IP \[bu] 2
@@ -6002,64 +6141,489 @@ be indented four spaces.
6002Use Project Gutenberg conventions for \f[C]plain\f[R] output: all-caps
6141Use Project Gutenberg conventions for \f[C]plain\f[R] output: all-caps
6003for strong emphasis, surround by underscores for regular emphasis, add
6142for strong emphasis, surround by underscores for regular emphasis, add
6004extra blank space around headings.
6143extra blank space around headings.
6144+.SS Extension: \f[C]sourcepos\f[R]
6146+Include source position attributes when parsing \f[C]commonmark\f[R].
6147+For elements that accept attributes, a \f[C]data-pos\f[R] attribute is
6148+added; other elements are placed in a surrounding Div or Span elemnet
6149+with a \f[C]data-pos\f[R] attribute.
6005.SS Markdown variants
6150.SS Markdown variants
6007−In addition to pandoc\[aq]s extended Markdown, the following Markdown
6152+In addition to pandoc\[cq]s extended Markdown, the following Markdown
6008variants are supported:
6153variants are supported:
6155+\f[C]markdown_phpextra\f[R] (PHP Markdown Extra)
6157+\f[C]markdown_github\f[R] (deprecated GitHub-Flavored Markdown)
6159+\f[C]markdown_mmd\f[R] (MultiMarkdown)
6161+\f[C]markdown_strict\f[R] (Markdown.pl)
6163+\f[C]commonmark\f[R] (CommonMark)
6165+\f[C]gfm\f[R] (Github-Flavored Markdown)
6167+\f[C]commonmark_x\f[R] (CommonMark with many pandoc extensions)
6169+To see which extensions are supported for a given format, and which are
6170+enabled by default, you can use the command
6174+pandoc --list-extensions=FORMAT
6178+where \f[C]FORMAT\f[R] is replaced with the name of the format.
6180+Note that the list of extensions for \f[C]commonmark\f[R],
6181+\f[C]gfm\f[R], and \f[C]commonmark_x\f[R] are defined relative to
6183+So, for example, \f[C]backtick_code_blocks\f[R] does not appear as an
6184+extension, since it is enabled by default and cannot be disabled.
6187+When the \f[C]--citeproc\f[R] option is used, pandoc can automatically
6188+generate citations and a bibliography in a number of styles.
6193+pandoc --citeproc myinput.txt
6197+To use this feature, you will need to have
6199+a document containing citations (see Extension: \f[C]citations\f[R]);
6201+a source of bibliographic data: either an external bibliography file or
6202+a list of \f[C]references\f[R] in the document\[cq]s YAML metadata
6204+optionally, a CSL citation style.
6205+.SS Specifying bibliographic data
6207+You can specify an external bibliography using the
6208+\f[C]bibliography\f[R] metadata field in a YAML metadata section or the
6209+\f[C]--bibliography\f[R] command line argument.
6210+If you want to use multiple bibliography files, you can supply multiple
6211+\f[C]--bibliography\f[R] arguments or set \f[C]bibliography\f[R]
6212+metadata field to YAML array.
6213+A bibliography may have any of these formats:
6246+Note that \f[C].bib\f[R] can be used with both BibTeX and BibLaTeX
6247+files; use the extension \f[C].bibtex\f[R] to force interpretation as
6250+In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup inside
6251+fields such as \f[C]title\f[R]; in CSL YAML databases, pandoc Markdown;
6252+and in CSL JSON databases, an HTML-like markup:
6254+\f[B]\f[CB]<i>...</i>\f[B]\f[R]
6257+\f[B]\f[CB]<b>...</b>\f[B]\f[R]
6260+\f[B]\f[CB]<span style=\[dq]font-variant:small-caps;\[dq]>...</span>\f[B]\f[R] or \f[B]\f[CB]<sc>...</sc>\f[B]\f[R]
6263+\f[B]\f[CB]<sub>...</sub>\f[B]\f[R]
6266+\f[B]\f[CB]<sup>...</sup>\f[B]\f[R]
6269+\f[B]\f[CB]<span class=\[dq]nocase\[dq]>...</span>\f[B]\f[R]
6270+prevent a phrase from being capitalized as title case
6272+As an alternative to specifying a bibliography file using
6273+\f[C]--bibliography\f[R] or the YAML metadata field
6274+\f[C]bibliography\f[R], you can include the citation data directly in
6275+the \f[C]references\f[R] field of the document\[cq]s YAML metadata.
6276+The field should contain an array of YAML-encoded references, for
6283+- type: article-journal
6284+ id: WatsonCrick1953
6295+ title: \[aq]Molecular structure of nucleic acids: a structure for
6296+ deoxyribose nucleic acid\[aq]
6297+ title-short: Molecular structure of nucleic acids
6298+ container-title: Nature
6302+ DOI: 10.1038/171737a0
6303+ URL: https://www.nature.com/articles/171737a0
6309+If both an external bibliography and inline (YAML metadata) references
6310+are provided, both will be used.
6311+In case of conflicting \f[C]id\f[R]s, the inline references will take
6314+Note that \f[C]pandoc\f[R] can be used to produce such a YAML metadata
6315+section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
6319+pandoc chem.bib -s -f biblatex -t markdown
6320+pandoc chem.json -s -f csljson -t markdown
6324+Indeed, \f[C]pandoc\f[R] can convert between any of these citation
6329+pandoc chem.bib -s -f biblatex -t csljson
6330+pandoc chem.yaml -s -f markdown -t biblatex
6334+Running pandoc on a bibliography file with the \f[C]--citeproc\f[R]
6335+option will create a formatted bibliography in the format of your
6340+pandoc chem.bib -s --citeproc -o chem.html
6341+pandoc chem.bib -s --citeproc -o chem.pdf
6344+.SS Capitalization in titles
6346+If you are using a bibtex or biblatex bibliography, then observe the
6349+English titles should be in title case.
6350+Non-English titles should be in sentence case, and the \f[C]langid\f[R]
6351+field in biblatex should be set to the relevant language.
6352+(The following values are treated as English: \f[C]american\f[R],
6353+\f[C]british\f[R], \f[C]canadian\f[R], \f[C]english\f[R],
6354+\f[C]australian\f[R], \f[C]newzealand\f[R], \f[C]USenglish\f[R], or
6355+\f[C]UKenglish\f[R].)
6357+As is standard with bibtex/biblatex, proper names should be protected
6358+with curly braces so that they won\[cq]t be lowercased in styles that
6359+call for sentence case.
6365+title = {My Dinner with {Andre}}
6370+In addition, words that should remain lowercase (or camelCase) should be
6376+title = {Spin Wave Dispersion on the {nm} Scale}
6380+Though this is not necessary in bibtex/biblatex, it is necessary with
6381+citeproc, which stores titles internally in sentence case, and converts
6382+to title case in styles that require it.
6383+Here we protect \[lq]nm\[rq] so that it doesn\[cq]t get converted to
6384+\[lq]Nm\[rq] at this stage.
6387+If you are using a CSL bibliography (either JSON or YAML), then observe
6388+the following rules:
6390+All titles should be in sentence case.
6392+Use the \f[C]language\f[R] field for non-English titles to prevent their
6393+conversion to title case in styles that call for this.
6394+(Conversion happens only if \f[C]language\f[R] begins with \f[C]en\f[R]
6397+Protect words that should not be converted to title case using this
6403+Spin wave dispersion on the <span class=\[dq]nocase\[dq]>nm</span> scale
6407+.SS Conference Papers, Published vs.\ Unpublished
6409+For a formally published conference paper, use the biblatex entry type
6410+\f[C]inproceedings\f[R] (which will be mapped to CSL
6411+\f[C]paper-conference\f[R]).
6413+For an unpublished manuscript, use the biblatex entry type
6414+\f[C]unpublished\f[R] without an \f[C]eventtitle\f[R] field (this entry
6415+type will be mapped to CSL \f[C]manuscript\f[R]).
6417+For a talk, an unpublished conference paper, or a poster presentation,
6418+use the biblatex entry type \f[C]unpublished\f[R] with an
6419+\f[C]eventtitle\f[R] field (this entry type will be mapped to CSL
6421+Use the biblatex \f[C]type\f[R] field to indicate the type,
6422+e.g.\ \[lq]Paper\[rq], or \[lq]Poster\[rq].
6423+\f[C]venue\f[R] and \f[C]eventdate\f[R] may be useful too, though
6424+\f[C]eventdate\f[R] will not be rendered by most CSL styles.
6425+Note that \f[C]venue\f[R] is for the event\[cq]s venue, unlike
6426+\f[C]location\f[R] which describes the publisher\[cq]s location; do not
6427+use the latter for an unpublished conference paper.
6428+.SS Specifying a citation style
6430+Citations and references can be formatted using any style supported by
6431+the Citation Style Language, listed in the Zotero Style Repository.
6432+These files are specified using the \f[C]--csl\f[R] option or the
6433+\f[C]csl\f[R] (or \f[C]citation-style\f[R]) metadata field.
6434+By default, pandoc will use the Chicago Manual of Style author-date
6436+(You can override this default by copying a CSL style of your choice to
6437+\f[C]default.csl\f[R] in your user data directory.) The CSL project
6438+provides further information on finding and editing styles.
6440+The \f[C]--citation-abbreviations\f[R] option (or the
6441+\f[C]citation-abbreviations\f[R] metadata field) may be used to specify
6442+a JSON file containing abbreviations of journals that should be used in
6443+formatted bibliographies when \f[C]form=\[dq]short\[dq]\f[R] is
6445+The format of the file can be illustrated with an example:
6449+{ \[dq]default\[dq]: {
6450+ \[dq]container-title\[dq]: {
6451+ \[dq]Lloyd\[aq]s Law Reports\[dq]: \[dq]Lloyd\[aq]s Rep\[dq],
6452+ \[dq]Estates Gazette\[dq]: \[dq]EG\[dq],
6453+ \[dq]Scots Law Times\[dq]: \[dq]SLT\[dq]
6459+.SS Citations in note styles
6461+Pandoc\[cq]s citation processing is designed to allow you to move
6462+between author-date, numerical, and note styles without modifying the
6464+When you\[cq]re using a note style, avoid inserting footnotes manually.
6465+Instead, insert citations just as you would in an author-date
6466+style\[em]for example,
6470+Blah blah [\[at]foo, p. 33].
6474+The footnote will be created automatically.
6475+Pandoc will take care of removing the space and moving the note before
6476+or after the period, depending on the setting of
6477+\f[C]notes-after-punctuation\f[R], as described below in Other relevant
6480+In some cases you may need to put a citation inside a regular footnote.
6481+Normal citations in footnotes (such as \f[C][\[at]foo, p. 33]\f[R]) will
6482+be rendered in parentheses.
6483+In-text citations (such as \f[C]\[at]foo [p. 33]\f[R]) will be rendered
6484+without parentheses.
6485+(A comma will be added if appropriate.) Thus:
6489+[\[ha]1]: Some studies [\[at]foo; \[at]bar, p. 33] show that
6490+frubulicious zoosnaps are quantical. For a survey
6491+of the literature, see \[at]baz [chap. 1].
6494+.SS Raw content in a style
6496+To include raw content in a prefix, suffix, delimiter, or term, surround
6497+it with these tags indicating the format:
6501+{{jats}}<ref>{{/jats}}
6505+Without the tags, the string will be interpreted as a string and escaped
6506+in the output, rather than being passed through raw.
6508+This feature allows stylesheets to be customized to give different
6509+output for different output formats.
6510+However, stylesheets customized in this way will not be usable by other
6511+CSL implementations.
6512+.SS Placement of the bibliography
6514+If the style calls for a list of works cited, it will be placed in a div
6515+with id \f[C]refs\f[R], if one exists:
6524+Otherwise, it will be placed at the end of the document.
6525+Generation of the bibliography can be suppressed by setting
6526+\f[C]suppress-bibliography: true\f[R] in the YAML metadata.
6528+If you wish the bibliography to have a section heading, you can set
6529+\f[C]reference-section-title\f[R] in the metadata, or put the heading at
6530+the beginning of the div with id \f[C]refs\f[R] (if you are using it) or
6531+at the end of your document:
6541+The bibliography will be inserted after this heading.
6542+Note that the \f[C]unnumbered\f[R] class will be added to this heading,
6543+so that the section will not be numbered.
6544+.SS Including uncited items in the bibliography
6546+If you want to include items in the bibliography without actually citing
6547+them in the body text, you can define a dummy \f[C]nocite\f[R] metadata
6548+field and put the citations there:
6554+ \[at]item1, \[at]item2
6561+In this example, the document will contain a citation for
6562+\f[C]item3\f[R] only, but the bibliography will contain entries for
6563+\f[C]item1\f[R], \f[C]item2\f[R], and \f[C]item3\f[R].
6565+It is possible to create a bibliography with all the citations, whether
6566+or not they appear in the document, by using a wildcard:
6577+For LaTeX output, you can also use \f[C]natbib\f[R] or
6578+\f[C]biblatex\f[R] to render the bibliography.
6579+In order to do so, specify bibliography files as outlined above, and add
6580+\f[C]--natbib\f[R] or \f[C]--biblatex\f[R] argument to \f[C]pandoc\f[R]
6582+Bear in mind that bibliography files have to be in either BibTeX (for
6583+\f[C]--natbib\f[R]) or BibLaTeX (for \f[C]--biblatex\f[R]) format.
6584+.SS Other relevant metadata fields
6586+A few other metadata fields affect bibliography formatting:
6588+\f[B]\f[CB]link-citations\f[B]\f[R]
6589+If true, citations will be hyperlinked to the corresponding bibliography
6590+entries (for author-date and numerical styles only).
6592+\f[B]\f[CB]lang\f[B]\f[R]
6593+The \f[C]lang\f[R] field will affect how the style is localized, for
6594+example in the translation of labels, the use of quotation marks, and
6595+the way items are sorted.
6596+(For backwards compatibility, \f[C]locale\f[R] may be used instead of
6597+\f[C]lang\f[R], but this use is deprecated.)
6600+A BCP 47 language tag is expected: for example, \f[C]en\f[R],
6601+\f[C]de\f[R], \f[C]en-US\f[R], \f[C]fr-CA\f[R], \f[C]ug-Cyrl\f[R].
6602+The unicode extension syntax (after \f[C]-u-\f[R]) may be used to
6603+specify options for collation (sorting) more precisely.
6604+Here are some examples:
6606+\f[C]zh-u-co-pinyin\f[R] \[en] Chinese with the Pinyin collation.
6608+\f[C]es-u-co-trad\f[R] \[en] Spanish with the traditional collation
6609+(with \f[C]Ch\f[R] sorting after \f[C]C\f[R]).
6611+\f[C]fr-u-kb\f[R] \[en] French with \[lq]backwards\[rq] accent sorting
6612+(with \f[C]cot\['e]\f[R] sorting after \f[C]c\[^o]te\f[R]).
6614+\f[C]en-US-u-kf-upper\f[R] \[en] English with uppercase letters sorting
6615+before lower (default is lower before upper).
6010−\f[B]\f[CB]markdown_phpextra\f[B]\f[R] (PHP Markdown Extra)
6618+\f[B]\f[CB]notes-after-punctuation\f[B]\f[R]
6011−\f[C]footnotes\f[R], \f[C]pipe_tables\f[R], \f[C]raw_html\f[R],
6619+If true (the default), pandoc will put footnote citations after
6012−\f[C]markdown_attribute\f[R], \f[C]fenced_code_blocks\f[R],
6620+following punctuation.
6013−\f[C]definition_lists\f[R], \f[C]intraword_underscores\f[R],
6621+For example, if the source contains \f[C]blah blah [\[at]jones99].\f[R],
6014−\f[C]header_attributes\f[R], \f[C]link_attributes\f[R],
6622+the result will look like \f[C]blah blah.[\[ha]1]\f[R], with the note
6015−\f[C]abbreviations\f[R], \f[C]shortcut_reference_links\f[R],
6623+moved after the period and the space collapsed.
6016−\f[C]spaced_reference_links\f[R].
6624+If false, the space will still be collapsed, but the footnote will not
6017−.TP
6625+be moved after the punctuation.
6018−\f[B]\f[CB]markdown_github\f[B]\f[R] (deprecated GitHub-Flavored Markdown)
6019−\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]fenced_code_blocks\f[R],
6020−\f[C]auto_identifiers\f[R], \f[C]gfm_auto_identifiers\f[R],
6021−\f[C]backtick_code_blocks\f[R], \f[C]autolink_bare_uris\f[R],
6022−\f[C]space_in_atx_header\f[R], \f[C]intraword_underscores\f[R],
6023−\f[C]strikeout\f[R], \f[C]task_lists\f[R], \f[C]emoji\f[R],
6024−\f[C]shortcut_reference_links\f[R], \f[C]angle_brackets_escapable\f[R],
6025−\f[C]lists_without_preceding_blankline\f[R].
6027−\f[B]\f[CB]markdown_mmd\f[B]\f[R] (MultiMarkdown)
6028−\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]markdown_attribute\f[R],
6029−\f[C]mmd_link_attributes\f[R], \f[C]tex_math_double_backslash\f[R],
6030−\f[C]intraword_underscores\f[R], \f[C]mmd_title_block\f[R],
6031−\f[C]footnotes\f[R], \f[C]definition_lists\f[R],
6032−\f[C]all_symbols_escapable\f[R], \f[C]implicit_header_references\f[R],
6033−\f[C]auto_identifiers\f[R], \f[C]mmd_header_identifiers\f[R],
6034−\f[C]shortcut_reference_links\f[R], \f[C]implicit_figures\f[R],
6035−\f[C]superscript\f[R], \f[C]subscript\f[R],
6036−\f[C]backtick_code_blocks\f[R], \f[C]spaced_reference_links\f[R],
6037−\f[C]raw_attribute\f[R].
6039−\f[B]\f[CB]markdown_strict\f[B]\f[R] (Markdown.pl)
6040−\f[C]raw_html\f[R], \f[C]shortcut_reference_links\f[R],
6041−\f[C]spaced_reference_links\f[R].
6043−We also support \f[C]commonmark\f[R] and \f[C]gfm\f[R] (GitHub-Flavored
6044−Markdown, which is implemented as a set of extensions on
6045−\f[C]commonmark\f[R]).
6047−Note, however, that \f[C]commonmark\f[R] and \f[C]gfm\f[R] have limited
6048−support for extensions.
6049−Only those listed below (and \f[C]smart\f[R], \f[C]raw_tex\f[R], and
6050−\f[C]hard_line_breaks\f[R]) will work.
6051−The extensions can, however, all be individually disabled.
6052−Also, \f[C]raw_tex\f[R] only affects \f[C]gfm\f[R] output, not input.
6054−\f[B]\f[CB]gfm\f[B]\f[R] (GitHub-Flavored Markdown)
6055−\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]fenced_code_blocks\f[R],
6056−\f[C]auto_identifiers\f[R], \f[C]gfm_auto_identifiers\f[R],
6057−\f[C]backtick_code_blocks\f[R], \f[C]autolink_bare_uris\f[R],
6058−\f[C]space_in_atx_header\f[R], \f[C]intraword_underscores\f[R],
6059−\f[C]strikeout\f[R], \f[C]task_lists\f[R], \f[C]emoji\f[R],
6060−\f[C]shortcut_reference_links\f[R], \f[C]angle_brackets_escapable\f[R],
6061−\f[C]lists_without_preceding_blankline\f[R].
6062−.SH PRODUCING SLIDE SHOWS WITH PANDOC
6626+.SH SLIDE SHOWS
6064You can use pandoc to produce an HTML + JavaScript slide presentation
6628You can use pandoc to produce an HTML + JavaScript slide presentation
6065that can be viewed via a web browser.
6629that can be viewed via a web browser.
@@ -6068,7 +6632,7 @@ reveal.js.
6068You can also produce a PDF slide show using LaTeX \f[C]beamer\f[R], or
6632You can also produce a PDF slide show using LaTeX \f[C]beamer\f[R], or
6069slides shows in Microsoft PowerPoint format.
6633slides shows in Microsoft PowerPoint format.
6071−Here\[aq]s the Markdown source for a simple slide show,
6635+Here\[cq]s the Markdown source for a simple slide show,
6072\f[C]habits.txt\f[R]:
6636\f[C]habits.txt\f[R]:
@@ -6170,21 +6734,26 @@ A heading at the slide level always starts a new slide.
6170.IP \[bu] 2
6734.IP \[bu] 2
6171Headings \f[I]below\f[R] the slide level in the hierarchy create
6735Headings \f[I]below\f[R] the slide level in the hierarchy create
6172headings \f[I]within\f[R] a slide.
6736headings \f[I]within\f[R] a slide.
6737+(In beamer, a \[lq]block\[rq] will be created.
6738+If the heading has the class \f[C]example\f[R], an
6739+\f[C]exampleblock\f[R] environment will be used; if it has the class
6740+\f[C]alert\f[R], an \f[C]alertblock\f[R] will be used; otherwise a
6741+regular \f[C]block\f[R] will be used.)
6173.IP \[bu] 2
6742.IP \[bu] 2
6174Headings \f[I]above\f[R] the slide level in the hierarchy create
6743Headings \f[I]above\f[R] the slide level in the hierarchy create
6175−\[dq]title slides,\[dq] which just contain the section title and help to
6744+\[lq]title slides,\[rq] which just contain the section title and help to
6176break the slide show into sections.
6745break the slide show into sections.
6177Non-slide content under these headings will be included on the title
6746Non-slide content under these headings will be included on the title
6178slide (for HTML slide shows) or in a subsequent slide with the same
6747slide (for HTML slide shows) or in a subsequent slide with the same
6179title (for beamer).
6748title (for beamer).
6180.IP \[bu] 2
6749.IP \[bu] 2
6181−A title page is constructed automatically from the document\[aq]s title
6750+A title page is constructed automatically from the document\[cq]s title
6182block, if present.
6751block, if present.
6183(In the case of beamer, this can be disabled by commenting out some
6752(In the case of beamer, this can be disabled by commenting out some
6184lines in the default template.)
6753lines in the default template.)
6186These rules are designed to support many different styles of slide show.
6755These rules are designed to support many different styles of slide show.
6187−If you don\[aq]t care about structuring your slides into sections and
6756+If you don\[cq]t care about structuring your slides into sections and
6188subsections, you can just use level-1 headings for all each slide.
6757subsections, you can just use level-1 headings for all each slide.
6189(In that case, level-1 will be the slide level.) But you can also
6758(In that case, level-1 will be the slide level.) But you can also
6190structure the slide show into sections, as in the example above.
6759structure the slide show into sections, as in the example above.
@@ -6196,8 +6765,8 @@ It is not recommended that you use deeper nesting of section levels with
6196reveal.js.
6765reveal.js.
6197.SS Incremental lists
6766.SS Incremental lists
6199−By default, these writers produce lists that display \[dq]all at
6768+By default, these writers produce lists that display \[lq]all at
6200−once.\[dq] If you want your lists to display incrementally (one item at
6769+once.\[rq] If you want your lists to display incrementally (one item at
6201a time), use the \f[C]-i\f[R] option.
6770a time), use the \f[C]-i\f[R] option.
6202If you want a particular list to depart from the default, put it in a
6771If you want a particular list to depart from the default, put it in a
6203\f[C]div\f[R] block with class \f[C]incremental\f[R] or
6772\f[C]div\f[R] block with class \f[C]incremental\f[R] or
@@ -6250,7 +6819,7 @@ Note: Neither the \f[C]-i/--incremental\f[R] option nor any of the
6250methods described here currently works for PowerPoint output.
6819methods described here currently works for PowerPoint output.
6251.SS Inserting pauses
6820.SS Inserting pauses
6253−You can add \[dq]pauses\[dq] within a slide by including a paragraph
6822+You can add \[lq]pauses\[rq] within a slide by including a paragraph
6254containing three dots, separated by spaces:
6823containing three dots, separated by spaces:
@@ -6273,7 +6842,7 @@ in \f[C]$DATADIR/s5/default\f[R] (for S5), \f[C]$DATADIR/slidy\f[R] (for
6273Slidy), or \f[C]$DATADIR/slideous\f[R] (for Slideous), where
6842Slidy), or \f[C]$DATADIR/slideous\f[R] (for Slideous), where
6274\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
6843\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
6276−The originals may be found in pandoc\[aq]s system data directory
6845+The originals may be found in pandoc\[cq]s system data directory
6277(generally \f[C]$CABALDIR/pandoc-VERSION/s5/default\f[R]).
6846(generally \f[C]$CABALDIR/pandoc-VERSION/s5/default\f[R]).
6278Pandoc will look there for any files it does not find in the user data
6847Pandoc will look there for any files it does not find in the user data
6279directory.
6848directory.
@@ -6359,6 +6928,51 @@ contents...
6359::::::::::::::
6928::::::::::::::
6931+.SS Additional columns attributes in beamer
6933+The div containers with classes \f[C]columns\f[R] and \f[C]column\f[R]
6934+can optionally have an \f[C]align\f[R] attribute.
6935+The class \f[C]columns\f[R] can optionally have a \f[C]totalwidth\f[R]
6936+attribute or an \f[C]onlytextwidth\f[R] class.
6940+:::::::::::::: {.columns align=center totalwidth=8em}
6941+::: {.column width=\[dq]40%\[dq]}
6944+::: {.column width=\[dq]60%\[dq] align=bottom}
6951+The \f[C]align\f[R] attributes on \f[C]columns\f[R] and \f[C]column\f[R]
6952+can be used with the values \f[C]top\f[R], \f[C]top-baseline\f[R],
6953+\f[C]center\f[R] and \f[C]bottom\f[R] to vertically align the columns.
6954+It defaults to \f[C]top\f[R] in \f[C]columns\f[R].
6956+The \f[C]totalwidth\f[R] attribute limits the width of the columns to
6961+:::::::::::::: {.columns align=top .onlytextwidth}
6962+::: {.column width=\[dq]40%\[dq] align=center}
6965+::: {.column width=\[dq]60%\[dq]}
6972+The class \f[C]onlytextwidth\f[R] sets the \f[C]totalwidth\f[R] to
6973+\f[C]\[rs]textwidth\f[R].
6975+See Section 12.7 of the Beamer User\[cq]s Guide for more details.
6362.SS Frame attributes in beamer
6976.SS Frame attributes in beamer
6364Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[R] option to
6978Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[R] option to
@@ -6374,7 +6988,7 @@ introducing the slide:
6376All of the other frame attributes described in Section 8.1 of the Beamer
6990All of the other frame attributes described in Section 8.1 of the Beamer
6377−User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[R],
6991+User\[cq]s Guide may also be used: \f[C]allowdisplaybreaks\f[R],
6378\f[C]allowframebreaks\f[R], \f[C]b\f[R], \f[C]c\f[R], \f[C]t\f[R],
6992\f[C]allowframebreaks\f[R], \f[C]b\f[R], \f[C]c\f[R], \f[C]t\f[R],
6379\f[C]environment\f[R], \f[C]label\f[R], \f[C]plain\f[R],
6993\f[C]environment\f[R], \f[C]label\f[R], \f[C]plain\f[R],
6380\f[C]shrink\f[R], \f[C]standout\f[R], \f[C]noframenumbering\f[R].
6994\f[C]shrink\f[R], \f[C]standout\f[R], \f[C]noframenumbering\f[R].
@@ -6399,7 +7013,7 @@ To set an image for a particular reveal.js slide, add
6399\f[C]{data-background-image=\[dq]/path/to/image\[dq]}\f[R] to the first
7013\f[C]{data-background-image=\[dq]/path/to/image\[dq]}\f[R] to the first
6400slide-level heading on the slide (which may even be empty).
7014slide-level heading on the slide (which may even be empty).
6402−In reveal.js\[aq]s overview mode, the parallaxBackgroundImage will show
7016+In reveal.js\[cq]s overview mode, the parallaxBackgroundImage will show
6403up only on the first slide.
7017up only on the first slide.
6405Other reveal.js background settings also work on individual slides,
7019Other reveal.js background settings also work on individual slides,
@@ -6435,7 +7049,7 @@ Slide 1 has background_image.png as its background.
6435Slide 2 has a special image for its background, even though the heading has no content.
7049Slide 2 has a special image for its background, even though the heading has no content.
6438−.SH CREATING EPUBS WITH PANDOC
7052+.SH EPUBS
6439.SS EPUB Metadata
7053.SS EPUB Metadata
6441EPUB metadata may be specified using the \f[C]--epub-metadata\f[R]
7055EPUB metadata may be specified using the \f[C]--epub-metadata\f[R]
@@ -6489,8 +7103,8 @@ Valid values for \f[C]type\f[R] are \f[C]main\f[R], \f[C]subtitle\f[R],
6489Either a string value, or an object with fields \f[C]role\f[R],
7103Either a string value, or an object with fields \f[C]role\f[R],
6490\f[C]file-as\f[R], and \f[C]text\f[R], or a list of such objects.
7104\f[C]file-as\f[R], and \f[C]text\f[R], or a list of such objects.
6491Valid values for \f[C]role\f[R] are MARC relators, but pandoc will
7105Valid values for \f[C]role\f[R] are MARC relators, but pandoc will
6492−attempt to translate the human-readable versions (like \[dq]author\[dq]
7106+attempt to translate the human-readable versions (like \[lq]author\[rq]
6493−and \[dq]editor\[dq]) to the appropriate marc relators.
7107+and \[lq]editor\[rq]) to the appropriate marc relators.
6495\f[B]\f[CB]contributor\f[B]\f[R]
7109\f[B]\f[CB]contributor\f[B]\f[R]
6496Same format as \f[C]creator\f[R].
7110Same format as \f[C]creator\f[R].
@@ -6525,6 +7139,16 @@ A string value.
6525\f[B]\f[CB]rights\f[B]\f[R]
7139\f[B]\f[CB]rights\f[B]\f[R]
6526A string value.
7140A string value.
7142+\f[B]\f[CB]belongs-to-collection\f[B]\f[R]
7144+identifies the name of a collection to which the EPUB Publication
7147+\f[B]\f[CB]group-position\f[B]\f[R]
7148+The \f[C]group-position\f[R] field indicates the numeric position in
7149+which the EPUB Publication belongs relative to other works belonging to
7150+the same \f[C]belongs-to-collection\f[R] field.
6528\f[B]\f[CB]cover-image\f[B]\f[R]
7152\f[B]\f[CB]cover-image\f[B]\f[R]
6529A string value (path to cover image).
7153A string value (path to cover image).
@@ -6679,16 +7303,6 @@ T}@T{
6679frontmatter
7303frontmatter
6694backmatter
7308backmatter
@@ -6723,13 +7337,13 @@ For example:
6725<audio controls=\[dq]1\[dq]>
7339<audio controls=\[dq]1\[dq]>
6726− <source src=\[dq]http://example.com/music/toccata.mp3\[dq]
7340+ <source src=\[dq]https://example.com/music/toccata.mp3\[dq]
6727 data-external=\[dq]1\[dq] type=\[dq]audio/mpeg\[dq]>
7341 data-external=\[dq]1\[dq] type=\[dq]audio/mpeg\[dq]>
6728 </source>
7342 </source>
6732−.SH CREATING JUPYTER NOTEBOOKS WITH PANDOC
7346+.SH JUPYTER NOTEBOOKS
6734When creating a Jupyter notebook, pandoc will try to infer the notebook
7348When creating a Jupyter notebook, pandoc will try to infer the notebook
6735structure.
7349structure.
@@ -6844,7 +7458,7 @@ hello
6844If you include raw HTML or TeX in an output cell, use the [raw
7458If you include raw HTML or TeX in an output cell, use the [raw
6845attribute][Extension: \f[C]fenced_attribute\f[R]], as shown in the last
7459attribute][Extension: \f[C]fenced_attribute\f[R]], as shown in the last
6846cell of the example above.
7460cell of the example above.
6847−Although pandoc can process \[dq]bare\[dq] raw HTML and TeX, the result
7461+Although pandoc can process \[lq]bare\[rq] raw HTML and TeX, the result
6848is often interspersed raw elements and normal textual elements, and in
7462is often interspersed raw elements and normal textual elements, and in
6849an output cell pandoc expects a single, connected raw block.
7463an output cell pandoc expects a single, connected raw block.
6850To avoid using raw HTML or TeX except when marked explicitly using raw
7464To avoid using raw HTML or TeX except when marked explicitly using raw
@@ -6897,10 +7511,10 @@ pandoc --highlight-style my.theme
6899If you are not satisfied with the built-in highlighting, or you want
7513If you are not satisfied with the built-in highlighting, or you want
6900−highlight a language that isn\[aq]t supported, you can use the
7514+highlight a language that isn\[cq]t supported, you can use the
6901\f[C]--syntax-definition\f[R] option to load a KDE-style XML syntax
7515\f[C]--syntax-definition\f[R] option to load a KDE-style XML syntax
6902definition file.
7516definition file.
6903−Before writing your own, have a look at KDE\[aq]s repository of syntax
7517+Before writing your own, have a look at KDE\[cq]s repository of syntax
6904definitions.
7518definitions.
6906To disable highlighting, use the \f[C]--no-highlight\f[R] option.
7520To disable highlighting, use the \f[C]--no-highlight\f[R] option.
@@ -6909,7 +7523,7 @@ To disable highlighting, use the \f[C]--no-highlight\f[R] option.
6909Custom styles can be used in the docx and ICML formats.
7523Custom styles can be used in the docx and ICML formats.
6910.SS Output
7524.SS Output
6912−By default, pandoc\[aq]s docx and ICML output applies a predefined set
7526+By default, pandoc\[cq]s docx and ICML output applies a predefined set
6913of styles for blocks such as paragraphs and block quotes, and uses
7527of styles for blocks such as paragraphs and block quotes, and uses
6914largely default formatting (italics, bold) for inlines.
7528largely default formatting (italics, bold) for inlines.
6915This will work for most purposes, especially alongside a
7529This will work for most purposes, especially alongside a
@@ -6930,7 +7544,7 @@ So, for example, using the \f[C]bracketed_spans\f[R] syntax,
6933−would produce a docx file with \[dq]Get out\[dq] styled with character
7547+would produce a docx file with \[lq]Get out\[rq] styled with character
6934style \f[C]Emphatically\f[R].
7548style \f[C]Emphatically\f[R].
6935Similarly, using the \f[C]fenced_divs\f[R] syntax,
7549Similarly, using the \f[C]fenced_divs\f[R] syntax,
@@ -6961,13 +7575,13 @@ character style (perhaps to change their color), you can write a filter
6961which will transform all italicized inlines to inlines within an
7575which will transform all italicized inlines to inlines within an
6962\f[C]Emphasis\f[R] custom-style \f[C]span\f[R].
7576\f[C]Emphasis\f[R] custom-style \f[C]span\f[R].
6964−For docx output, you don\[aq]t need to enable any extensions for custom
7578+For docx output, you don\[cq]t need to enable any extensions for custom
6965styles to work.
7579styles to work.
6966.SS Input
7580.SS Input
6968The docx reader, by default, only reads those styles that it can convert
7582The docx reader, by default, only reads those styles that it can convert
6969into pandoc elements, either by direct conversion or interpreting the
7583into pandoc elements, either by direct conversion or interpreting the
6970−derivation of the input document\[aq]s styles.
7584+derivation of the input document\[cq]s styles.
6972By enabling the \f[C]styles\f[R] extension in the docx reader
7586By enabling the \f[C]styles\f[R] extension in the docx reader
6973(\f[C]-f docx+styles\f[R]), you can produce output that maintains the
7587(\f[C]-f docx+styles\f[R]), you can produce output that maintains the
@@ -7019,11 +7633,11 @@ reference-doc while creating docx output (see below), and maintain the
7019same styles in your input and output files.
7633same styles in your input and output files.
7020.SH CUSTOM WRITERS
7634.SH CUSTOM WRITERS
7022−Pandoc can be extended with custom writers written in lua.
7636+Pandoc can be extended with custom writers written in Lua.
7023−(Pandoc includes a lua interpreter, so lua need not be installed
7637+(Pandoc includes a Lua interpreter, so Lua need not be installed
7024separately.)
7638separately.)
7026−To use a custom writer, simply specify the path to the lua script in
7640+To use a custom writer, simply specify the path to the Lua script in
7027place of the output format.
7641place of the output format.
7028For example:
7642For example:
@@ -7033,7 +7647,7 @@ pandoc -t data/sample.lua
7036−Creating a custom writer requires writing a lua function for each
7650+Creating a custom writer requires writing a Lua function for each
7037possible element in a pandoc document.
7651possible element in a pandoc document.
7038To get a documented example which you can modify according to your
7652To get a documented example which you can modify according to your
7039needs, do
7653needs, do
@@ -7050,6 +7664,20 @@ need to specify a template manually using \f[C]--template\f[R] or add a
7050new default template with the name
7664new default template with the name
7051\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
7665\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
7052subdirectory of your user data directory (see Templates).
7666subdirectory of your user data directory (see Templates).
7667+.SH REPRODUCIBLE BUILDS
7669+Some of the document formats pandoc targets (such as EPUB, docx, and
7670+ODT) include build timestamps in the generated document.
7671+That means that the files generated on successive builds will differ,
7672+even if the source does not.
7673+To avoid this, set the \f[C]SOURCE_DATE_EPOCH\f[R] environment variable,
7674+and the timestamp will be taken from it instead of the current time.
7675+\f[C]SOURCE_DATE_EPOCH\f[R] should contain an integer unix timestamp
7676+(specifying the number of second since midnight UTC January 1, 1970).
7678+Some document formats also include a unique identifier.
7679+For EPUB, this can be set explicitly by setting the \f[C]identifier\f[R]
7680+metadata field (see EPUB Metadata, above).
7053.SH A NOTE ON SECURITY
7681.SH A NOTE ON SECURITY
7055If you use pandoc to convert user-contributed content in a web
7683If you use pandoc to convert user-contributed content in a web
@@ -7068,7 +7696,7 @@ fully isolates pandoc from your file system, by running the pandoc
7068operations in the \f[C]PandocPure\f[R] monad.
7696operations in the \f[C]PandocPure\f[R] monad.
7069See the document Using the pandoc API for more details.
7697See the document Using the pandoc API for more details.
7070.IP "3." 3
7698.IP "3." 3
7071−Pandoc\[aq]s parsers can exhibit pathological performance on some corner
7699+Pandoc\[cq]s parsers can exhibit pathological performance on some corner
7073It is wise to put any pandoc operations under a timeout, to avoid DOS
7701It is wise to put any pandoc operations under a timeout, to avoid DOS
7074attacks that exploit these issues.
7702attacks that exploit these issues.
@@ -7080,16 +7708,16 @@ The HTML generated by pandoc is not guaranteed to be safe.
7080If \f[C]raw_html\f[R] is enabled for the Markdown input, users can
7708If \f[C]raw_html\f[R] is enabled for the Markdown input, users can
7081inject arbitrary HTML.
7709inject arbitrary HTML.
7082Even if \f[C]raw_html\f[R] is disabled, users can include dangerous
7710Even if \f[C]raw_html\f[R] is disabled, users can include dangerous
7083−content in attributes for headings, spans, and code blocks.
7711+content in URLs and attributes.
7084To be safe, you should run all the generated HTML through an HTML
7712To be safe, you should run all the generated HTML through an HTML
7085sanitizer.
7713sanitizer.
7086.SH AUTHORS
7714.SH AUTHORS
7088−Copyright 2006--2019 John MacFarlane (jgm\[at]berkeley.edu).
7716+Copyright 2006\[en]2021 John MacFarlane (jgm\[at]berkeley.edu).
7089Released under the GPL, version 2 or greater.
7717Released under the GPL, version 2 or greater.
7090This software carries no warranty of any kind.
7718This software carries no warranty of any kind.
7091(See COPYRIGHT for full copyright and warranty notices.) For a full list
7719(See COPYRIGHT for full copyright and warranty notices.) For a full list
7092of contributors, see the file AUTHORS.md in the pandoc source code.
7720of contributors, see the file AUTHORS.md in the pandoc source code.
7094The Pandoc source code and all documentation may be downloaded
7722The Pandoc source code and all documentation may be downloaded
7095−from <http://pandoc.org>.
7723+from <https://pandoc.org>.