README · typeable/pandoc

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

1432

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

1434

1435

1436### Numbered example lists ###

1437

1438**Extension: `example_lists`**

1439

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

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

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

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

1444where the last stopped. So, for example:

1445

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

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

1448

1449 Explanation of examples.

1450

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

1452

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

1454document:

1455

1456 (@good) This is a good example.

1457

1458 As (@good) illustrates, ...

1459

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

1461or hyphens.

1462

1463

1464### Compact and loose lists ###

1465

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

1467cases" involving lists. Consider this source:

1468

1469 + First

1470 + Second:

1471 - Fee

1472 - Fie

1473 - Foe

1474

1475 + Third

1476

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

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

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

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

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

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

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

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

1485behavior is consistent with the official markdown syntax description,

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

1487

1488

1489### Ending a list ###

1490

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

1492

1493 - item one

1494 - item two

1495

1496 { my code block }

1497

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

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

1500a code block.

1501

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

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

1504any format:

1505

1506 - item one

1507 - item two

1508

1509

1510

1511 { my code block }

1512

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

1514of one big list:

1515

1516 1. one

1517 2. two

1518 3. three

1519

1520

1521

1522 1. uno

1523 2. dos

1524 3. tres

1525

1526Horizontal rules

1527----------------

1528

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

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

1532 * * * *

1534 ---------------

1537Tables

1538------

1539

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

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

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

1543

1544### Simple tables

1545

1546**Extension: `simple_tables`, `table_captions`**

1547

1548Simple tables look like this:

1549

1550 Right Left Center Default

1551 ------- ------ ---------- -------

1552 12 12 12 12

1553 123 123 123 123

1554 1 1 1 1

1555

1556 Table: Demonstration of simple table syntax.

1557

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

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

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

1561

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

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

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

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

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

1567 the column is centered.

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

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

1570

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

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

1573

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

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

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

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

1578before or after the table.

1579

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

1581to end the table. For example:

1582

1583 ------- ------ ---------- -------

1584 12 12 12 12

1585 123 123 123 123

1586 1 1 1 1

1587 ------- ------ ---------- -------

1588

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

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

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

1592

1593### Multiline tables

1594

1595**Extension: `multiline_tables`, `table_captions`**

1596

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

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

1599not supported). Here is an example:

1600

1601 -------------------------------------------------------------

1602 Centered Default Right Left

1603 Header Aligned Aligned Aligned

1604 ----------- ------- --------------- -------------------------

1605 First row 12.0 Example of a row that

1606 spans multiple lines.

1607

1608 Second row 5.0 Here's another one. Note

1609 the blank line between

1610 rows.

1611 -------------------------------------------------------------

1612

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

1614 multiple lines.

1615

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

1617

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

1619 (unless the headers are omitted).

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

1621 - The rows must be separated by blank lines.

1622

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

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

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

1626output, try widening it in the markdown source.

1627

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

1629

1630 ----------- ------- --------------- -------------------------

1631 First row 12.0 Example of a row that

1632 spans multiple lines.

1633

1634 Second row 5.0 Here's another one. Note

1635 the blank line between

1636 rows.

1637 ----------- ------- --------------- -------------------------

1638

1639 : Here's a multiline table without headers.

1640

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

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

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

1644

1645### Grid tables

1646

1647**Extension: `grid_tables`, `table_captions`**

1648

1649Grid tables look like this:

1650

1651 : Sample grid table.

1652

1653 +---------------+---------------+--------------------+

1654 | Fruit | Price | Advantages |

1655 +===============+===============+====================+

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

1657 | | | - bright color |

1658 +---------------+---------------+--------------------+

1659 | Oranges | $2.10 | - cures scurvy |

1660 | | | - tasty |

1661 +---------------+---------------+--------------------+

1662

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

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

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

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

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

1668

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

1670

1671### Pipe tables

1672

1673**Extension: `pipe_tables`, `table_captions`**

1674

1675Pipe tables look like this:

1676

1678 |------:|:-----|---------|:------:|

1679 | 12 | 12 | 12 | 12 |

1680 | 123 | 123 | 123 | 123 |

1681 | 1 | 1 | 1 | 1 |

1682

1683 : Demonstration of simple table syntax.

1684

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

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

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

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

1689it defines column alignments.

1690

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

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

1693legal (though ugly) pipe table:

1694

1695 fruit| price

1696 -----|-----:

1697 apple|2.05

1698 pear|1.37

1699 orange|3.09

1700

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

1702and lists, and cannot span multiple lines.

1703

1704 [the same as in PHP markdown extra]:

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

1706

