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

12 Oracle Help for Java Developer's Kitの概要

この章では、Oracle Help for Java Developer's Kit (OHJDK)の概要と、OHJDKの内容、およびOHJDKのインストール方法について説明します。

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

12.1 Oracle Help for Java Developer's Kitについて

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対応ヘルプ・オーサリング・システムを使用している場合は、そのドキュメントを参照してください。

12.2 JDeveloperのOracle Help for Javaランタイム

Oracle Help for Javaランタイム・ライブラリohj.jarは、JDeveloperの一部として配布されます。開発者がOracle Help for Javaと自身のアプリケーションを統合する場合、Oracle Help for Javaライブラリを依存性ライブラリとして追加するようにプロジェクト設定を変更できます。サンプル・コード、ヘルプセット・オーサリング・ウィザード、インデクサおよびデモを含むOracle Help for Javaリリース一式は、次のOracle Technology NetworkのOracle Helpページから無料で入手できます。

http://www.oracle.com/technetwork/topics/index-083946.html

12.3 OHJDKを使用する前に

Oracle Help for Java Developer's Kit (OHJDK)は、Java環境でHTMLベースのヘルプ・コンテンツを開発および表示するための一連のJavaコンポーネントとJava APIです。この中には、JavaアプレットおよびJavaアプリケーションで状況依存ヘルプを実装するために必要なOracle Help for Java (OHJ)エンジンとその他のツールが含まれます。

この項では、OHJDKの内容と、OHJヘルプ・システムを開発するための設定方法について説明します。この項の内容は次のとおりです。

12.3.1 OHJDKのインストール

次の手順は、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リリースの内容」で説明されているファイルを確認します。

12.3.2 OHJDKリリースの内容

OHJDKには、OHJエンジンのためのコンパイル済ライブラリと、オーサリング・ツールやデモンストレーションのためのライブラリが含まれています。これらのライブラリは、JAR (Java ARchive)形式で配布されます。OHJDKには、このページを含むドキュメントも含まれています。

各ファイルについては、次の項で説明しています。

12.3.2.1 OHJエンジン

これらのファイルには、OHJエンジンの実装とその依存性で使用されるバイナリ・ファイルが含まれています。これらのファイルは、製品アプリケーションとともに再配布する必要があります。

表12-1 OHJのバイナリ

ファイル 目次

ohj.jar

ヘルプ・エンジンの最適化済バイナリ。

oracle_ice.jar

ICEsoft Technologies, Inc.のICEbrowserをOracleがカスタマイズしたバージョン。OHJエンジンは、HTMLトピックの表示にICEbrowserを使用します。

12.3.2.2 オーサリング・ツール

次のJARファイルには、ヘルプセット・オーサリング・ウィザードおよびテキスト検索インデクサの実装が含まれています。これらのファイルは、製品アプリケーションとともに再配布するためのものではありません。

表12-2 OHJのオーサリング・ツール

ファイル 目次

help-wizard.jar

ヘルプセット・オーサリング・ウィザードの実装。ヘルプセット・オーサリング・ウィザードの実行には、OHJDKインストールのbinディレクトリに作成されるバッチ・ファイルを使用できます。

help-indexer.jar

OHJテキスト検索インデクサの実装。この全文検索インデクサを使用してOracle Helpの検索索引(.idx)ファイルを作成できます。

12.3.2.3 デモンストレーション・ファイル

次のJARファイルには、OHJDKとともに配布されるデモンストレーション・プログラムが含まれています。このファイルは、製品アプリケーションとともに再配布するためのものではありません。

表12-3 OHJのデモンストレーションJARファイル

ファイル 目次

help-demo.jar

デモンストレーションのバイナリとソース・コードおよびHTML形式とOracle Help制御ファイル形式のサンプル・ドキュメント。

デモンストレーション・プログラムを実行するには、OHJDKインストールのbinディレクトリにあるバッチ・ファイルを実行します。Windows用のOHJインストーラは、Windowsの「スタート」メニューにショートカットを追加します。デモ・プログラムが使用するサンプル・コンテンツは、demodocサブディレクトリにあります。

OHJをアプリケーションに統合する際は、(helpdemo-version_num.jarファイルに含まれている)デモンストレーション・プログラムのソース・コードの検討が役立ちます。次のデモは特に参考になります。

表12-4 OHJのデモンストレーション・ファイル

ファイル 目次

ChoiceDemo.java

(OHJの機能のデモ)

次の機能について説明するサンプルJavaコード。

  • Helpオブジェクトの構成

  • ヘルプセット(データ)の追加

  • OHJのナビゲータ・ウィンドウの表示

  • 複数のヘルプセットの表示

CSHDemo.java

(状況依存ヘルプのデモ)

次の機能について説明するサンプルJavaコード。

  • メニューからのヘルプ・システムの起動

  • 特定のアプリケーション・コントロールへのヘルプ・トピックの関連付け

  • [F1]キーによるヘルプ起動の有効化

  • 右クリックで表示されるポップアップ・メニュー・ヘルプの実装

12.3.2.4 ドキュメント

OHJDKには次のドキュメントが用意されています。

表12-5 OHJのドキュメント

ドキュメント 内容 OHJDKリリースでの場所

OHJ APIリファレンス・ドキュメント

OHJのApplication Program Interface (API)のドキュメントがJavaDocとして用意されています。

OHJDKインストールのdoc/javadocサブディレクトリ。APIドキュメントを表示するには、HTMLブラウザでindex.htmlファイルを開きます。

Oracle Helpガイド

このドキュメント

OHJDKインストールのdocサブディレクトリ。

12.3.3 OHJDK開発のためのJava CLASSPATHの設定

OHJDKを使用して開発する場合は、OHJエンジン・ライブラリとツールキットの依存関係を環境のクラス・パスに追加する必要があります。

次に例を示します。

  • Windows 2000またはXPの場合は、「環境変数」ダイアログ・ボックスのCLASSPATHを設定します。このダイアログ・ボックスには、「コントロール パネル」の「システムのプロパティ」の「詳細設定」タブからアクセスします。

  • Windows NTの場合は、「コントロール パネル」の「システムのプロパティ」の「環境」タブでCLASSPATH変数を設定します。

  • Windows 95/98の場合は、autoexec.batファイルでSETコマンドを使用します。

  • UNIXの場合は、setenvコマンドを使用してシェルの環境変数を設定します。

CLASSPATH変数の設定方法の詳細は、使用しているJava仮想マシン(JVM)およびオペレーティング・システムのドキュメントを参照してください。

  前
前 		 次
次
  目次へ移動
目次