| Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発 12c(12.1.2) E48092-01 |
|
 前 |
この付録では、Oracle Help for the Web-UIX (OHW-UIX)について説明します。OHW-UIXは、HTMLに基づくヘルプ・コンテンツをWeb環境で開発し、配信するためのJavaサーブレットおよびファイル形式仕様です。
OHW-UIXを使用すると、Webアプリケーションの状況依存ヘルプを提供したり、独立したHTMLコンテンツの構造化されたビューをWebで処理および表示できます。OHW-UIXでは、ユーザーに必要となるのは、ヘルプ・コンテンツをナビゲートし、表示するためのWebブラウザのみです。処理は、OHW-UIXサーブレットを介してサーバー上で行われます。ヘルプ・コンテンツは1台のサーバーで管理され、任意の数のWebブラウザで表示されるため、数多くのユーザーがヘルプの単一のインストールにアクセスします。
この付録の構成は、次のとおりです。
OHW-UIXは、Oracle Help for the Webの以前のバージョンです。新しいヘルプ・システムを作成する場合、OHW-UIXのかわりにOracle Help for the Webを使用してヘルプ・システムを作成することをお薦めします。オラクル社のADF UIXテクノロジを使用してアプリケーションを構築する場合は、OHW-UIXを使用する必要があります。
OHW-UIXに含まれているものは、次のとおりです。
OHW-UIXサーブレット: OHW-UIXサーブレットはWebサーバーにインストールされ、Webブラウザからヘルプ・システムにアクセスする複数のユーザーにヘルプを提供します。OHW-UIXサーブレットのタスクは、次のとおりです。
ヘルプセットの解析とマージ
検索の処理
OHW-UIXユーザー・インタフェースの生成とユーザーのWebブラウザへのインタフェースの配信
ユーザーのWebブラウザでOHW-UIXを介して表示するヘルプ・コンテンツの配信
OHW-UIXユーザー・インタフェースには、OHJのJavaユーザー・インタフェースで使用可能な機能がすべて含まれていますが、これらの機能は、ユーザーのブラウザでHTMLとしてレンダリングされます。機能には、目次、索引、テキスト検索などがあります。
ヘルプ・コンテンツ・ファイルおよび制御ファイル(OHJで使用されるのと同じHTMLファイルおよびXMLファイル)は、同じサーバーにサーブレットとして保存することも、様々な場所にある複数のサーバーに分散させることもできます。
ドキュメント: ドキュメントにはこのマニュアルも含まれます。
Oracle Help for the Web-UIX (OHW-UIX)のユーザー・インタフェースは、Oracle Help for Java (OHJ)と同じ機能を提供します。ただし、OHW-UIXはWebアプリケーションであるため、外観および動作に若干の相違点があります。
Oracle ADF UIXテクノロジを使用してアプリケーションを構築する場合は、OHW-UIXのヘルプ・システムの使用をお薦めします。Oracle ADF UIXテクノロジを使用しない場合は、Oracle Help for the Web-Rich Clientのヘルプ・システムを使用する必要があります。詳細は、第3章「Oracle Help for the Webのユーザー・インタフェース」を参照してください。
図D-1の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
ブランド領域: この領域には、テキスト、イメージまたはその両方を含めることができます。通常、この領域では、ヘルプ・コンテンツが特定されるか、または社名やロゴなどの会社情報が表示されます。
ヘルプセット・スイッチャ: ヘルプセットが複数ある場合に、それらのヘルプセットをマージするか、またはこのドロップダウンに個別に登録するかを指定できます。
タブ・バー: デフォルトのタブは、「目次」、「索引」、「検索」および「トピックの表示」です。
コンテンツ領域: タブを選択すると、そのタブに関連するコンテンツが、この領域に表示されます。
ブランド領域を除いて、これらの要素はヘルプセット・ファイルで構成されています。OHW-UIXおよびOHJは、ヘルプセット・ファイルを含め、まったく同じファイル形式を使用します。つまり、既存の制御ファイルを変更することなく、既存のOHJヘルプ・システムをOHW-UIXシステムとしてデプロイできます。OHW-UIXおよびOHJでは、ヘルプセット・ファイルの同じディレクティブを使用して、ユーザー・インタフェースを構築します。ヘルプ・システムをOHW-UIXシステムとしてデプロイするには、サーブレット・コンテナを構成してデプロイし、OHW-UIX構成ファイルを追加する必要があります。ブランド情報は、他の構成パラメータとともにこのファイル内に指定されます。
OHW-UIXシステムのデプロイの詳細は、第D.4項「OHW-UIXのデプロイの理解」を参照してください。
OHW-UIXのタブとOHJのタブの比較
OHW-UIXの標準タブ(ナビゲータとも呼ばれる)は、「目次」、「索引」、「検索」および「トピックの表示」になります。「目次」、「索引」および「検索」の各タブは、ヘルプセットのOHJナビゲーション・ウィンドウに表示される同じタブに相当します。「トピックの表示」タブは、OHJでのトピック・ウィンドウのかわりになるものです。OHW-UIXナビゲータは、現行ユーザーの状態を記憶します。つまり、あるタブから別のタブに切り替える場合や、トピックからの一連のリンクをたどる場合、前にアクセスしたタブにはそのコンテンツが保持されます。たとえば、「検索」タブで検索を実行し、検索で見つかったいずれかのトピックから複数のリンクをたどる場合、「検索」タブに戻ると、最新の検索条件や結果が表示されます。これは、ローカル・システム(OHJなど)上にあるアプリケーションにとって驚くような機能ではありませんが、アプリケーションがサーバー上で実行するWebアプリケーションにとっては重要な機能になります。この機能には、多くのリモート・ユーザーが同時にアクセスできます。次のトピックでは、OHJとの比較を含め、OHW-UIXユーザー・インタフェース要素について詳しく説明します。
目次(TOC)をツリーで表示するOHJとは対照的に、OHW-UIXのTOCでは、ヘルプ・システムの階層は一連のページで表示されます。各ページは階層の1つのノードを示します。そのページでは、トピックと子ノード(つまり、現在のノードの配下のノード)の両方をリスト表示できます。トピック・タイトルを選択すると、OHW-UIXは「トピックの表示」タブに切り替えられ、そのトピックのコンテンツが表示されます。「目次」タブでノードのタイトルをクリックすると、ページがリフレッシュされ、該当ノードのリストが表示されます。階層を移動すると、ナビゲーション証跡(ブレッドクラム)がページ上部に一連のリンクとして表示されます。これにより、階層の前のレベルにすばやく戻ることができます。
OHW-UIXのキーワード索引も、OHJのキーワード索引とは若干異なっています。OHJと同様、OHW-UIXの索引にも、「移動先」というラベルが付けられた、索引で見つける語句を入力するためのテキスト・フィールドがあります。ただし、OHJとは異なり、関連する語句が表示されるようにするには、「移動」を選択するか、または[Enter]キーを押す必要があります。OHW-UIXで一度に表示される項目は10個のみですが、「移動先」フィールドに入力した語句と一致する項目のリスト内を移動するためのコントロールも表示されます。「移動先」フィールドに何も入力しない場合は、キーワード・リスト全体での移動が可能です。
キーワード・リストから項目を選択すると、ページがリフレッシュされ、選択したキーワードに関連するトピックのリストが表示されます。このリストは、OHJの「索引」タブの下部に表示される、見つかったトピックのリストに相当します。このリストから項目を選択すると、タブが「トピックの表示」に切り替えられ、そのトピックが表示されます。
索引のトピックの対象ページの上部には、目次の項で説明したものと同様のナビゲーション・リンクが表示されます。ただし、このリンクを使用した場合、常に、キーワード・リストに戻ります。
OHW-UIXのテキスト検索は、索引に似ています。「検索」テキスト・フィールドに単語または句を入力して[Enter]を押すと、関連するトピックのリストが表示されます。最初の10項目が表示され(リストはランクに応じてソートされます)、リストの他の項目にさらに移動できます。「拡張検索」モードでは、検索オプション(大/小文字の区別、すべての単語に一致する、いずれかの単語に一致する、など)を指定したり、ブール式を使用することもできます。
索引と同様、見つかったトピックのリストから項目を選択すると、「トピックの表示」タブにトピックが表示されます。
OHW-UIXでは、トピックは、「トピックの表示」タブに表示されます。このナビゲータでは、トピックIDリンク、関連リンク、ポップアップなどのOHJのいくつかの特殊機能がサポートされています。OHJでは、これらの機能はICEbrowser表示エンジンによってサポートされています。OHW-UIXでは、これらの機能はどのブラウザでも動作します。これらの機能の詳細は、第7章「トピック・ファイル」を参照してください。
「目次」でトピックを見つけるには、「目次に移動」をクリックします。トピックを印刷するには、「印刷可能ページ」をクリックします。ナビゲーション・タブ、ヘルプ・タイトルおよびヘルプセット・スイッチャなしで、新しい印刷可能ページが作成されます。
この項では、OHW-UIXのデモ・ファイルをOracle WebLogic Serverにデプロイする方法について説明します。
OHW-UIXデモEARファイルには、デモの表示やリリースの試用を行う必要があるクラス・ライブラリが含まれています。また、サンプル・ヘルプセット、OHW-UIXサーブレット・ファイルおよびXML構成ファイルが含まれています。OHW-UIXインタフェースを体験するデモ・ファイルのデプロイや、既存のヘルプセットの交換および各自のヘルプセットの追加などを行えます。
次の項では、デモ・ファイルについて理解し、ユーザーの環境でサンプル・ヘルプセットをデプロイおよびテストを行ったり、オプションでデプロイおよびテスト用に独自のヘルプセットを追加する方法について説明します。
OHW-UIXデモ・ファイルohw-uix-demo.earには、3つのOHW-UIXサンプル・ヘルプセットと、そのヘルプ・トピック、ヘルプセット・ファイルおよび制御ファイルが含まれています。また、OHW-UIXの構成に必要なohwconfig.xmlも含まれています。
OHWデモEARファイルによって、ohw-uix-demoディレクトリにファイルが解凍されます。解凍されたEARファイルにはohw-uix-demo.warファイルが含まれており、application.xmlファイルを含むMETA-INFディレクトリが作成されます。ohw-uix-demo.warの解凍後に作成されるohw-uix-demoディレクトリには、ヘルプセットのディレクトリが、それぞれのヘルプ・トピック、ヘルプセット・ファイルおよび制御ファイルとともに含まれます。
表D-1に、OHW-UIXのデモ・ファイルに含まれるファイルとディレクトリを示します。
表D-1 OHW-UIXのデモ・ファイル
| ディレクトリの場所 | 説明 |
|---|---|
|
|
Java EEアプリケーション: 簡単なOHW-UIXアプリケーションです。 このファイルは、 |
|
|
ヘルプセット・ディレクトリは、 |
|
|
UIXのインストール可能なリソース・ファイルです。
|
|
|
OHW-UIXに影響する構成およびデプロイの情報が含まれます。 このファイルは、 |
|
|
OHW-UIX構成ファイルです。 このファイルは、 |
デモEARファイルのインストールは、非常に簡単なプロセスです。
OHW-UIXのデモEARファイルをOTNからダウンロードします。デモ・ファイルの名前は、ohw-uix-demo.earです。このファイルには、OHW-UIXおよびサンプル・ヘルプセットが含まれています。
Oracle WebLogic Server管理コンソールを起動し、「デプロイメント」ページに移動します。
「デプロイメント」ページで、「インストール」をクリックしてデプロイ・ウィザードを起動します。
「パス」フィールドにohw-uix-demo.earファイルの保存先を入力し、「次へ」をクリックします。
ターゲット指定スタイルの選択ページで、このデプロイメントをアプリケーションとしてインストールするを選択し、「次へ」をクリックします。
「オプション設定」ページで設定を確認します。設定をデフォルトのままにしておくことをお薦めします。「次」をクリックして続行するか、「終了」をクリックしてデプロイメントを完了します。
追加構成ページで、はい、デプロイメントの構成画面を表示しますを選択し、「終了」をクリックしてデプロイを完了します。
デプロイが成功すると、デプロイ・ウィザードの表示は、ohw-uix-demo.earの設定ページに戻ります。ファイルのデプロイ中にエラーが発生した場合は、「デプロイメント」ホームページが表示され、エラーが赤いテキストでリストされます。
Oracle JDeveloperにデモ・ファイルをインストールする手順は、次のとおりです。
OHW-UIXのデモEARファイルをOTNからダウンロードします。デモ・ファイルの名前は、ohw-uix-demo.earです。このファイルには、OHW-UIXおよびサンプル・ヘルプセットが含まれます。
JDeveloperを起動します。
ohw-uix-demo.earファイルから新規アプリケーションを作成します。「ファイル」メニューから、「新規」を選択します。「新規ギャラリ」ダイアログ・ボックスで、「一般」カテゴリの下の「アプリケーション」を選択し、「項目」リストから「EARファイルからのアプリケーション」を選択します。
EARファイルからのアプリケーション作成ウィザードの場所ページで、ohw-uix-demo.earファイルを参照して選択します。また、アプリケーション名およびアプリケーションの場所を変更することもできます。「次へ」をクリックして続行します。
ウィザードのEARモジュール・ページに、プロジェクト名およびモジュール名が表示されます。「次へ」をクリックして続行するか、または「終了」をクリックしてEARファイルからアプリケーションを作成します。
ウィザードの終了ページに、アプリケーションの設定の概要が表示されます。「終了」をクリックしてEARファイルからアプリケーションを作成します。JDeveloperによって、EARファイルからすべてのファイルが抽出され、編集およびデプロイ可能なアプリケーションが作成されます。
「アプリケーション」ウィンドウで、プロジェクトを開き、目的のファイルを編集します。
アプリケーションをデプロイするには、統合されたOracle WebLogic Serverインスタンスを起動します。「実行」メニューから、「サーバー・インスタンスの起動」を選択して統合されたOracle WebLogic Serverを起動します。
「アプリケーション」ウィンドウで、ohw-uix-demoプロジェクトを選択します。「アプリケーション」メニューから、「デプロイ」を選択します。サブメニューからohw-uix-demo→「デプロイ先」を選択し、IntegratedWLSConnectionを選択します。JDeveloperによってデプロイメント・プロセスが開始され、デプロイのステータスが「ログ」ウィンドウに反映されます。
アプリケーションが正常にデプロイされると、「ログ」ウィンドウに「---- デプロイが終了 ----」メッセージが表示されます。
ohw-uix-demo.earのデプロイに成功すると、ブラウザが開いて次のURLが表示されます。
http://<yourHost>:<yourPort>/ohw-uix-demo/help/
次に例を示します。
Oracle WebLogic Serverをローカル・システムにインストールした場合は、次のURLを使用してデモ・ヘルプ・ファイルを開くことができます。
http://localhost:7101/ohw-uix-demo/help/
このURLは自動的にhttp://localhost:7101/ohw-uix-demo/help/state?navSetId=ohguide&navId=0&destination=に変更され、ヘルプの目次ビューが表示されます。OHW-UIXのユーザー・インタフェースの詳細は、第D.2項「OHW-UIXユーザー・インタフェース」を参照してください。
ヘルプ作成者は、任意のオーサリング・ツールを使用してヘルプ・コンテンツを作成します。ヘルプ作成者は、通常、ヘルプ・コンテンツをOHW-UIXヘルプ・システムとしてデプロイするために必要なOracle Help制御ファイルも作成します。OHW-UIX管理者は、一般的に、ヘルプセットのデプロイに必要なすべてのタスクを実行します。
ヘルプ作成者およびOHW-UIX管理者の両方とも、テストまたは本番用にデプロイすることがあるため、デモ・デプロイ・ファイルが提供されています。最新のデモ・ファイルは、OTNからダウンロードできます。
OHW-UIXに慣れていない場合は、デモ・ファイルohw-uix-demo.earのデプロイから開始できます。詳細は、第D.3.1項「OHW-UIXのデモ・ファイルの理解」を参照してください。デモEARファイルには、サンプル・ヘルプセットを即時にデプロイするためのファイルが含まれます。
OHW-UIXの新しいヘルプセットを作成する場合、次の各項で、OHW-UIXのデプロイメント・プロセスに役立つ情報と、OHW-UIXヘルプ・システムを作成してデプロイする手順を参照してください。
構成ファイルをすでに作成し、アプリケーション・サーバーを構成している場合を除いて、OHW-UIX管理者は、OHW-UIXヘルプ・システムをデプロイするために、次のタスクを実行する必要があります。
デプロイを開始する前に、すべての要件および依存性を検証します。
表D-2 OHW-UIXデプロイの最小要件
| 要件 | 説明 |
|---|---|
|
サーブレット・コンテナ |
OHW-UIXには、JavaEE 1.5互換のアプリケーション・サーバーが必要です。Oracle WebLogic Server(スタンドアロンとしてまたはJDeveloperと統合して提供されている)では、構成作業を最小限に抑えることができるため、その使用をお薦めします。 |
|
クライアント |
クライアントはHTMLのみを受信するため、必要となるのは、OHW-UIXヘルプ・コンテンツを表示して閲覧するためのWebブラウザのみです。WebブラウザのJavaScriptサポートは有効にする必要があります。 OHW-UIXは、Microsoft Internet Explorer 7、Microsoft Internet Explorer 8、Mozilla FireFox 2、Mozilla FireFox 3、Apple SafariおよびGoogle Chromeでサポートされます。 |
|
UIX |
OHW-UIXはUIXアプリケーションです。 |
|
UNIXのみ: X Server |
UNIXでは、動的イメージ生成が正常に行われるために、X Serverに接続するようにサーブレット・コンテナを構成する必要があります。 |
OHW-UIXヘルプセットのデプロイを開始する前に、OHW-UIXを正しく構成するために変更の必要なファイルがあります。次に、XML構成ファイルの理解に役立つ情報を示します。
application.xml: 指定のJava EEアプリケーションで実行するすべてのWebモジュールのマニフェスト。デプロイされる各製品のそれぞれのWebモジュールを指し示します。2つのインスタンスのapplication.xmlを使用することをお薦めします。
UIXアプリケーション用の比較的安定したバージョン(任意)。
Webモジュールが追加または再構成されるたびに、頻繁に変更されるOHW-UIXアプリケーション用のバージョン。
application.xmlの名前および場所は、Java EE標準によって固定されています。OHW-UIXでは、このファイルは<OHW-UIX_HOME>\META-INFディレクトリにある必要があります。
web.xml: OHW-UIX構成ファイルの場所など、サーブレットの初期化パラメータを設定します。各Webモジュールに1つのweb.xmlインスタンスがあります。OHW-UIX構成ファイルが一定の方法で格納され、名前が付けられている場合、このファイルはすべてのOHW-UIXのWebモジュールに対して同じになります。このファイルは、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\WEB-INF\ディレクトリにある必要があります。
ohwconfig.xml(デフォルトのファイル名): 表示するヘルプセットと、それらの表示方法を指定します。ロケール、ブランド情報およびその他各種設定も指定できます。構成ファイルの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。このファイルの名前と場所は、サーブレット初期化パラメータとして設定されます。このパラメータは、サーブレット・コンテナごとに個別に処理されます。このファイルは、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>ディレクトリにある必要があります。
この項では、OHW-UIXヘルプ・システムで必要とされるディレクトリ構造の作成、カスタム・ヘルプセット・ファイルの正しい場所への追加、構成ファイルの作成と変更、およびアプリケーション・サーバーへのヘルプ・システムのデプロイに役立つ情報が提供されます。
この項の説明では、OHW-UIXのデモEARファイルがインストール済で、ユーザーがデモEARファイルのディレクトリ構造に精通していることを想定しています。まだデモ・ファイルがインストールされていない場合は、第D.3.1項「OHW-UIXのデモ・ファイルの理解」の手順に従ってインストールしてください。
OHW-UIXヘルプ・システムを設定する手順は、次のとおりです。
次のようにディレクトリ構造を設定します。
<OHW-UIX_HOME>
|
— <OHW-UIX_deployment_name>
|
— cabo
— helpsets
|
— <custom_helpset_directory>
— META-INF
— WEB-INF
|
— lib
— META-INF
次に例を示します。
my_module
|
— my_module_help
|
— cabo
— helpsets
|
— my_ModuleHelpset
— META-INF
— WEB-INF
|
— lib
— META-INF
独自のヘルプセット・ディレクトリを作成します。ヘルプセット・ファイル、トピック・ファイルおよび他の制御ファイル(索引、目次など)を含め、独自のヘルプ・ファイルをすべて<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\helpsets\<custom_helpset_directory>ディレクトリの下に配置します。また、ヘルプセットにJARファイルを使用する場合は、JARファイルもここに配置します。JARファイルを作成したヘルプセットとJARファイルを作成していないヘルプセットを1つのデプロイで一緒に使用できます。
ohwconfig.xmlをohw-uix-demo\ohw-uix-demo\helpsetsディレクトリからコピーして、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\helpsetsディレクトリに保存します。その後、構成ファイルを更新および構成します。
自分のヘルプセットにダイレクトするように<books></books>セクションを変更します。次に例を示します。
<books> <helpSet id="myModule" location="my_ModuleHelpset/my_ModuleHelpset.hs" /> </books>
<books></books>セクションから、希望しないヘルプセットを削除します。削除されたヘルプセットは、OHW-UIXユーザー・インタフェースのヘルプセット・スイッチャのドロップダウン・リストに表示されなくなります。<books></books>セクション内に<helpSet>要素が1つしかない場合、ヘルプセット・スイッチャは使用できません。
<brandings></brandings>セクションを更新して、独自のブランドを表示します。次に例を示します。
<brandings> <branding text="My Module" /></brandings>
caboファイルをohw-uix-demo\ohw-uix-demo\caboディレクトリから<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\caboディレクトリへ、ライブラリ・ファイルをohw-uix-demo\ohw-uix-demo\WEB-INF\libディレクトリから<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\WEB-INF\libディレクトリへ、それぞれコピーします。
uix-config.xmlをohw-uix-demo\ohw-uix-demo\WEB-INFディレクトリからコピーして、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\WEB-INFディレクトリに保存します。必要に応じてファイルを編集します。
web.xmlをohw-uix-demo\ohw-uix-demo\WEB-INFディレクトリからコピーして、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\WEB-INFディレクトリに保存します。次の手順で、必要に応じてファイルを編集します。
<display-name></<display-name>と<description></description>セクションを変更して、カスタム・ヘルプセット名を表示します。次に例を示します。
<web-app> <display-name>My Module</display-name> <description>My module help</description> </web-app>
オプションで、<servlet>要素の下の<servlet-name>要素を編集して、OHW-UIXのアクセスに使用するURLを変更することもできます。アクセスURLの変更方法の詳細は、「OHW-UIXのアクセスURLの変更」を参照してください。
<OHW-UIX_deployment_name>ディレクトリをWARファイルに圧縮します。
application.xmlをohw-uix-demo\META-INFディレクトリからコピーして、<OHW-UIX_HOME>\META-INFディレクトリに保存します。必要に応じてファイルを編集します。このファイルで、デプロイする各製品のWebモジュール名を指定します。手順7で<web-uri></web-uri>要素内に作成したWARファイル名を指定します。アプリケーションのアクセスURLを変更する場合は、<context-root></context-root>要素を更新します。詳細は、第D.4.4項「OHW-UIXのアクセスURLの変更」を参照してください。
<OHW-UIX_HOME>ディレクトリをEARファイルに圧縮します。
Oracle WebLogic Serverを起動してEARファイルをデプロイします。Oracle WebLogic Serverがすでに実行されている場合は、サーブレットを最後に起動してから加えた変更が有効になるように、シャットダウンしてから再起動する必要があります。
ブラウザでhttp://<hostname>:<port>/<OHW-UIX_deployment_name>/help/を指定します。<hostname>は、OHW-UIXおよびOracle WebLogic Serverがインストールされているシステムの名前です。
デモ・ヘルプ・システムの最初のページがブラウザに表示されます。2つ以上のヘルプセットがある場合は、ツールバーのドロップダウン・リストを使用して1つのヘルプセットを選択し、ヘルプセット・スイッチャをクリックして、選択したヘルプセットのみの目次および索引を表示します。テキスト検索では、選択したヘルプセットの項目のみ検索されます。
OHW-UIXにアクセスするURLは、http://<hostname>:<port>/mymodule/help/です。<hostname>は、OHW-UIXおよびOracle WebLogic Serverがインストールされているマシンの名前です。
このURLは、次の方法で変更できます。
URLの最後にあるhelpを変更するには、<OHW-UIX_HOME>\<OHW-UIX_deployment_name>\WEB-INFのweb.xmlを編集します。
<servlet-mapping>のパラメータである<url-pattern>に、OHW-UIXへのアクセスに使用するURLを指定します。たとえば、<url-pattern>を、デフォルトの/help/*から/onlinereference/*に変更した場合、OHW-UIXへのアクセスに使用するURLはhttp://<hostname>:<port>/mymodule/onlinereference/となります。
次に例を示します。
<servlet-mapping> <servlet-name>mymodule</servlet-name> <url-pattern>/onlinereference/*</url-pattern> </servlet-mapping>
アプリケーションのアクセスURLを変更するには、<OHW-UIX_HOME>\META-INFにあるapplication.xml内で、<web>要素の下の<context-root>要素エントリを編集します。
<web> <web-uri>my_module.war</web-uri> <context-root>my_module</context-root> </web>
たとえば、OHW-UIXのアクセスURLをhttp://<hostname>:<port>/jdeveloper/help/にする場合は、ルート要素を次のように変更します。
<web> <web-uri>my_module.war</web-uri> <context-root>jdeveloper</context-root> </web>
OHW-UIXおよびUIXの新規バージョンがリリースされた場合、OHW-UIXをアップグレードする前に、OHW-UIXおよびUIXのダウンロード・ページを参照して最新のダウンロードおよびインストール方法について確認してください。
OHW-UIXを新規バージョンにアップグレードするには、WEB-INF/libディレクトリにあるOHW-UIXのJARファイルを置換する必要があります。
UIXを新規バージョンにアップグレードするには、WEB-INF/libディレクトリにあるUIXのJARファイルを置換し、また、uix2-install.zipをcaboディレクトリに解凍することによって、UIXのインストール可能なリソース・ファイルを置換する必要があります。
アップグレードをテストするには、サーブレット・コンテナを再起動し、ブラウザでhttp://<hostname>:<port>/ohw-uix-demo/help/またはOHW-UIXアプリケーションをマップした場所を指定します。
Oracle Help for the Web-UIX (OHW-UIX)には、Webアプリケーションのユーザー・インタフェースの一部の状況に関連付けられたヘルプ・トピックを表示する、状況依存ヘルプ・メカニズムが備えられています。通常、ヘルプ・トピックは、Webアプリケーションの特定のページ、表または入力フィールドの機能について説明するために記述されています。「ヘルプ」ボタンを選択するなどして、ユーザー・インタフェース・コントロールのヘルプを要求すると、その状況(またはコントロール)に関連する適切なトピックが表示されます。
状況依存ヘルプをWebアプリケーションで使用するには、ヘルプ・システムに1つ以上のマップ・ファイルが存在し、アプリケーション・コードに適切なヘルプ・コードが追加されている必要があります。
次の項では、OHW-UIXを使用して状況依存ヘルプを実装する方法について説明します。
OHW-UIXの状況依存ヘルプ・システムには、ヘルプ・トピックHTMLファイルにトピックIDをマップする1つ以上のマップ・ファイルが必要となります。ヘルプセットでは、マップ・ファイルはXMLファイル形式で記述されています。
通常、マップ・ファイルはヘルプ作成者が作成します。Webアプリケーション開発者は、Webアプリケーションのコントロールを状況依存トピックに関連付けるときに、ヘルプ作成者のマップ・ファイルに指定されたトピックIDを使用する必要があります。このため、作業内容についてヘルプ作成者と調整を行う必要性が生じます。
次に、マップXMLファイルのサンプルを示します。
<?xml version='1.0' ?> <map version="1.0"> <mapID target="topic_1" url="file_1.html" /> <mapID target="topic_2" url="file_2.html#a1" /> <mapID target="topic_3" url="file_3.html" wintype="intro" /> </map>
target属性には、ヘルプセット内の関連付けられたHTMLファイルを示す一意のIDを指定します。url属性には、このIDに関連付けるファイルの場所を指定します。wintype属性はオプションであり、トピックを表示するウィンドウ・タイプの名前を指定します。マップ・ファイルで使用される要素の詳細は、第12.3.2項「OHJDKリリースの内容」を参照してください。
状況依存ヘルプの実装にOHW-UIXを使用するアプリケーションは、OHW-UIXサーブレットへの特別な形式のURLを使用して状況依存トピックを要求します。宛先URL(リンク、イメージなど)を持つすべてのユーザー・インタフェース・コントロールを、状況依存トピックに関連付けることができます。
状況依存ヘルプ用のOHW-UIXへのリンクを作成するには、フロント・ページ(「目次」、「索引」および「検索」ナビゲータを含む)の宛先URLを使用するか、またはトピックIDを使用してトピックの宛先URLを作成できます。また、宛先URLにロケールを指定することもできます。
フロント・ページのURLは、次のように、単にOHW-UIXサーブレットのURLとなります。
http://<server>:<port>/<servlet mapping>
<server>はサーブレット・コンテナを実行するサーバーの名前、<port>はサーブレット・コンテナが使用するポート、および<servlet mapping>はOHW-UIXサーブレット用のweb.xmlファイル(デフォルトの場所はohw-uix/help/)に設定されているサーブレット・マッピングです。次に例を示します。
http://www.yourcompany.com:7101/ohw-uix/help/
ユーザーがフロント・ページにリンクされたユーザー・インタフェース・コントロールのヘルプを要求すると、ユーザーのブラウザにOHW-UIXが表示され、ヘルプ・システムの最初のページ(通常は目次)が表示されます。
トピックへリンクするURLを作成するには、OHW-UIXサーブレットのURLに、トピック・パラメータを追加します。topicパラメータの値には、次のようにヘルプ・トピックのトピックIDを指定します。
http://<server>:<port>/<servlet mapping>/?topic=<topic-id>
たとえば、次のURLは、トピックID topic_1と関連付けられているトピックを要求します。
http://www.yourcompany.com:7101/ohw-uix/help/?topic=topic_1
OHW-UIXへの状況依存リンクを実装するときに、アプリケーションのメイン・ページを置き換えるのではなく、JavaScriptを使用して2次ウィンドウにリンク先が表示されるようにする場合があります。
ユーザーがトピックIDにリンクされたユーザー・インタフェース・コントロールのヘルプを要求すると、OHW-UIXナビゲータ(タブ)が含まれないウィンドウ・ページに、そのトピックIDに関連付けられたファイルが表示されます。ただし、ユーザーがヘルプのメイン・ページにアクセスする場合は、トピック・ページに含まれるヘルプ・システムのフロント・ページへのリンクを使用できます。
トピック・ページまたはフロント・ページなどのOHW-UIXページへのリンクを作成する場合は、locale問合せパラメータを使用して、OHW-UIXサーブレットのURLにロケールを含めることができます。
トピックの構文は、次のとおりです。
http://<server>:<port>/<servlet-mapping>/?topic=<topic-id>&locale=<ISO-code>
フロント・ページの構文は、次のとおりです。
http://<server>:<port>/<servlet-mapping>/help?locale=<ISO-code>
ロケールを指定した場合、OHW-UIXは、ローカライズ済ヘルプセット(使用可能な場合)に切り替えられ、指定したロケールが上書きまたは削除されるまで引き続きそのロケールが使用されます。指定したローカライズ済ヘルプセットがない場合、このパラメータは無視されます。
次に例を示します。
http://www.yourcompany.com:7101/ohw-uix/help/?topic=topic_1&locale=sp
ロケールの詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。
UIXは、Webアプリケーションを作成するためのオラクル社のテクノロジです。UIXには、OHW-UIXを使用して状況依存ヘルプを簡単に実装できるメカニズムが備えられています。UIXでは、状況依存ヘルプをUIX Java APIを使用してプログラム的に実装するか、またはUIX言語(XML言語の1つ)を使用して宣言的に実装できます。
|
注意: UIXは、現行リリースのJDeveloperに付属していませんが、UIXを使用する場合は、OTNのアーカイブからJDeveloper 10.1.2以前のリリースをダウンロードします。 |
UIXのHelpProviderアーキテクチャには、汎用的な状況依存ヘルプ・メカニズムが備えられています。OHW-UIXでは、OracleHelpProviderと呼ばれる固有のHelpProviderを実装することによって、UIXアプリケーションに状況依存ヘルプを提供します。
OracleHelpProviderを使用するには、アプリケーションにOHW-UIXを登録してから、データ・バインディングによって状況依存ヘルプへのリンクを指定する必要があります。
OracleHelpProviderを使用する際の最初の手順として、OracleHelpProviderインスタンス(OHW-UIXなど)をUIX構成オブジェクトに登録します。UIXでは、HelpProviderは、データバインディングに使用できる特殊なUIX DataProviderとして表示されます。これは、UIXページで宣言する必要がないという点で特殊です。HelpProviderを構成オブジェクトに登録すると、すべてのページで利用できます。
UIXでは、uix-config.xmlファイルおよびApplicationConfiguration APIを使用して、コードを1行も記述することなく構成オブジェクトのセットを作成でき、フィールドの構成プロパティを更新する場合もコードの再コンパイルが必要ありません。
OHW-UIXをアプリケーションに登録するには、UIXがOHW-UIXサーブレットのインスタンスを指すようにuix-config.xmlファイルを変更します。
次に、uix-config.xmlファイルのサンプルを示します。
<?xml version="1.0" encoding="ISO-8859-1"?>
<configurations xmlns="http://xmlns.oracle.com/uix/config">
...
<default-configuration>
<help-provider>
<ohw-servlet-url>http://www.yourcompany.com:7101/ohw-uix</ohw-servlet-url>
</help-provider>
</default-configuration>
...
</configurations>
<help-provider>要素を使用すると、ヘルプ・プロバイダを構成できます。現在サポートされている構文は、含まれている<ohw-servlet-url>要素のみです。ohw-servlet-urlには、OHW-UIXのインストール先を指すURLを含める必要があります。このプロパティを設定した後、すべてのuiXMLページおよびUIX Javaページから、ui:helpTopicsおよびui:helpSystemという2つのデータ・プロバイダにアクセスできます。
UIXで、構成オブジェクトの作成にJavaコードの使用が必要であるものの、uix-config.xmlファイルに定義されているデフォルトのプロパティを使用する場合は、次のコードを使用します。
ApplicationConfiguration appConfig =
ApplicationConfiguration.getInstance(servletContext);
configurationImpl impl =
new ConfigurationImpl ("someName", appConfig.getDefault());
impl.register(servletContext);
UIXで、OHWをアプリケーションにプログラム的に登録するには、次のサンプル・コードを参照してください。
protected ConfigurationImpl createDefaultConfiguration()
{
ConfigurationImpl cfg = super.createDefaultConfiguration();
//For your application you'd likely pull the location of the
//OHW servlet out of a servlet init parameter
OracleHelpProvider provider = new OracleHelpProvider("http://www.yourcompany.com:7101/ohw-uix/help/")
cfg.setProperty(Configuration.HELP_PROVIDER, provider);
return cfg;
}
HelpProviderでは、2つの特別なデータ・オブジェクト(UIX UIコンポーネントの名前空間にあるhelpTopicsおよびhelpSystem)が設定されます。
HelpProviderでは、2つのデータ・プロバイダ(ui:helpTopicsおよびui:helpSystem)が設定されます。uiはUIX UI名前空間の接頭辞として使用されます。これらは、ヘルプ・システムへの接続元とするリンクまたはボタン(リンク先を持つすべてのコントロール)のdestination属性をデータ・バインディングする場合に使用されます。
OHW-UIXをUIXベースのアプリケーションに登録した後、ui:helpTopicsおよびui:helpSystemのデータ・オブジェクトを使用して、状況依存ヘルプを宣言的に指定できます。
フロント・ページのリンク先のデータ・バインディング
宣言的なUIXでは、ui:helpSystemデータ・オブジェクトに特別なfrontPageキーを使用することによって、フロント・ページに対してリンク先を作成できます。次に例を示します。
<globalButton icon="globalhelp.gif" text="Help" data:destination="frontPage@ui:helpSystem"/>
ユーザーがフロント・ページにリンクされたユーザー・インタフェース・コントロールのヘルプを要求すると、ユーザーのブラウザにOHW-UIXが表示され、ヘルプ・システムの最初のページが表示されます。
|
注意: ヘルプ・システムの最初のページは、 |
トピックのリンク先のデータ・バインディング
トピックを表示するには、ui:helpTopicsデータ・オブジェクトのキーとして一意のトピックIDを使用します。次に例を示します。
<button text="Button To Help" data:destination="myTopicID@ui:helpTopics" /> <link text="Link To Help" data:destination="someOtherTopicID@ui:helpTopics" />
実行時に、UIXでは、OracleHelpProviderインスタンスを使用してこれらのリンク先の値を解決します。OracleHelpProviderによって、小さい別のブラウザ・ウィンドウでヘルプを起動するJavaScriptが含まれるリンク先が自動的に返されます。ユーザーがメイン・ページにアクセスする場合は、このウィンドウに含まれるヘルプ・システムのフロント・ページへのリンクを使用できます。
OHW-UIXからOHWにアップグレードする場合、ヘルプセット・コンテンツの変更は不要ですが、OHWを使用するために、次の2つの操作を実行する必要があります。
OHWのjarファイルを、WEB-INF/libディレクトリにコピーします。
WEB-INF/ディレクトリにあるweb.xmlファイルを変更します。このためには、OHWのデモ・バンドルからweb.xmlを取り出し、サーブレットとリソースの定義およびマッピングをコピーする方法が最適です。
OHWのweb.xmlには、3つの主要部分があります。
JSF TrinidadおよびADF RC (Facesサーブレット、Trinidadサーブレットおよびフィルタなど)の基本構成
<context-param> <param-name>javax.faces.STATE_SAVING_METHOD</param-name> <param-value>client</param-value> </context-param> <filter> <filter-name>trinidad</filter-name> <filter-class>org.apache.myfaces.trinidad.webapp.TrinidadFilter</filter-class> </filter> <filter-mapping> <filter-name>trinidad</filter-name> <servlet-name>Faces Servlet</servlet-name> </filter-mapping> <servlet> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Faces Servlet</servlet-name> <url-pattern>/faces/*</url-pattern> </servlet-mapping> <servlet> <servlet-name>resources</servlet-name> <servlet-class>org.apache.myfaces.trinidad.webapp.ResourceServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>resources</servlet-name> <url-pattern>/adf/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>resources</servlet-name> <url-pattern>/afr/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>resources</servlet-name> <url-pattern>/ohr/*</url-pattern> </servlet-mapping>
OHWの基本構成:
OHWのフィルタを定義し、そのフィルタをFacesサーブレットにマップする必要があります。
<filter> <filter-name>OHWRCFRequestFilter</filter-name> <filter-class>oracle.help.web.rich.OHWFilter</filter-class> </filter> <filter-mapping> <filter-name>OHWRCFRequestFilter</filter-name> <servlet-name>Faces Servlet</servlet-name> </filter-mapping>
OHW-UIXサーブレット定義およびサーブレット・マッピング
既存のOHW-UIXのサーブレット定義は、OHWのクラスoracle.help.web.rich.OHWServletを使用するように変更が必要です。次に、既存のOHWサーブレット定義を変更する手順を説明します。
OHW-UIXサーブレット・インスタンス用のohw-config.xmlの場所を指定するために、OHW-UIXサーブレットに、ohwConfigFileURLという名前の<init-param>を定義します。
OHW-UIXサーブレットにURLマッピングを定義します。既存のサーブレット・マッピングを変更する必要はありません。
<load-on-startup>パラメータを指定します。
OHWでは、1つのWebアプリケーションで複数のOHWインスタンスをサポートします。次に、2つのOHWインスタンスをデプロイするweb.xmlの例を示します。
<!-- configuration for product1 help front servlet -->
<servlet>
<servlet-name>product1</servlet-name>
<servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
<init-param>
<param-name>ohwConfigFileURL</param-name>
<param-value>/helpsets/product1/ohwconfig.xml</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>resources</servlet-name>
<url-pattern>/ohr/*</url-pattern>
</servlet-mapping>
<!-- configuration for product1 help front servlet -->
<servlet>
<servlet-name>product2</servlet-name>
<servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
<init-param>
<param-name>ohwConfigFileURL</param-name>
<param-value>/helpsets/product2/ohwconfig.xml</param-value>
</init-param>
<load-on-startup>3</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>product1</servlet-name>
<url-pattern>/product1/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>product2</servlet-name>
<url-pattern>/product2/*</url-pattern>
</servlet-mapping>
