Продолжение нумерованного списка пикши

Как продолжить нумерованный список с помощью инструмента документирования пикши? Следующие строки в пикше

--  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 или мне попробовать что-то другое (>>> дает хорошее форматирование, почему я хотел бы его использовать)?


person Gspia    schedule 01.04.2013    source источник
comment
Боюсь, пикша вообще не поддерживает вложенные структуры. Я бы хотел научиться иначе.   -  person Daniel Fischer    schedule 01.04.2013
comment
Я согласен с Даниэлем Фишером, документация, кажется, поддерживает идею о том, что список должен быть непрерывным, вы не можете вкладываться. haskell.org/haddock/doc/html/ch03s08.html#id566282< /а>   -  person mech    schedule 15.07.2013
comment
Спасибо вам обоим за ваши ответы, которые я считаю действительными при нынешнем положении дел --› следует ли их перенести в ответы или это имеет значение?   -  person Gspia    schedule 29.07.2013
comment
trac.haskell.org/haddock/ticket/27   -  person daveloyall    schedule 22.08.2013
comment
Я исправил тикет №27. Смотрите мой обновленный ответ.   -  person Mateusz Kowalczyk    schedule 13.01.2014


Ответы (1)


Вы не можете. Вы используете >>>. Чтобы это отображалось в качестве примера, оно должно быть в начале абзаца.

Что считается началом абзаца?

  • Что угодно в начале комментария пикши, пропуская все пробелы перед ним.

  • Все, что следует за пустой строкой.

В вашем сценарии у вас есть 4 абзаца: элемент списка, элемент списка, пример, элемент списка. Внутри Haddock полностью игнорирует номера списка, которые вы записываете: вы можете начать с 999, если хотите. Когда Haddock видит последовательные абзацы со списком одного типа, он объединяет их и нумерует. Поскольку вы нарушаете шаблон, списки не рассматриваются как продолжение. Отступ >>> с пробелами в этом сценарии на самом деле бессмысленен, так как они будут удалены, когда мы перейдем к новому абзацу. Обратите внимание, что пробелы важны, если у вас есть последовательные примеры: вы можете поместить их в один и тот же абзац, если ваш отступ идентичен.

Другие вещи, которые должны быть в отдельном абзаце (и поэтому нарушают порядок в списке), — это списки, следы птиц, кодовые блоки (абзац, содержащий только текст между @) и свойства (prop>).

Хотя эту проблему можно решить, разрешив вложение абзацев, это не планируется. Билет № 27 касается исключительно вложенных списков (которые действительно являются объектами уровня абзаца), но не решит эту проблему.

Я рекомендую вам использовать неупорядоченные списки, если числа не важны, или немного схитрить и использовать именованные списки ([name] content)

решения для именованных и неупорядоченных списков

РЕДАКТИРОВАТЬ: по состоянию на 12 января 2014 г. Билет Haddock № 27 был решен, и теперь это возможно путем отступа в примере 4 пробела после второго элемента списка. Этот:

1. First element

2. Second element

    >>> your example
    your example result

3. Third element

Теперь результаты:

Элементы вложенного списка пикши
(источник: fuuzetsu .co.uk)

person Mateusz Kowalczyk    schedule 22.08.2013