git.iko.soy/typeable/pandoc
on master help sign in
Documented ConTeXt writer in README. Removed statement

that table output is limited to HTML and LaTeX writers, since it is now supported in all writers. git-svn-id: https://pandoc.googlecode.com/svn/trunk@724 788f1e2b-df1e-0410-8736-df70ead52e1b

commit676b1ab149115cb989f46ea988d9d637d3fd6847 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSun 15 Jul 2007, 03:24 (19 years ago) parentda645eb
1 file changed+27−27
README+27−27
README+27−27
@@ -2,13 +2,13 @@
22% John MacFarlane
33% July 14, 2007
44
5−Pandoc is a [Haskell] library for converting from one markup format
6−to another, and a command-line tool that uses this library. It can read
7−[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX],
8−and it can write [markdown], [reStructuredText], [HTML], [LaTeX], [RTF],
9−[DocBook XML], [groff man] pages, and [S5] HTML slide shows. Pandoc's
10−version of markdown contains some enhancements, like footnotes and
11−embedded LaTeX.
5+Pandoc is a [Haskell] library for converting from one markup format to
6+another, and a command-line tool that uses this library. It can read
7+[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX], and
8+it can write [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt],
9+[RTF], [DocBook XML], [groff man] pages, and [S5] HTML slide shows.
10+Pandoc's version of markdown contains some enhancements, like footnotes
11+and embedded LaTeX.
1212
1313In contrast to existing tools for converting markdown to HTML, which
1414use 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.
2222[S5]: http://meyerweb.com/eric/tools/s5/
2323[HTML]: http://www.w3.org/TR/html40/
2424[LaTeX]: http://www.latex-project.org/
25+[ConTeXt]: http://www.pragma-ade.nl/
2526[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
2627[DocBook XML]: http://www.docbook.org/
2728[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:
110111
111112 pandoc -f html -t markdown hello.html
112113
113−Supported output formats include `markdown`, `latex`, `html`, `rtf`
114−(rich text format), `rst` (reStructuredText), `docbook` (DocBook
115−XML), `man` (groff man), and `s5` (which produces an HTML file that
116−acts like powerpoint). Supported input formats include `markdown`,
117−`html`, `latex`, and `rst`. Note that the `rst` reader only parses
118−a subset of reStructuredText syntax. For example, it doesn't handle
119−tables, definition lists, option lists, or footnotes. It handles only
120−the constructs expressible in unextended markdown. But for simple
114+Supported output formats include `markdown`, `latex`, `context`
115+(ConTeXt), `html`, `rtf` (rich text format), `rst` (reStructuredText),
116+`docbook` (DocBook XML), `man` (groff man), and `s5` (which produces an
117+HTML file that acts like powerpoint). Supported input formats include
118+`markdown`, `html`, `latex`, and `rst`. Note that the `rst` reader only
119+parses a subset of reStructuredText syntax. For example, it doesn't
120+handle tables, definition lists, option lists, or footnotes. It handles
121+only the constructs expressible in unextended markdown. But for simple
121122documents it should be adequate. The `latex` and `html` readers are also
122123limited in what they can do. Because the `html` reader is picky about
123124the HTML it parses, it is recommended that you pipe HTML through [HTML
@@ -233,8 +234,8 @@ formats are `native`, `markdown`, `rst`, `html`, and `latex`.
233234
234235`-t`, `--to`, `-w`, or `--write` can be used to specify the output
235236format -- the format Pandoc will be converting *to*. Available formats
236−are `native`, `html`, `s5`, `docbook`, `latex`, `markdown`, `rst`, and
237−`rtf`.
237+are `native`, `html`, `s5`, `docbook`, `latex`, `context`, `markdown`,
238+`rst`, and `rtf`.
238239
239240`-s` or `--standalone` indicates that a standalone document is to be
240241produced (with appropriate headers and footers), rather than a fragment.
@@ -258,7 +259,7 @@ and reStructuredText output. By default inline links are used.
258259codes and LaTeX environments that it can't translate as raw HTML or
259260LaTeX. Raw HTML can be printed in markdown, reStructuredText, HTML,
260261and 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
262263untranslatable HTML codes and LaTeX environments. (The LaTeX reader
263264does pass through untranslatable LaTeX commands, even if `-R` is not
264265specified.)
@@ -268,9 +269,9 @@ header. To see the headers used by default, use the `-D` option:
268269for example, `pandoc -D html` prints the default HTML header.
269270
270271`--toc` or `--table-of-contents` includes an automatically generated
271−table of contents (or, in the case of `latex` and `rst`, an instruction
272−to create one) in the output document. This option has no effect with
273−`man`, `docbook`, or `s5` output formats.
272+table of contents (or, in the case of `latex`, `context`, and `rst`, an
273+instruction to create one) in the output document. This option has no
274+effect with `man`, `docbook`, or `s5` output formats.
274275
275276`-c` or `--css` allows the user to specify a custom stylesheet that
276277will be linked to in HTML and S5 output.
@@ -280,12 +281,12 @@ will be linked to in HTML and S5 output.
280281example, to include special CSS or javascript in HTML documents.
281282
282283`-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>`
284285tag in HTML, or the `\begin{document}` command in LaTeX). This can be
285286used to include navigation bars or banners in HTML documents.
286287
287288`-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
289290HTML, or the `\end{document}` command in LaTeX).
290291
291292`-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].
298299Straight quotes are converted to curly quotes, `---` to dashes, and
299300`...` to ellipses. (Note: This option is only significant when
300301the input format is `markdown`. It is selected automatically
301−when the output format is `latex`.)
302+when the output format is `latex` or `context`.)
302303
303304[Smartypants]: http://daringfireball.net/projects/smartypants/
304305
@@ -314,7 +315,7 @@ incrementally by default (one item at a time). The normal default
314315is for lists to be displayed all at once.
315316
316317`-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.
318319
319320`--dump-args` is intended to make it easier to create wrapper scripts
320321that use Pandoc. It causes Pandoc to dump information about the arguments
@@ -536,8 +537,7 @@ Tables
536537------
537538
538539Two 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−Docbook, and LaTeX writers support tables.
540+a fixed-width font, such as Courier.
541541
542542Simple tables look like this:
543543