コンテキスト

ID: org.eclipse.help.contexts

説明: 個々のプラグインのヘルプ情報を定義します。

構成マークアップ:

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

コンテキストの構成マークアップ (コンテキストのマニフェスト・ファイルの内容):

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

コンテキスト・マニフェスト・ファイルには、ユーザーがヘルプ情報を要求した際に必要とされる情報がすべて含まれています。 プラットフォームからは、現在アクティブなコンテキストを識別するための ID が渡されます。 マッチング ID を持つコンテキスト定義が検索されます。 次に、指定された ID のすべてのコンテキスト定義の説明とトピックが含まれるヘルプ・システムにより、 IContext オブジェクトが作成されます。 説明がユーザーに表示され、関連トピックは現在のコンテキストを理解するために役立ちます。 関連トピックは、オンライン・ヘルプの一部であるトピックとともに doc.zip にパッケージされた HTML ファイルです。
 

例:

contexts 拡張ポイントの例を次に示します。

(ファイル plugin.xml)

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

ストリングの外部化

Context XML ファイルは変換可能で、結果のコピー (変換された説明のラベル付き) は nl/<language>/<country> または nl/<language> ディレクトリーに配置されます。 <language> と <country> はロケール・コードで使用される言語と国別コードを示す 2 文字です。 たとえば、中国語 (繁体字) 変換は nl/zh/TW ディレクトリーに配置されます。 nl/<language>/<country> ディレクトリーは nl/<language> より高い優先順位を持ちます。 nl/<language>/<country> にファイルが見つからない場合のみ、nl/<language> にあるファイルが 使用されます。 プラグインのルート・ディレクトリーは最後に検索されます。

doc.zip に含まれる関連トピックは、変換されたバージョンの文書で doc.zip ファイルを作成し、 doc.zip を
nl/<language>/<country> または nl/<language> ディレクトリーに配置する ことによりローカライズできます。 ヘルプ・システムは、プラグイン・ディレクトリーをデフォルトにする前に、このディレクトリー下にある ファイルを探します。

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

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


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