% Enable hyperlinks
\setupinteraction
  [state=start,
  title={Pandoc User's Guide},
  author={John MacFarlane},
  style=,
  color=,
  contrastcolor=]
\setupurl[style=]

% make chapter, section bookmarks visible when opening document
\placebookmarks[chapter, section, subsection, subsubsection, subsubsubsection, subsubsubsubsection][chapter, section]
\setupinteractionscreen[option={bookmark,title}]

\setuppagenumbering[location={footer,middle}]
\setupbackend[export=yes]
\setupstructure[state=start,method=auto]

% use microtypography
\definefontfeature[default][default][script=latn, protrusion=quality, expansion=quality, itlc=yes, textitalics=yes, onum=yes, pnum=yes]
\definefontfeature[default:tnum][default][tnum=yes, pnum=no]
\definefontfeature[smallcaps][script=latn, protrusion=quality, expansion=quality, smcp=yes, onum=yes, pnum=yes]
\setupalign[hz,hanging]
\setupitaliccorrection[global, always]

\setupbodyfontenvironment[default][em=italic] % use italic as em, not slanted

\definefallbackfamily[mainface][rm][CMU Serif][preset=range:greek, force=yes]
\definefontfamily[mainface][rm][Latin Modern Roman]
\definefontfamily[mainface][mm][Latin Modern Math]
\definefontfamily[mainface][ss][Latin Modern Sans]
\definefontfamily[mainface][tt][Latin Modern Typewriter][features=none]
\setupbodyfont[mainface]

\setupwhitespace[medium]

\setuphead[chapter]            [style=\tfd\setupinterlinespace,header=empty]
\setuphead[section]            [style=\tfc\setupinterlinespace]
\setuphead[subsection]         [style=\tfb\setupinterlinespace]
\setuphead[subsubsection]      [style=\bf]
\setuphead[subsubsubsection]   [style=\sc]
\setuphead[subsubsubsubsection][style=\it]

\definesectionlevels
   [default]
   [section, subsection, subsubsection, subsubsubsection, subsubsubsubsection]

\setuphead[chapter, section, subsection, subsubsection, subsubsubsection, subsubsubsubsection][number=no]

\definedescription
  [description]
  [headstyle=bold, style=normal, location=hanging, width=broad, margin=1cm, alternative=hanging]

\setupitemize[autointro]    % prevent orphan list intro
\setupitemize[indentnext=no]

\defineitemgroup[enumerate]
\setupenumerate[each][fit][itemalign=left,distance=.5em,style={\feature[+][default:tnum]}]

\setupfloat[figure][default={here,nonumber}]
\setupfloat[table][default={here,nonumber}]

\setupxtable[frame=off]
\setupxtable[head][topframe=on]
\setupxtable[body][]
\setupxtable[foot][]
\setupxtable[lastrow][bottomframe=on]

\defineframedtext [shaded]
  [backgroundcolor=shadecolor,
   background=color,
   frame=off,
   offset=0pt,
   width=local]
\definetyping [highlighting]
  [escape=yes,
   before={\startshaded},
   after={\stopshaded}]
\definetype [highlight]
  [escape=yes]
\define[1]\AlertTok{\colored[r=1.00,g=0.00,b=0.00]{\bf #1}}
\define[1]\AnnotationTok{\colored[r=0.38,g=0.63,b=0.69]{\bf \em #1}}
\define[1]\AttributeTok{\colored[r=0.49,g=0.56,b=0.16]{#1}}
\define[1]\BaseNTok{\colored[r=0.25,g=0.63,b=0.44]{#1}}
\define[1]\BuiltInTok{\colored[r=0.00,g=0.50,b=0.00]{#1}}
\define[1]\CharTok{\colored[r=0.25,g=0.44,b=0.63]{#1}}
\define[1]\CommentTok{\colored[r=0.38,g=0.63,b=0.69]{\em #1}}
\define[1]\CommentVarTok{\colored[r=0.38,g=0.63,b=0.69]{\bf \em #1}}
\define[1]\ConstantTok{\colored[r=0.53,g=0.00,b=0.00]{#1}}
\define[1]\ControlFlowTok{\colored[r=0.00,g=0.44,b=0.13]{\bf #1}}
\define[1]\DataTypeTok{\colored[r=0.56,g=0.13,b=0.00]{#1}}
\define[1]\DecValTok{\colored[r=0.25,g=0.63,b=0.44]{#1}}
\define[1]\DocumentationTok{\colored[r=0.73,g=0.13,b=0.13]{\em #1}}
\define[1]\ErrorTok{\colored[r=1.00,g=0.00,b=0.00]{\bf #1}}
\define[1]\ExtensionTok{#1}
\define[1]\FloatTok{\colored[r=0.25,g=0.63,b=0.44]{#1}}
\define[1]\FunctionTok{\colored[r=0.02,g=0.16,b=0.49]{#1}}
\define[1]\ImportTok{\colored[r=0.00,g=0.50,b=0.00]{\bf #1}}
\define[1]\InformationTok{\colored[r=0.38,g=0.63,b=0.69]{\bf \em #1}}
\define[1]\KeywordTok{\colored[r=0.00,g=0.44,b=0.13]{\bf #1}}
\define[1]\NormalTok{#1}
\define[1]\OperatorTok{\colored[r=0.40,g=0.40,b=0.40]{#1}}
\define[1]\OtherTok{\colored[r=0.00,g=0.44,b=0.13]{#1}}
\define[1]\PreprocessorTok{\colored[r=0.74,g=0.48,b=0.00]{#1}}
\define[1]\RegionMarkerTok{#1}
\define[1]\SpecialCharTok{\colored[r=0.25,g=0.44,b=0.63]{#1}}
\define[1]\SpecialStringTok{\colored[r=0.73,g=0.40,b=0.53]{#1}}
\define[1]\StringTok{\colored[r=0.25,g=0.44,b=0.63]{#1}}
\define[1]\VariableTok{\colored[r=0.10,g=0.09,b=0.49]{#1}}
\define[1]\VerbatimStringTok{\colored[r=0.25,g=0.44,b=0.63]{#1}}
\define[1]\WarningTok{\colored[r=0.38,g=0.63,b=0.69]{\bf \em #1}}

\starttext
\startalignment[middle]
  {\tfd\setupinterlinespace Pandoc User's Guide}
  \smallskip
  {\tfa\setupinterlinespace John MacFarlane}
  \smallskip
  {\tfa\setupinterlinespace April 7, 2024}
  \bigskip
\stopalignment

\startsectionlevel[title={Synopsis},reference={synopsis}]

\type{pandoc} {[}{\em options}{]} {[}{\em input-file}{]}\ldots{}

\stopsectionlevel

\startsectionlevel[title={Description},reference={description}]

Pandoc is a \goto{Haskell}[url(https://www.haskell.org)] library for
converting from one markup format to another, and a command-line tool
that uses this library.

Pandoc can convert between numerous markup and word processing formats,
including, but not limited to, various flavors of
\goto{Markdown}[url(https://daringfireball.net/projects/markdown/)],
\goto{HTML}[url(https://www.w3.org/html/)],
\goto{LaTeX}[url(https://www.latex-project.org/)] and \goto{Word
docx}[url(https://en.wikipedia.org/wiki/Office_Open_XML)]. For the full
lists of input and output formats, see the \type{--from} and \type{--to}
\goto{options below}[general-options]. Pandoc can also produce
\goto{PDF}[url(https://www.adobe.com/pdf/)] output: see \goto{creating a
PDF}[creating-a-pdf], below.

Pandoc's enhanced version of Markdown includes syntax for
\goto{tables}[tables], \goto{definition lists}[definition-lists],
\goto{metadata blocks}[metadata-blocks], \goto{footnotes}[footnotes],
\goto{citations}[citations], \goto{math}[math], and much more. See below
under \goto{Pandoc's Markdown}[pandocs-markdown].

Pandoc has a modular design: it consists of a set of readers, which
parse text in a given format and produce a native representation of the
document (an {\em abstract syntax tree} or AST), and a set of writers,
which convert this native representation into a target format. Thus,
adding an input or output format requires only adding a reader or
writer. Users can also run custom \goto{pandoc
filters}[url(https://pandoc.org/filters.html)] to modify the
intermediate AST.

Because pandoc's intermediate representation of a document is less
expressive than many of the formats it converts between, one should not
expect perfect conversions between every format and every other. Pandoc
attempts to preserve the structural elements of a document, but not
formatting details such as margin size. And some document elements, such
as complex tables, may not fit into pandoc's simple document model.
While conversions from pandoc's Markdown to all formats aspire to be
perfect, conversions from formats more expressive than pandoc's Markdown
can be expected to be lossy.

\startsectionlevel[title={Using pandoc},reference={using-pandoc}]

If no {\em input-files} are specified, input is read from {\em stdin}.
Output goes to {\em stdout} by default. For output to a file, use the
\type{-o} option:

\starttyping
pandoc -o output.html input.txt
\stoptyping

By default, pandoc produces a document fragment. To produce a standalone
document (e.g.~a valid HTML file including \type{<head>} and
\type{<body>}), use the \type{-s} or \type{--standalone} flag:

\starttyping
pandoc -s -o output.html input.txt
\stoptyping

For more information on how standalone documents are produced, see
\goto{Templates}[templates] below.

If multiple input files are given, pandoc will concatenate them all
(with blank lines between them) before parsing. (Use \type{--file-scope}
to parse files individually.)

\stopsectionlevel

\startsectionlevel[title={Specifying
formats},reference={specifying-formats}]

The format of the input and output can be specified explicitly using
command-line options. The input format can be specified using the
\type{-f/--from} option, the output format using the \type{-t/--to}
option. Thus, to convert \type{hello.txt} from Markdown to LaTeX, you
could type:

\starttyping
pandoc -f markdown -t latex hello.txt
\stoptyping

To convert \type{hello.html} from HTML to Markdown:

\starttyping
pandoc -f html -t markdown hello.html
\stoptyping

Supported input and output formats are listed below under
\goto{Options}[options] (see \type{-f} for input formats and \type{-t}
for output formats). You can also use \type{pandoc --list-input-formats}
and \type{pandoc --list-output-formats} to print lists of supported
formats.

If the input or output format is not specified explicitly, pandoc will
attempt to guess it from the extensions of the filenames. Thus, for
example,

\starttyping
pandoc -o hello.tex hello.txt
\stoptyping

will convert \type{hello.txt} from Markdown to LaTeX. If no output file
is specified (so that output goes to {\em stdout}), or if the output
file's extension is unknown, the output format will default to HTML. If
no input file is specified (so that input comes from {\em stdin}), or if
the input files' extensions are unknown, the input format will be
assumed to be Markdown.

\stopsectionlevel

\startsectionlevel[title={Character
encoding},reference={character-encoding}]

Pandoc uses the UTF-8 character encoding for both input and output. If
your local character encoding is not UTF-8, you should pipe input and
output through
\goto{\type{iconv}}[url(https://www.gnu.org/software/libiconv/)]:

\starttyping
iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
\stoptyping

Note that in some output formats (such as HTML, LaTeX, ConTeXt, RTF,
OPML, DocBook, and Texinfo), information about the character encoding is
included in the document header, which will only be included if you use
the \type{-s/--standalone} option.

\stopsectionlevel

\startsectionlevel[title={Creating a PDF},reference={creating-a-pdf}]

To produce a PDF, specify an output file with a \type{.pdf} extension:

\starttyping
pandoc test.txt -o test.pdf
\stoptyping

By default, pandoc will use LaTeX to create the PDF, which requires that
a LaTeX engine be installed (see \type{--pdf-engine} below).
Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
intermediate format. To do this, specify an output file with a
\type{.pdf} extension, as before, but add the \type{--pdf-engine} option
or \type{-t context}, \type{-t html}, or \type{-t ms} to the command
line. The tool used to generate the PDF from the intermediate format may
be specified using \type{--pdf-engine}.

You can control the PDF style using variables, depending on the
intermediate format used: see \goto{variables for
LaTeX}[variables-for-latex], \goto{variables for
ConTeXt}[variables-for-context], \goto{variables for
\type{wkhtmltopdf}}[variables-for-wkhtmltopdf], \goto{variables for
ms}[variables-for-ms]. When HTML is used as an intermediate format, the
output can be styled using \type{--css}.

To debug the PDF creation, it can be useful to look at the intermediate
representation: instead of \type{-o test.pdf}, use for example
\type{-s -o test.tex} to output the generated LaTeX. You can then test
it with \type{pdflatex test.tex}.

When using LaTeX, the following packages need to be available (they are
included with all recent versions of \goto{TeX
Live}[url(https://www.tug.org/texlive/)]):
\goto{\type{amsfonts}}[url(https://ctan.org/pkg/amsfonts)],
\goto{\type{amsmath}}[url(https://ctan.org/pkg/amsmath)],
\goto{\type{lm}}[url(https://ctan.org/pkg/lm)],
\goto{\type{unicode-math}}[url(https://ctan.org/pkg/unicode-math)],
\goto{\type{iftex}}[url(https://ctan.org/pkg/iftex)],
\goto{\type{listings}}[url(https://ctan.org/pkg/listings)] (if the
\type{--listings} option is used),
\goto{\type{fancyvrb}}[url(https://ctan.org/pkg/fancyvrb)],
\goto{\type{longtable}}[url(https://ctan.org/pkg/longtable)],
\goto{\type{booktabs}}[url(https://ctan.org/pkg/booktabs)],
\goto{\type{graphicx}}[url(https://ctan.org/pkg/graphicx)] (if the
document contains images),
\goto{\type{bookmark}}[url(https://ctan.org/pkg/bookmark)],
\goto{\type{xcolor}}[url(https://ctan.org/pkg/xcolor)],
\goto{\type{soul}}[url(https://ctan.org/pkg/soul)],
\goto{\type{geometry}}[url(https://ctan.org/pkg/geometry)] (with the
\type{geometry} variable set),
\goto{\type{setspace}}[url(https://ctan.org/pkg/setspace)] (with
\type{linestretch}), and
\goto{\type{babel}}[url(https://ctan.org/pkg/babel)] (with \type{lang}).
If \type{CJKmainfont} is set,
\goto{\type{xeCJK}}[url(https://ctan.org/pkg/xecjk)] is needed. The use
of \type{xelatex} or \type{lualatex} as the PDF engine requires
\goto{\type{fontspec}}[url(https://ctan.org/pkg/fontspec)].
\type{lualatex} uses
\goto{\type{selnolig}}[url(https://ctan.org/pkg/selnolig)].
\type{xelatex} uses \goto{\type{bidi}}[url(https://ctan.org/pkg/bidi)]
(with the \type{dir} variable set). If the \type{mathspec} variable is
set, \type{xelatex} will use
\goto{\type{mathspec}}[url(https://ctan.org/pkg/mathspec)] instead of
\goto{\type{unicode-math}}[url(https://ctan.org/pkg/unicode-math)]. The
\goto{\type{upquote}}[url(https://ctan.org/pkg/upquote)] and
\goto{\type{microtype}}[url(https://ctan.org/pkg/microtype)] packages
are used if available, and
\goto{\type{csquotes}}[url(https://ctan.org/pkg/csquotes)] will be used
for \goto{typography}[typography] if the \type{csquotes} variable or
metadata field is set to a true value. The
\goto{\type{natbib}}[url(https://ctan.org/pkg/natbib)],
\goto{\type{biblatex}}[url(https://ctan.org/pkg/biblatex)],
\goto{\type{bibtex}}[url(https://ctan.org/pkg/bibtex)], and
\goto{\type{biber}}[url(https://ctan.org/pkg/biber)] packages can
optionally be used for \goto{citation rendering}[citation-rendering].
The following packages will be used to improve output quality if
present, but pandoc does not require them to be present:
\goto{\type{upquote}}[url(https://ctan.org/pkg/upquote)] (for straight
quotes in verbatim environments),
\goto{\type{microtype}}[url(https://ctan.org/pkg/microtype)] (for better
spacing adjustments),
\goto{\type{parskip}}[url(https://ctan.org/pkg/parskip)] (for better
inter-paragraph spaces),
\goto{\type{xurl}}[url(https://ctan.org/pkg/xurl)] (for better line
breaks in URLs), and
\goto{\type{footnotehyper}}[url(https://ctan.org/pkg/footnotehyper)] or
\goto{\type{footnote}}[url(https://ctan.org/pkg/footnote)] (to allow
footnotes in tables).

\stopsectionlevel

\startsectionlevel[title={Reading from the
Web},reference={reading-from-the-web}]

Instead of an input file, an absolute URI may be given. In this case
pandoc will fetch the content using HTTP:

\starttyping
pandoc -f html -t markdown https://www.fsf.org
\stoptyping

It is possible to supply a custom User-Agent string or other header when
requesting a document from a URL:

\starttyping
pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
  https://www.fsf.org
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Options},reference={options}]

\startsectionlevel[title={General options},reference={general-options}]

\startdescription{\type{-f} {\em FORMAT}, \type{-r} {\em FORMAT},
\type{--from=}{\em FORMAT}, \type{--read=}{\em FORMAT}}
  Specify input format. {\em FORMAT} can be:

  \reference[input-formats]{}%
  \startitemize[packed]
  \item
    \type{bibtex} (\goto{BibTeX}[url(https://ctan.org/pkg/bibtex)]
    bibliography)
  \item
    \type{biblatex} (\goto{BibLaTeX}[url(https://ctan.org/pkg/biblatex)]
    bibliography)
  \item
    \type{bits}
    (\goto{BITS}[url(https://jats.nlm.nih.gov/extensions/bits/)] XML,
    alias for \type{jats})
  \item
    \type{commonmark} (\goto{CommonMark}[url(https://commonmark.org)]
    Markdown)
  \item
    \type{commonmark_x} (\goto{CommonMark}[url(https://commonmark.org)]
    Markdown with extensions)
  \item
    \type{creole} (\goto{Creole
    1.0}[url(http://www.wikicreole.org/wiki/Creole1.0)])
  \item
    \type{csljson} (\goto{CSL
    JSON}[url(https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)]
    bibliography)
  \item
    \type{csv} (\goto{CSV}[url(https://tools.ietf.org/html/rfc4180)]
    table)
  \item
    \type{tsv}
    (\goto{TSV}[url(https://www.iana.org/assignments/media-types/text/tab-separated-values)]
    table)
  \item
    \type{djot} (\goto{Djot markup}[url(https://djot.net)])
  \item
    \type{docbook} (\goto{DocBook}[url(https://docbook.org)])
  \item
    \type{docx} (\goto{Word
    docx}[url(https://en.wikipedia.org/wiki/Office_Open_XML)])
  \item
    \type{dokuwiki} (\goto{DokuWiki
    markup}[url(https://www.dokuwiki.org/dokuwiki)])
  \item
    \type{endnotexml} (\goto{EndNote XML
    bibliography}[url(https://support.clarivate.com/Endnote/s/article/EndNote-XML-Document-Type-Definition)])
  \item
    \type{epub} (\goto{EPUB}[url(http://idpf.org/epub)])
  \item
    \type{fb2}
    (\goto{FictionBook2}[url(http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)]
    e-book)
  \item
    \type{gfm} (\goto{GitHub-Flavored
    Markdown}[url(https://help.github.com/articles/github-flavored-markdown/)]),
    or the deprecated and less accurate \type{markdown_github}; use
    \goto{\type{markdown_github}}[markdown-variants] only if you need
    extensions not supported in \goto{\type{gfm}}[markdown-variants].
  \item
    \type{haddock} (\goto{Haddock
    markup}[url(https://www.haskell.org/haddock/doc/html/ch03s08.html)])
  \item
    \type{html} (\goto{HTML}[url(https://www.w3.org/html/)])
  \item
    \type{ipynb} (\goto{Jupyter
    notebook}[url(https://nbformat.readthedocs.io/en/latest/)])
  \item
    \type{jats} (\goto{JATS}[url(https://jats.nlm.nih.gov)] XML)
  \item
    \type{jira}
    (\goto{Jira}[url(https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)]/Confluence
    wiki markup)
  \item
    \type{json} (JSON version of native AST)
  \item
    \type{latex} (\goto{LaTeX}[url(https://www.latex-project.org/)])
  \item
    \type{markdown} (\goto{Pandoc's Markdown}[pandocs-markdown])
  \item
    \type{markdown_mmd}
    (\goto{MultiMarkdown}[url(https://fletcherpenney.net/multimarkdown/)])
  \item
    \type{markdown_phpextra} (\goto{PHP Markdown
    Extra}[url(https://michelf.ca/projects/php-markdown/extra/)])
  \item
    \type{markdown_strict} (original unextended
    \goto{Markdown}[url(https://daringfireball.net/projects/markdown/)])
  \item
    \type{mediawiki} (\goto{MediaWiki
    markup}[url(https://www.mediawiki.org/wiki/Help:Formatting)])
  \item
    \type{man} (\goto{roff man}[url(https://man.cx/groff_man(7))])
  \item
    \type{muse} (\goto{Muse}[url(https://amusewiki.org/library/manual)])
  \item
    \type{native} (native Haskell)
  \item
    \type{odt}
    (\goto{ODT}[url(https://en.wikipedia.org/wiki/OpenDocument)])
  \item
    \type{opml} (\goto{OPML}[url(http://dev.opml.org/spec2.html)])
  \item
    \type{org} (\goto{Emacs Org mode}[url(https://orgmode.org)])
  \item
    \type{ris}
    (\goto{RIS}[url(https://en.wikipedia.org/wiki/RIS_(file_format))]
    bibliography)
  \item
    \type{rtf} (\goto{Rich Text
    Format}[url(https://en.wikipedia.org/wiki/Rich_Text_Format)])
  \item
    \type{rst}
    (\goto{reStructuredText}[url(https://docutils.sourceforge.io/docs/ref/rst/introduction.html)])
  \item
    \type{t2t} (\goto{txt2tags}[url(https://txt2tags.org)])
  \item
    \type{textile} (\goto{Textile}[url(https://textile-lang.com)])
  \item
    \type{tikiwiki} (\goto{TikiWiki
    markup}[url(https://doc.tiki.org/Wiki-Syntax-Text\#The_Markup_Language_Wiki-Syntax)])
  \item
    \type{twiki} (\goto{TWiki
    markup}[url(https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules)])
  \item
    \type{typst} (\goto{typst}[url(https://typst.app)])
  \item
    \type{vimwiki} (\goto{Vimwiki}[url(https://vimwiki.github.io)])
  \item
    the path of a custom Lua reader, see \goto{Custom readers and
    writers}[custom-readers-and-writers] below
  \stopitemize

  Extensions can be individually enabled or disabled by appending
  \type{+EXTENSION} or \type{-EXTENSION} to the format name. See
  \goto{Extensions}[extensions] below, for a list of extensions and
  their names. See \type{--list-input-formats} and
  \type{--list-extensions}, below.
\stopdescription

\startdescription{\type{-t} {\em FORMAT}, \type{-w} {\em FORMAT},
\type{--to=}{\em FORMAT}, \type{--write=}{\em FORMAT}}
  Specify output format. {\em FORMAT} can be:

  \reference[output-formats]{}%
  \startitemize[packed]
  \item
    \type{asciidoc} (modern
    \goto{AsciiDoc}[url(https://www.methods.co.nz/asciidoc/)] as
    interpreted by \goto{AsciiDoctor}[url(https://asciidoctor.org/)])
  \item
    \type{asciidoc_legacy}
    (\goto{AsciiDoc}[url(https://www.methods.co.nz/asciidoc/)] as
    interpreted by
    \goto{\type{asciidoc-py}}[url(https://github.com/asciidoc-py/asciidoc-py)]).
  \item
    \type{asciidoctor} (deprecated synonym for \type{asciidoc})
  \item
    \type{beamer} (\goto{LaTeX beamer}[url(https://ctan.org/pkg/beamer)]
    slide show)
  \item
    \type{bibtex} (\goto{BibTeX}[url(https://ctan.org/pkg/bibtex)]
    bibliography)
  \item
    \type{biblatex} (\goto{BibLaTeX}[url(https://ctan.org/pkg/biblatex)]
    bibliography)
  \item
    \type{chunkedhtml} (zip archive of multiple linked HTML files)
  \item
    \type{commonmark} (\goto{CommonMark}[url(https://commonmark.org)]
    Markdown)
  \item
    \type{commonmark_x} (\goto{CommonMark}[url(https://commonmark.org)]
    Markdown with extensions)
  \item
    \type{context} (\goto{ConTeXt}[url(https://www.contextgarden.net/)])
  \item
    \type{csljson} (\goto{CSL
    JSON}[url(https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)]
    bibliography)
  \item
    \type{djot} (\goto{Djot markup}[url(https://djot.net)])
  \item
    \type{docbook} or \type{docbook4}
    (\goto{DocBook}[url(https://docbook.org)] 4)
  \item
    \type{docbook5} (DocBook 5)
  \item
    \type{docx} (\goto{Word
    docx}[url(https://en.wikipedia.org/wiki/Office_Open_XML)])
  \item
    \type{dokuwiki} (\goto{DokuWiki
    markup}[url(https://www.dokuwiki.org/dokuwiki)])
  \item
    \type{epub} or \type{epub3} (\goto{EPUB}[url(http://idpf.org/epub)]
    v3 book)
  \item
    \type{epub2} (EPUB v2)
  \item
    \type{fb2}
    (\goto{FictionBook2}[url(http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)]
    e-book)
  \item
    \type{gfm} (\goto{GitHub-Flavored
    Markdown}[url(https://help.github.com/articles/github-flavored-markdown/)]),
    or the deprecated and less accurate \type{markdown_github}; use
    \goto{\type{markdown_github}}[markdown-variants] only if you need
    extensions not supported in \goto{\type{gfm}}[markdown-variants].
  \item
    \type{haddock} (\goto{Haddock
    markup}[url(https://www.haskell.org/haddock/doc/html/ch03s08.html)])
  \item
    \type{html} or \type{html5}
    (\goto{HTML}[url(https://www.w3.org/html/)],
    i.e.~\goto{HTML5}[url(https://html.spec.whatwg.org/)]/XHTML
    \goto{polyglot markup}[url(https://www.w3.org/TR/html-polyglot/)])
  \item
    \type{html4} (\goto{XHTML}[url(https://www.w3.org/TR/xhtml1/)] 1.0
    Transitional)
  \item
    \type{icml} (\goto{InDesign
    ICML}[url(https://manualzz.com/doc/9627253/adobe-indesign-cs6-idml-cookbook)])
  \item
    \type{ipynb} (\goto{Jupyter
    notebook}[url(https://nbformat.readthedocs.io/en/latest/)])
  \item
    \type{jats_archiving} (\goto{JATS}[url(https://jats.nlm.nih.gov)]
    XML, Archiving and Interchange Tag Set)
  \item
    \type{jats_articleauthoring}
    (\goto{JATS}[url(https://jats.nlm.nih.gov)] XML, Article Authoring
    Tag Set)
  \item
    \type{jats_publishing} (\goto{JATS}[url(https://jats.nlm.nih.gov)]
    XML, Journal Publishing Tag Set)
  \item
    \type{jats} (alias for \type{jats_archiving})
  \item
    \type{jira}
    (\goto{Jira}[url(https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)]/Confluence
    wiki markup)
  \item
    \type{json} (JSON version of native AST)
  \item
    \type{latex} (\goto{LaTeX}[url(https://www.latex-project.org/)])
  \item
    \type{man} (\goto{roff man}[url(https://man.cx/groff_man(7))])
  \item
    \type{markdown} (\goto{Pandoc's Markdown}[pandocs-markdown])
  \item
    \type{markdown_mmd}
    (\goto{MultiMarkdown}[url(https://fletcherpenney.net/multimarkdown/)])
  \item
    \type{markdown_phpextra} (\goto{PHP Markdown
    Extra}[url(https://michelf.ca/projects/php-markdown/extra/)])
  \item
    \type{markdown_strict} (original unextended
    \goto{Markdown}[url(https://daringfireball.net/projects/markdown/)])
  \item
    \type{markua} (\goto{Markua}[url(https://leanpub.com/markua/read)])
  \item
    \type{mediawiki} (\goto{MediaWiki
    markup}[url(https://www.mediawiki.org/wiki/Help:Formatting)])
  \item
    \type{ms} (\goto{roff ms}[url(https://man.cx/groff_ms(7))])
  \item
    \type{muse} (\goto{Muse}[url(https://amusewiki.org/library/manual)])
  \item
    \type{native} (native Haskell)
  \item
    \type{odt} (\goto{OpenOffice text
    document}[url(https://en.wikipedia.org/wiki/OpenDocument)])
  \item
    \type{opml} (\goto{OPML}[url(http://dev.opml.org/spec2.html)])
  \item
    \type{opendocument}
    (\goto{OpenDocument}[url(http://opendocument.xml.org)])
  \item
    \type{org} (\goto{Emacs Org mode}[url(https://orgmode.org)])
  \item
    \type{pdf} (\goto{PDF}[url(https://www.adobe.com/pdf/)])
  \item
    \type{plain} (plain text)
  \item
    \type{pptx}
    (\goto{PowerPoint}[url(https://en.wikipedia.org/wiki/Microsoft_PowerPoint)]
    slide show)
  \item
    \type{rst}
    (\goto{reStructuredText}[url(https://docutils.sourceforge.io/docs/ref/rst/introduction.html)])
  \item
    \type{rtf} (\goto{Rich Text
    Format}[url(https://en.wikipedia.org/wiki/Rich_Text_Format)])
  \item
    \type{texinfo} (\goto{GNU
    Texinfo}[url(https://www.gnu.org/software/texinfo/)])
  \item
    \type{textile} (\goto{Textile}[url(https://textile-lang.com)])
  \item
    \type{slideous}
    (\goto{Slideous}[url(https://goessner.net/articles/slideous/)] HTML
    and JavaScript slide show)
  \item
    \type{slidy}
    (\goto{Slidy}[url(https://www.w3.org/Talks/Tools/Slidy2/)] HTML and
    JavaScript slide show)
  \item
    \type{dzslides}
    (\goto{DZSlides}[url(https://paulrouget.com/dzslides/)] HTML5 +
    JavaScript slide show)
  \item
    \type{revealjs} (\goto{reveal.js}[url(https://revealjs.com/)] HTML5
    + JavaScript slide show)
  \item
    \type{s5} (\goto{S5}[url(https://meyerweb.com/eric/tools/s5/)] HTML
    and JavaScript slide show)
  \item
    \type{tei} (\goto{TEI
    Simple}[url(https://github.com/TEIC/TEI-Simple)])
  \item
    \type{typst} (\goto{typst}[url(https://typst.app)])
  \item
    \type{xwiki} (\goto{XWiki
    markup}[url(https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/)])
  \item
    \type{zimwiki} (\goto{ZimWiki
    markup}[url(https://zim-wiki.org/manual/Help/Wiki_Syntax.html)])
  \item
    the path of a custom Lua writer, see \goto{Custom readers and
    writers}[custom-readers-and-writers] below
  \stopitemize

  Note that \type{odt}, \type{docx}, \type{epub}, and \type{pdf} output
  will not be directed to {\em stdout} unless forced with \type{-o -}.

  Extensions can be individually enabled or disabled by appending
  \type{+EXTENSION} or \type{-EXTENSION} to the format name. See
  \goto{Extensions}[extensions] below, for a list of extensions and
  their names. See \type{--list-output-formats} and
  \type{--list-extensions}, below.
\stopdescription

\startdescription{\type{-o} {\em FILE}, \type{--output=}{\em FILE}}
  Write output to {\em FILE} instead of {\em stdout}. If {\em FILE} is
  \type{-}, output will go to {\em stdout}, even if a non-textual format
  (\type{docx}, \type{odt}, \type{epub2}, \type{epub3}) is specified. If
  the output format is \type{chunkedhtml} and {\em FILE} has no
  extension, then instead of producing a \type{.zip} file pandoc will
  create a directory {\em FILE} and unpack the zip archive there (unless
  {\em FILE} already exists, in which case an error will be raised).
\stopdescription

\startdescription{\type{--data-dir=}{\em DIRECTORY}}
  Specify the user data directory to search for pandoc data files. If
  this option is not specified, the default user data directory will be
  used. On *nix and macOS systems this will be the \type{pandoc}
  subdirectory of the XDG data directory (by default,
  \type{$HOME/.local/share}, overridable by setting the
  \type{XDG_DATA_HOME} environment variable). If that directory does not
  exist and \type{$HOME/.pandoc} exists, it will be used (for backwards
  compatibility). On Windows the default user data directory is
  \type{%APPDATA%\pandoc}. You can find the default user data directory
  on your system by looking at the output of \type{pandoc --version}.
  Data files placed in this directory (for example,
  \type{reference.odt}, \type{reference.docx}, \type{epub.css},
  \type{templates}) will override pandoc's normal defaults. (Note that
  the user data directory is not created by pandoc, so you will need to
  create it yourself if you want to make use of it.)
\stopdescription

\startdescription{\type{-d} {\em FILE}, \type{--defaults=}{\em FILE}}
  Specify a set of default option settings. {\em FILE} is a YAML file
  whose fields correspond to command-line option settings. All options
  for document conversion, including input and output files, can be set
  using a defaults file. The file will be searched for first in the
  working directory, and then in the \type{defaults} subdirectory of the
  user data directory (see \type{--data-dir}). The \type{.yaml}
  extension may be omitted. See the section \goto{Defaults
  files}[defaults-files] for more information on the file format.
  Settings from the defaults file may be overridden or extended by
  subsequent options on the command line.
\stopdescription

\startdescription{\type{--bash-completion}}
  Generate a bash completion script. To enable bash completion with
  pandoc, add this to your \type{.bashrc}:

\starttyping
eval "$(pandoc --bash-completion)"
\stoptyping
\stopdescription

\startdescription{\type{--verbose}}
  Give verbose debugging output.
\stopdescription

\startdescription{\type{--quiet}}
  Suppress warning messages.
\stopdescription

\startdescription{\type{--fail-if-warnings[=true|false]}}
  Exit with error status if there are any warnings.
\stopdescription

\startdescription{\type{--log=}{\em FILE}}
  Write log messages in machine-readable JSON format to {\em FILE}. All
  messages above DEBUG level will be written, regardless of verbosity
  settings (\type{--verbose}, \type{--quiet}).
\stopdescription

\startdescription{\type{--list-input-formats}}
  List supported input formats, one per line.
\stopdescription

\startdescription{\type{--list-output-formats}}
  List supported output formats, one per line.
\stopdescription

\startdescription{\type{--list-extensions}{[}\type{=}{\em FORMAT}{]}}
  List supported extensions for {\em FORMAT}, one per line, preceded by
  a \type{+} or \type{-} indicating whether it is enabled by default in
  {\em FORMAT}. If {\em FORMAT} is not specified, defaults for pandoc's
  Markdown are given.
\stopdescription

\startdescription{\type{--list-highlight-languages}}
  List supported languages for syntax highlighting, one per line.
\stopdescription

\startdescription{\type{--list-highlight-styles}}
  List supported styles for syntax highlighting, one per line. See
  \type{--highlight-style}.
\stopdescription

\startdescription{\type{-v}, \type{--version}}
  Print version.
\stopdescription

\startdescription{\type{-h}, \type{--help}}
  Show usage message.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Reader options},reference={reader-options}]

\startdescription{\type{--shift-heading-level-by=}{\em NUMBER}}
  Shift heading levels by a positive or negative integer. For example,
  with \type{--shift-heading-level-by=-1}, level 2 headings become level
  1 headings, and level 3 headings become level 2 headings. Headings
  cannot have a level less than 1, so a heading that would be shifted
  below level 1 becomes a regular paragraph. Exception: with a shift of
  -N, a level-N heading at the beginning of the document replaces the
  metadata title. \type{--shift-heading-level-by=-1} is a good choice
  when converting HTML or Markdown documents that use an initial level-1
  heading for the document title and level-2+ headings for sections.
  \type{--shift-heading-level-by=1} may be a good choice for converting
  Markdown documents that use level-1 headings for sections to HTML,
  since pandoc uses a level-1 heading to render the document title.
\stopdescription

\startdescription{\type{--base-header-level=}{\em NUMBER}}
  {\em Deprecated. Use \type{--shift-heading-level-by}=X instead, where
  X = NUMBER - 1.} Specify the base level for headings (defaults to 1).
\stopdescription

\startdescription{\type{--indented-code-classes=}{\em CLASSES}}
  Specify classes to use for indented code blocks--for example,
  \type{perl,numberLines} or \type{haskell}. Multiple classes may be
  separated by spaces or commas.
\stopdescription

\startdescription{\type{--default-image-extension=}{\em EXTENSION}}
  Specify a default extension to use when image paths/URLs have no
  extension. This allows you to use the same source for formats that
  require different kinds of images. Currently this option only affects
  the Markdown and LaTeX readers.
\stopdescription

\startdescription{\type{--file-scope[=true|false]}}
  Parse each file individually before combining for multifile documents.
  This will allow footnotes in different files with the same identifiers
  to work as expected. If this option is set, footnotes and links will
  not work across files. Reading binary files (docx, odt, epub) implies
  \type{--file-scope}.

  If two or more files are processed using \type{--file-scope}, prefixes
  based on the filenames will be added to identifiers in order to
  disambiguate them, and internal links will be adjusted accordingly.
  For example, a header with identifier \type{foo} in
  \type{subdir/file1.txt} will have its identifier changed to
  \type{subdir__file1.txt__foo}.

  In addition, a Div with an identifier based on the filename will be
  added around the file's content, so that internal links to the
  filename will point to this Div's identifier.
\stopdescription

\startdescription{\type{-F} {\em PROGRAM}, \type{--filter=}{\em
PROGRAM}}
  Specify an executable to be used as a filter transforming the pandoc
  AST after the input is parsed and before the output is written. The
  executable should read JSON from stdin and write JSON to stdout. The
  JSON must be formatted like pandoc's own JSON input and output. The
  name of the output format will be passed to the filter as the first
  argument. Hence,

\starttyping
pandoc --filter ./caps.py -t latex
\stoptyping

  is equivalent to

\starttyping
pandoc -t json | ./caps.py latex | pandoc -f json -t latex
\stoptyping

  The latter form may be useful for debugging filters.

  Filters may be written in any language. \type{Text.Pandoc.JSON}
  exports \type{toJSONFilter} to facilitate writing filters in Haskell.
  Those who would prefer to write filters in python can use the module
  \goto{\type{pandocfilters}}[url(https://github.com/jgm/pandocfilters)],
  installable from PyPI. There are also pandoc filter libraries in
  \goto{PHP}[url(https://github.com/vinai/pandocfilters-php)],
  \goto{perl}[url(https://metacpan.org/pod/Pandoc::Filter)], and
  \goto{JavaScript/node.js}[url(https://github.com/mvhenderson/pandoc-filter-node)].

  In order of preference, pandoc will look for filters in

  \startenumerate[n][stopper=.]
  \item
    a specified full or relative path (executable or non-executable),
  \item
    \type{$DATADIR/filters} (executable or non-executable) where
    \type{$DATADIR} is the user data directory (see \type{--data-dir},
    above),
  \item
    \type{$PATH} (executable only).
  \stopenumerate

  Filters, Lua-filters, and citeproc processing are applied in the order
  specified on the command line.
\stopdescription

\startdescription{\type{-L} {\em SCRIPT}, \type{--lua-filter=}{\em
SCRIPT}}
  Transform the document in a similar fashion as JSON filters (see
  \type{--filter}), but use pandoc's built-in Lua filtering system. The
  given Lua script is expected to return a list of Lua filters which
  will be applied in order. Each Lua filter must contain
  element-transforming functions indexed by the name of the AST element
  on which the filter function should be applied.

  The \type{pandoc} Lua module provides helper functions for element
  creation. It is always loaded into the script's Lua environment.

  See the \goto{Lua filters
  documentation}[url(https://pandoc.org/lua-filters.html)] for further
  details.

  In order of preference, pandoc will look for Lua filters in

  \startenumerate[n][stopper=.]
  \item
    a specified full or relative path,
  \item
    \type{$DATADIR/filters} where \type{$DATADIR} is the user data
    directory (see \type{--data-dir}, above).
  \stopenumerate

  Filters, Lua filters, and citeproc processing are applied in the order
  specified on the command line.
\stopdescription

\startdescription{\type{-M} {\em KEY}{[}\type{=}{\em VAL}{]},
\type{--metadata=}{\em KEY}{[}\type{:}{\em VAL}{]}}
  Set the metadata field {\em KEY} to the value {\em VAL}. A value
  specified on the command line overrides a value specified in the
  document using \goto{YAML metadata
  blocks}[extension-yaml_metadata_block]. Values will be parsed as YAML
  boolean or string values. If no value is specified, the value will be
  treated as Boolean true. Like \type{--variable}, \type{--metadata}
  causes template variables to be set. But unlike \type{--variable},
  \type{--metadata} affects the metadata of the underlying document
  (which is accessible from filters and may be printed in some output
  formats) and metadata values will be escaped when inserted into the
  template.
\stopdescription

\startdescription{\type{--metadata-file=}{\em FILE}}
  Read metadata from the supplied YAML (or JSON) file. This option can
  be used with every input format, but string scalars in the metadata
  file will always be parsed as Markdown. (If the input format is
  Markdown or a Markdown variant, then the same variant will be used to
  parse the metadata file; if it is a non-Markdown format, pandoc's
  default Markdown extensions will be used.) This option can be used
  repeatedly to include multiple metadata files; values in files
  specified later on the command line will be preferred over those
  specified in earlier files. Metadata values specified inside the
  document, or by using \type{-M}, overwrite values specified with this
  option. The file will be searched for first in the working directory,
  and then in the \type{metadata} subdirectory of the user data
  directory (see \type{--data-dir}).
\stopdescription

\startdescription{\type{-p}, \type{--preserve-tabs[=true|false]}}
  Preserve tabs instead of converting them to spaces. (By default,
  pandoc converts tabs to spaces before parsing its input.) Note that
  this will only affect tabs in literal code spans and code blocks. Tabs
  in regular text are always treated as spaces.
\stopdescription

\startdescription{\type{--tab-stop=}{\em NUMBER}}
  Specify the number of spaces per tab (default is 4).
\stopdescription

\startdescription{\type{--track-changes=accept}\letterbar{}\type{reject}\letterbar{}\type{all}}
  Specifies what to do with insertions, deletions, and comments produced
  by the MS Word \quotation{Track Changes} feature. \type{accept} (the
  default) processes all the insertions and deletions. \type{reject}
  ignores them. Both \type{accept} and \type{reject} ignore comments.
  \type{all} includes all insertions, deletions, and comments, wrapped
  in spans with \type{insertion}, \type{deletion}, \type{comment-start},
  and \type{comment-end} classes, respectively. The author and time of
  change is included. \type{all} is useful for scripting: only accepting
  changes from a certain reviewer, say, or before a certain date. If a
  paragraph is inserted or deleted, \type{track-changes=all} produces a
  span with the class
  \type{paragraph-insertion}/\type{paragraph-deletion} before the
  affected paragraph break. This option only affects the docx reader.
\stopdescription

\startdescription{\type{--extract-media=}{\em DIR}}
  Extract images and other media contained in or linked from the source
  document to the path {\em DIR}, creating it if necessary, and adjust
  the images references in the document so they point to the extracted
  files. Media are downloaded, read from the file system, or extracted
  from a binary container (e.g.~docx), as needed. The original file
  paths are used if they are relative paths not containing \type{..}.
  Otherwise filenames are constructed from the SHA1 hash of the
  contents.
\stopdescription

\startdescription{\type{--abbreviations=}{\em FILE}}
  Specifies a custom abbreviations file, with abbreviations one to a
  line. If this option is not specified, pandoc will read the data file
  \type{abbreviations} from the user data directory or fall back on a
  system default. To see the system default, use
  \type{pandoc --print-default-data-file=abbreviations}. The only use
  pandoc makes of this list is in the Markdown reader. Strings found in
  this list will be followed by a nonbreaking space, and the period will
  not produce sentence-ending space in formats like LaTeX. The strings
  may not contain spaces.
\stopdescription

\startdescription{\type{--trace[=true|false]}}
  Print diagnostic output tracing parser progress to stderr. This option
  is intended for use by developers in diagnosing performance issues.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={General writer
options},reference={general-writer-options}]

\startdescription{\type{-s}, \type{--standalone}}
  Produce output with an appropriate header and footer (e.g.~a
  standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
  is set automatically for \type{pdf}, \type{epub}, \type{epub3},
  \type{fb2}, \type{docx}, and \type{odt} output. For \type{native}
  output, this option causes metadata to be included; otherwise,
  metadata is suppressed.
\stopdescription

\startdescription{\type{--template=}{\em FILE}\letterbar{}{\em URL}}
  Use the specified file as a custom template for the generated
  document. Implies \type{--standalone}. See
  \goto{Templates}[templates], below, for a description of template
  syntax. If no extension is specified, an extension corresponding to
  the writer will be added, so that \type{--template=special} looks for
  \type{special.html} for HTML output. If the template is not found,
  pandoc will search for it in the \type{templates} subdirectory of the
  user data directory (see \type{--data-dir}). If this option is not
  used, a default template appropriate for the output format will be
  used (see \type{-D/--print-default-template}).
\stopdescription

\startdescription{\type{-V} {\em KEY}{[}\type{=}{\em VAL}{]},
\type{--variable=}{\em KEY}{[}\type{:}{\em VAL}{]}}
  Set the template variable {\em KEY} to the value {\em VAL} when
  rendering the document in standalone mode. If no {\em VAL} is
  specified, the key will be given the value \type{true}.
\stopdescription

\startdescription{\type{--sandbox[=true|false]}}
  Run pandoc in a sandbox, limiting IO operations in readers and writers
  to reading the files specified on the command line. Note that this
  option does not limit IO operations by filters or in the production of
  PDF documents. But it does offer security against, for example,
  disclosure of files through the use of \type{include} directives.
  Anyone using pandoc on untrusted user input should use this option.

  Note: some readers and writers (e.g., \type{docx}) need access to data
  files. If these are stored on the file system, then pandoc will not be
  able to find them when run in \type{--sandbox} mode and will raise an
  error. For these applications, we recommend using a pandoc binary
  compiled with the \type{embed_data_files} option, which causes the
  data files to be baked into the binary instead of being stored on the
  file system.
\stopdescription

\startdescription{\type{-D} {\em FORMAT},
\type{--print-default-template=}{\em FORMAT}}
  Print the system default template for an output {\em FORMAT}. (See
  \type{-t} for a list of possible {\em FORMAT}s.) Templates in the user
  data directory are ignored. This option may be used with
  \type{-o}/\type{--output} to redirect output to a file, but
  \type{-o}/\type{--output} must come before
  \type{--print-default-template} on the command line.

  Note that some of the default templates use partials, for example
  \type{styles.html}. To print the partials, use
  \type{--print-default-data-file}: for example,
  \type{--print-default-data-file=templates/styles.html}.
\stopdescription

\startdescription{\type{--print-default-data-file=}{\em FILE}}
  Print a system default data file. Files in the user data directory are
  ignored. This option may be used with \type{-o}/\type{--output} to
  redirect output to a file, but \type{-o}/\type{--output} must come
  before \type{--print-default-data-file} on the command line.
\stopdescription

\startdescription{\type{--eol=crlf}\letterbar{}\type{lf}\letterbar{}\type{native}}
  Manually specify line endings: \type{crlf} (Windows), \type{lf}
  (macOS/Linux/UNIX), or \type{native} (line endings appropriate to the
  OS on which pandoc is being run). The default is \type{native}.
\stopdescription

\startdescription{\type{--dpi}={\em NUMBER}}
  Specify the default dpi (dots per inch) value for conversion from
  pixels to inch/centimeters and vice versa. (Technically, the correct
  term would be ppi: pixels per inch.) The default is 96dpi. When images
  contain information about dpi internally, the encoded value is used
  instead of the default specified by this option.
\stopdescription

\startdescription{\type{--wrap=auto}\letterbar{}\type{none}\letterbar{}\type{preserve}}
  Determine how text is wrapped in the output (the source code, not the
  rendered version). With \type{auto} (the default), pandoc will attempt
  to wrap lines to the column width specified by \type{--columns}
  (default 72). With \type{none}, pandoc will not wrap lines at all.
  With \type{preserve}, pandoc will attempt to preserve the wrapping
  from the source document (that is, where there are nonsemantic
  newlines in the source, there will be nonsemantic newlines in the
  output as well). In \type{ipynb} output, this option affects wrapping
  of the contents of Markdown cells.
\stopdescription

\startdescription{\type{--columns=}{\em NUMBER}}
  Specify length of lines in characters. This affects text wrapping in
  the generated source code (see \type{--wrap}). It also affects
  calculation of column widths for plain text tables (see
  \goto{Tables}[tables] below).
\stopdescription

\startdescription{\type{--toc[=true|false]},
\type{--table-of-contents[=true|false]}}
  Include an automatically generated table of contents (or, in the case
  of \type{latex}, \type{context}, \type{docx}, \type{odt},
  \type{opendocument}, \type{rst}, or \type{ms}, an instruction to
  create one) in the output document. This option has no effect unless
  \type{-s/--standalone} is used, and it has no effect on \type{man},
  \type{docbook4}, \type{docbook5}, or \type{jats} output.

  Note that if you are producing a PDF via \type{ms}, the table of
  contents will appear at the beginning of the document, before the
  title. If you would prefer it to be at the end of the document, use
  the option \type{--pdf-engine-opt=--no-toc-relocation}.
\stopdescription

\startdescription{\type{--toc-depth=}{\em NUMBER}}
  Specify the number of section levels to include in the table of
  contents. The default is 3 (which means that level-1, 2, and 3
  headings will be listed in the contents).
\stopdescription

\startdescription{\type{--strip-comments[=true|false]}}
  Strip out HTML comments in the Markdown or Textile source, rather than
  passing them on to Markdown, Textile or HTML output as raw HTML. This
  does not apply to HTML comments inside raw HTML blocks when the
  \type{markdown_in_html_blocks} extension is not set.
\stopdescription

\startdescription{\type{--no-highlight}}
  Disables syntax highlighting for code blocks and inlines, even when a
  language attribute is given.
\stopdescription

\startdescription{\type{--highlight-style=}{\em STYLE}\letterbar{}{\em
FILE}}
  Specifies the coloring style to be used in highlighted source code.
  Options are \type{pygments} (the default), \type{kate},
  \type{monochrome}, \type{breezeDark}, \type{espresso}, \type{zenburn},
  \type{haddock}, and \type{tango}. For more information on syntax
  highlighting in pandoc, see \goto{Syntax
  highlighting}[syntax-highlighting], below. See also
  \type{--list-highlight-styles}.

  Instead of a {\em STYLE} name, a JSON file with extension
  \type{.theme} may be supplied. This will be parsed as a KDE syntax
  highlighting theme and (if valid) used as the highlighting style.

  To generate the JSON version of an existing style, use
  \type{--print-highlight-style}.
\stopdescription

\startdescription{\type{--print-highlight-style=}{\em
STYLE}\letterbar{}{\em FILE}}
  Prints a JSON version of a highlighting style, which can be modified,
  saved with a \type{.theme} extension, and used with
  \type{--highlight-style}. This option may be used with
  \type{-o}/\type{--output} to redirect output to a file, but
  \type{-o}/\type{--output} must come before
  \type{--print-highlight-style} on the command line.
\stopdescription

\startdescription{\type{--syntax-definition=}{\em FILE}}
  Instructs pandoc to load a KDE XML syntax definition file, which will
  be used for syntax highlighting of appropriately marked code blocks.
  This can be used to add support for new languages or to use altered
  syntax definitions for existing languages. This option may be repeated
  to add multiple syntax definitions.
\stopdescription

\startdescription{\type{-H} {\em FILE}, \type{--include-in-header=}{\em
FILE}\letterbar{}{\em URL}}
  Include contents of {\em FILE}, verbatim, at the end of the header.
  This can be used, for example, to include special CSS or JavaScript in
  HTML documents. This option can be used repeatedly to include multiple
  files in the header. They will be included in the order specified.
  Implies \type{--standalone}.
\stopdescription

\startdescription{\type{-B} {\em FILE},
\type{--include-before-body=}{\em FILE}\letterbar{}{\em URL}}
  Include contents of {\em FILE}, verbatim, at the beginning of the
  document body (e.g.~after the \type{<body>} tag in HTML, or the
  \type"\begin{document}" command in LaTeX). This can be used to include
  navigation bars or banners in HTML documents. This option can be used
  repeatedly to include multiple files. They will be included in the
  order specified. Implies \type{--standalone}.
\stopdescription

\startdescription{\type{-A} {\em FILE}, \type{--include-after-body=}{\em
FILE}\letterbar{}{\em URL}}
  Include contents of {\em FILE}, verbatim, at the end of the document
  body (before the \type{</body>} tag in HTML, or the
  \type"\end{document}" command in LaTeX). This option can be used
  repeatedly to include multiple files. They will be included in the
  order specified. Implies \type{--standalone}.
\stopdescription

\startdescription{\type{--resource-path=}{\em SEARCHPATH}}
  List of paths to search for images and other resources. The paths
  should be separated by \type{:} on Linux, UNIX, and macOS systems, and
  by \type{;} on Windows. If \type{--resource-path} is not specified,
  the default resource path is the working directory. Note that, if
  \type{--resource-path} is specified, the working directory must be
  explicitly listed or it will not be searched. For example:
  \type{--resource-path=.:test} will search the working directory and
  the \type{test} subdirectory, in that order. This option can be used
  repeatedly. Search path components that come later on the command line
  will be searched before those that come earlier, so
  \type{--resource-path foo:bar --resource-path baz:bim} is equivalent
  to \type{--resource-path baz:bim:foo:bar}. Note that this option only
  has an effect when pandoc itself needs to find an image (e.g., in
  producing a PDF or docx, or when \type{--embed-resources} is used.) It
  will not cause image paths to be rewritten in other cases (e.g., when
  pandoc is generating LaTeX or HTML).
\stopdescription

\startdescription{\type{--request-header=}{\em NAME}\type{:}{\em VAL}}
  Set the request header {\em NAME} to the value {\em VAL} when making
  HTTP requests (for example, when a URL is given on the command line,
  or when resources used in a document must be downloaded). If you're
  behind a proxy, you also need to set the environment variable
  \type{http_proxy} to \type{http://...}.
\stopdescription

\startdescription{\type{--no-check-certificate[=true|false]}}
  Disable the certificate verification to allow access to unsecure HTTP
  resources (for example when the certificate is no longer valid or self
  signed).
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Options affecting specific
writers},reference={options-affecting-specific-writers}]

\startdescription{\type{--self-contained[=true|false]}}
  {\em Deprecated synonym for \type{--embed-resources --standalone}.}
\stopdescription

\startdescription{\type{--embed-resources[=true|false]}}
  Produce a standalone HTML file with no external dependencies, using
  \type{data:} URIs to incorporate the contents of linked scripts,
  stylesheets, images, and videos. The resulting file should be
  \quotation{self-contained,} in the sense that it needs no external
  files and no net access to be displayed properly by a browser. This
  option works only with HTML output formats, including \type{html4},
  \type{html5}, \type{html+lhs}, \type{html5+lhs}, \type{s5},
  \type{slidy}, \type{slideous}, \type{dzslides}, and \type{revealjs}.
  Scripts, images, and stylesheets at absolute URLs will be downloaded;
  those at relative URLs will be sought relative to the working
  directory (if the first source file is local) or relative to the base
  URL (if the first source file is remote). Elements with the attribute
  \type{data-external="1"} will be left alone; the documents they link
  to will not be incorporated in the document. Limitation: resources
  that are loaded dynamically through JavaScript cannot be incorporated;
  as a result, fonts may be missing when \type{--mathjax} is used, and
  some advanced features (e.g.~zoom or speaker notes) may not work in an
  offline \quotation{self-contained} \type{reveal.js} slide show.
\stopdescription

\startdescription{\type{--html-q-tags[=true|false]}}
  Use \type{<q>} tags for quotes in HTML. (This option only has an
  effect if the \type{smart} extension is enabled for the input format
  used.)
\stopdescription

\startdescription{\type{--ascii[=true|false]}}
  Use only ASCII characters in output. Currently supported for XML and
  HTML formats (which use entities instead of UTF-8 when this option is
  selected), CommonMark, gfm, and Markdown (which use entities), roff
  man and ms (which use hexadecimal escapes), and to a limited degree
  LaTeX (which uses standard commands for accented characters when
  possible).
\stopdescription

\startdescription{\type{--reference-links[=true|false]}}
  Use reference-style links, rather than inline links, in writing
  Markdown or reStructuredText. By default inline links are used. The
  placement of link references is affected by the
  \type{--reference-location} option.
\stopdescription

\startdescription{\type{--reference-location=block}\letterbar{}\type{section}\letterbar{}\type{document}}
  Specify whether footnotes (and references, if \type{reference-links}
  is set) are placed at the end of the current (top-level) block, the
  current section, or the document. The default is \type{document}.
  Currently this option only affects the \type{markdown}, \type{muse},
  \type{html}, \type{epub}, \type{slidy}, \type{s5}, \type{slideous},
  \type{dzslides}, and \type{revealjs} writers. In slide formats,
  specifying \type{--reference-location=section} will cause notes to be
  rendered at the bottom of a slide.
\stopdescription

\startdescription{\type{--markdown-headings=setext}\letterbar{}\type{atx}}
  Specify whether to use ATX-style (\type{#}-prefixed) or Setext-style
  (underlined) headings for level 1 and 2 headings in Markdown output.
  (The default is \type{atx}.) ATX-style headings are always used for
  levels 3+. This option also affects Markdown cells in \type{ipynb}
  output.
\stopdescription

\startdescription{\type{--list-tables[=true|false]}}
  Render tables as list tables in RST output.
\stopdescription

\startdescription{\type{--top-level-division=default}\letterbar{}\type{section}\letterbar{}\type{chapter}\letterbar{}\type{part}}
  Treat top-level headings as the given division type in LaTeX, ConTeXt,
  DocBook, and TEI output. The hierarchy order is part, chapter, then
  section; all headings are shifted such that the top-level heading
  becomes the specified type. The default behavior is to determine the
  best division type via heuristics: unless other conditions apply,
  \type{section} is chosen. When the \type{documentclass} variable is
  set to \type{report}, \type{book}, or \type{memoir} (unless the
  \type{article} option is specified), \type{chapter} is implied as the
  setting for this option. If \type{beamer} is the output format,
  specifying either \type{chapter} or \type{part} will cause top-level
  headings to become \type"\part{..}", while second-level headings
  remain as their default type.
\stopdescription

\startdescription{\type{-N}, \type{--number-sections}}
  Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
  output. By default, sections are not numbered. Sections with class
  \type{unnumbered} will never be numbered, even if
  \type{--number-sections} is specified.
\stopdescription

\startdescription{\type{--number-offset=}{\em NUMBER}{[}\type{,}{\em
NUMBER}\type{,}{\em \ldots{}}{]}}
  Offset for section headings in HTML output (ignored in other output
  formats). The first number is added to the section number for
  top-level headings, the second for second-level headings, and so on.
  So, for example, if you want the first top-level heading in your
  document to be numbered \quotation{6}, specify
  \type{--number-offset=5}. If your document starts with a level-2
  heading which you want to be numbered \quotation{1.5}, specify
  \type{--number-offset=1,4}. Offsets are 0 by default. Implies
  \type{--number-sections}.
\stopdescription

\startdescription{\type{--listings[=true|false]}}
  Use the \goto{\type{listings}}[url(https://ctan.org/pkg/listings)]
  package for LaTeX code blocks. The package does not support multi-byte
  encoding for source code. To handle UTF-8 you would need to use a
  custom template. This issue is fully documented here: \goto{Encoding
  issue with the listings
  package}[url(https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings\#Encoding_issue)].
\stopdescription

\startdescription{\type{-i}, \type{--incremental[=true|false]}}
  Make list items in slide shows display incrementally (one by one). The
  default is for lists to be displayed all at once.
\stopdescription

\startdescription{\type{--slide-level=}{\em NUMBER}}
  Specifies that headings with the specified level create slides (for
  \type{beamer}, \type{s5}, \type{slidy}, \type{slideous},
  \type{dzslides}). Headings above this level in the hierarchy are used
  to divide the slide show into sections; headings below this level
  create subheads within a slide. Valid values are 0-6. If a slide level
  of 0 is specified, slides will not be split automatically on headings,
  and horizontal rules must be used to indicate slide boundaries. If a
  slide level is not specified explicitly, the slide level will be set
  automatically based on the contents of the document; see
  \goto{Structuring the slide show}[structuring-the-slide-show].
\stopdescription

\startdescription{\type{--section-divs[=true|false]}}
  Wrap sections in \type{<section>} tags (or \type{<div>} tags for
  \type{html4}), and attach identifiers to the enclosing
  \type{<section>} (or \type{<div>}) rather than the heading itself (see
  \goto{Heading identifiers}[heading-identifiers], below). This option
  only affects HTML output (and does not affect HTML slide formats).
\stopdescription

\startdescription{\type{--email-obfuscation=none}\letterbar{}\type{javascript}\letterbar{}\type{references}}
  Specify a method for obfuscating \type{mailto:} links in HTML
  documents. \type{none} leaves \type{mailto:} links as they are.
  \type{javascript} obfuscates them using JavaScript. \type{references}
  obfuscates them by printing their letters as decimal or hexadecimal
  character references. The default is \type{none}.
\stopdescription

\startdescription{\type{--id-prefix=}{\em STRING}}
  Specify a prefix to be added to all identifiers and internal links in
  HTML and DocBook output, and to footnote numbers in Markdown and
  Haddock output. This is useful for preventing duplicate identifiers
  when generating fragments to be included in other pages.
\stopdescription

\startdescription{\type{-T} {\em STRING}, \type{--title-prefix=}{\em
STRING}}
  Specify {\em STRING} as a prefix at the beginning of the title that
  appears in the HTML header (but not in the title as it appears at the
  beginning of the HTML body). Implies \type{--standalone}.
\stopdescription

\startdescription{\type{-c} {\em URL}, \type{--css=}{\em URL}}
  Link to a CSS style sheet. This option can be used repeatedly to
  include multiple files. They will be included in the order specified.
  This option only affects HTML (including HTML slide shows) and EPUB
  output. It should be used together with \type{-s/--standalone},
  because the link to the stylesheet goes in the document header.

  A stylesheet is required for generating EPUB. If none is provided
  using this option (or the \type{css} or \type{stylesheet} metadata
  fields), pandoc will look for a file \type{epub.css} in the user data
  directory (see \type{--data-dir}). If it is not found there, sensible
  defaults will be used.
\stopdescription

\startdescription{\type{--reference-doc=}{\em FILE}\letterbar{}{\em
URL}}
  Use the specified file as a style reference in producing a docx or ODT
  file.

  \startdescription{Docx}
    For best results, the reference docx should be a modified version of
    a docx file produced using pandoc. The contents of the reference
    docx are ignored, but its stylesheets and document properties
    (including margins, page size, header, and footer) are used in the
    new docx. If no reference docx is specified on the command line,
    pandoc will look for a file \type{reference.docx} in the user data
    directory (see \type{--data-dir}). If this is not found either,
    sensible defaults will be used.

    To produce a custom \type{reference.docx}, first get a copy of the
    default \type{reference.docx}:
    \type{pandoc -o custom-reference.docx --print-default-data-file reference.docx}.
    Then open \type{custom-reference.docx} in Word, modify the styles as
    you wish, and save the file. For best results, do not make changes
    to this file other than modifying the styles used by pandoc:

    Paragraph styles:

    \startitemize[packed]
    \item
      Normal
    \item
      Body Text
    \item
      First Paragraph
    \item
      Compact
    \item
      Title
    \item
      Subtitle
    \item
      Author
    \item
      Date
    \item
      Abstract
    \item
      AbstractTitle
    \item
      Bibliography
    \item
      Heading 1
    \item
      Heading 2
    \item
      Heading 3
    \item
      Heading 4
    \item
      Heading 5
    \item
      Heading 6
    \item
      Heading 7
    \item
      Heading 8
    \item
      Heading 9
    \item
      Block Text {[}for block quotes{]}
    \item
      Footnote Block Text {[}for block quotes in footnotes{]}
    \item
      Source Code
    \item
      Footnote Text
    \item
      Definition Term
    \item
      Definition
    \item
      Caption
    \item
      Table Caption
    \item
      Image Caption
    \item
      Figure
    \item
      Captioned Figure
    \item
      TOC Heading
    \stopitemize

    Character styles:

    \startitemize[packed]
    \item
      Default Paragraph Font
    \item
      Body Text Char
    \item
      Verbatim Char
    \item
      Footnote Reference
    \item
      Hyperlink
    \item
      Section Number
    \stopitemize

    Table style:

    \startitemize[packed]
    \item
      Table
    \stopitemize
  \stopdescription

  \startdescription{ODT}
    For best results, the reference ODT should be a modified version of
    an ODT produced using pandoc. The contents of the reference ODT are
    ignored, but its stylesheets are used in the new ODT. If no
    reference ODT is specified on the command line, pandoc will look for
    a file \type{reference.odt} in the user data directory (see
    \type{--data-dir}). If this is not found either, sensible defaults
    will be used.

    To produce a custom \type{reference.odt}, first get a copy of the
    default \type{reference.odt}:
    \type{pandoc -o custom-reference.odt --print-default-data-file reference.odt}.
    Then open \type{custom-reference.odt} in LibreOffice, modify the
    styles as you wish, and save the file.
  \stopdescription

  \startdescription{PowerPoint}
    Templates included with Microsoft PowerPoint 2013 (either with
    \type{.pptx} or \type{.potx} extension) are known to work, as are
    most templates derived from these.

    The specific requirement is that the template should contain layouts
    with the following names (as seen within PowerPoint):

    \startitemize[packed]
    \item
      Title Slide
    \item
      Title and Content
    \item
      Section Header
    \item
      Two Content
    \item
      Comparison
    \item
      Content with Caption
    \item
      Blank
    \stopitemize

    For each name, the first layout found with that name will be used.
    If no layout is found with one of the names, pandoc will output a
    warning and use the layout with that name from the default reference
    doc instead. (How these layouts are used is described in
    \goto{PowerPoint layout choice}[powerpoint-layout-choice].)

    All templates included with a recent version of MS PowerPoint will
    fit these criteria. (You can click on \type{Layout} under the
    \type{Home} menu to check.)

    You can also modify the default \type{reference.pptx}: first run
    \type{pandoc -o custom-reference.pptx --print-default-data-file reference.pptx},
    and then modify \type{custom-reference.pptx} in MS PowerPoint
    (pandoc will use the layouts with the names listed above).
  \stopdescription
\stopdescription

\startdescription{\type{--split-level=}{\em NUMBER}}
  Specify the heading level at which to split an EPUB or chunked HTML
  document into separate files. The default is to split into chapters at
  level-1 headings. In the case of EPUB, this option only affects the
  internal composition of the EPUB, not the way chapters and sections
  are displayed to users. Some readers may be slow if the chapter files
  are too large, so for large documents with few level-1 headings, one
  might want to use a chapter level of 2 or 3. For chunked HTML, this
  option determines how much content goes in each \quotation{chunk.}
\stopdescription

\startdescription{\type{--chunk-template=}{\em PATHTEMPLATE}}
  Specify a template for the filenames in a \type{chunkedhtml} document.
  In the template, \type{%n} will be replaced by the chunk number
  (padded with leading 0s to 3 digits), \type{%s} with the section
  number of the chunk, \type{%h} with the heading text (with formatting
  removed), \type{%i} with the section identifier. For example,
  \type{%section-%s-%i.html} might be resolved to
  \type{section-1.1-introduction.html}. The characters \type{/} and
  \type{\} are not allowed in chunk templates and will be ignored. The
  default is \type{%s-%i.html}.
\stopdescription

\startdescription{\type{--epub-chapter-level=}{\em NUMBER}}
  {\em Deprecated synonym for \type{--split-level}.}
\stopdescription

\startdescription{\type{--epub-cover-image=}{\em FILE}}
  Use the specified image as the EPUB cover. It is recommended that the
  image be less than 1000px in width and height. Note that in a Markdown
  source document you can also specify \type{cover-image} in a YAML
  metadata block (see \goto{EPUB Metadata}[epub-metadata], below).
\stopdescription

\startdescription{\type{--epub-title-page=true}\letterbar{}\type{false}}
  Determines whether a the title page is included in the EPUB (default
  is \type{true}).
\stopdescription

\startdescription{\type{--epub-metadata=}{\em FILE}}
  Look in the specified XML file for metadata for the EPUB. The file
  should contain a series of \goto{Dublin Core
  elements}[url(https://www.dublincore.org/specifications/dublin-core/dces/)].
  For example:

\starttyping
 <dc:rights>Creative Commons</dc:rights>
 <dc:language>es-AR</dc:language>
\stoptyping

  By default, pandoc will include the following metadata elements:
  \type{<dc:title>} (from the document title), \type{<dc:creator>} (from
  the document authors), \type{<dc:date>} (from the document date, which
  should be in \goto{ISO 8601
  format}[url(https://www.w3.org/TR/NOTE-datetime)]),
  \type{<dc:language>} (from the \type{lang} variable, or, if is not
  set, the locale), and \type{<dc:identifier id="BookId">} (a randomly
  generated UUID). Any of these may be overridden by elements in the
  metadata file.

  Note: if the source document is Markdown, a YAML metadata block in the
  document can be used instead. See below under \goto{EPUB
  Metadata}[epub-metadata].
\stopdescription

\startdescription{\type{--epub-embed-font=}{\em FILE}}
  Embed the specified font in the EPUB. This option can be repeated to
  embed multiple fonts. Wildcards can also be used: for example,
  \type{DejaVuSans-*.ttf}. However, if you use wildcards on the command
  line, be sure to escape them or put the whole filename in single
  quotes, to prevent them from being interpreted by the shell. To use
  the embedded fonts, you will need to add declarations like the
  following to your CSS (see \type{--css}):

\starttyping
@font-face {
   font-family: DejaVuSans;
   font-style: normal;
   font-weight: normal;
   src:url("../fonts/DejaVuSans-Regular.ttf");
}
@font-face {
   font-family: DejaVuSans;
   font-style: normal;
   font-weight: bold;
   src:url("../fonts/DejaVuSans-Bold.ttf");
}
@font-face {
   font-family: DejaVuSans;
   font-style: italic;
   font-weight: normal;
   src:url("../fonts/DejaVuSans-Oblique.ttf");
}
@font-face {
   font-family: DejaVuSans;
   font-style: italic;
   font-weight: bold;
   src:url("../fonts/DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }
\stoptyping
\stopdescription

\startdescription{\type{--epub-subdirectory=}{\em DIRNAME}}
  Specify the subdirectory in the OCF container that is to hold the
  EPUB-specific contents. The default is \type{EPUB}. To put the EPUB
  contents in the top level, use an empty string.
\stopdescription

\startdescription{\type{--ipynb-output=all|none|best}}
  Determines how ipynb output cells are treated. \type{all} means that
  all of the data formats included in the original are preserved.
  \type{none} means that the contents of data cells are omitted.
  \type{best} causes pandoc to try to pick the richest data block in
  each output cell that is compatible with the output format. The
  default is \type{best}.
\stopdescription

\startdescription{\type{--pdf-engine=}{\em PROGRAM}}
  Use the specified engine when producing PDF output. Valid values are
  \type{pdflatex}, \type{lualatex}, \type{xelatex}, \type{latexmk},
  \type{tectonic}, \type{wkhtmltopdf}, \type{weasyprint},
  \type{pagedjs-cli}, \type{prince}, \type{context}, \type{pdfroff}, and
  \type{typst}. If the engine is not in your PATH, the full path of the
  engine may be specified here. If this option is not specified, pandoc
  uses the following defaults depending on the output format specified
  using \type{-t/--to}:

  \startitemize[packed]
  \item
    \type{-t latex} or none: \type{pdflatex} (other options:
    \type{xelatex}, \type{lualatex}, \type{tectonic}, \type{latexmk})
  \item
    \type{-t context}: \type{context}
  \item
    \type{-t html}: \type{wkhtmltopdf} (other options: \type{prince},
    \type{weasyprint}, \type{pagedjs-cli}; see
    \goto{print-css.rocks}[url(https://print-css.rocks)] for a good
    introduction to PDF generation from HTML/CSS)
  \item
    \type{-t ms}: \type{pdfroff}
  \item
    \type{-t typst}: \type{typst}
  \stopitemize
\stopdescription

\startdescription{\type{--pdf-engine-opt=}{\em STRING}}
  Use the given string as a command-line argument to the
  \type{pdf-engine}. For example, to use a persistent directory
  \type{foo} for \type{latexmk}'s auxiliary files, use
  \type{--pdf-engine-opt=-outdir=foo}. Note that no check for duplicate
  options is done.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Citation
rendering},reference={citation-rendering}]

\startdescription{\type{-C}, \type{--citeproc}}
  Process the citations in the file, replacing them with rendered
  citations and adding a bibliography. Citation processing will not take
  place unless bibliographic data is supplied, either through an
  external file specified using the \type{--bibliography} option or the
  \type{bibliography} field in metadata, or via a \type{references}
  section in metadata containing a list of citations in CSL YAML format
  with Markdown formatting. The style is controlled by a
  \goto{CSL}[url(https://docs.citationstyles.org/en/stable/specification.html)]
  stylesheet specified using the \type{--csl} option or the \type{csl}
  field in metadata. (If no stylesheet is specified, the
  \type{chicago-author-date} style will be used by default.) The
  citation processing transformation may be applied before or after
  filters or Lua filters (see \type{--filter}, \type{--lua-filter}):
  these transformations are applied in the order they appear on the
  command line. For more information, see the section on
  \goto{Citations}[citations].
\stopdescription

\startdescription{\type{--bibliography=}{\em FILE}}
  Set the \type{bibliography} field in the document's metadata to {\em
  FILE}, overriding any value set in the metadata. If you supply this
  argument multiple times, each {\em FILE} will be added to
  bibliography. If {\em FILE} is a URL, it will be fetched via HTTP. If
  {\em FILE} is not found relative to the working directory, it will be
  sought in the resource path (see \type{--resource-path}).
\stopdescription

\startdescription{\type{--csl=}{\em FILE}}
  Set the \type{csl} field in the document's metadata to {\em FILE},
  overriding any value set in the metadata. (This is equivalent to
  \type{--metadata csl=FILE}.) If {\em FILE} is a URL, it will be
  fetched via HTTP. If {\em FILE} is not found relative to the working
  directory, it will be sought in the resource path (see
  \type{--resource-path}) and finally in the \type{csl} subdirectory of
  the pandoc user data directory.
\stopdescription

\startdescription{\type{--citation-abbreviations=}{\em FILE}}
  Set the \type{citation-abbreviations} field in the document's metadata
  to {\em FILE}, overriding any value set in the metadata. (This is
  equivalent to \type{--metadata citation-abbreviations=FILE}.) If {\em
  FILE} is a URL, it will be fetched via HTTP. If {\em FILE} is not
  found relative to the working directory, it will be sought in the
  resource path (see \type{--resource-path}) and finally in the
  \type{csl} subdirectory of the pandoc user data directory.
\stopdescription

\startdescription{\type{--natbib}}
  Use \goto{\type{natbib}}[url(https://ctan.org/pkg/natbib)] for
  citations in LaTeX output. This option is not for use with the
  \type{--citeproc} option or with PDF output. It is intended for use in
  producing a LaTeX file that can be processed with
  \goto{\type{bibtex}}[url(https://ctan.org/pkg/bibtex)].
\stopdescription

\startdescription{\type{--biblatex}}
  Use \goto{\type{biblatex}}[url(https://ctan.org/pkg/biblatex)] for
  citations in LaTeX output. This option is not for use with the
  \type{--citeproc} option or with PDF output. It is intended for use in
  producing a LaTeX file that can be processed with
  \goto{\type{bibtex}}[url(https://ctan.org/pkg/bibtex)] or
  \goto{\type{biber}}[url(https://ctan.org/pkg/biber)].
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Math rendering in
HTML},reference={math-rendering-in-html}]

The default is to render TeX math as far as possible using Unicode
characters. Formulas are put inside a \type{span} with
\type{class="math"}, so that they may be styled differently from the
surrounding text if needed. However, this gives acceptable results only
for basic math, usually you will want to use \type{--mathjax} or another
of the following options.

\startdescription{\type{--mathjax}{[}\type{=}{\em URL}{]}}
  Use \goto{MathJax}[url(https://www.mathjax.org)] to display embedded
  TeX math in HTML output. TeX math will be put between \type{\(...\)}
  (for inline math) or \type{\[...\]} (for display math) and wrapped in
  \type{<span>} tags with class \type{math}. Then the MathJax JavaScript
  will render it. The {\em URL} should point to the \type{MathJax.js}
  load script. If a {\em URL} is not provided, a link to the Cloudflare
  CDN will be inserted.
\stopdescription

\startdescription{\type{--mathml}}
  Convert TeX math to \goto{MathML}[url(https://www.w3.org/Math/)] (in
  \type{epub3}, \type{docbook4}, \type{docbook5}, \type{jats},
  \type{html4} and \type{html5}). This is the default in \type{odt}
  output. MathML is supported natively by the main web browsers and
  select e-book readers.
\stopdescription

\startdescription{\type{--webtex}{[}\type{=}{\em URL}{]}}
  Convert TeX formulas to \type{<img>} tags that link to an external
  script that converts formulas to images. The formula will be
  URL-encoded and concatenated with the URL provided. For SVG images you
  can for example use
  \type{--webtex https://latex.codecogs.com/svg.latex?}. If no URL is
  specified, the CodeCogs URL generating PNGs will be used
  (\type{https://latex.codecogs.com/png.latex?}). Note: the
  \type{--webtex} option will affect Markdown output as well as HTML,
  which is useful if you're targeting a version of Markdown without
  native math support.
\stopdescription

\startdescription{\type{--katex}{[}\type{=}{\em URL}{]}}
  Use \goto{KaTeX}[url(https://github.com/Khan/KaTeX)] to display
  embedded TeX math in HTML output. The {\em URL} is the base URL for
  the KaTeX library. That directory should contain a \type{katex.min.js}
  and a \type{katex.min.css} file. If a {\em URL} is not provided, a
  link to the KaTeX CDN will be inserted.
\stopdescription

\startdescription{\type{--gladtex}}
  Enclose TeX math in \type{<eq>} tags in HTML output. The resulting
  HTML can then be processed by
  \goto{GladTeX}[url(https://humenda.github.io/GladTeX/)] to produce SVG
  images of the typeset formulas and an HTML file with these images
  embedded.

\starttyping
pandoc -s --gladtex input.md -o myfile.htex
gladtex -d image_dir myfile.htex
# produces myfile.html and images in image_dir
\stoptyping
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Options for wrapper
scripts},reference={options-for-wrapper-scripts}]

\startdescription{\type{--dump-args[=true|false]}}
  Print information about command-line arguments to {\em stdout}, then
  exit. This option is intended primarily for use in wrapper scripts.
  The first line of output contains the name of the output file
  specified with the \type{-o} option, or \type{-} (for {\em stdout}) if
  no output file was specified. The remaining lines contain the
  command-line arguments, one per line, in the order they appear. These
  do not include regular pandoc options and their arguments, but do
  include any options appearing after a \type{--} separator at the end
  of the line.
\stopdescription

\startdescription{\type{--ignore-args[=true|false]}}
  Ignore command-line arguments (for use in wrapper scripts). Regular
  pandoc options are not ignored. Thus, for example,

\starttyping
pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
\stoptyping

  is equivalent to

\starttyping
pandoc -o foo.html -s
\stoptyping
\stopdescription

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Exit codes},reference={exit-codes}]

If pandoc completes successfully, it will return exit code 0. Nonzero
exit codes have the following meanings:

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=left] Code \stopxcell
\startxcell[align=right] Error \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=left] 1 \stopxcell
\startxcell[align=right] PandocIOError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 3 \stopxcell
\startxcell[align=right] PandocFailOnWarningError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 4 \stopxcell
\startxcell[align=right] PandocAppError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 5 \stopxcell
\startxcell[align=right] PandocTemplateError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 6 \stopxcell
\startxcell[align=right] PandocOptionError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 21 \stopxcell
\startxcell[align=right] PandocUnknownReaderError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 22 \stopxcell
\startxcell[align=right] PandocUnknownWriterError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 23 \stopxcell
\startxcell[align=right] PandocUnsupportedExtensionError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 24 \stopxcell
\startxcell[align=right] PandocCiteprocError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 25 \stopxcell
\startxcell[align=right] PandocBibliographyError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 31 \stopxcell
\startxcell[align=right] PandocEpubSubdirectoryError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 43 \stopxcell
\startxcell[align=right] PandocPDFError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 44 \stopxcell
\startxcell[align=right] PandocXMLError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 47 \stopxcell
\startxcell[align=right] PandocPDFProgramNotFoundError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 61 \stopxcell
\startxcell[align=right] PandocHttpError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 62 \stopxcell
\startxcell[align=right] PandocShouldNeverHappenError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 63 \stopxcell
\startxcell[align=right] PandocSomeError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 64 \stopxcell
\startxcell[align=right] PandocParseError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 66 \stopxcell
\startxcell[align=right] PandocMakePDFError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 67 \stopxcell
\startxcell[align=right] PandocSyntaxMapError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 83 \stopxcell
\startxcell[align=right] PandocFilterError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 84 \stopxcell
\startxcell[align=right] PandocLuaError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 89 \stopxcell
\startxcell[align=right] PandocNoScriptingEngine \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 91 \stopxcell
\startxcell[align=right] PandocMacroLoop \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 92 \stopxcell
\startxcell[align=right] PandocUTF8DecodingError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 93 \stopxcell
\startxcell[align=right] PandocIpynbDecodingError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 94 \stopxcell
\startxcell[align=right] PandocUnsupportedCharsetError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 97 \stopxcell
\startxcell[align=right] PandocCouldNotFindDataFileError \stopxcell
\stopxrow
\startxrow
\startxcell[align=left] 98 \stopxcell
\startxcell[align=right] PandocCouldNotFindMetadataFileError \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=left] 99 \stopxcell
\startxcell[align=right] PandocResourceNotFound \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\stopsectionlevel

\startsectionlevel[title={Defaults files},reference={defaults-files}]

The \type{--defaults} option may be used to specify a package of
options, in the form of a YAML file.

Fields that are omitted will just have their regular default values. So
a defaults file can be as simple as one line:

\starthighlighting
/BTEX\FunctionTok{verbosity}\KeywordTok{:}\AttributeTok{ INFO}/ETEX
\stophighlighting

In fields that expect a file path (or list of file paths), the following
syntax may be used to interpolate environment variables:

\starthighlighting
/BTEX\FunctionTok{csl}\KeywordTok{:}\AttributeTok{ { }\letterdollar{}\letteropenbrace{}HOME\letterclosebrace{}\letterslash{}mycsldir\letterslash{}special.csl}/ETEX
\stophighlighting

\type"${USERDATA}" may also be used; this will always resolve to the
user data directory that is current when the defaults file is parsed,
regardless of the setting of the environment variable \type{USERDATA}.

\type"${.}" will resolve to the directory containing the defaults file
itself. This allows you to refer to resources contained in that
directory:

\starthighlighting
/BTEX\FunctionTok{epub-cover-image}\KeywordTok{:}\AttributeTok{ \letterdollar{}\letteropenbrace{}.\letterclosebrace{}\letterslash{}cover.jpg}/ETEX
/BTEX\FunctionTok{epub-metadata}\KeywordTok{:}\AttributeTok{ \letterdollar{}\letteropenbrace{}.\letterclosebrace{}\letterslash{}meta.xml}/ETEX
/BTEX\FunctionTok{resource-path}\KeywordTok{:}/ETEX
/BTEX\KeywordTok{-}\AttributeTok{ .}\CommentTok{ { } { } { } { } { } { } \letterhash{} the working directory from which pandoc is run}/ETEX
/BTEX\KeywordTok{-}\AttributeTok{ \letterdollar{}\letteropenbrace{}.\letterclosebrace{}\letterslash{}images}\CommentTok{ { } \letterhash{} the images subdirectory of the directory}/ETEX
/BTEX\CommentTok{ { } { } { } { } { } { } { } { }\letterhash{} containing this defaults file}/ETEX
\stophighlighting

This environment variable interpolation syntax {\em only} works in
fields that expect file paths.

Defaults files can be placed in the \type{defaults} subdirectory of the
user data directory and used from any directory. For example, one could
create a file specifying defaults for writing letters, save it as
\type{letter.yaml} in the \type{defaults} subdirectory of the user data
directory, and then invoke these defaults from any directory using
\type{pandoc --defaults letter} or \type{pandoc -dletter}.

When multiple defaults are used, their contents will be combined.

Note that, where command-line arguments may be repeated
(\type{--metadata-file}, \type{--css}, \type{--include-in-header},
\type{--include-before-body}, \type{--include-after-body},
\type{--variable}, \type{--metadata}, \type{--syntax-definition}), the
values specified on the command line will combine with values specified
in the defaults file, rather than replacing them.

The following tables show the mapping between the command line and
defaults file entries.

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
foo.md
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{input-file}\KeywordTok{:}\AttributeTok{ foo.md}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
foo.md bar.md

\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{input-files}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ foo.md}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ bar.md}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

The value of \type{input-files} may be left empty to indicate input from
stdin, and it can be an empty sequence \type{[]} for no input.

\startsectionlevel[title={General
options},reference={general-options-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--from markdown+emoji
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{from}\KeywordTok{:}\AttributeTok{ markdown+emoji}/ETEX
\stophighlighting

\starthighlighting
/BTEX\FunctionTok{reader}\KeywordTok{:}\AttributeTok{ markdown+emoji}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--to markdown+hard_line_breaks
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{to}\KeywordTok{:}\AttributeTok{ markdown+hard\letterunderscore{}line\letterunderscore{}breaks}/ETEX
\stophighlighting

\starthighlighting
/BTEX\FunctionTok{writer}\KeywordTok{:}\AttributeTok{ markdown+hard\letterunderscore{}line\letterunderscore{}breaks}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--output foo.pdf
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{output-file}\KeywordTok{:}\AttributeTok{ foo.pdf}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--output -
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{output-file}\KeywordTok{:}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--data-dir dir
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{data-dir}\KeywordTok{:}\AttributeTok{ dir}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--defaults file
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{defaults}\KeywordTok{:}/ETEX
/BTEX\KeywordTok{-}\AttributeTok{ file}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--verbose
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{verbosity}\KeywordTok{:}\AttributeTok{ INFO}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--quiet
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{verbosity}\KeywordTok{:}\AttributeTok{ ERROR}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--fail-if-warnings
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{fail-if-warnings}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--sandbox
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{sandbox}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--log=FILE
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{log-file}\KeywordTok{:}\AttributeTok{ FILE}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

Options specified in a defaults file itself always have priority over
those in another file included with a \type{defaults:} entry.

\type{verbosity} can have the values \type{ERROR}, \type{WARNING}, or
\type{INFO}.

\stopsectionlevel

\startsectionlevel[title={Reader options},reference={reader-options-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--shift-heading-level-by -1
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{shift-heading-level-by}\KeywordTok{:}\AttributeTok{ }\DecValTok{-1}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--indented-code-classes python
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{indented-code-classes}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ python}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--default-image-extension ".jpg"
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{default-image-extension}\KeywordTok{:}\AttributeTok{ }\StringTok{'.jpg'}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--file-scope
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{file-scope}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--citeproc \
 --lua-filter count-words.lua \
 --filter special.lua

\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{filters}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ citeproc}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ count-words.lua}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ }\FunctionTok{type}\KeywordTok{:}\AttributeTok{ json}/ETEX
/BTEX\AttributeTok{ { } { }}\FunctionTok{path}\KeywordTok{:}\AttributeTok{ special.lua}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--metadata key=value \
 --metadata key2
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{metadata}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{key}\KeywordTok{:}\AttributeTok{ value}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{key2}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--metadata-file meta.yaml
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{metadata-files}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ meta.yaml}/ETEX
\stophighlighting

\starthighlighting
/BTEX\FunctionTok{metadata-file}\KeywordTok{:}\AttributeTok{ meta.yaml}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--preserve-tabs
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{preserve-tabs}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--tab-stop 8
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{tab-stop}\KeywordTok{:}\AttributeTok{ }\DecValTok{8}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--track-changes accept
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{track-changes}\KeywordTok{:}\AttributeTok{ accept}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--extract-media dir
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{extract-media}\KeywordTok{:}\AttributeTok{ dir}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--abbreviations abbrevs.txt
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{abbreviations}\KeywordTok{:}\AttributeTok{ abbrevs.txt}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--trace
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{trace}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

Metadata values specified in a defaults file are parsed as literal
string text, not Markdown.

Filters will be assumed to be Lua filters if they have the \type{.lua}
extension, and JSON filters otherwise. But the filter type can also be
specified explicitly, as shown. Filters are run in the order specified.
To include the built-in citeproc filter, use either \type{citeproc} or
\type"{type: citeproc}".

\stopsectionlevel

\startsectionlevel[title={General writer
options},reference={general-writer-options-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--standalone
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{standalone}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--template letter
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{template}\KeywordTok{:}\AttributeTok{ letter}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--variable key=val \
  --variable key2
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{variables}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{key}\KeywordTok{:}\AttributeTok{ val}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{key2}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--eol nl
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{eol}\KeywordTok{:}\AttributeTok{ nl}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--dpi 300
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{dpi}\KeywordTok{:}\AttributeTok{ }\DecValTok{300}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--wrap 60
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{wrap}\KeywordTok{:}\AttributeTok{ }\DecValTok{60}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--columns 72
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{columns}\KeywordTok{:}\AttributeTok{ }\DecValTok{72}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--table-of-contents
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{table-of-contents}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--toc
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{toc}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--toc-depth 3
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{toc-depth}\KeywordTok{:}\AttributeTok{ }\DecValTok{3}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--strip-comments
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{strip-comments}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--no-highlight
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{highlight-style}\KeywordTok{:}\AttributeTok{ }\CharTok{null}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--highlight-style kate
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{highlight-style}\KeywordTok{:}\AttributeTok{ kate}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--syntax-definition mylang.xml
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{syntax-definitions}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ mylang.xml}/ETEX
\stophighlighting

\starthighlighting
/BTEX\FunctionTok{syntax-definition}\KeywordTok{:}\AttributeTok{ mylang.xml}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--include-in-header inc.tex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{include-in-header}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ inc.tex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--include-before-body inc.tex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{include-before-body}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ inc.tex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--include-after-body inc.tex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{include-after-body}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ inc.tex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--resource-path .:foo
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{resource-path}\KeywordTok{:}\AttributeTok{ }\KeywordTok{[}\StringTok{'.'}\KeywordTok{,}\StringTok{'foo'}\KeywordTok{]}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--request-header foo:bar
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{request-headers}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ }\KeywordTok{[}\StringTok{"User-Agent"}\KeywordTok{,}\AttributeTok{ }\StringTok{"Mozilla\letterslash{}5.0"}\KeywordTok{]}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--no-check-certificate
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{no-check-certificate}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\stopsectionlevel

\startsectionlevel[title={Options affecting specific
writers},reference={options-affecting-specific-writers-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--self-contained
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{self-contained}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--html-q-tags
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-q-tags}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--ascii
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{ascii}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--reference-links
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{reference-links}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--reference-location block
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{reference-location}\KeywordTok{:}\AttributeTok{ block}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--markdown-headings atx
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{markdown-headings}\KeywordTok{:}\AttributeTok{ atx}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--list-tables
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{list-tables}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--top-level-division chapter
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{top-level-division}\KeywordTok{:}\AttributeTok{ chapter}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--number-sections
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{number-sections}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--number-offset=1,4
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{number-offset}\KeywordTok{:}\AttributeTok{ \letterbackslash{}[1,4\letterbackslash{}]}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--listings
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{listings}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--incremental
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{incremental}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--slide-level 2
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{slide-level}\KeywordTok{:}\AttributeTok{ }\DecValTok{2}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--section-divs
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{section-divs}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--email-obfuscation references
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{email-obfuscation}\KeywordTok{:}\AttributeTok{ references}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--id-prefix ch1
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{identifier-prefix}\KeywordTok{:}\AttributeTok{ ch1}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--title-prefix MySite
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{title-prefix}\KeywordTok{:}\AttributeTok{ MySite}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--css styles/screen.css  \
  --css styles/special.css
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{css}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ styles\letterslash{}screen.css}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ styles\letterslash{}special.css}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--reference-doc my.docx
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{reference-doc}\KeywordTok{:}\AttributeTok{ my.docx}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--epub-cover-image cover.jpg
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{epub-cover-image}\KeywordTok{:}\AttributeTok{ cover.jpg}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--epub-title-page=false
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{epub-title-page}\KeywordTok{:}\AttributeTok{ }\CharTok{false}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--epub-metadata meta.xml
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{epub-metadata}\KeywordTok{:}\AttributeTok{ meta.xml}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--epub-embed-font special.otf \
  --epub-embed-font headline.otf
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{epub-fonts}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ special.otf}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ headline.otf}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--split-level 2
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{split-level}\KeywordTok{:}\AttributeTok{ }\DecValTok{2}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--chunk-template="%i.html"
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{chunk-template}\KeywordTok{:}\AttributeTok{ }\StringTok{"\letterpercent{}i.html"}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--epub-subdirectory=""
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{epub-subdirectory}\KeywordTok{:}\AttributeTok{ }\StringTok{''}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--ipynb-output best
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{ipynb-output}\KeywordTok{:}\AttributeTok{ best}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--pdf-engine xelatex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{pdf-engine}\KeywordTok{:}\AttributeTok{ xelatex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--pdf-engine-opt=--shell-escape
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{pdf-engine-opts}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\KeywordTok{-}\AttributeTok{ }\StringTok{'-shell-escape'}/ETEX
\stophighlighting

\starthighlighting
/BTEX\FunctionTok{pdf-engine-opt}\KeywordTok{:}\AttributeTok{ }\StringTok{'-shell-escape'}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\stopsectionlevel

\startsectionlevel[title={Citation
rendering},reference={citation-rendering-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--citeproc
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{citeproc}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--bibliography logic.bib
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{bibliography}\KeywordTok{:}\AttributeTok{ logic.bib}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--csl ieee.csl
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{csl}\KeywordTok{:}\AttributeTok{ ieee.csl}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--citation-abbreviations ab.json
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{citation-abbreviations}\KeywordTok{:}\AttributeTok{ ab.json}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--natbib
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{cite-method}\KeywordTok{:}\AttributeTok{ natbib}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--biblatex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{cite-method}\KeywordTok{:}\AttributeTok{ biblatex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\type{cite-method} can be \type{citeproc}, \type{natbib}, or
\type{biblatex}. This only affects LaTeX output. If you want to use
citeproc to format citations, you should also set \quote{citeproc:
true}.

If you need control over when the citeproc processing is done relative
to other filters, you should instead use \type{citeproc} in the list of
\type{filters} (see \goto{Reader options}[reader-options-1]).

\stopsectionlevel

\startsectionlevel[title={Math rendering in
HTML},reference={math-rendering-in-html-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--mathjax
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-math-method}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{method}\KeywordTok{:}\AttributeTok{ mathjax}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--mathml
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-math-method}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{method}\KeywordTok{:}\AttributeTok{ mathml}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--webtex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-math-method}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{method}\KeywordTok{:}\AttributeTok{ webtex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--katex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-math-method}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{method}\KeywordTok{:}\AttributeTok{ katex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--gladtex
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{html-math-method}\KeywordTok{:}/ETEX
/BTEX\AttributeTok{ { }}\FunctionTok{method}\KeywordTok{:}\AttributeTok{ gladtex}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

In addition to the values listed above, \type{method} can have the value
\type{plain}.

If the command line option accepts a URL argument, an \type{url:} field
can be added to \type{html-math-method:}.

\stopsectionlevel

\startsectionlevel[title={Options for wrapper
scripts},reference={options-for-wrapper-scripts-1}]

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] command line \stopxcell
\startxcell[align=right,width={0.50\textwidth}] defaults file \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--dump-args
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{dump-args}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right,width={0.49\textwidth}] \starttyping
--ignore-args
\stoptyping

 \stopxcell
\startxcell[align=right,width={0.50\textwidth}] \starthighlighting
/BTEX\FunctionTok{ignore-args}\KeywordTok{:}\AttributeTok{ }\CharTok{true}/ETEX
\stophighlighting

 \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Templates},reference={templates}]

When the \type{-s/--standalone} option is used, pandoc uses a template
to add header and footer material that is needed for a self-standing
document. To see the default template that is used, just type

\starttyping
pandoc -D *FORMAT*
\stoptyping

where {\em FORMAT} is the name of the output format. A custom template
can be specified using the \type{--template} option. You can also
override the system default templates for a given output format {\em
FORMAT} by putting a file \type{templates/default.*FORMAT*} in the user
data directory (see \type{--data-dir}, above). {\em Exceptions:}

\startitemize[packed]
\item
  For \type{odt} output, customize the \type{default.opendocument}
  template.
\item
  For \type{pdf} output, customize the \type{default.latex} template (or
  the \type{default.context} template, if you use \type{-t context}, or
  the \type{default.ms} template, if you use \type{-t ms}, or the
  \type{default.html} template, if you use \type{-t html}).
\item
  \type{docx} and \type{pptx} have no template (however, you can use
  \type{--reference-doc} to customize the output).
\stopitemize

Templates contain {\em variables}, which allow for the inclusion of
arbitrary information at any point in the file. They may be set at the
command line using the \type{-V/--variable} option. If a variable is not
set, pandoc will look for the key in the document's metadata, which can
be set using either \goto{YAML metadata
blocks}[extension-yaml_metadata_block] or with the \type{-M/--metadata}
option. In addition, some variables are given default values by pandoc.
See \goto{Variables}[variables] below for a list of variables used in
pandoc's default templates.

If you use custom templates, you may need to revise them as pandoc
changes. We recommend tracking the changes in the default templates, and
modifying your custom templates accordingly. An easy way to do this is
to fork the
\goto{pandoc-templates}[url(https://github.com/jgm/pandoc-templates)]
repository and merge in changes after each pandoc release.

\startsectionlevel[title={Template syntax},reference={template-syntax}]

\startsectionlevel[title={Comments},reference={comments}]

Anything between the sequence \type{$--} and the end of the line will be
treated as a comment and omitted from the output.

\stopsectionlevel

\startsectionlevel[title={Delimiters},reference={delimiters}]

To mark variables and control structures in the template, either
\type{$}\ldots{}\type{$} or \type"${"\ldots{}\type"}" may be used as
delimiters. The styles may also be mixed in the same template, but the
opening and closing delimiter must match in each case. The opening
delimiter may be followed by one or more spaces or tabs, which will be
ignored. The closing delimiter may be preceded by one or more spaces or
tabs, which will be ignored.

To include a literal \type{$} in the document, use \type{$$}.

\stopsectionlevel

\startsectionlevel[title={Interpolated
variables},reference={interpolated-variables}]

A slot for an interpolated variable is a variable name surrounded by
matched delimiters. Variable names must begin with a letter and can
contain letters, numbers, \type{_}, \type{-}, and \type{.}. The keywords
\type{it}, \type{if}, \type{else}, \type{endif}, \type{for}, \type{sep},
and \type{endfor} may not be used as variable names. Examples:

\starttyping
$foo$
$foo.bar.baz$
$foo_bar.baz-bim$
$ foo $
${foo}
${foo.bar.baz}
${foo_bar.baz-bim}
${ foo }
\stoptyping

Variable names with periods are used to get at structured variable
values. So, for example, \type{employee.salary} will return the value of
the \type{salary} field of the object that is the value of the
\type{employee} field.

\startitemize[packed]
\item
  If the value of the variable is a simple value, it will be rendered
  verbatim. (Note that no escaping is done; the assumption is that the
  calling program will escape the strings appropriately for the output
  format.)
\item
  If the value is a list, the values will be concatenated.
\item
  If the value is a map, the string \type{true} will be rendered.
\item
  Every other value will be rendered as the empty string.
\stopitemize

\stopsectionlevel

\startsectionlevel[title={Conditionals},reference={conditionals}]

A conditional begins with \type{if(variable)} (enclosed in matched
delimiters) and ends with \type{endif} (enclosed in matched delimiters).
It may optionally contain an \type{else} (enclosed in matched
delimiters). The \type{if} section is used if \type{variable} has a
non-empty value, otherwise the \type{else} section is used (if present).
Examples:

\starttyping
$if(foo)$bar$endif$

$if(foo)$
  $foo$
$endif$

$if(foo)$
part one
$else$
part two
$endif$

${if(foo)}bar${endif}

${if(foo)}
  ${foo}
${endif}

${if(foo)}
${ foo.bar }
${else}
no foo!
${endif}
\stoptyping

The keyword \type{elseif} may be used to simplify complex nested
conditionals:

\starttyping
$if(foo)$
XXX
$elseif(bar)$
YYY
$else$
ZZZ
$endif$
\stoptyping

\stopsectionlevel

\startsectionlevel[title={For loops},reference={for-loops}]

A for loop begins with \type{for(variable)} (enclosed in matched
delimiters) and ends with \type{endfor} (enclosed in matched
delimiters).

\startitemize[packed]
\item
  If \type{variable} is an array, the material inside the loop will be
  evaluated repeatedly, with \type{variable} being set to each value of
  the array in turn, and concatenated.
\item
  If \type{variable} is a map, the material inside will be set to the
  map.
\item
  If the value of the associated variable is not an array or a map, a
  single iteration will be performed on its value.
\stopitemize

Examples:

\starttyping
$for(foo)$$foo$$sep$, $endfor$

$for(foo)$
  - $foo.last$, $foo.first$
$endfor$

${ for(foo.bar) }
  - ${ foo.bar.last }, ${ foo.bar.first }
${ endfor }

$for(mymap)$
$it.name$: $it.office$
$endfor$
\stoptyping

You may optionally specify a separator between consecutive values using
\type{sep} (enclosed in matched delimiters). The material between
\type{sep} and the \type{endfor} is the separator.

\starttyping
${ for(foo) }${ foo }${ sep }, ${ endfor }
\stoptyping

Instead of using \type{variable} inside the loop, the special anaphoric
keyword \type{it} may be used.

\starttyping
${ for(foo.bar) }
  - ${ it.last }, ${ it.first }
${ endfor }
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Partials},reference={partials}]

Partials (subtemplates stored in different files) may be included by
using the name of the partial, followed by \type{()}, for example:

\starttyping
${ styles() }
\stoptyping

Partials will be sought in the directory containing the main template.
The file name will be assumed to have the same extension as the main
template if it lacks an extension. When calling the partial, the full
name including file extension can also be used:

\starttyping
${ styles.html() }
\stoptyping

(If a partial is not found in the directory of the template and the
template path is given as a relative path, it will also be sought in the
\type{templates} subdirectory of the user data directory.)

Partials may optionally be applied to variables using a colon:

\starttyping
${ date:fancy() }

${ articles:bibentry() }
\stoptyping

If \type{articles} is an array, this will iterate over its values,
applying the partial \type{bibentry()} to each one. So the second
example above is equivalent to

\starttyping
${ for(articles) }
${ it:bibentry() }
${ endfor }
\stoptyping

Note that the anaphoric keyword \type{it} must be used when iterating
over partials. In the above examples, the \type{bibentry} partial should
contain \type{it.title} (and so on) instead of \type{articles.title}.

Final newlines are omitted from included partials.

Partials may include other partials.

A separator between values of an array may be specified in square
brackets, immediately after the variable name or partial:

\starttyping
${months[, ]}$

${articles:bibentry()[; ]$
\stoptyping

The separator in this case is literal and (unlike with \type{sep} in an
explicit \type{for} loop) cannot contain interpolated variables or other
template directives.

\stopsectionlevel

\startsectionlevel[title={Nesting},reference={nesting}]

To ensure that content is \quotation{nested,} that is, subsequent lines
indented, use the \type{^} directive:

\starttyping
$item.number$  $^$$item.description$ ($item.price$)
\stoptyping

In this example, if \type{item.description} has multiple lines, they
will all be indented to line up with the first line:

\starttyping
00123  A fine bottle of 18-year old
       Oban whiskey. ($148)
\stoptyping

To nest multiple lines to the same level, align them with the \type{^}
directive in the template. For example:

\starttyping
$item.number$  $^$$item.description$ ($item.price$)
               (Available til $item.sellby$.)
\stoptyping

will produce

\starttyping
00123  A fine bottle of 18-year old
       Oban whiskey. ($148)
       (Available til March 30, 2020.)
\stoptyping

If a variable occurs by itself on a line, preceded by whitespace and not
followed by further text or directives on the same line, and the
variable's value contains multiple lines, it will be nested
automatically.

\stopsectionlevel

\startsectionlevel[title={Breakable
spaces},reference={breakable-spaces}]

Normally, spaces in the template itself (as opposed to values of the
interpolated variables) are not breakable, but they can be made
breakable in part of the template by using the \type{~} keyword (ended
with another \type{~}).

\starttyping
$~$This long line may break if the document is rendered
with a short line length.$~$
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Pipes},reference={pipes}]

A pipe transforms the value of a variable or partial. Pipes are
specified using a slash (\type{/}) between the variable name (or
partial) and the pipe name. Example:

\starttyping
$for(name)$
$name/uppercase$
$endfor$

$for(metadata/pairs)$
- $it.key$: $it.value$
$endfor$

$employee:name()/uppercase$
\stoptyping

Pipes may be chained:

\starttyping
$for(employees/pairs)$
$it.key/alpha/uppercase$. $it.name$
$endfor$
\stoptyping

Some pipes take parameters:

\starttyping
|----------------------|------------|
$for(employee)$
$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
$endfor$
|----------------------|------------|
\stoptyping

Currently the following pipes are predefined:

\startitemize
\item
  \type{pairs}: Converts a map or array to an array of maps, each with
  \type{key} and \type{value} fields. If the original value was an
  array, the \type{key} will be the array index, starting with 1.
\item
  \type{uppercase}: Converts text to uppercase.
\item
  \type{lowercase}: Converts text to lowercase.
\item
  \type{length}: Returns the length of the value: number of characters
  for a textual value, number of elements for a map or array.
\item
  \type{reverse}: Reverses a textual value or array, and has no effect
  on other values.
\item
  \type{first}: Returns the first value of an array, if applied to a
  non-empty array; otherwise returns the original value.
\item
  \type{last}: Returns the last value of an array, if applied to a
  non-empty array; otherwise returns the original value.
\item
  \type{rest}: Returns all but the first value of an array, if applied
  to a non-empty array; otherwise returns the original value.
\item
  \type{allbutlast}: Returns all but the last value of an array, if
  applied to a non-empty array; otherwise returns the original value.
\item
  \type{chomp}: Removes trailing newlines (and breakable space).
\item
  \type{nowrap}: Disables line wrapping on breakable spaces.
\item
  \type{alpha}: Converts textual values that can be read as an integer
  into lowercase alphabetic characters \type{a..z} (mod 26). This can be
  used to get lettered enumeration from array indices. To get uppercase
  letters, chain with \type{uppercase}.
\item
  \type{roman}: Converts textual values that can be read as an integer
  into lowercase roman numerals. This can be used to get lettered
  enumeration from array indices. To get uppercase roman, chain with
  \type{uppercase}.
\item
  \type{left n "leftborder" "rightborder"}: Renders a textual value in a
  block of width \type{n}, aligned to the left, with an optional left
  and right border. Has no effect on other values. This can be used to
  align material in tables. Widths are positive integers indicating the
  number of characters. Borders are strings inside double quotes;
  literal \type{"} and \type{\} characters must be backslash-escaped.
\item
  \type{right n "leftborder" "rightborder"}: Renders a textual value in
  a block of width \type{n}, aligned to the right, and has no effect on
  other values.
\item
  \type{center n "leftborder" "rightborder"}: Renders a textual value in
  a block of width \type{n}, aligned to the center, and has no effect on
  other values.
\stopitemize

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Variables},reference={variables}]

\startsectionlevel[title={Metadata
variables},reference={metadata-variables}]

\startdescription{\type{title}, \type{author}, \type{date}}
  allow identification of basic aspects of the document. Included in PDF
  metadata through LaTeX and ConTeXt. These can be set through a
  \goto{pandoc title block}[extension-pandoc_title_block], which allows
  for multiple authors, or through a \goto{YAML metadata
  block}[extension-yaml_metadata_block]:

\starttyping
---
author:
- Aristotle
- Peter Abelard
...
\stoptyping

  Note that if you just want to set PDF or HTML metadata, without
  including a title block in the document itself, you can set the
  \type{title-meta}, \type{author-meta}, and \type{date-meta} variables.
  (By default these are set automatically, based on \type{title},
  \type{author}, and \type{date}.) The page title in HTML is set by
  \type{pagetitle}, which is equal to \type{title} by default.
\stopdescription

\startdescription{\type{subtitle}}
  document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
  documents
\stopdescription

\startdescription{\type{abstract}}
  document summary, included in HTML, LaTeX, ConTeXt, AsciiDoc, and docx
  documents
\stopdescription

\startdescription{\type{abstract-title}}
  title of abstract, currently used only in HTML, EPUB, and docx. This
  will be set automatically to a localized value, depending on
  \type{lang}, but can be manually overridden.
\stopdescription

\startdescription{\type{keywords}}
  list of keywords to be included in HTML, PDF, ODT, pptx, docx and
  AsciiDoc metadata; repeat as for \type{author}, above
\stopdescription

\startdescription{\type{subject}}
  document subject, included in ODT, PDF, docx, EPUB, and pptx metadata
\stopdescription

\startdescription{\type{description}}
  document description, included in ODT, docx and pptx metadata. Some
  applications show this as \type{Comments} metadata.
\stopdescription

\startdescription{\type{category}}
  document category, included in docx and pptx metadata
\stopdescription

Additionally, any root-level string metadata, not included in ODT, docx
or pptx metadata is added as a {\em custom property}. The following
\goto{YAML}[url(https://yaml.org/spec/1.2/spec.html)] metadata block for
instance:

\starttyping
---
title:  'This is the title'
subtitle: "This is the subtitle"
author:
- Author One
- Author Two
description: |
    This is a long
    description.

    It consists of two paragraphs
...
\stoptyping

will include \type{title}, \type{author} and \type{description} as
standard document properties and \type{subtitle} as a custom property
when converting to docx, ODT or pptx.

\stopsectionlevel

\startsectionlevel[title={Language
variables},reference={language-variables}]

\startdescription{\type{lang}}
  identifies the main language of the document using IETF language tags
  (following the \goto{BCP 47}[url(https://tools.ietf.org/html/bcp47)]
  standard), such as \type{en} or \type{en-GB}. The \goto{Language
  subtag lookup}[url(https://r12a.github.io/app-subtags/)] tool can look
  up or verify these tags. This affects most formats, and controls
  hyphenation in PDF output when using LaTeX (through
  \goto{\type{babel}}[url(https://ctan.org/pkg/babel)] and
  \goto{\type{polyglossia}}[url(https://ctan.org/pkg/polyglossia)]) or
  ConTeXt.

  Use native pandoc \goto{Divs and Spans}[divs-and-spans] with the
  \type{lang} attribute to switch the language:

\starttyping
---
lang: en-GB
...

Text in the main document language (British English).

::: {lang=fr-CA}
> Cette citation est écrite en français canadien.
:::

More text in English. ['Zitat auf Deutsch.']{lang=de}
\stoptyping
\stopdescription

\startdescription{\type{dir}}
  the base script direction, either \type{rtl} (right-to-left) or
  \type{ltr} (left-to-right).

  For bidirectional documents, native pandoc \type{span}s and
  \type{div}s with the \type{dir} attribute (value \type{rtl} or
  \type{ltr}) can be used to override the base direction in some output
  formats. This may not always be necessary if the final renderer
  (e.g.~the browser, when generating HTML) supports the \goto{Unicode
  Bidirectional
  Algorithm}[url(https://www.w3.org/International/articles/inline-bidi-markup/uba-basics)].

  When using LaTeX for bidirectional documents, only the \type{xelatex}
  engine is fully supported (use \type{--pdf-engine=xelatex}).
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
HTML},reference={variables-for-html}]

\startdescription{\type{document-css}}
  Enables inclusion of most of the
  \goto{CSS}[url(https://developer.mozilla.org/en-US/docs/Learn/CSS)] in
  the \type{styles.html} \goto{partial}[partials] (have a look with
  \type{pandoc --print-default-data-file=templates/styles.html}). Unless
  you use \goto{\type{--css}}[option--css], this variable is set to
  \type{true} by default. You can disable it with
  e.g.~\type{pandoc -M document-css=false}.
\stopdescription

\startdescription{\type{mainfont}}
  sets the CSS \type{font-family} property on the \type{html} element.
\stopdescription

\startdescription{\type{fontsize}}
  sets the base CSS \type{font-size}, which you'd usually set to
  e.g.~\type{20px}, but it also accepts \type{pt} (12pt = 16px in most
  browsers).
\stopdescription

\startdescription{\type{fontcolor}}
  sets the CSS \type{color} property on the \type{html} element.
\stopdescription

\startdescription{\type{linkcolor}}
  sets the CSS \type{color} property on all links.
\stopdescription

\startdescription{\type{monofont}}
  sets the CSS \type{font-family} property on \type{code} elements.
\stopdescription

\startdescription{\type{monobackgroundcolor}}
  sets the CSS \type{background-color} property on \type{code} elements
  and adds extra padding.
\stopdescription

\startdescription{\type{linestretch}}
  sets the CSS \type{line-height} property on the \type{html} element,
  which is preferred to be unitless.
\stopdescription

\startdescription{\type{maxwidth}}
  sets the CSS \type{max-width} property (default is 32em).
\stopdescription

\startdescription{\type{backgroundcolor}}
  sets the CSS \type{background-color} property on the \type{html}
  element.
\stopdescription

\startdescription{\type{margin-left}, \type{margin-right},
\type{margin-top}, \type{margin-bottom}}
  sets the corresponding CSS \type{padding} properties on the
  \type{body} element.
\stopdescription

To override or extend some
\goto{CSS}[url(https://developer.mozilla.org/en-US/docs/Learn/CSS)] for
just one document, include for example:

\starttyping
---
header-includes: |
  <style>
  blockquote {
    font-style: italic;
  }
  tr.even {
    background-color: #f0f0f0;
  }
  td, th {
    padding: 0.5em 2em 0.5em 0.5em;
  }
  tbody {
    border-bottom: none;
  }
  </style>
---
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Variables for HTML
math},reference={variables-for-html-math}]

\startdescription{\type{classoption}}
  when using \goto{KaTeX}[option--katex], you can render display math
  equations flush left using \goto{YAML metadata}[layout] or with
  \type{-M classoption=fleqn}.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for HTML
slides},reference={variables-for-html-slides}]

These affect HTML output when \goto{producing slide shows with
pandoc}[slide-shows].

\startdescription{\type{institute}}
  author affiliations: can be a list when there are multiple authors
\stopdescription

\startdescription{\type{revealjs-url}}
  base URL for reveal.js documents (defaults to
  \type{https://unpkg.com/reveal.js@^4/})
\stopdescription

\startdescription{\type{s5-url}}
  base URL for S5 documents (defaults to \type{s5/default})
\stopdescription

\startdescription{\type{slidy-url}}
  base URL for Slidy documents (defaults to
  \type{https://www.w3.org/Talks/Tools/Slidy2})
\stopdescription

\startdescription{\type{slideous-url}}
  base URL for Slideous documents (defaults to \type{slideous})
\stopdescription

\startdescription{\type{title-slide-attributes}}
  additional attributes for the title slide of reveal.js slide shows.
  See \goto{background in reveal.js, beamer, and
  pptx}[background-in-reveal.js-beamer-and-pptx] for an example.
\stopdescription

All \goto{reveal.js configuration
options}[url(https://revealjs.com/config/)] are available as variables.
To turn off boolean flags that default to true in reveal.js, use
\type{0}.

\stopsectionlevel

\startsectionlevel[title={Variables for Beamer
slides},reference={variables-for-beamer-slides}]

These variables change the appearance of PDF slides using
\goto{\type{beamer}}[url(https://ctan.org/pkg/beamer)].

\startdescription{\type{aspectratio}}
  slide aspect ratio (\type{43} for 4:3 {[}default{]}, \type{169} for
  16:9, \type{1610} for 16:10, \type{149} for 14:9, \type{141} for
  1.41:1, \type{54} for 5:4, \type{32} for 3:2)
\stopdescription

\startdescription{\type{beameroption}}
  add extra beamer option with \type"\setbeameroption{}"
\stopdescription

\startdescription{\type{institute}}
  author affiliations: can be a list when there are multiple authors
\stopdescription

\startdescription{\type{logo}}
  logo image for slides
\stopdescription

\startdescription{\type{navigation}}
  controls navigation symbols (default is \type{empty} for no navigation
  symbols; other valid values are \type{frame}, \type{vertical}, and
  \type{horizontal})
\stopdescription

\startdescription{\type{section-titles}}
  enables \quotation{title pages} for new sections (default is true)
\stopdescription

\startdescription{\type{theme}, \type{colortheme}, \type{fonttheme},
\type{innertheme}, \type{outertheme}}
  beamer themes
\stopdescription

\startdescription{\type{themeoptions}}
  options for LaTeX beamer themes (a list).
\stopdescription

\startdescription{\type{titlegraphic}}
  image for title slide
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
PowerPoint},reference={variables-for-powerpoint}]

These variables control the visual aspects of a slide show that are not
easily controlled via templates.

\startdescription{\type{monofont}}
  font to use for code.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
LaTeX},reference={variables-for-latex}]

Pandoc uses these variables when \goto{creating a PDF}[creating-a-pdf]
with a LaTeX engine.

\startsectionlevel[title={Layout},reference={layout}]

\startdescription{\type{block-headings}}
  make \type{\paragraph} and \type{\subparagraph} (fourth- and
  fifth-level headings, or fifth- and sixth-level with book classes)
  free-standing rather than run-in; requires further formatting to
  distinguish from \type{\subsubsection} (third- or fourth-level
  headings). Instead of using this option,
  \goto{KOMA-Script}[url(https://ctan.org/pkg/koma-script)] can adjust
  headings more extensively:

\starttyping
---
documentclass: scrartcl
header-includes: |
  \RedeclareSectionCommand[
    beforeskip=-10pt plus -2pt minus -1pt,
    afterskip=1sp plus -1sp minus 1sp,
    font=\normalfont\itshape]{paragraph}
  \RedeclareSectionCommand[
    beforeskip=-10pt plus -2pt minus -1pt,
    afterskip=1sp plus -1sp minus 1sp,
    font=\normalfont\scshape,
    indent=0pt]{subparagraph}
...
\stoptyping
\stopdescription

\startdescription{\type{classoption}}
  option for document class, e.g.~\type{oneside}; repeat for multiple
  options:

\starttyping
---
classoption:
- twocolumn
- landscape
...
\stoptyping
\stopdescription

\startdescription{\type{documentclass}}
  document class: usually one of the standard classes,
  \goto{\type{article}}[url(https://ctan.org/pkg/article)],
  \goto{\type{book}}[url(https://ctan.org/pkg/book)], and
  \goto{\type{report}}[url(https://ctan.org/pkg/report)]; the
  \goto{KOMA-Script}[url(https://ctan.org/pkg/koma-script)] equivalents,
  \type{scrartcl}, \type{scrbook}, and \type{scrreprt}, which default to
  smaller margins; or
  \goto{\type{memoir}}[url(https://ctan.org/pkg/memoir)]
\stopdescription

\startdescription{\type{geometry}}
  option for \goto{\type{geometry}}[url(https://ctan.org/pkg/geometry)]
  package, e.g.~\type{margin=1in}; repeat for multiple options:

\starttyping
---
geometry:
- top=30mm
- left=20mm
- heightrounded
...
\stoptyping
\stopdescription

\startdescription{\type{hyperrefoptions}}
  option for \goto{\type{hyperref}}[url(https://ctan.org/pkg/hyperref)]
  package, e.g.~\type{linktoc=all}; repeat for multiple options:

\starttyping
---
hyperrefoptions:
- linktoc=all
- pdfwindowui
- pdfpagemode=FullScreen
...
\stoptyping
\stopdescription

\startdescription{\type{indent}}
  if true, pandoc will use document class settings for indentation (the
  default LaTeX template otherwise removes indentation and adds space
  between paragraphs)
\stopdescription

\startdescription{\type{linestretch}}
  adjusts line spacing using the
  \goto{\type{setspace}}[url(https://ctan.org/pkg/setspace)] package,
  e.g.~\type{1.25}, \type{1.5}
\stopdescription

\startdescription{\type{margin-left}, \type{margin-right},
\type{margin-top}, \type{margin-bottom}}
  sets margins if \type{geometry} is not used (otherwise \type{geometry}
  overrides these)
\stopdescription

\startdescription{\type{pagestyle}}
  control \type"\pagestyle{}": the default article class supports
  \type{plain} (default), \type{empty} (no running heads or page
  numbers), and \type{headings} (section titles in running heads)
\stopdescription

\startdescription{\type{papersize}}
  paper size, e.g.~\type{letter}, \type{a4}
\stopdescription

\startdescription{\type{secnumdepth}}
  numbering depth for sections (with \type{--number-sections} option or
  \type{numbersections} variable)
\stopdescription

\startdescription{\type{beamerarticle}}
  produce an article from Beamer slides
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Fonts},reference={fonts}]

\startdescription{\type{fontenc}}
  allows font encoding to be specified through \type{fontenc} package
  (with \type{pdflatex}); default is \type{T1} (see \goto{LaTeX font
  encodings guide}[url(https://ctan.org/pkg/encguide)])
\stopdescription

\startdescription{\type{fontfamily}}
  font package for use with \type{pdflatex}: \goto{TeX
  Live}[url(https://www.tug.org/texlive/)] includes many options,
  documented in the \goto{LaTeX Font
  Catalogue}[url(https://tug.org/FontCatalogue/)]. The default is
  \goto{Latin Modern}[url(https://ctan.org/pkg/lm)].
\stopdescription

\startdescription{\type{fontfamilyoptions}}
  options for package used as \type{fontfamily}; repeat for multiple
  options. For example, to use the Libertine font with proportional
  lowercase (old-style) figures through the
  \goto{\type{libertinus}}[url(https://ctan.org/pkg/libertinus)]
  package:

\starttyping
---
fontfamily: libertinus
fontfamilyoptions:
- osf
- p
...
\stoptyping
\stopdescription

\startdescription{\type{fontsize}}
  font size for body text. The standard classes allow 10pt, 11pt, and
  12pt. To use another size, set \type{documentclass} to one of the
  \goto{KOMA-Script}[url(https://ctan.org/pkg/koma-script)] classes,
  such as \type{scrartcl} or \type{scrbook}.
\stopdescription

\startdescription{\type{mainfont}, \type{sansfont}, \type{monofont},
\type{mathfont}, \type{CJKmainfont}, \type{CJKsansfont},
\type{CJKmonofont}}
  font families for use with \type{xelatex} or \type{lualatex}: take the
  name of any system font, using the
  \goto{\type{fontspec}}[url(https://ctan.org/pkg/fontspec)] package.
  \type{CJKmainfont} uses the
  \goto{\type{xecjk}}[url(https://ctan.org/pkg/xecjk)] package.
\stopdescription

\startdescription{\type{mainfontoptions}, \type{sansfontoptions},
\type{monofontoptions}, \type{mathfontoptions}, \type{CJKoptions}}
  options to use with \type{mainfont}, \type{sansfont}, \type{monofont},
  \type{mathfont}, \type{CJKmainfont} in \type{xelatex} and
  \type{lualatex}. Allow for any choices available through
  \goto{\type{fontspec}}[url(https://ctan.org/pkg/fontspec)]; repeat for
  multiple options. For example, to use the \goto{TeX
  Gyre}[url(http://www.gust.org.pl/projects/e-foundry/tex-gyre)] version
  of Palatino with lowercase figures:

\starttyping
---
mainfont: TeX Gyre Pagella
mainfontoptions:
- Numbers=Lowercase
- Numbers=Proportional
...
\stoptyping
\stopdescription

\startdescription{\type{mainfontfallback}, \type{sansfontfallback},
\type{monofontfallback}}
  fonts to try if a glyph isn't found in \type{mainfont},
  \type{sansfont}, or \type{monofont} respectively. These are lists. The
  font name must be followed by a colon and optionally a set of options,
  for example:

\starttyping
---
mainfontfallback:
  - "FreeSans:"
  - "NotoColorEmoji:mode=harf"
...
\stoptyping

  Font fallbacks currently only work with \type{lualatex}.
\stopdescription

\startdescription{\type{babelfonts}}
  a map of Babel language names (e.g.~\type{chinese}) to the font to be
  used with the language:

  \thinrule

  babelfonts: chinese-hant: \quotation{Noto Serif CJK TC} russian:
  \quotation{Noto Serif} \ldots{}
\stopdescription

\startdescription{\type{microtypeoptions}}
  options to pass to the microtype package
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Links},reference={links}]

\startdescription{\type{colorlinks}}
  add color to link text; automatically enabled if any of
  \type{linkcolor}, \type{filecolor}, \type{citecolor}, \type{urlcolor},
  or \type{toccolor} are set
\stopdescription

\startdescription{\type{boxlinks}}
  add visible box around links (has no effect if \type{colorlinks} is
  set)
\stopdescription

\startdescription{\type{linkcolor}, \type{filecolor}, \type{citecolor},
\type{urlcolor}, \type{toccolor}}
  color for internal links, external links, citation links, linked URLs,
  and links in table of contents, respectively: uses options allowed by
  \goto{\type{xcolor}}[url(https://ctan.org/pkg/xcolor)], including the
  \type{dvipsnames}, \type{svgnames}, and \type{x11names} lists
\stopdescription

\startdescription{\type{links-as-notes}}
  causes links to be printed as footnotes
\stopdescription

\startdescription{\type{urlstyle}}
  style for URLs (e.g., \type{tt}, \type{rm}, \type{sf}, and, the
  default, \type{same})
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Front matter},reference={front-matter}]

\startdescription{\type{lof}, \type{lot}}
  include list of figures, list of tables
\stopdescription

\startdescription{\type{thanks}}
  contents of acknowledgments footnote after document title
\stopdescription

\startdescription{\type{toc}}
  include table of contents (can also be set using
  \type{--toc/--table-of-contents})
\stopdescription

\startdescription{\type{toc-depth}}
  level of section to include in table of contents
\stopdescription

\stopsectionlevel

\startsectionlevel[title={BibLaTeX
Bibliographies},reference={biblatex-bibliographies}]

These variables function when using BibLaTeX for \goto{citation
rendering}[citation-rendering].

\startdescription{\type{biblatexoptions}}
  list of options for biblatex
\stopdescription

\startdescription{\type{biblio-style}}
  bibliography style, when used with \type{--natbib} and
  \type{--biblatex}
\stopdescription

\startdescription{\type{biblio-title}}
  bibliography title, when used with \type{--natbib} and
  \type{--biblatex}
\stopdescription

\startdescription{\type{bibliography}}
  bibliography to use for resolving references
\stopdescription

\startdescription{\type{natbiboptions}}
  list of options for natbib
\stopdescription

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Variables for
ConTeXt},reference={variables-for-context}]

Pandoc uses these variables when \goto{creating a PDF}[creating-a-pdf]
with ConTeXt.

\startdescription{\type{fontsize}}
  font size for body text (e.g.~\type{10pt}, \type{12pt})
\stopdescription

\startdescription{\type{headertext}, \type{footertext}}
  text to be placed in running header or footer (see \goto{ConTeXt
  Headers and
  Footers}[url(https://wiki.contextgarden.net/Headers_and_Footers)]);
  repeat up to four times for different placement
\stopdescription

\startdescription{\type{indenting}}
  controls indentation of paragraphs, e.g.~\type{yes,small,next} (see
  \goto{ConTeXt
  Indentation}[url(https://wiki.contextgarden.net/Indentation)]); repeat
  for multiple options
\stopdescription

\startdescription{\type{interlinespace}}
  adjusts line spacing, e.g.~\type{4ex} (using
  \goto{\type{setupinterlinespace}}[url(https://wiki.contextgarden.net/Command/setupinterlinespace)]);
  repeat for multiple options
\stopdescription

\startdescription{\type{layout}}
  options for page margins and text arrangement (see \goto{ConTeXt
  Layout}[url(https://wiki.contextgarden.net/Layout)]); repeat for
  multiple options
\stopdescription

\startdescription{\type{linkcolor}, \type{contrastcolor}}
  color for links outside and inside a page, e.g.~\type{red},
  \type{blue} (see \goto{ConTeXt
  Color}[url(https://wiki.contextgarden.net/Color)])
\stopdescription

\startdescription{\type{linkstyle}}
  typeface style for links, e.g.~\type{normal}, \type{bold},
  \type{slanted}, \type{boldslanted}, \type{type}, \type{cap},
  \type{small}
\stopdescription

\startdescription{\type{lof}, \type{lot}}
  include list of figures, list of tables
\stopdescription

\startdescription{\type{mainfont}, \type{sansfont}, \type{monofont},
\type{mathfont}}
  font families: take the name of any system font (see \goto{ConTeXt
  Font Switching}[url(https://wiki.contextgarden.net/Font_Switching)])
\stopdescription

\startdescription{\type{mainfontfallback}, \type{sansfontfallback},
\type{monofontfallback}}
  list of fonts to try, in order, if a glyph is not found in the main
  font. Use \type{\definefallbackfamily}-compatible font name syntax.
  Emoji fonts are unsupported.
\stopdescription

\startdescription{\type{margin-left}, \type{margin-right},
\type{margin-top}, \type{margin-bottom}}
  sets margins, if \type{layout} is not used (otherwise \type{layout}
  overrides these)
\stopdescription

\startdescription{\type{pagenumbering}}
  page number style and location (using
  \goto{\type{setuppagenumbering}}[url(https://wiki.contextgarden.net/Command/setuppagenumbering)]);
  repeat for multiple options
\stopdescription

\startdescription{\type{papersize}}
  paper size, e.g.~\type{letter}, \type{A4}, \type{landscape} (see
  \goto{ConTeXt Paper
  Setup}[url(https://wiki.contextgarden.net/PaperSetup)]); repeat for
  multiple options
\stopdescription

\startdescription{\type{pdfa}}
  adds to the preamble the setup necessary to generate PDF/A of the type
  specified, e.g.~\type{1a:2005}, \type{2a}. If no type is specified
  (i.e.~the value is set to True, by e.g. \type{--metadata=pdfa} or
  \type{pdfa: true} in a YAML metadata block), \type{1b:2005} will be
  used as default, for reasons of backwards compatibility. Using
  \type{--variable=pdfa} without specified value is not supported. To
  successfully generate PDF/A the required ICC color profiles have to be
  available and the content and all included files (such as images) have
  to be standard-conforming. The ICC profiles and output intent may be
  specified using the variables \type{pdfaiccprofile} and
  \type{pdfaintent}. See also \goto{ConTeXt
  PDFA}[url(https://wiki.contextgarden.net/PDF/A)] for more details.
\stopdescription

\startdescription{\type{pdfaiccprofile}}
  when used in conjunction with \type{pdfa}, specifies the ICC profile
  to use in the PDF, e.g.~\type{default.cmyk}. If left unspecified,
  \type{sRGB.icc} is used as default. May be repeated to include
  multiple profiles. Note that the profiles have to be available on the
  system. They can be obtained from \goto{ConTeXt ICC
  Profiles}[url(https://wiki.contextgarden.net/PDFX\#ICC_profiles)].
\stopdescription

\startdescription{\type{pdfaintent}}
  when used in conjunction with \type{pdfa}, specifies the output intent
  for the colors,
  e.g.~\type{ISO coated v2 300\letterpercent\space (ECI)} If left
  unspecified, \type{sRGB IEC61966-2.1} is used as default.
\stopdescription

\startdescription{\type{toc}}
  include table of contents (can also be set using
  \type{--toc/--table-of-contents})
\stopdescription

\startdescription{\type{urlstyle}}
  typeface style for links without link text, e.g.~\type{normal},
  \type{bold}, \type{slanted}, \type{boldslanted}, \type{type},
  \type{cap}, \type{small}
\stopdescription

\startdescription{\type{whitespace}}
  spacing between paragraphs, e.g.~\type{none}, \type{small} (using
  \goto{\type{setupwhitespace}}[url(https://wiki.contextgarden.net/Command/setupwhitespace)])
\stopdescription

\startdescription{\type{includesource}}
  include all source documents as file attachments in the PDF file
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
\type{wkhtmltopdf}},reference={variables-for-wkhtmltopdf}]

Pandoc uses these variables when \goto{creating a PDF}[creating-a-pdf]
with \goto{\type{wkhtmltopdf}}[url(https://wkhtmltopdf.org)]. The
\type{--css} option also affects the output.

\startdescription{\type{footer-html}, \type{header-html}}
  add information to the header and footer
\stopdescription

\startdescription{\type{margin-left}, \type{margin-right},
\type{margin-top}, \type{margin-bottom}}
  set the page margins
\stopdescription

\startdescription{\type{papersize}}
  sets the PDF paper size
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for man
pages},reference={variables-for-man-pages}]

\startdescription{\type{adjusting}}
  adjusts text to left (\type{l}), right (\type{r}), center (\type{c}),
  or both (\type{b}) margins
\stopdescription

\startdescription{\type{footer}}
  footer in man pages
\stopdescription

\startdescription{\type{header}}
  header in man pages
\stopdescription

\startdescription{\type{section}}
  section number in man pages
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
Typst},reference={variables-for-typst}]

\startdescription{\type{margin}}
  A dictionary with the fields defined in the Typst documentation:
  \type{x}, \type{y}, \type{top}, \type{bottom}, \type{left},
  \type{right}.
\stopdescription

\startdescription{\type{papersize}}
  Paper size: \type{a4}, \type{us-letter}, etc.
\stopdescription

\startdescription{\type{mainfont}}
  Name of system font to use for the main font.
\stopdescription

\startdescription{\type{fontsize}}
  Font size (e.g., \type{12pt}).
\stopdescription

\startdescription{\type{section-numbering}}
  Schema to use for numbering sections, e.g.~\type{1.A.1}.
\stopdescription

\startdescription{\type{columns}}
  Number of columns for body text.
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables for
ms},reference={variables-for-ms}]

\startdescription{\type{fontfamily}}
  \type{A} (Avant Garde), \type{B} (Bookman), \type{C} (Helvetica),
  \type{HN} (Helvetica Narrow), \type{P} (Palatino), or \type{T} (Times
  New Roman). This setting does not affect source code, which is always
  displayed using monospace Courier. These built-in fonts are limited in
  their coverage of characters. Additional fonts may be installed using
  the script
  \goto{\type{install-font.sh}}[url(https://www.schaffter.ca/mom/bin/install-font.sh)]
  provided by Peter Schaffter and documented in detail on \goto{his web
  site}[url(https://www.schaffter.ca/mom/momdoc/appendices.html\#steps)].
\stopdescription

\startdescription{\type{indent}}
  paragraph indent (e.g.~\type{2m})
\stopdescription

\startdescription{\type{lineheight}}
  line height (e.g.~\type{12p})
\stopdescription

\startdescription{\type{pointsize}}
  point size (e.g.~\type{10p})
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Variables set
automatically},reference={variables-set-automatically}]

Pandoc sets these variables automatically in response to
\goto{options}[options] or document contents; users can also modify
them. These vary depending on the output format, and include the
following:

\startdescription{\type{body}}
  body of document
\stopdescription

\startdescription{\type{date-meta}}
  the \type{date} variable converted to ISO 8601 YYYY-MM-DD, included in
  all HTML based formats (dzslides, epub, html, html4, html5, revealjs,
  s5, slideous, slidy). The recognized formats for \type{date} are:
  \type{mm/dd/yyyy}, \type{mm/dd/yy}, \type{yyyy-mm-dd} (ISO 8601),
  \type{dd MM yyyy} (e.g.~either \type{02 Apr 2018} or
  \type{02 April 2018}), \type{MM dd, yyyy} (e.g.~\type{Apr. 02, 2018}
  or \type{April 02, 2018),}yyyy{[}mm{[}dd{]}{]}\type{(e.g.}20180402,
  \type{201804} or \type{2018}).
\stopdescription

\startdescription{\type{header-includes}}
  contents specified by \type{-H/--include-in-header} (may have multiple
  values)
\stopdescription

\startdescription{\type{include-before}}
  contents specified by \type{-B/--include-before-body} (may have
  multiple values)
\stopdescription

\startdescription{\type{include-after}}
  contents specified by \type{-A/--include-after-body} (may have
  multiple values)
\stopdescription

\startdescription{\type{meta-json}}
  JSON representation of all of the document's metadata. Field values
  are transformed to the selected output format.
\stopdescription

\startdescription{\type{numbersections}}
  non-null value if \type{-N/--number-sections} was specified
\stopdescription

\startdescription{\type{sourcefile}, \type{outputfile}}
  source and destination filenames, as given on the command line.
  \type{sourcefile} can also be a list if input comes from multiple
  files, or empty if input is from stdin. You can use the following
  snippet in your template to distinguish them:

\starttyping
$if(sourcefile)$
$for(sourcefile)$
$sourcefile$
$endfor$
$else$
(stdin)
$endif$
\stoptyping

  Similarly, \type{outputfile} can be \type{-} if output goes to the
  terminal.

  If you need absolute paths, use e.g.~\type{$curdir$/$sourcefile$}.
\stopdescription

\startdescription{\type{curdir}}
  working directory from which pandoc is run.
\stopdescription

\startdescription{\type{pandoc-version}}
  pandoc version.
\stopdescription

\startdescription{\type{toc}}
  non-null value if \type{--toc/--table-of-contents} was specified
\stopdescription

\startdescription{\type{toc-title}}
  title of table of contents (works only with EPUB, HTML, revealjs,
  opendocument, odt, docx, pptx, beamer, LaTeX)
\stopdescription

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Extensions},reference={extensions}]

The behavior of some of the readers and writers can be adjusted by
enabling or disabling various extensions.

An extension can be enabled by adding \type{+EXTENSION} to the format
name and disabled by adding \type{-EXTENSION}. For example,
\type{--from markdown_strict+footnotes} is strict Markdown with
footnotes enabled, while \type{--from markdown-footnotes-pipe_tables} is
pandoc's Markdown without footnotes or pipe tables.

The Markdown reader and writer make by far the most use of extensions.
Extensions only used by them are therefore covered in the section
\goto{Pandoc's Markdown}[pandocs-markdown] below (see \goto{Markdown
variants}[markdown-variants] for \type{commonmark} and \type{gfm}). In
the following, extensions that also work for other formats are covered.

Note that Markdown extensions added to the \type{ipynb} format affect
Markdown cells in Jupyter notebooks (as do command-line options like
\type{--markdown-headings}).

\startsectionlevel[title={Typography},reference={typography}]

\startsectionlevel[title={Extension:
\type{smart}},reference={extension-smart}]

Interpret straight quotes as curly quotes, \type{---} as em-dashes,
\type{--} as en-dashes, and \type{...} as ellipses. Nonbreaking spaces
are inserted after certain abbreviations, such as \quotation{Mr.}

This extension can be enabled/disabled for the following formats:

\startdescription{input formats}
  \type{markdown}, \type{commonmark}, \type{latex}, \type{mediawiki},
  \type{org}, \type{rst}, \type{twiki}, \type{html}
\stopdescription

\startdescription{output formats}
  \type{markdown}, \type{latex}, \type{context}, \type{rst}
\stopdescription

\startdescription{enabled by default in}
  \type{markdown}, \type{latex}, \type{context} (both input and output)
\stopdescription

Note: If you are {\em writing} Markdown, then the \type{smart} extension
has the reverse effect: what would have been curly quotes comes out
straight.

In LaTeX, \type{smart} means to use the standard TeX ligatures for
quotation marks (\type{``} and \type{''} for double quotes, \type{`} and
\type{'} for single quotes) and dashes (\type{--} for en-dash and
\type{---} for em-dash). If \type{smart} is disabled, then in reading
LaTeX pandoc will parse these characters literally. In writing LaTeX,
enabling \type{smart} tells pandoc to use the ligatures when possible;
if \type{smart} is disabled pandoc will use unicode quotation mark and
dash characters.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Headings and
sections},reference={headings-and-sections}]

\startsectionlevel[title={Extension:
\type{auto_identifiers}},reference={extension-auto_identifiers}]

A heading without an explicitly specified identifier will be
automatically assigned a unique identifier based on the heading text.

This extension can be enabled/disabled for the following formats:

\startdescription{input formats}
  \type{markdown}, \type{latex}, \type{rst}, \type{mediawiki},
  \type{textile}
\stopdescription

\startdescription{output formats}
  \type{markdown}, \type{muse}
\stopdescription

\startdescription{enabled by default in}
  \type{markdown}, \type{muse}
\stopdescription

The default algorithm used to derive the identifier from the heading
text is:

\startitemize[packed]
\item
  Remove all formatting, links, etc.
\item
  Remove all footnotes.
\item
  Remove all non-alphanumeric characters, except underscores, hyphens,
  and periods.
\item
  Replace all spaces and newlines with hyphens.
\item
  Convert all alphabetic characters to lowercase.
\item
  Remove everything up to the first letter (identifiers may not begin
  with a number or punctuation mark).
\item
  If nothing is left after this, use the identifier \type{section}.
\stopitemize

Thus, for example,

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right] Heading \stopxcell
\startxcell[align=right] Identifier \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right] \type{Heading identifiers in HTML} \stopxcell
\startxcell[align=right] \type{heading-identifiers-in-html} \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] \type{Maître d'hôtel} \stopxcell
\startxcell[align=right] \type{maître-dhôtel} \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] \type{*Dogs*?--in *my* house?} \stopxcell
\startxcell[align=right] \type{dogs--in-my-house} \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] \type{[HTML], [S5], or [RTF]?} \stopxcell
\startxcell[align=right] \type{html-s5-or-rtf} \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] \type{3. Applications} \stopxcell
\startxcell[align=right] \type{applications} \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right] \type{33} \stopxcell
\startxcell[align=right] \type{section} \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

These rules should, in most cases, allow one to determine the identifier
from the heading text. The exception is when several headings have the
same text; in this case, the first will get an identifier as described
above; the second will get the same identifier with \type{-1} appended;
the third with \type{-2}; and so on.

(However, a different algorithm is used if \type{gfm_auto_identifiers}
is enabled; see below.)

These identifiers are used to provide link targets in the table of
contents generated by the \type{--toc|--table-of-contents} option. They
also make it easy to provide links from one section of a document to
another. A link to this section, for example, might look like this:

\starttyping
See the section on
[heading identifiers](#heading-identifiers-in-html-latex-and-context).
\stoptyping

Note, however, that this method of providing links to sections works
only in HTML, LaTeX, and ConTeXt formats.

If the \type{--section-divs} option is specified, then each section will
be wrapped in a \type{section} (or a \type{div}, if \type{html4} was
specified), and the identifier will be attached to the enclosing
\type{<section>} (or \type{<div>}) tag rather than the heading itself.
This allows entire sections to be manipulated using JavaScript or
treated differently in CSS.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{ascii_identifiers}},reference={extension-ascii_identifiers}]

Causes the identifiers produced by \type{auto_identifiers} to be pure
ASCII. Accents are stripped off of accented Latin letters, and non-Latin
letters are omitted.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{gfm_auto_identifiers}},reference={extension-gfm_auto_identifiers}]

Changes the algorithm used by \type{auto_identifiers} to conform to
GitHub's method. Spaces are converted to dashes (\type{-}), uppercase
characters to lowercase characters, and punctuation characters other
than \type{-} and \type{_} are removed. Emojis are replaced by their
names.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Math Input},reference={math-input}]

The extensions
\goto{\type{tex_math_dollars}}[extension-tex_math_dollars],
\goto{\type{tex_math_gfm}}[extension-tex_math_gfm],
\goto{\type{tex_math_single_backslash}}[extension-tex_math_single_backslash],
and
\goto{\type{tex_math_double_backslash}}[extension-tex_math_double_backslash]
are described in the section about Pandoc's Markdown.

However, they can also be used with HTML input. This is handy for
reading web pages formatted using MathJax, for example.

\stopsectionlevel

\startsectionlevel[title={Raw HTML/TeX},reference={raw-htmltex}]

The following extensions are described in more detail in their
respective sections of \goto{Pandoc's Markdown}[pandocs-markdown]:

\startitemize
\item
  \goto{\type{raw_html}}[extension-raw_html] allows HTML elements which
  are not representable in pandoc's AST to be parsed as raw HTML. By
  default, this is disabled for HTML input.
\item
  \goto{\type{raw_tex}}[extension-raw_tex] allows raw LaTeX, TeX, and
  ConTeXt to be included in a document. This extension can be
  enabled/disabled for the following formats (in addition to
  \type{markdown}):

  \startdescription{input formats}
    \type{latex}, \type{textile}, \type{html} (environments,
    \type{\ref}, and \type{\eqref} only), \type{ipynb}
  \stopdescription

  \startdescription{output formats}
    \type{textile}, \type{commonmark}
  \stopdescription

  Note: as applied to \type{ipynb}, \type{raw_html} and \type{raw_tex}
  affect not only raw TeX in Markdown cells, but data with mime type
  \type{text/html} in output cells. Since the \type{ipynb} reader
  attempts to preserve the richest possible outputs when several options
  are given, you will get best results if you disable \type{raw_html}
  and \type{raw_tex} when converting to formats like \type{docx} which
  don't allow raw \type{html} or \type{tex}.
\item
  \goto{\type{native_divs}}[extension-native_divs] causes HTML
  \type{div} elements to be parsed as native pandoc Div blocks. If you
  want them to be parsed as raw HTML, use
  \type{-f html-native_divs+raw_html}.
\item
  \goto{\type{native_spans}}[extension-native_spans] causes HTML
  \type{span} elements to be parsed as native pandoc Span inlines. If
  you want them to be parsed as raw HTML, use
  \type{-f html-native_spans+raw_html}. If you want to drop all
  \type{div}s and \type{span}s when converting HTML to Markdown, you can
  use \type{pandoc -f html-native_divs-native_spans -t markdown}.
\stopitemize

\stopsectionlevel

\startsectionlevel[title={Literate Haskell
support},reference={literate-haskell-support}]

\startsectionlevel[title={Extension:
\type{literate_haskell}},reference={extension-literate_haskell}]

Treat the document as literate Haskell source.

This extension can be enabled/disabled for the following formats:

\startdescription{input formats}
  \type{markdown}, \type{rst}, \type{latex}
\stopdescription

\startdescription{output formats}
  \type{markdown}, \type{rst}, \type{latex}, \type{html}
\stopdescription

If you append \type{+lhs} (or \type{+literate_haskell}) to one of the
formats above, pandoc will treat the document as literate Haskell
source. This means that

\startitemize
\item
  In Markdown input, \quotation{bird track} sections will be parsed as
  Haskell code rather than block quotations. Text between
  \type"\begin{code}" and \type"\end{code}" will also be treated as
  Haskell code. For ATX-style headings the character \quote{=} will be
  used instead of \quote{\#}.
\item
  In Markdown output, code blocks with classes \type{haskell} and
  \type{literate} will be rendered using bird tracks, and block
  quotations will be indented one space, so they will not be treated as
  Haskell code. In addition, headings will be rendered setext-style
  (with underlines) rather than ATX-style (with \quote{\#} characters).
  (This is because ghc treats \quote{\#} characters in column 1 as
  introducing line numbers.)
\item
  In restructured text input, \quotation{bird track} sections will be
  parsed as Haskell code.
\item
  In restructured text output, code blocks with class \type{haskell}
  will be rendered using bird tracks.
\item
  In LaTeX input, text in \type{code} environments will be parsed as
  Haskell code.
\item
  In LaTeX output, code blocks with class \type{haskell} will be
  rendered inside \type{code} environments.
\item
  In HTML output, code blocks with class \type{haskell} will be rendered
  with class \type{literatehaskell} and bird tracks.
\stopitemize

Examples:

\starttyping
pandoc -f markdown+lhs -t html
\stoptyping

reads literate Haskell source formatted with Markdown conventions and
writes ordinary HTML (without bird tracks).

\starttyping
pandoc -f markdown+lhs -t html+lhs
\stoptyping

writes HTML with the Haskell code in bird tracks, so it can be copied
and pasted as literate Haskell source.

Note that GHC expects the bird tracks in the first column, so indented
literate code blocks (e.g.~inside an itemized environment) will not be
picked up by the Haskell compiler.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Other
extensions},reference={other-extensions}]

\startsectionlevel[title={Extension:
\type{empty_paragraphs}},reference={extension-empty_paragraphs}]

Allows empty paragraphs. By default empty paragraphs are omitted.

This extension can be enabled/disabled for the following formats:

\startdescription{input formats}
  \type{docx}, \type{html}
\stopdescription

\startdescription{output formats}
  \type{docx}, \type{odt}, \type{opendocument}, \type{html},
  \type{latex}
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{native_numbering}},reference={extension-native_numbering}]

Enables native numbering of figures and tables. Enumeration starts at 1.

This extension can be enabled/disabled for the following formats:

\startdescription{output formats}
  \type{odt}, \type{opendocument}, \type{docx}
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{xrefs_name}},reference={extension-xrefs_name}]

Links to headings, figures and tables inside the document are
substituted with cross-references that will use the name or caption of
the referenced item. The original link text is replaced once the
generated document is refreshed. This extension can be combined with
\type{xrefs_number} in which case numbers will appear before the name.

Text in cross-references is only made consistent with the referenced
item once the document has been refreshed.

This extension can be enabled/disabled for the following formats:

\startdescription{output formats}
  \type{odt}, \type{opendocument}
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{xrefs_number}},reference={extension-xrefs_number}]

Links to headings, figures and tables inside the document are
substituted with cross-references that will use the number of the
referenced item. The original link text is discarded. This extension can
be combined with \type{xrefs_name} in which case the name or caption
numbers will appear after the number.

For the \type{xrefs_number} to be useful heading numbers must be enabled
in the generated document, also table and figure captions must be
enabled using for example the \type{native_numbering} extension.

Numbers in cross-references are only visible in the final document once
it has been refreshed.

This extension can be enabled/disabled for the following formats:

\startdescription{output formats}
  \type{odt}, \type{opendocument}
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{styles}},reference={ext-styles}]

When converting from docx, read all docx styles as divs (for paragraph
styles) and spans (for character styles) regardless of whether pandoc
understands the meaning of these styles. This can be used with
\goto{docx custom styles}[custom-styles]. Disabled by default.

\startdescription{input formats}
  \type{docx}
\stopdescription

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{amuse}},reference={extension-amuse}]

In the \type{muse} input format, this enables Text::Amuse extensions to
Emacs Muse markup.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{raw_markdown}},reference={extension-raw_markdown}]

In the \type{ipynb} input format, this causes Markdown cells to be
included as raw Markdown blocks (allowing lossless round-tripping)
rather than being parsed. Use this only when you are targeting
\type{ipynb} or a Markdown-based output format.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{citations}},reference={org-citations}]

When the \type{citations} extension is enabled in \type{org}, org-cite
and org-ref style citations will be parsed as native pandoc citations.

When \type{citations} is enabled in \type{docx}, citations inserted by
Zotero or Mendeley or EndNote plugins will be parsed as native pandoc
citations. (Otherwise, the formatted citations generated by the
bibliographic software will be parsed as regular text.)

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{fancy_lists}},reference={org-fancy-lists}]

Some aspects of \goto{Pandoc's Markdown fancy
lists}[extension-fancy_lists] are also accepted in \type{org} input,
mimicking the option \type{org-list-allow-alphabetical} in Emacs. As in
Org Mode, enabling this extension allows lowercase and uppercase
alphabetical markers for ordered lists to be parsed in addition to
arabic ones. Note that for Org, this does not include roman numerals or
the \type{#} placeholder that are enabled by the extension in Pandoc's
Markdown.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{element_citations}},reference={extension-element_citations}]

In the \type{jats} output formats, this causes reference items to be
replaced with \type{<element-citation>} elements. These elements are not
influenced by CSL styles, but all information on the item is included in
tags.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{ntb}},reference={extension-ntb}]

In the \type{context} output format this enables the use of
\goto{Natural Tables (TABLE)}[url(https://wiki.contextgarden.net/TABLE)]
instead of the default \goto{Extreme Tables
(xtables)}[url(https://wiki.contextgarden.net/xtables)]. Natural tables
allow more fine-grained global customization but come at a performance
penalty compared to extreme tables.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{tagging}},reference={extension-tagging}]

Enabling this extension with \type{context} output will produce markup
suitable for the production of tagged PDFs. This includes additional
markers for paragraphs and alternative markup for emphasized text. The
\type{emphasis-command} template variable is set if the extension is
enabled.

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Pandoc's
Markdown},reference={pandocs-markdown}]

Pandoc understands an extended and slightly revised version of John
Gruber's
\goto{Markdown}[url(https://daringfireball.net/projects/markdown/)]
syntax. This document explains the syntax, noting differences from
original Markdown. Except where noted, these differences can be
suppressed by using the \type{markdown_strict} format instead of
\type{markdown}. Extensions can be enabled or disabled to specify the
behavior more granularly. They are described in the following. See also
\goto{Extensions}[extensions] above, for extensions that work also on
other formats.

\startsectionlevel[title={Philosophy},reference={philosophy}]

Markdown is designed to be easy to write, and, even more importantly,
easy to read:

\startblockquote
A Markdown-formatted document should be publishable as-is, as plain
text, without looking like it's been marked up with tags or formatting
instructions. -- \goto{John
Gruber}[url(https://daringfireball.net/projects/markdown/syntax\#philosophy)]
\stopblockquote

This principle has guided pandoc's decisions in finding syntax for
tables, footnotes, and other extensions.

There is, however, one respect in which pandoc's aims are different from
the original aims of Markdown. Whereas Markdown was originally designed
with HTML generation in mind, pandoc is designed for multiple output
formats. Thus, while pandoc allows the embedding of raw HTML, it
discourages it, and provides other, non-HTMLish ways of representing
important document elements like definition lists, tables, mathematics,
and footnotes.

\stopsectionlevel

\startsectionlevel[title={Paragraphs},reference={paragraphs}]

A paragraph is one or more lines of text followed by one or more blank
lines. Newlines are treated as spaces, so you can reflow your paragraphs
as you like. If you need a hard line break, put two or more spaces at
the end of a line.

\startsectionlevel[title={Extension:
\type{escaped_line_breaks}},reference={extension-escaped_line_breaks}]

A backslash followed by a newline is also a hard line break. Note: in
multiline and grid table cells, this is the only way to create a hard
line break, since trailing spaces in the cells are ignored.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Headings},reference={headings}]

There are two kinds of headings: Setext and ATX.

\startsectionlevel[title={Setext-style
headings},reference={setext-style-headings}]

A setext-style heading is a line of text \quotation{underlined} with a
row of \type{=} signs (for a level-one heading) or \type{-} signs (for a
level-two heading):

\starttyping
A level-one heading
===================

A level-two heading
-------------------
\stoptyping

The heading text can contain inline formatting, such as emphasis (see
\goto{Inline formatting}[inline-formatting], below).

\stopsectionlevel

\startsectionlevel[title={ATX-style
headings},reference={atx-style-headings}]

An ATX-style heading consists of one to six \type{#} signs and a line of
text, optionally followed by any number of \type{#} signs. The number of
\type{#} signs at the beginning of the line is the heading level:

\starttyping
## A level-two heading

### A level-three heading ###
\stoptyping

As with setext-style headings, the heading text can contain formatting:

\starttyping
# A level-one heading with a [link](/url) and *emphasis*
\stoptyping

\startsectionlevel[title={Extension:
\type{blank_before_header}},reference={extension-blank_before_header}]

Original Markdown syntax does not require a blank line before a heading.
Pandoc does require this (except, of course, at the beginning of the
document). The reason for the requirement is that it is all too easy for
a \type{#} to end up at the beginning of a line by accident (perhaps
through line wrapping). Consider, for example:

\starttyping
I like several of their flavors of ice cream:
#22, for example, and #5.
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{space_in_atx_header}},reference={extension-space_in_atx_header}]

Many Markdown implementations do not require a space between the opening
\type{#}s of an ATX heading and the heading text, so that \type{#5 bolt}
and \type{#hashtag} count as headings. With this extension, pandoc does
require the space.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Heading
identifiers},reference={heading-identifiers}]

See also the \goto{\type{auto_identifiers}
extension}[extension-auto_identifiers] above.

\startsectionlevel[title={Extension:
\type{header_attributes}},reference={extension-header_attributes}]

Headings can be assigned attributes using this syntax at the end of the
line containing the heading text:

\starttyping
{#identifier .class .class key=value key=value}
\stoptyping

Thus, for example, the following headings will all be assigned the
identifier \type{foo}:

\starttyping
# My heading {#foo}

## My heading ##    {#foo}

My other heading   {#foo}
---------------
\stoptyping

(This syntax is compatible with \goto{PHP Markdown
Extra}[url(https://michelf.ca/projects/php-markdown/extra/)].)

Note that although this syntax allows assignment of classes and
key/value attributes, writers generally don't use all of this
information. Identifiers, classes, and key/value attributes are used in
HTML and HTML-based formats such as EPUB and slidy. Identifiers are used
for labels and link anchors in the LaTeX, ConTeXt, Textile, Jira markup,
and AsciiDoc writers.

Headings with the class \type{unnumbered} will not be numbered, even if
\type{--number-sections} is specified. A single hyphen (\type{-}) in an
attribute context is equivalent to \type{.unnumbered}, and preferable in
non-English documents. So,

\starttyping
# My heading {-}
\stoptyping

is just the same as

\starttyping
# My heading {.unnumbered}
\stoptyping

If the \type{unlisted} class is present in addition to
\type{unnumbered}, the heading will not be included in a table of
contents. (Currently this feature is only implemented for certain
formats: those based on LaTeX and HTML, PowerPoint, and RTF.)

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{implicit_header_references}},reference={extension-implicit_header_references}]

Pandoc behaves as if reference links have been defined for each heading.
So, to link to a heading

\starttyping
# Heading identifiers in HTML
\stoptyping

you can simply write

\starttyping
[Heading identifiers in HTML]
\stoptyping

or

\starttyping
[Heading identifiers in HTML][]
\stoptyping

or

\starttyping
[the section on heading identifiers][heading identifiers in
HTML]
\stoptyping

instead of giving the identifier explicitly:

\starttyping
[Heading identifiers in HTML](#heading-identifiers-in-html)
\stoptyping

If there are multiple headings with identical text, the corresponding
reference will link to the first one only, and you will need to use
explicit links to link to the others, as described above.

Like regular reference links, these references are case-insensitive.

Explicit link reference definitions always take priority over implicit
heading references. So, in the following example, the link will point to
\type{bar}, not to \type{#foo}:

\starttyping
# Foo

[foo]: bar

See [foo]
\stoptyping

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Block
quotations},reference={block-quotations}]

Markdown uses email conventions for quoting blocks of text. A block
quotation is one or more paragraphs or other block elements (such as
lists or headings), with each line preceded by a \type{>} character and
an optional space. (The \type{>} need not start at the left margin, but
it should not be indented more than three spaces.)

\starttyping
> This is a block quote. This
> paragraph has two lines.
>
> 1. This is a list inside a block quote.
> 2. Second item.
\stoptyping

A \quotation{lazy} form, which requires the \type{>} character only on
the first line of each block, is also allowed:

\starttyping
> This is a block quote. This
paragraph has two lines.

> 1. This is a list inside a block quote.
2. Second item.
\stoptyping

Among the block elements that can be contained in a block quote are
other block quotes. That is, block quotes can be nested:

\starttyping
> This is a block quote.
>
> > A block quote within a block quote.
\stoptyping

If the \type{>} character is followed by an optional space, that space
will be considered part of the block quote marker and not part of the
indentation of the contents. Thus, to put an indented code block in a
block quote, you need five spaces after the \type{>}:

\starttyping
>     code
\stoptyping

\startsectionlevel[title={Extension:
\type{blank_before_blockquote}},reference={extension-blank_before_blockquote}]

Original Markdown syntax does not require a blank line before a block
quote. Pandoc does require this (except, of course, at the beginning of
the document). The reason for the requirement is that it is all too easy
for a \type{>} to end up at the beginning of a line by accident (perhaps
through line wrapping). So, unless the \type{markdown_strict} format is
used, the following does not produce a nested block quote in pandoc:

\starttyping
> This is a block quote.
>> Not nested, since `blank_before_blockquote` is enabled by default
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Verbatim (code)
blocks},reference={verbatim-code-blocks}]

\startsectionlevel[title={Indented code
blocks},reference={indented-code-blocks}]

A block of text indented four spaces (or one tab) is treated as verbatim
text: that is, special characters do not trigger special formatting, and
all spaces and line breaks are preserved. For example,

\starttyping
    if (a > 3) {
      moveShip(5 * gravity, DOWN);
    }
\stoptyping

The initial (four space or one tab) indentation is not considered part
of the verbatim text, and is removed in the output.

Note: blank lines in the verbatim text need not begin with four spaces.

\stopsectionlevel

\startsectionlevel[title={Fenced code
blocks},reference={fenced-code-blocks}]

\startsectionlevel[title={Extension:
\type{fenced_code_blocks}},reference={extension-fenced_code_blocks}]

In addition to standard indented code blocks, pandoc supports {\em
fenced} code blocks. These begin with a row of three or more tildes
(\type{~}) and end with a row of tildes that must be at least as long as
the starting row. Everything between these lines is treated as code. No
indentation is necessary:

\starttyping
~~~~~~~
if (a > 3) {
  moveShip(5 * gravity, DOWN);
}
~~~~~~~
\stoptyping

Like regular code blocks, fenced code blocks must be separated from
surrounding text by blank lines.

If the code itself contains a row of tildes or backticks, just use a
longer row of tildes or backticks at the start and end:

\starttyping
~~~~~~~~~~~~~~~~
~~~~~~~~~~
code including tildes
~~~~~~~~~~
~~~~~~~~~~~~~~~~
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{backtick_code_blocks}},reference={extension-backtick_code_blocks}]

Same as \type{fenced_code_blocks}, but uses backticks (\type{`}) instead
of tildes (\type{~}).

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{fenced_code_attributes}},reference={extension-fenced_code_attributes}]

Optionally, you may attach attributes to fenced or backtick code block
using this syntax:

\starttyping
~~~~ {#mycode .haskell .numberLines startFrom="100"}
qsort []     = []
qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
               qsort (filter (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
\stoptyping

Here \type{mycode} is an identifier, \type{haskell} and
\type{numberLines} are classes, and \type{startFrom} is an attribute
with value \type{100}. Some output formats can use this information to
do syntax highlighting. Currently, the only output formats that use this
information are HTML, LaTeX, Docx, Ms, and PowerPoint. If highlighting
is supported for your output format and language, then the code block
above will appear highlighted, with numbered lines. (To see which
languages are supported, type \type{pandoc --list-highlight-languages}.)
Otherwise, the code block above will appear as follows:

\starttyping
<pre id="mycode" class="haskell numberLines" startFrom="100">
  <code>
  ...
  </code>
</pre>
\stoptyping

The \type{numberLines} (or \type{number-lines}) class will cause the
lines of the code block to be numbered, starting with \type{1} or the
value of the \type{startFrom} attribute. The \type{lineAnchors} (or
\type{line-anchors}) class will cause the lines to be clickable anchors
in HTML output.

A shortcut form can also be used for specifying the language of the code
block:

\starttyping
```haskell
qsort [] = []
```
\stoptyping

This is equivalent to:

\starttyping
``` {.haskell}
qsort [] = []
```
\stoptyping

This shortcut form may be combined with attributes:

\starttyping
```haskell {.numberLines}
qsort [] = []
```
\stoptyping

Which is equivalent to:

\starttyping
``` {.haskell .numberLines}
qsort [] = []
```
\stoptyping

If the \type{fenced_code_attributes} extension is disabled, but input
contains class attribute(s) for the code block, the first class
attribute will be printed after the opening fence as a bare word.

To prevent all highlighting, use the \type{--no-highlight} flag. To set
the highlighting style, use \type{--highlight-style}. For more
information on highlighting, see \goto{Syntax
highlighting}[syntax-highlighting], below.

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Line blocks},reference={line-blocks}]

\startsectionlevel[title={Extension:
\type{line_blocks}},reference={extension-line_blocks}]

A line block is a sequence of lines beginning with a vertical bar
(\type{|}) followed by a space. The division into lines will be
preserved in the output, as will any leading spaces; otherwise, the
lines will be formatted as Markdown. This is useful for verse and
addresses:

\starttyping
| The limerick packs laughs anatomical
| In space that is quite economical.
|    But the good ones I've seen
|    So seldom are clean
| And the clean ones so seldom are comical

| 200 Main St.
| Berkeley, CA 94718
\stoptyping

The lines can be hard-wrapped if needed, but the continuation line must
begin with a space.

\starttyping
| The Right Honorable Most Venerable and Righteous Samuel L.
  Constable, Jr.
| 200 Main St.
| Berkeley, CA 94718
\stoptyping

Inline formatting (such as emphasis) is allowed in the content (though
it can't cross line boundaries). Block-level formatting (such as block
quotes or lists) is not recognized.

This syntax is borrowed from
\goto{reStructuredText}[url(https://docutils.sourceforge.io/docs/ref/rst/introduction.html)].

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Lists},reference={lists}]

\startsectionlevel[title={Bullet lists},reference={bullet-lists}]

A bullet list is a list of bulleted list items. A bulleted list item
begins with a bullet (\type{*}, \type{+}, or \type{-}). Here is a simple
example:

\starttyping
* one
* two
* three
\stoptyping

This will produce a \quotation{compact} list. If you want a
\quotation{loose} list, in which each item is formatted as a paragraph,
put spaces between the items:

\starttyping
* one

* two

* three
\stoptyping

The bullets need not be flush with the left margin; they may be indented
one, two, or three spaces. The bullet must be followed by whitespace.

List items look best if subsequent lines are flush with the first line
(after the bullet):

\starttyping
* here is my first
  list item.
* and my second.
\stoptyping

But Markdown also allows a \quotation{lazy} format:

\starttyping
* here is my first
list item.
* and my second.
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Block content in list
items},reference={block-content-in-list-items}]

A list item may contain multiple paragraphs and other block-level
content. However, subsequent paragraphs must be preceded by a blank line
and indented to line up with the first non-space content after the list
marker.

\starttyping
  * First paragraph.

    Continued.

  * Second paragraph. With a code block, which must be indented
    eight spaces:

        { code }
\stoptyping

Exception: if the list marker is followed by an indented code block,
which must begin 5 spaces after the list marker, then subsequent
paragraphs must begin two columns after the last character of the list
marker:

\starttyping
*     code

  continuation paragraph
\stoptyping

List items may include other lists. In this case the preceding blank
line is optional. The nested list must be indented to line up with the
first non-space character after the list marker of the containing list
item.

\starttyping
* fruits
  + apples
    - macintosh
    - red delicious
  + pears
  + peaches
* vegetables
  + broccoli
  + chard
\stoptyping

As noted above, Markdown allows you to write list items
\quotation{lazily,} instead of indenting continuation lines. However, if
there are multiple paragraphs or other blocks in a list item, the first
line of each must be indented.

\starttyping
+ A lazy, lazy, list
item.

+ Another one; this looks
bad but is legal.

    Second paragraph of second
list item.
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Ordered lists},reference={ordered-lists}]

Ordered lists work just like bulleted lists, except that the items begin
with enumerators rather than bullets.

In original Markdown, enumerators are decimal numbers followed by a
period and a space. The numbers themselves are ignored, so there is no
difference between this list:

\starttyping
1.  one
2.  two
3.  three
\stoptyping

and this one:

\starttyping
5.  one
7.  two
1.  three
\stoptyping

\startsectionlevel[title={Extension:
\type{fancy_lists}},reference={extension-fancy_lists}]

Unlike original Markdown, pandoc allows ordered list items to be marked
with uppercase and lowercase letters and roman numerals, in addition to
Arabic numerals. List markers may be enclosed in parentheses or followed
by a single right-parenthesis or period. They must be separated from the
text that follows by at least one space, and, if the list marker is a
capital letter with a period, by at least two
spaces.\startbuffer The point of this rule is to ensure that normal
  paragraphs starting with people's initials, like

\starttyping
B. Russell won a Nobel Prize (but not for "On Denoting").
\stoptyping

  do not get treated as list items.

  This rule will not prevent

\starttyping
(C) 2007 Joe Smith
\stoptyping

  from being interpreted as a list item. In this case, a backslash
  escape can be used:

\starttyping
(C\) 2007 Joe Smith
\stoptyping\stopbuffer\footnote{\getbuffer}

The \type{fancy_lists} extension also allows \quote{\type{#}} to be used
as an ordered list marker in place of a numeral:

\starttyping
#. one
#. two
\stoptyping

Note: the \quote{\type{#}} ordered list marker doesn't work with
\type{commonmark}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{startnum}},reference={extension-startnum}]

Pandoc also pays attention to the type of list marker used, and to the
starting number, and both of these are preserved where possible in the
output format. Thus, the following yields a list with numbers followed
by a single parenthesis, starting with 9, and a sublist with lowercase
roman numerals:

\starttyping
 9)  Ninth
10)  Tenth
11)  Eleventh
       i. subone
      ii. subtwo
     iii. subthree
\stoptyping

Pandoc will start a new list each time a different type of list marker
is used. So, the following will create three lists:

\starttyping
(2) Two
(5) Three
1.  Four
*   Five
\stoptyping

If default list markers are desired, use \type{#.}:

\starttyping
#.  one
#.  two
#.  three
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{task_lists}},reference={extension-task_lists}]

Pandoc supports task lists, using the syntax of GitHub-Flavored
Markdown.

\starttyping
- [ ] an unchecked task list item
- [x] checked item
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Definition
lists},reference={definition-lists}]

\startsectionlevel[title={Extension:
\type{definition_lists}},reference={extension-definition_lists}]

Pandoc supports definition lists, using the syntax of \goto{PHP Markdown
Extra}[url(https://michelf.ca/projects/php-markdown/extra/)] with some
extensions.\footnote{I have been influenced by the suggestions of
  \goto{David
  Wheeler}[url(https://justatheory.com/2009/02/modest-markdown-proposal/)].}

\starttyping
Term 1

:   Definition 1

Term 2 with *inline markup*

:   Definition 2

        { some code, part of Definition 2 }

    Third paragraph of definition 2.
\stoptyping

Each term must fit on one line, which may optionally be followed by a
blank line, and must be followed by one or more definitions. A
definition begins with a colon or tilde, which may be indented one or
two spaces.

A term may have multiple definitions, and each definition may consist of
one or more block elements (paragraph, code block, list, etc.), each
indented four spaces or one tab stop. The body of the definition (not
including the first line) should be indented four spaces. However, as
with other Markdown lists, you can \quotation{lazily} omit indentation
except at the beginning of a paragraph or other block element:

\starttyping
Term 1

:   Definition
with lazy continuation.

    Second paragraph of the definition.
\stoptyping

If you leave space before the definition (as in the example above), the
text of the definition will be treated as a paragraph. In some output
formats, this will mean greater spacing between term/definition pairs.
For a more compact definition list, omit the space before the
definition:

\starttyping
Term 1
  ~ Definition 1

Term 2
  ~ Definition 2a
  ~ Definition 2b
\stoptyping

Note that space between items in a definition list is required. (A
variant that loosens this requirement, but disallows \quotation{lazy}
hard wrapping, can be activated with the
\goto{\type{compact_definition_lists}
extension}[extension-compact_definition_lists].)

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Numbered example
lists},reference={numbered-example-lists}]

\startsectionlevel[title={Extension:
\type{example_lists}},reference={extension-example_lists}]

The special list marker \type{@} can be used for sequentially numbered
examples. The first list item with a \type{@} marker will be numbered
\quote{1}, the next \quote{2}, and so on, throughout the document. The
numbered examples need not occur in a single list; each new list using
\type{@} will take up where the last stopped. So, for example:

\starttyping
(@)  My first example will be numbered (1).
(@)  My second example will be numbered (2).

Explanation of examples.

(@)  My third example will be numbered (3).
\stoptyping

Numbered examples can be labeled and referred to elsewhere in the
document:

\starttyping
(@good)  This is a good example.

As (@good) illustrates, ...
\stoptyping

The label can be any string of alphanumeric characters, underscores, or
hyphens.

Note: continuation paragraphs in example lists must always be indented
four spaces, regardless of the length of the list marker. That is,
example lists always behave as if the \type{four_space_rule} extension
is set. This is because example labels tend to be long, and indenting
content to the first non-space character after the label would be
awkward.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Ending a list},reference={ending-a-list}]

What if you want to put an indented code block after a list?

\starttyping
-   item one
-   item two

    { my code block }
\stoptyping

Trouble! Here pandoc (like other Markdown implementations) will treat
\type"{ my code block }" as the second paragraph of item two, and not as
a code block.

To \quotation{cut off} the list after item two, you can insert some
non-indented content, like an HTML comment, which won't produce visible
output in any format:

\starttyping
-   item one
-   item two

<!-- end of list -->

    { my code block }
\stoptyping

You can use the same trick if you want two consecutive lists instead of
one big list:

\starttyping
1.  one
2.  two
3.  three

<!-- -->

1.  uno
2.  dos
3.  tres
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Horizontal
rules},reference={horizontal-rules}]

A line containing a row of three or more \type{*}, \type{-}, or \type{_}
characters (optionally separated by spaces) produces a horizontal rule:

\starttyping
*  *  *  *

---------------
\stoptyping

We strongly recommend that horizontal rules be separated from
surrounding text by blank lines. If a horizontal rule is not followed by
a blank line, pandoc may try to interpret the lines that follow as a
YAML metadata block or a table.

\stopsectionlevel

\startsectionlevel[title={Tables},reference={tables}]

Four kinds of tables may be used. The first three kinds presuppose the
use of a fixed-width font, such as Courier. The fourth kind can be used
with proportionally spaced fonts, as it does not require lining up
columns.

\startsectionlevel[title={Extension:
\type{table_captions}},reference={extension-table_captions}]

A caption may optionally be provided with all 4 kinds of tables (as
illustrated in the examples below). A caption is a paragraph beginning
with the string \type{Table:} (or \type{table:} or just \type{:}), which
will be stripped off. It may appear either before or after the table.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{simple_tables}},reference={extension-simple_tables}]

Simple tables look like this:

\starttyping
  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.
\stoptyping

The header and table rows must each fit on one line. Column alignments
are determined by the position of the header text relative to the dashed
line below it:\footnote{This scheme is due to Michel Fortin, who
  proposed it on the \goto{Markdown discussion
  list}[url(http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html)].}

\startitemize[packed]
\item
  If the dashed line is flush with the header text on the right side but
  extends beyond it on the left, the column is right-aligned.
\item
  If the dashed line is flush with the header text on the left side but
  extends beyond it on the right, the column is left-aligned.
\item
  If the dashed line extends beyond the header text on both sides, the
  column is centered.
\item
  If the dashed line is flush with the header text on both sides, the
  default alignment is used (in most cases, this will be left).
\stopitemize

The table must end with a blank line, or a line of dashes followed by a
blank line.

The column header row may be omitted, provided a dashed line is used to
end the table. For example:

\starttyping
-------     ------ ----------   -------
     12     12        12             12
    123     123       123           123
      1     1          1              1
-------     ------ ----------   -------
\stoptyping

When the header row is omitted, column alignments are determined on the
basis of the first line of the table body. So, in the tables above, the
columns would be right, left, center, and right aligned, respectively.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{multiline_tables}},reference={extension-multiline_tables}]

Multiline tables allow header and table rows to span multiple lines of
text (but cells that span multiple columns or rows of the table are not
supported). Here is an example:

\starttyping
-------------------------------------------------------------
 Centered   Default           Right Left
  Header    Aligned         Aligned Aligned
----------- ------- --------------- -------------------------
   First    row                12.0 Example of a row that
                                    spans multiple lines.

  Second    row                 5.0 Here's another one. Note
                                    the blank line between
                                    rows.
-------------------------------------------------------------

Table: Here's the caption. It, too, may span
multiple lines.
\stoptyping

These work like simple tables, but with the following differences:

\startitemize[packed]
\item
  They must begin with a row of dashes, before the header text (unless
  the header row is omitted).
\item
  They must end with a row of dashes, then a blank line.
\item
  The rows must be separated by blank lines.
\stopitemize

In multiline tables, the table parser pays attention to the widths of
the columns, and the writers try to reproduce these relative widths in
the output. So, if you find that one of the columns is too narrow in the
output, try widening it in the Markdown source.

The header may be omitted in multiline tables as well as simple tables:

\starttyping
----------- ------- --------------- -------------------------
   First    row                12.0 Example of a row that
                                    spans multiple lines.

  Second    row                 5.0 Here's another one. Note
                                    the blank line between
                                    rows.
----------- ------- --------------- -------------------------

: Here's a multiline table without a header.
\stoptyping

It is possible for a multiline table to have just one row, but the row
should be followed by a blank line (and then the row of dashes that ends
the table), or the table may be interpreted as a simple table.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{grid_tables}},reference={extension-grid_tables}]

Grid tables look like this:

\starttyping
: Sample grid table.

+---------------+---------------+--------------------+
| Fruit         | Price         | Advantages         |
+===============+===============+====================+
| Bananas       | $1.34         | - built-in wrapper |
|               |               | - bright color     |
+---------------+---------------+--------------------+
| Oranges       | $2.10         | - cures scurvy     |
|               |               | - tasty            |
+---------------+---------------+--------------------+
\stoptyping

The row of \type{=}s separates the header from the table body, and can
be omitted for a headerless table. The cells of grid tables may contain
arbitrary block elements (multiple paragraphs, code blocks, lists,
etc.).

Cells can span multiple columns or rows:

\starttyping
+---------------------+----------+
| Property            | Earth    |
+=============+=======+==========+
|             | min   | -89.2 °C |
| Temperature +-------+----------+
| 1961-1990   | mean  | 14 °C    |
|             +-------+----------+
|             | max   | 56.7 °C  |
+-------------+-------+----------+
\stoptyping

A table header may contain more than one row:

\starttyping
+---------------------+-----------------------+
| Location            | Temperature 1961-1990 |
|                     | in degree Celsius     |
|                     +-------+-------+-------+
|                     | min   | mean  | max   |
+=====================+=======+=======+=======+
| Antarctica          | -89.2 | N/A   | 19.8  |
+---------------------+-------+-------+-------+
| Earth               | -89.2 | 14    | 56.7  |
+---------------------+-------+-------+-------+
\stoptyping

Alignments can be specified as with pipe tables, by putting colons at
the boundaries of the separator line after the header:

\starttyping
+---------------+---------------+--------------------+
| Right         | Left          | Centered           |
+==============:+:==============+:==================:+
| Bananas       | $1.34         | built-in wrapper   |
+---------------+---------------+--------------------+
\stoptyping

For headerless tables, the colons go on the top line instead:

\starttyping
+--------------:+:--------------+:------------------:+
| Right         | Left          | Centered           |
+---------------+---------------+--------------------+
\stoptyping

A table foot can be defined by enclosing it with separator lines that
use \type{=} instead of \type{-}:

\starttyping
 +---------------+---------------+
 | Fruit         | Price         |
 +===============+===============+
 | Bananas       | $1.34         |
 +---------------+---------------+
 | Oranges       | $2.10         |
 +===============+===============+
 | Sum           | $3.44         |
 +===============+===============+
\stoptyping

The foot must always be placed at the very bottom of the table.

Grid tables can be created easily using Emacs' table-mode
(\type{M-x table-insert}).

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{pipe_tables}},reference={extension-pipe_tables}]

Pipe tables look like this:

\starttyping
| Right | Left | Default | Center |
|------:|:-----|---------|:------:|
|   12  |  12  |    12   |    12  |
|  123  |  123 |   123   |   123  |
|    1  |    1 |     1   |     1  |

  : Demonstration of pipe table syntax.
\stoptyping

The syntax is identical to \goto{PHP Markdown Extra
tables}[url(https://michelf.ca/projects/php-markdown/extra/\#table)].
The beginning and ending pipe characters are optional, but pipes are
required between all columns. The colons indicate column alignment as
shown. The header cannot be omitted. To simulate a headerless table,
include a header with blank cells.

Since the pipes indicate column boundaries, columns need not be
vertically aligned, as they are in the above example. So, this is a
perfectly legal (though ugly) pipe table:

\starttyping
fruit| price
-----|-----:
apple|2.05
pear|1.37
orange|3.09
\stoptyping

The cells of pipe tables cannot contain block elements like paragraphs
and lists, and cannot span multiple lines. If any line of the Markdown
source is longer than the column width (see \type{--columns}), then the
table will take up the full text width and the cell contents will wrap,
with the relative cell widths determined by the number of dashes in the
line separating the table header from the table body. (For example
\type{---|-} would make the first column 3/4 and the second column 1/4
of the full text width.) On the other hand, if no lines are wider than
column width, then cell contents will not be wrapped, and the cells will
be sized to their contents.

Note: pandoc also recognizes pipe tables of the following form, as can
be produced by Emacs' orgtbl-mode:

\starttyping
| One | Two   |
|-----+-------|
| my  | table |
| is  | nice  |
\stoptyping

The difference is that \type{+} is used instead of \type{|}. Other
orgtbl features are not supported. In particular, to get non-default
column alignment, you'll need to add colons as above.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Metadata blocks},reference={metadata-blocks}]

\startsectionlevel[title={Extension:
\type{pandoc_title_block}},reference={extension-pandoc_title_block}]

If the file begins with a title block

\starttyping
% title
% author(s) (separated by semicolons)
% date
\stoptyping

it will be parsed as bibliographic information, not regular text. (It
will be used, for example, in the title of standalone LaTeX or HTML
output.) The block may contain just a title, a title and an author, or
all three elements. If you want to include an author but no title, or a
title and a date but no author, you need a blank line:

\starttyping
%
% Author
\stoptyping

\starttyping
% My title
%
% June 15, 2006
\stoptyping

The title may occupy multiple lines, but continuation lines must begin
with leading space, thus:

\starttyping
% My title
  on multiple lines
\stoptyping

If a document has multiple authors, the authors may be put on separate
lines with leading space, or separated by semicolons, or both. So, all
of the following are equivalent:

\starttyping
% Author One
  Author Two
\stoptyping

\starttyping
% Author One; Author Two
\stoptyping

\starttyping
% Author One;
  Author Two
\stoptyping

The date must fit on one line.

All three metadata fields may contain standard inline formatting
(italics, links, footnotes, etc.).

Title blocks will always be parsed, but they will affect the output only
when the \type{--standalone} (\type{-s}) option is chosen. In HTML
output, titles will appear twice: once in the document head -- this is
the title that will appear at the top of the window in a browser -- and
once at the beginning of the document body. The title in the document
head can have an optional prefix attached (\type{--title-prefix} or
\type{-T} option). The title in the body appears as an H1 element with
class \quotation{title}, so it can be suppressed or reformatted with
CSS. If a title prefix is specified with \type{-T} and no title block
appears in the document, the title prefix will be used by itself as the
HTML title.

The man page writer extracts a title, man page section number, and other
header and footer information from the title line. The title is assumed
to be the first word on the title line, which may optionally end with a
(single-digit) section number in parentheses. (There should be no space
between the title and the parentheses.) Anything after this is assumed
to be additional footer and header text. A single pipe character
(\type{|}) should be used to separate the footer text from the header
text. Thus,

\starttyping
% PANDOC(1)
\stoptyping

will yield a man page with the title \type{PANDOC} and section 1.

\starttyping
% PANDOC(1) Pandoc User Manuals
\stoptyping

will also have \quotation{Pandoc User Manuals} in the footer.

\starttyping
% PANDOC(1) Pandoc User Manuals | Version 4.0
\stoptyping

will also have \quotation{Version 4.0} in the header.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{yaml_metadata_block}},reference={extension-yaml_metadata_block}]

A \goto{YAML}[url(https://yaml.org/spec/1.2/spec.html)] metadata block
is a valid YAML object, delimited by a line of three hyphens
(\type{---}) at the top and a line of three hyphens (\type{---}) or
three dots (\type{...}) at the bottom. The initial line \type{---} must
not be followed by a blank line. A YAML metadata block may occur
anywhere in the document, but if it is not at the beginning, it must be
preceded by a blank line.

Note that, because of the way pandoc concatenates input files when
several are provided, you may also keep the metadata in a separate YAML
file and pass it to pandoc as an argument, along with your Markdown
files:

\starttyping
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
\stoptyping

Just be sure that the YAML file begins with \type{---} and ends with
\type{---} or \type{...}. Alternatively, you can use the
\type{--metadata-file} option. Using that approach however, you cannot
reference content (like footnotes) from the main Markdown input
document.

Metadata will be taken from the fields of the YAML object and added to
any existing document metadata. Metadata can contain lists and objects
(nested arbitrarily), but all string scalars will be interpreted as
Markdown. Fields with names ending in an underscore will be ignored by
pandoc. (They may be given a role by external processors.) Field names
must not be interpretable as YAML numbers or boolean values (so, for
example, \type{yes}, \type{True}, and \type{15} cannot be used as field
names).

A document may contain multiple metadata blocks. If two metadata blocks
attempt to set the same field, the value from the second block will be
taken.

Each metadata block is handled internally as an independent YAML
document. This means, for example, that any YAML anchors defined in a
block cannot be referenced in another block.

When pandoc is used with \type{-t markdown} to create a Markdown
document, a YAML metadata block will be produced only if the
\type{-s/--standalone} option is used. All of the metadata will appear
in a single block at the beginning of the document.

Note that \goto{YAML}[url(https://yaml.org/spec/1.2/spec.html)] escaping
rules must be followed. Thus, for example, if a title contains a colon,
it must be quoted, and if it contains a backslash escape, then it must
be ensured that it is not treated as a \goto{YAML escape
sequence}[url(https://yaml.org/spec/1.2/spec.html\#id2776092)]. The pipe
character (\type{|}) can be used to begin an indented block that will be
interpreted literally, without need for escaping. This form is necessary
when the field contains blank lines or block-level formatting:

\starttyping
---
title:  'This is the title: it contains a colon'
author:
- Author One
- Author Two
keywords: [nothing, nothingness]
abstract: |
  This is the abstract.

  It consists of two paragraphs.
...
\stoptyping

The literal block after the \type{|} must be indented relative to the
line containing the \type{|}. If it is not, the YAML will be invalid and
pandoc will not interpret it as metadata. For an overview of the complex
rules governing YAML, see the \goto{Wikipedia entry on YAML
syntax}[url(https://en.wikipedia.org/wiki/YAML\#Syntax)].

Template variables will be set automatically from the metadata. Thus,
for example, in writing HTML, the variable \type{abstract} will be set
to the HTML equivalent of the Markdown in the \type{abstract} field:

\starttyping
<p>This is the abstract.</p>
<p>It consists of two paragraphs.</p>
\stoptyping

Variables can contain arbitrary YAML structures, but the template must
match this structure. The \type{author} variable in the default
templates expects a simple list or string, but can be changed to support
more complicated structures. The following combination, for example,
would add an affiliation to the author if one is given:

\starttyping
---
title: The document title
author:
- name: Author One
  affiliation: University of Somewhere
- name: Author Two
  affiliation: University of Nowhere
...
\stoptyping

To use the structured authors in the example above, you would need a
custom template:

\starttyping
$for(author)$
$if(author.name)$
$author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
$else$
$author$
$endif$
$endfor$
\stoptyping

Raw content to include in the document's header may be specified using
\type{header-includes}; however, it is important to mark up this content
as raw code for a particular output format, using the
\goto{\type{raw_attribute} extension}[extension-raw_attribute], or it
will be interpreted as Markdown. For example:

\starttyping
header-includes:
- |
  ```{=latex}
  \let\oldsection\section
  \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
  ```
\stoptyping

Note: the \type{yaml_metadata_block} extension works with
\type{commonmark} as well as \type{markdown} (and it is enabled by
default in \type{gfm} and \type{commonmark_x}). However, in these
formats the following restrictions apply:

\startitemize
\item
  The YAML metadata block must occur at the beginning of the document
  (and there can be only one). If multiple files are given as arguments
  to pandoc, only the first can be a YAML metadata block.
\item
  The leaf nodes of the YAML structure are parsed in isolation from each
  other and from the rest of the document. So, for example, you can't
  use a reference link in these contexts if the link definition is
  somewhere else in the document.
\stopitemize

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Backslash
escapes},reference={backslash-escapes}]

\startsectionlevel[title={Extension:
\type{all_symbols_escapable}},reference={extension-all_symbols_escapable}]

Except inside a code block or inline code, any punctuation or space
character preceded by a backslash will be treated literally, even if it
would normally indicate formatting. Thus, for example, if one writes

\starttyping
*\*hello\**
\stoptyping

one will get

\starttyping
<em>*hello*</em>
\stoptyping

instead of

\starttyping
<strong>hello</strong>
\stoptyping

This rule is easier to remember than original Markdown's rule, which
allows only the following characters to be backslash-escaped:

\starttyping
\`*_{}[]()>#+-.!
\stoptyping

(However, if the \type{markdown_strict} format is used, the original
Markdown rule will be used.)

A backslash-escaped space is parsed as a nonbreaking space. In TeX
output, it will appear as \type{~}. In HTML and XML output, it will
appear as a literal unicode nonbreaking space character (note that it
will thus actually look \quotation{invisible} in the generated HTML
source; you can still use the \type{--ascii} command-line option to make
it appear as an explicit entity).

A backslash-escaped newline (i.e.~a backslash occurring at the end of a
line) is parsed as a hard line break. It will appear in TeX output as
\type{\\} and in HTML as \type{<br />}. This is a nice alternative to
Markdown's \quotation{invisible} way of indicating hard line breaks
using two trailing spaces on a line.

Backslash escapes do not work in verbatim contexts.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Inline
formatting},reference={inline-formatting}]

\startsectionlevel[title={Emphasis},reference={emphasis}]

To {\em emphasize} some text, surround it with \type{*}s or \type{_},
like this:

\starttyping
This text is _emphasized with underscores_, and this
is *emphasized with asterisks*.
\stoptyping

Double \type{*} or \type{_} produces {\bf strong emphasis}:

\starttyping
This is **strong emphasis** and __with underscores__.
\stoptyping

A \type{*} or \type{_} character surrounded by spaces, or
backslash-escaped, will not trigger emphasis:

\starttyping
This is * not emphasized *, and \*neither is this\*.
\stoptyping

\startsectionlevel[title={Extension:
\type{intraword_underscores}},reference={extension-intraword_underscores}]

Because \type{_} is sometimes used inside words and identifiers, pandoc
does not interpret a \type{_} surrounded by alphanumeric characters as
an emphasis marker. If you want to emphasize just part of a word, use
\type{*}:

\starttyping
feas*ible*, not feas*able*.
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Strikeout},reference={strikeout}]

\startsectionlevel[title={Extension:
\type{strikeout}},reference={extension-strikeout}]

To strike out a section of text with a horizontal line, begin and end it
with \type{~~}. Thus, for example,

\starttyping
This ~~is deleted text.~~
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Superscripts and
subscripts},reference={superscripts-and-subscripts}]

\startsectionlevel[title={Extension: \type{superscript},
\type{subscript}},reference={extension-superscript-subscript}]

Superscripts may be written by surrounding the superscripted text by
\type{^} characters; subscripts may be written by surrounding the
subscripted text by \type{~} characters. Thus, for example,

\starttyping
H~2~O is a liquid.  2^10^ is 1024.
\stoptyping

The text between \type{^...^} or \type{~...~} may not contain spaces or
newlines. If the superscripted or subscripted text contains spaces,
these spaces must be escaped with backslashes. (This is to prevent
accidental superscripting and subscripting through the ordinary use of
\type{~} and \type{^}, and also bad interactions with footnotes.) Thus,
if you want the letter P with \quote{a cat} in subscripts, use
\type{P~a\ cat~}, not \type{P~a cat~}.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Verbatim},reference={verbatim}]

To make a short span of text verbatim, put it inside backticks:

\starttyping
What is the difference between `>>=` and `>>`?
\stoptyping

If the verbatim text includes a backtick, use double backticks:

\starttyping
Here is a literal backtick `` ` ``.
\stoptyping

(The spaces after the opening backticks and before the closing backticks
will be ignored.)

The general rule is that a verbatim span starts with a string of
consecutive backticks (optionally followed by a space) and ends with a
string of the same number of backticks (optionally preceded by a space).

Note that backslash-escapes (and other Markdown constructs) do not work
in verbatim contexts:

\starttyping
This is a backslash followed by an asterisk: `\*`.
\stoptyping

\startsectionlevel[title={Extension:
\type{inline_code_attributes}},reference={extension-inline_code_attributes}]

Attributes can be attached to verbatim text, just as with \goto{fenced
code blocks}[fenced-code-blocks]:

\starttyping
`<$>`{.haskell}
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Underline},reference={underline}]

To underline text, use the \type{underline} class:

\starttyping
[Underline]{.underline}
\stoptyping

Or, without the \type{bracketed_spans} extension (but with
\type{native_spans}):

\starttyping
<span class="underline">Underline</span>
\stoptyping

This will work in all output formats that support underline.

\stopsectionlevel

\startsectionlevel[title={Small caps},reference={small-caps}]

To write small caps, use the \type{smallcaps} class:

\starttyping
[Small caps]{.smallcaps}
\stoptyping

Or, without the \type{bracketed_spans} extension:

\starttyping
<span class="smallcaps">Small caps</span>
\stoptyping

For compatibility with other Markdown flavors, CSS is also supported:

\starttyping
<span style="font-variant:small-caps;">Small caps</span>
\stoptyping

This will work in all output formats that support small caps.

\stopsectionlevel

\startsectionlevel[title={Highlighting},reference={highlighting}]

To highlight text, use the \type{mark} class:

\starttyping
[Mark]{.mark}
\stoptyping

Or, without the \type{bracketed_spans} extension (but with
\type{native_spans}):

\starttyping
<span class="mark">Mark</span>
\stoptyping

This will work in all output formats that support highlighting.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Math},reference={math}]

\startsectionlevel[title={Extension:
\type{tex_math_dollars}},reference={extension-tex_math_dollars}]

Anything between two \type{$} characters will be treated as TeX math.
The opening \type{$} must have a non-space character immediately to its
right, while the closing \type{$} must have a non-space character
immediately to its left, and must not be followed immediately by a
digit. Thus, \type{$20,000 and $30,000} won't parse as math. If for some
reason you need to enclose text in literal \type{$} characters,
backslash-escape them and they won't be treated as math delimiters.

For display math, use \type{$$} delimiters. (In this case, the
delimiters may be separated from the formula by whitespace. However,
there can be no blank lines between the opening and closing \type{$$}
delimiters.)

TeX math will be printed in all output formats. How it is rendered
depends on the output format:

\startdescription{LaTeX}
  It will appear verbatim surrounded by \type{\(...\)} (for inline math)
  or \type{\[...\]} (for display math).
\stopdescription

\startdescription{Markdown, Emacs Org mode, ConTeXt, ZimWiki}
  It will appear verbatim surrounded by \type{$...$} (for inline math)
  or \type{$$...$$} (for display math).
\stopdescription

\startdescription{XWiki}
  It will appear verbatim surrounded by
  \type"{{formula}}..{{/formula}}".
\stopdescription

\startdescription{reStructuredText}
  It will be rendered using an \goto{interpreted text role
  \type{:math:}}[url(https://docutils.sourceforge.io/docs/ref/rst/roles.html\#math)].
\stopdescription

\startdescription{AsciiDoc}
  For AsciiDoc output math will appear verbatim surrounded by
  \type{latexmath:[...]}. For \type{asciidoc_legacy} the bracketed
  material will also include inline or display math delimiters.
\stopdescription

\startdescription{Texinfo}
  It will be rendered inside a \type{@math} command.
\stopdescription

\startdescription{roff man, Jira markup}
  It will be rendered verbatim without \type{$}'s.
\stopdescription

\startdescription{MediaWiki, DokuWiki}
  It will be rendered inside \type{<math>} tags.
\stopdescription

\startdescription{Textile}
  It will be rendered inside \type{<span class="math">} tags.
\stopdescription

\startdescription{RTF, OpenDocument}
  It will be rendered, if possible, using Unicode characters, and will
  otherwise appear verbatim.
\stopdescription

\startdescription{ODT}
  It will be rendered, if possible, using MathML.
\stopdescription

\startdescription{DocBook}
  If the \type{--mathml} flag is used, it will be rendered using MathML
  in an \type{inlineequation} or \type{informalequation} tag. Otherwise
  it will be rendered, if possible, using Unicode characters.
\stopdescription

\startdescription{Docx and PowerPoint}
  It will be rendered using OMML math markup.
\stopdescription

\startdescription{FictionBook2}
  If the \type{--webtex} option is used, formulas are rendered as images
  using CodeCogs or other compatible web service, downloaded and
  embedded in the e-book. Otherwise, they will appear verbatim.
\stopdescription

\startdescription{HTML, Slidy, DZSlides, S5, EPUB}
  The way math is rendered in HTML will depend on the command-line
  options selected. Therefore see \goto{Math rendering in
  HTML}[math-rendering-in-html] above.
\stopdescription

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Raw HTML},reference={raw-html}]

\startsectionlevel[title={Extension:
\type{raw_html}},reference={extension-raw_html}]

Markdown allows you to insert raw HTML (or DocBook) anywhere in a
document (except verbatim contexts, where \type{<}, \type{>}, and
\type{&} are interpreted literally). (Technically this is not an
extension, since standard Markdown allows it, but it has been made an
extension so that it can be disabled if desired.)

The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
output, and suppressed in other formats.

For a more explicit way of including raw HTML in a Markdown document,
see the \goto{\type{raw_attribute} extension}[extension-raw_attribute].

In the CommonMark format, if \type{raw_html} is enabled, superscripts,
subscripts, strikeouts and small capitals will be represented as HTML.
Otherwise, plain-text fallbacks will be used. Note that even if
\type{raw_html} is disabled, tables will be rendered with HTML syntax if
they cannot use pipe syntax.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{markdown_in_html_blocks}},reference={extension-markdown_in_html_blocks}]

Original Markdown allows you to include HTML \quotation{blocks}: blocks
of HTML between balanced tags that are separated from the surrounding
text with blank lines, and start and end at the left margin. Within
these blocks, everything is interpreted as HTML, not Markdown; so (for
example), \type{*} does not signify emphasis.

Pandoc behaves this way when the \type{markdown_strict} format is used;
but by default, pandoc interprets material between HTML block tags as
Markdown. Thus, for example, pandoc will turn

\starttyping
<table>
<tr>
<td>*one*</td>
<td>[a link](https://google.com)</td>
</tr>
</table>
\stoptyping

into

\starttyping
<table>
<tr>
<td><em>one</em></td>
<td><a href="https://google.com">a link</a></td>
</tr>
</table>
\stoptyping

whereas \type{Markdown.pl} will preserve it as is.

There is one exception to this rule: text between \type{<script>},
\type{<style>}, \type{<pre>}, and \type{<textarea>} tags is not
interpreted as Markdown.

This departure from original Markdown should make it easier to mix
Markdown with HTML block elements. For example, one can surround a block
of Markdown text with \type{<div>} tags without preventing it from being
interpreted as Markdown.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{native_divs}},reference={extension-native_divs}]

Use native pandoc \type{Div} blocks for content inside \type{<div>}
tags. For the most part this should give the same output as
\type{markdown_in_html_blocks}, but it makes it easier to write pandoc
filters to manipulate groups of blocks.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{native_spans}},reference={extension-native_spans}]

Use native pandoc \type{Span} blocks for content inside \type{<span>}
tags. For the most part this should give the same output as
\type{raw_html}, but it makes it easier to write pandoc filters to
manipulate groups of inlines.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{raw_tex}},reference={extension-raw_tex}]

In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be
included in a document. Inline TeX commands will be preserved and passed
unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can
use LaTeX to include BibTeX citations:

\starttyping
This result was proved in \cite{jones.1967}.
\stoptyping

Note that in LaTeX environments, like

\starttyping
\begin{tabular}{|l|l|}\hline
Age & Frequency \\ \hline
18--25  & 15 \\
26--35  & 33 \\
36--45  & 22 \\ \hline
\end{tabular}
\stoptyping

the material between the begin and end tags will be interpreted as raw
LaTeX, not as Markdown.

For a more explicit and flexible way of including raw TeX in a Markdown
document, see the \goto{\type{raw_attribute}
extension}[extension-raw_attribute].

Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
Emacs Org mode, and ConTeXt.

\stopsectionlevel

\startsectionlevel[title={Generic raw
attribute},reference={generic-raw-attribute}]

\startsectionlevel[title={Extension:
\type{raw_attribute}},reference={extension-raw_attribute}]

Inline spans and fenced code blocks with a special kind of attribute
will be parsed as raw content with the designated format. For example,
the following produces a raw roff \type{ms} block:

\starttyping
```{=ms}
.MYMACRO
blah blah
```
\stoptyping

And the following produces a raw \type{html} inline element:

\starttyping
This is `<a>html</a>`{=html}
\stoptyping

This can be useful to insert raw xml into \type{docx} documents, e.g. a
pagebreak:

\starttyping
```{=openxml}
<w:p>
  <w:r>
    <w:br w:type="page"/>
  </w:r>
</w:p>
```
\stoptyping

The format name should match the target format name (see \type{-t/--to},
above, for a list, or use \type{pandoc --list-output-formats}). Use
\type{openxml} for \type{docx} output, \type{opendocument} for
\type{odt} output, \type{html5} for \type{epub3} output, \type{html4}
for \type{epub2} output, and \type{latex}, \type{beamer}, \type{ms}, or
\type{html5} for \type{pdf} output (depending on what you use for
\type{--pdf-engine}).

This extension presupposes that the relevant kind of inline code or
fenced code block is enabled. Thus, for example, to use a raw attribute
with a backtick code block, \type{backtick_code_blocks} must be enabled.

The raw attribute cannot be combined with regular attributes.

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={LaTeX macros},reference={latex-macros}]

\startsectionlevel[title={Extension:
\type{latex_macros}},reference={extension-latex_macros}]

When this extension is enabled, pandoc will parse LaTeX macro
definitions and apply the resulting macros to all LaTeX math and raw
LaTeX. So, for example, the following will work in all output formats,
not just LaTeX:

\starttyping
\newcommand{\tuple}[1]{\langle #1 \rangle}

$\tuple{a, b, c}$
\stoptyping

Note that LaTeX macros will not be applied if they occur inside a raw
span or block marked with the \goto{\type{raw_attribute}
extension}[extension-raw_attribute].

When \type{latex_macros} is disabled, the raw LaTeX and math will not
have macros applied. This is usually a better approach when you are
targeting LaTeX or PDF.

Macro definitions in LaTeX will be passed through as raw LaTeX only if
\type{latex_macros} is not enabled. Macro definitions in Markdown source
(or other formats allowing \type{raw_tex}) will be passed through
regardless of whether \type{latex_macros} is enabled.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Links},reference={links-1}]

Markdown allows links to be specified in several ways.

\startsectionlevel[title={Automatic links},reference={automatic-links}]

If you enclose a URL or email address in pointy brackets, it will become
a link:

\starttyping
<https://google.com>
<sam@green.eggs.ham>
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Inline links},reference={inline-links}]

An inline link consists of the link text in square brackets, followed by
the URL in parentheses. (Optionally, the URL can be followed by a link
title, in quotes.)

\starttyping
This is an [inline link](/url), and here's [one with
a title](https://fsf.org "click here for a good time!").
\stoptyping

There can be no space between the bracketed part and the parenthesized
part. The link text can contain formatting (such as emphasis), but the
title cannot.

Email addresses in inline links are not autodetected, so they have to be
prefixed with \type{mailto}:

\starttyping
[Write me!](mailto:sam@green.eggs.ham)
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Reference links},reference={reference-links}]

An {\em explicit} reference link has two parts, the link itself and the
link definition, which may occur elsewhere in the document (either
before or after the link).

The link consists of link text in square brackets, followed by a label
in square brackets. (There cannot be space between the two unless the
\type{spaced_reference_links} extension is enabled.) The link definition
consists of the bracketed label, followed by a colon and a space,
followed by the URL, and optionally (after a space) a link title either
in quotes or in parentheses. The label must not be parseable as a
citation (assuming the \type{citations} extension is enabled): citations
take precedence over link labels.

Here are some examples:

\starttyping
[my label 1]: /foo/bar.html  "My title, optional"
[my label 2]: /foo
[my label 3]: https://fsf.org (The Free Software Foundation)
[my label 4]: /bar#special  'A title in single quotes'
\stoptyping

The URL may optionally be surrounded by angle brackets:

\starttyping
[my label 5]: <http://foo.bar.baz>
\stoptyping

The title may go on the next line:

\starttyping
[my label 3]: https://fsf.org
  "The Free Software Foundation"
\stoptyping

Note that link labels are not case sensitive. So, this will work:

\starttyping
Here is [my link][FOO]

[Foo]: /bar/baz
\stoptyping

In an {\em implicit} reference link, the second pair of brackets is
empty:

\starttyping
See [my website][].

[my website]: http://foo.bar.baz
\stoptyping

Note: In \type{Markdown.pl} and most other Markdown implementations,
reference link definitions cannot occur in nested constructions such as
list items or block quotes. Pandoc lifts this arbitrary-seeming
restriction. So the following is fine in pandoc, though not in most
other implementations:

\starttyping
> My block [quote].
>
> [quote]: /foo
\stoptyping

\startsectionlevel[title={Extension:
\type{shortcut_reference_links}},reference={extension-shortcut_reference_links}]

In a {\em shortcut} reference link, the second pair of brackets may be
omitted entirely:

\starttyping
See [my website].

[my website]: http://foo.bar.baz
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Internal links},reference={internal-links}]

To link to another section of the same document, use the automatically
generated identifier (see \goto{Heading
identifiers}[heading-identifiers]). For example:

\starttyping
See the [Introduction](#introduction).
\stoptyping

or

\starttyping
See the [Introduction].

[Introduction]: #introduction
\stoptyping

Internal links are currently supported for HTML formats (including HTML
slide shows and EPUB), LaTeX, and ConTeXt.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Images},reference={images}]

A link immediately preceded by a \type{!} will be treated as an image.
The link text will be used as the image's alt text:

\starttyping
![la lune](lalune.jpg "Voyage to the moon")

![movie reel]

[movie reel]: movie.gif
\stoptyping

\startsectionlevel[title={Extension:
\type{implicit_figures}},reference={extension-implicit_figures}]

An image with nonempty alt text, occurring by itself in a paragraph,
will be rendered as a figure with a caption. The image's alt text will
be used as the caption.

\starttyping
![This is the caption](/url/of/image.png)
\stoptyping

How this is rendered depends on the output format. Some output formats
(e.g.~RTF) do not yet support figures. In those formats, you'll just get
an image in a paragraph by itself, with no caption.

If you just want a regular inline image, just make sure it is not the
only thing in the paragraph. One way to do this is to insert a
nonbreaking space after the image:

\starttyping
![This image won't be a figure](/url/of/image.png)\
\stoptyping

Note that in reveal.js slide shows, an image in a paragraph by itself
that has the \type{r-stretch} class will fill the screen, and the
caption and figure tags will be omitted.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{link_attributes}},reference={extension-link_attributes}]

Attributes can be set on links and images:

\starttyping
An inline ![image](foo.jpg){#id .class width=30 height=20px}
and a reference ![image][ref] with attributes.

[ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
\stoptyping

(This syntax is compatible with \goto{PHP Markdown
Extra}[url(https://michelf.ca/projects/php-markdown/extra/)] when only
\type{#id} and \type{.class} are used.)

For HTML and EPUB, all known HTML5 attributes except \type{width} and
\type{height} (but including \type{srcset} and \type{sizes}) are passed
through as is. Unknown attributes are passed through as custom
attributes, with \type{data-} prepended. The other writers ignore
attributes that are not specifically supported by their output format.

The \type{width} and \type{height} attributes on images are treated
specially. When used without a unit, the unit is assumed to be pixels.
However, any of the following unit identifiers can be used: \type{px},
\type{cm}, \type{mm}, \type{in}, \type{inch} and \type{%}. There must
not be any spaces between the number and the unit. For example:

\starttyping
![](file.jpg){ width=50% }
\stoptyping

\startitemize[packed]
\item
  Dimensions may be converted to a form that is compatible with the
  output format (for example, dimensions given in pixels will be
  converted to inches when converting HTML to LaTeX). Conversion between
  pixels and physical measurements is affected by the \type{--dpi}
  option (by default, 96 dpi is assumed, unless the image itself
  contains dpi information).
\item
  The \type{%} unit is generally relative to some available space. For
  example the above example will render to the following.
  \startitemize[packed]
  \item
    HTML: \type{<img href="file.jpg" style="width: 50%;" />}
  \item
    LaTeX:
    \type"\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}"
    (If you're using a custom template, you need to configure
    \type{graphicx} as in the default template.)
  \item
    ConTeXt: \type{\externalfigure[file.jpg][width=0.5\textwidth]}
  \stopitemize
\item
  Some output formats have a notion of a class
  (\goto{ConTeXt}[url(https://wiki.contextgarden.net/Using_Graphics\#Multiple_Image_Settings)])
  or a unique identifier (LaTeX \type{\caption}), or both (HTML).
\item
  When no \type{width} or \type{height} attributes are specified, the
  fallback is to look at the image resolution and the dpi metadata
  embedded in the image file.
\stopitemize

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Divs and Spans},reference={divs-and-spans}]

Using the \type{native_divs} and \type{native_spans} extensions (see
\goto{above}[extension-native_divs]), HTML syntax can be used as part of
Markdown to create native \type{Div} and \type{Span} elements in the
pandoc AST (as opposed to raw HTML). However, there is also nicer syntax
available:

\startsectionlevel[title={Extension:
\type{fenced_divs}},reference={extension-fenced_divs}]

Allow special fenced syntax for native \type{Div} blocks. A Div starts
with a fence containing at least three consecutive colons plus some
attributes. The attributes may optionally be followed by another string
of consecutive colons.

Note: the \type{commonmark} parser doesn't permit colons after the
attributes.

The attribute syntax is exactly as in fenced code blocks (see
\goto{Extension:
\type{fenced_code_attributes}}[extension-fenced_code_attributes]). As
with fenced code blocks, one can use either attributes in curly braces
or a single unbraced word, which will be treated as a class name. The
Div ends with another line containing a string of at least three
consecutive colons. The fenced Div should be separated by blank lines
from preceding and following blocks.

Example:

\starttyping
::::: {#special .sidebar}
Here is a paragraph.

And another.
:::::
\stoptyping

Fenced divs can be nested. Opening fences are distinguished because they
{\em must} have attributes:

\starttyping
::: Warning ::::::
This is a warning.

::: Danger
This is a warning within a warning.
:::
::::::::::::::::::
\stoptyping

Fences without attributes are always closing fences. Unlike with fenced
code blocks, the number of colons in the closing fence need not match
the number in the opening fence. However, it can be helpful for visual
clarity to use fences of different lengths to distinguish nested divs
from their parents.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{bracketed_spans}},reference={extension-bracketed_spans}]

A bracketed sequence of inlines, as one would use to begin a link, will
be treated as a \type{Span} with attributes if it is followed
immediately by attributes:

\starttyping
[This is *some text*]{.class key="val"}
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Footnotes},reference={footnotes}]

\startsectionlevel[title={Extension:
\type{footnotes}},reference={extension-footnotes}]

Pandoc's Markdown allows footnotes, using the following syntax:

\starttyping
Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

        { some.code }

    The whole paragraph can be indented, or just the first
    line.  In this way, multi-paragraph footnotes work like
    multi-paragraph list items.

This paragraph won't be part of the note, because it
isn't indented.
\stoptyping

The identifiers in footnote references may not contain spaces, tabs,
newlines, or the characters \type{^}, \type{[}, or \type{]}. These
identifiers are used only to correlate the footnote reference with the
note itself; in the output, footnotes will be numbered sequentially.

The footnotes themselves need not be placed at the end of the document.
They may appear anywhere except inside other block elements (lists,
block quotes, tables, etc.). Each footnote should be separated from
surrounding content (including other footnotes) by blank lines.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{inline_notes}},reference={extension-inline_notes}]

Inline footnotes are also allowed (though, unlike regular notes, they
cannot contain multiple paragraphs). The syntax is as follows:

\starttyping
Here is an inline note.^[Inline notes are easier to write, since
you don't have to pick an identifier and move down to type the
note.]
\stoptyping

Inline and regular footnotes may be mixed freely.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Citation syntax},reference={citation-syntax}]

\startsectionlevel[title={Extension:
\type{citations}},reference={extension-citations}]

To cite a bibliographic item with an identifier foo, use the syntax
\type{@foo}. Normal citations should be included in square brackets,
with semicolons separating distinct items:

\starttyping
Blah blah [@doe99; @smith2000; @smith2004].
\stoptyping

How this is rendered depends on the citation style. In an author-date
style, it might render as

\starttyping
Blah blah (Doe 1999, Smith 2000, 2004).
\stoptyping

In a footnote style, it might render as

\starttyping
Blah blah.[^1]

[^1]:  John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
Susan Smith, "Flies," *Journal of Insects* (2000);
Susan Smith, "Bees," *Journal of Insects* (2004).
\stoptyping

See the \goto{CSL user
documentation}[url(https://citationstyles.org/authors/)] for more
information about CSL styles and how they affect rendering.

Unless a citation key starts with a letter, digit, or \type{_}, and
contains only alphanumerics and single internal punctuation characters
(\type{:.#$%&-+?<>~/}), it must be surrounded by curly braces, which are
not considered part of the key. In \type{@Foo_bar.baz.}, the key is
\type{Foo_bar.baz} because the final period is not {\em internal}
punctuation, so it is not included in the key. In
\type"@{Foo_bar.baz.}", the key is \type{Foo_bar.baz.}, including the
final period. In \type{@Foo_bar--baz}, the key is \type{Foo_bar} because
the repeated internal punctuation characters terminate the key. The
curly braces are recommended if you use URLs as keys:
\type"[@{https://example.com/bib?name=foobar&date=2000}, p.  33]".

Citation items may optionally include a prefix, a locator, and a suffix.
In

\starttyping
Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
\stoptyping

the first item (\type{doe99}) has prefix \type{see}, locator
\type{pp.  33-35}, and suffix \type{and *passim*}. The second item
(\type{smith04}) has locator \type{chap. 1} and no prefix or suffix.

Pandoc uses some heuristics to separate the locator from the rest of the
subject. It is sensitive to the locator terms defined in the \goto{CSL
locale files}[url(https://github.com/citation-style-language/locales)].
Either abbreviated or unabbreviated forms are accepted. In the
\type{en-US} locale, locator terms can be written in either singular or
plural forms, as \type{book}, \type{bk.}/\type{bks.}; \type{chapter},
\type{chap.}/\type{chaps.}; \type{column}, \type{col.}/\type{cols.};
\type{figure}, \type{fig.}/\type{figs.}; \type{folio},
\type{fol.}/\type{fols.}; \type{number}, \type{no.}/\type{nos.};
\type{line}, \type{l.}/\type{ll.}; \type{note}, \type{n.}/\type{nn.};
\type{opus}, \type{op.}/\type{opp.}; \type{page}, \type{p.}/\type{pp.};
\type{paragraph}, \type{para.}/\type{paras.}; \type{part},
\type{pt.}/\type{pts.}; \type{section}, \type{sec.}/\type{secs.};
\type{sub verbo}, \type{s.v.}/\type{s.vv.}; \type{verse},
\type{v.}/\type{vv.}; \type{volume}, \type{vol.}/\type{vols.};
\type{¶}/\type{¶¶}; \type{§}/\type{§§}. If no locator term is used,
\quotation{page} is assumed.

In complex cases, you can force something to be treated as a locator by
enclosing it in curly braces or prevent parsing the suffix as locator by
prepending curly braces:

\starttyping
[@smith{ii, A, D-Z}, with a suffix]
[@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
[@smith{}, 99 years later]
\stoptyping

A minus sign (\type{-}) before the \type{@} will suppress mention of the
author in the citation. This can be useful when the author is already
mentioned in the text:

\starttyping
Smith says blah [-@smith04].
\stoptyping

You can also write an author-in-text citation, by omitting the square
brackets:

\starttyping
@smith04 says blah.

@smith04 [p. 33] says blah.
\stoptyping

This will cause the author's name to be rendered, followed by the
bibliographical details. Use this form when you want to make the
citation the subject of a sentence.

When you are using a note style, it is usually better to let citeproc
create the footnotes from citations rather than writing an explicit
note. If you do write an explicit note that contains a citation, note
that normal citations will be put in parentheses, while author-in-text
citations will not. For this reason, it is sometimes preferable to use
the author-in-text style inside notes when using a note style.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Non-default
extensions},reference={non-default-extensions}]

The following Markdown syntax extensions are not enabled by default in
pandoc, but may be enabled by adding \type{+EXTENSION} to the format
name, where \type{EXTENSION} is the name of the extension. Thus, for
example, \type{markdown+hard_line_breaks} is Markdown with hard line
breaks.

\startsectionlevel[title={Extension:
\type{rebase_relative_paths}},reference={extension-rebase_relative_paths}]

Rewrite relative paths for Markdown links and images, depending on the
path of the file containing the link or image link. For each link or
image, pandoc will compute the directory of the containing file,
relative to the working directory, and prepend the resulting path to the
link or image path.

The use of this extension is best understood by example. Suppose you
have a subdirectory for each chapter of a book, \type{chap1},
\type{chap2}, \type{chap3}. Each contains a file \type{text.md} and a
number of images used in the chapter. You would like to have
\type{![image](spider.jpg)} in \type{chap1/text.md} refer to
\type{chap1/spider.jpg} and \type{![image](spider.jpg)} in
\type{chap2/text.md} refer to \type{chap2/spider.jpg}. To do this, use

\starttyping
pandoc chap*/*.md -f markdown+rebase_relative_paths
\stoptyping

Without this extension, you would have to use
\type{![image](chap1/spider.jpg)} in \type{chap1/text.md} and
\type{![image](chap2/spider.jpg)} in \type{chap2/text.md}. Links with
relative paths will be rewritten in the same way as images.

Absolute paths and URLs are not changed. Neither are empty paths or
paths consisting entirely of a fragment, e.g., \type{#foo}.

Note that relative paths in reference links and images will be rewritten
relative to the file containing the link reference definition, not the
file containing the reference link or image itself, if these differ.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{mark}},reference={extension-mark}]

To highlight out a section of text, begin and end it with with
\type{==}. Thus, for example,

\starttyping
This ==is deleted text.==
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{attributes}},reference={extension-attributes}]

Allows attributes to be attached to any inline or block-level element
when parsing \type{commonmark}. The syntax for the attributes is the
same as that used in
\goto{\type{header_attributes}}[extension-header_attributes].

\startitemize[packed]
\item
  Attributes that occur immediately after an inline element affect that
  element. If they follow a space, then they belong to the space.
  (Hence, this option subsumes \type{inline_code_attributes} and
  \type{link_attributes}.)
\item
  Attributes that occur immediately before a block element, on a line by
  themselves, affect that element.
\item
  Consecutive attribute specifiers may be used, either for blocks or for
  inlines. Their attributes will be combined.
\item
  Attributes that occur at the end of the text of a Setext or ATX
  heading (separated by whitespace from the text) affect the heading
  element. (Hence, this option subsumes \type{header_attributes}.)
\item
  Attributes that occur after the opening fence in a fenced code block
  affect the code block element. (Hence, this option subsumes
  \type{fenced_code_attributes}.)
\item
  Attributes that occur at the end of a reference link definition affect
  links that refer to that definition.
\stopitemize

Note that pandoc's AST does not currently allow attributes to be
attached to arbitrary elements. Hence a Span or Div container will be
added if needed.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{old_dashes}},reference={extension-old_dashes}]

Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
\type{-} before a numeral is an en-dash, and \type{--} is an em-dash.
This option only has an effect if \type{smart} is enabled. It is
selected automatically for \type{textile} input.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{angle_brackets_escapable}},reference={extension-angle_brackets_escapable}]

Allow \type{<} and \type{>} to be backslash-escaped, as they can be in
GitHub flavored Markdown but not original Markdown. This is implied by
pandoc's default \type{all_symbols_escapable}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{lists_without_preceding_blankline}},reference={extension-lists_without_preceding_blankline}]

Allow a list to occur right after a paragraph, with no intervening blank
space.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{four_space_rule}},reference={extension-four_space_rule}]

Selects the pandoc <= 2.0 behavior for parsing lists, so that four
spaces indent are needed for list item continuation paragraphs.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{spaced_reference_links}},reference={extension-spaced_reference_links}]

Allow whitespace between the two components of a reference link, for
example,

\starttyping
[foo] [bar].
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{hard_line_breaks}},reference={extension-hard_line_breaks}]

Causes all newlines within a paragraph to be interpreted as hard line
breaks instead of spaces.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{ignore_line_breaks}},reference={extension-ignore_line_breaks}]

Causes newlines within a paragraph to be ignored, rather than being
treated as spaces or as hard line breaks. This option is intended for
use with East Asian languages where spaces are not used between words,
but text is divided into lines for readability.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{east_asian_line_breaks}},reference={extension-east_asian_line_breaks}]

Causes newlines within a paragraph to be ignored, rather than being
treated as spaces or as hard line breaks, when they occur between two
East Asian wide characters. This is a better choice than
\type{ignore_line_breaks} for texts that include a mix of East Asian
wide characters and other characters.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{emoji}},reference={extension-emoji}]

Parses textual emojis like \type{:smile:} as Unicode emoticons.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{tex_math_gfm}},reference={extension-tex_math_gfm}]

Supports two GitHub-specific formats for math. Inline math:
\type{$`e=mc^2`$}.

Display math:

\starttyping
``` math
e=mc^2
```
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{tex_math_single_backslash}},reference={extension-tex_math_single_backslash}]

Causes anything between \type{\(} and \type{\)} to be interpreted as
inline TeX math, and anything between \type{\[} and \type{\]} to be
interpreted as display TeX math. Note: a drawback of this extension is
that it precludes escaping \type{(} and \type{[}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{tex_math_double_backslash}},reference={extension-tex_math_double_backslash}]

Causes anything between \type{\\(} and \type{\\)} to be interpreted as
inline TeX math, and anything between \type{\\[} and \type{\\]} to be
interpreted as display TeX math.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{markdown_attribute}},reference={extension-markdown_attribute}]

By default, pandoc interprets material inside block-level tags as
Markdown. This extension changes the behavior so that Markdown is only
parsed inside block-level tags if the tags have the attribute
\type{markdown=1}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{mmd_title_block}},reference={extension-mmd_title_block}]

Enables a
\goto{MultiMarkdown}[url(https://fletcherpenney.net/multimarkdown/)]
style title block at the top of the document, for example:

\starttyping
Title:   My title
Author:  John Doe
Date:    September 1, 2008
Comment: This is a sample mmd title block, with
         a field spanning multiple lines.
\stoptyping

See the MultiMarkdown documentation for details. If
\type{pandoc_title_block} or \type{yaml_metadata_block} is enabled, it
will take precedence over \type{mmd_title_block}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{abbreviations}},reference={extension-abbreviations}]

Parses PHP Markdown Extra abbreviation keys, like

\starttyping
*[HTML]: Hypertext Markup Language
\stoptyping

Note that the pandoc document model does not support abbreviations, so
if this extension is enabled, abbreviation keys are simply skipped (as
opposed to being parsed as paragraphs).

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{alerts}},reference={extension-alerts}]

Supports \goto{GitHub-style Markdown
alerts}[url(https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax\#alerts)],
like

\starttyping
> [!INFO]
> This is an informational message.
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{autolink_bare_uris}},reference={extension-autolink_bare_uris}]

Makes all absolute URIs into links, even when not surrounded by pointy
braces \type{<...>}.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{mmd_link_attributes}},reference={extension-mmd_link_attributes}]

Parses MultiMarkdown-style key-value attributes on link and image
references. This extension should not be confused with the
\goto{\type{link_attributes}}[extension-link_attributes] extension.

\starttyping
This is a reference ![image][ref] with MultiMarkdown attributes.

[ref]: https://path.to/image "Image title" width=20px height=30px
       id=myId class="myClass1 myClass2"
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{mmd_header_identifiers}},reference={extension-mmd_header_identifiers}]

Parses MultiMarkdown-style heading identifiers (in square brackets,
after the heading but before any trailing \type{#}s in an ATX heading).

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{compact_definition_lists}},reference={extension-compact_definition_lists}]

Activates the definition list syntax of pandoc 1.12.x and earlier. This
syntax differs from the one described above under \goto{Definition
lists}[definition-lists] in several respects:

\startitemize[packed]
\item
  No blank line is required between consecutive items of the definition
  list.
\item
  To get a \quotation{tight} or \quotation{compact} list, omit space
  between consecutive items; the space between a term and its definition
  does not affect anything.
\item
  Lazy wrapping of paragraphs is not allowed: the entire definition must
  be indented four spaces.\startbuffer To see why laziness is
    incompatible with relaxing the requirement of a blank line between
    items, consider the following example:

\starttyping
bar
:    definition
foo
:    definition
\stoptyping

    Is this a single list item with two definitions of \quotation{bar,}
    the first of which is lazily wrapped, or two list items? To remove
    the ambiguity we must either disallow lazy wrapping or require a
    blank line between list items.\stopbuffer\footnote{\getbuffer}
\stopitemize

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{gutenberg}},reference={extension-gutenberg}]

Use \goto{Project Gutenberg}[url(https://www.gutenberg.org)] conventions
for \type{plain} output: all-caps for strong emphasis, surround by
underscores for regular emphasis, add extra blank space around headings.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{sourcepos}},reference={extension-sourcepos}]

Include source position attributes when parsing \type{commonmark}. For
elements that accept attributes, a \type{data-pos} attribute is added;
other elements are placed in a surrounding Div or Span element with a
\type{data-pos} attribute.

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{short_subsuperscripts}},reference={extension-short_subsuperscripts}]

Parse MultiMarkdown-style subscripts and superscripts, which start with
a \quote{\lettertilde{}} or \quote{^} character, respectively, and
include the alphanumeric sequence that follows. For example:

\starttyping
x^2 = 4
\stoptyping

or

\starttyping
Oxygen is O~2.
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Extension:
\type{wikilinks_title_after_pipe}},reference={extension-wikilinks_title_after_pipe}]

Pandoc supports multiple Markdown wikilink syntaxes, regardless of
whether the title is before or after the pipe.

Using \type{--from=markdown+wikilinks_title_after_pipe} results in

\starttyping
[[URL|title]]
\stoptyping

while using \type{--from=markdown+wikilinks_title_before_pipe} results
in

\starttyping
[[title|URL]]
\stoptyping

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Markdown
variants},reference={markdown-variants}]

In addition to pandoc's extended Markdown, the following Markdown
variants are supported:

\startitemize[packed]
\item
  \type{markdown_phpextra} (PHP Markdown Extra)
\item
  \type{markdown_github} (deprecated GitHub-Flavored Markdown)
\item
  \type{markdown_mmd} (MultiMarkdown)
\item
  \type{markdown_strict} (Markdown.pl)
\item
  \type{commonmark} (CommonMark)
\item
  \type{gfm} (Github-Flavored Markdown)
\item
  \type{commonmark_x} (CommonMark with many pandoc extensions)
\stopitemize

To see which extensions are supported for a given format, and which are
enabled by default, you can use the command

\starttyping
pandoc --list-extensions=FORMAT
\stoptyping

where \type{FORMAT} is replaced with the name of the format.

Note that the list of extensions for \type{commonmark}, \type{gfm}, and
\type{commonmark_x} are defined relative to default commonmark. So, for
example, \type{backtick_code_blocks} does not appear as an extension,
since it is enabled by default and cannot be disabled.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Citations},reference={citations}]

When the \type{--citeproc} option is used, pandoc can automatically
generate citations and a bibliography in a number of styles. Basic usage
is

\starttyping
pandoc --citeproc myinput.txt
\stoptyping

To use this feature, you will need to have

\startitemize[packed]
\item
  a document containing citations (see \goto{Citation
  syntax}[citation-syntax]);
\item
  a source of bibliographic data: either an external bibliography file
  or a list of \type{references} in the document's YAML metadata;
\item
  optionally, a
  \goto{CSL}[url(https://docs.citationstyles.org/en/stable/specification.html)]
  citation style.
\stopitemize

\startsectionlevel[title={Specifying bibliographic
data},reference={specifying-bibliographic-data}]

You can specify an external bibliography using the \type{bibliography}
metadata field in a YAML metadata section or the \type{--bibliography}
command line argument. If you want to use multiple bibliography files,
you can supply multiple \type{--bibliography} arguments or set
\type{bibliography} metadata field to YAML array. A bibliography may
have any of these formats:

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right] Format \stopxcell
\startxcell File extension \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell[align=right] BibLaTeX \stopxcell
\startxcell .bib \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] BibTeX \stopxcell
\startxcell .bibtex \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] CSL JSON \stopxcell
\startxcell .json \stopxcell
\stopxrow
\startxrow
\startxcell[align=right] CSL YAML \stopxcell
\startxcell .yaml \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell[align=right] RIS \stopxcell
\startxcell .ris \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

Note that \type{.bib} can be used with both BibTeX and BibLaTeX files;
use the extension \type{.bibtex} to force interpretation as BibTeX.

In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup inside
fields such as \type{title}; in CSL YAML databases, pandoc Markdown; and
in CSL JSON databases, an \goto{HTML-like
markup}[url(https://docs.citationstyles.org/en/1.0/release-notes.html\#rich-text-markup-within-fields)]:

\startdescription{\type{<i>...</i>}}
  italics
\stopdescription

\startdescription{\type{<b>...</b>}}
  bold
\stopdescription

\startdescription{\type{<span style="font-variant:small-caps;">...</span>}
or \type{<sc>...</sc>}}
  small capitals
\stopdescription

\startdescription{\type{<sub>...</sub>}}
  subscript
\stopdescription

\startdescription{\type{<sup>...</sup>}}
  superscript
\stopdescription

\startdescription{\type{<span class="nocase">...</span>}}
  prevent a phrase from being capitalized as title case
\stopdescription

As an alternative to specifying a bibliography file using
\type{--bibliography} or the YAML metadata field \type{bibliography},
you can include the citation data directly in the \type{references}
field of the document's YAML metadata. The field should contain an array
of YAML-encoded references, for example:

\starttyping
---
references:
- type: article-journal
  id: WatsonCrick1953
  author:
  - family: Watson
    given: J. D.
  - family: Crick
    given: F. H. C.
  issued:
    date-parts:
    - - 1953
      - 4
      - 25
  title: 'Molecular structure of nucleic acids: a structure for
    deoxyribose nucleic acid'
  title-short: Molecular structure of nucleic acids
  container-title: Nature
  volume: 171
  issue: 4356
  page: 737-738
  DOI: 10.1038/171737a0
  URL: https://www.nature.com/articles/171737a0
  language: en-GB
...
\stoptyping

If both an external bibliography and inline (YAML metadata) references
are provided, both will be used. In case of conflicting \type{id}s, the
inline references will take precedence.

Note that pandoc can be used to produce such a YAML metadata section
from a BibTeX, BibLaTeX, or CSL JSON bibliography:

\starttyping
pandoc chem.bib -s -f biblatex -t markdown
pandoc chem.json -s -f csljson -t markdown
\stoptyping

Indeed, pandoc can convert between any of these citation formats:

\starttyping
pandoc chem.bib -s -f biblatex -t csljson
pandoc chem.yaml -s -f markdown -t biblatex
\stoptyping

Running pandoc on a bibliography file with the \type{--citeproc} option
will create a formatted bibliography in the format of your choice:

\starttyping
pandoc chem.bib -s --citeproc -o chem.html
pandoc chem.bib -s --citeproc -o chem.pdf
\stoptyping

\startsectionlevel[title={Capitalization in
titles},reference={capitalization-in-titles}]

If you are using a bibtex or biblatex bibliography, then observe the
following rules:

\startitemize
\item
  English titles should be in title case. Non-English titles should be
  in sentence case, and the \type{langid} field in biblatex should be
  set to the relevant language. (The following values are treated as
  English: \type{american}, \type{british}, \type{canadian},
  \type{english}, \type{australian}, \type{newzealand},
  \type{USenglish}, or \type{UKenglish}.)
\item
  As is standard with bibtex/biblatex, proper names should be protected
  with curly braces so that they won't be lowercased in styles that call
  for sentence case. For example:

\starttyping
title = {My Dinner with {Andre}}
\stoptyping
\item
  In addition, words that should remain lowercase (or camelCase) should
  be protected:

\starttyping
title = {Spin Wave Dispersion on the {nm} Scale}
\stoptyping

  Though this is not necessary in bibtex/biblatex, it is necessary with
  citeproc, which stores titles internally in sentence case, and
  converts to title case in styles that require it. Here we protect
  \quotation{nm} so that it doesn't get converted to \quotation{Nm} at
  this stage.
\stopitemize

If you are using a CSL bibliography (either JSON or YAML), then observe
the following rules:

\startitemize
\item
  All titles should be in sentence case.
\item
  Use the \type{language} field for non-English titles to prevent their
  conversion to title case in styles that call for this. (Conversion
  happens only if \type{language} begins with \type{en} or is left
  empty.)
\item
  Protect words that should not be converted to title case using this
  syntax:

\starttyping
Spin wave dispersion on the <span class="nocase">nm</span> scale
\stoptyping
\stopitemize

\stopsectionlevel

\startsectionlevel[title={Conference Papers, Published
vs.~Unpublished},reference={conference-papers-published-vs.-unpublished}]

For a formally published conference paper, use the biblatex entry type
\type{inproceedings} (which will be mapped to CSL
\type{paper-conference}).

For an unpublished manuscript, use the biblatex entry type
\type{unpublished} without an \type{eventtitle} field (this entry type
will be mapped to CSL \type{manuscript}).

For a talk, an unpublished conference paper, or a poster presentation,
use the biblatex entry type \type{unpublished} with an \type{eventtitle}
field (this entry type will be mapped to CSL \type{speech}). Use the
biblatex \type{type} field to indicate the type, e.g.~\quotation{Paper},
or \quotation{Poster}. \type{venue} and \type{eventdate} may be useful
too, though \type{eventdate} will not be rendered by most CSL styles.
Note that \type{venue} is for the event's venue, unlike \type{location}
which describes the publisher's location; do not use the latter for an
unpublished conference paper.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Specifying a citation
style},reference={specifying-a-citation-style}]

Citations and references can be formatted using any style supported by
the \goto{Citation Style Language}[url(https://citationstyles.org)],
listed in the \goto{Zotero Style
Repository}[url(https://www.zotero.org/styles)]. These files are
specified using the \type{--csl} option or the \type{csl} (or
\type{citation-style}) metadata field. By default, pandoc will use the
\goto{Chicago Manual of Style}[url(https://chicagomanualofstyle.org)]
author-date format. (You can override this default by copying a CSL
style of your choice to \type{default.csl} in your user data directory.)
The CSL project provides further information on \goto{finding and
editing styles}[url(https://citationstyles.org/authors/)].

The \type{--citation-abbreviations} option (or the
\type{citation-abbreviations} metadata field) may be used to specify a
JSON file containing abbreviations of journals that should be used in
formatted bibliographies when \type{form="short"} is specified. The
format of the file can be illustrated with an example:

\starttyping
{ "default": {
    "container-title": {
            "Lloyd's Law Reports": "Lloyd's Rep",
            "Estates Gazette": "EG",
            "Scots Law Times": "SLT"
    }
  }
}
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Citations in note
styles},reference={citations-in-note-styles}]

Pandoc's citation processing is designed to allow you to move between
author-date, numerical, and note styles without modifying the Markdown
source. When you're using a note style, avoid inserting footnotes
manually. Instead, insert citations just as you would in an author-date
style---for example,

\starttyping
Blah blah [@foo, p. 33].
\stoptyping

The footnote will be created automatically. Pandoc will take care of
removing the space and moving the note before or after the period,
depending on the setting of \type{notes-after-punctuation}, as described
below in \goto{Other relevant metadata
fields}[other-relevant-metadata-fields].

In some cases you may need to put a citation inside a regular footnote.
Normal citations in footnotes (such as \type{[@foo, p. 33]}) will be
rendered in parentheses. In-text citations (such as \type{@foo [p. 33]})
will be rendered without parentheses. (A comma will be added if
appropriate.) Thus:

\starttyping
[^1]:  Some studies [@foo; @bar, p. 33] show that
frubulicious zoosnaps are quantical.  For a survey
of the literature, see @baz [chap. 1].
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Placement of the
bibliography},reference={placement-of-the-bibliography}]

If the style calls for a list of works cited, it will be placed in a div
with id \type{refs}, if one exists:

\starttyping
::: {#refs}
:::
\stoptyping

Otherwise, it will be placed at the end of the document. Generation of
the bibliography can be suppressed by setting
\type{suppress-bibliography: true} in the YAML metadata.

If you wish the bibliography to have a section heading, you can set
\type{reference-section-title} in the metadata, or put the heading at
the beginning of the div with id \type{refs} (if you are using it) or at
the end of your document:

\starttyping
last paragraph...

# References
\stoptyping

The bibliography will be inserted after this heading. Note that the
\type{unnumbered} class will be added to this heading, so that the
section will not be numbered.

If you want to put the bibliography into a variable in your template,
one way to do that is to put the div with id \type{refs} into a metadata
field, e.g.

\starttyping
---
refs: |
   ::: {#refs}
   :::
...
\stoptyping

You can then put the variable \type{$refs$} into your template where you
want the bibliography to be placed.

\stopsectionlevel

\startsectionlevel[title={Including uncited items in the
bibliography},reference={including-uncited-items-in-the-bibliography}]

If you want to include items in the bibliography without actually citing
them in the body text, you can define a dummy \type{nocite} metadata
field and put the citations there:

\starttyping
---
nocite: |
  @item1, @item2
...

@item3
\stoptyping

In this example, the document will contain a citation for \type{item3}
only, but the bibliography will contain entries for \type{item1},
\type{item2}, and \type{item3}.

It is possible to create a bibliography with all the citations, whether
or not they appear in the document, by using a wildcard:

\starttyping
---
nocite: |
  @*
...
\stoptyping

For LaTeX output, you can also use
\goto{\type{natbib}}[url(https://ctan.org/pkg/natbib)] or
\goto{\type{biblatex}}[url(https://ctan.org/pkg/biblatex)] to render the
bibliography. In order to do so, specify bibliography files as outlined
above, and add \type{--natbib} or \type{--biblatex} argument to pandoc
invocation. Bear in mind that bibliography files have to be in either
BibTeX (for \type{--natbib}) or BibLaTeX (for \type{--biblatex}) format.

\stopsectionlevel

\startsectionlevel[title={Other relevant metadata
fields},reference={other-relevant-metadata-fields}]

A few other metadata fields affect bibliography formatting:

\startdescription{\type{link-citations}}
  If true, citations will be hyperlinked to the corresponding
  bibliography entries (for author-date and numerical styles only).
  Defaults to false.
\stopdescription

\startdescription{\type{link-bibliography}}
  If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be
  rendered as hyperlinks. (If an entry contains a DOI, PMCID, PMID, or
  URL, but none of these fields are rendered by the style, then the
  title, or in the absence of a title the whole entry, will be
  hyperlinked.) Defaults to true.
\stopdescription

\startdescription{\type{lang}}
  The \type{lang} field will affect how the style is localized, for
  example in the translation of labels, the use of quotation marks, and
  the way items are sorted. (For backwards compatibility, \type{locale}
  may be used instead of \type{lang}, but this use is deprecated.)

  A BCP 47 language tag is expected: for example, \type{en}, \type{de},
  \type{en-US}, \type{fr-CA}, \type{ug-Cyrl}. The unicode extension
  syntax (after \type{-u-}) may be used to specify options for collation
  (sorting) more precisely. Here are some examples:

  \startitemize[packed]
  \item
    \type{zh-u-co-pinyin} -- Chinese with the Pinyin collation.
  \item
    \type{es-u-co-trad} -- Spanish with the traditional collation (with
    \type{Ch} sorting after \type{C}).
  \item
    \type{fr-u-kb} -- French with \quotation{backwards} accent sorting
    (with \type{coté} sorting after \type{côte}).
  \item
    \type{en-US-u-kf-upper} -- English with uppercase letters sorting
    before lower (default is lower before upper).
  \stopitemize
\stopdescription

\startdescription{\type{notes-after-punctuation}}
  If true (the default for note styles), pandoc will put footnote
  references or superscripted numerical citations after following
  punctuation. For example, if the source contains
  \type{blah blah [@jones99].}, the result will look like
  \type{blah blah.[^1]}, with the note moved after the period and the
  space collapsed. If false, the space will still be collapsed, but the
  footnote will not be moved after the punctuation. The option may also
  be used in numerical styles that use superscripts for citation numbers
  (but for these styles the default is not to move the citation).
\stopdescription

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Slide shows},reference={slide-shows}]

You can use pandoc to produce an HTML + JavaScript slide presentation
that can be viewed via a web browser. There are five ways to do this,
using \goto{S5}[url(https://meyerweb.com/eric/tools/s5/)],
\goto{DZSlides}[url(https://paulrouget.com/dzslides/)],
\goto{Slidy}[url(https://www.w3.org/Talks/Tools/Slidy2/)],
\goto{Slideous}[url(https://goessner.net/articles/slideous/)], or
\goto{reveal.js}[url(https://revealjs.com/)]. You can also produce a PDF
slide show using LaTeX
\goto{\type{beamer}}[url(https://ctan.org/pkg/beamer)], or slide shows
in Microsoft
\goto{PowerPoint}[url(https://en.wikipedia.org/wiki/Microsoft_PowerPoint)]
format.

Here's the Markdown source for a simple slide show, \type{habits.txt}:

\starttyping
% Habits
% John Doe
% March 22, 2005

# In the morning

## Getting up

- Turn off alarm
- Get out of bed

## Breakfast

- Eat eggs
- Drink coffee

# In the evening

## Dinner

- Eat spaghetti
- Drink wine

------------------

![picture of spaghetti](images/spaghetti.jpg)

## Going to sleep

- Get in bed
- Count sheep
\stoptyping

To produce an HTML/JavaScript slide show, simply type

\starttyping
pandoc -t FORMAT -s habits.txt -o habits.html
\stoptyping

where \type{FORMAT} is either \type{s5}, \type{slidy}, \type{slideous},
\type{dzslides}, or \type{revealjs}.

For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with
the \type{-s/--standalone} option embeds a link to JavaScript and CSS
files, which are assumed to be available at the relative path
\type{s5/default} (for S5), \type{slideous} (for Slideous),
\type{reveal.js} (for reveal.js), or at the Slidy website at
\type{w3.org} (for Slidy). (These paths can be changed by setting the
\type{slidy-url}, \type{slideous-url}, \type{revealjs-url}, or
\type{s5-url} variables; see \goto{Variables for HTML
slides}[variables-for-html-slides], above.) For DZSlides, the
(relatively short) JavaScript and CSS are included in the file by
default.

With all HTML slide formats, the \type{--self-contained} option can be
used to produce a single file that contains all of the data necessary to
display the slide show, including linked scripts, stylesheets, images,
and videos.

To produce a PDF slide show using beamer, type

\starttyping
pandoc -t beamer habits.txt -o habits.pdf
\stoptyping

Note that a reveal.js slide show can also be converted to a PDF by
printing it to a file from the browser.

To produce a PowerPoint slide show, type

\starttyping
pandoc habits.txt -o habits.pptx
\stoptyping

\startsectionlevel[title={Structuring the slide
show},reference={structuring-the-slide-show}]

By default, the {\em slide level} is the highest heading level in the
hierarchy that is followed immediately by content, and not another
heading, somewhere in the document. In the example above, level-1
headings are always followed by level-2 headings, which are followed by
content, so the slide level is 2. This default can be overridden using
the \type{--slide-level} option.

The document is carved up into slides according to the following rules:

\startitemize
\item
  A horizontal rule always starts a new slide.
\item
  A heading at the slide level always starts a new slide.
\item
  Headings {\em below} the slide level in the hierarchy create headings
  {\em within} a slide. (In beamer, a \quotation{block} will be created.
  If the heading has the class \type{example}, an \type{exampleblock}
  environment will be used; if it has the class \type{alert}, an
  \type{alertblock} will be used; otherwise a regular \type{block} will
  be used.)
\item
  Headings {\em above} the slide level in the hierarchy create
  \quotation{title slides,} which just contain the section title and
  help to break the slide show into sections. Non-slide content under
  these headings will be included on the title slide (for HTML slide
  shows) or in a subsequent slide with the same title (for beamer).
\item
  A title page is constructed automatically from the document's title
  block, if present. (In the case of beamer, this can be disabled by
  commenting out some lines in the default template.)
\stopitemize

These rules are designed to support many different styles of slide show.
If you don't care about structuring your slides into sections and
subsections, you can either just use level-1 headings for all slides (in
that case, level 1 will be the slide level) or you can set
\type{--slide-level=0}.

Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
layout will be produced, with level-1 headings building horizontally and
level-2 headings building vertically. It is not recommended that you use
deeper nesting of section levels with reveal.js unless you set
\type{--slide-level=0} (which lets reveal.js produce a one-dimensional
layout and only interprets horizontal rules as slide boundaries).

\startsectionlevel[title={PowerPoint layout
choice},reference={powerpoint-layout-choice}]

When creating slides, the pptx writer chooses from a number of
pre-defined layouts, based on the content of the slide:

\startdescription{Title Slide}
  This layout is used for the initial slide, which is generated and
  filled from the metadata fields \type{date}, \type{author}, and
  \type{title}, if they are present.
\stopdescription

\startdescription{Section Header}
  This layout is used for what pandoc calls \quotation{title slides},
  i.e. slides which start with a header which is above the slide level
  in the hierarchy.
\stopdescription

\startdescription{Two Content}
  This layout is used for two-column slides, i.e.~slides containing a
  div with class \type{columns} which contains at least two divs with
  class \type{column}.
\stopdescription

\startdescription{Comparison}
  This layout is used instead of \quotation{Two Content} for any
  two-column slides in which at least one column contains text followed
  by non-text (e.g.~an image or a table).
\stopdescription

\startdescription{Content with Caption}
  This layout is used for any non-two-column slides which contain text
  followed by non-text (e.g.~an image or a table).
\stopdescription

\startdescription{Blank}
  This layout is used for any slides which only contain blank content,
  e.g.~a slide containing only speaker notes, or a slide containing only
  a non-breaking space.
\stopdescription

\startdescription{Title and Content}
  This layout is used for all slides which do not match the criteria for
  another layout.
\stopdescription

These layouts are chosen from the default pptx reference doc included
with pandoc, unless an alternative reference doc is specified using
\type{--reference-doc}.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Incremental
lists},reference={incremental-lists}]

By default, these writers produce lists that display \quotation{all at
once.} If you want your lists to display incrementally (one item at a
time), use the \type{-i} option. If you want a particular list to depart
from the default, put it in a \type{div} block with class
\type{incremental} or \type{nonincremental}. So, for example, using the
\type{fenced div} syntax, the following would be incremental regardless
of the document default:

\starttyping
::: incremental

- Eat spaghetti
- Drink wine

:::
\stoptyping

or

\starttyping
::: nonincremental

- Eat spaghetti
- Drink wine

:::
\stoptyping

While using \type{incremental} and \type{nonincremental} divs is the
recommended method of setting incremental lists on a per-case basis, an
older method is also supported: putting lists inside a blockquote will
depart from the document default (that is, it will display incrementally
without the \type{-i} option and all at once with the \type{-i} option):

\starttyping
> - Eat spaghetti
> - Drink wine
\stoptyping

Both methods allow incremental and nonincremental lists to be mixed in a
single document.

If you want to include a block-quoted list, you can work around this
behavior by putting the list inside a fenced div, so that it is not the
direct child of the block quote:

\starttyping
> ::: wrapper
> - a
> - list in a quote
> :::
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Inserting
pauses},reference={inserting-pauses}]

You can add \quotation{pauses} within a slide by including a paragraph
containing three dots, separated by spaces:

\starttyping
# Slide with a pause

content before the pause

. . .

content after the pause
\stoptyping

Note: this feature is not yet implemented for PowerPoint output.

\stopsectionlevel

\startsectionlevel[title={Styling the
slides},reference={styling-the-slides}]

You can change the style of HTML slides by putting customized CSS files
in \type{$DATADIR/s5/default} (for S5), \type{$DATADIR/slidy} (for
Slidy), or \type{$DATADIR/slideous} (for Slideous), where
\type{$DATADIR} is the user data directory (see \type{--data-dir},
above). The originals may be found in pandoc's system data directory
(generally \type{$CABALDIR/pandoc-VERSION/s5/default}). Pandoc will look
there for any files it does not find in the user data directory.

For dzslides, the CSS is included in the HTML file itself, and may be
modified there.

All \goto{reveal.js configuration
options}[url(https://revealjs.com/config/)] can be set through
variables. For example, themes can be used by setting the \type{theme}
variable:

\starttyping
-V theme=moon
\stoptyping

Or you can specify a custom stylesheet using the \type{--css} option.

To style beamer slides, you can specify a \type{theme},
\type{colortheme}, \type{fonttheme}, \type{innertheme}, and
\type{outertheme}, using the \type{-V} option:

\starttyping
pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
\stoptyping

Note that heading attributes will turn into slide attributes (on a
\type{<div>} or \type{<section>}) in HTML slide formats, allowing you to
style individual slides. In beamer, a number of heading classes and
attributes are recognized as frame options and will be passed through as
options to the frame: see \goto{Frame attributes in
beamer}[frame-attributes-in-beamer], below.

\stopsectionlevel

\startsectionlevel[title={Speaker notes},reference={speaker-notes}]

Speaker notes are supported in reveal.js, PowerPoint (pptx), and beamer
output. You can add notes to your Markdown document thus:

\starttyping
::: notes

This is my note.

- It can contain Markdown
- like this list

:::
\stoptyping

To show the notes window in reveal.js, press \type{s} while viewing the
presentation. Speaker notes in PowerPoint will be available, as usual,
in handouts and presenter view.

Notes are not yet supported for other slide formats, but the notes will
not appear on the slides themselves.

\stopsectionlevel

\startsectionlevel[title={Columns},reference={columns}]

To put material in side by side columns, you can use a native div
container with class \type{columns}, containing two or more div
containers with class \type{column} and a \type{width} attribute:

\starttyping
:::::::::::::: {.columns}
::: {.column width="40%"}
contents...
:::
::: {.column width="60%"}
contents...
:::
::::::::::::::
\stoptyping

\startsectionlevel[title={Additional columns attributes in
beamer},reference={additional-columns-attributes-in-beamer}]

The div containers with classes \type{columns} and \type{column} can
optionally have an \type{align} attribute. The class \type{columns} can
optionally have a \type{totalwidth} attribute or an \type{onlytextwidth}
class.

\starttyping
:::::::::::::: {.columns align=center totalwidth=8em}
::: {.column width="40%"}
contents...
:::
::: {.column width="60%" align=bottom}
contents...
:::
::::::::::::::
\stoptyping

The \type{align} attributes on \type{columns} and \type{column} can be
used with the values \type{top}, \type{top-baseline}, \type{center} and
\type{bottom} to vertically align the columns. It defaults to \type{top}
in \type{columns}.

The \type{totalwidth} attribute limits the width of the columns to the
given value.

\starttyping
:::::::::::::: {.columns align=top .onlytextwidth}
::: {.column width="40%" align=center}
contents...
:::
::: {.column width="60%"}
contents...
:::
::::::::::::::
\stoptyping

The class \type{onlytextwidth} sets the \type{totalwidth} to
\type{\textwidth}.

See Section 12.7 of the \goto{Beamer User's
Guide}[url(http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf)]
for more details.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Frame attributes in
beamer},reference={frame-attributes-in-beamer}]

Sometimes it is necessary to add the LaTeX \type{[fragile]} option to a
frame in beamer (for example, when using the \type{minted} environment).
This can be forced by adding the \type{fragile} class to the heading
introducing the slide:

\starttyping
# Fragile slide {.fragile}
\stoptyping

All of the other frame attributes described in Section 8.1 of the
\goto{Beamer User's
Guide}[url(http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf)]
may also be used: \type{allowdisplaybreaks}, \type{allowframebreaks},
\type{b}, \type{c}, \type{s}, \type{t}, \type{environment},
\type{label}, \type{plain}, \type{shrink}, \type{standout},
\type{noframenumbering}, \type{squeeze}. \type{allowframebreaks} is
recommended especially for bibliographies, as it allows multiple slides
to be created if the content overfills the frame:

\starttyping
# References {.allowframebreaks}
\stoptyping

In addition, the \type{frameoptions} attribute may be used to pass
arbitrary frame options to a beamer slide:

\starttyping
# Heading {frameoptions="squeeze,shrink,customoption=foobar"}
\stoptyping

\stopsectionlevel

\startsectionlevel[title={Background in reveal.js, beamer, and
pptx},reference={background-in-reveal.js-beamer-and-pptx}]

Background images can be added to self-contained reveal.js slide shows,
beamer slide shows, and pptx slide shows.

\startsectionlevel[title={On all slides (beamer, reveal.js,
pptx)},reference={on-all-slides-beamer-reveal.js-pptx}]

With beamer and reveal.js, the configuration option
\type{background-image} can be used either in the YAML metadata block or
as a command-line variable to get the same image on every slide.

Note that for reveal.js, the \type{background-image} will be used as a
\type{parallaxBackgroundImage} (see below).

For pptx, you can use a \goto{reference doc}[option--reference-doc] in
which background images have been set on the \goto{relevant
layouts}[powerpoint-layout-choice].

\startsectionlevel[title={\type{parallaxBackgroundImage}
(reveal.js)},reference={parallaxbackgroundimage-reveal.js}]

For reveal.js, there is also the reveal.js-native option
\type{parallaxBackgroundImage}, which produces a parallax scrolling
background. You must also set \type{parallaxBackgroundSize}, and can
optionally set \type{parallaxBackgroundHorizontal} and
\type{parallaxBackgroundVertical} to configure the scrolling behaviour.
See the \goto{reveal.js
documentation}[url(https://revealjs.com/backgrounds/\#parallax-background)]
for more details about the meaning of these options.

In reveal.js's overview mode, the parallaxBackgroundImage will show up
only on the first slide.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={On individual slides (reveal.js,
pptx)},reference={on-individual-slides-reveal.js-pptx}]

To set an image for a particular reveal.js or pptx slide, add
\type'{background-image="/path/to/image"}' to the first slide-level
heading on the slide (which may even be empty).

As the \goto{HTML writers pass unknown attributes
through}[extension-link_attributes], other reveal.js background settings
also work on individual slides, including \type{background-size},
\type{background-repeat}, \type{background-color}, \type{transition},
and \type{transition-speed}. (The \type{data-} prefix will automatically
be added.)

Note: \type{data-background-image} is also supported in pptx for
consistency with reveal.js -- if \type{background-image} isn't found,
\type{data-background-image} will be checked.

\stopsectionlevel

\startsectionlevel[title={On the title slide (reveal.js,
pptx)},reference={on-the-title-slide-reveal.js-pptx}]

To add a background image to the automatically generated title slide for
reveal.js, use the \type{title-slide-attributes} variable in the YAML
metadata block. It must contain a map of attribute names and values.
(Note that the \type{data-} prefix is required here, as it isn't added
automatically.)

For pptx, pass a \goto{reference doc}[option--reference-doc] with the
background image set on the \quotation{Title Slide} layout.

\stopsectionlevel

\startsectionlevel[title={Example
(reveal.js)},reference={example-reveal.js}]

\starttyping
---
title: My Slide Show
parallaxBackgroundImage: /path/to/my/background_image.png
title-slide-attributes:
    data-background-image: /path/to/title_image.png
    data-background-size: contain
---

## Slide One

Slide 1 has background_image.png as its background.

## {background-image="/path/to/special_image.jpg"}

Slide 2 has a special image for its background, even though the heading has no content.
\stoptyping

\stopsectionlevel

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={EPUBs},reference={epubs}]

\startsectionlevel[title={EPUB Metadata},reference={epub-metadata}]

EPUB metadata may be specified using the \type{--epub-metadata} option,
but if the source document is Markdown, it is better to use a \goto{YAML
metadata block}[extension-yaml_metadata_block]. Here is an example:

\starttyping
---
title:
- type: main
  text: My Book
- type: subtitle
  text: An investigation of metadata
creator:
- role: author
  text: John Smith
- role: editor
  text: Sarah Jones
identifier:
- scheme: DOI
  text: doi:10.234234.234/33
publisher:  My Press
rights: © 2007 John Smith, CC BY-NC
ibooks:
  version: 1.3.4
...
\stoptyping

The following fields are recognized:

\startdescription{\type{identifier}}
  Either a string value or an object with fields \type{text} and
  \type{scheme}. Valid values for \type{scheme} are \type{ISBN-10},
  \type{GTIN-13}, \type{UPC}, \type{ISMN-10}, \type{DOI}, \type{LCCN},
  \type{GTIN-14}, \type{ISBN-13}, \type{Legal deposit number},
  \type{URN}, \type{OCLC}, \type{ISMN-13}, \type{ISBN-A}, \type{JP},
  \type{OLCC}.
\stopdescription

\startdescription{\type{title}}
  Either a string value, or an object with fields \type{file-as} and
  \type{type}, or a list of such objects. Valid values for \type{type}
  are \type{main}, \type{subtitle}, \type{short}, \type{collection},
  \type{edition}, \type{extended}.
\stopdescription

\startdescription{\type{creator}}
  Either a string value, or an object with fields \type{role},
  \type{file-as}, and \type{text}, or a list of such objects. Valid
  values for \type{role} are \goto{MARC
  relators}[url(https://loc.gov/marc/relators/relaterm.html)], but
  pandoc will attempt to translate the human-readable versions (like
  \quotation{author} and \quotation{editor}) to the appropriate marc
  relators.
\stopdescription

\startdescription{\type{contributor}}
  Same format as \type{creator}.
\stopdescription

\startdescription{\type{date}}
  A string value in \type{YYYY-MM-DD} format. (Only the year is
  necessary.) Pandoc will attempt to convert other common date formats.
\stopdescription

\startdescription{\type{lang} (or legacy: \type{language})}
  A string value in \goto{BCP
  47}[url(https://tools.ietf.org/html/bcp47)] format. Pandoc will
  default to the local language if nothing is specified.
\stopdescription

\startdescription{\type{subject}}
  Either a string value, or an object with fields \type{text},
  \type{authority}, and \type{term}, or a list of such objects. Valid
  values for \type{authority} are either a \goto{reserved authority
  value}[url(https://idpf.github.io/epub-registries/authorities/)]
  (currently \type{AAT}, \type{BIC}, \type{BISAC}, \type{CLC},
  \type{DDC}, \type{CLIL}, \type{EuroVoc}, \type{MEDTOP}, \type{LCSH},
  \type{NDC}, \type{Thema}, \type{UDC}, and \type{WGS}) or an absolute
  IRI identifying a custom scheme. Valid values for \type{term} are
  defined by the scheme.
\stopdescription

\startdescription{\type{description}}
  A string value.
\stopdescription

\startdescription{\type{type}}
  A string value.
\stopdescription

\startdescription{\type{format}}
  A string value.
\stopdescription

\startdescription{\type{relation}}
  A string value.
\stopdescription

\startdescription{\type{coverage}}
  A string value.
\stopdescription

\startdescription{\type{rights}}
  A string value.
\stopdescription

\startdescription{\type{belongs-to-collection}}
  A string value. Identifies the name of a collection to which the EPUB
  Publication belongs.
\stopdescription

\startdescription{\type{group-position}}
  The \type{group-position} field indicates the numeric position in
  which the EPUB Publication belongs relative to other works belonging
  to the same \type{belongs-to-collection} field.
\stopdescription

\startdescription{\type{cover-image}}
  A string value (path to cover image).
\stopdescription

\startdescription{\type{css} (or legacy: \type{stylesheet})}
  A string value (path to CSS stylesheet).
\stopdescription

\startdescription{\type{page-progression-direction}}
  Either \type{ltr} or \type{rtl}. Specifies the
  \type{page-progression-direction} attribute for the \goto{\type{spine}
  element}[url(http://idpf.org/epub/301/spec/epub-publications.html\#sec-spine-elem)].
\stopdescription

\startdescription{\type{accessModes}}
  An array of strings
  (\goto{schema}[url(https://kb.daisy.org/publishing/docs/metadata/schema.org/index.html)]).
  Defaults to \type{["textual"]}.
\stopdescription

\startdescription{\type{accessModeSufficient}}
  An array of strings
  (\goto{schema}[url(https://kb.daisy.org/publishing/docs/metadata/schema.org/index.html)]).
  Defaults to \type{["textual"]}.
\stopdescription

\startdescription{\type{accessibilityHazards}}
  An array of strings
  (\goto{schema}[url(https://kb.daisy.org/publishing/docs/metadata/schema.org/index.html)]).
  Defaults to \type{["none"]}.
\stopdescription

\startdescription{\type{accessibilityFeatures}}
  An array of strings
  (\goto{schema}[url(https://kb.daisy.org/publishing/docs/metadata/schema.org/index.html)]).
  Defaults to

\starttyping
- "alternativeText"
- "readingOrder"
- "structuralNavigation"
- "tableOfContents"
\stoptyping
\stopdescription

\startdescription{\type{accessibilitySummary}}
  A string value.
\stopdescription

\startdescription{\type{ibooks}}
  iBooks-specific metadata, with the following fields:

  \startitemize[packed]
  \item
    \type{version}: (string)
  \item
    \type{specified-fonts}: \type{true}\letterbar{}\type{false} (default
    \type{false})
  \item
    \type{ipad-orientation-lock}:
    \type{portrait-only}\letterbar{}\type{landscape-only}
  \item
    \type{iphone-orientation-lock}:
    \type{portrait-only}\letterbar{}\type{landscape-only}
  \item
    \type{binding}: \type{true}\letterbar{}\type{false} (default
    \type{true})
  \item
    \type{scroll-axis}:
    \type{vertical}\letterbar{}\type{horizontal}\letterbar{}\type{default}
  \stopitemize
\stopdescription

\stopsectionlevel

\startsectionlevel[title={The \type{epub:type}
attribute},reference={the-epubtype-attribute}]

For \type{epub3} output, you can mark up the heading that corresponds to
an EPUB chapter using the \goto{\type{epub:type}
attribute}[url(http://www.idpf.org/epub/31/spec/epub-contentdocs.html\#sec-epub-type-attribute)].
For example, to set the attribute to the value \type{prologue}, use this
Markdown:

\starttyping
# My chapter {epub:type=prologue}
\stoptyping

Which will result in:

\starttyping
<body epub:type="frontmatter">
  <section epub:type="prologue">
    <h1>My chapter</h1>
\stoptyping

Pandoc will output \type{<body epub:type="bodymatter">}, unless you use
one of the following values, in which case either \type{frontmatter} or
\type{backmatter} will be output.

\startplacetable[location=none]
\startxtable
\startxtablehead[head]
\startxrowgroup[lastrow]
\startxrow
\startxcell \type{epub:type} of first section \stopxcell
\startxcell \type{epub:type} of body \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablehead
\startxtablebody[body]
\startxrow
\startxcell prologue \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell abstract \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell acknowledgments \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell copyright-page \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell dedication \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell credits \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell keywords \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell imprint \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell contributors \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell other-credits \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell errata \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell revision-history \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell titlepage \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell halftitlepage \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell seriespage \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell foreword \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell preface \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell frontispiece \stopxcell
\startxcell frontmatter \stopxcell
\stopxrow
\startxrow
\startxcell appendix \stopxcell
\startxcell backmatter \stopxcell
\stopxrow
\startxrow
\startxcell colophon \stopxcell
\startxcell backmatter \stopxcell
\stopxrow
\startxrow
\startxcell bibliography \stopxcell
\startxcell backmatter \stopxcell
\stopxrow
\startxrowgroup[lastrow]
\startxrow
\startxcell index \stopxcell
\startxcell backmatter \stopxcell
\stopxrow
\stopxrowgroup
\stopxtablebody
\startxtablefoot[foot]
\stopxtablefoot
\stopxtable
\stopplacetable

\stopsectionlevel

\startsectionlevel[title={Linked media},reference={linked-media}]

By default, pandoc will download media referenced from any \type{<img>},
\type{<audio>}, \type{<video>} or \type{<source>} element present in the
generated EPUB, and include it in the EPUB container, yielding a
completely self-contained EPUB. If you want to link to external media
resources instead, use raw HTML in your source and add
\type{data-external="1"} to the tag with the \type{src} attribute. For
example:

\starttyping
<audio controls="1">
  <source src="https://example.com/music/toccata.mp3"
          data-external="1" type="audio/mpeg">
  </source>
</audio>
\stoptyping

If the input format already is HTML then \type{data-external="1"} will
work as expected for \type{<img>} elements. Similarly, for Markdown,
external images can be declared with \type"![img](url){external=1}".
Note that this only works for images; the other media elements have no
native representation in pandoc's AST and require the use of raw HTML.

\stopsectionlevel

\startsectionlevel[title={EPUB styling},reference={epub-styling}]

By default, pandoc will include some basic styling contained in its
\type{epub.css} data file. (To see this, use
\type{pandoc --print-default-data-file epub.css}.) To use a different
CSS file, just use the \type{--css} command line option. A few inline
styles are defined in addition; these are essential for correct
formatting of pandoc's HTML output.

The \type{document-css} variable may be set if the more opinionated
styling of pandoc's default HTML templates is desired (and in that case
the variables defined in \goto{Variables for HTML}[variables-for-html]
may be used to fine-tune the style).

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Chunked HTML},reference={chunked-html}]

\type{pandoc -t chunkedhtml} will produce a zip archive of linked HTML
files, one for each section of the original document. Internal links
will automatically be adjusted to point to the right place, images
linked to under the working directory will be incorporated, and
navigation links will be added. In addition, a JSON file
\type{sitemap.json} will be included describing the hierarchical
structure of the files.

If an output file without an extension is specified, then it will be
interpreted as a directory and the zip archive will be automatically
unpacked into it (unless it already exists, in which case an error will
be raised). Otherwise a \type{.zip} file will be produced.

The navigation links can be customized by adjusting the template. By
default, a table of contents is included only on the top page. To
include it on every page, set the \type{toc} variable manually.

\stopsectionlevel

\startsectionlevel[title={Jupyter
notebooks},reference={jupyter-notebooks}]

When creating a \goto{Jupyter
notebook}[url(https://nbformat.readthedocs.io/en/latest/)], pandoc will
try to infer the notebook structure. Code blocks with the class
\type{code} will be taken as code cells, and intervening content will be
taken as Markdown cells. Attachments will automatically be created for
images in Markdown cells. Metadata will be taken from the \type{jupyter}
metadata field. For example:

\starttyping
---
title: My notebook
jupyter:
  nbformat: 4
  nbformat_minor: 5
  kernelspec:
     display_name: Python 2
     language: python
     name: python2
  language_info:
     codemirror_mode:
       name: ipython
       version: 2
     file_extension: ".py"
     mimetype: "text/x-python"
     name: "python"
     nbconvert_exporter: "python"
     pygments_lexer: "ipython2"
     version: "2.7.15"
---

# Lorem ipsum

**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
bibendum felis dictum sodales.

``` code
print("hello")
```

## Pyout

``` code
from IPython.display import HTML
HTML("""
<script>
console.log("hello");
</script>
<b>HTML</b>
""")
```

## Image

This image ![image](myimage.png) will be
included as a cell attachment.
\stoptyping

If you want to add cell attributes, group cells differently, or add
output to code cells, then you need to include divs to indicate the
structure. You can use either \goto{fenced divs}[extension-fenced_divs]
or \goto{native divs}[extension-native_divs] for this. Here is an
example:

\starttyping
:::::: {.cell .markdown}
# Lorem

**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
bibendum felis dictum sodales.
::::::

:::::: {.cell .code execution_count=1}
``` {.python}
print("hello")
```

::: {.output .stream .stdout}
```
hello
```
:::
::::::

:::::: {.cell .code execution_count=2}
``` {.python}
from IPython.display import HTML
HTML("""
<script>
console.log("hello");
</script>
<b>HTML</b>
""")
```

::: {.output .execute_result execution_count=2}
```{=html}
<script>
console.log("hello");
</script>
<b>HTML</b>
hello
```
:::
::::::
\stoptyping

If you include raw HTML or TeX in an output cell, use the \goto{raw
attribute}[extension-raw_attribute], as shown in the last cell of the
example above. Although pandoc can process \quotation{bare} raw HTML and
TeX, the result is often interspersed raw elements and normal textual
elements, and in an output cell pandoc expects a single, connected raw
block. To avoid using raw HTML or TeX except when marked explicitly
using raw attributes, we recommend specifying the extensions
\type{-raw_html-raw_tex+raw_attribute} when translating between Markdown
and ipynb notebooks.

Note that options and extensions that affect reading and writing of
Markdown will also affect Markdown cells in ipynb notebooks. For
example, \type{--wrap=preserve} will preserve soft line breaks in
Markdown cells; \type{--markdown-headings=setext} will cause
Setext-style headings to be used; and \type{--preserve-tabs} will
prevent tabs from being turned to spaces.

\stopsectionlevel

\startsectionlevel[title={Syntax
highlighting},reference={syntax-highlighting}]

Pandoc will automatically highlight syntax in \goto{fenced code
blocks}[fenced-code-blocks] that are marked with a language name. The
Haskell library
\goto{skylighting}[url(https://github.com/jgm/skylighting)] is used for
highlighting. Currently highlighting is supported only for HTML, EPUB,
Docx, Ms, Man, and LaTeX/PDF output. To see a list of language names
that pandoc will recognize, type
\type{pandoc --list-highlight-languages}.

The color scheme can be selected using the \type{--highlight-style}
option. The default color scheme is \type{pygments}, which imitates the
default color scheme used by the Python library pygments (though
pygments is not actually used to do the highlighting). To see a list of
highlight styles, type \type{pandoc --list-highlight-styles}.

If you are not satisfied with the predefined styles, you can use
\type{--print-highlight-style} to generate a JSON \type{.theme} file
which can be modified and used as the argument to
\type{--highlight-style}. To get a JSON version of the \type{pygments}
style, for example:

\starttyping
pandoc --print-highlight-style pygments > my.theme
\stoptyping

Then edit \type{my.theme} and use it like this:

\starttyping
pandoc --highlight-style my.theme
\stoptyping

If you are not satisfied with the built-in highlighting, or you want to
highlight a language that isn't supported, you can use the
\type{--syntax-definition} option to load a \goto{KDE-style XML syntax
definition
file}[url(https://docs.kde.org/stable5/en/kate/katepart/highlight.html)].
Before writing your own, have a look at KDE's \goto{repository of syntax
definitions}[url(https://github.com/KDE/syntax-highlighting/tree/master/data/syntax)].

To disable highlighting, use the \type{--no-highlight} option.

\stopsectionlevel

\startsectionlevel[title={Custom Styles},reference={custom-styles}]

Custom styles can be used in the docx and ICML formats.

\startsectionlevel[title={Output},reference={output}]

By default, pandoc's docx and ICML output applies a predefined set of
styles for blocks such as paragraphs and block quotes, and uses largely
default formatting (italics, bold) for inlines. This will work for most
purposes, especially alongside a \type{reference.docx} file. However, if
you need to apply your own styles to blocks, or match a preexisting set
of styles, pandoc allows you to define custom styles for blocks and text
using \type{div}s and \type{span}s, respectively.

If you define a \type{div} or \type{span} with the attribute
\type{custom-style}, pandoc will apply your specified style to the
contained elements (with the exception of elements whose function
depends on a style, like headings, code blocks, block quotes, or links).
So, for example, using the \type{bracketed_spans} syntax,

\starttyping
[Get out]{custom-style="Emphatically"}, he said.
\stoptyping

would produce a docx file with \quotation{Get out} styled with character
style \type{Emphatically}. Similarly, using the \type{fenced_divs}
syntax,

\starttyping
Dickinson starts the poem simply:

::: {custom-style="Poetry"}
| A Bird came down the Walk---
| He did not know I saw---
:::
\stoptyping

would style the two contained lines with the \type{Poetry} paragraph
style.

For docx output, styles will be defined in the output file as inheriting
from normal text, if the styles are not yet in your reference.docx. If
they are already defined, pandoc will not alter the definition.

This feature allows for greatest customization in conjunction with
\goto{pandoc filters}[url(https://pandoc.org/filters.html)]. If you want
all paragraphs after block quotes to be indented, you can write a filter
to apply the styles necessary. If you want all italics to be transformed
to the \type{Emphasis} character style (perhaps to change their color),
you can write a filter which will transform all italicized inlines to
inlines within an \type{Emphasis} custom-style \type{span}.

For docx output, you don't need to enable any extensions for custom
styles to work.

\stopsectionlevel

\startsectionlevel[title={Input},reference={input}]

The docx reader, by default, only reads those styles that it can convert
into pandoc elements, either by direct conversion or interpreting the
derivation of the input document's styles.

By enabling the \goto{\type{styles} extension}[ext-styles] in the docx
reader (\type{-f docx+styles}), you can produce output that maintains
the styles of the input document, using the \type{custom-style} class.
Paragraph styles are interpreted as divs, while character styles are
interpreted as spans.

For example, using the \type{custom-style-reference.docx} file in the
test directory, we have the following different outputs:

Without the \type{+styles} extension:

\starttyping
$ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
This is some text.

This is text with an *emphasized* text style. And this is text with a
**strengthened** text style.

> Here is a styled paragraph that inherits from Block Text.
\stoptyping

And with the extension:

\starttyping
$ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown

::: {custom-style="First Paragraph"}
This is some text.
:::

::: {custom-style="Body Text"}
This is text with an [emphasized]{custom-style="Emphatic"} text style.
And this is text with a [strengthened]{custom-style="Strengthened"}
text style.
:::

::: {custom-style="My Block Style"}
> Here is a styled paragraph that inherits from Block Text.
:::
\stoptyping

With these custom styles, you can use your input document as a
reference-doc while creating docx output (see below), and maintain the
same styles in your input and output files.

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Custom readers and
writers},reference={custom-readers-and-writers}]

Pandoc can be extended with custom readers and writers written in
\goto{Lua}[url(https://www.lua.org)]. (Pandoc includes a Lua
interpreter, so Lua need not be installed separately.)

To use a custom reader or writer, simply specify the path to the Lua
script in place of the input or output format. For example:

\starttyping
pandoc -t data/sample.lua
pandoc -f my_custom_markup_language.lua -t latex -s
\stoptyping

If the script is not found relative to the working directory, it will be
sought in the \type{custom} subdirectory of the user data directory (see
\type{--data-dir}).

A custom reader is a Lua script that defines one function, Reader, which
takes a string as input and returns a Pandoc AST. See the \goto{Lua
filters documentation}[url(https://pandoc.org/lua-filters.html)] for
documentation of the functions that are available for creating pandoc
AST elements. For parsing, the
\goto{lpeg}[url(http://www.inf.puc-rio.br/~roberto/lpeg/)] parsing
library is available by default. To see a sample custom reader:

\starttyping
pandoc --print-default-data-file creole.lua
\stoptyping

If you want your custom reader to have access to reader options
(e.g.~the tab stop setting), you give your Reader function a second
\type{options} parameter.

A custom writer is a Lua script that defines a function that specifies
how to render each element in a Pandoc AST. See the
\goto{djot-writer.lua}[url(https://github.com/jgm/djot.lua/blob/main/djot-writer.lua)]
for a full-featured example.

Note that custom writers have no default template. If you want to use
\type{--standalone} with a custom writer, you will need to specify a
template manually using \type{--template} or add a new default template
with the name \type{default.NAME_OF_CUSTOM_WRITER.lua} to the
\type{templates} subdirectory of your user data directory (see
\goto{Templates}[templates]).

\stopsectionlevel

\startsectionlevel[title={Reproducible
builds},reference={reproducible-builds}]

Some of the document formats pandoc targets (such as EPUB, docx, and
ODT) include build timestamps in the generated document. That means that
the files generated on successive builds will differ, even if the source
does not. To avoid this, set the \type{SOURCE_DATE_EPOCH} environment
variable, and the timestamp will be taken from it instead of the current
time. \type{SOURCE_DATE_EPOCH} should contain an integer unix timestamp
(specifying the number of seconds since midnight UTC January 1, 1970).

Some document formats also include a unique identifier. For EPUB, this
can be set explicitly by setting the \type{identifier} metadata field
(see \goto{EPUB Metadata}[epub-metadata], above).

\stopsectionlevel

\startsectionlevel[title={Accessible PDFs and PDF archiving
standards},reference={accessible-pdfs-and-pdf-archiving-standards}]

PDF is a flexible format, and using PDF in certain contexts requires
additional conventions. For example, PDFs are not accessible by default;
they define how characters are placed on a page but do not contain
semantic information on the content. However, it is possible to generate
accessible PDFs, which use tagging to add semantic information to the
document.

Pandoc defaults to LaTeX to generate PDF. Tagging support in LaTeX is in
development and not readily available, so PDFs generated in this way
will always be untagged and not accessible. This means that alternative
engines must be used to generate accessible PDFs.

The PDF standards PDF/A and PDF/UA define further restrictions intended
to optimize PDFs for archiving and accessibility. Tagging is commonly
used in combination with these standards to ensure best results.

Note, however, that standard compliance depends on many things,
including the colorspace of embedded images. Pandoc cannot check this,
and external programs must be used to ensure that generated PDFs are in
compliance.

\startsectionlevel[title={ConTeXt},reference={context}]

ConTeXt always produces tagged PDFs, but the quality depends on the
input. The default ConTeXt markup generated by pandoc is optimized for
readability and reuse, not tagging. Enable the
\goto{\type{tagging}}[extension--tagging] format extension to force
markup that is optimized for tagging. This can be combined with the
\type{pdfa} variable to generate standard-compliant PDFs. E.g.:

\starttyping
pandoc --to=context+tagging -V pdfa=3a
\stoptyping

A recent \type{context} version should be used, as older versions
contained a bug that lead to invalid PDF metadata.

\stopsectionlevel

\startsectionlevel[title={WeasyPrint},reference={weasyprint}]

The HTML-based engine WeasyPrint includes experimental support for PDF/A
and PDF/UA since version 57. Tagged PDFs can created with

\starttyping
pandoc --pdf-engine=weasyprint \
       --pdf-engine-opt=--pdf-variant=pdf/ua-1 ...
\stoptyping

The feature is experimental and standard compliance should not be
assumed.

\stopsectionlevel

\startsectionlevel[title={Prince XML},reference={prince-xml}]

The non-free HTML-to-PDf converter \type{prince} has extensive support
for various PDF standards as well as tagging. E.g.:

\starttyping
pandoc --pdf-engine=prince \
       --pdf-engine-opt=--tagged-pdf ...
\stoptyping

See the prince documentation for more info.

\stopsectionlevel

\startsectionlevel[title={Word Processors},reference={word-processors}]

Word processors like LibreOffice and MS Word can also be used to
generate standardized and tagged PDF output. Pandoc does not support
direct conversions via these tools. However, pandoc can convert a
document to a \type{docx} or \type{odt} file, which can then be opened
and converted to PDF with the respective word processor. See the
documentation for
\goto{Word}[url(https://support.microsoft.com/en-us/office/create-accessible-pdfs-064625e0-56ea-4e16-ad71-3aa33bb4b7ed)]
and
\goto{LibreOffice}[url(https://help.libreoffice.org/7.1/en-US/text/shared/01/ref_pdf_export_general.html)].

\stopsectionlevel

\stopsectionlevel

\startsectionlevel[title={Running pandoc as a web
server},reference={running-pandoc-as-a-web-server}]

If you rename (or symlink) the pandoc executable to
\type{pandoc-server}, or if you call pandoc with \type{server} as the
first argument, it will start up a web server with a JSON API. This
server exposes most of the conversion functionality of pandoc. For full
documentation, see the
\goto{pandoc-server}[url(https://github.com/jgm/pandoc/blob/master/doc/pandoc-server.md)]
man page.

If you rename (or symlink) the pandoc executable to
\type{pandoc-server.cgi}, it will function as a CGI program exposing the
same API as \type{pandoc-server}.

\type{pandoc-server} is designed to be maximally secure; it uses
Haskell's type system to provide strong guarantees that no I/O will be
performed on the server during pandoc conversions.

\stopsectionlevel

\startsectionlevel[title={Running pandoc as a Lua
interpreter},reference={running-pandoc-as-a-lua-interpreter}]

Calling the pandoc executable under the name \type{pandoc-lua} or with
\type{lua} as the first argument will make it function as a standalone
Lua interpreter. The behavior is mostly identical to that of the
\goto{standalone \type{lua}
executable}[url(https://www.lua.org/manual/5.4/manual.html\#7)], version
5.4. However, there is no REPL yet, and the \type{-i} option has no
effect. For full documentation, see the
\goto{pandoc-lua}[url(https://github.com/jgm/pandoc/blob/master/doc/pandoc-lua.md)]
man page.

\stopsectionlevel

\startsectionlevel[title={A note on
security},reference={a-note-on-security}]

\startenumerate[n][stopper=.]
\item
  Although pandoc itself will not create or modify any files other than
  those you explicitly ask it create (with the exception of temporary
  files used in producing PDFs), a filter or custom writer could in
  principle do anything on your file system. Please audit filters and
  custom writers very carefully before using them.
\item
  Several input formats (including HTML, Org, and RST) support
  \type{include} directives that allow the contents of a file to be
  included in the output. An untrusted attacker could use these to view
  the contents of files on the file system. (Using the \type{--sandbox}
  option can protect against this threat.)
\item
  Several output formats (including RTF, FB2, HTML with
  \type{--self-contained}, EPUB, Docx, and ODT) will embed encoded or
  raw images into the output file. An untrusted attacker could exploit
  this to view the contents of non-image files on the file system.
  (Using the \type{--sandbox} option can protect against this threat,
  but will also prevent including images in these formats.)
\item
  If your application uses pandoc as a Haskell library (rather than
  shelling out to the executable), it is possible to use it in a mode
  that fully isolates pandoc from your file system, by running the
  pandoc operations in the \type{PandocPure} monad. See the document
  \goto{Using the pandoc
  API}[url(https://pandoc.org/using-the-pandoc-api.html)] for more
  details. (This corresponds to the use of the \type{--sandbox} option
  on the command line.)
\item
  Pandoc's parsers can exhibit pathological performance on some corner
  cases. It is wise to put any pandoc operations under a timeout, to
  avoid DOS attacks that exploit these issues. If you are using the
  pandoc executable, you can add the command line options
  \type{+RTS -M512M -RTS} (for example) to limit the heap size to 512MB.
  Note that the \type{commonmark} parser (including \type{commonmark_x}
  and \type{gfm}) is much less vulnerable to pathological performance
  than the \type{markdown} parser, so it is a better choice when
  processing untrusted input.
\item
  The HTML generated by pandoc is not guaranteed to be safe. If
  \type{raw_html} is enabled for the Markdown input, users can inject
  arbitrary HTML. Even if \type{raw_html} is disabled, users can include
  dangerous content in URLs and attributes. To be safe, you should run
  all HTML generated from untrusted user input through an HTML
  sanitizer.
\stopenumerate

\stopsectionlevel

\startsectionlevel[title={Authors},reference={authors}]

Copyright 2006--2022 John MacFarlane (jgm@berkeley.edu). Released under
the \goto{GPL}[url(https://www.gnu.org/copyleft/gpl.html)], version 2 or
greater. This software carries no warranty of any kind. (See COPYRIGHT
for full copyright and warranty notices.) For a full list of
contributors, see the file AUTHORS.md in the pandoc source code.

\stopsectionlevel

\stoptext
