Использование звездочки в элементе pod в качестве текста - PullRequest
Новая
       9

Использование звездочки в элементе pod в качестве текста

0 голосов
/ 05 марта 2012

Я пишу свою документацию Perl в формате POD
Моя проблема в том, что я хочу, чтобы метка элемента просто называлась *

Я пробовал =item *, =item S<*>, =item Z<>* и=item E<42>

все подходы интерпретируются как маркеры, но я хочу, чтобы звездочка интерпретировалась как обычный текст
любая идея, как вообще решить эту проблему без добавления дополнительного текста, например =item "*"?

Я не уверен, если это полезно, но вот небольшой пример (я оставил пустые строки): 

=pod
=head1 HEAD
=over 4
=item a
A
=item *
B
=item c
C
=back
=cut

Я использую podchecker , чтобы проверить мои документыдо того, как я использую pod2text, pod2html и т. д.
и там написано =item type mismatch ('definition' vs. 'bullet')
Я не говорил об этом в первую очередь, потому что я думал, что каждый преобразователь зависит от интерпретации podchecker

Ответы [ 2 ]

3 голосов
/ 05 марта 2012

Было бы полезно, если бы вы показали точный вывод, который вы ищете, и вывод, который вы получаете.

Я могу заставить звездочку отображаться в выводе perldoc, пока я это делаювторой =item: 

=head1 OPTIONS

=over 5

=item help

Help me!

=item *

Asterisk

=back

=cut

Вот вывод, который я получаю из perldoc: 

OPTIONS
       help Help me!

       *    Asterisk

Вот соответствующая цитата из perlpod :

И, возможно, самое главное, сохранять элементы непротиворечивыми: либо используйте «= item *» для всех них, чтобы производить пули;или используйте "= item 1.", "= item 2." и т. д. для создания нумерованных списков;или используйте «= item foo», «= item bar» и т. д., а именно, вещи, которые не похожи на маркеры или цифры.

Если вы начинаете с маркеров или цифр, придерживайтесь их, как используют средства форматированияпервый тип "= item", чтобы решить, как форматировать список.

См. также: Избегайте несогласованного POD = over = отступ элемента

0 голосов
/ 06 марта 2012

хорошо, самое хорошее решение, которое я нашел до сих пор, - это использование =item S< >*, которое выдает 

HEAD
    a   A

     *  B

    c   C

не совсем то, что я хотел (* немного отключено), но в любом случае

...