<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Marques de configuration du fichier d'index :
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
L'élément d'index
L'élément d'index représente une instance d'index. L'index se compose d'entrées, chacune d'elle correspondant à un mot clé spécifique. Tous les index ajoutés sont fusionnés en un index principal que le système d'aide fournit à l'utilisateur. Lorsque l'index est constitué, les entrées sont ajoutées dans l'ordre alphabétique.
L'élément d'entrée
L'élément d'entrée représente un mot clé de l'index. Chaque entrée peut contenir plusieurs liens vers les rubriques d'aide qui sont associées au mot clé. L'entrée peut également être un conteneur pour d'autres entrées (sous-entrées) pour former une hiérarchie de mots clés. Une entrée peut être un conteneur pour les sous-entrées et contenir des rubriques en parallèle.
L'élément de rubrique
L'élément de rubrique fournit une référence à la table des matières de l'aide associée au mot clé. L'attribut href est relatif au plug-in auquel appartient le fichier manifeste. Si vous devez accéder à un fichier dans un autre plug-in, vous pouvez utiliser la syntaxe suivante :
<topic label="rubrique dans un autre plug-in" href="../other.plugin.id/concepts/some_other_file.html"/>
L'attribut title permet d'attribuer un nom au lien vers la table des matières de l'aide lorsque plusieurs rubriques sont associées à un même mot clé. Si l'attribut n'est pas spécifié, le titre est issu d'une table des matières qui contient le lien. Si le lien n'appartient à aucune table des matières, l'attribut title doit être indiqué, sans quoi le titre ne sera pas défini.
(dans le fichier plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(dans le fichier index.xml)
<index>
<entry keyword="Véhicule">
<topic href="inventory_of_wheel.html"/>
<entry keyword="Voiture>
<topic href="car.html"/>
</entry>
<entry keyword="Bateau>
<topic href="ship.html"/>
</entry>
<entry keyword="Avion>
<topic href="airplane.html" title="Histoire de l'aviation"/>
<topic href="jet.html" title="Moteur Jet>
</entry>
</entry>
<entry keyword="Moteur">
<entry keyword="Cheval">
<topic href="horse.html"/>
</entry>
<entry keyword="Bateau à vapeur">
<topic href="steamer.html"/>
</entry>
<entry keyword="Moteur Jet">
<topic href="wankel.html"/>
</entry>
<entry keyword="Moteur Jet">
<topic href="jet.html"/>
</entry>
</entry>
<entry keyword="Electricité">
<topic href="electricity.html"/>
</entry>
</index>
Internationalisation Les fichiers XML d'index peuvent être traduits et la copie résultante (mots clé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 du 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.
Copyright (c) 2006 Intel Corporation and others.
All rights reserved. Ce programme et les produits qui l'accompagnent sont
distribués sous licence publique v1.0 d'Eclipse et disponibles à l'adresse suivante : http://www.eclipse.org/legal/epl-v10.html