% Pandoc User's Guide% John MacFarlane% March 20, 2010Pandoc is a [Haskell] library for converting from one markup format toanother, and a command-line tool that uses this library. It can read[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX]; andit 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.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 ofcontents, embedded LaTeX math, and markdown inside HTML block elements.(These enhancements can be disabled if a drop-in replacement for`Markdown.pl` is desired.)In contrast to most existing tools for converting markdown to HTML, whichuse regex substitutions, Pandoc has a modular design: it consists of aset of readers, which parse text in a given format and produce a nativerepresentation of the document, and a set of writers, which convertthis native representation into a target format. Thus, adding an inputor 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 ofany 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 fromstdin.  If you run it with file names as arguments, it will take inputfrom 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(The `-s` option here tells `pandoc` to produce a standalone HTML file,with a proper header, rather than a fragment.  For more details on thisand many other command-line options, see below.)Instead of a filename, you can specify an absolute URI. In thiscase pandoc will attempt to download the content via HTTP:    pandoc -f html -t markdown http://www.fsf.orgThe format of the input and output can be specified explicitly usingcommand-line options.  The input format can be specified using the`-r/--read` or `-f/--from` options, the output format using the`-w/--write` or `-t/--to` options.  Thus, to convert `hello.txt` frommarkdown to LaTeX, you could type:    pandoc -f markdown -t latex hello.txtTo convert `hello.html` from html to markdown:    pandoc -f html -t markdown hello.htmlSupported 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`, (GNUTexinfo), `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 reStructuredTextsyntax. For example, it doesn't handle tables, option lists, orfootnotes. 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` willtry to determine the input and output format from the extensions ofthe input and output filenames.  Thus, for example,    pandoc -o hello.tex hello.txtwill convert `hello.txt` from markdown to LaTeX.  If no output fileis specified (so that output goes to stdout), or if the output file'sextension is unknown, the output format will default to HTML.If no input file is specified (so that input comes from stdin), orif the input files' extensions are unknown, the input format willbe assumed to be markdown unless explicitly specified.Character encodings-------------------All input is assumed to be in the UTF-8 encoding, and all outputis in UTF-8. If your local character encoding is not UTF-8 and you useaccented or foreign characters, you should pipe the input and outputthrough [`iconv`]. For example,    iconv -t utf-8 source.txt | pandoc | iconv -f utf-8 > output.htmlwill convert `source.txt` from the local encoding to UTF-8, thenconvert it to HTML, then convert back to the local encoding,putting the output in `output.html`.Wrappers========`markdown2pdf`--------------The standard Pandoc installation includes `markdown2pdf`, a wrapperaround `pandoc` and `pdflatex` that produces PDFs directly from markdownsources. The default behavior of `markdown2pdf` is to create a file withthe same base name as the first argument and the extension `pdf`; thus,for example,    markdown2pdf sample.txt endnotes.txtwill produce `sample.pdf`.  (If `sample.pdf` exists already,it will be backed up before being overwritten.)  An output filename can be specified explicitly using the `-o` option:    markdown2pdf -o book.pdf chap1 chap2If 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 alsoassumes that the following LaTeX packages are available:`unicode`, `fancyhdr` (if you have verbatim text in footnotes),`graphicx` (if you use images), `array` (if you use tables),and `ulem` (if you use strikeout text).  If they are not alreadyincluded in your LaTeX distribution, you can get them from[CTAN]. A full [TeX Live] or [MacTeX] distribution will have all ofthese packages.`hsmarkdown`------------A user who wants a drop-in replacement for `Markdown.pl` may createa symbolic link to the `pandoc` executable called `hsmarkdown`. Wheninvoked under the name `hsmarkdown`, `pandoc` will behave as if the`--strict` flag had been selected, and no command-line options will berecognized. However, this approach does not work under Cygwin, due toproblems with its simulation of symbolic links.[Cygwin]:  http://www.cygwin.com/ [`iconv`]: http://www.gnu.org/software/libiconv/[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"[TeX Live]: http://www.tug.org/texlive/[MacTeX]:   http://www.tug.org/mactex/Command-line options====================Various command-line options can be used to customize the output.For further documentation, see the `pandoc(1)` man page.`-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.)`-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.)`-s` or `--standalone`:   indicates that a standalone document is to be produced (with    appropriate headers and footers), rather than a fragment.`-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.)`-p` or `--preserve-tabs`:   causes tabs in the source text to be preserved, rather than converted    to spaces (the default).`--tab-stop` *tabstop*:   sets the number of spaces per tab to *tabstop* (defaults to 4).`--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.`--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.)`-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.*`--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.`--base-header-level` *level*:   specifies 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    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    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`.`-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    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    `\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    `\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.    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.`--epub-stylesheet` *filename*:   uses 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:         <dc:rights>Creative Commons</dc:rights>         <dc:language>es-AR</dc:language>    By default, pandoc will include the following metadata elements:    `<dc:title>` (from the document title), `<dc:creator>` (from the    document authors), `<dc:language>` (from the locale), and    `<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.`-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.`--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.`--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.`--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.    If this option is not specified, the default user data directory    will be used:        $HOME/.pandoc    in unix and        C:\Documents And Settings\USERNAME\Application Data\pandoc    in Windows. A `reference.odt`, `epub.css`, `templates` directory,    or `s5` directory placed in this directory will override pandoc's    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`--ignore-args`:   causes Pandoc to ignore all command-line arguments.    Regular Pandoc options are not ignored.  Thus, for example,        pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1    is equivalent to        pandoc -o foo.html -s`-v` or `--version`:   prints the version number to STDERR.`-h` or `--help`:   prints a usage message to STDERR.[Smartypants]: http://daringfireball.net/projects/smartypants/[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/[jsMath]:  http://www.math.union.edu/~dpvc/jsmath/[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/Templates=========When the `-s/--standalone` option is used, pandoc uses a template toadd header and footer material that is needed for a self-standingdocument.  To see the default template that is used, just type    pandoc -D FORMATwhere `FORMAT` is the name of the output format. A custom templatecan be specified using the `--template` option.  You can also overridethe system default templates for a given output format `FORMAT`by putting a file `templates/FORMAT.template` in the user datadirectory (see `--data-dir`, above).Templates may contain *variables*.  Variable names are sequences ofalphanumerics, `-`, and `_`, starting with a letter.  A variable namesurrounded by `$` signs will be replaced by its value.  For example,the string `$title$` in    <title>$title$</title>will be replaced by the document title.To write a literal `$` in a template, use `$$`.Some variables are set automatically by pandoc.  These vary somewhatdepending 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)`toc`:   non-null value if `--toc/--table-of-contents` was specified`include-before`:   contents specified by `-B/--include-before-body` (may have    multiple values)`include-after`:   contents specified by `-A/--include-after-body` (may have    multiple values)`body`:   body of document`title`:   title of document, as specified in title block`author`:   author of document, as specified in title block (may have    multiple values)`date`:   date of document, as specified in title blockVariables may be set at the command line using the `-V/--variable`option. This allows users to include custom variables in theirtemplates.Templates may contain conditionals.  The syntax is as follows:    $if(variable)$    X    $else$    Y    $endif$This will include `X` in the template if `variable` has a non-nullvalue; otherwise it will include `Y`. `X` and `Y` are placeholders forany valid template text, and may include interpolated variables or otherconditionals. The `$else$` section may be omitted.When variables can have multiple values (for example, `author` ina multi-author document), you can use the `$for$` keyword:    $for(author)$    <meta name="author" content="$author$" />    $endfor$You can optionally specify a separator to be used betweenconsecutive items:    $for(author)$$author$$sep$, $endfor$Pandoc's markdown vs. standard markdown=======================================In parsing markdown, Pandoc departs from and extends [standard markdown]in a few respects.  Except where noted, these differences canbe suppressed by specifying the `--strict` command-line option.[standard markdown]:  http://daringfireball.net/projects/markdown/syntax  "Markdown syntax description"Backslash escapes-----------------Except inside a code block or inline code, any punctuation or spacecharacter preceded by a backslash will be treated literally, even if itwould 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:    \`*_{}[]()>#+-.!A backslash-escaped space is parsed as a nonbreaking space.  It willappear in TeX output as `~` and in HTML and XML as `\&#160;` or`\&nbsp;`.A backslash-escaped newline (i.e. a backslash occurring at the end ofa 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 tomarkdown's "invisible" way of indicating hard line breaks usingtwo trailing spaces on a line.Subscripts and superscripts---------------------------Superscripts may be written by surrounding the superscripted text by `^`characters; subscripts may be written by surrounding the subscriptedtext by `~` characters.  Thus, for example,    H~2~O is a liquid.  2^10^ is 1024.If the superscripted or subscripted text contains spaces, these spacesmust be escaped with backslashes.  (This is to prevent accidentalsuperscripting 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~`.Strikeout---------To strikeout a section of text with a horizontal line, begin and end itwith `~~`. Thus, for example,    This ~~is deleted text.~~Nested Lists------------Pandoc behaves differently from standard markdown on some "edgecases" involving lists.  Consider this source:     1.  First    2.  Second:    -   Fee    -   Fie    -   Foe    3.  ThirdPandoc 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 spacearound "Third". Pandoc follows a simple rule: if the text is followed bya blank line, it is treated as a paragraph. Since "Second" is followedby a list, and not a blank line, it isn't treated as a paragraph. Thefact that the list is followed by a blank line is irrelevant. (Note:Pandoc works this way even when the `--strict` option is specified. Thisbehavior is consistent with the official markdown syntax description,even though it is different from that of `Markdown.pl`.)Ordered Lists-------------Unlike standard markdown, Pandoc allows ordered list items to be markedwith uppercase and lowercase letters and roman numerals, in addition toarabic numerals. (This behavior can be turned off using the `--strict`option.) List markers may be enclosed in parentheses or followed by asingle right-parentheses or period. They must be separated from thetext that follows by at least one space, and, if the list marker is acapital 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.    do not get treated as list items.    This rule will not prevent        (C) 2007 Joe Smith    from being interpreted as a list item.  In this case, a backslash    escape can be used:        (C\) 2007 Joe SmithPandoc also pays attention to the type of list marker used, and to thestarting number, and both of these are preserved where possible in theoutput format. Thus, the following yields a list with numbers followedby a single parenthesis, starting with 9, and a sublist with lowercaseroman numerals:     9)  Ninth    10)  Tenth    11)  Eleventh           i. subone          ii. subtwo         iii. subthreeNote that Pandoc pays attention only to the *starting* marker in a list.So, the following yields a list numbered sequentially starting from 2:    (2) Two    (5) Three    1.  Four    *   FiveIf default list markers are desired, use `#.`:    #.  one    #.  two    #.  threeNumbered examples-----------------The special list marker `@` can be used for sequentially numberedexamples. The first list item with a `@` marker will be numbered '1',the next '2', and so on, throughout the document. The numbered examplesneed not occur in a single list; each new list using `@` will take upwhere 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 thedocument:    (@good)  This is a good example.    As (@good) illustrates, ...The label can be any string of alphanumeric characters, underscores,or hyphens.Definition lists----------------Pandoc supports definition lists, using a syntax inspired by[PHP Markdown Extra] and [reStructuredText]:[^3]    Term 1    :   Definition 1    Term 2 with *inline markup*    :   Definition 2            { some code, part of Definition 2 }        Third paragraph of definition 2.Each term must fit on one line, which may optionally be followed bya blank line, and must be followed by one or more definitions.A definition begins with a colon or tilde, which may be indented oneor two spaces. A term may have multiple definitions, and each definitionmay consist of one or more block elements (paragraph, code block, list,etc.), each indented four spaces or one tab stop.If you leave space after the definition (as in the example above),the blocks of the definitions will be considered paragraphs. In someoutput formats, this will mean greater spacing between term/definitionpairs. For a compact definition list, do not leave space between thedefinition and the next term:    Term 1      ~ Definition 1    Term 2      ~ Definition 2a      ~ Definition 2b[^3]:  I have also been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/Reference links---------------Pandoc allows implicit reference links with just a single set ofbrackets.  So, the following links are equivalent:    1. Here's my [link]    2. Here's my [link][]    [link]: linky.com(Note:  Pandoc works this way even if `--strict` is specified, because`Markdown.pl` 1.0.2b7 allows single-bracket links.)Footnotes---------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 thefootnote reference with the note itself; in the output, footnoteswill be numbered sequentially.The footnotes themselves need not be placed at the end of thedocument.  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.Tables------Three kinds of tables may be used. All three kinds presuppose the use ofa fixed-width font, such as Courier.**Simple tables** look like this:      Right     Left     Center     Default    -------     ------ ----------   -------         12     12        12            12        123     123       123          123          1     1          1             1    Table:  Demonstration of simple table syntax.The headers and table rows must each fit on one line.  Columnalignments are determined by the position of the header text relativeto the dashed line below it:[^4]  - If the dashed line is flush with the header text on the right side    but extends beyond it on the left, the column is right-aligned.  - If the dashed line is flush with the header text on the left side     but extends beyond it on the right, the column is left-aligned.  - If the dashed line extends beyond the header text on both sides,    the column is centered.  - If the dashed line is flush with the header text on both sides,    the default alignment is used (in most cases, this will be left).[^4]:  This scheme is due to Michel Fortin, who proposed it on the       [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).The table must end with a blank line, or a line of dashes followed bya blank line. A caption may optionally be provided (as illustrated inthe example above). A caption is a paragraph beginning with the string`Table:` (or just `:`), which will be stripped off. It may appear eitherbefore or after the table.The column headers may be omitted, provided a dashed line is usedto end the table. For example:    -------     ------ ----------   -------         12     12        12             12        123     123       123           123          1     1          1              1    -------     ------ ----------   -------When headers are omitted, column alignments are determined on the basisof the first line of the table body. So, in the tables above, the columnswould be right, left, center, and right aligned, respectively.**Multiline tables** allow headers and table rows to span multiple linesof text.  Here is an example:    -------------------------------------------------------------     Centered   Default           Right Left      Header    Aligned         Aligned Aligned    ----------- ------- --------------- -------------------------       First    row                12.0 Example of a row that                                        spans multiple lines.      Second    row                 5.0 Here's another one. Note                                        the blank line between                                        rows.    -------------------------------------------------------------    Table: Here's the caption. It, too, may span    multiple lines.These work like simple tables, but with the following differences:  - They must begin with a row of dashes, before the header text    (unless the headers are omitted).  - They must end with a row of dashes, then a blank line.  - The rows must be separated by blank lines.In multiline tables, the table parser pays attention to the widths ofthe columns, and the writers try to reproduce these relative widths inthe output. So, if you find that one of the columns is too narrow in theoutput, try widening it in the markdown source.Headers may be omitted in multiline tables as well as simple tables:    ----------- ------- --------------- -------------------------       First    row                12.0 Example of a row that                                        spans multiple lines.      Second    row                 5.0 Here's another one. Note                                        the blank line between                                        rows.    -------------------------------------------------------------    : Here's a multiline table without headers.It is possible for a multiline table to have just one row, but the rowshould be followed by a blank line (and then the row of dashes that endsthe table), or the table may be interpreted as a simple table.**Grid tables** look like this:    : Sample grid table.        +---------------+---------------+--------------------+    | Fruit         | Price         | Advantages         |    +===============+===============+====================+    | Bananas       | $1.34         | - built-in wrapper |    |               |               | - bright color     |    +---------------+---------------+--------------------+    | Oranges       | $2.10         | - cures scurvy     |    |               |               | - tasty            |    +---------------+---------------+--------------------+The row of `=`s separates the header from the table body, and can beomitted for a headerless table. The cells of grid tables may containarbitrary block elements (multiple paragraphs, code blocks, lists,etc.). Alignments are not supported, nor are multi-column or multi-rowcells. 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 moretildes (`~`) and end with a row of tildes that must be at leastas long as the starting row.  Everything between the tilde-linesis treated as code.  No indentation is necessary:    ~~~~~~~    {code here}    ~~~~~~~Like regular code blocks, delimited code blocks must be separatedfrom surrounding text by blank lines.If the code itself contains a row of tildes, just use a longerrow of tildes at the start and end:    ~~~~~~~~~~~~~~~~    ~~~~~~~~~~    code including tildes    ~~~~~~~~~~    ~~~~~~~~~~~~~~~~Optionally, you may specify the language of the code block usingthis 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 thecode block above will appear highlighted, with numbered lines.  (To seewhich languages are supported, do `pandoc --version`.)If pandoc has not been compiled with syntax highlighting support, thecode 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 asa figure with a caption.[^5] (In LaTeX, a figure environment will beused; 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.    ![This is the caption](/url/of/image.png)[^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 notthe only thing in the paragraph. One way to do this is to insert anonbreaking space after the image:    ![This image won't be a figure](/url/of/image.png)\ Title blocks------------If the file begins with a title block    % title    % author(s) (separated by semicolons)    % dateit will be parsed as bibliographic information, not regular text.  (Itwill be used, for example, in the title of standalone LaTeX or HTMLoutput.)  The block may contain just a title, a title and an author,or all three elements. If you want to include an author but notitle, or a title and a date but no author, you need a blank line:    %    % Author    % My title    %    % June 15, 2006The title may occupy multiple lines, but continuation lines mustbegin with leading space, thus:    % My title      on multiple linesIf a document has multiple authors, the authors may be put onseparate lines with leading space, or separated by semicolons, orboth.  So, all of the following are equivalent:    % Author One      Author Two    % Author One; Author Two    % Author One;      Author TwoThe date must fit on one line.All three metadata fields may contain standard inline formatting(italics, links, footnotes, etc.).Title blocks will always be parsed, but they will affect the output onlywhen the `--standalone` (`-s`) option is chosen. In HTML output, titleswill appear twice: once in the document head -- this is the title thatwill appear at the top of the window in a browser -- and once at thebeginning of the document body. The title in the document head can havean optional prefix attached (`--title-prefix` or `-T` option). The titlein the body appears as an H1 element with class "title", so it can besuppressed or reformatted with CSS. If a title prefix is specified with`-T` and no title block appears in the document, the title prefix willbe used by itself as the HTML title.The man page writer extracts a title, man page section number, andother header and footer information from the title line. The titleis assumed to be the first word on the title line, which may optionallyend with a (single-digit) section number in parentheses. (There shouldbe no space between the title and the parentheses.)  Anything afterthis is assumed to be additional footer and header text. A single pipecharacter (`|`) should be used to separate the footer text from the headertext.  Thus,    % PANDOC(1)will yield a man page with the title `PANDOC` and section 1.    % PANDOC(1) Pandoc User Manualswill also have "Pandoc User Manuals" in the footer.    % PANDOC(1) Pandoc User Manuals | Version 4.0will also have "Version 4.0" in the header.Markdown in HTML blocks-----------------------While standard markdown leaves HTML blocks exactly as they are, Pandoctreats text between HTML tags as markdown. Thus, for example, Pandocwill turn    <table>    <tr>    <td>*one*</td>    <td>[a link](http://google.com)</td>    </tr>    </table>into    <table>    <tr>    <td><em>one</em></td>    <td><a href="http://google.com">a link</a></td>    </tr>    </table>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.This departure from standard markdown should make it easier to mixmarkdown with HTML block elements.  For example, one can surrounda block of markdown text with `<div>` tags without preventing itfrom being interpreted as markdown.Header identifiers in HTML--------------------------Each header element in pandoc's HTML output is given a uniqueidentifier. This identifier is based on the text of the header. Toderive 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 identifierfrom the header text. The exception is when several headers have thesame text; in this case, the first will get an identifier as describedabove; the second will get the same identifier with `-1` appended; thethird with `-2`; and so on.These identifiers are used to provide link targets in the table ofcontents generated by the `--toc|--table-of-contents` option. Theyalso make it easy to provide links from one section of a document toanother. 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 worksonly in HTML.If the `--section-divs` option is specified, then each section willbe wrapped in a `div`, and the identifier will be attached to theenclosing `<div>` tag rather than the header itself. This allows entiresections to be manipulated using javascript or treated differently inCSS.Blank lines before headers and blockquotes------------------------------------------Standard markdown syntax does not require a blank line before a headeror blockquote.  Pandoc does require this (except, of course, at thebeginning of the document). The reason for the requirement is thatit is all too easy for a `>` or `#` to end up at the beginning of aline by accident (perhaps through line wrapping).  Consider, forexample:    I like several of their flavors of ice cream:  #22, for example, and    #5.Math----Anything between two $ characters will be treated as TeX math.  Theopening $ must have a character immediately to its right, while theclosing $ must have a character immediately to its left.  Thus,`$20,000 and $30,000` won't parse as math.  If for some reasonyou need to enclose text in literal $ characters, backslash-escapethem 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 verbatimbetween $ characters.In reStructuredText output, it will be rendered using an interpretedtext 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 aspossible, using unicode characters, and will otherwise appear verbatim.Unknown commands and symbols, and commands that cannot be dealt withthis way (like `\frac`), will be rendered verbatim. So the results maybe 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 thecommand-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-images6.  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----------Inline TeX commands will be preserved and passed unchanged to theLaTeX and ConTeXt writers. Thus, for example, you can use LaTeX toinclude BibTeX citations:    This result was proved in \cite{jones.1967}.Note that in LaTeX environments, like    \begin{tabular}{|l|l|}\hline    Age & Frequency \\ \hline    18--25  & 15 \\    26--35  & 33 \\     36--45  & 22 \\ \hline    \end{tabular}the material between the begin and end tags will be interpreted as rawLaTeX, not as markdown.Inline LaTeX is ignored in output formats other than Markdown, LaTeX,and ConTeXt.Producing HTML slide shows with Pandoc======================================You can use Pandoc to produce an HTML + javascript slide presentationthat can be viewed via a web browser.  There are two ways to do this,using [S5] or [Slidy].Here's the markdown source for a simple slide show, `eating.txt`:    % Eating Habits    % John Doe    % March 22, 2005    # In the morning    - Eat eggs    - Drink coffee    # In the evening    - Eat spaghetti    - Drink wine    --------------------------    ![picture of spaghetti](images/spaghetti.jpg)To produce the slide show, simply type    pandoc -w s5 -s eating.txt > eating.htmlfor S5, or    pandoc -w slidy -s eating.txt > eating.htmlfor Slidy.A title page is constructed automatically from the document's titleblock. Each level-one header and horizontal rule begins a new slide.The file produced by pandoc with the `-s/--standalone` option embeds alink to javascripts and CSS files, which are assumed to be available atthe relative path `ui/default` (for S5) or at the Slidy website at`w3.org` (for Slidy). If the `--offline` option is specified, thescripts and CSS will be included directly in the generated file, so thatit may be used offline.You can change the style of the slides by putting customized CSS filesin `$DATADIR/s5/default` (for S5) or `$DATADIR/slidy` (for Slidy),where `$DATADIR` is the user data directory (see `--data-dir`, above).The originals may be found in pandoc's system data directory (generally`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for anyfiles it does not find in the user data directory.Incremental lists-----------------By default, these writers produces lists that display "all at once."If you want your lists to display incrementally (one item at a time),use the `-i` option. If you want a particular list to depart from thedefault (that is, to display incrementally without the `-i` option andall at once with the `-i` option), put it in a block quote:    > - Eat spaghetti    > - Drink wineIn this way incremental and nonincremental lists can be mixed ina single document.Literate Haskell support========================If you append `+lhs` to an appropriate input or output format (`markdown`,`rst`, or `latex` for input or output; `html` for output only), pandocwill treat the document as literate Haskell source. This means that  - In markdown input, "bird track" sections will be parsed as Haskell    code rather than block quotations.  Text between `\begin{code}`    and `\end{code}` will also be treated as Haskell code.  - In markdown output, code blocks with class `haskell` will be    rendered using bird tracks, and block quotations will be    indented one space, so they will not be treated as Haskell code.    In addition, headers will be rendered setext-style (with underlines)    rather than atx-style (with '#' characters). (This is because ghc    treats '#' characters in column 1 as introducing line numbers.)  - In restructured text input, "bird track" sections will be parsed    as Haskell code.  - In restructured text output, code blocks with class `haskell` will    be rendered using bird tracks.  - In LaTeX input, text in `code` environments will be parsed as    Haskell code.  - In LaTeX output, code blocks with class `haskell` will be rendered    inside `code` environments.  - In HTML output, code blocks with class `haskell` will be rendered    with class `literatehaskell` and bird tracks.Examples:    pandoc -f markdown+lhs -t htmlreads literate Haskell source formatted with markdown conventions and writesordinary HTML (without bird tracks).    pandoc -f markdown+lhs -t html+lhswrites HTML with the Haskell code in bird tracks, so it can be copiedand pasted as literate Haskell source.