Index des mots clés

org.eclipse.help.index

3.2

Enregistrer un index de mots clés pour la table des matières de l'aide ajoutée.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


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

(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.

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 index.