InfoCenter

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

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

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

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

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

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

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

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-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.1.0.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.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:¥myApp¥eclipse

InfoCenter の使用

上の命令を使用して InfoCenter を開始します。 Web ブラウザーが、InfoCenter の開始時に指定されたポート (8081 など) で実行される「/help」Web アプリケーションを指すようにします。例えば、InfoCenter がインストールされているマシンの場合、これは http://localhost:8081/help/ になります。

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

InfoCenter を別のアプリケーションの一部として含む場合は、システム・コマンドの代わりに Java API 呼び出しを使用してこれを開始および停止した方が便利です。このような場合は、以下のステップを実行します。

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

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

Eclipse には完全な 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 モードで実行しているときに、フィルタリング・サポートがオフになると、フィルタリングされているコンテンツを含むすべてのコンテンツが表示されます。ドキュメンテーションをワークベンチ・モードと InfoCenter モードの両方でホストする場合は、フィルタリングをオフにしていても意味がある方法でフィルターを使用する必要があります。

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

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

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

ドキュメンテーション・プラグインには、他のプラグインと依存関係にあるものがあります。通常、バンドル・マニフェストで必須プラグインを指定することにより関係が成立します。依存プラグインは、同様に InfoCenter にインストールする必要があります。

InfoCenter プラグインは、InfoCenter を再起動することなく更新できます。それには、実行中の InfoCenter をコマンド行から更新するのトピックで説明されているコマンドを使用します。この機能を使用するには、プラグインの最小セットに org.eclipse.update.core プラグインが組み込まれている必要があります。

ヘルプ・システムのカスタマイズについて詳しくは、 製品のカスタマイズのトピックを参照してください。