活動支援

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>

元素 documentMessage 的屬性 class 必須實作 org.eclipse.help.ILiveHelpAction 介面。

Eclipse SDK 提供使用詞彙「功能」的預設活動支援,並從已停用主題的超鏈結開啟「功能」喜好設定頁面。在置換時,確認變更及專有名詞與平台使用者介面中的相符。