1707Note: Pandoc also recognizes pipe tables of the following

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

1709

1710 | One | Two |

1711 |-----+-------|

1712 | my | table |

1713 | is | nice |

1714

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

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

1717you'll need to add colons as above.

1718

1719Title block

1720-----------

1721

1722**Extension: `pandoc_title_block`**

1723

1724If the file begins with a title block

1725

1726 % title

1727 % author(s) (separated by semicolons)

1728 % date

1729

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

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

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

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

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

1735

1736 %

1737 % Author

1738

1739 % My title

1740 %

1741 % June 15, 2006

1742

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

1744begin with leading space, thus:

1745

1746 % My title

1747 on multiple lines

1748

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

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

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

1752

1753 % Author One

1754 Author Two

1755

1756 % Author One; Author Two

1757

1758 % Author One;

1759 Author Two

1760

1761The date must fit on one line.

1762

1763All three metadata fields may contain standard inline formatting

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

1765

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

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

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

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

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

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

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

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

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

1775be used by itself as the HTML title.

1776

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

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

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

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

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

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

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

1784text. Thus,

1785

1786 % PANDOC(1)

1787

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

1789

1790 % PANDOC(1) Pandoc User Manuals

1791

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

1793

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

1795

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

1797

1798YAML metadata block

1799-------------------

1800

1801**Extension: `yaml_metadata_block`**

1802

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

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

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

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

1807line.

1808

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

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

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

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

1813given a role by external processors.)

1814

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

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

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

1818

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

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

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

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

1823when the field contains blank lines:

1824

1825 ---

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

1827 author:

1828 - name: Author One

1829 affiliation: University of Somewhere

1830 - name: Author Two

1831 affiliation: University of Nowhere

1832 tags: [nothing, nothingness]

1833 abstract: |

1834 This is the abstract.

1835

1836 It consists of two paragraphs.

1837 ...

1838

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

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

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

1842

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

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

1845

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

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

1848custom template. For example:

1849

1850 $for(author)$

1851 $if(author.name)$

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

1853 $else$

1854 $author$

1855 $endif$

1856 $endfor$

1857

1858

1859Backslash escapes

1860-----------------

1861

1862**Extension: `all_symbols_escapable`**

1863

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

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

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

1867

1868 *\*hello\**

1869

1870one will get

1871

1872 <em>*hello*</em>

1873

1874instead of

1875

1876 <strong>hello</strong>

1877

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

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

1880

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

1882

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

1884will be used.)

1885

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

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

1888`\ `.

1889

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

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

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

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

1894two trailing spaces on a line.

1895

1896Backslash escapes do not work in verbatim contexts.

1897

1898Smart punctuation

1899-----------------

1900

1901**Extension**

1902

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

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

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

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

1907

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

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

1910

1911Inline formatting

1912-----------------

1913

1914### Emphasis ###

1915

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

1917

1918 This text is _emphasized with underscores_, and this

1919 is *emphasized with asterisks*.

1920

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

1922

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

1924

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

1926will not trigger emphasis:

1927

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

1929

1930**Extension: `intraword_underscores`**

1931

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

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

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

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

1936

1937 feas*ible*, not feas*able*.

1938

1939

1940### Strikeout ###

1941

1942**Extension: `strikeout`**

1943

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

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

1946

1947 This ~~is deleted text.~~

1948

1949

1950### Superscripts and subscripts ###

1951

1952**Extension: `superscript`, `subscript`**

1953

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

1955characters; subscripts may be written by surrounding the subscripted

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

1957

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

1959

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

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

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

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

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

1965

1966

1967### Verbatim ###

1968

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

1970

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

1972

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

1974

