スタンドアロン・ヘルプ・システムのインストール

Eclipse フレームワークに基づいていないアプリケーションを作成している場合でも、Eclipse ヘルプ・システムを使用することができます。 ご使用のアプリケーションは、スタンドアロン・ヘルプ・システム (取り除かれたヘルプ・システム以外のすべてが入っている非常に小さいバージョンの Eclipse) をパッケージし、インストールできます。 これで、アプリケーションはそのヘルプ・メニューまたは UI オブジェクトから API 呼び出しを行い、ヘルプ・ブラウザーを起動できるようになります。 スタンドアロン・ヘルプ・システムには、infopop とアクティブ・ヘルプを除いて、統合ヘルプ・システムのすべてのフィーチャーがあります。 アプリケーションが Java ベースではない場合、またはアプリケーションが実行されていないときにヘルプが必要な場合は、 システム・シェル、シェル・スクリプト、またはデスクトップ・ショートカットからスタンドアロン・ヘルプを使用して、 Java API を呼び出す代わりにコマンド行オプションを指定することができます。

スタンドアロン・ヘルプ・システムを使用すると、ヘルプ・システムの様々な面をカスタマイズするために使用可能なオプションの数を渡すことができます。 次のオプションがサポートされています。

インストール/パッケージ

これらのステップはヘルプ・システム・インテグレーター用で、考えられるすべてのシナリオを指しているわけではありません。 ここでは、すべてのドキュメンテーションが Eclipse プラグインとして提供され、 あなたが Eclipse ヘルプ・システムを熟知していると想定します。
  1. Eclipse Platform Runtime Binary ドライバーを www.eclipse.org からダウンロードします。
  2. ドライバーをアプリケーション・ディレクトリー (例えば d:¥myApp) にインストール (解凍) します。 これで、Eclipse プラットフォーム (ヘルプ・システムを含む) に必要なコードが入っている Eclipse サブディレクトリー d:¥myApp¥eclipse が作成されます。

Java からヘルプ・クラスを呼び出す方法

  1. d:¥myApp¥eclipse¥plugins¥org.eclipse.help.base_3.1.0.jar が app クラスパスにあることを確認してください。ヘルプ・システムを開始、起動、およびシャットダウンするために使用するクラスは org.eclipse.help.standalone.Help です。
  2. ヘルプ・システム・サポートに渡すオプションを含むストリングの配列を作成します。 通常、eclipsehome オプションが必要です。
    String[] options = new String[] { "-eclipsehome", "d:¥¥myApp¥¥eclipse" }; 
  3. アプリケーションで、オプションを渡すことによって、ヘルプ・クラスのインスタンスを作成します。 このオブジェクトは、アプリケーションの終了まで保持される必要があります。
    Help helpSystem = new Help(options); 
  4. ヘルプ・システムを開始するには:
    helpSystem.start(); 
  5. 必要なときにヘルプを起動するには:
    helpSystem.displayHelp(); 

    また、特定の 1 次 TOC ファイルやトピックについてのヘルプを呼び出すこともできます。

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. コンテキスト依存ヘルプを起動するには、helpSystem.displayContext(contextId, x, y) を呼び出します。 ここで、contextId は完全修飾のコンテキスト ID です。 画面座標、x および y は現在使用されていません。
  7. アプリケーションの終了時にヘルプ・システムをシャットダウンするには:

    helpSystem.shutdown(); 

コマンド行からヘルプを呼び出す方法

org.eclipse.help.standalone.Help クラスには、 コマンド行からスタンドアロン・ヘルプを起動するために使用できるメイン・メソッドがあります。 コマンド行引数の構文は次のとおりです。

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

ヘルプを表示する簡単な方法は、

java -classpath d:¥myApp¥eclipse¥plugins¥org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

を d:¥myApp¥eclipse ディレクトリー内から呼び出すというものです。 特定の TOC ファイルまたはトピックを表示するには、次のファイルを使用します。

java -classpath d:¥myApp¥eclipse¥plugins¥org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

ヘルプを表示するための上記の呼び出しによって、ヘルプ・システムが開始し、ヘルプが表示されて、 コマンドの実行後もユーザーが引き続きヘルプをブラウズできるようにするために続けて実行されます。 ヘルプ・システムのライフ・サイクルを制御するには、displayHelp コマンドだけでなく、 start および shutdown コマンドを使用します。 たとえば、次のものを呼び出すことができます。

java -classpath d:¥myApp¥eclipse¥plugins¥org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[オプション] プラグインの最小セットのインストール

スタンドアロン・ヘルプは完全な Eclipse プラットフォーム・パッケージを必要としません。 以下のプラグイン (eclipse¥plugins ディレクトリーに存在) で、スタンドアロン・ヘルプを実行できます。 

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Windows および Linux では、堅固なブラウザー・サポートを提供するために、最小構成の一番上に以下のプラグインとフラグメントが必要となります (SWT が組み込まれた Windows の Internet Explorer および Linux の Mozilla、または Windows のスタンドアロン・システム・ブラウザー)。

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 or org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

ドキュメンテーション・プラグインには、他のプラグインと依存関係にあるものがあります。 通常、plugin.xml で必須プラグインを指定することにより関係が成立します。 依存プラグインは、同様に InfoCenter にインストールする必要があります。 また、Eclipse 3.0 より前のバージョン用に設計されたプラグインでは、 暗黙的に org.eclipse.core.runtime.compatibility を現在機能するプラグインにする必要があります。

ヘルプ・システムのカスタマイズについての詳細は、『ヘルプ・システム設定』を参照してください。

org.eclipse.help.base preferences