README · typeable/pandoc

1456[^3]: I have also been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).

1457

1458[PHP Markdown Extra]: http://www.michelf.com/projects/php-markdown/extra/

1459

1460

1461### Numbered example lists ###

1462

1463**Extension: `example_lists`**

1464

1465The special list marker `@` can be used for sequentially numbered

1466examples. The first list item with a `@` marker will be numbered '1',

1467the next '2', and so on, throughout the document. The numbered examples

1468need not occur in a single list; each new list using `@` will take up

1469where the last stopped. So, for example:

1470

1471 (@) My first example will be numbered (1).

1472 (@) My second example will be numbered (2).

1473

1474 Explanation of examples.

1475

1476 (@) My third example will be numbered (3).

1477

1478Numbered examples can be labeled and referred to elsewhere in the

1479document:

1480

1481 (@good) This is a good example.

1482

1483 As (@good) illustrates, ...

1484

1485The label can be any string of alphanumeric characters, underscores,

1486or hyphens.

1487

1488

1489### Compact and loose lists ###

1490

1491Pandoc behaves differently from `Markdown.pl` on some "edge

1492cases" involving lists. Consider this source:

1493

1494 + First

1495 + Second:

1496 - Fee

1497 - Fie

1498 - Foe

1499

1500 + Third

1501

1502Pandoc transforms this into a "compact list" (with no `<p>` tags around

1503"First", "Second", or "Third"), while markdown puts `<p>` tags around

1504"Second" and "Third" (but not "First"), because of the blank space

1505around "Third". Pandoc follows a simple rule: if the text is followed by

1506a blank line, it is treated as a paragraph. Since "Second" is followed

1507by a list, and not a blank line, it isn't treated as a paragraph. The

1508fact that the list is followed by a blank line is irrelevant. (Note:

1509Pandoc works this way even when the `markdown_strict` format is specified. This

1510behavior is consistent with the official markdown syntax description,

1511even though it is different from that of `Markdown.pl`.)

1512

1513

1514### Ending a list ###

1515

1516What if you want to put an indented code block after a list?

1517

1518 - item one

1519 - item two

1520

1521 { my code block }

1522

1523Trouble! Here pandoc (like other markdown implementations) will treat

1524`{ my code block }` as the second paragraph of item two, and not as

1525a code block.

1526

1527To "cut off" the list after item two, you can insert some non-indented

1528content, like an HTML comment, which won't produce visible output in

1529any format:

1530

1531 - item one

1532 - item two

1533

1534

1535

1536 { my code block }

1537

1538You can use the same trick if you want two consecutive lists instead

1539of one big list:

1540

1541 1. one

1542 2. two

1543 3. three

1544

1545

1546

1547 1. uno

1548 2. dos

1549 3. tres

1550

1551Horizontal rules

1552----------------

1553

1554A line containing a row of three or more `*`, `-`, or `_` characters

1555(optionally separated by spaces) produces a horizontal rule:

1557 * * * *

1559 ---------------

1562Tables

1563------

1564

1565Four kinds of tables may be used. The first three kinds presuppose the use of

1566a fixed-width font, such as Courier. The fourth kind can be used with

1567proportionally spaced fonts, as it does not require lining up columns.

1568

1569### Simple tables

1570

1571**Extension: `simple_tables`, `table_captions`**

1572

1573Simple tables look like this:

1574

1575 Right Left Center Default

1576 ------- ------ ---------- -------

1577 12 12 12 12

1578 123 123 123 123

1579 1 1 1 1

1580

1581 Table: Demonstration of simple table syntax.

1582

1583The headers and table rows must each fit on one line. Column

1584alignments are determined by the position of the header text relative

1585to the dashed line below it:[^4]

1586

1587 - If the dashed line is flush with the header text on the right side

1588 but extends beyond it on the left, the column is right-aligned.

1589 - If the dashed line is flush with the header text on the left side

1590 but extends beyond it on the right, the column is left-aligned.

1591 - If the dashed line extends beyond the header text on both sides,

1592 the column is centered.

1593 - If the dashed line is flush with the header text on both sides,

1594 the default alignment is used (in most cases, this will be left).

1595

1596[^4]: This scheme is due to Michel Fortin, who proposed it on the

1597 [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).

1598

1599The table must end with a blank line, or a line of dashes followed by

1600a blank line. A caption may optionally be provided (as illustrated in

1601the example above). A caption is a paragraph beginning with the string

1602`Table:` (or just `:`), which will be stripped off. It may appear either

1603before or after the table.

1604

1605The column headers may be omitted, provided a dashed line is used

1606to end the table. For example:

1607

1608 ------- ------ ---------- -------

1609 12 12 12 12

1610 123 123 123 123

1611 1 1 1 1

1612 ------- ------ ---------- -------

1613

1614When headers are omitted, column alignments are determined on the basis

1615of the first line of the table body. So, in the tables above, the columns

1616would be right, left, center, and right aligned, respectively.

1617

1618### Multiline tables

1619

1620**Extension: `multiline_tables`, `table_captions`**

1621

1622Multiline tables allow headers and table rows to span multiple lines

1623of text (but cells that span multiple columns or rows of the table are

1624not supported). Here is an example:

1625

1626 -------------------------------------------------------------

1627 Centered Default Right Left

1628 Header Aligned Aligned Aligned

1629 ----------- ------- --------------- -------------------------

1630 First row 12.0 Example of a row that

1631 spans multiple lines.

1632

1633 Second row 5.0 Here's another one. Note

1634 the blank line between

1635 rows.

1636 -------------------------------------------------------------

1637

1638 Table: Here's the caption. It, too, may span

1639 multiple lines.

1640

1641These work like simple tables, but with the following differences:

1642

1643 - They must begin with a row of dashes, before the header text

1644 (unless the headers are omitted).

1645 - They must end with a row of dashes, then a blank line.

1646 - The rows must be separated by blank lines.

1647

1648In multiline tables, the table parser pays attention to the widths of

1649the columns, and the writers try to reproduce these relative widths in

1650the output. So, if you find that one of the columns is too narrow in the

1651output, try widening it in the markdown source.

1652

1653Headers may be omitted in multiline tables as well as simple tables:

1654

1655 ----------- ------- --------------- -------------------------

1656 First row 12.0 Example of a row that

1657 spans multiple lines.

1658

1659 Second row 5.0 Here's another one. Note

1660 the blank line between

1661 rows.

1662 ----------- ------- --------------- -------------------------

1663

1664 : Here's a multiline table without headers.

1665

1666It is possible for a multiline table to have just one row, but the row

