描述和封装弹出信息内容

通过将用户界面代码中声明的上下文标识与描述和至联机帮助中相关主题的链接列表相关联来描述弹出信息。这些关联在 XML 文件中进行。您可以为每个插件创建包含弹出信息关联的任何数目的 XML 文件。每个上下文标识的描述和链接都在 XML 文件中的 <context> 元素内部给出。每个上下文元素都可以有可选的 <description> 元素,它用来描述用户界面对象和与联机文档链接的任何数目的 <topic> 元素。

<contexts>
	<context id="panic_button">
		<description>This is the panic button.</description>
		<topic href="tasks/pushing_the_panic_button.htm" label="Pushing the panic button"/>
		<topic href="reference/panic_button.htm" label="Panic Button Reference"/>
	</context>
	...
</contexts>

一旦在 XML 文件(一个或多个)中描述了上下文,就可以引用插件清单中的上下文文件。注意:以上的上下文标识不是全限定的。这是允许的,只要在定义上下文标识的插件清单中添加了上下文文件。换句话说,上下文标识被解析为添加 XML 文件的插件的标识。  

插件使用 org.eclipse.help.contexts 扩展点向上下文文件进行添加。  

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

您可以通过包含 plugin 属性来从其它插件引用上下文文件。这允许您在一个插件中分组所有文档(包括弹出信息),并从用户界面代码插件或一些其它相关插件引用它。

   <extension point="org.eclipse.help.contexts">
      <contexts name="myInfopops.xml" plugin="com.example.helpExample"  />
   </extension>

如您所见,在将弹出信息组织进包含在一个或多个插件中的一个或多个文件时,具有许多灵活性。主要的注意事项是文件中的上下文标识可正确解析。若未全限定上下文标识,则必须向插件中添加声明了上下文标识的上下文 XML 文件。若您在上下文 XML 文件中使用了全限定上下文标识,则您在 XML 文件的位置和要添加到上下文的插件方面具有完全的灵活性。

多个插件的弹出信息

另一级别的灵活性是能够从不同插件为相同上下文标识添加弹出信息。这是很有用的,例如,若有可能安装到用户配置或未安装的不同文档插件集。这允许每个文档插件独立地声明它的上下文。最终用户将看到为小窗口标识添加上下文的所有插件的合并弹出信息内容。

注意,必须使用对小窗口的全限定上下文标识,因为没有文档插件声明了上下文标识。当多个插件为相同的上下文标识添加弹出信息时,将首先显示声明了上下文的插件(UI 插件)中定义的内容。附加描述和链接的附加没有一定次序。

Copyright IBM Corporation and others 2000, 2003.