Cours DocBook accelere

1.2. Pourquoi DocBook ?

Le format DocBook a été développé par le consortium OASIS spécifiquement pour la documentation technique. Il fournit un riche ensemble de balises pour décrire le contenu de votre document.

Ici, voyons certains points-clé pour vous aider à comprendre ce qu'est DocBook :

Docbook est un langage de balises

Il est très similaire au HTML. Les balises permettent la structuration de votre document et s'entremêle avec le texte.

Ce point particulier en fait une révolution avec respect de la traduction de la documentation, car la phase DTP (rendant le texte agréable) est faite une fois pour toute indirectement en balisant le texte original. Les traducteurs ont seulement à traduire "entre les balises" et en pressant une simple touche la sortie traduite est générée.

Il est conçu pour la documentation technique

DocBook est parfaitement adapté pour la documentation des pièces détachées de moteurs de voitures. Cependant, il est fortement prédisposé pour la documentation des programmes informatiques.

Il est maintenu par un consortium indépendant

Le consortium OASIS est en charge de la maintenance du standard développé par le Comité Technique DocBook. C'est une garantie d'indépendance vis-à-vis des logiciels propriétaires.

Des acteurs majeurs de l'industrie comme Boeing ou IBM sont membres de OASIS. Voyez la liste des membres pour plus d'information.

Techniquement, DocBook est une DTD SGML ou XML

Ceci veut dire que l'on peut tirer profit de nombreux outils SGML et XML. Alors que DocBook comme implémentation XML est assez récent, il a une longue histoire en tant qu'implémentation SGML.

DocBook n'est pas un langage de présentation

DocBook n'indique pas spécifiquement à quoi le document final ressemblera. Ceci permet à l'auteur de se concentrer sur l'organisation du document. La présentation est gérée par les feuilles de style.

Ceci assure à vos documents une apparence logique.

DocBook est personnalisable

Il est facile de personnaliser la DTD en fonction de vos besoins. Mais ceci doit être fait dans le respect des conventions SGML/XML.

Si DocBook est utilisé concurremment avec les feuilles de style de Norman Walsh, il est également possible de personnaliser un fichier DocBook pour l'impression ou la mise en ligne.

DocBook est intelligible

Le grand nombre de balises défini dans DocBook garantit qu'il peut s'accommoder de situations très variées.

Ceci fait qu'il est un peu difficile à apprendre, mais dans la plupart des cas vous n'aurez à utiliser qu'un nombre limité de balises.

DocBook utilise des balises longues et compréhensibles

Un exemple des ces balises est <itemizedlist> ou <literallayout>. Ceci rend un texte DocBook plus facile à lire qu'une source HTML. Désavantage, il peut aussi devenir un peu fastidieux de taper ces longues balises, mais certains modes spécialisés (comme le mode psgml de Emacs) peuvent vous y aider.

DocBook n'assure pas la compatibilité ascendante entre les révisions majeures

Alors que ceci pourrait sembler être un inconvénient, en fait ce ne l'est pas, car ça assure une présentation propre même si de mauvais choix ont été faits précédemment par le Comité DocBook de OASIS et parce que les documents écrits avec différentes DTD peuvent coexister sur un même ordinateur.

Certains de ces points-clé seront vus plus en détail dans les prochaines sections.