Глава 12. Формат Pod

Содержание

Структура Pod
Синтаксическая структура Pod
Блоки Pod
Разграниченные блоки / Delimited blocks
Блоки-параграфы / Paragraph blocks
Сокращенные блоки / Abbreviated blocks
Блоки-деклараторы / Declarator blocks
Равнозначность стилевых блоков
Стандартные конфигурационные параметры
Вложенность блоков
Списки
Нумерованные списки
Маркированные списки
Параграфы в элементах списков
Списки определений
Псевдонимы
Псевдонимы для макросов
Контекстуальные псевдонимы
Уровни значимости текста
Блоки I/O
Код форматирования X - индекс терминов
Код форматирования E - определение сущностей
Примеры
Код форматирования N - примечания
Код форматирования D - определения
Код форматирования Z - комментарии
Комментарии как метки категорий
Код форматирования S - текст с неразрывными пробелами
Семантические блоки
спецификаторы примеров

Широко известный формат ведения документации в perl5 - POD (Plain Old Documentation) совсем недавно отпраздновал 15 лет. Вместе с новой версией perl6 готовится новый формат : Pod. Чем отличается perl 5 POD от Perl 6 Pod ?

Немного исторических дат, связанных с обоими форматами:

18 октября 1994

В списке анонса perl 5.000 присутвует поддержка POD

18 October 1994:
It was a complete rewrite of Perl. 
A few of the features and pitfalls are: 
 ...
  * The documentation is much more extensive 
    and perldoc along with pod is introduced.
  ..
9 апреля 2005

S26: cпецификация формата Pod для perl6. Автор - Damian Conway.

25 Apr 2007

Первая редакция формата.

August 16, 2009

S26 - The Next Generation ( preview).

31 Jul 2010

Последняя редакция. Появились декларативные блоки.

В то время как существующий ныне POD означает Perl Old Documentation, cпецификация s26 представляет новый формат следующим образом:

Pod - является эволюцией POD. В сравнении с POD, Perl 6 Pod более однороден, компактен и выразительнее. Pod также характеризуется описательной нотацией разметки, чем презентационной.

Таким образом Pod избавился от слова "старый".