git.iko.soy/typeable/pandoc
on master help sign in
Documented docx reader in README.
commit75a2b2fda199bc71ebbf4825a189efcf255732ad authorJohn MacFarlane <fiddlosopher@gmail.com> dateThu 19 Jan 2012, 23:26 (15 years ago) parent12c96fe
1 file changed+29−15
README+29−15
README+29−15
@@ -15,7 +15,7 @@ another, and a command-line tool that uses this library. It can read
1515[markdown] and (subsets of) [Textile], [reStructuredText], [HTML],
1616and [LaTeX]; and it can write plain text, [markdown], [reStructuredText],
1717[XHTML], [HTML 5], [LaTeX], [LaTeX beamer], [ConTeXt], [RTF], [DocBook XML],
18−[OpenDocument XML], [ODT], [GNU Texinfo], [MediaWiki markup], [EPUB],
18+[OpenDocument XML], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup], [EPUB],
1919[Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc], and [Slidy],
2020[DZSlides], or [S5] HTML slide shows.
2121
@@ -40,8 +40,8 @@ Using Pandoc
4040If no *input-file* is specified, input is read from *stdin*.
4141Otherwise, the *input-files* are concatenated (with a blank
4242line between each) and used as input. Output goes to *stdout* by
43−default (though output to *stdout* is disabled for the `odt` and
44−`epub` output formats). For output to a file, use the `-o` option:
43+default (though output to *stdout* is disabled for the `odt`, `docx`,
44+and `epub` output formats). For output to a file, use the `-o` option:
4545
4646 pandoc -o output.html input.txt
4747
@@ -156,14 +156,14 @@ Options
156156 (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup), `textile`
157157 (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo), `docbook`
158158 (DocBook XML), `opendocument` (OpenDocument XML), `odt` (OpenOffice text
159− document), `epub` (EPUB book), `asciidoc` (AsciiDoc), `slidy` (Slidy HTML
160− and javascript slide show), `dzslides` (HTML5 + javascript slide show),
161− `s5` (S5 HTML and javascript slide show), or `rtf` (rich text format).
162− Note that `odt` and `epub` output will not be directed to *stdout*;
163− an output filename must be specified using the `-o/--output` option.
164− If `+lhs` is appended to `markdown`, `rst`, `latex`, `html`, or `html5`,
165− the output will be rendered as literate Haskell source: see [Literate
166− Haskell support](#literate-haskell-support), below.
159+ document), `docx` (Word docx), `epub` (EPUB book), `asciidoc` (AsciiDoc),
160+ `slidy` (Slidy HTML and javascript slide show), `dzslides` (HTML5 +
161+ javascript slide show), `s5` (S5 HTML and javascript slide show), or
162+ `rtf` (rich text format). Note that `odt` and `epub` output will not be
163+ directed to *stdout*; an output filename must be specified using the
164+ `-o/--output` option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
165+ `html`, or `html5`, the output will be rendered as literate Haskell source:
166+ see [Literate Haskell support](#literate-haskell-support), below.
167167
168168`-s`, `--standalone`
169169: Produce output with an appropriate header and footer (e.g. a
@@ -172,7 +172,7 @@ Options
172172`-o` *FILE*, `--output=`*FILE*
173173: Write output to *FILE* instead of *stdout*. If *FILE* is
174174 `-`, output will go to *stdout*. (Exception: if the output
175− format is `odt` or `epub`, output to stdout is disabled.)
175+ format is `odt`, `docx`, or `epub`, output to stdout is disabled.)
176176
177177`-p`, `--preserve-tabs`
178178: Preserve tabs instead of converting them to spaces (the default).
@@ -397,6 +397,16 @@ Options
397397 `--data-dir`). If this is not found either, sensible defaults will be
398398 used.
399399
400+`--reference-docx=`*FILE*
401+: Use the specified file as a style reference in producing a docx file.
402+ For best results, the reference docx should be a modified version
403+ of a docx file produced using pandoc. The contents of the reference docx
404+ are ignored, but its stylesheets are used in the new docx. If no
405+ reference docx is specified on the command line, pandoc will look
406+ for a file `reference.docx` in the user data directory (see
407+ `--data-dir`). If this is not found either, sensible defaults will be
408+ used.
409+
400410`--epub-stylesheet=`*FILE*
401411: Use the specified CSS file to style the EPUB. If no stylesheet
402412 is specified, pandoc will look for a file `epub.css` in the
@@ -494,9 +504,9 @@ Options
494504
495505 C:\Documents And Settings\USERNAME\Application Data\pandoc
496506
497− in Windows. A `reference.odt`, `epub.css`, `templates` directory,
498− or `s5` directory placed in this directory will override pandoc's
499− normal defaults.
507+ in Windows. A `reference.odt`, `reference.docx`,
508+ `epub.css`, `templates` directory, or `s5` directory placed in this
509+ directory will override pandoc's normal defaults.
500510
501511`--dump-args`
502512: Print information about command-line arguments to *stdout*, then exit.
@@ -1567,6 +1577,9 @@ RTF, DocBook, OpenDocument, ODT
15671577 ~ It will be rendered, if possible, using unicode characters,
15681578 and will otherwise appear verbatim.
15691579
1580+Docx
1581+ ~ It will be rendered using OMML math markup.
1582+
15701583HTML, Slidy, DZSlides, S5, EPUB
15711584 ~ The way math is rendered in HTML will depend on the
15721585 command-line options selected:
@@ -2080,3 +2093,4 @@ Christopher Sawicki, Kelsey Hightower.
20802093[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
20812094[DZSlides]: http://paulrouget.com/dzslides/
20822095[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
2096+[Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx