| Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発 12c (12.2.1.1) E77341-01 |
|
 前 |
 次 |
この章では、Oracle Helpのテクノロジ(Oracle Help for JavaおよびOracle Help for the Web)を紹介します。また、Javaベースの環境アプリケーションとWebアプリケーションについて、HTMLベースのヘルプ・システムを開発および表示する場合の概要についても説明します。
この章の内容は次のとおりです。
Oracle Helpテクノロジは、Oracle Help for JavaとOracle Help for the Webの2つのカテゴリに分けられます。作成者は、Oracle Help for Java (OHJ)を使用するJava環境とOracle Help for the Webを使用するWeb環境の両方で、変更なしで表示可能な1つのヘルプ・システムを作成できます。または、Oracle Help for Javaのみを使用してJava環境用アプリケーションのヘルプを作成し、Oracle Help for the Webのみを使用してWeb環境用アプリケーションのヘルプを作成することもできます。Oracle Help for the Webには、Oracle Help for the WebとOracle Help for the Web-UIXの2つのバージョンがあります。
このガイドでは、説明内容がOracle Help for JavaとOracle Help for the Webの両方に該当する場合は、Oracle Helpと表記します。OHJは、説明内容がOracle Help for Javaにのみ該当する場合に使用します。OHWは、説明内容がOracle Help for the Webにのみ該当する場合に使用します。
Oracle Help for Javaは、HTMLに基づくヘルプ・コンテンツをJava環境で開発して表示するためのJavaコンポーネント、Java API、ファイル形式の仕様のセットです。OHJは、基本的にJavaアプリケーションでヘルプを表示するように設計されていますが、Java環境で使用するスタンドアロン・ドキュメント・ビューアとして実装することもできます。
Oracle Help for Java Developer's Kit (OHJDK)には、OHJテクノロジとともにJavaアプレットおよびアプリケーションの状況依存ヘルプを開発するためのツールとドキュメントが含まれています。次のものが必要となります。
Javaコンポーネント: OHJには、目次、索引、検索およびトピック・ウィンドウを持つ完全なヘルプ・システムを構成するデフォルトのJavaユーザー・インタフェース・コンポーネントが含まれます。
API: OHJ APIには、状況依存ヘルプの実装、ヘルプの表示方法(サイズ、位置など)の制御、およびヘルプ・システムのカスタマイズと拡張を行う機能が含まれます。たとえば、デフォルトのコンポーネントを独自のコンポーネントと置き換えたり、カスタム・コントロールを作成したり、選択したコンポーネントをアプリケーションに埋め込むことができます。
ドキュメント: ドキュメントには、この開発者ガイドおよびAPIリファレンス(JavaDocドキュメントとして提供されます)があります。
ヘルプセット・オーサリング・ウィザード: ヘルプセット・オーサリング・ウィザードを使用すると、サード・パーティのオーサリング・ツールを使用することなく、Oracle Help制御ファイルを作成できます。
OHJ機能の詳細は、第2章「Oracle Help for Javaユーザー・インタフェース」を参照してください。
Oracle Help for the Web(リッチ・インタフェースを備えているため、Oracle Help for the Web – Rich Client (OHW-RC)とも呼ばれる)は、Web環境でHTMLベースのヘルプ・コンテンツを配信します。これは、Java Server Faces (JSF)テクノロジに基づいたOracle Application Developer Framework (ADF)を使用して、オラクル社のBrowser Look And Feel Plus (BLAF+)動作とガイドラインに準拠したユーザー・インタフェースを構築します。
Oracle Help for the Webは、次のような様々な状況で使用できます。
リッチ・クライアント・アプリケーションに状況依存ヘルプを新しいブラウザ・ウィンドウで提供するヘルプ・システムとして
公開Webサイト上のヘルプ・コンテンツのスタンドアロン・ドキュメント・ビューアとして
ユーザーが一般的な検索エンジンで検索し、その結果が索引付けされたOracle Help for the Webコンテンツにリンクされている場合
ADF Facesコンポーネントの実行時実装で、このコンポーネントが定義するHelpProviderインタフェースを使用して埋込みヘルプ情報(定義テキスト、方法テキストまたはフル・ヘルプ)を取得する必要がある場合
Oracle Help for the Webに含まれる内容は、次のとおりです。
Oracle Help for the Webフロント・サーブレット: Webサーバーにインストールされます。これにより、Oracle Help for the Webは、状況依存ヘルプ・リクエストに対するURL構文をサポートできます。また、これを使用すると、単一のWebアプリケーションで複数のOracle Help for the Webヘルプセットをサポートする簡単な構成も可能になります。
Oracle Help for the Webサーブレット・フィルタ: JSFサーブレットに送信されるリクエストの前処理に使用されます。
ドキュメント: ドキュメントにはこの開発者ガイドも含まれます。
JDeveloperには、内部のJDeveloperヘルプ・システム自体に使用するものに加えて、Oracle Help for Javaランタイム・ライブラリが含まれているため、JDeveloperを使用してJavaアプリケーションを開発している場合は、Javaヘルプ・システム・テクノロジとしてOHJを簡単に組み込むことができます。詳細は、第12章「Oracle Help for Java Developer's Kitの概要」を参照してください。
JDeveloperには、Oracle Help for the Webは含まれていません。これを含む完全なOracle Help for Java開発キットは、Oracle Technology Network (OTN)で入手できます。
お客様とソフトウェア・コミュニティへのサービスの一環として、オラクル社ではOracle Helpのソフトウェアとサポートを無償で提供しています。Oracle Helpソフトウェアには、Oracle Help for JavaおよびOracle Help for the Webが含まれます。
Oracle Helpは無料で提供され、ご自身のアプリケーションのヘルプ・システムとして再配布できます。詳細は、このリリースのライセンス情報を参照してください。
ご質問は、Oracle Technology NetworkのOracle Help Technologies Forumに投稿してください。
