git.iko.soy/typeable/pandoc
on master help sign in
Update man page.
commit92722eecbb0cbfc32088208e844821931b32e482 authorJohn MacFarlane <jgm@berkeley.edu> dateTue 31 Jan 2017, 16:04 (10 years ago) parentf23bcc6
1 file changed+161−158
man/pandoc.1+161−158
man/pandoc.1+161−158
@@ -1,10 +1,10 @@
11.\"t
2−.TH PANDOC 1 "January 29, 2017" "pandoc 1.19.2"
2+.TH PANDOC 1 "January 29, 2017" "pandoc 1.19.2.1"
33.SH NAME
44pandoc - general markup converter
55.SH SYNOPSIS
66.PP
7−\f[C]pandoc\f[] [\f[I]options\f[]] [\f[I]input\-file\f[]]\&...
7+\f[C]pandoc\f[] [\f[I]options\f[]] [\f[I]input\-file\f[]]...
88.SH DESCRIPTION
99.PP
1010Pandoc is a Haskell library for converting from one markup format to
@@ -23,13 +23,13 @@ Simple, and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows.
2323It can also produce PDF output on systems where LaTeX, ConTeXt, or
2424\f[C]wkhtmltopdf\f[] is installed.
2525.PP
26−Pandoc's enhanced version of Markdown includes syntax for footnotes,
26+Pandoc\[aq]s enhanced version of Markdown includes syntax for footnotes,
2727tables, flexible ordered lists, definition lists, fenced code blocks,
2828superscripts and subscripts, strikeout, metadata blocks, automatic
2929tables of contents, embedded LaTeX math, citations, and Markdown inside
3030HTML block elements.
31−(These enhancements, described further under Pandoc's Markdown, can be
32−disabled using the \f[C]markdown_strict\f[] input or output format.)
31+(These enhancements, described further under Pandoc\[aq]s Markdown, can
32+be disabled using the \f[C]markdown_strict\f[] input or output format.)
3333.PP
3434In contrast to most existing tools for converting Markdown to HTML,
3535which use regex substitutions, pandoc has a modular design: it consists
@@ -39,16 +39,16 @@ convert this native representation into a target format.
3939Thus, adding an input or output format requires only adding a reader or
4040writer.
4141.PP
42−Because pandoc's intermediate representation of a document is less
42+Because pandoc\[aq]s intermediate representation of a document is less
4343expressive than many of the formats it converts between, one should not
4444expect perfect conversions between every format and every other.
4545Pandoc attempts to preserve the structural elements of a document, but
4646not formatting details such as margin size.
4747And some document elements, such as complex tables, may not fit into
48−pandoc's simple document model.
49−While conversions from pandoc's Markdown to all formats aspire to be
50−perfect, conversions from formats more expressive than pandoc's Markdown
51−can be expected to be lossy.
48+pandoc\[aq]s simple document model.
49+While conversions from pandoc\[aq]s Markdown to all formats aspire to be
50+perfect, conversions from formats more expressive than pandoc\[aq]s
51+Markdown can be expected to be lossy.
5252.SS Using \f[C]pandoc\f[]
5353.PP
5454If no \f[I]input\-file\f[] is specified, input is read from
@@ -137,11 +137,11 @@ pandoc\ \-o\ hello.tex\ hello.txt
137137.PP
138138will convert \f[C]hello.txt\f[] from Markdown to LaTeX.
139139If no output file is specified (so that output goes to \f[I]stdout\f[]),
140−or if the output file's extension is unknown, the output format will
140+or if the output file\[aq]s extension is unknown, the output format will
141141default to HTML.
142142If no input file is specified (so that input comes from \f[I]stdin\f[]),
143−or if the input files' extensions are unknown, the input format will be
144−assumed to be Markdown unless explicitly specified.
143+or if the input files\[aq] extensions are unknown, the input format will
144+be assumed to be Markdown unless explicitly specified.
145145.PP
146146Pandoc uses the UTF\-8 character encoding for both input and output.
147147If your local character encoding is not UTF\-8, you should pipe input
@@ -208,7 +208,7 @@ as will \f[C]\-\-css\f[].
208208.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[]
209209Specify input format.
210210\f[I]FORMAT\f[] can be \f[C]native\f[] (native Haskell), \f[C]json\f[]
211−(JSON version of native AST), \f[C]markdown\f[] (pandoc's extended
211+(JSON version of native AST), \f[C]markdown\f[] (pandoc\[aq]s extended
212212Markdown), \f[C]markdown_strict\f[] (original unextended Markdown),
213213\f[C]markdown_phpextra\f[] (PHP Markdown Extra),
214214\f[C]markdown_github\f[] (GitHub\-Flavored Markdown),
@@ -227,9 +227,10 @@ appending \f[C]+EXTENSION\f[] or \f[C]\-EXTENSION\f[] to the format
227227name.
228228So, for example, \f[C]markdown_strict+footnotes+definition_lists\f[] is
229229strict Markdown with footnotes and definition lists enabled, and
230−\f[C]markdown\-pipe_tables+hard_line_breaks\f[] is pandoc's Markdown
230+\f[C]markdown\-pipe_tables+hard_line_breaks\f[] is pandoc\[aq]s Markdown
231231without pipe tables and with hard line breaks.
232−See Pandoc's Markdown, below, for a list of extensions and their names.
232+See Pandoc\[aq]s Markdown, below, for a list of extensions and their
233+names.
233234See \f[C]\-\-list\-input\-formats\f[] and \f[C]\-\-list\-extensions\f[],
234235below.
235236.RS
@@ -239,9 +240,10 @@ below.
239240Specify output format.
240241\f[I]FORMAT\f[] can be \f[C]native\f[] (native Haskell), \f[C]json\f[]
241242(JSON version of native AST), \f[C]plain\f[] (plain text),
242−\f[C]markdown\f[] (pandoc's extended Markdown), \f[C]markdown_strict\f[]
243−(original unextended Markdown), \f[C]markdown_phpextra\f[] (PHP Markdown
244−Extra), \f[C]markdown_github\f[] (GitHub\-Flavored Markdown),
243+\f[C]markdown\f[] (pandoc\[aq]s extended Markdown),
244+\f[C]markdown_strict\f[] (original unextended Markdown),
245+\f[C]markdown_phpextra\f[] (PHP Markdown Extra),
246+\f[C]markdown_github\f[] (GitHub\-Flavored Markdown),
245247\f[C]markdown_mmd\f[] (MultiMarkdown), \f[C]commonmark\f[] (CommonMark
246248Markdown), \f[C]rst\f[] (reStructuredText), \f[C]html\f[] (XHTML),
247249\f[C]html5\f[] (HTML5), \f[C]latex\f[] (LaTeX), \f[C]beamer\f[] (LaTeX
@@ -317,7 +319,7 @@ You can find the default user data directory on your system by looking
317319at the output of \f[C]pandoc\ \-\-version\f[].
318320A \f[C]reference.odt\f[], \f[C]reference.docx\f[], \f[C]epub.css\f[],
319321\f[C]templates\f[], \f[C]slidy\f[], \f[C]slideous\f[], or \f[C]s5\f[]
320−directory placed in this directory will override pandoc's normal
322+directory placed in this directory will override pandoc\[aq]s normal
321323defaults.
322324.RE
323325.TP
@@ -353,7 +355,7 @@ List supported output formats, one per line.
353355.B \f[C]\-\-list\-extensions\f[]
354356List supported Markdown extensions, one per line, followed by a
355357\f[C]+\f[] or \f[C]\-\f[] indicating whether it is enabled by default in
356−pandoc's Markdown.
358+pandoc\[aq]s Markdown.
357359.RS
358360.RE
359361.TP
@@ -399,8 +401,8 @@ Produce typographically correct output, converting straight quotes to
399401curly quotes, \f[C]\-\-\-\f[] to em\-dashes, \f[C]\-\-\f[] to
400402en\-dashes, and \f[C]\&...\f[] to ellipses.
401403Nonbreaking spaces are inserted after certain abbreviations, such as
402−\[lq]Mr.\[rq] (Note: This option is selected automatically when the
403−output format is \f[C]latex\f[] or \f[C]context\f[], unless
404+"Mr." (Note: This option is selected automatically when the output
405+format is \f[C]latex\f[] or \f[C]context\f[], unless
404406\f[C]\-\-no\-tex\-ligatures\f[] is used.
405407It has no effect for \f[C]latex\f[] input.)
406408.RS
@@ -420,7 +422,7 @@ Specify the base level for headers (defaults to 1).
420422.RE
421423.TP
422424.B \f[C]\-\-indented\-code\-classes=\f[]\f[I]CLASSES\f[]
423−Specify classes to use for indented code blocks\[en]for example,
425+Specify classes to use for indented code blocks\-\-for example,
424426\f[C]perl,numberLines\f[] or \f[C]haskell\f[].
425427Multiple classes may be separated by spaces or commas.
426428.RS
@@ -448,7 +450,7 @@ Reading binary files (docx, odt, epub) implies \f[C]\-\-file\-scope\f[].
448450Specify an executable to be used as a filter transforming the pandoc AST
449451after the input is parsed and before the output is written.
450452The executable should read JSON from stdin and write JSON to stdout.
451−The JSON must be formatted like pandoc's own JSON input and output.
453+The JSON must be formatted like pandoc\[aq]s own JSON input and output.
452454The name of the output format will be passed to the filter as the first
453455argument.
454456Hence,
@@ -522,7 +524,7 @@ Specify the number of spaces per tab (default is 4).
522524.TP
523525.B \f[C]\-\-track\-changes=accept\f[]|\f[C]reject\f[]|\f[C]all\f[]
524526Specifies what to do with insertions, deletions, and comments produced
525−by the MS Word \[lq]Track Changes\[rq] feature.
527+by the MS Word "Track Changes" feature.
526528\f[C]accept\f[] (the default), inserts all insertions, and ignores all
527529deletions.
528530\f[C]reject\f[] inserts all deletions and ignores insertions.
@@ -548,8 +550,8 @@ This option only affects the docx and epub readers.
548550.SS General writer options
549551.TP
550552.B \f[C]\-s\f[], \f[C]\-\-standalone\f[]
551−Produce output with an appropriate header and footer (e.g.\ a standalone
552−HTML, LaTeX, TEI, or RTF file, not a fragment).
553+Produce output with an appropriate header and footer (e.g.
554+a standalone HTML, LaTeX, TEI, or RTF file, not a fragment).
553555This option is set automatically for \f[C]pdf\f[], \f[C]epub\f[],
554556\f[C]epub3\f[], \f[C]fb2\f[], \f[C]docx\f[], and \f[C]odt\f[] output.
555557.RS
@@ -679,8 +681,9 @@ Implies \f[C]\-\-standalone\f[].
679681.TP
680682.B \f[C]\-B\f[] \f[I]FILE\f[], \f[C]\-\-include\-before\-body=\f[]\f[I]FILE\f[]
681683Include contents of \f[I]FILE\f[], verbatim, at the beginning of the
682−document body (e.g.\ after the \f[C]<body>\f[] tag in HTML, or the
683−\f[C]\\begin{document}\f[] command in LaTeX).
684+document body (e.g.
685+after the \f[C]<body>\f[] tag in HTML, or the \f[C]\\begin{document}\f[]
686+command in LaTeX).
684687This can be used to include navigation bars or banners in HTML
685688documents.
686689This option can be used repeatedly to include multiple files.
@@ -704,9 +707,9 @@ Implies \f[C]\-\-standalone\f[].
704707Produce a standalone HTML file with no external dependencies, using
705708\f[C]data:\f[] URIs to incorporate the contents of linked scripts,
706709stylesheets, images, and videos.
707−The resulting file should be \[lq]self\-contained,\[rq] in the sense
708−that it needs no external files and no net access to be displayed
709−properly by a browser.
710+The resulting file should be "self\-contained," in the sense that it
711+needs no external files and no net access to be displayed properly by a
712+browser.
710713This option works only with HTML output formats, including
711714\f[C]html\f[], \f[C]html5\f[], \f[C]html+lhs\f[], \f[C]html5+lhs\f[],
712715\f[C]s5\f[], \f[C]slidy\f[], \f[C]slideous\f[], \f[C]dzslides\f[], and
@@ -717,9 +720,9 @@ those at relative URLs will be sought relative to the working directory
717720first source file is remote).
718721Limitation: resources that are loaded dynamically through JavaScript
719722cannot be incorporated; as a result, \f[C]\-\-self\-contained\f[] does
720−not work with \f[C]\-\-mathjax\f[], and some advanced features
721−(e.g.\ zoom or speaker notes) may not work in an offline
722−\[lq]self\-contained\[rq] \f[C]reveal.js\f[] slide show.
723+not work with \f[C]\-\-mathjax\f[], and some advanced features (e.g.
724+zoom or speaker notes) may not work in an offline "self\-contained"
725+\f[C]reveal.js\f[] slide show.
723726.RS
724727.RE
725728.TP
@@ -790,16 +793,15 @@ Sections with class \f[C]unnumbered\f[] will never be numbered, even if
790793.RS
791794.RE
792795.TP
793−.B \f[C]\-\-number\-offset=\f[]\f[I]NUMBER\f[][\f[C],\f[]\f[I]NUMBER\f[]\f[C],\f[]\f[I]\&...\f[]]
796+.B \f[C]\-\-number\-offset=\f[]\f[I]NUMBER\f[][\f[C],\f[]\f[I]NUMBER\f[]\f[C],\f[]\f[I]...\f[]]
794797Offset for section headings in HTML output (ignored in other output
795798formats).
796799The first number is added to the section number for top\-level headers,
797800the second for second\-level headers, and so on.
798801So, for example, if you want the first top\-level header in your
799−document to be numbered \[lq]6\[rq], specify
800−\f[C]\-\-number\-offset=5\f[].
802+document to be numbered "6", specify \f[C]\-\-number\-offset=5\f[].
801803If your document starts with a level\-2 header which you want to be
802−numbered \[lq]1.5\[rq], specify \f[C]\-\-number\-offset=1,4\f[].
804+numbered "1.5", specify \f[C]\-\-number\-offset=1,4\f[].
803805Offsets are 0 by default.
804806Implies \f[C]\-\-number\-sections\f[].
805807.RS
@@ -1025,7 +1027,7 @@ body\ {\ font\-family:\ "DejaVuSans";\ }
10251027.TP
10261028.B \f[C]\-\-epub\-chapter\-level=\f[]\f[I]NUMBER\f[]
10271029Specify the header level at which to split the EPUB into separate
1028−\[lq]chapter\[rq] files.
1030+"chapter" files.
10291031The default is to split into chapters at level 1 headers.
10301032This option only affects the internal composition of the EPUB, not the
10311033way chapters and sections are displayed to users.
@@ -1054,7 +1056,7 @@ Note that no check for duplicate options is done.
10541056.SS Citation rendering
10551057.TP
10561058.B \f[C]\-\-bibliography=\f[]\f[I]FILE\f[]
1057−Set the \f[C]bibliography\f[] field in the document's metadata to
1059+Set the \f[C]bibliography\f[] field in the document\[aq]s metadata to
10581060\f[I]FILE\f[], overriding any value set in the metadata, and process
10591061citations using \f[C]pandoc\-citeproc\f[].
10601062(This is equivalent to
@@ -1068,15 +1070,15 @@ added to bibliography.
10681070.RE
10691071.TP
10701072.B \f[C]\-\-csl=\f[]\f[I]FILE\f[]
1071−Set the \f[C]csl\f[] field in the document's metadata to \f[I]FILE\f[],
1072−overriding any value set in the metadata.
1073+Set the \f[C]csl\f[] field in the document\[aq]s metadata to
1074+\f[I]FILE\f[], overriding any value set in the metadata.
10731075(This is equivalent to \f[C]\-\-metadata\ csl=FILE\f[].) This option is
10741076only relevant with \f[C]pandoc\-citeproc\f[].
10751077.RS
10761078.RE
10771079.TP
10781080.B \f[C]\-\-citation\-abbreviations=\f[]\f[I]FILE\f[]
1079−Set the \f[C]citation\-abbreviations\f[] field in the document's
1081+Set the \f[C]citation\-abbreviations\f[] field in the document\[aq]s
10801082metadata to \f[I]FILE\f[], overriding any value set in the metadata.
10811083(This is equivalent to
10821084\f[C]\-\-metadata\ citation\-abbreviations=FILE\f[].) This option is
@@ -1163,7 +1165,7 @@ to images.
11631165The formula will be concatenated with the URL provided.
11641166If \f[I]URL\f[] is not specified, the CodeCogs will be used.
11651167Note: the \f[C]\-\-webtex\f[] option will affect Markdown output as well
1166−as HTML, which is useful if you're targeting a version of Markdown
1168+as HTML, which is useful if you\[aq]re targeting a version of Markdown
11671169without native math support.
11681170.RS
11691171.RE
@@ -1344,7 +1346,7 @@ body of document
13441346.RE
13451347.TP
13461348.B \f[C]meta\-json\f[]
1347−JSON representation of all of the document's metadata
1349+JSON representation of all of the document\[aq]s metadata
13481350.RS
13491351.RE
13501352.SS Language variables
@@ -1386,8 +1388,8 @@ For bidirectional documents, native pandoc \f[C]span\f[]s and
13861388\f[C]div\f[]s with the \f[C]dir\f[] attribute (value \f[C]rtl\f[] or
13871389\f[C]ltr\f[]) can be used to override the base direction in some output
13881390formats.
1389−This may not always be necessary if the final renderer (e.g.\ the
1390−browser, when generating HTML) supports the Unicode Bidirectional
1391+This may not always be necessary if the final renderer (e.g.
1392+the browser, when generating HTML) supports the Unicode Bidirectional
13911393Algorithm.
13921394.PP
13931395When using LaTeX for bidirectional documents, only the \f[C]xelatex\f[]
@@ -1437,8 +1439,8 @@ controls navigation symbols in \f[C]beamer\f[] documents (default is
14371439.RE
14381440.TP
14391441.B \f[C]section\-titles\f[]
1440−enables on \[lq]title pages\[rq] for new sections in \f[C]beamer\f[]
1441−documents (default = true).
1442+enables on "title pages" for new sections in \f[C]beamer\f[] documents
1443+(default = true).
14421444.RS
14431445.RE
14441446.TP
@@ -1818,10 +1820,10 @@ We recommend tracking the changes in the default templates, and
18181820modifying your custom templates accordingly.
18191821An easy way to do this is to fork the pandoc\-templates repository and
18201822merge in changes after each pandoc release.
1821−.SH PANDOC'S MARKDOWN
1823+.SH PANDOC\[aq]S MARKDOWN
18221824.PP
18231825Pandoc understands an extended and slightly revised version of John
1824−Gruber's Markdown syntax.
1826+Gruber\[aq]s Markdown syntax.
18251827This document explains the syntax, noting differences from standard
18261828Markdown.
18271829Except where noted, these differences can be suppressed by using the
@@ -1830,7 +1832,7 @@ An extensions can be enabled by adding \f[C]+EXTENSION\f[] to the format
18301832name and disabled by adding \f[C]\-EXTENSION\f[].
18311833For example, \f[C]markdown_strict+footnotes\f[] is strict Markdown with
18321834footnotes enabled, while \f[C]markdown\-footnotes\-pipe_tables\f[] is
1833−pandoc's Markdown without footnotes or pipe tables.
1835+pandoc\[aq]s Markdown without footnotes or pipe tables.
18341836.SS Philosophy
18351837.PP
18361838Markdown is designed to be easy to write, and, even more importantly,
@@ -1838,16 +1840,16 @@ easy to read:
18381840.RS
18391841.PP
18401842A Markdown\-formatted document should be publishable as\-is, as plain
1841−text, without looking like it's been marked up with tags or formatting
1842−instructions.
1843−\[en] John Gruber
1843+text, without looking like it\[aq]s been marked up with tags or
1844+formatting instructions.
1845+\-\- John Gruber
18441846.RE
18451847.PP
1846−This principle has guided pandoc's decisions in finding syntax for
1848+This principle has guided pandoc\[aq]s decisions in finding syntax for
18471849tables, footnotes, and other extensions.
18481850.PP
1849−There is, however, one respect in which pandoc's aims are different from
1850−the original aims of Markdown.
1851+There is, however, one respect in which pandoc\[aq]s aims are different
1852+from the original aims of Markdown.
18511853Whereas Markdown was originally designed with HTML generation in mind,
18521854pandoc is designed for multiple output formats.
18531855Thus, while pandoc allows the embedding of raw HTML, it discourages it,
@@ -1871,8 +1873,8 @@ a hard line break, since trailing spaces in the cells are ignored.
18711873There are two kinds of headers: Setext and ATX.
18721874.SS Setext\-style headers
18731875.PP
1874−A setext\-style header is a line of text \[lq]underlined\[rq] with a row
1875−of \f[C]=\f[] signs (for a level one header) or \f[C]\-\f[] signs (for a
1876+A setext\-style header is a line of text "underlined" with a row of
1877+\f[C]=\f[] signs (for a level one header) or \f[C]\-\f[] signs (for a
18761878level two header):
18771879.IP
18781880.nf
@@ -1954,7 +1956,7 @@ My\ other\ header\ \ \ {#foo}
19541956(This syntax is compatible with PHP Markdown Extra.)
19551957.PP
19561958Note that although this syntax allows assignment of classes and
1957−key/value attributes, writers generally don't use all of this
1959+key/value attributes, writers generally don\[aq]t use all of this
19581960information.
19591961Identifiers, classes, and key/value attributes are used in HTML and
19601962HTML\-based formats such as EPUB and slidy.
@@ -2153,8 +2155,8 @@ indented more than three spaces.)
21532155\f[]
21542156.fi
21552157.PP
2156−A \[lq]lazy\[rq] form, which requires the \f[C]>\f[] character only on
2157−the first line of each block, is also allowed:
2158+A "lazy" form, which requires the \f[C]>\f[] character only on the first
2159+line of each block, is also allowed:
21582160.IP
21592161.nf
21602162\f[C]
@@ -2382,8 +2384,8 @@ Here is a simple example:
23822384\f[]
23832385.fi
23842386.PP
2385−This will produce a \[lq]compact\[rq] list.
2386−If you want a \[lq]loose\[rq] list, in which each item is formatted as a
2387+This will produce a "compact" list.
2388+If you want a "loose" list, in which each item is formatted as a
23872389paragraph, put spaces between the items:
23882390.IP
23892391.nf
@@ -2411,7 +2413,7 @@ List items look best if subsequent lines are flush with the first line
24112413\f[]
24122414.fi
24132415.PP
2414−But Markdown also allows a \[lq]lazy\[rq] format:
2416+But Markdown also allows a "lazy" format:
24152417.IP
24162418.nf
24172419\f[C]
@@ -2460,8 +2462,8 @@ The nested list must be indented four spaces or one tab:
24602462\f[]
24612463.fi
24622464.PP
2463−As noted above, Markdown allows you to write list items
2464−\[lq]lazily,\[rq] instead of indenting continuation lines.
2465+As noted above, Markdown allows you to write list items "lazily,"
2466+instead of indenting continuation lines.
24652467However, if there are multiple paragraphs or other blocks in a list
24662468item, the first line of each must be indented.
24672469.IP
@@ -2527,8 +2529,8 @@ They must be separated from the text that follows by at least one space,
25272529and, if the list marker is a capital letter with a period, by at least
25282530two spaces.
25292531.PP
2530−The \f[C]fancy_lists\f[] extension also allows `\f[C]#\f[]' to be used
2531−as an ordered list marker in place of a numeral:
2532+The \f[C]fancy_lists\f[] extension also allows \[aq]\f[C]#\f[]\[aq] to
2533+be used as an ordered list marker in place of a numeral:
25322534.IP
25332535.nf
25342536\f[C]
@@ -2610,9 +2612,8 @@ one or more block elements (paragraph, code block, list, etc.), each
26102612indented four spaces or one tab stop.
26112613The body of the definition (including the first line, aside from the
26122614colon or tilde) should be indented four spaces.
2613−However, as with other Markdown lists, you can \[lq]lazily\[rq] omit
2614−indentation except at the beginning of a paragraph or other block
2615−element:
2615+However, as with other Markdown lists, you can "lazily" omit indentation
2616+except at the beginning of a paragraph or other block element:
26162617.IP
26172618.nf
26182619\f[C]
@@ -2644,16 +2645,16 @@ Term\ 2
26442645.fi
26452646.PP
26462647Note that space between items in a definition list is required.
2647−(A variant that loosens this requirement, but disallows \[lq]lazy\[rq]
2648−hard wrapping, can be activated with \f[C]compact_definition_lists\f[]:
2649−see Non\-pandoc extensions, below.)
2648+(A variant that loosens this requirement, but disallows "lazy" hard
2649+wrapping, can be activated with \f[C]compact_definition_lists\f[]: see
2650+Non\-pandoc extensions, below.)
26502651.SS Numbered example lists
26512652.SS Extension: \f[C]example_lists\f[]
26522653.PP
26532654The special list marker \f[C]\@\f[] can be used for sequentially
26542655numbered examples.
2655−The first list item with a \f[C]\@\f[] marker will be numbered `1', the
2656−next `2', and so on, throughout the document.
2656+The first list item with a \f[C]\@\f[] marker will be numbered
2657+\[aq]1\[aq], the next \[aq]2\[aq], and so on, throughout the document.
26572658The numbered examples need not occur in a single list; each new list
26582659using \f[C]\@\f[] will take up where the last stopped.
26592660So, for example:
@@ -2684,8 +2685,8 @@ The label can be any string of alphanumeric characters, underscores, or
26842685hyphens.
26852686.SS Compact and loose lists
26862687.PP
2687−Pandoc behaves differently from \f[C]Markdown.pl\f[] on some \[lq]edge
2688−cases\[rq] involving lists.
2688+Pandoc behaves differently from \f[C]Markdown.pl\f[] on some "edge
2689+cases" involving lists.
26892690Consider this source:
26902691.IP
26912692.nf
@@ -2700,15 +2701,14 @@ Consider this source:
27002701\f[]
27012702.fi
27022703.PP
2703−Pandoc transforms this into a \[lq]compact list\[rq] (with no
2704−\f[C]<p>\f[] tags around \[lq]First\[rq], \[lq]Second\[rq], or
2705−\[lq]Third\[rq]), while Markdown puts \f[C]<p>\f[] tags around
2706−\[lq]Second\[rq] and \[lq]Third\[rq] (but not \[lq]First\[rq]), because
2707−of the blank space around \[lq]Third\[rq].
2704+Pandoc transforms this into a "compact list" (with no \f[C]<p>\f[] tags
2705+around "First", "Second", or "Third"), while Markdown puts \f[C]<p>\f[]
2706+tags around "Second" and "Third" (but not "First"), because of the blank
2707+space around "Third".
27082708Pandoc follows a simple rule: if the text is followed by a blank line,
27092709it is treated as a paragraph.
2710−Since \[lq]Second\[rq] is followed by a list, and not a blank line, it
2711−isn't treated as a paragraph.
2710+Since "Second" is followed by a list, and not a blank line, it isn\[aq]t
2711+treated as a paragraph.
27122712The fact that the list is followed by a blank line is irrelevant.
27132713(Note: Pandoc works this way even when the \f[C]markdown_strict\f[]
27142714format is specified.
@@ -2732,9 +2732,9 @@ Trouble! Here pandoc (like other Markdown implementations) will treat
27322732\f[C]{\ my\ code\ block\ }\f[] as the second paragraph of item two, and
27332733not as a code block.
27342734.PP
2735−To \[lq]cut off\[rq] the list after item two, you can insert some
2736−non\-indented content, like an HTML comment, which won't produce visible
2737−output in any format:
2735+To "cut off" the list after item two, you can insert some non\-indented
2736+content, like an HTML comment, which won\[aq]t produce visible output in
2737+any format:
27382738.IP
27392739.nf
27402740\f[C]
@@ -2998,7 +2998,7 @@ wrap, with the relative cell widths determined by the widths of the
29982998separator lines.
29992999.PP
30003000Note: pandoc also recognizes pipe tables of the following form, as can
3001−be produced by Emacs' orgtbl\-mode:
3001+be produced by Emacs\[aq] orgtbl\-mode:
30023002.IP
30033003.nf
30043004\f[C]
@@ -3011,8 +3011,8 @@ be produced by Emacs' orgtbl\-mode:
30113011.PP
30123012The difference is that \f[C]+\f[] is used instead of \f[C]|\f[].
30133013Other orgtbl features are not supported.
3014−In particular, to get non\-default column alignment, you'll need to add
3015−colons as above.
3014+In particular, to get non\-default column alignment, you\[aq]ll need to
3015+add colons as above.
30163016.SS Metadata blocks
30173017.SS Extension: \f[C]pandoc_title_block\f[]
30183018.PP
@@ -3077,13 +3077,13 @@ All three metadata fields may contain standard inline formatting
30773077.PP
30783078Title blocks will always be parsed, but they will affect the output only
30793079when the \f[C]\-\-standalone\f[] (\f[C]\-s\f[]) option is chosen.
3080−In HTML output, titles will appear twice: once in the document head
3081−\[en] this is the title that will appear at the top of the window in a
3082−browser \[en] and once at the beginning of the document body.
3080+In HTML output, titles will appear twice: once in the document head \-\-
3081+this is the title that will appear at the top of the window in a browser
3082+\-\- and once at the beginning of the document body.
30833083The title in the document head can have an optional prefix attached
30843084(\f[C]\-\-title\-prefix\f[] or \f[C]\-T\f[] option).
3085−The title in the body appears as an H1 element with class
3086−\[lq]title\[rq], so it can be suppressed or reformatted with CSS.
3085+The title in the body appears as an H1 element with class "title", so it
3086+can be suppressed or reformatted with CSS.
30873087If a title prefix is specified with \f[C]\-T\f[] and no title block
30883088appears in the document, the title prefix will be used by itself as the
30893089HTML title.
@@ -3112,7 +3112,7 @@ will yield a man page with the title \f[C]PANDOC\f[] and section 1.
31123112\f[]
31133113.fi
31143114.PP
3115−will also have \[lq]Pandoc User Manuals\[rq] in the footer.
3115+will also have "Pandoc User Manuals" in the footer.
31163116.IP
31173117.nf
31183118\f[C]
@@ -3120,7 +3120,7 @@ will also have \[lq]Pandoc User Manuals\[rq] in the footer.
31203120\f[]
31213121.fi
31223122.PP
3123−will also have \[lq]Version 4.0\[rq] in the header.
3123+will also have "Version 4.0" in the header.
31243124.SS Extension: \f[C]yaml_metadata_block\f[]
31253125.PP
31263126A YAML metadata block is a valid YAML object, delimited by a line of
@@ -3259,7 +3259,7 @@ instead of
32593259\f[]
32603260.fi
32613261.PP
3262−This rule is easier to remember than standard Markdown's rule, which
3262+This rule is easier to remember than standard Markdown\[aq]s rule, which
32633263allows only the following characters to be backslash\-escaped:
32643264.IP
32653265.nf
@@ -3275,11 +3275,12 @@ A backslash\-escaped space is parsed as a nonbreaking space.
32753275It will appear in TeX output as \f[C]~\f[] and in HTML and XML as
32763276\f[C]\\&#160;\f[] or \f[C]\\&nbsp;\f[].
32773277.PP
3278−A backslash\-escaped newline (i.e.\ a backslash occurring at the end of
3279−a line) is parsed as a hard line break.
3278+A backslash\-escaped newline (i.e.
3279+a backslash occurring at the end of a line) is parsed as a hard line
3280+break.
32803281It will appear in TeX output as \f[C]\\\\\f[] and in HTML as
32813282\f[C]<br\ />\f[].
3282−This is a nice alternative to Markdown's \[lq]invisible\[rq] way of
3283+This is a nice alternative to Markdown\[aq]s "invisible" way of
32833284indicating hard line breaks using two trailing spaces on a line.
32843285.PP
32853286Backslash escapes do not work in verbatim contexts.
@@ -3291,7 +3292,7 @@ typographically correct output, converting straight quotes to curly
32913292quotes, \f[C]\-\-\-\f[] to em\-dashes, \f[C]\-\-\f[] to en\-dashes, and
32923293\f[C]\&...\f[] to ellipses.
32933294Nonbreaking spaces are inserted after certain abbreviations, such as
3294−\[lq]Mr.\[rq]
3295+"Mr."
32953296.PP
32963297Note: if your LaTeX template or any included header file call for the
32973298\f[C]csquotes\f[] package, pandoc will detect this automatically and use
@@ -3367,8 +3368,8 @@ If the superscripted or subscripted text contains spaces, these spaces
33673368must be escaped with backslashes.
33683369(This is to prevent accidental superscripting and subscripting through
33693370the ordinary use of \f[C]~\f[] and \f[C]^\f[].) Thus, if you want the
3370−letter P with `a cat' in subscripts, use \f[C]P~a\\\ cat~\f[], not
3371−\f[C]P~a\ cat~\f[].
3371+letter P with \[aq]a cat\[aq] in subscripts, use \f[C]P~a\\\ cat~\f[],
3372+not \f[C]P~a\ cat~\f[].
33723373.SS Verbatim
33733374.PP
33743375To make a short span of text verbatim, put it inside backticks:
@@ -3440,9 +3441,9 @@ The opening \f[C]$\f[] must have a non\-space character immediately to
34403441its right, while the closing \f[C]$\f[] must have a non\-space character
34413442immediately to its left, and must not be followed immediately by a
34423443digit.
3443−Thus, \f[C]$20,000\ and\ $30,000\f[] won't parse as math.
3444+Thus, \f[C]$20,000\ and\ $30,000\f[] won\[aq]t parse as math.
34443445If for some reason you need to enclose text in literal \f[C]$\f[]
3445−characters, backslash\-escape them and they won't be treated as math
3446+characters, backslash\-escape them and they won\[aq]t be treated as math
34463447delimiters.
34473448.PP
34483449TeX math will be printed in all output formats.
@@ -3469,7 +3470,7 @@ It will be rendered inside a \f[C]\@math\f[] command.
34693470.RE
34703471.TP
34713472.B groff man
3472−It will be rendered verbatim without \f[C]$\f[]'s.
3473+It will be rendered verbatim without \f[C]$\f[]\[aq]s.
34733474.RS
34743475.RE
34753476.TP
@@ -3583,9 +3584,9 @@ DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and
35833584suppressed in other formats.
35843585.SS Extension: \f[C]markdown_in_html_blocks\f[]
35853586.PP
3586−Standard Markdown allows you to include HTML \[lq]blocks\[rq]: blocks of
3587−HTML between balanced tags that are separated from the surrounding text
3588−with blank lines, and start and end at the left margin.
3587+Standard Markdown allows you to include HTML "blocks": blocks of HTML
3588+between balanced tags that are separated from the surrounding text with
3589+blank lines, and start and end at the left margin.
35893590Within these blocks, everything is interpreted as HTML, not Markdown; so
35903591(for example), \f[C]*\f[] does not signify emphasis.
35913592.PP
@@ -3853,7 +3854,7 @@ slide shows and EPUB), LaTeX, and ConTeXt.
38533854.SS Images
38543855.PP
38553856A link immediately preceded by a \f[C]!\f[] will be treated as an image.
3856−The link text will be used as the image's alt text:
3857+The link text will be used as the image\[aq]s alt text:
38573858.IP
38583859.nf
38593860\f[C]
@@ -3870,7 +3871,7 @@ An image occurring by itself in a paragraph will be rendered as a figure
38703871with a caption. (In LaTeX, a figure environment will be used; in HTML,
38713872the image will be placed in a \f[C]div\f[] with class \f[C]figure\f[],
38723873together with a caption in a \f[C]p\f[] with class \f[C]caption\f[].)
3873−The image's alt text will be used as the caption.
3874+The image\[aq]s alt text will be used as the caption.
38743875.IP
38753876.nf
38763877\f[C]
@@ -3957,7 +3958,7 @@ attributes:
39573958.SS Footnotes
39583959.SS Extension: \f[C]footnotes\f[]
39593960.PP
3960−Pandoc's Markdown allows footnotes, using the following syntax:
3961+Pandoc\[aq]s Markdown allows footnotes, using the following syntax:
39613962.IP
39623963.nf
39633964\f[C]
@@ -4141,7 +4142,7 @@ JSON and CSL YAML formats as far as possible.
41414142As an alternative to specifying a bibliography file using
41424143\f[C]\-\-bibliography\f[] or the YAML metadata field
41434144\f[C]bibliography\f[], you can include the citation data directly in the
4144−\f[C]references\f[] field of the document's YAML metadata.
4145+\f[C]references\f[] field of the document\[aq]s YAML metadata.
41454146The field should contain an array of YAML\-encoded references, for
41464147example:
41474148.IP
@@ -4191,7 +4192,7 @@ To make your citations hyperlinks to the corresponding bibliography
41914192entries, add \f[C]link\-citations:\ true\f[] to your YAML metadata.
41924193.PP
41934194Citations go inside square brackets and are separated by semicolons.
4194−Each citation must have a key, composed of `\@' + the citation
4195+Each citation must have a key, composed of \[aq]\@\[aq] + the citation
41954196identifier from the database, and may optionally have a prefix, a
41964197locator, and a suffix.
41974198The citation key must begin with a letter, digit, or \f[C]_\f[], and may
@@ -4226,7 +4227,7 @@ singular or plural forms, as \f[C]book\f[], \f[C]bk.\f[]/\f[C]bks.\f[];
42264227\f[C]s.v.\f[]/\f[C]s.vv.\f[]; \f[C]verse\f[], \f[C]v.\f[]/\f[C]vv.\f[];
42274228\f[C]volume\f[], \f[C]vol.\f[]/\f[C]vols.\f[]; \f[C]¶\f[]/\f[C]¶¶\f[];
42284229\f[C]§\f[]/\f[C]§§\f[].
4229−If no locator term is used, \[lq]page\[rq] is assumed.
4230+If no locator term is used, "page" is assumed.
42304231.PP
42314232A minus sign (\f[C]\-\f[]) before the \f[C]\@\f[] will suppress mention
42324233of the author in the citation.
@@ -4315,7 +4316,7 @@ hard line breaks.
43154316.PP
43164317Allow \f[C]<\f[] and \f[C]>\f[] to be backslash\-escaped, as they can be
43174318in GitHub flavored Markdown but not original Markdown.
4318−This is implied by pandoc's default \f[C]all_symbols_escapable\f[].
4319+This is implied by pandoc\[aq]s default \f[C]all_symbols_escapable\f[].
43194320.SS Extension: \f[C]lists_without_preceding_blankline\f[]
43204321.PP
43214322Allow a list to occur right after a paragraph, with no intervening blank
@@ -4429,15 +4430,15 @@ in several respects:
44294430No blank line is required between consecutive items of the definition
44304431list.
44314432.IP \[bu] 2
4432−To get a \[lq]tight\[rq] or \[lq]compact\[rq] list, omit space between
4433−consecutive items; the space between a term and its definition does not
4434−affect anything.
4433+To get a "tight" or "compact" list, omit space between consecutive
4434+items; the space between a term and its definition does not affect
4435+anything.
44354436.IP \[bu] 2
44364437Lazy wrapping of paragraphs is not allowed: the entire definition must
44374438be indented four spaces.
44384439.SS Markdown variants
44394440.PP
4440−In addition to pandoc's extended Markdown, the following Markdown
4441+In addition to pandoc\[aq]s extended Markdown, the following Markdown
44414442variants are supported:
44424443.TP
44434444.B \f[C]markdown_phpextra\f[] (PHP Markdown Extra)
@@ -4494,7 +4495,8 @@ There are five ways to do this, using S5, DZSlides, Slidy, Slideous, or
44944495reveal.js.
44954496You can also produce a PDF slide show using LaTeX \f[C]beamer\f[].
44964497.PP
4497−Here's the Markdown source for a simple slide show, \f[C]habits.txt\f[]:
4498+Here\[aq]s the Markdown source for a simple slide show,
4499+\f[C]habits.txt\f[]:
44984500.IP
44994501.nf
45004502\f[C]
@@ -4589,17 +4591,17 @@ A header at the slide level always starts a new slide.
45894591Headers \f[I]below\f[] the slide level in the hierarchy create headers
45904592\f[I]within\f[] a slide.
45914593.IP \[bu] 2
4592−Headers \f[I]above\f[] the slide level in the hierarchy create
4593−\[lq]title slides,\[rq] which just contain the section title and help to
4594−break the slide show into sections.
4594+Headers \f[I]above\f[] the slide level in the hierarchy create "title
4595+slides," which just contain the section title and help to break the
4596+slide show into sections.
45954597.IP \[bu] 2
4596−A title page is constructed automatically from the document's title
4598+A title page is constructed automatically from the document\[aq]s title
45974599block, if present.
45984600(In the case of beamer, this can be disabled by commenting out some
45994601lines in the default template.)
46004602.PP
46014603These rules are designed to support many different styles of slide show.
4602−If you don't care about structuring your slides into sections and
4604+If you don\[aq]t care about structuring your slides into sections and
46034605subsections, you can just use level 1 headers for all each slide.
46044606(In that case, level 1 will be the slide level.) But you can also
46054607structure the slide show into sections, as in the example above.
@@ -4611,9 +4613,9 @@ It is not recommended that you use deeper nesting of section levels with
46114613reveal.js.
46124614.SS Incremental lists
46134615.PP
4614−By default, these writers produce lists that display \[lq]all at
4615−once.\[rq] If you want your lists to display incrementally (one item at
4616−a time), use the \f[C]\-i\f[] option.
4616+By default, these writers produce lists that display "all at once." If
4617+you want your lists to display incrementally (one item at a time), use
4618+the \f[C]\-i\f[] option.
46174619If you want a particular list to depart from the default (that is, to
46184620display incrementally without the \f[C]\-i\f[] option and all at once
46194621with the \f[C]\-i\f[] option), put it in a block quote:
@@ -4629,8 +4631,8 @@ In this way incremental and nonincremental lists can be mixed in a
46294631single document.
46304632.SS Inserting pauses
46314633.PP
4632−You can add \[lq]pauses\[rq] within a slide by including a paragraph
4633−containing three dots, separated by spaces:
4634+You can add "pauses" within a slide by including a paragraph containing
4635+three dots, separated by spaces:
46344636.IP
46354637.nf
46364638\f[C]
@@ -4650,8 +4652,8 @@ in \f[C]$DATADIR/s5/default\f[] (for S5), \f[C]$DATADIR/slidy\f[] (for
46504652Slidy), or \f[C]$DATADIR/slideous\f[] (for Slideous), where
46514653\f[C]$DATADIR\f[] is the user data directory (see
46524654\f[C]\-\-data\-dir\f[], above).
4653−The originals may be found in pandoc's system data directory (generally
4654−\f[C]$CABALDIR/pandoc\-VERSION/s5/default\f[]).
4655+The originals may be found in pandoc\[aq]s system data directory
4656+(generally \f[C]$CABALDIR/pandoc\-VERSION/s5/default\f[]).
46554657Pandoc will look there for any files it does not find in the user data
46564658directory.
46574659.PP
@@ -4730,7 +4732,7 @@ introducing the slide:
47304732.fi
47314733.PP
47324734All of the other frame attributes described in Section 8.1 of the Beamer
4733−User's Guide may also be used: \f[C]allowdisplaybreaks\f[],
4735+User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[],
47344736\f[C]allowframebreaks\f[], \f[C]b\f[], \f[C]c\f[], \f[C]t\f[],
47354737\f[C]environment\f[], \f[C]label\f[], \f[C]plain\f[], \f[C]shrink\f[].
47364738.SH CREATING EPUBS WITH PANDOC
@@ -4789,8 +4791,8 @@ Valid values for \f[C]type\f[] are \f[C]main\f[], \f[C]subtitle\f[],
47894791Either a string value, or an object with fields \f[C]role\f[],
47904792\f[C]file\-as\f[], and \f[C]text\f[], or a list of such objects.
47914793Valid values for \f[C]role\f[] are MARC relators, but pandoc will
4792−attempt to translate the human\-readable versions (like \[lq]author\[rq]
4793−and \[lq]editor\[rq]) to the appropriate marc relators.
4794+attempt to translate the human\-readable versions (like "author" and
4795+"editor") to the appropriate marc relators.
47944796.RS
47954797.RE
47964798.TP
@@ -4891,23 +4893,24 @@ output; \f[C]beamer\f[], \f[C]html\f[] or \f[C]html5\f[] for output
48914893only), pandoc will treat the document as literate Haskell source.
48924894This means that
48934895.IP \[bu] 2
4894−In Markdown input, \[lq]bird track\[rq] sections will be parsed as
4895−Haskell code rather than block quotations.
4896+In Markdown input, "bird track" sections will be parsed as Haskell code
4897+rather than block quotations.
48964898Text between \f[C]\\begin{code}\f[] and \f[C]\\end{code}\f[] will also
48974899be treated as Haskell code.
4898−For ATX\-style headers the character `=' will be used instead of `#'.
4900+For ATX\-style headers the character \[aq]=\[aq] will be used instead of
4901+\[aq]#\[aq].
48994902.IP \[bu] 2
49004903In Markdown output, code blocks with classes \f[C]haskell\f[] and
49014904\f[C]literate\f[] will be rendered using bird tracks, and block
49024905quotations will be indented one space, so they will not be treated as
49034906Haskell code.
49044907In addition, headers will be rendered setext\-style (with underlines)
4905−rather than ATX\-style (with `#' characters).
4906−(This is because ghc treats `#' characters in column 1 as introducing
4907−line numbers.)
4908+rather than ATX\-style (with \[aq]#\[aq] characters).
4909+(This is because ghc treats \[aq]#\[aq] characters in column 1 as
4910+introducing line numbers.)
49084911.IP \[bu] 2
4909−In restructured text input, \[lq]bird track\[rq] sections will be parsed
4910−as Haskell code.
4912+In restructured text input, "bird track" sections will be parsed as
4913+Haskell code.
49114914.IP \[bu] 2
49124915In restructured text output, code blocks with class \f[C]haskell\f[]
49134916will be rendered using bird tracks.
@@ -4960,8 +4963,8 @@ To see a list of highlight styles, type
49604963To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
49614964.SH CUSTOM STYLES IN DOCX OUTPUT
49624965.PP
4963−By default, pandoc's docx output applies a predefined set of styles for
4964−blocks such as paragraphs and block quotes, and uses largely default
4966+By default, pandoc\[aq]s docx output applies a predefined set of styles
4967+for blocks such as paragraphs and block quotes, and uses largely default
49654968formatting (italics, bold) for inlines.
49664969This will work for most purposes, especially alongside a
49674970\f[C]reference.docx\f[] file.
@@ -4980,8 +4983,8 @@ So, for example,
49804983\f[]
49814984.fi
49824985.PP
4983−would produce a docx file with \[lq]Get out,\[rq] styled with character
4984−style \f[C]Emphatically\f[].
4986+would produce a docx file with "Get out," styled with character style
4987+\f[C]Emphatically\f[].
49854988Similarly,
49864989.IP
49874990.nf
@@ -5046,14 +5049,14 @@ This software carries no warranty of any kind.
50465049Contributors include Arata Mizuki, Aaron Wolen, Albert Krewinkel, Alex
50475050Ivkin, Alex Vong, Alexander Kondratskiy, Alexander Sulfrian, Alexander V
50485051Vershilov, Alfred Wechselberger, Andreas Lööw, Andrew Dunning, Antoine
5049−Latter, Arata Mizuki, Arlo O'Keeffe, Artyom Kazak, B.
5052+Latter, Arata Mizuki, Arlo O\[aq]Keeffe, Artyom Kazak, B.
50505053Scott Michel, Ben Gamari, Beni Cherniavsky\-Paskin, Benoit Schweblin,
5051−Bjorn Buckwalter, Bradley Kuhn, Brent Yorgey, Bryan O'Sullivan, Caleb
5052−McDaniel, Calvin Beck, Carlos Sosa, Chris Black, Christian Conkle,
5054+Bjorn Buckwalter, Bradley Kuhn, Brent Yorgey, Bryan O\[aq]Sullivan,
5055+Caleb McDaniel, Calvin Beck, Carlos Sosa, Chris Black, Christian Conkle,
50535056Christoffer Ackelman, Christoffer Sawicki, Clare Macrae, Clint Adams,
50545057Conal Elliott, Craig S.
50555058Bosma, Daniel Bergey, Daniel T.
5056−Staal, Daniele D'Orazio, David Lazar, David Röthlisberger, Denis
5059+Staal, Daniele D\[aq]Orazio, David Lazar, David Röthlisberger, Denis
50575060Laxalde, Douglas Calvert, Emanuel Evans, Emily Eisenberg, Eric Kow, Eric
50585061Seidel, Felix Yan, Florian Eitel, François Gannaz, Freiric Barral,
50595062Freirich Raabe, Frerich Raabe, Fyodor Sheremetyev, Gabor Pali, Gavin