Remarque : Le système d'aide est toujours en cours de développement et il faut s'attendre à ce qu'il soit modifié d'ici son achèvement. Il est diffusé à ce stade pour solliciter les commentaires des premiers utilisateurs, tout en signalant que les détails des mécanismes de contribution peuvent considérablement changer d'ici là.

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 name 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 (topic)* >
    <!ATTLIST topic id ID #IMPLIED >
    <!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. La définition contextuelle avec un ID correspondant est alors extraite. Cet élément contextuel contient la description abrégée qui doit être affichée à l'utilisateur, ainsi que les rubriques connexes qu'il peut trouver utiles pour comprendre le contexte courant.
 

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 name="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 des chaînes

Les fichiers manifestes de contexte externalisent leurs chaînes en remplaçant la chaîne par une clé (par exemple, %fooWidget) et en créant dans le fichier context.properties une entrée de la forme suivante :
    fooWidget = "Builds the project "
Les libellés des rubriques connexes sont externalisés par une approche similaire. Pour externaliser <topic href="fooHelp.html" label="Building Projects">, remplacez son libellé par une clé %buildingProjects. La rubrique ressemblera à ceci :
    <topic href="fooHelp.html" label="%buildingProjects">
Créez une entrée dans le fichier context.properties contenant l'entrée suivante :
    buildingProjects = Building Projects
Le système d'aide utilisera le fichier context.properties lors de la recherche des chaînes externalisées par les contributions de l'aide contextuelle.
 

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 optionnelle par défaut de l'interface utilisateur du système d'aide fournie avec la plateforme Eclipse supporte le point d'extension contexts.
 
 
 

Copyright IBM Corp. 2000, 2001. Tous droits réservés.