附註:說明系統仍在開發中,應該還需要有些更動,才能夠進入穩定狀態。 在這個階段將它提供出來是為了取得先期使用者的意見,但使用者必須瞭解,提供機制的細節可能會有截然不同的更動。

環境定義

識別碼:org.eclipse.help.contexts

說明:用來定義個別外掛程式的上下文相關說明。

配置標記:

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

環境定義的配置標記(這是放在環境定義處理檔中的項目)

    <!ELEMENT contexts (context)* ) >

    <!ELEMENT context (description?,topic*) >
    <!ATTLIST context id  ID #REQUIRED >

    <!ELEMENT description (#PCDATA)>

    <!ELEMENT topic (topic)* >
    <!ATTLIST topic id ID #IMPLIED >
    <!ATTLIST topic label CDATA #REQUIRED >
    <!ATTLIST topic href  CDATA #IMPLIED >

環境定義處理檔會提供使用者要求上下文相關說明時所需要的所有資訊。 平台會傳遞這個 ID 來識別目前在作用中的環境定義。 之後,就會擷取含相符 ID 的環境定義之定義。 這個環境定義元素含有要讓使用者見到的簡要說明,以及使用者在理解現行環境定義時可能會覺得很有用的主題。
 

範例:

以下是使用 contexts 延伸點的範例 :

(在 plugin.xml 檔中)

   <extension point="org.eclipse.help.contexts">
      <contexts name="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>
 

外部化字串

環境定義處理檔會將字串取代為某個鍵(如 %fooWidget),並採用下列格式在 context.properties 檔中建立一個項目,外部化它們的字串:
    fooWidget = "Builds the project"
相關的主題標籤是利用類似方式來外部化的。 如果要外部化 <topic href="fooHelp.html" label="Building Projects">,請將它的標籤取代為 %buildingProjects 鍵。 這個主題可能會類似:
    <topic href="fooHelp.html" label="%buildingProjects">
請在含有下列項目的 context.properties 檔中建立一個項目:
    buildingProjects = Building Projects
當查閱我們的上下文說明構成要素所外部化的字串時,說明系統會用到 context.properties。
 

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

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

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.