texmath

# texmath

[![CI
tests](https://github.com/jgm/texmath/workflows/CI%20tests/badge.svg)](https://github.com/jgm/texmath/actions)

texmath is a Haskell library for converting between formats used to
represent mathematics.  Currently it provides functions to read and
write TeX math, presentation MathML, and OMML (Office Math Markup
Language, used in Microsoft Office), and to write Gnu eqn, typst,
StarMath (used by LibreOffice), and [pandoc]'s native format
(allowing conversion, using pandoc, to a variety of different
markup formats). The TeX reader and writer supports basic LaTeX
and AMS extensions, and it can parse and apply LaTeX macros. The
package also includes several utility modules which may be useful
for anyone looking to manipulate either TeX math or MathML. For
example, a copy of the MathML operator dictionary is included.

[pandoc]: http://github.com/jgm/pandoc

You can [try it out online here](http://johnmacfarlane.net/texmath.html).

By default, only the Haskell library is installed.  To install a
test program, `texmath`, use the `executable` Cabal flag:

    cabal install -fexecutable

By default, the executable will be installed in `~/.cabal/bin`.

The `texmath` binary will be put in `~/.local/bin`.

Macro definitions may be included before a LaTeX formula.

# Running texmath as a server

`texmath` will behave as a CGI script when called under the name
`texmath-cgi` (e.g. through a symbolic link).

But it is also possible to compile a full webserver with a JSON
API.  To do this, set the `server` cabal flag, e.g.

    cabal install -fserver

To run the server on port 3000:

    texmath-server -p 3000

Sample of use, with `httpie`:

```
% http --verbose localhost:3000 text='2^2' from=tex to=mathml display:=false Accept:'text/plain'
POST /convert HTTP/1.1
Accept: text/plain
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 64
Content-Type: application/json
Host: localhost:3000
User-Agent: HTTPie/3.1.0

{
    "display": false,
    "from": "tex",
    "text": "2^2",
    "to": "mathml"
}


HTTP/1.1 200 OK
Content-Type: text/plain;charset=utf-8
Date: Mon, 21 Mar 2022 18:29:26 GMT
Server: Warp/3.3.17
Transfer-Encoding: chunked

<math display="inline" xmlns="http://www.w3.org/1998/Math/MathML">
  <msup>
    <mn>2</mn>
    <mn>2</mn>
  </msup>
</math>
```

Possible values for `from` are `tex`, `mathml`, and `omml`.
Possible values for `to` are `tex`, `mathml`, `omml`, `eqn`,
`typst` and `pandoc` (JSON-encoded Pandoc).

Alternatively, you can use the `/batch` endpoint, passing
in in a JSON-encoded list of conversions and getting back a
JSON-encoded list of results.

If you rename `pandoc-server` to `pandoc-server.cgi`, it will
function as a CGI program that accepts POST requests.

# Generating lookup tables

There are three main lookup tables which are built form externally compiled lists.
This section contains information about how to modify and regenerate these tables.

In the `lib` direction there are two sub-directories wh