上下文

标识符:org.eclipse.help.contexts

描述:用于为个别插件定义上下文相关帮助。

配置标记:

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

上下文的配置标记(这是上下文清单文件的内容)

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

上下文清单文件提供当用户请求上下文相关帮助时所需的所有信息。平台传送此标识以标识当前活动的上下文。于是就检索了具有匹配标识的上下文定义。于是,包含给定标识的所有上下文定义中的描述和主题的帮助系统就创建了 IContext 对象。将对用户显示描述,而相关主题可帮助用户了解当前上下文。相关主题是一些 html 文件,它与作为联机帮助的一部分的主题一起封装在 doc.zip 中。
 

示例:

以下是使用上下文扩展点的示例。

(在 plugin.xml 文件中)

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

(在文件 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>
 

外部化字符串

可以翻译上下文 XML 文件且应该将生成的副本(具有已翻译的描述标号)放置在 nl/<language>/<country> 或 nl/<language> 目录中。<language> 和 <country> 代表两个字母的语言和国家或地区代码,与在语言环境代码中使用的一样。例如,“繁体中文”翻译应放置在 nl/zh/TW 目录中。nl/<language>/<country> 目录的优先级高于 nl/<language>。仅当在 nl/<language>/<country> 中找不到任何文件时才会使用驻留在 nl/<language> 中的文件。将最后搜索插件的根目录。

可通过创建具有已翻译版本的文档的 doc.zip 文件并将 doc.zip 文件放置在
nl/<language>/<country> 或 nl/<language> 目录中来使 doc.zip 中包含的相关主题本地化。在缺省设置为插件目录之前,帮助系统将查找这些目录下面的文件。

 
API 信息使用此扩展点不需要任何代码。只需要提供在 plugin.xml 文件中提到的相应清单文件。
 

所提供的实现:随 Eclipse 平台一起提供的帮助系统 UI 的缺省实现完全支持上下文扩展点。


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