README · typeable/pandoc

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

1438

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

1440

1441

1442### Numbered example lists ###

1443

1444**Extension: `example_lists`**

1445

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

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

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

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

1450where the last stopped. So, for example:

1451

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

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

1454

1455 Explanation of examples.

1456

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

1458

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

1460document:

1461

1462 (@good) This is a good example.

1463

1464 As (@good) illustrates, ...

1465

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

1467or hyphens.

1468

1469

1470### Compact and loose lists ###

1471

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

1473cases" involving lists. Consider this source:

1474

1475 + First

1476 + Second:

1477 - Fee

1478 - Fie

1479 - Foe

1480

1481 + Third

1482

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

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

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

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

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

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

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

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

1491behavior is consistent with the official markdown syntax description,

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

1493

1494

1495### Ending a list ###

1496

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

1498

1499 - item one

1500 - item two

1501

1502 { my code block }

1503

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

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

1506a code block.

1507

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

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

1510any format:

1511

1512 - item one

1513 - item two

1514

1515

1516

1517 { my code block }

1518

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

1520of one big list:

1521

1522 1. one

1523 2. two

1524 3. three

1525

1526

1527

1528 1. uno

1529 2. dos

1530 3. tres

1531

1532Horizontal rules

1533----------------

1534

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

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

1538 * * * *

1540 ---------------

1543Tables

1544------

1545

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

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

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

1549

1550### Simple tables

1551

1552**Extension: `simple_tables`, `table_captions`**

1553

1554Simple tables look like this:

1555

1556 Right Left Center Default

1557 ------- ------ ---------- -------

1558 12 12 12 12

1559 123 123 123 123

1560 1 1 1 1

1561

1562 Table: Demonstration of simple table syntax.

1563

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

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

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

1567

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

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

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

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

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

1573 the column is centered.

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

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

1576

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

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

1579

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

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

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

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

1584before or after the table.

1585

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

1587to end the table. For example:

1588

1589 ------- ------ ---------- -------

1590 12 12 12 12

1591 123 123 123 123

1592 1 1 1 1

1593 ------- ------ ---------- -------

1594

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

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

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

1598

1599### Multiline tables

1600

1601**Extension: `multiline_tables`, `table_captions`**

1602

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

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

1605not supported). Here is an example:

1606

1607 -------------------------------------------------------------

1608 Centered Default Right Left

1609 Header Aligned Aligned Aligned

1610 ----------- ------- --------------- -------------------------

1611 First row 12.0 Example of a row that

1612 spans multiple lines.

1613

1614 Second row 5.0 Here's another one. Note

1615 the blank line between

1616 rows.

1617 -------------------------------------------------------------

1618

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

1620 multiple lines.

1621

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

1623

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

1625 (unless the headers are omitted).

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

1627 - The rows must be separated by blank lines.

1628

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

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

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

1632output, try widening it in the markdown source.

1633

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

1635

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

1637 First row 12.0 Example of a row that

1638 spans multiple lines.

1639

1640 Second row 5.0 Here's another one. Note

1641 the blank line between

1642 rows.

1643 ----------- ------- --------------- -------------------------

1644

1645 : Here's a multiline table without headers.

1646

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

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

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

1650

1651### Grid tables

1652

1653**Extension: `grid_tables`, `table_captions`**

1654

1655Grid tables look like this:

1656

1657 : Sample grid table.

1658

1659 +---------------+---------------+--------------------+

1660 | Fruit | Price | Advantages |

1661 +===============+===============+====================+

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

1663 | | | - bright color |

1664 +---------------+---------------+--------------------+

1665 | Oranges | $2.10 | - cures scurvy |

1666 | | | - tasty |

1667 +---------------+---------------+--------------------+

1668

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

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

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

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

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

1674

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

1676

1677### Pipe tables

1678

1679**Extension: `pipe_tables`, `table_captions`**

1680

1681Pipe tables look like this:

1682

1684 |------:|:-----|---------|:------:|

1685 | 12 | 12 | 12 | 12 |

1686 | 123 | 123 | 123 | 123 |

1687 | 1 | 1 | 1 | 1 |

1688

1689 : Demonstration of simple table syntax.

1690

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

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

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

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

1695it defines column alignments.

1696

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

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

1699legal (though ugly) pipe table:

1700

1701 fruit| price

1702 -----|-----:

1703 apple|2.05

1704 pear|1.37

1705 orange|3.09

1706

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

1708and lists, and cannot span multiple lines.

1709

1710 [the same as in PHP markdown extra]:

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

1712

1713Note: Pandoc also recognizes pipe tables of the following

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

1715

1716 | One | Two |

