ヘルプ目次の拡張

org.eclipse.help.contentExtension

この拡張ポイントは、ヘルプ・システム・ページ内の動的で再使用可能なコンテンツをサポートするためのものです。これにより、既存のヘルプ・システム・ページ内へコンテンツをコントリビュートすることが可能になります。ヘルプ・システム内のどの XHTML ページも、anchor 要素を使用してコントリビューション・ポイントを明示的に指定することによって、コンテンツ・コントリビューションを受諾できることを「宣言」できます。従って、XHTML のスニペットは、実行時に動的にこれらの文書内に挿入されることが可能です。

<!ELEMENT extension (contentExtension+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentExtension EMPTY>

<!ATTLIST contentExtension

file CDATA #REQUIRED>

1 つ以上のヘルプ・システム・ページに対して、コンテンツ拡張を定義します。コンテンツ拡張ファイルのロケーションは、file 属性によって指定されます。



contentExtension 拡張ポイントの使用例を以下に示します。

(ファイル plugin.xml)

 

<extension point=

"org.eclipse.help.contentExtension"

>

<contentExtension file=

"contentExtensionFile.xml"

/>

</extension>

(ファイル contentExtensionFile.xml)

<contentExtension>

<topicExtension content=

"xhtml/topicA.xhtml"

path=

"org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml/topicAnchor"

/>

</contentExtension>

上記のコントリビューションは、XHTML ファイル topicA.xhtml のコンテンツを、path 属性によって指定されたターゲットのヘルプ・システム・ページ内へ挿入します。この事例では、コンテンツ拡張は、プラグイン org.xxx.yyy.somePluginId 内のページ someHelpPage.xhtmltopicAnchor という名前のロケーションに挿入されます。

上記のコントリビューションは、XHTML ファイル topicA.xhtml のコンテンツを、path 属性によって指定されたターゲットのヘルプ・システム・ページ内へ挿入します。この事例では、コンテンツ拡張は、プラグイン org.xxx.yyy.somePluginId 内のページ someHelpPage.xhtmltopicAnchor という名前のロケーションに挿入されます。

この拡張ポイントにコードは必要ありません。必要なのは、plugin.xml ファイルに記された適切なコンテンツ・ファイルを提供することだけです。

Eclipse プラットフォームに提供されている基本ヘルプ・システムのデフォルト実装では、この contentExtension 拡張ポイントが完全にサポートされます。