Documented org-mode writer in README, cabal, man pages.

This commit is contained in:
John MacFarlane 2010-12-05 09:45:45 -08:00
parent e8e491bdbf
commit 05b8017679
3 changed files with 21 additions and 15 deletions

25
README
View file

@ -8,7 +8,7 @@ another, and a command-line tool that uses this library. It can read
and [LaTeX]; and it can write plain text, [markdown], [reStructuredText],
[HTML], [LaTeX], [ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT],
[GNU Texinfo], [MediaWiki markup], [EPUB], [Textile], [groff man] pages,
and [Slidy] or [S5] HTML slide shows.
[Emacs Org-Mode], and [Slidy] or [S5] HTML slide shows.
Pandoc's enhanced version of markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, delimited code blocks,
@ -76,8 +76,9 @@ Supported output formats include `markdown`, `latex`, `context`
(reStructuredText), `docbook` (DocBook XML), `opendocument`
(OpenDocument XML), `odt` (OpenOffice text document), `texinfo`, (GNU
Texinfo), `mediawiki` (MediaWiki markup), `textile` (Textile),
`epub` (EPUB ebook), `man` (groff man), `slidy` (slidy HTML and
javascript slide show), or `s5` (S5 HTML and javascript slide show).
`epub` (EPUB ebook), `man` (groff man), `org` (Emacs Org-Mode),
`slidy` (slidy HTML and javascript slide show), or `s5`
(S5 HTML and javascript slide show).
Supported input formats include `markdown`, `textile`, `html`,
`latex`, and `rst`. Note that the `rst` reader only parses a subset of
@ -170,15 +171,18 @@ 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`, `textile`, `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.)
or `latex`. (`+lhs` can be appended to `html`, `markdown`, `latex`,
or `rst` 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`, `slidy`, `s5`,
`docbook`, `opendocument`, `latex`, `context`, `markdown`, `man`,
`plain`, `rst`, and `rtf`. (`+lhs` can be appended to indicate that
`docbook`, `opendocument`, `odt`, `epub`, `latex`, `context`,
`markdown`, `man`, `plain`, `mediawiki`, `texinfo`, `textile`, `org`,
`plain`, `rst`, and `rtf`. (`+lhs` can be appended to `html`,
`markdown`, `rst`, or `latex` to indicate that
the output should be treated as literate Haskell source. See
[Literate Haskell support](#literate-haskell-support), below.)
@ -1217,8 +1221,8 @@ 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.
reStructuredText, LaTeX, Org-Mode, and ConTeXt output, it will appear
verbatim between $ characters.
In reStructuredText output, it will be rendered using an interpreted
text role `:math:`, as described
@ -1474,6 +1478,7 @@ and pasted as literate Haskell source.
[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/
[Emacs Org-Mode]: http://org-mode.org
[EPUB]: http://www.idpf.org/
[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

View file

@ -16,8 +16,8 @@ Pandoc converts files from one markup format to another. It can
read markdown and (subsets of) Textile, reStructuredText, HTML, and LaTeX,
and it can write plain text, markdown, reStructuredText, HTML, LaTeX,
ConTeXt, Texinfo, groff man, MediaWiki markup, Textile, RTF,
OpenDocument XML, ODT, DocBook XML, EPUB, and Slidy or S5 HTML slide
shows.
OpenDocument XML, ODT, DocBook XML, EPUB, Emacs Org-Mode, and
Slidy or S5 HTML slide shows.
If no *input-file* is specified, input is read from *stdin*.
Otherwise, the *input-files* are concatenated (with a blank
@ -73,8 +73,8 @@ should pipe input and output through `iconv`:
: Specify output format. *FORMAT* can be `native` (native Haskell),
`plain` (plain text), `markdown` (markdown), `rst` (reStructuredText),
`html` (HTML), `latex` (LaTeX), `context` (ConTeXt), `man` (groff man),
`mediawiki` (MediaWiki markup), `textile` (Textile),
`texinfo` (GNU Texinfo), `docbook` (DocBook XML),
`mediawiki` (MediaWiki markup), `textile` (Textile), `org` (Emacs
Org-Mode), `texinfo` (GNU Texinfo), `docbook` (DocBook XML),
`opendocument` (OpenDocument XML), `odt` (OpenOffice text document),
`epub` (EPUB book), `slidy` (Slidy HTML and javascript slide show),
`s5` (S5 HTML and javascript slide show), or `rtf` (rich text

View file

@ -19,7 +19,8 @@ Description: Pandoc is a Haskell library for converting from one markup
reStructuredText, HTML, LaTeX and Textile, and it can write
markdown, reStructuredText, HTML, LaTeX, ConTeXt, Docbook,
OpenDocument, ODT, RTF, MediaWiki, Textile, groff man pages,
EPUB, and S5 and Slidy HTML slide shows.
plain text, Emacs Org-Mode, EPUB, and S5 and Slidy HTML
slide shows.
.
Pandoc extends standard markdown syntax with footnotes,
embedded LaTeX, definition lists, tables, and other