如何在Haddock文档中生成表格

Question

我正在使用 Haddock 编写文档，需要在其中放置一个包含多个列和对应值的表格。如何使用 Haddock 实现呢？目前没有查找到相关信息。似乎也不可能将 HTML 代码嵌入其中作为替代方案。

- Randomize

---

我认为没有适当的表格支持。你可能只能使用图像文件。 - leftaroundabout

现在Haddock已经支持MathJax了，因此可以使用例如\begin{matrix}和\mathrm{...}来创建表格 - 这可能不是很好，但可能比图像文件更好。或者，您可以将表格支持添加到Haddock中 - 代码不难修改，但您必须担心除HTML之外的输出格式。 - idontgetoutmuch

Answer 1

GHC 8.4或更高版本（Haddock版本>=2.18.2）附带的Haddock支持表格。根据添加此功能的拉取请求，语法基于RST Grid表格。

示例用法：

module Sample where

-- | A table:
--
-- +------------------------+------------+----------+----------+
-- | Header row, column 1   | Header 2   | Header 3 | Header 4 |
-- | (header rows optional) |            |          |          |
-- +========================+============+==========+==========+
-- | body row 1, column 1   | column 2   | column 3 | column 4 |
-- +------------------------+------------+----------+----------+
-- | body row 2             | Cells may span columns.          |
-- +------------------------+------------+---------------------+
-- | body row 3             | Cells may  | \[                  |
-- +------------------------+ span rows. | f(n) = \sum_{i=1}   |
-- | body row 4             |            | \]                  |
-- +------------------------+------------+---------------------+
sample :: ()
sample = ()

转变为

- Alec

Answer 2

Haddock "标记语言" 目前不支持表格，更多信息请参见Haddock用户指南-第三章。文档和标记。有一个开放问题来增加对简单表格的支持。

- Giovanni Cappellotto