活动支持

org.eclipse.help.base.activitySupport

3.1

此扩展点由产品插件用来配置当使用活动时“帮助”系统的行为。它用于配置以下几个方面:

此扩展点是实验性的,以后随着活动支持的发展,可能会更改。

<!ELEMENT extension (support+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>

<!ATTLIST support

productId CDATA #REQUIRED>


<!ELEMENT showAllMessage (#PCDATA)>

在关闭活动过滤时将显示在对话框中的纯文本消息。该消息的目的是进行警告:如果没有过滤器,某些文档可能会引用不可视的用户界面元素。



<!ELEMENT localScopeCheckbox (#PCDATA)>

本地搜索作用域首选项页面中的复选框的标签。当选中此复选框时,将把属于被禁用活动的文档中的搜索匹配项包括在搜索结果中。



<!ELEMENT documentMessage EMPTY>

<!ATTLIST documentMessage

class    CDATA #IMPLIED

pluginId CDATA #REQUIRED>

将显示在属于禁用活动的帮助主题顶部的 HTML 片段。该消息的目的是通知用户:主题可能包含对不可视的用户界面元素的引用。由于消息文本位于 XML 文件内,所以必须使用特殊字符的标准 XML 实体来退出 HTML 标记。

此消息可能包含一个超链接,该超链接将用户带到为更改活动启用状态而提供的活动编辑器。在这种情况下必须使用 class 属性。



以下是活动支持扩展点的样本用法:

 

<extension point=

"org.eclipse.help.base.activitySupport"

>

<support productId=

"com.example.xyzProduct"

>

<showAllMessage>

此操作将显示目录中的所有主题。

</showAllMessage>

<documentMessage class=

"com.example.xyz.OpenRolePreference"

>

此主题属于当前禁用的角色。 &lt;p&gt; 要启用该角色,打开 &lt;a href="ACTIVITY_EDITOR"&gt;角色首选项页面。&lt;/a&gt;

</documentMessage>

</support>

</extension>

元素 documentMessageclass 属性必须实现 org.eclipse.help.ILiveHelpAction 接口。

Eclipse SDK 提供了缺省活动支持,该支持使用“能力”这一术语,并从禁用的主题中的超链接打开“能力”首选项页面。当进行覆盖时,确保更改和术语与平台用户界面中的对应项相匹配。