J.1. DocBook #

Исходный материал документации создаётся в DocBook, языке разметки на базе XML. Далее термины DocBook и XML используются как синонимы, но технически они обозначают не одно и то же.

Формат DocBook позволяет авторам определять структуру и содержимое технического документа, не заботясь о деталях представления. Как это содержимое будет представлено в различных конечных формах, определяет стиль документа. DocBook поддерживается группой OASIS. На официальном сайте DocBook имеется хорошая вводная и справочная документация, а также полная книга издательства О'Рейли для чтения в электронном виде. Кроме того, в Проекте документации FreeBSD (FreeBSD Documentation Project) также применяется формат DocBook и даются полезные сведения, включая ряд замечаний по стилю, которые стоит принять во внимание.

J.1. DocBook #

The documentation sources are written in DocBook, which is a markup language defined in XML. In what follows, the terms DocBook and XML are both used, but technically they are not interchangeable.

DocBook allows an author to specify the structure and content of a technical document without worrying about presentation details. A document style defines how that content is rendered into one of several final forms. DocBook is maintained by the OASIS group. The official DocBook site has good introductory and reference documentation and a complete O'Reilly book for your online reading pleasure. The FreeBSD Documentation Project also uses DocBook and has some good information, including a number of style guidelines that might be worth considering.

FAQ