描述弹出信息内容并将弹出信息内容打包

弹出信息是通过将用户界面代码中声明的上下文标识与某个描述及指向联机帮助中的相关主题的链接进行关联来描述的。这些关联是在 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 文件的位置以及由哪个插件提供这些上下文。

多个插件的弹出信息

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

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

法律声明。