khajavi / pandoc Goto Github PK

Automatically exported from code.google.com/p/pandoc

License: GNU General Public License v2.0

TeX 0.16% Haskell 63.59% JavaScript 2.49% Shell 0.57% CSS 0.96% Perl 0.53% HTML 28.81% Groff 1.71% Batchfile 0.07% Inno Setup 1.11%

pandoc's Introduction

% Pandoc User's Guide
% John MacFarlane
% March 20, 2010

Pandoc is a [Haskell] library for converting from one markup format to
another, and a command-line tool that uses this library. It can read
[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX]; and
it can write plain text, [markdown], [reStructuredText], [HTML], [LaTeX],
[ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT], [GNU Texinfo],
[MediaWiki markup], [groff man] pages, and [S5] HTML slide shows.
Pandoc's enhanced version of markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, delimited code blocks,
superscript, subscript, strikeout, title blocks, automatic tables of
contents, embedded LaTeX math, and markdown inside HTML block elements.
(These enhancements can be disabled if a drop-in replacement for
`Markdown.pl` is desired.)

In contrast to most existing tools for converting markdown to HTML, which
use regex substitutions, Pandoc has a modular design: it consists of a
set of readers, which parse text in a given format and produce a native
representation of the document, and a set of writers, which convert
this native representation into a target format. Thus, adding an input
or output format requires only adding a reader or writer.

