git.iko.soy/typeable/pandoc
on master help sign in
Updated documentation on ASCIIMathML.js.

git-svn-id: https://pandoc.googlecode.com/svn/trunk@800 788f1e2b-df1e-0410-8736-df70ead52e1b

commit622606bae9ce0c1d55bb7e104919b6b1fc76910b authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateThu 26 Jul 2007, 02:40 (19 years ago) parentf2e21a8
2 files changed+18−19
README+14−18 man/man1/pandoc.1.md+4−1
README+14−18
@@ -309,11 +309,17 @@ For further documentation, see the `pandoc(1)` man page.
309309 It is selected automatically when the output format is `latex` or
310310 `context`.)
311311
312−`-m` or `--asciimathml`
312+`-m`*[URL]* or `--asciimathml=`*[URL]*
313313: will cause LaTeX formulas (between $ signs) in HTML or S5 to display
314314 as formulas rather than as code. The trick will not work in all
315315 browsers, but it works in Firefox. Peter Jipsen's [ASCIIMathML]
316− script is used to do the magic.
316+ script is used to do the magic. If a local copy of `ASCIIMathML.js`
317+ is available on the webserver where the page will be viewed,
318+ provide a *URL* and a link will be inserted in the generated
319+ HTML or S5. If no *URL* is provided, the contents of the script
320+ will be inserted directly; this provides portability at the price of
321+ efficiency. If you plan to use math on several pages, it is much
322+ better to link to a copy of `ASCIIMathML.js`, which can be cached.
317323
318324`-i` or `--incremental`
319325: causes all lists in S5 output to be displayed incrementally by
@@ -784,10 +790,9 @@ closing $ must have a character immediately to its left. Thus,
784790`$20,000 and $30,000` won't parse as math. The $ character can be
785791escaped with a backslash if needed.
786792
787−If you pass the `-m` (`--asciimathml`) option to `pandoc`, it will
788−embed the [ASCIIMathML] script in the resulting HTML. This will
789−cause LaTeX math to be displayed as formulas in better
790−browsers.[^2]
793+Pandoc can use the [ASCIIMathML] script to display LaTeX formulas
794+in HTML (at least on better browsers). See above on the
795+`-m|--asciimathml` command-line option.
791796
792797[ASCIIMathML]: http://www1.chapman.edu/~jipsen/asciimath.html
793798
@@ -797,7 +802,7 @@ include BibTeX citations:
797802
798803 This result was proved in \cite{jones.1967}.
799804
800−You can also use LaTeX environments. For example,
805+Note that in LaTeX environments, like
801806
802807 \begin{tabular}{|l|l|}\hline
803808 Age & Frequency \\ \hline
@@ -806,17 +811,8 @@ You can also use LaTeX environments. For example,
806811 36--45 & 22 \\ \hline
807812 \end{tabular}
808813
809−Note, however, that material between the begin and end tags will
810−be interpreted as raw LaTeX, not as markdown.
811−
812−[^2]: If you are serving several pages that use ASCIIMathML, it will be
813− more efficient to link to an external copy of `ASCIIMathML.js`
814− instead of using the `-m|--asciimathml` option to embed it directly
815− in web pages. To do this, get a copy of `ASCIIMathML.js` from the
816− [ASCIIMathML] website and make it available on your webserver. Then
817− create a custom header for your web page that includes the line
818−
819− <script src="/path/to/ASCIIMathML.js"></script>
814+the material between the begin and end tags will be interpreted as raw
815+LaTeX, not as markdown.
820816
821817Custom headers
822818==============
man/man1/pandoc.1.md+4−1
@@ -101,8 +101,11 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
101101 only when the input format is `markdown`. It is selected automatically
102102 when the output format is `latex` or `context`.)
103103
104−-m, \--asciimathml
104+-m*URL*, \--asciimathml=*URL*
105105: Use ASCIIMathML to display embedded LaTeX math in HTML output.
106+ To insert a link to a local copy of the `ASCIIMathML.js` script,
107+ provide a *URL*. If no *URL* is provided, the contents of the
108+ script will be inserted directly into the HTML header.
106109
107110-i, \--incremental
108111: Make list items in S5 display incrementally (one by one).