Oracle Help for the Web開発者ガイド | ![]() 目次 |
![]() 前へ |
![]() 次へ |
Oracle Help for the Web(OHW)はJavaサーブレットであるため、サーブレット・エンジンを必要とします。OHWがWebアプリケーションのヘルプ・システムとして使用される場合、OHWはアプリケーションと同じサーブレット・エンジンを使用できます。
このページでは、次の項目について説明します。
OHWにはJavaサーブレットAPIのバージョン2.0以上をサポートするサーブレット・エンジンが必要です。たとえば、次のサーブレット・エンジンの最近のリリースがあげられます。
サーブレットAPIはSun社によって定義されています。サーブレットAPIの詳細は、Sun社のサイトのJava Servlet Technology(http://java.sun.com/products/servlet/
)を参照してください。
何も必要ありません。クライアントはHTMLのみを受信するので、必要なのはOHWのヘルプ・コンテンツを表示し閲覧するためのWebブラウザのみです。WebブラウザはJavaScriptのサポートを有効にしておく必要があります。
一般的に、ヘルプの作成者が各自選択したオーサリング・ツールを使用してヘルプのコンテンツを作成します。ヘルプの作成者は、ヘルプのコンテンツをOHWヘルプ・システムとしてデプロイするために必要なOracle Helpの制御ファイルも作成します。制御ファイルの詳細は、「Oracle Helpのファイル形式」を参照してください。
OHW管理者は、サーブレット・エンジンおよびOHWをサーバーに設定します。基本的なOHW管理タスクは次のとおりです。
サーブレット・エンジンは、OHWをサポートするためにインストールおよび構成する必要があります。この処理はサーブレット・エンジンによって異なるため、詳細は使用するサーブレット・エンジンのドキュメントを参照してください。
「デモ・バンドルを使用したOC4JでのOHWのデプロイ」、「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」および「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」も参照してください。
OHWサーブレット(Javaクラス・ファイル、XML構成ファイルおよびその他のファイルを含む)を構成する様々なファイルは、サーバーの、サーブレット・エンジンにとって適切な場所にインストールする必要があります。この処理はサーブレット・エンジンによって異なるため、詳細は使用するサーブレット・エンジンのドキュメントを参照してください。
「デモ・バンドルを使用したOC4JでのOHWのデプロイ」、「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」および「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」も参照してください。
サーブレット・エンジンによっては、OHWをデプロイするために通常1から4つのXML構成ファイルを変更する場合があります。
OC4Jでは、次のファイルを変更する必要があります。
Tomcatでは、Webモジュールを構成するためにweb.xmlファイルを変更する必要があります。
XML構成ファイルの詳細は次のとおりです。
server.xml: このファイルは、すべてのOC4Jアプリケーションを定義します。OHWのデプロイには、OHWアプリケーション(必須)およびUIXアプリケーション(推奨/オプション)の、2つのJ2EEアプリケーションが通常必要です。このファイルは、Webモジュールで使用される*-web-site.xmlファイルも定義します。OC4Jインスタンスの実行用には、1つのserver.xmlしかありません。
http-web-site.xml: このファイルは、URLをWebモジュールにマップし、OC4Jが使用するポート番号を宣言します。このポート番号に割り当てられたURLは、Webモジュールに対して適切なWebサイトにルーティングされます。オラクル社は、Webモジュールの定義が多数含まれている、http-web-site.xmlという名前の1つの*-web-site.xmlファイルの使用をお薦めします。http-web-site.xmlの場所はserver.xmlにより決定され、通常はserver.xmlと同じディレクトリに格納されます。http-web-site.xmlファイルは、Webモジュール(製品のヘルプセット)が追加または再構成された場合、通常変更されます。
application.xml: このファイルは、指定されたJ2EEアプリケーションで実行されるすべてのWebモジュールのマニフェストです。これは、デプロイされた各製品の各Webモジュールを指定します。オラクル社は、(1)比較的安定した、UIXアプリケーション用(オプション)および(2)Webモジュールが追加および再構成された場合に通常変更される、OHWアプリケーション用の、application.xmlの2つのインスタンスの使用をお薦めします。application.xmlファイルの名前および場所は、J2EE標準によって決定されます。
web.xml: このファイルは、OHW構成ファイルの場所を含む、サーブレットの初期パラメータを設定します。各Webモジュールには、1つのインスタンスしかありません。OHW構成ファイルが統一した方法で格納され名前が付けられた場合、このファイルはすべてのOHWのWebモジュールで同じになります。
OHW自体を構成するには、1つのOHW構成ファイル(デフォルトのファイル名はohwconfig.xml)のみが必要です。たとえば、デプロイするヘルプセットおよびその表示方法を指定する必要があります。ロケール、ブランド情報およびその他各種の設定も指定できます。この構成ファイルの詳細は、「OHW構成ファイル」を参照してください。このファイルの名前と場所は、サーブレットの初期パラメータとして設定され、この処理はサーブレット・エンジンごとに異なります。詳細は、使用するサーブレット・エンジンのドキュメントを参照してください。
「デモ・バンドルを使用したOC4JでのOHWのデプロイ」、「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」および「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」も参照してください。
サーブレット・エンジンは、Webを介してユーザーが使用できるように起動する必要があります。この処理はサーブレット・エンジンによって異なるため、詳細は使用するサーブレット・エンジンのドキュメントを参照してください。
OHWインストールのヘルプセットを変更する場合、ユーザーが変更箇所を確認できるように、サーブレット・エンジンを再起動する必要があります。
「デモ・バンドルを使用したOC4JでのOHWのデプロイ」、「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」および「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」も参照してください。
OHWおよびUIXの新しいリリースがリリースされた場合、使用しているOHW/OC4JまたはOHW/Tomcatのインストールをアップグレードする前に、OHWおよびUIXのダウンロード・ページを必ずチェックして、最新リリースおよびインストール方法をダウンロードしてください。
OHWを新しいリリースにアップグレードするには、OHWおよびUIXのJARファイル、およびOHWのJavaScriptファイル(ohw-install.zipとして配布)を置き換える必要があります。
UIXを新しいリリースにアップグレードするには、インストール可能なUIXリソース・ファイル(uix2-install.zipとして配布)を置き換える必要があります。
「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」および「デプロイ・バンドルを使用したTomcatでのOHWのデプロイ」も参照してください。
Copyright © 1996, 2004, Oracle. All rights reserved.