DocBook

Бесплатно
Открытый исходный код

Сайт: docbook.org

DocBook — это семантический формат разметки документов, основанный на XML и исторически имеющий корни в SGML. Он предназначен для описания технической документации, включая руководства пользователя, справочники, спецификации и учебные материалы, в нейтральной по представлению форме. Структура DocBook сосредоточена на смысловых элементах (например, главы, разделы, примеры, таблицы, списки), что позволяет отделить содержание от оформления и обеспечивать многоканальную публикацию одного исходного текста.

Формат сопровождается набором схем и DTD для валидации, а также инструментами преобразования в целевые форматы вывода, такие как HTML, PDF, EPUB и man-страницы. Сообщество вокруг DocBook развивало стили и преобразователи, позволяющие автоматически собирать и публиковать документацию с сохранением единой семантики и возможности повторного использования содержимого в разных представлениях.

  • Семантическая разметка: акцент на смысловых элементах документа, а не на визуальном оформлении.
  • Модульность: элементы для глав, секций, примеров, процедур, шагов, списков и т.п., позволяющие структурировать сложные технические тексты.
  • Валидация: поддержка схем (XML Schema, RELAX NG, DTD) для проверки корректности документов.
  • Преобразование в целевые форматы: готовность к автоматической генерации HTML, PDF, EPUB, man и других выходных форматов с помощью процессоров и стилевых наборов.
  • Разделение содержания и представления: одна и та же исходная документация может публиковаться в разных стилях без изменения основного текста.
  • Поддержка локализации и многоязычности: механизмы для управления переводами и адаптацией документов.
  • Расширяемость: возможность добавления пользовательских модулей и элементов для специфических типов документов.
  • Интеграция с системами сборки: совместимость с инструментами автоматизации для построения документации в конвейерах CI/CD.
  • Историческая устойчивость: продолжительное использование в проектах с длинным жизненным циклом, благодаря стабильности спецификаций.
Подробнее