注: ヘルプ・システムは現在開発中であり、安定版の完成までには変更が予想されます。 初期段階の採択者からは、現在、contribution メカニズムの詳細が予期しない形で変更される可能性のあることを理解した上で、 フィードバックを受け付けています。

コンテキスト

ID: 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> This is a sample F1 help string.</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
ヘルプ・システムは、コンテキスト・ヘルプ contribution により外部化されたストリングを参照する際に context.properties を使用します。
 

API 情報: この拡張ポイントには、コードは必要ありません。 plugin.xml ファイルに記された適切なマニフェスト・ファイルを指定するだけです。
 

提供されるインプリメンテーション: Eclipse プラットフォームに提供されるヘルプ・システム UI の オプションのデフォルト・インプリメンテーションは、 contexts 拡張ポイントを完全にサポートします。
 
 
 

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