/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: 2019-01-03 12:28:20 UTC
  • Revision ID: distler@golem.ph.utexas.edu-20190103122820-rqnrpbgnq8784vrk
New version of MovableType plugin

Show diffs side-by-side

added added

removed removed

README
1
1
INTRODUCTION:
2
2
 
3
 
This package contains the distribution for itex2MML. Binaries for MacOSX and
4
 
Linux are provided in the itex-binaries directory. The source code is in the
 
3
This package contains the distribution for itex2MML. The source code is in the
5
4
itex-src directory. It should compile on most platforms by simply typing
6
5
 
7
6
     make
22
21
     make test_ruby
23
22
     sudo make install_ruby
24
23
 
25
 
The Ruby module provides four public methods
 
24
The Rubygem provides four public methods
26
25
 
27
26
       require 'itextomml'
28
27
       itex =  Itex2MML::Parser.new
47
46
               
48
47
Note that the commandline tool and the Ruby library return MathML named entities in the output.
49
48
On the public web, it is safest to convert these either to utf-8 characters or to NCRs. For that,
50
 
you can use the Perl library, MathML::Entities (available from CPAN) or the String methods
 
49
the itex_stringsupport.rb library included with the Rubygem adds the following methods to the String class
51
50
  String#to_ncr
52
51
  String to_utf8
53
52
  String#to_ncr!
54
53
and
55
54
  String#to_utf8!
56
 
provided for that purpose in the itex_stringsupport.rb library included with the Rubygem.
 
55
 
 
56
For Perl users, there are Perl modules, MathML::itex2MML and MathML::Entities (both available on CPAN), which
 
57
provide exactly the same functionality as described for the Rubygem.
57
58
 
58
59
Finally, there is a MovableType (2.6 or greater) plugin which provides two
59
60
Text Filtering options:
61
62
1) itex to MathML
62
63
2) itex to MathML with parbreaks
63
64
 
64
 
The plugin relies on the itex2MML commandline utility to do the actual
 
65
The plugin relies on the MathML::itex2MML Perl module (which you'll need to install) to do the actual
65
66
conversion. The first filter is a straight itex2MML translation. The latter
66
67
uses the "TeX" (and blogger's) convention that two linebreaks in succession
67
68
signify a new paragraph. (The bloggers also like to convert single linebreaks
81
82
See
82
83
      http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html
83
84
 
84
 
and Paul Gartside's page
85
 
 
86
 
      http://pear.math.pitt.edu/mathzilla/itex2mml.html
87
 
 
88
85
for more details on composing in itex and using the itex2MML program.
89
86
The version of itex2MML included here is greatly-enhanced, with
90
87
many bugfixes and support for a larger subset of LaTeX/AMSLaTeX syntax.
140
137
cd into the itex-src directory and type "make". The result should be an itex2MML
141
138
binary for your architecture.
142
139
 
143
 
3) Copy itex2MML into /usr/local/bin/, and make sure it's executable
144
 
(mode 755). If you're building from source, you can achieve this by typing
145
 
"make install". If you decide to put it in another location, edit
146
 
itex2MML.pl to reflect its new location.
 
140
3) Run
 
141
  cpan install MathML::itex2MML
 
142
 
 
143
to install the Perl Module
147
144
 
148
145
Itex2MML is Open Source software, released under a triple license: GPL, MPL and LGPL.