1975 Here is a literal backtick `` ` ``.

1976

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

1978backticks will be ignored.)

1979

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

1981of consecutive backticks (optionally followed by a space)

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

1983preceded by a space).

1984

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

1986work in verbatim contexts:

1987

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

1989

1990**Extension: `inline_code_attributes`**

1991

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

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

1994

1995 `<$>`{.haskell}

1996

1997Math

1998----

1999

2000**Extension: `tex_math_dollars`**

2001

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

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

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

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

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

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

2008

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

2010depends on the output format:

2011

2012Markdown, LaTeX, Org-Mode, ConTeXt

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

2014

2015reStructuredText

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

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

2018

2019AsciiDoc

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

2021

2022Texinfo

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

2024

2025groff man

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

2027

2028MediaWiki

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

2030

2031Textile

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

2033

2034RTF, OpenDocument, ODT

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

2036 and will otherwise appear verbatim.

2037

2038Docbook

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

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

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

2042

2043Docx

2044 ~ It will be rendered using OMML math markup.

2045

2046FictionBook2

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

2048 using Google Charts or other compatible web service, downloaded

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

2050

2051HTML, Slidy, DZSlides, S5, EPUB

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

2053 command-line options selected:

2054

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

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

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

2058 styled differently from the surrounding text if needed.

2059

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

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

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

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

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

2065 verbatim between `$` characters.)

2066

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

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

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

2070 it.

2071

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

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

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

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

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

2077

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

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

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

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

2082 procedure is:

2083

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

2085 gladtex -d myfile-images myfile.htex

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

2087

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

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

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

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

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

2093

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

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

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

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

2098

2099Raw HTML

2100--------

2101

2102**Extension: `raw_html`**

2103

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

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

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

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

2108be disabled if desired.)

2109

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

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

2112formats.

2113

2114**Extension: `markdown_in_html_blocks`**

2115

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

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

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

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

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

2121

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

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

2124Thus, for example, Pandoc will turn

2125

2126 <table>

2127 <tr>

2128 <td>*one*</td>

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

2130 </tr>

2131 </table>

2132

2133into

2134

2135 <table>

2136 <tr>

2137 <td><em>one</em></td>

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

2139 </tr>

2140 </table>

2141

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

2143

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

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

2146

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

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

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

2150from being interpreted as markdown.

2151

2152Raw TeX

2153-------

2154

2155**Extension: `raw_tex`**

2156

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

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

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

2160LaTeX to include BibTeX citations:

2161

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

2163

2164Note that in LaTeX environments, like

2165

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

2167 Age & Frequency \\ \hline

2168 18--25 & 15 \\

2169 26--35 & 33 \\

2170 36--45 & 22 \\ \hline

2171 \end{tabular}

2172

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

2174LaTeX, not as markdown.

2175

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

2177and ConTeXt.

2178

2179LaTeX macros

2180------------

2181

2182**Extension: `latex_macros`**

2183

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

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

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

2187not just LaTeX:

2188

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

2190

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

2192

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

2194unchanged to the output.

2195

2196

2197Links

2198-----

2199

2200Markdown allows links to be specified in several ways.

2201

2202### Automatic links ###

2203

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

2205will become a link:

2206

2207 <http://google.com>

2208 <sam@green.eggs.ham>

2209

2210### Inline links ###

2211

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

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

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

2215

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

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

2218

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

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

2221

2222

2223### Reference links ###

2224

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

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

2227before or after the link).

2228

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

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

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

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

2233parentheses.

2234

2235Here are some examples:

2236

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

2238 [my label 2]: /foo

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

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

2241

2242The URL may optionally be surrounded by angle brackets:

2243

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

2245

2246The title may go on the next line:

2247

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

2249 "The free software foundation"

2250

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

2252

2253 Here is [my link][FOO]

2254

2255 [Foo]: /bar/baz

2256

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

2258empty, or omitted entirely:

2259

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

2261

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

2263

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

2265reference link definitions cannot occur in nested constructions

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

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

2268not in most other implementations:

2269

2270 > My block [quote].

2271 >

2272 > [quote]: /foo

2273

2274### Internal links

2275

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

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

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

2279For example:

2280

2281 See the [Introduction](#introduction).

2282

2283or

2284

2285 See the [Introduction].

2286

2287 [Introduction]: #introduction

2288

2289Internal links are currently supported for HTML formats (including

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

2291

2292Images

2293------

2294

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

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

2297

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

2299

2300 ![movie reel]

2301

2302 [movie reel]: movie.gif

2303

2304### Pictures with captions ###

2305

2306**Extension: `implicit_figures`**

2307

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

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

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

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

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

2313

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

2315

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

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

2318 itself, with no caption.

2319

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

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

2322nonbreaking space after the image:

2323

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

2325

2326

2327Footnotes

2328---------

2329

2330**Extension: `footnotes`**

2331

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

2333

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

2335

2336 [^1]: Here is the footnote.

2337

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

2339

2340 Subsequent paragraphs are indented to show that they

2341 belong to the previous footnote.

2342

2343 { some.code }

2344

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

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

2347 multi-paragraph list items.

2348

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

2350 isn't indented.

2351

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

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

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

2355will be numbered sequentially.

2356

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

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

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

2360

2361**Extension: `inline_notes`**

2362

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

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

2365

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

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

2368 note.]

2369

2370Inline and regular footnotes may be mixed freely.

2371

2372

2373Citations

2374---------

2375

2376**Extension: `citations`**

2377

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

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

2380

2381 pandoc --filter pandoc-citeproc myinput.txt

2382

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

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

2385The bibliography may have any of these formats:

2386

2387 Format File extension

2388 ------------ --------------

2389 MODS .mods

2390 BibLaTeX .bib

2391 BibTeX .bibtex

2392 RIS .ris

2393 EndNote .enl

2394 EndNote XML .xml

2395 ISI .wos

2396 MEDLINE .medline

2397 Copac .copac

2398 JSON citeproc .json

2399

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

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

2402

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

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

2405for example:

2406

2407 ---

2408 references:

2409 - id: fenner2012a

2410 title: One-click science marketing

2411 author:

2412 - family: Fenner

2413 given: Martin

2414 container-title: Nature Materials

2415 volume: 11

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

2417 DOI: 10.1038/nmat3283

2418 issue: 4

2419 publisher: Nature Publishing Group

2420 page: 261-263

2421 type: article-journal

2422 issued:

2423 year: 2012

2424 month: 3

2425 ...

2426

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

2428these from a MODS reference collection.)

2429

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

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

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

2433modifying CSL styles can be found at

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

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

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

2437

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

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

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

2441a locator, and a suffix. Here are some examples:

2442

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

2444

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

2446

2447 Blah blah [@smith04; @doe99].

2448

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

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

2451author is already mentioned in the text:

2452

2453 Smith says blah [-@smith04].

2454

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

2456

2457 @smith04 says blah.

2458

2459 @smith04 [p. 33] says blah.

2460

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

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

2463document with an appropriate header:

2464

2465 last paragraph...

2466

2467 # References

2468

2469The bibliography will be inserted after this header.

2470

2471Non-pandoc extensions

2472---------------------

2473

2474The following markdown syntax extensions are not enabled by default

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

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

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

2478

2479**Extension: `lists_without_preceding_blankline`**\

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

2481blank space.

2482

2483**Extension: `hard_line_breaks`**\

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

2485breaks instead of spaces.

2486

2487**Extension: `ignore_line_breaks`**\

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

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

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

2491but text is divided into lines for readability.

2492

2493**Extension: `tex_math_single_backslash`**\

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

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

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

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

2498

2499**Extension: `tex_math_double_backslash`**\

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

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

2502as display TeX math.

2503

2504**Extension: `markdown_attribute`**\

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

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

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

2508

2509**Extension: `mmd_title_block`**\

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

2511the document, for example:

2512

2513 Title: My title

2514 Author: John Doe

2515 Date: September 1, 2008

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

2517 a field spanning multiple lines.

2518

2519See the MultiMarkdown documentation for details. Note that only title,

2520author, and date are recognized; other fields are simply ignored by

2521pandoc. If `pandoc_title_block` or `yaml_metadata_block` is enabled,

2522it will take precedence over `mmd_title_block`.

2523

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

2525

2526**Extension: `abbreviations`**\

2527Parses PHP Markdown Extra abbreviation keys, like

2528

2529 *[HTML]: Hyper Text Markup Language

2530

2531Note that the pandoc document model does not support

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

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

2534

2535**Extension: `autolink_bare_uris`**\

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

2537pointy braces `<...>`.

2538

2539**Extension: `ascii_identifiers`**\

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

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

2542letters are omitted.

2543

2544**Extension: `link_attributes`**\

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

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

2547these, so they are presently just ignored.

2548

2549**Extension: `mmd_header_identifiers`**\

2550Parses multimarkdown style header identifiers (in square brackets,

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

2552

2553Markdown variants

2554-----------------

2555

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

2557variants are supported:

2558

2559`markdown_phpextra` (PHP Markdown Extra)

2560: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

2561 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

2562 `header_attributes`, `abbreviations`.

2563

2564`markdown_github` (Github-flavored Markdown)

2565: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,

2566 `fenced_code_blocks`, `fenced_code_attributes`, `auto_identifiers`,

2567 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

2568 `intraword_underscores`, `strikeout`, `hard_line_breaks`

2569

2570`markdown_mmd` (MultiMarkdown)

2571: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,

2572 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,

2573 `mmd_title_block`, `footnotes`, `definition_lists`,

2574 `all_symbols_escapable`, `implicit_header_references`,

2575 `auto_identifiers`, `mmd_header_identifiers`

2576

2577`markdown_strict` (Markdown.pl)

2578: `raw_html`

2579

2580Extensions with formats other than markdown

2581-------------------------------------------

2582

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

2584other than markdown:

2585

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

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

2588

2589* `tex_math_dollars`, `tex_math_single_backslash`, and

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

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

2592 for example.)

2593

2594Producing slide shows with Pandoc

2595=================================

2596

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

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

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

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

2601

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

2603

2604 % Habits

2605 % John Doe

2606 % March 22, 2005

2607

2608 # In the morning

2609

2610 ## Getting up

2611

2612 - Turn off alarm

2613 - Get out of bed

2614

2615 ## Breakfast

2616

2617 - Eat eggs

2618 - Drink coffee

2619

2620 # In the evening

2621

2622 ## Dinner

2623

2624 - Eat spaghetti

2625 - Drink wine

2626

2627 ------------------

2628

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

2630

2631 ## Going to sleep

2632

2633 - Get in bed

2634 - Count sheep

2635

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

2637

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

2639

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

2641

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

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

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

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

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

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

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

2649the file by default.

2650

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

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

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

2654

2655To produce a PDF slide show using beamer, type

2656

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

2658

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

2660by printing it to a file from the browser.

2661

2662Structuring the slide show

2663--------------------------

2664

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

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

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

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

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

2670the `--slide-level` option.

2671

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

2673rules:

2674

2675 * A horizontal rule always starts a new slide.

2676

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

2678

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

2680 headers *within* a slide.

2681

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

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

2684 and help to break the slide show into sections.

2685

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

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

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

2689

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

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

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

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

2694sections, as in the example above.

2695

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

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

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

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

2700

2701Incremental lists

2702-----------------

2703

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

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

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

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

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

2709

2710 > - Eat spaghetti

2711 > - Drink wine

2712

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

2714a single document.

2715

2716Inserting pauses

2717----------------

2718

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

2720three dots, separated by spaces:

2721

2722 # Slide with a pause

2723

2724 content before the pause

2725

2726 . . .

2727

2728 content after the pause

2729

2730Styling the slides

2731------------------

2732

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

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

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

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

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

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

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

2740

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

2742be modified there.

2743

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

2745for example:

2746

2747 -V theme=moon

2748

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

2750

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

2752using the `-V` option:

2753

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

2755

2756Note that header attributes will turn into slide attributes

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

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

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

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

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

2762bibliographies:

2763

2764 # References {.allowframebreaks}

2765

2766Speaker notes

2767-------------

2768

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

2770markdown document thus:

2771

2772 <div class="notes">

2773 This is my note.

2774

2775 - It can contain markdown

2776 - like this list

2777

2778 </div>

2779

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

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

2782will not appear on the slides themselves.

2783

2784EPUB Metadata

2785=============

2786

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

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

2789block. Here is an example:

2790

2791 ---

2792 title:

2793 - type: main

2794 text: My Book

2795 - type: subtitle

2796 text: An investigation of metadata

2797 creator:

2798 - role: author

2799 text: John Smith

2800 - role: editor

2801 text: Sarah Jones

2802 identifier:

2803 - scheme: DOI

2804 text: doi:10.234234.234/33

2805 publisher: My Press

2807 ...

2808

2809The following fields are recognized:

2810

2811`identifier`

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

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

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

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

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

2817`title`

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

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

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

2821`creator`

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

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

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

2825 pandoc will attempt to translate the human-readable versions

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

2827`contributor`

2828 ~ Same format as `creator`.

2829`date`

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

2831 Pandoc will attempt to convert other common date formats.

2832`language`

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

2834 language if nothing is specified.

2835`subject`

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

2837`description`

2838 ~ A string value.

2839`type`

2840 ~ A string value.

2841`format`

2842 ~ A string value.

2843`relation`

2844 ~ A string value.

2845`coverage`

2846 ~ A string value.

2847`rights`

2848 ~ A string value.

2849`cover-image`

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

2851`stylesheet`

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

2853

2854Literate Haskell support

2855========================

2856

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

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

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

2860literate Haskell source. This means that

2861

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

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

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

2865

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

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

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

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

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

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

2872

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

2874 as Haskell code.

2875

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

2877 be rendered using bird tracks.

2878

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

2880 Haskell code.

2881

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

2883 inside `code` environments.

2884

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

2886 with class `literatehaskell` and bird tracks.

2887

2888Examples:

2889

2890 pandoc -f markdown+lhs -t html

2891

2892reads literate Haskell source formatted with markdown conventions and writes

2893ordinary HTML (without bird tracks).

2894

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

2896

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

2898and pasted as literate Haskell source.

2899

2900Custom writers

2901==============

2902

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

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

2905

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

2907in place of the output format. For example:

2908

2909 pandoc -t data/sample.lua

2910

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

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

2913which you can modify according to your needs, do

2914

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

2916

2917Authors

2918=======

2919

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

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

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

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

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

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

2927Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine

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

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

2930Jamie F. Olson.

2931

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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