Haddock编号列表延续

时间:2013-04-01 09:26:44

标签: haskell haddock

如何使用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中的第三个数字,或者我应该尝试其他的东西(&gt;&gt;&gt;给出一个很好的格式,我为什么要使用它)?

1 个答案:

答案 0 :(得分:4)

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

该段落的开头是什么?

  • Haddock评论开头的任何内容,都会跳过前面的任何空格。

  • 空行后的任何内容。

在您的方案中,您有4个段落:列表元素,列表元素,示例,列表元素。在内部,Haddock完全忽略了你所放下的列表编号:如果你愿意,你可以从999开始。当Haddock看到具有相同类型列表的连续段落时,它会加入它们并对它们进行编号。当您破坏模式时,列表不会被视为延续。使用空格缩进>>>在这种情况下实际上是没有意义的,因为当我们在新的段落中时它们将被剥离。请注意,如果您有连续的示例,则空格很重要:只要缩进相同,就可以将它们放在同一段落中。

必须在他们自己的段落上的其他内容(因此会破坏列表顺序)是列表,鸟类跟踪,代码块(仅包含@之间的文本的段落)和属性(prop>

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

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

named and unordered list solutions

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

1. First element

2. Second element

    >>> your example
    your example result

3. Third element

现在导致:

Haddock nested list items http://fuuzetsu.co.uk/images/1389605057.png