Annexe G. Documentation

Table des matières
G.1. DocBook
G.2. Ensemble d'outils
G.3. Génération de la documentation
G.4. Écriture de la documentation
G.5. Guide des styles

PostgreSQL fournit quatre formats de documentation de base :

De plus, un certain nombre de fichiers README pourront être trouvés à divers endroits de l'arbre des sources de PostgreSQL. Ils renseigneront l'utilisateur sur différents points d'implémentation.

La documentation HTML et les pages de manuel font parties de la distribution standard et sont installées par défaut. Les documents au format PDF et Postscript sont disponibles indépendemment par le biais du téléchargement.

G.1. DocBook

Les sources de la documentation sont écrites en DocBook, qui est un langage semblable au HTML au premier abord. Ces deux langages sont des applications de Standard Generalized Markup Language, SGML, qui est essentiellement un langage décrivant d'autres langages. Dans ce qui suivra, les termes DocBook et SGML seront utilisés, ils ne sont cependant pas techniquement interchangeables.

DocBook permet à l'auteur de spécifier la structure et le contenu d'un document technique sans qu'il ait besoin de se soucier du détail de la présentation. Un style de document définit la manière dont le contenu sera rendu dans un des formats de sortie finaux. DocBook est maintenu par le groupe OASIS . Le site officiel de DocBook présente une bonne documentation d'introduction et de référence ainsi qu'un livre complet de chez O'Reilly disponible en ligne pour votre plaisir. Le projet de documentation FreeBSD utilise également DocBook et fournit également de bonnes informations, incluant un certain nombre de lignes directrices qu'il peut être bon de prendre en considération.