Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Documented ConTeXt writer in README. Removed statement

Browse source 
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
This commit is contained in:
fiddlosopher 2007-07-15 03:24:48 +00:00
parent da645eb24b
commit 676b1ab149
1 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README
View file

@ -2,13 +2,13 @@
% John MacFarlane
% July 14, 2007
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 [markdown], [reStructuredText], [HTML], [LaTeX], [RTF],
[DocBook XML], [groff man] pages, and [S5] HTML slide shows. Pandoc's
version of markdown contains some enhancements, like footnotes and
embedded LaTeX.
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 [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt],
[RTF], [DocBook XML], [groff man] pages, and [S5] HTML slide shows.
Pandoc's version of markdown contains some enhancements, like footnotes
and embedded LaTeX.
In contrast to existing tools for converting markdown to HTML, which
use 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.
[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/
[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:
pandoc -f html -t markdown hello.html
Supported output formats include `markdown`, `latex`, `html`, `rtf`
(rich text format), `rst` (reStructuredText), `docbook` (DocBook
XML), `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, definition lists, option lists, or footnotes. It handles only
the constructs expressible in unextended markdown. But for simple
Supported output formats include `markdown`, `latex`, `context`
(ConTeXt), `html`, `rtf` (rich text format), `rst` (reStructuredText),
`docbook` (DocBook XML), `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, definition lists, option lists, or footnotes. It handles
only the constructs expressible in unextended markdown. But for simple
documents it should be adequate. The `latex` and `html` readers are also
limited in what they can do. Because the `html` reader is picky about
the HTML it parses, it is recommended that you pipe HTML through [HTML
@ -233,8 +234,8 @@ formats are `native`, `markdown`, `rst`, `html`, and `latex`.
`-t`, `--to`, `-w`, or `--write` can be used to specify the output
format -- the format Pandoc will be converting *to*. Available formats
are `native`, `html`, `s5`, `docbook`, `latex`, `markdown`, `rst`, and
`rtf`.
are `native`, `html`, `s5`, `docbook`, `latex`, `context`, `markdown`,
`rst`, and `rtf`.
`-s` or `--standalone` indicates that a standalone document is to be
produced (with appropriate headers and footers), rather than a fragment.
@ -258,7 +259,7 @@ and reStructuredText output. By default inline links are used.
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,
and LaTeX output. The default is for the readers to omit
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.)
@ -268,9 +269,9 @@ header. To see the headers used by default, use the `-D` option:
for example, `pandoc -D html` prints the default HTML header.
`--toc` or `--table-of-contents` includes an automatically generated
table of contents (or, in the case of `latex` and `rst`, an instruction
to create one) in the output document. This option has no effect with
`man`, `docbook`, or `s5` output formats.
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.
`-c` or `--css` allows the user to specify a custom stylesheet that
will be linked to in HTML and S5 output.
@ -280,12 +281,12 @@ will be linked to in HTML and S5 output.
example, to include special CSS or javascript in HTML documents.
`-B` or `--include-before-body` specifies a file to be included
(verbatim) at the beginning of the document body (after the `<body>`
(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.
`-A` or `--include-after-body` specifies a file to be included
(verbatim) at the end of the docment body (before the `</body>` tag in
(verbatim) at the end of the document body (before the `</body>` tag in
HTML, or the `\end{document}` command in LaTeX).
`-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].
Straight quotes are converted to curly quotes, `---` to dashes, and
`...` to ellipses. (Note: This option is only significant when
the input format is `markdown`. It is selected automatically
when the output format is `latex`.)
when the output format is `latex` or `context`.)
[Smartypants]: http://daringfireball.net/projects/smartypants/
@ -314,7 +315,7 @@ incrementally by default (one item at a time). The normal default
is for lists to be displayed all at once.
`-N` or `--number-sections` causes sections to be numbered in LaTeX
output. By default, sections are not numbered.
or ConTeXt output. By default, sections are not numbered.
`--dump-args` is intended to make it easier to create wrapper scripts
that use Pandoc. It causes Pandoc to dump information about the arguments
@ -536,8 +537,7 @@ Tables
------
Two kinds of tables may be used. Both kinds presuppose the use of
a fixed-width font, such as Courier. Currently only the HTML,
Docbook, and LaTeX writers support tables.
a fixed-width font, such as Courier.
Simple tables look like this: