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

plugin CDATA #IMPLIED>

• file - the name of the manifest file which contains the context-sensitive help documentation for this plug-in.

  Configuration Markup for what goes into the contexts manifest file:

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

  The contexts manifest files provide all the information needed when context-sensitive help is requested by the user. The id is passed by the platform to identify the currently active context. The context definitions with matching IDs are then retrieved. The IContext object is then created by help system that contains descriptions and topics from all context definitions for a given ID.  The description is to be displayed to the user, and related topics might be useful to the user for understanding the current context.  The related topic are html files packaged in doc.zip, together with topics that are part of on line help.

• plugin - Plugin to which its context definitions are extended with extra information.

  If a plugin defines some context id's, one can extend the description or related links of a context by declaring another context with the same id.

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.

Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html