Comprendre DocBook (Guide pratique)

Version française du guide pratique DocBook Demystification HOWTO

Raphaël Semeteys

Adaptation française

Jean-Philippe Guérard

Relecture de la version française

Jean-Philippe Guérard

Préparation de la publication de la v.f.

Version : 1.3.fr.1.2

11 juin 2008

Historique des versions
Version 1.3.fr.1.22008-06-11JPG
Correction d'une petite coquille. Merci Joris Rehm de nous l'avoir signalé. Remplacement d'un lien obsolète vers le livre « XML en concentré » (qui n'est plus édité) par un lien vers sa version originale.
Version 1.3.fr.1.12007-04-26JPG
Modification du titre français.
Version 1.3.fr.1.02006-01-07RSS, JPG
Adaptation française initiale.
Version 1.32004-02-27ESR
Ajout de pointeurs vers deux éditeurs. Add pointers to two editors.
Version 1.22003-02-17ESR
Déplacement des références à SGML après que celui-ci ait été présenté. Reorder to defer references to SGML until after it has been introduced.
Version 1.12002-10-01ESR
Correction d'une erreur faite par inadvertance sur la position de la FSF. Ajout d'un pointeur vers la FAQ DocBook. Correct inadvertent misrepresentation of FSF's position. Added pointer to the DocBook FAQ.
Version 1.02002-09-20ESR
Version initiale. Initial version.

Résumé

Ce guide pratique tente de dissiper le brouillard et le mystère entourant le système de balisage DocBook et les outils associés. Il est destiné aux auteurs de documentations techniques pour les projets libres sous Linux, mais devrait également être utile à la rédaction d'autres types de documents sur d'autres systèmes Unix.


Table des matières

Introduction
Pourquoi s'intéresser à DocBook ?
Balisage structurel : préambule
Définitions de types de documents (DTD)
Autres DTD
La chaîne logicielle DocBook
Quels sont les projets et les acteurs ?
Outils de migration
Outils d'édition
Trucs et astuces
Pratiques et standards apparentés
SGML et les outils SGML
DocBook SGML
Outils SGML
Pourquoi le SGML DocBook est mort
SGML-Tools
Références

Bon nombre de grands projets libres sont en train de converger vers l'utilisation du format DocBook comme format standard de documentation — des projets comme le noyau Linux, GNOME, KDE, Samba et le Projet de documentation Linux (LDP). Les défenseurs du balisage structurel basé sur XML (par opposition au style plus ancien de balisage de présentation illustré par troff, Tex et Texinfo) semblent avoir gagné la bataille théorique. Il est possible de produire un balisage de présentation à partir d'un balisage structurel, mais l'inverse est très difficile.

Néanmoins, une grande confusion entoure DocBook et les programmes qui l'accompagnent. Ses adeptes parlent un argot dense et intimidant, même selon les canons de l'informatique, utilisant à tout va des sigles sans rapport évident avec ce qui doit être fait pour écrire du texte balisé et produire du HTML ou du Postscript. Les standards et les documents techniques sur XML sont notoirement obscurs.

Ce guide va tenter de clarifier les principaux mystères existants autour de DocBook et de son utilisation pour les documents relatifs aux logiciels libres — qu'il s'agisse de documentations techniques ou politiques. Notre objectif est de vous permettre de comprendre non seulement ce que vous devez faire pour fabriquer des documents, mais aussi pourquoi le processus est si complexe — et comment on peut s'attendre à voir cela changer au fur et mesure de la disponibilité de nouveaux outils DocBook.