Oracle Help for the Web開発者ガイド | ![]() 目次 |
![]() 前へ |
![]() 次へ |
Oracle Technology Network(OTN)からダウンロード可能なOracle Help for the Web(OHW)リリース・ファイルの1つには、Javaサーブレット・エンジンであるOracle9iAS Containers for J2EE(OC4J)にインストールされた構成済のOHWが含まれています。OC4JはJava 2 Enterprise Edition(J2EE)の開発環境で、Javaサーブレット2.2および2.3仕様をサポートするサーブレット・エンジンが含まれています。
OHWデモ・バンドルには、デモを表示しリリースを試用する必要があるすべてのデバッグ・クラス・ライブラリが含まれています。これには、OC4Jサーブレット・エンジンとOHWサーブレットの起動および停止に使用される、構成済のオラクル社のOC4J 9.0.xサーブレット・エンジン、バッチ付きヘルプセットおよびスクリプト・ファイルが含まれています。このリリースを、変更を加えずにインストールおよび実行したり、OHWの動作を確認したり、サンプル・ヘルプセットを開発中のものと置き換えたりできます。
このページでは、次の項目について説明します。
最新情報は、OHWのダウンロード・ページで入手可能なダウンロードおよびインストール方法をチェックしてください。しかし、デモ・バンドルのインストールは、通常きわめて簡単です。
OHWデモ・バンドルをOTN(http://otn.oracle.com/tech/java/help/content.html
)からダウンロードします。デモ・バンドルのファイル名はohw-demo-nnn.zip
で、nnn
はOHWのリリース番号です。たとえば、ohw-demo-1_1_1.zip
などです。このファイルにはOHW、サンプル・ヘルプセットおよびOC4Jサーブレット・エンジンが含まれています。
ohw-demo-nnn.zipを、ホスト・コンピュータのデモをインストールする場所に解凍します。
ファイルが解凍され、ohw
ディレクトリに格納されます。 デモ・バンドル・ファイルの詳細は、「OHWデモ・バンドル・ファイルの理解」を参照してください。
JAVA_HOME環境変数をJDK 1.2.2以上(推奨はJDK 1.3.1)がインストールされているホスト・コンピュータのディレクトリに設定していることを確認してください。
サーバーを起動するために、OHW/OC4Jの起動バッチ・ファイルを実行するか、またはohw/bin
ディレクトリから次のスクリプトを実行します。
startup
と入力します。./startup.sh
と入力します。UNIXのスクリプトに実行可能権限がない場合、UNIXのchmodコマンドを使用して、権限を付与する必要があります。
OC4Jが起動したことを示す出力、たとえば「OracleAS <version> Containers for J2EE initialized」などが表示されます。
ブラウザにhttp://<hostname>:8888/ohw/help/
と入力してOHWデモを表示します。ここで<hostname>
はOHWおよびOC4Jがインストールされているホスト・マシンの名前です。
注意: 最後のスラッシュ(/)は必須です。
OHWがブラウザに表示され、ヘルプ・システムの最初のページ(通常は目次)が表示されます。ネットワークに接続した場合、これと同じURLに移動することで、リモート・コンピュータでもブラウザに同じコンテンツが表示されます。
OHWがインストールされているコンピュータでOHWを表示する場合、ブラウザの構成によってはhttp://localhost:8888/ohw/help/
というURLも使用できます。しかし、リモート・コンピュータでヘルプを表示する場合、コンテンツを表示するにはホスト名を使用する必要があります。
サーバーを停止するために、OHW/OC4Jのシャットダウン・バッチ・ファイルを実行するか、またはohw/bin
ディレクトリから次のスクリプトを実行します。
shutdown
と入力します。./shutdown.sh
と入力します。OC4Jは、それぞれ1つ以上のアプリケーション・モジュールから構成される、複数のJ2EEアプリケーションを処理できます。アプリケーション・モジュールは、(1)JSPも採用されたサーブレットのコントロールで実行するWebモジュール、(2)EJBアプリケーション、または(3)Javaクライアント・アプリケーション・モジュールです。OHWアプリケーション・モジュールはWebモジュールです。
OHWデモ・バンドルにより、ファイルがohw
ディレクトリに解凍されます。これによりohw/oc4j/j2ee/home
ディレクトリが作成されます。ここにはデフォルトの構成でOC4Jを実行する際に必要なすべてのファイルが含まれます。
OHWデモ・バンドルで使用されるOC4Jの構成は、OHWアプリケーションおよびUIXアプリケーションの、2つのJ2EEアプリケーションから構成されています。OHWアプリケーション(ohw-eapp
)は、各製品ごとに1つのWebモジュール、および単一または複数のヘルプセットを提供します。UIXアプリケーション(uixresources-eapp
)によって、複数のWebモジュールはインストール可能なUIXリソース・ファイルの1つのセットを共有できます。
OHWおよびUIXのJARフィルは、ohw/oc4j/j2ee/home/lib
ディレクトリにインストールされます。OHWのJavaScriptファイルは、ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/jsLibs
にインストールされます。各Webモジュールには、OHWのJavaScriptファイルのプライベート・コピーが必ず含まれます。
2つのヘルプセットを含む1つのWebモジュールが、デモ・バンドルで提供されています。デモのヘルプセット・ファイルは、ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
にインストールされます。ヘルプセットの2つのサブディレクトリ、fileformats
およびshakespeare
が含まれます。
インストール可能なUIXリソース・ファイルは、ohw/oc4j/j2ee/home/applications/uixresources-eapp/cabo
ディレクトリとそのサブディレクトリにインストールされます。実行時に、ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/cabo
ディレクトリが自動的に作成されます。(UIXリソース・アプリケーションの作成方法は、「デプロイ・バンドルを使用したOC4JでのOHWのデプロイ」を参照してください。)
注意: 1.0.8より前のリリースおよび1.1.xのOHWでは、OHWデモ・バンドルは、共有のインストール可能なUIXリソースに対応して構成されていませんでした。各Webモジュールには、UIXリソース・ファイルのプライベート・コピーが含まれていました。
OHWのデプロイに重要なOC4J構成ファイルは次のとおりです。
ohw/oc4j/j2ee/home/config/server.xml
ohw/oc4j/j2ee/home/config/http-web-site.xml
ohw/oc4j/j2ee/home/applications/ohw-eapp/META-INF/application.xml
ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/WEB-INF/web.xml
ohw/oc4j/j2ee/home/applications/uixresources-eapp/META-INF/application.xml
ohw/oc4j/j2ee/home/applications/uixresources-eapp/cabo/WEB-INF/web.xml
ohwconfig.xmlという構成ファイルのみohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
に格納されています。
この項では、OHWデモ・バンドルがインストール済であると想定して説明します。 デモをインストールしていない場合、「OHWデモ・バンドルのインストールおよび実行」を参照してください。
OHWデモ・バンドルにはサンプル・ヘルプセットが含まれていますが、OHWを使用して開発中のヘルプセットを表示する必要もあるでしょう。開発中のヘルプセットをohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
ディレクトリにコピーし、その後ohwconfig.xmlファイルを変更することで、簡単にデモのヘルプセットと置き換えることができます。そのためには、次の手順に従ってください。
開発中のヘルプ・システムの制御ファイルおよびコンテンツ・ファイルをインストールします。通常、そして使用しやすいように、ヘルプセットは、OHWのhelpsets
ディレクトリまたはその下に格納されます。(ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
ディレクトリ構造は、OHWデモ・バンドルをインストールした場合、デフォルトで必ずインストールされます。)たとえば、myProductという製品の場合、次のようなディレクトリを作成します。
ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets/myProduct
ヘルプセット・ファイル、トピック(HTML)ファイルおよびその他の制御ファイル(索引、目次など)を含むすべてのヘルプ・ファイルを、このディレクトリまたはその下に配置します。これらのファイルの詳細は、「ファイルについて」を参照してください。ヘルプセットにJARファイルを使用している場合は、JARファイルもここに配置します。(JAR形式および非JAR形式のヘルプセットを、同じデプロイで使用できます。)
構成ファイルを編集します。デフォルトでohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
ディレクトリにあるohwconfig.xmlファイルをエディタで開きます。開発中のヘルプセットを指定するように<books></books>
セクションを変更します。 次に例を示します。
<books combineBooks="true" useLabelInfo="true">
<helpSet location="myProduct/myProductHelp.hs" />
<helpSet jar="otherProduct/otherProduct.jar" location="otherProduct.hs" />
</books>
特にohwconfig.xmlファイルは、OHWで使用するヘルプセットおよびヘルプ・トピックHTMLファイルが格納されている場所を定義します。<books>
要素には、任意の数のヘルプセットまたはHelpBook、または両方の組合せを含めることができます。ヘルプセットは実行時にマージされるので、複数の作成者が複数のヘルプセットを作成した場合でも、それらをシームレスにマージできます。マージの動作はcombineBooks
属性およびuseLabelInfo
属性によって指定されます。<helpSet>
要素には、0個以上の<contentLocation>
要素を含めることができます。<contentLocation>
要素は、Oracle Helpで使用する一連のヘルプ・トピックHTMLファイルのルート位置を指定するために使用されます。ohwconfig.xmlファイルの詳細は、「OHW構成ファイル」を参照してください。
サーブレット・エンジンを起動します。前述の「OHWデモ・バンドルのインストールおよび実行」のステップ4で説明されている方法で、サーブレット・エンジンを起動します。OC4Jをすでに実行している場合、最後にサーブレットを起動したときから変更された箇所を確認するために、シャットダウンして再起動する必要があります。
ブラウザにhttp://<hostname>:8888/ohw/help/
と入力します。ここで<hostname>
はOHWおよびOC4Jがインストールされているホスト・マシンの名前です。
ヘルプ・システムのデモの最初のページがブラウザに表示されます。1つ以上のヘルプセットがある場合、ツールバーのドロップダウン・リストからヘルプセットを選択し、「ヘルプセットの切替え」をクリックすれば、選択したヘルプセットのみの目次および索引が表示されます。テキスト検索では、選択したヘルプセット内の項目のみを検索します。
この項では、OHWデモ・バンドルがインストール済であると想定して説明します。 デモをインストールしていない場合、「OHWデモ・バンドルのインストールおよび実行」を参照してください。
OHWデモ・バンドルにはサンプルWebモジュール(ohw)が含まれていますが、独自のWebモジュールを作成して他のヘルプセットを表示する必要もあるでしょう。 その場合、ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw
ディレクトリからファイルをコピーして、ohwconfig.xmlファイル、application.xmlファイルおよびweb.xmlファイルを変更することで、簡単に実行できます。 そのためには、次の手順に従ってください。
Webモジュール・ディレクトリを作成します。新規ディレクトリをohw/oc4j/j2ee/home/applications/ohw-eapp
の下に作成します。たとえば、mymoduleというWebモジュールの場合、次のような新規ディレクトリを作成します。
ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule
web.xmlファイルおよびOHWのJavaScriptファイルをコピーします。各Webモジュールには、web.xmlファイルおよびOHWのJavaScriptファイルのプライベート・コピーが必ず含まれます。ohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/jsLibs
ディレクトリおよびohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/WEB-INF
ディレクトリをコピーし、ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule
に配置します。これで新しいWebモジュールに対して次の構造が設定されました。
ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/jsLibs/<files>
ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/WEB-INF/web.xml
開発中のヘルプ・システムの制御ファイルおよびコンテンツ・ファイルをインストールします。helpsets
ディレクトリを、独自のWebモジュールのディレクトリ内に作成し、helpsets
ディレクトリまたはその下に開発中のヘルプ・ファイルをインストールします。たとえば、myProductという製品の場合、次のようなディレクトリを作成します。
ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/helpsets/myProduct
ヘルプセット・ファイル、トピック(HTML)ファイルおよびその他の制御ファイル(索引、目次など)を含むすべてのヘルプ・ファイルを、このディレクトリまたはその下に配置します。これらのファイルの詳細は、「ファイルについて」を参照してください。ヘルプセットにJARファイルを使用している場合は、JARファイルもここに配置します。(JAR形式および非JAR形式のヘルプセットを、同じデプロイで使用できます。)
構成ファイルを編集します。ohwconfig.xmlをohw/oc4j/j2ee/home/applications/ohw-eapp/ohw/helpsets
からコピーし、ohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/helpsets
に配置します。
デフォルトでohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/helpsets
ディレクトリにあるohwconfig.xmlファイルをエディタで開き、開発中のヘルプセットを指定するように<books></books>
セクションを変更します。 次に例を示します。
<books combineBooks="true" useLabelInfo="true">
<helpSet location="myProduct/myProductHelp.hs" />
<helpSet jar="otherProduct/otherProduct.jar" location="otherProduct.hs" />
</books>
特にohwconfig.xmlファイルは、OHWで使用するヘルプセットおよびヘルプ・トピックHTMLファイルが格納されている場所を定義します。<books>
要素には、任意の数のヘルプセットまたはHelpBook、または両方の組合せを含めることができます。ヘルプセットは実行時にマージされるので、複数の作成者が複数のヘルプセットを作成した場合でも、それらをシームレスにマージできます。マージの動作はcombineBooks
属性およびuseLabelInfo
属性によって指定されます。<helpSet>
要素には、0個以上の<contentLocation>
要素を含めることができます。<contentLocation>
要素は、Oracle Helpで使用する一連のヘルプ・トピックHTMLファイルのルート位置を指定するために使用されます。ohwconfig.xmlファイルの詳細は、「OHW構成ファイル」を参照してください。
新しいWebモジュールの情報をapplication.xmlファイルに追加します。ohw/oc4j/j2ee/home/applications/ohw-eapp/META-INF/application.xml
ファイルをエディタで開き、次の行を<application></application>
セクションに追加します。
<module>
<web>
<web-uri>mymodule</web-uri>
<context-root>/</context-root>
</web>
</module>
最終的なapplication.xmlファイルは、次のサンプルXMLファイルに近似しているはずです。
application.xmlファイルの例:
<?xml version="1.0"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN"
"http://java.sun.com/aplication_1_3.dtd">
<application>
<display-name>ohw-eapp</display-name>
<module>
<web>
<web-uri>ohw</web-uri>
<context-root>/</context-root>
</web>
</module>
<module>
<web>
<web-uri>mymodule</web-uri>
<context-root>/</context-root>
</web>
</module>
</application>
新しいWebモジュールのアクセス位置をOHWアプリケーションにバインドします。ohw/oc4j/j2ee/home/config/http-web-site.xml
ファイルをエディタで開き、次の行を追加します。
<web-app application="ohw-eapp" name="mymodule" root="/mymodule" />
最終的なhttp-web-site.xmlファイルは、次のサンプルXMLファイルに近似しているはずです。
http-web-site.xmlファイルの例:
<?xml version="1.0"?>
<!DOCTYPE web-site PUBLIC "Orion Web-site" "http://xmlns.oracle.com/ias/dtds/web-site.dtd">
<web-site port="8888" display-name="Default Oracle9iAS Containers for J2EE Web Site">
<default-web-app application="default" name="defaultWebApp" />
<web-app application="ohw-eapp" name="ohw" root="/ohw" />
<web-app application="ohw-eapp" name="mymodule" root="/mymodule" />
<web-app application="uixresources-eapp" name="cabo" root="/cabo" />
<access-log path="../log/http-web-access.log" />
</web-site>
注意: name="mymodule"
と、前述のステップ5に記載されている<web-uri></web-uri>
に設定する名前は同一にします。
サーブレット・エンジンを起動します。前述の「OHWデモ・バンドルのインストールおよび実行」のステップ4どおりに行います。OC4Jをすでに実行している場合、最後にサーブレットを起動したときから変更された箇所を確認するために、シャットダウンして再起動する必要があります。
http://<hostname>:8888/ohw/help/
と入力してヘルプ・システムを表示します。ここで<hostname>
はOHWおよびOC4Jがインストールされているホスト・マシンの名前です。
ヘルプ・システムの最初のページがブラウザに表示されます。1つ以上のヘルプセットがある場合、ツールバーのドロップダウン・リストからヘルプセットを選択し、「ヘルプセットの切替え」をクリックすれば、選択したヘルプセットのみの目次および索引が表示されます。テキスト検索では、選択したヘルプセット内の項目のみを検索します。
前述の「Webモジュールの追加」で説明したように、OHWにアクセスするURLはhttp://<hostname>:8888/mymodule/help/
で、<hostname>
はOHWおよびOC4Jがインストールされているマシンの名前です。
このURLは次の方法で変更できます。
web.xmlファイルを編集し、URLの末尾のhelpを変更します。 「Webモジュールの追加」の項のステップ2に記載されているweb.xmlファイルは、次のサンプルXMLファイルに近似しているはずです。このweb.xmlファイルは、ohwconfig.xmlファイルがohw/oc4j/j2ee/home/applications/ohw-eapp/mymodule/helpsets
ディレクトリにあるかぎり使用できます。
web.xmlファイルの例:
<?xml version="1.0"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/j2ee/dtds/web-app_2_3.dtd">
<web-app>
<servlet>
<servlet-name>OHW</servlet-name>
<servlet-class>oracle.help.OHW</servlet-class>
<init-param>
<param-name>configFileName</param-name>
<param-value>/helpsets/ohwconfig.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>OHW</servlet-name>
<url-pattern>/help/*</url-pattern>
</servlet-mapping>
</web-app>
<servlet-mapping>
パラメータの<url-pattern>
は、OHWへのアクセスに使用されるURLを指定します。たとえば、<url-pattern>
をデフォルトの/help/*
から/onlinereference/*
に変更した場合、OHWへのアクセスに使用されるURLはhttp://<hostname>:8888/mymodule/onlinereference/
になります。
次のパラメータは、OHW構成ファイル(ohwconfig.xml)の場所を指定します。
<init-param>
<param-name>configFileName</param-name>
<param-value>/helpsets/ohwconfig.xml</param-value>
</init-param>
構成ファイルのパスはサーブレットのコンテキスト・パスの相対位置に指定されます。ほとんどのユーザーは、このパラメータを変更しないことをお薦めします。
http-web-site.xmlファイルを編集して、mymoduleを他の名前に変更します。
前述の「Webモジュールの追加」のステップ6には、http-web-site.xmlファイルの例が記載されています。
root="/mymodule"
はURLで使用される名前(たとえばhttp://<hostname>:8888/mymodule/help/
)を指定します。
OHWにアクセスするURLをhttp://<hostname>:8888/jdeveloper/help/
にする場合、root="/mymodule"
をroot="/jdeveloper"
に変更します。
Copyright © 1996, 2004, Oracle. All rights reserved.