mathml/README.md

# Automated LuaLaTeX math to MathML conversion
**Highly experimental! At this point all interfaces may change without prior warning and many features aren't implemented yet. It is not ready for anything beyond simple experiments.**

This is an attempt to implement automatic conversion of LuaLaTeX inline and display math expressions into MathML code to aid with tagging.
It works best with `unicode-math`, but it can also be used with traditional math fonts if mappings to Unicode are provided.

## Installation
Run `l3build install` to install `luamml` into your local `texmf` tree.

## Demo
Run `lualatex test_tex` to see all equations from [our example file](./test_tex.tex) converted into MathML. 

To test it on your own files, add `\usepackage[tracing]{luamml-demo}` (to print MathML to the terminal) or `\usepackage[files]{luamml-demo}` to generate separate files with MathML output.
Also see a [`tagpdf` experiment using this to tag PDF formulas](https://github.com/u-fischer/tagpdf/blob/develop/experiments/exp-mathml-lua.tex).

If you are very brave you can also try running `pdflatex test_pdf` and afterwards run `./pdfmml.lua test_pdf.lua` to get pdflatex formulas converted.
Add README 2021-05-03 23:20:48 +02:00			`# Automated LuaLaTeX math to MathML conversion`
			`Highly experimental! At this point all interfaces may change without prior warning and many features aren't implemented yet. It is not ready for anything beyond simple experiments.`

			`This is an attempt to implement automatic conversion of LuaLaTeX inline and display math expressions into MathML code to aid with tagging.`
			It works best with `unicode-math`, but it can also be used with traditional math fonts if mappings to Unicode are provided.

			`## Installation`
			Run `l3build install` to install `luamml` into your local `texmf` tree.

			`## Demo`
			Run `lualatex test_tex` to see all equations from [our example file](./test_tex.tex) converted into MathML.

Reference demo package in README 2021-12-17 08:37:21 +01:00			To test it on your own files, add `\usepackage[tracing]{luamml-demo}` (to print MathML to the terminal) or `\usepackage[files]{luamml-demo}` to generate separate files with MathML output.
Add README 2021-05-03 23:20:48 +02:00			Also see a [`tagpdf` experiment using this to tag PDF formulas](https://github.com/u-fischer/tagpdf/blob/develop/experiments/exp-mathml-lua.tex).
Update README 2021-06-01 23:36:41 +02:00
			If you are very brave you can also try running `pdflatex test_pdf` and afterwards run `./pdfmml.lua test_pdf.lua` to get pdflatex formulas converted.