aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-12-02 00:36:32 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-12-02 00:36:32 +0000
commitd1832da9e104d61aa6ee0161aefeabf4aef9bbd2 (patch)
tree2971739743b16e10d1333b5a6ad9f7b4bf12f4c3 /README
parent8e872f9f7d89dcc1f16309afd7a50945f2c154ee (diff)
downloadpandoc-d1832da9e104d61aa6ee0161aefeabf4aef9bbd2.tar.gz
Added Text.Pandoc.Readers.TeXMath and changed default handling of math.
+ Text.Pandoc.Readers.TeXMath exports readTeXMath, which reads raw TeX math and outputs a string of pandoc inlines that tries to render it as far as possible, lapsing into literal TeX when needed. + Added Text.Pandoc.Readers.TeXMath to pandoc.cabal + ghc66 version. + Modified writers so that readTeXMath is used for default HTMl output in HTML, S5, RTF, Docbook. + Updated README with information about how math is rendered in all formats. + Updated test suite. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1129 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 16 insertions, 8 deletions
diff --git a/README b/README
index 1bec255ab..d58669987 100644
--- a/README
+++ b/README
@@ -846,12 +846,23 @@ closing $ must have a character immediately to its left. Thus,
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, LaTeX, and
-ConTeXt output, it will appear between $ characters, so that it may be
-treated as math. In HTML and S5 output, there are four possible ways
-to display math:
+TeX math will be printed in all output formats. In Markdown,
+reStructuredText, LaTeX, and ConTeXt output, it will appear verbatim
+between $ characters.
-1. The default is to display TeX math verbatim.
+In groff man output, it will be rendered verbatim without $'s.
+
+In RTF and Docbook output, it will be rendered, as far as possible,
+using unicode characters, and will otherwise appear verbatim. Unknown
+commands and symbols, and commands that cannot be dealt with this way
+(like `\frac`), will be rendered verbatim. So the results may be a mix
+of raw TeX code and properly rendered unicode math.
+
+In HTML and S5 output, the way math is rendered will depend on the
+command-line options selected:
+
+1. The default is to render TeX math as far as possible using unicode
+ characters, as with RTF and Docbook output.
2. If the `--asciimathml` option is used, TeX math will be displayed
between $ characters, as in LaTeX, and the [ASCIIMathML] script will
@@ -877,9 +888,6 @@ to display math:
gladtex -d myfile-images myfile.htex # produces myfile.html
# and images in myfile-images
-In other output formats, TeX math will appear verbatim, with no enclosing
-$'s.
-
Inline TeX
----------