/itexToMML

To download this project, use:
bzr branch http://golem.ph.utexas.edu/~distler/code/itexToMML/

« back to all changes in this revision

Viewing changes to README

  • Committer: Jacques Distler
  • Date: 2007-01-17 07:00:16 UTC
  • Revision ID: distler@golem.ph.utexas.edu-20070117070016-meaagnft95pf7ww1
Update MovableType plugin to support equation numbering and cross-referencing.
Bundle the TextileMarkdownMML plugin.

Show diffs side-by-side

added added

removed removed

README
7
7
     make
8
8
     sudo make install
9
9
 
 
10
The resulting itex2MML binary is a stream filter. It takes text with embedded
 
11
itex equations on STDIN, converts the itex equations to MathML, and outputs
 
12
the resulting text on STDOUT.
 
13
 
10
14
Also included are Ruby bindings. They require GNU make and SWIG 1.3, and can be
11
15
built with
12
16
 
36
40
 
37
41
Finally, there is a MovableType (2.6 or greater) plugin which provides two
38
42
Text Filtering options:
 
43
 
39
44
1) itex to MathML
40
45
2) itex to MathML with parbreaks
41
46
 
45
50
signify a new paragraph. (The bloggers also like to convert single linebreaks
46
51
to <br />, but that would mess with TeX formula entry, so we don't support it.)
47
52
 
48
 
Another plugin, which adds itex support to the Textile and Markdown text
49
 
filters is available separately from 
 
53
A second plugin (also included) provides additionalText Filtering options:
 
54
 
 
55
1) Textile with itex to MathML
 
56
2) Markdown with itex to MathML
 
57
 
 
58
Details describing this plugin are available at: 
50
59
 
51
60
    http://golem.ph.utexas.edu/~distler/blog/archives/000374.html
52
61
 
53
 
To use it, you need both this plugin and the Textile and/or Markdown plugins
54
 
installed.
 
62
It requires both the itex2MML plugin and the Textile and/or Markdown plugins.
55
63
 
56
64
See
57
65
      http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html
58
 
and the itex2MML homepage 
 
66
 
 
67
and Paul Gartside's page
 
68
 
59
69
      http://pear.math.pitt.edu/mathzilla/itex2mml.html
 
70
 
60
71
for more details on composing in itex and using the itex2MML program.
61
 
The version of itex2MML included here is a greatly-enhanced version, with
 
72
The version of itex2MML included here is greatly-enhanced, with
62
73
many bugfixes and support for a larger subset of LaTeX/AMSLaTeX syntax.
63
74
 
64
75
Below I've put some simple notes specific to the use of this plugin.
71
82
in your text. If you want to enter something that renders as a $, use
72
83
the unicode entity &#36;.
73
84
 
 
85
2) The itex2MML stream filter does not distinguish between $$...$$ and \[...\].
 
86
Both result in display equations. However, the MovableType plugin and Maruku
 
87
 
 
88
    http://maruku.rubyforge.org/
 
89
 
 
90
the Ruby Markdown implementation, do distinguish between them. Both have
 
91
automatic equation-numbering: \[...\] results in a numbered equation. You
 
92
can add an optional label
 
93
 
 
94
    \[...\label{foo}...\]
 
95
 
 
96
and then you can refer to the equation with either (eq:foo) or \eqref{foo}.
 
97
These are automatically turned into hyperlinks.
 
98
 
74
99
2) If you are using the "itex to MathML with parbreaks" filter, paragraph
75
 
breaks are inserted automatically. So
76
 
 
77
 
              Some text is here.
78
 
 
79
 
              Some more text
80
 
              \[    display equation    \]
81
 
              Yet more text.
82
 
 
83
 
              And still more.
84
 
 
85
 
gets turned into three paragraphs.  If you are using the plain
86
 
"itex to MathML" filter, you need to put in the paragraph breaks
87
 
yourself, so the above would look like
88
 
 
89
 
              <p>Some text is here. </p>
90
 
              <p>Some more text
91
 
              \[    display equation    \]
92
 
              Yet more text.</p>         
93
 
              <p>And still more.</p>
 
100
breaks are inserted automatically, whenever you insert a blank line in your
 
101
text.  If you are using the plain "itex to MathML" filter, you need to put
 
102
in the paragraph (and any other) XHTML tags yourself.
94
103
 
95
104
3) Mozilla only renders MathML when you serve the document as XML (ie
96
 
using the MIME type application/xhtml+xml rather than text/html). You had better
97
 
be producing 100% valid XHTML if you want to see *anything* when Mozilla
 
105
using the MIME type application/xhtml+xml rather than text/html). You had
 
106
better be producing 100% valid XHTML if you want to see *anything* when Mozilla
98
107
is operating in that mode.
99
108
 
100
109
4)The best way to serve up XML to Mozilla, while still catering to
103
112
    http://golem.ph.utexas.edu/~distler/blog/archives/000167.html
104
113
for how to do that.
105
114
 
106
 
INSTALLATION INSTRUCTIONS:
 
115
PLUGIN INSTALLATION INSTRUCTIONS:
107
116
 
108
 
1) Put itex2MML.pl in your MovableType plugins directory.
 
117
1) Put the contents of the plugins directory into your MovableType plugins
 
118
directory.
109
119
 
110
120
2) If you are running MacOSX or Linux, I've provided a precompiled binary,
111
121
so you can skip to step 3).
114
124
binary for your architecture.
115
125
 
116
126
3) Copy itex2MML into /usr/local/bin/, and make sure it's executable
117
 
(mode 755). If you decide to put it in another location, you merely have
118
 
to edit itex2MML.pl to reflect its new location.
 
127
(mode 755). If you're building from source, you can achieve this by typing
 
128
"make install". If you decide to put it in another location, edit
 
129
itex2MML.pl to reflect its new location.
119
130
 
120
131
As with Paul Gartside's original version,
121
132
 
122
133
  http://pear.math.pitt.edu/mathzilla/itex2mmlBugs.html
123
134
 
124
135
itex2MML is Open Source software, released under a dual license: GPL and MPL.
125