プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発
12c (12.2.1.3.0)
E90225-01
  目次へ移動
目次
前
前 		 次
次		  

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

この章では、OHJヘルプ・システムをアプリケーションにデプロイする方法について説明します。また、OHJファイルに備えておく必要のあるファイルのリストと、JARファイルを作成する方法についても説明します。

この章の内容は次のとおりです。

15.1 サポートされているJava仮想マシン

OHJはJavaアプリケーション(またはアプレット)であるため、Java仮想マシン(JVM)で実行する必要があります。つまり、ユーザーの環境に適切なJVMがインストールされている必要があります。OHJがJavaアプリケーションのヘルプとして使用されている場合は、そのアプリケーションも仮想マシンで実行する必要があるため、通常、JVMはアプリケーションとともに配布されているはずです。

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

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

  • helpversion_num.jar

  • oracle_ice.jar

15.3 JARに含まれる圧縮ヘルプ・コンテンツのデプロイ

Javaベースのアプリケーションは、多くの場合、JAR形式で配布されます。HTMLコンテンツはJAR圧縮することでサイズが大幅に小さくなるため、ヘルプ・コンテンツをJARファイルとして含めることを検討してください。

15.3.1 JARファイルの作成

JARファイルを作成するには、Java Development Kitに付属のJARツールを使用します。この作業を、サード・パーティのOHJ対応ヘルプ・オーサリング・システムでもできることがあります。

ファイルの構成とそれらの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

15.3.2 使用するBookコンストラクタ

JARファイルからロードされるヘルプ・コンテンツを使用するBookオブジェクトを作成するには、ヘルプJARファイルと実装JARファイルがシステムのCLASSPATH上にあることが必要です。JARファイルを前述のように編成した場合は、ヘルプ・コンテンツの場所はCLASSPATH上の実装クラスの場所を基準にしてわかります。

そのため、Javaクラスとそのクラスの相対パスを受け付けるバージョンのHelpSetコンストラクタを使用します。

たとえば、JARファイルが2つある場合は、helpsetオブジェクトの構成に次のコードを使用します。

import com.yourCompany.yourProduct.SomeProduct; 
helpset myhelpset = new helpset(SomeProduct.class, "help/ProductHelp.hs");
  前
前 		 次
次
  目次へ移動
目次