Почему DocBook?

Классификация тэгов DocBook

• Корневые тэги

  Корневым называется самый внешний тэг XML-документа. Корневыми тэгами DocBook обычно служат:

  • article — для документов относительно небольшого объема (формата статьи)

  • book — для более объемных и строже оформленных документов (книг)

• Сопроводительная информация

  Документ DocBook обычно начинается тэгом articleinfo или bookinfo, который группирует следующую информацию:

  • title — название

  • author — авторы

  • keyword — ключевые слова

  • copyright — авторские права

  • revhistory — история изменений

• Структура документа

  Структурные тэги делят документ на главы и разделы:

  • chapter — глава книги

  • section — раздел книги или статьи (произвольного уровня)

  • abstract — аннотация

  • preface — вступительное слово

  • appendix — приложение

  • bibliography — список литературы

  • index — предметный указатель

  Главы и разделы обычно начинаются с названия title.

• Абзацы

  Регулярный текст в DocBook оформляется тэгом para. Это — наиболее часто используемый тэг.

  Абзацы, требующие особого внимания, оформляются тэгами:

  • note — примечание

  • tip — подсказка, совет

  • warning — предупреждение (обычно об опасности для человека)

  • caution — предупреждение (обычно об опасности для оборудования)

  • important — важное замечание

• Списки и перечни

  Списки в DocBook бывают следующих видов:

  • itemizedlist — маркированный

  • orderedlist — нумерованный

  • variablelist — список переменных или определений

  Пункт списка оформляется тэгом listitem, термин или переменная в variablelist — тэгом term.

• Выделенный текст

  Тэги для выделения текста внутри абзаца:

  • emphasis — смысловое ударение

  • filename — имя файла

  • command — компьютерная команда

  • option — опция (ключ) команды

  • replaceable — переменная часть (аргумент) команды

  • userinput — текст, вводимый пользователем

  • computeroutput — сообщение программы

  • literal — кодовое слово

• Цитаты

  Тэги для цитат:

  • quote — просто закавыченный текст внутри абзаца

  • blockquote — цитата из одного или нескольких абзацев

  • citetitle — название процитированного источника

• Ссылки

  Тэги для различных вариантов ссылок:

  • ulink — интернет-ссылки

  • link — перекрестные ссылки внутри документа, текст ссылки подставляется автоматически

  • xref — перекрестные ссылки внутри документа, текстом ссылки можно задавать произвольно

  • olink — ссылки на другие документы в рамках единой базы данных ресурсов

  К разновидности ссылок можно отнести также сноски:

  • footnote — примечание к тексту

  • callout — примечание к иллюстрации или листингу программы

• Иллюстрации

  Для вставки в текст изображений в DocBook есть два способа:

  • graphic — простой, но не гибкий

  • mediaobject — более сложный, позволяет автору предоставлять несколько альтернативных форматов изображения

  Графику можно вставлять непосредственно внутрь раздела или абзаца, но предпочтельнее — в один из следующих тэгов:

  • figure — иллюстрация, включаемая в автоматически генерируемый список иллюстраций

  • informalfigure — иллюстрация без названия и не попадающая в список иллюстрация

  • screenshot — графическая копия экрана компьютера

  Там, где требуется, чтобы текст обтекал изображение, используются тэги:

  • inlinegraphic — упрощенный вариант

  • inlinemediaobject — универсальный вариант

• Таблицы

  Корневые тэги таблицы DocBook:

  • table — таблица, включаемая в автоматически генерируемый список таблиц

  • informaltable — таблица без названия и не включаемая список таблиц

  Содержимое таблицы:

  • thead — шапка

  • tbody — тело

  • tfoot — подвал

  • row — строка

  • entry — ячейка

  • entrytbl — вложенная таблица

• Компьютерные листинги

  Тэги для различных вариантов компьютерных листингов, форматируемых "как есть" :

  • code — фрагмент программного кода внутри абзаца

  • programlisting — текст программы

  • screen — текст, видимый на экране компьютера

  • literallayout — произвольный заранее отформатированный текст

  Листинги можно вставлять непосредственно в раздел или абзац, но часто они являются содержимым следующих тэгов:

  • example — пример, включаемый в автоматически генерируемый список примеров

  • informalexample — пример без названия и не попадающий в список примеров

  Листинги часто сопровождаются примечаниями-сносками:

  • co — место, к которому относится примечание

  • calloutlist — список примечаний, обычно следующий за листингом

  • callout — текст примечания