Oracle Help for Java開発者ガイド | ![]() 目次 |
![]() 前へ |
![]() 次へ |
Oracle Help for Java Developer's Kit(OHJDK)は、Java環境でHTMLベースのヘルプのコンテンツを開発および表示するためのJavaコンポーネントとAPIのセットです。Oracle Help for Java(OHJ)エンジンと、Javaアプレットおよびアプリケーションに状況依存ヘルプを実装するために必要な追加のツールが含まれます。
ここでは、OHJDKの内容を説明し、OHJヘルプ・システムを開発するためのセットアップ方法を解説します。項目は、次のとおりです。
OHJDKには、OHJエンジン用のコンパイル済ライブラリに加えて、オーサリング・ツールおよびデモ用のライブラリが含まれます。これらのライブラリは、JAR(Java ARchive)形式で提供されています。OHJDKには、ドキュメントも用意されています(このドキュメントを含む)。JARファイルについては、次の各項目で説明します。
これらのファイルには、OHJエンジンの実装およびその依存性のためのバイナリ・ファイルが含まれます。製品アプリケーションとともに、これらのファイルも再配布する必要があります。
ファイル | 内容 |
---|---|
help-version_num.jar |
ヘルプ・エンジンの最適化済バイナリ。 |
oracle_ice-version_num.jar |
ICEsoft Technologies社によるICEブラウザを、オラクル社がカスタマイズしたバージョン。 OHJエンジンでは、HTMLトピックの表示にICEブラウザを使用します。 |
次のJARファイルには、ヘルプセット・オーサリング・ウィザードおよび検索インデックス作成機能のための実装が含まれます。これらのファイルは、製品アプリケーションとともに配布する必要はありません。
ファイル | 内容 |
---|---|
help-wizard-version_num.jar |
ヘルプセット・オーサリング・ウィザードの実装。ヘルプセット・オーサリング・ウィザードは、OHJDKのインストール時にbinディレクトリに作成されるバッチ・ファイルを使用して実行します。 |
help-indexer-version_num.jar |
OHJの検索インデックス作成機能の実装。検索インデックス作成機能を使用して、Oracle Helpの検索インデックス・ファイル(.idx)を処理および作成します。 |
次のJARファイルには、OHJDKで提供されるデモ・プログラムが含まれます。このファイルは、製品アプリケーションとともに配布する必要はありません。
ファイル | 内容 |
---|---|
help-demo-version_num.jar |
デモのバイナリおよびソース・コードと、HTML形式およびOracle Helpの制御ファイル形式でのサンプル・ドキュメント。 |
デモ・プログラムを実行するには、OHJDKのbin
のサブディレクトリにあるバッチ・ファイルを実行します。(Windows版OHJのインストーラは、Windowsの「スタート」メニューにショートカットを追加します。)デモ・プログラムで使用されるサンプルのコンテンツは、demodoc
のサブディレクトリにあります。
アプリケーションにOHJを統合する場合、デモ・プログラムのソース・コード(help-demo-version_num.jar
ファイル(前述)にあります)を調べることをお薦めします。特に、次の2つのデモが役に立ちます。
ファイル | 内容 |
---|---|
ChoiceDemo.java (OHJ機能のデモ) |
次の機能を示す、サンプルのJavaコード。
|
CSHDemo.java (状況依存ヘルプのデモ) |
次の機能を示す、サンプルのJavaコード。
|
OHJDKには、次のドキュメントが含まれます。
ドキュメント | 内容 | OHJDKリリースでの場所 |
---|---|---|
OHJ APIリファレンス・ドキュメント | JavaDocで提供される、OHJのApplication Program Interface(API)のリファレンス・ドキュメント。 | OHJDKのdoc/javadoc のサブディレクトリ。このAPIのドキュメントを表示するには、HTMLブラウザでindex.htmlファイルを開きます。 |
Oracle Helpガイド | このドキュメント。 | OHJDKのdoc のサブディレクトリ。 |
OHJDKによる開発を行うためには、OHJエンジンのライブラリおよびツールキットの依存性(前述のJARファイル)を、使用環境のCLASSPATHに追加する必要があります。次に例を示します。
SET
コマンドを使用します。setenv
コマンドを使用して、シェルの環境変数を設定します。CLASSPATH変数の設定方法の詳細は、使用しているJava Virtual Machine(JVM)およびオペレーティング・システムに対応するドキュメントを参照してください。
Copyright © 1996, 2004, Oracle. All rights reserved.