Haddock编号列表延续

Question

如何使用haddock文档工具继续编号列表？黑线鳕的以下几行

--  1. First line.
-- 
--  2. Second line with instructions to do something 
-- 
--     >>> command-linecmd param
--
--  3. Third line..
--

生成下一个html:

</p><ol><li> First line.
</li><li> Second line with instructions to do something 
</li></ol><pre class="screen"><code class="prompt">&gt;&gt;&gt; </code><strong         class="userinput"><code>command-linecmd param
</code></strong></pre><ol><li> Third line..
</li></ol>

这打破了编号.有没有办法让黑线鳕继续使用HTML中的第三个数字,或者我应该尝试其他的东西(>>>给出一个很好的格式,我为什么要使用它)？

Answer 1

你不能。您正在使用>>>. 为了将此作为示例呈现，它需要位于段落的开头。

什么被认为是段落的开头？

• Haddock 注释开头的任何内容，跳过它前面的任何空格。

• 空行之后的任何内容。

在您的场景中，您有 4 个段落：列表元素、列表元素、示例、列表元素。在内部，Haddock 会完全忽略您所记录的列表编号：如果您愿意，可以从 999 开始。当 Haddock 看到具有相同类型列表的连续段落时，它会将它们连接起来并编号。当您打破模式时，列表不会被视为延续。>>>在这种情况下用空格缩进实际上毫无意义，因为它们将在我们进入新段落时被剥离。请注意，如果您有连续的示例，空格很重要：只要缩进相同，您就可以将它们放在同一段落中。

其他必须在自己的段落上（因此会破坏列表顺序）的内容是列表、鸟迹、代码块（段落仅包含@s之间的文本）和属性 ( prop>)。

虽然这可以通过允许段落嵌套来解决，但这不是计划中的。票证 #27 仅是关于嵌套列表（恰好是段落级实体），但不能解决这个问题。

如果数字不重要或有点作弊，我建议您使用无序列表并使用命名列表 ( [name] content)

编辑：截至 2014 年 1 月 12 日，Haddock 票 #27已解决，现在可以通过在第二个列表元素后缩进示例 4 个空格来实现。这个：

1. First element

2. Second element

    >>> your example
    your example result

3. Third element

现在的结果是：

_{（来源：fuuzetsu.co.uk）}