注: ヘルプ・システムは現在開発中であり、安定版の完成までには変更が予想されます。 初期段階の採択者からは、現在、contribution メカニズムの詳細が予期しない形で変更される可能性のあることを理解した上で、 フィードバックを受け付けています。 |
説明: 個々のプラグインのヘルプ情報を定義します。
構成マークアップ:
<!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>
API 情報: この拡張ポイントには、コードは必要ありません。
plugin.xml ファイルに記された適切なマニフェスト・ファイルを指定するだけです。
提供されるインプリメンテーション: Eclipse プラットフォームに提供されるヘルプ・システム UI の
オプションのデフォルト・インプリメンテーションは、
contexts 拡張ポイントを完全にサポートします。