git.iko.soy/typeable/pandoc
on master help sign in
Updated MANUAL date and man page.
commit35ff12a569637f7c09ad6b68b74f4a9c9e5e98d4 authorJohn MacFarlane <jgm@berkeley.edu> dateSat 10 Dec 2016, 11:29 (10 years ago) parentabc874b
2 files changed+43−30
MANUAL.txt+1−1 man/pandoc.1+42−29
MANUAL.txt+1−1
@@ -1,6 +1,6 @@
11% Pandoc User's Guide
22% John MacFarlane
3−% November 30, 2016
3+% December 10, 2016
44
55Synopsis
66========
man/pandoc.1+42−29
@@ -1,5 +1,5 @@
11.\"t
2−.TH PANDOC 1 "November 30, 2016" "pandoc 1.19"
2+.TH PANDOC 1 "December 10, 2016" "pandoc 1.19.1"
33.SH NAME
44pandoc - general markup converter
55.SH SYNOPSIS
@@ -257,11 +257,11 @@ markup), \f[C]zimwiki\f[] (ZimWiki markup), \f[C]textile\f[] (Textile),
257257(Haddock markup), \f[C]rtf\f[] (rich text format), \f[C]epub\f[] (EPUB
258258v2 book), \f[C]epub3\f[] (EPUB v3), \f[C]fb2\f[] (FictionBook2 e\-book),
259259\f[C]asciidoc\f[] (AsciiDoc), \f[C]icml\f[] (InDesign ICML),
260−\f[C]tei\f[] (TEI Simple), \f[C]slidy\f[] (Slidy HTML and javascript
261−slide show), \f[C]slideous\f[] (Slideous HTML and javascript slide
262−show), \f[C]dzslides\f[] (DZSlides HTML5 + javascript slide show),
263−\f[C]revealjs\f[] (reveal.js HTML5 + javascript slide show), \f[C]s5\f[]
264−(S5 HTML and javascript slide show), or the path of a custom lua writer
260+\f[C]tei\f[] (TEI Simple), \f[C]slidy\f[] (Slidy HTML and JavaScript
261+slide show), \f[C]slideous\f[] (Slideous HTML and JavaScript slide
262+show), \f[C]dzslides\f[] (DZSlides HTML5 + JavaScript slide show),
263+\f[C]revealjs\f[] (reveal.js HTML5 + JavaScript slide show), \f[C]s5\f[]
264+(S5 HTML and JavaScript slide show), or the path of a custom lua writer
265265(see Custom writers, below).
266266Note that \f[C]odt\f[], \f[C]epub\f[], and \f[C]epub3\f[] output will
267267not be directed to \f[I]stdout\f[]; an output filename must be specified
@@ -669,7 +669,7 @@ See also \f[C]\-\-list\-highlight\-styles\f[].
669669.TP
670670.B \f[C]\-H\f[] \f[I]FILE\f[], \f[C]\-\-include\-in\-header=\f[]\f[I]FILE\f[]
671671Include contents of \f[I]FILE\f[], verbatim, at the end of the header.
672−This can be used, for example, to include special CSS or javascript in
672+This can be used, for example, to include special CSS or JavaScript in
673673HTML documents.
674674This option can be used repeatedly to include multiple files in the
675675header.
@@ -731,7 +731,7 @@ Use \f[C]<q>\f[] tags for quotes in HTML.
731731.RE
732732.TP
733733.B \f[C]\-\-ascii\f[]
734−Use only ascii characters in output.
734+Use only ASCII characters in output.
735735Currently supported only for HTML output (which uses numerical entities
736736instead of UTF\-8 when this option is selected).
737737.RS
@@ -756,7 +756,7 @@ Currently only affects the markdown writer.
756756.RE
757757.TP
758758.B \f[C]\-\-atx\-headers\f[]
759−Use ATX\-style headers in Markdown and asciidoc output.
759+Use ATX\-style headers in Markdown and AsciiDoc output.
760760The default is to use setext\-style headers for levels 1\-2, and then
761761ATX headers.
762762.RS
@@ -792,7 +792,7 @@ Sections with class \f[C]unnumbered\f[] will never be numbered, even if
792792.RS
793793.RE
794794.TP
795−.B \f[C]\-\-number\-offset=\f[]\f[I]NUMBER\f[][\f[C],\f[]\f[I]NUMBER\f[]\f[C],\f[]\f[I]\&...\f[]]
795+.B \f[C]\-\-number\-offset=\f[]\f[I]NUMBER\f[][\f[C],\f[]\f[I]NUMBER\f[]\f[C],\f[]\f[I]...\f[]]
796796Offset for section headings in HTML output (ignored in other output
797797formats).
798798The first number is added to the section number for top\-level headers,
@@ -860,7 +860,7 @@ See Header identifiers, below.
860860Specify a method for obfuscating \f[C]mailto:\f[] links in HTML
861861documents.
862862\f[C]none\f[] leaves \f[C]mailto:\f[] links as they are.
863−\f[C]javascript\f[] obfuscates them using javascript.
863+\f[C]javascript\f[] obfuscates them using JavaScript.
864864\f[C]references\f[] obfuscates them by printing their letters as decimal
865865or hexadecimal character references.
866866The default is \f[C]none\f[].
@@ -901,6 +901,12 @@ for a file \f[C]reference.odt\f[] in the user data directory (see
901901\f[C]\-\-data\-dir\f[]).
902902If this is not found either, sensible defaults will be used.
903903.RS
904+.PP
905+To produce a custom \f[C]reference.odt\f[], first get a copy of the
906+default \f[C]reference.odt\f[]:
907+\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.odt\ >\ custom\-reference.odt\f[].
908+Then open \f[C]custom\-reference.docx\f[] in LibreOffice, modify the
909+styles as you wish, and save the file.
904910.RE
905911.TP
906912.B \f[C]\-\-reference\-docx=\f[]\f[I]FILE\f[]
@@ -914,14 +920,21 @@ If no reference docx is specified on the command line, pandoc will look
914920for a file \f[C]reference.docx\f[] in the user data directory (see
915921\f[C]\-\-data\-dir\f[]).
916922If this is not found either, sensible defaults will be used.
917−The following styles are used by pandoc: [paragraph] Normal, Body Text,
918−First Paragraph, Compact, Title, Subtitle, Author, Date, Abstract,
923+.RS
924+.PP
925+To produce a custom \f[C]reference.docx\f[], first get a copy of the
926+default \f[C]reference.docx\f[]:
927+\f[C]pandoc\ \-\-print\-default\-data\-file\ reference.docx\ >\ custom\-reference.docx\f[].
928+Then open \f[C]custom\-reference.docx\f[] in Word, modify the styles as
929+you wish, and save the file.
930+For best results, do not make changes to this file other than modifying
931+the styles used by pandoc: [paragraph] Normal, Body Text, First
932+Paragraph, Compact, Title, Subtitle, Author, Date, Abstract,
919933Bibliography, Heading 1, Heading 2, Heading 3, Heading 4, Heading 5,
920934Heading 6, Block Text, Footnote Text, Definition Term, Definition,
921935Caption, Table Caption, Image Caption, Figure, Figure With Caption, TOC
922936Heading; [character] Default Paragraph Font, Body Text Char, Verbatim
923937Char, Footnote Reference, Hyperlink; [table] Normal Table.
924−.RS
925938.RE
926939.TP
927940.B \f[C]\-\-epub\-stylesheet=\f[]\f[I]FILE\f[]
@@ -1106,7 +1119,7 @@ copy of the script, so it can be cached.
11061119.B \f[C]\-\-mathml\f[][\f[C]=\f[]\f[I]URL\f[]]
11071120Convert TeX math to MathML (in \f[C]docbook\f[], \f[C]docbook5\f[],
11081121\f[C]html\f[] and \f[C]html5\f[]).
1109−In standalone \f[C]html\f[] output, a small javascript (or a link to
1122+In standalone \f[C]html\f[] output, a small JavaScript (or a link to
11101123such a script if a \f[I]URL\f[] is supplied) will be inserted that
11111124allows the MathML to be viewed on some browsers.
11121125.RS
@@ -2051,7 +2064,7 @@ will be wrapped in a \f[C]div\f[] (or a \f[C]section\f[], if
20512064\f[C]\-\-html5\f[] was specified), and the identifier will be attached
20522065to the enclosing \f[C]<div>\f[] (or \f[C]<section>\f[]) tag rather than
20532066the header itself.
2054−This allows entire sections to be manipulated using javascript or
2067+This allows entire sections to be manipulated using JavaScript or
20552068treated differently in CSS.
20562069.SS Extension: \f[C]implicit_header_references\f[]
20572070.PP
@@ -2308,8 +2321,8 @@ qsort\ []\ =\ []
23082321.fi
23092322.PP
23102323If the \f[C]fenced_code_attributes\f[] extension is disabled, but input
2311−contains class attribute(s) for the codeblock, the first class attribute
2312−will be printed after the opening fence as a bare word.
2324+contains class attribute(s) for the code block, the first class
2325+attribute will be printed after the opening fence as a bare word.
23132326.PP
23142327To prevent all highlighting, use the \f[C]\-\-no\-highlight\f[] flag.
23152328To set the highlighting style, use \f[C]\-\-highlight\-style\f[].
@@ -2503,7 +2516,7 @@ and this one:
25032516.PP
25042517Unlike standard Markdown, pandoc allows ordered list items to be marked
25052518with uppercase and lowercase letters and roman numerals, in addition to
2506−arabic numerals.
2519+Arabic numerals.
25072520List markers may be enclosed in parentheses or followed by a single
25082521right\-parentheses or period.
25092522They must be separated from the text that follows by at least one space,
@@ -3466,7 +3479,7 @@ It will be rendered inside \f[C]<span\ class="math">\f[] tags.
34663479.RE
34673480.TP
34683481.B RTF, OpenDocument, ODT
3469−It will be rendered, if possible, using unicode characters, and will
3482+It will be rendered, if possible, using Unicode characters, and will
34703483otherwise appear verbatim.
34713484.RS
34723485.RE
@@ -3474,7 +3487,7 @@ otherwise appear verbatim.
34743487.B DocBook
34753488If the \f[C]\-\-mathml\f[] flag is used, it will be rendered using
34763489MathML in an \f[C]inlineequation\f[] or \f[C]informalequation\f[] tag.
3477−Otherwise it will be rendered, if possible, using unicode characters.
3490+Otherwise it will be rendered, if possible, using Unicode characters.
34783491.RS
34793492.RE
34803493.TP
@@ -3496,7 +3509,7 @@ The way math is rendered in HTML will depend on the command\-line
34963509options selected:
34973510.RS
34983511.IP "1." 3
3499−The default is to render TeX math as far as possible using unicode
3512+The default is to render TeX math as far as possible using Unicode
35003513characters, as with RTF, DocBook, and OpenDocument output.
35013514Formulas are put inside a \f[C]span\f[] with \f[C]class="math"\f[], so
35023515that they may be styled differently from the surrounding text if needed.
@@ -4367,7 +4380,7 @@ braces \f[C]<...>\f[].
43674380.PP
43684381Causes the identifiers produced by \f[C]auto_identifiers\f[] to be pure
43694382ASCII.
4370−Accents are stripped off of accented latin letters, and non\-latin
4383+Accents are stripped off of accented Latin letters, and non\-Latin
43714384letters are omitted.
43724385.SS Extension: \f[C]mmd_link_attributes\f[]
43734386.PP
@@ -4456,7 +4469,7 @@ than Markdown:
44564469example.)
44574470.SH PRODUCING SLIDE SHOWS WITH PANDOC
44584471.PP
4459−You can use pandoc to produce an HTML + javascript slide presentation
4472+You can use pandoc to produce an HTML + JavaScript slide presentation
44604473that can be viewed via a web browser.
44614474There are five ways to do this, using S5, DZSlides, Slidy, Slideous, or
44624475reveal.js.
@@ -4501,7 +4514,7 @@ Here\[aq]s the Markdown source for a simple slide show,
45014514\f[]
45024515.fi
45034516.PP
4504−To produce an HTML/javascript slide show, simply type
4517+To produce an HTML/JavaScript slide show, simply type
45054518.IP
45064519.nf
45074520\f[C]
@@ -4513,7 +4526,7 @@ where \f[C]FORMAT\f[] is either \f[C]s5\f[], \f[C]slidy\f[],
45134526\f[C]slideous\f[], \f[C]dzslides\f[], or \f[C]revealjs\f[].
45144527.PP
45154528For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with
4516−the \f[C]\-s/\-\-standalone\f[] option embeds a link to javascripts and
4529+the \f[C]\-s/\-\-standalone\f[] option embeds a link to JavaScript and
45174530CSS files, which are assumed to be available at the relative path
45184531\f[C]s5/default\f[] (for S5), \f[C]slideous\f[] (for Slideous),
45194532\f[C]reveal.js\f[] (for reveal.js), or at the Slidy website at
@@ -4521,7 +4534,7 @@ CSS files, which are assumed to be available at the relative path
45214534(These paths can be changed by setting the \f[C]slidy\-url\f[],
45224535\f[C]slideous\-url\f[], \f[C]revealjs\-url\f[], or \f[C]s5\-url\f[]
45234536variables; see Variables for slides, above.) For DZSlides, the
4524−(relatively short) javascript and css are included in the file by
4537+(relatively short) JavaScript and CSS are included in the file by
45254538default.
45264539.PP
45274540With all HTML slide formats, the \f[C]\-\-self\-contained\f[] option can
@@ -4925,7 +4938,7 @@ The default color scheme is \f[C]pygments\f[], which imitates the
49254938default color scheme used by the Python library pygments (though
49264939pygments is not actually used to do the highlighting).
49274940To see a list of highlight styles, type
4928−\f[C]pandoc\ \-\-list\-hightlight\-styles\f[].
4941+\f[C]pandoc\ \-\-list\-highlight\-styles\f[].
49294942.PP
49304943To disable highlighting, use the \f[C]\-\-no\-highlight\f[] option.
49314944.SH CUSTOM STYLES IN DOCX OUTPUT
@@ -4937,7 +4950,7 @@ This will work for most purposes, especially alongside a
49374950\f[C]reference.docx\f[] file.
49384951However, if you need to apply your own styles to blocks, or match a
49394952preexisting set of styles, pandoc allows you to define custom styles for
4940−blocks and text using \f[C]div\f[]s and \f[C]span\f[]s, respecitively.
4953+blocks and text using \f[C]div\f[]s and \f[C]span\f[]s, respectively.
49414954.PP
49424955If you define a \f[C]div\f[] or \f[C]span\f[] with the attribute
49434956\f[C]custom\-style\f[], pandoc will apply your specified style to the