Contextes

Identificateur : org.eclipse.help.contexts

Description : destiné à la définition de l'aide contextuelle d'un plug-in individuel.

Marques de configuration :

   <!ELEMENT contexts EMPTY>
   <!ATTLIST contexts file CDATA #REQUIRED>

Marques de configuration pour les contextes (elles correspondent à ce qui entre dans le fichier manifeste des contextes) :

    <!ELEMENT contexts (context)* ) >

    <!ELEMENT context (description?,topic*) >
    <!ATTLIST context id ID #REQUIRED >

    <!ELEMENT description (#PCDATA)>

    <!ELEMENT topic EMPTY >
    <!ATTLIST topic label CDATA #REQUIRED >
    <!ATTLIST topic href CDATA #IMPLIED >

Les fichiers manifestes des contextes fournissent tous les informations requises lorsque l'aide contextuelle est demandée par l'utilisateur. L'ID est transmis par la plateforme pour identifier le contexte actif en cours. Les définitions de contexte correspondant aux ID sont alors extraites. L'objet IContext est ensuite créé par le système d'aide contenant les descriptions et les rubriques de toutes les définitions de contexte pour un ID donné. La description doit être visible par l'utilisateur et les rubriques connexes peuvent servir à comprendre le contexte actuel. Ces rubriques sont des fichiers html rassemblés dans un doc.zip avec les autres rubriques faisant partie de l'aide en ligne.
 

Exemples :

L'exemple ci-dessous montre l'utilisation du point d'extension contexts.

(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> This is a sample F1 help string.</description>
        <topic href="contexts/RelatedContext1.html"  label="Help Related Topic 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Help Related Topic 2"/>
      </context>
    </contexts>
 

Externalisation de chaînes

les fichier 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> possède une priorité supérieure à nl/<langue>. Seulement si un fichier se trouve dans nl/<langue>/<pays>, celui figurant dans nl/<langue> sera 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 fichiers dans ces répertoires avant d'aller par défaut dans le répertoire du plug-in.

 
Informations d'API : aucun code n'est requis pour utiliser le point d'extension. Il suffit de fournir le(s) fichier(s) manifeste(s) approprié(s), mentionné(s) dans le fichier plugin.xml.
 

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


Copyright IBM Corp. and others 2000, 2002. All Rights Reserved.