Exposé système - DocBook

DocBook se veut être un format permettant la rédaction de documents de manière structurée.

Par structuré on entend que chaque élément est très clairement identifié :

Cette structuration permet d'avoir un format robuste, claire et introduit de la valeur ajoutée grace à toutes les meta-données qu'on peut introduire. Mais elle a aussi un coût, DocBook comporte plus de 400 éléments XML différents.

DocBook autorise en gain de productivité car la rédaction n'est faite qu'une seule fois et indépendament des supports cibles car les parties contenu et présentation sont séparées.

Ce document étant lui même réalisé en DocBook, il sera donc disponible sous plusieurs formats mais la rédaction à été unique.

La distribution de base fournit les transformations pour les supports suivants : PDF (via xsl-fo), PS (via xsl-fo), (X)HTML, HTML help, Java help et Eclipse help.

On peut aussi trouver d'autre transformations telles que : WordML, OpenDocument, ...

On peut noter que les fichiers sources DocBook, étant donné leur nature XML, peuvent être issue de transformations à partir de OpenOffice, Word, ...

La modularité de DocBook est aussi un atout très appréciable, elle se présente sous deux formes :

La premère forme de modularité se trouve au niveau des sources elles mêmes avec la possibilité de réaliser des inclusions (locales ou distantes) d'autres sources. L'inclusion peut principalement s'effectuer de deux manières différentes : XML et XInclude.

La suite d'exemples suivants présentent la manière XML :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY chap1 SYSTEM "Chap_Priorites_Developpement.xml">
<!ENTITY chap2 SYSTEM "use_case.xml">
<!ENTITY chap3 SYSTEM "Chap_packages.xml">
...
<book lang="fr">
  <title>Cahier Des Charges Fonctionnel</title>
    &chap1;
    &chap2;
    &chap3;
...
</book>

<?xml version="1.0" encoding="UTF-8"?>
<chapter>
  <title>Les priorités de développement</title>
...
</chapter>

Ici, on a utilisé la fonctionnalité interne d'XML qui est la définition d'une entité système pointant sur le fichier à inclure. Ce procédé est pratique pour des exemples simples mais devient très compliqué lorsqu'il y a beaucoup d'inclusions à faire ou lorsqu'il y a des inclusions multiples.

La suite d'exemples suivants présentent la manière XInclude :

<?xml version="1.0" encoding="UTF-8"?>
<book lang="fr" xmlns:xi="http://www.w3.org/2001/XInclude">
  <title>Cahier Des Charges Fonctionnel</title>
...
    <xi:include href="Chapter_001_introduction_cdc.xml"/>
    <xi:include href="Chapter_002_glossaire.xml"/>
...
</book>

<?xml version="1.0" encoding="UTF-8"?>
<chapter>
  <title>Introduction</title>
...
</chapter>

Ici, on a utilisé le programme XInclude afin de réaliser les inclusions. Il faudra donc avoir un parser XML, ou un programme, gérant XInclude. XInclude est beaucoup plus maniable car les inclusions peuvent se faire où on en a besoin et gère les chemins relatifs. Il permet aussi la selection de la partie à inclure par l'intermédiaire d'une requête XQuery (similaire au format de XPath).

La seconde forme de modularité se trouve au niveau de la grammaire. Elle peut être diminuée ou étendue pour répondre au problématiques métiers.

On prendra ici l'exemple de Slides qui est une dérivation de DocBook pour la l'écriture de présentations sous forme de diaposives. Cette dérivation rajoute principalement les éléments suivants (liste incomplète) :

...
<!ELEMENT slides (slidesinfo, speakernotes?, foil*, foilgroup*)>
<!ATTLIST slides
  %label.attrib;
  %status.attrib;
  %common.attrib;
  %role.attrib;
>
<!ELEMENT slidesinfo ((mediaobject
       | legalnotice
       | subjectset | keywordset
       | %bibliocomponent.mix;)+)>
<!ATTLIST slidesinfo
  %common.attrib;
  %role.attrib;
>
<!ELEMENT foilgroup (foilgroupinfo?, title, subtitle?, titleabbrev?,
                   (%divcomponent.mix;)*,
                   foil+)>
<!ATTLIST foilgroup
  %label.attrib;
  %status.attrib;
  %common.attrib;
  %role.attrib;
>
<!ELEMENT foilgroupinfo ((mediaobject
        | legalnotice
        | subjectset | keywordset
        | %bibliocomponent.mix;)+)>
<!ATTLIST foilgroupinfo
  %common.attrib;
  %role.attrib;
>
<!ELEMENT foil (foilinfo?, title, subtitle?, titleabbrev?,
                (%divcomponent.mix;)+)>
<!ATTLIST foil
  %label.attrib;
  %status.attrib;
  %common.attrib;
  %role.attrib;
>
<!ELEMENT foilinfo ((mediaobject
         | legalnotice
         | subjectset | keywordset
         | %bibliocomponent.mix;)+)>
<!ATTLIST foilinfo
  %common.attrib;
  %role.attrib;
>
<!ELEMENT speakernotes (%divcomponent.mix;)*>
<!ATTLIST speakernotes
  %common.attrib;
  %role.attrib;
...

On est donc façe à une augmentation de la grammaire avec l'apparition de nouveaux éléments pour l'écriture de diapositives.

La modularité permet le travaille collaboratif et simultané car chacun peut éditer une seule section et on réaliser le document final par une inclusion de toutes les sections.

Au tableau des bénéfices introduits par DocBook on peut siter les suivants :

Séparation du travail avec les graphistes (aussi appelés programmeurs) qui ne s'attachent qu'à la présentation d'un format de sortie particulier et avec les rédacteurs qui ne s'attachent qu'au contenu et sa signification.

Lors de l'utilisation de DocBook, on se rend très vite compte des difficultés suivantes :