說明:用來定義個別外掛程式的上下文相關說明。
配置標記:
<!ELEMENT extension (contexts*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA
#IMPLIED
name CDATA #IMPLIED
>
<!ELEMENT contexts EMPTY>
<!ATTLIST contexts
file CDATA #REQUIRED
plugin CDATA #IMPLIED
>
放在環境定義 manifest 檔中的「配置標記」:
<!ELEMENT contexts (context)* ) >
<!ELEMENT context (description?,topic*) >
<!ATTLIST context id ID #REQUIRED >
<!ELEMENT description (#PCDATA)>
<!ELEMENT topic EMPTY >
<!ATTLIST topic label CDATA #REQUIRED >
<!ATTLIST topic href CDATA #IMPLIED
>
環境定義 manifest 檔會提供使用者要求上下文相關說明時所需要的所有資訊。 平台會傳遞這個 ID 來識別目前在作用中的環境定義。 接著,將擷取含有相符 ID 的環境定義檔。然後,說明系統將建立 IContext 物件, 來含有來自給定的 ID 之所有環境定義的說明及主題。說明將顯示給使用者, 而且相關主題可能有助於使用者瞭解現行環境定義。相關的主題是 HTML 檔案並壓縮在 doc.zip 中,與主題一起就是線上說明的一部份。
如果外掛程式定義了某個環境定義 ID,使用者就可以利用相同 ID 宣告另一個環境定義,來延伸環境定義的說明或相關鏈結。
<extension point="org.eclipse.help.contexts"> <contexts file="xyzContexts.xml"/> </extension>
(在 xyzContexts.xml 檔中)
<contexts>
<context id="generalContextId">
<description>這是範例 F1 說明字串。</description>
<topic href="contexts/RelatedContext1.html"
label="Help Related Topic 1"/>
<topic href="contexts/RelatedContext2.html"
label="Help Related Topic 2"/>
</context>
</contexts>
相關主題可藉由下列方式進行本土化 - 建立將翻譯後文件併入的 doc.zip,把這個 doc.zip 檔放置在
nl/<language>/<country> 或 nl/<language> 目錄下。在預設為 plugin 目錄前,說明系統將在這個目錄下尋找檔案。
API 資訊:使用這個延伸點不需要任何程式碼。只需要提供 plugin.xml 檔中所提及的適當 manifest 檔 就行了。
提供的實作:Eclipse 平台所提供的說明系統 UI 之預設實作能充分支援 contexts 延伸點。
Copyright (c) 2000, 2003 IBM Corporation and others.
All rights reserved.
這個程式和伴隨的素材可以根據伴隨這個分送,而且可在 http://www.eclipse.org/legal/cpl-v10.html 中取得的 Common Public License v1.0 的條款來使用