About Blahcaml

Blahcaml provides basic Ocaml bindings to the Blahtex library. Blahtex is written in C++, and aims at the conversion of TeX equations into MathML. Blahtex was originally designed by David Harvey, but is currently maintained by Gilles van Assche.

Blahcaml is developed by Dario Teixeira and is licensed under the terms of the GNU GPL 2.0.

Status

Blahcaml is now at version 2.1, and can be considered stable. The library is composed of two modules: Mathml2dtd and Blahcaml. The former provides low-level access to the MathML2 DTD, and should not be required by most users; The latter module contains facilities for performing both safe and unsafe conversions from TeX into MathML. Basically, an unsafe conversion simply invokes the underlying Blahtex code, while a safe conversion adds a subsequent validation of the generated MathML against the official MathML2 DTD [2].

Dependencies

On the Ocaml side, Blahcaml depends on PXP. PXP is used by the "safe" functions for validating the generated MathML against the official MathML2 DTD.

There is no need to get the Blahtex code because the Blahcaml tarball ships with a snapshot of the relevant code from Blahtex. This turned out to be the most practical solution because presently the Blahtex source has no provisions for building just the library and assumes that developers will just copy the code into their own projects.

The Blahtex code is contained in the src/blahtexcore, src/unicodeconverter, and src/messages directories, and except for the makefiles, is bundled in a pristine form. The copyright of this code is of course that of the Blahtex authors.

Downloads and development

Blahcaml is distributed in source-code form. You can get all releases from the project's page at GitHub or the OCaml Forge. The latest version is Blahcaml 2.1, released on 2013-07-18. Here is the changelog for the last few releases:

Version 2.1 (2013-07-18)

Version 2.0 (2010-02-03)

Bulding and Installing

Change into the src directory and issue make to build the Blahtex code and the Blahcaml bindings. Note that the C++ portions require g++. After building, make install will perform a Findlib installation. To generate the ocamldoc API documentation, use make apidoc.

Documentation

You can browse the Ocamldoc generated API documentation online.

License

Blahcaml is licensed under the terms of the GPL version 2. The Blahtex portions bundled with the Blahcaml tarball are licensed in the same terms. The tarball includes also the official MathML2 DTD from the W3C. Check the COPYRIGHT file in the 'src/mathml2dtd/mathml2dtd.d' directory for details.

Links