WebSphere Message Broker バージョン 8.0.0.5 オペレーティング・システム: AIX、HP-Itanium、Linux、Solaris、Windows、z/OS

製品の最新バージョンについては、IBM Integration Bus バージョン 9.0 をご覧ください。

ノードへのヘルプの追加

作成したノードに 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>
      「参照」 > 「メッセージ・フローの開発」 > 「ユーザー定義拡張機能」 > 「ユーザー定義ノード」の下の目次ビューにヘルプ・トピックが表示されるようになります。

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

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

  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, 2014Copyright IBM Corporation 1999, 2014.

        
        最終更新:
        
        最終更新: 2015-02-28 17:48:01


タスク・トピックタスク・トピック | バージョン 8.0.0.5 | as04497_