DOCBOOK WINDOWS
Что есть DocBook? Это просто исходный код вашей документации (или книги) в прямом смысле этого слова, который априори не зависит ни от платформы, ни от компилятора (правильнее трансформатора), ни от формата конечного результата. Потому что это простой текстовый файл с особой разметкой в стиле XML. Собственно, DocBook-ом и называется этот самый набор специальных тегов для разметки документов, а сам документ является самым настоящим XML-документом со всеми из этого вытекающими.
Важно, на мой взгляд то, что это простой текст, а следовательно он идеально подходит для постановки на учет в какую-нибудь систему управления версиями кода (рекламирую в качестве таковой – Git), что обеспечит максимально комфортную работу над исходным кодом документации коллективом разработчиков, в каком бы географическом месте последние ни находились. Также имеет место быть полная свобода в инструментарии для работы над файлами – от умолчательного блокнота или любимого FAR до текстового редактора среды разработки на одном из языков программирования или специализированного XML-редактора. Круглосуточно и всепогодно.
Как информацию для размышления привожу скомпилированный по материалам из Сети список положительных характеристик технологии DocBoook:
- Бесплатное распространение
- Поддержка принципа единого источника, унифицированное форматирование с разделением контента от дизайна
- Поддержка различных выходных форматов
- Нативная работа с системами контроля версий
- Профайлинг и гибкое управление контентом, например, создание различных версий документа для различных групп пользователей
- Поддержка документов больших объемов
- Модульность и возможность повторного использования текста
- Легкая модификация шаблонов выходных документов
- Перспективный внутренний формат (XML)
- Мощный набор стандартов (XSL)
С точки зрения разработчика, работа в DocBook ничем не отличается от процесса создания программы: также надо думать над архитектурой документации, также надо разбивать код на логические модули и физические файлы, также надо думать о возможных зависимостях в коде между файлами, также надо набирать текст… Схема работы с DocBook аналогична таковой при создании программ:
XML (source code) >> XSLT-processor (script.xsl) >> Output (pdf|rtf|html|chm...)
Установка DocBook в Windows своими руками:
- Скачать DocBook XML последней версии (docbook-5.x.zip) и распаковать в C:\DOCBOOK.
- Скачать XSLT Stylesheets последней версии (docbook-xsl-ns) и распаковать в C:\DOCBOOK\xsl-ns.
- Скачать XSLT Proc Binary последней версии (iconv, libxml2, libxslt, zlib) и распаковать (bin) в C:\DOCBOOK\xsltproc.
- Необходимо использовать online документацию или же загрузить себе offline вариант.
Ссылки:
