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.