Haskell Haddock乳胶方程式在评论中

时间:2014-06-15 12:57:21

标签: haskell documentation latex haddock

我想在源代码中使用乳胶表示法来表示方程式。 例如,我会在一些haskell源文件Equations.hs中写下以下注释:

-- | $v = \frac{dx}{dt}$

doc目录中,这会被Equations.tex中的haddock渲染为:

{\char '44}v = frac{\char '173}dx{\char '175}{\char '173}dt{\char '175}{\char '44}

我在Haddock的乳胶后端的源代码中发现了这个函数,它取代了乳胶格式化中使用的许多字符:

latexMunge :: Char -> String -> String
...
latexMunge '$'  s = "{\\char '44}" ++ s

是否有任何现有功能允许我绕过它并在评论中插入乳胶方程式?

1 个答案:

答案 0 :(得分:3)

没有。这个(以及类似功能)不存在的主要原因是,它不清楚如何处理其他后端的标记,无论是HTML,还是其他人可能正在使用的其他任何内容。这是相当普遍的要求,但没有共同的协议,更重要的是没有补丁。

从技术上讲,我们不支持LaTeX后端,它一直在编译,以便生成Haskell报告。如果您或其他人想要给它一些新的生活(和功能),那么我们将乐意接受补丁。

tl;博士:没有办法。我知道人们只需预先渲染LaTeX并使用图像语法插入生成的图像。