【问题标题】:Haddock numbered list continuation黑线鳕编号列表继续
【发布时间】:2013-04-01 09:26:43
【问题描述】:

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

--  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 中使用第三个数字,或者我应该尝试其他的东西(>>> 提供了一个很好的格式,为什么我想使用它)?

【问题讨论】:

  • 恐怕黑线鳕根本不支持嵌套结构。我很想学习其他方式。
  • 我同意 Daniel Fischer 的观点,文档似乎支持列表必须不间断、不能嵌套的概念。 haskell.org/haddock/doc/html/ch03s08.html#id566282
  • 感谢你们的回答,我认为在目前的情况下是有效的 --> 应该将这些转移到答案中还是有关系?
  • 我修好了票 #27。请参阅我的更新答案。

标签: haskell haddock


【解决方案1】:

你不能。您正在使用&gt;&gt;&gt;。为了将此呈现为示例,它需要位于段落的开头。

什么是段落的开头?

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

  • 空行之后的任何内容。

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

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

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

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

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

1. First element

2. Second element

    >>> your example
    your example result

3. Third element

现在结果:


(来源:fuuzetsu.co.uk

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-06-12
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-07-14
    相关资源
    最近更新 更多