/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-12 15:59:05 UTC
  • Revision ID: distler@golem.ph.utexas.edu-20070112155905-xbx2sdw5zumxr1uj
Added two new methods to the Ruby bindings.

Show diffs side-by-side

added added

removed removed

README
14
14
     make test_ruby
15
15
     sudo make install_ruby
16
16
 
17
 
Also included is a MovableType (2.6 or greater) plugin which provides two
 
17
The Ruby module provides four public methods
 
18
 
 
19
       itex.html_filter(a_string)
 
20
               converts all itex equations in a_string to MathML, passing the
 
21
               rest of a_string unmodified. Returns the converted string. 
 
22
 
 
23
       itex.filter(a_string)
 
24
               converts all itex equations in a_string to MathML. Returns just
 
25
               the MathML equation(s), as a string.
 
26
 
 
27
       itex.inline_filter(a_string)
 
28
               treats a_string as an inline equation (automatically supplies
 
29
               the surrounding $...$, so you don't have to) and converts it
 
30
               MathML. Returns the MathML inline equation, as a string.
 
31
 
 
32
       itex.block_filter(a_string)
 
33
               treats a_string as a block equation (automatically supplies
 
34
               the surrounding $$...$$, so you don't have to) and converts it
 
35
               MathML. Returns the MathML block equation, as a string.
 
36
 
 
37
Finally, there is a MovableType (2.6 or greater) plugin which provides two
18
38
Text Filtering options:
19
39
1) itex to MathML
20
40
2) itex to MathML with parbreaks