Nous avons commencé cet exemple par la création de notre plug-in et des fichiers de document. Ensuite nous avons créé des fichiers de table des matières pour décrire l'organisation du contenu. Reste à rassembler le tout dans une table des matières principale et à mettre à jour le fichier plugin.xml pour réellement générer une table des matières.
Il faut d'abord créer un fichier toc.xml pour ajouter les trois tables des matières générées initialement. Au lieu d'indiquer un argument href pour chaque rubrique, vous pouvez utiliser l'attribut link afin de faire référence aux fichiers TDM existants.
<toc label="Online Help Sample" topic="html/book.html"> <topic label="Concepts"> <link toc="toc_Concepts.xml" /> </topic> <topic label="Tâches"> <link toc="toc_Tasks.xml" /> </topic> <topic label="Référence"> <link toc="toc_Ref.xml" /> </topic> </toc>
Il s'agit ensuite de mettre à jour le fichier plugin.xml pour générer la table des matières principale :
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Vous remarquez l'emploi de l'attribut primary. S'il possède la
valeur true, la table des matières doit toujours apparaître dans la navigation,
même si aucune autre table n'y fait référence. De cette façon, l'affichage
de la table "principale" est garanti dans la liste des rubriques. Elle
apparaît dans la liste de niveau supérieur sachant qu'aucune autre table n'y
fait référence.
Remarque : si plusieurs fichiers sont associés à cette table des
matières mais absents de la navigation et seulement liés à partir d'autres
rubriques, nous devons employer l'attribut extradir pour que
celles-ci soient disponibles pour le moteur de recherche.
Vous ajoutez enfin les fichiers TDM individuels.
<extension point="org.eclipse.help.toc"> <toc file="toc_Concepts.xml" /> <toc file="toc_Tasks.xml" /> <toc file="toc_Reference.xml" /> </extension>
Ces fichiers n'apparaissent pas dans la liste de niveau supérieur des ouvrages car l'attribut primary n'a pas été défini. Les fichiers TDM non désignés comme primaires apparaîtront uniquement dans la documentation en ligne si une autre table principale ou liée à une table principale y fait référence.
C'est terminé. Si vous copiez le répertoire de plug-in dans le répertoire plugins de la plate-forme, démarrez cette dernière et choisissez Aide->Rubriques de l'aide, votre exemple doit apparaître dans la liste d'ouvrages. Si vous cliquez sur Exemple d'aide en ligne, votre structure de table des matières s'affiche :