Уже некоторое время для меня представляет интерес новый диалект Pod - развитие привычного формата ведения документации POD (Palin Old Documentation). Новый Pod предлагается к введению в Perl6 и его спецификация описана в Synopsis 26. Последняя редакция этого документа представлена в 2007 году и совсем скоро ожидаются очередные изменения.

Мой интерес имеет определенные причины: Pod - является тем самым форматом, с помощью которого я решаю свои задачи по обработке текстовых данных. А именно:

  • ведение документации
  • подготовка презентаций
  • формат статей этого блога

Я уверен, что этот список со временем будет только увеличиваться и будут появятся новые примеры использования Perldoc Pod. Потому что он:

  • однороден
  • компактен
  • выразителен
  • расширяем !

Это те качества, которые смогут привлечь к нему внимание большого количества почитателей.

Perl6 планируется к выходу в начале следующего года и полной реализации Perldoc Pod пока нет. В канун прошедшей весной конференции YAPC::Russia 2009 мне удалось обнаружить только две реализации этого диалекта. Одна из которых ( реализованная на rakudo) у меня отказалась работать, а вторая, созданная автором спецификации Damian Conway, была ограничена только двумя форматами экспорта: text и xhtml. Именно поэтому, я приступил к самостоятельной реализации этого формата на perl5 (Perl6::Pod).

Циклом статей на тему perl6 Pod, я не только хочу рассказать про новый диалект. Еще одна цель - пройтись по уже реализованным частям Synopsis 26, а также продолжить разработку оставшихся.

Введение

Широко известный формат ведения документации в perl5 - POD (Plain Old Documentation) отпраздновал в этом году 15 лет. Вместе с новой версией perl6 готовится новый формат : Perldoc Pod. Чем отличается perl5 POD от Perldoc 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).

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

Perldoc - легкий в использовании язык разметки с простой, однозначной моделью документа. Perldoc - поддерживает множество синтаксических диалектов, которые преобразуются в стандартные объекты модели. Стандартный диалект Perldoc - "Pod".

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