aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2010-12-03 23:50:03 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2010-12-03 23:50:03 -0800
commit5171de66c53b4117fd0f4b16ef53d037cce38eb4 (patch)
treedc49c9d291321ec35bfb99dad4285c42104a3ad8
parent357b965b4455422cfdeb2676befda31d017f944f (diff)
downloadpandoc-5171de66c53b4117fd0f4b16ef53d037cce38eb4.tar.gz
Updated README and pandoc man page with textile reader.
-rw-r--r--README27
-rw-r--r--man/man1/pandoc.1.md10
2 files changed, 19 insertions, 18 deletions
diff --git a/README b/README
index 6440272ad..6ce1e13f7 100644
--- a/README
+++ b/README
@@ -4,11 +4,11 @@
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], [EPUB], [Textile], [groff man] pages, and [Slidy]
-or [S5] HTML slide shows.
+[markdown] and (subsets of) [Textile], [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], [EPUB], [Textile], [groff man] pages,
+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,
@@ -79,11 +79,12 @@ 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).
-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.
+Supported input formats include `markdown`, `textile`, `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 `textile`, `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
@@ -168,8 +169,8 @@ 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
+ *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.)
@@ -1314,7 +1315,7 @@ and ConTeXt.
Citations
---------
-
+TODO
Producing HTML slide shows with Pandoc
======================================
diff --git a/man/man1/pandoc.1.md b/man/man1/pandoc.1.md
index f6cb7e3a6..88c072ccc 100644
--- a/man/man1/pandoc.1.md
+++ b/man/man1/pandoc.1.md
@@ -13,8 +13,8 @@ pandoc [*options*] [*input-file*]...
# DESCRIPTION
Pandoc converts files from one markup format to another. It can
-read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
-it can write plain text, markdown, reStructuredText, HTML, LaTeX,
+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.
@@ -65,9 +65,9 @@ should pipe input and output through `iconv`:
-f *FORMAT*, -r *FORMAT*, \--from=*FORMAT*, \--read=*FORMAT*
: Specify input format. *FORMAT* can be
`native` (native Haskell), `markdown` (markdown or plain text),
- `rst` (reStructuredText), `html` (HTML), or `latex` (LaTeX).
- If `+lhs` is appended to `markdown`, `rst`, or `latex`, the input
- will be treated as literate Haskell source.
+ `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
+ or `latex` (LaTeX). If `+lhs` is appended to `markdown`, `rst`,
+ or `latex`, the input will be treated as literate Haskell source.
-t *FORMAT*, -w *FORMAT*, \--to=*FORMAT*, \--write=*FORMAT*
: Specify output format. *FORMAT* can be `native` (native Haskell),