texmath
texmath是一个Haskell库,用于在数学表示格式之间进行转换。目前它提供了读取和写入TeX数学公式、表示性MathML和OMML(Office Math Markup Language,用于Microsoft Office)的功能,以及写入Gnu eqn、typst和pandoc的原生格式(允许使用pandoc转换为多种不同的标记格式)。TeX读取器和写入器支持基本的LaTeX和AMS扩展,并且可以解析和应用LaTeX宏。该软件包还包含几个实用模块,可能对任何想要操作TeX数学或MathML的人有用。例如,包含了MathML运算符字典的副本。
你可以在这里在线试用。
默认情况下,只安装Haskell库。要安装测试程序texmath
,请使用executable
Cabal标志:
cabal install -fexecutable
默认情况下,可执行文件将安装在~/.cabal/bin
中。
或者,可以使用stack安装texmath。将stack二进制文件安装在路径中的某个位置。然后,在texmath仓库中,执行:
stack setup
stack install --flag texmath:executable
texmath
二进制文件将被放置在~/.local/bin
中。
在LaTeX公式之前可以包含宏定义。
将texmath作为服务器运行
当texmath
以texmath-cgi
的名称被调用时(例如通过符号链接),它将作为CGI脚本运行。
文件cgi/texmath.html
包含了如何使用它的示例。
但也可以编译一个带有JSON API的完整Web服务器。要做到这一点,设置server
cabal标志,例如:
stack install --flag texmath:server
要在3000端口运行服务器:
texmath-server -p 3000
使用示例,使用httpie
:
% http --verbose localhost:3000/convert 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>
from
可能的值为tex
、mathml
和omml
。
to
可能的值为tex
、mathml
、omml
、eqn
和pandoc
(JSON编码的Pandoc)。
或者,你可以使用convert-batch
端点传入JSON编码的转换列表,并获取JSON编码的结果列表。
生成查找表
有三个主要的查找表是从外部编译的列表构建的。本节包含有关如何修改和重新生成这些表的信息。
在lib
目录中有两个子目录,包含必要的文件。
MMLDict.hs
需要使用xsltproc
实用程序。
你可以在lib/mmldict/
中找到这些文件
- 如果需要,用更新版本替换
unicode.xml
(你可以从这里下载副本) xsltproc -o dictionary.xml operatorDictionary.xsl unicode.xml
runghc generateMMLDict.hs
- 用
mmldict.hs
的内容替换src/Text/TeXMath/Readers/MathML/MMLDict.hs
底部的运算符表
ToTeXMath.hs
你可以在lib/totexmath/
中找到这些文件
- 如果需要,用这里的更新版本替换
unimathsymbols.txt
runghc unicodetotex.hs
- 用
UnicodeToLaTeX.hs
的内容替换src/Text/TeXMath/Unicode/ToTeXMath.hs
底部的记录表
ToUnicode.hs
你可以在lib/tounicode/
中找到这些文件。
- 如果需要,用这里的更新版本替换
UnicodeData.txt
。 runghc mkUnicodeTable.hs
- 用输出替换
src/Text/TeXMath/Unicode/ToUnicode.hs
底部的表。
编辑表格
不需要编辑源文件来向表格添加记录。要添加或修改表格,更容易的方法是修改unicodetotex.hs
或generateMMLDict.hs
。这可以通过向相应的updates
列表添加项目来轻松实现。进行更改后,按照上述步骤重新生成表格。
测试套件
要运行测试套件,执行cabal test
或stack test
。
在标准模式下,测试套件将运行各个读取器和写入器的黄金测试。读取器测试可以在test/reader/{mml,omml,tex}
中找到,写入器测试在test/writer/{eqn,mml,omml,tex}
中。与特定问题相关的回归测试在test/regression
中。
每个测试文件由输入和预期输出组成。输入在<<< FORMAT
行之后开始,输出在>>> FORMAT
行之后开始。
如果由于更改而导致许多测试失败,但测试失败都是因为输出改进,你可以向测试套件传递--accept
(例如,在stack test
中使用--test-arguments=--accept
),现有的黄金文件将被覆盖。如果你这样做,请非常仔细地检查输出以确保它们是正确的。
如果你向测试套件传递--roundtrip
选项(例如,在stack test
中使用--test-arguments=--roundtrip
),将运行往返测试。其中许多将失败。在这些测试中,test/roundtrip/*.native
中的原生输入将分别转换为mml
、omml
或tex
,然后再转换回来,结果将与起点进行比较。虽然我们不保证这种往返转换将是恒等的,但查看失败的情况可以作为改进的指导。
作者
John MacFarlane编写了原始的TeX读取器、MathML写入器、Eq写入器和OMML写入器。Matthew Pickering贡献了MathML读取器、TeX写入器和许多辅助模块。Jesse Rosenthal贡献了OMML读取器。还要感谢John Lenz的诸多贡献。