プラグイン オンライン ヘルプの定義

プラグイン オンライン ヘルプを定義する手順は、次のとおりです。

1. プラグイン オンライン ヘルプ（JavaHelp または HTML）ファイルを定義します。

   例として、SAMPLES_HOME/integration/samples/bpm_api/htmlhelp/Sample ディレクトリにある HTML ファイルを参照してください。

2. HelpSetInfo オブジェクトに定義されているコンストラクタを使用して、com.bea.wlpi.common.plugin.HelpSetInfo 値オブジェクトを定義します。

   helpType コンストラクタ パラメータを使用して、JavaHelp ヘルプ セットまたは HTML ヘルプ セットのどちらを定義するか指定し、どちらのヘルプ セットを定義するかに基づいて、helpNames コンストラクタ パラメータを使用して、それぞれ次の情報を渡す必要があります。

   • JavaHelp ヘルプ セット（.hs）ファイル名と JavaHelp ヘルプ キー

   • メイン インデックス ページまたは目次の HTML ヘルプ ファイル ルート ディレクトリと HTML ファイル名

   詳細については、HelpSetInfo オブジェクトを参照してください。

3. PluginInfo オブジェクトに定義されているコンストラクタを使用して、com.bea.wlpi.common.plugin.PluginInfo 値オブジェクトを定義します。helpSet コンストラクタ パラメータ値として、前の手順で定義した HelpSetInfo 値オブジェクトの名前を渡す必要があります。

プラグイン サンプルから抜粋した次のコード リストは、プラグイン HTML オンライン ヘルプを定義する方法を示しています。このコードでは、createPluginInfo() メソッドを定義します。このメソッドは、まず HelpSetInfo 値オブジェクトを定義してから、この HelpSetInfo オブジェクトを渡して PluginInfo オブジェクトを定義します。この抜粋は、SAMPLES_HOME/integration/samples/bpm_api/plugin/src/com/bea/wlpi/tour/po/plugin ディレクトリの SamplePluginBean.java ファイルから取り出したものです。重要なコード行は、太字で示します。

コード リスト 8-1 プラグイン HTML オンライン ヘルプの定義

private PluginInfo createPluginInfo(Locale lc) {
   HelpSetInfo helpSet;
   PluginInfo pi;
   SampleBundle bundle = new SampleBundle(lc);
   String name = bundle.getString("pluginName");
   String desc = bundle.getString("pluginDesc");
   String helpName = bundle.getString("helpName");
   String helpDesc = bundle.getString("helpDesc");
   helpSet = new HelpSetInfo(
         SamplePluginConstants.PLUGIN_NAME, helpName, helpDesc,
         new String[]{ "htmlhelp/Sample", "index" },
         HelpSetInfo.HELP_HTML);
   pi = new PluginInfo(SamplePluginConstants.PLUGIN_NAME, name,
      desc, lc, SamplePluginConstants.VENDOR_NAME,
      SamplePluginConstants.VENDOR_URL,
      SamplePluginConstants.PLUGIN_VERSION,
      SamplePluginConstants.PLUGIN_FRAMEWORK_VERSION,
      null, null, helpSet);
   return pi;
}

この例について説明します。

• HTML ファイルは、他のサポート ファイルとともに、WAR ファイル（たとえば sampleplugin.war）にパッケージ化する必要があります。WAR ファイルは、com.bea.wlpi.SamplePlugin という Name 属性値を持つ WebAppComponent としてデプロイする必要があります。その他のデプロイメント事項については、コンフィグレーション ファイルの更新を参照してください。

• プラグイン フレームワークは、pluginName の値に関連する htmlhelp/Sample パスを使用して、ヘルプ セットの URL を作成します。例 : http://localhost:7001/com.bea.wlpi.SamplePlugin/htmlhelp/Sample/index.htm

• デフォルト ヘルプ ページは、index.htm です。

次の図に、サンプル プラグイン HTML ヘルプ セットにアクセスできる WebLogic Integration Studio の [ヘルプ] メニューを示します。

図8-1 プラグイン ヘルプ セット

 

次のコード リストは、プラグイン JavaHelp ヘルプ セットのための HelpSetInfo 値オブジェクトを定義する方法を示しています。

コード リスト 8-2 プラグイン JavaHelp オンライン ヘルプの定義

javaHelpSet = new HelpSetInfo(SamplePluginConstants.PLUGIN_NAME,
        "Sample Plugin JavaHelp", "Plugin-provided help set",
        new String[] {"javahelp/HolidayHistory", "hol_intro"},
        HelpSetInfo.HELP_JAVA_HELP);

この例について説明します。

• このプラグイン フレームワークは、pluginName の値に関連する javahelp/HolidayHistory パスを使用して、このプラグインにより提供されるヘルプ セットの URL を作成します。
  例 : http://localhost:7001/com.bea.wlpi.SamplePlugin/javahelp/HolidayHistory.hs

• デフォルト ヘルプ トピックは、hol_intro です。

プラグイン オンライン ヘルプのデプロイメントの詳細については、プラグインのデプロイメントを参照してください。