[markdown]: http://daringfireball.net/projects/markdown/
[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
[S5]: http://meyerweb.com/eric/tools/s5/
[HTML]:  http://www.w3.org/TR/html40/
[LaTeX]: http://www.latex-project.org/
[ConTeXt]: http://www.pragma-ade.nl/ 
[RTF]:  http://en.wikipedia.org/wiki/Rich_Text_Format
[DocBook XML]:  http://www.docbook.org/
[OpenDocument XML]: http://opendocument.xml.org/ 
[ODT]: http://en.wikipedia.org/wiki/OpenDocument
[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
[Haskell]:  http://www.haskell.org/
[GNU Texinfo]: http://www.gnu.org/software/texinfo/

© 2006-2010 John MacFarlane (jgm at berkeley dot edu). Released under the
[GPL], version 2 or greater.  This software carries no warranty of
any kind.  (See COPYRIGHT for full copyright and warranty notices.)
Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
rodja.trappe, Bradley Kuhn, thsutton.

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

Using Pandoc
============

If you run `pandoc` without arguments, it will accept input from
stdin.  If you run it with file names as arguments, it will take input
from those files.  By default, `pandoc` writes its output to stdout.[^1]
If you want to write to a file, use the `-o` option:

    pandoc -o hello.html hello.txt

[^1]:  The exception is for `odt`.  Since this is a binary output format,
       an output file must be specified explicitly.

Note that you can specify multiple input files on the command line.
`pandoc` will concatenate them all (with blank lines between them)
before parsing:

    pandoc -s ch1.txt ch2.txt refs.txt > book.html

(The `-s` option here tells `pandoc` to produce a standalone HTML file,
with a proper header, rather than a fragment.  For more details on this
and many other command-line options, see below.)

Instead of a filename, you can specify an absolute URI. In this
case pandoc will attempt to download the content via HTTP:

    pandoc -f html -t markdown http://www.fsf.org

The format of the input and output can be specified explicitly using
command-line options.  The input format can be specified using the
`-r/--read` or `-f/--from` options, the output format using the
`-w/--write` or `-t/--to` options.  Thus, to convert `hello.txt` from
markdown to LaTeX, you could type:

    pandoc -f markdown -t latex hello.txt

To convert `hello.html` from html to markdown:

    pandoc -f html -t markdown hello.html

Supported output formats include `markdown`, `latex`, `context`
(ConTeXt), `html`, `rtf` (rich text format), `rst`
(reStructuredText), `docbook` (DocBook XML), `opendocument`
(OpenDocument XML), `odt` (OpenOffice text document), `texinfo`, (GNU
Texinfo), `mediawiki` (MediaWiki markup), `man` (groff man), and `s5`
(which produces an HTML file that acts like powerpoint).

Supported input formats include `markdown`, `html`, `latex`, and `rst`.
Note that the `rst` reader only parses a subset of reStructuredText
syntax. For example, it doesn't handle tables, option lists, or
footnotes. But for simple documents it should be adequate. The `latex`
and `html` readers are also limited in what they can do.

If you don't specify a reader or writer explicitly, `pandoc` will
try to determine the input and output format from the extensions of
the input and output filenames.  Thus, for example,

    pandoc -o hello.tex hello.txt

will convert `hello.txt` from markdown to LaTeX.  If no output file
is specified (so that output goes to stdout), or if the output file's
extension is unknown, the output format will default to HTML.
If no input file is specified (so that input comes from stdin), or
if the input files' extensions are unknown, the input format will
be assumed to be markdown unless explicitly specified.

Character encodings
-------------------

All input is assumed to be in the UTF-8 encoding, and all output
is in UTF-8 (unless your version of pandoc was compiled using
GHC 6.12 or higher, in which case the local encoding will be used).
If your local character encoding is not UTF-8 and you use
accented or foreign characters, you should pipe the input and output
through [`iconv`]. For example,

    iconv -t utf-8 source.txt | pandoc | iconv -f utf-8 > output.html

will convert `source.txt` from the local encoding to UTF-8, then
convert it to HTML, then convert back to the local encoding,
putting the output in `output.html`.

Wrappers
========

`markdown2pdf`
--------------

The standard Pandoc installation includes `markdown2pdf`, a wrapper
around `pandoc` and `pdflatex` that produces PDFs directly from markdown
sources. The default behavior of `markdown2pdf` is to create a file with
the same base name as the first argument and the extension `pdf`; thus,
for example,

    markdown2pdf sample.txt endnotes.txt

will produce `sample.pdf`.  (If `sample.pdf` exists already,
it will be backed up before being overwritten.)  An output file
name can be specified explicitly using the `-o` option:

    markdown2pdf -o book.pdf chap1 chap2

If no input file is specified, input will be taken from stdin.
All of `pandoc`'s options will work with `markdown2pdf` as well.

`markdown2pdf` assumes that `pdflatex` is in the path.  It also
assumes that the following LaTeX packages are available:
`unicode`, `fancyhdr` (if you have verbatim text in footnotes),
`graphicx` (if you use images), `array` (if you use tables),
and `ulem` (if you use strikeout text).  If they are not already
included in your LaTeX distribution, you can get them from
[CTAN]. A full [TeX Live] or [MacTeX] distribution will have all of
these packages.

`hsmarkdown`
------------

A user who wants a drop-in replacement for `Markdown.pl` may create
a symbolic link to the `pandoc` executable called `hsmarkdown`. When
invoked under the name `hsmarkdown`, `pandoc` will behave as if the
`--strict` flag had been selected, and no command-line options will be
recognized. However, this approach does not work under Cygwin, due to
problems with its simulation of symbolic links.

[Cygwin]:  http://www.cygwin.com/ 
[`iconv`]: http://www.gnu.org/software/libiconv/
[CTAN]: http://www.ctan.org "Comprehensive TeX Archive Network"
[TeX Live]: http://www.tug.org/texlive/
[MacTeX]:   http://www.tug.org/mactex/

Command-line options
====================

Various command-line options can be used to customize the output.
For further documentation, see the `pandoc(1)` man page.

`-f`, `--from`, `-r`, or `--read` *format*
:   specifies the input format (the format Pandoc will be converting
    *from*). *format* can be `native`, `markdown`, `rst`, `html`, or
    `latex`.  (`+lhs` can be appended to indicate that the input should
    be treated as literate Haskell source.  See
    [Literate Haskell support](#literate-haskell-support), below.)

`-t`, `--to`, `-w`, or `--write` *format*
:   specifies the output format -- the format Pandoc will
    be converting *to*. *format* can be `native`, `html`, `s5`,
    `docbook`, `opendocument`, `latex`, `context`, `markdown`, `man`,
    `plain`, `rst`, and `rtf`. (`+lhs` can be appended to indicate that
    the output should be treated as literate Haskell source. See
    [Literate Haskell support](#literate-haskell-support), below.)

`-s` or `--standalone`
:   indicates that a standalone document is to be produced (with
    appropriate headers and footers), rather than a fragment.

`-o` or `--output` *filename*
:   sends output to *filename*. If this option is not specified,
    or if its argument is `-`, output will be sent to stdout.
    (Exception: if the output format is `odt`, output to stdout
    is disabled.)

`-p` or `--preserve-tabs`
:   causes tabs in the source text to be preserved, rather than converted
    to spaces (the default).

`--tab-stop` *tabstop*
:   sets the number of spaces per tab to *tabstop* (defaults to 4).

`--strict`
:   specifies that strict markdown syntax is to be used, without
    pandoc's usual extensions and variants (described below).  When the
    input format is HTML, this means that constructs that have no
    equivalents in standard markdown (e.g. definition lists or strikeout
    text) will be parsed as raw HTML.

`--reference-links`
:   causes reference-style links to be used in markdown 
    and reStructuredText output.  By default inline links are used.

`-R` or `--parse-raw`
:   causes the HTML and LaTeX readers to parse HTML codes and LaTeX
    environments that it can't translate as raw HTML or LaTeX. Raw HTML can
    be printed in markdown, reStructuredText, HTML, and S5 output; raw LaTeX
    can be printed in markdown, reStructuredText, LaTeX, and ConTeXt output.
    The default is for the readers to omit untranslatable HTML codes and
    LaTeX environments. (The LaTeX reader does pass through untranslatable
    LaTeX *commands*, even if `-R` is not specified.)

`-C` or `--custom-header` *filename*
:   can be used to specify a custom document header. Implies `--standalone`.
    *Note: this option is deprecated. Use of `--template` is preferred.*

`--toc` or `--table-of-contents`
:   includes an automatically generated table of contents (or, in the
    case of `latex`, `context`, and `rst`, an instruction to create
    one) in the output document. This option has no effect with `man`,
    `docbook`, or `s5` output formats.

`--base-header-level` *level*
:   specifies the base level for headers (defaults to 1).

`--template=`*file*
:   uses *file* as a custom template for the generated document. Implies
    `-s`. See [Templates](#templates) below for a description
    of template syntax. If this option is not used, a default
    template appropriate for the output format will be used. See also
    `-D/--print-default-template`.

`-V` *key=val*, `--variable=`*key:val*
:   sets the template variable *key* to the value *val* when rendering the
    document in standalone mode. This is only useful when the
    `--template` option is used to specify a custom template, since
    pandoc automatically sets the variables used in the default
    templates.

`-c` or `--css` *filename*
:   allows the user to specify a custom stylesheet that will be linked to
    in HTML and S5 output.  This option can be used repeatedly to include
    multiple stylesheets. They will be included in the order specified.
    Implies `--standalone`.

`-H` or `--include-in-header` *filename*
:   includes the contents of *filename* (verbatim) at the end of the
    document header. This can be used, for example, to include special
    CSS or javascript in HTML documents.  This option can be used
    repeatedly to include multiple files in the header.  They will be
    included in the order specified.  Implies `--standalone`.

`-B` or `--include-before-body` *filename*
:   includes the contents of *filename* (verbatim) at the beginning of
    the document body (e.g. after the `<body>` tag in HTML, or the
    `\begin{document}` command in LaTeX). This can be used to include
    navigation bars or banners in HTML documents. This option can be
    used repeatedly to include multiple files. They will be included in
    the order specified.  Implies `--standalone`.

`-A` or `--include-after-body` *filename*
:   includes the contents of *filename* (verbatim) at the end of
    the document body (before the `</body>` tag in HTML, or the
    `\end{document}` command in LaTeX). This option can be be used
    repeatedly to include multiple files. They will be included in the
    order specified.  Implies `--standalone`.

`--reference-odt` *filename*
:   uses the specified file as a style reference in producing an ODT.
    For best results, the reference ODT should be a modified version
    of an ODT produced using pandoc.  The contents of the reference ODT
    are ignored, but its stylesheets are used in the new ODT. If no
    reference ODT is specified on the command line, pandoc will look
    for a file `reference.odt` in the user data directory (see
    `--data-dir`, below). If it is not found there, sensible defaults
    will be used.

`-D` or `--print-default-template` *format*
:   prints the default template for an output *format*. (See `-t`
    for a list of possible *format*s.)

`-T` or `--title-prefix` *string*
:   includes *string* as a prefix at the beginning of the title that
    appears in the HTML header (but not in the title as it appears at
    the beginning of the HTML body). (See below on
    [Title Blocks](#title-blocks).)  Implies `--standalone`.

`-S` or `--smart`
:   causes `pandoc` to produce typographically correct output, along the
    lines of John Gruber's [Smartypants]. Straight quotes are converted
    to curly quotes, `---` to dashes, and `...` to ellipses. Nonbreaking
    spaces are inserted after certain abbreviations, such as "Mr."
    (Note: This option is only significant when the input format is
    `markdown`. It is selected automatically when the output format is
    `latex` or `context`.)

`-m`*[url]* or `--latexmathml`*[=url]*
:   causes `pandoc` to use the [LaTeXMathML] script to display
    TeX math in HTML or S5. If a local copy of `LaTeXMathML.js` is
    available on the webserver where the page will be viewed, provide a
    *url* and a link will be inserted in the generated HTML or S5. If
    no *url* is provided, the contents of the script will be inserted
    directly; this provides portability at the price of efficiency. If
    you plan to use math on several pages, it is much better to link to
    a copy of `LaTeXMathML.js`, which can be cached.  (See `--jsmath`,
    `--gladtex`, and `--mimetex` for alternative ways of dealing with
    math in HTML.)

`--mathml`
:   causes `pandoc` to convert all TeX math to MathML.
    In standalone mode, a small javascript will be inserted that allows
    the MathML to be viewed on some browsers.

`--jsmath`*=[url]*
:   causes `pandoc` to use the [jsMath] script to display
    TeX math in HTML or S5. The *url* should point to the jsMath load
    script (e.g. `jsMath/easy/load.js`). If it is provided, a link to it
    will be included in the header of standalone HTML documents.
    (See `--latexmathml`, `--mimetex`, and `--gladtex` for alternative
    ways of dealing with math in HTML.)

`--gladtex`*[=url]*
:   causes TeX formulas to be enclosed in `<eq>` tags in HTML or S5 output.
    This output can then be processed by [gladTeX] to produce links to
    images with the typeset formulas.  (See `--latexmathml`, `--jsmath`, and
    `--mimetex` for alternative ways of dealing with math in HTML.)

`--mimetex`*[=url]*
:   causes TeX formulas to be replaced by `<img>` tags linking to the
    [mimeTeX] CGI script, which will produce images with the typeset
    formulas.  (See `--latexmathml`, `--jsmath`, and `--gladtex` for alternative
    ways of dealing with math in HTML.)

`-i` or `--incremental`
:   causes all lists in S5 output to be displayed incrementally by
    default (one item at a time). The normal default is for lists to be
    displayed all at once.

`--xetex`
:   creates LaTeX outut suitable for processing by XeTeX.

`-N` or `--number-sections`
:   causes sections to be numbered in LaTeX, ConTeXt, or HTML output.
    By default, sections are not numbered.

`--no-wrap`
:   disables text-wrapping in output.  By default, text is wrapped
    appropriately for the output format.

`--sanitize-html`
:   sanitizes HTML (in markdown or HTML input) using a whitelist.
    Unsafe tags are replaced by HTML comments; unsafe attributes
    are omitted. URIs in links and images are also checked against a
    whitelist of URI schemes.

`--email-obfuscation`*=none|javascript|references*
:   specifies a method for obfuscating `mailto:` links in HTML documents.
    *none* leaves `mailto:` links as they are.  *javascript* obfuscates
    them using javascript. *references* obfuscates them by printing their
    letters as decimal or hexadecimal character references.  If `--strict`
    is specified, *references* is used regardless of the presence
    of this option.

`--id-prefix`*=string*
:   specifies a prefix to be added to all automatically generated identifiers
    in HTML output.  This is useful for preventing duplicate identifiers
    when generating fragments to be included in other pages.

`--indented-code-classes`*=classes*
:   specifies classes to use for indented code blocks--for example,
    `perl,numberLines` or `haskell`. Multiple classes may be separated
    by spaces or commas.

`--data-dir`*=directory*
:   specifies the user data directory to search for pandoc data files.
    If this option is not specified, the default user data directory
    will be used:

        $HOME/.pandoc

    in unix and

        C:\Documents And Settings\USERNAME\Application Data\pandoc

    in Windows. A reference ODT, `templates` directory, `s5` directory
    placed in this directory will override pandoc's normal defaults.

`--dump-args`
:   is intended to make it easier to create wrapper scripts that use
    Pandoc. It causes Pandoc to dump information about the arguments
    with which it was called to stdout, then exit. The first line
    printed is the name of the output file specified using the `-o`
    or `--output` option, or `-` if output would go to stdout. The
    remaining lines, if any, list command-line arguments. These will
    include the names of input files and any special options passed
    after ` -- ` on the command line. So, for example,

        pandoc --dump-args -o foo.html -s foo.txt \
          appendix.txt -- -e latin1

    will cause the following to be printed to stdout:

        foo.html foo.txt appendix.txt -e latin1

`--ignore-args`
:   causes Pandoc to ignore all command-line arguments.
    Regular Pandoc options are not ignored.  Thus, for example,

        pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1

    is equivalent to

        pandoc -o foo.html -s

`-v` or `--version`
:   prints the version number to STDERR.

`-h` or `--help`
:   prints a usage message to STDERR.

[Smartypants]: http://daringfireball.net/projects/smartypants/
[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
[jsMath]:  http://www.math.union.edu/~dpvc/jsmath/
[gladTeX]:  http://www.math.uio.no/~martingu/gladtex/index.html
[mimeTeX]: http://www.forkosh.com/mimetex.html 

Templates
=========

When the `-s/--standalone` option is used, pandoc uses a template to
add header and footer material that is needed for a self-standing
document.  To see the default template that is used, just type

    pandoc -D FORMAT

where `FORMAT` is the name of the output format. A custom template
can be specified using the `--template` option.  You can also override
the system default templates for a given output format `FORMAT`
by putting a file `templates/FORMAT.template` in the user data
directory (see `--data-dir`, above).

Templates may contain *variables*.  Variable names are sequences of
alphanumerics, `-`, and `_`, starting with a letter.  A variable name
surrounded by `$` signs will be replaced by its value.  For example,
the string `$title$` in

    <title>$title$</title>

will be replaced by the document title.

To write a literal `$` in a template, use `$$`.

Some variables are set automatically by pandoc.  These vary somewhat
depending on the output format, but include:

`legacy-header`
:   contents specified by `-C/--custom-header`
`header-includes`
:   contents specified by `-H/--include-in-header` (may have multiple
    values)
`toc`
:   non-null value if `--toc/--table-of-contents` was specified
`include-before`
:   contents specified by `-B/--include-before-body` (may have
    multiple values)
`include-after`
:   contents specified by `-A/--include-after-body` (may have
    multiple values)
`body`
:   body of document
`title`
:   title of document, as specified in title block
`author`
:   author of document, as specified in title block (may have
    multiple values)
`date`
:   date of document, as specified in title block

Variables may be set at the command line using the `-V/--variable`
option. This allows users to include custom variables in their
templates.

Templates may contain conditionals.  The syntax is as follows:

    $if(variable)$
    X
    $else$
    Y
    $endif$

This will include `X` in the template if `variable` has a non-null
value; otherwise it will include `Y`. `X` and `Y` are placeholders for
any valid template text, and may include interpolated variables or other
conditionals. The `$else$` section may be omitted.

When variables can have multiple values (for example, `author` in
a multi-author document), you can use the `$for$` keyword:

    $for(author)$
    <meta name="author" content="$author$" />
    $endfor$

You can optionally specify a separator to be used between
consecutive items:

    $for(author)$$author$$sep$, $endfor$

Pandoc's markdown vs. standard markdown
=======================================

In parsing markdown, Pandoc departs from and extends [standard markdown]
in a few respects.  Except where noted, these differences can
be suppressed by specifying the `--strict` command-line option.

[standard markdown]:  http://daringfireball.net/projects/markdown/syntax
  "Markdown syntax description"

Backslash escapes
-----------------

Except inside a code block or inline code, any punctuation or space
character preceded by a backslash will be treated literally, even if it
would normally indicate formatting.  Thus, for example, if one writes

    *\*hello\**

one will get

    <em>*hello*</em>

instead of

    <strong>hello</strong>

This rule is easier to remember than standard markdown's rule,
which allows only the following characters to be backslash-escaped:

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

A backslash-escaped space is parsed as a nonbreaking space.  It will
appear in TeX output as '`~`' and in HTML and XML as '`\&#160;`' or
'`\&nbsp;`'.

A backslash-escaped newline (i.e. a backslash occurring at the end of
a line) is parsed as a hard line break.  It will appear in TeX output as
'`\\`' and in HTML as '`<br />`'.  This is a nice alternative to
markdown's "invisible" way of indicating hard line breaks using
two trailing spaces on a line.

Subscripts and superscripts
---------------------------

Superscripts may be written by surrounding the superscripted text by `^`
characters; subscripts may be written by surrounding the subscripted
text by `~` characters.  Thus, for example,

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

If the superscripted or subscripted text contains spaces, these spaces
must be escaped with backslashes.  (This is to prevent accidental
superscripting and subscripting through the ordinary use of `~` and `^`.)
Thus, if you want the letter P with 'a cat' in subscripts, use
`P~a\ cat~`, not `P~a cat~`.

Strikeout
---------

To strikeout a section of text with a horizontal line, begin and end it
with `~~`. Thus, for example,

    This ~~is deleted text.~~

Nested Lists
------------

Pandoc behaves differently from standard markdown on some "edge
cases" involving lists.  Consider this source: 

    1.  First
    2.  Second:
    	-   Fee
    	-   Fie
    	-   Foe

    3.  Third

Pandoc transforms this into a "compact list" (with no `<p>` tags around
"First", "Second", or "Third"), while markdown puts `<p>` tags around
"Second" and "Third" (but not "First"), because of the blank space
around "Third". Pandoc follows a simple rule: if the text is followed by
a blank line, it is treated as a paragraph. Since "Second" is followed
by a list, and not a blank line, it isn't treated as a paragraph. The
fact that the list is followed by a blank line is irrelevant. (Note:
Pandoc works this way even when the `--strict` option is specified. This
behavior is consistent with the official markdown syntax description,
even though it is different from that of `Markdown.pl`.)

Ordered Lists
-------------

Unlike standard markdown, Pandoc allows ordered list items to be marked
with uppercase and lowercase letters and roman numerals, in addition to
arabic numerals. (This behavior can be turned off using the `--strict`
option.) List markers may be enclosed in parentheses or followed by a
single right-parentheses or period. They must be separated from the
text that follows by at least one space, and, if the list marker is a
capital letter with a period, by at least two spaces.[^2]

[^2]:  The point of this rule is to ensure that normal paragraphs
    starting with people's initials, like

        B. Russell was an English philosopher.

    do not get treated as list items.

    This rule will not prevent

        (C) 2007 Joe Smith

    from being interpreted as a list item.  In this case, a backslash
    escape can be used:

        (C\) 2007 Joe Smith
    
Pandoc also pays attention to the type of list marker used, and to the
starting number, and both of these are preserved where possible in the
output format. Thus, the following yields a list with numbers followed
by a single parenthesis, starting with 9, and a sublist with lowercase
roman numerals:

     9)  Ninth
    10)  Tenth
    11)  Eleventh
           i. subone
          ii. subtwo
         iii. subthree

Note that Pandoc pays attention only to the *starting* marker in a list.
So, the following yields a list numbered sequentially starting from 2:

    (2) Two
    (5) Three
    1.  Four
    *   Five

If default list markers are desired, use '`#.`':

    #.  one
    #.  two
    #.  three

Definition lists
----------------

Pandoc supports definition lists, using a syntax inspired by
[PHP Markdown Extra] and [reStructuredText]:[^3]

    Term 1

    :   Definition 1

    Term 2 with *inline markup*

    :   Definition 2

            { some code, part of Definition 2 }

        Third paragraph of definition 2.

Each term must fit on one line, which may optionally be followed by
a blank line, and must be followed by one or more definitions.
A definition begins with a colon or tilde, which may be indented one
or two spaces. A term may have multiple definitions, and each definition
may consist of one or more block elements (paragraph, code block, list,
etc.), each indented four spaces or one tab stop.

If you leave space after the definition (as in the example above),
the blocks of the definitions will be considered paragraphs. In some
output formats, this will mean greater spacing between term/definition
pairs. For a compact definition list, do not leave space between the
definition and the next term:

    Term 1
      ~ Definition 1
    Term 2
      ~ Definition 2a
      ~ Definition 2b

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

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

Reference links
---------------

Pandoc allows implicit reference links with just a single set of
brackets.  So, the following links are equivalent:

    1. Here's my [link]
    2. Here's my [link][]

    [link]: linky.com

(Note:  Pandoc works this way even if `--strict` is specified, because
`Markdown.pl` 1.0.2b7 allows single-bracket links.)

Footnotes
---------

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

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

    [^1]: Here is the footnote.

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

        Subsequent paragraphs are indented to show that they 
    belong to the previous footnote.

            { some.code }

        The whole paragraph can be indented, or just the first
        line.  In this way, multi-paragraph footnotes work like
        multi-paragraph list items.

    This paragraph won't be part of the note, because it isn't indented.

The identifiers in footnote references may not contain spaces, tabs,
or newlines.  These identifiers are used only to correlate the
footnote reference with the note itself; in the output, footnotes
will be numbered sequentially.

The footnotes themselves need not be placed at the end of the
document.  They may appear anywhere except inside other block elements
(lists, block quotes, tables, etc.).

Inline footnotes are also allowed (though, unlike regular notes,
they cannot contain multiple paragraphs).  The syntax is as follows:

    Here is an inline note.^[Inlines notes are easier to write, since
    you don't have to pick an identifier and move down to type the
    note.]

Inline and regular footnotes may be mixed freely.

Tables
------

Two kinds of tables may be used.  Both kinds presuppose the use of
a fixed-width font, such as Courier.

Simple tables look like this:

      Right     Left     Center     Default
    -------     ------ ----------   -------
         12     12        12            12
        123     123       123          123
          1     1          1             1

    Table:  Demonstration of simple table syntax.

The headers and table rows must each fit on one line.  Column
alignments are determined by the position of the header text relative
to the dashed line below it:[^4]

  - If the dashed line is flush with the header text on the right side
    but extends beyond it on the left, the column is right-aligned.
  - If the dashed line is flush with the header text on the left side 
    but extends beyond it on the right, the column is left-aligned.
  - If the dashed line extends beyond the header text on both sides,
    the column is centered.
  - If the dashed line is flush with the header text on both sides,
    the default alignment is used (in most cases, this will be left).

[^4]:  This scheme is due to Michel Fortin, who proposed it on the
       [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).

The table must end with a blank line, or a line of dashes followed by
a blank line. A caption may optionally be provided (as illustrated in
the example above). A caption is a paragraph beginning with the string
`Table:`, which will be stripped off.

The column headers may be omitted, provided a dashed line is used
to end the table. For example:

    -------     ------ ----------   -------
         12     12        12             12
        123     123       123           123
          1     1          1              1
    -------     ------ ----------   -------

When headers are omitted, column alignments are determined on the basis
of the first line of the table body. So, in the tables above, the columns
would be right, left, center, and right aligned, respectively.

Multiline tables allow headers and table rows to span multiple lines
of text.  Here is an example:

    -------------------------------------------------------------
     Centered   Default           Right Left
      Header    Aligned         Aligned Aligned
    ----------- ------- --------------- -------------------------
       First    row                12.0 Example of a row that
                                        spans multiple lines.

      Second    row                 5.0 Here's another one. Note
                                        the blank line between
                                        rows.
    -------------------------------------------------------------

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

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

  - They must begin with a row of dashes, before the header text
    (unless the headers are omitted).
  - They must end with a row of dashes, then a blank line.
  - The rows must be separated by blank lines.

In multiline tables, the table parser pays attention to the widths of
the columns, and the writers try to reproduce these relative widths in
the output. So, if you find that one of the columns is too narrow in the
output, try widening it in the markdown source.

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

    ----------- ------- --------------- -------------------------
       First    row                12.0 Example of a row that
                                        spans multiple lines.

      Second    row                 5.0 Here's another one. Note
                                        the blank line between
                                        rows.
    -------------------------------------------------------------

    Table: Here's a multiline table without headers.

It is possible for a multiline table to have just one row, but the row
should be followed by a blank line (and then the row of dashes that ends
the table), or the table may be interpreted as a simple table.

Delimited Code blocks
---------------------

In addition to standard indented code blocks, Pandoc supports
*delimited* code blocks.  These begin with a row of three or more
tildes (`~`) and end with a row of tildes that must be at least
as long as the starting row.  Everything between the tilde-lines
is treated as code.  No indentation is necessary:

    ~~~~~~~
    {code here}
    ~~~~~~~

Like regular code blocks, delimited code blocks must be separated
from surrounding text by blank lines.

If the code itself contains a row of tildes, just use a longer
row of tildes at the start and end:

    ~~~~~~~~~~~~~~~~
    ~~~~~~~~~~
    code including tildes
    ~~~~~~~~~~
    ~~~~~~~~~~~~~~~~

Optionally, you may specify the language of the code block using
this syntax:

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.haskell .numberLines}
    qsort []     = []
    qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
                   qsort (filter (>= x) xs) 
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Some output formats can use this information to do syntax highlighting.
Currently, the only output format that uses this information is HTML.

If pandoc has been compiled with syntax highlighting support, then the
code block above will appear highlighted, with numbered lines.  (To see
which languages are supported, do `pandoc --version`.)

If pandoc has not been compiled with syntax highlighting support, the
code block above will appear as follows:

    <pre class="haskell">
      <code>
      ...
      </code>
    </pre>

Images with captions
--------------------

An image occurring by itself in a paragraph will be rendered as
a figure with a caption.[^5] (In LaTeX, a figure environment will be
used; in HTML, the image will be placed in a `div` with class
`figure`, together with a caption in a `p` with class `caption`.)
The image's alt text will be used as the caption.

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

[^5]: This feature is not yet implemented for RTF, OpenDocument, or
    ODT. In those formats, you'll just get an image in a paragraph by
    itself, with no caption.

If you just want a regular inline image, just make sure it is not
the only thing in the paragraph. One way to do this is to insert a
nonbreaking space after the image:

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

Title blocks
------------

If the file begins with a title block

    % title
    % author(s) (separated by semicolons)
    % date

it will be parsed as bibliographic information, not regular text.  (It
will be used, for example, in the title of standalone LaTeX or HTML
output.)  The block may contain just a title, a title and an author,
or all three elements. If you want to include an author but no
title, or a title and a date but no author, you need a blank line:

    %
    % Author

    % My title
    %
    % June 15, 2006

The title may occupy multiple lines, but continuation lines must
begin with leading space, thus:

    % My title
      on multiple lines

If a document has multiple authors, the authors may be put on
separate lines with leading space, or separated by semicolons, or
both.  So, all of the following are equivalent:

    % Author One
      Author Two

    % Author One; Author Two

    % Author One;
      Author Two

The date must fit on one line.

All three metadata fields may contain standard inline formatting
(italics, links, footnotes, etc.).

Title blocks will always be parsed, but they will affect the output only
when the `--standalone` (`-s`) option is chosen. In HTML output, titles
will appear twice: once in the document head -- this is the title that
will appear at the top of the window in a browser -- and once at the
beginning of the document body. The title in the document head can have
an optional prefix attached (`--title-prefix` or `-T` option). The title
in the body appears as an H1 element with class "title", so it can be
suppressed or reformatted with CSS. If a title prefix is specified with
`-T` and no title block appears in the document, the title prefix will
be used by itself as the HTML title.

The man page writer extracts a title, man page section number, and
other header and footer information from the title line. The title
is assumed to be the first word on the title line, which may optionally
end with a (single-digit) section number in parentheses. (There should
be no space between the title and the parentheses.)  Anything after
this is assumed to be additional footer and header text. A single pipe
character (`|`) should be used to separate the footer text from the header
text.  Thus,

    % PANDOC(1)

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

    % PANDOC(1) Pandoc User Manuals

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

    % PANDOC(1) Pandoc User Manuals | Version 4.0

will also have "Version 4.0" in the header.

Markdown in HTML blocks
-----------------------

While standard markdown leaves HTML blocks exactly as they are, Pandoc
treats text between HTML tags as markdown. Thus, for example, Pandoc
will turn

    <table>
    	<tr>
    		<td>*one*</td>
    		<td>[a link](http://google.com)</td>
    	</tr>
    </table>

into

    <table>
    	<tr>
    		<td><em>one</em></td>
    		<td><a href="http://google.com">a link</a></td>
    	</tr>
    </table>

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

There is one exception to this rule:  text between `<script>` and
`</script>` tags is not interpreted as markdown.

This departure from standard markdown should make it easier to mix
markdown with HTML block elements.  For example, one can surround
a block of markdown text with `<div>` tags without preventing it
from being interpreted as markdown.

Header identifiers in HTML
--------------------------

Each header element in pandoc's HTML output is given a unique
identifier. This identifier is based on the text of the header. To
derive the identifier from the header text,

  - Remove all formatting, links, etc.
  - Remove all punctuation, except underscores, hyphens, and periods.
  - Replace all spaces and newlines with hyphens.
  - Convert all alphabetic characters to lowercase.
  - Remove everything up to the first letter (identifiers may
    not begin with a number or punctuation mark).
  - If nothing is left after this, use the identifier `section`.

Thus, for example,

  Header                                  Identifier
  -------------------------------------   ---------------------------
  Header identifiers in HTML              `header-identifiers-in-html`
  *Dogs*?--in *my* house?                 `dogs--in-my-house`
  [HTML], [S5], or [RTF]?                 `html-s5-or-rtf`
  3. Applications                         `applications`
  33                                      `section`

These rules should, in most cases, allow one to determine the identifier
from the header text. The exception is when several headers have the
same text; in this case, the first will get an identifier as described
above; the second will get the same identifier with `-1` appended; the
third with `-2`; and so on.

These identifiers are used to provide link targets in the table of
contents generated by the `--toc|--table-of-contents` option. They
also make it easy to provide links from one section of a document to
another. A link to this section, for example, might look like this:

    See the section on [header identifiers](#header-identifiers-in-html). 

Note, however, that this method of providing links to sections works
only in HTML.

Blank lines before headers and blockquotes
------------------------------------------

Standard markdown syntax does not require a blank line before a header
or blockquote.  Pandoc does require this (except, of course, at the
beginning of the document). The reason for the requirement is that
it is all too easy for a `>` or `#` to end up at the beginning of a
line by accident (perhaps through line wrapping).  Consider, for
example:

    I like several of their flavors of ice cream:  #22, for example, and
    #5.

Math
----

Anything between two $ characters will be treated as TeX math.  The
opening $ must have a character immediately to its right, while the
closing $ must have a character immediately to its left.  Thus,
`$20,000 and $30,000` won't parse as math.  If for some reason
you need to enclose text in literal $ characters, backslash-escape
them and they won't be treated as math delimiters.

TeX math will be printed in all output formats. In Markdown,
reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim
between $ characters.

In reStructuredText output, it will be rendered using an interpreted
text role `:math:`, as described
[here](http://www.american.edu/econ/itex2mml/mathhack.rst).

In Texinfo output, it will be rendered inside a `@math` command.

In groff man output, it will be rendered verbatim without $'s.

In MediaWiki output, it will be rendered inside `<math>` tags.

In RTF, Docbook, and OpenDocument output, it will be rendered, as far as
possible, using unicode characters, and will otherwise appear verbatim.
Unknown commands and symbols, and commands that cannot be dealt with
this way (like `\frac`), will be rendered verbatim. So the results may
be a mix of raw TeX code and properly rendered unicode math.

In HTML and S5 output, the way math is rendered will depend on the
command-line options selected:

1.  The default is to render TeX math as far as possible using unicode
    characters, as with RTF, Docbook, and OpenDocument output. Formulas
    are put inside a `span` with `class="math"`, so that they may be
    styled differently from the surrounding text if needed.

2.  If the `--latexmathml` option is used, TeX math will be displayed
    between $ or $$ characters and put in `<span>` tags with class `LaTeX`.
    The [LaTeXMathML] script will be used to render it as formulas.
    (This trick does not work in all browsers, but it works in Firefox.
    In browsers that do not support LaTeXMathML, TeX math will appear
    verbatim between $ characters.)

3.  If the `--jsmath` option is used, TeX math will be put inside
    `<span>` tags (for inline math) or `<div>` tags (for display math)
    with class `math`.  The [jsMath] script will be used to render
    it.

4.  If the `--mimetex` option is used, the [mimeTeX] CGI script will
    be called to generate images for each TeX formula. This should
    work in all browsers. The `--mimetex` option takes an optional URL
    as argument. If no URL is specified, it will be assumed that the
    mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.

5.  If the `--gladtex` option is used, TeX formulas will be enclosed
    in `<eq>` tags in the HTML output.  The resulting `htex` file may then
    be processed by [gladTeX], which will produce image files for each
    formula and an `html` file with links to these images.  So, the
    procedure is:

        pandoc -s --gladtex myfile.txt -o myfile.htex
        gladtex -d myfile-images myfile.htex
        # produces myfile.html and images in myfile-images

Inline TeX
----------

Inline TeX commands will be preserved and passed unchanged to the
LaTeX and ConTeXt writers. Thus, for example, you can use LaTeX to
include BibTeX citations:

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

Note that in LaTeX environments, like

    \begin{tabular}{|l|l|}\hline
    Age & Frequency \\ \hline
    18--25  & 15 \\
    26--35  & 33 \\ 
    36--45  & 22 \\ \hline
    \end{tabular}

the material between the begin and end tags will be interpreted as raw
LaTeX, not as markdown.

Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
and ConTeXt.

Producing S5 with Pandoc
========================

Producing an [S5] web-based slide show with Pandoc is easy.  A title
page is constructed automatically from the document's title block (see
above).  Each section (with a level-one header) produces a single slide.
(Note that if the section is too big, the slide will not fit on the page;
S5 is not smart enough to produce multiple pages.)

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

    % Eating Habits
    % John Doe
    % March 22, 2005

    # In the morning

    - Eat eggs
    - Drink coffee

    # In the evening

    - Eat spaghetti
    - Drink wine

To produce the slide show, simply type

    pandoc -w s5 -s eating.txt > eating.html

and open up `eating.html` in a browser.

Note that by default, the S5 writer produces lists that display
"all at once."  If you want your lists to display incrementally
(one item at a time), use the `-i` option.  If you want a
particular list to depart from the default (that is, to display
incrementally without the `-i` option and all at once with the
`-i` option), put it in a block quote:

    > - Eat spaghetti
    > - Drink wine

In this way incremental and nonincremental lists can be mixed in
a single document.

Note: the S5 file produced by pandoc with the `-s/--standalone` option
embeds the javascript and CSS required to show the slides. Thus it
does not depend on any additional files: you can send the HTML file to
others, and they will be able to view the slide show just by opening
it. However, if you intend to produce several S5 slide shows, and you
are displaying them on your own website, it is better to keep the S5
javascript and CSS files separate from the slide shows themselves, so
that they may be cached. The best approach in this case is to use pandoc
without the `-s` option to produce the body of the S5 document, which
can then be inserted into an HTML template that links to the javascript
and CSS files required by S5. (See the instructions on the S5 website.)
Alternatively, you may use `-s` together with the `--template`
option to specify a custom template.

You can change the style of the slides by putting customized CSS files
in `$DATADIR/s5/default`, where `$DATADIR` is the user data directory
(see `--data-dir`, above). The originals may be found in pandoc's system
data directory (generally `$CABALDIR/pandoc-VERSION/s5/default`). Pandoc
will look there for any files it does not find in the user data
directory.

Literate Haskell support
========================

If you append `+lhs` to an appropriate input or output format (`markdown`,
`rst`, or `latex` for input or output; `html` for output only), pandoc
will treat the document as literate Haskell source. This means that

  - In markdown input, "bird track" sections will be parsed as Haskell
    code rather than block quotations.  Text between `\begin{code}`
    and `\end{code}` will also be treated as Haskell code.

  - In markdown output, code blocks with class `haskell` will be
    rendered using bird tracks, and block quotations will be
    indented one space, so they will not be treated as Haskell code.
    In addition, headers will be rendered setext-style (with underlines)
    rather than atx-style (with '#' characters). (This is because ghc
    treats '#' characters in column 1 as introducing line numbers.)

  - In restructured text input, "bird track" sections will be parsed
    as Haskell code.

  - In restructured text output, code blocks with class `haskell` will
    be rendered using bird tracks.

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

  - In LaTeX output, code blocks with class `haskell` will be rendered
    inside `code` environments.

  - In HTML output, code blocks with class `haskell` will be rendered
    with class `literatehaskell` and bird tracks.

Examples:

    pandoc -f markdown+lhs -t html

reads literate Haskell source formatted with markdown conventions and writes
ordinary HTML (without bird tracks).

    pandoc -f markdown+lhs -t html+lhs

writes HTML with the Haskell code in bird tracks, so it can be copied
and pasted as literate Haskell source.

pandoc's People

Watchers

pandoc's Issues

html2markdown converts HTML entities to Unicode

What steps will reproduce the problem?
1. Run pandoc on <a href="">foo&nbsp;bar</a>

What is the expected output? What do you see instead?

Expected that the HTML &nbsp; entity would be preserved; instead, it is
translated as a Unicode non-breaking space.  Uggh.

What version of the product are you using? On what operating system?

pandoc 0.3 Debian

Please provide any additional information below.

Original issue reported on code.google.com by [email protected] on 25 Jan 2007 at 7:31

Debian package is 0.4, has html output bug

The link to the Pandoc 0.3 Debian package in Pandoc's home page is broken. 
Instead, there is a Pandoc 0.4 package on Recai Oktaş repository:

http://people.debian.org/~roktas/packages/pandoc_0.4_i386.deb  

This pandoc_0.4_i386.deb produces html with greater-than signs (>) at the
beginning of each line. See attached file.

To reproduce the issue:

1. environment is Debian testing 
2. sudo dpkg -i pandoc_0.4_i386.deb
3. pandoc README -o example1.html

The output html file has an > for every new line. Same for standalone output.

Removing 0.4 and installing 0.3  fixes the issue. There is an 0.3 package here:

http://people.debian.org/~roktas/tmp/pandoc-old/pandoc_0.3_i386.deb

Original issue reported on code.google.com by [email protected] on 4 May 2007 at 8:52

Attachments:

example1.html

Periods in email address autolinks

Pandoc does not properly handle autolink email addresses with periods
in them:

<[email protected]>

does not get converted into an email link.

Original issue reported on code.google.com by [email protected] on 16 Dec 2007 at 7:27

AsciiDoc support

It would be fantastic if it supported at least a subset of AsciiDoc. (I 
personally prefer AsciiDoc's section headers over Markdown's, where the 
former underlines the title with = or -.)

Original issue reported on code.google.com by [email protected] on 12 Feb 2007 at 2:39

Allow tables with no column headings

Allow tables to have no column heading.

E.g.

------------ ---
California    42
New Mexico     5
------------ ---

How do we determine the alignment in these cases?
Possibly from the first line.  Or possibly we could
introduce a special notation:

.              .
------------ ---
California    42
New Mexico     5
------------ ---

Original issue reported on code.google.com by [email protected] on 22 Jan 2008 at 3:40

Incorrect parsing of internal RST hyperlink targets

RST allows "internal" hyperlink targets that refer to the next element.
They can also be "chained."  Pandoc's parser doesn't handle either case
correctly.  See
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-tar
gets

What steps will reproduce the problem?

1. Run pandoc on the following input:

`hello`_

.. _hello:

paragraph

Expected output:  "hello" should link to the paragraph "paragraph", which
should get id="hello".

2.  Run pandoc on the following input:

`hello`_ and `goodbye`_

.. _hello:
.. _goodbye: foo.bar.com

Expected output:  Both "hello" and "goodbye" should be links to foo.bar.com.

Original issue reported on code.google.com by [email protected] on 12 Feb 2007 at 2:43

add option to disable hard wrapping

In some cases it is preferable to obtain output which is not hard wrapped. 
Perhaps this option could 
be called: no-wrap.

Original issue reported on code.google.com by [email protected] on 25 Sep 2007 at 4:33

Support for strikeout (patch included)

I've added support for strikeout text.  The included patch applies against
your current trunk (r714 at time of submission).  The only input/output
format that didn't support strikeout was reStructured text, so I added a
dummy output for it.  For the rest, I added the standard methods for the
given format.

Original issue reported on code.google.com by [email protected] on 15 Jul 2007 at 4:28

Attachments:

pandoc-strikeout.diff

missing final paragraph annotation

Thanks for quick fix for last report!

This is a minor issue when input strings end with a single
newline character, adding a further newline character
works as a fix.

I'd half expect no newline character to still catch the final
paragraph as well, I'm not sure.

Thanks again,
Rohan 

What steps will reproduce the problem?

test.hs
>>>
import Text.Pandoc.Readers.Markdown ( readMarkdown )
import Text.Pandoc.Writers.HTML ( writeHtmlString )
import Text.Pandoc.Definition
import Text.Pandoc.Shared

prs = defaultParserState { stateParseRaw    = False
                         , stateTabStop     = 4
                         , stateStandalone  = False
                         , stateSmart       = False
                         , stateColumns     = 1
                         , stateStrict      = True
                         , stateInlineLinks = False }

opt = WriterOptions { writerStandalone     = False
                    , writerTitlePrefix    = ""
                    , writerHeader         = ""
                    , writerIncludeBefore  = "" 
                    , writerIncludeAfter   = ""
                    , writerS5             = False
                    , writerIncremental    = False
                    , writerNumberSections = False
                    , writerStrictMarkdown = True
                    , writerTabStop        = 4
                    , writerNotes          = [] }

main = do let s = "this is a paragraph\n\nand this is another\n"
              d = readMarkdown prs s
          putStrLn (writeHtmlString opt d)
<<<

What is the expected output? What do you see instead?

expect:

<p
>this is a paragraph</p
><p
>and this is another</p
>

receive:

<p
>this is a paragraph</p
>and this is another

What version of the product are you using? On what operating system?

Current svn (as of 12/3/07)

$ pandoc --version
pandoc 0.4
Copyright (C) 2006 John MacFarlane
Web:  http://sophos.berkeley.edu/macfarlane/pandoc
This is free software; see the source for copying conditions.  There is no
warranty, not even for merchantability or fitness for a particular purpose.
$ uname --all
Linux alice.localdomain 2.6.20-rt8 #1 PREEMPT Thu Mar 8 23:01:25 EST 2007
i686 i686 i386 GNU/Linux
$ 


Please provide any additional information below.

Original issue reported on code.google.com by [email protected] on 12 Mar 2007 at 10:36

html2markdown does not permit inline markdown

What steps will reproduce the problem?
What is the expected output? What do you see instead?

Create an HTML document with an A tag like <a href="http://foo">bar</a>.
pandoc chooses to encode this as

  [bar][1]

    [1]: http://foo

which is legitimate referenced-link markdown, but to my tasted is far
inferior to the inline markdown

  [bar](http://foo)


What version of the product are you using? On what operating system?

pandoc 0.3 Debian

Please provide any additional information below.

Original issue reported on code.google.com by [email protected] on 25 Jan 2007 at 7:39

Markdown reader interprets "A." in "A.B." as ordered list start

What steps will reproduce the problem?

pandoc
A.B.
^D

What is the expected output?

<p
>A.B.</p
>

What do you see instead?

pandoc: 
Error:
"source" (line 7, column 3):
unexpected "B"

This is due to the fact that anyOrderedListStart doesn't require a
space after the marker.

Original issue reported on code.google.com by [email protected] on 18 Aug 2007 at 3:14

Man page backend

Hi, I love this program! Please consider adding support (perhaps for a 
subset of input formats) for generating man pages. (This is featured in 
AsciiDoc.)

Original issue reported on code.google.com by [email protected] on 22 Mar 2007 at 6:32

Odd interaction between inline literal and headers with backticks in RST reader

What steps will reproduce the problem?

Run pandoc -r rst on the following input:

``#``

Indented code block

Indented code block


Expected output:  an inline literal # followed by two h1 headings.

The problem:  Pandoc will get this right, but it takes forever.  This
happens even with r526, which fixed a few bugs in RST parsing.  Note
that the inline literal by itself, or the headings by themselves,
are parsed quickly.

This bug is responsible for pandoc's hanging while trying to parse the RST
markup specification:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.txt

Original issue reported on code.google.com by [email protected] on 12 Feb 2007 at 3:59

Email obfuscation double-encodes entities in link text

To see the bug:
1. Create a link with text containing a character entity, `[Foo 
&c.](mailto:[email protected])`; and
2. Translate the document to HTML.

With JavaScript enabled one sees the expected link "Foo &c.". 
With JS disabled the one sees the incorrect text "Foo &amp;c. (foo at bar dot 
baz)".

Encountered using the OS X package of pandoc 0.3. Tested with Camino 1.0.3 and 
eLinks 0.10.6.

The attached pandoc-0.3-obfuscateString.patch resolves the issue, and doesn't 
introduce any 
regressions w.r.t. the test suite.

Original issue reported on code.google.com by [email protected] on 8 Apr 2007 at 10:07

Attachments:

pandoc-0.3-obfuscateString.patch

Invalid nesting of links is possible

Pandoc allows links to occur nested in links, which is not valid HTML:
So, running pandoc on

[[Link](url)](url)

yields

<p
><a href="url"
  ><a href="url"
    >Link</a
    ></a
  ></p
>

Original issue reported on code.google.com by [email protected] on 16 Dec 2007 at 7:22

definition lists, compatibility with HTML and PHP Markdown Extra

I think Pandoc should treat definition lists as PHP Markdown Extra does.[^1] In 
accordance with the 
HTML specification, it supports consecutive terms (several terms may share a 
common definition) 
and consecutive definitions (terms may have more than one definition). It also 
seems useful to 
remain compatible with the existing syntax specified by PHP Markdown Extra. 

Such changes may be incompatible with Latex and other formats but the 
deficiencies of a given 
format should not impair the utility of another.

[^1]: http://michelf.com/projects/php-markdown/extra/#def-list

Original issue reported on code.google.com by [email protected] on 24 Sep 2007 at 10:29

Improve ConTeXt output.

We've had a number of good suggestions for improving ConTeXt output.
See http://code.google.com/p/pandoc/wiki/ConTeXtImprovements

Original issue reported on code.google.com by [email protected] on 1 Nov 2007 at 5:07

newlines inside html tags before '>'

What steps will reproduce the problem?
1. make test
2. head -n 5 tests/writer.html

What is the expected output? 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Pandoc Test Suite</title>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">


What do you see instead?

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
><head
  ><title
    >Pandoc Test Suite</title

What version of the product are you using? On what operating system?
pandoc 0.44, Linux 2.6.20-suspend2-r6 #3 PREEMPT

Please provide any additional information below.
compiled with "The Glorious Glasgow Haskell Compilation System, version 6.6.1"

Original issue reported on code.google.com by [email protected] on 17 Nov 2007 at 2:22

PDF Margin sizes too large (and untouchable through markdown2pdf)

1. use markdown2pdf to generate a pdf
2. use pandoc to generate a tex (pandoc -w context) and texexec to convert
to pdf 

You get a PDF as expected but the margins are very large. Using
markdown2pdf I see no way to effectively manipulate margins.  Using padoc
to generate an intermediary tex allows you to modify the tex before using
texexec to convert.

On 0.46 - OS X 10.5.1 (Leopard)

Original issue reported on code.google.com by [email protected] on 19 Jan 2008 at 1:20

Include amsmath

Latex output doesn't usepackage amsmath. It would be nice to have that 
included by default, though perhaps you intentionally excluded it because 
you felt it wasn't safe to assume people had that package. Perhaps some 
simple heuristics for implicitly detecting amsmath commands could be added.

Original issue reported on code.google.com by [email protected] on 19 Jan 2008 at 6:39

pandoc --strict html output mangles mailto text

Hello John,

Pandoc is excellent, thanks very kindly!

A minor issue: the mail address mangling is nice however
under --strict it the encoding for the visible text is
not correct.

What steps will reproduce the problem?

test.md
>>>
contact [us][1] for details

  [1]: mailto:[email protected]
<<<

$ pandoc --strict test.md > test.html

What is the expected output? What do you see instead?

expected: contact us for details

received: contact &#x75;&#x73; for details

What version of the product are you using? On what operating system?

~$ pandoc --version
pandoc 0.4
Copyright (C) 2006 John MacFarlane
Web:  http://sophos.berkeley.edu/macfarlane/pandoc
This is free software; see the source for copying conditions.  There is no
warranty, not even for merchantability or fitness for a particular purpose.
~$ uname --all
Linux alice.localdomain 2.6.20-rt8 #1 PREEMPT Thu Mar 8 23:01:25 EST 2007
i686 i686 i386 GNU/Linux
~$

Original issue reported on code.google.com by [email protected] on 10 Mar 2007 at 10:26

fails on a rst->mdwn conversion

What steps will reproduce the problem?
1. markdown -f rst -t mdwn attached_file.rst

What is the expected output? What do you see instead?
markdown output, but it seems to loop forever.

What version of the product are you using? On what operating system?
pandoc 0.45 / debian sid

Original issue reported on code.google.com by [email protected] on 6 Jan 2008 at 12:57

Attachments:

2006.06.25-froscon.rst

Add tables with pipes

Currently pandoc's markdown tables are difficult to use with
proportionally spaced fonts, because they require lining up columns.
It might be worth adding an additional table syntax similar to that 
used by PHP Markdown Extra:

| Item      | Value |
| --------- | -----:|
| Computer  | $1600 |
| Phone     |   $12 |
| Pipe      |    $1 |

Here the columns would not have to line up.  A multiline variant could
also be added:

---------------------
| Item      | Value |
| --------- | -----:|
| Computer  | $1600 |
|           |       |
| Phone     |   $12 |
| jack      |       |
|           |       |
| Pipe      |    $1 |
---------------------

Original issue reported on code.google.com by [email protected] on 4 Jan 2008 at 8:19

Support for arbitrary off-side indentation

Currently, we're required to use 4 spaces for indenting bulleted lists. 
Ideally pandoc should allow an arbitrary amount of indentation.

- this
  - should
    - work
    - but
  - right now
  - it doesn't

Original issue reported on code.google.com by [email protected] on 23 Mar 2007 at 6:36

RST->Markdown: code blocks not properly converted.

Hi,

RST code blocks are indented blocks of text following a paragraph ending
with two colons::

  like this

Alternatively, you can even do this!

::

  This is code.

I hope Google preserves the spacing.

When pandoc converts this to Markdown, it creates indented text:

> like
> this

and it does not preserve line breaks or spaces.

Instead, it should really convert indented blocks following a :: to blocks
indented by four spaces or a tab, which is what Markdown uses.

Thanks for your attention.

Original issue reported on code.google.com by [email protected] on 10 Oct 2007 at 9:39

Support for ditaa (and other ASCII art?)

This is an enhancement request.

I have recently been using ditaa for generating diagrams. It would be 
incredibly awesome if pandoc supported in-line generation of these 
diagrams!

I'm surprised something like this hasn't been done before with (e.g.) 
Markdown. I'm not sure what other ASCII art renderers exist - I tried 
looking for a while but didn't find anything - but if you know of 
others, then perhaps consider those too!

Original issue reported on code.google.com by [email protected] on 2 Jun 2007 at 9:54

brackets in inline footnotes

What steps will reproduce the problem?

Run pandoc on the following input:

test^[my [note] contains brackets].

What is the expected output? What do you see instead?

Expected a footnote with the content: "my [note] contains brackets".
Instead, the note is cut off at the first closing bracket: "my [note",
and the rest appears in the main text.

Original issue reported on code.google.com by [email protected] on 26 Mar 2007 at 8:41

cross references

This is a feature request and not a bug report :)  Would it be possible to
support internal cross references, perhaps in the manner of
http://fletcherpenney.net/MultiMarkdown_Syntax_Guide#automaticcross-references

Original issue reported on code.google.com by [email protected] on 16 Aug 2007 at 1:28

Faulty wrapping for long hyperlinks or paths in PDFs

1. Create a markdown document with very long link text (not the uri - the
description) or with a long file path

http://localhost/workingdir/trunk/src/project/trunk/WebContent/
~/Documents/Work/Project/SVN/workingdir/trunk/src/project/trunk/WebContent/ 

2. Generate PDF using markdown2pdf or pandoc to tex to pdf

Would expect to see a PDF where the hyperlinks are wrapped or at least
forced to their own line.  This is not the case.

0.46 on OS X 10.5.1 (Leopard)

When coupled with the extremely large margins of PDF out this exacerbates
the problem.

Original issue reported on code.google.com by [email protected] on 19 Jan 2008 at 1:28

Installation Problem: `Distribution.GetOpt' hidden

What steps will reproduce the problem?
1. Install GHC (OSX 10.4.8, intel), Audrey Tang version of GHC binary.
2. run Make on pandoc
3.

What is the expected output? What do you see instead?
error message: 

Main.hs:21:7:
    Could not find module `Distribution.GetOpt':
      it is hidden (in package Cabal-1.1.6.1)
make[1]: *** [../pandoc] Error 1
make: *** [all] Error 2


What version of the product are you using? On what operating system?
OSX 10.4.8. Intel, Pandoc-0.2, GHC 6.6, Cabal 1.1.6.1a

Please provide any additional information below.
Being newbie to Haskel, GHC, etc., I also reinstalled Cabal independently
of GHC after getting the error message. Cabal installation was successfull,
but error message persists. Any obvious issues?

Original issue reported on code.google.com by [email protected] on 4 Nov 2006 at 3:28

<no title>

It would be great to have some way to output 'display' (multiline, aligned, 
etc., not in-line) math equations for HTML (any of the math-in-HTML options). 
Thanks!

Original issue reported on code.google.com by [email protected] on 19 Jan 2008 at 5:58

Option to specify footnote anchor prefix

Jonathan Deber notes on the Markdown list: "If you're posting to a CMS
system where multiple articles may appear on the same HTML page, you need
to assign each article a GUID so that the footnote links make sense (i.e.,
you can't have two articles that both use "fnref" as the anchor name for
the footnotes, since you would end up with two anchors with the same name
if two articles are published on the same page). It's of course possible to
do this with a search and replace of "fnref" to something like
"2007-01-23-1" prior to publishing. But, it would be nice if you could
specify a document GUID and have the Markdown processor do that
substitution for you."

Perhaps a command-line option should be provided to specify a string to be
added to the anchor names?

Original issue reported on code.google.com by [email protected] on 4 Jan 2008 at 8:14

line wrapping does not respect HTML br element

input:

    A long line with enough text to break the following line.<br />
    This is the following line.

output: 

    A long line with enough text to break the following line.  
    This is
    the following line.

Original issue reported on code.google.com by [email protected] on 25 Sep 2007 at 4:26

Contents of <style> tags are processed, sometimes resulting in bogus CSS/HTML

What steps will reproduce the problem?
1. Make a file with the following contents:

<style type="text/css">
body {}

</style>

2. Run pandoc --from=markdown on it.

What is the expected output? What do you see instead?

Expected is something like:

<style type="text/css">body {}</style>

Seen is:

<style type="text/css"><p
>body {}</p
></style>

I.e. a <p> tag is wrapped around the contents, because of the blank line
before the closing </style> tag.

Another, worse case is:

<style type="text/css">
/*

* a CSS comment
*
*/
</style>

Which becomes a mess which isn't even valid HTML, let alone CSS:

<style type="text/css"><p
>/*</p
><ul
><li
  >a CSS comment * */</style>

</li
  ></ul
>

What version of the product are you using? On what operating system?

SVN revision 1161 on Windows XP, compiled with the help of Cygwin and GHC
6.8.2.

Please provide any additional information below.

This isn't as bad as it seems, since it's easy to work around: don't put
any blank lines in <style>. Still, it's annoying.

Original issue reported on code.google.com by [email protected] on 30 Dec 2007 at 1:12

Header identifiers in HTML starting with numbers

What steps will reproduce the problem?
1. Create a document that contains this line only: "# 1 Test"
2. Run "pandoc -st html test.txt > test.html".

What is the expected output? What do you see instead?

The output should contain a valid ID for the HTML h1 tag. However, the
identifier is "1-test", which is not a valid identifier because identifiers
may not begin with a number (see
http://htmlhelp.com/reference/html40/attrs.html).

Running this through HTML Tidy will result in the following warning: 'line
10 column 4 - Warning: <h1> attribute "id" has invalid value "1-test"'.

What version of the product are you using? On what operating system?

I'm using revision 1145 checked out from the SVN repository on Windows
under Cygwin.

Original issue reported on code.google.com by [email protected] on 10 Dec 2007 at 3:21

</body> and </html> are entity-escaped

What steps will reproduce the problem?
1. echo "<html><body>Foo bar.</body></html>" | pandoc --no-wrap

What is the expected output? What do you see instead?

Pandoc escapes the closing html and body tags, resulting in:

<html><body><p>Foo bar.&lt;/body&gt;&lt;/html&gt;</p>

What I hoped to see was:

<html><body><p>Foo bar.</p></body></html>

What version of the product are you using? On what operating system?

Pandoc 0.45, the Windows binary package on Windows XP.

Original issue reported on code.google.com by [email protected] on 22 Dec 2007 at 6:59

Syntax for specifying image sizes.

There is currently no way to specify the size of an image.
For some ideas, see http://code.google.com/p/pandoc/wiki/ImageSizes.

Original issue reported on code.google.com by [email protected] on 1 Nov 2007 at 5:05

Code blocks don't work when preceded by inline HTML tags

What steps will reproduce the problem?
1. Make a file containing the following:

<br>

    foo
    bar

2. Run pandoc --no-wrap --from=markdown on it.

What is the expected output? What do you see instead?

I expected something like:

<br>
<pre><code>foo
bar
</code></pre>

But I got:

<br>

    <p>foo bar</p>

I was originally seeing if literate Haskell would work by doing the following:

<pre><code>
> foo
> bar
</code></pre>

Which gives (note the incorrect tag nesting):

<pre><code><blockquote>foo bar </code></pre>
</blockquote>

What version of the product are you using? On what operating system?

SVN revision 1161 on Windows XP, compiled with the help of Cygwin and GHC
6.8.2.

Original issue reported on code.google.com by [email protected] on 30 Dec 2007 at 12:35

pandoc generates invalid xhtml

Validation fails because:

- missing xmlns element (note: this can be fixed by compiling pandoc
  with the newest xhtml library in GHC 6.6.1)
- when --toc option is used, headers are wrapped in anchors, and this
  is invalid (block-level content inside inline-level tags).

Original issue reported on code.google.com by [email protected] on 2 Sep 2007 at 4:50

Escaped characters in URLs

Backslash escapes don't work in link URLs.
Run pandoc on:

[test](/url\(test\))

Output:

<p
><a href="/url\(test\"
  >test</a
  >)</p
>

Expected output:  the final ) should be part of the URL, and the
backslashes should not be part of it.

Original issue reported on code.google.com by [email protected] on 16 Dec 2007 at 7:20

Proper treatment of HTML tags that can be either block or inline

Run pandoc on

<ins>hello</ins>

You get:

<ins><p
>hello</ins></p
>

which is improperly nested.

Optimal output:

<p><ins>hello</ins></p>

Perhaps this can be fixed by putting the raw HTML parser after
the paragraph parser in the definition of 'block'.

Original issue reported on code.google.com by [email protected] on 16 Dec 2007 at 7:26

Want official release for GHC 6.6

I'd like to see an official release that works on GHC 6.6, since previous 
versions of GHC don't work 
on OS X i386 (but MacPorts has a build process for 6.6 that works). I could use 
the subversion 
repository, but I personally don't need pandoc, instead I want to enable others 
to use it, and it 
would be a lot easier if there was an official release that I could make a 
MacPorts Portfile for.

Original issue reported on code.google.com by [email protected] on 5 Dec 2006 at 2:57

Add documentation

There are a number of differences from the original Markdown syntax which 
pandoc offers. These should be documented!

Original issue reported on code.google.com by [email protected] on 22 Mar 2007 at 8:46

Add syntax for general ascii tables

These tables could include arbitrary lists of blocks in each cell.

+------------------------+------------+----------+----------+
| Header row, column 1   | Header 2   | Header 3 | Header 4 |
+------------------------+------------+----------+----------+
| body row 1, column 1   | column 2   | column 3 | column 4 |
| and more col 1         |            |          | and more |
| and more               | and more   | and more |   col4   |
+------------------------+------------+----------+----------+
| body row 2             | Cells may span column |          |
+------------------------+------------+----------+----------+

Look at reStructuredText's table syntax as a paradigm.

Original issue reported on code.google.com by [email protected] on 4 Jan 2008 at 8:21

RST hyperlink target URIs can be broken into several lines

According to the RST documentation
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-ta
rgets),
the following external hyperlink targets are equivalent:

.. _one-liner: http://docutils.sourceforge.net/rst.html

.. _starts-on-this-line: http://
   docutils.sourceforge.net/rst.html

.. _entirely-below:
   http://docutils.
   sourceforge.net/rst.html

Pandoc does not currently handle this correctly.  It assumes that the
entire URI is on one line.

Original issue reported on code.google.com by [email protected] on 12 Feb 2007 at 2:45

Non-strict Markdown parsing breaks on unknown HTML tags

What steps will reproduce the problem?

Convert the following snippet as Pandoc-enhanced Markdown:

Lorem <lj user="ipsum" /> dolor sic

What is the expected output? What do you see instead?

Markdown.pl produces:

<p>Lorem <lj user="ipsum" /> dolor sic</p>

Strict Markdown produces:

<p>Lorem <lj user="ipsum" /> dolor sic</p>

Pandoc enhanced produces:

Lorem <lj user="ipsum" /> 
<p>dolor sic</p>

What version of the product are you using? On what operating system?

PanDoc 0.3 w/ GHC 6.6 and Ubuntu 7.04 (Feisty).

Please provide any additional information below.

Original issue reported on code.google.com by [email protected] on 16 Aug 2007 at 3:01

(Hidden) Comments

This is a feature request.

Would you consider adding some syntax for comments? Perhaps something 
along the lines of:

[Comment: To render this text file document into HTML, use pandoc 0.3 or 
greater, available at http://....]

Thanks!

Original issue reported on code.google.com by [email protected] on 26 Jul 2007 at 5:42

Precedence of tilde vs brackets

[http://www.mit.edu/~y_z/](http://www.mit.edu/~y_z/)

I think that generally, brackets/parens should get precedence over tilde, 
especially since tildes are commonly used in URLs.

BTW, is there any way to create the above type of link without the 
repetition? Thanks!

Original issue reported on code.google.com by [email protected] on 20 Jan 2008 at 8:26

incorrect html linebreaks

steps to reproduce the problem

1. debian sid, pandoc 0.44,
2. get a markdown file such as http://johnmacfarlane.net/pandoc/README
3. pandoc -S README.txt -o README.html 
4. less README.html

HTML linebreaks happen before the closing > tag, newlines beginning with
the same > tag.

Debian sid
pandoc 0.44
libghc6-pandoc-dev 0.44

Original issue reported on code.google.com by [email protected] on 17 Oct 2007 at 2:28

Attachments:

linebreak.tar.gz

does not make without ghc in $PATH, simple Makefile edit not sufficient

What steps will reproduce the problem?
1. install ghc in, say "/opt/ghc/bin"
2. extract pandoc tarball 
3. cd into pandoc dir
4. type make
5. behold the error
6. change GDC* variables in Makefile to full path of binaries
7. try again
8. see the error
9. sigh.
10. make symlinks of all files in /opt/ghc/bin to /usr/local/bin/
11. try again
12. works.
13. there is no step 13.

What is the expected output? What do you see instead?
Eh... works now. Forgot *what* I saw exactly.

What version of the product are you using? On what operating system?
pandoc 0.44

Original issue reported on code.google.com by [email protected] on 17 Nov 2007 at 2:11

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.