diff options
| author | John MacFarlane <jgm@berkeley.edu> | 2018-10-19 22:56:40 -0700 |
|---|---|---|
| committer | John MacFarlane <jgm@berkeley.edu> | 2018-10-19 22:56:40 -0700 |
| commit | c01897281a468797a021ac2b05a7520b93247711 (patch) | |
| tree | 20e08b56c244fbba57797476b9b5ad3f2989339a /man | |
| parent | f5704fac9769e4b236cfe70292f77b80b19accc6 (diff) | |
| download | pandoc-c01897281a468797a021ac2b05a7520b93247711.tar.gz | |
Update man page to use `\[at]` instead of `\@`.
Diffstat (limited to 'man')
| -rw-r--r-- | man/pandoc.1 | 3358 |
1 files changed, 1697 insertions, 1661 deletions
diff --git a/man/pandoc.1 b/man/pandoc.1 index 00cdfdc00..52ec02173 100644 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,10 +1,10 @@ .\"t -.TH PANDOC 1 "September 27, 2018" "pandoc 2.3.1" +.TH PANDOC 1 "September 27, 2018" "pandoc 2.4" .SH NAME pandoc - general markup converter .SH SYNOPSIS .PP -\f[C]pandoc\f[] [\f[I]options\f[]] [\f[I]input\-file\f[]]... +\f[C]pandoc\f[R] [\f[I]options\f[R]] [\f[I]input\-file\f[R]]... .SH DESCRIPTION .PP Pandoc is a Haskell library for converting from one markup format to @@ -14,7 +14,7 @@ Pandoc can convert between numerous markup and word processing formats, including, but not limited to, various flavors of Markdown, HTML, LaTeX and Word docx. For the full lists of input and output formats, see the -\f[C]\-\-from\f[] and \f[C]\-\-to\f[] options below. +\f[C]\-\-from\f[R] and \f[C]\-\-to\f[R] options below. Pandoc can also produce PDF output: see creating a PDF, below. .PP Pandoc\[aq]s enhanced version of Markdown includes syntax for tables, @@ -24,7 +24,7 @@ See below under Pandoc\[aq]s Markdown. .PP 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 \f[I]abstract syntax tree\f[] or AST), and a set of +document (an \f[I]abstract syntax tree\f[R] 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. @@ -40,158 +40,160 @@ pandoc\[aq]s simple document model. While conversions from pandoc\[aq]s Markdown to all formats aspire to be perfect, conversions from formats more expressive than pandoc\[aq]s Markdown can be expected to be lossy. -.SS Using \f[C]pandoc\f[] +.SS Using \f[C]pandoc\f[R] .PP -If no \f[I]input\-files\f[] are specified, input is read from -\f[I]stdin\f[]. -Output goes to \f[I]stdout\f[] by default. -For output to a file, use the \f[C]\-o\f[] option: +If no \f[I]input\-files\f[R] are specified, input is read from +\f[I]stdin\f[R]. +Output goes to \f[I]stdout\f[R] by default. +For output to a file, use the \f[C]\-o\f[R] option: .IP .nf \f[C] pandoc\ \-o\ output.html\ input.txt -\f[] +\f[R] .fi .PP By default, pandoc produces a document fragment. To produce a standalone document (e.g. -a valid HTML file including \f[C]<head>\f[] and \f[C]<body>\f[]), use -the \f[C]\-s\f[] or \f[C]\-\-standalone\f[] flag: +a valid HTML file including \f[C]<head>\f[R] and \f[C]<body>\f[R]), use +the \f[C]\-s\f[R] or \f[C]\-\-standalone\f[R] flag: .IP .nf \f[C] pandoc\ \-s\ \-o\ output.html\ input.txt -\f[] +\f[R] .fi .PP For more information on how standalone documents are produced, see Templates below. .PP -If multiple input files are given, \f[C]pandoc\f[] will concatenate them -all (with blank lines between them) before parsing. -(Use \f[C]\-\-file\-scope\f[] to parse files individually.) +If multiple input files are given, \f[C]pandoc\f[R] will concatenate +them all (with blank lines between them) before parsing. +(Use \f[C]\-\-file\-scope\f[R] to parse files individually.) .SS Specifying formats .PP The format of the input and output can be specified explicitly using command\-line options. -The input format can be specified using the \f[C]\-f/\-\-from\f[] -option, the output format using the \f[C]\-t/\-\-to\f[] option. -Thus, to convert \f[C]hello.txt\f[] from Markdown to LaTeX, you could +The input format can be specified using the \f[C]\-f/\-\-from\f[R] +option, the output format using the \f[C]\-t/\-\-to\f[R] option. +Thus, to convert \f[C]hello.txt\f[R] from Markdown to LaTeX, you could type: .IP .nf \f[C] pandoc\ \-f\ markdown\ \-t\ latex\ hello.txt -\f[] +\f[R] .fi .PP -To convert \f[C]hello.html\f[] from HTML to Markdown: +To convert \f[C]hello.html\f[R] from HTML to Markdown: .IP .nf \f[C] pandoc\ \-f\ html\ \-t\ markdown\ hello.html -\f[] +\f[R] .fi .PP Supported input and output formats are listed below under Options (see -\f[C]\-f\f[] for input formats and \f[C]\-t\f[] for output formats). -You can also use \f[C]pandoc\ \-\-list\-input\-formats\f[] and -\f[C]pandoc\ \-\-list\-output\-formats\f[] to print lists of supported +\f[C]\-f\f[R] for input formats and \f[C]\-t\f[R] for output formats). +You can also use \f[C]pandoc\ \-\-list\-input\-formats\f[R] and +\f[C]pandoc\ \-\-list\-output\-formats\f[R] to print lists of supported formats. .PP If the input or output format is not specified explicitly, -\f[C]pandoc\f[] will attempt to guess it from the extensions of the +\f[C]pandoc\f[R] will attempt to guess it from the extensions of the filenames. Thus, for example, .IP .nf \f[C] pandoc\ \-o\ hello.tex\ hello.txt -\f[] +\f[R] .fi .PP -will convert \f[C]hello.txt\f[] from Markdown to LaTeX. -If no output file is specified (so that output goes to \f[I]stdout\f[]), -or if the output file\[aq]s extension is unknown, the output format will -default to HTML. -If no input file is specified (so that input comes from \f[I]stdin\f[]), -or if the input files\[aq] extensions are unknown, the input format will -be assumed to be Markdown. +will convert \f[C]hello.txt\f[R] from Markdown to LaTeX. +If no output file is specified (so that output goes to +\f[I]stdout\f[R]), or if the output file\[aq]s extension is unknown, the +output format will default to HTML. +If no input file is specified (so that input comes from +\f[I]stdin\f[R]), or if the input files\[aq] extensions are unknown, the +input format will be assumed to be Markdown. .SS Character encoding .PP 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 \f[C]iconv\f[]: +and output through \f[C]iconv\f[R]: .IP .nf \f[C] iconv\ \-t\ utf\-8\ input.txt\ |\ pandoc\ |\ iconv\ \-f\ utf\-8 -\f[] +\f[R] .fi .PP 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 \f[C]\-s/\-\-standalone\f[] option. +the \f[C]\-s/\-\-standalone\f[R] option. .SS Creating a PDF .PP -To produce a PDF, specify an output file with a \f[C]\&.pdf\f[] +To produce a PDF, specify an output file with a \f[C]\&.pdf\f[R] extension: .IP .nf \f[C] pandoc\ test.txt\ \-o\ test.pdf -\f[] +\f[R] .fi .PP By default, pandoc will use LaTeX to create the PDF, which requires that -a LaTeX engine be installed (see \f[C]\-\-pdf\-engine\f[] below). +a LaTeX engine be installed (see \f[C]\-\-pdf\-engine\f[R] below). .PP -Alternatively, pandoc can use ConTeXt, \f[C]pdfroff\f[], or any of the +Alternatively, pandoc can use ConTeXt, \f[C]pdfroff\f[R], or any of the following HTML/CSS\-to\-PDF\-engines, to create a PDF: -\f[C]wkhtmltopdf\f[], \f[C]weasyprint\f[] or \f[C]prince\f[]. -To do this, specify an output file with a \f[C]\&.pdf\f[] extension, as -before, but add the \f[C]\-\-pdf\-engine\f[] option or -\f[C]\-t\ context\f[], \f[C]\-t\ html\f[], or \f[C]\-t\ ms\f[] to the -command line (\f[C]\-t\ html\f[] defaults to -\f[C]\-\-pdf\-engine=wkhtmltopdf\f[]). +\f[C]wkhtmltopdf\f[R], \f[C]weasyprint\f[R] or \f[C]prince\f[R]. +To do this, specify an output file with a \f[C]\&.pdf\f[R] extension, as +before, but add the \f[C]\-\-pdf\-engine\f[R] option or +\f[C]\-t\ context\f[R], \f[C]\-t\ html\f[R], or \f[C]\-t\ ms\f[R] to the +command line (\f[C]\-t\ html\f[R] defaults to +\f[C]\-\-pdf\-engine=wkhtmltopdf\f[R]). .PP PDF output can be controlled using variables for LaTeX (if LaTeX is used) and variables for ConTeXt (if ConTeXt is used). -When using an HTML/CSS\-to\-PDF\-engine, \f[C]\-\-css\f[] affects the +When using an HTML/CSS\-to\-PDF\-engine, \f[C]\-\-css\f[R] affects the output. -If \f[C]wkhtmltopdf\f[] is used, then the variables -\f[C]margin\-left\f[], \f[C]margin\-right\f[], \f[C]margin\-top\f[], -\f[C]margin\-bottom\f[], \f[C]footer\-html\f[], \f[C]header\-html\f[] -and \f[C]papersize\f[] will affect the output. +If \f[C]wkhtmltopdf\f[R] is used, then the variables +\f[C]margin\-left\f[R], \f[C]margin\-right\f[R], \f[C]margin\-top\f[R], +\f[C]margin\-bottom\f[R], \f[C]footer\-html\f[R], \f[C]header\-html\f[R] +and \f[C]papersize\f[R] will affect the output. .PP To debug the PDF creation, it can be useful to look at the intermediate -representation: instead of \f[C]\-o\ test.pdf\f[], use for example -\f[C]\-s\ \-o\ test.tex\f[] to output the generated LaTeX. -You can then test it with \f[C]pdflatex\ test.tex\f[]. +representation: instead of \f[C]\-o\ test.pdf\f[R], use for example +\f[C]\-s\ \-o\ test.tex\f[R] to output the generated LaTeX. +You can then test it with \f[C]pdflatex\ test.tex\f[R]. .PP When using LaTeX, the following packages need to be available (they are -included with all recent versions of TeX Live): \f[C]amsfonts\f[], -\f[C]amsmath\f[], \f[C]lm\f[], \f[C]unicode\-math\f[], \f[C]ifxetex\f[], -\f[C]ifluatex\f[], \f[C]listings\f[] (if the \f[C]\-\-listings\f[] -option is used), \f[C]fancyvrb\f[], \f[C]longtable\f[], -\f[C]booktabs\f[], \f[C]graphicx\f[] and \f[C]grffile\f[] (if the -document contains images), \f[C]hyperref\f[], \f[C]xcolor\f[] (with -\f[C]colorlinks\f[]), \f[C]ulem\f[], \f[C]geometry\f[] (with the -\f[C]geometry\f[] variable set), \f[C]setspace\f[] (with -\f[C]linestretch\f[]), and \f[C]babel\f[] (with \f[C]lang\f[]). -The use of \f[C]xelatex\f[] or \f[C]lualatex\f[] as the LaTeX engine -requires \f[C]fontspec\f[]. -\f[C]xelatex\f[] uses \f[C]polyglossia\f[] (with \f[C]lang\f[]), -\f[C]xecjk\f[], and \f[C]bidi\f[] (with the \f[C]dir\f[] variable set). -If the \f[C]mathspec\f[] variable is set, \f[C]xelatex\f[] will use -\f[C]mathspec\f[] instead of \f[C]unicode\-math\f[]. -The \f[C]upquote\f[] and \f[C]microtype\f[] packages are used if -available, and \f[C]csquotes\f[] will be used for typography if -\f[C]\\usepackage{csquotes}\f[] is present in the template or included -via \f[C]/H/\-\-include\-in\-header\f[]. -The \f[C]natbib\f[], \f[C]biblatex\f[], \f[C]bibtex\f[], and -\f[C]biber\f[] packages can optionally be used for citation rendering. +included with all recent versions of TeX Live): \f[C]amsfonts\f[R], +\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode\-math\f[R], +\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the +\f[C]\-\-listings\f[R] option is used), \f[C]fancyvrb\f[R], +\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] and +\f[C]grffile\f[R] (if the document contains images), \f[C]hyperref\f[R], +\f[C]xcolor\f[R] (with \f[C]colorlinks\f[R]), \f[C]ulem\f[R], +\f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable set), +\f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and \f[C]babel\f[R] +(with \f[C]lang\f[R]). +The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the LaTeX engine +requires \f[C]fontspec\f[R]. +\f[C]xelatex\f[R] uses \f[C]polyglossia\f[R] (with \f[C]lang\f[R]), +\f[C]xecjk\f[R], and \f[C]bidi\f[R] (with the \f[C]dir\f[R] variable +set). +If the \f[C]mathspec\f[R] variable is set, \f[C]xelatex\f[R] will use +\f[C]mathspec\f[R] instead of \f[C]unicode\-math\f[R]. +The \f[C]upquote\f[R] and \f[C]microtype\f[R] packages are used if +available, and \f[C]csquotes\f[R] will be used for typography if +\f[C]\[rs]usepackage{csquotes}\f[R] is present in the template or +included via \f[C]/H/\-\-include\-in\-header\f[R]. +The \f[C]natbib\f[R], \f[C]biblatex\f[R], \f[C]bibtex\f[R], and +\f[C]biber\f[R] packages can optionally be used for citation rendering. .SS Reading from the Web .PP Instead of an input file, an absolute URI may be given. @@ -200,7 +202,7 @@ In this case pandoc will fetch the content using HTTP: .nf \f[C] pandoc\ \-f\ html\ \-t\ markdown\ http://www.fsf.org -\f[] +\f[R] .fi .PP It is possible to supply a custom User\-Agent string or other header @@ -208,202 +210,203 @@ when requesting a document from a URL: .IP .nf \f[C] -pandoc\ \-f\ html\ \-t\ markdown\ \-\-request\-header\ User\-Agent:"Mozilla/5.0"\ \\ +pandoc\ \-f\ html\ \-t\ markdown\ \-\-request\-header\ User\-Agent:\[dq]Mozilla/5.0\[dq]\ \[rs] \ \ http://www.fsf.org -\f[] +\f[R] .fi .SH OPTIONS .SS General options .TP -.B \f[C]\-f\f[] \f[I]FORMAT\f[], \f[C]\-r\f[] \f[I]FORMAT\f[], \f[C]\-\-from=\f[]\f[I]FORMAT\f[], \f[C]\-\-read=\f[]\f[I]FORMAT\f[] +.B \f[C]\-f\f[R] \f[I]FORMAT\f[R], \f[C]\-r\f[R] \f[I]FORMAT\f[R], \f[C]\-\-from=\f[R]\f[I]FORMAT\f[R], \f[C]\-\-read=\f[R]\f[I]FORMAT\f[R] Specify input format. -\f[I]FORMAT\f[] can be: +\f[I]FORMAT\f[R] can be: .RS .IP \[bu] 2 -\f[C]commonmark\f[] (CommonMark Markdown) +\f[C]commonmark\f[R] (CommonMark Markdown) .IP \[bu] 2 -\f[C]creole\f[] (Creole 1.0) +\f[C]creole\f[R] (Creole 1.0) .IP \[bu] 2 -\f[C]docbook\f[] (DocBook) +\f[C]docbook\f[R] (DocBook) .IP \[bu] 2 -\f[C]docx\f[] (Word docx) +\f[C]docx\f[R] (Word docx) .IP \[bu] 2 -\f[C]epub\f[] (EPUB) +\f[C]epub\f[R] (EPUB) .IP \[bu] 2 -\f[C]fb2\f[] (FictionBook2 e\-book) +\f[C]fb2\f[R] (FictionBook2 e\-book) .IP \[bu] 2 -\f[C]gfm\f[] (GitHub\-Flavored Markdown), or the deprecated and less -accurate \f[C]markdown_github\f[]; use \f[C]markdown_github\f[] only if -you need extensions not supported in \f[C]gfm\f[]. +\f[C]gfm\f[R] (GitHub\-Flavored Markdown), or the deprecated and less +accurate \f[C]markdown_github\f[R]; use \f[C]markdown_github\f[R] only +if you need extensions not supported in \f[C]gfm\f[R]. .IP \[bu] 2 -\f[C]haddock\f[] (Haddock markup) +\f[C]haddock\f[R] (Haddock markup) .IP \[bu] 2 -\f[C]html\f[] (HTML) +\f[C]html\f[R] (HTML) .IP \[bu] 2 -\f[C]jats\f[] (JATS XML) +\f[C]jats\f[R] (JATS XML) .IP \[bu] 2 -\f[C]json\f[] (JSON version of native AST) +\f[C]json\f[R] (JSON version of native AST) .IP \[bu] 2 -\f[C]latex\f[] (LaTeX) +\f[C]latex\f[R] (LaTeX) .IP \[bu] 2 -\f[C]markdown\f[] (Pandoc\[aq]s Markdown) +\f[C]markdown\f[R] (Pandoc\[aq]s Markdown) .IP \[bu] 2 -\f[C]markdown_mmd\f[] (MultiMarkdown) +\f[C]markdown_mmd\f[R] (MultiMarkdown) .IP \[bu] 2 -\f[C]markdown_phpextra\f[] (PHP Markdown Extra) +\f[C]markdown_phpextra\f[R] (PHP Markdown Extra) .IP \[bu] 2 -\f[C]markdown_strict\f[] (original unextended Markdown) +\f[C]markdown_strict\f[R] (original unextended Markdown) .IP \[bu] 2 -\f[C]mediawiki\f[] (MediaWiki markup) +\f[C]mediawiki\f[R] (MediaWiki markup) .IP \[bu] 2 -\f[C]muse\f[] (Muse) +\f[C]muse\f[R] (Muse) .IP \[bu] 2 -\f[C]native\f[] (native Haskell) +\f[C]native\f[R] (native Haskell) .IP \[bu] 2 -\f[C]odt\f[] (ODT) +\f[C]odt\f[R] (ODT) .IP \[bu] 2 -\f[C]opml\f[] (OPML) +\f[C]opml\f[R] (OPML) .IP \[bu] 2 -\f[C]org\f[] (Emacs Org mode) +\f[C]org\f[R] (Emacs Org mode) .IP \[bu] 2 -\f[C]rst\f[] (reStructuredText) +\f[C]rst\f[R] (reStructuredText) .IP \[bu] 2 -\f[C]t2t\f[] (txt2tags) +\f[C]t2t\f[R] (txt2tags) .IP \[bu] 2 -\f[C]textile\f[] (Textile) +\f[C]textile\f[R] (Textile) .IP \[bu] 2 -\f[C]tikiwiki\f[] (TikiWiki markup) +\f[C]tikiwiki\f[R] (TikiWiki markup) .IP \[bu] 2 -\f[C]twiki\f[] (TWiki markup) +\f[C]twiki\f[R] (TWiki markup) .IP \[bu] 2 -\f[C]vimwiki\f[] (Vimwiki) +\f[C]vimwiki\f[R] (Vimwiki) .PP Extensions can be individually enabled or disabled by appending -\f[C]+EXTENSION\f[] or \f[C]\-EXTENSION\f[] to the format name. +\f[C]+EXTENSION\f[R] or \f[C]\-EXTENSION\f[R] to the format name. See Extensions below, for a list of extensions and their names. -See \f[C]\-\-list\-input\-formats\f[] and \f[C]\-\-list\-extensions\f[], -below. +See \f[C]\-\-list\-input\-formats\f[R] and +\f[C]\-\-list\-extensions\f[R], below. .RE .TP -.B \f[C]\-t\f[] \f[I]FORMAT\f[], \f[C]\-w\f[] \f[I]FORMAT\f[], \f[C]\-\-to=\f[]\f[I]FORMAT\f[], \f[C]\-\-write=\f[]\f[I]FORMAT\f[] +.B \f[C]\-t\f[R] \f[I]FORMAT\f[R], \f[C]\-w\f[R] \f[I]FORMAT\f[R], \f[C]\-\-to=\f[R]\f[I]FORMAT\f[R], \f[C]\-\-write=\f[R]\f[I]FORMAT\f[R] Specify output format. -\f[I]FORMAT\f[] can be: +\f[I]FORMAT\f[R] can be: .RS .IP \[bu] 2 -\f[C]asciidoc\f[] (AsciiDoc) +\f[C]asciidoc\f[R] (AsciiDoc) .IP \[bu] 2 -\f[C]beamer\f[] (LaTeX beamer slide show) +\f[C]beamer\f[R] (LaTeX beamer slide show) .IP \[bu] 2 -\f[C]commonmark\f[] (CommonMark Markdown) +\f[C]commonmark\f[R] (CommonMark Markdown) .IP \[bu] 2 -\f[C]context\f[] (ConTeXt) +\f[C]context\f[R] (ConTeXt) .IP \[bu] 2 -\f[C]docbook\f[] or \f[C]docbook4\f[] (DocBook 4) +\f[C]docbook\f[R] or \f[C]docbook4\f[R] (DocBook 4) .IP \[bu] 2 -\f[C]docbook5\f[] (DocBook 5) +\f[C]docbook5\f[R] (DocBook 5) .IP \[bu] 2 -\f[C]docx\f[] (Word docx) +\f[C]docx\f[R] (Word docx) .IP \[bu] 2 -\f[C]dokuwiki\f[] (DokuWiki markup) +\f[C]dokuwiki\f[R] (DokuWiki markup) .IP \[bu] 2 -\f[C]epub\f[] or \f[C]epub3\f[] (EPUB v3 book) +\f[C]epub\f[R] or \f[C]epub3\f[R] (EPUB v3 book) .IP \[bu] 2 -\f[C]epub2\f[] (EPUB v2) +\f[C]epub2\f[R] (EPUB v2) .IP \[bu] 2 -\f[C]fb2\f[] (FictionBook2 e\-book) +\f[C]fb2\f[R] (FictionBook2 e\-book) .IP \[bu] 2 -\f[C]gfm\f[] (GitHub\-Flavored Markdown), or the deprecated and less -accurate \f[C]markdown_github\f[]; use \f[C]markdown_github\f[] only if -you need extensions not supported in \f[C]gfm\f[]. +\f[C]gfm\f[R] (GitHub\-Flavored Markdown), or the deprecated and less +accurate \f[C]markdown_github\f[R]; use \f[C]markdown_github\f[R] only +if you need extensions not supported in \f[C]gfm\f[R]. .IP \[bu] 2 -\f[C]haddock\f[] (Haddock markup) +\f[C]haddock\f[R] (Haddock markup) .IP \[bu] 2 -\f[C]html\f[] or \f[C]html5\f[] (HTML, i.e. +\f[C]html\f[R] or \f[C]html5\f[R] (HTML, i.e. HTML5/XHTML polyglot markup) .IP \[bu] 2 -\f[C]html4\f[] (XHTML 1.0 Transitional) +\f[C]html4\f[R] (XHTML 1.0 Transitional) .IP \[bu] 2 -\f[C]icml\f[] (InDesign ICML) +\f[C]icml\f[R] (InDesign ICML) .IP \[bu] 2 -\f[C]jats\f[] (JATS XML) +\f[C]jats\f[R] (JATS XML) .IP \[bu] 2 -\f[C]json\f[] (JSON version of native AST) +\f[C]json\f[R] (JSON version of native AST) .IP \[bu] 2 -\f[C]latex\f[] (LaTeX) +\f[C]latex\f[R] (LaTeX) .IP \[bu] 2 -\f[C]man\f[] (groff man) +\f[C]man\f[R] (groff man) .IP \[bu] 2 -\f[C]markdown\f[] (Pandoc\[aq]s Markdown) +\f[C]markdown\f[R] (Pandoc\[aq]s Markdown) .IP \[bu] 2 -\f[C]markdown_mmd\f[] (MultiMarkdown) +\f[C]markdown_mmd\f[R] (MultiMarkdown) .IP \[bu] 2 -\f[C]markdown_phpextra\f[] (PHP Markdown Extra) +\f[C]markdown_phpextra\f[R] (PHP Markdown Extra) .IP \[bu] 2 -\f[C]markdown_strict\f[] (original unextended Markdown) +\f[C]markdown_strict\f[R] (original unextended Markdown) .IP \[bu] 2 -\f[C]mediawiki\f[] (MediaWiki markup) +\f[C]mediawiki\f[R] (MediaWiki markup) .IP \[bu] 2 -\f[C]ms\f[] (groff ms) +\f[C]ms\f[R] (groff ms) .IP \[bu] 2 -\f[C]muse\f[] (Muse), +\f[C]muse\f[R] (Muse), .IP \[bu] 2 -\f[C]native\f[] (native Haskell), +\f[C]native\f[R] (native Haskell), .IP \[bu] 2 -\f[C]odt\f[] (OpenOffice text document) +\f[C]odt\f[R] (OpenOffice text document) .IP \[bu] 2 -\f[C]opml\f[] (OPML) +\f[C]opml\f[R] (OPML) .IP \[bu] 2 -\f[C]opendocument\f[] (OpenDocument) +\f[C]opendocument\f[R] (OpenDocument) .IP \[bu] 2 -\f[C]org\f[] (Emacs Org mode) +\f[C]org\f[R] (Emacs Org mode) .IP \[bu] 2 -\f[C]plain\f[] (plain text), +\f[C]plain\f[R] (plain text), .IP \[bu] 2 -\f[C]pptx\f[] (PowerPoint slide show) +\f[C]pptx\f[R] (PowerPoint slide show) .IP \[bu] 2 -\f[C]rst\f[] (reStructuredText) +\f[C]rst\f[R] (reStructuredText) .IP \[bu] 2 -\f[C]rtf\f[] (Rich Text Format) +\f[C]rtf\f[R] (Rich Text Format) .IP \[bu] 2 -\f[C]texinfo\f[] (GNU Texinfo) +\f[C]texinfo\f[R] (GNU Texinfo) .IP \[bu] 2 -\f[C]textile\f[] (Textile) +\f[C]textile\f[R] (Textile) .IP \[bu] 2 -\f[C]slideous\f[] (Slideous HTML and JavaScript slide show) +\f[C]slideous\f[R] (Slideous HTML and JavaScript slide show) .IP \[bu] 2 -\f[C]slidy\f[] (Slidy HTML and JavaScript slide show) +\f[C]slidy\f[R] (Slidy HTML and JavaScript slide show) .IP \[bu] 2 -\f[C]dzslides\f[] (DZSlides HTML5 + JavaScript slide show), +\f[C]dzslides\f[R] (DZSlides HTML5 + JavaScript slide show), .IP \[bu] 2 -\f[C]revealjs\f[] (reveal.js HTML5 + JavaScript slide show) +\f[C]revealjs\f[R] (reveal.js HTML5 + JavaScript slide show) .IP \[bu] 2 -\f[C]s5\f[] (S5 HTML and JavaScript slide show) +\f[C]s5\f[R] (S5 HTML and JavaScript slide show) .IP \[bu] 2 -\f[C]tei\f[] (TEI Simple) +\f[C]tei\f[R] (TEI Simple) .IP \[bu] 2 -\f[C]zimwiki\f[] (ZimWiki markup) +\f[C]zimwiki\f[R] (ZimWiki markup) .IP \[bu] 2 the path of a custom lua writer, see Custom writers below .PP -Note that \f[C]odt\f[], \f[C]docx\f[], and \f[C]epub\f[] output will not -be directed to \f[I]stdout\f[] unless forced with \f[C]\-o\ \-\f[]. +Note that \f[C]odt\f[R], \f[C]docx\f[R], and \f[C]epub\f[R] output will +not be directed to \f[I]stdout\f[R] unless forced with +\f[C]\-o\ \-\f[R]. .PP Extensions can be individually enabled or disabled by appending -\f[C]+EXTENSION\f[] or \f[C]\-EXTENSION\f[] to the format name. +\f[C]+EXTENSION\f[R] or \f[C]\-EXTENSION\f[R] to the format name. See Extensions below, for a list of extensions and their names. -See \f[C]\-\-list\-output\-formats\f[] and -\f[C]\-\-list\-extensions\f[], below. +See \f[C]\-\-list\-output\-formats\f[R] and +\f[C]\-\-list\-extensions\f[R], below. .RE .TP -.B \f[C]\-o\f[] \f[I]FILE\f[], \f[C]\-\-output=\f[]\f[I]FILE\f[] -Write output to \f[I]FILE\f[] instead of \f[I]stdout\f[]. -If \f[I]FILE\f[] is \f[C]\-\f[], output will go to \f[I]stdout\f[], even -if a non\-textual format (\f[C]docx\f[], \f[C]odt\f[], \f[C]epub2\f[], -\f[C]epub3\f[]) is specified. +.B \f[C]\-o\f[R] \f[I]FILE\f[R], \f[C]\-\-output=\f[R]\f[I]FILE\f[R] +Write output to \f[I]FILE\f[R] instead of \f[I]stdout\f[R]. +If \f[I]FILE\f[R] is \f[C]\-\f[R], output will go to \f[I]stdout\f[R], +even if a non\-textual format (\f[C]docx\f[R], \f[C]odt\f[R], +\f[C]epub2\f[R], \f[C]epub3\f[R]) is specified. .RS .RE .TP -.B \f[C]\-\-data\-dir=\f[]\f[I]DIRECTORY\f[] +.B \f[C]\-\-data\-dir=\f[R]\f[I]DIRECTORY\f[R] 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. @@ -413,131 +416,131 @@ This is, in UNIX: .nf \f[C] $HOME/.pandoc -\f[] +\f[R] .fi .PP in Windows XP: .IP .nf \f[C] -C:\\Documents\ And\ Settings\\USERNAME\\Application\ Data\\pandoc -\f[] +C:\[rs]Documents\ And\ Settings\[rs]USERNAME\[rs]Application\ Data\[rs]pandoc +\f[R] .fi .PP and in Windows Vista or later: .IP .nf \f[C] -C:\\Users\\USERNAME\\AppData\\Roaming\\pandoc -\f[] +C:\[rs]Users\[rs]USERNAME\[rs]AppData\[rs]Roaming\[rs]pandoc +\f[R] .fi .PP You can find the default user data directory on your system by looking -at the output of \f[C]pandoc\ \-\-version\f[]. -A \f[C]reference.odt\f[], \f[C]reference.docx\f[], \f[C]epub.css\f[], -\f[C]templates\f[], \f[C]slidy\f[], \f[C]slideous\f[], or \f[C]s5\f[] -directory placed in this directory will override pandoc\[aq]s normal -defaults. +at the output of \f[C]pandoc\ \-\-version\f[R]. +A \f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R], +\f[C]templates\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], or +\f[C]s5\f[R] directory placed in this directory will override +pandoc\[aq]s normal defaults. .RE .TP -.B \f[C]\-\-bash\-completion\f[] +.B \f[C]\-\-bash\-completion\f[R] Generate a bash completion script. To enable bash completion with pandoc, add this to your -\f[C]\&.bashrc\f[]: +\f[C]\&.bashrc\f[R]: .RS .IP .nf \f[C] -eval\ "$(pandoc\ \-\-bash\-completion)" -\f[] +eval\ \[dq]$(pandoc\ \-\-bash\-completion)\[dq] +\f[R] .fi .RE .TP -.B \f[C]\-\-verbose\f[] +.B \f[C]\-\-verbose\f[R] Give verbose debugging output. Currently this only has an effect with PDF output. .RS .RE .TP -.B \f[C]\-\-quiet\f[] +.B \f[C]\-\-quiet\f[R] Suppress warning messages. .RS .RE .TP -.B \f[C]\-\-fail\-if\-warnings\f[] +.B \f[C]\-\-fail\-if\-warnings\f[R] Exit with error status if there are any warnings. .RS .RE .TP -.B \f[C]\-\-log=\f[]\f[I]FILE\f[] -Write log messages in machine\-readable JSON format to \f[I]FILE\f[]. +.B \f[C]\-\-log=\f[R]\f[I]FILE\f[R] +Write log messages in machine\-readable JSON format to \f[I]FILE\f[R]. All messages above DEBUG level will be written, regardless of verbosity -settings (\f[C]\-\-verbose\f[], \f[C]\-\-quiet\f[]). +settings (\f[C]\-\-verbose\f[R], \f[C]\-\-quiet\f[R]). .RS .RE .TP -.B \f[C]\-\-list\-input\-formats\f[] +.B \f[C]\-\-list\-input\-formats\f[R] List supported input formats, one per line. .RS .RE .TP -.B \f[C]\-\-list\-output\-formats\f[] +.B \f[C]\-\-list\-output\-formats\f[R] List supported output formats, one per line. .RS .RE .TP -.B \f[C]\-\-list\-extensions\f[][\f[C]=\f[]\f[I]FORMAT\f[]] -List supported extensions, one per line, preceded by a \f[C]+\f[] or -\f[C]\-\f[] indicating whether it is enabled by default in -\f[I]FORMAT\f[]. -If \f[I]FORMAT\f[] is not specified, defaults for pandoc\[aq]s Markdown +.B \f[C]\-\-list\-extensions\f[R][\f[C]=\f[R]\f[I]FORMAT\f[R]] +List supported extensions, one per line, preceded by a \f[C]+\f[R] or +\f[C]\-\f[R] indicating whether it is enabled by default in +\f[I]FORMAT\f[R]. +If \f[I]FORMAT\f[R] is not specified, defaults for pandoc\[aq]s Markdown are given. .RS .RE .TP -.B \f[C]\-\-list\-highlight\-languages\f[] +.B \f[C]\-\-list\-highlight\-languages\f[R] List supported languages for syntax highlighting, one per line. .RS .RE .TP -.B \f[C]\-\-list\-highlight\-styles\f[] +.B \f[C]\-\-list\-highlight\-styles\f[R] List supported styles for syntax highlighting, one per line. -See \f[C]\-\-highlight\-style\f[]. +See \f[C]\-\-highlight\-style\f[R]. .RS .RE .TP -.B \f[C]\-v\f[], \f[C]\-\-version\f[] +.B \f[C]\-v\f[R], \f[C]\-\-version\f[R] Print version. .RS .RE .TP -.B \f[C]\-h\f[], \f[C]\-\-help\f[] +.B \f[C]\-h\f[R], \f[C]\-\-help\f[R] Show usage message. .RS .RE .SS Reader options .TP -.B \f[C]\-\-base\-header\-level=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-base\-header\-level=\f[R]\f[I]NUMBER\f[R] Specify the base level for headers (defaults to 1). .RS .RE .TP -.B \f[C]\-\-strip\-empty\-paragraphs\f[] +.B \f[C]\-\-strip\-empty\-paragraphs\f[R] \f[I]Deprecated. Use the \f[CI]+empty_paragraphs\f[I] extension -instead.\f[] Ignore paragraphs with no content. +instead.\f[R] Ignore paragraphs with no content. This option is useful for converting word processing documents where users have used empty paragraphs to create inter\-paragraph space. .RS .RE .TP -.B \f[C]\-\-indented\-code\-classes=\f[]\f[I]CLASSES\f[] +.B \f[C]\-\-indented\-code\-classes=\f[R]\f[I]CLASSES\f[R] Specify classes to use for indented code blocks\-\-for example, -\f[C]perl,numberLines\f[] or \f[C]haskell\f[]. +\f[C]perl,numberLines\f[R] or \f[C]haskell\f[R]. Multiple classes may be separated by spaces or commas. .RS .RE .TP -.B \f[C]\-\-default\-image\-extension=\f[]\f[I]EXTENSION\f[] +.B \f[C]\-\-default\-image\-extension=\f[R]\f[I]EXTENSION\f[R] 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 @@ -546,16 +549,17 @@ Currently this option only affects the Markdown and LaTeX readers. .RS .RE .TP -.B \f[C]\-\-file\-scope\f[] +.B \f[C]\-\-file\-scope\f[R] 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 \f[C]\-\-file\-scope\f[]. +Reading binary files (docx, odt, epub) implies +\f[C]\-\-file\-scope\f[R]. .RS .RE .TP -.B \f[C]\-F\f[] \f[I]PROGRAM\f[], \f[C]\-\-filter=\f[]\f[I]PROGRAM\f[] +.B \f[C]\-F\f[R] \f[I]PROGRAM\f[R], \f[C]\-\-filter=\f[R]\f[I]PROGRAM\f[R] 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. @@ -568,7 +572,7 @@ Hence, .nf \f[C] pandoc\ \-\-filter\ ./caps.py\ \-t\ latex -\f[] +\f[R] .fi .PP is equivalent to @@ -576,16 +580,16 @@ is equivalent to .nf \f[C] pandoc\ \-t\ json\ |\ ./caps.py\ latex\ |\ pandoc\ \-f\ json\ \-t\ latex -\f[] +\f[R] .fi .PP The latter form may be useful for debugging filters. .PP Filters may be written in any language. -\f[C]Text.Pandoc.JSON\f[] exports \f[C]toJSONFilter\f[] to facilitate +\f[C]Text.Pandoc.JSON\f[R] exports \f[C]toJSONFilter\f[R] to facilitate writing filters in Haskell. Those who would prefer to write filters in python can use the module -\f[C]pandocfilters\f[], installable from PyPI. +\f[C]pandocfilters\f[R], installable from PyPI. There are also pandoc filter libraries in PHP, perl, and JavaScript/node.js. .PP @@ -593,19 +597,19 @@ In order of preference, pandoc will look for filters in .IP "1." 3 a specified full or relative path (executable or non\-executable) .IP "2." 3 -\f[C]$DATADIR/filters\f[] (executable or non\-executable) where -\f[C]$DATADIR\f[] is the user data directory (see -\f[C]\-\-data\-dir\f[], above). +\f[C]$DATADIR/filters\f[R] (executable or non\-executable) where +\f[C]$DATADIR\f[R] is the user data directory (see +\f[C]\-\-data\-dir\f[R], above). .IP "3." 3 -\f[C]$PATH\f[] (executable only) +\f[C]$PATH\f[R] (executable only) .PP Filters and lua\-filters are applied in the order specified on the command line. .RE .TP -.B \f[C]\-\-lua\-filter=\f[]\f[I]SCRIPT\f[] +.B \f[C]\-\-lua\-filter=\f[R]\f[I]SCRIPT\f[R] Transform the document in a similar fashion as JSON filters (see -\f[C]\-\-filter\f[]), but use pandoc\[aq]s build\-in lua filtering +\f[C]\-\-filter\f[R]), but use pandoc\[aq]s build\-in lua filtering system. The given lua script is expected to return a list of lua filters which will be applied in order. @@ -614,7 +618,7 @@ the name of the AST element on which the filter function should be applied. .RS .PP -The \f[C]pandoc\f[] lua module provides helper functions for element +The \f[C]pandoc\f[R] lua module provides helper functions for element creation. It is always loaded into the script\[aq]s lua environment. .PP @@ -624,88 +628,88 @@ The following is an example lua script for macro\-expansion: \f[C] function\ expand_hello_world(inline) \ \ if\ inline.c\ ==\ \[aq]{{helloworld}}\[aq]\ then -\ \ \ \ return\ pandoc.Emph{\ pandoc.Str\ "Hello,\ World"\ } +\ \ \ \ return\ pandoc.Emph{\ pandoc.Str\ \[dq]Hello,\ World\[dq]\ } \ \ else \ \ \ \ return\ inline \ \ end end return\ {{Str\ =\ expand_hello_world}} -\f[] +\f[R] .fi .PP In order of preference, pandoc will look for lua filters in .IP "1." 3 a specified full or relative path (executable or non\-executable) .IP "2." 3 -\f[C]$DATADIR/filters\f[] (executable or non\-executable) where -\f[C]$DATADIR\f[] is the user data directory (see -\f[C]\-\-data\-dir\f[], above). +\f[C]$DATADIR/filters\f[R] (executable or non\-executable) where +\f[C]$DATADIR\f[R] is the user data directory (see +\f[C]\-\-data\-dir\f[R], above). .RE .TP -.B \f[C]\-M\f[] \f[I]KEY\f[][\f[C]=\f[]\f[I]VAL\f[]], \f[C]\-\-metadata=\f[]\f[I]KEY\f[][\f[C]:\f[]\f[I]VAL\f[]] -Set the metadata field \f[I]KEY\f[] to the value \f[I]VAL\f[]. +.B \f[C]\-M\f[R] \f[I]KEY\f[R][\f[C]=\f[R]\f[I]VAL\f[R]], \f[C]\-\-metadata=\f[R]\f[I]KEY\f[R][\f[C]:\f[R]\f[I]VAL\f[R]] +Set the metadata field \f[I]KEY\f[R] to the value \f[I]VAL\f[R]. A value specified on the command line overrides a value specified in the document using YAML metadata blocks. Values will be parsed as YAML boolean or string values. If no value is specified, the value will be treated as Boolean true. -Like \f[C]\-\-variable\f[], \f[C]\-\-metadata\f[] causes template +Like \f[C]\-\-variable\f[R], \f[C]\-\-metadata\f[R] causes template variables to be set. -But unlike \f[C]\-\-variable\f[], \f[C]\-\-metadata\f[] affects the +But unlike \f[C]\-\-variable\f[R], \f[C]\-\-metadata\f[R] 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. .RS .RE .TP -.B \f[C]\-\-metadata\-file=\f[]\f[I]FILE\f[] +.B \f[C]\-\-metadata\-file=\f[R]\f[I]FILE\f[R] Read metadata from the supplied YAML (or JSON) file. This option can be used with every input format, but string scalars in the YAML file will always be parsed as Markdown. Generally, the input will be handled the same as in YAML metadata blocks. -Metadata values specified inside the document, or by using \f[C]\-M\f[], -overwrite values specified with this option. +Metadata values specified inside the document, or by using +\f[C]\-M\f[R], overwrite values specified with this option. .RS .RE .TP -.B \f[C]\-p\f[], \f[C]\-\-preserve\-tabs\f[] +.B \f[C]\-p\f[R], \f[C]\-\-preserve\-tabs\f[R] Preserve tabs instead of converting them to spaces (the default). Note that this will only affect tabs in literal code spans and code blocks; tabs in regular text will be treated as spaces. .RS .RE .TP -.B \f[C]\-\-tab\-stop=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-tab\-stop=\f[R]\f[I]NUMBER\f[R] Specify the number of spaces per tab (default is 4). .RS .RE .TP -.B \f[C]\-\-track\-changes=accept\f[]|\f[C]reject\f[]|\f[C]all\f[] +.B \f[C]\-\-track\-changes=accept\f[R]|\f[C]reject\f[R]|\f[C]all\f[R] Specifies what to do with insertions, deletions, and comments produced -by the MS Word "Track Changes" feature. -\f[C]accept\f[] (the default), inserts all insertions, and ignores all +by the MS Word \[dq]Track Changes\[dq] feature. +\f[C]accept\f[R] (the default), inserts all insertions, and ignores all deletions. -\f[C]reject\f[] inserts all deletions and ignores insertions. -Both \f[C]accept\f[] and \f[C]reject\f[] ignore comments. -\f[C]all\f[] puts in insertions, deletions, and comments, wrapped in -spans with \f[C]insertion\f[], \f[C]deletion\f[], -\f[C]comment\-start\f[], and \f[C]comment\-end\f[] classes, +\f[C]reject\f[R] inserts all deletions and ignores insertions. +Both \f[C]accept\f[R] and \f[C]reject\f[R] ignore comments. +\f[C]all\f[R] puts in insertions, deletions, and comments, wrapped in +spans with \f[C]insertion\f[R], \f[C]deletion\f[R], +\f[C]comment\-start\f[R], and \f[C]comment\-end\f[R] classes, respectively. The author and time of change is included. -\f[C]all\f[] is useful for scripting: only accepting changes from a +\f[C]all\f[R] is useful for scripting: only accepting changes from a certain reviewer, say, or before a certain date. -If a paragraph is inserted or deleted, \f[C]track\-changes=all\f[] +If a paragraph is inserted or deleted, \f[C]track\-changes=all\f[R] produces a span with the class -\f[C]paragraph\-insertion\f[]/\f[C]paragraph\-deletion\f[] before the +\f[C]paragraph\-insertion\f[R]/\f[C]paragraph\-deletion\f[R] before the affected paragraph break. This option only affects the docx reader. .RS .RE .TP -.B \f[C]\-\-extract\-media=\f[]\f[I]DIR\f[] +.B \f[C]\-\-extract\-media=\f[R]\f[I]DIR\f[R] Extract images and other media contained in or linked from the source -document to the path \f[I]DIR\f[], creating it if necessary, and adjust +document to the path \f[I]DIR\f[R], creating it if necessary, and adjust the images references in the document so they point to the extracted files. If the source format is a binary container (docx, epub, or odt), the @@ -716,13 +720,13 @@ filenames are constructed based on SHA1 hashes of the contents. .RS .RE .TP -.B \f[C]\-\-abbreviations=\f[]\f[I]FILE\f[] +.B \f[C]\-\-abbreviations=\f[R]\f[I]FILE\f[R] Specifies a custom abbreviations file, with abbreviations one to a line. If this option is not specified, pandoc will read the data file -\f[C]abbreviations\f[] from the user data directory or fall back on a +\f[C]abbreviations\f[R] from the user data directory or fall back on a system default. To see the system default, use -\f[C]pandoc\ \-\-print\-default\-data\-file=abbreviations\f[]. +\f[C]pandoc\ \-\-print\-default\-data\-file=abbreviations\f[R]. The only use pandoc makes of this list is in the Markdown reader. Strings ending in a period that are found in this list will be followed by a nonbreaking space, so that the period will not produce @@ -731,65 +735,66 @@ sentence\-ending space in formats like LaTeX. .RE .SS General writer options .TP -.B \f[C]\-s\f[], \f[C]\-\-standalone\f[] +.B \f[C]\-s\f[R], \f[C]\-\-standalone\f[R] 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 \f[C]pdf\f[], \f[C]epub\f[], -\f[C]epub3\f[], \f[C]fb2\f[], \f[C]docx\f[], and \f[C]odt\f[] output. -For \f[C]native\f[] output, this option causes metadata to be included; +This option is set automatically for \f[C]pdf\f[R], \f[C]epub\f[R], +\f[C]epub3\f[R], \f[C]fb2\f[R], \f[C]docx\f[R], and \f[C]odt\f[R] +output. +For \f[C]native\f[R] output, this option causes metadata to be included; otherwise, metadata is suppressed. .RS .RE .TP -.B \f[C]\-\-template=\f[]\f[I]FILE\f[]|\f[I]URL\f[] +.B \f[C]\-\-template=\f[R]\f[I]FILE\f[R]|\f[I]URL\f[R] Use the specified file as a custom template for the generated document. -Implies \f[C]\-\-standalone\f[]. +Implies \f[C]\-\-standalone\f[R]. See Templates, below, for a description of template syntax. If no extension is specified, an extension corresponding to the writer -will be added, so that \f[C]\-\-template=special\f[] looks for -\f[C]special.html\f[] for HTML output. +will be added, so that \f[C]\-\-template=special\f[R] looks for +\f[C]special.html\f[R] for HTML output. If the template is not found, pandoc will search for it in the -\f[C]templates\f[] subdirectory of the user data directory (see -\f[C]\-\-data\-dir\f[]). +\f[C]templates\f[R] subdirectory of the user data directory (see +\f[C]\-\-data\-dir\f[R]). If this option is not used, a default template appropriate for the output format will be used (see -\f[C]\-D/\-\-print\-default\-template\f[]). +\f[C]\-D/\-\-print\-default\-template\f[R]). .RS .RE .TP -.B \f[C]\-V\f[] \f[I]KEY\f[][\f[C]=\f[]\f[I]VAL\f[]], \f[C]\-\-variable=\f[]\f[I]KEY\f[][\f[C]:\f[]\f[I]VAL\f[]] -Set the template variable \f[I]KEY\f[] to the value \f[I]VAL\f[] when +.B \f[C]\-V\f[R] \f[I]KEY\f[R][\f[C]=\f[R]\f[I]VAL\f[R]], \f[C]\-\-variable=\f[R]\f[I]KEY\f[R][\f[C]:\f[R]\f[I]VAL\f[R]] +Set the template variable \f[I]KEY\f[R] to the value \f[I]VAL\f[R] when rendering the document in standalone mode. -This is generally only useful when the \f[C]\-\-template\f[] option is +This is generally only useful when the \f[C]\-\-template\f[R] option is used to specify a custom template, since pandoc automatically sets the variables used in the default templates. -If no \f[I]VAL\f[] is specified, the key will be given the value -\f[C]true\f[]. +If no \f[I]VAL\f[R] is specified, the key will be given the value +\f[C]true\f[R]. .RS .RE .TP -.B \f[C]\-D\f[] \f[I]FORMAT\f[], \f[C]\-\-print\-default\-template=\f[]\f[I]FORMAT\f[] -Print the system default template for an output \f[I]FORMAT\f[]. -(See \f[C]\-t\f[] for a list of possible \f[I]FORMAT\f[]s.) Templates in -the user data directory are ignored. +.B \f[C]\-D\f[R] \f[I]FORMAT\f[R], \f[C]\-\-print\-default\-template=\f[R]\f[I]FORMAT\f[R] +Print the system default template for an output \f[I]FORMAT\f[R]. +(See \f[C]\-t\f[R] for a list of possible \f[I]FORMAT\f[R]s.) Templates +in the user data directory are ignored. .RS .RE .TP -.B \f[C]\-\-print\-default\-data\-file=\f[]\f[I]FILE\f[] +.B \f[C]\-\-print\-default\-data\-file=\f[R]\f[I]FILE\f[R] Print a system default data file. Files in the user data directory are ignored. .RS .RE .TP -.B \f[C]\-\-eol=crlf\f[]|\f[C]lf\f[]|\f[C]native\f[] -Manually specify line endings: \f[C]crlf\f[] (Windows), \f[C]lf\f[] -(macOS/Linux/UNIX), or \f[C]native\f[] (line endings appropriate to the +.B \f[C]\-\-eol=crlf\f[R]|\f[C]lf\f[R]|\f[C]native\f[R] +Manually specify line endings: \f[C]crlf\f[R] (Windows), \f[C]lf\f[R] +(macOS/Linux/UNIX), or \f[C]native\f[R] (line endings appropriate to the OS on which pandoc is being run). -The default is \f[C]native\f[]. +The default is \f[C]native\f[R]. .RS .RE .TP -.B \f[C]\-\-dpi\f[]=\f[I]NUMBER\f[] +.B \f[C]\-\-dpi\f[R]=\f[I]NUMBER\f[R] Specify the dpi (dots per inch) value for conversion from pixels to inch/centimeters and vice versa. The default is 96dpi. @@ -797,13 +802,13 @@ Technically, the correct term would be ppi (pixels per inch). .RS .RE .TP -.B \f[C]\-\-wrap=auto\f[]|\f[C]none\f[]|\f[C]preserve\f[] +.B \f[C]\-\-wrap=auto\f[R]|\f[C]none\f[R]|\f[C]preserve\f[R] Determine how text is wrapped in the output (the source code, not the rendered version). -With \f[C]auto\f[] (the default), pandoc will attempt to wrap lines to -the column width specified by \f[C]\-\-columns\f[] (default 72). -With \f[C]none\f[], pandoc will not wrap lines at all. -With \f[C]preserve\f[], pandoc will attempt to preserve the wrapping +With \f[C]auto\f[R] (the default), pandoc will attempt to wrap lines to +the column width specified by \f[C]\-\-columns\f[R] (default 72). +With \f[C]none\f[R], pandoc will not wrap lines at all. +With \f[C]preserve\f[R], 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). @@ -811,27 +816,27 @@ Automatic wrapping does not currently work in HTML output. .RS .RE .TP -.B \f[C]\-\-columns=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-columns=\f[R]\f[I]NUMBER\f[R] Specify length of lines in characters. This affects text wrapping in the generated source code (see -\f[C]\-\-wrap\f[]). +\f[C]\-\-wrap\f[R]). It also affects calculation of column widths for plain text tables (see Tables below). .RS .RE .TP -.B \f[C]\-\-toc\f[], \f[C]\-\-table\-of\-contents\f[] +.B \f[C]\-\-toc\f[R], \f[C]\-\-table\-of\-contents\f[R] Include an automatically generated table of contents (or, in the case of -\f[C]latex\f[], \f[C]context\f[], \f[C]docx\f[], \f[C]odt\f[], -\f[C]opendocument\f[], \f[C]rst\f[], or \f[C]ms\f[], an instruction to -create one) in the output document. -This option has no effect unless \f[C]\-s/\-\-standalone\f[] is used, -and it has no effect on \f[C]man\f[], \f[C]docbook4\f[], -\f[C]docbook5\f[], or \f[C]jats\f[] output. +\f[C]latex\f[R], \f[C]context\f[R], \f[C]docx\f[R], \f[C]odt\f[R], +\f[C]opendocument\f[R], \f[C]rst\f[R], or \f[C]ms\f[R], an instruction +to create one) in the output document. +This option has no effect unless \f[C]\-s/\-\-standalone\f[R] is used, +and it has no effect on \f[C]man\f[R], \f[C]docbook4\f[R], +\f[C]docbook5\f[R], or \f[C]jats\f[R] output. .RS .RE .TP -.B \f[C]\-\-toc\-depth=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-toc\-depth=\f[R]\f[I]NUMBER\f[R] 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 headers will be @@ -839,47 +844,47 @@ listed in the contents). .RS .RE .TP -.B \f[C]\-\-strip\-comments\f[] +.B \f[C]\-\-strip\-comments\f[R] 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 -\f[C]markdown_in_html_blocks\f[] extension is not set. +\f[C]markdown_in_html_blocks\f[R] extension is not set. .RS .RE .TP -.B \f[C]\-\-no\-highlight\f[] +.B \f[C]\-\-no\-highlight\f[R] Disables syntax highlighting for code blocks and inlines, even when a language attribute is given. .RS .RE .TP -.B \f[C]\-\-highlight\-style=\f[]\f[I]STYLE\f[]|\f[I]FILE\f[] +.B \f[C]\-\-highlight\-style=\f[R]\f[I]STYLE\f[R]|\f[I]FILE\f[R] Specifies the coloring style to be used in highlighted source code. -Options are \f[C]pygments\f[] (the default), \f[C]kate\f[], -\f[C]monochrome\f[], \f[C]breezeDark\f[], \f[C]espresso\f[], -\f[C]zenburn\f[], \f[C]haddock\f[], and \f[C]tango\f[]. +Options are \f[C]pygments\f[R] (the default), \f[C]kate\f[R], +\f[C]monochrome\f[R], \f[C]breezeDark\f[R], \f[C]espresso\f[R], +\f[C]zenburn\f[R], \f[C]haddock\f[R], and \f[C]tango\f[R]. For more information on syntax highlighting in pandoc, see Syntax highlighting, below. -See also \f[C]\-\-list\-highlight\-styles\f[]. +See also \f[C]\-\-list\-highlight\-styles\f[R]. .RS .PP -Instead of a \f[I]STYLE\f[] name, a JSON file with extension -\f[C]\&.theme\f[] may be supplied. +Instead of a \f[I]STYLE\f[R] name, a JSON file with extension +\f[C]\&.theme\f[R] may be supplied. This will be parsed as a KDE syntax highlighting theme and (if valid) used as the highlighting style. .PP To generate the JSON version of an existing style, use -\f[C]\-\-print\-highlight\-style\f[]. +\f[C]\-\-print\-highlight\-style\f[R]. .RE .TP -.B \f[C]\-\-print\-highlight\-style=\f[]\f[I]STYLE\f[]|\f[I]FILE\f[] +.B \f[C]\-\-print\-highlight\-style=\f[R]\f[I]STYLE\f[R]|\f[I]FILE\f[R] Prints a JSON version of a highlighting style, which can be modified, -saved with a \f[C]\&.theme\f[] extension, and used with -\f[C]\-\-highlight\-style\f[]. +saved with a \f[C]\&.theme\f[R] extension, and used with +\f[C]\-\-highlight\-style\f[R]. .RS .RE .TP -.B \f[C]\-\-syntax\-definition=\f[]\f[I]FILE\f[] +.B \f[C]\-\-syntax\-definition=\f[R]\f[I]FILE\f[R] 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 @@ -887,175 +892,179 @@ syntax definitions for existing languages. .RS .RE .TP -.B \f[C]\-H\f[] \f[I]FILE\f[], \f[C]\-\-include\-in\-header=\f[]\f[I]FILE\f[] -Include contents of \f[I]FILE\f[], verbatim, at the end of the header. +.B \f[C]\-H\f[R] \f[I]FILE\f[R], \f[C]\-\-include\-in\-header=\f[R]\f[I]FILE\f[R] +Include contents of \f[I]FILE\f[R], 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 \f[C]\-\-standalone\f[]. +Implies \f[C]\-\-standalone\f[R]. .RS .RE .TP -.B \f[C]\-B\f[] \f[I]FILE\f[], \f[C]\-\-include\-before\-body=\f[]\f[I]FILE\f[] -Include contents of \f[I]FILE\f[], verbatim, at the beginning of the +.B \f[C]\-B\f[R] \f[I]FILE\f[R], \f[C]\-\-include\-before\-body=\f[R]\f[I]FILE\f[R] +Include contents of \f[I]FILE\f[R], verbatim, at the beginning of the document body (e.g. -after the \f[C]<body>\f[] tag in HTML, or the \f[C]\\begin{document}\f[] -command in LaTeX). +after the \f[C]<body>\f[R] tag in HTML, or the +\f[C]\[rs]begin{document}\f[R] 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 \f[C]\-\-standalone\f[]. +Implies \f[C]\-\-standalone\f[R]. .RS .RE .TP -.B \f[C]\-A\f[] \f[I]FILE\f[], \f[C]\-\-include\-after\-body=\f[]\f[I]FILE\f[] -Include contents of \f[I]FILE\f[], verbatim, at the end of the document -body (before the \f[C]</body>\f[] tag in HTML, or the -\f[C]\\end{document}\f[] command in LaTeX). +.B \f[C]\-A\f[R] \f[I]FILE\f[R], \f[C]\-\-include\-after\-body=\f[R]\f[I]FILE\f[R] +Include contents of \f[I]FILE\f[R], verbatim, at the end of the document +body (before the \f[C]</body>\f[R] tag in HTML, or the +\f[C]\[rs]end{document}\f[R] command in LaTeX). This option can be used repeatedly to include multiple files. They will be included in the order specified. -Implies \f[C]\-\-standalone\f[]. +Implies \f[C]\-\-standalone\f[R]. .RS .RE .TP -.B \f[C]\-\-resource\-path=\f[]\f[I]SEARCHPATH\f[] +.B \f[C]\-\-resource\-path=\f[R]\f[I]SEARCHPATH\f[R] List of paths to search for images and other resources. -The paths should be separated by \f[C]:\f[] on Linux, UNIX, and macOS -systems, and by \f[C];\f[] on Windows. -If \f[C]\-\-resource\-path\f[] is not specified, the default resource +The paths should be separated by \f[C]:\f[R] on Linux, UNIX, and macOS +systems, and by \f[C];\f[R] on Windows. +If \f[C]\-\-resource\-path\f[R] is not specified, the default resource path is the working directory. -Note that, if \f[C]\-\-resource\-path\f[] is specified, the working +Note that, if \f[C]\-\-resource\-path\f[R] is specified, the working directory must be explicitly listed or it will not be searched. -For example: \f[C]\-\-resource\-path=.:test\f[] will search the working -directory and the \f[C]test\f[] subdirectory, in that order. +For example: \f[C]\-\-resource\-path=.:test\f[R] will search the working +directory and the \f[C]test\f[R] subdirectory, in that order. .RS .PP -\f[C]\-\-resource\-path\f[] only has an effect if (a) the output format -embeds images (for example, \f[C]docx\f[], \f[C]pdf\f[], or -\f[C]html\f[] with \f[C]\-\-self\-contained\f[]) or (b) it is used -together with \f[C]\-\-extract\-media\f[]. +\f[C]\-\-resource\-path\f[R] only has an effect if (a) the output format +embeds images (for example, \f[C]docx\f[R], \f[C]pdf\f[R], or +\f[C]html\f[R] with \f[C]\-\-self\-contained\f[R]) or (b) it is used +together with \f[C]\-\-extract\-media\f[R]. .RE .TP -.B \f[C]\-\-request\-header=\f[]\f[I]NAME\f[]\f[C]:\f[]\f[I]VAL\f[] -Set the request header \f[I]NAME\f[] to the value \f[I]VAL\f[] when +.B \f[C]\-\-request\-header=\f[R]\f[I]NAME\f[R]\f[C]:\f[R]\f[I]VAL\f[R] +Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] 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\[aq]re behind a proxy, you also need to set the environment -variable \f[C]http_proxy\f[] to \f[C]http://...\f[]. +variable \f[C]http_proxy\f[R] to \f[C]http://...\f[R]. .RS .RE .SS Options affecting specific writers .TP -.B \f[C]\-\-self\-contained\f[] +.B \f[C]\-\-self\-contained\f[R] Produce a standalone HTML file with no external dependencies, using -\f[C]data:\f[] URIs to incorporate the contents of linked scripts, +\f[C]data:\f[R] URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. -Implies \f[C]\-\-standalone\f[]. -The resulting file should be "self\-contained," in the sense that it -needs no external files and no net access to be displayed properly by a -browser. +Implies \f[C]\-\-standalone\f[R]. +The resulting file should be \[dq]self\-contained,\[dq] 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 -\f[C]html4\f[], \f[C]html5\f[], \f[C]html+lhs\f[], \f[C]html5+lhs\f[], -\f[C]s5\f[], \f[C]slidy\f[], \f[C]slideous\f[], \f[C]dzslides\f[], and -\f[C]revealjs\f[]. +\f[C]html4\f[R], \f[C]html5\f[R], \f[C]html+lhs\f[R], +\f[C]html5+lhs\f[R], \f[C]s5\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], +\f[C]dzslides\f[R], and \f[C]revealjs\f[R]. 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 \f[C]data\-external="1"\f[] will be left -alone; the documents they link to will not be incorporated in the +Elements with the attribute \f[C]data\-external=\[dq]1\[dq]\f[R] 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, \f[C]\-\-self\-contained\f[] does -not work with \f[C]\-\-mathjax\f[], and some advanced features (e.g. -zoom or speaker notes) may not work in an offline "self\-contained" -\f[C]reveal.js\f[] slide show. +cannot be incorporated; as a result, \f[C]\-\-self\-contained\f[R] does +not work with \f[C]\-\-mathjax\f[R], and some advanced features (e.g. +zoom or speaker notes) may not work in an offline +\[dq]self\-contained\[dq] \f[C]reveal.js\f[R] slide show. .RS .RE .TP -.B \f[C]\-\-html\-q\-tags\f[] -Use \f[C]<q>\f[] tags for quotes in HTML. +.B \f[C]\-\-html\-q\-tags\f[R] +Use \f[C]<q>\f[R] tags for quotes in HTML. .RS .RE .TP -.B \f[C]\-\-ascii\f[] +.B \f[C]\-\-ascii\f[R] Use only ASCII characters in output. Currently supported for XML and HTML formats (which use numerical -entities instead of UTF\-8 when this option is selected) and for groff -ms and man (which use hexadecimal escapes). +entities instead of UTF\-8 when this option is selected), groff ms +(which use hexadecimal escapes), and to a limited degree LaTeX (which +uses standard commands for accented characters when possible). +Groff man output uses ASCII by default. .RS .RE .TP -.B \f[C]\-\-reference\-links\f[] +.B \f[C]\-\-reference\-links\f[R] 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 -\f[C]\-\-reference\-location\f[] option. +\f[C]\-\-reference\-location\f[R] option. .RS .RE .TP -.B \f[C]\-\-reference\-location\ =\ block\f[]|\f[C]section\f[]|\f[C]document\f[] -Specify whether footnotes (and references, if \f[C]reference\-links\f[] +.B \f[C]\-\-reference\-location\ =\ block\f[R]|\f[C]section\f[R]|\f[C]document\f[R] +Specify whether footnotes (and references, if \f[C]reference\-links\f[R] is set) are placed at the end of the current (top\-level) block, the current section, or the document. -The default is \f[C]document\f[]. +The default is \f[C]document\f[R]. Currently only affects the markdown writer. .RS .RE .TP -.B \f[C]\-\-atx\-headers\f[] +.B \f[C]\-\-atx\-headers\f[R] Use ATX\-style headers in Markdown and AsciiDoc output. The default is to use setext\-style headers for levels 1\-2, and then ATX headers. -(Note: for \f[C]gfm\f[] output, ATX headers are always used.) +(Note: for \f[C]gfm\f[R] output, ATX headers are always used.) .RS .RE .TP -.B \f[C]\-\-top\-level\-division=[default|section|chapter|part]\f[] +.B \f[C]\-\-top\-level\-division=[default|section|chapter|part]\f[R] Treat top\-level headers as the given division type in LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy order is part, chapter, then section; all headers are shifted such that the top\-level header becomes the specified type. The default behavior is to determine the best division type via -heuristics: unless other conditions apply, \f[C]section\f[] is chosen. -When the LaTeX document class is set to \f[C]report\f[], \f[C]book\f[], -or \f[C]memoir\f[] (unless the \f[C]article\f[] option is specified), -\f[C]chapter\f[] is implied as the setting for this option. -If \f[C]beamer\f[] is the output format, specifying either -\f[C]chapter\f[] or \f[C]part\f[] will cause top\-level headers to -become \f[C]\\part{..}\f[], while second\-level headers remain as their -default type. +heuristics: unless other conditions apply, \f[C]section\f[R] is chosen. +When the LaTeX document class is set to \f[C]report\f[R], +\f[C]book\f[R], or \f[C]memoir\f[R] (unless the \f[C]article\f[R] option +is specified), \f[C]chapter\f[R] is implied as the setting for this +option. +If \f[C]beamer\f[R] is the output format, specifying either +\f[C]chapter\f[R] or \f[C]part\f[R] will cause top\-level headers to +become \f[C]\[rs]part{..}\f[R], while second\-level headers remain as +their default type. .RS .RE .TP -.B \f[C]\-N\f[], \f[C]\-\-number\-sections\f[] +.B \f[C]\-N\f[R], \f[C]\-\-number\-sections\f[R] Number section headings in LaTeX, ConTeXt, HTML, or EPUB output. By default, sections are not numbered. -Sections with class \f[C]unnumbered\f[] will never be numbered, even if -\f[C]\-\-number\-sections\f[] is specified. +Sections with class \f[C]unnumbered\f[R] will never be numbered, even if +\f[C]\-\-number\-sections\f[R] is specified. .RS .RE .TP -.B \f[C]\-\-number\-offset=\f[]\f[I]NUMBER\f[][\f[C],\f[]\f[I]NUMBER\f[]\f[C],\f[]\f[I]...\f[]] +.B \f[C]\-\-number\-offset=\f[R]\f[I]NUMBER\f[R][\f[C],\f[R]\f[I]NUMBER\f[R]\f[C],\f[R]\f[I]...\f[R]] Offset for section headings in HTML output (ignored in other output formats). The first number is added to the section number for top\-level headers, the second for second\-level headers, and so on. So, for example, if you want the first top\-level header in your -document to be numbered "6", specify \f[C]\-\-number\-offset=5\f[]. +document to be numbered \[dq]6\[dq], specify +\f[C]\-\-number\-offset=5\f[R]. If your document starts with a level\-2 header which you want to be -numbered "1.5", specify \f[C]\-\-number\-offset=1,4\f[]. +numbered \[dq]1.5\[dq], specify \f[C]\-\-number\-offset=1,4\f[R]. Offsets are 0 by default. -Implies \f[C]\-\-number\-sections\f[]. +Implies \f[C]\-\-number\-sections\f[R]. .RS .RE .TP -.B \f[C]\-\-listings\f[] -Use the \f[C]listings\f[] package for LaTeX code blocks. +.B \f[C]\-\-listings\f[R] +Use the \f[C]listings\f[R] 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: Encoding issue with the listings @@ -1063,16 +1072,16 @@ package. .RS .RE .TP -.B \f[C]\-i\f[], \f[C]\-\-incremental\f[] +.B \f[C]\-i\f[R], \f[C]\-\-incremental\f[R] Make list items in slide shows display incrementally (one by one). The default is for lists to be displayed all at once. .RS .RE .TP -.B \f[C]\-\-slide\-level=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-slide\-level=\f[R]\f[I]NUMBER\f[R] Specifies that headers with the specified level create slides (for -\f[C]beamer\f[], \f[C]s5\f[], \f[C]slidy\f[], \f[C]slideous\f[], -\f[C]dzslides\f[]). +\f[C]beamer\f[R], \f[C]s5\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], +\f[C]dzslides\f[R]). Headers above this level in the hierarchy are used to divide the slide show into sections; headers below this level create subheads within a slide. @@ -1083,26 +1092,26 @@ document; see Structuring the slide show. .RS .RE .TP -.B \f[C]\-\-section\-divs\f[] -Wrap sections in \f[C]<section>\f[] tags (or \f[C]<div>\f[] tags for -\f[C]html4\f[]), and attach identifiers to the enclosing -\f[C]<section>\f[] (or \f[C]<div>\f[]) rather than the header itself. +.B \f[C]\-\-section\-divs\f[R] +Wrap sections in \f[C]<section>\f[R] tags (or \f[C]<div>\f[R] tags for +\f[C]html4\f[R]), and attach identifiers to the enclosing +\f[C]<section>\f[R] (or \f[C]<div>\f[R]) rather than the header itself. See Header identifiers, below. .RS .RE .TP -.B \f[C]\-\-email\-obfuscation=none\f[]|\f[C]javascript\f[]|\f[C]references\f[] -Specify a method for obfuscating \f[C]mailto:\f[] links in HTML +.B \f[C]\-\-email\-obfuscation=none\f[R]|\f[C]javascript\f[R]|\f[C]references\f[R] +Specify a method for obfuscating \f[C]mailto:\f[R] links in HTML documents. -\f[C]none\f[] leaves \f[C]mailto:\f[] links as they are. -\f[C]javascript\f[] obfuscates them using JavaScript. -\f[C]references\f[] obfuscates them by printing their letters as decimal -or hexadecimal character references. -The default is \f[C]none\f[]. +\f[C]none\f[R] leaves \f[C]mailto:\f[R] links as they are. +\f[C]javascript\f[R] obfuscates them using JavaScript. +\f[C]references\f[R] obfuscates them by printing their letters as +decimal or hexadecimal character references. +The default is \f[C]none\f[R]. .RS .RE .TP -.B \f[C]\-\-id\-prefix=\f[]\f[I]STRING\f[] +.B \f[C]\-\-id\-prefix=\f[R]\f[I]STRING\f[R] 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. @@ -1111,28 +1120,28 @@ fragments to be included in other pages. .RS .RE .TP -.B \f[C]\-T\f[] \f[I]STRING\f[], \f[C]\-\-title\-prefix=\f[]\f[I]STRING\f[] -Specify \f[I]STRING\f[] as a prefix at the beginning of the title that +.B \f[C]\-T\f[R] \f[I]STRING\f[R], \f[C]\-\-title\-prefix=\f[R]\f[I]STRING\f[R] +Specify \f[I]STRING\f[R] 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 \f[C]\-\-standalone\f[]. +Implies \f[C]\-\-standalone\f[R]. .RS .RE .TP -.B \f[C]\-c\f[] \f[I]URL\f[], \f[C]\-\-css=\f[]\f[I]URL\f[] +.B \f[C]\-c\f[R] \f[I]URL\f[R], \f[C]\-\-css=\f[R]\f[I]URL\f[R] Link to a CSS style sheet. This option can be used repeatedly to include multiple files. They will be included in the order specified. .RS .PP A stylesheet is required for generating EPUB. -If none is provided using this option (or the \f[C]stylesheet\f[] -metadata field), pandoc will look for a file \f[C]epub.css\f[] in the -user data directory (see \f[C]\-\-data\-dir\f[]). +If none is provided using this option (or the \f[C]stylesheet\f[R] +metadata field), pandoc will look for a file \f[C]epub.css\f[R] in the +user data directory (see \f[C]\-\-data\-dir\f[R]). If it is not found there, sensible defaults will be used. .RE .TP -.B \f[C]\-\-reference\-doc=\f[]\f[I]FILE\f[] +.B \f[C]\-\-reference\-doc=\f[R]\f[I]FILE\f[R] Use the specified file as a style reference in producing a docx or ODT file. .RS @@ -1144,15 +1153,15 @@ 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 \f[C]reference.docx\f[] in the user data directory (see -\f[C]\-\-data\-dir\f[]). +for a file \f[C]reference.docx\f[R] in the user data directory (see +\f[C]\-\-data\-dir\f[R]). If this is not found either, sensible defaults will be used. .RS .PP -To produce a custom \f[C]reference.docx\f[], first get a copy of the -default \f[C]reference.docx\f[]: -\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.docx\ >\ custom\-reference.docx\f[]. -Then open \f[C]custom\-reference.docx\f[] in Word, modify the styles as +To produce a custom \f[C]reference.docx\f[R], first get a copy of the +default \f[C]reference.docx\f[R]: +\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.docx\ >\ custom\-reference.docx\f[R]. +Then open \f[C]custom\-reference.docx\f[R] 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] Normal, Body Text, First @@ -1171,21 +1180,21 @@ 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 \f[C]reference.odt\f[] in the user data directory (see -\f[C]\-\-data\-dir\f[]). +for a file \f[C]reference.odt\f[R] in the user data directory (see +\f[C]\-\-data\-dir\f[R]). If this is not found either, sensible defaults will be used. .RS .PP -To produce a custom \f[C]reference.odt\f[], first get a copy of the -default \f[C]reference.odt\f[]: -\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.odt\ >\ custom\-reference.odt\f[]. -Then open \f[C]custom\-reference.odt\f[] in LibreOffice, modify the +To produce a custom \f[C]reference.odt\f[R], first get a copy of the +default \f[C]reference.odt\f[R]: +\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.odt\ >\ custom\-reference.odt\f[R]. +Then open \f[C]custom\-reference.odt\f[R] in LibreOffice, modify the styles as you wish, and save the file. .RE .TP .B PowerPoint Any template included with a recent install of Microsoft PowerPoint -(either with \f[C]\&.pptx\f[] or \f[C]\&.potx\f[] extension) should +(either with \f[C]\&.pptx\f[R] or \f[C]\&.potx\f[R] extension) should work, as will most templates derived from these. .RS .PP @@ -1202,27 +1211,27 @@ Two Content .PP All templates included with a recent version of MS PowerPoint will fit these criteria. -(You can click on \f[C]Layout\f[] under the \f[C]Home\f[] menu to +(You can click on \f[C]Layout\f[R] under the \f[C]Home\f[R] menu to check.) .PP -You can also modify the default \f[C]reference.pptx\f[]: first run -\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.pptx\ >\ custom\-reference.pptx\f[], -and then modify \f[C]custom\-reference.pptx\f[] in MS PowerPoint (pandoc -will use the first four layout slides, as mentioned above). +You can also modify the default \f[C]reference.pptx\f[R]: first run +\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.pptx\ >\ custom\-reference.pptx\f[R], +and then modify \f[C]custom\-reference.pptx\f[R] in MS PowerPoint +(pandoc will use the first four layout slides, as mentioned above). .RE .RE .TP -.B \f[C]\-\-epub\-cover\-image=\f[]\f[I]FILE\f[] +.B \f[C]\-\-epub\-cover\-image=\f[R]\f[I]FILE\f[R] 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 -\f[C]cover\-image\f[] in a YAML metadata block (see EPUB Metadata, +\f[C]cover\-image\f[R] in a YAML metadata block (see EPUB Metadata, below). .RS .RE .TP -.B \f[C]\-\-epub\-metadata=\f[]\f[I]FILE\f[] +.B \f[C]\-\-epub\-metadata=\f[R]\f[I]FILE\f[R] Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements. For example: @@ -1232,15 +1241,16 @@ For example: \f[C] \ <dc:rights>Creative\ Commons</dc:rights> \ <dc:language>es\-AR</dc:language> -\f[] +\f[R] .fi .PP By default, pandoc will include the following metadata elements: -\f[C]<dc:title>\f[] (from the document title), \f[C]<dc:creator>\f[] -(from the document authors), \f[C]<dc:date>\f[] (from the document date, -which should be in ISO 8601 format), \f[C]<dc:language>\f[] (from the -\f[C]lang\f[] variable, or, if is not set, the locale), and -\f[C]<dc:identifier\ id="BookId">\f[] (a randomly generated UUID). +\f[C]<dc:title>\f[R] (from the document title), \f[C]<dc:creator>\f[R] +(from the document authors), \f[C]<dc:date>\f[R] (from the document +date, which should be in ISO 8601 format), \f[C]<dc:language>\f[R] (from +the \f[C]lang\f[R] variable, or, if is not set, the locale), and +\f[C]<dc:identifier\ id=\[dq]BookId\[dq]>\f[R] (a randomly generated +UUID). Any of these may be overridden by elements in the metadata file. .PP Note: if the source document is Markdown, a YAML metadata block in the @@ -1248,51 +1258,51 @@ document can be used instead. See below under EPUB Metadata. .RE .TP -.B \f[C]\-\-epub\-embed\-font=\f[]\f[I]FILE\f[] +.B \f[C]\-\-epub\-embed\-font=\f[R]\f[I]FILE\f[R] Embed the specified font in the EPUB. This option can be repeated to embed multiple fonts. -Wildcards can also be used: for example, \f[C]DejaVuSans\-*.ttf\f[]. +Wildcards can also be used: for example, \f[C]DejaVuSans\-*.ttf\f[R]. 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 \f[C]\-\-css\f[]): +following to your CSS (see \f[C]\-\-css\f[R]): .RS .IP .nf \f[C] -\@font\-face\ { +\[at]font\-face\ { font\-family:\ DejaVuSans; font\-style:\ normal; font\-weight:\ normal; -src:url("DejaVuSans\-Regular.ttf"); +src:url(\[dq]DejaVuSans\-Regular.ttf\[dq]); } -\@font\-face\ { +\[at]font\-face\ { font\-family:\ DejaVuSans; font\-style:\ normal; font\-weight:\ bold; -src:url("DejaVuSans\-Bold.ttf"); +src:url(\[dq]DejaVuSans\-Bold.ttf\[dq]); } -\@font\-face\ { +\[at]font\-face\ { font\-family:\ DejaVuSans; font\-style:\ italic; font\-weight:\ normal; -src:url("DejaVuSans\-Oblique.ttf"); +src:url(\[dq]DejaVuSans\-Oblique.ttf\[dq]); } -\@font\-face\ { +\[at]font\-face\ { font\-family:\ DejaVuSans; font\-style:\ italic; font\-weight:\ bold; -src:url("DejaVuSans\-BoldOblique.ttf"); +src:url(\[dq]DejaVuSans\-BoldOblique.ttf\[dq]); } -body\ {\ font\-family:\ "DejaVuSans";\ } -\f[] +body\ {\ font\-family:\ \[dq]DejaVuSans\[dq];\ } +\f[R] .fi .RE .TP -.B \f[C]\-\-epub\-chapter\-level=\f[]\f[I]NUMBER\f[] +.B \f[C]\-\-epub\-chapter\-level=\f[R]\f[I]NUMBER\f[R] Specify the header level at which to split the EPUB into separate -"chapter" files. +\[dq]chapter\[dq] files. The default is to split into chapters at level 1 headers. This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users. @@ -1302,25 +1312,25 @@ chapter level of 2 or 3. .RS .RE .TP -.B \f[C]\-\-epub\-subdirectory=\f[]\f[I]DIRNAME\f[] +.B \f[C]\-\-epub\-subdirectory=\f[R]\f[I]DIRNAME\f[R] Specify the subdirectory in the OCF container that is to hold the EPUB\-specific contents. -The default is \f[C]EPUB\f[]. +The default is \f[C]EPUB\f[R]. To put the EPUB contents in the top level, use an empty string. .RS .RE .TP -.B \f[C]\-\-pdf\-engine=pdflatex\f[]|\f[C]lualatex\f[]|\f[C]xelatex\f[]|\f[C]wkhtmltopdf\f[]|\f[C]weasyprint\f[]|\f[C]prince\f[]|\f[C]context\f[]|\f[C]pdfroff\f[] +.B \f[C]\-\-pdf\-engine=pdflatex\f[R]|\f[C]lualatex\f[R]|\f[C]xelatex\f[R]|\f[C]wkhtmltopdf\f[R]|\f[C]weasyprint\f[R]|\f[C]prince\f[R]|\f[C]context\f[R]|\f[C]pdfroff\f[R] Use the specified engine when producing PDF output. -The default is \f[C]pdflatex\f[]. +The default is \f[C]pdflatex\f[R]. If the engine is not in your PATH, the full path of the engine may be specified here. .RS .RE .TP -.B \f[C]\-\-pdf\-engine\-opt=\f[]\f[I]STRING\f[] +.B \f[C]\-\-pdf\-engine\-opt=\f[R]\f[I]STRING\f[R] Use the given string as a command\-line argument to the -\f[C]pdf\-engine\f[]. +\f[C]pdf\-engine\f[R]. If used multiple times, the arguments are provided with spaces between them. Note that no check for duplicate options is done. @@ -1328,111 +1338,113 @@ Note that no check for duplicate options is done. .RE .SS Citation rendering .TP -.B \f[C]\-\-bibliography=\f[]\f[I]FILE\f[] -Set the \f[C]bibliography\f[] field in the document\[aq]s metadata to -\f[I]FILE\f[], overriding any value set in the metadata, and process -citations using \f[C]pandoc\-citeproc\f[]. +.B \f[C]\-\-bibliography=\f[R]\f[I]FILE\f[R] +Set the \f[C]bibliography\f[R] field in the document\[aq]s metadata to +\f[I]FILE\f[R], overriding any value set in the metadata, and process +citations using \f[C]pandoc\-citeproc\f[R]. (This is equivalent to -\f[C]\-\-metadata\ bibliography=FILE\ \-\-filter\ pandoc\-citeproc\f[].) -If \f[C]\-\-natbib\f[] or \f[C]\-\-biblatex\f[] is also supplied, -\f[C]pandoc\-citeproc\f[] is not used, making this equivalent to -\f[C]\-\-metadata\ bibliography=FILE\f[]. -If you supply this argument multiple times, each \f[I]FILE\f[] will be +\f[C]\-\-metadata\ bibliography=FILE\ \-\-filter\ pandoc\-citeproc\f[R].) +If \f[C]\-\-natbib\f[R] or \f[C]\-\-biblatex\f[R] is also supplied, +\f[C]pandoc\-citeproc\f[R] is not used, making this equivalent to +\f[C]\-\-metadata\ bibliography=FILE\f[R]. +If you supply this argument multiple times, each \f[I]FILE\f[R] will be added to bibliography. .RS .RE .TP -.B \f[C]\-\-csl=\f[]\f[I]FILE\f[] -Set the \f[C]csl\f[] field in the document\[aq]s metadata to -\f[I]FILE\f[], overriding any value set in the metadata. -(This is equivalent to \f[C]\-\-metadata\ csl=FILE\f[].) This option is -only relevant with \f[C]pandoc\-citeproc\f[]. +.B \f[C]\-\-csl=\f[R]\f[I]FILE\f[R] +Set the \f[C]csl\f[R] field in the document\[aq]s metadata to +\f[I]FILE\f[R], overriding any value set in the metadata. +(This is equivalent to \f[C]\-\-metadata\ csl=FILE\f[R].) This option is +only relevant with \f[C]pandoc\-citeproc\f[R]. .RS .RE .TP -.B \f[C]\-\-citation\-abbreviations=\f[]\f[I]FILE\f[] -Set the \f[C]citation\-abbreviations\f[] field in the document\[aq]s -metadata to \f[I]FILE\f[], overriding any value set in the metadata. +.B \f[C]\-\-citation\-abbreviations=\f[R]\f[I]FILE\f[R] +Set the \f[C]citation\-abbreviations\f[R] field in the document\[aq]s +metadata to \f[I]FILE\f[R], overriding any value set in the metadata. (This is equivalent to -\f[C]\-\-metadata\ citation\-abbreviations=FILE\f[].) This option is -only relevant with \f[C]pandoc\-citeproc\f[]. +\f[C]\-\-metadata\ citation\-abbreviations=FILE\f[R].) This option is +only relevant with \f[C]pandoc\-citeproc\f[R]. .RS .RE .TP -.B \f[C]\-\-natbib\f[] -Use \f[C]natbib\f[] for citations in LaTeX output. -This option is not for use with the \f[C]pandoc\-citeproc\f[] filter or +.B \f[C]\-\-natbib\f[R] +Use \f[C]natbib\f[R] for citations in LaTeX output. +This option is not for use with the \f[C]pandoc\-citeproc\f[R] filter or with PDF output. It is intended for use in producing a LaTeX file that can be processed -with \f[C]bibtex\f[]. +with \f[C]bibtex\f[R]. .RS .RE .TP -.B \f[C]\-\-biblatex\f[] -Use \f[C]biblatex\f[] for citations in LaTeX output. -This option is not for use with the \f[C]pandoc\-citeproc\f[] filter or +.B \f[C]\-\-biblatex\f[R] +Use \f[C]biblatex\f[R] for citations in LaTeX output. +This option is not for use with the \f[C]pandoc\-citeproc\f[R] filter or with PDF output. It is intended for use in producing a LaTeX file that can be processed -with \f[C]bibtex\f[] or \f[C]biber\f[]. +with \f[C]bibtex\f[R] or \f[C]biber\f[R]. .RS .RE .SS Math rendering in HTML .PP The default is to render TeX math as far as possible using Unicode characters. -Formulas are put inside a \f[C]span\f[] with \f[C]class="math"\f[], so -that they may be styled differently from the surrounding text if needed. +Formulas are put inside a \f[C]span\f[R] with +\f[C]class=\[dq]math\[dq]\f[R], 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 \f[C]\-\-mathjax\f[] or another of the following +will want to use \f[C]\-\-mathjax\f[R] or another of the following options. .TP -.B \f[C]\-\-mathjax\f[][\f[C]=\f[]\f[I]URL\f[]] +.B \f[C]\-\-mathjax\f[R][\f[C]=\f[R]\f[I]URL\f[R]] Use MathJax to display embedded TeX math in HTML output. -TeX math will be put between \f[C]\\(...\\)\f[] (for inline math) or -\f[C]\\[...\\]\f[] (for display math) and wrapped in \f[C]<span>\f[] -tags with class \f[C]math\f[]. +TeX math will be put between \f[C]\[rs](...\[rs])\f[R] (for inline math) +or \f[C]\[rs][...\[rs]]\f[R] (for display math) and wrapped in +\f[C]<span>\f[R] tags with class \f[C]math\f[R]. Then the MathJax JavaScript will render it. -The \f[I]URL\f[] should point to the \f[C]MathJax.js\f[] load script. -If a \f[I]URL\f[] is not provided, a link to the Cloudflare CDN will be +The \f[I]URL\f[R] should point to the \f[C]MathJax.js\f[R] load script. +If a \f[I]URL\f[R] is not provided, a link to the Cloudflare CDN will be inserted. .RS .RE .TP -.B \f[C]\-\-mathml\f[] -Convert TeX math to MathML (in \f[C]epub3\f[], \f[C]docbook4\f[], -\f[C]docbook5\f[], \f[C]jats\f[], \f[C]html4\f[] and \f[C]html5\f[]). -This is the default in \f[C]odt\f[] output. +.B \f[C]\-\-mathml\f[R] +Convert TeX math to MathML (in \f[C]epub3\f[R], \f[C]docbook4\f[R], +\f[C]docbook5\f[R], \f[C]jats\f[R], \f[C]html4\f[R] and +\f[C]html5\f[R]). +This is the default in \f[C]odt\f[R] output. Note that currently only Firefox and Safari (and select e\-book readers) natively support MathML. .RS .RE .TP -.B \f[C]\-\-webtex\f[][\f[C]=\f[]\f[I]URL\f[]] -Convert TeX formulas to \f[C]<img>\f[] tags that link to an external +.B \f[C]\-\-webtex\f[R][\f[C]=\f[R]\f[I]URL\f[R]] +Convert TeX formulas to \f[C]<img>\f[R] 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 -\f[C]\-\-webtex\ https://latex.codecogs.com/svg.latex?\f[]. +\f[C]\-\-webtex\ https://latex.codecogs.com/svg.latex?\f[R]. If no URL is specified, the CodeCogs URL generating PNGs will be used -(\f[C]https://latex.codecogs.com/png.latex?\f[]). -Note: the \f[C]\-\-webtex\f[] option will affect Markdown output as well -as HTML, which is useful if you\[aq]re targeting a version of Markdown -without native math support. +(\f[C]https://latex.codecogs.com/png.latex?\f[R]). +Note: the \f[C]\-\-webtex\f[R] option will affect Markdown output as +well as HTML, which is useful if you\[aq]re targeting a version of +Markdown without native math support. .RS .RE .TP -.B \f[C]\-\-katex\f[][\f[C]=\f[]\f[I]URL\f[]] +.B \f[C]\-\-katex\f[R][\f[C]=\f[R]\f[I]URL\f[R]] Use KaTeX to display embedded TeX math in HTML output. -The \f[I]URL\f[] is the base URL for the KaTeX library. -That directory should contain a \f[C]katex.min.js\f[] and a -\f[C]katex.min.css\f[] file. -If a \f[I]URL\f[] is not provided, a link to the KaTeX CDN will be +The \f[I]URL\f[R] is the base URL for the KaTeX library. +That directory should contain a \f[C]katex.min.js\f[R] and a +\f[C]katex.min.css\f[R] file. +If a \f[I]URL\f[R] is not provided, a link to the KaTeX CDN will be inserted. .RS .RE .TP -.B \f[C]\-\-gladtex\f[] -Enclose TeX math in \f[C]<eq>\f[] tags in HTML output. +.B \f[C]\-\-gladtex\f[R] +Enclose TeX math in \f[C]<eq>\f[R] tags in HTML output. The resulting HTML can then be processed by GladTeX to produce images of the typeset formulas and an HTML file with links to these images. So, the procedure is: @@ -1443,27 +1455,27 @@ So, the procedure is: pandoc\ \-s\ \-\-gladtex\ input.md\ \-o\ myfile.htex gladtex\ \-d\ myfile\-images\ myfile.htex #\ produces\ myfile.html\ and\ images\ in\ myfile\-images -\f[] +\f[R] .fi .RE .SS Options for wrapper scripts .TP -.B \f[C]\-\-dump\-args\f[] -Print information about command\-line arguments to \f[I]stdout\f[], then -exit. +.B \f[C]\-\-dump\-args\f[R] +Print information about command\-line arguments to \f[I]stdout\f[R], +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 \f[C]\-o\f[] option, or \f[C]\-\f[] (for \f[I]stdout\f[]) if no -output file was specified. +with the \f[C]\-o\f[R] option, or \f[C]\-\f[R] (for \f[I]stdout\f[R]) 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 \f[C]\-\-\f[] separator at the end -of the line. +include any options appearing after a \f[C]\-\-\f[R] separator at the +end of the line. .RS .RE .TP -.B \f[C]\-\-ignore\-args\f[] +.B \f[C]\-\-ignore\-args\f[R] Ignore command\-line arguments (for use in wrapper scripts). Regular pandoc options are not ignored. Thus, for example, @@ -1472,7 +1484,7 @@ Thus, for example, .nf \f[C] pandoc\ \-\-ignore\-args\ \-o\ foo.html\ \-s\ foo.txt\ \-\-\ \-e\ latin1 -\f[] +\f[R] .fi .PP is equivalent to @@ -1480,12 +1492,12 @@ is equivalent to .nf \f[C] pandoc\ \-o\ foo.html\ \-s -\f[] +\f[R] .fi .RE .SH TEMPLATES .PP -When the \f[C]\-s/\-\-standalone\f[] option is used, pandoc uses a +When the \f[C]\-s/\-\-standalone\f[R] 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 @@ -1493,46 +1505,46 @@ To see the default template that is used, just type .nf \f[C] pandoc\ \-D\ *FORMAT* -\f[] +\f[R] .fi .PP -where \f[I]FORMAT\f[] is the name of the output format. -A custom template can be specified using the \f[C]\-\-template\f[] +where \f[I]FORMAT\f[R] is the name of the output format. +A custom template can be specified using the \f[C]\-\-template\f[R] option. You can also override the system default templates for a given output -format \f[I]FORMAT\f[] by putting a file -\f[C]templates/default.*FORMAT*\f[] in the user data directory (see -\f[C]\-\-data\-dir\f[], above). -\f[I]Exceptions:\f[] +format \f[I]FORMAT\f[R] by putting a file +\f[C]templates/default.*FORMAT*\f[R] in the user data directory (see +\f[C]\-\-data\-dir\f[R], above). +\f[I]Exceptions:\f[R] .IP \[bu] 2 -For \f[C]odt\f[] output, customize the \f[C]default.opendocument\f[] +For \f[C]odt\f[R] output, customize the \f[C]default.opendocument\f[R] template. .IP \[bu] 2 -For \f[C]pdf\f[] output, customize the \f[C]default.latex\f[] template -(or the \f[C]default.context\f[] template, if you use -\f[C]\-t\ context\f[], or the \f[C]default.ms\f[] template, if you use -\f[C]\-t\ ms\f[], or the \f[C]default.html\f[] template, if you use -\f[C]\-t\ html\f[]). +For \f[C]pdf\f[R] output, customize the \f[C]default.latex\f[R] template +(or the \f[C]default.context\f[R] template, if you use +\f[C]\-t\ context\f[R], or the \f[C]default.ms\f[R] template, if you use +\f[C]\-t\ ms\f[R], or the \f[C]default.html\f[R] template, if you use +\f[C]\-t\ html\f[R]). .IP \[bu] 2 -\f[C]docx\f[] has no template (however, you can use -\f[C]\-\-reference\-doc\f[] to customize the output). +\f[C]docx\f[R] has no template (however, you can use +\f[C]\-\-reference\-doc\f[R] to customize the output). .PP -Templates contain \f[I]variables\f[], which allow for the inclusion of +Templates contain \f[I]variables\f[R], which allow for the inclusion of arbitrary information at any point in the file. -They may be set at the command line using the \f[C]\-V/\-\-variable\f[] +They may be set at the command line using the \f[C]\-V/\-\-variable\f[R] option. If a variable is not set, pandoc will look for the key in the document\[aq]s metadata \[en] which can be set using either YAML -metadata blocks or with the \f[C]\-\-metadata\f[] option. +metadata blocks or with the \f[C]\-\-metadata\f[R] option. .SS Variables set by pandoc .PP Some variables are set automatically by pandoc. These vary somewhat depending on the output format, but include the following: .TP -.B \f[C]sourcefile\f[], \f[C]outputfile\f[] +.B \f[C]sourcefile\f[R], \f[C]outputfile\f[R] source and destination filenames, as given on the command line. -\f[C]sourcefile\f[] can also be a list if input comes from multiple +\f[C]sourcefile\f[R] 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: .RS @@ -1546,14 +1558,14 @@ $endfor$ $else$ (stdin) $endif$ -\f[] +\f[R] .fi .PP -Similarly, \f[C]outputfile\f[] can be \f[C]\-\f[] if output goes to the -terminal. +Similarly, \f[C]outputfile\f[R] can be \f[C]\-\f[R] if output goes to +the terminal. .RE .TP -.B \f[C]title\f[], \f[C]author\f[], \f[C]date\f[] +.B \f[C]title\f[R], \f[C]author\f[R], \f[C]date\f[R] allow identification of basic aspects of the document. Included in PDF metadata through LaTeX and ConTeXt. These can be set through a pandoc title block, which allows for multiple @@ -1567,366 +1579,367 @@ author: \-\ Aristotle \-\ Peter\ Abelard \&... -\f[] +\f[R] .fi .RE .TP -.B \f[C]subtitle\f[] +.B \f[C]subtitle\f[R] document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx; renders in LaTeX only when using a document class that supports -\f[C]\\subtitle\f[], such as \f[C]beamer\f[] or the KOMA\-Script series -(\f[C]scrartcl\f[], \f[C]scrreprt\f[], \f[C]scrbook\f[]). +\f[C]\[rs]subtitle\f[R], such as \f[C]beamer\f[R] or the KOMA\-Script +series (\f[C]scrartcl\f[R], \f[C]scrreprt\f[R], \f[C]scrbook\f[R]). .RS .RE .TP -.B \f[C]institute\f[] +.B \f[C]institute\f[R] author affiliations (in LaTeX and Beamer only). Can be a list, when there are multiple authors. .RS .RE .TP -.B \f[C]abstract\f[] +.B \f[C]abstract\f[R] document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx .RS .RE .TP -.B \f[C]keywords\f[] +.B \f[C]keywords\f[R] list of keywords to be included in HTML, PDF, and AsciiDoc metadata; may -be repeated as for \f[C]author\f[], above +be repeated as for \f[C]author\f[R], above .RS .RE .TP -.B \f[C]header\-includes\f[] -contents specified by \f[C]\-H/\-\-include\-in\-header\f[] (may have +.B \f[C]header\-includes\f[R] +contents specified by \f[C]\-H/\-\-include\-in\-header\f[R] (may have multiple values) .RS .RE .TP -.B \f[C]toc\f[] -non\-null value if \f[C]\-\-toc/\-\-table\-of\-contents\f[] was +.B \f[C]toc\f[R] +non\-null value if \f[C]\-\-toc/\-\-table\-of\-contents\f[R] was specified .RS .RE .TP -.B \f[C]toc\-title\f[] +.B \f[C]toc\-title\f[R] title of table of contents (works only with EPUB, opendocument, odt, docx, pptx, beamer, LaTeX) .RS .RE .TP -.B \f[C]include\-before\f[] -contents specified by \f[C]\-B/\-\-include\-before\-body\f[] (may have +.B \f[C]include\-before\f[R] +contents specified by \f[C]\-B/\-\-include\-before\-body\f[R] (may have multiple values) .RS .RE .TP -.B \f[C]include\-after\f[] -contents specified by \f[C]\-A/\-\-include\-after\-body\f[] (may have +.B \f[C]include\-after\f[R] +contents specified by \f[C]\-A/\-\-include\-after\-body\f[R] (may have multiple values) .RS .RE .TP -.B \f[C]body\f[] +.B \f[C]body\f[R] body of document .RS .RE .TP -.B \f[C]meta\-json\f[] +.B \f[C]meta\-json\f[R] JSON representation of all of the document\[aq]s metadata. Field values are transformed to the selected output format. .RS .RE .SS Language variables .TP -.B \f[C]lang\f[] +.B \f[C]lang\f[R] identifies the main language of the document, using a code according to BCP 47 (e.g. -\f[C]en\f[] or \f[C]en\-GB\f[]). +\f[C]en\f[R] or \f[C]en\-GB\f[R]). For some output formats, pandoc will convert it to an appropriate format -stored in the additional variables \f[C]babel\-lang\f[], -\f[C]polyglossia\-lang\f[] (LaTeX) and \f[C]context\-lang\f[] (ConTeXt). +stored in the additional variables \f[C]babel\-lang\f[R], +\f[C]polyglossia\-lang\f[R] (LaTeX) and \f[C]context\-lang\f[R] +(ConTeXt). .RS .PP Native pandoc Spans and Divs with the lang attribute (value in BCP 47) can be used to switch the language in that range. -In LaTeX output, \f[C]babel\-otherlangs\f[] and -\f[C]polyglossia\-otherlangs\f[] variables will be generated -automatically based on the \f[C]lang\f[] attributes of Spans and Divs in -the document. +In LaTeX output, \f[C]babel\-otherlangs\f[R] and +\f[C]polyglossia\-otherlangs\f[R] variables will be generated +automatically based on the \f[C]lang\f[R] attributes of Spans and Divs +in the document. .RE .TP -.B \f[C]dir\f[] -the base direction of the document, either \f[C]rtl\f[] -(right\-to\-left) or \f[C]ltr\f[] (left\-to\-right). +.B \f[C]dir\f[R] +the base direction of the document, either \f[C]rtl\f[R] +(right\-to\-left) or \f[C]ltr\f[R] (left\-to\-right). .RS .PP -For bidirectional documents, native pandoc \f[C]span\f[]s and -\f[C]div\f[]s with the \f[C]dir\f[] attribute (value \f[C]rtl\f[] or -\f[C]ltr\f[]) can be used to override the base direction in some output +For bidirectional documents, native pandoc \f[C]span\f[R]s and +\f[C]div\f[R]s with the \f[C]dir\f[R] attribute (value \f[C]rtl\f[R] or +\f[C]ltr\f[R]) 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 Unicode Bidirectional Algorithm. .PP -When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[] -engine is fully supported (use \f[C]\-\-pdf\-engine=xelatex\f[]). +When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[R] +engine is fully supported (use \f[C]\-\-pdf\-engine=xelatex\f[R]). .RE .SS Variables for slides .PP Variables are available for producing slide shows with pandoc, including all reveal.js configuration options. .TP -.B \f[C]titlegraphic\f[] +.B \f[C]titlegraphic\f[R] title graphic for Beamer documents .RS .RE .TP -.B \f[C]logo\f[] +.B \f[C]logo\f[R] logo for Beamer documents .RS .RE .TP -.B \f[C]slidy\-url\f[] +.B \f[C]slidy\-url\f[R] base URL for Slidy documents (defaults to -\f[C]https://www.w3.org/Talks/Tools/Slidy2\f[]) +\f[C]https://www.w3.org/Talks/Tools/Slidy2\f[R]) .RS .RE .TP -.B \f[C]slideous\-url\f[] -base URL for Slideous documents (defaults to \f[C]slideous\f[]) +.B \f[C]slideous\-url\f[R] +base URL for Slideous documents (defaults to \f[C]slideous\f[R]) .RS .RE .TP -.B \f[C]s5\-url\f[] -base URL for S5 documents (defaults to \f[C]s5/default\f[]) +.B \f[C]s5\-url\f[R] +base URL for S5 documents (defaults to \f[C]s5/default\f[R]) .RS .RE .TP -.B \f[C]revealjs\-url\f[] -base URL for reveal.js documents (defaults to \f[C]reveal.js\f[]) +.B \f[C]revealjs\-url\f[R] +base URL for reveal.js documents (defaults to \f[C]reveal.js\f[R]) .RS .RE .TP -.B \f[C]theme\f[], \f[C]colortheme\f[], \f[C]fonttheme\f[], \f[C]innertheme\f[], \f[C]outertheme\f[] -themes for LaTeX \f[C]beamer\f[] documents +.B \f[C]theme\f[R], \f[C]colortheme\f[R], \f[C]fonttheme\f[R], \f[C]innertheme\f[R], \f[C]outertheme\f[R] +themes for LaTeX \f[C]beamer\f[R] documents .RS .RE .TP -.B \f[C]themeoptions\f[] +.B \f[C]themeoptions\f[R] options for LaTeX beamer themes (a list). .RS .RE .TP -.B \f[C]navigation\f[] -controls navigation symbols in \f[C]beamer\f[] documents (default is -\f[C]empty\f[] for no navigation symbols; other valid values are -\f[C]frame\f[], \f[C]vertical\f[], and \f[C]horizontal\f[]). +.B \f[C]navigation\f[R] +controls navigation symbols in \f[C]beamer\f[R] documents (default is +\f[C]empty\f[R] for no navigation symbols; other valid values are +\f[C]frame\f[R], \f[C]vertical\f[R], and \f[C]horizontal\f[R]). .RS .RE .TP -.B \f[C]section\-titles\f[] -enables on "title pages" for new sections in \f[C]beamer\f[] documents -(default = true). +.B \f[C]section\-titles\f[R] +enables on \[dq]title pages\[dq] for new sections in \f[C]beamer\f[R] +documents (default = true). .RS .RE .TP -.B \f[C]beamerarticle\f[] -when true, the \f[C]beamerarticle\f[] package is loaded (for producing +.B \f[C]beamerarticle\f[R] +when true, the \f[C]beamerarticle\f[R] package is loaded (for producing an article from beamer slides). .RS .RE .TP -.B \f[C]aspectratio\f[] -aspect ratio of slides (for beamer only, \f[C]1610\f[] for 16:10, -\f[C]169\f[] for 16:9, \f[C]149\f[] for 14:9, \f[C]141\f[] for 1.41:1, -\f[C]54\f[] for 5:4, \f[C]43\f[] for 4:3 which is the default, and -\f[C]32\f[] for 3:2). +.B \f[C]aspectratio\f[R] +aspect ratio of slides (for beamer only, \f[C]1610\f[R] for 16:10, +\f[C]169\f[R] for 16:9, \f[C]149\f[R] for 14:9, \f[C]141\f[R] for +1.41:1, \f[C]54\f[R] for 5:4, \f[C]43\f[R] for 4:3 which is the default, +and \f[C]32\f[R] for 3:2). .RS .RE .SS Variables for LaTeX .PP LaTeX variables are used when creating a PDF. .TP -.B \f[C]papersize\f[] +.B \f[C]papersize\f[R] paper size, e.g. -\f[C]letter\f[], \f[C]a4\f[] +\f[C]letter\f[R], \f[C]a4\f[R] .RS .RE .TP -.B \f[C]fontsize\f[] +.B \f[C]fontsize\f[R] font size for body text (e.g. -\f[C]10pt\f[], \f[C]12pt\f[]) +\f[C]10pt\f[R], \f[C]12pt\f[R]) .RS .RE .TP -.B \f[C]documentclass\f[] +.B \f[C]documentclass\f[R] document class, e.g. -\f[C]article\f[], \f[C]report\f[], \f[C]book\f[], \f[C]memoir\f[] +\f[C]article\f[R], \f[C]report\f[R], \f[C]book\f[R], \f[C]memoir\f[R] .RS .RE .TP -.B \f[C]classoption\f[] +.B \f[C]classoption\f[R] option for document class, e.g. -\f[C]oneside\f[]; may be repeated for multiple options +\f[C]oneside\f[R]; may be repeated for multiple options .RS .RE .TP -.B \f[C]beameroption\f[] -In beamer, add extra beamer option with \f[C]\\setbeameroption{}\f[] +.B \f[C]beameroption\f[R] +In beamer, add extra beamer option with \f[C]\[rs]setbeameroption{}\f[R] .RS .RE .TP -.B \f[C]geometry\f[] -option for \f[C]geometry\f[] package, e.g. -\f[C]margin=1in\f[]; may be repeated for multiple options +.B \f[C]geometry\f[R] +option for \f[C]geometry\f[R] package, e.g. +\f[C]margin=1in\f[R]; may be repeated for multiple options .RS .RE .TP -.B \f[C]margin\-left\f[], \f[C]margin\-right\f[], \f[C]margin\-top\f[], \f[C]margin\-bottom\f[] -sets margins, if \f[C]geometry\f[] is not used (otherwise -\f[C]geometry\f[] overrides these) +.B \f[C]margin\-left\f[R], \f[C]margin\-right\f[R], \f[C]margin\-top\f[R], \f[C]margin\-bottom\f[R] +sets margins, if \f[C]geometry\f[R] is not used (otherwise +\f[C]geometry\f[R] overrides these) .RS .RE .TP -.B \f[C]linestretch\f[] -adjusts line spacing using the \f[C]setspace\f[] package, e.g. -\f[C]1.25\f[], \f[C]1.5\f[] +.B \f[C]linestretch\f[R] +adjusts line spacing using the \f[C]setspace\f[R] package, e.g. +\f[C]1.25\f[R], \f[C]1.5\f[R] .RS .RE .TP -.B \f[C]fontfamily\f[] -font package for use with \f[C]pdflatex\f[]: TeX Live includes many +.B \f[C]fontfamily\f[R] +font package for use with \f[C]pdflatex\f[R]: TeX Live includes many options, documented in the LaTeX Font Catalogue. The default is Latin Modern. .RS .RE .TP -.B \f[C]fontfamilyoptions\f[] -options for package used as \f[C]fontfamily\f[]: e.g. -\f[C]osf,sc\f[] with \f[C]fontfamily\f[] set to \f[C]mathpazo\f[] +.B \f[C]fontfamilyoptions\f[R] +options for package used as \f[C]fontfamily\f[R]: e.g. +\f[C]osf,sc\f[R] with \f[C]fontfamily\f[R] set to \f[C]mathpazo\f[R] provides Palatino with old\-style figures and true small caps; may be repeated for multiple options .RS .RE .TP -.B \f[C]mainfont\f[], \f[C]sansfont\f[], \f[C]monofont\f[], \f[C]mathfont\f[], \f[C]CJKmainfont\f[] -font families for use with \f[C]xelatex\f[] or \f[C]lualatex\f[]: take -the name of any system font, using the \f[C]fontspec\f[] package. -Note that if \f[C]CJKmainfont\f[] is used, the \f[C]xecjk\f[] package +.B \f[C]mainfont\f[R], \f[C]sansfont\f[R], \f[C]monofont\f[R], \f[C]mathfont\f[R], \f[C]CJKmainfont\f[R] +font families for use with \f[C]xelatex\f[R] or \f[C]lualatex\f[R]: take +the name of any system font, using the \f[C]fontspec\f[R] package. +Note that if \f[C]CJKmainfont\f[R] is used, the \f[C]xecjk\f[R] package must be available. .RS .RE .TP -.B \f[C]mainfontoptions\f[], \f[C]sansfontoptions\f[], \f[C]monofontoptions\f[], \f[C]mathfontoptions\f[], \f[C]CJKoptions\f[] -options to use with \f[C]mainfont\f[], \f[C]sansfont\f[], -\f[C]monofont\f[], \f[C]mathfont\f[], \f[C]CJKmainfont\f[] in -\f[C]xelatex\f[] and \f[C]lualatex\f[]. -Allow for any choices available through \f[C]fontspec\f[], such as the -OpenType features \f[C]Numbers=OldStyle,Numbers=Proportional\f[]. +.B \f[C]mainfontoptions\f[R], \f[C]sansfontoptions\f[R], \f[C]monofontoptions\f[R], \f[C]mathfontoptions\f[R], \f[C]CJKoptions\f[R] +options to use with \f[C]mainfont\f[R], \f[C]sansfont\f[R], +\f[C]monofont\f[R], \f[C]mathfont\f[R], \f[C]CJKmainfont\f[R] in +\f[C]xelatex\f[R] and \f[C]lualatex\f[R]. +Allow for any choices available through \f[C]fontspec\f[R], such as the +OpenType features \f[C]Numbers=OldStyle,Numbers=Proportional\f[R]. May be repeated for multiple options. .RS .RE .TP -.B \f[C]fontenc\f[] -allows font encoding to be specified through \f[C]fontenc\f[] package -(with \f[C]pdflatex\f[]); default is \f[C]T1\f[] (see guide to LaTeX +.B \f[C]fontenc\f[R] +allows font encoding to be specified through \f[C]fontenc\f[R] package +(with \f[C]pdflatex\f[R]); default is \f[C]T1\f[R] (see guide to LaTeX font encodings) .RS .RE .TP -.B \f[C]microtypeoptions\f[] +.B \f[C]microtypeoptions\f[R] options to pass to the microtype package .RS .RE .TP -.B \f[C]colorlinks\f[] +.B \f[C]colorlinks\f[R] add color to link text; automatically enabled if any of -\f[C]linkcolor\f[], \f[C]filecolor\f[], \f[C]citecolor\f[], -\f[C]urlcolor\f[], or \f[C]toccolor\f[] are set +\f[C]linkcolor\f[R], \f[C]filecolor\f[R], \f[C]citecolor\f[R], +\f[C]urlcolor\f[R], or \f[C]toccolor\f[R] are set .RS .RE .TP -.B \f[C]linkcolor\f[], \f[C]filecolor\f[], \f[C]citecolor\f[], \f[C]urlcolor\f[], \f[C]toccolor\f[] +.B \f[C]linkcolor\f[R], \f[C]filecolor\f[R], \f[C]citecolor\f[R], \f[C]urlcolor\f[R], \f[C]toccolor\f[R] color for internal links, external links, citation links, linked URLs, and links in table of contents, respectively: uses options allowed by -\f[C]xcolor\f[], including the \f[C]dvipsnames\f[], \f[C]svgnames\f[], -and \f[C]x11names\f[] lists +\f[C]xcolor\f[R], including the \f[C]dvipsnames\f[R], +\f[C]svgnames\f[R], and \f[C]x11names\f[R] lists .RS .RE .TP -.B \f[C]links\-as\-notes\f[] +.B \f[C]links\-as\-notes\f[R] causes links to be printed as footnotes .RS .RE .TP -.B \f[C]indent\f[] +.B \f[C]indent\f[R] uses document class settings for indentation (the default LaTeX template otherwise removes indentation and adds space between paragraphs) .RS .RE .TP -.B \f[C]subparagraph\f[] +.B \f[C]subparagraph\f[R] disables default behavior of LaTeX template that redefines (sub)paragraphs as sections, changing the appearance of nested headings in some classes .RS .RE .TP -.B \f[C]thanks\f[] +.B \f[C]thanks\f[R] specifies contents of acknowledgments footnote after document title. .RS .RE .TP -.B \f[C]toc\f[] +.B \f[C]toc\f[R] include table of contents (can also be set using -\f[C]\-\-toc/\-\-table\-of\-contents\f[]) +\f[C]\-\-toc/\-\-table\-of\-contents\f[R]) .RS .RE .TP -.B \f[C]toc\-depth\f[] +.B \f[C]toc\-depth\f[R] level of section to include in table of contents .RS .RE .TP -.B \f[C]secnumdepth\f[] +.B \f[C]secnumdepth\f[R] numbering depth for sections, if sections are numbered .RS .RE .TP -.B \f[C]lof\f[], \f[C]lot\f[] +.B \f[C]lof\f[R], \f[C]lot\f[R] include list of figures, list of tables .RS .RE .TP -.B \f[C]bibliography\f[] +.B \f[C]bibliography\f[R] bibliography to use for resolving references .RS .RE .TP -.B \f[C]biblio\-style\f[] -bibliography style, when used with \f[C]\-\-natbib\f[] and -\f[C]\-\-biblatex\f[]. +.B \f[C]biblio\-style\f[R] +bibliography style, when used with \f[C]\-\-natbib\f[R] and +\f[C]\-\-biblatex\f[R]. .RS .RE .TP -.B \f[C]biblio\-title\f[] -bibliography title, when used with \f[C]\-\-natbib\f[] and -\f[C]\-\-biblatex\f[]. +.B \f[C]biblio\-title\f[R] +bibliography title, when used with \f[C]\-\-natbib\f[R] and +\f[C]\-\-biblatex\f[R]. .RS .RE .TP -.B \f[C]biblatexoptions\f[] +.B \f[C]biblatexoptions\f[R] list of options for biblatex. .RS .RE .TP -.B \f[C]natbiboptions\f[] +.B \f[C]natbiboptions\f[R] list of options for natbib. .RS .RE .TP -.B \f[C]pagestyle\f[] -An option for LaTeX\[aq]s \f[C]\\pagestyle{}\f[]. +.B \f[C]pagestyle\f[R] +An option for LaTeX\[aq]s \f[C]\[rs]pagestyle{}\f[R]. The default article class supports \[aq]plain\[aq] (default), \[aq]empty\[aq], and \[aq]headings\[aq]; headings puts section titles in the header. @@ -1934,94 +1947,94 @@ the header. .RE .SS Variables for ConTeXt .TP -.B \f[C]papersize\f[] +.B \f[C]papersize\f[R] paper size, e.g. -\f[C]letter\f[], \f[C]A4\f[], \f[C]landscape\f[] (see ConTeXt Paper +\f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R] (see ConTeXt Paper Setup); may be repeated for multiple options .RS .RE .TP -.B \f[C]layout\f[] +.B \f[C]layout\f[R] options for page margins and text arrangement (see ConTeXt Layout); may be repeated for multiple options .RS .RE .TP -.B \f[C]margin\-left\f[], \f[C]margin\-right\f[], \f[C]margin\-top\f[], \f[C]margin\-bottom\f[] -sets margins, if \f[C]layout\f[] is not used (otherwise \f[C]layout\f[] -overrides these) +.B \f[C]margin\-left\f[R], \f[C]margin\-right\f[R], \f[C]margin\-top\f[R], \f[C]margin\-bottom\f[R] +sets margins, if \f[C]layout\f[R] is not used (otherwise +\f[C]layout\f[R] overrides these) .RS .RE .TP -.B \f[C]fontsize\f[] +.B \f[C]fontsize\f[R] font size for body text (e.g. -\f[C]10pt\f[], \f[C]12pt\f[]) +\f[C]10pt\f[R], \f[C]12pt\f[R]) .RS .RE .TP -.B \f[C]mainfont\f[], \f[C]sansfont\f[], \f[C]monofont\f[], \f[C]mathfont\f[] +.B \f[C]mainfont\f[R], \f[C]sansfont\f[R], \f[C]monofont\f[R], \f[C]mathfont\f[R] font families: take the name of any system font (see ConTeXt Font Switching) .RS .RE .TP -.B \f[C]linkcolor\f[], \f[C]contrastcolor\f[] +.B \f[C]linkcolor\f[R], \f[C]contrastcolor\f[R] color for links outside and inside a page, e.g. -\f[C]red\f[], \f[C]blue\f[] (see ConTeXt Color) +\f[C]red\f[R], \f[C]blue\f[R] (see ConTeXt Color) .RS .RE .TP -.B \f[C]linkstyle\f[] +.B \f[C]linkstyle\f[R] typeface style for links, e.g. -\f[C]normal\f[], \f[C]bold\f[], \f[C]slanted\f[], \f[C]boldslanted\f[], -\f[C]type\f[], \f[C]cap\f[], \f[C]small\f[] +\f[C]normal\f[R], \f[C]bold\f[R], \f[C]slanted\f[R], +\f[C]boldslanted\f[R], \f[C]type\f[R], \f[C]cap\f[R], \f[C]small\f[R] .RS .RE .TP -.B \f[C]indenting\f[] +.B \f[C]indenting\f[R] controls indentation of paragraphs, e.g. -\f[C]yes,small,next\f[] (see ConTeXt Indentation); may be repeated for +\f[C]yes,small,next\f[R] (see ConTeXt Indentation); may be repeated for multiple options .RS .RE .TP -.B \f[C]whitespace\f[] +.B \f[C]whitespace\f[R] spacing between paragraphs, e.g. -\f[C]none\f[], \f[C]small\f[] (using \f[C]setupwhitespace\f[]) +\f[C]none\f[R], \f[C]small\f[R] (using \f[C]setupwhitespace\f[R]) .RS .RE .TP -.B \f[C]interlinespace\f[] +.B \f[C]interlinespace\f[R] adjusts line spacing, e.g. -\f[C]4ex\f[] (using \f[C]setupinterlinespace\f[]); may be repeated for +\f[C]4ex\f[R] (using \f[C]setupinterlinespace\f[R]); may be repeated for multiple options .RS .RE .TP -.B \f[C]headertext\f[], \f[C]footertext\f[] +.B \f[C]headertext\f[R], \f[C]footertext\f[R] text to be placed in running header or footer (see ConTeXt Headers and Footers); may be repeated up to four times for different placement .RS .RE .TP -.B \f[C]pagenumbering\f[] -page number style and location (using \f[C]setuppagenumbering\f[]); may +.B \f[C]pagenumbering\f[R] +page number style and location (using \f[C]setuppagenumbering\f[R]); may be repeated for multiple options .RS .RE .TP -.B \f[C]toc\f[] +.B \f[C]toc\f[R] include table of contents (can also be set using -\f[C]\-\-toc/\-\-table\-of\-contents\f[]) +\f[C]\-\-toc/\-\-table\-of\-contents\f[R]) .RS .RE .TP -.B \f[C]lof\f[], \f[C]lot\f[] +.B \f[C]lof\f[R], \f[C]lot\f[R] include list of figures, list of tables .RS .RE .TP -.B \f[C]pdfa\f[] +.B \f[C]pdfa\f[R] adds to the preamble the setup necessary to generate PDF/A\-1b:2005. To successfully generate PDF/A the required ICC color profiles have to be available and the content and all included files (such as images) @@ -2032,73 +2045,73 @@ See also ConTeXt PDFA for more details. .RE .SS Variables for man pages .TP -.B \f[C]section\f[] +.B \f[C]section\f[R] section number in man pages .RS .RE .TP -.B \f[C]header\f[] +.B \f[C]header\f[R] header in man pages .RS .RE .TP -.B \f[C]footer\f[] +.B \f[C]footer\f[R] footer in man pages .RS .RE .TP -.B \f[C]adjusting\f[] -adjusts text to left (\f[C]l\f[]), right (\f[C]r\f[]), center -(\f[C]c\f[]), or both (\f[C]b\f[]) margins +.B \f[C]adjusting\f[R] +adjusts text to left (\f[C]l\f[R]), right (\f[C]r\f[R]), center +(\f[C]c\f[R]), or both (\f[C]b\f[R]) margins .RS .RE .TP -.B \f[C]hyphenate\f[] -if \f[C]true\f[] (the default), hyphenation will be used +.B \f[C]hyphenate\f[R] +if \f[C]true\f[R] (the default), hyphenation will be used .RS .RE .SS Variables for ms .TP -.B \f[C]pointsize\f[] +.B \f[C]pointsize\f[R] point size (e.g. -\f[C]10p\f[]) +\f[C]10p\f[R]) .RS .RE .TP -.B \f[C]lineheight\f[] +.B \f[C]lineheight\f[R] line height (e.g. -\f[C]12p\f[]) +\f[C]12p\f[R]) .RS .RE .TP -.B \f[C]fontfamily\f[] +.B \f[C]fontfamily\f[R] font family (e.g. -\f[C]T\f[] or \f[C]P\f[]) +\f[C]T\f[R] or \f[C]P\f[R]) .RS .RE .TP -.B \f[C]indent\f[] +.B \f[C]indent\f[R] paragraph indent (e.g. -\f[C]2m\f[]) +\f[C]2m\f[R]) .RS .RE .SS Using variables in templates .PP -Variable names are sequences of alphanumerics, \f[C]\-\f[], and -\f[C]_\f[], starting with a letter. -A variable name surrounded by \f[C]$\f[] signs will be replaced by its +Variable names are sequences of alphanumerics, \f[C]\-\f[R], and +\f[C]_\f[R], starting with a letter. +A variable name surrounded by \f[C]$\f[R] signs will be replaced by its value. -For example, the string \f[C]$title$\f[] in +For example, the string \f[C]$title$\f[R] in .IP .nf \f[C] <title>$title$</title> -\f[] +\f[R] .fi .PP will be replaced by the document title. .PP -To write a literal \f[C]$\f[] in a template, use \f[C]$$\f[]. +To write a literal \f[C]$\f[R] in a template, use \f[C]$$\f[R]. .PP Templates may contain conditionals. The syntax is as follows: @@ -2110,11 +2123,11 @@ X $else$ Y $endif$ -\f[] +\f[R] .fi .PP -This will include \f[C]X\f[] in the template if \f[C]variable\f[] has a -truthy value; otherwise it will include \f[C]Y\f[]. +This will include \f[C]X\f[R] in the template if \f[C]variable\f[R] has +a truthy value; otherwise it will include \f[C]Y\f[R]. Here a truthy value is any of the following: .IP \[bu] 2 a string that is not entirely white space, @@ -2125,25 +2138,25 @@ any number (including zero), .IP \[bu] 2 any object, .IP \[bu] 2 -the boolean \f[C]true\f[] (to specify the boolean \f[C]true\f[] value -using YAML metadata or the \f[C]\-\-metadata\f[] flag, use -\f[C]true\f[], \f[C]True\f[], or \f[C]TRUE\f[]; with the -\f[C]\-\-variable\f[] flag, simply omit a value for the variable, e.g. -\f[C]\-\-variable\ draft\f[]). +the boolean \f[C]true\f[R] (to specify the boolean \f[C]true\f[R] value +using YAML metadata or the \f[C]\-\-metadata\f[R] flag, use +\f[C]true\f[R], \f[C]True\f[R], or \f[C]TRUE\f[R]; with the +\f[C]\-\-variable\f[R] flag, simply omit a value for the variable, e.g. +\f[C]\-\-variable\ draft\f[R]). .PP -\f[C]X\f[] and \f[C]Y\f[] are placeholders for any valid template text, -and may include interpolated variables or other conditionals. -The \f[C]$else$\f[] section may be omitted. +\f[C]X\f[R] and \f[C]Y\f[R] are placeholders for any valid template +text, and may include interpolated variables or other conditionals. +The \f[C]$else$\f[R] section may be omitted. .PP -When variables can have multiple values (for example, \f[C]author\f[] in -a multi\-author document), you can use the \f[C]$for$\f[] keyword: +When variables can have multiple values (for example, \f[C]author\f[R] +in a multi\-author document), you can use the \f[C]$for$\f[R] keyword: .IP .nf \f[C] $for(author)$ -<meta\ name="author"\ content="$author$"\ /> +<meta\ name=\[dq]author\[dq]\ content=\[dq]$author$\[dq]\ /> $endfor$ -\f[] +\f[R] .fi .PP You can optionally specify a separator to be used between consecutive @@ -2152,7 +2165,7 @@ items: .nf \f[C] $for(author)$$author$$sep$,\ $endfor$ -\f[] +\f[R] .fi .PP A dot can be used to select a field of a variable that takes an object @@ -2162,7 +2175,7 @@ So, for example: .nf \f[C] $author.name$\ ($author.affiliation$) -\f[] +\f[R] .fi .PP If you use custom templates, you may need to revise them as pandoc @@ -2172,67 +2185,69 @@ modifying your custom templates accordingly. An easy way to do this is to fork the pandoc\-templates repository and merge in changes after each pandoc release. .PP -Templates may contain comments: anything on a line after \f[C]$\-\-\f[] +Templates may contain comments: anything on a line after \f[C]$\-\-\f[R] will be treated as a comment and ignored. .SH EXTENSIONS .PP The behavior of some of the readers and writers can be adjusted by enabling or disabling various extensions. .PP -An extension can be enabled by adding \f[C]+EXTENSION\f[] to the format -name and disabled by adding \f[C]\-EXTENSION\f[]. -For example, \f[C]\-\-from\ markdown_strict+footnotes\f[] is strict +An extension can be enabled by adding \f[C]+EXTENSION\f[R] to the format +name and disabled by adding \f[C]\-EXTENSION\f[R]. +For example, \f[C]\-\-from\ markdown_strict+footnotes\f[R] is strict Markdown with footnotes enabled, while -\f[C]\-\-from\ markdown\-footnotes\-pipe_tables\f[] is pandoc\[aq]s +\f[C]\-\-from\ markdown\-footnotes\-pipe_tables\f[R] is pandoc\[aq]s Markdown without footnotes or pipe tables. .PP The markdown reader and writer make by far the most use of extensions. Extensions only used by them are therefore covered in the section Pandoc\[aq]s Markdown below (See Markdown variants for -\f[C]commonmark\f[] and \f[C]gfm\f[].) In the following, extensions that -also work for other formats are covered. +\f[C]commonmark\f[R] and \f[C]gfm\f[R].) In the following, extensions +that also work for other formats are covered. .SS Typography -.SS Extension: \f[C]smart\f[] +.SS Extension: \f[C]smart\f[R] .PP -Interpret straight quotes as curly quotes, \f[C]\-\-\-\f[] as -em\-dashes, \f[C]\-\-\f[] as en\-dashes, and \f[C]\&...\f[] as ellipses. +Interpret straight quotes as curly quotes, \f[C]\-\-\-\f[R] as +em\-dashes, \f[C]\-\-\f[R] as en\-dashes, and \f[C]\&...\f[R] as +ellipses. Nonbreaking spaces are inserted after certain abbreviations, such as -"Mr." +\[dq]Mr.\[dq] .PP This extension can be enabled/disabled for the following formats: .TP .B input formats -\f[C]markdown\f[], \f[C]commonmark\f[], \f[C]latex\f[], -\f[C]mediawiki\f[], \f[C]org\f[], \f[C]rst\f[], \f[C]twiki\f[] +\f[C]markdown\f[R], \f[C]commonmark\f[R], \f[C]latex\f[R], +\f[C]mediawiki\f[R], \f[C]org\f[R], \f[C]rst\f[R], \f[C]twiki\f[R] .RS .RE .TP .B output formats -\f[C]markdown\f[], \f[C]latex\f[], \f[C]context\f[], \f[C]rst\f[] +\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]context\f[R], \f[C]rst\f[R] .RS .RE .TP .B enabled by default in -\f[C]markdown\f[], \f[C]latex\f[], \f[C]context\f[] (both input and +\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]context\f[R] (both input and output) .RS .RE .PP -Note: If you are \f[I]writing\f[] Markdown, then the \f[C]smart\f[] +Note: If you are \f[I]writing\f[R] Markdown, then the \f[C]smart\f[R] extension has the reverse effect: what would have been curly quotes comes out straight. .PP -In LaTeX, \f[C]smart\f[] means to use the standard TeX ligatures for -quotation marks (\f[C]``\f[] and \f[C]\[aq]\[aq]\f[] for double quotes, -\f[C]`\f[] and \f[C]\[aq]\f[] for single quotes) and dashes -(\f[C]\-\-\f[] for en\-dash and \f[C]\-\-\-\f[] for em\-dash). -If \f[C]smart\f[] is disabled, then in reading LaTeX pandoc will parse +In LaTeX, \f[C]smart\f[R] means to use the standard TeX ligatures for +quotation marks (\f[C]\[ga]\[ga]\f[R] and \f[C]\[aq]\[aq]\f[R] for +double quotes, \f[C]\[ga]\f[R] and \f[C]\[aq]\f[R] for single quotes) +and dashes (\f[C]\-\-\f[R] for en\-dash and \f[C]\-\-\-\f[R] for +em\-dash). +If \f[C]smart\f[R] is disabled, then in reading LaTeX pandoc will parse these characters literally. -In writing LaTeX, enabling \f[C]smart\f[] tells pandoc to use the -ligatures when possible; if \f[C]smart\f[] is disabled pandoc will use +In writing LaTeX, enabling \f[C]smart\f[R] tells pandoc to use the +ligatures when possible; if \f[C]smart\f[R] is disabled pandoc will use unicode quotation mark and dash characters. .SS Headers and sections -.SS Extension: \f[C]auto_identifiers\f[] +.SS Extension: \f[C]auto_identifiers\f[R] .PP A header without an explicitly specified identifier will be automatically assigned a unique identifier based on the header text. @@ -2240,18 +2255,18 @@ automatically assigned a unique identifier based on the header text. This extension can be enabled/disabled for the following formats: .TP .B input formats -\f[C]markdown\f[], \f[C]latex\f[], \f[C]rst\f[], \f[C]mediawiki\f[], -\f[C]textile\f[] +\f[C]markdown\f[R], \f[C]latex\f[R], \f[C]rst\f[R], \f[C]mediawiki\f[R], +\f[C]textile\f[R] .RS .RE .TP .B output formats -\f[C]markdown\f[], \f[C]muse\f[] +\f[C]markdown\f[R], \f[C]muse\f[R] .RS .RE .TP .B enabled by default in -\f[C]markdown\f[], \f[C]muse\f[] +\f[C]markdown\f[R], \f[C]muse\f[R] .RS .RE .PP @@ -2270,7 +2285,7 @@ Convert all alphabetic characters to lowercase. Remove everything up to the first letter (identifiers may not begin with a number or punctuation mark). .IP \[bu] 2 -If nothing is left after this, use the identifier \f[C]section\f[]. +If nothing is left after this, use the identifier \f[C]section\f[R]. .PP Thus, for example, .PP @@ -2284,29 +2299,29 @@ Identifier T} _ T{ -\f[C]Header\ identifiers\ in\ HTML\f[] +\f[C]Header\ identifiers\ in\ HTML\f[R] T}@T{ -\f[C]header\-identifiers\-in\-html\f[] +\f[C]header\-identifiers\-in\-html\f[R] T} T{ -\f[C]*Dogs*?\-\-in\ *my*\ house?\f[] +\f[C]*Dogs*?\-\-in\ *my*\ house?\f[R] T}@T{ -\f[C]dogs\-\-in\-my\-house\f[] +\f[C]dogs\-\-in\-my\-house\f[R] T} T{ -\f[C][HTML],\ [S5],\ or\ [RTF]?\f[] +\f[C][HTML],\ [S5],\ or\ [RTF]?\f[R] T}@T{ -\f[C]html\-s5\-or\-rtf\f[] +\f[C]html\-s5\-or\-rtf\f[R] T} T{ -\f[C]3.\ Applications\f[] +\f[C]3.\ Applications\f[R] T}@T{ -\f[C]applications\f[] +\f[C]applications\f[R] T} T{ -\f[C]33\f[] +\f[C]33\f[R] T}@T{ -\f[C]section\f[] +\f[C]section\f[R] T} .TE .PP @@ -2314,11 +2329,11 @@ These rules should, in most cases, allow one to determine the identifier from the header text. The exception is when several headers have the same text; in this case, the first will get an identifier as described above; the second will get -the same identifier with \f[C]\-1\f[] appended; the third with -\f[C]\-2\f[]; and so on. +the same identifier with \f[C]\-1\f[R] appended; the third with +\f[C]\-2\f[R]; and so on. .PP These identifiers are used to provide link targets in the table of -contents generated by the \f[C]\-\-toc|\-\-table\-of\-contents\f[] +contents generated by the \f[C]\-\-toc|\-\-table\-of\-contents\f[R] option. They also make it easy to provide links from one section of a document to another. @@ -2328,30 +2343,30 @@ A link to this section, for example, might look like this: \f[C] See\ the\ section\ on [header\ identifiers](#header\-identifiers\-in\-html\-latex\-and\-context). -\f[] +\f[R] .fi .PP Note, however, that this method of providing links to sections works only in HTML, LaTeX, and ConTeXt formats. .PP -If the \f[C]\-\-section\-divs\f[] option is specified, then each section -will be wrapped in a \f[C]section\f[] (or a \f[C]div\f[], if -\f[C]html4\f[] was specified), and the identifier will be attached to -the enclosing \f[C]<section>\f[] (or \f[C]<div>\f[]) tag rather than the -header itself. +If the \f[C]\-\-section\-divs\f[R] option is specified, then each +section will be wrapped in a \f[C]section\f[R] (or a \f[C]div\f[R], if +\f[C]html4\f[R] was specified), and the identifier will be attached to +the enclosing \f[C]<section>\f[R] (or \f[C]<div>\f[R]) tag rather than +the header itself. This allows entire sections to be manipulated using JavaScript or treated differently in CSS. -.SS Extension: \f[C]ascii_identifiers\f[] +.SS Extension: \f[C]ascii_identifiers\f[R] .PP -Causes the identifiers produced by \f[C]auto_identifiers\f[] to be pure +Causes the identifiers produced by \f[C]auto_identifiers\f[R] to be pure ASCII. Accents are stripped off of accented Latin letters, and non\-Latin letters are omitted. .SS Math Input .PP -The extensions \f[C]tex_math_dollars\f[], -\f[C]tex_math_single_backslash\f[], and -\f[C]tex_math_double_backslash\f[] are described in the section about +The extensions \f[C]tex_math_dollars\f[R], +\f[C]tex_math_single_backslash\f[R], and +\f[C]tex_math_double_backslash\f[R] are described in the section about Pandoc\[aq]s Markdown. .PP However, they can also be used with HTML input. @@ -2362,77 +2377,77 @@ example. The following extensions (especially how they affect Markdown input/output) are also described in more detail in their respective sections of Pandoc\[aq]s Markdown. -.SS Extension: \f[C]raw_html\f[] +.SS Extension: \f[C]raw_html\f[R] .PP When converting from HTML, parse elements to raw HTML which are not representable in pandoc\[aq]s AST. By default, this is disabled for HTML input. -.SS Extension: \f[C]raw_tex\f[] +.SS Extension: \f[C]raw_tex\f[R] .PP Allows raw LaTeX, TeX, and ConTeXt to be included in a document. .PP This extension can be enabled/disabled for the following formats (in -addition to \f[C]markdown\f[]): +addition to \f[C]markdown\f[R]): .TP .B input formats -\f[C]latex\f[], \f[C]org\f[], \f[C]textile\f[], \f[C]html\f[] -(environments, \f[C]\\ref\f[], and \f[C]\\eqref\f[] only) +\f[C]latex\f[R], \f[C]org\f[R], \f[C]textile\f[R], \f[C]html\f[R] +(environments, \f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only) .RS .RE .TP .B output formats -\f[C]textile\f[], \f[C]commonmark\f[] +\f[C]textile\f[R], \f[C]commonmark\f[R] .RS .RE -.SS Extension: \f[C]native_divs\f[] +.SS Extension: \f[C]native_divs\f[R] .PP This extension is enabled by default for HTML input. -This means that \f[C]div\f[]s are parsed to pandoc native elements. +This means that \f[C]div\f[R]s are parsed to pandoc native elements. (Alternatively, you can parse them to raw HTML using -\f[C]\-f\ html\-native_divs+raw_html\f[].) +\f[C]\-f\ html\-native_divs+raw_html\f[R].) .PP When converting HTML to Markdown, for example, you may want to drop all -\f[C]div\f[]s and \f[C]span\f[]s: +\f[C]div\f[R]s and \f[C]span\f[R]s: .IP .nf \f[C] pandoc\ \-f\ html\-native_divs\-native_spans\ \-t\ markdown -\f[] +\f[R] .fi -.SS Extension: \f[C]native_spans\f[] +.SS Extension: \f[C]native_spans\f[R] .PP -Analogous to \f[C]native_divs\f[] above. +Analogous to \f[C]native_divs\f[R] above. .SS Literate Haskell support -.SS Extension: \f[C]literate_haskell\f[] +.SS Extension: \f[C]literate_haskell\f[R] .PP Treat the document as literate Haskell source. .PP This extension can be enabled/disabled for the following formats: .TP .B input formats -\f[C]markdown\f[], \f[C]rst\f[], \f[C]latex\f[] +\f[C]markdown\f[R], \f[C]rst\f[R], \f[C]latex\f[R] .RS .RE .TP .B output formats -\f[C]markdown\f[], \f[C]rst\f[], \f[C]latex\f[], \f[C]html\f[] +\f[C]markdown\f[R], \f[C]rst\f[R], \f[C]latex\f[R], \f[C]html\f[R] .RS .RE .PP -If you append \f[C]+lhs\f[] (or \f[C]+literate_haskell\f[]) to one of +If you append \f[C]+lhs\f[R] (or \f[C]+literate_haskell\f[R]) to one of the formats above, pandoc will treat the document as literate Haskell source. This means that .IP \[bu] 2 -In Markdown input, "bird track" sections will be parsed as Haskell code -rather than block quotations. -Text between \f[C]\\begin{code}\f[] and \f[C]\\end{code}\f[] will also -be treated as Haskell code. +In Markdown input, \[dq]bird track\[dq] sections will be parsed as +Haskell code rather than block quotations. +Text between \f[C]\[rs]begin{code}\f[R] and \f[C]\[rs]end{code}\f[R] +will also be treated as Haskell code. For ATX\-style headers the character \[aq]=\[aq] will be used instead of \[aq]#\[aq]. .IP \[bu] 2 -In Markdown output, code blocks with classes \f[C]haskell\f[] and -\f[C]literate\f[] will be rendered using bird tracks, and block +In Markdown output, code blocks with classes \f[C]haskell\f[R] and +\f[C]literate\f[R] 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, headers will be rendered setext\-style (with underlines) @@ -2440,27 +2455,27 @@ rather than ATX\-style (with \[aq]#\[aq] characters). (This is because ghc treats \[aq]#\[aq] characters in column 1 as introducing line numbers.) .IP \[bu] 2 -In restructured text input, "bird track" sections will be parsed as -Haskell code. +In restructured text input, \[dq]bird track\[dq] sections will be parsed +as Haskell code. .IP \[bu] 2 -In restructured text output, code blocks with class \f[C]haskell\f[] +In restructured text output, code blocks with class \f[C]haskell\f[R] will be rendered using bird tracks. .IP \[bu] 2 -In LaTeX input, text in \f[C]code\f[] environments will be parsed as +In LaTeX input, text in \f[C]code\f[R] environments will be parsed as Haskell code. .IP \[bu] 2 -In LaTeX output, code blocks with class \f[C]haskell\f[] will be -rendered inside \f[C]code\f[] environments. +In LaTeX output, code blocks with class \f[C]haskell\f[R] will be +rendered inside \f[C]code\f[R] environments. .IP \[bu] 2 -In HTML output, code blocks with class \f[C]haskell\f[] will be rendered -with class \f[C]literatehaskell\f[] and bird tracks. +In HTML output, code blocks with class \f[C]haskell\f[R] will be +rendered with class \f[C]literatehaskell\f[R] and bird tracks. .PP Examples: .IP .nf \f[C] pandoc\ \-f\ markdown+lhs\ \-t\ html -\f[] +\f[R] .fi .PP reads literate Haskell source formatted with Markdown conventions and @@ -2469,7 +2484,7 @@ writes ordinary HTML (without bird tracks). .nf \f[C] pandoc\ \-f\ markdown+lhs\ \-t\ html+lhs -\f[] +\f[R] .fi .PP writes HTML with the Haskell code in bird tracks, so it can be copied @@ -2480,7 +2495,7 @@ literate code blocks (e.g. inside an itemized environment) will not be picked up by the Haskell compiler. .SS Other extensions -.SS Extension: \f[C]empty_paragraphs\f[] +.SS Extension: \f[C]empty_paragraphs\f[R] .PP Allows empty paragraphs. By default empty paragraphs are omitted. @@ -2488,15 +2503,15 @@ By default empty paragraphs are omitted. This extension can be enabled/disabled for the following formats: .TP .B input formats -\f[C]docx\f[], \f[C]html\f[] +\f[C]docx\f[R], \f[C]html\f[R] .RS .RE .TP .B output formats -\f[C]docx\f[], \f[C]odt\f[], \f[C]opendocument\f[], \f[C]html\f[] +\f[C]docx\f[R], \f[C]odt\f[R], \f[C]opendocument\f[R], \f[C]html\f[R] .RS .RE -.SS Extension: \f[C]styles\f[] +.SS Extension: \f[C]styles\f[R] .PP Read all docx styles as divs (for paragraph styles) and spans (for character styles) regardless of whether pandoc understands the meaning @@ -2505,20 +2520,20 @@ This can be used with docx custom styles. Disabled by default. .TP .B input formats -\f[C]docx\f[] +\f[C]docx\f[R] .RS .RE -.SS Extension: \f[C]amuse\f[] +.SS Extension: \f[C]amuse\f[R] .PP -In the \f[C]muse\f[] input format, this enables Text::Amuse extensions +In the \f[C]muse\f[R] input format, this enables Text::Amuse extensions to Emacs Muse markup. -.SS Extension: \f[C]citations\f[] +.SS Extension: \f[C]citations\f[R] .PP Some aspects of Pandoc\[aq]s Markdown citation syntax are also accepted -in \f[C]org\f[] input. -.SS Extension: \f[C]ntb\f[] +in \f[C]org\f[R] input. +.SS Extension: \f[C]ntb\f[R] .PP -In the \f[C]context\f[] output format this enables the use of Natural +In the \f[C]context\f[R] output format this enables the use of Natural Tables (TABLE) instead of the default Extreme Tables (xtables). Natural tables allow more fine\-grained global customization but come at a performance penalty compared to extreme tables. @@ -2529,7 +2544,7 @@ Gruber\[aq]s Markdown syntax. This document explains the syntax, noting differences from standard Markdown. Except where noted, these differences can be suppressed by using the -\f[C]markdown_strict\f[] format instead of \f[C]markdown\f[]. +\f[C]markdown_strict\f[R] format instead of \f[C]markdown\f[R]. Extensions can be enabled or disabled to specify the behavior more granularly. They are described in the following. @@ -2565,7 +2580,7 @@ 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. -.SS Extension: \f[C]escaped_line_breaks\f[] +.SS Extension: \f[C]escaped_line_breaks\f[R] .PP 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 @@ -2575,9 +2590,9 @@ a hard line break, since trailing spaces in the cells are ignored. There are two kinds of headers: Setext and ATX. .SS Setext\-style headers .PP -A setext\-style header is a line of text "underlined" with a row of -\f[C]=\f[] signs (for a level one header) or \f[C]\-\f[] signs (for a -level two header): +A setext\-style header is a line of text \[dq]underlined\[dq] with a row +of \f[C]=\f[R] signs (for a level one header) or \f[C]\-\f[R] signs (for +a level two header): .IP .nf \f[C] @@ -2586,16 +2601,16 @@ A\ level\-one\ header A\ level\-two\ header \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -\f[] +\f[R] .fi .PP The header text can contain inline formatting, such as emphasis (see Inline formatting, below). .SS ATX\-style headers .PP -An ATX\-style header consists of one to six \f[C]#\f[] signs and a line -of text, optionally followed by any number of \f[C]#\f[] signs. -The number of \f[C]#\f[] signs at the beginning of the line is the +An ATX\-style header consists of one to six \f[C]#\f[R] signs and a line +of text, optionally followed by any number of \f[C]#\f[R] signs. +The number of \f[C]#\f[R] signs at the beginning of the line is the header level: .IP .nf @@ -2603,7 +2618,7 @@ header level: ##\ A\ level\-two\ header ###\ A\ level\-three\ header\ ### -\f[] +\f[R] .fi .PP As with setext\-style headers, the header text can contain formatting: @@ -2611,15 +2626,15 @@ As with setext\-style headers, the header text can contain formatting: .nf \f[C] #\ A\ level\-one\ header\ with\ a\ [link](/url)\ and\ *emphasis* -\f[] +\f[R] .fi -.SS Extension: \f[C]blank_before_header\f[] +.SS Extension: \f[C]blank_before_header\f[R] .PP Standard Markdown syntax does not require a blank line before a header. 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 -\f[C]#\f[] to end up at the beginning of a line by accident (perhaps +\f[C]#\f[R] to end up at the beginning of a line by accident (perhaps through line wrapping). Consider, for example: .IP @@ -2627,18 +2642,18 @@ Consider, for example: \f[C] I\ like\ several\ of\ their\ flavors\ of\ ice\ cream: #22,\ for\ example,\ and\ #5. -\f[] +\f[R] .fi -.SS Extension: \f[C]space_in_atx_header\f[] +.SS Extension: \f[C]space_in_atx_header\f[R] .PP Many Markdown implementations do not require a space between the opening -\f[C]#\f[]s of an ATX header and the header text, so that -\f[C]#5\ bolt\f[] and \f[C]#hashtag\f[] count as headers. +\f[C]#\f[R]s of an ATX header and the header text, so that +\f[C]#5\ bolt\f[R] and \f[C]#hashtag\f[R] count as headers. With this extension, pandoc does require the space. .SS Header identifiers .PP -See also the \f[C]auto_identifiers\f[] extension above. -.SS Extension: \f[C]header_attributes\f[] +See also the \f[C]auto_identifiers\f[R] extension above. +.SS Extension: \f[C]header_attributes\f[R] .PP Headers can be assigned attributes using this syntax at the end of the line containing the header text: @@ -2646,11 +2661,11 @@ line containing the header text: .nf \f[C] {#identifier\ .class\ .class\ key=value\ key=value} -\f[] +\f[R] .fi .PP Thus, for example, the following headers will all be assigned the -identifier \f[C]foo\f[]: +identifier \f[C]foo\f[R]: .IP .nf \f[C] @@ -2660,7 +2675,7 @@ identifier \f[C]foo\f[]: My\ other\ header\ \ \ {#foo} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -\f[] +\f[R] .fi .PP (This syntax is compatible with PHP Markdown Extra.) @@ -2673,16 +2688,16 @@ HTML\-based formats such as EPUB and slidy. Identifiers are used for labels and link anchors in the LaTeX, ConTeXt, Textile, and AsciiDoc writers. .PP -Headers with the class \f[C]unnumbered\f[] will not be numbered, even if -\f[C]\-\-number\-sections\f[] is specified. -A single hyphen (\f[C]\-\f[]) in an attribute context is equivalent to -\f[C]\&.unnumbered\f[], and preferable in non\-English documents. +Headers with the class \f[C]unnumbered\f[R] will not be numbered, even +if \f[C]\-\-number\-sections\f[R] is specified. +A single hyphen (\f[C]\-\f[R]) in an attribute context is equivalent to +\f[C]\&.unnumbered\f[R], and preferable in non\-English documents. So, .IP .nf \f[C] #\ My\ header\ {\-} -\f[] +\f[R] .fi .PP is just the same as @@ -2690,9 +2705,9 @@ is just the same as .nf \f[C] #\ My\ header\ {.unnumbered} -\f[] +\f[R] .fi -.SS Extension: \f[C]implicit_header_references\f[] +.SS Extension: \f[C]implicit_header_references\f[R] .PP Pandoc behaves as if reference links have been defined for each header. So, to link to a header @@ -2700,7 +2715,7 @@ So, to link to a header .nf \f[C] #\ Header\ identifiers\ in\ HTML -\f[] +\f[R] .fi .PP you can simply write @@ -2708,7 +2723,7 @@ you can simply write .nf \f[C] [Header\ identifiers\ in\ HTML] -\f[] +\f[R] .fi .PP or @@ -2716,7 +2731,7 @@ or .nf \f[C] [Header\ identifiers\ in\ HTML][] -\f[] +\f[R] .fi .PP or @@ -2725,7 +2740,7 @@ or \f[C] [the\ section\ on\ header\ identifiers][header\ identifiers\ in HTML] -\f[] +\f[R] .fi .PP instead of giving the identifier explicitly: @@ -2733,7 +2748,7 @@ instead of giving the identifier explicitly: .nf \f[C] [Header\ identifiers\ in\ HTML](#header\-identifiers\-in\-html) -\f[] +\f[R] .fi .PP If there are multiple headers with identical text, the corresponding @@ -2744,8 +2759,8 @@ Like regular reference links, these references are case\-insensitive. .PP Explicit link reference definitions always take priority over implicit header references. -So, in the following example, the link will point to \f[C]bar\f[], not -to \f[C]#foo\f[]: +So, in the following example, the link will point to \f[C]bar\f[R], not +to \f[C]#foo\f[R]: .IP .nf \f[C] @@ -2754,15 +2769,15 @@ to \f[C]#foo\f[]: [foo]:\ bar See\ [foo] -\f[] +\f[R] .fi .SS Block quotations .PP 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 headers), with each line preceded by a \f[C]>\f[] +(such as lists or headers), with each line preceded by a \f[C]>\f[R] character and an optional space. -(The \f[C]>\f[] need not start at the left margin, but it should not be +(The \f[C]>\f[R] need not start at the left margin, but it should not be indented more than three spaces.) .IP .nf @@ -2772,11 +2787,11 @@ indented more than three spaces.) > >\ 1.\ This\ is\ a\ list\ inside\ a\ block\ quote. >\ 2.\ Second\ item. -\f[] +\f[R] .fi .PP -A "lazy" form, which requires the \f[C]>\f[] character only on the first -line of each block, is also allowed: +A \[dq]lazy\[dq] form, which requires the \f[C]>\f[R] character only on +the first line of each block, is also allowed: .IP .nf \f[C] @@ -2785,7 +2800,7 @@ paragraph\ has\ two\ lines. >\ 1.\ This\ is\ a\ list\ inside\ a\ block\ quote. 2.\ Second\ item. -\f[] +\f[R] .fi .PP Among the block elements that can be contained in a block quote are @@ -2797,37 +2812,37 @@ That is, block quotes can be nested: >\ This\ is\ a\ block\ quote. > >\ >\ A\ block\ quote\ within\ a\ block\ quote. -\f[] +\f[R] .fi .PP -If the \f[C]>\f[] 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. +If the \f[C]>\f[R] 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 \f[C]>\f[]: +spaces after the \f[C]>\f[R]: .IP .nf \f[C] >\ \ \ \ \ code -\f[] +\f[R] .fi -.SS Extension: \f[C]blank_before_blockquote\f[] +.SS Extension: \f[C]blank_before_blockquote\f[R] .PP Standard 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 -\f[C]>\f[] to end up at the beginning of a line by accident (perhaps +\f[C]>\f[R] to end up at the beginning of a line by accident (perhaps through line wrapping). -So, unless the \f[C]markdown_strict\f[] format is used, the following +So, unless the \f[C]markdown_strict\f[R] format is used, the following does not produce a nested block quote in pandoc: .IP .nf \f[C] >\ This\ is\ a\ block\ quote. >>\ Nested. -\f[] +\f[R] .fi .SS Verbatim (code) blocks .SS Indented code blocks @@ -2842,7 +2857,7 @@ For example, \ \ \ \ if\ (a\ >\ 3)\ { \ \ \ \ \ \ moveShip(5\ *\ gravity,\ DOWN); \ \ \ \ } -\f[] +\f[R] .fi .PP The initial (four space or one tab) indentation is not considered part @@ -2850,23 +2865,23 @@ of the verbatim text, and is removed in the output. .PP Note: blank lines in the verbatim text need not begin with four spaces. .SS Fenced code blocks -.SS Extension: \f[C]fenced_code_blocks\f[] +.SS Extension: \f[C]fenced_code_blocks\f[R] .PP In addition to standard indented code blocks, pandoc supports -\f[I]fenced\f[] code blocks. -These begin with a row of three or more tildes (\f[C]~\f[]) and end with -a row of tildes that must be at least as long as the starting row. +\f[I]fenced\f[R] code blocks. +These begin with a row of three or more tildes (\f[C]\[ti]\f[R]) 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: .IP .nf \f[C] -~~~~~~~ +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] if\ (a\ >\ 3)\ { \ \ moveShip(5\ *\ gravity,\ DOWN); } -~~~~~~~ -\f[] +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] +\f[R] .fi .PP Like regular code blocks, fenced code blocks must be separated from @@ -2877,58 +2892,58 @@ longer row of tildes or backticks at the start and end: .IP .nf \f[C] -~~~~~~~~~~~~~~~~ -~~~~~~~~~~ +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] code\ including\ tildes -~~~~~~~~~~ -~~~~~~~~~~~~~~~~ -\f[] +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] +\f[R] .fi -.SS Extension: \f[C]backtick_code_blocks\f[] +.SS Extension: \f[C]backtick_code_blocks\f[R] .PP -Same as \f[C]fenced_code_blocks\f[], but uses backticks (\f[C]`\f[]) -instead of tildes (\f[C]~\f[]). -.SS Extension: \f[C]fenced_code_attributes\f[] +Same as \f[C]fenced_code_blocks\f[R], but uses backticks +(\f[C]\[ga]\f[R]) instead of tildes (\f[C]\[ti]\f[R]). +.SS Extension: \f[C]fenced_code_attributes\f[R] .PP Optionally, you may attach attributes to fenced or backtick code block using this syntax: .IP .nf \f[C] -~~~~\ {#mycode\ .haskell\ .numberLines\ startFrom="100"} +\[ti]\[ti]\[ti]\[ti]\ {#mycode\ .haskell\ .numberLines\ startFrom=\[dq]100\[dq]} qsort\ []\ \ \ \ \ =\ [] qsort\ (x:xs)\ =\ qsort\ (filter\ (<\ x)\ xs)\ ++\ [x]\ ++ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ qsort\ (filter\ (>=\ x)\ xs) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -\f[] +\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti]\[ti] +\f[R] .fi .PP -Here \f[C]mycode\f[] is an identifier, \f[C]haskell\f[] and -\f[C]numberLines\f[] are classes, and \f[C]startFrom\f[] is an attribute -with value \f[C]100\f[]. +Here \f[C]mycode\f[R] is an identifier, \f[C]haskell\f[R] and +\f[C]numberLines\f[R] are classes, and \f[C]startFrom\f[R] is an +attribute with value \f[C]100\f[R]. Some output formats can use this information to do syntax highlighting. Currently, the only output formats that uses 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 -\f[C]pandoc\ \-\-list\-highlight\-languages\f[].) Otherwise, the code +\f[C]pandoc\ \-\-list\-highlight\-languages\f[R].) Otherwise, the code block above will appear as follows: .IP .nf \f[C] -<pre\ id="mycode"\ class="haskell\ numberLines"\ startFrom="100"> +<pre\ id=\[dq]mycode\[dq]\ class=\[dq]haskell\ numberLines\[dq]\ startFrom=\[dq]100\[dq]> \ \ <code> \ \ ... \ \ </code> </pre> -\f[] +\f[R] .fi .PP -The \f[C]numberLines\f[] (or \f[C]number\-lines\f[]) class will cause -the lines of the code block to be numbered, starting with \f[C]1\f[] or -the value of the \f[C]startFrom\f[] attribute. -The \f[C]lineAnchors\f[] (or \f[C]line\-anchors\f[]) class will cause +The \f[C]numberLines\f[R] (or \f[C]number\-lines\f[R]) class will cause +the lines of the code block to be numbered, starting with \f[C]1\f[R] or +the value of the \f[C]startFrom\f[R] attribute. +The \f[C]lineAnchors\f[R] (or \f[C]line\-anchors\f[R]) class will cause the lines to be clickable anchors in HTML output. .PP A shortcut form can also be used for specifying the language of the code @@ -2936,34 +2951,34 @@ block: .IP .nf \f[C] -```haskell +\[ga]\[ga]\[ga]haskell qsort\ []\ =\ [] -``` -\f[] +\[ga]\[ga]\[ga] +\f[R] .fi .PP This is equivalent to: .IP .nf \f[C] -```\ {.haskell} +\[ga]\[ga]\[ga]\ {.haskell} qsort\ []\ =\ [] -``` -\f[] +\[ga]\[ga]\[ga] +\f[R] .fi .PP -If the \f[C]fenced_code_attributes\f[] extension is disabled, but input +If the \f[C]fenced_code_attributes\f[R] 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. .PP -To prevent all highlighting, use the \f[C]\-\-no\-highlight\f[] flag. -To set the highlighting style, use \f[C]\-\-highlight\-style\f[]. +To prevent all highlighting, use the \f[C]\-\-no\-highlight\f[R] flag. +To set the highlighting style, use \f[C]\-\-highlight\-style\f[R]. For more information on highlighting, see Syntax highlighting, below. .SS Line blocks -.SS Extension: \f[C]line_blocks\f[] +.SS Extension: \f[C]line_blocks\f[R] .PP A line block is a sequence of lines beginning with a vertical bar -(\f[C]|\f[]) followed by a space. +(\f[C]|\f[R]) 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: @@ -2978,7 +2993,7 @@ This is useful for verse and addresses: |\ 200\ Main\ St. |\ Berkeley,\ CA\ 94718 -\f[] +\f[R] .fi .PP The lines can be hard\-wrapped if needed, but the continuation line must @@ -2990,7 +3005,7 @@ begin with a space. \ \ Constable,\ Jr. |\ 200\ Main\ St. |\ Berkeley,\ CA\ 94718 -\f[] +\f[R] .fi .PP This syntax is borrowed from reStructuredText. @@ -2998,8 +3013,8 @@ This syntax is borrowed from reStructuredText. .SS Bullet lists .PP A bullet list is a list of bulleted list items. -A bulleted list item begins with a bullet (\f[C]*\f[], \f[C]+\f[], or -\f[C]\-\f[]). +A bulleted list item begins with a bullet (\f[C]*\f[R], \f[C]+\f[R], or +\f[C]\-\f[R]). Here is a simple example: .IP .nf @@ -3007,11 +3022,11 @@ Here is a simple example: *\ one *\ two *\ three -\f[] +\f[R] .fi .PP -This will produce a "compact" list. -If you want a "loose" list, in which each item is formatted as a +This will produce a \[dq]compact\[dq] list. +If you want a \[dq]loose\[dq] list, in which each item is formatted as a paragraph, put spaces between the items: .IP .nf @@ -3021,7 +3036,7 @@ paragraph, put spaces between the items: *\ two *\ three -\f[] +\f[R] .fi .PP The bullets need not be flush with the left margin; they may be indented @@ -3036,17 +3051,17 @@ List items look best if subsequent lines are flush with the first line *\ here\ is\ my\ first \ \ list\ item. *\ and\ my\ second. -\f[] +\f[R] .fi .PP -But Markdown also allows a "lazy" format: +But Markdown also allows a \[dq]lazy\[dq] format: .IP .nf \f[C] *\ here\ is\ my\ first list\ item. *\ and\ my\ second. -\f[] +\f[R] .fi .SS Block content in list items .PP @@ -3066,7 +3081,7 @@ marker. \ \ \ \ eight\ spaces: \ \ \ \ \ \ \ \ {\ code\ } -\f[] +\f[R] .fi .PP Exception: if the list marker is followed by an indented code block, @@ -3079,7 +3094,7 @@ marker: *\ \ \ \ \ code \ \ continuation\ paragraph -\f[] +\f[R] .fi .PP List items may include other lists. @@ -3098,11 +3113,11 @@ character after the list marker of the containing list item. *\ vegetables \ \ +\ broccoli \ \ +\ chard -\f[] +\f[R] .fi .PP -As noted above, Markdown allows you to write list items "lazily," -instead of indenting continuation lines. +As noted above, Markdown allows you to write list items +\[dq]lazily,\[dq] 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. .IP @@ -3116,7 +3131,7 @@ bad\ but\ is\ legal. \ \ \ \ Second\ paragraph\ of\ second list\ item. -\f[] +\f[R] .fi .SS Ordered lists .PP @@ -3133,7 +3148,7 @@ this list: 1.\ \ one 2.\ \ two 3.\ \ three -\f[] +\f[R] .fi .PP and this one: @@ -3143,9 +3158,9 @@ and this one: 5.\ \ one 7.\ \ two 1.\ \ three -\f[] +\f[R] .fi -.SS Extension: \f[C]fancy_lists\f[] +.SS Extension: \f[C]fancy_lists\f[R] .PP Unlike standard Markdown, pandoc allows ordered list items to be marked with uppercase and lowercase letters and roman numerals, in addition to @@ -3156,16 +3171,16 @@ 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. .PP -The \f[C]fancy_lists\f[] extension also allows \[aq]\f[C]#\f[]\[aq] to +The \f[C]fancy_lists\f[R] extension also allows \[aq]\f[C]#\f[R]\[aq] to be used as an ordered list marker in place of a numeral: .IP .nf \f[C] #.\ one #.\ two -\f[] +\f[R] .fi -.SS Extension: \f[C]startnum\f[] +.SS Extension: \f[C]startnum\f[R] .PP 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 @@ -3182,7 +3197,7 @@ numerals: \ \ \ \ \ \ \ i.\ subone \ \ \ \ \ \ ii.\ subtwo \ \ \ \ \ iii.\ subthree -\f[] +\f[R] .fi .PP Pandoc will start a new list each time a different type of list marker @@ -3195,20 +3210,20 @@ So, the following will create three lists: (5)\ Three 1.\ \ Four *\ \ \ Five -\f[] +\f[R] .fi .PP -If default list markers are desired, use \f[C]#.\f[]: +If default list markers are desired, use \f[C]#.\f[R]: .IP .nf \f[C] #.\ \ one #.\ \ two #.\ \ three -\f[] +\f[R] .fi .SS Definition lists -.SS Extension: \f[C]definition_lists\f[] +.SS Extension: \f[C]definition_lists\f[R] .PP Pandoc supports definition lists, using the syntax of PHP Markdown Extra with some extensions. @@ -3226,7 +3241,7 @@ Term\ 2\ with\ *inline\ markup* \ \ \ \ \ \ \ \ {\ some\ code,\ part\ of\ Definition\ 2\ } \ \ \ \ Third\ paragraph\ of\ definition\ 2. -\f[] +\f[R] .fi .PP Each term must fit on one line, which may optionally be followed by a @@ -3239,8 +3254,9 @@ one or more block elements (paragraph, code block, list, etc.), each indented four spaces or one tab stop. The body of the definition (including the first line, aside from the colon or tilde) should be indented four spaces. -However, as with other Markdown lists, you can "lazily" omit indentation -except at the beginning of a paragraph or other block element: +However, as with other Markdown lists, you can \[dq]lazily\[dq] omit +indentation except at the beginning of a paragraph or other block +element: .IP .nf \f[C] @@ -3250,7 +3266,7 @@ Term\ 1 with\ lazy\ continuation. \ \ \ \ Second\ paragraph\ of\ the\ definition. -\f[] +\f[R] .fi .PP If you leave space before the definition (as in the example above), the @@ -3263,38 +3279,38 @@ definition: .nf \f[C] Term\ 1 -\ \ ~\ Definition\ 1 +\ \ \[ti]\ Definition\ 1 Term\ 2 -\ \ ~\ Definition\ 2a -\ \ ~\ Definition\ 2b -\f[] +\ \ \[ti]\ Definition\ 2a +\ \ \[ti]\ Definition\ 2b +\f[R] .fi .PP Note that space between items in a definition list is required. -(A variant that loosens this requirement, but disallows "lazy" hard -wrapping, can be activated with \f[C]compact_definition_lists\f[]: see -Non\-pandoc extensions, below.) +(A variant that loosens this requirement, but disallows \[dq]lazy\[dq] +hard wrapping, can be activated with \f[C]compact_definition_lists\f[R]: +see Non\-pandoc extensions, below.) .SS Numbered example lists -.SS Extension: \f[C]example_lists\f[] +.SS Extension: \f[C]example_lists\f[R] .PP -The special list marker \f[C]\@\f[] can be used for sequentially +The special list marker \f[C]\[at]\f[R] can be used for sequentially numbered examples. -The first list item with a \f[C]\@\f[] marker will be numbered +The first list item with a \f[C]\[at]\f[R] marker will be numbered \[aq]1\[aq], the next \[aq]2\[aq], and so on, throughout the document. The numbered examples need not occur in a single list; each new list -using \f[C]\@\f[] will take up where the last stopped. +using \f[C]\[at]\f[R] will take up where the last stopped. So, for example: .IP .nf \f[C] -(\@)\ \ My\ first\ example\ will\ be\ numbered\ (1). -(\@)\ \ My\ second\ example\ will\ be\ numbered\ (2). +(\[at])\ \ My\ first\ example\ will\ be\ numbered\ (1). +(\[at])\ \ My\ second\ example\ will\ be\ numbered\ (2). Explanation\ of\ examples. -(\@)\ \ My\ third\ example\ will\ be\ numbered\ (3). -\f[] +(\[at])\ \ My\ third\ example\ will\ be\ numbered\ (3). +\f[R] .fi .PP Numbered examples can be labeled and referred to elsewhere in the @@ -3302,10 +3318,10 @@ document: .IP .nf \f[C] -(\@good)\ \ This\ is\ a\ good\ example. +(\[at]good)\ \ This\ is\ a\ good\ example. -As\ (\@good)\ illustrates,\ ... -\f[] +As\ (\[at]good)\ illustrates,\ ... +\f[R] .fi .PP The label can be any string of alphanumeric characters, underscores, or @@ -3313,14 +3329,14 @@ hyphens. .PP 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 \f[C]four_space_rule\f[] +That is, example lists always behave as if the \f[C]four_space_rule\f[R] 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. .SS Compact and loose lists .PP -Pandoc behaves differently from \f[C]Markdown.pl\f[] on some "edge -cases" involving lists. +Pandoc behaves differently from \f[C]Markdown.pl\f[R] on some \[dq]edge +cases\[dq] involving lists. Consider this source: .IP .nf @@ -3332,23 +3348,24 @@ Consider this source: \ \ \ \ \-\ \ \ Foe +\ \ \ Third -\f[] +\f[R] .fi .PP -Pandoc transforms this into a "compact list" (with no \f[C]<p>\f[] tags -around "First", "Second", or "Third"), while Markdown puts \f[C]<p>\f[] -tags around "Second" and "Third" (but not "First"), because of the blank -space around "Third". +Pandoc transforms this into a \[dq]compact list\[dq] (with no +\f[C]<p>\f[R] tags around \[dq]First\[dq], \[dq]Second\[dq], or +\[dq]Third\[dq]), while Markdown puts \f[C]<p>\f[R] tags around +\[dq]Second\[dq] and \[dq]Third\[dq] (but not \[dq]First\[dq]), because +of the blank space around \[dq]Third\[dq]. Pandoc follows a simple rule: if the text is followed by a blank line, it is treated as a paragraph. -Since "Second" is followed by a list, and not a blank line, it isn\[aq]t -treated as a paragraph. +Since \[dq]Second\[dq] is followed by a list, and not a blank line, it +isn\[aq]t treated as a paragraph. The fact that the list is followed by a blank line is irrelevant. -(Note: Pandoc works this way even when the \f[C]markdown_strict\f[] +(Note: Pandoc works this way even when the \f[C]markdown_strict\f[R] format is specified. This behavior is consistent with the official Markdown syntax description, even though it is different from that of -\f[C]Markdown.pl\f[].) +\f[C]Markdown.pl\f[R].) .SS Ending a list .PP What if you want to put an indented code block after a list? @@ -3359,16 +3376,16 @@ What if you want to put an indented code block after a list? \-\ \ \ item\ two \ \ \ \ {\ my\ code\ block\ } -\f[] +\f[R] .fi .PP Trouble! Here pandoc (like other Markdown implementations) will treat -\f[C]{\ my\ code\ block\ }\f[] as the second paragraph of item two, and +\f[C]{\ my\ code\ block\ }\f[R] as the second paragraph of item two, and not as a code block. .PP -To "cut off" the list after item two, you can insert some non\-indented -content, like an HTML comment, which won\[aq]t produce visible output in -any format: +To \[dq]cut off\[dq] the list after item two, you can insert some +non\-indented content, like an HTML comment, which won\[aq]t produce +visible output in any format: .IP .nf \f[C] @@ -3378,7 +3395,7 @@ any format: <!\-\-\ end\ of\ list\ \-\-> \ \ \ \ {\ my\ code\ block\ } -\f[] +\f[R] .fi .PP You can use the same trick if you want two consecutive lists instead of @@ -3395,12 +3412,12 @@ one big list: 1.\ \ uno 2.\ \ dos 3.\ \ tres -\f[] +\f[R] .fi .SS Horizontal rules .PP -A line containing a row of three or more \f[C]*\f[], \f[C]\-\f[], or -\f[C]_\f[] characters (optionally separated by spaces) produces a +A line containing a row of three or more \f[C]*\f[R], \f[C]\-\f[R], or +\f[C]_\f[R] characters (optionally separated by spaces) produces a horizontal rule: .IP .nf @@ -3408,7 +3425,7 @@ horizontal rule: *\ \ *\ \ *\ \ * \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -\f[] +\f[R] .fi .SS Tables .PP @@ -3417,14 +3434,14 @@ 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. -.SS Extension: \f[C]table_captions\f[] +.SS Extension: \f[C]table_captions\f[R] .PP 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 \f[C]Table:\f[] (or -just \f[C]:\f[]), which will be stripped off. +A caption is a paragraph beginning with the string \f[C]Table:\f[R] (or +just \f[C]:\f[R]), which will be stripped off. It may appear either before or after the table. -.SS Extension: \f[C]simple_tables\f[] +.SS Extension: \f[C]simple_tables\f[R] .PP Simple tables look like this: .IP @@ -3437,7 +3454,7 @@ Simple tables look like this: \ \ \ \ \ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ 1 Table:\ \ Demonstration\ of\ simple\ table\ syntax. -\f[] +\f[R] .fi .PP The headers and table rows must each fit on one line. @@ -3470,14 +3487,14 @@ For example: \ \ \ \ 123\ \ \ \ \ 123\ \ \ \ \ \ \ 123\ \ \ \ \ \ \ \ \ \ \ 123 \ \ \ \ \ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ \ 1 \-\-\-\-\-\-\-\ \ \ \ \ \-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\ \ \ \-\-\-\-\-\-\- -\f[] +\f[R] .fi .PP When headers are 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. -.SS Extension: \f[C]multiline_tables\f[] +.SS Extension: \f[C]multiline_tables\f[R] .PP Multiline tables allow headers and table rows to span multiple lines of text (but cells that span multiple columns or rows of the table are not @@ -3500,7 +3517,7 @@ Here is an example: Table:\ Here\[aq]s\ the\ caption.\ It,\ too,\ may\ span multiple\ lines. -\f[] +\f[R] .fi .PP These work like simple tables, but with the following differences: @@ -3532,13 +3549,13 @@ Headers may be omitted in multiline tables as well as simple tables: \-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- :\ Here\[aq]s\ a\ multiline\ table\ without\ headers. -\f[] +\f[R] .fi .PP 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. -.SS Extension: \f[C]grid_tables\f[] +.SS Extension: \f[C]grid_tables\f[R] .PP Grid tables look like this: .IP @@ -3555,11 +3572,11 @@ Grid tables look like this: |\ Oranges\ \ \ \ \ \ \ |\ $2.10\ \ \ \ \ \ \ \ \ |\ \-\ cures\ scurvy\ \ \ \ \ | |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ tasty\ \ \ \ \ \ \ \ \ \ \ \ | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ -\f[] +\f[R] .fi .PP -The row of \f[C]=\f[]s separates the header from the table body, and can -be omitted for a headerless table. +The row of \f[C]=\f[R]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 that span multiple columns or rows are not supported. @@ -3575,7 +3592,7 @@ the boundaries of the separator line after the header: +==============:+:==============+:==================:+ |\ Bananas\ \ \ \ \ \ \ |\ $1.34\ \ \ \ \ \ \ \ \ |\ built\-in\ wrapper\ \ \ | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ -\f[] +\f[R] .fi .PP For headerless tables, the colons go on the top line instead: @@ -3585,7 +3602,7 @@ For headerless tables, the colons go on the top line instead: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-:+:\-\-\-\-\-\-\-\-\-\-\-\-\-\-+:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:+ |\ Right\ \ \ \ \ \ \ \ \ |\ Left\ \ \ \ \ \ \ \ \ \ |\ Centered\ \ \ \ \ \ \ \ \ \ \ | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ -\f[] +\f[R] .fi .SS Grid Table Limitations .PP @@ -3596,7 +3613,7 @@ All grid tables must have the same number of columns in each row, and the same number of rows in each column. For example, the Docutils sample grid tables will not render as expected with Pandoc. -.SS Extension: \f[C]pipe_tables\f[] +.SS Extension: \f[C]pipe_tables\f[R] .PP Pipe tables look like this: .IP @@ -3609,7 +3626,7 @@ Pipe tables look like this: |\ \ \ \ 1\ \ |\ \ \ \ 1\ |\ \ \ \ \ 1\ \ \ |\ \ \ \ \ 1\ \ | \ \ :\ Demonstration\ of\ pipe\ table\ syntax. -\f[] +\f[R] .fi .PP The syntax is identical to PHP Markdown Extra tables. @@ -3630,17 +3647,17 @@ fruit|\ price apple|2.05 pear|1.37 orange|3.09 -\f[] +\f[R] .fi .PP The cells of pipe tables cannot contain block elements like paragraphs and lists, and cannot span multiple lines. If a pipe table contains a row whose printable content is wider than the -column width (see \f[C]\-\-columns\f[]), 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 \f[C]\-\-\-|\-\f[] would make the first column 3/4 and the +column width (see \f[C]\-\-columns\f[R]), 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 \f[C]\-\-\-|\-\f[R] 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. @@ -3654,15 +3671,15 @@ be produced by Emacs\[aq] orgtbl\-mode: |\-\-\-\-\-+\-\-\-\-\-\-\-| |\ my\ \ |\ table\ | |\ is\ \ |\ nice\ \ | -\f[] +\f[R] .fi .PP -The difference is that \f[C]+\f[] is used instead of \f[C]|\f[]. +The difference is that \f[C]+\f[R] is used instead of \f[C]|\f[R]. Other orgtbl features are not supported. In particular, to get non\-default column alignment, you\[aq]ll need to add colons as above. .SS Metadata blocks -.SS Extension: \f[C]pandoc_title_block\f[] +.SS Extension: \f[C]pandoc_title_block\f[R] .PP If the file begins with a title block .IP @@ -3671,7 +3688,7 @@ If the file begins with a title block %\ title %\ author(s)\ (separated\ by\ semicolons) %\ date -\f[] +\f[R] .fi .PP it will be parsed as bibliographic information, not regular text. @@ -3689,7 +3706,7 @@ no author, you need a blank line: %\ My\ title % %\ June\ 15,\ 2006 -\f[] +\f[R] .fi .PP The title may occupy multiple lines, but continuation lines must begin @@ -3699,7 +3716,7 @@ with leading space, thus: \f[C] %\ My\ title \ \ on\ multiple\ lines -\f[] +\f[R] .fi .PP If a document has multiple authors, the authors may be put on separate @@ -3715,7 +3732,7 @@ So, all of the following are equivalent: %\ Author\ One; \ \ Author\ Two -\f[] +\f[R] .fi .PP The date must fit on one line. @@ -3724,15 +3741,15 @@ All three metadata fields may contain standard inline formatting (italics, links, footnotes, etc.). .PP Title blocks will always be parsed, but they will affect the output only -when the \f[C]\-\-standalone\f[] (\f[C]\-s\f[]) option is chosen. +when the \f[C]\-\-standalone\f[R] (\f[C]\-s\f[R]) 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 -(\f[C]\-\-title\-prefix\f[] or \f[C]\-T\f[] option). -The title in the body appears as an H1 element with class "title", so it -can be suppressed or reformatted with CSS. -If a title prefix is specified with \f[C]\-T\f[] and no title block +(\f[C]\-\-title\-prefix\f[R] or \f[C]\-T\f[R] option). +The title in the body appears as an H1 element with class +\[dq]title\[dq], so it can be suppressed or reformatted with CSS. +If a title prefix is specified with \f[C]\-T\f[R] and no title block appears in the document, the title prefix will be used by itself as the HTML title. .PP @@ -3742,38 +3759,38 @@ 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 (\f[C]|\f[]) should be used to separate the +A single pipe character (\f[C]|\f[R]) should be used to separate the footer text from the header text. Thus, .IP .nf \f[C] %\ PANDOC(1) -\f[] +\f[R] .fi .PP -will yield a man page with the title \f[C]PANDOC\f[] and section 1. +will yield a man page with the title \f[C]PANDOC\f[R] and section 1. .IP .nf \f[C] %\ PANDOC(1)\ Pandoc\ User\ Manuals -\f[] +\f[R] .fi .PP -will also have "Pandoc User Manuals" in the footer. +will also have \[dq]Pandoc User Manuals\[dq] in the footer. .IP .nf \f[C] %\ PANDOC(1)\ Pandoc\ User\ Manuals\ |\ Version\ 4.0 -\f[] +\f[R] .fi .PP -will also have "Version 4.0" in the header. -.SS Extension: \f[C]yaml_metadata_block\f[] +will also have \[dq]Version 4.0\[dq] in the header. +.SS Extension: \f[C]yaml_metadata_block\f[R] .PP A YAML metadata block is a valid YAML object, delimited by a line of -three hyphens (\f[C]\-\-\-\f[]) at the top and a line of three hyphens -(\f[C]\-\-\-\f[]) or three dots (\f[C]\&...\f[]) at the bottom. +three hyphens (\f[C]\-\-\-\f[R]) at the top and a line of three hyphens +(\f[C]\-\-\-\f[R]) or three dots (\f[C]\&...\f[R]) at the bottom. 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 @@ -3784,12 +3801,12 @@ files: .nf \f[C] pandoc\ chap1.md\ chap2.md\ chap3.md\ metadata.yaml\ \-s\ \-o\ book.html -\f[] +\f[R] .fi .PP -Just be sure that the YAML file begins with \f[C]\-\-\-\f[] and ends -with \f[C]\-\-\-\f[] or \f[C]\&...\f[].) Alternatively, you can use the -\f[C]\-\-metadata\-file\f[] option. +Just be sure that the YAML file begins with \f[C]\-\-\-\f[R] and ends +with \f[C]\-\-\-\f[R] or \f[C]\&...\f[R].) Alternatively, you can use +the \f[C]\-\-metadata\-file\f[R] option. Using that approach however, you cannot reference content (like footnotes) from the main markdown input document. .PP @@ -3800,23 +3817,23 @@ 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, -\f[C]yes\f[], \f[C]True\f[], and \f[C]15\f[] cannot be used as field +\f[C]yes\f[R], \f[C]True\f[R], and \f[C]15\f[R] cannot be used as field names). .PP A document may contain multiple metadata blocks. The metadata fields will be combined through a \f[I]left\-biased -union\f[]: if two metadata blocks attempt to set the same field, the +union\f[R]: if two metadata blocks attempt to set the same field, the value from the first block will be taken. .PP -When pandoc is used with \f[C]\-t\ markdown\f[] to create a Markdown +When pandoc is used with \f[C]\-t\ markdown\f[R] to create a Markdown document, a YAML metadata block will be produced only if the -\f[C]\-s/\-\-standalone\f[] option is used. +\f[C]\-s/\-\-standalone\f[R] option is used. All of the metadata will appear in a single block at the beginning of the document. .PP Note that YAML escaping rules must be followed. Thus, for example, if a title contains a colon, it must be quoted. -The pipe character (\f[C]|\f[]) can be used to begin an indented block +The pipe character (\f[C]|\f[R]) 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: @@ -3834,24 +3851,24 @@ abstract:\ | \ \ It\ consists\ of\ two\ paragraphs. \&... -\f[] +\f[R] .fi .PP Template variables will be set automatically from the metadata. -Thus, for example, in writing HTML, the variable \f[C]abstract\f[] will -be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[] +Thus, for example, in writing HTML, the variable \f[C]abstract\f[R] will +be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[R] field: .IP .nf \f[C] <p>This\ is\ the\ abstract.</p> <p>It\ consists\ of\ two\ paragraphs.</p> -\f[] +\f[R] .fi .PP Variables can contain arbitrary YAML structures, but the template must match this structure. -The \f[C]author\f[] variable in the default templates expects a simple +The \f[C]author\f[R] 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 @@ -3867,7 +3884,7 @@ author: \-\ name:\ Author\ Two \ \ affiliation:\ University\ of\ Nowhere \&... -\f[] +\f[R] .fi .PP To use the structured authors in the example above, you would need a @@ -3882,13 +3899,13 @@ $else$ $author$ $endif$ $endfor$ -\f[] +\f[R] .fi .PP Raw content to include in the document\[aq]s header may be specified -using \f[C]header\-includes\f[]; however, it is important to mark up +using \f[C]header\-includes\f[R]; however, it is important to mark up this content as raw code for a particular output format, using the -\f[C]raw_attribute\f[] extension), or it will be interpreted as +\f[C]raw_attribute\f[R] extension), or it will be interpreted as markdown. For example: .IP @@ -3896,14 +3913,14 @@ For example: \f[C] header\-includes: \-\ | -\ \ ```{=latex} -\ \ \\let\\oldsection\\section -\ \ \\renewcommand{\\section}[1]{\\clearpage\\oldsection{#1}} -\ \ ``` -\f[] +\ \ \[ga]\[ga]\[ga]{=latex} +\ \ \[rs]let\[rs]oldsection\[rs]section +\ \ \[rs]renewcommand{\[rs]section}[1]{\[rs]clearpage\[rs]oldsection{#1}} +\ \ \[ga]\[ga]\[ga] +\f[R] .fi .SS Backslash escapes -.SS Extension: \f[C]all_symbols_escapable\f[] +.SS Extension: \f[C]all_symbols_escapable\f[R] .PP Except inside a code block or inline code, any punctuation or space character preceded by a backslash will be treated literally, even if it @@ -3912,8 +3929,8 @@ Thus, for example, if one writes .IP .nf \f[C] -*\\*hello\\** -\f[] +*\[rs]*hello\[rs]** +\f[R] .fi .PP one will get @@ -3921,7 +3938,7 @@ one will get .nf \f[C] <em>*hello*</em> -\f[] +\f[R] .fi .PP instead of @@ -3929,7 +3946,7 @@ instead of .nf \f[C] <strong>hello</strong> -\f[] +\f[R] .fi .PP This rule is easier to remember than standard Markdown\[aq]s rule, which @@ -3937,115 +3954,115 @@ allows only the following characters to be backslash\-escaped: .IP .nf \f[C] -\\`*_{}[]()>#+\-.! -\f[] +\[rs]\[ga]*_{}[]()>#+\-.! +\f[R] .fi .PP -(However, if the \f[C]markdown_strict\f[] format is used, the standard +(However, if the \f[C]markdown_strict\f[R] format is used, the standard Markdown rule will be used.) .PP A backslash\-escaped space is parsed as a nonbreaking space. -It will appear in TeX output as \f[C]~\f[] and in HTML and XML as -\f[C]\\ \f[] or \f[C]\\ \f[]. +It will appear in TeX output as \f[C]\[ti]\f[R] and in HTML and XML as +\f[C]\[rs] \f[R] or \f[C]\[rs] \f[R]. .PP 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 \f[C]\\\\\f[] and in HTML as -\f[C]<br\ />\f[]. -This is a nice alternative to Markdown\[aq]s "invisible" way of +It will appear in TeX output as \f[C]\[rs]\[rs]\f[R] and in HTML as +\f[C]<br\ />\f[R]. +This is a nice alternative to Markdown\[aq]s \[dq]invisible\[dq] way of indicating hard line breaks using two trailing spaces on a line. .PP Backslash escapes do not work in verbatim contexts. .SS Inline formatting .SS Emphasis .PP -To \f[I]emphasize\f[] some text, surround it with \f[C]*\f[]s or -\f[C]_\f[], like this: +To \f[I]emphasize\f[R] some text, surround it with \f[C]*\f[R]s or +\f[C]_\f[R], like this: .IP .nf \f[C] This\ text\ is\ _emphasized\ with\ underscores_,\ and\ this is\ *emphasized\ with\ asterisks*. -\f[] +\f[R] .fi .PP -Double \f[C]*\f[] or \f[C]_\f[] produces \f[B]strong emphasis\f[]: +Double \f[C]*\f[R] or \f[C]_\f[R] produces \f[B]strong emphasis\f[R]: .IP .nf \f[C] This\ is\ **strong\ emphasis**\ and\ __with\ underscores__. -\f[] +\f[R] .fi .PP -A \f[C]*\f[] or \f[C]_\f[] character surrounded by spaces, or +A \f[C]*\f[R] or \f[C]_\f[R] character surrounded by spaces, or backslash\-escaped, will not trigger emphasis: .IP .nf \f[C] -This\ is\ *\ not\ emphasized\ *,\ and\ \\*neither\ is\ this\\*. -\f[] +This\ is\ *\ not\ emphasized\ *,\ and\ \[rs]*neither\ is\ this\[rs]*. +\f[R] .fi -.SS Extension: \f[C]intraword_underscores\f[] +.SS Extension: \f[C]intraword_underscores\f[R] .PP -Because \f[C]_\f[] is sometimes used inside words and identifiers, -pandoc does not interpret a \f[C]_\f[] surrounded by alphanumeric +Because \f[C]_\f[R] is sometimes used inside words and identifiers, +pandoc does not interpret a \f[C]_\f[R] surrounded by alphanumeric characters as an emphasis marker. -If you want to emphasize just part of a word, use \f[C]*\f[]: +If you want to emphasize just part of a word, use \f[C]*\f[R]: .IP .nf \f[C] feas*ible*,\ not\ feas*able*. -\f[] +\f[R] .fi .SS Strikeout -.SS Extension: \f[C]strikeout\f[] +.SS Extension: \f[C]strikeout\f[R] .PP To strikeout a section of text with a horizontal line, begin and end it -with \f[C]~~\f[]. +with \f[C]\[ti]\[ti]\f[R]. Thus, for example, .IP .nf \f[C] -This\ ~~is\ deleted\ text.~~ -\f[] +This\ \[ti]\[ti]is\ deleted\ text.\[ti]\[ti] +\f[R] .fi .SS Superscripts and subscripts -.SS Extension: \f[C]superscript\f[], \f[C]subscript\f[] +.SS Extension: \f[C]superscript\f[R], \f[C]subscript\f[R] .PP Superscripts may be written by surrounding the superscripted text by -\f[C]^\f[] characters; subscripts may be written by surrounding the -subscripted text by \f[C]~\f[] characters. +\f[C]\[ha]\f[R] characters; subscripts may be written by surrounding the +subscripted text by \f[C]\[ti]\f[R] characters. Thus, for example, .IP .nf \f[C] -H~2~O\ is\ a\ liquid.\ \ 2^10^\ is\ 1024. -\f[] +H\[ti]2\[ti]O\ is\ a\ liquid.\ \ 2\[ha]10\[ha]\ is\ 1024. +\f[R] .fi .PP 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 \f[C]~\f[] and \f[C]^\f[].) Thus, if you want the -letter P with \[aq]a cat\[aq] in subscripts, use \f[C]P~a\\\ cat~\f[], -not \f[C]P~a\ cat~\f[]. +the ordinary use of \f[C]\[ti]\f[R] and \f[C]\[ha]\f[R].) Thus, if you +want the letter P with \[aq]a cat\[aq] in subscripts, use +\f[C]P\[ti]a\[rs]\ cat\[ti]\f[R], not \f[C]P\[ti]a\ cat\[ti]\f[R]. .SS Verbatim .PP To make a short span of text verbatim, put it inside backticks: .IP .nf \f[C] -What\ is\ the\ difference\ between\ `>>=`\ and\ `>>`? -\f[] +What\ is\ the\ difference\ between\ \[ga]>>=\[ga]\ and\ \[ga]>>\[ga]? +\f[R] .fi .PP If the verbatim text includes a backtick, use double backticks: .IP .nf \f[C] -Here\ is\ a\ literal\ backtick\ ``\ `\ ``. -\f[] +Here\ is\ a\ literal\ backtick\ \[ga]\[ga]\ \[ga]\ \[ga]\[ga]. +\f[R] .fi .PP (The spaces after the opening backticks and before the closing backticks @@ -4060,56 +4077,56 @@ in verbatim contexts: .IP .nf \f[C] -This\ is\ a\ backslash\ followed\ by\ an\ asterisk:\ `\\*`. -\f[] +This\ is\ a\ backslash\ followed\ by\ an\ asterisk:\ \[ga]\[rs]*\[ga]. +\f[R] .fi -.SS Extension: \f[C]inline_code_attributes\f[] +.SS Extension: \f[C]inline_code_attributes\f[R] .PP Attributes can be attached to verbatim text, just as with fenced code blocks: .IP .nf \f[C] -`<$>`{.haskell} -\f[] +\[ga]<$>\[ga]{.haskell} +\f[R] .fi .SS Small caps .PP -To write small caps, use the \f[C]smallcaps\f[] class: +To write small caps, use the \f[C]smallcaps\f[R] class: .IP .nf \f[C] [Small\ caps]{.smallcaps} -\f[] +\f[R] .fi .PP -Or, without the \f[C]bracketed_spans\f[] extension: +Or, without the \f[C]bracketed_spans\f[R] extension: .IP .nf \f[C] -<span\ class="smallcaps">Small\ caps</span> -\f[] +<span\ class=\[dq]smallcaps\[dq]>Small\ caps</span> +\f[R] .fi .PP For compatibility with other Markdown flavors, CSS is also supported: .IP .nf \f[C] -<span\ style="font\-variant:small\-caps;">Small\ caps</span> -\f[] +<span\ style=\[dq]font\-variant:small\-caps;\[dq]>Small\ caps</span> +\f[R] .fi .PP This will work in all output formats that support small caps. .SS Math -.SS Extension: \f[C]tex_math_dollars\f[] -.PP -Anything between two \f[C]$\f[] characters will be treated as TeX math. -The opening \f[C]$\f[] must have a non\-space character immediately to -its right, while the closing \f[C]$\f[] must have a non\-space character -immediately to its left, and must not be followed immediately by a -digit. -Thus, \f[C]$20,000\ and\ $30,000\f[] won\[aq]t parse as math. -If for some reason you need to enclose text in literal \f[C]$\f[] +.SS Extension: \f[C]tex_math_dollars\f[R] +.PP +Anything between two \f[C]$\f[R] characters will be treated as TeX math. +The opening \f[C]$\f[R] must have a non\-space character immediately to +its right, while the closing \f[C]$\f[R] must have a non\-space +character immediately to its left, and must not be followed immediately +by a digit. +Thus, \f[C]$20,000\ and\ $30,000\f[R] won\[aq]t parse as math. +If for some reason you need to enclose text in literal \f[C]$\f[R] characters, backslash\-escape them and they won\[aq]t be treated as math delimiters. .PP @@ -4117,44 +4134,44 @@ TeX math will be printed in all output formats. How it is rendered depends on the output format: .TP .B LaTeX -It will appear verbatim surrounded by \f[C]\\(...\\)\f[] (for inline -math) or \f[C]\\[...\\]\f[] (for display math). +It will appear verbatim surrounded by \f[C]\[rs](...\[rs])\f[R] (for +inline math) or \f[C]\[rs][...\[rs]]\f[R] (for display math). .RS .RE .TP .B Markdown, Emacs Org mode, ConTeXt, ZimWiki -It will appear verbatim surrounded by \f[C]$...$\f[] (for inline math) -or \f[C]$$...$$\f[] (for display math). +It will appear verbatim surrounded by \f[C]$...$\f[R] (for inline math) +or \f[C]$$...$$\f[R] (for display math). .RS .RE .TP .B reStructuredText -It will be rendered using an interpreted text role \f[C]:math:\f[]. +It will be rendered using an interpreted text role \f[C]:math:\f[R]. .RS .RE .TP .B AsciiDoc -It will be rendered as \f[C]latexmath:[...]\f[]. +It will be rendered as \f[C]latexmath:[...]\f[R]. .RS .RE .TP .B Texinfo -It will be rendered inside a \f[C]\@math\f[] command. +It will be rendered inside a \f[C]\[at]math\f[R] command. .RS .RE .TP .B groff man -It will be rendered verbatim without \f[C]$\f[]\[aq]s. +It will be rendered verbatim without \f[C]$\f[R]\[aq]s. .RS .RE .TP .B MediaWiki, DokuWiki -It will be rendered inside \f[C]<math>\f[] tags. +It will be rendered inside \f[C]<math>\f[R] tags. .RS .RE .TP .B Textile -It will be rendered inside \f[C]<span\ class="math">\f[] tags. +It will be rendered inside \f[C]<span\ class=\[dq]math\[dq]>\f[R] tags. .RS .RE .TP @@ -4170,8 +4187,8 @@ It will be rendered, if possible, using MathML. .RE .TP .B DocBook -If the \f[C]\-\-mathml\f[] flag is used, it will be rendered using -MathML in an \f[C]inlineequation\f[] or \f[C]informalequation\f[] tag. +If the \f[C]\-\-mathml\f[R] flag is used, it will be rendered using +MathML in an \f[C]inlineequation\f[R] or \f[C]informalequation\f[R] tag. Otherwise it will be rendered, if possible, using Unicode characters. .RS .RE @@ -4182,7 +4199,7 @@ It will be rendered using OMML math markup. .RE .TP .B FictionBook2 -If the \f[C]\-\-webtex\f[] option is used, formulas are rendered as +If the \f[C]\-\-webtex\f[R] 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. @@ -4196,27 +4213,34 @@ Therefore see Math rendering in HTML above. .RS .RE .SS Raw HTML -.SS Extension: \f[C]raw_html\f[] +.SS Extension: \f[C]raw_html\f[R] .PP Markdown allows you to insert raw HTML (or DocBook) anywhere in a -document (except verbatim contexts, where \f[C]<\f[], \f[C]>\f[], and -\f[C]&\f[] are interpreted literally). +document (except verbatim contexts, where \f[C]<\f[R], \f[C]>\f[R], and +\f[C]&\f[R] 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.) .PP The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous, -DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and -suppressed in other formats. -.SS Extension: \f[C]markdown_in_html_blocks\f[] -.PP -Standard Markdown allows you to include HTML "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. +DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile +output, and suppressed in other formats. +.PP +In the CommonMark format, if \f[C]raw_html\f[R] is enabled, +superscripts, subscripts, strikeouts and small capitals will be +represented as HTML. +Otherwise, plain\-text fallbacks will be used. +Note that even if \f[C]raw_html\f[R] is disabled, tables will be +rendered with HTML syntax if they cannot use pipe syntax. +.SS Extension: \f[C]markdown_in_html_blocks\f[R] +.PP +Standard Markdown allows you to include HTML \[dq]blocks\[dq]: 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), \f[C]*\f[] does not signify emphasis. +(for example), \f[C]*\f[R] does not signify emphasis. .PP -Pandoc behaves this way when the \f[C]markdown_strict\f[] format is +Pandoc behaves this way when the \f[C]markdown_strict\f[R] format is used; but by default, pandoc interprets material between HTML block tags as Markdown. Thus, for example, pandoc will turn @@ -4229,7 +4253,7 @@ Thus, for example, pandoc will turn <td>[a\ link](http://google.com)</td> </tr> </table> -\f[] +\f[R] .fi .PP into @@ -4239,37 +4263,37 @@ into <table> <tr> <td><em>one</em></td> -<td><a\ href="http://google.com">a\ link</a></td> +<td><a\ href=\[dq]http://google.com\[dq]>a\ link</a></td> </tr> </table> -\f[] +\f[R] .fi .PP -whereas \f[C]Markdown.pl\f[] will preserve it as is. +whereas \f[C]Markdown.pl\f[R] will preserve it as is. .PP -There is one exception to this rule: text between \f[C]<script>\f[] and -\f[C]<style>\f[] tags is not interpreted as Markdown. +There is one exception to this rule: text between \f[C]<script>\f[R] and +\f[C]<style>\f[R] tags is not interpreted as Markdown. .PP This departure from standard Markdown should make it easier to mix Markdown with HTML block elements. For example, one can surround a block of Markdown text with -\f[C]<div>\f[] tags without preventing it from being interpreted as +\f[C]<div>\f[R] tags without preventing it from being interpreted as Markdown. -.SS Extension: \f[C]native_divs\f[] +.SS Extension: \f[C]native_divs\f[R] .PP -Use native pandoc \f[C]Div\f[] blocks for content inside \f[C]<div>\f[] -tags. +Use native pandoc \f[C]Div\f[R] blocks for content inside +\f[C]<div>\f[R] tags. For the most part this should give the same output as -\f[C]markdown_in_html_blocks\f[], but it makes it easier to write pandoc -filters to manipulate groups of blocks. -.SS Extension: \f[C]native_spans\f[] +\f[C]markdown_in_html_blocks\f[R], but it makes it easier to write +pandoc filters to manipulate groups of blocks. +.SS Extension: \f[C]native_spans\f[R] .PP -Use native pandoc \f[C]Span\f[] blocks for content inside -\f[C]<span>\f[] tags. -For the most part this should give the same output as \f[C]raw_html\f[], -but it makes it easier to write pandoc filters to manipulate groups of -inlines. -.SS Extension: \f[C]raw_tex\f[] +Use native pandoc \f[C]Span\f[R] blocks for content inside +\f[C]<span>\f[R] tags. +For the most part this should give the same output as +\f[C]raw_html\f[R], but it makes it easier to write pandoc filters to +manipulate groups of inlines. +.SS Extension: \f[C]raw_tex\f[R] .PP In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be included in a document. @@ -4279,21 +4303,21 @@ Thus, for example, you can use LaTeX to include BibTeX citations: .IP .nf \f[C] -This\ result\ was\ proved\ in\ \\cite{jones.1967}. -\f[] +This\ result\ was\ proved\ in\ \[rs]cite{jones.1967}. +\f[R] .fi .PP Note that in LaTeX environments, like .IP .nf \f[C] -\\begin{tabular}{|l|l|}\\hline -Age\ &\ Frequency\ \\\\\ \\hline -18\-\-25\ \ &\ 15\ \\\\ -26\-\-35\ \ &\ 33\ \\\\ -36\-\-45\ \ &\ 22\ \\\\\ \\hline -\\end{tabular} -\f[] +\[rs]begin{tabular}{|l|l|}\[rs]hline +Age\ &\ Frequency\ \[rs]\[rs]\ \[rs]hline +18\-\-25\ \ &\ 15\ \[rs]\[rs] +26\-\-35\ \ &\ 33\ \[rs]\[rs] +36\-\-45\ \ &\ 22\ \[rs]\[rs]\ \[rs]hline +\[rs]end{tabular} +\f[R] .fi .PP the material between the begin and end tags will be interpreted as raw @@ -4302,61 +4326,61 @@ LaTeX, not as Markdown. Inline LaTeX is ignored in output formats other than Markdown, LaTeX, Emacs Org mode, and ConTeXt. .SS Generic raw attribute -.SS Extension: \f[C]raw_attribute\f[] +.SS Extension: \f[C]raw_attribute\f[R] .PP 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 groff \f[C]ms\f[] block: +For example, the following produces a raw groff \f[C]ms\f[R] block: .IP .nf \f[C] -```{=ms} +\[ga]\[ga]\[ga]{=ms} \&.MYMACRO blah\ blah -``` -\f[] +\[ga]\[ga]\[ga] +\f[R] .fi .PP -And the following produces a raw \f[C]html\f[] inline element: +And the following produces a raw \f[C]html\f[R] inline element: .IP .nf \f[C] -This\ is\ `<a>html</a>`{=html} -\f[] +This\ is\ \[ga]<a>html</a>\[ga]{=html} +\f[R] .fi .PP -This can be useful to insert raw xml into \f[C]docx\f[] documents, e.g. +This can be useful to insert raw xml into \f[C]docx\f[R] documents, e.g. a pagebreak: .IP .nf \f[C] -```{=openxml} +\[ga]\[ga]\[ga]{=openxml} <w:p> \ \ <w:r> -\ \ \ \ <w:br\ w:type="page"/> +\ \ \ \ <w:br\ w:type=\[dq]page\[dq]/> \ \ </w:r> </w:p> -``` -\f[] +\[ga]\[ga]\[ga] +\f[R] .fi .PP The format name should match the target format name (see -\f[C]\-t/\-\-to\f[], above, for a list, or use -\f[C]pandoc\ \-\-list\-output\-formats\f[]). -Use \f[C]openxml\f[] for \f[C]docx\f[] output, \f[C]opendocument\f[] for -\f[C]odt\f[] output, \f[C]html5\f[] for \f[C]epub3\f[] output, -\f[C]html4\f[] for \f[C]epub2\f[] output, and \f[C]latex\f[], -\f[C]beamer\f[], \f[C]ms\f[], or \f[C]html5\f[] for \f[C]pdf\f[] output -(depending on what you use for \f[C]\-\-pdf\-engine\f[]). +\f[C]\-t/\-\-to\f[R], above, for a list, or use +\f[C]pandoc\ \-\-list\-output\-formats\f[R]). +Use \f[C]openxml\f[R] for \f[C]docx\f[R] output, \f[C]opendocument\f[R] +for \f[C]odt\f[R] output, \f[C]html5\f[R] for \f[C]epub3\f[R] output, +\f[C]html4\f[R] for \f[C]epub2\f[R] output, and \f[C]latex\f[R], +\f[C]beamer\f[R], \f[C]ms\f[R], or \f[C]html5\f[R] for \f[C]pdf\f[R] +output (depending on what you use for \f[C]\-\-pdf\-engine\f[R]). .PP 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, -\f[C]backtick_code_blocks\f[] must be enabled. +\f[C]backtick_code_blocks\f[R] must be enabled. .PP The raw attribute cannot be combined with regular attributes. .SS LaTeX macros -.SS Extension: \f[C]latex_macros\f[] +.SS Extension: \f[C]latex_macros\f[R] .PP For output formats other than LaTeX, pandoc will parse LaTeX macro definitions and apply the resulting macros to all LaTeX math and raw @@ -4366,20 +4390,20 @@ LaTeX: .IP .nf \f[C] -\\newcommand{\\tuple}[1]{\\langle\ #1\ \\rangle} +\[rs]newcommand{\[rs]tuple}[1]{\[rs]langle\ #1\ \[rs]rangle} -$\\tuple{a,\ b,\ c}$ -\f[] +$\[rs]tuple{a,\ b,\ c}$ +\f[R] .fi .PP Note that LaTeX macros will not be applied if they occur inside inside a -raw span or block marked with the \f[C]raw_attribute\f[] extension. +raw span or block marked with the \f[C]raw_attribute\f[R] extension. .PP -When \f[C]latex_macros\f[] is disabled, the raw LaTeX and math will not +When \f[C]latex_macros\f[R] 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. .PP -Whether or not \f[C]latex_macros\f[] is enabled, the macro definitions +Whether or not \f[C]latex_macros\f[R] is enabled, the macro definitions will still be passed through as raw LaTeX. .SS Links .PP @@ -4392,8 +4416,8 @@ a link: .nf \f[C] <http://google.com> -<sam\@green.eggs.ham> -\f[] +<sam\[at]green.eggs.ham> +\f[R] .fi .SS Inline links .PP @@ -4404,8 +4428,8 @@ the URL in parentheses. .nf \f[C] This\ is\ an\ [inline\ link](/url),\ and\ here\[aq]s\ [one\ with -a\ title](http://fsf.org\ "click\ here\ for\ a\ good\ time!"). -\f[] +a\ title](http://fsf.org\ \[dq]click\ here\ for\ a\ good\ time!\[dq]). +\f[R] .fi .PP There can be no space between the bracketed part and the parenthesized @@ -4414,39 +4438,39 @@ The link text can contain formatting (such as emphasis), but the title cannot. .PP Email addresses in inline links are not autodetected, so they have to be -prefixed with \f[C]mailto\f[]: +prefixed with \f[C]mailto\f[R]: .IP .nf \f[C] -[Write\ me!](mailto:sam\@green.eggs.ham) -\f[] +[Write\ me!](mailto:sam\[at]green.eggs.ham) +\f[R] .fi .SS Reference links .PP -An \f[I]explicit\f[] reference link has two parts, the link itself and +An \f[I]explicit\f[R] 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). .PP 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 -\f[C]spaced_reference_links\f[] extension is enabled.) The link +\f[C]spaced_reference_links\f[R] 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 -\f[C]citations\f[] extension is enabled): citations take precedence over -link labels. +\f[C]citations\f[R] extension is enabled): citations take precedence +over link labels. .PP Here are some examples: .IP .nf \f[C] -[my\ label\ 1]:\ /foo/bar.html\ \ "My\ title,\ optional" +[my\ label\ 1]:\ /foo/bar.html\ \ \[dq]My\ title,\ optional\[dq] [my\ label\ 2]:\ /foo [my\ label\ 3]:\ http://fsf.org\ (The\ free\ software\ foundation) [my\ label\ 4]:\ /bar#special\ \ \[aq]A\ title\ in\ single\ quotes\[aq] -\f[] +\f[R] .fi .PP The URL may optionally be surrounded by angle brackets: @@ -4454,7 +4478,7 @@ The URL may optionally be surrounded by angle brackets: .nf \f[C] [my\ label\ 5]:\ <http://foo.bar.baz> -\f[] +\f[R] .fi .PP The title may go on the next line: @@ -4462,8 +4486,8 @@ The title may go on the next line: .nf \f[C] [my\ label\ 3]:\ http://fsf.org -\ \ "The\ free\ software\ foundation" -\f[] +\ \ \[dq]The\ free\ software\ foundation\[dq] +\f[R] .fi .PP Note that link labels are not case sensitive. @@ -4474,10 +4498,10 @@ So, this will work: Here\ is\ [my\ link][FOO] [Foo]:\ /bar/baz -\f[] +\f[R] .fi .PP -In an \f[I]implicit\f[] reference link, the second pair of brackets is +In an \f[I]implicit\f[R] reference link, the second pair of brackets is empty: .IP .nf @@ -4485,10 +4509,10 @@ empty: See\ [my\ website][]. [my\ website]:\ http://foo.bar.baz -\f[] +\f[R] .fi .PP -Note: In \f[C]Markdown.pl\f[] and most other Markdown implementations, +Note: In \f[C]Markdown.pl\f[R] 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. @@ -4500,11 +4524,11 @@ implementations: >\ My\ block\ [quote]. > >\ [quote]:\ /foo -\f[] +\f[R] .fi -.SS Extension: \f[C]shortcut_reference_links\f[] +.SS Extension: \f[C]shortcut_reference_links\f[R] .PP -In a \f[I]shortcut\f[] reference link, the second pair of brackets may +In a \f[I]shortcut\f[R] reference link, the second pair of brackets may be omitted entirely: .IP .nf @@ -4512,7 +4536,7 @@ be omitted entirely: See\ [my\ website]. [my\ website]:\ http://foo.bar.baz -\f[] +\f[R] .fi .SS Internal links .PP @@ -4523,7 +4547,7 @@ For example: .nf \f[C] See\ the\ [Introduction](#introduction). -\f[] +\f[R] .fi .PP or @@ -4533,26 +4557,27 @@ or See\ the\ [Introduction]. [Introduction]:\ #introduction -\f[] +\f[R] .fi .PP Internal links are currently supported for HTML formats (including HTML slide shows and EPUB), LaTeX, and ConTeXt. .SS Images .PP -A link immediately preceded by a \f[C]!\f[] will be treated as an image. +A link immediately preceded by a \f[C]!\f[R] will be treated as an +image. The link text will be used as the image\[aq]s alt text: .IP .nf \f[C] - + ![movie\ reel] [movie\ reel]:\ movie.gif -\f[] +\f[R] .fi -.SS Extension: \f[C]implicit_figures\f[] +.SS Extension: \f[C]implicit_figures\f[R] .PP An image with nonempty alt text, occurring by itself in a paragraph, will be rendered as a figure with a caption. @@ -4561,7 +4586,7 @@ The image\[aq]s alt text will be used as the caption. .nf \f[C]  -\f[] +\f[R] .fi .PP How this is rendered depends on the output format. @@ -4576,14 +4601,14 @@ One way to do this is to insert a nonbreaking space after the image: .IP .nf \f[C] -![This\ image\ won\[aq]t\ be\ a\ figure](/url/of/image.png)\\ -\f[] +![This\ image\ won\[aq]t\ be\ a\ figure](/url/of/image.png)\[rs] +\f[R] .fi .PP Note that in reveal.js slide shows, an image in a paragraph by itself -that has the \f[C]stretch\f[] class will fill the screen, and the +that has the \f[C]stretch\f[R] class will fill the screen, and the caption and figure tags will be omitted. -.SS Extension: \f[C]link_attributes\f[] +.SS Extension: \f[C]link_attributes\f[R] .PP Attributes can be set on links and images: .IP @@ -4592,68 +4617,72 @@ Attributes can be set on links and images: An\ inline\ {#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"} -\f[] +[ref]:\ foo.jpg\ \[dq]optional\ title\[dq]\ {#id\ .class\ key=val\ key2=\[dq]val\ 2\[dq]} +\f[R] .fi .PP (This syntax is compatible with PHP Markdown Extra when only -\f[C]#id\f[] and \f[C]\&.class\f[] are used.) +\f[C]#id\f[R] and \f[C]\&.class\f[R] are used.) .PP -For HTML and EPUB, all attributes except \f[C]width\f[] and -\f[C]height\f[] (but including \f[C]srcset\f[] and \f[C]sizes\f[]) are -passed through as is. +For HTML and EPUB, all attributes except \f[C]width\f[R] and +\f[C]height\f[R] (but including \f[C]srcset\f[R] and \f[C]sizes\f[R]) +are passed through as is. The other writers ignore attributes that are not supported by their output format. .PP -The \f[C]width\f[] and \f[C]height\f[] attributes on images are treated -specially. +The \f[C]width\f[R] and \f[C]height\f[R] 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: \f[C]px\f[], -\f[C]cm\f[], \f[C]mm\f[], \f[C]in\f[], \f[C]inch\f[] and \f[C]%\f[]. +However, any of the following unit identifiers can be used: +\f[C]px\f[R], \f[C]cm\f[R], \f[C]mm\f[R], \f[C]in\f[R], \f[C]inch\f[R] +and \f[C]%\f[R]. There must not be any spaces between the number and the unit. For example: .IP .nf \f[C] {\ width=50%\ } -\f[] +\f[R] .fi .IP \[bu] 2 Dimensions are converted to inches for output in page\-based formats like LaTeX. Dimensions are converted to pixels for output in HTML\-like formats. -Use the \f[C]\-\-dpi\f[] option to specify the number of pixels per +Use the \f[C]\-\-dpi\f[R] option to specify the number of pixels per inch. The default is 96dpi. .IP \[bu] 2 -The \f[C]%\f[] unit is generally relative to some available space. +The \f[C]%\f[R] unit is generally relative to some available space. For example the above example will render to -\f[C]<img\ href="file.jpg"\ style="width:\ 50%;"\ />\f[] (HTML), -\f[C]\\includegraphics[width=0.5\\textwidth]{file.jpg}\f[] (LaTeX), or -\f[C]\\externalfigure[file.jpg][width=0.5\\textwidth]\f[] (ConTeXt). +\f[C]<img\ href=\[dq]file.jpg\[dq]\ style=\[dq]width:\ 50%;\[dq]\ />\f[R] +(HTML), +\f[C]\[rs]includegraphics[width=0.5\[rs]textwidth]{file.jpg}\f[R] +(LaTeX), or +\f[C]\[rs]externalfigure[file.jpg][width=0.5\[rs]textwidth]\f[R] +(ConTeXt). .IP \[bu] 2 Some output formats have a notion of a class (ConTeXt) or a unique -identifier (LaTeX \f[C]\\caption\f[]), or both (HTML). +identifier (LaTeX \f[C]\[rs]caption\f[R]), or both (HTML). .IP \[bu] 2 -When no \f[C]width\f[] or \f[C]height\f[] attributes are specified, the -fallback is to look at the image resolution and the dpi metadata +When no \f[C]width\f[R] or \f[C]height\f[R] attributes are specified, +the fallback is to look at the image resolution and the dpi metadata embedded in the image file. .SS Divs and Spans .PP -Using the \f[C]native_divs\f[] and \f[C]native_spans\f[] extensions (see -above), HTML syntax can be used as part of markdown to create native -\f[C]Div\f[] and \f[C]Span\f[] elements in the pandoc AST (as opposed to -raw HTML). +Using the \f[C]native_divs\f[R] and \f[C]native_spans\f[R] extensions +(see above), HTML syntax can be used as part of markdown to create +native \f[C]Div\f[R] and \f[C]Span\f[R] elements in the pandoc AST (as +opposed to raw HTML). However, there is also nicer syntax available: -.SS Extension: \f[C]fenced_divs\f[] +.SS Extension: \f[C]fenced_divs\f[R] .PP -Allow special fenced syntax for native \f[C]Div\f[] blocks. +Allow special fenced syntax for native \f[C]Div\f[R] 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. The attribute syntax is exactly as in fenced code blocks (see Extension: -\f[C]fenced_code_attributes\f[]). +\f[C]fenced_code_attributes\f[R]). 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 @@ -4670,11 +4699,11 @@ Here\ is\ a\ paragraph. And\ another. ::::: -\f[] +\f[R] .fi .PP Fenced divs can be nested. -Opening fences are distinguished because they \f[I]must\f[] have +Opening fences are distinguished because they \f[I]must\f[R] have attributes: .IP .nf @@ -4686,7 +4715,7 @@ This\ is\ a\ warning. This\ is\ a\ warning\ within\ a\ warning. ::: :::::::::::::::::: -\f[] +\f[R] .fi .PP Fences without attributes are always closing fences. @@ -4694,29 +4723,29 @@ 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. -.SS Extension: \f[C]bracketed_spans\f[] +.SS Extension: \f[C]bracketed_spans\f[R] .PP A bracketed sequence of inlines, as one would use to begin a link, will -be treated as a \f[C]Span\f[] with attributes if it is followed +be treated as a \f[C]Span\f[R] with attributes if it is followed immediately by attributes: .IP .nf \f[C] -[This\ is\ *some\ text*]{.class\ key="val"} -\f[] +[This\ is\ *some\ text*]{.class\ key=\[dq]val\[dq]} +\f[R] .fi .SS Footnotes -.SS Extension: \f[C]footnotes\f[] +.SS Extension: \f[C]footnotes\f[R] .PP Pandoc\[aq]s Markdown allows footnotes, using the following syntax: .IP .nf \f[C] -Here\ is\ a\ footnote\ reference,[^1]\ and\ another.[^longnote] +Here\ is\ a\ footnote\ reference,[\[ha]1]\ and\ another.[\[ha]longnote] -[^1]:\ Here\ is\ the\ footnote. +[\[ha]1]:\ Here\ is\ the\ footnote. -[^longnote]:\ Here\[aq]s\ one\ with\ multiple\ blocks. +[\[ha]longnote]:\ Here\[aq]s\ one\ with\ multiple\ blocks. \ \ \ \ Subsequent\ paragraphs\ are\ indented\ to\ show\ that\ they belong\ to\ the\ previous\ footnote. @@ -4729,7 +4758,7 @@ belong\ to\ the\ previous\ footnote. This\ paragraph\ won\[aq]t\ be\ part\ of\ the\ note,\ because\ it isn\[aq]t\ indented. -\f[] +\f[R] .fi .PP The identifiers in footnote references may not contain spaces, tabs, or @@ -4742,7 +4771,7 @@ 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. -.SS Extension: \f[C]inline_notes\f[] +.SS Extension: \f[C]inline_notes\f[R] .PP Inline footnotes are also allowed (though, unlike regular notes, they cannot contain multiple paragraphs). @@ -4750,17 +4779,17 @@ The syntax is as follows: .IP .nf \f[C] -Here\ is\ an\ inline\ note.^[Inlines\ notes\ are\ easier\ to\ write,\ since +Here\ is\ an\ inline\ note.\[ha][Inlines\ notes\ are\ easier\ to\ write,\ since you\ don\[aq]t\ have\ to\ pick\ an\ identifier\ and\ move\ down\ to\ type\ the note.] -\f[] +\f[R] .fi .PP Inline and regular footnotes may be mixed freely. .SS Citations -.SS Extension: \f[C]citations\f[] +.SS Extension: \f[C]citations\f[R] .PP -Using an external filter, \f[C]pandoc\-citeproc\f[], pandoc can +Using an external filter, \f[C]pandoc\-citeproc\f[R], pandoc can automatically generate citations and a bibliography in a number of styles. Basic usage is @@ -4768,14 +4797,14 @@ Basic usage is .nf \f[C] pandoc\ \-\-filter\ pandoc\-citeproc\ myinput.txt -\f[] +\f[R] .fi .PP In order to use this feature, you will need to specify a bibliography -file using the \f[C]bibliography\f[] metadata field in a YAML metadata -section, or \f[C]\-\-bibliography\f[] command line argument. -You can supply multiple \f[C]\-\-bibliography\f[] arguments or set -\f[C]bibliography\f[] metadata field to YAML array, if you want to use +file using the \f[C]bibliography\f[R] metadata field in a YAML metadata +section, or \f[C]\-\-bibliography\f[R] command line argument. +You can supply multiple \f[C]\-\-bibliography\f[R] arguments or set +\f[C]bibliography\f[R] metadata field to YAML array, if you want to use multiple bibliography files. The bibliography may have any of these formats: .PP @@ -4845,54 +4874,54 @@ T}@T{ T} .TE .PP -Note that \f[C]\&.bib\f[] can be used with both BibTeX and BibLaTeX -files; use \f[C]\&.bibtex\f[] to force BibTeX. +Note that \f[C]\&.bib\f[R] can be used with both BibTeX and BibLaTeX +files; use \f[C]\&.bibtex\f[R] to force BibTeX. .PP -Note that \f[C]pandoc\-citeproc\ \-\-bib2json\f[] and -\f[C]pandoc\-citeproc\ \-\-bib2yaml\f[] can produce \f[C]\&.json\f[] and -\f[C]\&.yaml\f[] files from any of the supported formats. +Note that \f[C]pandoc\-citeproc\ \-\-bib2json\f[R] and +\f[C]pandoc\-citeproc\ \-\-bib2yaml\f[R] can produce \f[C]\&.json\f[R] +and \f[C]\&.yaml\f[R] files from any of the supported formats. .PP In\-field markup: In BibTeX and BibLaTeX databases, pandoc\-citeproc parses a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an HTML\-like markup: .TP -.B \f[C]<i>...</i>\f[] +.B \f[C]<i>...</i>\f[R] italics .RS .RE .TP -.B \f[C]<b>...</b>\f[] +.B \f[C]<b>...</b>\f[R] bold .RS .RE .TP -.B \f[C]<span\ style="font\-variant:small\-caps;">...</span>\f[] or \f[C]<sc>...</sc>\f[] +.B \f[C]<span\ style=\[dq]font\-variant:small\-caps;\[dq]>...</span>\f[R] or \f[C]<sc>...</sc>\f[R] small capitals .RS .RE .TP -.B \f[C]<sub>...</sub>\f[] +.B \f[C]<sub>...</sub>\f[R] subscript .RS .RE .TP -.B \f[C]<sup>...</sup>\f[] +.B \f[C]<sup>...</sup>\f[R] superscript .RS .RE .TP -.B \f[C]<span\ class="nocase">...</span>\f[] +.B \f[C]<span\ class=\[dq]nocase\[dq]>...</span>\f[R] prevent a phrase from being capitalized as title case .RS .RE .PP -\f[C]pandoc\-citeproc\ \-j\f[] and \f[C]\-y\f[] interconvert the CSL +\f[C]pandoc\-citeproc\ \-j\f[R] and \f[C]\-y\f[R] interconvert the CSL JSON and CSL YAML formats as far as possible. .PP As an alternative to specifying a bibliography file using -\f[C]\-\-bibliography\f[] or the YAML metadata field -\f[C]bibliography\f[], you can include the citation data directly in the -\f[C]references\f[] field of the document\[aq]s YAML metadata. +\f[C]\-\-bibliography\f[R] or the YAML metadata field +\f[C]bibliography\f[R], you can include the citation data directly in +the \f[C]references\f[R] field of the document\[aq]s YAML metadata. The field should contain an array of YAML\-encoded references, for example: .IP @@ -4923,80 +4952,84 @@ references: \ \ URL:\ http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html \ \ language:\ en\-GB \&... -\f[] +\f[R] .fi .PP -(\f[C]pandoc\-citeproc\ \-\-bib2yaml\f[] can produce these from a +(\f[C]pandoc\-citeproc\ \-\-bib2yaml\f[R] can produce these from a bibliography file in one of the supported formats.) .PP Citations and references can be formatted using any style supported by the Citation Style Language, listed in the Zotero Style Repository. -These files are specified using the \f[C]\-\-csl\f[] option or the -\f[C]csl\f[] metadata field. -By default, \f[C]pandoc\-citeproc\f[] will use the Chicago Manual of +These files are specified using the \f[C]\-\-csl\f[R] option or the +\f[C]csl\f[R] metadata field. +By default, \f[C]pandoc\-citeproc\f[R] will use the Chicago Manual of Style author\-date format. The CSL project provides further information on finding and editing styles. .PP To make your citations hyperlinks to the corresponding bibliography -entries, add \f[C]link\-citations:\ true\f[] to your YAML metadata. +entries, add \f[C]link\-citations:\ true\f[R] to your YAML metadata. .PP Citations go inside square brackets and are separated by semicolons. -Each citation must have a key, composed of \[aq]\@\[aq] + the citation -identifier from the database, and may optionally have a prefix, a -locator, and a suffix. -The citation key must begin with a letter, digit, or \f[C]_\f[], and may -contain alphanumerics, \f[C]_\f[], and internal punctuation characters -(\f[C]:.#$%&\-+?<>~/\f[]). +Each citation must have a key, composed of \[aq]\[at]\[aq] + the +citation identifier from the database, and may optionally have a prefix, +a locator, and a suffix. +The citation key must begin with a letter, digit, or \f[C]_\f[R], and +may contain alphanumerics, \f[C]_\f[R], and internal punctuation +characters (\f[C]:.#$%&\-+?<>\[ti]/\f[R]). Here are some examples: .IP .nf \f[C] -Blah\ blah\ [see\ \@doe99,\ pp.\ 33\-35;\ also\ \@smith04,\ chap.\ 1]. +Blah\ blah\ [see\ \[at]doe99,\ pp.\ 33\-35;\ also\ \[at]smith04,\ chap.\ 1]. -Blah\ blah\ [\@doe99,\ pp.\ 33\-35,\ 38\-39\ and\ *passim*]. +Blah\ blah\ [\[at]doe99,\ pp.\ 33\-35,\ 38\-39\ and\ *passim*]. -Blah\ blah\ [\@smith04;\ \@doe99]. -\f[] +Blah\ blah\ [\[at]smith04;\ \[at]doe99]. +\f[R] .fi .PP -\f[C]pandoc\-citeproc\f[] detects locator terms in the CSL locale files. +\f[C]pandoc\-citeproc\f[R] detects locator terms in the CSL locale +files. Either abbreviated or unabbreviated forms are accepted. -In the \f[C]en\-US\f[] locale, locator terms can be written in either -singular or plural forms, as \f[C]book\f[], \f[C]bk.\f[]/\f[C]bks.\f[]; -\f[C]chapter\f[], \f[C]chap.\f[]/\f[C]chaps.\f[]; \f[C]column\f[], -\f[C]col.\f[]/\f[C]cols.\f[]; \f[C]figure\f[], -\f[C]fig.\f[]/\f[C]figs.\f[]; \f[C]folio\f[], -\f[C]fol.\f[]/\f[C]fols.\f[]; \f[C]number\f[], -\f[C]no.\f[]/\f[C]nos.\f[]; \f[C]line\f[], \f[C]l.\f[]/\f[C]ll.\f[]; -\f[C]note\f[], \f[C]n.\f[]/\f[C]nn.\f[]; \f[C]opus\f[], -\f[C]op.\f[]/\f[C]opp.\f[]; \f[C]page\f[], \f[C]p.\f[]/\f[C]pp.\f[]; -\f[C]paragraph\f[], \f[C]para.\f[]/\f[C]paras.\f[]; \f[C]part\f[], -\f[C]pt.\f[]/\f[C]pts.\f[]; \f[C]section\f[], -\f[C]sec.\f[]/\f[C]secs.\f[]; \f[C]sub\ verbo\f[], -\f[C]s.v.\f[]/\f[C]s.vv.\f[]; \f[C]verse\f[], \f[C]v.\f[]/\f[C]vv.\f[]; -\f[C]volume\f[], \f[C]vol.\f[]/\f[C]vols.\f[]; \f[C]¶\f[]/\f[C]¶¶\f[]; -\f[C]§\f[]/\f[C]§§\f[]. -If no locator term is used, "page" is assumed. -.PP -A minus sign (\f[C]\-\f[]) before the \f[C]\@\f[] will suppress mention -of the author in the citation. +In the \f[C]en\-US\f[R] locale, locator terms can be written in either +singular or plural forms, as \f[C]book\f[R], +\f[C]bk.\f[R]/\f[C]bks.\f[R]; \f[C]chapter\f[R], +\f[C]chap.\f[R]/\f[C]chaps.\f[R]; \f[C]column\f[R], +\f[C]col.\f[R]/\f[C]cols.\f[R]; \f[C]figure\f[R], +\f[C]fig.\f[R]/\f[C]figs.\f[R]; \f[C]folio\f[R], +\f[C]fol.\f[R]/\f[C]fols.\f[R]; \f[C]number\f[R], +\f[C]no.\f[R]/\f[C]nos.\f[R]; \f[C]line\f[R], +\f[C]l.\f[R]/\f[C]ll.\f[R]; \f[C]note\f[R], \f[C]n.\f[R]/\f[C]nn.\f[R]; +\f[C]opus\f[R], \f[C]op.\f[R]/\f[C]opp.\f[R]; \f[C]page\f[R], +\f[C]p.\f[R]/\f[C]pp.\f[R]; \f[C]paragraph\f[R], +\f[C]para.\f[R]/\f[C]paras.\f[R]; \f[C]part\f[R], +\f[C]pt.\f[R]/\f[C]pts.\f[R]; \f[C]section\f[R], +\f[C]sec.\f[R]/\f[C]secs.\f[R]; \f[C]sub\ verbo\f[R], +\f[C]s.v.\f[R]/\f[C]s.vv.\f[R]; \f[C]verse\f[R], +\f[C]v.\f[R]/\f[C]vv.\f[R]; \f[C]volume\f[R], +\f[C]vol.\f[R]/\f[C]vols.\f[R]; \f[C]\[ps]\f[R]/\f[C]\[ps]\[ps]\f[R]; +\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R]. +If no locator term is used, \[dq]page\[dq] is assumed. +.PP +A minus sign (\f[C]\-\f[R]) before the \f[C]\[at]\f[R] will suppress +mention of the author in the citation. This can be useful when the author is already mentioned in the text: .IP .nf \f[C] -Smith\ says\ blah\ [\-\@smith04]. -\f[] +Smith\ says\ blah\ [\-\[at]smith04]. +\f[R] .fi .PP You can also write an in\-text citation, as follows: .IP .nf \f[C] -\@smith04\ says\ blah. +\[at]smith04\ says\ blah. -\@smith04\ [p.\ 33]\ says\ blah. -\f[] +\[at]smith04\ [p.\ 33]\ says\ blah. +\f[R] .fi .PP If the style calls for a list of works cited, it will be placed at the @@ -5008,31 +5041,31 @@ Normally, you will want to end your document with an appropriate header: last\ paragraph... #\ References -\f[] +\f[R] .fi .PP The bibliography will be inserted after this header. -Note that the \f[C]unnumbered\f[] class will be added to this header, so -that the section will not be numbered. +Note that the \f[C]unnumbered\f[R] class will be added to this header, +so that the section will not be numbered. .PP If you want to include items in the bibliography without actually citing -them in the body text, you can define a dummy \f[C]nocite\f[] metadata +them in the body text, you can define a dummy \f[C]nocite\f[R] metadata field and put the citations there: .IP .nf \f[C] \-\-\- nocite:\ | -\ \ \@item1,\ \@item2 +\ \ \[at]item1,\ \[at]item2 \&... -\@item3 -\f[] +\[at]item3 +\f[R] .fi .PP -In this example, the document will contain a citation for \f[C]item3\f[] -only, but the bibliography will contain entries for \f[C]item1\f[], -\f[C]item2\f[], and \f[C]item3\f[]. +In this example, the document will contain a citation for +\f[C]item3\f[R] only, but the bibliography will contain entries for +\f[C]item1\f[R], \f[C]item2\f[R], and \f[C]item3\f[R]. .PP It is possible to create a bibliography with all the citations, whether or not they appear in the document, by using a wildcard: @@ -5041,16 +5074,16 @@ or not they appear in the document, by using a wildcard: \f[C] \-\-\- nocite:\ | -\ \ \@* +\ \ \[at]* \&... -\f[] +\f[R] .fi .PP -For LaTeX output, you can also use \f[C]natbib\f[] or \f[C]biblatex\f[] -to render the bibliography. +For LaTeX output, you can also use \f[C]natbib\f[R] or +\f[C]biblatex\f[R] to render the bibliography. In order to do so, specify bibliography files as outlined above, and add -\f[C]\-\-natbib\f[] or \f[C]\-\-biblatex\f[] argument to \f[C]pandoc\f[] -invocation. +\f[C]\-\-natbib\f[R] or \f[C]\-\-biblatex\f[R] argument to +\f[C]pandoc\f[R] invocation. Bear in mind that bibliography files have to be in respective format (either BibTeX or BibLaTeX). .PP @@ -5058,31 +5091,31 @@ For more information, see the pandoc\-citeproc man page. .SS Non\-pandoc extensions .PP The following Markdown syntax extensions are not enabled by default in -pandoc, but may be enabled by adding \f[C]+EXTENSION\f[] to the format -name, where \f[C]EXTENSION\f[] is the name of the extension. -Thus, for example, \f[C]markdown+hard_line_breaks\f[] is Markdown with +pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format +name, where \f[C]EXTENSION\f[R] is the name of the extension. +Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with hard line breaks. -.SS Extension: \f[C]old_dashes\f[] +.SS Extension: \f[C]old_dashes\f[R] .PP Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes: -\f[C]\-\f[] before a numeral is an en\-dash, and \f[C]\-\-\f[] is an +\f[C]\-\f[R] before a numeral is an en\-dash, and \f[C]\-\-\f[R] is an em\-dash. -This option only has an effect if \f[C]smart\f[] is enabled. -It is selected automatically for \f[C]textile\f[] input. -.SS Extension: \f[C]angle_brackets_escapable\f[] +This option only has an effect if \f[C]smart\f[R] is enabled. +It is selected automatically for \f[C]textile\f[R] input. +.SS Extension: \f[C]angle_brackets_escapable\f[R] .PP -Allow \f[C]<\f[] and \f[C]>\f[] to be backslash\-escaped, as they can be -in GitHub flavored Markdown but not original Markdown. -This is implied by pandoc\[aq]s default \f[C]all_symbols_escapable\f[]. -.SS Extension: \f[C]lists_without_preceding_blankline\f[] +Allow \f[C]<\f[R] and \f[C]>\f[R] to be backslash\-escaped, as they can +be in GitHub flavored Markdown but not original Markdown. +This is implied by pandoc\[aq]s default \f[C]all_symbols_escapable\f[R]. +.SS Extension: \f[C]lists_without_preceding_blankline\f[R] .PP Allow a list to occur right after a paragraph, with no intervening blank space. -.SS Extension: \f[C]four_space_rule\f[] +.SS Extension: \f[C]four_space_rule\f[R] .PP Selects the pandoc <= 2.0 behavior for parsing lists, so that four spaces indent are needed for list item continuation paragraphs. -.SS Extension: \f[C]spaced_reference_links\f[] +.SS Extension: \f[C]spaced_reference_links\f[R] .PP Allow whitespace between the two components of a reference link, for example, @@ -5090,49 +5123,50 @@ example, .nf \f[C] [foo]\ [bar]. -\f[] +\f[R] .fi -.SS Extension: \f[C]hard_line_breaks\f[] +.SS Extension: \f[C]hard_line_breaks\f[R] .PP Causes all newlines within a paragraph to be interpreted as hard line breaks instead of spaces. -.SS Extension: \f[C]ignore_line_breaks\f[] +.SS Extension: \f[C]ignore_line_breaks\f[R] .PP 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. -.SS Extension: \f[C]east_asian_line_breaks\f[] +.SS Extension: \f[C]east_asian_line_breaks\f[R] .PP 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 \f[C]ignore_line_breaks\f[] for texts that +This is a better choice than \f[C]ignore_line_breaks\f[R] for texts that include a mix of East Asian wide characters and other characters. -.SS Extension: \f[C]emoji\f[] +.SS Extension: \f[C]emoji\f[R] .PP -Parses textual emojis like \f[C]:smile:\f[] as Unicode emoticons. -.SS Extension: \f[C]tex_math_single_backslash\f[] +Parses textual emojis like \f[C]:smile:\f[R] as Unicode emoticons. +.SS Extension: \f[C]tex_math_single_backslash\f[R] .PP -Causes anything between \f[C]\\(\f[] and \f[C]\\)\f[] to be interpreted -as inline TeX math, and anything between \f[C]\\[\f[] and \f[C]\\]\f[] -to be interpreted as display TeX math. +Causes anything between \f[C]\[rs](\f[R] and \f[C]\[rs])\f[R] to be +interpreted as inline TeX math, and anything between \f[C]\[rs][\f[R] +and \f[C]\[rs]]\f[R] to be interpreted as display TeX math. Note: a drawback of this extension is that it precludes escaping -\f[C](\f[] and \f[C][\f[]. -.SS Extension: \f[C]tex_math_double_backslash\f[] +\f[C](\f[R] and \f[C][\f[R]. +.SS Extension: \f[C]tex_math_double_backslash\f[R] .PP -Causes anything between \f[C]\\\\(\f[] and \f[C]\\\\)\f[] to be -interpreted as inline TeX math, and anything between \f[C]\\\\[\f[] and -\f[C]\\\\]\f[] to be interpreted as display TeX math. -.SS Extension: \f[C]markdown_attribute\f[] +Causes anything between \f[C]\[rs]\[rs](\f[R] and \f[C]\[rs]\[rs])\f[R] +to be interpreted as inline TeX math, and anything between +\f[C]\[rs]\[rs][\f[R] and \f[C]\[rs]\[rs]]\f[R] to be interpreted as +display TeX math. +.SS Extension: \f[C]markdown_attribute\f[R] .PP 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 -\f[C]markdown=1\f[]. -.SS Extension: \f[C]mmd_title_block\f[] +\f[C]markdown=1\f[R]. +.SS Extension: \f[C]mmd_title_block\f[R] .PP Enables a MultiMarkdown style title block at the top of the document, for example: @@ -5144,49 +5178,49 @@ Author:\ \ John\ Doe Date:\ \ \ \ September\ 1,\ 2008 Comment:\ This\ is\ a\ sample\ mmd\ title\ block,\ with \ \ \ \ \ \ \ \ \ a\ field\ spanning\ multiple\ lines. -\f[] +\f[R] .fi .PP See the MultiMarkdown documentation for details. -If \f[C]pandoc_title_block\f[] or \f[C]yaml_metadata_block\f[] is -enabled, it will take precedence over \f[C]mmd_title_block\f[]. -.SS Extension: \f[C]abbreviations\f[] +If \f[C]pandoc_title_block\f[R] or \f[C]yaml_metadata_block\f[R] is +enabled, it will take precedence over \f[C]mmd_title_block\f[R]. +.SS Extension: \f[C]abbreviations\f[R] .PP Parses PHP Markdown Extra abbreviation keys, like .IP .nf \f[C] *[HTML]:\ Hypertext\ Markup\ Language -\f[] +\f[R] .fi .PP 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). -.SS Extension: \f[C]autolink_bare_uris\f[] +.SS Extension: \f[C]autolink_bare_uris\f[R] .PP Makes all absolute URIs into links, even when not surrounded by pointy -braces \f[C]<...>\f[]. -.SS Extension: \f[C]mmd_link_attributes\f[] +braces \f[C]<...>\f[R]. +.SS Extension: \f[C]mmd_link_attributes\f[R] .PP Parses multimarkdown style key\-value attributes on link and image references. -This extension should not be confused with the \f[C]link_attributes\f[] +This extension should not be confused with the \f[C]link_attributes\f[R] extension. .IP .nf \f[C] This\ is\ a\ reference\ ![image][ref]\ with\ multimarkdown\ attributes. -[ref]:\ http://path.to/image\ "Image\ title"\ width=20px\ height=30px -\ \ \ \ \ \ \ id=myId\ class="myClass1\ myClass2" -\f[] +[ref]:\ http://path.to/image\ \[dq]Image\ title\[dq]\ width=20px\ height=30px +\ \ \ \ \ \ \ id=myId\ class=\[dq]myClass1\ myClass2\[dq] +\f[R] .fi -.SS Extension: \f[C]mmd_header_identifiers\f[] +.SS Extension: \f[C]mmd_header_identifiers\f[R] .PP Parses multimarkdown style header identifiers (in square brackets, after -the header but before any trailing \f[C]#\f[]s in an ATX header). -.SS Extension: \f[C]compact_definition_lists\f[] +the header but before any trailing \f[C]#\f[R]s in an ATX header). +.SS Extension: \f[C]compact_definition_lists\f[R] .PP Activates the definition list syntax of pandoc 1.12.x and earlier. This syntax differs from the one described above under Definition lists @@ -5195,9 +5229,9 @@ in several respects: No blank line is required between consecutive items of the definition list. .IP \[bu] 2 -To get a "tight" or "compact" list, omit space between consecutive -items; the space between a term and its definition does not affect -anything. +To get a \[dq]tight\[dq] or \[dq]compact\[dq] list, omit space between +consecutive items; the space between a term and its definition does not +affect anything. .IP \[bu] 2 Lazy wrapping of paragraphs is not allowed: the entire definition must be indented four spaces. @@ -5206,64 +5240,65 @@ be indented four spaces. In addition to pandoc\[aq]s extended Markdown, the following Markdown variants are supported: .TP -.B \f[C]markdown_phpextra\f[] (PHP Markdown Extra) -\f[C]footnotes\f[], \f[C]pipe_tables\f[], \f[C]raw_html\f[], -\f[C]markdown_attribute\f[], \f[C]fenced_code_blocks\f[], -\f[C]definition_lists\f[], \f[C]intraword_underscores\f[], -\f[C]header_attributes\f[], \f[C]link_attributes\f[], -\f[C]abbreviations\f[], \f[C]shortcut_reference_links\f[], -\f[C]spaced_reference_links\f[]. +.B \f[C]markdown_phpextra\f[R] (PHP Markdown Extra) +\f[C]footnotes\f[R], \f[C]pipe_tables\f[R], \f[C]raw_html\f[R], +\f[C]markdown_attribute\f[R], \f[C]fenced_code_blocks\f[R], +\f[C]definition_lists\f[R], \f[C]intraword_underscores\f[R], +\f[C]header_attributes\f[R], \f[C]link_attributes\f[R], +\f[C]abbreviations\f[R], \f[C]shortcut_reference_links\f[R], +\f[C]spaced_reference_links\f[R]. .RS .RE .TP -.B \f[C]markdown_github\f[] (deprecated GitHub\-Flavored Markdown) -\f[C]pipe_tables\f[], \f[C]raw_html\f[], \f[C]fenced_code_blocks\f[], -\f[C]gfm_auto_identifiers\f[], \f[C]ascii_identifiers\f[], -\f[C]backtick_code_blocks\f[], \f[C]autolink_bare_uris\f[], -\f[C]space_in_atx_header\f[], \f[C]intraword_underscores\f[], -\f[C]strikeout\f[], \f[C]emoji\f[], \f[C]shortcut_reference_links\f[], -\f[C]angle_brackets_escapable\f[], -\f[C]lists_without_preceding_blankline\f[]. +.B \f[C]markdown_github\f[R] (deprecated GitHub\-Flavored Markdown) +\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]fenced_code_blocks\f[R], +\f[C]gfm_auto_identifiers\f[R], \f[C]ascii_identifiers\f[R], +\f[C]backtick_code_blocks\f[R], \f[C]autolink_bare_uris\f[R], +\f[C]space_in_atx_header\f[R], \f[C]intraword_underscores\f[R], +\f[C]strikeout\f[R], \f[C]emoji\f[R], +\f[C]shortcut_reference_links\f[R], \f[C]angle_brackets_escapable\f[R], +\f[C]lists_without_preceding_blankline\f[R]. .RS .RE .TP -.B \f[C]markdown_mmd\f[] (MultiMarkdown) -\f[C]pipe_tables\f[], \f[C]raw_html\f[], \f[C]markdown_attribute\f[], -\f[C]mmd_link_attributes\f[], \f[C]tex_math_double_backslash\f[], -\f[C]intraword_underscores\f[], \f[C]mmd_title_block\f[], -\f[C]footnotes\f[], \f[C]definition_lists\f[], -\f[C]all_symbols_escapable\f[], \f[C]implicit_header_references\f[], -\f[C]auto_identifiers\f[], \f[C]mmd_header_identifiers\f[], -\f[C]shortcut_reference_links\f[], \f[C]implicit_figures\f[], -\f[C]superscript\f[], \f[C]subscript\f[], \f[C]backtick_code_blocks\f[], -\f[C]spaced_reference_links\f[], \f[C]raw_attribute\f[]. +.B \f[C]markdown_mmd\f[R] (MultiMarkdown) +\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]markdown_attribute\f[R], +\f[C]mmd_link_attributes\f[R], \f[C]tex_math_double_backslash\f[R], +\f[C]intraword_underscores\f[R], \f[C]mmd_title_block\f[R], +\f[C]footnotes\f[R], \f[C]definition_lists\f[R], +\f[C]all_symbols_escapable\f[R], \f[C]implicit_header_references\f[R], +\f[C]auto_identifiers\f[R], \f[C]mmd_header_identifiers\f[R], +\f[C]shortcut_reference_links\f[R], \f[C]implicit_figures\f[R], +\f[C]superscript\f[R], \f[C]subscript\f[R], +\f[C]backtick_code_blocks\f[R], \f[C]spaced_reference_links\f[R], +\f[C]raw_attribute\f[R]. .RS .RE .TP -.B \f[C]markdown_strict\f[] (Markdown.pl) -\f[C]raw_html\f[], \f[C]shortcut_reference_links\f[], -\f[C]spaced_reference_links\f[]. +.B \f[C]markdown_strict\f[R] (Markdown.pl) +\f[C]raw_html\f[R], \f[C]shortcut_reference_links\f[R], +\f[C]spaced_reference_links\f[R]. .RS .RE .PP -We also support \f[C]commonmark\f[] and \f[C]gfm\f[] (GitHub\-Flavored +We also support \f[C]commonmark\f[R] and \f[C]gfm\f[R] (GitHub\-Flavored Markdown, which is implemented as a set of extensions on -\f[C]commonmark\f[]). +\f[C]commonmark\f[R]). .PP -Note, however, that \f[C]commonmark\f[] and \f[C]gfm\f[] have limited +Note, however, that \f[C]commonmark\f[R] and \f[C]gfm\f[R] have limited support for extensions. -Only those listed below (and \f[C]smart\f[] and \f[C]raw_tex\f[]) will +Only those listed below (and \f[C]smart\f[R] and \f[C]raw_tex\f[R]) will work. The extensions can, however, all be individually disabled. -Also, \f[C]raw_tex\f[] only affects \f[C]gfm\f[] output, not input. +Also, \f[C]raw_tex\f[R] only affects \f[C]gfm\f[R] output, not input. .TP -.B \f[C]gfm\f[] (GitHub\-Flavored Markdown) -\f[C]pipe_tables\f[], \f[C]raw_html\f[], \f[C]fenced_code_blocks\f[], -\f[C]gfm_auto_identifiers\f[], \f[C]ascii_identifiers\f[], -\f[C]backtick_code_blocks\f[], \f[C]autolink_bare_uris\f[], -\f[C]intraword_underscores\f[], \f[C]strikeout\f[], -\f[C]hard_line_breaks\f[], \f[C]emoji\f[], -\f[C]shortcut_reference_links\f[], \f[C]angle_brackets_escapable\f[]. +.B \f[C]gfm\f[R] (GitHub\-Flavored Markdown) +\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]fenced_code_blocks\f[R], +\f[C]gfm_auto_identifiers\f[R], \f[C]ascii_identifiers\f[R], +\f[C]backtick_code_blocks\f[R], \f[C]autolink_bare_uris\f[R], +\f[C]intraword_underscores\f[R], \f[C]strikeout\f[R], +\f[C]hard_line_breaks\f[R], \f[C]emoji\f[R], +\f[C]shortcut_reference_links\f[R], \f[C]angle_brackets_escapable\f[R]. .RS .RE .SH PRODUCING SLIDE SHOWS WITH PANDOC @@ -5272,11 +5307,11 @@ 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 S5, DZSlides, Slidy, Slideous, or reveal.js. -You can also produce a PDF slide show using LaTeX \f[C]beamer\f[], or +You can also produce a PDF slide show using LaTeX \f[C]beamer\f[R], or slides shows in Microsoft PowerPoint format. .PP Here\[aq]s the Markdown source for a simple slide show, -\f[C]habits.txt\f[]: +\f[C]habits.txt\f[R]: .IP .nf \f[C] @@ -5311,7 +5346,7 @@ Here\[aq]s the Markdown source for a simple slide show, \-\ Get\ in\ bed \-\ Count\ sheep -\f[] +\f[R] .fi .PP To produce an HTML/JavaScript slide show, simply type @@ -5319,35 +5354,35 @@ To produce an HTML/JavaScript slide show, simply type .nf \f[C] pandoc\ \-t\ FORMAT\ \-s\ habits.txt\ \-o\ habits.html -\f[] +\f[R] .fi .PP -where \f[C]FORMAT\f[] is either \f[C]s5\f[], \f[C]slidy\f[], -\f[C]slideous\f[], \f[C]dzslides\f[], or \f[C]revealjs\f[]. +where \f[C]FORMAT\f[R] is either \f[C]s5\f[R], \f[C]slidy\f[R], +\f[C]slideous\f[R], \f[C]dzslides\f[R], or \f[C]revealjs\f[R]. .PP For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with -the \f[C]\-s/\-\-standalone\f[] option embeds a link to JavaScript and +the \f[C]\-s/\-\-standalone\f[R] option embeds a link to JavaScript and CSS files, which are assumed to be available at the relative path -\f[C]s5/default\f[] (for S5), \f[C]slideous\f[] (for Slideous), -\f[C]reveal.js\f[] (for reveal.js), or at the Slidy website at -\f[C]w3.org\f[] (for Slidy). -(These paths can be changed by setting the \f[C]slidy\-url\f[], -\f[C]slideous\-url\f[], \f[C]revealjs\-url\f[], or \f[C]s5\-url\f[] +\f[C]s5/default\f[R] (for S5), \f[C]slideous\f[R] (for Slideous), +\f[C]reveal.js\f[R] (for reveal.js), or at the Slidy website at +\f[C]w3.org\f[R] (for Slidy). +(These paths can be changed by setting the \f[C]slidy\-url\f[R], +\f[C]slideous\-url\f[R], \f[C]revealjs\-url\f[R], or \f[C]s5\-url\f[R] variables; see Variables for slides, above.) For DZSlides, the (relatively short) JavaScript and CSS are included in the file by default. .PP -With all HTML slide formats, the \f[C]\-\-self\-contained\f[] 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. +With all HTML slide formats, the \f[C]\-\-self\-contained\f[R] 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. .PP To produce a PDF slide show using beamer, type .IP .nf \f[C] pandoc\ \-t\ beamer\ habits.txt\ \-o\ habits.pdf -\f[] +\f[R] .fi .PP Note that a reveal.js slide show can also be converted to a PDF by @@ -5358,16 +5393,16 @@ To produce a Powerpoint slide show, type .nf \f[C] pandoc\ habits.txt\ \-o\ habits.pptx -\f[] +\f[R] .fi .SS Structuring the slide show .PP -By default, the \f[I]slide level\f[] is the highest header level in the +By default, the \f[I]slide level\f[R] is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. In the example above, level 1 headers are always followed by level 2 headers, which are followed by content, so 2 is the slide level. -This default can be overridden using the \f[C]\-\-slide\-level\f[] +This default can be overridden using the \f[C]\-\-slide\-level\f[R] option. .PP The document is carved up into slides according to the following rules: @@ -5376,14 +5411,14 @@ A horizontal rule always starts a new slide. .IP \[bu] 2 A header at the slide level always starts a new slide. .IP \[bu] 2 -Headers \f[I]below\f[] the slide level in the hierarchy create headers -\f[I]within\f[] a slide. +Headers \f[I]below\f[R] the slide level in the hierarchy create headers +\f[I]within\f[R] a slide. .IP \[bu] 2 -Headers \f[I]above\f[] the slide level in the hierarchy create "title -slides," which just contain the section title and help to break the -slide show into sections. +Headers \f[I]above\f[R] the slide level in the hierarchy create +\[dq]title slides,\[dq] which just contain the section title and help to +break the slide show into sections. .IP \[bu] 2 -Content \f[I]above\f[] the slide level will not appear in the slide +Content \f[I]above\f[R] the slide level will not appear in the slide show. .IP \[bu] 2 A title page is constructed automatically from the document\[aq]s title @@ -5404,13 +5439,13 @@ It is not recommended that you use deeper nesting of section levels with reveal.js. .SS Incremental lists .PP -By default, these writers produce lists that display "all at once." If -you want your lists to display incrementally (one item at a time), use -the \f[C]\-i\f[] option. +By default, these writers produce lists that display \[dq]all at +once.\[dq] If you want your lists to display incrementally (one item at +a time), use the \f[C]\-i\f[R] option. If you want a particular list to depart from the default, put it in a -\f[C]div\f[] block with class \f[C]incremental\f[] or -\f[C]nonincremental\f[]. -So, for example, using the \f[C]fenced\ div\f[] syntax, the following +\f[C]div\f[R] block with class \f[C]incremental\f[R] or +\f[C]nonincremental\f[R]. +So, for example, using the \f[C]fenced\ div\f[R] syntax, the following would be incremental regardless of the document default: .IP .nf @@ -5421,7 +5456,7 @@ would be incremental regardless of the document default: \-\ Drink\ wine ::: -\f[] +\f[R] .fi .PP or @@ -5434,29 +5469,29 @@ or \-\ Drink\ wine ::: -\f[] +\f[R] .fi .PP -While using \f[C]incremental\f[] and \f[C]nonincremental\f[] divs are +While using \f[C]incremental\f[R] and \f[C]nonincremental\f[R] divs are 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 \f[C]\-i\f[] option and all at once -with the \f[C]\-i\f[] option): +display incrementally without the \f[C]\-i\f[R] option and all at once +with the \f[C]\-i\f[R] option): .IP .nf \f[C] >\ \-\ Eat\ spaghetti >\ \-\ Drink\ wine -\f[] +\f[R] .fi .PP Both methods allow incremental and nonincremental lists to be mixed in a single document. .SS Inserting pauses .PP -You can add "pauses" within a slide by including a paragraph containing -three dots, separated by spaces: +You can add \[dq]pauses\[dq] within a slide by including a paragraph +containing three dots, separated by spaces: .IP .nf \f[C] @@ -5467,17 +5502,17 @@ content\ before\ the\ pause \&.\ .\ . content\ after\ the\ pause -\f[] +\f[R] .fi .SS Styling the slides .PP You can change the style of HTML slides by putting customized CSS files -in \f[C]$DATADIR/s5/default\f[] (for S5), \f[C]$DATADIR/slidy\f[] (for -Slidy), or \f[C]$DATADIR/slideous\f[] (for Slideous), where -\f[C]$DATADIR\f[] is the user data directory (see -\f[C]\-\-data\-dir\f[], above). +in \f[C]$DATADIR/s5/default\f[R] (for S5), \f[C]$DATADIR/slidy\f[R] (for +Slidy), or \f[C]$DATADIR/slideous\f[R] (for Slideous), where +\f[C]$DATADIR\f[R] is the user data directory (see +\f[C]\-\-data\-dir\f[R], above). The originals may be found in pandoc\[aq]s system data directory -(generally \f[C]$CABALDIR/pandoc\-VERSION/s5/default\f[]). +(generally \f[C]$CABALDIR/pandoc\-VERSION/s5/default\f[R]). Pandoc will look there for any files it does not find in the user data directory. .PP @@ -5485,40 +5520,40 @@ For dzslides, the CSS is included in the HTML file itself, and may be modified there. .PP All reveal.js configuration options can be set through variables. -For example, themes can be used by setting the \f[C]theme\f[] variable: +For example, themes can be used by setting the \f[C]theme\f[R] variable: .IP .nf \f[C] \-V\ theme=moon -\f[] +\f[R] .fi .PP -Or you can specify a custom stylesheet using the \f[C]\-\-css\f[] +Or you can specify a custom stylesheet using the \f[C]\-\-css\f[R] option. .PP -To style beamer slides, you can specify a \f[C]theme\f[], -\f[C]colortheme\f[], \f[C]fonttheme\f[], \f[C]innertheme\f[], and -\f[C]outertheme\f[], using the \f[C]\-V\f[] option: +To style beamer slides, you can specify a \f[C]theme\f[R], +\f[C]colortheme\f[R], \f[C]fonttheme\f[R], \f[C]innertheme\f[R], and +\f[C]outertheme\f[R], using the \f[C]\-V\f[R] option: .IP .nf \f[C] pandoc\ \-t\ beamer\ habits.txt\ \-V\ theme:Warsaw\ \-o\ habits.pdf -\f[] +\f[R] .fi .PP Note that header attributes will turn into slide attributes (on a -\f[C]<div>\f[] or \f[C]<section>\f[]) in HTML slide formats, allowing +\f[C]<div>\f[R] or \f[C]<section>\f[R]) in HTML slide formats, allowing you to style individual slides. In beamer, the only header attribute that affects slides is the -\f[C]allowframebreaks\f[] class, which sets the -\f[C]allowframebreaks\f[] option, causing multiple slides to be created +\f[C]allowframebreaks\f[R] class, which sets the +\f[C]allowframebreaks\f[R] option, causing multiple slides to be created if the content overfills the frame. This is recommended especially for bibliographies: .IP .nf \f[C] #\ References\ {.allowframebreaks} -\f[] +\f[R] .fi .SS Speaker notes .PP @@ -5535,10 +5570,10 @@ This\ is\ my\ note. \-\ like\ this\ list ::: -\f[] +\f[R] .fi .PP -To show the notes window in reveal.js, press \f[C]s\f[] while viewing +To show the notes window in reveal.js, press \f[C]s\f[R] while viewing the presentation. Speaker notes in PowerPoint will be available, as usual, in handouts and presenter view. @@ -5548,68 +5583,68 @@ not appear on the slides themselves. .SS Columns .PP To put material in side by side columns, you can use a native div -container with class \f[C]columns\f[], containing two or more div -containers with class \f[C]column\f[] and a \f[C]width\f[] attribute: +container with class \f[C]columns\f[R], containing two or more div +containers with class \f[C]column\f[R] and a \f[C]width\f[R] attribute: .IP .nf \f[C] ::::::::::::::\ {.columns} -:::\ {.column\ width="40%"} +:::\ {.column\ width=\[dq]40%\[dq]} contents... ::: -:::\ {.column\ width="60%"} +:::\ {.column\ width=\[dq]60%\[dq]} contents... ::: :::::::::::::: -\f[] +\f[R] .fi .SS Frame attributes in beamer .PP -Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[] option to -a frame in beamer (for example, when using the \f[C]minted\f[] +Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[R] option to +a frame in beamer (for example, when using the \f[C]minted\f[R] environment). -This can be forced by adding the \f[C]fragile\f[] class to the header +This can be forced by adding the \f[C]fragile\f[R] class to the header introducing the slide: .IP .nf \f[C] #\ Fragile\ slide\ {.fragile} -\f[] +\f[R] .fi .PP All of the other frame attributes described in Section 8.1 of the Beamer -User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[], -\f[C]allowframebreaks\f[], \f[C]b\f[], \f[C]c\f[], \f[C]t\f[], -\f[C]environment\f[], \f[C]label\f[], \f[C]plain\f[], \f[C]shrink\f[], -\f[C]standout\f[], \f[C]noframenumbering\f[]. +User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[R], +\f[C]allowframebreaks\f[R], \f[C]b\f[R], \f[C]c\f[R], \f[C]t\f[R], +\f[C]environment\f[R], \f[C]label\f[R], \f[C]plain\f[R], +\f[C]shrink\f[R], \f[C]standout\f[R], \f[C]noframenumbering\f[R]. .SS Background in reveal.js and beamer .PP Background images can be added to self\-contained reveal.js slideshows and to beamer slideshows. .PP For the same image on every slide, use the configuration option -\f[C]background\-image\f[] either in the YAML metadata block or as a +\f[C]background\-image\f[R] either in the YAML metadata block or as a command\-line variable. (There are no other options in beamer and the rest of this section concerns reveal.js slideshows.) .PP For reveal.js, you can instead use the reveal.js\-native option -\f[C]parallaxBackgroundImage\f[]. -You can also set \f[C]parallaxBackgroundHorizontal\f[] and -\f[C]parallaxBackgroundVertical\f[] the same way and must also set -\f[C]parallaxBackgroundSize\f[] to have your values take effect. +\f[C]parallaxBackgroundImage\f[R]. +You can also set \f[C]parallaxBackgroundHorizontal\f[R] and +\f[C]parallaxBackgroundVertical\f[R] the same way and must also set +\f[C]parallaxBackgroundSize\f[R] to have your values take effect. .PP To set an image for a particular reveal.js slide, add -\f[C]{data\-background\-image="/path/to/image"}\f[] to the first -slide\-level header on the slide (which may even be empty). +\f[C]{data\-background\-image=\[dq]/path/to/image\[dq]}\f[R] to the +first slide\-level header on the slide (which may even be empty). .PP In reveal.js\[aq]s overview mode, the parallaxBackgroundImage will show up only on the first slide. .PP Other reveal.js background settings also work on individual slides, -including \f[C]data\-background\-size\f[], -\f[C]data\-background\-repeat\f[], \f[C]data\-background\-color\f[], -\f[C]data\-transition\f[], and \f[C]data\-transition\-speed\f[]. +including \f[C]data\-background\-size\f[R], +\f[C]data\-background\-repeat\f[R], \f[C]data\-background\-color\f[R], +\f[C]data\-transition\f[R], and \f[C]data\-transition\-speed\f[R]. .PP See the reveal.js documentation for more details. .PP @@ -5626,15 +5661,15 @@ parallaxBackgroundImage:\ /path/to/my/background_image.png Slide\ 1\ has\ background_image.png\ as\ its\ background. -##\ {data\-background\-image="/path/to/special_image.jpg"} +##\ {data\-background\-image=\[dq]/path/to/special_image.jpg\[dq]} Slide\ 2\ has\ a\ special\ image\ for\ its\ background,\ even\ though\ the\ header\ has\ no\ content. -\f[] +\f[R] .fi .SH CREATING EPUBS WITH PANDOC .SS EPUB Metadata .PP -EPUB metadata may be specified using the \f[C]\-\-epub\-metadata\f[] +EPUB metadata may be specified using the \f[C]\-\-epub\-metadata\f[R] option, but if the source document is Markdown, it is better to use a YAML metadata block. Here is an example: @@ -5656,168 +5691,169 @@ identifier: \-\ scheme:\ DOI \ \ text:\ doi:10.234234.234/33 publisher:\ \ My\ Press -rights:\ ©\ 2007\ John\ Smith,\ CC\ BY\-NC +rights:\ \[co]\ 2007\ John\ Smith,\ CC\ BY\-NC ibooks: \ \ version:\ 1.3.4 \&... -\f[] +\f[R] .fi .PP The following fields are recognized: .TP -.B \f[C]identifier\f[] -Either a string value or an object with fields \f[C]text\f[] and -\f[C]scheme\f[]. -Valid values for \f[C]scheme\f[] are \f[C]ISBN\-10\f[], -\f[C]GTIN\-13\f[], \f[C]UPC\f[], \f[C]ISMN\-10\f[], \f[C]DOI\f[], -\f[C]LCCN\f[], \f[C]GTIN\-14\f[], \f[C]ISBN\-13\f[], -\f[C]Legal\ deposit\ number\f[], \f[C]URN\f[], \f[C]OCLC\f[], -\f[C]ISMN\-13\f[], \f[C]ISBN\-A\f[], \f[C]JP\f[], \f[C]OLCC\f[]. +.B \f[C]identifier\f[R] +Either a string value or an object with fields \f[C]text\f[R] and +\f[C]scheme\f[R]. +Valid values for \f[C]scheme\f[R] are \f[C]ISBN\-10\f[R], +\f[C]GTIN\-13\f[R], \f[C]UPC\f[R], \f[C]ISMN\-10\f[R], \f[C]DOI\f[R], +\f[C]LCCN\f[R], \f[C]GTIN\-14\f[R], \f[C]ISBN\-13\f[R], +\f[C]Legal\ deposit\ number\f[R], \f[C]URN\f[R], \f[C]OCLC\f[R], +\f[C]ISMN\-13\f[R], \f[C]ISBN\-A\f[R], \f[C]JP\f[R], \f[C]OLCC\f[R]. .RS .RE .TP -.B \f[C]title\f[] -Either a string value, or an object with fields \f[C]file\-as\f[] and -\f[C]type\f[], or a list of such objects. -Valid values for \f[C]type\f[] are \f[C]main\f[], \f[C]subtitle\f[], -\f[C]short\f[], \f[C]collection\f[], \f[C]edition\f[], -\f[C]extended\f[]. +.B \f[C]title\f[R] +Either a string value, or an object with fields \f[C]file\-as\f[R] and +\f[C]type\f[R], or a list of such objects. +Valid values for \f[C]type\f[R] are \f[C]main\f[R], \f[C]subtitle\f[R], +\f[C]short\f[R], \f[C]collection\f[R], \f[C]edition\f[R], +\f[C]extended\f[R]. .RS .RE .TP -.B \f[C]creator\f[] -Either a string value, or an object with fields \f[C]role\f[], -\f[C]file\-as\f[], and \f[C]text\f[], or a list of such objects. -Valid values for \f[C]role\f[] are MARC relators, but pandoc will -attempt to translate the human\-readable versions (like "author" and -"editor") to the appropriate marc relators. +.B \f[C]creator\f[R] +Either a string value, or an object with fields \f[C]role\f[R], +\f[C]file\-as\f[R], and \f[C]text\f[R], or a list of such objects. +Valid values for \f[C]role\f[R] are MARC relators, but pandoc will +attempt to translate the human\-readable versions (like \[dq]author\[dq] +and \[dq]editor\[dq]) to the appropriate marc relators. .RS .RE .TP -.B \f[C]contributor\f[] -Same format as \f[C]creator\f[]. +.B \f[C]contributor\f[R] +Same format as \f[C]creator\f[R]. .RS .RE .TP -.B \f[C]date\f[] -A string value in \f[C]YYYY\-MM\-DD\f[] format. +.B \f[C]date\f[R] +A string value in \f[C]YYYY\-MM\-DD\f[R] format. (Only the year is necessary.) Pandoc will attempt to convert other common date formats. .RS .RE .TP -.B \f[C]lang\f[] (or legacy: \f[C]language\f[]) +.B \f[C]lang\f[R] (or legacy: \f[C]language\f[R]) A string value in BCP 47 format. Pandoc will default to the local language if nothing is specified. .RS .RE .TP -.B \f[C]subject\f[] +.B \f[C]subject\f[R] A string value or a list of such values. .RS .RE .TP -.B \f[C]description\f[] +.B \f[C]description\f[R] A string value. .RS .RE .TP -.B \f[C]type\f[] +.B \f[C]type\f[R] A string value. .RS .RE .TP -.B \f[C]format\f[] +.B \f[C]format\f[R] A string value. .RS .RE .TP -.B \f[C]relation\f[] +.B \f[C]relation\f[R] A string value. .RS .RE .TP -.B \f[C]coverage\f[] +.B \f[C]coverage\f[R] A string value. .RS .RE .TP -.B \f[C]rights\f[] +.B \f[C]rights\f[R] A string value. .RS .RE .TP -.B \f[C]cover\-image\f[] +.B \f[C]cover\-image\f[R] A string value (path to cover image). .RS .RE .TP -.B \f[C]stylesheet\f[] +.B \f[C]stylesheet\f[R] A string value (path to CSS stylesheet). .RS .RE .TP -.B \f[C]page\-progression\-direction\f[] -Either \f[C]ltr\f[] or \f[C]rtl\f[]. -Specifies the \f[C]page\-progression\-direction\f[] attribute for the -\f[C]spine\f[] element. +.B \f[C]page\-progression\-direction\f[R] +Either \f[C]ltr\f[R] or \f[C]rtl\f[R]. +Specifies the \f[C]page\-progression\-direction\f[R] attribute for the +\f[C]spine\f[R] element. .RS .RE .TP -.B \f[C]ibooks\f[] +.B \f[C]ibooks\f[R] iBooks\-specific metadata, with the following fields: .RS .IP \[bu] 2 -\f[C]version\f[]: (string) +\f[C]version\f[R]: (string) .IP \[bu] 2 -\f[C]specified\-fonts\f[]: \f[C]true\f[]|\f[C]false\f[] (default -\f[C]false\f[]) +\f[C]specified\-fonts\f[R]: \f[C]true\f[R]|\f[C]false\f[R] (default +\f[C]false\f[R]) .IP \[bu] 2 -\f[C]ipad\-orientation\-lock\f[]: -\f[C]portrait\-only\f[]|\f[C]landscape\-only\f[] +\f[C]ipad\-orientation\-lock\f[R]: +\f[C]portrait\-only\f[R]|\f[C]landscape\-only\f[R] .IP \[bu] 2 -\f[C]iphone\-orientation\-lock\f[]: -\f[C]portrait\-only\f[]|\f[C]landscape\-only\f[] +\f[C]iphone\-orientation\-lock\f[R]: +\f[C]portrait\-only\f[R]|\f[C]landscape\-only\f[R] .IP \[bu] 2 -\f[C]binding\f[]: \f[C]true\f[]|\f[C]false\f[] (default \f[C]true\f[]) +\f[C]binding\f[R]: \f[C]true\f[R]|\f[C]false\f[R] (default +\f[C]true\f[R]) .IP \[bu] 2 -\f[C]scroll\-axis\f[]: -\f[C]vertical\f[]|\f[C]horizontal\f[]|\f[C]default\f[] +\f[C]scroll\-axis\f[R]: +\f[C]vertical\f[R]|\f[C]horizontal\f[R]|\f[C]default\f[R] .RE -.SS The \f[C]epub:type\f[] attribute +.SS The \f[C]epub:type\f[R] attribute .PP -For \f[C]epub3\f[] output, you can mark up the header that corresponds -to an EPUB chapter using the \f[C]epub:type\f[] attribute. -For example, to set the attribute to the value \f[C]prologue\f[], use +For \f[C]epub3\f[R] output, you can mark up the header that corresponds +to an EPUB chapter using the \f[C]epub:type\f[R] attribute. +For example, to set the attribute to the value \f[C]prologue\f[R], use this markdown: .IP .nf \f[C] #\ My\ chapter\ {epub:type=prologue} -\f[] +\f[R] .fi .PP Which will result in: .IP .nf \f[C] -<body\ epub:type="frontmatter"> -\ \ <section\ epub:type="prologue"> +<body\ epub:type=\[dq]frontmatter\[dq]> +\ \ <section\ epub:type=\[dq]prologue\[dq]> \ \ \ \ <h1>My\ chapter</h1> -\f[] +\f[R] .fi .PP -Pandoc will output \f[C]<body\ epub:type="bodymatter">\f[], unless you -use one of the following values, in which case either -\f[C]frontmatter\f[] or \f[C]backmatter\f[] will be output. +Pandoc will output \f[C]<body\ epub:type=\[dq]bodymatter\[dq]>\f[R], +unless you use one of the following values, in which case either +\f[C]frontmatter\f[R] or \f[C]backmatter\f[R] will be output. .PP .TS tab(@); l l. T{ -\f[C]epub:type\f[] of first section +\f[C]epub:type\f[R] of first section T}@T{ -\f[C]epub:type\f[] of body +\f[C]epub:type\f[R] of body T} _ T{ @@ -5904,22 +5940,22 @@ T} .SS Linked media .PP By default, pandoc will download media referenced from any -\f[C]<img>\f[], \f[C]<audio>\f[], \f[C]<video>\f[] or \f[C]<source>\f[] -element present in the generated EPUB, and include it in the EPUB -container, yielding a completely self\-contained EPUB. +\f[C]<img>\f[R], \f[C]<audio>\f[R], \f[C]<video>\f[R] or +\f[C]<source>\f[R] 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 \f[C]data\-external="1"\f[] to the tag with the -\f[C]src\f[] attribute. +your source and add \f[C]data\-external=\[dq]1\[dq]\f[R] to the tag with +the \f[C]src\f[R] attribute. For example: .IP .nf \f[C] -<audio\ controls="1"> -\ \ <source\ src="http://example.com/music/toccata.mp3" -\ \ \ \ \ \ \ \ \ \ data\-external="1"\ type="audio/mpeg"> +<audio\ controls=\[dq]1\[dq]> +\ \ <source\ src=\[dq]http://example.com/music/toccata.mp3\[dq] +\ \ \ \ \ \ \ \ \ \ data\-external=\[dq]1\[dq]\ type=\[dq]audio/mpeg\[dq]> \ \ </source> </audio> -\f[] +\f[R] .fi .SH SYNTAX HIGHLIGHTING .PP @@ -5929,44 +5965,44 @@ The Haskell library skylighting is used for highlighting. Currently highlighting is supported only for HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names that pandoc will recognize, type -\f[C]pandoc\ \-\-list\-highlight\-languages\f[]. +\f[C]pandoc\ \-\-list\-highlight\-languages\f[R]. .PP -The color scheme can be selected using the \f[C]\-\-highlight\-style\f[] -option. -The default color scheme is \f[C]pygments\f[], which imitates the +The color scheme can be selected using the +\f[C]\-\-highlight\-style\f[R] option. +The default color scheme is \f[C]pygments\f[R], 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 -\f[C]pandoc\ \-\-list\-highlight\-styles\f[]. +\f[C]pandoc\ \-\-list\-highlight\-styles\f[R]. .PP If you are not satisfied with the predefined styles, you can use -\f[C]\-\-print\-highlight\-style\f[] to generate a JSON -\f[C]\&.theme\f[] file which can be modified and used as the argument to -\f[C]\-\-highlight\-style\f[]. -To get a JSON version of the \f[C]pygments\f[] style, for example: +\f[C]\-\-print\-highlight\-style\f[R] to generate a JSON +\f[C]\&.theme\f[R] file which can be modified and used as the argument +to \f[C]\-\-highlight\-style\f[R]. +To get a JSON version of the \f[C]pygments\f[R] style, for example: .IP .nf \f[C] pandoc\ \-\-print\-highlight\-style\ pygments\ >\ my.theme -\f[] +\f[R] .fi .PP -Then edit \f[C]my.theme\f[] and use it like this: +Then edit \f[C]my.theme\f[R] and use it like this: .IP .nf \f[C] pandoc\ \-\-highlight\-style\ my.theme -\f[] +\f[R] .fi .PP If you are not satisfied with the built\-in highlighting, or you want highlight a language that isn\[aq]t supported, you can use the -\f[C]\-\-syntax\-definition\f[] option to load a KDE\-style XML syntax +\f[C]\-\-syntax\-definition\f[R] option to load a KDE\-style XML syntax definition file. Before writing your own, have a look at KDE\[aq]s repository of syntax definitions. .PP -To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option. +To disable highlighting, use the \f[C]\-\-no\-highlight\f[R] option. .SH CUSTOM STYLES IN DOCX .SS Input .PP @@ -5974,16 +6010,16 @@ 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\[aq]s styles. .PP -By enabling the \f[C]styles\f[] extension in the docx reader -(\f[C]\-f\ docx+styles\f[]), you can produce output that maintains the -styles of the input document, using the \f[C]custom\-style\f[] class. +By enabling the \f[C]styles\f[R] extension in the docx reader +(\f[C]\-f\ docx+styles\f[R]), you can produce output that maintains the +styles of the input document, using the \f[C]custom\-style\f[R] class. Paragraph styles are interpreted as divs, while character styles are interpreted as spans. .PP -For example, using the \f[C]custom\-style\-reference.docx\f[] file in +For example, using the \f[C]custom\-style\-reference.docx\f[R] file in the test directory, we have the following different outputs: .PP -Without the \f[C]+styles\f[] extension: +Without the \f[C]+styles\f[R] extension: .IP .nf \f[C] @@ -5994,7 +6030,7 @@ This\ is\ text\ with\ an\ *emphasized*\ text\ style.\ And\ this\ is\ text\ with\ **strengthened**\ text\ style. >\ Here\ is\ a\ styled\ paragraph\ that\ inherits\ from\ Block\ Text. -\f[] +\f[R] .fi .PP And with the extension: @@ -6003,20 +6039,20 @@ And with the extension: \f[C] $\ pandoc\ test/docx/custom\-style\-reference.docx\ \-f\ docx+styles\ \-t\ markdown -:::\ {custom\-style="FirstParagraph"} +:::\ {custom\-style=\[dq]FirstParagraph\[dq]} This\ is\ some\ text. ::: -:::\ {custom\-style="BodyText"} -This\ is\ text\ with\ an\ [emphasized]{custom\-style="Emphatic"}\ text\ style. -And\ this\ is\ text\ with\ a\ [strengthened]{custom\-style="Strengthened"} +:::\ {custom\-style=\[dq]BodyText\[dq]} +This\ is\ text\ with\ an\ [emphasized]{custom\-style=\[dq]Emphatic\[dq]}\ text\ style. +And\ this\ is\ text\ with\ a\ [strengthened]{custom\-style=\[dq]Strengthened\[dq]} text\ style. ::: -:::\ {custom\-style="MyBlockStyle"} +:::\ {custom\-style=\[dq]MyBlockStyle\[dq]} >\ Here\ is\ a\ styled\ paragraph\ that\ inherits\ from\ Block\ Text. ::: -\f[] +\f[R] .fi .PP With these custom styles, you can use your input document as a @@ -6028,38 +6064,38 @@ By default, pandoc\[aq]s docx 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 -\f[C]reference.docx\f[] file. +\f[C]reference.docx\f[R] 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 \f[C]div\f[]s and \f[C]span\f[]s, respectively. +blocks and text using \f[C]div\f[R]s and \f[C]span\f[R]s, respectively. .PP -If you define a \f[C]div\f[] or \f[C]span\f[] with the attribute -\f[C]custom\-style\f[], pandoc will apply your specified style to the +If you define a \f[C]div\f[R] or \f[C]span\f[R] with the attribute +\f[C]custom\-style\f[R], pandoc will apply your specified style to the contained elements. -So, for example using the \f[C]bracketed_spans\f[] syntax, +So, for example using the \f[C]bracketed_spans\f[R] syntax, .IP .nf \f[C] -[Get\ out]{custom\-style="Emphatically"},\ he\ said. -\f[] +[Get\ out]{custom\-style=\[dq]Emphatically\[dq]},\ he\ said. +\f[R] .fi .PP -would produce a docx file with "Get out" styled with character style -\f[C]Emphatically\f[]. -Similarly, using the \f[C]fenced_divs\f[] syntax, +would produce a docx file with \[dq]Get out\[dq] styled with character +style \f[C]Emphatically\f[R]. +Similarly, using the \f[C]fenced_divs\f[R] syntax, .IP .nf \f[C] Dickinson\ starts\ the\ poem\ simply: -:::\ {custom\-style="Poetry"} +:::\ {custom\-style=\[dq]Poetry\[dq]} |\ A\ Bird\ came\ down\ the\ Walk\-\-\- |\ He\ did\ not\ know\ I\ saw\-\-\- ::: -\f[] +\f[R] .fi .PP -would style the two contained lines with the \f[C]Poetry\f[] paragraph +would style the two contained lines with the \f[C]Poetry\f[R] paragraph style. .PP If the styles are not yet in your reference.docx, they will be defined @@ -6070,10 +6106,10 @@ This feature allows for greatest customization in conjunction with pandoc filters. 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 \f[C]Emphasis\f[] +If you want all italics to be transformed to the \f[C]Emphasis\f[R] character style (perhaps to change their color), you can write a filter which will transform all italicized inlines to inlines within an -\f[C]Emphasis\f[] custom\-style \f[C]span\f[]. +\f[C]Emphasis\f[R] custom\-style \f[C]span\f[R]. .SH CUSTOM WRITERS .PP Pandoc can be extended with custom writers written in lua. @@ -6087,7 +6123,7 @@ For example: .nf \f[C] pandoc\ \-t\ data/sample.lua -\f[] +\f[R] .fi .PP Creating a custom writer requires writing a lua function for each @@ -6098,11 +6134,11 @@ needs, do .nf \f[C] pandoc\ \-\-print\-default\-data\-file\ sample.lua -\f[] +\f[R] .fi .SH AUTHORS .PP -Copyright 2006\-2017 John MacFarlane (jgm\@berkeley.edu). +Copyright 2006\-2017 John MacFarlane (jgm\[at]berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.) For a full list |