1717 |-----+-------|

1718 | my | table |

1719 | is | nice |

1720

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

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

1723you'll need to add colons as above.

1724

1725Title block

1726-----------

1727

1728**Extension: `pandoc_title_block`**

1729

1730If the file begins with a title block

1731

1732 % title

1733 % author(s) (separated by semicolons)

1734 % date

1735

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

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

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

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

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

1741

1742 %

1743 % Author

1744

1745 % My title

1746 %

1747 % June 15, 2006

1748

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

1750begin with leading space, thus:

1751

1752 % My title

1753 on multiple lines

1754

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

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

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

1758

1759 % Author One

1760 Author Two

1761

1762 % Author One; Author Two

1763

1764 % Author One;

1765 Author Two

1766

1767The date must fit on one line.

1768

1769All three metadata fields may contain standard inline formatting

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

1771

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

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

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

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

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

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

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

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

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

1781be used by itself as the HTML title.

1782

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

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

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

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

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

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

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

1790text. Thus,

1791

1792 % PANDOC(1)

1793

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

1795

1796 % PANDOC(1) Pandoc User Manuals

1797

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

1799

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

1801

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

1803

1804YAML metadata block

1805-------------------

1806

1807**Extension: `yaml_metadata_block`**

1808

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

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

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

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

1813line.

1814

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

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

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

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

1819given a role by external processors.)

1820

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

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

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

1824

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

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

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

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

1829when the field contains blank lines:

1830

1831 ---

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

1833 author:

1834 - name: Author One

1835 affiliation: University of Somewhere

1836 - name: Author Two

1837 affiliation: University of Nowhere

1838 tags: [nothing, nothingness]

1839 abstract: |

1840 This is the abstract.

1841

1842 It consists of two paragraphs.

1843 ...

1844

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

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

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

1848

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

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

1851

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

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

1854custom template. For example:

1855

1856 $for(author)$

1857 $if(author.name)$

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

1859 $else$

1860 $author$

1861 $endif$

1862 $endfor$

1863

1864

1865Backslash escapes

1866-----------------

1867

1868**Extension: `all_symbols_escapable`**

1869

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

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

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

1873

1874 *\*hello\**

1875

1876one will get

1877

1878 <em>*hello*</em>

1879

1880instead of

1881

1882 <strong>hello</strong>

1883

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

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

1886

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

1888

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

1890will be used.)

1891

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

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

1894`\ `.

1895

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

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

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

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

1900two trailing spaces on a line.

1901

1902Backslash escapes do not work in verbatim contexts.

1903

1904Smart punctuation

1905-----------------

1906

1907**Extension**

1908

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

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

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

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

1913

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

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

1916

1917Inline formatting

1918-----------------

1919

1920### Emphasis ###

1921

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

1923

1924 This text is _emphasized with underscores_, and this

1925 is *emphasized with asterisks*.

1926

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

1928

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

1930

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

1932will not trigger emphasis:

1933

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

1935

1936**Extension: `intraword_underscores`**

1937

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

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

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

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

1942

1943 feas*ible*, not feas*able*.

1944

1945

1946### Strikeout ###

1947

1948**Extension: `strikeout`**

1949

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

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

1952

1953 This ~~is deleted text.~~

1954

1955

1956### Superscripts and subscripts ###

1957

1958**Extension: `superscript`, `subscript`**

1959

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

1961characters; subscripts may be written by surrounding the subscripted

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

1963

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

1965

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

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

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

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

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

1971

1972

1973### Verbatim ###

1974

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

1976

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

1978

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

1980

