Contextes

org.eclipse.help.contexts

Permet de définir une aide contextuelle pour un plug-in individuel.

<!ELEMENT extension (contexts*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contexts EMPTY>

<!ATTLIST contexts

file   CDATA #REQUIRED

plugin CDATA #IMPLIED>


L'exemple ci-dessous illustre l'utilisation du point d'extension de contextes :
(dans le fichier plugin.xml)

   

<extension point=

"org.eclipse.help.contexts"

>

<contexts file=

"xyzContexts.xml"

/>

</extension>

(dans le fichier xyzContexts.xml)

    <contexts>
      <context  id="generalContextId">
        <description> Voici un exemple de chaîne d'aide F1.</description>
        <topic href="contexts/RelatedContext1.html"  label="Rubrique d'aide 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Rubrique d'aide 2"/>
      </context>
    </contexts>
 

Externalisation des chaînes Les fichiers de contexte XML peuvent être traduits et la copie obtenue (avec des intitulés de descriptions également 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.

Les rubriques connexes se trouvant dans le doc.zip peuvent être localisées en créant un fichier doc.zip avec la version traduite des documents et en le plaçant dans le répertoire
nl/<langue>/<pays> ou nl/<langue>. Le système d'aide recherchera les fichier 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 le ou les fichiers manifestes appropriés, mentionnés dans le fichier plugin.xml.

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