@@ -2,13 +2,13 @@
2% John MacFarlane
2% John MacFarlane
3% July 14, 2007
3% July 14, 2007
5−Pandoc is a [Haskell] library for converting from one markup format
5+Pandoc is a [Haskell] library for converting from one markup format to
6−to another, and a command-line tool that uses this library. It can read
6+another, and a command-line tool that uses this library. It can read
7−[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX],
7+[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX], and
8−and it can write [markdown], [reStructuredText], [HTML], [LaTeX], [RTF],
8+it can write [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt],
9−[DocBook XML], [groff man] pages, and [S5] HTML slide shows. Pandoc's
9+[RTF], [DocBook XML], [groff man] pages, and [S5] HTML slide shows.
10−version of markdown contains some enhancements, like footnotes and
10+Pandoc's version of markdown contains some enhancements, like footnotes
11−embedded LaTeX.
11+and embedded LaTeX.
13In contrast to existing tools for converting markdown to HTML, which
13In contrast to existing tools for converting markdown to HTML, which
14use regex substitutions, Pandoc has a modular design: it consists of a
14use regex substitutions, Pandoc has a modular design: it consists of a
@@ -22,6 +22,7 @@ or output format requires only adding a reader or writer.
22[S5]: http://meyerweb.com/eric/tools/s5/
22[S5]: http://meyerweb.com/eric/tools/s5/
23[HTML]: http://www.w3.org/TR/html40/
23[HTML]: http://www.w3.org/TR/html40/
24[LaTeX]: http://www.latex-project.org/
24[LaTeX]: http://www.latex-project.org/
25+[ConTeXt]: http://www.pragma-ade.nl/
25[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
26[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
26[DocBook XML]: http://www.docbook.org/
27[DocBook XML]: http://www.docbook.org/
27[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
28[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
@@ -110,14 +111,14 @@ To convert `hello.html` from html to markdown:
111 pandoc -f html -t markdown hello.html
112 pandoc -f html -t markdown hello.html
113−Supported output formats include `markdown`, `latex`, `html`, `rtf`
114+Supported output formats include `markdown`, `latex`, `context`
114−(rich text format), `rst` (reStructuredText), `docbook` (DocBook
115+(ConTeXt), `html`, `rtf` (rich text format), `rst` (reStructuredText),
115−XML), `man` (groff man), and `s5` (which produces an HTML file that
116+`docbook` (DocBook XML), `man` (groff man), and `s5` (which produces an
116−acts like powerpoint). Supported input formats include `markdown`,
117+HTML file that acts like powerpoint). Supported input formats include
117−`html`, `latex`, and `rst`. Note that the `rst` reader only parses
118+`markdown`, `html`, `latex`, and `rst`. Note that the `rst` reader only
118−a subset of reStructuredText syntax. For example, it doesn't handle
119+parses a subset of reStructuredText syntax. For example, it doesn't
119−tables, definition lists, option lists, or footnotes. It handles only
120+handle tables, definition lists, option lists, or footnotes. It handles
120−the constructs expressible in unextended markdown. But for simple
121+only the constructs expressible in unextended markdown. But for simple
121documents it should be adequate. The `latex` and `html` readers are also
122documents it should be adequate. The `latex` and `html` readers are also
122limited in what they can do. Because the `html` reader is picky about
123limited in what they can do. Because the `html` reader is picky about
123the HTML it parses, it is recommended that you pipe HTML through [HTML
124the HTML it parses, it is recommended that you pipe HTML through [HTML
@@ -233,8 +234,8 @@ formats are `native`, `markdown`, `rst`, `html`, and `latex`.
234`-t`, `--to`, `-w`, or `--write` can be used to specify the output
235`-t`, `--to`, `-w`, or `--write` can be used to specify the output
235format -- the format Pandoc will be converting *to*. Available formats
236format -- the format Pandoc will be converting *to*. Available formats
236−are `native`, `html`, `s5`, `docbook`, `latex`, `markdown`, `rst`, and
237+are `native`, `html`, `s5`, `docbook`, `latex`, `context`, `markdown`,
237−`rtf`.
238+`rst`, and `rtf`.
239`-s` or `--standalone` indicates that a standalone document is to be
240`-s` or `--standalone` indicates that a standalone document is to be
240produced (with appropriate headers and footers), rather than a fragment.
241produced (with appropriate headers and footers), rather than a fragment.
@@ -258,7 +259,7 @@ and reStructuredText output. By default inline links are used.
258codes and LaTeX environments that it can't translate as raw HTML or
259codes and LaTeX environments that it can't translate as raw HTML or
259LaTeX. Raw HTML can be printed in markdown, reStructuredText, HTML,
260LaTeX. Raw HTML can be printed in markdown, reStructuredText, HTML,
260and S5 output; raw LaTeX can be printed in markdown, reStructuredText,
261and S5 output; raw LaTeX can be printed in markdown, reStructuredText,
261−and LaTeX output. The default is for the readers to omit
262+LaTeX, and ConTeXt output. The default is for the readers to omit
262untranslatable HTML codes and LaTeX environments. (The LaTeX reader
263untranslatable HTML codes and LaTeX environments. (The LaTeX reader
263does pass through untranslatable LaTeX commands, even if `-R` is not
264does pass through untranslatable LaTeX commands, even if `-R` is not
264specified.)
265specified.)
@@ -268,9 +269,9 @@ header. To see the headers used by default, use the `-D` option:
268for example, `pandoc -D html` prints the default HTML header.
269for example, `pandoc -D html` prints the default HTML header.
270`--toc` or `--table-of-contents` includes an automatically generated
271`--toc` or `--table-of-contents` includes an automatically generated
271−table of contents (or, in the case of `latex` and `rst`, an instruction
272+table of contents (or, in the case of `latex`, `context`, and `rst`, an
272−to create one) in the output document. This option has no effect with
273+instruction to create one) in the output document. This option has no
273−`man`, `docbook`, or `s5` output formats.
274+effect with `man`, `docbook`, or `s5` output formats.
275`-c` or `--css` allows the user to specify a custom stylesheet that
276`-c` or `--css` allows the user to specify a custom stylesheet that
276will be linked to in HTML and S5 output.
277will be linked to in HTML and S5 output.
@@ -280,12 +281,12 @@ will be linked to in HTML and S5 output.
280example, to include special CSS or javascript in HTML documents.
281example, to include special CSS or javascript in HTML documents.
282`-B` or `--include-before-body` specifies a file to be included
283`-B` or `--include-before-body` specifies a file to be included
283−(verbatim) at the beginning of the document body (after the `<body>`
284+(verbatim) at the beginning of the document body (e.g. after the `<body>`
284tag in HTML, or the `\begin{document}` command in LaTeX). This can be
285tag in HTML, or the `\begin{document}` command in LaTeX). This can be
285used to include navigation bars or banners in HTML documents.
286used to include navigation bars or banners in HTML documents.
287`-A` or `--include-after-body` specifies a file to be included
288`-A` or `--include-after-body` specifies a file to be included
288−(verbatim) at the end of the docment body (before the `</body>` tag in
289+(verbatim) at the end of the document body (before the `</body>` tag in
289HTML, or the `\end{document}` command in LaTeX).
290HTML, or the `\end{document}` command in LaTeX).
291`-T` or `--title-prefix` specifies a string to be included as a prefix
292`-T` or `--title-prefix` specifies a string to be included as a prefix
@@ -298,7 +299,7 @@ correct output, along the lines of John Gruber's [Smartypants].
298Straight quotes are converted to curly quotes, `---` to dashes, and
299Straight quotes are converted to curly quotes, `---` to dashes, and
299`...` to ellipses. (Note: This option is only significant when
300`...` to ellipses. (Note: This option is only significant when
300the input format is `markdown`. It is selected automatically
301the input format is `markdown`. It is selected automatically
301−when the output format is `latex`.)
302+when the output format is `latex` or `context`.)
303[Smartypants]: http://daringfireball.net/projects/smartypants/
304[Smartypants]: http://daringfireball.net/projects/smartypants/
@@ -314,7 +315,7 @@ incrementally by default (one item at a time). The normal default
314is for lists to be displayed all at once.
315is for lists to be displayed all at once.
316`-N` or `--number-sections` causes sections to be numbered in LaTeX
317`-N` or `--number-sections` causes sections to be numbered in LaTeX
317−output. By default, sections are not numbered.
318+or ConTeXt output. By default, sections are not numbered.
319`--dump-args` is intended to make it easier to create wrapper scripts
320`--dump-args` is intended to make it easier to create wrapper scripts
320that use Pandoc. It causes Pandoc to dump information about the arguments
321that use Pandoc. It causes Pandoc to dump information about the arguments
@@ -536,8 +537,7 @@ Tables
538Two kinds of tables may be used. Both kinds presuppose the use of
539Two kinds of tables may be used. Both kinds presuppose the use of
539−a fixed-width font, such as Courier. Currently only the HTML,
540+a fixed-width font, such as Courier.
540−Docbook, and LaTeX writers support tables.
542Simple tables look like this:
542Simple tables look like this: