Haddock suite liste numérotée

Question

Comment continuer une liste numérotée avec l'outil de documentation haddock? Les lignes suivantes dans l'aiglefin

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

générer le prochain 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>
 

Cela casse la numérotation. Existe-t-il un moyen de faire en sorte que haddock continue avec le troisième nombre également en HTML ou devrais-je essayer autre chose (>>> donne une bonne mise en forme, pourquoi j'aimerais l'utiliser)?

br, gspia

Answer 1

Vous ne pouvez pas. Vous êtes à l'aide de >>>. Pour avoir un rendu comme un exemple, il doit être au début du paragraphe.

Ce qui est considéré comme un début de paragraphe?

• Tout au début de l'Aiglefin commentaire, en ignorant tout l'espace blanc qui le précède.

• Tout ce qui suit une ligne vide.

Dans votre scénario, vous avez 4 paragraphes: élément de la liste, un élément de liste, par exemple, d'un élément de liste. En interne, l'Aiglefin ignore complètement les numéros de la liste que vous mettez vers le bas: vous pouvez commencer à partir de 999, si vous vouliez. Quand Haddock voit paragraphes consécutifs avec le même type de liste, il se joint à eux et les numéros. Comme vous êtes briser le modèle, les listes ne sont pas traités comme une continuation. L'indentation >>> avec des espaces, il est en fait inutile dans ce scénario, car ils seront dépouillées comme nous sommes dans un nouveau paragraphe. Notez que les espaces sont importants si vous avez consécutives exemples: vous pouvez les mettre dans le même paragraphe, tant que votre indentation est identique.

D'autres choses qui doivent être sur leurs propres paragraphe (et donc de briser l'ordre de la liste) est listes, birdtracks, codeblocks (paragraphe contenant uniquement du texte entre @s) et les propriétés (prop>).

Tandis que ceci peut être résolu en permettant paragraphe de nidification, ce n'est pas prévu. Ticket #27 est uniquement sur l'imbrication des listes (qui ne se trouvent être point les entités de niveau), mais ne résoudra pas ce problème.

Je vous recommande d'utiliser les listes à puces si les numéros ne sont pas vitales ou de tricher un peu et utiliser nommé listes ([name] content)

EDIT: à compter du 12 janvier 2014, l'Aiglefin billet n ° 27 a été résolu et c'est aujourd'hui possible par l'indentation de l'exemple 4 espaces après le deuxième élément de la liste. Ce:

1. First element

2. Second element

    >>> your example
    your example result

3. Third element

Maintenant les résultats dans: