ナビゲーション・ヘッダーをスキップ
Oracle Help for Java開発者ガイド Table of Contents
目次
Previous topic
前へ
Next topic
次へ

OHJヘルプ・システムのデプロイ

次の各項では、OHJヘルプ・システムを製品とともにデプロイする方法を説明します。

サポートされているJava Virtual Machine

OHJは、Javaアプリケーション(またはアプレット)であるため、実行にはJava Virtual Machine(JVM)が必要です。つまり、ユーザーが適切なJVMをインストールしていることを確認する必要があります。JavaアプリケーションのヘルプとしてOHJを使用する場合、そのアプリケーションもVMで実行する必要があるため、そのアプリケーションとともにJVMもすでに配布されていると考えられます。 Oracle Help for Javaでは、 Sun社のJDK 1.3以上が必要です。

同梱する必要のあるOHJ JARファイル

製品の一部として、次のJAR(Java ARchive)ファイルも再配布する必要があります。これらのファイルには、OHJエンジンの実装およびその依存性が含まれます。 これらのファイルの詳細は、「OHJDKリリースの内容」を参照してください。

JAR形式で圧縮したヘルプのコンテンツのデプロイ

Javaベースのアプリケーションは、多くの場合JAR形式で配布されます。HTMLファイルは、JAR形式への圧縮によりサイズをかなり縮小できるため、ヘルプのコンテンツはJARファイルで配布に含めることをお薦めします。

JARファイルの作成

JARファイルを作成するには、Java Development Kitに同梱されているJARツールを使用します。OHJをサポートしているサード・パーティ製のヘルプ・オーサリング・システムを使用する場合は、そのシステムでもJARファイルを作成できます。

JARアーカイブ内では、ファイルの構成と、ファイルに割り当てるパスに特に注意してください。ヘルプJARファイル内のディレクトリ構造は、アプリケーションの実装JARファイルのディレクトリ構造と一致している必要があります。ヘルプのコンテンツは、参照ポイントとして使用する実装クラスの下に置く必要があります。

例:

アプリケーションの実装JARに、次のようなディレクトリ構造を持つクラスが含まれているとします。


/com/yourCompany/yourProduct/SomeProduct.class
/com/yourCompany/yourProduct/SomeClass.class

この場合、ヘルプJARには、共有ディレクトリ構造でヘルプのコンテンツがアプリケーションの実装クラスの下に置かれるように、一致したパスが含まれている必要があります。


/com/yourCompany/yourProduct/help/ProductHelp.hs
/com/yourCompany/yourProduct/help/TableOfContents.xml
/com/yourCompany/yourProduct/help/SomeHelpTopic.html

使用するBookコンストラクタの選択

JARファイルからロードされるヘルプのコンテンツを使用してBookオブジェクトを作成するには、ヘルプJARファイルと実装JARファイルが、システムのCLASSPATHに含まれている必要があります。JARファイルを前述のように構成してある場合、CLASSPATH上の実装クラスの位置に対する、ヘルプ・コンテンツの相対的な位置が判断できます。

したがって、HelpBookまたはHelpSetでは、Javaクラスおよびそのクラスからの相対パスを使用できるタイプのコンストラクタを使用します(「ヘルプ・データの追加」を参照してください)。

例:

前述2つのJARファイルの例では、次のようにしてヘルプセット・オブジェクトを構築します。

import com.yourCompany.yourProduct.SomeProduct;
helpset myhelpset = new helpset(SomeProduct.class, "help/ProductHelp.hs");