diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 1850 |
1 files changed, 1194 insertions, 656 deletions
@@ -1,21 +1,30 @@ % Pandoc User's Guide % John MacFarlane -% March 20, 2010 +% January 29, 2011 + +Synopsis +======== + +pandoc [*options*] [*input-file*]... + +Description +=========== Pandoc is a [Haskell] library for converting from one markup format to another, and a command-line tool that uses this library. It can read -[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX]; and -it can write plain text, [markdown], [reStructuredText], [HTML], [LaTeX], -[ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT], [GNU Texinfo], -[MediaWiki markup], [EPUB], [groff man] pages, and [Slidy] or [S5] -HTML slide shows. +[markdown] and (subsets of) [Textile], [reStructuredText], [HTML], +and [LaTeX]; and it can write plain text, [markdown], [reStructuredText], +[HTML], [LaTeX], [ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT], +[GNU Texinfo], [MediaWiki markup], [EPUB], [Textile], [groff man] pages, +[Emacs Org-Mode], and [Slidy] or [S5] HTML slide shows. Pandoc's enhanced version of markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, delimited code blocks, superscript, subscript, strikeout, title blocks, automatic tables of -contents, embedded LaTeX math, and markdown inside HTML block elements. -(These enhancements can be disabled if a drop-in replacement for -`Markdown.pl` is desired.) +contents, embedded LaTeX math, citations, and markdown inside HTML block +elements. (These enhancements, described below under +[Pandoc's markdown](#pandocs-markdown), can be disabled using the `--strict` +option.) In contrast to most existing tools for converting markdown to HTML, which use regex substitutions, Pandoc has a modular design: it consists of a @@ -24,60 +33,25 @@ representation of the document, and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer. -[markdown]: http://daringfireball.net/projects/markdown/ -[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html -[S5]: http://meyerweb.com/eric/tools/s5/ -[Slidy]: http://www.w3.org/Talks/Tools/Slidy/ -[HTML]: http://www.w3.org/TR/html40/ -[LaTeX]: http://www.latex-project.org/ -[ConTeXt]: http://www.pragma-ade.nl/ -[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format -[DocBook XML]: http://www.docbook.org/ -[OpenDocument XML]: http://opendocument.xml.org/ -[ODT]: http://en.wikipedia.org/wiki/OpenDocument -[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting -[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html -[Haskell]: http://www.haskell.org/ -[GNU Texinfo]: http://www.gnu.org/software/texinfo/ -[EPUB]: http://www.idpf.org/ - -© 2006-2010 John MacFarlane (jgm at berkeley dot edu). Released under the -[GPL], version 2 or greater. This software carries no warranty of -any kind. (See COPYRIGHT for full copyright and warranty notices.) -Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang, -Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public, -rodja.trappe, Bradley Kuhn, thsutton, Justin Bogner. - -[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License" - Using Pandoc -============ - -If you run `pandoc` without arguments, it will accept input from -stdin. If you run it with file names as arguments, it will take input -from those files. By default, `pandoc` writes its output to stdout.[^1] -If you want to write to a file, use the `-o` option: - - pandoc -o hello.html hello.txt - -[^1]: The exceptions are for `odt` and `epub`. Since these are - a binary output formats, an output file must be specified explicitly. - -Note that you can specify multiple input files on the command line. -`pandoc` will concatenate them all (with blank lines between them) -before parsing: +------------ - pandoc -s ch1.txt ch2.txt refs.txt > book.html +If no *input-file* is specified, input is read from *stdin*. +Otherwise, the *input-files* are concatenated (with a blank +line between each) and used as input. Output goes to *stdout* by +default (though output to *stdout* is disabled for the `odt` and +`epub` output formats). For output to a file, use the `-o` option: -(The `-s` option here tells `pandoc` to produce a standalone HTML file, -with a proper header, rather than a fragment. For more details on this -and many other command-line options, see below.) + pandoc -o output.html input.txt -Instead of a filename, you can specify an absolute URI. In this -case pandoc will attempt to download the content via HTTP: +Instead of a file, an absolute URI may be given. In this case +pandoc will fetch the content using HTTP: pandoc -f html -t markdown http://www.fsf.org +If multiple input files are given, `pandoc` will concatenate them all (with +blank lines between them) before parsing. + The format of the input and output can be specified explicitly using command-line options. The input format can be specified using the `-r/--read` or `-f/--from` options, the output format using the @@ -90,46 +64,29 @@ To convert `hello.html` from html to markdown: pandoc -f html -t markdown hello.html -Supported output formats include `markdown`, `latex`, `context` -(ConTeXt), `html`, `rtf` (rich text format), `rst` -(reStructuredText), `docbook` (DocBook XML), `opendocument` -(OpenDocument XML), `odt` (OpenOffice text document), `texinfo`, (GNU -Texinfo), `mediawiki` (MediaWiki markup), `epub` (EPUB ebook), -`man` (groff man), `slidy` (slidy HTML and javascript slide show), or -`s5` (S5 HTML and javascript slide show). - -Supported input formats include `markdown`, `html`, `latex`, and `rst`. -Note that the `rst` reader only parses a subset of reStructuredText -syntax. For example, it doesn't handle tables, option lists, or -footnotes. But for simple documents it should be adequate. The `latex` -and `html` readers are also limited in what they can do. - -If you don't specify a reader or writer explicitly, `pandoc` will -try to determine the input and output format from the extensions of +Supported output formats are listed below under the `-t/--to` option. +Supported input formats are listed below under the `-f/--from` option. Note +that the `rst`, `textile`, `latex`, and `html` readers are not complete; +there are some constructs that they do not parse. + +If the input or output format is not specified explicitly, `pandoc` +will attempt to guess it from the extensions of the input and output filenames. Thus, for example, pandoc -o hello.tex hello.txt will convert `hello.txt` from markdown to LaTeX. If no output file -is specified (so that output goes to stdout), or if the output file's +is specified (so that output goes to *stdout*), or if the output file's extension is unknown, the output format will default to HTML. -If no input file is specified (so that input comes from stdin), or +If no input file is specified (so that input comes from *stdin*), or if the input files' extensions are unknown, the input format will be assumed to be markdown unless explicitly specified. -Character encodings -------------------- - -All input is assumed to be in the UTF-8 encoding, and all output -is in UTF-8. If your local character encoding is not UTF-8 and you use -accented or foreign characters, you should pipe the input and output -through [`iconv`]. For example, +Pandoc uses the UTF-8 character encoding for both input and output. +If your local character encoding is not UTF-8, you +should pipe input and output through `iconv`: - iconv -t utf-8 source.txt | pandoc | iconv -f utf-8 > output.html - -will convert `source.txt` from the local encoding to UTF-8, then -convert it to HTML, then convert back to the local encoding, -putting the output in `output.html`. + iconv -t utf-8 input.txt | pandoc | iconv -f utf-8 Wrappers ======== @@ -151,7 +108,7 @@ name can be specified explicitly using the `-o` option: markdown2pdf -o book.pdf chap1 chap2 -If no input file is specified, input will be taken from stdin. +If no input file is specified, input will be taken from *stdin*. All of `pandoc`'s options will work with `markdown2pdf` as well. `markdown2pdf` assumes that `pdflatex` is in the path. It also @@ -179,140 +136,246 @@ problems with its simulation of symbolic links. [TeX Live]: http://www.tug.org/texlive/ [MacTeX]: http://www.tug.org/mactex/ -Command-line options -==================== +Options +======= + +`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT* +: Specify input format. *FORMAT* can be `native` (native Haskell), + `json` (JSON version of native AST), `markdown` (markdown), + `textile` (Textile), `rst` (reStructuredText), `html` (HTML), + or `latex` (LaTeX). If `+lhs` is appended to `markdown`, `rst`, + or `latex`, the input will be treated as literate Haskell source: + see [Literate Haskell support](#literate-haskell-support), + below. + +`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT* +: Specify output format. *FORMAT* can be `native` (native Haskell), + `json` (JSON version of native AST), `plain` (plain text), + `markdown` (markdown), `rst` (reStructuredText), + `html` (HTML), `latex` (LaTeX), `context` (ConTeXt), `man` (groff man), + `mediawiki` (MediaWiki markup), `textile` (Textile), `org` (Emacs + Org-Mode), `texinfo` (GNU Texinfo), `docbook` (DocBook XML), + `opendocument` (OpenDocument XML), `odt` (OpenOffice text document), + `epub` (EPUB book), `slidy` (Slidy HTML and javascript slide show), + `s5` (S5 HTML and javascript slide show), or `rtf` (rich text + format). Note that `odt` and `epub` output will not be directed to + *stdout*; an output filename must be specified using the `-o/--output` + option. If `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, + the output will be rendered as literate Haskell source: + see [Literate Haskell support](#literate-haskell-support), + below. + +`-s`, `--standalone` +: Produce output with an appropriate header and footer (e.g. a + standalone HTML, LaTeX, or RTF file, not a fragment). + +`-o` *FILE*, `--output=`*FILE* +: Write output to *FILE* instead of *stdout*. If *FILE* is + `-`, output will go to *stdout*. (Exception: if the output + format is `odt` or `epub`, output to stdout is disabled.) + +`-p`, `--preserve-tabs` +: Preserve tabs instead of converting them to spaces (the default). + +`--tab-stop=`*NUMBER* +: Specify the number of spaces per tab (default is 4). -Various command-line options can be used to customize the output. -For further documentation, see the `pandoc(1)` man page. +`--strict` +: Use strict markdown syntax, with no pandoc extensions or variants. + When the input format is HTML, this means that constructs that have no + equivalents in standard markdown (e.g. definition lists or strikeout + text) will be parsed as raw HTML. -`-f`, `--from`, `-r`, or `--read` *format* -: specifies the input format (the format Pandoc will be converting - *from*). *format* can be `native`, `markdown`, `rst`, `html`, or - `latex`. (`+lhs` can be appended to indicate that the input should - be treated as literate Haskell source. See - [Literate Haskell support](#literate-haskell-support), below.) +`--normalize` +: Normalize the document after reading: merge adjacent + `Str` or `Emph` elements, for example, and remove repeated `Space`s. -`-t`, `--to`, `-w`, or `--write` *format* -: specifies the output format -- the format Pandoc will - be converting *to*. *format* can be `native`, `html`, `slidy`, `s5`, - `docbook`, `opendocument`, `latex`, `context`, `markdown`, `man`, - `plain`, `rst`, and `rtf`. (`+lhs` can be appended to indicate that - the output should be treated as literate Haskell source. See - [Literate Haskell support](#literate-haskell-support), below.) +`--reference-links` +: Use reference-style links, rather than inline links, in writing markdown + or reStructuredText. By default inline links are used. + +`-R`, `--parse-raw` +: Parse untranslatable HTML codes and LaTeX environments as raw HTML + or LaTeX, instead of ignoring them. Affects only HTML and LaTeX + input. Raw HTML can be printed in markdown, reStructuredText, HTML, Slidy, + and S5 output; raw LaTeX can be printed in markdown, reStructuredText, + LaTeX, and ConTeXt output. The default is for the readers to omit + untranslatable HTML codes and LaTeX environments. (The LaTeX reader + does pass through untranslatable LaTeX *commands*, even if `-R` is not + specified.) + +`-S`, `--smart` +: Produce typographically correct output, converting straight quotes + to curly quotes, `---` and `--` to dashes, ande `...` to ellipses. + Nonbreaking spaces are inserted after certain abbreviations, such + as "Mr." (Note: This option is significant only when the input format is + `markdown` or `textile`. It is selected automatically when the input + format is `textile` or the output format is `latex` or `context`.) + +`-5`, `--html5` +: Produce HTML5 instead of HTML4. This option has no effect for writers + other than `html`. + +`-m` *URL*, `--latexmathml=`*URL* +: Use the [LaTeXMathML] script to display embedded TeX math in HTML output. + To insert a link to a local copy of the `LaTeXMathML.js` script, + provide a *URL*. If no *URL* is provided, the contents of the + script will be inserted directly into the HTML header, preserving + portability at the price of efficiency. If you plan to use math on + several pages, it is much better to link to a copy of the script, + so it can be cached. -`-s` or `--standalone` -: indicates that a standalone document is to be produced (with - appropriate headers and footers), rather than a fragment. +`--mathml` +: Convert TeX math to MathML. In standalone mode, a small javascript + will be inserted that allows the MathML to be viewed on some browsers. -`-o` or `--output` *filename* -: sends output to *filename*. If this option is not specified, - or if its argument is `-`, output will be sent to stdout. - (Exception: if the output format is `odt` or `epub`, output to - stdout is disabled.) +`--jsmath=`*URL* +: Use [jsMath] to display embedded TeX math in HTML output. + The *URL* should point to the jsMath load script (e.g. + `jsMath/easy/load.js`); if provided, it will be linked to in + the header of standalone HTML documents. -`-p` or `--preserve-tabs` -: causes tabs in the source text to be preserved, rather than converted - to spaces (the default). +`--mathjax=`*URL* +: Use [MathJax] to display embedded TeX math in HTML output. + The *URL* should point to the `MathJax.js` load script. -`--tab-stop` *tabstop* -: sets the number of spaces per tab to *tabstop* (defaults to 4). +`--gladtex` +: Enclose TeX math in `<eq>` tags in HTML output. These can then + be processed by [gladTeX] to produce links to images of the typeset + formulas. -`--strict` -: specifies that strict markdown syntax is to be used, without - pandoc's usual extensions and variants (described below). When the - input format is HTML, this means that constructs that have no - equivalents in standard markdown (e.g. definition lists or strikeout - text) will be parsed as raw HTML. +`--mimetex=`*URL* +: Render TeX math using the [mimeTeX] CGI script. If *URL* is not + specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`. -`--reference-links` -: causes reference-style links to be used in markdown - and reStructuredText output. By default inline links are used. - -`-R` or `--parse-raw` -: causes the HTML and LaTeX readers to parse HTML codes and LaTeX - environments that it can't translate as raw HTML or LaTeX. Raw HTML can - be printed in markdown, reStructuredText, HTML, Slidy, and S5 - output; raw LaTeX can be printed in markdown, reStructuredText, - LaTeX, and ConTeXt output. The default is for the readers to omit - untranslatable HTML codes and LaTeX environments. (The LaTeX reader - does pass through untranslatable LaTeX *commands*, even if `-R` is - not specified.) +`--webtex=`*URL* +: Render TeX formulas using an external script that converts TeX + formulas to images. The formula will be concatenated with the URL + provided. If *URL* is not specified, the Google Chart API will be used. + +`-i`, `--incremental` +: Make list items in Slidy or S5 display incrementally (one by one). + The default is for lists to be displayed all at once. + +`--offline` +: Include all the CSS and javascript needed for a Slidy or S5 slide + show in the output, so that the slide show will work even when no + internet connection is available. + +`--xetex` +: Create LaTeX outut suitable for processing by XeTeX. + +`--chapters` +: Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook + output. + +`-N`, `--number-sections` +: Number section headings in LaTeX, ConTeXt, or HTML output. + By default, sections are not numbered. + +`--listings` +: Use listings package for LaTeX code blocks + +`--section-divs` +: Wrap sections in `<div>` tags (or `<section>` tags in HTML5), + and attach identifiers to the enclosing `<div>` (or `<section>`) + rather than the header itself. + See [Section identifiers](#header-identifiers-in-html), below. + +`--no-wrap` +: Disable text wrapping in output. By default, text is wrapped + appropriately for the output format. + +`--columns`=*NUMBER* +: Specify length of lines in characters (for text wrapping). + +`--email-obfuscation=`*none|javascript|references* +: Specify a method for obfuscating `mailto:` links in HTML documents. + *none* leaves `mailto:` links as they are. *javascript* obfuscates + them using javascript. *references* obfuscates them by printing their + letters as decimal or hexadecimal character references. + If `--strict` is specified, *references* is used regardless of the + presence of this option. + +`--id-prefix`=*STRING* +: Specify a prefix to be added to all automatically generated identifiers + in HTML output. This is useful for preventing duplicate identifiers + when generating fragments to be included in other pages. -`-C` or `--custom-header` *filename* -: can be used to specify a custom document header. Implies `--standalone`. - *Note: this option is deprecated. Use of `--template` is preferred.* +`--indented-code-classes=`*CLASSES* +: Specify classes to use for indented code blocks--for example, + `perl,numberLines` or `haskell`. Multiple classes may be separated + by spaces or commas. -`--toc` or `--table-of-contents` -: includes an automatically generated table of contents (or, in the - case of `latex`, `context`, and `rst`, an instruction to create - one) in the output document. This option has no effect with `man`, - `docbook`, `slidy`, or `s5` output formats. +`--toc`, `--table-of-contents` +: Include an automatically generated table of contents (or, in + the case of `latex`, `context`, and `rst`, an instruction to create + one) in the output document. This option has no effect on `man`, + `docbook`, `slidy`, or `s5` output. -`--base-header-level` *level* -: specifies the base level for headers (defaults to 1). +`--base-header-level=`*NUMBER* +: Specify the base level for headers (defaults to 1). -`--template=`*file* -: uses *file* as a custom template for the generated document. Implies - `-s`. See [Templates](#templates) below for a description +`--template=`*FILE* +: Use *FILE* as a custom template for the generated document. Implies + `--standalone`. See [Templates](#templates) below for a description of template syntax. If this option is not used, a default template appropriate for the output format will be used. See also `-D/--print-default-template`. -`-V` *key=val*, `--variable=`*key:val* -: sets the template variable *key* to the value *val* when rendering the +`-V` *KEY=VAL*, `--variable=`*KEY:VAL* +: Set the template variable *KEY* to the value *VAL* when rendering the document in standalone mode. This is only useful when the `--template` option is used to specify a custom template, since pandoc automatically sets the variables used in the default templates. -`-c` or `--css` *filename* -: allows the user to specify a custom stylesheet that will be linked to - in HTML, Slidy, and S5 output. This option can be used repeatedly - to include multiple stylesheets. They will be included in the order - specified. Implies `--standalone`. +`-c` *URL*, `--css=`*URL* +: Link to a CSS style sheet. -`-H` or `--include-in-header` *filename* -: includes the contents of *filename* (verbatim) at the end of the - document header. This can be used, for example, to include special +`-H` *FILE*, `--include-in-header=`*FILE* +: Include contents of *FILE*, verbatim, at the end of the header. + This can be used, for example, to include special CSS or javascript in HTML documents. This option can be used repeatedly to include multiple files in the header. They will be included in the order specified. Implies `--standalone`. -`-B` or `--include-before-body` *filename* -: includes the contents of *filename* (verbatim) at the beginning of - the document body (e.g. after the `<body>` tag in HTML, or the +`-B` *FILE*, `--include-before-body=`*FILE* +: Include contents of *FILE*, verbatim, at the beginning of the + document body (e.g. after the `<body>` tag in HTML, or the `\begin{document}` command in LaTeX). This can be used to include navigation bars or banners in HTML documents. This option can be used repeatedly to include multiple files. They will be included in the order specified. Implies `--standalone`. -`-A` or `--include-after-body` *filename* -: includes the contents of *filename* (verbatim) at the end of - the document body (before the `</body>` tag in HTML, or the +`-A` *FILE*, `--include-after-body=`*FILE* +: Include contents of *FILE*, verbatim, at the end of the document + body (before the `</body>` tag in HTML, or the `\end{document}` command in LaTeX). This option can be be used repeatedly to include multiple files. They will be included in the order specified. Implies `--standalone`. -`--reference-odt` *filename* -: uses the specified file as a style reference in producing an ODT. +`--reference-odt=`*FILE* +: Use the specified file as a style reference in producing an 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`, below). If it is not found there, sensible defaults - will be used. + `--data-dir`). If this is not found either, sensible defaults will be + used. -`--epub-stylesheet` *filename* -: uses the specified CSS file to style the EPUB. If no stylesheet +`--epub-stylesheet=`*FILE* +: Use the specified CSS file to style the EPUB. If no stylesheet is specified, pandoc will look for a file `epub.css` in the user data directory (see `--data-dir`, below). If it is not found there, sensible defaults will be used. -`--epub-metadata` *filename* -: looks in the specified XML file for metadata for the EPUB. - The file should contain a series of [Dublin Core elements], - for example: +`--epub-metadata=`*FILE* +: Look in the specified XML file for metadata for the EPUB. + The file should contain a series of Dublin Core elements, + as documented at <http://dublincore.org/documents/dces/>. + For example: <dc:rights>Creative Commons</dc:rights> <dc:language>es-AR</dc:language> @@ -323,123 +386,45 @@ For further documentation, see the `pandoc(1)` man page. `<dc:identifier id="BookId">` (a randomly generated UUID). Any of these may be overridden by elements in the metadata file. -`-D` or `--print-default-template` *format* -: prints the default template for an output *format*. (See `-t` - for a list of possible *format*s.) - -`-T` or `--title-prefix` *string* -: includes *string* as a prefix at the beginning of the title that - appears in the HTML header (but not in the title as it appears at - the beginning of the HTML body). (See below on - [Title Blocks](#title-blocks).) Implies `--standalone`. - -`-S` or `--smart` -: causes `pandoc` to produce typographically correct output, along the - lines of John Gruber's [Smartypants]. Straight quotes are converted - to curly quotes, `---` to dashes, and `...` to ellipses. Nonbreaking - spaces are inserted after certain abbreviations, such as "Mr." - (Note: This option is only significant when the input format is - `markdown`. It is selected automatically when the output format is - `latex` or `context`.) - -`-m`*[url]* or `--latexmathml`*[=url]* -: causes `pandoc` to use the [LaTeXMathML] script to display - TeX math in HTML, Slidy, or S5. If a local copy of `LaTeXMathML.js` - is available on the webserver where the page will be viewed, provide - a *url* and a link will be inserted in the generated HTML. If - no *url* is provided, the contents of the script will be inserted - directly; this provides portability at the price of efficiency. If - you plan to use math on several pages, it is much better to link to - a copy of `LaTeXMathML.js`, which can be cached. (See `--jsmath`, - `--gladtex`, `--webtex`, and `--mimetex` for alternative ways of - dealing with math in HTML.) - -`--mathml` -: causes `pandoc` to convert all TeX math to MathML. - In standalone mode, a small javascript will be inserted that allows - the MathML to be viewed on some browsers. - -`--jsmath`*=[url]* -: causes `pandoc` to use the [jsMath] script to display - TeX math in HTML, Slidy, or S5. The *url* should point to the jsMath - load script (e.g. `jsMath/easy/load.js`). If it is provided, a link - to it will be included in the header of standalone HTML documents. - (See `--latexmathml`, `--mimetex`, `--webtex`, and `--gladtex` for - alternative ways of dealing with math in HTML.) - -`--gladtex`*[=url]* -: causes TeX formulas to be enclosed in `<eq>` tags in HTML, Slidy, or - S5 output. This output can then be processed by [gladTeX] to produce - links to images with the typeset formulas. (See `--latexmathml`, - `--jsmath`, `--webtex`, and `--mimetex` for alternative ways of - dealing with math in HTML.) - -`--mimetex`*[=url]* -: causes TeX formulas to be replaced by `<img>` tags linking to the - [mimeTeX] CGI script, which will produce images with the typeset - formulas. (See `--latexmathml`, `--jsmath`, `--webtex`, and - `--gladtex` for alternative ways of dealing with math in HTML.) - -`--webtex`*[=url]* -: causes TeX formulas to be replaced by `<img>` tags linking to an - external service that converts TeX formulas to images. The formula - will be concatenated with the URL provided. If no URL - is specified, the Google Chart API is used. (See `--latexmathml`, - `--jsmath`, `--mimetex`, and `--gladtex` for alternative ways of - dealing with math in HTML.) - -`-i` or `--incremental` -: causes all lists in Slidy or S5 output to be displayed incrementally by - default (one item at a time). The normal default is for lists to be - displayed all at once. - -`--offline` -: causes all the CSS and javascript needed for a Slidy or S5 slide show - to be included in the output, so that the slide show will work even - when no internet connection is available. - -`--xetex` -: creates LaTeX outut suitable for processing by XeTeX. +`-D` *FORMAT*, `--print-default-template=`*FORMAT* +: Print the default template for an output *FORMAT*. (See `-t` + for a list of possible *FORMAT*s.) + +`-T` *STRING*, `--title-prefix=`*STRING* +: Specify *STRING* as a prefix at the beginning of the title + that appears in the HTML header (but not in the title as it + appears at the beginning of the HTML body). Implies + `--standalone`. + +`--bibliography=`*FILE* +: Specify bibliography database to be used in resolving + citations. The database type will be determined from the + extension of *FILE*, which may be `.mods` (MODS format), + `.bib` (BibTeX format), `.bbx` (BibLaTeX format), + `.ris` (RIS format), `.enl` (EndNote format), + `.xml` (EndNote XML format), `.wos` (ISI format), + `.medline` (MEDLINE format), `.copac` (Copac format), + or `.json` (citeproc JSON). If you want to use multiple + bibliographies, just use this option repeatedly. + +`--csl=`*FILE* +: Specify [CSL] style to be used in formatting citations and + the bibliography. If *FILE* is not found, pandoc will look + for it in + + $HOME/.csl -`-N` or `--number-sections` -: causes sections to be numbered in LaTeX, ConTeXt, or HTML output. - By default, sections are not numbered. - -`--section-divs` -: causes sections to be wrapped in `<div>` tags. In this case, - [section identifiers](#header-identifiers-in-html) - are attached to the enclosing `<div>` rather than the header itself. - -`--no-wrap` -: disables text-wrapping in output. By default, text is wrapped - appropriately for the output format. + in unix and -`--sanitize-html` -: sanitizes HTML (in markdown or HTML input) using a whitelist. - Unsafe tags are replaced by HTML comments; unsafe attributes - are omitted. URIs in links and images are also checked against a - whitelist of URI schemes. + C:\Documents And Settings\USERNAME\Application Data\csl -`--email-obfuscation`*=none|javascript|references* -: specifies a method for obfuscating `mailto:` links in HTML documents. - *none* leaves `mailto:` links as they are. *javascript* obfuscates - them using javascript. *references* obfuscates them by printing their - letters as decimal or hexadecimal character references. If `--strict` - is specified, *references* is used regardless of the presence - of this option. + in Windows. If the `--csl` option is not specified, pandoc + will use a default style: either `default.csl` in the + user data directory (see `--data-dir`), or, if that is + not present, the Chicago author-date style. -`--id-prefix`*=string* -: specifies a prefix to be added to all automatically generated identifiers - in HTML output. This is useful for preventing duplicate identifiers - when generating fragments to be included in other pages. - -`--indented-code-classes`*=classes* -: specifies classes to use for indented code blocks--for example, - `perl,numberLines` or `haskell`. Multiple classes may be separated - by spaces or commas. - -`--data-dir`*=directory* -: specifies the user data directory to search for pandoc data files. +`--data-dir=`*DIRECTORY* +: Specify the user data directory to search for pandoc data files. If this option is not specified, the default user data directory will be used: @@ -454,24 +439,17 @@ For further documentation, see the `pandoc(1)` man page. normal defaults. `--dump-args` -: is intended to make it easier to create wrapper scripts that use - Pandoc. It causes Pandoc to dump information about the arguments - with which it was called to stdout, then exit. The first line - printed is the name of the output file specified using the `-o` - or `--output` option, or `-` if output would go to stdout. The - remaining lines, if any, list command-line arguments. These will - include the names of input files and any special options passed - after ` -- ` on the command line. So, for example, - - pandoc --dump-args -o foo.html -s foo.txt \ - appendix.txt -- -e latin1 - - will cause the following to be printed to stdout: - - foo.html foo.txt appendix.txt -e latin1 +: Print information about command-line arguments to *stdout*, then exit. + This option is intended primarily for use in wrapper scripts. + The first line of output contains the name of the output file specified + with the `-o` option, or `-` (for *stdout*) if no output file was + specified. The remaining lines contain the command-line arguments, + one per line, in the order they appear. These do not include regular + Pandoc options and their arguments, but do include any options appearing + after a `--` separator at the end of the line. `--ignore-args` -: causes Pandoc to ignore all command-line arguments. +: 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 @@ -480,18 +458,18 @@ For further documentation, see the `pandoc(1)` man page. pandoc -o foo.html -s -`-v` or `--version` -: prints the version number to STDERR. +`-v`, `--version` +: Print version. -`-h` or `--help` -: prints a usage message to STDERR. +`-h`, `--help` +: Show usage message. -[Smartypants]: http://daringfireball.net/projects/smartypants/ [LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/ [jsMath]: http://www.math.union.edu/~dpvc/jsmath/ +[MathJax]: http://www.mathjax.org/ [gladTeX]: http://www.math.uio.no/~martingu/gladtex/index.html [mimeTeX]: http://www.forkosh.com/mimetex.html -[Dublin Core elements]: http://dublincore.org/documents/dces/ +[CSL]: http://CitationStyles.org Templates ========= @@ -522,8 +500,6 @@ To write a literal `$` in a template, use `$$`. Some variables are set automatically by pandoc. These vary somewhat depending on the output format, but include: -`legacy-header` -: contents specified by `-C/--custom-header` `header-includes` : contents specified by `-H/--include-in-header` (may have multiple values) @@ -544,6 +520,8 @@ depending on the output format, but include: multiple values) `date` : date of document, as specified in title block +`lang` +: language code for HTML documents Variables may be set at the command line using the `-V/--variable` option. This allows users to include custom variables in their @@ -574,103 +552,347 @@ consecutive items: $for(author)$$author$$sep$, $endfor$ -Pandoc's markdown vs. standard markdown -======================================= +Pandoc's markdown +================= -In parsing markdown, Pandoc departs from and extends [standard markdown] -in a few respects. Except where noted, these differences can -be suppressed by specifying the `--strict` command-line option. +Pandoc understands an extended and slightly revised version of +John Gruber's [markdown] syntax. This document explains the syntax, +noting differences from standard markdown. Except where noted, these +differences can be suppressed by specifying the `--strict` command-line +option. -[standard markdown]: http://daringfireball.net/projects/markdown/syntax - "Markdown syntax description" +Philosophy +---------- -Backslash escapes ------------------ +Markdown is designed to be easy to write, and, even more importantly, +easy to read: -Except inside a code block or inline code, any punctuation or space -character preceded by a backslash will be treated literally, even if it -would normally indicate formatting. Thus, for example, if one writes +> A Markdown-formatted document should be publishable as-is, as plain +> text, without looking like it's been marked up with tags or formatting +> instructions. +> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy) - *\*hello\** +This principle has guided pandoc's decisions in finding syntax for +tables, footnotes, and other extensions. -one will get +There is, however, one respect in which pandoc's aims are different +from the original aims of markdown. Whereas markdown was originally +designed with HTML generation in mind, pandoc is designed for multiple +output formats. Thus, while pandoc allows the embedding of raw HTML, +it discourages it, and provides other, non-HTMLish ways of representing +important document elements like definition lists, tables, mathematics, and +footnotes. - <em>*hello*</em> +Paragraphs +---------- -instead of +A paragraph is one or more lines of text followed by one or more blank line. +Newlines are treated as spaces, so you can reflow your paragraphs as you like. +If you need a hard line break, put two or more spaces at the end of a line, +or or type a backslash followed by a newline. - <strong>hello</strong> +Headers +------- -This rule is easier to remember than standard markdown's rule, -which allows only the following characters to be backslash-escaped: +There are two kinds of headers, Setext and atx. - \`*_{}[]()>#+-.! +### Setext-style headers ### -A backslash-escaped space is parsed as a nonbreaking space. It will -appear in TeX output as `~` and in HTML and XML as `\ ` or -`\ `. +A setext-style header is a line of text "underlined" with a row of `=` signs +(for a level one header) of `-` signs (for a level two header): -A backslash-escaped newline (i.e. a backslash occurring at the end of -a line) is parsed as a hard line break. It will appear in TeX output as -`\\` and in HTML as `<br />`. This is a nice alternative to -markdown's "invisible" way of indicating hard line breaks using -two trailing spaces on a line. + A level-one header + ================== -Subscripts and superscripts ---------------------------- + A level-two header + ------------------ -Superscripts may be written by surrounding the superscripted text by `^` -characters; subscripts may be written by surrounding the subscripted -text by `~` characters. Thus, for example, +The header text can contain inline formatting, such as emphasis (see +[Inline formatting](#inline-formatting), below). - H~2~O is a liquid. 2^10^ is 1024. -If the superscripted or subscripted text contains spaces, these spaces -must be escaped with backslashes. (This is to prevent accidental -superscripting and subscripting through the ordinary use of `~` and `^`.) -Thus, if you want the letter P with 'a cat' in subscripts, use -`P~a\ cat~`, not `P~a cat~`. +### Atx-style headers ### -Strikeout ---------- +An Atx-style header consists of one to six `#` signs and a line of +text, optionally followed by any number of `#` signs. The number of +`#` signs at the beginning of the line is the header level: -To strikeout a section of text with a horizontal line, begin and end it -with `~~`. Thus, for example, + ## A level-two header - This ~~is deleted text.~~ + ### A level-three header ### -Nested Lists ------------- +As with setext-style headers, the header text can contain formatting: -Pandoc behaves differently from standard markdown on some "edge -cases" involving lists. Consider this source: + # A level-one header with a [link](/url) and *emphasis* - 1. First - 2. Second: - - Fee - - Fie - - Foe +Standard markdown syntax does not require a blank line before a header. +Pandoc does require this (except, of course, at the beginning of the +document). The reason for the requirement is that it is all too easy for a +`#` to end up at the beginning of a line by accident (perhaps through line +wrapping). Consider, for example: - 3. Third + I like several of their flavors of ice cream: + #22, for example, and #5. + + +### Header identifiers in HTML ### + +*Pandoc extension*. + +Each header element in pandoc's HTML output is given a unique +identifier. This identifier is based on the text of the header. To +derive the identifier from the header text, + + - Remove all formatting, links, etc. + - Remove all punctuation, except underscores, hyphens, and periods. + - Replace all spaces and newlines with hyphens. + - Convert all alphabetic characters to lowercase. + - Remove everything up to the first letter (identifiers may + not begin with a number or punctuation mark). + - If nothing is left after this, use the identifier `section`. + +Thus, for example, + + Header Identifier + ------------------------------- ---------------------------- + Header identifiers in HTML `header-identifiers-in-html` + *Dogs*?--in *my* house? `dogs--in-my-house` + [HTML], [S5], or [RTF]? `html-s5-or-rtf` + 3. Applications `applications` + 33 `section` + +These rules should, in most cases, allow one to determine the identifier +from the header text. The exception is when several headers have the +same text; in this case, the first will get an identifier as described +above; the second will get the same identifier with `-1` appended; the +third with `-2`; and so on. + +These identifiers are used to provide link targets in the table of +contents generated by the `--toc|--table-of-contents` option. They +also make it easy to provide links from one section of a document to +another. A link to this section, for example, might look like this: + + See the section on + [header identifiers](#header-identifiers-in-html). + +Note, however, that this method of providing links to sections works +only in HTML. + +If the `--section-divs` option is specified, then each section will +be wrapped in a `div` (or a `section`, if `--html5` was specified), +and the identifier will be attached to the enclosing `<div>` +(or `<section>`) tag rather than the header itself. This allows entire +sections to be manipulated using javascript or treated differently in +CSS. -Pandoc transforms this into a "compact list" (with no `<p>` tags around -"First", "Second", or "Third"), while markdown puts `<p>` tags around -"Second" and "Third" (but not "First"), because of the blank space -around "Third". Pandoc follows a simple rule: if the text is followed by -a blank line, it is treated as a paragraph. Since "Second" is followed -by a list, and not a blank line, it isn't treated as a paragraph. The -fact that the list is followed by a blank line is irrelevant. (Note: -Pandoc works this way even when the `--strict` option is specified. This -behavior is consistent with the official markdown syntax description, -even though it is different from that of `Markdown.pl`.) -Ordered Lists -------------- +Block quotations +---------------- + +Markdown uses email conventions for quoting blocks of text. +A block quotation is one or more paragraphs or other block elements +(such as lists or headers), with each line preceded by a `>` character +and a space. (The `>` need not start at the left margin, but it should +not be indented more than three spaces.) + + > This is a block quote. This + > paragraph has two lines. + > + > 1. This is a list inside a block quote. + > 2. Second item. + +A "lazy" form, which requires the `>` character only on the first +line of each block, is also allowed: + + > This is a block quote. This + paragraph has two lines. + + > 1. This is a list inside a block quote. + 2. Second item. + +Among the block elements that can be contained in a block quote are +other block quotes. That is, block quotes can be nested: + + > This is a block quote. + > + > > A block quote within a block quote. + +Standard markdown syntax does not require a blank line before a block +quote. Pandoc does require this (except, of course, at the beginning of the +document). The reason for the requirement is that it is all too easy for a +`>` to end up at the beginning of a line by accident (perhaps through line +wrapping). So, unless `--strict` is used, the following does not produce +a nested block quote in pandoc: + + > This is a block quote. + >> Nested. + + +Verbatim (code) blocks +---------------------- + +### Indented code blocks ### + +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); + } + +The initial (four space or one tab) indentation is not considered part +of the verbatim text, and is removed in the output. + +Note: blank lines in the verbatim text need not begin with four spaces. + + +### Delimited code blocks ### + +*Pandoc extension*. + +In addition to standard indented code blocks, Pandoc supports +*delimited* code blocks. These begin with a row of three or more +tildes (`~`) and end with a row of tildes that must be at least +as long as the starting row. Everything between the tilde-lines +is treated as code. No indentation is necessary: + + ~~~~~~~ + if (a > 3) { + moveShip(5 * gravity, DOWN); + } + ~~~~~~~ + +Like regular code blocks, delimited code blocks must be separated +from surrounding text by blank lines. + +If the code itself contains a row of tildes, just use a longer +row of tildes at the start and end: + + ~~~~~~~~~~~~~~~~ + ~~~~~~~~~~ + code including tildes + ~~~~~~~~~~ + ~~~~~~~~~~~~~~~~ + +Optionally, you may specify the language of the code block using +this syntax: + + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines} + qsort [] = [] + qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ + qsort (filter (>= x) xs) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some output formats can use this information to do syntax highlighting. +Currently, the only output format that uses this information is HTML. + +If pandoc has been compiled with syntax highlighting support, then the +code block above will appear highlighted, with numbered lines. (To see +which languages are supported, do `pandoc --version`.) + +If pandoc has not been compiled with syntax highlighting support, the +code block above will appear as follows: + + <pre class="haskell"> + <code> + ... + </code> + </pre> + + +Lists +----- + +### Bullet lists ### + +A bullet list is a list of bulleted list items. A bulleted list +item begins with a bullet (`*`, `+`, or `-`). Here is a simple +example: + + * one + * two + * three + +This will produce a "compact" list. If you want a "loose" list, in which +each item is formatted as a paragraph, put spaces between the items: + + * one + + * two + + * three + +The bullets need not be flush with the left margin; they may be +indented one, two, or three spaces. The bullet must be followed +by whitespace. + +A list item may contain multiple paragraphs and other block-level +content. Subsequent paragraphs must be preceded by a blank line +and indented four spaces or a tab. The list will look better if +the first paragraph is aligned with the rest: + + * First paragraph. + + Continued. + + * Second paragraph. With a code block, which must be indented + eight spaces: + + { code } + +List items may include other lists. In this case the preceding blank +line is optional. The nested list must be indented four spaces or +one tab: + + * fruits + + apples + - macintosh + - red delicious + + pears + + peaches + * vegetables + + brocolli + + chard + +Markdown allows you to write list items "lazily," instead of +indenting continuation lines. However, if there are multiple paragraphs +or other blocks in a list item, the first line of each must be indented. + + + A lazy, lazy, list + item. + + + Another one; this looks + bad but is legal. + + Second paragraph of second + list item. + + +### Ordered lists ### + +Ordered lists work just like bulleted lists, except that the items +begin with enumerators rather than bullets. + +In standard markdown, enumerators are decimal numbers followed +by a period and a space. The numbers themselves are ignored, so +there is no difference between this list: + + 1. one + 2. two + 3. three + +and this one: + + 5. one + 7. two + 1. three + +*Pandoc extension*. Unlike standard markdown, Pandoc allows ordered list items to be marked with uppercase and lowercase letters and roman numerals, in addition to -arabic numerals. (This behavior can be turned off using the `--strict` -option.) 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 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] @@ -718,34 +940,10 @@ If default list markers are desired, use `#.`: #. two #. three -Numbered examples ------------------ - -The special list marker `@` can be used for sequentially numbered -examples. The first list item with a `@` marker will be numbered '1', -the next '2', and so on, throughout the document. The numbered examples -need not occur in a single list; each new list using `@` will take up -where the last stopped. So, for example: - - (@) My first example will be numbered (1). - (@) My second example will be numbered (2). - Explanation of examples. - - (@) My third example will be numbered (3). - -Numbered examples can be labeled and referred to elsewhere in the -document: - - (@good) This is a good example. - - As (@good) illustrates, ... - -The label can be any string of alphanumeric characters, underscores, -or hyphens. +### Definition lists ### -Definition lists ----------------- +*Pandoc extension*. Pandoc supports definition lists, using a syntax inspired by [PHP Markdown Extra] and [reStructuredText]:[^3] @@ -785,63 +983,114 @@ definition and the next term: [PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/ -Reference links ---------------- -Pandoc allows implicit reference links with just a single set of -brackets. So, the following links are equivalent: +### Numbered example lists ### - 1. Here's my [link] - 2. Here's my [link][] +*Pandoc extension*. - [link]: linky.com +The special list marker `@` can be used for sequentially numbered +examples. The first list item with a `@` marker will be numbered '1', +the next '2', and so on, throughout the document. The numbered examples +need not occur in a single list; each new list using `@` will take up +where the last stopped. So, for example: -(Note: Pandoc works this way even if `--strict` is specified, because -`Markdown.pl` 1.0.2b7 allows single-bracket links.) + (@) My first example will be numbered (1). + (@) My second example will be numbered (2). -Footnotes ---------- + Explanation of examples. -Pandoc's markdown allows footnotes, using the following syntax: + (@) My third example will be numbered (3). - Here is a footnote reference,[^1] and another.[^longnote] +Numbered examples can be labeled and referred to elsewhere in the +document: - [^1]: Here is the footnote. + (@good) This is a good example. - [^longnote]: Here's one with multiple blocks. + As (@good) illustrates, ... - Subsequent paragraphs are indented to show that they - belong to the previous footnote. +The label can be any string of alphanumeric characters, underscores, +or hyphens. - { 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. +### Compact and loose lists ### - This paragraph won't be part of the note, because it isn't indented. +Pandoc behaves differently from `Markdown.pl` on some "edge +cases" involving lists. Consider this source: -The identifiers in footnote references may not contain spaces, tabs, -or newlines. These identifiers are used only to correlate the -footnote reference with the note itself; in the output, footnotes -will be numbered sequentially. + + First + + Second: + - Fee + - Fie + - Foe -The footnotes themselves need not be placed at the end of the -document. They may appear anywhere except inside other block elements -(lists, block quotes, tables, etc.). + + Third -Inline footnotes are also allowed (though, unlike regular notes, -they cannot contain multiple paragraphs). The syntax is as follows: +Pandoc transforms this into a "compact list" (with no `<p>` tags around +"First", "Second", or "Third"), while markdown puts `<p>` tags around +"Second" and "Third" (but not "First"), because of the blank space +around "Third". Pandoc follows a simple rule: if the text is followed by +a blank line, it is treated as a paragraph. Since "Second" is followed +by a list, and not a blank line, it isn't treated as a paragraph. The +fact that the list is followed by a blank line is irrelevant. (Note: +Pandoc works this way even when the `--strict` option is specified. This +behavior is consistent with the official markdown syntax description, +even though it is different from that of `Markdown.pl`.) - Here is an inline note.^[Inlines notes are easier to write, since - you don't have to pick an identifier and move down to type the - note.] -Inline and regular footnotes may be mixed freely. +### Ending a list ### + +What if you want to put an indented code block after a list? + + - item one + - item two + + { 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 +a code block. + +To "cut off" the list after item two, you can insert some non-indented +content, like an HTML comment, which won't produce visible output in +any format: + + - item one + - item two + + <!-- end of list --> + + { my code block } + +You can use the same trick if you want two consecutive lists instead +of one big list: + + 1. one + 2. two + 3. three + + <!-- --> + + a. uno + b. dos + c. tres + + +Horizontal rules +---------------- + +A line containing a row of three or more `*`, `-`, or `_` characters +(optionally separated by spaces) produces a horizontal rule: + + * * * * + + --------------- + Tables ------ +*Pandoc extension*. + Three kinds of tables may be used. All three kinds presuppose the use of a fixed-width font, such as Courier. @@ -891,7 +1140,8 @@ of the first line of the table body. So, in the tables above, the columns would be right, left, center, and right aligned, respectively. **Multiline tables** allow headers and table rows to span multiple lines -of text. Here is an example: +of text (but cells that span multiple columns or rows of the table are +not supported). Here is an example: ------------------------------------------------------------- Centered Default Right Left @@ -940,7 +1190,7 @@ the table), or the table may be interpreted as a simple table. **Grid tables** look like this: : Sample grid table. - + +---------------+---------------+--------------------+ | Fruit | Price | Advantages | +===============+===============+====================+ @@ -954,84 +1204,16 @@ the table), or the table may be interpreted as a simple table. The row of `=`s separates the header from the table body, and can be omitted for a headerless table. The cells of grid tables may contain arbitrary block elements (multiple paragraphs, code blocks, lists, -etc.). Alignments are not supported, nor are multi-column or multi-row -cells. Grid tables can be created easily using [Emacs table mode]. +etc.). Alignments are not supported, nor are cells that span multiple +columns or rows. Grid tables can be created easily using [Emacs table mode]. [Emacs table mode]: http://table.sourceforge.net/ -Delimited Code blocks ---------------------- - -In addition to standard indented code blocks, Pandoc supports -*delimited* code blocks. These begin with a row of three or more -tildes (`~`) and end with a row of tildes that must be at least -as long as the starting row. Everything between the tilde-lines -is treated as code. No indentation is necessary: - - ~~~~~~~ - {code here} - ~~~~~~~ -Like regular code blocks, delimited code blocks must be separated -from surrounding text by blank lines. +Title block +----------- -If the code itself contains a row of tildes, just use a longer -row of tildes at the start and end: - - ~~~~~~~~~~~~~~~~ - ~~~~~~~~~~ - code including tildes - ~~~~~~~~~~ - ~~~~~~~~~~~~~~~~ - -Optionally, you may specify the language of the code block using -this syntax: - - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines} - qsort [] = [] - qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ - qsort (filter (>= x) xs) - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some output formats can use this information to do syntax highlighting. -Currently, the only output format that uses this information is HTML. - -If pandoc has been compiled with syntax highlighting support, then the -code block above will appear highlighted, with numbered lines. (To see -which languages are supported, do `pandoc --version`.) - -If pandoc has not been compiled with syntax highlighting support, the -code block above will appear as follows: - - <pre class="haskell"> - <code> - ... - </code> - </pre> - -Images with captions --------------------- - -An image occurring by itself in a paragraph will be rendered as -a figure with a caption.[^5] (In LaTeX, a figure environment will be -used; in HTML, the image will be placed in a `div` with class -`figure`, together with a caption in a `p` with class `caption`.) -The image's alt text will be used as the caption. - -  - -[^5]: This feature is not yet implemented for RTF, OpenDocument, or - ODT. In those formats, you'll just get an image in a paragraph by - itself, with no caption. - -If you just want a regular inline image, just make sure it is not -the only thing in the paragraph. One way to do this is to insert a -nonbreaking space after the image: - - \ - -Title blocks ------------- +*Pandoc extension*. If the file begins with a title block @@ -1107,12 +1289,233 @@ will also have "Pandoc User Manuals" in the footer. will also have "Version 4.0" in the header. -Markdown in HTML blocks ------------------------ -While standard markdown leaves HTML blocks exactly as they are, Pandoc -treats text between HTML tags as markdown. Thus, for example, Pandoc -will turn +Backslash escapes +----------------- + +Except inside a code block or inline code, any punctuation or space +character preceded by a backslash will be treated literally, even if it +would normally indicate formatting. Thus, for example, if one writes + + *\*hello\** + +one will get + + <em>*hello*</em> + +instead of + + <strong>hello</strong> + +This rule is easier to remember than standard markdown's rule, +which allows only the following characters to be backslash-escaped: + + \`*_{}[]()>#+-.! + +(However, if the `--strict` option is supplied, the standard +markdown rule will be used.) + +A backslash-escaped space is parsed as a nonbreaking space. It will +appear in TeX output as `~` and in HTML and XML as `\ ` or +`\ `. + +A backslash-escaped newline (i.e. a backslash occurring at the end of +a line) is parsed as a hard line break. It will appear in TeX output as +`\\` and in HTML as `<br />`. This is a nice alternative to +markdown's "invisible" way of indicating hard line breaks using +two trailing spaces on a line. + +Backslash escapes do not work in verbatim contexts. + +Smart punctuation +----------------- + +If the `--smart` option is specified, pandoc will produce typographically +correct output, converting straight quotes to curly quotes, `---` and `--` +to Em-dashes, and `...` to ellipses. Nonbreaking spaces are inserted after +certain abbreviations, such as "Mr." + +Inline formatting +----------------- + +### Emphasis ### + +To *emphasize* some text, surround it with `*`s or `_`, like this: + + This text is _emphasized with underscores_, and this + is *emphasized with asterisks*. + +Double `*` or `_` produces **strong emphasis**: + + This is **strong emphasis** and __with underscores__. + +A `*` or `_` character surrounded by spaces, or backslash-escaped, +will not trigger emphasis: + + This is * not emphasized *, and \*neither is this\*. + +Because `_` is sometimes used inside words and identifiers, +pandoc does not interpret a `_` surrounded by alphanumeric +characters as an emphasis marker. If you want to emphasize +just part of a word, use `*`: + + feas*ible*, not feas*able*. + + +### Strikeout ### + +*Pandoc extension*. + +To strikeout a section of text with a horizontal line, begin and end it +with `~~`. Thus, for example, + + This ~~is deleted text.~~ + + +### Superscripts and subscripts ### + +*Pandoc extension*. + +Superscripts may be written by surrounding the superscripted text by `^` +characters; subscripts may be written by surrounding the subscripted +text by `~` characters. Thus, for example, + + H~2~O is a liquid. 2^10^ is 1024. + +If the superscripted or subscripted text contains spaces, these spaces +must be escaped with backslashes. (This is to prevent accidental +superscripting and subscripting through the ordinary use of `~` and `^`.) +Thus, if you want the letter P with 'a cat' in subscripts, use +`P~a\ cat~`, not `P~a cat~`. + + +### Verbatim ### + +To make a short span of text verbatim, put it inside backticks: + + What is the difference between `>>=` and `>>`? + +If the verbatim text includes a backtick, use double backticks: + + Here is a literal backtick `` ` ``. + +(The spaces after the opening backticks and before the closing +backticks will be ignored.) + +The general rule is that a verbatim span starts with a string +of consecutive backticks (optionally followed by a space) +and ends with a string of the same number of backticks (optionally +preceded by a space). + +Note that backslash-escapes (and other markdown constructs) do not +work in verbatim contexts: + + This is a backslash followed by an asterisk: `\*`. + + +Math +---- + +*Pandoc extension*. + +Anything between two `$` characters will be treated as TeX math. The +opening `$` must have a character immediately to its right, while the +closing `$` must have a character immediately to its left. Thus, +`$20,000 and $30,000` won't parse as math. If for some reason +you need to enclose text in literal `$` characters, backslash-escape +them and they won't be treated as math delimiters. + +TeX math will be printed in all output formats. How it is rendered +depends on the output format: + +Markdown, reStructuredText, LaTeX, Org-Mode, ConTeXt + ~ It will appear verbatim between `$` characters. + +reStructuredText + ~ It will be rendered using an interpreted text role `:math:`, as described + [here](http://www.american.edu/econ/itex2mml/mathhack.rst). + +Texinfo + ~ It will be rendered inside a `@math` command. + +groff man + ~ It will be rendered verbatim without `$`'s. + +MediaWiki + ~ It will be rendered inside `<math>` tags. + +Textile + ~ It will be rendered inside `<span class="math">` tags. + +RTF, Docbook, OpenDocument, ODT + ~ It will be rendered, if possible, using unicode characters, + and will otherwise appear verbatim. + +HTML, Slidy, S5, EPUB + ~ The way math is rendered in HTML will depend on the + command-line options selected: + + 1. The default is to render TeX math as far as possible using unicode + characters, as with RTF, Docbook, and OpenDocument output. Formulas + are put inside a `span` with `class="math"`, so that they may be + styled differently from the surrounding text if needed. + + 2. If the `--latexmathml` option is used, TeX math will be displayed + between $ or $$ characters and put in `<span>` tags with class `LaTeX`. + The [LaTeXMathML] script will be used to render it as formulas. + (This trick does not work in all browsers, but it works in Firefox. + In browsers that do not support LaTeXMathML, TeX math will appear + verbatim between $ characters.) + + 3. If the `--jsmath` option is used, TeX math will be put inside + `<span>` tags (for inline math) or `<div>` tags (for display math) + with class `math`. The [jsMath] script will be used to render + it. + + 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will + be called to generate images for each TeX formula. This should + work in all browsers. The `--mimetex` option takes an optional URL + as argument. If no URL is specified, it will be assumed that the + mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`. + + 5. If the `--gladtex` option is used, TeX formulas will be enclosed + in `<eq>` tags in the HTML output. The resulting `htex` file may then + be processed by [gladTeX], which will produce image files for each + formula and an `html` file with links to these images. So, the + procedure is: + + pandoc -s --gladtex myfile.txt -o myfile.htex + gladtex -d myfile-images myfile.htex + # produces myfile.html and images in myfile-images + + 6. If the `--webtex` option is used, TeX formulas will be converted + to `<img>` tags that link to an external script that converts + formulas to images. The formula will be URL-encoded and concatenated + with the URL provided. If no URL is specified, the Google Chart + API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`). + + +Raw HTML +-------- + +Markdown allows you to insert raw HTML anywhere in a document +(except verbatim contexts, where `<`, `>`, and `&` are interpreted +literally). + +The raw HTML is passed through unchanged in HTML, S5, Slidy, EPUB, +Markdown, and Textile output, and suppressed in other formats. + +*Pandoc extension*. + +Standard markdown allows you to include HTML "blocks": blocks +of HTML between balanced tags that are separated from the surrounding text +with blank lines, and start and end at the left margin. Within +these blocks, everything is interpreted as HTML, not markdown; +so (for example), `*` does not signify emphasis. + +Pandoc behaves this way when `--strict` is specified; but by default, +pandoc interprets material between HTML block tags as markdown. +Thus, for example, Pandoc will turn <table> <tr> @@ -1133,168 +1536,272 @@ into whereas `Markdown.pl` will preserve it as is. There is one exception to this rule: text between `<script>` and -`</script>` tags is not interpreted as markdown. +`<style>` tags is not interpreted as markdown. This departure from standard markdown should make it easier to mix markdown with HTML block elements. For example, one can surround a block of markdown text with `<div>` tags without preventing it from being interpreted as markdown. -Header identifiers in HTML --------------------------- -Each header element in pandoc's HTML output is given a unique -identifier. This identifier is based on the text of the header. To -derive the identifier from the header text, +Raw TeX +------- - - Remove all formatting, links, etc. - - Remove all punctuation, except underscores, hyphens, and periods. - - Replace all spaces and newlines with hyphens. - - Convert all alphabetic characters to lowercase. - - Remove everything up to the first letter (identifiers may - not begin with a number or punctuation mark). - - If nothing is left after this, use the identifier `section`. +*Pandoc extension*. -Thus, for example, +In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be +included in a document. Inline TeX commands will be preserved and passed +unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use +LaTeX to include BibTeX citations: - Header Identifier - ------------------------------------- --------------------------- - Header identifiers in HTML `header-identifiers-in-html` - *Dogs*?--in *my* house? `dogs--in-my-house` - [HTML], [S5], or [RTF]? `html-s5-or-rtf` - 3. Applications `applications` - 33 `section` + This result was proved in \cite{jones.1967}. -These rules should, in most cases, allow one to determine the identifier -from the header text. The exception is when several headers have the -same text; in this case, the first will get an identifier as described -above; the second will get the same identifier with `-1` appended; the -third with `-2`; and so on. +Note that in LaTeX environments, like -These identifiers are used to provide link targets in the table of -contents generated by the `--toc|--table-of-contents` option. They -also make it easy to provide links from one section of a document to -another. A link to this section, for example, might look like this: + \begin{tabular}{|l|l|}\hline + Age & Frequency \\ \hline + 18--25 & 15 \\ + 26--35 & 33 \\ + 36--45 & 22 \\ \hline + \end{tabular} - See the section on [header identifiers](#header-identifiers-in-html). +the material between the begin and end tags will be interpreted as raw +LaTeX, not as markdown. -Note, however, that this method of providing links to sections works -only in HTML. +Inline LaTeX is ignored in output formats other than Markdown, LaTeX, +and ConTeXt. -If the `--section-divs` option is specified, then each section will -be wrapped in a `div`, and the identifier will be attached to the -enclosing `<div>` tag rather than the header itself. This allows entire -sections to be manipulated using javascript or treated differently in -CSS. +### Macros ### -Blank lines before headers and blockquotes ------------------------------------------- +For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and +`\renewcommand` definitions and apply the resulting macros to all LaTeX +math. So, for example, the following will work in all output formats, +not just LaTeX: -Standard markdown syntax does not require a blank line before a header -or blockquote. Pandoc does require this (except, of course, at the -beginning of the document). The reason for the requirement is that -it is all too easy for a `>` or `#` to end up at the beginning of a -line by accident (perhaps through line wrapping). Consider, for -example: + \newcommand{\tuple}[1]{\langle #1 \rangle} - I like several of their flavors of ice cream: #22, for example, and - #5. + $\tuple{a, b, c}$ -Math ----- +In LaTeX output, the `\newcommand` definition will simply be passed +unchanged to the output. -Anything between two $ characters will be treated as TeX math. The -opening $ must have a character immediately to its right, while the -closing $ must have a character immediately to its left. Thus, -`$20,000 and $30,000` won't parse as math. If for some reason -you need to enclose text in literal $ characters, backslash-escape -them and they won't be treated as math delimiters. -TeX math will be printed in all output formats. In Markdown, -reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim -between $ characters. - -In reStructuredText output, it will be rendered using an interpreted -text role `:math:`, as described -[here](http://www.american.edu/econ/itex2mml/mathhack.rst). - -In Texinfo output, it will be rendered inside a `@math` command. - -In groff man output, it will be rendered verbatim without $'s. - -In MediaWiki output, it will be rendered inside `<math>` tags. - -In RTF, Docbook, and OpenDocument output, it will be rendered, as far as -possible, using unicode characters, and will otherwise appear verbatim. -Unknown commands and symbols, and commands that cannot be dealt with -this way (like `\frac`), will be rendered verbatim. So the results may -be a mix of raw TeX code and properly rendered unicode math. - -In HTML, Slidy, and S5 output, the way math is rendered will depend on the -command-line options selected: - -1. The default is to render TeX math as far as possible using unicode - characters, as with RTF, Docbook, and OpenDocument output. Formulas - are put inside a `span` with `class="math"`, so that they may be - styled differently from the surrounding text if needed. - -2. If the `--latexmathml` option is used, TeX math will be displayed - between $ or $$ characters and put in `<span>` tags with class `LaTeX`. - The [LaTeXMathML] script will be used to render it as formulas. - (This trick does not work in all browsers, but it works in Firefox. - In browsers that do not support LaTeXMathML, TeX math will appear - verbatim between $ characters.) - -3. If the `--jsmath` option is used, TeX math will be put inside - `<span>` tags (for inline math) or `<div>` tags (for display math) - with class `math`. The [jsMath] script will be used to render - it. - -4. If the `--mimetex` option is used, the [mimeTeX] CGI script will - be called to generate images for each TeX formula. This should - work in all browsers. The `--mimetex` option takes an optional URL - as argument. If no URL is specified, it will be assumed that the - mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`. - -5. If the `--gladtex` option is used, TeX formulas will be enclosed - in `<eq>` tags in the HTML output. The resulting `htex` file may then - be processed by [gladTeX], which will produce image files for each - formula and an `html` file with links to these images. So, the - procedure is: - - pandoc -s --gladtex myfile.txt -o myfile.htex - gladtex -d myfile-images myfile.htex - # produces myfile.html and images in myfile-images - -6. If the `--webtex` option is used, TeX formulas will be converted - to `<img>` tags that link to an external script that converts - formulas to images. The formula will be URL-encoded and concatenated - with the URL provided. If no URL is specified, the Google Chart - API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`). - -Inline TeX ----------- +Links +----- -Inline TeX commands will be preserved and passed unchanged to the -LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to -include BibTeX citations: +Markdown allows links to be specified in several ways. - This result was proved in \cite{jones.1967}. +### Automatic links ### -Note that in LaTeX environments, like +If you enclose a URL or email address in pointy brackets, it +will become a link: - \begin{tabular}{|l|l|}\hline - Age & Frequency \\ \hline - 18--25 & 15 \\ - 26--35 & 33 \\ - 36--45 & 22 \\ \hline - \end{tabular} + <http://google.com> + <sam@green.eggs.ham> -the material between the begin and end tags will be interpreted as raw -LaTeX, not as markdown. -Inline LaTeX is ignored in output formats other than Markdown, LaTeX, -and ConTeXt. +### Inline links ### + +An inline link consists of the link text in square brackets, +followed by the URL in parentheses. (Optionally, the URL can +be followed by a link title, in quotes.) + + This is an [inline link](/url), and here's [one with + a title](http://fsf.org "click here for a good time!"). + +There can be no space between the bracketed part and the parenthesized part. +The link text can contain formatting (such as emphasis), but the title cannot. + + +### Reference links ### + +An *explicit* reference link has two parts, the link itself and the link +definition, which may occur elsewhere in the document (either +before or after the link). + +The link consists of link text in square brackets, followed by a label in +square brackets. (There can be space between the two.) The link definition +must begin at the left margin or indented no more than three spaces. It +consists of the bracketed label, followed by a colon and a space, followed by +the URL, and optionally (after a space) a link title either in quotes or in +parentheses. + +Here are some examples: + + [my label 1]: /foo/bar.html "My title, optional" + [my label 2]: /foo + [my label 3]: http://fsf.org (The free software foundation) + [my label 4]: /bar#special 'A title in single quotes' + +The URL may optionally be surrounded by angle brackets: + + [my label 5]: <http://foo.bar.baz> + +The title may go on the next line: + + [my label 3]: http://fsf.org + "The free software foundation" + +Note that link labels are not case sensitive. So, this will work: + + Here is [my link][FOO] + + [Foo]: /bar/baz + +In an *implicit* reference link, the second pair of brackets is +empty, or omitted entirely: + + See [my website][], or [my website]. + + [my website]: http://foo.bar.baz + + +Images +------ + +A link immediately preceded by a `!` will be treated as an image. +The link text will be used as the image's alt text: + +  + + ![movie reel] + + [movie reel]: movie.gif + +### Pictures with captions ### + +*Pandoc extension*. + +An image occurring by itself in a paragraph will be rendered as +a figure with a caption.[^5] (In LaTeX, a figure environment will be +used; in HTML, the image will be placed in a `div` with class +`figure`, together with a caption in a `p` with class `caption`.) +The image's alt text will be used as the caption. + +  + +[^5]: This feature is not yet implemented for RTF, OpenDocument, or + ODT. In those formats, you'll just get an image in a paragraph by + itself, with no caption. + +If you just want a regular inline image, just make sure it is not +the only thing in the paragraph. One way to do this is to insert a +nonbreaking space after the image: + + \ + + +Footnotes +--------- + +*Pandoc extension*. + +Pandoc's markdown allows footnotes, using the following syntax: + + Here is a footnote reference,[^1] and another.[^longnote] + + [^1]: Here is the footnote. + + [^longnote]: Here's one with multiple blocks. + + Subsequent paragraphs are indented to show that they + belong to the previous footnote. + + { 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. + + This paragraph won't be part of the note, because it + isn't indented. + +The identifiers in footnote references may not contain spaces, tabs, +or newlines. These identifiers are used only to correlate the +footnote reference with the note itself; in the output, footnotes +will be numbered sequentially. + +The footnotes themselves need not be placed at the end of the +document. They may appear anywhere except inside other block elements +(lists, block quotes, tables, etc.). + +Inline footnotes are also allowed (though, unlike regular notes, +they cannot contain multiple paragraphs). The syntax is as follows: + + Here is an inline note.^[Inlines notes are easier to write, since + you don't have to pick an identifier and move down to type the + note.] + +Inline and regular footnotes may be mixed freely. + + +Citations +--------- + +*Pandoc extension*. + +Pandoc can automatically generate citations and a bibliography in a number of +styles (using Andrea Rossato's `hs-citeproc`). In order to use this feature, +you will need a bibliographic database in one of the following formats: + + Format File extension + ------------ -------------- + MODS .mods + BibTeX .bib + BibLaTeX .bbx + RIS .ris + EndNote .enl + EndNote XML .xml + ISI .wos + MEDLINE .medline + Copac .copac + JSON citeproc .json + +You will need to specify the bibliography file using the `--bibliography` +command-line option (which may be repeated if you have several +bibliographies). + +By default, pandoc will use a Chicago author-date format for citations +and references. To use another style, you will need to use the +`--csl` option to specify a [CSL] 1.0 style file. A primer on +creating and modifying CSL styles can be found at +<http://citationstyles.org/downloads/primer.html>. +A repository of CSL styles can be found at +<https://github.com/citation-style-language/styles>. + +Citations go inside square brackets and are separated by semicolons. +Each citation must have a key, composed of '@' + the citation +identifier from the database, and may optionally have a prefix, +a locator, and a suffix. Here are some examples: + + Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1]. + + Blah blah [@doe99, pp. 33-35, 38-39 and *passim*]. + + Blah blah [@smith04; @doe99]. + +A minus sign (`-`) before the `@` will suppress mention of +the author in the citation. This can be useful when the +author is already mentioned in the text: + + Smith says blah [-@smith04]. + +You can also write an in-text citation, as follows: + + @smith04 says blah. + + @smith04 [p. 33] says blah. + +If the style calls for a list of works cited, it will be placed +at the end of the document. Normally, you will want to end your +document with an appropriate header: + + last paragraph... + + # References + +The bibliography will be inserted after this header. + Producing HTML slide shows with Pandoc ====================================== @@ -1410,3 +1917,34 @@ ordinary HTML (without bird tracks). writes HTML with the Haskell code in bird tracks, so it can be copied and pasted as literate Haskell source. +Authors +======= + +© 2006-2011 John MacFarlane (jgm at berkeley dot edu). Released under the +[GPL], version 2 or greater. This software carries no warranty of +any kind. (See COPYRIGHT for full copyright and warranty notices.) +Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang, +Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public, +Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton, +Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner. + +[markdown]: http://daringfireball.net/projects/markdown/ +[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html +[S5]: http://meyerweb.com/eric/tools/s5/ +[Slidy]: http://www.w3.org/Talks/Tools/Slidy/ +[HTML]: http://www.w3.org/TR/html40/ +[LaTeX]: http://www.latex-project.org/ +[ConTeXt]: http://www.pragma-ade.nl/ +[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format +[DocBook XML]: http://www.docbook.org/ +[OpenDocument XML]: http://opendocument.xml.org/ +[ODT]: http://en.wikipedia.org/wiki/OpenDocument +[Textile]: http://redcloth.org/textile +[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting +[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html +[Haskell]: http://www.haskell.org/ +[GNU Texinfo]: http://www.gnu.org/software/texinfo/ +[Emacs Org-Mode]: http://org-mode.org +[EPUB]: http://www.idpf.org/ +[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License" + |