Oracle Help for Java開発者ガイド | ![]() 目次 |
![]() 前へ |
![]() 次へ |
次の各項では、OHJヘルプ・システムを製品とともにデプロイする方法を説明します。
OHJは、Javaアプリケーション(またはアプレット)であるため、実行にはJava Virtual Machine(JVM)が必要です。つまり、ユーザーが適切なJVMをインストールしていることを確認する必要があります。JavaアプリケーションのヘルプとしてOHJを使用する場合、そのアプリケーションもVMで実行する必要があるため、そのアプリケーションとともにJVMもすでに配布されていると考えられます。Oracle Help for Javaには、次のいずれかのJVMが必要です。
製品の一部として、次のJAR(Java ARchive)ファイルも再配布する必要があります。これらのファイルには、OHJエンジンの実装およびその依存性が含まれます。これらのファイルの詳細は、「OHJDKリリースの内容」を参照してください。
help-version_num.jar
ohj-jewt-version_num.jar
またはohj-ewt-version_num.jar
(OHJのリリースにより異なる)oracle_ice-version_num.jar
OHJ 4.1.xを使用する場合、インストールした製品はJava Foundation Class(Swing)にアクセスできる必要があります。JDK 1.1.8の場合に必要な、Swing 1.1.1はOHJ 4.1.xとともに配布されます。JDK 1.2およびJDK 1.3には、Swingクラスがすでに含まれているため、これらのバージョンを使用する場合にはライブラリの追加は不要です。
Javaベースのアプリケーションは、多くの場合JAR形式で配布されます。HTMLファイルは、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
またはヘルプセットでは、Javaクラスとそのクラスからの相対パスを使用できるタイプのコンストラクタを使用します(「ヘルプ・データの追加」を参照してください)。
例:
前述2つのJARファイルの例では、次のようにしてヘルプセット・オブジェクトを構築します。
import com.yourCompany.yourProduct.SomeProduct;
helpset myhelpset = new helpset(SomeProduct.class, "help/ProductHelp.hs");