3.2.7. Bookmap

La spécialisation bookmap de l'élément <map> standard de DITA permet d'organiser ses thèmes DITA en une collection qui peut être imprimée à la manière d'un livre ou d'une autre mise en pages.

Pourquoi utiliser une carte bookmap ?

L'application bookmap OASIS de DITA permet de produire ses thèmes DITA et même des cartes DITA entières comme sommaire (content) d'un livre défini auparavant. Cela permet de produire non seulement des cartes pour les produits livrables en ligne mais aussi des fichiers PDF avec le même sommaire, des couvertures (covers), des notices formelles et des pages liminaires (frontmatter), et ainsi de suite.

Qu'est-ce qu'une carte bookmap ?

Une carte bookmap est un type spécial de carte DITA qui définit les structures majeures et les données de mise en place (setup information) pour produire des cartes d'information à la manière d'un livre.

Une carte DITA typique aura un titre puis un ensemble de références de thème (<topicref>), en succession, en hiérarchie ou les deux, qui définissent la structure d'après laquelle les thèmes doivent être vus comme un produit livrable d'information (information deliverable) complet. Une carte DITA n'a pas de structures pour désigner spécifiquement la façon de traiter les thèmes comme des chapitres, une préface, ou même pour construire une couverture ou un contenu spécial tel qu'une notice d'édition passe-partout (edition notice boilerplate). Afin de pouvoir visionner un contenu DITA plus à la manière un livre, il faut un contexte qui représente tout le traitement spécial susceptible d'être consacré à produire une carte ou un ensemble de cartes à la manière d'un livre. C'est le rôle de la spécialisation bookmap de DITA.

Un élément <bookmap> comprend les structures spécialisées majeures suivantes :

Un titre (<title>) ou un titre de livre (<booktitle>) optionnels (ce dernier élément pouvant lui-même avoir une sous-structure pour des titres complexes) ;
Un élément <bookmeta> optionnel (toutes les informations à propos du livre — les propriétaires des droits, les auteurs, les données de publication, et ainsi de suite) ;
Une section liminaire (<frontmatter>) optionnelle, c'est-à-dire la préface et les sujets préliminaires dans un livre avant la substance du livre, et comprenant également des listes de livre (<booklists>) — conteneurs pour des collections spéciales d'informations dans un livre) ;
Un nombre quelconque de chapitres ou de parties (qui peuvent contenir des chapitres) ;
Un nombre quelconque de sujets annexes ;
Des parties annexes (<backmatter>) optionnelles (souvent pour des annonces spéciales ou des informations supplémentaires, et aussi pour des listes de livre) ;
Un nombre quelconque de tables de relation (<reltable>), comme dans une carte typique.

Qu'est-ce que l'élément <`bookmeta`> ?

L'élément <bookmeta> est une spécialisation de l'élément <topicmeta> dans une carte DITA. Il a un contenu spécialisé pour stocker des informations à propos du livre particulier représenté par la carte bookmap.

Qu'est-ce que l'élément <`booklists`> ?

Une liste de livre (<booklist>) est un élément <topicref> spécialisé qui indique une collection d'informations du contenu d'un livre. Les ensembles d'éléments <booklist> (ou les éléments dérivés de <booklist>) sont contenus dans l'élément <booklists>.

Un type de liste de livre courant est la table des matières. Si on le souhaite, on peut définir une collection entièrement nouvelle telle qu'une table des notes de pied de page (footnotes) et fournir soit un thème pré-rempli avec ce contenu, soit un traitement pour collecter et insérer ce contenu thématique (topical content) lors du traitement du livre.

La carte bookmap OASIS fournit des éléments de liste de livre spécifiques :

<toc> — la table des matières (table of contents) habituelle, trouvée dans les listes de livre des pages liminaires (<frontmatter>) ;
<figurelist> — une liste de figures ;
<tablelist> — une liste de tables ;
<abbrevlist> — une liste d'abréviations ;
<trademarklist> — une liste de noms de marque ;
<bibliolist> — une liste de références bibliographiques ;
<glossarylist> — une liste d'entrées de glossaire et de définitions ;
<indexlist< — un index, trouvé habituellement dans les listes de livre des pages annexes (<backmatter>) ;
<booklist> — référence tout autre thème contenant des données de type liste de livre, ou spécialise l'élément pour représenter une collection qui sera assemblée par un nouveau traitement prioritaire (override processing).

