ヘルプ・システムを InfoCenter としてインストール

InfoCenter と文書プラグインをサーバーにインストールすることによって、 ユーザーがインターネットやイントラネット経由でヘルプ・システムにアクセスできるようにできます。 クライアントは、URL にナビゲートすることによってヘルプを表示し、 ヘルプ・システムはクライアントの Web ブラウザーに表示されます。InfoCenter ヘルプ・システムはクライアント・アプリケーションと Web アプリケーションの両方で使用できますが、 リモートでヘルプにアクセスできるのはいずれかです。 infopop とアクティブ・ヘルプを除く、ヘルプ・システムのすべてのフィーチャーがサポートされています。

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

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

これらのステップはヘルプ・システム・インテグレーター用で、考えられるすべてのシナリオを指しているわけではありません。 ここでは、すべてのドキュメンテーションが Eclipse プラグインとして提供され、 あなたが Eclipse ヘルプ・システムを熟知していると想定します。

  1. Eclipse Platform Runtime Binary ドライバーを www.eclipse.org からダウンロードします。
  2. ドライバーをディレクトリー d:\myApp にインストール (unzip) します。これで、Eclipse プラットフォーム (ヘルプ・システムを含む) に必要なコードが入っている Eclipse サブディレクトリー d:\myApp\eclipse が作成されます。

コマンド行から InfoCenter を開始または停止する方法

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

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-host helpServerHost] [-port helpServerPort] [-servertimeout timeout] [-noexec] [platform options] [-vmargs JavaVMarguments]

ポート 8081 で InfoCenter を開始するには、次のコードを実行して start コマンドを発行します。

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

InfoCenter をシャットダウンするには、次のコードを実行して shutdown コマンドを発行します。

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

InfoCenter の使用

Web サーバーを始動します。 Web ブラウザーで、InfoCenter の開始時に指定されたポートで実行されるパス「ヘルプ」Web アプリケーションを指します。  InfoCenter がインストールされているマシンでは、これは http://localhost:8081/help/ になります。

Java から InfoCenterを 開始または停止する方法

InfoCenter を別のアプリケーションの一部として含む場合は、 システム・コマンドを使用しないで、Java API を使用してこれを開始および停止した方がはるかに便利です。 この場合は、次のステップを実行してください。

  1. d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar が app クラスパスにあることを確認してください。InfoCenter の開始とシャットダウンに使用するクラスは、 org.eclipse.help.standalone.Infocenter です。
  2. InfoCenter に渡すオプションを含むストリングの配列を作成します。 通常、eclipsehome およびポート・オプションが必要です。
    String[] options = new String[] {
    "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. アプリケーションで、オプションを渡すことによって、ヘルプ・クラスのインスタンスを作成します。
    Infocenter infocenter = new Help(options); 
  4. ヘルプ・システムを開始するには:
    helpSystem.start();
  5. InfoCenter をシャットダウンするには:

    helpSystem.shutdown(); 

InfoCenter を Web 上で使用可能にする

Eclipse には完全な InfoCenter が含まれていて、別のサーバー・ソフトウェアを実行する必要はありません。 しかし、インターネットのようなセキュリティーが不完全な環境では、 クライアントが InfoCenter に直接アクセスできるのではなく、 HTTP サーバーまたはアプリケーション・サーバーから利用できるようにすることをお薦めします。 ほとんどのサーバーには、特定の要求を他の Web リソースに委任するためのモジュール、 またはサーブレットがあります。たとえば、Apache HTTP Server のプロキシー・モジュールを構成して、 http://mycompany.com/myproduct/infocenter に対して行われた要求を、 InfoCenter を実行する http://internalserver:8081/help にリダイレクトすることができます。 以下の行:

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct http://internalserver:8081/help
ProxyPassReverse /myproduct http://internalserver:8081/help
を、mycompany Web サイトを実行する Apache サーバーの conf/httpd.conf ファイルに追加すると、この処理を行うことができます。

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

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

org.apache.lucene
org.apache.xerces
org.eclipse.core.boot
org.eclipse.core.resources
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.update.core

オペレーティング・システムまたはマシン・アーキテクチャーに応じて、上記のプラグインに加え、 それらに対応するフラグメント (存在する場合) のインストールも必要な場合があります。 たとえば Windows では、以下のフラグメント (eclipse\plugins ディレクトリーに存在) を追加する必要があります。

org.eclipse.core.resources.win32
org.eclipse.update.core.win32

Copyright IBM Corporation and others 2000, 2003.