1667should be followed by a blank line (and then the row of dashes that ends

1668the table), or the table may be interpreted as a simple table.

1669

1670### Grid tables

1671

1672**Extension: `grid_tables`, `table_captions`**

1673

1674Grid tables look like this:

1675

1676 : Sample grid table.

1677

1678 +---------------+---------------+--------------------+

1679 | Fruit | Price | Advantages |

1680 +===============+===============+====================+

1681 | Bananas | $1.34 | - built-in wrapper |

1682 | | | - bright color |

1683 +---------------+---------------+--------------------+

1684 | Oranges | $2.10 | - cures scurvy |

1685 | | | - tasty |

1686 +---------------+---------------+--------------------+

1687

1688The row of `=`s separates the header from the table body, and can be

1689omitted for a headerless table. The cells of grid tables may contain

1690arbitrary block elements (multiple paragraphs, code blocks, lists,

1691etc.). Alignments are not supported, nor are cells that span multiple

1692columns or rows. Grid tables can be created easily using [Emacs table mode].

1693

1694 [Emacs table mode]: http://table.sourceforge.net/

1695

1696### Pipe tables

1697

1698**Extension: `pipe_tables`, `table_captions`**

1699

1700Pipe tables look like this:

1701

1703 |------:|:-----|---------|:------:|

1704 | 12 | 12 | 12 | 12 |

1705 | 123 | 123 | 123 | 123 |

1706 | 1 | 1 | 1 | 1 |

1707

1708 : Demonstration of simple table syntax.

1709

1710The syntax is [the same as in PHP markdown extra]. The beginning and

1711ending pipe characters are optional, but pipes are required between all

1712columns. The colons indicate column alignment as shown. The header

1713can be omitted, but the horizontal line must still be included, as

1714it defines column alignments.

1715

1716Since the pipes indicate column boundaries, columns need not be vertically

1717aligned, as they are in the above example. So, this is a perfectly

1718legal (though ugly) pipe table:

1719

1720 fruit| price

1721 -----|-----:

1722 apple|2.05

1723 pear|1.37

1724 orange|3.09

1725

1726The cells of pipe tables cannot contain block elements like paragraphs

1727and lists, and cannot span multiple lines.

1728

1729 [the same as in PHP markdown extra]:

1730 http://michelf.ca/projects/php-markdown/extra/#table

1731

1732Note: Pandoc also recognizes pipe tables of the following

1733form, as can produced by Emacs' orgtbl-mode:

1734

1735 | One | Two |

1736 |-----+-------|

1737 | my | table |

1738 | is | nice |

1739

1740The difference is that `+` is used instead of `|`. Other orgtbl features

1741are not supported. In particular, to get non-default column alignment,

1742you'll need to add colons as above.

1743

1744Title block

1745-----------

1746

1747**Extension: `pandoc_title_block`**

1748

1749If the file begins with a title block

1750

1751 % title

1752 % author(s) (separated by semicolons)

1753 % date

1754

1755it will be parsed as bibliographic information, not regular text. (It

1756will be used, for example, in the title of standalone LaTeX or HTML

1757output.) The block may contain just a title, a title and an author,

1758or all three elements. If you want to include an author but no

1759title, or a title and a date but no author, you need a blank line:

1760

1761 %

1762 % Author

1763

1764 % My title

1765 %

1766 % June 15, 2006

1767

1768The title may occupy multiple lines, but continuation lines must

1769begin with leading space, thus:

1770

1771 % My title

1772 on multiple lines

1773

1774If a document has multiple authors, the authors may be put on

1775separate lines with leading space, or separated by semicolons, or

1776both. So, all of the following are equivalent:

1777

1778 % Author One

1779 Author Two

1780

1781 % Author One; Author Two

1782

1783 % Author One;

1784 Author Two

1785

1786The date must fit on one line.

1787

1788All three metadata fields may contain standard inline formatting

1789(italics, links, footnotes, etc.).

1790

1791Title blocks will always be parsed, but they will affect the output only

1792when the `--standalone` (`-s`) option is chosen. In HTML output, titles

1793will appear twice: once in the document head -- this is the title that

1794will appear at the top of the window in a browser -- and once at the

1795beginning of the document body. The title in the document head can have

1796an optional prefix attached (`--title-prefix` or `-T` option). The title

1797in the body appears as an H1 element with class "title", so it can be

1798suppressed or reformatted with CSS. If a title prefix is specified with

1799`-T` and no title block appears in the document, the title prefix will

1800be used by itself as the HTML title.

1801

1802The man page writer extracts a title, man page section number, and

1803other header and footer information from the title line. The title

1804is assumed to be the first word on the title line, which may optionally

1805end with a (single-digit) section number in parentheses. (There should

1806be no space between the title and the parentheses.) Anything after

1807this is assumed to be additional footer and header text. A single pipe

1808character (`|`) should be used to separate the footer text from the header

1809text. Thus,

1810

1811 % PANDOC(1)

1812

1813will yield a man page with the title `PANDOC` and section 1.

1814

1815 % PANDOC(1) Pandoc User Manuals

1816

1817will also have "Pandoc User Manuals" in the footer.

1818

1819 % PANDOC(1) Pandoc User Manuals | Version 4.0

1820

1821will also have "Version 4.0" in the header.

1822

1823YAML metadata block

1824-------------------

1825

1826**Extension: `yaml_metadata_block`**

1827

1828A YAML metadata block is a valid YAML object, delimited by a line of three

1829hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

1830(`...`) at the bottom. A YAML metadata block may occur anywhere in the

1831document, but if it is not at the beginning, it must be preceded by a blank

1832line.

1833

1834Metadata will be taken from the fields of the YAML object and added to any

1835existing document metadata. Metadata can contain lists and objects (nested

1836arbitrarily), but all string scalars will be interpreted as markdown. Fields

1837with names ending in an underscore will be ignored by pandoc. (They may be

1838given a role by external processors.)

1839

1840A document may contain multiple metadata blocks. The metadata fields will

1841be combined through a *left-biased union*: if two metadata blocks attempt

1842to set the same field, the value from the first block will be taken.

1843

1844Note that YAML escaping rules must be followed. Thus, for example,

1845if a title contains a colon, it must be quoted. The pipe character

1846(`|`) can be used to begin an indented block that will be interpreted

1847literally, without need for escaping. This form is necessary

1848when the field contains blank lines:

1849

1850 ---

1851 title: 'This is the title: it contains a colon'

1852 author:

1853 - name: Author One

1854 affiliation: University of Somewhere

1855 - name: Author Two

1856 affiliation: University of Nowhere

