Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Minor spelling typos in the manual (#3273)

Browse source 
* Fix spelling typos:

 * hightlight
 * respecitively
 * codeblock – inconsistent with rest of document using “code block”

* Use consistent case for proper nouns.

For example: “ASCII”, “Unicode”, “Latin”, “JavaScript”, “CSS”.
This commit is contained in:
Anthony Geoghegan 2016-12-03 20:17:27 +00:00 committed by John MacFarlane
parent 3dacf5b5e7
commit 733b1f3ae2
1 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
MANUAL.txt
View file

@ -284,11 +284,11 @@ General options
(Haddock markup), `rtf` (rich text format), `epub` (EPUB v2 (Haddock markup), `rtf` (rich text format), `epub` (EPUB v2
book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book), book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
`asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
Simple), `slidy` (Slidy HTML and javascript slide show), Simple), `slidy` (Slidy HTML and JavaScript slide show),
`slideous` (Slideous HTML and javascript slide show), `slideous` (Slideous HTML and JavaScript slide show),
`dzslides` (DZSlides HTML5 + javascript slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),
`revealjs` (reveal.js HTML5 + javascript slide show), `s5` `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
(S5 HTML and javascript slide show), or the path of a custom (S5 HTML and JavaScript slide show), or the path of a custom
lua writer (see [Custom writers], below). Note that `odt`, lua writer (see [Custom writers], below). Note that `odt`,
`epub`, and `epub3` output will not be directed to *stdout*; `epub`, and `epub3` output will not be directed to *stdout*;
an output filename must be specified using the `-o/--output` an output filename must be specified using the `-o/--output`
@ -609,7 +609,7 @@ General writer options
: Include contents of *FILE*, verbatim, at the end of the header. : Include contents of *FILE*, verbatim, at the end of the header.
This can be used, for example, to include special This can be used, for example, to include special
CSS or javascript in HTML documents. This option can be used CSS or JavaScript in HTML documents. This option can be used
repeatedly to include multiple files in the header. They will be repeatedly to include multiple files in the header. They will be
included in the order specified. Implies `--standalone`. included in the order specified. Implies `--standalone`.
@ -657,7 +657,7 @@ Options affecting specific writers
`--ascii` `--ascii`
: Use only ascii characters in output. Currently supported only : Use only ASCII characters in output. Currently supported only
for HTML output (which uses numerical entities instead of for HTML output (which uses numerical entities instead of
UTF-8 when this option is selected). UTF-8 when this option is selected).
@ -677,7 +677,7 @@ Options affecting specific writers
`--atx-headers` `--atx-headers`
: Use ATX-style headers in Markdown and asciidoc output. The default is : 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. to use setext-style headers for levels 1-2, and then ATX headers.
`--chapters` `--chapters`
@ -761,7 +761,7 @@ Options affecting specific writers
: Specify a method for obfuscating `mailto:` links in HTML documents. : Specify a method for obfuscating `mailto:` links in HTML documents.
`none` leaves `mailto:` links as they are. `javascript` obfuscates `none` leaves `mailto:` links as they are. `javascript` obfuscates
them using javascript. `references` obfuscates them by printing their them using JavaScript. `references` obfuscates them by printing their
letters as decimal or hexadecimal character references. The default letters as decimal or hexadecimal character references. The default
is `none`. is `none`.
@ -966,7 +966,7 @@ Math rendering in HTML
`--mathml`[`=`*URL*] `--mathml`[`=`*URL*]
: Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`). : Convert TeX math to [MathML] (in `docbook`, `docbook5`, `html` and `html5`).
In standalone `html` output, a small javascript (or a link to such a In standalone `html` output, a small JavaScript (or a link to such a
script if a *URL* is supplied) will be inserted that allows the MathML to script if a *URL* is supplied) will be inserted that allows the MathML to
be viewed on some browsers. be viewed on some browsers.
@ -1665,7 +1665,7 @@ If the `--section-divs` option is specified, then each section will
be wrapped in a `div` (or a `section`, if `--html5` was specified), be wrapped in a `div` (or a `section`, if `--html5` was specified),
and the identifier will be attached to the enclosing `<div>` and the identifier will be attached to the enclosing `<div>`
(or `<section>`) tag rather than the header itself. This allows entire (or `<section>`) tag rather than the header itself. This allows entire
sections to be manipulated using javascript or treated differently in sections to be manipulated using JavaScript or treated differently in
CSS. CSS.
#### Extension: `implicit_header_references` #### #### Extension: `implicit_header_references` ####
@ -1851,7 +1851,7 @@ This is equivalent to:
``` ```
If the `fenced_code_attributes` extension is disabled, but If the `fenced_code_attributes` extension is disabled, but
input contains class attribute(s) for the codeblock, the first input contains class attribute(s) for the code block, the first
class attribute will be printed after the opening fence as a bare class attribute will be printed after the opening fence as a bare
word. word.
@ -2009,7 +2009,7 @@ and this one:
Unlike standard Markdown, pandoc allows ordered list items to be marked Unlike standard Markdown, pandoc allows ordered list items to be marked
with uppercase and lowercase letters and roman numerals, in addition to with uppercase and lowercase letters and roman numerals, in addition to
arabic numerals. List markers may be enclosed in parentheses or followed by a Arabic numerals. List markers may be enclosed in parentheses or followed by a
single right-parentheses or period. They must be separated from the single right-parentheses or period. They must be separated from the
text that follows by at least one space, and, if the list marker is a 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.[^2] capital letter with a period, by at least two spaces.[^2]
@ -2774,13 +2774,13 @@ Textile
~ It will be rendered inside `<span class="math">` tags. ~ It will be rendered inside `<span class="math">` tags.
RTF, OpenDocument, ODT RTF, OpenDocument, ODT
~ It will be rendered, if possible, using unicode characters, ~ It will be rendered, if possible, using Unicode characters,
and will otherwise appear verbatim. and will otherwise appear verbatim.
DocBook DocBook
~ If the `--mathml` flag is used, it will be rendered using MathML ~ If the `--mathml` flag is used, it will be rendered using MathML
in an `inlineequation` or `informalequation` tag. Otherwise it in an `inlineequation` or `informalequation` tag. Otherwise it
will be rendered, if possible, using unicode characters. will be rendered, if possible, using Unicode characters.
Docx Docx
~ It will be rendered using OMML math markup. ~ It will be rendered using OMML math markup.
@ -2794,7 +2794,7 @@ HTML, Slidy, DZSlides, S5, EPUB
~ The way math is rendered in HTML will depend on the ~ The way math is rendered in HTML will depend on the
command-line options selected: command-line options selected:
1. The default is to render TeX math as far as possible using unicode 1. The default is to render TeX math as far as possible using Unicode
characters, as with RTF, DocBook, and OpenDocument output. Formulas characters, as with RTF, DocBook, and OpenDocument output. Formulas
are put inside a `span` with `class="math"`, so that they may be are put inside a `span` with `class="math"`, so that they may be
styled differently from the surrounding text if needed. styled differently from the surrounding text if needed.
@ -3471,7 +3471,7 @@ pointy braces `<...>`.
#### Extension: `ascii_identifiers` #### #### Extension: `ascii_identifiers` ####
Causes the identifiers produced by `auto_identifiers` to be pure ASCII. Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
Accents are stripped off of accented latin letters, and non-latin Accents are stripped off of accented Latin letters, and non-Latin
letters are omitted. letters are omitted.
#### Extension: `mmd_link_attributes` #### #### Extension: `mmd_link_attributes` ####
@ -3563,7 +3563,7 @@ other than Markdown:
Producing slide shows with pandoc Producing slide shows with pandoc
================================= =================================
You can use pandoc to produce an HTML + javascript slide presentation 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, that can be viewed via a web browser. There are five ways to do this,
using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js]. using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
You can also produce a PDF slide show using LaTeX [`beamer`]. You 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`:
- Get in bed - Get in bed
- Count sheep - Count sheep
To produce an HTML/javascript slide show, simply type To produce an HTML/JavaScript slide show, simply type
pandoc -t FORMAT -s habits.txt -o habits.html pandoc -t FORMAT -s habits.txt -o habits.html
where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`. where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
`-s/--standalone` option embeds a link to javascripts and CSS files, which are `-s/--standalone` option embeds a link to JavaScript and CSS files, which are
assumed to be available at the relative path `s5/default` (for S5), `slideous` assumed to be available at the relative path `s5/default` (for S5), `slideous`
(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at (for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`, `w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides], `slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
above.) For DZSlides, the (relatively short) javascript and css are included in above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
the file by default. the file by default.
With all HTML slide formats, the `--self-contained` option can be used to With 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.
The default color scheme is `pygments`, which imitates the default color The default color scheme is `pygments`, which imitates the default color
scheme used by the Python library pygments (though pygments is not actually scheme used by the Python library pygments (though pygments is not actually
used to do the highlighting). To see a list of highlight styles, used to do the highlighting). To see a list of highlight styles,
type `pandoc --list-hightlight-styles`. type `pandoc --list-highlight-styles`.
To disable highlighting, use the `--no-highlight` option. To disable highlighting, use the `--no-highlight` option.
@ -3949,7 +3949,7 @@ formatting (italics, bold) for inlines. This will work for most
purposes, especially alongside a `reference.docx` file. However, if you purposes, especially alongside a `reference.docx` file. However, if you
need to apply your own styles to blocks, or match a preexisting set of 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 styles, pandoc allows you to define custom styles for blocks and text
using `div`s and `span`s, respecitively. using `div`s and `span`s, respectively.
If you define a `div` or `span` with the attribute `custom-style`, If you define a `div` or `span` with the attribute `custom-style`,
pandoc will apply your specified style to the contained elements. So, pandoc will apply your specified style to the contained elements. So,