1981 Here is a literal backtick `` ` ``.

1982

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

1984backticks will be ignored.)

1985

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

1987of consecutive backticks (optionally followed by a space)

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

1989preceded by a space).

1990

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

1992work in verbatim contexts:

1993

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

1995

1996**Extension: `inline_code_attributes`**

1997

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

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

2000

2001 `<$>`{.haskell}

2002

2003Math

2004----

2005

2006**Extension: `tex_math_dollars`**

2007

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

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

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

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

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

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

2014

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

2016depends on the output format:

2017

2018Markdown, LaTeX, Org-Mode, ConTeXt

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

2020

2021reStructuredText

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

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

2024

2025AsciiDoc

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

2027

2028Texinfo

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

2030

2031groff man

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

2033

2034MediaWiki

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

2036

2037Textile

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

2039

2040RTF, OpenDocument, ODT

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

2042 and will otherwise appear verbatim.

2043

2044Docbook

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

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

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

2048

2049Docx

2050 ~ It will be rendered using OMML math markup.

2051

2052FictionBook2

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

2054 using Google Charts or other compatible web service, downloaded

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

2056

2057HTML, Slidy, DZSlides, S5, EPUB

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

2059 command-line options selected:

2060

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

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

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

2064 styled differently from the surrounding text if needed.

2065

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

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

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

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

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

2071 verbatim between `$` characters.)

2072

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

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

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

2076 it.

2077

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

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

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

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

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

2083

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

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

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

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

2088 procedure is:

2089

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

2091 gladtex -d myfile-images myfile.htex

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

2093

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

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

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

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

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

2099

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

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

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

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

2104

2105Raw HTML

2106--------

2107

2108**Extension: `raw_html`**

2109

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

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

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

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

2114be disabled if desired.)

2115

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

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

2118formats.

2119

2120**Extension: `markdown_in_html_blocks`**

2121

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

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

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

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

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

2127

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

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

2130Thus, for example, Pandoc will turn

2131

2132 <table>

2133 <tr>

2134 <td>*one*</td>

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

2136 </tr>

2137 </table>

2138

2139into

2140

2141 <table>

2142 <tr>

2143 <td><em>one</em></td>

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

2145 </tr>

2146 </table>

2147

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

2149

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

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

2152

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

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

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

2156from being interpreted as markdown.

2157

2158Raw TeX

2159-------

2160

2161**Extension: `raw_tex`**

2162

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

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

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

2166LaTeX to include BibTeX citations:

2167

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

2169

2170Note that in LaTeX environments, like

2171

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

2173 Age & Frequency \\ \hline

2174 18--25 & 15 \\

2175 26--35 & 33 \\

2176 36--45 & 22 \\ \hline

2177 \end{tabular}

2178

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

2180LaTeX, not as markdown.

2181

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

2183and ConTeXt.

2184

2185LaTeX macros

2186------------

2187

2188**Extension: `latex_macros`**

2189

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

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

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

2193not just LaTeX:

2194

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

2196

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

2198

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

2200unchanged to the output.

2201

2202

2203Links

2204-----

2205

2206Markdown allows links to be specified in several ways.

2207

2208### Automatic links ###

2209

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

2211will become a link:

2212

2213 <http://google.com>

2214 <sam@green.eggs.ham>

2215

2216### Inline links ###

2217

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

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

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

2221

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

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

2224

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

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

2227

2228

2229### Reference links ###

2230

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

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

2233before or after the link).

2234

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

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

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

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

2239parentheses.

2240

2241Here are some examples:

2242

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

2244 [my label 2]: /foo

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

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

2247

2248The URL may optionally be surrounded by angle brackets:

2249

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

2251

2252The title may go on the next line:

2253

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

2255 "The free software foundation"

2256

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

2258

2259 Here is [my link][FOO]

2260

2261 [Foo]: /bar/baz

2262

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

2264empty, or omitted entirely:

2265

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

2267

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

2269

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

2271reference link definitions cannot occur in nested constructions

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

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

2274not in most other implementations:

2275

2276 > My block [quote].

2277 >

2278 > [quote]: /foo

2279

2280### Internal links

2281

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

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

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

2285For example:

2286

2287 See the [Introduction](#introduction).

2288

2289or

2290

2291 See the [Introduction].

2292

2293 [Introduction]: #introduction

2294

2295Internal links are currently supported for HTML formats (including

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

2297

2298Images

2299------

2300

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

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

2303

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

2305

2306 ![movie reel]

2307

2308 [movie reel]: movie.gif

2309

2310### Pictures with captions ###

2311

2312**Extension: `implicit_figures`**

2313

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

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

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

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

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

2319

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

2321

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

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

2324 itself, with no caption.

2325

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

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

2328nonbreaking space after the image:

2329

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

2331

2332

2333Footnotes

2334---------

2335

2336**Extension: `footnotes`**

2337

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

2339

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

2341

2342 [^1]: Here is the footnote.

2343

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

2345

2346 Subsequent paragraphs are indented to show that they

2347 belong to the previous footnote.

2348

2349 { some.code }

2350

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

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

2353 multi-paragraph list items.

2354

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

2356 isn't indented.

2357

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

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

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

2361will be numbered sequentially.

2362

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

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

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

2366

2367**Extension: `inline_notes`**

2368

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

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

2371

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

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

2374 note.]

2375

2376Inline and regular footnotes may be mixed freely.

2377

2378

2379Citations

2380---------

2381

2382**Extension: `citations`**

2383

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

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

2386

2387 pandoc --filter pandoc-citeproc myinput.txt

2388

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

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

2391The bibliography may have any of these formats:

2392

2393 Format File extension

2394 ------------ --------------

2395 MODS .mods

2396 BibLaTeX .bib

2397 BibTeX .bibtex

2398 RIS .ris

2399 EndNote .enl

2400 EndNote XML .xml

2401 ISI .wos

2402 MEDLINE .medline

2403 Copac .copac

2404 JSON citeproc .json

2405

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

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

2408

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

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

2411for example:

2412

2413 ---

2414 references:

2415 - id: fenner2012a

2416 title: One-click science marketing

2417 author:

2418 - family: Fenner

2419 given: Martin

2420 container-title: Nature Materials

2421 volume: 11

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

2423 DOI: 10.1038/nmat3283

2424 issue: 4

2425 publisher: Nature Publishing Group

2426 page: 261-263

2427 type: article-journal

2428 issued:

2429 year: 2012

2430 month: 3

2431 ...

2432

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

2434these from a MODS reference collection.)

2435

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

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

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

2439modifying CSL styles can be found at

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

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

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

2443

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

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

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

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

2448

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

2450

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

2452

2453 Blah blah [@smith04; @doe99].

2454

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

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

2457author is already mentioned in the text:

2458

2459 Smith says blah [-@smith04].

2460

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

2462

2463 @smith04 says blah.

2464

2465 @smith04 [p. 33] says blah.

2466

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

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

2469document with an appropriate header:

2470

2471 last paragraph...

2472

2473 # References

2474

2475The bibliography will be inserted after this header.

2476

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

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

2479field and put the citations there:

2480

2481 ---

2482 nocite:

2483 | @item1, @item2

2484 ...

2485

2486 @item3

2487

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

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

2490`item3`.

2491

2492Non-pandoc extensions

2493---------------------

2494

2495The following markdown syntax extensions are not enabled by default

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

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

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

2499

2500**Extension: `lists_without_preceding_blankline`**\

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

2502blank space.

2503

2504**Extension: `hard_line_breaks`**\

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

2506breaks instead of spaces.

2507

2508**Extension: `ignore_line_breaks`**\

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

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

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

2512but text is divided into lines for readability.

2513

2514**Extension: `tex_math_single_backslash`**\

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

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

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

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

2519

2520**Extension: `tex_math_double_backslash`**\

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

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

2523as display TeX math.

2524

2525**Extension: `markdown_attribute`**\

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

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

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

2529

2530**Extension: `mmd_title_block`**\

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

2532the document, for example:

2533

2534 Title: My title

2535 Author: John Doe

2536 Date: September 1, 2008

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

2538 a field spanning multiple lines.

2539

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

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

2542`mmd_title_block`.

2543

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

2545

2546**Extension: `abbreviations`**\

2547Parses PHP Markdown Extra abbreviation keys, like

2548

2549 *[HTML]: Hyper Text Markup Language

2550

2551Note that the pandoc document model does not support

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

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

2554

2555**Extension: `autolink_bare_uris`**\

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

2557pointy braces `<...>`.

2558

2559**Extension: `ascii_identifiers`**\

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

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

2562letters are omitted.

2563

2564**Extension: `link_attributes`**\

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

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

2567these, so they are presently just ignored.

2568

2569**Extension: `mmd_header_identifiers`**\

2570Parses multimarkdown style header identifiers (in square brackets,

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

2572

2573Markdown variants

2574-----------------

2575

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

2577variants are supported:

2578

2579`markdown_phpextra` (PHP Markdown Extra)

2580: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

2581 `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

