Perl 6 Pod: Книги в формате Pod

Основным предназначением разметки Pod является создание качественной документации по программному коду Perl 6. Однако он отлично подходит, как впрочем и его предшественник POD, для создания любых документов, в том числе и для написания книг.

До недавнего времени первой и единственной (насколько мне известно) являлась книга "Все о Perl 6". Однако появились еще пару. Количество книг невелико и поэтому пока несложно рассказать о каждой из них.

"Все о Perl 6" [1]

Эта книга задумывалась и развивается как сборник материалов о языке Perl 6. Характерной ее особенностью является ее открытость как для читателей, так и для авторов. Проект создания этой книги ориентируется на совместную работу нескольких авторов.

"Создание Web приложений в WebDAO" [2]

Книга посвящена программной платформе WebDAO. Для меня она также является еще и техническим заданием для разработки. Особенностью этой книги является то, что исходные тексты книги находятся в дереве исходников объекта описания, т.е. в непосредственной близости к программному коду [3].

"Develop web applications in WebDAO" [4]

Перевод предидущей книги на английский. Одной из полезных свойств является тренировки навыков создания текстов на английском языке.

"Социальные API и протоколы" [5]

В данной книге собираются материалы полезные при разработке программ, использующих API популярных социальных сервисов. Книга расположена в репозитории git, рядом с статьями этого блога [6] . Это мне позволяет наполнять книгу материалами и вести блог одновременно.

Структура каталогов репозитория содержит катлог pub для опубликованных материалов, draft - для черновиков. После push новые статьи публикуются посредством REST запросов на сайте. Теперь среди каталогов появился book.

total 18
2 drwxr-xr-x   8 zag  wheel   512 14 июн 18:22 .
2 drwxr-xr-x   6 zag  wheel  1024 30 янв 15:09 ..
2 drwxr-xr-x   8 zag  wheel   512 14 июн 14:38 .git
2 -rw-r--r--   1 zag  wheel   801 14 июн 18:21 README
2 drwxr-xr-x   2 zag  wheel   512 31 окт  2010 bin
B<2 drwxr-xr-x   2 zag  wheel   512 14 июн 17:58 book>
2 drwxr-xr-x   5 zag  wheel   512 14 июн 14:38 draft
2 drwxr-xr-x   5 zag  wheel   512 12 июн 12:44 notes
2 drwxr-xr-x  10 zag  wheel   512  2 июн 14:31 pub

Посты этого блога подключаются с помощью директивы =Include и при внесении исправлений в запись блога, они автоматически учитываются в книге. При этом не создаются копии текста. Подключение опубликованной записи выглядит следующим образом:

CHAPTER

�оциальный робот

�ва робота

С помощью параметров директивы =Include я исключаю излишнюю секцию DESCRIPTION. Секцию NAME пропускаю, так как название главы книги может отличаться от названия поста в блоге.

В книге на данный момент содержится рецепт по созданию робота, помогающего мне в освещении конференции lvee.org. Как показывает практика [7], книга - лучший инструмент для систематизации информации. Такой путь кажется мне оптимальным и для проработки темы персональной публикации [8].

Каждая из описанных книг, независимо от общего формата, демонстрирует различные способы накопления информации. Поэтому для меня книга не только источник знания, но и источник опыта.

NOTES

1. Книга "Все о Perl 6". http://zag.ru/perl6-book/

2. Книга "WebDAO - платформа для создания web приложений". http://webdao.sourceforge.net/index.ru.html

3. Каталог с книгой по WebDAO на github. https://github.com/zag/webdao/tree/master/contrib

4. Книга "Develop web application in WebDAO". http://webdao.sourceforge.net/

5. Книга "Социальные API и протоколы". http://writeat.com/zag/social-book/

6. "REST интерфейс и публикация с помощью Git". http://zag.ru/b48h1

7. Статус книги "Все о Perl 6". http://zag.ru/a4Bo1

8. "Персональная публикация в Интернет". http://zag.ru/a4CJ1

All Articles