summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 27 insertions, 11 deletions
diff --git a/README b/README
index 05af25c31..230ad9c5b 100644
--- a/README
+++ b/README
@@ -328,19 +328,28 @@ For further documentation, see the `pandoc(1)` man page.
no *url* is provided, the contents of the script will be inserted
directly; this provides portability at the price of efficiency. If
you plan to use math on several pages, it is much better to link to
- a copy of `LaTeXMathML.js`, which can be cached. (See `--gladtex`
- and `--mimetex` for alternative ways of dealing with math in HTML.)
+ a copy of `LaTeXMathML.js`, which can be cached. (See `--jsmath`,
+ `--gladtex`, and `--mimetex` for alternative ways of dealing with
+ math in HTML.)
+
+`--jsmath`*=[url]*
+: causes `pandoc` to use the [jsMath] script to display
+ TeX math in HTML or S5. The *url* should point to the jsMath load
+ script (e.g. `jsMath/easy/load.js`). If it is provided, a link to it
+ will be included in the header of standalone HTML documents.
+ (See `--latexmathml`, `--mimetex`, and `--gladtex` for alternative
+ ways of dealing with math in HTML.)
`--gladtex`*[=url]*
: causes TeX formulas to be enclosed in `<eq>` tags in HTML or S5 output.
This output can then be processed by [gladTeX] to produce links to
- images with the typeset formulas. (See `--latexmathml` and
+ images with the typeset formulas. (See `--latexmathml`, `--jsmath`, and
`--mimetex` for alternative ways of dealing with math in HTML.)
`--mimetex`*[=url]*
: causes TeX formulas to be replaced by `<img>` tags linking to the
[mimeTeX] CGI script, which will produce images with the typeset
- formulas. (See `--latexmathml` and `--gladtex` for alternative
+ formulas. (See `--latexmathml`, `--jsmath`, and `--gladtex` for alternative
ways of dealing with math in HTML.)
`-i` or `--incremental`
@@ -397,6 +406,7 @@ For further documentation, see the `pandoc(1)` man page.
[Smartypants]: http://daringfireball.net/projects/smartypants/
[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
+[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
[gladTeX]: http://www.math.uio.no/~martingu/gladtex/index.html
[mimeTeX]: http://www.forkosh.com/mimetex.html
@@ -924,18 +934,24 @@ command-line options selected:
styled differently from the surrounding text if needed.
2. If the `--latexmathml` option is used, TeX math will be displayed
- between $ characters, as in LaTeX, and the [LaTeXMathML] script will
- be used to render it as formulas. (This trick does not work in all
- browsers, but it works in Firefox. In browsers that do not support
- LaTeXMathML, TeX math will appear verbatim between $ characters.)
-
-3. If the `--mimetex` option is used, the [mimeTeX] CGI script will
+ between $ or $$ characters and put in `<span>` tags with class `LaTeX`.
+ The [LaTeXMathML] script will be used to render it as formulas.
+ (This trick does not work in all browsers, but it works in Firefox.
+ In browsers that do not support LaTeXMathML, TeX math will appear
+ verbatim between $ characters.)
+
+3. If the `--jsmath` option is used, TeX math will be put inside
+ `<span>` tags (for inline math) or `<div>` tags (for display math)
+ with class `math`. The [jsMath] script will be used to render
+ it.
+
+4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
be called to generate images for each TeX formula. This should
work in all browsers. The `--mimetex` option takes an optional URL
as argument. If no URL is specified, it will be assumed that the
mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
-4. If the `--gladtex` option is used, TeX formulas will be enclosed
+5. If the `--gladtex` option is used, TeX formulas will be enclosed
in `<eq>` tags in the HTML output. The resulting `htex` file may then
be processed by [gladTeX], which will produce image files for each
formula and an `html` file with links to these images. So, the