G. Documentation
PostgreSQL™ fournit quatre
formats principaux de documentation :
-
le texte brut, pour les information de pré-installation ;
-
HTML, pour la lecture en
ligne et les références ;
-
PDF ou Postscript, pour l'impression ;
-
les pages man (de manuel), pour la référence rapide.
De plus, un certain nombre de fichiers README peuvent être trouvés à divers endroits de
l'arbre des sources de PostgreSQL™. Ils renseignent l'utilisateur
sur différents points d'implantation.
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 téléchargement.
Les sources de la documentation sont écrites en DocBook, langage assez semblable au
HTML. Ces deux langages sont des
applications du Standard Generalized Markup
Language, SGML, qui est
essentiellement un langage de description d'autres langages. Dans
ce qui suit, les termes DocBook et SGML sont tous deux utilisés, mais ils ne sont
pas techniquement interchangeables.
DocBook™ permet à l'auteur
de spécifier la structure et le contenu d'un document technique
sans qu'il ait à se soucier du détail de la présentation. Un style
de document définit le rendu du contenu 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
à la lecture en ligne. Le
guide
DocBook des nouveaux venus
est très utile pour les
débutants. 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.