DocBook

Так сложилось, что существуют различные системы подготовки публикаций, и каждую из них можно с определенной точностью отнести к той или иной области применения. MS Word – для бизнеса, LaTeX – для научных статей, в частности математики, DocBook[1] – программная документация.

DocBook считается наиболее подходящим инструментом для написания программной документации: книги, статьи, руководства пользователя. На сегодняшний день это общепризнанный стандарт как в open source сообществе, так и во многих коммерческих организациях. DocBook используется в таких проектах, как FreeBSD, ядро Linux, Gnome, KDE и многих других, книги O’Reilly, документация Sun.

DocBook – это XML-язык разметки семантической (не только логической) структуры документа, позволяющий задать его содержимое в форме, не зависящей от конкретного представления (и здесь этот принцип соблюдается более последовательно, чем в LaTeX или HTML). И это его основная фишка. Этот документ затем можно автоматически представить в различных выходных форматах без каких-либо изменений в исходном документе: man (*roff), обычный текст, HTML, Info, TeX/LaTeX, XSL‑FO, PDF, PostScript, RTF. Существуют стили для получения веб-сайта, слайдов.

Формат DocBook возник в 1991 году, как совместный проект HaL Computer Systems и O’Reilly & Associates. Затем для его поддержки возникла специальная организация Davenport Group. В 1998 году DocBook перешел под контроль SGML Open consortium, который в последствии стал называться OASIS.

Изначально DocBook базировался на универсальном языке разметки SGML (как и HTML). Но в связи с развитием XML, появилась XML-версия, которая постепенно заменила SGML-версию практически везде. Внутри DocBook могут использоваться другие XML-языки, такие как MathML (набор математических формул), SVG (векторная графика), XHTML, CML (химические формулы). Сообщество пользователей DocBook в связи с популярностью XML в последнее время надеется, что это увеличит количество новообращенных пользователей.

<book id="simple_book">
    <title>Very simple book</title>
    <chapter id="simplechapter">
        <title>Chapter 1</title>
        <para>Hello world!</para>
        <para>I hope that your day is proceeding splendidly!</para>
    </chapter>
    <chapter id="simplechapter">
        <title>Chapter 2</title>
        <para>Hello again, world!</para>
    </chapter>
</book>

Для получения выходных форматов используются XSLT-шаблоны. До появления XSLT аналогичную роль играл язык DSSSL, который не является XML-языком, а имеет синтаксис больше похожий на LISP, т.е. куча скобочек, вложенные списки и т.д. Это еще одно преимущество по сравнению с LaTeX, т.к. делает процесс создания нестандартных стилей более простым.

Стандарт DocBook включает большое количество разнообразных тэгов на все случаи жизни: для разметки структуры документа, создания содержания и индекса, метаинформация (~50), внедренные объекты, перекрестные ссылки, inline-тэги для обозначения различных видов текста (торговая марка, вывод программы, элементы GUI, элементы программ). Существует и упрощенная версия DocBook, в которой сокращено количество тэгов до набора, которого достаточно в большинстве случаев.

DocBook не стоит на месте, постоянно улучшается. В данный момент разрабатывается очередная 5-я версия и уже доступны предварительные спецификации.

Проблемы DocBook:

Не подходит для создания встроенной справки для программ, которая обычно имеет не книжную древовидную структуру последовательности статей, а состоящую из множества взаимосвязанных между собой статей, не обязательно придерживающихся определенного порядка. Альтернатива – DITA[2] (IBM, OASIS).
Недостаточное разнообразие хороших WYSIWYG-редакторов, что особенно актуально при использовании MathML, SVG. На самом деле такие редакторы есть, но все они имеют свои недостатки. Например, есть шаблон для OpenOffice, позволяющий разметить документ специальными стилями и затем сохранить в формате DocBook, но он реализует далеко не все тэги. Есть плагин для Eclipse. Редактор XMLMind судя по скриншотам неплох.