オプション: ノードへのヘルプの追加

  1. オンライン・ヘルプをノードに追加します。 プロジェクト内に help.html ファイルを作成し、 ノードが行えることおよびその方法について説明したオンライン・ヘルプを含めることができます。 複数のファイルがある場合は、プラグイン・プロジェクトに別個の doc サブディレクトリーを作成し、そこにオンライン・ヘルプ・ファイルを格納することも検討できます。 ノードのオンライン・ヘルプの表示が製品提供の情報と統合されるようにすることができます。 WebSphere Business Integration Message Broker 製品情報で、 「参照 (Reference)」>「メッセージ・フロー・ノード (Message flows nodes)」を選択すると、 「ユーザー定義ノード (User-defined nodes)」という葉ノードがあります。 ノードのオンライン・ヘルプがこのノードに表示されるようにするには、 以下のようにする必要があります。
    1. 拡張ポイントを次の WebSphere Business Integration Message Broker 製品資料に組み込むために、plugin.xml ファイルを変更します。
      <extension point="org.eclipse.help.toc">
      	<toc file="toc.xml"/>
      </extension>
    2. プラグイン・ノード・プロジェクトに toc.xml ファイルを作成し、 link_to 属性を変更して、 WebSphere Business Integration Message Broker 資料の目次に次のように既に定義されている「UDNodes」アンカーにリンクします。
      <toc label="My Plugin Node" topic="my_node.htm" link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      	<topic label="Mytopic 1" href="topic1.htm>
      </toc>
      このようにすると、目次の「参照 (Reference)」>「メッセージ・フロー (Message flows)」>「ユーザー定義ノード (User-defined nodes)」を選択して、ヘルプ・トピックを参照できます。

      製品に添付されているサンプル・ノードは、この機能のデモを行います。

      拡張ポイントおよびその使用法に関する詳細な説明については、 PDE ガイド (PDE Guide) を参照してください。

  2. コンテキスト (F1) ヘルプをノードに追加します。 「ブローカー・アプリケーション開発 (Broker Application Development)」パースペクティブ でノードをクリックして F1 を押すと表示されるのが、 このヘルプです。

    ノードが作成されると、HelpContexts.xml ファイルが作成されます。 このファイルは、ノードの名前に基づいてコンテキスト ID を割り当てます。 記述フィールドのテキストを変更することによって、 使用するノードの HelpContexts.xml ファイルを変更できます。 HelpContexts.xml ファイルの名前はプロジェクト内で重複があってはなりませんが、名前に複数のコンテキスト・エントリーを含めることはできます。たとえば、1 つのプロジェクト内に複数のノードがある場合、各ノードはこのファイルの中にそれぞれのコンテキスト・ヘルプを持つことができます。

    コンテキスト・ヘルプには、長さの制限があります。 ユーザーにより詳細なヘルプを提供する便利な方法は、F1 ヘルプから補足情報を含む HTML ファイル(たとえば、前述の例ではノードのオンライン・ヘルプ) にリンクすることです。 このリンクは、次のようにコード化してください。
    <topic href"../plugin directory/html file" label="Link title">
  3. ノード吹き出しヘルプ (ツールチップ・ヘルプ) を追加します。 ノードが作成されると、palette.properties ファイルが作成されます。 ノード用の吹き出しヘルプを含むようにこのファイルを変更することができます。 このヘルプは、ノード名をすべて表示できるほどパレットが広くない場合にそのノード名を表示するのに使用されます。

オプション機能を何も追加しない場合は、この時点でご使用のノードをテストできます。 そのためにはワークベンチの別のインスタンスを起動し、 「実行 (Run)」>「実行 (Run as)」>「Runtime Workbench」を選択します。 Runtime Workbench を使用してのテストに関しては、 PDE ガイド (PDE Guide) を参照してください。

関連概念
ユーザー定義の入力ノード
ユーザー定義のメッセージ処理ノード
ユーザー定義の出力ノード

関連タスク
ユーザー定義拡張機能の開発
提供されているサンプルのインプリメント
ユーザー定義ノードのテスト
ユーザー定義ノードの配布

関連資料
ユーザー定義拡張機能