ヘルプ・システムを 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] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

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

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.0.1\helpbase.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.base_3.0.1\helpbase.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.base_3.0.1\helpbase.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/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help
を、mycompany Web サイトを実行する Apache サーバーの conf/httpd.conf ファイルに追加すると、この処理を行うことができます。

Apache HTTP Server の一部のバージョンには、構成ファイルで使用可能な AddDefaultCharset ディレクティブが含まれています。 ディレクティブを除去するか、または

AddDefaultCharset Off
に置き換えて、ブラウザー表示文書に正しい文字セットが使用されるようにします。

InfoCenter の複数インスタンスの実行

InfoCenter の複数インスタンスは、1 回のインストールによりマシンで実行されます。 各開始済みインスタンスは、独自のポートを使用し、ワークスペースと共に提供される必要があります。このため、-port および -data オプションを指定する必要があります。 このインスタンスは、-configuration オプションを使用して有効なプラットフォーム構成を提供し、さまざまなプラグインのセットから文書を提供します。

-configuration が使用されず、構成ディレクトリーが複数の InfoCenter インスタンスで共有され、ロケールの設定が重複している場合は、1 つの InfoCenter インスタンスによってすべての検索索引が作成されてから、他のインスタンスが開始されるようにしなければなりません。 インデックスは構成ディレクトリーに保管され、書き込みアクセスは InfoCenter プロセス間で同期していません。

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

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

org.apache.ant
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

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

特記事項