1857 tags: [nothing, nothingness]

1858 abstract: |

1859 This is the abstract.

1860

1861 It consists of two paragraphs.

1862 ...

1863

1864Template variables will be set automatically from the metadata. Thus, for

1865example, in writing HTML, the variable `abstract` will be set to the HTML

1866equivalent of the markdown in the `abstract` field:

1867

1868 <p>This is the abstract.</p>

1869 <p>It consists of two paragraphs.</p>

1870

1871Note: The `author` variable in the default templates expects a simple list or

1872string. To use the structured authors in the example, you would need a

1873custom template. For example:

1874

1875 $for(author)$

1876 $if(author.name)$

1877 $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$

1878 $else$

1879 $author$

1880 $endif$

1881 $endfor$

1882

1883

1884Backslash escapes

1885-----------------

1886

1887**Extension: `all_symbols_escapable`**

1888

1889Except inside a code block or inline code, any punctuation or space

1890character preceded by a backslash will be treated literally, even if it

1891would normally indicate formatting. Thus, for example, if one writes

1892

1893 *\*hello\**

1894

1895one will get

1896

1897 <em>*hello*</em>

1898

1899instead of

1900

1901 <strong>hello</strong>

1902

1903This rule is easier to remember than standard markdown's rule,

1904which allows only the following characters to be backslash-escaped:

1905

1906 \`*_{}[]()>#+-.!

1907

1908(However, if the `markdown_strict` format is used, the standard markdown rule

1909will be used.)

1910

1911A backslash-escaped space is parsed as a nonbreaking space. It will

1912appear in TeX output as `~` and in HTML and XML as `\ ` or

1913`\ `.

1914

1915A backslash-escaped newline (i.e. a backslash occurring at the end of

1916a line) is parsed as a hard line break. It will appear in TeX output as

1917`\\` and in HTML as `<br />`. This is a nice alternative to

1918markdown's "invisible" way of indicating hard line breaks using

1919two trailing spaces on a line.

1920

1921Backslash escapes do not work in verbatim contexts.

1922

1923Smart punctuation

1924-----------------

1925

1926**Extension**

1927

1928If the `--smart` option is specified, pandoc will produce typographically

1929correct output, converting straight quotes to curly quotes, `---` to

1930em-dashes, `--` to en-dashes, and `...` to ellipses. Nonbreaking spaces

1931are inserted after certain abbreviations, such as "Mr."

1932

1933Note: if your LaTeX template uses the `csquotes` package, pandoc will

1934detect automatically this and use `\enquote{...}` for quoted text.

1935

1936Inline formatting

1937-----------------

1938

1939### Emphasis ###

1940

1941To *emphasize* some text, surround it with `*`s or `_`, like this:

1942

1943 This text is _emphasized with underscores_, and this

1944 is *emphasized with asterisks*.

1945

1946Double `*` or `_` produces **strong emphasis**:

1947

1948 This is **strong emphasis** and __with underscores__.

1949

1950A `*` or `_` character surrounded by spaces, or backslash-escaped,

1951will not trigger emphasis:

1952

1953 This is * not emphasized *, and \*neither is this\*.

1954

1955**Extension: `intraword_underscores`**

1956

1957Because `_` is sometimes used inside words and identifiers,

1958pandoc does not interpret a `_` surrounded by alphanumeric

1959characters as an emphasis marker. If you want to emphasize

1960just part of a word, use `*`:

1961

1962 feas*ible*, not feas*able*.

1963

1964

1965### Strikeout ###

1966

1967**Extension: `strikeout`**

1968

1969To strikeout a section of text with a horizontal line, begin and end it

1970with `~~`. Thus, for example,

1971

1972 This ~~is deleted text.~~

1973

1974

1975### Superscripts and subscripts ###

1976

1977**Extension: `superscript`, `subscript`**

1978

1979Superscripts may be written by surrounding the superscripted text by `^`

1980characters; subscripts may be written by surrounding the subscripted

1981text by `~` characters. Thus, for example,

1982

1983 H~2~O is a liquid. 2^10^ is 1024.

1984

1985If the superscripted or subscripted text contains spaces, these spaces

1986must be escaped with backslashes. (This is to prevent accidental

1987superscripting and subscripting through the ordinary use of `~` and `^`.)

1988Thus, if you want the letter P with 'a cat' in subscripts, use

1989`P~a\ cat~`, not `P~a cat~`.

1990

1991

1992### Verbatim ###

1993

1994To make a short span of text verbatim, put it inside backticks:

1995

1996 What is the difference between `>>=` and `>>`?

1997

1998If the verbatim text includes a backtick, use double backticks:

1999

2000 Here is a literal backtick `` ` ``.

2001

2002(The spaces after the opening backticks and before the closing

2003backticks will be ignored.)

2004

2005The general rule is that a verbatim span starts with a string

2006of consecutive backticks (optionally followed by a space)

2007and ends with a string of the same number of backticks (optionally

2008preceded by a space).

2009

2010Note that backslash-escapes (and other markdown constructs) do not

2011work in verbatim contexts:

2012

2013 This is a backslash followed by an asterisk: `\*`.

2014

2015**Extension: `inline_code_attributes`**

2016

2017Attributes can be attached to verbatim text, just as with

