git.iko.soy/typeable/pandoc
on master help sign in
Minor spelling typos in the manual (#3273)
733b1f3Anthony Geoghegan
MANUAL.txt+23−23
@@ -284,11 +284,11 @@ General options
284 (Haddock markup), `rtf` (rich text format), `epub` (EPUB v2
284 (Haddock markup), `rtf` (rich text format), `epub` (EPUB v2
285 book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
285 book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
286 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
286 `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
287− Simple), `slidy` (Slidy HTML and javascript slide show),
287+ Simple), `slidy` (Slidy HTML and JavaScript slide show),
288− `slideous` (Slideous HTML and javascript slide show),
288+ `slideous` (Slideous HTML and JavaScript slide show),
289− `dzslides` (DZSlides HTML5 + javascript slide show),
289+ `dzslides` (DZSlides HTML5 + JavaScript slide show),
290− `revealjs` (reveal.js HTML5 + javascript slide show), `s5`
290+ `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
291− (S5 HTML and javascript slide show), or the path of a custom
291+ (S5 HTML and JavaScript slide show), or the path of a custom
292 lua writer (see [Custom writers], below). Note that `odt`,
292 lua writer (see [Custom writers], below). Note that `odt`,
293 `epub`, and `epub3` output will not be directed to *stdout*;
293 `epub`, and `epub3` output will not be directed to *stdout*;
294 an output filename must be specified using the `-o/--output`
294 an output filename must be specified using the `-o/--output`
@@ -609,7 +609,7 @@ General writer options
609
609
610: Include contents of *FILE*, verbatim, at the end of the header.
610: Include contents of *FILE*, verbatim, at the end of the header.
611 This can be used, for example, to include special
611 This can be used, for example, to include special
612− CSS or javascript in HTML documents. This option can be used
612+ CSS or JavaScript in HTML documents. This option can be used
613 repeatedly to include multiple files in the header. They will be
613 repeatedly to include multiple files in the header. They will be
614 included in the order specified. Implies `--standalone`.
614 included in the order specified. Implies `--standalone`.
615
615
@@ -657,7 +657,7 @@ Options affecting specific writers
657
657
658`--ascii`
658`--ascii`
659
659
660−: Use only ascii characters in output. Currently supported only
660+: Use only ASCII characters in output. Currently supported only
661 for HTML output (which uses numerical entities instead of
661 for HTML output (which uses numerical entities instead of
662 UTF-8 when this option is selected).
662 UTF-8 when this option is selected).
663
663
@@ -677,7 +677,7 @@ Options affecting specific writers
677
677
678`--atx-headers`
678`--atx-headers`
679
679
680−: Use ATX-style headers in Markdown and asciidoc output. The default is
680+: Use ATX-style headers in Markdown and AsciiDoc output. The default is
681 to use setext-style headers for levels 1-2, and then ATX headers.
681 to use setext-style headers for levels 1-2, and then ATX headers.
682
682
683`--chapters`
683`--chapters`
@@ -761,7 +761,7 @@ Options affecting specific writers
761
761
762: Specify a method for obfuscating `mailto:` links in HTML documents.
762: Specify a method for obfuscating `mailto:` links in HTML documents.
763 `none` leaves `mailto:` links as they are. `javascript` obfuscates
763 `none` leaves `mailto:` links as they are. `javascript` obfuscates
764− them using javascript. `references` obfuscates them by printing their
764+ them using JavaScript. `references` obfuscates them by printing their
765 letters as decimal or hexadecimal character references. The default
765 letters as decimal or hexadecimal character references. The default
766 is `none`.
766 is `none`.
767
767
@@ -966,7 +966,7 @@ Math rendering in HTML
966`--mathml`[`=`*URL*]
966`--mathml`[`=`*URL*]
967
967
968: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
968: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
969− In standalone `html` output, a small javascript (or a link to such a
969+ In standalone `html` output, a small JavaScript (or a link to such a
970 script if a *URL* is supplied) will be inserted that allows the MathML to
970 script if a *URL* is supplied) will be inserted that allows the MathML to
971 be viewed on some browsers.
971 be viewed on some browsers.
972
972
@@ -1665,7 +1665,7 @@ If the `--section-divs` option is specified, then each section will
1665be wrapped in a `div` (or a `section`, if `--html5` was specified),
1665be wrapped in a `div` (or a `section`, if `--html5` was specified),
1666and the identifier will be attached to the enclosing `<div>`
1666and the identifier will be attached to the enclosing `<div>`
1667(or `<section>`) tag rather than the header itself. This allows entire
1667(or `<section>`) tag rather than the header itself. This allows entire
1668−sections to be manipulated using javascript or treated differently in
1668+sections to be manipulated using JavaScript or treated differently in
1669CSS.
1669CSS.
1670
1670
1671#### Extension: `implicit_header_references` ####
1671#### Extension: `implicit_header_references` ####
@@ -1851,7 +1851,7 @@ This is equivalent to:
1851 ```
1851 ```
1852
1852
1853If the `fenced_code_attributes` extension is disabled, but
1853If the `fenced_code_attributes` extension is disabled, but
1854−input contains class attribute(s) for the codeblock, the first
1854+input contains class attribute(s) for the code block, the first
1855class attribute will be printed after the opening fence as a bare
1855class attribute will be printed after the opening fence as a bare
1856word.
1856word.
1857
1857
@@ -2009,7 +2009,7 @@ and this one:
2009
2009
2010Unlike standard Markdown, pandoc allows ordered list items to be marked
2010Unlike standard Markdown, pandoc allows ordered list items to be marked
2011with uppercase and lowercase letters and roman numerals, in addition to
2011with uppercase and lowercase letters and roman numerals, in addition to
2012−arabic numerals. List markers may be enclosed in parentheses or followed by a
2012+Arabic numerals. List markers may be enclosed in parentheses or followed by a
2013single right-parentheses or period. They must be separated from the
2013single right-parentheses or period. They must be separated from the
2014text that follows by at least one space, and, if the list marker is a
2014text that follows by at least one space, and, if the list marker is a
2015capital letter with a period, by at least two spaces.[^2]
2015capital letter with a period, by at least two spaces.[^2]
@@ -2774,13 +2774,13 @@ Textile
2774 ~ It will be rendered inside `<span class="math">` tags.
2774 ~ It will be rendered inside `<span class="math">` tags.
2775
2775
2776RTF, OpenDocument, ODT
2776RTF, OpenDocument, ODT
2777− ~ It will be rendered, if possible, using unicode characters,
2777+ ~ It will be rendered, if possible, using Unicode characters,
2778 and will otherwise appear verbatim.
2778 and will otherwise appear verbatim.
2779
2779
2780DocBook
2780DocBook
2781 ~ If the `--mathml` flag is used, it will be rendered using MathML
2781 ~ If the `--mathml` flag is used, it will be rendered using MathML
2782 in an `inlineequation` or `informalequation` tag. Otherwise it
2782 in an `inlineequation` or `informalequation` tag. Otherwise it
2783− will be rendered, if possible, using unicode characters.
2783+ will be rendered, if possible, using Unicode characters.
2784
2784
2785Docx
2785Docx
2786 ~ It will be rendered using OMML math markup.
2786 ~ It will be rendered using OMML math markup.
@@ -2794,7 +2794,7 @@ HTML, Slidy, DZSlides, S5, EPUB
2794 ~ The way math is rendered in HTML will depend on the
2794 ~ The way math is rendered in HTML will depend on the
2795 command-line options selected:
2795 command-line options selected:
2796
2796
2797− 1. The default is to render TeX math as far as possible using unicode
2797+ 1. The default is to render TeX math as far as possible using Unicode
2798 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2798 characters, as with RTF, DocBook, and OpenDocument output. Formulas
2799 are put inside a `span` with `class="math"`, so that they may be
2799 are put inside a `span` with `class="math"`, so that they may be
2800 styled differently from the surrounding text if needed.
2800 styled differently from the surrounding text if needed.
@@ -3471,7 +3471,7 @@ pointy braces `<...>`.
3471#### Extension: `ascii_identifiers` ####
3471#### Extension: `ascii_identifiers` ####
3472
3472
3473Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3473Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3474−Accents are stripped off of accented latin letters, and non-latin
3474+Accents are stripped off of accented Latin letters, and non-Latin
3475letters are omitted.
3475letters are omitted.
3476
3476
3477#### Extension: `mmd_link_attributes` ####
3477#### Extension: `mmd_link_attributes` ####
@@ -3563,7 +3563,7 @@ other than Markdown:
3563Producing slide shows with pandoc
3563Producing slide shows with pandoc
3564=================================
3564=================================
3565
3565
3566−You can use pandoc to produce an HTML + javascript slide presentation
3566+You can use pandoc to produce an HTML + JavaScript slide presentation
3567that can be viewed via a web browser. There are five ways to do this,
3567that can be viewed via a web browser. There are five ways to do this,
3568using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3568using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3569You can also produce a PDF slide show using LaTeX [`beamer`].
3569You can also produce a PDF slide show using LaTeX [`beamer`].
@@ -3602,19 +3602,19 @@ Here's the Markdown source for a simple slide show, `habits.txt`:
3602 - Get in bed
3602 - Get in bed
3603 - Count sheep
3603 - Count sheep
3604
3604
3605−To produce an HTML/javascript slide show, simply type
3605+To produce an HTML/JavaScript slide show, simply type
3606
3606
3607 pandoc -t FORMAT -s habits.txt -o habits.html
3607 pandoc -t FORMAT -s habits.txt -o habits.html
3608
3608
3609where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3609where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3610
3610
3611For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3611For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
3612−`-s/--standalone` option embeds a link to javascripts and CSS files, which are
3612+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
3613assumed to be available at the relative path `s5/default` (for S5), `slideous`
3613assumed to be available at the relative path `s5/default` (for S5), `slideous`
3614(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3614(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
3615`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3615`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
3616`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3616`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
3617−above.) For DZSlides, the (relatively short) javascript and css are included in
3617+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
3618the file by default.
3618the file by default.
3619
3619
3620With all HTML slide formats, the `--self-contained` option can be used to
3620With all HTML slide formats, the `--self-contained` option can be used to
@@ -3934,7 +3934,7 @@ The color scheme can be selected using the `--highlight-style` option.
3934The default color scheme is `pygments`, which imitates the default color
3934The default color scheme is `pygments`, which imitates the default color
3935scheme used by the Python library pygments (though pygments is not actually
3935scheme used by the Python library pygments (though pygments is not actually
3936used to do the highlighting). To see a list of highlight styles,
3936used to do the highlighting). To see a list of highlight styles,
3937−type `pandoc --list-hightlight-styles`.
3937+type `pandoc --list-highlight-styles`.
3938
3938
3939To disable highlighting, use the `--no-highlight` option.
3939To disable highlighting, use the `--no-highlight` option.
3940
3940
@@ -3949,7 +3949,7 @@ formatting (italics, bold) for inlines. This will work for most
3949purposes, especially alongside a `reference.docx` file. However, if you
3949purposes, especially alongside a `reference.docx` file. However, if you
3950need to apply your own styles to blocks, or match a preexisting set of
3950need to apply your own styles to blocks, or match a preexisting set of
3951styles, pandoc allows you to define custom styles for blocks and text
3951styles, pandoc allows you to define custom styles for blocks and text
3952−using `div`s and `span`s, respecitively.
3952+using `div`s and `span`s, respectively.
3953
3953
3954If you define a `div` or `span` with the attribute `custom-style`,
3954If you define a `div` or `span` with the attribute `custom-style`,
3955pandoc will apply your specified style to the contained elements. So,
3955pandoc will apply your specified style to the contained elements. So,