ノードへのヘルプの追加

作成したノードのヘルプ情報を HTML ファイルとして追加します。

始める前に:
作成したノードのヘルプ情報を追加して、ノードを使用する理由とタイミング、およびノードの構成方法について説明します。

3 つの形式のヘルプはすべてオプションです。以下に説明されている 3 つのリソースのうちの 1 つまたはそれ以上を作成することができます。

  1. プロジェクト内に help.html ファイルを作成し、ノードが行うこととその使用方法について説明したオンライン・ヘルプを含めることができます。 複数のファイルがある場合は、プラグイン・プロジェクトに別個の doc サブディレクトリーを作成し、そこにオンライン・ヘルプ・ファイルを格納します。

    「ユーザー定義ノード」と呼ばれるリーフ・ノード (「参照」 > 「メッセージ・フロー」 にある) の下で、ノードのオンライン・ヘルプが、製品提供のインフォメーション・センターと統合されて表示されるようにすることができます。ノードのオンライン・ヘルプがこの部分に表示されるようにするには、以下のようにします。

    1. 次の拡張ポイントを、インフォメーション・センターに組み込むために、plugin.xml ファイルを変更します。
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. ユーザー定義ノード・プロジェクトに toc.xml ファイルを作成し、link_to 属性を変更して、インフォメーション・センターの資料の目次に既に定義されている「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>
      これで、ヘルプ・トピックが、「参照」 > 「メッセージ・フロー」 > 「ユーザー定義ノード」 の下の目次に表示されるようになります。

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

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

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

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

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

オプション機能であるノード・アイコンプロパティー・エディターまたはコンパイラーを追加できますし、ノードのテストを行うこともできます。

関連概念
ユーザー定義の入力ノード
ユーザー定義のメッセージ処理ノード
ユーザー定義の出力ノード
関連タスク
ユーザー定義拡張機能の開発
提供されているユーザー定義拡張機能のサンプルのインプリメント
ユーザー定義ノードのテスト
ユーザー定義ノードのワークベンチ・プロジェクトのパッケージ化
関連資料
ユーザー定義拡張機能
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
最終更新 : 2009-02-20 12:44:33

as04497_