Contexts

Identifier: org.eclipse.help.contexts

Description: For defining context-sensitive help for an individual plug-in.

Configuration Markup:

   <!ELEMENT extension (contexts*)>

   <!ATTLIST extension
     point CDATA #REQUIRED
     id    CDATA #IMPLIED
     name  CDATA #IMPLIED
   >

   <!ELEMENT contexts EMPTY>

   <!ATTLIST contexts
     file CDATA #REQUIRED
   >

Examples: The following is an example of using the contexts extension point:
(in file plugin.xml)

   <extension point="org.eclipse.help.contexts"> 
      <contexts file="xyzContexts.xml"/> 
   </extension> 

(in file 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>
 

Externalizing Strings The Context XML files can be translated and the resulting copy (with translated descriptions labels) should be placed in nl/<language>/<country> or nl/<language> directory.  The <language> and <country> stand for two letter language and country codes as used in locale codes.  For example, Traditional Chinese translations should be placed in the nl/zh/TW directory.  The nl/<language>/<country> directory has a higher priority than nl/<language>.  Only if no file is found in the nl/<language>/<country>, the file residing in nl/<language> will be used.  The the root directory of a plugin will be searched last.

The related topics contained in doc.zip can be localized by creating a doc.zip file with translated version of documents, and placing doc.zip in
nl/<language>/<country> or nl/<language> directory. The help system will look for the files under this directories before defaulting to plugin directory.

API Information: No code is required to use this extension point. All that is needed is to supply the appropriate manifest file(s) mentioned in the plugin.xml file.

Supplied Implementation: The optional default implementation of the help system UI supplied with the Eclipse platform fully supports the contexts extension point.