Perl 6 Pod на ближайших конференциях

Perl 6 Pod представляет собой гибкий и расширяемый язык разметки. В первую очередь он полезен для ведения документации: как технической (описание API, технические задания ), так и пользовательской: например, руководства и даже книги.

Мои первые руководства я создавал для пользователей компьютерной лаборатории. В те времена (в середине 90x) для этих целей применялся Microsoft Word. Позднее я использовал для создания документов HTML, Tex и docbook. В дальнейшем основным форматом, который я стал использовать повсеместно, был Perl 5 POD [1]. Возможно, причиной тому стала его интеграция с языком Perl. Это позволило создавать качественную документацию непосредственно во время разработки, а так же поддерживать ее в актуальном состоянии. Конечно же, эта документация была по программному коду.

Тем не менее, Perl 5 POD был удовлетворительным форматом и для создания руководств. Для полного счастья не хватало поддержки изображений, таблиц. Эти неудобства устранялись созданием специализированного парсера, который особым образом обрабатывал POD. Таким образом создавался некий подсинтаксис POD и, как следствие, подобная документация могла быть обработана только этим особым парсером.

В новом Perl 6 Pod [2], все описанные ограничения были устранены. Данный формат стал лаконичнее, появились таблицы и самое главное - расширяемость. Благодаря последней особенности в документах Pod можно реализовать любые собственные сущности: например, изображения. Хорошим примером может служить исходный код этой статьи [3].

Рассказать о данном формате я планирую на следующих ближайших мероприятиях:

  • YAPC::Russia 2011 "May Perl + Perl Mova", 13-15 мая, Москва. [4]

  • DevConf 2011, 4 Июня 2011, Москва. [5]

  • Lvee 2011, 30 июня, Гродно. [6]

  • YAPC::Europe 2011 "Modern Perl",15-17 августа, Рига. [7]

Помимо описания основных деталей формата Perl 6 Pod, также расскажу для решения каких задач я его использую.

[1] Plain Old Documentation. http://perldoc.perl.org/perlpod.html

[2] Спецификация формата Pod (Synopsis 26).https://github.com/zag/specs/raw/master/S26-documentation.pod

[3] Исходный код статьи в формате Perl 6 Pod. http://zag.ru/2011/119/a1/Perl-6-Pod-na-blizhajshikh-konferencijakh.pod

[4] YAPC::Russia 2011 "May Perl + Perl Mova", 13-15 мая, Москва. "Использование Perl 6 Pod"

[5] DefConf 2011, 4 Июня 2011, Москва. "Perl 6 Pod - современный формат ведения документации"

[6] Lvee 2011, 30 июня, Гродно. http://lvee.org

[7] YAPC::Europe 2011 "Modern Perl", 15-17 августа, Рига. http://yapceurope.lv/ye2011/

All Articles