2582 `header_attributes`, `abbreviations`.

2583

2584`markdown_github` (Github-flavored Markdown)

2585: `pipe_tables`, `raw_html`, `tex_math_single_backslash`,

2586 `fenced_code_blocks`, `fenced_code_attributes`, `auto_identifiers`,

2587 `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

2588 `intraword_underscores`, `strikeout`, `hard_line_breaks`

2589

2590`markdown_mmd` (MultiMarkdown)

2591: `pipe_tables` `raw_html`, `markdown_attribute`, `link_attributes`,

2592 `raw_tex`, `tex_math_double_backslash`, `intraword_underscores`,

2593 `mmd_title_block`, `footnotes`, `definition_lists`,

2594 `all_symbols_escapable`, `implicit_header_references`,

2595 `auto_identifiers`, `mmd_header_identifiers`

2596

2597`markdown_strict` (Markdown.pl)

2598: `raw_html`

2599

2600Extensions with formats other than markdown

2601-------------------------------------------

2602

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

2604other than markdown:

2605

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

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

2608

2609* `tex_math_dollars`, `tex_math_single_backslash`, and

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

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

2612 for example.)

2613

2614Producing slide shows with Pandoc

2615=================================

2616

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

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

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

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

2621

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

2623

2624 % Habits

2625 % John Doe

2626 % March 22, 2005

2627

2628 # In the morning

2629

2630 ## Getting up

2631

2632 - Turn off alarm

2633 - Get out of bed

2634

2635 ## Breakfast

2636

2637 - Eat eggs

2638 - Drink coffee

2639

2640 # In the evening

2641

2642 ## Dinner

2643

2644 - Eat spaghetti

2645 - Drink wine

2646

2647 ------------------

2648

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

2650

2651 ## Going to sleep

2652

2653 - Get in bed

2654 - Count sheep

2655

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

2657

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

2659

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

2661

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

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

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

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

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

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

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

2669the file by default.

2670

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

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

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

2674

2675To produce a PDF slide show using beamer, type

2676

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

2678

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

2680by printing it to a file from the browser.

2681

2682Structuring the slide show

2683--------------------------

2684

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

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

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

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

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

2690the `--slide-level` option.

2691

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

2693rules:

2694

2695 * A horizontal rule always starts a new slide.

2696

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

2698

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

2700 headers *within* a slide.

2701

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

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

2704 and help to break the slide show into sections.

2705

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

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

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

2709

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

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

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

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

2714sections, as in the example above.

2715

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

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

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

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

2720

2721Incremental lists

2722-----------------

2723

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

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

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

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

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

2729

2730 > - Eat spaghetti

2731 > - Drink wine

2732

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

2734a single document.

2735

2736Inserting pauses

2737----------------

2738

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

2740three dots, separated by spaces:

2741

2742 # Slide with a pause

2743

2744 content before the pause

2745

2746 . . .

2747

2748 content after the pause

2749

2750Styling the slides

2751------------------

2752

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

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

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

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

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

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

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

2760

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

2762be modified there.

2763

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

2765for example:

2766

2767 -V theme=moon

2768

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

2770

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

2772using the `-V` option:

2773

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

2775

2776Note that header attributes will turn into slide attributes

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

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

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

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

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

2782bibliographies:

2783

2784 # References {.allowframebreaks}

2785

2786Speaker notes

2787-------------

2788

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

2790markdown document thus:

2791

2792 <div class="notes">

2793 This is my note.

2794

2795 - It can contain markdown

2796 - like this list

2797

2798 </div>

2799

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

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

2802will not appear on the slides themselves.

2803

2804EPUB Metadata

2805=============

2806

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

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

2809block. Here is an example:

2810

2811 ---

2812 title:

2813 - type: main

2814 text: My Book

2815 - type: subtitle

2816 text: An investigation of metadata

2817 creator:

2818 - role: author

2819 text: John Smith

2820 - role: editor

2821 text: Sarah Jones

2822 identifier:

2823 - scheme: DOI

2824 text: doi:10.234234.234/33

2825 publisher: My Press

2827 ...

2828

2829The following fields are recognized:

2830

2831`identifier`

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

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

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

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

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

2837`title`

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

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

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

2841`creator`

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

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

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

2845 pandoc will attempt to translate the human-readable versions

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

2847`contributor`

2848 ~ Same format as `creator`.

2849`date`

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

2851 Pandoc will attempt to convert other common date formats.

2852`language`

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

2854 language if nothing is specified.

2855`subject`

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

2857`description`

2858 ~ A string value.

2859`type`

2860 ~ A string value.

2861`format`

2862 ~ A string value.

2863`relation`

2864 ~ A string value.

2865`coverage`

2866 ~ A string value.

2867`rights`

2868 ~ A string value.

2869`cover-image`

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

2871`stylesheet`

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

2873

2874Literate Haskell support

2875========================

2876

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

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

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

2880literate Haskell source. This means that

2881

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

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

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

2885

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

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

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

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

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

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

2892

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

2894 as Haskell code.

2895

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

2897 be rendered using bird tracks.

2898

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

2900 Haskell code.

2901

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

2903 inside `code` environments.

2904

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

2906 with class `literatehaskell` and bird tracks.

2907

2908Examples:

2909

2910 pandoc -f markdown+lhs -t html

2911

2912reads literate Haskell source formatted with markdown conventions and writes

2913ordinary HTML (without bird tracks).

2914

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

2916

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

2918and pasted as literate Haskell source.

2919

2920Custom writers

2921==============

2922

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

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

2925

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

2927in place of the output format. For example:

2928

2929 pandoc -t data/sample.lua

2930

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

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

2933which you can modify according to your needs, do

2934

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

2936

2937Authors

2938=======

2939

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

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

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

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

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

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

2947Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine

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

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

2950Jamie F. Olson.

2951

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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