Oracle Helpのファイル形式 | ![]() 目次 |
![]() 前へ |
![]() 次へ |
トピック・ファイルは、ヘルプ・トピックのコンテンツを含むHTMLファイルです。HTMLファイルでサポートされる機能は、表示するブラウザ(またはHTML表示コンポーネント)によって異なります。
OHJの現在のリリースに同梱されているHTML表示コンポーネントは、ICEsoft Technologies社によるICEブラウザをオラクル社が変更したバージョンです。 バージョン5.01以上のICEブラウザは、HTML 4.0に準拠しており、表およびフレームの表示と、Javaアプレットの実行が可能です。しかし、標準的なICEブラウザは、完全な機能を備えたヘルプ・システムにとって重要ないくつかの機能をサポートしていません。したがってオラクル社は、ICEsoft Technologies社のライセンスを受けて、次の機能を提供するためにオラクル社が開発した規則をサポートするようにICEブラウザを変更しました。
OHJでこれらの機能が動作するには、OHJに同梱されているICEブラウザのデフォルトのバージョンを使用する必要があります。別のHTML表示コンポーネントをかわりに使用する場合、これらの機能は動作しません。また、HTMLトピック・ファイルをWebブラウザに直接表示した場合、ブラウザはこのページで宣言されているプロトコルやメタデータを認識しないため、これらの機能は動作しません。
OHWは、これらの機能をサポートします。しかしOHJと処理は異なります。OHWヘルプ・システムは、現行のどのWebブラウザでも表示できます。ブラウザはこれらの規則を直接サポートしていません。したがって、これらのカスタム機能はWebサーバーのOHWサーブレットで処理され、標準HTMLリンクおよびブラウザ固有のJavaScriptとしてユーザーの使用するブラウザに配信されます。
HTMLのターゲットへのリンク<a href="target">
は、URLを(標準的なHTMLリンクと同様に)使用するか、Oracle Helpのtopicid
プロトコルをヘルプセットのマップ・ファイルで指定されているトピックIDとともに使用して指定できます。 次に例を示します。
<a href="topicid:getting_started">Getting Started</a>
このリンクをクリックすると、Oracle Helpはマップ・ファイルを参照し、このリンクのトピックIDに関連付けられたHTMLファイルにジャンプします。
たとえば、このリンクをクリックすると、次のように定義されたトピックIDによるリンクを確認できます。
<a href="topicid:ohff_topicidex_html">this link</a>
関連リンクは、1つ以上のターゲットに関連付けられたリンクです。ユーザーがトピック内の関連リンクを選択すると、関連付けられたすべてのトピックのリストが表示され、ユーザーはトピックを1つ選択できます。
Oracle Helpは、Oracle Helpのalink
プロトコルを介して、ヘルプセットの関連リンクを定義するリンク・ファイルとあわせて関連リンクをサポートします。 たとえば、「worksheet」というキーワードに関連するすべてのトピックを表示する関連リンクは、次のように指定します。
<a href="alink:worksheet">Related Topics</a>
Oracle Helpでは、関連リンクのキーワード(この例では「worksheet」)を使用して、リンク・ファイル(またはファイル)を検索し、関連項目のリストをポップアップ・ウィンドウで表示します。この機能は、複数のヘルプセットからリンク・ファイルがマージされた場合、特に便利です。
たとえば、このリンクをクリックすると、次のように定義された関連リンクのリストが表示されます。
<a href="alink:alinkexamples">this link</a>
Oracle Help for Java 4.2.6以上では、Oracle Helpのcustom
プロトコルを介して、カスタム・プロトコルのリンクをサポートします。 たとえば、myProtocolというカスタム・プロトコルを使用したリンクは、次のように指定します。
<a href="custom:myProtocol:myValue">Link to activate custom protocol</a>
カスタム・プロトコルの定義は、ヘルプ・システムにおけるアプリケーションへのコール・バックに利用できる強力な手段です。 アプリケーション内でこうしたリンクを処理するには、CustomProtocolHandler
をHelp
インスタンスに登録します。 oracle.help.CustomProtocolHandler
の実装を作成し、registerCustomProtocolHandler
メソッドにより、この実装をoracle.help.Help
インスタンスに登録します。 このリンクの例では、String
myProtocolをregisterCustomProtocolHandler
メソッドに対する1つ目の引数として使用し、CustomProtocolHandler
のインスタンスを登録します。
Oracle Help for Javaでは、前述のようなリンクを検出した場合、識別子"myProtocol"を使用して、Help
オブジェクトに登録されたCustomProtocolHandler
を検索します。 見つかった場合、CustomProtocolHandler
のhandleValue(String value)
メソッドが起動され、値として"myValue"を渡します。
ポップアップは、Oracle Helpのpopup
プロトコルを介してサポートされています。 次に例を示します。
<a href="popup:sheetdefinition">Sheet Definition</a>
popup
プロトコルに続くキーワードは、ヘルプセットのマップ・ファイルで指定されているトピックIDです。ポップアップのリンクをクリックすると、トピックIDに関連付けられたファイルのコンテンツがポップアップ・ウィンドウに表示されます。
たとえば、このリンクをクリックすると、次のように定義されたポップアップが表示されます。
<a href="popup:ohff_popupdemo_html">this link</a>
Oracle HelpのトピックIDはマップ・ファイルで保持され、Oracle HelpがトピックIDを参照する必要がある場合、マップ・ファイルからデータを使用します。 しかし、トピック・ファイル自体からトピックIDを指定すれば、ヘルプセット・オーサリング・ウィザードを使用してその情報からマップ・ファイルを生成できます。トピック・ファイルでトピックIDを定義するには、METAタグを次の構文とともに挿入します。
<META name="topic-id" content="topic_id_name">
ここで、topic_id_name
は、マップ・ファイルで使用されるトピックIDを指定します。
注意: サード・パーティ製のオーサリング・ツールでも、マップ・ファイルを生成するためにこのMETAタグを使用できる場合があります。
ヘルプセット・ファイルには、WinTypeセクションを含めることができ、ここで1つ以上の名前の付けられたウィンドウを、サイズ、位置および背景色とともに定義できます。トピック(およびトピックID)とこのウィンドウ・タイプはマップ・ファイルで関連付けることができます。そうすることで、トピックが表示される場合は必ず指定したウィンドウに表示されます。この機能はOHJでのみ動作します。OHWでは無視されます。
ヘルプセット・オーサリング・ウィザードを使用する予定がある場合、ウィンドウ・タイプとトピックを、トピック・ファイル自体で関連付けることができます。関連付ける場合、トピックに対するトピックIDのMETAタグにトピックIDを指定する必要もあります。その後、ウィザードが両方のMETAタグから取得した情報を使用してマップ・ファイルを生成します。
ウィンドウとトピックをトピック・ファイルで関連付けるには、METAタグを次の構文とともに挿入します。
<META name="window-type" content="window_name">
ここで、window_name
は、ヘルプセット・ファイルで定義されたウィンドウの名前です。
注意:
Copyright © 1996, 2004, Oracle. All rights reserved.