| Oracle® Fusion Middleware Oracle Helpによるヘルプ・システムの開発 12c (12.2.1.2.0) E82760-01 |
|
 前 |
 次 |
この章では、Oracle Help for the Webのユーザー・インタフェース・コンポーネントについて説明します。このコンポーネントには、グローバル・ツールバーやトピック・ナビゲータ、索引ナビゲータ、検索ナビゲータなどがあります。
この章には、次のセクションがあります。
Oracle Help for the Web (OHW)のユーザー・インタフェースは、OHJと同じ機能を提供します。ただし、OHWはWebアプリケーションであるため、外観および動作の一部に違いがあります。
図3-1に、Webブラウザに表示されたOHWを示します。
図3-1の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
ナビゲータ領域: ページの左端にある領域で、アコーディオン方式が使用されます。各アコーディオン・パネルが1つのナビゲータを表します。OHWフレームワークには、3つの標準ナビゲータ(「目次」、「索引」および「検索」)があります。OHWインスタンスのナビゲータの正確なセットは、ヘルプセット定義ファイル(.hsファイルなど)によって動的に決まります。
ブランド領域: リッチ・クライアント・インタフェースの上部にある領域で、テキスト、イメージまたはその両方を追加できます。通常、この領域では、ヘルプ・コンテンツが特定されるか、または社名やロゴなどの会社情報が表示されます。
ツールバー領域: ブランド領域の下に位置します。メイン・メニュー項目、ヘルプセット・スイッチャ(該当する場合)およびクイック検索コントロールを表示します。
トピック表示領域: ナビゲータ領域のいずれかのタブでトピックを選択すると、そのトピックのコンテンツがこの領域に表示されます。
ブランド領域を除いて、これらの要素はヘルプセット・ファイルで構成されています。OHWとOHJは、ヘルプセット・ファイルを含め、まったく同じファイル形式を使用します。そのため、既存の制御ファイルを変更することなく、既存のOHJヘルプ・システムをOHWシステムとしてデプロイできます。
OHWシステムのデプロイの詳細は、第16章「OHWデモ・ファイルのデプロイ」を参照してください。
リッチ・クライアントの上部領域には、ヘルプセット・スイッチャ(該当する場合)、クイック検索コントロール、ページの領域を操作する「表示」メニューおよびツールバーがあります。
図3-2の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
ヘルプセット・スイッチャ: OHWアプリケーションで定義されるすべてのヘルプセットを含むドロップダウン・リスト。現在開いているヘルプセットがドロップダウン・ボックスに表示され、ユーザーはこのリストを使用して別のヘルプセットに切り替えることができます。ヘルプセット・スイッチャは、複数の独立したコンテンツのセットがあり、ohwconfig.xmlファイルのcombineBooksパラメータがfalseに設定されている場合のみ表示されます。
ヘルプセット内検索: 検索ナビゲータに切り替えることなくクイック検索を実行するためのクイック検索コントロールです。この検索のデフォルトの検索オプションは、大文字/小文字の区別なし、すべての語およびすべてのソースに設定されています。検索ナビゲータが複数ある場合、クイック検索コントロールは表示されません。ヘルプセット・ファイルに、oracle.help.navigator.searchNavigator.SearchNavigatorタイプのナビゲータのビューが複数含まれている場合、複数の検索ナビゲータが存在することがあります。
表示: このメニューには、ヘルプセットの表示および移動を制御するためのコマンド・メニュー項目のリストが表示されます。コマンド項目は、次のように類似した機能ごとにグループ化されています。
「読取りペインの最大化」は、ナビゲータ・ペインの展開または縮小を切り替えます。
「デフォルトのウィンドウ・レイアウトの復元」は、ペインをデフォルトのレイアウトで再配置します。
ナビゲータ項目セクションには、使用可能なすべてのナビゲータ・ペイン(「目次」、「索引」、「検索」およびカスタム・ナビゲータ(該当する場合))に移動するためのコマンド項目が含まれます。
このトピック・ページのブックマーク可能なリンクの表示は、現在のトピックの永続リンクを含むポップアップを表示します。これを使用してブックマークを作成できます。
ツールバーには次のボタンが含まれています。
前のトピックに戻る: 以前表示したトピックを再度開きます。
次のトピックに進む: このトピックの前に表示していたトピックを再表示します。
このトピック・ページの印刷: 現在のトピックを印刷します。
このトピック・ページへのEメール・リンク: デフォルトの電子メール・アプリケーションを開き、現在のトピックのURLをメッセージ本文に、トピック・タイトルを件名フィールドにコピーします。
このトピック・ページの永続リンクの表示は、現在のトピックの永続リンクを含むポップアップを表示します。これを使用してブックマークを作成できます。
また、ペインの縮小ボタンを使用すると、ツールバーを非表示にしてトピック・ペインを最大化します。
「目次」ナビゲータには、トピックが階層ツリー形式で表示されます。ツリーのコンテンツと構造により、ロードされたヘルプセットに目次ビューのマージされたデータが表示されます。ユーザーは、ツリーのブランチの展開や折りたたみを行い、リーフ(およびトピックが関連付けられているブランチ)を選択できます。リーフや、トピックが関連付けられているブランチを選択すると、トピックが右側のトピック・ペインに表示されます。必要に応じてスクロール・バーが表示されます。「目次」ナビゲータに目次が表示されない場合、グローバル・ツールバーの「表示」メニューを使用してタブに移動します。
「目次」ナビゲータは、トピック・ペインに表示されるトピックと常に同期します。たとえば、トピック内のリンクをクリックして別のトピックにジャンプすると、新しいトピックが「目次」タブで自動的に強調表示されます。ユーザーがナビゲータを切り替えた場合でも、「目次」タブの状態は維持されます。たとえば、ユーザーがトピックを選択して「索引」ナビゲータに切り替えてから再度戻した場合(他のトピックは開かない)、選択したトピック、スクロール位置、およびツリーの展開状態は変わりません。これは、自動同期化機能で有効になります。ポップアップ・メニューには、ヘルプセットの表示および移動を制御するためのコマンド・メニュー項目のリストが表示されます。選択できる項目は次のとおりです。
このページの印刷: 選択されたトピックのコンテンツを印刷します。
このページをEメールで送信: デフォルトの電子メール・アプリケーションを開き、現在のトピックのURLをメッセージ本文に、トピック・タイトルを件名フィールドにコピーします(グローバル・ツールバーからも使用できます)。
このページへのリンク: 選択されたトピックの永続リンクを含むポップアップを表示します。これを使用してブックマークを作成できます(グローバル・ツールバーからも使用できます)。
展開: ツリーを展開し、選択されたノードの子トピックを表示します。
縮小: ツリーを縮小し、選択されたノードの子トピックを非表示にします。
下をすべて展開: 選択されたノードの下にあるすべてのノードを開いて関連する子トピックを表示します。
下をすべて縮小: 選択されたノードの下にあるすべてのノードを閉じて関連する子トピックを非表示にします。
先頭として表示: 現在のノードをツリーのルートとして表示します。
「索引」ナビゲータには、ソートされたキーワード・リストが、2レベルの階層で表示されます。1つのキーワードを複数のトピックに関連付けることができます。階層では、子項目はインデント表示されます。
図3-4の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
キーワードに移動: このフィールドに単語(複数可)を入力します。ユーザーが入力すると、リスト内のキーワードのうち、入力された文字列に一致する最初のキーワードが選択されます。入力する文字が多いほど、より正確な選択が行われます。または、単にキーワードのリストからキーワードを選択できます。
キーワード・リスト: 2レベルのリストに、キーワードがロケール依存の順序で表示されます。リスト内のキーワードを選択すると、関連付けられているトピックがトピックのリストに表示されます。
トピック・リスト: このリストには、キーワード・リストで選択されたキーワードに関連付けられている各トピックのタイトルおよびソースが表示されます。タイトルの1つを選択すると、トピック・ペインにそのトピックが表示されます。「トピック」列および「ソース」列の両方をアルファベットの昇順または降順にソートできます。
「検索」ナビゲータには、全文検索の問合せを実行するユーザー・インタフェースが用意されています。検索文字列として複数の語を入力できます。
図3-5の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
検索テキスト: ユーザーは単語(複数可)をこのフィールドに入力します。完全一致する句を検索する場合は、検索対象の句を二重引用符で囲みます。
また、検索文字列内にワイルドカード文字(*)を使用することもできます。ワイルドカード文字(*)は、文字列の間や文字列の末尾に使用することはできますが、文字列の先頭に使用することはできません。たとえば、John*DoeとJohn*は有効な検索文字列ですが、*Doeは無効な検索文字列です。
ソース: 検索対象のソース・トピックのセットを指定するドロップダウン・リストです。
検索オプション: このドロップダウンで、指定された語のいずれか、またはすべてを含むトピックを表示するように指定できます。また、ブール式(AND、OR)を使用して検索を実行するように指定できます。
大/小文字の区別: このチェック・ボックスを選択すると、ユーザーが入力した語と大/小文字が一致する語を検索できます。
トピック・リスト: 検索条件に一致する各トピックの「トピック・タイトル」、「スコア」および「ソース」を表示する検索結果領域です。「スコア」列には、検索条件との一致率に応じたトピックのランキングが表示されます。すべての列をアルファベットの昇順または降順にソートできます。デフォルトでは、すべてのトピックが「スコア」でソートされています。項目の上にマウスを置くとツールチップが表示され、関連するフォルダ、トピックおよびソース・データのフルネームが示されます。ユーザーが特定の結果を選択すると、関連付けられているトピックがトピック・ペインに表示されます。
Oracle Help for the Webには、単語の位置情報をIDXファイルに追加する、Oracle Help全文検索インデクサが組み込まれています。Oracle Help全文検索インデクサにより、完全一致する句の検索が可能になり、検索結果のランキング・メカニズムが向上します(相互に類似した検索語が検出された場合は高いポイントが与えられます)。完全一致する句を検索する場合は、その句を二重引用符で囲みます。たとえば、"John Doe"のようにします。
Oracle Help for the Webは、以前のバージョンのOracle Help Indexerで作成されたIDXファイルも読み取ることができます。また、古いIDXファイルと新しいIDXファイルの両方を必要に応じて一緒に使用できます。以前のリリースのOHJまたはOHWの新しいインデクサで作成されたIDXファイルの使用はサポートされません。使用すると、IDXバージョンがサポートされないことを示すSearchException例外のログが記録されます。
|
注意: Oracle Help全文検索インデクサで作成したIDXファイルには、下位互換性がありません。現在のインデクサで作成したIDXファイルを、古いバージョンのOracle Help for the Webで使用すると、インデクサでエラーが発生します。 |
トピック・ペインには、HTMLヘルプ・コンテンツが表示されます。
トピック・ペインには、現在表示されているトピックを操作するための固有のツールバーがあります。図3-6の番号付きコールアウトは、次のユーザー・インタフェース・コンポーネントを示しています。
ページ内で検索: このフィールドに、トピック・コンテンツ内で検索する特定のテキストを入力します。
次へ: ユーザーが指定したテキストと一致する次の出現箇所を検索します。見つかった場合は、一致する箇所が選択されます。
前へ: ユーザーが指定したテキストと一致する前の出現箇所を検索します。見つかった場合は、一致する箇所が選択されます。
トピック・ペイン: このペインにヘルプ・コンテンツが表示されます。
このマニュアル以外では説明されていないOHW機能には次のようなものがあります。
OHWバージョン情報機能では、OHWヘルプ・システムについての情報、オラクル社のコピーライト情報および使用するOHWのビルド情報が表示されます。
|
注意: Oracle Help for Javaでは、request問合せパラメータaboutOHWを使用することで、OHWバージョン情報機能をサポートします。 |
OHWバージョン情報ページを表示するには、次のURLに移動します。
http://localhost:<port_number>/<help ohw-rcf context-root>/faces/helppages/main.jspx?config=OHW+Servlet+1&aboutOHW=true
このURLに移動すると、トピック・ペインに、現在使用しているOHWのビルド情報と、コピーライト情報が表示されます。
ブックマークにページを登録すると、そのブックマークに移動したときに同じトピックが表示されます。また、URLリンクを保存して、そのリンクを電子メールで送信することもできます。ブックマーク機能については、次の点に注意してください。
ページをブックマークに登録するには、グローバル・ツールバーの「このトピック・ページの永続リンクの表示」ボタンを使用する必要があります。これにより、リッチ・クライアントのURLがブックマーク可能なURLにリフレッシュされます。ユーザーは、ブラウザのブックマーク登録機能を使用してURLを保存できます。
「索引」および「検索」ナビゲータの状態は、ブックマーク情報に含まれません。「目次」ナビゲータは、表示されるトピックと自動的に連動します。
ユーザーは、URLを変更すると、現在のトピックを単一ペイン・レイアウトで表示できます。
次に例を示します。
topicId
http://localhost:7101/help-ohw-rcf-context-root/ohguide/?topic=ohg_about_about_html&linkHelp=false
vtTopicFile
http://localhost:7101/help-ohw-rcf-context-root/ohguide/?vtTopicFile=ohguide/ohg_about_about.html&linkHelp=false
