Oracle Help for Java開発者ガイド Previous topic
前へ
Next topic
次へ

スタート・ガイド

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

Oracle JDeveloperには、OHJランタイム・ライブラリ(JDeveloper内のohelp4.jarというファイル)は含まれていますが、OHJDKの完全版は含まれていません。サンプル・コード、Helpset Authoring Wizard、インデックス作成機能およびデモを含むOracle Help for Javaの完全版は、Oracle Technology Network(otn.oracle.com)のOracle Help Technologiesから無償で入手できます。

ここでは、OHJDKの内容を説明し、OHJヘルプ・システムを開発するためのセットアップ方法を解説します。項目は、次のとおりです。

Oracle Help For Javaの概要

Oracle Help for Javaエンジンは、JavaアプリケーションおよびアプレットのためのJavaベースのヘルプ・システムです。OHJは、状況依存ヘルプ内の移動と表示を行うPure Javaのコンポーネントを提供します。Oracle Help for Javaは無償で利用でき、アプリケーションのヘルプ・システムとして再配布も可能です(リリースに同梱されているライセンスを参照してください)。

Oracle Help for Javaでは、Sun社のJavaHelpの拡張形式およびMicrosoft HTMLHelpの標準形式を含む、複数のファイル形式のヘルプのコンテンツがサポートされています。Oracle Help for Javaのヘルプのコンテンツ作成に関する詳細は、「Oracle Help for Javaのファイル形式」のドキュメントを参照してください。OHJをサポートしているサード・パーティ製のヘルプ・オーサリング・システムを使用する場合は、各システムのドキュメントを参照してください。

OHJDKリリースの内容

OHJDKには、OHJエンジン用のコンパイル済ライブラリに加えて、オーサリング・ツールおよびデモ用のライブラリが含まれます。これらのライブラリは、JAR(Java ARchive)形式で提供されています。OHJDKには、ドキュメントも用意されています。JARファイルについては、次の各項目で説明します。

OHJエンジン

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

OHJバイナリ
ファイル 内容
help-version_num.jar ヘルプ・エンジンの最適化済バイナリ。
jewt-opt-version_num.jar
またはewt-opt-version_num.jar
ヘルプ・エンジンの依存性を含むファイル。OHJ 4.1.xの場合はjewt-opt-version_num.jar、OHJ 3.2.xの場合はewt-opt-version_num.jarが提供されます。
oracle_ice-version_num.jar ICESoftのICEブラウザをオラクル社がカスタマイズしたバージョン。OHJエンジンでは、HTMLトピックの表示にICEブラウザを使用します。

オーサリング・ツール

次のJARファイルには、HelpSet Authoring Wizardおよび全文検索インデックス作成機能のための実装が含まれます。これらのファイルは、製品アプリケーションとともに配布する必要はありません。

ファイル 内容
help-wizard-version_num.jar HelpSet Authoring Wizardの実装。HelpSet Authoring Wizardは、OHJDKのインストール時にbinディレクトリに作成されるバッチ・ファイルを使用して実行します。
help-indexer-version_num.jar OHJの全文検索インデックス作成機能の実装。全文検索インデックス作成機能を使用して、OHJの全文検索インデックス・ファイル(.idx)を処理および作成します。インデックス作成機能は、HelpSet Authoring Wizardを介して、またはインストール・ディレクトリにあるREADME-Indexer.txtファイルに記された手順に従って手動で実行できます。
wizard-ewt-version_num.jar HelpSet Authoring Wizardの依存性を含むファイル。

デモ・ファイル

次のJARファイルには、OHJDKで提供されるデモ・プログラムが含まれます。このファイルは、製品アプリケーションとともに配布する必要はありません。

ファイル 内容
help-demo-version_num.jar デモのバイナリおよびソース・コードと、HTML形式およびOHJ制御ファイル形式でのサンプル・ドキュメント。

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

アプリケーションにOHJを統合する場合、デモ・プログラムのソース・コード(help-demo-version_num.jarファイル(前述)にあります)を調べることをお薦めします。特に、次の2つのデモが役に立ちます。

ファイル 内容
ChoiceDemo.java
(OHJ機能のデモ)
次の機能を示す、サンプルのJavaコード。
  • Helpオブジェクトの作成
  • ヘルプセット(データ)の追加
  • ナビゲータ・ウィンドウの表示
  • 複数のヘルプセットを表示するデモ
CSHDemo.java
(状況依存ヘルプのデモ)
次の機能を示す、サンプルのJavaコード。
  • メニューからのヘルプ・システムの起動
  • ヘルプ・トピックと、特定のアプリケーション・コントロールとの関連付け
  • [F1]キーによるヘルプの起動
  • 右クリックによるポップアップ・メニューのヘルプ

ドキュメント

OHJDKには、次のドキュメントが含まれます。

ドキュメント 内容 OHJDKリリースでの場所
OHJ APIリファレンス・ドキュメント OHJのApplication Program Interface(API)のリファレンス・ドキュメント。(OHJDKのクラスからJavadocとして生成されます。) OHJDKのdocのサブディレクトリ
Oracle Help for Javaのファイル形式 Oracle Help for Javaのヘルプセット、目次、索引および全文検索の制御ファイル形式を説明したドキュメント。
Oracle Help for Java開発者ガイド このドキュメント。

OHJDKによる開発のためのJava CLASSPATHの設定

OHJDKによる開発を行うためには、OHJエンジンのライブラリおよびツールキットの依存性(前述のJARファイル)を、使用環境のCLASSPATHに追加する必要があります。

CLASSPATH変数の設定方法の詳細は、使用しているJava Virtual Machineおよびオペレーティング・システムに対応するドキュメントを参照してください。


  Previous topic
前へ
Next topic
次へ