ヘルプ目次プロデューサー

org.eclipse.help.contentProducer

3.0

実行時に生成されるダイナミック・ヘルプ目次を提供します。目次プロデューサーはプラグインごとに登録され、プラグイン・スコープ内でのみ機能します。 目次プロデューサーを別のプラグイン内で再利用するには、binding 要素を使用する必要があります。この方法で、すべてのプラグインのための目次作成が、プラグインのアタックを受けないようにします。プラグインは、目次プロデューサーにバインディングすることによって、認可側のプラグイン内のすべての文書のための目次作成をコントロールする許可を目次プロデューサーに与えます。

<!ELEMENT extension (contentProducer | binding)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentProducer (producer)>

<!ATTLIST contentProducer

producer CDATA #IMPLIED>


<!ELEMENT producer (parameter*)>

<!ATTLIST producer

class CDATA #REQUIRED>


<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>


<!ELEMENT binding EMPTY>

<!ATTLIST binding

producerId CDATA #REQUIRED>


目次プロデューサー拡張ポイントの使用例を以下に示します。

  

<extension point=

"org.eclipse.help.contentProducer"

id=

"org.eclipse.myPlugin.myDynamicHelpProducer"

name=

"My Dynamic Help Content"

>

<contentProducer producer=

"org.eclipse.myPlugin.myPackage.Myproducer"

/>

</extension>

提供される目次プロデューサー・クラスは、org.eclipse.help.IHelpContentProducer インターフェースを実装する必要があります。プロデューサーは、プラグインからダイナミック・ヘルプ・リソースのコンテンツを提供します。目次プロデューサーのメソッドは、プラグインから取得された各ヘルプ・リソースに対するヘルプによって呼び出されます。

なし。文書プラグインによってヘルプ目次プロデューサーが提供されない場合や、その呼び出しの結果がヌルになる場合、ヘルプ・システムでは、プラグイン・インストール・ロケーションの doc.zip およびファイル・システムで静的文書を検索し、その内容を表示します。