2018[fenced code blocks](#fenced-code-blocks):

2019

2020 `<$>`{.haskell}

2021

2022Math

2023----

2024

2025**Extension: `tex_math_dollars`**

2026

2027Anything between two `$` characters will be treated as TeX math. The

2028opening `$` must have a character immediately to its right, while the

2029closing `$` must have a character immediately to its left. Thus,

2030`$20,000 and $30,000` won't parse as math. If for some reason

2031you need to enclose text in literal `$` characters, backslash-escape

2032them and they won't be treated as math delimiters.

2033

2034TeX math will be printed in all output formats. How it is rendered

2035depends on the output format:

2036

2037Markdown, LaTeX, Org-Mode, ConTeXt

2038 ~ It will appear verbatim between `$` characters.

2039

2040reStructuredText

2041 ~ It will be rendered using an interpreted text role `:math:`, as described

2042 [here](http://www.american.edu/econ/itex2mml/mathhack.rst).

2043

2044AsciiDoc

2045 ~ It will be rendered as `latexmath:[...]`.

2046

2047Texinfo

2048 ~ It will be rendered inside a `@math` command.

2049

2050groff man

2051 ~ It will be rendered verbatim without `$`'s.

2052

2053MediaWiki

2054 ~ It will be rendered inside `<math>` tags.

2055

2056Textile

2057 ~ It will be rendered inside `<span class="math">` tags.

2058

2059RTF, OpenDocument, ODT

2060 ~ It will be rendered, if possible, using unicode characters,

2061 and will otherwise appear verbatim.

2062

2063Docbook

2064 ~ If the `--mathml` flag is used, it will be rendered using mathml

2065 in an `inlineequation` or `informalequation` tag. Otherwise it

2066 will be rendered, if possible, using unicode characters.

2067

2068Docx

2069 ~ It will be rendered using OMML math markup.

2070

2071FictionBook2

2072 ~ If the `--webtex` option is used, formulas are rendered as images

2073 using Google Charts or other compatible web service, downloaded

2074 and embedded in the e-book. Otherwise, they will appear verbatim.

2075

2076HTML, Slidy, DZSlides, S5, EPUB

2077 ~ The way math is rendered in HTML will depend on the

2078 command-line options selected:

2079

2080 1. The default is to render TeX math as far as possible using unicode

2081 characters, as with RTF, DocBook, and OpenDocument output. Formulas

2082 are put inside a `span` with `class="math"`, so that they may be

2083 styled differently from the surrounding text if needed.

2084

2085 2. If the `--latexmathml` option is used, TeX math will be displayed

2086 between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.

2087 The [LaTeXMathML] script will be used to render it as formulas.

2088 (This trick does not work in all browsers, but it works in Firefox.

2089 In browsers that do not support LaTeXMathML, TeX math will appear

2090 verbatim between `$` characters.)

2091

2092 3. If the `--jsmath` option is used, TeX math will be put inside

2093 `<span>` tags (for inline math) or `<div>` tags (for display math)

2094 with class `math`. The [jsMath] script will be used to render

2095 it.

2096

2097 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will

2098 be called to generate images for each TeX formula. This should

2099 work in all browsers. The `--mimetex` option takes an optional URL

2100 as argument. If no URL is specified, it will be assumed that the

2101 mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.

2102

2103 5. If the `--gladtex` option is used, TeX formulas will be enclosed

2104 in `<eq>` tags in the HTML output. The resulting `htex` file may then

2105 be processed by [gladTeX], which will produce image files for each

2106 formula and an `html` file with links to these images. So, the

2107 procedure is:

2108

2109 pandoc -s --gladtex myfile.txt -o myfile.htex

2110 gladtex -d myfile-images myfile.htex

2111 # produces myfile.html and images in myfile-images

2112

2113 6. If the `--webtex` option is used, TeX formulas will be converted

2114 to `<img>` tags that link to an external script that converts

2115 formulas to images. The formula will be URL-encoded and concatenated

2116 with the URL provided. If no URL is specified, the Google Chart

2117 API will be used (`http://chart.apis.google.com/chart?cht=tx&chl=`).

2118

2119 7. If the `--mathjax` option is used, TeX math will be displayed

2120 between `$...$` (for inline math) or `\[...\]` (for display

2121 math) and put in `<span>` tags with class `math`.

2122 The [MathJax] script will be used to render it as formulas.

2123

2124Raw HTML

2125--------

2126

2127**Extension: `raw_html`**

2128

2129Markdown allows you to insert raw HTML (or DocBook) anywhere in a document

2130(except verbatim contexts, where `<`, `>`, and `&` are interpreted

2131literally). (Technically this is not an extension, since standard

2132markdown allows it, but it has been made an extension so that it can

2133be disabled if desired.)

2134

2135The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,

2136DZSlides, EPUB, Markdown, and Textile output, and suppressed in other

2137formats.

2138

2139**Extension: `markdown_in_html_blocks`**

2140

2141Standard markdown allows you to include HTML "blocks": blocks

2142of HTML between balanced tags that are separated from the surrounding text

2143with blank lines, and start and end at the left margin. Within

2144these blocks, everything is interpreted as HTML, not markdown;

2145so (for example), `*` does not signify emphasis.

2146

2147Pandoc behaves this way when the `markdown_strict` format is used; but

2148by default, pandoc interprets material between HTML block tags as markdown.

2149Thus, for example, Pandoc will turn

2150

2151 <table>

2152 <tr>

2153 <td>*one*</td>

2154 <td>[a link](http://google.com)</td>

2155 </tr>

2156 </table>

2157

2158into

2159

2160 <table>

2161 <tr>

2162 <td><em>one</em></td>

2163 <td><a href="http://google.com">a link</a></td>

2164 </tr>

2165 </table>

2166

2167whereas `Markdown.pl` will preserve it as is.

2168

2169There is one exception to this rule: text between `<script>` and

2170`<style>` tags is not interpreted as markdown.

2171

2172This departure from standard markdown should make it easier to mix

2173markdown with HTML block elements. For example, one can surround

2174a block of markdown text with `<div>` tags without preventing it

2175from being interpreted as markdown.

2176

2177Raw TeX

2178-------

2179

2180**Extension: `raw_tex`**

2181

2182In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be

2183included in a document. Inline TeX commands will be preserved and passed

2184unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use

2185LaTeX to include BibTeX citations:

2186

2187 This result was proved in \cite{jones.1967}.

2188

2189Note that in LaTeX environments, like

2190

2191 \begin{tabular}{|l|l|}\hline

2192 Age & Frequency \\ \hline

2193 18--25 & 15 \\

2194 26--35 & 33 \\

2195 36--45 & 22 \\ \hline

2196 \end{tabular}

2197

2198the material between the begin and end tags will be interpreted as raw

2199LaTeX, not as markdown.

2200

2201Inline LaTeX is ignored in output formats other than Markdown, LaTeX,

2202and ConTeXt.

2203

2204LaTeX macros

2205------------

2206

2207**Extension: `latex_macros`**

2208

2209For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and

2210`\renewcommand` definitions and apply the resulting macros to all LaTeX

2211math. So, for example, the following will work in all output formats,

2212not just LaTeX:

2213

2214 \newcommand{\tuple}[1]{\langle #1 \rangle}

2215

2216 $\tuple{a, b, c}$

2217

2218In LaTeX output, the `\newcommand` definition will simply be passed

2219unchanged to the output.

2220

2221

2222Links

2223-----

2224

2225Markdown allows links to be specified in several ways.

2226

2227### Automatic links ###

2228

2229If you enclose a URL or email address in pointy brackets, it

2230will become a link:

2231

2232 <http://google.com>

2233 <sam@green.eggs.ham>

2234

2235### Inline links ###

2236

2237An inline link consists of the link text in square brackets,

2238followed by the URL in parentheses. (Optionally, the URL can

2239be followed by a link title, in quotes.)

2240

2241 This is an [inline link](/url), and here's [one with

2242 a title](http://fsf.org "click here for a good time!").

2243

2244There can be no space between the bracketed part and the parenthesized part.

2245The link text can contain formatting (such as emphasis), but the title cannot.

2246

2247

2248### Reference links ###

2249

2250An *explicit* reference link has two parts, the link itself and the link

2251definition, which may occur elsewhere in the document (either

2252before or after the link).

2253

2254The link consists of link text in square brackets, followed by a label in

2255square brackets. (There can be space between the two.) The link definition

2256consists of the bracketed label, followed by a colon and a space, followed by

2257the URL, and optionally (after a space) a link title either in quotes or in

2258parentheses.

2259

2260Here are some examples:

2261

2262 [my label 1]: /foo/bar.html "My title, optional"

2263 [my label 2]: /foo

2264 [my label 3]: http://fsf.org (The free software foundation)

2265 [my label 4]: /bar#special 'A title in single quotes'

2266

2267The URL may optionally be surrounded by angle brackets:

2268

2269 [my label 5]: <http://foo.bar.baz>

2270

2271The title may go on the next line:

2272

2273 [my label 3]: http://fsf.org

2274 "The free software foundation"

2275

2276Note that link labels are not case sensitive. So, this will work:

2277

2278 Here is [my link][FOO]

2279

2280 [Foo]: /bar/baz

2281

2282In an *implicit* reference link, the second pair of brackets is

2283empty, or omitted entirely:

2284

2285 See [my website][], or [my website].

2286

2287 [my website]: http://foo.bar.baz

2288

2289Note: In `Markdown.pl` and most other markdown implementations,

2290reference link definitions cannot occur in nested constructions

2291such as list items or block quotes. Pandoc lifts this arbitrary

2292seeming restriction. So the following is fine in pandoc, though

2293not in most other implementations:

2294

2295 > My block [quote].

2296 >

2297 > [quote]: /foo

2298

2299### Internal links

2300

2301To link to another section of the same document, use the automatically

2302generated identifier (see [Header identifiers in HTML, LaTeX, and

2303ConTeXt](#header-identifiers-in-html-latex-and-context), below).

2304For example:

2305

2306 See the [Introduction](#introduction).

2307

2308or

2309

2310 See the [Introduction].

2311

2312 [Introduction]: #introduction

2313

2314Internal links are currently supported for HTML formats (including

2315HTML slide shows and EPUB), LaTeX, and ConTeXt.

2316

2317Images

2318------

2319

2320A link immediately preceded by a `!` will be treated as an image.

2321The link text will be used as the image's alt text:

2322

2323 ![la lune](lalune.jpg "Voyage to the moon")

2324

2325 ![movie reel]

2326

2327 [movie reel]: movie.gif

2328

2329### Pictures with captions ###

2330

2331**Extension: `implicit_figures`**

2332

2333An image occurring by itself in a paragraph will be rendered as

2334a figure with a caption.[^5] (In LaTeX, a figure environment will be

2335used; in HTML, the image will be placed in a `div` with class

2336`figure`, together with a caption in a `p` with class `caption`.)

2337The image's alt text will be used as the caption.

2338

2339 ![This is the caption](/url/of/image.png)

2340

2341[^5]: This feature is not yet implemented for RTF, OpenDocument, or

2342 ODT. In those formats, you'll just get an image in a paragraph by

2343 itself, with no caption.

2344

2345If you just want a regular inline image, just make sure it is not

2346the only thing in the paragraph. One way to do this is to insert a

2347nonbreaking space after the image:

2348

2349 ![This image won't be a figure](/url/of/image.png)\

2350

2351

2352Footnotes

2353---------

2354

2355**Extension: `footnotes`**

2356

2357Pandoc's markdown allows footnotes, using the following syntax:

2358

2359 Here is a footnote reference,[^1] and another.[^longnote]

2360

2361 [^1]: Here is the footnote.

2362

2363 [^longnote]: Here's one with multiple blocks.

2364

2365 Subsequent paragraphs are indented to show that they

2366 belong to the previous footnote.

2367

2368 { some.code }

2369

2370 The whole paragraph can be indented, or just the first

2371 line. In this way, multi-paragraph footnotes work like

2372 multi-paragraph list items.

2373

2374 This paragraph won't be part of the note, because it

2375 isn't indented.

2376

2377The identifiers in footnote references may not contain spaces, tabs,

2378or newlines. These identifiers are used only to correlate the

2379footnote reference with the note itself; in the output, footnotes

2380will be numbered sequentially.

2381

2382The footnotes themselves need not be placed at the end of the

2383document. They may appear anywhere except inside other block elements

2384(lists, block quotes, tables, etc.).

2385

2386**Extension: `inline_notes`**

2387

2388Inline footnotes are also allowed (though, unlike regular notes,

2389they cannot contain multiple paragraphs). The syntax is as follows:

2390

2391 Here is an inline note.^[Inlines notes are easier to write, since

2392 you don't have to pick an identifier and move down to type the

2393 note.]

2394

2395Inline and regular footnotes may be mixed freely.

2396

2397

2398Citations

2399---------

2400

2401**Extension: `citations`**

2402

2403Using an external filter, `pandoc-citeproc`, pandoc can automatically generate

2404citations and a bibliography in a number of styles. Basic usage is

2405

2406 pandoc --filter pandoc-citeproc myinput.txt

2407

2408In order to use this feature, you will need to specify a bibliography file

2409using the `bibliography` metadata field in a YAML metadata section.

2410The bibliography may have any of these formats:

2411

2412 Format File extension

2413 ------------ --------------

2414 MODS .mods

2415 BibLaTeX .bib

2416 BibTeX .bibtex

2417 RIS .ris

2418 EndNote .enl

2419 EndNote XML .xml

2420 ISI .wos

2421 MEDLINE .medline

2422 Copac .copac

2423 JSON citeproc .json

2424

2425Note that `.bib` can generally be used with both BibTeX and BibLaTeX

2426files, but you can use `.bibtex` to force BibTeX.

2427

2428Alternatively you can use a `references` field in the document's YAML

2429metadata. This should include an array of YAML-encoded references,

2430for example:

2431

2432 ---

2433 references:

2434 - id: fenner2012a

2435 title: One-click science marketing

2436 author:

2437 - family: Fenner

2438 given: Martin

2439 container-title: Nature Materials

2440 volume: 11

2441 URL: 'http://dx.doi.org/10.1038/nmat3283'

2442 DOI: 10.1038/nmat3283

2443 issue: 4

2444 publisher: Nature Publishing Group

2445 page: 261-263

2446 type: article-journal

2447 issued:

2448 year: 2012

2449 month: 3

2450 ...

2451

2452(The program `mods2yaml`, which comes with `pandoc-citeproc`, can help produce

2453these from a MODS reference collection.)

2454

2455By default, `pandoc-citeproc` will use a Chicago author-date format for

2456citations and references. To use another style, you will need to specify

2457a [CSL] 1.0 style file in the `csl` metadata field. A primer on creating and

2458modifying CSL styles can be found at

2459<http://citationstyles.org/downloads/primer.html>. A repository of CSL styles

2460can be found at <https://github.com/citation-style-language/styles>. See also

2461<http://zotero.org/styles> for easy browsing.

2462

2463Citations go inside square brackets and are separated by semicolons.

2464Each citation must have a key, composed of '@' + the citation

2465identifier from the database, and may optionally have a prefix,

2466a locator, and a suffix. The citation key must begin with a letter

2467or `_`, and may contain alphanumerics, `_`, and internal punctuation

2468characters (`:.#$%&-+?<>~/`). Here are some examples:

2469

2470 Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].

2471

2472 Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

2473

2474 Blah blah [@smith04; @doe99].

2475

2476A minus sign (`-`) before the `@` will suppress mention of

2477the author in the citation. This can be useful when the

2478author is already mentioned in the text:

2479

2480 Smith says blah [-@smith04].

2481

2482You can also write an in-text citation, as follows:

2483

2484 @smith04 says blah.

2485

2486 @smith04 [p. 33] says blah.

2487

2488If the style calls for a list of works cited, it will be placed

2489at the end of the document. Normally, you will want to end your

2490document with an appropriate header:

2491

2492 last paragraph...

2493

2494 # References

2495

2496The bibliography will be inserted after this header. Note that

2497the `unnumbered` class will be added to this header, so that the

2498section will not be numbered.

2499

2500If you want to include items in the bibliography without actually

2501citing them in the body text, you can define a dummy `nocite` metadata

2502field and put the citations there:

2503

2504 ---

2505 nocite: |

2506 @item1, @item2

2507 ...

2508

2509 @item3

2510

2511In this example, the document will contain a citation for `item3`

2512only, but the bibliography will contain entries for `item1`, `item2`, and

2513`item3`.

2514

2515Non-pandoc extensions

2516---------------------

2517

2518The following markdown syntax extensions are not enabled by default

2519in pandoc, but may be enabled by adding `+EXTENSION` to the format

2520name, where `EXTENSION` is the name of the extension. Thus, for

2521example, `markdown+hard_line_breaks` is markdown with hard line breaks.

2522

2523**Extension: `lists_without_preceding_blankline`**\

2524Allow a list to occur right after a paragraph, with no intervening

2525blank space.

2526

2527**Extension: `hard_line_breaks`**\

2528Causes all newlines within a paragraph to be interpreted as hard line

2529breaks instead of spaces.

2530

2531**Extension: `ignore_line_breaks`**\

2532Causes newlines within a paragraph to be ignored, rather than being

2533treated as spaces or as hard line breaks. This option is intended for

2534use with East Asian languages where spaces are not used between words,

2535but text is divided into lines for readability.

2536

2537**Extension: `tex_math_single_backslash`**\

2538Causes anything between `$` and `$` to be interpreted as inline

2539TeX math, and anything between `\[` and `\]` to be interpreted

2540as display TeX math. Note: a drawback of this extension is that

2541it precludes escaping `(` and `[`.

2542

2543**Extension: `tex_math_double_backslash`**\

2544Causes anything between `\$` and `\$` to be interpreted as inline

2545TeX math, and anything between `\\[` and `\\]` to be interpreted

2546as display TeX math.

2547

2548**Extension: `markdown_attribute`**\

2549By default, pandoc interprets material inside block-level tags as markdown.

2550This extension changes the behavior so that markdown is only parsed

2551inside block-level tags if the tags have the attribute `markdown=1`.

2552

2553**Extension: `mmd_title_block`**\

2554Enables a [MultiMarkdown] style title block at the top of

2555the document, for example:

2556

2557 Title: My title

2558 Author: John Doe

2559 Date: September 1, 2008

2560 Comment: This is a sample mmd title block, with

2561 a field spanning multiple lines.

2562

2563See the MultiMarkdown documentation for details. If `pandoc_title_block` or

2564`yaml_metadata_block` is enabled, it will take precedence over

2565`mmd_title_block`.

2566

2567 [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

2568

2569**Extension: `abbreviations`**\

2570Parses PHP Markdown Extra abbreviation keys, like

2571

2572 *[HTML]: Hyper Text Markup Language

2573

2574Note that the pandoc document model does not support

2575abbreviations, so if this extension is enabled, abbreviation keys are

2576simply skipped (as opposed to being parsed as paragraphs).

2577

2578**Extension: `autolink_bare_uris`**\

2579Makes all absolute URIs into links, even when not surrounded by

2580pointy braces `<...>`.

2581

2582**Extension: `ascii_identifiers`**\

2583Causes the identifiers produced by `auto_identifiers` to be pure ASCII.

2584Accents are stripped off of accented latin letters, and non-latin

2585letters are omitted.

2586

2587**Extension: `link_attributes`**\

2588Parses multimarkdown style key-value attributes on link and image references.

2589Note that pandoc's internal document model provides nowhere to put

2590these, so they are presently just ignored.

2591

2592**Extension: `mmd_header_identifiers`**\

2593Parses multimarkdown style header identifiers (in square brackets,

2594after the header but before any trailing `#`s in an ATX header).

2595

2596Markdown variants

2597-----------------

2598

2599In addition to pandoc's extended markdown, the following markdown

2600variants are supported:

2601

2602`markdown_phpextra` (PHP Markdown Extra)

2603: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

2604 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

2605 `header_attributes`, `abbreviations`.

2606

2607`markdown_github` (Github-flavored Markdown)

2608: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,

2609 `fenced_code_blocks`, `fenced_code_attributes`, `auto_identifiers`,

2610 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

2611 `intraword_underscores`, `strikeout`, `hard_line_breaks`

2612

2613`markdown_mmd` (MultiMarkdown)

2614: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,

2615 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,

2616 `mmd_title_block`, `footnotes`, `definition_lists`,

2617 `all_symbols_escapable`, `implicit_header_references`,

2618 `auto_identifiers`, `mmd_header_identifiers`

2619

2620`markdown_strict` (Markdown.pl)

2621: `raw_html`

2622

2623Extensions with formats other than markdown

2624-------------------------------------------

2625

2626Some of the extensions discussed above can be used with formats

2627other than markdown:

2628

2629* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,

2630 and `textile` input (and is used by default).

2631

2632* `tex_math_dollars`, `tex_math_single_backslash`, and

2633 `tex_math_double_backslash` can be used with `html` input.

2634 (This is handy for reading web pages formatted using MathJax,

2635 for example.)

2636

2637Producing slide shows with Pandoc

2638=================================

2639

2640You can use Pandoc to produce an HTML + javascript slide presentation

2641that can be viewed via a web browser. There are five ways to do this,

2642using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].

2643You can also produce a PDF slide show using LaTeX [beamer].

2644

2645Here's the markdown source for a simple slide show, `habits.txt`:

2646

2647 % Habits

2648 % John Doe

2649 % March 22, 2005

2650

2651 # In the morning

2652

2653 ## Getting up

2654

2655 - Turn off alarm

2656 - Get out of bed

2657

2658 ## Breakfast

2659

2660 - Eat eggs

2661 - Drink coffee

2662

2663 # In the evening

2664

2665 ## Dinner

2666

2667 - Eat spaghetti

2668 - Drink wine

2669

2670 ------------------

2671

2672 ![picture of spaghetti](images/spaghetti.jpg)

2673

2674 ## Going to sleep

2675

2676 - Get in bed

2677 - Count sheep

2678

2679To produce an HTML/javascript slide show, simply type

2680

2681 pandoc -t FORMAT -s habits.txt -o habits.html

2682

2683where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.

2684

2685For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the

2686`-s/--standalone` option embeds a link to javascripts and CSS files, which are

2687assumed to be available at the relative path `s5/default` (for S5), `slideous`

2688(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at

2689`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,

2690`slideous-url`, `revealjs-url`, or `s5-url` variables; see `--variable`,

2691above.) For DZSlides, the (relatively short) javascript and css are included in

2692the file by default.

2693

2694With all HTML slide formats, the `--self-contained` option can be used to

2695produce a single file that contains all of the data necessary to display the

2696slide show, including linked scripts, stylesheets, images, and videos.

2697

2698To produce a PDF slide show using beamer, type

2699

2700 pandoc -t beamer habits.txt -o habits.pdf

2701

2702Note that a reveal.js slide show can also be converted to a PDF

2703by printing it to a file from the browser.

2704

2705Structuring the slide show

2706--------------------------

2707

2708By default, the *slide level* is the highest header level in

2709the hierarchy that is followed immediately by content, and not another

2710header, somewhere in the document. In the example above, level 1 headers

2711are always followed by level 2 headers, which are followed by content,

2712so 2 is the slide level. This default can be overridden using

2713the `--slide-level` option.

2714

2715The document is carved up into slides according to the following

2716rules:

2717

2718 * A horizontal rule always starts a new slide.

2719

2720 * A header at the slide level always starts a new slide.

2721

2722 * Headers *below* the slide level in the hierarchy create

2723 headers *within* a slide.

2724

2725 * Headers *above* the slide level in the hierarchy create

2726 "title slides," which just contain the section title

2727 and help to break the slide show into sections.

2728

2729 * A title page is constructed automatically from the document's title

2730 block, if present. (In the case of beamer, this can be disabled

2731 by commenting out some lines in the default template.)

2732

2733These rules are designed to support many different styles of slide show. If

2734you don't care about structuring your slides into sections and subsections,

2735you can just use level 1 headers for all each slide. (In that case, level 1

2736will be the slide level.) But you can also structure the slide show into

2737sections, as in the example above.

2738

2739Note: in reveal.js slide shows, if slide level is 2, a two-dimensional

2740layout will be produced, with level 1 headers building horizontally

2741and level 2 headers building vertically. It is not recommended that

2742you use deeper nesting of section levels with reveal.js.

2743

2744Incremental lists

2745-----------------

2746

2747By default, these writers produces lists that display "all at once."

2748If you want your lists to display incrementally (one item at a time),

2749use the `-i` option. If you want a particular list to depart from the

2750default (that is, to display incrementally without the `-i` option and

2751all at once with the `-i` option), put it in a block quote:

2752

2753 > - Eat spaghetti

2754 > - Drink wine

2755

2756In this way incremental and nonincremental lists can be mixed in

2757a single document.

2758

2759Inserting pauses

2760----------------

2761

2762You can add "pauses" within a slide by including a paragraph containing

2763three dots, separated by spaces:

2764

2765 # Slide with a pause

2766

2767 content before the pause

2768

2769 . . .

2770

2771 content after the pause

2772

2773Styling the slides

2774------------------

2775

2776You can change the style of HTML slides by putting customized CSS files

2777in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),

2778or `$DATADIR/slideous` (for Slideous),

2779where `$DATADIR` is the user data directory (see `--data-dir`, above).

2780The originals may be found in pandoc's system data directory (generally

2781`$CABALDIR/pandoc-VERSION/s5/default`). Pandoc will look there for any

2782files it does not find in the user data directory.

2783

2784For dzslides, the CSS is included in the HTML file itself, and may

2785be modified there.

2786

2787For reveal.js, themes can be used by setting the `theme` variable,

2788for example:

2789

2790 -V theme=moon

2791

2792Or you can specify a custom stylesheet using the `--css` option.

2793

2794To style beamer slides, you can specify a beamer "theme" or "colortheme"

2795using the `-V` option:

2796

2797 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

2798

2799Note that header attributes will turn into slide attributes

2800(on a `<div>` or `<section>`) in HTML slide formats, allowing you

2801to style individual slides. In Beamer, the only header attribute

2802that affects slides is the `allowframebreaks` class, which sets the

2803`allowframebreaks` option, causing multiple slides to be created

2804if the content overfills the frame. This is recommended especially for

2805bibliographies:

2806

2807 # References {.allowframebreaks}

2808

2809Speaker notes

2810-------------

2811

2812reveal.js has good support for speaker notes. You can add notes to your

2813markdown document thus:

2814

2815 <div class="notes">

2816 This is my note.

2817

2818 - It can contain markdown

2819 - like this list

2820

2821 </div>

2822

2823To show the notes window, press `s` while viewing the presentation.

2824Notes are not yet supported for other slide formats, but the notes

2825will not appear on the slides themselves.

2826

2827EPUB Metadata

2828=============

2829

2830EPUB metadata may be specified using the `--epub-metadata` option, but

2831if the source document is markdown, it is better to use a YAML metadata

2832block. Here is an example:

2833

2834 ---

2835 title:

2836 - type: main

2837 text: My Book

2838 - type: subtitle

2839 text: An investigation of metadata

2840 creator:

2841 - role: author

2842 text: John Smith

2843 - role: editor

2844 text: Sarah Jones

2845 identifier:

2846 - scheme: DOI

2847 text: doi:10.234234.234/33

2848 publisher: My Press

2850 ...

2851

2852The following fields are recognized:

2853

2854`identifier`

2855 ~ Either a string value or an object with fields `text` and

2856 `scheme`. Valid values for `scheme` are `ISBN-10`,

2857 `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,

2858 `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,

2859 `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.

2860`title`

2861 ~ Either a string value, or an object with fields `file-as` and

2862 `type`, or a list of such objects. Valid values for `type` are

2863 `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.

2864`creator`

2865 ~ Either a string value, or an object with fields `role`, `file-as`,

2866 and `text`, or a list of such objects. Valid values for `role` are

2867 [marc relators](http://www.loc.gov/marc/relators/relaterm.html), but

2868 pandoc will attempt to translate the human-readable versions

2869 (like "author" and "editor") to the appropriate marc relators.

2870`contributor`

2871 ~ Same format as `creator`.

2872`date`

2873 ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)

2874 Pandoc will attempt to convert other common date formats.

2875`language`

2876 ~ A string value in [RFC5646] format. Pandoc will default to the local

2877 language if nothing is specified.

2878`subject`

2879 ~ A string value or a list of such values.

2880`description`

2881 ~ A string value.

2882`type`

2883 ~ A string value.

2884`format`

2885 ~ A string value.

2886`relation`

2887 ~ A string value.

2888`coverage`

2889 ~ A string value.

2890`rights`

2891 ~ A string value.

2892`cover-image`

2893 ~ A string value (path to cover image).

2894`stylesheet`

2895 ~ A string value (path to CSS stylesheet).

2896

2897Literate Haskell support

2898========================

2899

2900If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output

2901format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;

2902`beamer`, `html` or `html5` for output only), pandoc will treat the document as

2903literate Haskell source. This means that

2904

2905 - In markdown input, "bird track" sections will be parsed as Haskell

2906 code rather than block quotations. Text between `\begin{code}`

2907 and `\end{code}` will also be treated as Haskell code.

2908

2909 - In markdown output, code blocks with classes `haskell` and `literate`

2910 will be rendered using bird tracks, and block quotations will be

2911 indented one space, so they will not be treated as Haskell code.

2912 In addition, headers will be rendered setext-style (with underlines)

2913 rather than atx-style (with '#' characters). (This is because ghc

2914 treats '#' characters in column 1 as introducing line numbers.)

2915

2916 - In restructured text input, "bird track" sections will be parsed

2917 as Haskell code.

2918

2919 - In restructured text output, code blocks with class `haskell` will

2920 be rendered using bird tracks.

2921

2922 - In LaTeX input, text in `code` environments will be parsed as

2923 Haskell code.

2924

2925 - In LaTeX output, code blocks with class `haskell` will be rendered

2926 inside `code` environments.

2927

2928 - In HTML output, code blocks with class `haskell` will be rendered

2929 with class `literatehaskell` and bird tracks.

2930

2931Examples:

2932

2933 pandoc -f markdown+lhs -t html

2934

2935reads literate Haskell source formatted with markdown conventions and writes

2936ordinary HTML (without bird tracks).

2937

2938 pandoc -f markdown+lhs -t html+lhs

2939

2940writes HTML with the Haskell code in bird tracks, so it can be copied

2941and pasted as literate Haskell source.

2942

2943Custom writers

2944==============

2945

2946Pandoc can be extended with custom writers written in [lua]. (Pandoc

2947includes a lua interpreter, so lua need not be installed separately.)

2948

2949To use a custom writer, simply specify the path to the lua script

2950in place of the output format. For example:

2951

2952 pandoc -t data/sample.lua

2953

2954Creating a custom writer requires writing a lua function for each

2955possible element in a pandoc document. To get a documented example

2956which you can modify according to your needs, do

2957

2958 pandoc --print-default-data-file sample.lua

2959

2960Authors

2961=======

2962

2964[GPL], version 2 or greater. This software carries no warranty of

2965any kind. (See COPYRIGHT for full copyright and warranty notices.)

2966Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,

2967Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,

2968Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,

2969Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,

2970Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine

2971Latter, Ralf Stephan, Eric Seidel, B. Scott Michel, Gavin Beatty,

2972Sergey Astanin, Arlo O'Keeffe, Denis Laxalde, Brent Yorgey, David Lazar,

2973Jamie F. Olson, Matthew Pickering, Albert Krewinkel, mb21, Jesse

2974Rosenthal.

2975

2976[markdown]: http://daringfireball.net/projects/markdown/

2977[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html

2978[S5]: http://meyerweb.com/eric/tools/s5/

2979[Slidy]: http://www.w3.org/Talks/Tools/Slidy/

2980[Slideous]: http://goessner.net/articles/slideous/

2981[HTML]: http://www.w3.org/TR/html40/

2982[HTML 5]: http://www.w3.org/TR/html5/

2983[XHTML]: http://www.w3.org/TR/xhtml1/

2984[LaTeX]: http://www.latex-project.org/

2985[beamer]: http://www.tex.ac.uk/CTAN/macros/latex/contrib/beamer

2986[ConTeXt]: http://www.pragma-ade.nl/

2987[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format

2988[DocBook]: http://www.docbook.org/

2989[OPML]: http://dev.opml.org/spec2.html

2990[OpenDocument]: http://opendocument.xml.org/

2991[ODT]: http://en.wikipedia.org/wiki/OpenDocument

2992[Textile]: http://redcloth.org/textile

2993[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting

2994[Haddock markup]: http://www.haskell.org/haddock/doc/html/ch03s08.html

2995[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html

2996[Haskell]: http://www.haskell.org/

2997[GNU Texinfo]: http://www.gnu.org/software/texinfo/

2998[Emacs Org-Mode]: http://orgmode.org

2999[AsciiDoc]: http://www.methods.co.nz/asciidoc/

3000[EPUB]: http://www.idpf.org/

3001[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

3002[DZSlides]: http://paulrouget.com/dzslides/

3003[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime

3004[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx

3005[PDF]: http://www.adobe.com/pdf/

3006[reveal.js]: http://lab.hakim.se/reveal-js/

3007[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

3008[lua]: http://www.lua.org

3009[marc relators]: http://www.loc.gov/marc/relators/relaterm.html

3010[RFC5646]: http://tools.ietf.org/html/rfc5646

3011[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf