Fichiers de table des matières (TDM)

A présent que nous avons des fichiers d'exemple de contenu, nous pouvons créer un fichier de table des matières (TDM). Ce fichier définit les points d'entrée clés dans les fichiers de contenu HTML en mappant un intitulé de rubrique vers une référence dans l'un des fichiers HTML. 

Les applications migrées vers la plate-forme peuvent réutiliser la documentation existante à l'aide du fichier TDM pour définir des points d'entrée.

Un plug-in peut posséder un ou plusieurs fichiers TDM. Notre exemple de documentation s'organise en trois catégories principales : les concepts, les tâches et les références. Comment créer les fichier TDM représentant cette structure ?

Nous pouvons constituer un grand fichier TDM ou un fichier TDM distinct pour chaque catégorie principale de contenu. Cette décision doit être prise en fonction du mode de coopération des équipes de documentation. Si un auteur différent détient chaque catégorie, il peut s'avérer préférable de garder des fichiers TDM distincts pour chaque catégorie. La décision n'est pas dictée par l'architecture de la plate-forme.

Dans cet exemple, nous allons créer un fichier TDM pour chaque catégorie de contenu principal. Pour un si petit nombre de fichiers, avoir des fichiers TDM distincts pour chaque catégorie peut s'avérer inutile. Nous construirons cet exemple comme si nous avions davantage de fichiers ou des auteurs différents détenant chacun une catégorie de contenu.

Nos fichiers sont du type suivant :

toc_Concepts.xml

   <toc label="Concepts">
      <topic label="Concept1" href="html/concepts/concept1.html">
         <topic label="Concept1_1" href="html/concepts/concept1_1.html"/>
         <topic label="Concept1_2" href="html/concepts/concept1_2.html"/>
      </topic> 
   </toc>

toc_Tasks.xml

   <toc label="Tâches">
      <topic id="plainTasks" label="Plain Stuff">
         <topic label="Task1" href="html/tasks/task1.html"/>
         <topic label="Task2" href="html/tasks/task2.html"/>
      </topic>
      <topic id="funTasks" label="Fun Stuff" >
         <topic label="Task3_1" href="html/tasks/task3_1.html"/>
         <topic label="Task3_2" href="html/tasks/task3_2.html"/>
      </topic>
   </toc>

toc_Ref.xml

   <toc label="Référence">
      <topic label="Ref1" href="html/ref/ref1.html"/>
      <topic label="Ref2" href="html/ref/ref2.html"/>
   </toc>

Une rubrique peut se limiter à un simple lien vers un contenu. Par exemple, "Task1" fournit un intitulé et une liaison href au contenu. Une rubrique peut également constituer un regroupement hiérarchique de sous-rubriques sans contenu propre. Ainsi, "Fun Stuff" possède un seul intitulé et des sous-rubriques, mais aucun argumenthref. Les rubriques peuvent également réunir toutes ces conditions. Par exemple, "Concept1" possède un argument href et des sous-rubriques.