Contextes

Identificateur : org.eclipse.help.contexts

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

Marques de configuration :

   <!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
   >

Exemples : Voici un exemple d'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 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.

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

Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved. Ce programme et les produits qui l'accompagnent sont fournis sous licence v1.0 associée à cette distribution et disponibles à l'adresse suivante : http://www.eclipse.org/legal/cpl-v10.html