Qu'y a-t-il dans l'élément <`frontmatter`> ?

Les pages liminaires (front matter) d'un livre contiennent typiquement des préfaces, des instructions ou d'autres introductions en préalable du contenu réel du livre.

Les éléments <frontmatter> spécifiques comprennent un nombre quelconques des éléments suivants :

<booklists> — des collections de sections de livre, comme une table des matières ;
<notices> — des notes de publication, des précautions (safety notices), des clauses d'utilisation (terms and conditions), et ainsi de suite ;
<dedication> — des dédicaces aux prédecesseurs importants et à d'autres ;
<colophon> — des détails sur la fabrication du livre ;
<bookabstract> — un résumé du livre utile pour les outils de recherche et l'enregistrement dans des systèmes de suivi et de circulation des flux ;
<draftintro> — un contenu spécial pour les relecteurs (reviewers) ;
<preface> — une introduction ou une phrase d'introduction ;
<topicref> — un conteneur extensible (extensible placeholder) pour un thème quelconque ;
<topichead> — comme dans une carte DITA, cet élément permet un regroupement avec un titre de navigation ;
<topicgroup> — comme dans une carte DITA, cet élément permet un regroupement sans titre de navigation.

Qu'y a-t-il dans l'élément <`backmatter`> ?

Les pages annexes (back matter) d'un livre contiennent typiquement des informations de clôture qui suivent le contenu principal du livre.

Les éléments <backmatter> spécifiques comprennent un nombre quelconques des éléments suivants :

<booklists> — des collections de sections de livre comme l'index ;
<notices> — des notes de publication, des précautions, des clauses d'utilisation, et ainsi de suite ;
<dedication> — des dédicaces ;
<colophon> — des détails sur la fabrication du livre ;
<amendments> — pointe vers une liste de modifications ou de mises à jour du livre ;
<topicref> — conteneur extensible pour un thème quelconque ;
<topichead> — comme dans une carte DITA, cet élément permet un regroupement avec un titre ;
<topicgroup> — comme dans une carte DITA, cet élément permet un regroupement sans titre.

Comment est créée et produite une carte bookmap ?

En tant que spécialisation d'une carte DITA, la carte de livre DITA sera gérée par défaut comme une carte DITA normale dans les éditeurs et outils de traitement compatibles DITA.

Avec un style et des priorités fonctionnelles appropriées, les éditeurs XML peuvent afficher une carte bookmap DITA comme ils le feraient pour la structure XML d'autres définitions DTD supportant des livres, et un traitement DITA spécialisé ou des cartes bookmap DITA exploiteront les métadonnées de livre et les caractéristiques de livre dans une mise en pages de haute qualité en sortie.

Par exemple, vous pouvez avoir une carte DITA qui représente la hiérarchie voulue pour un produit livrable Web particulier de vos thèmes DITA. Vous souhaitez aussi produire cette carte à la manière d'un livre formel à empaqueter en même temps que votre produit en boîte. Vous pouvez ouvrir une nouvelle instance <bookmap> et définir un titre pour le livre, indiquer toute information d'éditeur nécessaire dans la zone <bookmeta>, lier une préface, indiquer si vous voulez une table des figures avec la table des matières et enfin créer un élément <chapter> qui référence votre carte DITA existante. Vous avez créé un produit livrable de livre complet, tout au moins sommairement. La conception de la carte bookmap vous permet d'affiner votre produit livrable et même faire que la version livre de la carte ait un contenu spécifique par rapport à la version Web.

Exemple

<bookmap id="taskbook">
  <booktitle>
    <mainbooktitle>Product tasks</mainbooktitle>
    <booktitlealt>Tasks and what they do</booktitlealt>
  </booktitle>
  <bookmeta>
    <author>John Doe</author>
    <bookrights>
      <copyrfirst>
        <year>2006</year>
      </copyrfirst>
      <bookowner>
        <person href="janedoe.xml">Jane Doe</person>
      </bookowner>
    </bookrights>
  </bookmeta>
  <frontmatter>
    <preface/>
  </frontmatter>
  <chapter format="ditamap" href="installing.ditamap"/>
  <chapter href="configuring.xml"/>
  <chapter href="maintaining.xml">
    <topicref href="maintainstorage.xml"/>
    <topicref href="maintainserver.xml"/>
    <topicref href="maintaindatabase.xml"/>
  </chapter>
  <appendix href="task_appendix.xml"/>
</bookmap>