ナビゲーション・ヘッダーをスキップ
Oracle Help概要 Table of Contents
目次
Previous topic
前へ
Next topic
次へ

OHWのユーザー・インタフェースについて

Oracle Help for the Web(OHW)のユーザー・インタフェースは、Oracle Help for Java(OHJ)と同様の機能を提供します。ただし、OHWはWebアプリケーションなので、表示および動作に多少の違いがあります。

このページでは、次の項目について説明します。

OHWユーザー・インタフェースの主要部分

次の図は、WebブラウザでOHWを表示したところです。

Oracle Help for the Webのユーザー・インタフェース

OHW User Interface

番号を付けた部分のユーザー・インタフェースは、次のとおりです。

  1. ブランド領域: テキスト、画像、またはその両方を含めることができます。この領域では通常、ヘルプの目次を示すか、または名前やロゴなどの企業情報を表します。
  2. ヘルプセットの切替え: ヘルプセットが複数ある場合、ヘルプセットをマージするか、個別にここでリストするかを指定できます。
  3. タブ・バー: デフォルトのタブは、「目次」「索引」「検索」および「トピックの表示」の各タブがあります。
  4. コンテンツ領域: タブを選択すると、そのタブに関連付けられたコンテンツがこの領域に表示されます。

ブランド領域以外の要素は、ヘルプセット・ファイル(「Oracle Helpのファイル形式」を参照)内で構成されます。OHWとOHJで使用するファイル形式は、ヘルプセット・ファイルも含めてまったく同一です。したがって、既存のOHJヘルプ・システムは、既存の制御ファイルを変更することなくOHWシステムとしてデプロイできます。OHWとOHJでは、ユーザー・インタフェースが構成するためのヘルプセット・ファイルのディレクティブも共通です。ヘルプ・システムをOHWシステムとしてデプロイするには、サーブレット・エンジン(「OHWのデプロイ」を参照)を構成およびデプロイし、OHW構成ファイルを追加する必要があります。ブランド情報は、他の構成パラメータとともにこのファイル内で指定します(「OHW構成ファイル」を参照)。

OHJと比較した、標準的なOHWのタブ

OHWの標準のタブ(ナビゲータとも呼ぶ)は、「目次」「索引」「検索」および「トピックの表示」です。「目次」「索引」および「検索」の各タブは、OHJでヘルプセットのナビゲーション・ウィンドウに表示される同名のタブに対応しています。「トピックの表示」タブは、OHJのトピック・ウィンドウに相当します。

OHWのナビゲータは、現在のユーザーに対してその状態を記憶します。つまり、タブを切り替えたり、トピックから一連のリンクをたどったりした場合でも、以前に表示したタブの内容は維持されているということです。たとえば、「検索」タブで検索を実行し、見つかったトピックの1つからリンクをいくつかたどった後で「検索」タブに戻ると、最新の検索基準と検索結果が表示されたままになっています。これは、ローカル・マシンに常駐するアプリケーション(OHJなど)であれば特別な機能ではありませんが、サーバーで実行され複数のユーザーから同時にアクセスされるWebアプリケーションでは重要な機能です。

次のセクションからは、OHWのユーザー・インタフェースを、OHJと対比しながら詳細に説明します。(次からの図では、常にOHWを左側、OHJを右側に示してあります。)

OHWの目次

OHJでは目次がツリー構造で表示されますが、OHWではヘルプ・システムの階層が一連のページとして表示されます。各ページは階層の1ノードを表し、そのページにはトピックと子ノード(現在のノードの下位に当たるノード)が表示されます。トピック・タイトルを選択すると、OHWは「トピックの表示」タブに切り替わり、選択したトピックの内容がそこに表示されます。「目次」タブでノードのタイトルをクリックすると、ページがリフレッシュされ、そのノードのリストが表示されます。階層内を下位レベルにナビゲート(ドリルダウン)すると、ページ上部にナビゲーションの履歴(軌跡)がリンクとして表示されます。これは、階層内の他のレベルに戻るときに便利です。

OHWとOHJでの目次の表示

Table of Contents Tabs in OHW Table of Contents Tabs in OHJ

ナビゲーション・リンク

Navigation links ("breadcrumbs")

OHWの索引

OHWでは、索引もOHJとは若干異なります。OHJと同じように、OHWの索引にもテキスト・フィールドがあり(OHWでは「移動先」という)、索引内で検索する単語をここに入力します。OHJと異なるのは、対応する単語を表示する際に「実行」をクリック、または[Enter]を押す必要があることです。OHWでは、一度に10個までしか項目が表示されませんが、「移動先」フィールドの入力に一致する項目のリスト全体をナビゲートするコントロールもあります。(「移動先」フィールドに何も入力しない場合、キーワード・リスト全体をナビゲートできます。)

キーワードのリストから項目を選択するとページがリフレッシュされ、選択したキーワードに関連するトピックのリストが表示されます。これは、OHJで「索引」タブの下部に表示されるトピック・リストと同じものです。このリストから項目を選択すると「トピックの表示」タブに切り替わり、トピックがそこに表示されます。

索引で見つかった項目のページ上部には、目次のときと類似したナビゲーション・リンクが表示されます。ただし、このリンクからは常にキーワード・リストに戻ります。

OHWとOHJでの索引の表示

Table of Contents Tabs in OHW Table of Contents Tabs in OHJ

OHWの全文検索

OHWのテキスト検索は、索引と類似しています。「検索」テキスト・フィールドに単語または句を入力して[Enter]を押すと、関連するトピックのリストが表示されます。最初の10項目が表示されます(リストはランク順にソートされます)が、それ以上の項目もナビゲートして表示できます。検索の際には、大/小文字の区別、すべての語に一致、任意の語に一致、ブール式のオプションを指定できます。

索引のときと同じく、見つかったトピックのリストから項目を選択すると「トピックの表示」タブにトピックが表示されます。

OHWとOHJでの検索ナビゲータ

Table of Contents Tabs in OHW Table of Contents Tabs in OHJ

OHWのトピック

OHWでは、トピックは「トピックの表示」タブに表示されます。このナビゲータでは、トピックIDリンク、関連リンクおよびポップアップなど、OHJからの特殊機能がサポートされています。OHJでは、これらの機能はICEブラウザ表示エンジンによって処理されます。OHWでは、任意のブラウザで機能します。(詳細は、「トピック・ファイル」を参照してください。)

OHWとOHJでのコンテンツ(トピック)の表示

Table of Contents Tabs in OHW Table of Contents Tabs in OHJ