上下文帮助编辑器

通过上下文相关帮助机制,可以将用户界面部件与特定帮助主题链接起来。当用户激活相关联的用户界面部件时,就会在动态帮助区中显示帮助页。用户界面与帮助页面通过两种方式互相关联:静态 XML 文件或动态上下文提供程序。要使页面以静态方式相关联,必须创建上下文帮助 XML 文件。上下文帮助编辑器可以帮助您创建这些页面。

该编辑器的定义页面提供了 XML 文件的图形视图,该视图分为两列。左边一列的标题为上下文帮助,它按树的形式显示各个 XML 元素,同时还会显示用于添加、移动和除去这些 XML 元素的操作。另一列提供了有关在左边一列中所选元素的更详细信息,并且可以编辑这些详细信息。

此编辑器的源代码页提供 XML 文件的文本视图。您可以直接编辑 XML,所作的更改如果有效的话,将反映在定义图形页中。

添加新的帮助上下文

已填写各个字段的帮助上下文编辑器

要添加新上下文,请单击添加上下文按钮。这将对 XML 添加新的上下文条目,并且该条目将显示在定义页上的树中。新上下文将被选中,从而在编辑器的右列中打开详细信息部分。在这个详细信息部分中,您可以提供关于该上下文的更详细信息,其中包括:

添加帮助主题和命令

通过对文件添加上下文,将提供具有要向用户显示的基本描述的动态帮助。通常,您希望提供其他指向帮助系统中相关主题的链接。要完成此任务,必须在 XML 文件中添加主题和命令。

已填写各个详细信息字段的帮助上下文编辑器

通过单击添加主题按钮,可以将新主题条目添加到 XML 中其中一个帮助上下文之下。主题将作为链接向用户显示。创建新主题后,您可以将其选中,以便打开定义页右列中的主题详细信息部分。在详细信息部分中,您可以更改将向用户显示的标签以及将要链接的文件的位置。在大多数情况下,链接的文件将是帮助系统中的 HTML 页面。您可以使用浏览...按钮来搜索要链接的文件。

除添加主题以外,您还可能想添加命令。对于用户而言,命令的外观与主题相同。但是,当链接被激活时,将执行代码命令,而不是打开文件。命令可以用于打开首选项页和执行其他操作。

帮助上下文编辑器的添加命令

单击添加命令按钮以添加新命令。您可以按照编辑主题的方式来编辑命令的详细信息。

除去命令、将命令上移以及将命令下移

定义页还提供了另外三个按钮,通过使用这些按钮,可以对上下文列表中的各个项进行排序或者删除这些项。

提供了处理按钮的帮助上下文

这些按钮是:

注册上下文帮助文件

要使 Eclipse 认识到上下文帮助 XML 文件是动态帮助系统的源,必须通过 org.eclipse.help.contexts 扩展点来注册该文件。编辑器提供了一种自动注册上下文帮助文件的方法。在编辑器右上角,有一个名为“注册此上下文帮助文件”的链接。单击此链接将在 plugin.xml 文件中添加正确的条目。