環境定義

識別碼:org.eclipse.help.contexts

說明:用來定義個別外掛程式的內容相關輔助說明。

配置標記:

   <!ELEMENT contexts EMPTY>
   <!ATTLIST contexts file CDATA #REQUIRED>

環境定義的配置標記(這是放在環境定義 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 中,與主題一起就是線上說明的一部份。
 

範例:

以下是使用環境定義延伸點的範例 :

(在 plugin.xml 檔中)

   <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>
 

外部化字串

TOC XML 檔案可被翻譯並結果副本(和翻譯過的說明標籤)必須被放置在 nl/<language>/<country> 或 nl/<language> 目錄。<language> 和 <country> 使用語言環境碼的兩個字母來表示。例如,繁體中文翻譯放置在 nl/zh/TW 目錄下。 nl/<language>/<country> 目錄比 nl/<language>具有高優先權。只有在 nl/<language>/<country>目錄找不到檔案時,才會使用在 nl/<language> 目錄下的檔案。最後才會搜尋根目錄下的外掛。

相關主題可藉由下列方式進行本土化 - 建立將翻譯後文件併入的 doc.zip,把這個 doc.zip 檔放置在
nl/<language>/<country> 或 nl/<language> 目錄下。在預設為 plugin 目錄前,說明系統將在這個目錄下尋找檔案。

 
API 資訊使用這個延伸點不需要任何程式碼。 只需要提供 plugin.xml 檔中所提及的適當 manifest 檔就行了。
 

提供的實作:Eclipse 平台所提供的說明系統 UI 之預設實作能充分支援 contexts 延伸點。


Copyright IBM Corp. and others 2000, 2002. All Rights Reserved.