注意:帮助系统仍在开发中,可能在获得稳定版本之前还会作些更改。在现阶段提供它的目的是为了获取早期使用者的反馈,因为我们知道添加机制的具体细节可能会断断续续地进行更改。

上下文

标识符:org.eclipse.help.contexts

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

配置标记:

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

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

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

上下文清单文件提供当用户请求上下文相关帮助时所需的所有信息。 平台传送此标识以标识当前活动的上下文。 然后,检索具有匹配的标识的上下文定义。 此上下文元素包含将要对用户显示的简要描述以及用户可能发现对于理解当前上下文很有用的相关主题。
 

示例:

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

(在 plugin.xml 文件中)

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

(在文件 xyzContexts.xml 中)

    <contexts>
      <context  id="generalContextId">
        <description> 这是样本 F1 帮助字符串。</description>
        <topic href="contexts/RelatedContext1.html"  label="Help Related Topic 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Help Related Topic 2"/>
      </context>
    </contexts>
 

外部化字符串

上下文清单文件通过将字符串替换为键(例如 %fooWidget) 并在表单的 context.properties 文件中创建条目来使它们的字符串外部化:
    fooWidget = "Builds the project "
相关主题标号是使用相似的方法来外部化的。 要外部化 <topic href="fooHelp.html" label="Building Projects">, 将它的标号替换为键 %buildingProjects。 主题将变为:
    <topic href="fooHelp.html" label="%buildingProjects">
在包含条目的 context.properties 文件中创建条目:
    buildingProjects = Building Projects
当查找由上下文帮助添加项外部化的字符串时,帮助系统将使用 context.properties。
 

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

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

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.