說明及包裝蹦現資訊內容

蹦現資訊由建立 UI 程式碼所宣告的環境定義 ID 與線上說明中鏈結至相關主題的清單的關聯性來說明。這些關聯在 XML 檔中製作的。您可以為每一個外掛程式建立含有蹦現資訊關聯的 XML 檔案號碼。每一個環境定義 ID 的說明與鏈結是在 XML 檔 <context> 元素中製作的。每一個環境定義元素可以有選用的 <description> 元素,用來說明 UI 物件和 <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 檔案中說明環境定義時,您已備妥參照外掛程式 Manifest 中的環境定義檔案。請注意上述環境定義 ID 不完整。只要在定義環境定義 ID 的外掛程式 Manifest 中提供環境定義檔案, 這是被容許的。換句話說,環境定義 ID 被解析為提供 XML 檔案的外掛程式 ID。

外掛程式使用 org.eclipse.help.contexts 延伸點提供環境定義檔案。

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

您可以藉由併入外掛程式 屬性以從其他外掛程式參照環境定義檔。這讓您為所有文件分組,包括一個外掛程式的蹦現資訊並從 UI 程式碼外掛程式或其他某些相關的外掛程式參照它。

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

如同您所見的,您有很多彈性來組織蹦現資訊為併入一或多個外掛程式中的一或多個檔案。主要因素是檔案中環境定義 ID 正確的解析。如果您沒有完整的環境定義 ID,您必須提供外掛程式中內容 XML 檔案來宣告環境定義 ID。如果您在環境定義 XML 檔案使用完整的環境定義 ID,則您在外掛程式提供環境 定義的 XML 檔案位置中有完整彈性。

多重外掛程式蹦現資訊

彈性的另一個層面是從不同的外掛程式為相同的環境定義 ID 提供蹦現資訊的功能。這非常有用,例如,如果有不同的文件外掛程式集,可能會或可能不會安裝在 安裝在使用者的配置架構中。這讓每一個文件外掛程式獨立宣告它的環境定義。一般使用者會看到所有外掛程式合併的蹦現資訊環境定義,其為 Widget 的 ID 提供環境定義。

請注意 Widget 必須使用完整的環境定義 ID,因為沒有文件外掛程式宣告環境定義 ID。當多重外掛程式為相同環境定義 ID 提供蹦現資訊時,外掛程式中定義的環境定義 首先顯示宣告的環境定義(UI 外掛程式)。以無一定的次序附加其他的說明和鏈結。

Copyright IBM Corporation and others 2000, 2003.