git.iko.soy/typeable/pandoc
on master help sign in
MANUAL: wrap some overly long lines.
commitc4029dcfed867de4c38c6ae96926d121c37d5400 authorJohn MacFarlane <jgm@berkeley.edu> dateSat 14 Nov 2020, 21:49 (6 years ago) parentb5d066f
1 file changed+130−102
MANUAL.txt+130−102
MANUAL.txt+130−102
@@ -914,7 +914,7 @@ header when requesting a document from a URL:
914914
915915`--no-check-certificate`
916916
917−: Disable the certificate verification to allow access to
917+: Disable the certificate verification to allow access to
918918 unsecure HTTP resources (for example when the certificate
919919 is no longer valid or self signed).
920920
@@ -984,16 +984,19 @@ header when requesting a document from a URL:
984984
985985`--top-level-division=default`|`section`|`chapter`|`part`
986986
987−: Treat top-level headings as the given division type in LaTeX, ConTeXt,
988− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
989− all headings are shifted such that the top-level heading becomes the specified
990− type. The default behavior is to determine the best division type via
991− heuristics: unless other conditions apply, `section` is chosen. When the
992− `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
993− `article` option is specified), `chapter` is implied as the setting for this
994− option. If `beamer` is the output format, specifying either `chapter` or
995− `part` will cause top-level headings to become `\part{..}`, while
996− second-level headings remain as their default type.
987+: Treat top-level headings as the given division type in
988+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
989+ order is part, chapter, then section; all headings are
990+ shifted such that the top-level heading becomes the
991+ specified type. The default behavior is to determine the
992+ best division type via heuristics: unless other conditions
993+ apply, `section` is chosen. When the `documentclass`
994+ variable is set to `report`, `book`, or `memoir` (unless the
995+ `article` option is specified), `chapter` is implied as the
996+ setting for this option. If `beamer` is the output format,
997+ specifying either `chapter` or `part` will cause top-level
998+ headings to become `\part{..}`, while second-level headings
999+ remain as their default type.
9971000
9981001`-N`, `--number-sections`
9991002
@@ -1355,23 +1358,26 @@ header when requesting a document from a URL:
13551358
13561359`--natbib`
13571360
1358−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1359− with the `--citeproc` option or with PDF output. It is intended for
1360− use in producing a LaTeX file that can be processed with [`bibtex`].
1361+: Use [`natbib`] for citations in LaTeX output. This option
1362+ is not for use with the `--citeproc` option or with PDF
1363+ output. It is intended for use in producing a LaTeX file
1364+ that can be processed with [`bibtex`].
13611365
13621366`--biblatex`
13631367
1364−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1365− with the `--citeproc` option or with PDF output. It is intended for
1366− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1368+: Use [`biblatex`] for citations in LaTeX output. This option
1369+ is not for use with the `--citeproc` option or with PDF
1370+ output. It is intended for use in producing a LaTeX file
1371+ that can be processed with [`bibtex`] or [`biber`].
13671372
13681373## Math rendering in HTML {.options}
13691374
1370−The default is to render TeX math as far as possible using Unicode characters.
1371−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1372−differently from the surrounding text if needed. However, this gives acceptable
1373−results only for basic math, usually you will want to use `--mathjax` or another
1374−of the following options.
1375+The default is to render TeX math as far as possible using
1376+Unicode characters. Formulas are put inside a `span` with
1377+`class="math"`, so that they may be styled differently from the
1378+surrounding text if needed. However, this gives acceptable
1379+results only for basic math, usually you will want to use
1380+`--mathjax` or another of the following options.
13751381
13761382`--mathjax`[`=`*URL*]
13771383
@@ -1385,10 +1391,11 @@ of the following options.
13851391
13861392`--mathml`
13871393
1388−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1389− `html4` and `html5`). This is the default in `odt` output. Note that
1390− currently only Firefox and Safari (and select e-book readers) natively
1391− support MathML.
1394+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1395+ `docbook5`, `jats`, `html4` and `html5`). This is the
1396+ default in `odt` output. Note that currently only Firefox
1397+ and Safari (and select e-book readers) natively support
1398+ MathML.
13921399
13931400`--webtex`[`=`*URL*]
13941401
@@ -2178,15 +2185,16 @@ ODT or pptx.
21782185: the base script direction, either `rtl` (right-to-left)
21792186 or `ltr` (left-to-right).
21802187
2181− For bidirectional documents, native pandoc `span`s and `div`s
2182− with the `dir` attribute (value `rtl` or `ltr`) can be used to
2183− override the base direction in some output formats.
2184− This may not always be necessary if the final renderer
2185− (e.g. the browser, when generating HTML) supports the
2186− [Unicode Bidirectional Algorithm].
2188+ For bidirectional documents, native pandoc `span`s and
2189+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2190+ be used to override the base direction in some output
2191+ formats. This may not always be necessary if the final
2192+ renderer (e.g. the browser, when generating HTML) supports
2193+ the [Unicode Bidirectional Algorithm].
21872194
2188− When using LaTeX for bidirectional documents, only the `xelatex` engine
2189− is fully supported (use `--pdf-engine=xelatex`).
2195+ When using LaTeX for bidirectional documents, only the
2196+ `xelatex` engine is fully supported (use
2197+ `--pdf-engine=xelatex`).
21902198
21912199[BCP 47]: https://tools.ietf.org/html/bcp47
21922200[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
@@ -2258,8 +2266,9 @@ To override or extend some [CSS] for just one document, include for example:
22582266### Variables for HTML math
22592267
22602268`classoption`
2261−: when using [KaTeX](#option--katex), you can render display math equations
2262− flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2269+: when using [KaTeX](#option--katex), you can render display
2270+math equations flush left using [YAML metadata](#layout) or with
2271+`-M classoption=fleqn`.
22632272
22642273### Variables for HTML slides
22652274
@@ -2371,9 +2380,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23712380 ...
23722381
23732382`documentclass`
2374−: document class: usually one of the standard classes, [`article`], [`book`],
2375− and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2376− and `scrreprt`, which default to smaller margins; or [`memoir`]
2383+: document class: usually one of the standard classes,
2384+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2385+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2386+ default to smaller margins; or [`memoir`]
23772387
23782388`geometry`
23792389: option for [`geometry`] package, e.g. `margin=1in`;
@@ -2398,8 +2408,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23982408 ...
23992409
24002410`indent`
2401−: if true, pandoc will use document class settings for indentation (the default LaTeX template
2402− otherwise removes indentation and adds space between paragraphs)
2411+: if true, pandoc will use document class settings for
2412+ indentation (the default LaTeX template otherwise removes
2413+ indentation and adds space between paragraphs)
24032414
24042415`linestretch`
24052416: adjusts line spacing using the [`setspace`]
@@ -2424,8 +2435,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24242435#### Fonts
24252436
24262437`fontenc`
2427−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2428− default is `T1` (see [LaTeX font encodings guide])
2438+: allows font encoding to be specified through `fontenc` package (with
2439+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
24292440
24302441`fontfamily`
24312442: font package for use with `pdflatex`:
@@ -2495,7 +2506,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24952506: contents of acknowledgments footnote after document title
24962507
24972508`toc`
2498−: include table of contents (can also be set using `--toc/--table-of-contents`)
2509+: include table of contents (can also be set using
2510+ `--toc/--table-of-contents`)
24992511
25002512`toc-depth`
25012513: level of section to include in table of contents
@@ -2537,12 +2549,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25372549: font size for body text (e.g. `10pt`, `12pt`)
25382550
25392551`headertext`, `footertext`
2540−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2541− repeat up to four times for different placement
2552+: text to be placed in running header or footer (see [ConTeXt Headers and
2553+ Footers]); repeat up to four times for different placement
25422554
25432555`indenting`
2544−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2545− repeat for multiple options
2556+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2557+ [ConTeXt Indentation]); repeat for multiple options
25462558
25472559`interlinespace`
25482560: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -2553,16 +2565,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25532565 repeat for multiple options
25542566
25552567`linkcolor`, `contrastcolor`
2556−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2568+: color for links outside and inside a page, e.g. `red`, `blue` (see
2569+ [ConTeXt Color])
25572570
25582571`linkstyle`
2559−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2572+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2573+ `type`, `cap`, `small`
25602574
25612575`lof`, `lot`
25622576: include list of figures, list of tables
25632577
25642578`mainfont`, `sansfont`, `monofont`, `mathfont`
2565−: font families: take the name of any system font (see [ConTeXt Font Switching])
2579+: font families: take the name of any system font (see
2580+ [ConTeXt Font Switching])
25662581
25672582`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
25682583: sets margins, if `layout` is not used (otherwise `layout`
@@ -2577,16 +2592,18 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25772592 repeat for multiple options
25782593
25792594`pdfa`
2580−: adds to the preamble the setup necessary to generate PDF/A of the type
2581− specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2582− is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2583− block), `1b:2005` will be used as default, for reasons of backwards
2584− compatibility. Using `--variable=pdfa` without specified value is not supported.
2585− To successfully generate PDF/A the required ICC color profiles have to
2586− be available and the content and all included files (such as images)
2587− have to be standard conforming. The ICC profiles and output intent
2588− may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2589− See also [ConTeXt PDFA] for more details.
2595+: adds to the preamble the setup necessary to generate PDF/A
2596+ of the type specified, e.g. `1a:2005`, `2a`. If no type is
2597+ specified (i.e. the value is set to True, by e.g.
2598+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2599+ `1b:2005` will be used as default, for reasons of backwards
2600+ compatibility. Using `--variable=pdfa` without specified value
2601+ is not supported. To successfully generate PDF/A the required
2602+ ICC color profiles have to be available and the content and all
2603+ included files (such as images) have to be standard conforming.
2604+ The ICC profiles and output intent may be specified using the
2605+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2606+ PDFA] for more details.
25902607
25912608`pdfaiccprofile`
25922609: when used in conjunction with `pdfa`, specifies the ICC profile to use
@@ -2601,10 +2618,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
26012618 If left unspecified, `sRGB IEC61966-2.1` is used as default.
26022619
26032620`toc`
2604−: include table of contents (can also be set using `--toc/--table-of-contents`)
2621+: include table of contents (can also be set using
2622+ `--toc/--table-of-contents`)
26052623
26062624`whitespace`
2607−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2625+: spacing between paragraphs, e.g. `none`, `small` (using
2626+ [`setupwhitespace`])
26082627
26092628`includesource`
26102629: include all source documents as file attachments in the PDF file
@@ -3033,8 +3052,8 @@ output format.
30333052
30343053#### Extension: `citations` {#org-citations}
30353054
3036−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3037−in `org` input.
3055+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3056+are also accepted in `org` input.
30383057
30393058#### Extension: `ntb` ####
30403059
@@ -3142,7 +3161,8 @@ pandoc does require the space.
31423161
31433162### Heading identifiers ###
31443163
3145−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3164+See also the [`auto_identifiers`
3165+extension](#extension-auto_identifiers) above.
31463166
31473167#### Extension: `header_attributes` ####
31483168
@@ -3264,11 +3284,12 @@ block in a block quote, you need five spaces after the `>`:
32643284
32653285#### Extension: `blank_before_blockquote` ####
32663286
3267−Standard Markdown syntax does not require a blank line before a block
3268−quote. Pandoc does require this (except, of course, at the beginning of the
3269−document). The reason for the requirement is that it is all too easy for a
3270−`>` to end up at the beginning of a line by accident (perhaps through line
3271−wrapping). So, unless the `markdown_strict` format is used, the following does
3287+Standard Markdown syntax does not require a blank line before a
3288+block quote. Pandoc does require this (except, of course, at
3289+the beginning of the document). The reason for the requirement
3290+is that it is all too easy for a `>` to end up at the beginning
3291+of a line by accident (perhaps through line wrapping). So,
3292+unless the `markdown_strict` format is used, the following does
32723293not produce a nested block quote in pandoc:
32733294
32743295 > This is a block quote.
@@ -3337,14 +3358,16 @@ this syntax:
33373358 qsort (filter (>= x) xs)
33383359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33393360
3340−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3341−`startFrom` is an attribute with value `100`. Some output formats can use this
3342−information to do syntax highlighting. Currently, the only output formats
3343−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3344−highlighting is supported for your output format and language, then the code
3345−block above will appear highlighted, with numbered lines. (To see which
3346−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3347−the code block above will appear as follows:
3361+Here `mycode` is an identifier, `haskell` and `numberLines` are
3362+classes, and `startFrom` is an attribute with value `100`. Some
3363+output formats can use this information to do syntax
3364+highlighting. Currently, the only output formats that uses this
3365+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3366+highlighting is supported for your output format and language,
3367+then the code block above will appear highlighted, with numbered
3368+lines. (To see which languages are supported, type `pandoc
3369+--list-highlight-languages`.) Otherwise, the code block above
3370+will appear as follows:
33483371
33493372 <pre id="mycode" class="haskell numberLines" startFrom="100">
33503373 <code>
@@ -3610,11 +3633,12 @@ a blank line, and must be followed by one or more definitions.
36103633A definition begins with a colon or tilde, which may be indented one
36113634or two spaces.
36123635
3613−A term may have multiple definitions, and each definition may consist of one or
3614−more block elements (paragraph, code block, list, etc.), each indented four
3615−spaces or one tab stop. The body of the definition (including the first line,
3616−aside from the colon or tilde) should be indented four spaces. However,
3617−as with other Markdown lists, you can "lazily" omit indentation except
3636+A term may have multiple definitions, and each definition may
3637+consist of one or more block elements (paragraph, code block,
3638+list, etc.), each indented four spaces or one tab stop. The
3639+body of the definition (including the first line, aside from the
3640+colon or tilde) should be indented four spaces. However, as with
3641+other Markdown lists, you can "lazily" omit indentation except
36183642at the beginning of a paragraph or other block element:
36193643
36203644 Term 1
@@ -3642,7 +3666,8 @@ Note that space between items in a definition list is required.
36423666hard wrapping, can be activated with `compact_definition_lists`: see
36433667[Non-pandoc extensions], below.)
36443668
3645−[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3669+[^3]: I have been influenced by the suggestions of [David
3670+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
36463671
36473672### Numbered example lists ###
36483673
@@ -5271,11 +5296,11 @@ The CSL project provides further information on [finding and
52715296editing styles].
52725297
52735298The `--citation-abbreviations` option (or the
5274−`citation-abbreviations` metadata field) may be used to
5275−specify a JSON file containing abbreviations of journals
5276−that should be used in formatted bibliographies when
5277−`form="short"` is specified. The format of the file
5278−can be illustrated with an example:
5299+`citation-abbreviations` metadata field) may be used to specify
5300+a JSON file containing abbreviations of journals that should be
5301+used in formatted bibliographies when `form="short"` is
5302+specified. The format of the file can be illustrated with an
5303+example:
52795304
52805305
52815306 { "default": {
@@ -5441,18 +5466,21 @@ To produce an HTML/JavaScript slide show, simply type
54415466
54425467where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
54435468
5444−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5445−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5446−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5447−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5448−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5449−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5450−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5451−the file by default.
5452−
5453−With all HTML slide formats, the `--self-contained` option can be used to
5454−produce a single file that contains all of the data necessary to display the
5455−slide show, including linked scripts, stylesheets, images, and videos.
5469+For Slidy, Slideous, reveal.js, and S5, the file produced by
5470+pandoc with the `-s/--standalone` option embeds a link to
5471+JavaScript and CSS files, which are assumed to be available at
5472+the relative path `s5/default` (for S5), `slideous` (for
5473+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5474+at `w3.org` (for Slidy). (These paths can be changed by setting
5475+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5476+variables; see [Variables for HTML slides], above.) For
5477+DZSlides, the (relatively short) JavaScript and CSS are included
5478+in the file by default.
5479+
5480+With all HTML slide formats, the `--self-contained` option can
5481+be used to produce a single file that contains all of the data
5482+necessary to display the slide show, including linked scripts,
5483+stylesheets, images, and videos.
54565484
54575485To produce a PDF slide show using beamer, type
54585486