From d57ff311e54e6fbdbdbace3467d8610d4b9dfee1 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 18 Jan 2018 08:16:08 -0800 Subject: Replaced tabs with spaces in MANUAL.txt. @jkr - the tabs were inserted by your 624abeec5c3b9f5c27cffe6d157617aa97367e92, presumably through some automatic setting in your editor that replaced 8 spaces with a tab. This messed up indented formatting in the manual. --- MANUAL.txt | 314 +++++++++++++++++++++++++++++------------------------------ README.md | 2 +- man/pandoc.1 | 274 +++++++++++++++++++++++++++++++++------------------ 3 files changed, 337 insertions(+), 253 deletions(-) diff --git a/MANUAL.txt b/MANUAL.txt index b06f3343f..4f785079b 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ % Pandoc User's Guide % John MacFarlane -% January 7, 2018 +% January 18, 2018 Synopsis ======== @@ -349,15 +349,15 @@ General options If this option is not specified, the default user data directory will be used. This is, in UNIX: - $HOME/.pandoc + $HOME/.pandoc in Windows XP: - C:\Documents And Settings\USERNAME\Application Data\pandoc + C:\Documents And Settings\USERNAME\Application Data\pandoc and in Windows Vista or later: - C:\Users\USERNAME\AppData\Roaming\pandoc + C:\Users\USERNAME\AppData\Roaming\pandoc You can find the default user data directory on your system by looking at the output of `pandoc --version`. @@ -370,7 +370,7 @@ General options : Generate a bash completion script. To enable bash completion with pandoc, add this to your `.bashrc`: - eval "$(pandoc --bash-completion)" + eval "$(pandoc --bash-completion)" `--verbose` @@ -468,11 +468,11 @@ Reader options JSON input and output. The name of the output format will be passed to the filter as the first argument. Hence, - pandoc --filter ./caps.py -t latex + pandoc --filter ./caps.py -t latex is equivalent to - pandoc -t json | ./caps.py latex | pandoc -f json -t latex + pandoc -t json | ./caps.py latex | pandoc -f json -t latex The latter form may be useful for debugging filters. @@ -511,15 +511,15 @@ Reader options The following is an example lua script for macro-expansion: - function expand_hello_world(inline) - if inline.c == '{{helloworld}}' then - return pandoc.Emph{ pandoc.Str "Hello, World" } - else - return inline - end - end + function expand_hello_world(inline) + if inline.c == '{{helloworld}}' then + return pandoc.Emph{ pandoc.Str "Hello, World" } + else + return inline + end + end - return {{Str = expand_hello_world}} + return {{Str = expand_hello_world}} `-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*] @@ -919,48 +919,48 @@ Options affecting specific writers Docx : For best results, the reference docx should be a modified - version of a docx file produced using pandoc. The contents - of the reference docx are ignored, but its stylesheets and - document properties (including margins, page size, header, - and footer) are used in the new docx. If no reference docx - is specified on the command line, pandoc will look for a - file `reference.docx` in the user data directory (see - `--data-dir`). If this is not found either, sensible - defaults will be used. - - To produce a custom `reference.docx`, first get a copy of - the default `reference.docx`: `pandoc - --print-default-data-file reference.docx > - custom-reference.docx`. Then open `custom-reference.docx` - in Word, modify the styles as you wish, and save the file. - For best results, do not make changes to this file other - than modifying the styles used by pandoc: [paragraph] - Normal, Body Text, First Paragraph, Compact, Title, - Subtitle, Author, Date, Abstract, Bibliography, Heading 1, - Heading 2, Heading 3, Heading 4, Heading 5, Heading 6, - Heading 7, Heading 8, Heading 9, Block Text, Footnote Text, - Definition Term, Definition, Caption, Table Caption, - Image Caption, Figure, Captioned Figure, TOC Heading; - [character] Default Paragraph Font, Body Text Char, - Verbatim Char, Footnote Reference, Hyperlink; [table] - Table. + version of a docx file produced using pandoc. The contents + of the reference docx are ignored, but its stylesheets and + document properties (including margins, page size, header, + and footer) are used in the new docx. If no reference docx + is specified on the command line, pandoc will look for a + file `reference.docx` in the user data directory (see + `--data-dir`). If this is not found either, sensible + defaults will be used. + + To produce a custom `reference.docx`, first get a copy of + the default `reference.docx`: `pandoc + --print-default-data-file reference.docx > + custom-reference.docx`. Then open `custom-reference.docx` + in Word, modify the styles as you wish, and save the file. + For best results, do not make changes to this file other + than modifying the styles used by pandoc: [paragraph] + Normal, Body Text, First Paragraph, Compact, Title, + Subtitle, Author, Date, Abstract, Bibliography, Heading 1, + Heading 2, Heading 3, Heading 4, Heading 5, Heading 6, + Heading 7, Heading 8, Heading 9, Block Text, Footnote Text, + Definition Term, Definition, Caption, Table Caption, + Image Caption, Figure, Captioned Figure, TOC Heading; + [character] Default Paragraph Font, Body Text Char, + Verbatim Char, Footnote Reference, Hyperlink; [table] + Table. ODT : For best results, the reference ODT should be a modified - version of an ODT produced using pandoc. The contents of - the reference ODT are ignored, but its stylesheets are used - in the new ODT. If no reference ODT is specified on the - command line, pandoc will look for a file `reference.odt` in - the user data directory (see `--data-dir`). If this is not - found either, sensible defaults will be used. - - To produce a custom `reference.odt`, first get a copy of - the default `reference.odt`: `pandoc - --print-default-data-file reference.odt > - custom-reference.odt`. Then open `custom-reference.odt` in - LibreOffice, modify the styles as you wish, and save the - file. + version of an ODT produced using pandoc. The contents of + the reference ODT are ignored, but its stylesheets are used + in the new ODT. If no reference ODT is specified on the + command line, pandoc will look for a file `reference.odt` in + the user data directory (see `--data-dir`). If this is not + found either, sensible defaults will be used. + + To produce a custom `reference.odt`, first get a copy of + the default `reference.odt`: `pandoc + --print-default-data-file reference.odt > + custom-reference.odt`. Then open `custom-reference.odt` in + LibreOffice, modify the styles as you wish, and save the + file. `--epub-cover-image=`*FILE* @@ -975,8 +975,8 @@ Options affecting specific writers The file should contain a series of [Dublin Core elements]. For example: - Creative Commons - es-AR + Creative Commons + es-AR By default, pandoc will include the following metadata elements: `` (from the document title), `` (from the @@ -1000,31 +1000,31 @@ Options affecting specific writers embedded fonts, you will need to add declarations like the following to your CSS (see `--css`): - @font-face { - font-family: DejaVuSans; - font-style: normal; - font-weight: normal; - src:url("DejaVuSans-Regular.ttf"); - } - @font-face { - font-family: DejaVuSans; - font-style: normal; - font-weight: bold; - src:url("DejaVuSans-Bold.ttf"); - } - @font-face { - font-family: DejaVuSans; - font-style: italic; - font-weight: normal; - src:url("DejaVuSans-Oblique.ttf"); - } - @font-face { - font-family: DejaVuSans; - font-style: italic; - font-weight: bold; - src:url("DejaVuSans-BoldOblique.ttf"); - } - body { font-family: "DejaVuSans"; } + @font-face { + font-family: DejaVuSans; + font-style: normal; + font-weight: normal; + src:url("DejaVuSans-Regular.ttf"); + } + @font-face { + font-family: DejaVuSans; + font-style: normal; + font-weight: bold; + src:url("DejaVuSans-Bold.ttf"); + } + @font-face { + font-family: DejaVuSans; + font-style: italic; + font-weight: normal; + src:url("DejaVuSans-Oblique.ttf"); + } + @font-face { + font-family: DejaVuSans; + font-style: italic; + font-weight: bold; + src:url("DejaVuSans-BoldOblique.ttf"); + } + body { font-family: "DejaVuSans"; } `--epub-chapter-level=`*NUMBER* @@ -1177,9 +1177,9 @@ of the following options. formulas and an HTML file with links to these images. So, the procedure is: - pandoc -s --gladtex input.md -o myfile.htex - gladtex -d myfile-images myfile.htex - # produces myfile.html and images in myfile-images + pandoc -s --gladtex input.md -o myfile.htex + gladtex -d myfile-images myfile.htex + # produces myfile.html and images in myfile-images `--mimetex`[`=`*URL*] @@ -1216,11 +1216,11 @@ Options for wrapper scripts : Ignore command-line arguments (for use in wrapper scripts). Regular pandoc options are not ignored. Thus, for example, - pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1 + pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1 is equivalent to - pandoc -o foo.html -s + pandoc -o foo.html -s Templates ========= @@ -1266,13 +1266,13 @@ as the following: if input is from stdin. You can use the following snippet in your template to distinguish them: - $if(sourcefile)$ - $for(sourcefile)$ - $sourcefile$ - $endfor$ - $else$ - (stdin) - $endif$ + $if(sourcefile)$ + $for(sourcefile)$ + $sourcefile$ + $endfor$ + $else$ + (stdin) + $endif$ Similarly, `outputfile` can be `-` if output goes to the terminal. @@ -1282,11 +1282,11 @@ as the following: through a [pandoc title block][Extension: `pandoc_title_block`], which allows for multiple authors, or through a YAML metadata block: - --- - author: - - Aristotle - - Peter Abelard - ... + --- + author: + - Aristotle + - Peter Abelard + ... `subtitle` : document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx; @@ -1334,11 +1334,11 @@ as the following: [^subtitle]: To make `subtitle` work with other LaTeX document classes, you can add the following to `header-includes`: - \providecommand{\subtitle}[1]{% - \usepackage{titling} - \posttitle{% - \par\large#1\end{center}} - } + \providecommand{\subtitle}[1]{% + \usepackage{titling} + \posttitle{% + \par\large#1\end{center}} + } Language variables ------------------ @@ -2208,9 +2208,9 @@ A block of text indented four spaces (or one tab) is treated as verbatim text: that is, special characters do not trigger special formatting, and all spaces and line breaks are preserved. For example, - if (a > 3) { - moveShip(5 * gravity, DOWN); - } + if (a > 3) { + moveShip(5 * gravity, DOWN); + } The initial (four space or one tab) indentation is not considered part of the verbatim text, and is removed in the output. @@ -2259,7 +2259,7 @@ this syntax: ~~~~ {#mycode .haskell .numberLines startFrom="100"} qsort [] = [] qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ - qsort (filter (>= x) xs) + qsort (filter (>= x) xs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and @@ -2383,12 +2383,12 @@ the list marker. * First paragraph. - Continued. + Continued. * Second paragraph. With a code block, which must be indented - eight spaces: + eight spaces: - { code } + { code } Exception: if the list marker is followed by an indented code block, which must begin 5 spaces after the list marker, then @@ -2406,8 +2406,8 @@ containing list item. * fruits + apples - - macintosh - - red delicious + - macintosh + - red delicious + pears + peaches * vegetables @@ -2424,7 +2424,7 @@ other blocks in a list item, the first line of each must be indented. + Another one; this looks bad but is legal. - Second paragraph of second + Second paragraph of second list item. ### Ordered lists ### @@ -2458,18 +2458,18 @@ capital letter with a period, by at least two spaces.[^2] [^2]: The point of this rule is to ensure that normal paragraphs starting with people's initials, like - B. Russell was an English philosopher. + B. Russell was an English philosopher. do not get treated as list items. This rule will not prevent - (C) 2007 Joe Smith + (C) 2007 Joe Smith from being interpreted as a list item. In this case, a backslash escape can be used: - (C\) 2007 Joe Smith + (C\) 2007 Joe Smith The `fancy_lists` extension also allows '`#`' to be used as an ordered list marker in place of a numeral: @@ -2488,9 +2488,9 @@ roman numerals: 9) Ninth 10) Tenth 11) Eleventh - i. subone - ii. subtwo - iii. subthree + i. subone + ii. subtwo + iii. subthree Pandoc will start a new list each time a different type of list marker is used. So, the following will create three lists: @@ -2522,9 +2522,9 @@ Pandoc supports definition lists, using the syntax of : Definition 2 - { some code, part of Definition 2 } + { some code, part of Definition 2 } - Third paragraph of definition 2. + Third paragraph of definition 2. Each term must fit on one line, which may optionally be followed by a blank line, and must be followed by one or more definitions. @@ -2543,7 +2543,7 @@ at the beginning of a paragraph or other block element: : Definition with lazy continuation. - Second paragraph of the definition. + Second paragraph of the definition. If you leave space before the definition (as in the example above), the text of the definition will be treated as a paragraph. In some @@ -2606,9 +2606,9 @@ cases" involving lists. Consider this source: + First + Second: - - Fee - - Fie - - Foe + - Fee + - Fie + - Foe + Third @@ -2631,7 +2631,7 @@ What if you want to put an indented code block after a list? - item one - item two - { my code block } + { my code block } Trouble! Here pandoc (like other Markdown implementations) will treat `{ my code block }` as the second paragraph of item two, and not as @@ -2646,7 +2646,7 @@ any format: - { my code block } + { my code block } You can use the same trick if you want two consecutive lists instead of one big list: @@ -2692,9 +2692,9 @@ Simple tables look like this: Right Left Center Default ------- ------ ---------- ------- - 12 12 12 12 - 123 123 123 123 - 1 1 1 1 + 12 12 12 12 + 123 123 123 123 + 1 1 1 1 Table: Demonstration of simple table syntax. @@ -2721,9 +2721,9 @@ The column headers may be omitted, provided a dashed line is used to end the table. For example: ------- ------ ---------- ------- - 12 12 12 12 - 123 123 123 123 - 1 1 1 1 + 12 12 12 12 + 123 123 123 123 + 1 1 1 1 ------- ------ ---------- ------- When headers are omitted, column alignments are determined on the basis @@ -2741,11 +2741,11 @@ not supported). Here is an example: Header Aligned Aligned Aligned ----------- ------- --------------- ------------------------- First row 12.0 Example of a row that - spans multiple lines. + spans multiple lines. Second row 5.0 Here's another one. Note - the blank line between - rows. + the blank line between + rows. ------------------------------------------------------------- Table: Here's the caption. It, too, may span @@ -2767,11 +2767,11 @@ Headers may be omitted in multiline tables as well as simple tables: ----------- ------- --------------- ------------------------- First row 12.0 Example of a row that - spans multiple lines. + spans multiple lines. Second row 5.0 Here's another one. Note - the blank line between - rows. + the blank line between + rows. ----------- ------- --------------- ------------------------- : Here's a multiline table without headers. @@ -3664,14 +3664,14 @@ Pandoc's Markdown allows footnotes, using the following syntax: [^longnote]: Here's one with multiple blocks. - Subsequent paragraphs are indented to show that they + Subsequent paragraphs are indented to show that they belong to the previous footnote. - { some.code } + { some.code } - The whole paragraph can be indented, or just the first - line. In this way, multi-paragraph footnotes work like - multi-paragraph list items. + The whole paragraph can be indented, or just the first + line. In this way, multi-paragraph footnotes work like + multi-paragraph list items. This paragraph won't be part of the note, because it isn't indented. @@ -3771,16 +3771,16 @@ YAML-encoded references, for example: id: WatsonCrick1953 author: - family: Watson - given: J. D. + given: J. D. - family: Crick - given: F. H. C. + given: F. H. C. issued: - date-parts: - - - 1953 - - 4 - - 25 + date-parts: + - - 1953 + - 4 + - 25 title: 'Molecular structure of nucleic acids: a structure for deoxyribose - nucleic acid' + nucleic acid' title-short: Molecular structure of nucleic acids container-title: Nature volume: 171 @@ -3981,7 +3981,7 @@ the document, for example: Author: John Doe Date: September 1, 2008 Comment: This is a sample mmd title block, with - a field spanning multiple lines. + a field spanning multiple lines. See the MultiMarkdown documentation for details. If `pandoc_title_block` or `yaml_metadata_block` is enabled, it will take precedence over @@ -4011,7 +4011,7 @@ and image references. This extension should not be confused with the This is a reference ![image][ref] with multimarkdown attributes. [ref]: http://path.to/image "Image title" width=20px height=30px - id=myId class="myClass1 myClass2" + id=myId class="myClass1 myClass2" #### Extension: `mmd_header_identifiers` #### @@ -4035,10 +4035,10 @@ in several respects: [^6]: To see why laziness is incompatible with relaxing the requirement of a blank line between items, consider the following example: - bar - : definition - foo - : definition + bar + : definition + foo + : definition Is this a single list item with two definitions of "bar," the first of which is lazily wrapped, or two list items? To remove the ambiguity @@ -4440,7 +4440,7 @@ with the `src` attribute. For example: diff --git a/README.md b/README.md index 20e1940fd..3f57b05aa 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ man](http://man7.org/linux/man-pages/man7/groff_man.7.html), [groff ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html), [Emacs Org mode](http://orgmode.org), [AsciiDoc](http://www.methods.co.nz/asciidoc/), [InDesign -ICML](https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf), +ICML](http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf), [TEI Simple](https://github.com/TEIC/TEI-Simple), [Muse](https://amusewiki.org/library/manual), [PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint) slide diff --git a/man/pandoc.1 b/man/pandoc.1 index 5c240cfc8..ee33b09ba 100644 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,5 +1,5 @@ .\"t -.TH PANDOC 1 "January 7, 2018" "pandoc 2.1.1" +.TH PANDOC 1 "January 18, 2018" "pandoc 2.1.1" .SH NAME pandoc - general markup converter .SH SYNOPSIS @@ -307,16 +307,28 @@ If this option is not specified, the default user data directory will be used. This is, in UNIX: .RS -.PP +.IP +.nf +\f[C] $HOME/.pandoc +\f[] +.fi .PP in Windows XP: -.PP -C:And SettingsData +.IP +.nf +\f[C] +C:\\Documents\ And\ Settings\\USERNAME\\Application\ Data\\pandoc +\f[] +.fi .PP and in Windows Vista or later: -.PP -C: +.IP +.nf +\f[C] +C:\\Users\\USERNAME\\AppData\\Roaming\\pandoc +\f[] +.fi .PP You can find the default user data directory on your system by looking at the output of \f[C]pandoc\ \-\-version\f[]. @@ -331,8 +343,12 @@ Generate a bash completion script. To enable bash completion with pandoc, add this to your \f[C]\&.bashrc\f[]: .RS -.PP -eval "$(pandoc \-\-bash\-completion)" +.IP +.nf +\f[C] +eval\ "$(pandoc\ \-\-bash\-completion)" +\f[] +.fi .RE .TP .B \f[C]\-\-verbose\f[] @@ -446,12 +462,20 @@ The name of the output format will be passed to the filter as the first argument. Hence, .RS -.PP -pandoc \-\-filter ./caps.py \-t latex +.IP +.nf +\f[C] +pandoc\ \-\-filter\ ./caps.py\ \-t\ latex +\f[] +.fi .PP is equivalent to -.PP -pandoc \-t json | ./caps.py latex | pandoc \-f json \-t latex +.IP +.nf +\f[C] +pandoc\ \-t\ json\ |\ ./caps.py\ latex\ |\ pandoc\ \-f\ json\ \-t\ latex +\f[] +.fi .PP The latter form may be useful for debugging filters. .PP @@ -493,12 +517,20 @@ creation. It is always loaded into the script\[aq]s lua environment. .PP The following is an example lua script for macro\-expansion: -.PP -function expand_hello_world(inline) if inline.c == -\[aq]{{helloworld}}\[aq] then return pandoc.Emph{ pandoc.Str "Hello, -World" } else return inline end end -.PP -return {{Str = expand_hello_world}} +.IP +.nf +\f[C] +function\ expand_hello_world(inline) +\ \ if\ inline.c\ ==\ \[aq]{{helloworld}}\[aq]\ then +\ \ \ \ return\ pandoc.Emph{\ pandoc.Str\ "Hello,\ World"\ } +\ \ else +\ \ \ \ return\ inline +\ \ end +end + +return\ {{Str\ =\ expand_hello_world}} +\f[] +.fi .RE .TP .B \f[C]\-M\f[] \f[I]KEY\f[][\f[C]=\f[]\f[I]VAL\f[]], \f[C]\-\-metadata=\f[]\f[I]KEY\f[][\f[C]:\f[]\f[I]VAL\f[]] @@ -978,7 +1010,6 @@ for a file \f[C]reference.docx\f[] in the user data directory (see \f[C]\-\-data\-dir\f[]). If this is not found either, sensible defaults will be used. .RS -.RE .PP To produce a custom \f[C]reference.docx\f[], first get a copy of the default \f[C]reference.docx\f[]: @@ -994,6 +1025,7 @@ Definition Term, Definition, Caption, Table Caption, Image Caption, Figure, Captioned Figure, TOC Heading; [character] Default Paragraph Font, Body Text Char, Verbatim Char, Footnote Reference, Hyperlink; [table] Table. +.RE .TP .B ODT For best results, the reference ODT should be a modified version of an @@ -1005,7 +1037,6 @@ for a file \f[C]reference.odt\f[] in the user data directory (see \f[C]\-\-data\-dir\f[]). If this is not found either, sensible defaults will be used. .RS -.RE .PP To produce a custom \f[C]reference.odt\f[], first get a copy of the default \f[C]reference.odt\f[]: @@ -1013,6 +1044,7 @@ default \f[C]reference.odt\f[]: Then open \f[C]custom\-reference.odt\f[] in LibreOffice, modify the styles as you wish, and save the file. .RE +.RE .TP .B \f[C]\-\-epub\-cover\-image=\f[]\f[I]FILE\f[] Use the specified image as the EPUB cover. @@ -1029,8 +1061,13 @@ Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements. For example: .RS -.PP -Creative Commons es\-AR +.IP +.nf +\f[C] +\ Creative\ Commons +\ es\-AR +\f[] +.fi .PP By default, pandoc will include the following metadata elements: \f[C]\f[] (from the document title), \f[C]\f[] @@ -1055,16 +1092,36 @@ being interpreted by the shell. To use the embedded fonts, you will need to add declarations like the following to your CSS (see \f[C]\-\-css\f[]): .RS -.PP -\@font\-face { font\-family: DejaVuSans; font\-style: normal; -font\-weight: normal; src:url("DejaVuSans\-Regular.ttf"); } \@font\-face -{ font\-family: DejaVuSans; font\-style: normal; font\-weight: bold; -src:url("DejaVuSans\-Bold.ttf"); } \@font\-face { font\-family: -DejaVuSans; font\-style: italic; font\-weight: normal; -src:url("DejaVuSans\-Oblique.ttf"); } \@font\-face { font\-family: -DejaVuSans; font\-style: italic; font\-weight: bold; -src:url("DejaVuSans\-BoldOblique.ttf"); } body { font\-family: -"DejaVuSans"; } +.IP +.nf +\f[C] +\@font\-face\ { +font\-family:\ DejaVuSans; +font\-style:\ normal; +font\-weight:\ normal; +src:url("DejaVuSans\-Regular.ttf"); +} +\@font\-face\ { +font\-family:\ DejaVuSans; +font\-style:\ normal; +font\-weight:\ bold; +src:url("DejaVuSans\-Bold.ttf"); +} +\@font\-face\ { +font\-family:\ DejaVuSans; +font\-style:\ italic; +font\-weight:\ normal; +src:url("DejaVuSans\-Oblique.ttf"); +} +\@font\-face\ { +font\-family:\ DejaVuSans; +font\-style:\ italic; +font\-weight:\ bold; +src:url("DejaVuSans\-BoldOblique.ttf"); +} +body\ {\ font\-family:\ "DejaVuSans";\ } +\f[] +.fi .RE .TP .B \f[C]\-\-epub\-chapter\-level=\f[]\f[I]NUMBER\f[] @@ -1249,10 +1306,14 @@ The resulting HTML can then be processed by gladTeX to produce images of the typeset formulas and an HTML file with links to these images. So, the procedure is: .RS -.PP -pandoc \-s \-\-gladtex input.md \-o myfile.htex gladtex \-d -myfile\-images myfile.htex # produces myfile.html and images in -myfile\-images +.IP +.nf +\f[C] +pandoc\ \-s\ \-\-gladtex\ input.md\ \-o\ myfile.htex +gladtex\ \-d\ myfile\-images\ myfile.htex +#\ produces\ myfile.html\ and\ images\ in\ myfile\-images +\f[] +.fi .RE .TP .B \f[C]\-\-mimetex\f[][\f[C]=\f[]\f[I]URL\f[]] @@ -1285,12 +1346,20 @@ Ignore command\-line arguments (for use in wrapper scripts). Regular pandoc options are not ignored. Thus, for example, .RS -.PP -pandoc \-\-ignore\-args \-o foo.html \-s foo.txt \-\- \-e latin1 +.IP +.nf +\f[C] +pandoc\ \-\-ignore\-args\ \-o\ foo.html\ \-s\ foo.txt\ \-\-\ \-e\ latin1 +\f[] +.fi .PP is equivalent to -.PP -pandoc \-o foo.html \-s +.IP +.nf +\f[C] +pandoc\ \-o\ foo.html\ \-s +\f[] +.fi .RE .SH TEMPLATES .PP @@ -1344,13 +1413,18 @@ source and destination filenames, as given on the command line. files, or empty if input is from stdin. You can use the following snippet in your template to distinguish them: .RS -.PP -\f[I]i\f[]\f[I]f\f[](\f[I]s\f[]\f[I]o\f[]\f[I]u\f[]\f[I]r\f[]\f[I]c\f[]\f[I]e\f[]\f[I]f\f[]\f[I]i\f[]\f[I]l\f[]\f[I]e\f[]) -\f[I]f\f[]\f[I]o\f[]\f[I]r\f[](\f[I]s\f[]\f[I]o\f[]\f[I]u\f[]\f[I]r\f[]\f[I]c\f[]\f[I]e\f[]\f[I]f\f[]\f[I]i\f[]\f[I]l\f[]\f[I]e\f[]) -\f[I]s\f[]\f[I]o\f[]\f[I]u\f[]\f[I]r\f[]\f[I]c\f[]\f[I]e\f[]\f[I]f\f[]\f[I]i\f[]\f[I]l\f[]\f[I]e\f[] -\f[I]e\f[]\f[I]n\f[]\f[I]d\f[]\f[I]f\f[]\f[I]o\f[]\f[I]r\f[] -\f[I]e\f[]\f[I]l\f[]\f[I]s\f[]\f[I]e\f[] (stdin) -\f[I]e\f[]\f[I]n\f[]\f[I]d\f[]\f[I]i\f[]\f[I]f\f[] +.IP +.nf +\f[C] +$if(sourcefile)$ +$for(sourcefile)$ +$sourcefile$ +$endfor$ +$else$ +(stdin) +$endif$ +\f[] +.fi .PP Similarly, \f[C]outputfile\f[] can be \f[C]\-\f[] if output goes to the terminal. @@ -1362,6 +1436,16 @@ Included in PDF metadata through LaTeX and ConTeXt. These can be set through a pandoc title block, which allows for multiple authors, or through a YAML metadata block: .RS +.IP +.nf +\f[C] +\-\-\- +author: +\-\ Aristotle +\-\ Peter\ Abelard +\&... +\f[] +.fi .RE .TP .B \f[C]subtitle\f[] @@ -2588,9 +2672,9 @@ For example, .IP .nf \f[C] -if\ (a\ >\ 3)\ { -\ \ moveShip(5\ *\ gravity,\ DOWN); -} +\ \ \ \ if\ (a\ >\ 3)\ { +\ \ \ \ \ \ moveShip(5\ *\ gravity,\ DOWN); +\ \ \ \ } \f[] .fi .PP @@ -2647,7 +2731,7 @@ using this syntax: ~~~~\ {#mycode\ .haskell\ .numberLines\ startFrom="100"} qsort\ []\ \ \ \ \ =\ [] qsort\ (x:xs)\ =\ qsort\ (filter\ (<\ x)\ xs)\ ++\ [x]\ ++ -\ \ \ \ \ \ \ qsort\ (filter\ (>=\ x)\ xs) +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ qsort\ (filter\ (>=\ x)\ xs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ \f[] .fi @@ -2809,12 +2893,12 @@ marker. \f[C] \ \ *\ First\ paragraph. -Continued. +\ \ \ \ Continued. \ \ *\ Second\ paragraph.\ With\ a\ code\ block,\ which\ must\ be\ indented -eight\ spaces: +\ \ \ \ eight\ spaces: -\ \ \ \ {\ code\ } +\ \ \ \ \ \ \ \ {\ code\ } \f[] .fi .PP @@ -2840,8 +2924,8 @@ character after the list marker of the containing list item. \f[C] *\ fruits \ \ +\ apples -\-\ macintosh -\-\ red\ delicious +\ \ \ \ \-\ macintosh +\ \ \ \ \-\ red\ delicious \ \ +\ pears \ \ +\ peaches *\ vegetables @@ -2863,7 +2947,7 @@ item. +\ Another\ one;\ this\ looks bad\ but\ is\ legal. -Second\ paragraph\ of\ second +\ \ \ \ Second\ paragraph\ of\ second list\ item. \f[] .fi @@ -2928,9 +3012,9 @@ numerals: \ 9)\ \ Ninth 10)\ \ Tenth 11)\ \ Eleventh -\ \ \ i.\ subone -\ \ ii.\ subtwo -\ iii.\ subthree +\ \ \ \ \ \ \ i.\ subone +\ \ \ \ \ \ ii.\ subtwo +\ \ \ \ \ iii.\ subthree \f[] .fi .PP @@ -2972,9 +3056,9 @@ Term\ 2\ with\ *inline\ markup* :\ \ \ Definition\ 2 -\ \ \ \ {\ some\ code,\ part\ of\ Definition\ 2\ } +\ \ \ \ \ \ \ \ {\ some\ code,\ part\ of\ Definition\ 2\ } -Third\ paragraph\ of\ definition\ 2. +\ \ \ \ Third\ paragraph\ of\ definition\ 2. \f[] .fi .PP @@ -2998,7 +3082,7 @@ Term\ 1 :\ \ \ Definition with\ lazy\ continuation. -Second\ paragraph\ of\ the\ definition. +\ \ \ \ Second\ paragraph\ of\ the\ definition. \f[] .fi .PP @@ -3076,9 +3160,9 @@ Consider this source: \f[C] +\ \ \ First +\ \ \ Second: -\-\ \ \ Fee -\-\ \ \ Fie -\-\ \ \ Foe +\ \ \ \ \-\ \ \ Fee +\ \ \ \ \-\ \ \ Fie +\ \ \ \ \-\ \ \ Foe +\ \ \ Third \f[] @@ -3107,7 +3191,7 @@ What if you want to put an indented code block after a list? \-\ \ \ item\ one \-\ \ \ item\ two -{\ my\ code\ block\ } +\ \ \ \ {\ my\ code\ block\ } \f[] .fi .PP @@ -3126,7 +3210,7 @@ any format: -{\ my\ code\ block\ } +\ \ \ \ {\ my\ code\ block\ } \f[] .fi .PP @@ -3181,9 +3265,9 @@ Simple tables look like this: \f[C] \ \ Right\ \ \ \ \ Left\ \ \ \ \ Center\ \ \ \ \ Default \-\-\-\-\-\-\-\ \ \ \ \ \-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\ \ \ \-\-\-\-\-\-\- -\ 12\ \ \ \ \ 12\ \ \ \ \ \ \ \ 12\ \ \ \ \ \ \ \ \ \ \ \ 12 -123\ \ \ \ \ 123\ \ \ \ \ \ \ 123\ \ \ \ \ \ \ \ \ \ 123 -\ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ 1 +\ \ \ \ \ 12\ \ \ \ \ 12\ \ \ \ \ \ \ \ 12\ \ \ \ \ \ \ \ \ \ \ \ 12 +\ \ \ \ 123\ \ \ \ \ 123\ \ \ \ \ \ \ 123\ \ \ \ \ \ \ \ \ \ 123 +\ \ \ \ \ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ 1 Table:\ \ Demonstration\ of\ simple\ table\ syntax. \f[] @@ -3215,9 +3299,9 @@ For example: .nf \f[C] \-\-\-\-\-\-\-\ \ \ \ \ \-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\ \ \ \-\-\-\-\-\-\- -\ 12\ \ \ \ \ 12\ \ \ \ \ \ \ \ 12\ \ \ \ \ \ \ \ \ \ \ \ \ 12 -123\ \ \ \ \ 123\ \ \ \ \ \ \ 123\ \ \ \ \ \ \ \ \ \ \ 123 -\ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ \ 1 +\ \ \ \ \ 12\ \ \ \ \ 12\ \ \ \ \ \ \ \ 12\ \ \ \ \ \ \ \ \ \ \ \ \ 12 +\ \ \ \ 123\ \ \ \ \ 123\ \ \ \ \ \ \ 123\ \ \ \ \ \ \ \ \ \ \ 123 +\ \ \ \ \ \ 1\ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ 1\ \ \ \ \ \ \ \ \ \ \ \ \ \ 1 \-\-\-\-\-\-\-\ \ \ \ \ \-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\ \ \ \-\-\-\-\-\-\- \f[] .fi @@ -3240,11 +3324,11 @@ Here is an example: \ \ Header\ \ \ \ Aligned\ \ \ \ \ \ \ \ \ Aligned\ Aligned \-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \ \ \ First\ \ \ \ row\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 12.0\ Example\ of\ a\ row\ that -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ spans\ multiple\ lines. +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ spans\ multiple\ lines. \ \ Second\ \ \ \ row\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 5.0\ Here\[aq]s\ another\ one.\ Note -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ blank\ line\ between -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ rows. +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ blank\ line\ between +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ rows. \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Table:\ Here\[aq]s\ the\ caption.\ It,\ too,\ may\ span @@ -3273,11 +3357,11 @@ Headers may be omitted in multiline tables as well as simple tables: \f[C] \-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \ \ \ First\ \ \ \ row\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 12.0\ Example\ of\ a\ row\ that -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ spans\ multiple\ lines. +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ spans\ multiple\ lines. \ \ Second\ \ \ \ row\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 5.0\ Here\[aq]s\ another\ one.\ Note -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ blank\ line\ between -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ rows. +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ blank\ line\ between +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ rows. \-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- :\ Here\[aq]s\ a\ multiline\ table\ without\ headers. @@ -4431,14 +4515,14 @@ Here\ is\ a\ footnote\ reference,[^1]\ and\ another.[^longnote] [^longnote]:\ Here\[aq]s\ one\ with\ multiple\ blocks. -Subsequent\ paragraphs\ are\ indented\ to\ show\ that\ they +\ \ \ \ Subsequent\ paragraphs\ are\ indented\ to\ show\ that\ they belong\ to\ the\ previous\ footnote. -\ \ \ \ {\ some.code\ } +\ \ \ \ \ \ \ \ {\ some.code\ } -The\ whole\ paragraph\ can\ be\ indented,\ or\ just\ the\ first -line.\ \ In\ this\ way,\ multi\-paragraph\ footnotes\ work\ like -multi\-paragraph\ list\ items. +\ \ \ \ The\ whole\ paragraph\ can\ be\ indented,\ or\ just\ the\ first +\ \ \ \ line.\ \ In\ this\ way,\ multi\-paragraph\ footnotes\ work\ like +\ \ \ \ multi\-paragraph\ list\ items. This\ paragraph\ won\[aq]t\ be\ part\ of\ the\ note,\ because\ it isn\[aq]t\ indented. @@ -4617,16 +4701,16 @@ references: \ \ id:\ WatsonCrick1953 \ \ author: \ \ \-\ family:\ Watson -given:\ J.\ D. +\ \ \ \ given:\ J.\ D. \ \ \-\ family:\ Crick -given:\ F.\ H.\ C. +\ \ \ \ given:\ F.\ H.\ C. \ \ issued: -date\-parts: -\-\ \-\ 1953 -\ \ \-\ 4 -\ \ \-\ 25 +\ \ \ \ date\-parts: +\ \ \ \ \-\ \-\ 1953 +\ \ \ \ \ \ \-\ 4 +\ \ \ \ \ \ \-\ 25 \ \ title:\ \[aq]Molecular\ structure\ of\ nucleic\ acids:\ a\ structure\ for\ deoxyribose -nucleic\ acid\[aq] +\ \ \ \ nucleic\ acid\[aq] \ \ title\-short:\ Molecular\ structure\ of\ nucleic\ acids \ \ container\-title:\ Nature \ \ volume:\ 171 @@ -4856,7 +4940,7 @@ Title:\ \ \ My\ title Author:\ \ John\ Doe Date:\ \ \ \ September\ 1,\ 2008 Comment:\ This\ is\ a\ sample\ mmd\ title\ block,\ with -\ \ \ \ \ a\ field\ spanning\ multiple\ lines. +\ \ \ \ \ \ \ \ \ a\ field\ spanning\ multiple\ lines. \f[] .fi .PP @@ -4892,7 +4976,7 @@ extension. This\ is\ a\ reference\ ![image][ref]\ with\ multimarkdown\ attributes. [ref]:\ http://path.to/image\ "Image\ title"\ width=20px\ height=30px -\ \ \ id=myId\ class="myClass1\ myClass2" +\ \ \ \ \ \ \ id=myId\ class="myClass1\ myClass2" \f[] .fi .SS Extension: \f[C]mmd_header_identifiers\f[] @@ -5425,7 +5509,7 @@ For example: \f[C] \ \ +\ \ \ \ \ \ \ \ \ \ data\-external="1"\ type="audio/mpeg"> \ \ \f[] -- cgit v1.2.3