Table des matières (TDM)

org.eclipse.help.toc

Permet d'enregistrer une contribution d'aide en ligne pour un plug-in individuel.

Chaque plug-in contribuant aux fichiers d'aide fonctionne en général comme suit :

De manière optionnelle, un index d'aide peut être préétabli et enregistré en utilisant l'élément index afin d'améliorer les performances de la première tentative de recherche. Il n'est possible d'enregistrer qu'un seul index par plug-in - plusieurs éléments index auront pour conséquence un comportement non défini.

<!ELEMENT extension (toc* , index?)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT toc EMPTY>

<!ATTLIST toc

file     CDATA #REQUIRED

primary  (true | false) "false"

extradir CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(depuis la version 3.1) élément facultatif permettant la déclaration d'un index de recherche préétabli créé à partir de documents fournis par ce plug-in.



L'exemple ci-dessous illustre l'utilisation du point d'extension toc.

(dans le fichier plugin.xml)

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"maindocs.html"

primary=

"true"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(dans le fichier maindocs.xml)

<toc label="Exemple de système d'aide">
 <topic label="Introduction" href="intro.html"/>
 <topic label="Tâches">
  <topic label="Création d'un projet" href="tasks/task1.html">
   <topic label="Création d'un projet Web" href="tasks/task11.html"/>
   <topic label="Création d'un projet Java" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Test d'un projet" href="tasks/taskn.html"/>
 </topic>
 <topic label="Exemples">
  <topic label="Création d'un projet Java" href="samples/sample1.html">
   <topic label="Lancement d'un assistant" href="samples/sample11.html"/>
   <topic label="Définition d'options" href="samples/sample12.html"/>
   <topic label="Fin de la création de projet" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(dans le fichier tasks.xml)

<toc label="Génération d'un projet">
 <topic label="Génération d'un projet" href="build/building.html">
  <topic label="Génération d'un projet Web" href="build/web.html"/>
  <topic label="Génération d'un projet Java" href="build/java.html"/>
 </topic>
</toc>


(dans le fichier samples.xml)

<toc link_to="maindocs.xml#samples" label="Utilisation de l'outil de compilation">
 <topic label="Exemple d'outil de compilation" href="compilesample/example.html">
  <topic label="Etape 1" href="compilesample/step1.html"/>
  <topic label="Etape 2" href="compilesample/step2.html"/>
  <topic label="Etape 3" href="compilesample/step3.html"/>
  <topic label="Etape 4" href="compilesample/step4.html"/>
 </topic>
</toc>

En supposant que d'autres documents existent avec le chemin commençant par "samples", ils n'apparaîtront pas dans l'arborescence mais seront accessibles par le biais de recherches. La raison est la présence de l'attribut "extradir" dans l'élément <toc file="sample.xml" extradir="samples"/> à l'intérieur du fichier plugin.xml. Par exemple, la recherche de "Création d'un projet Java" peut renvoyer un document "Autres modes de création d'un projet Java", dont le chemin est samples/sample2.html.

Internationalisation Les fichiers TOC XML peuvent être traduits et la copie résultante (intitulés traduits) doit être placée dans le répertoire nl/<langue>/<pays> ou nl/<langue>.  Les répertoires <langue> et <pays> correspondent aux deux lettres de code de langue et de pays utilisé dans les environnements locaux.  Par exemple, les traductions en chinois traditionnel doivent être placées dans le répertoire nl/zh/TW.  Le répertoire nl/<langue>/<pays> a une priorité supérieure à nl/<langue>.  Ce n'est que si un fichier se trouve dans nl/<langue>/<pays> que celui figurant dans nl/<langue> est utilisé.  Le répertoire racine d'un plug-in sera inspecté en dernier.

La documentation se trouvant dans le fichier doc.zip peut être localisée en créant un fichier doc.zip avec la version traduite des documents et en plaçant ce fichier dans le répertoire
nl/<langue>/<pays> ou nl/<langue>. Le système d'aide recherchera les fichiers dans ces répertoires avant d'aller par défaut dans le répertoire du plug-in.
 

Aucun code n'est requis pour utiliser ce point d'extension. Il suffit de fournir les fichiers manifestes appropriés, mentionnés dans le fichier plugin.xml.

L'implémentation par défaut de l'interface utilisateur du système d'aide fournie avec la plateforme Eclipse supporte totalement le point d'extension toc.