この章では、Oracle Help for Java Developer's Kit (OHJDK)の概要と、OHJDKの内容、およびOHJDKのインストール方法について説明します。
この章には次の項が含まれます:
Oracle Help for Java Developer's Kitは、Java環境でHTMLベースのヘルプ・コンテンツを開発および表示するための一連のJavaコンポーネントとJava APIです。JavaアプレットおよびJavaアプリケーションで状況依存ヘルプを実装するために必要なOracle Help for Java (OHJ)エンジンとその他のツールが含まれています。
Oracle Help for Javaエンジンは、JavaアプリケーションとJavaアプレット用の機能がすべて装備されたJavaベースのヘルプ・システムです。また、状況依存ヘルプを移動および表示するためのピュアJavaコンポーネントを備えています。Oracle Help for Javaは無料で入手でき、ご自身のアプリケーションのヘルプ・システムとして再配布できます(リリースで配布されるライセンスを参照)。
Oracle Help for Javaは、JavaHelpやMicrosoftのHTML Help標準の拡張形式など、いくつかのファイル形式のヘルプ・コンテンツをサポートします。ヘルプ・コンテンツの作成にヘルプ・オーサリング・ツールを使用しない場合は、「Oracle Helpのファイル形式」を参照することをお薦めします。サード・パーティのOHJ対応ヘルプ・オーサリング・システムを使用している場合は、そのドキュメントを参照してください。
Oracle Help for Javaランタイム・ライブラリohj.jar
は、JDeveloperの一部として配布されます。開発者がOracle Help for Javaと自身のアプリケーションを統合する場合、Oracle Help for Javaライブラリを依存性ライブラリとして追加するようにプロジェクト設定を変更できます。サンプル・コード、ヘルプセット・オーサリング・ウィザード、インデクサおよびデモを含むOracle Help for Javaリリース一式は、次のOracle Technology NetworkのOracle Helpページから無料で入手できます。
Oracle Help for Java Developer's Kit (OHJDK)は、Java環境でHTMLベースのヘルプ・コンテンツを開発および表示するための一連のJavaコンポーネントとJava APIです。この中には、JavaアプレットおよびJavaアプリケーションで状況依存ヘルプを実装するために必要なOracle Help for Java (OHJ)エンジンとその他のツールが含まれます。
この項では、OHJDKの内容と、OHJヘルプ・システムを開発するための設定方法について説明します。次のサブセクションが含まれます:
次の手順は、OHJDKのインストール・プロセスの説明です。
最新のOracle Help for Java Developer's KitをOTNからダウンロードします。Windowsの場合は、Windows実行可能ファイルまたは実行可能JARファイルをダウンロードします。SolarisまたはUNIXの場合は、バイナリ・ファイルをダウンロードします。
Windowsの場合は、Windows実行可能ファイルまたは実行可能JARファイルをダブルクリックして、インストール・ウィザードを起動します。デフォルトで、OHJDKはC:\Program Files\ohelp
にインストールされます。SolarisおよびUNIXの場合は、バイナリ・ファイルを実行して、インストール・ウィザードを起動します。
インストール・フォルダを開いて、第12.3.2項「OHJDKリリースの内容」で説明されているファイルを確認します。
OHJDKには、OHJエンジンのためのコンパイル済ライブラリと、オーサリング・ツールやデモンストレーションのためのライブラリが含まれています。これらのライブラリは、JAR (Java ARchive)形式で配布されます。OHJDKには、このページを含むドキュメントも含まれています。
各ファイルについては、次の項で説明しています。
これらのファイルには、OHJエンジンの実装とその依存性で使用されるバイナリ・ファイルが含まれています。これらのファイルは、製品アプリケーションとともに再配布する必要があります。
次のJARファイルには、ヘルプセット・オーサリング・ウィザードおよびテキスト検索インデクサの実装が含まれています。これらのファイルは、製品アプリケーションとともに再配布するためのものではありません。
次のJARファイルには、OHJDKとともに配布されるデモンストレーション・プログラムが含まれています。このファイルは、製品アプリケーションとともに再配布するためのものではありません。
表12-3 OHJのデモンストレーションJARファイル
ファイル | 内容 |
---|---|
|
デモンストレーションのバイナリとソース・コードおよびHTML形式とOracle Help制御ファイル形式のサンプル・ドキュメント。 |
デモンストレーション・プログラムを実行するには、OHJDKインストールのbin
ディレクトリにあるバッチ・ファイルを実行します。Windows用のOHJインストーラは、Windowsの「スタート」メニューにショートカットを追加します。デモ・プログラムが使用するサンプル・コンテンツは、demodoc
サブディレクトリにあります。
OHJをアプリケーションに統合する際は、(help
demo-version_num
.jar
ファイルに含まれている)デモンストレーション・プログラムのソース・コードの検討が役立ちます。次のデモは特に参考になります。
表12-4 OHJのデモンストレーション・ファイル
ファイル | 内容 |
---|---|
(OHJの機能のデモ) |
次の機能について説明するサンプルJavaコード。
|
(状況依存ヘルプのデモ) |
次の機能について説明するサンプルJavaコード。
|
OHJDKを使用して開発する場合は、OHJエンジン・ライブラリとツールキットの依存関係を環境のクラス・パスに追加する必要があります。
次に例を示します。
Windows 2000またはXPの場合は、「環境変数」ダイアログ・ボックスのCLASSPATHを設定します。このダイアログ・ボックスには、「コントロール パネル」の「システムのプロパティ」の「詳細設定」タブからアクセスします。
Windows NTの場合は、「コントロール パネル」の「システムのプロパティ」の「環境」タブでCLASSPATH変数を設定します。
Windows 95/98の場合は、autoexec.bat
ファイルでSET
コマンドを使用します。
UNIXの場合は、setenv
コマンドを使用してシェルの環境変数を設定します。
CLASSPATH変数の設定方法の詳細は、使用しているJava仮想マシン(JVM)およびオペレーティング・システムのドキュメントを参照してください。