Oracle Help for Javaのファイル形式 Previous topic
前へ
Next topic
次へ

トピック・ファイル

トピック・ファイルは、ヘルプ・トピックのコンテンツを含むHTMLファイルです。Oracle Help for Javaで使用されるトピック・ファイルでは、次の機能がサポートされています。

現時点で、Oracle Help for Javaに同梱されているヘルプ表示コンポーネントは、ICESoft ASのICEブラウザです。バージョン5.01以上のICEブラウザは、HTML 4.0に準拠しており、表およびフレームの表示と、Javaアプレットの実行が可能です。トピックIDによるリンク、関連リンク、ポップアップおよびウィンドウ・タイプをサポートするには、OHJ固有のHTML規則が必要になります。

トピックIDによるリンク

ICEブラウザ版のOHJでは、ハードコードされたHTMLファイル名またはトピックIDで指定されたリンクがサポートされています。次に例を示します。

  <a href="topicid:topic1">Link to Topic 1</a>

このリンクをクリックすると、OHJではヘルプセットのマップ・ファイル情報を参照し、このリンクのトピックIDに関連付けられたHTMLファイルにジャンプします。

たとえば、このリンクをクリックすると、次のように定義されたトピックIDによるリンクを確認できます。

  <a href="topicid:ohff_topicidex_html">このリンク</a>

関連リンク

ほとんどのHTMLヘルプ・オーサリング・ツールでは、関連項目へのリンクをサポートするためにappletタグを生成します。OHJリリース3.1では、関連リンクはリンク・プロトコルを介してサポートされます。たとえば、「worksheet」というキーワードに関連するすべてのトピックを表示する関連リンクは、次のように指定します。

  <a href="alink:worksheet">Related Topics</a>

OHJでは、関連リンクのキーワード(この例では「worksheet」)を使用して、マージされたリンク・ファイルを検索し、関連項目のリストをポップアップ・ウィンドウで表示します。この機能は、ICEブラウザ版のOHJでのみ機能します。他のHTML表示エンジンを使用するシステムでは、関連項目の表示にアプレットを使用する必要があります。

たとえば、このリンクをクリックすると、次のように定義された関連リンクのリストが表示されます。

  <a href="alink:alinkexamples">このリンク</a>

ポップアップ

ICEブラウザ版のOHJでは、ヒントや用語の定義に便利なポップアップがサポートされています。

次に例を示します。

  <a href="popup:sheetdefinition">Sheet Definition</a>

popupに続くキーワードには、トピックIDを指定します。ポップアップのリンクをクリックすると、マップ・ファイルで定義したトピックIDに関連付けられたファイルの内容が、ポップアップ・ウィンドウに表示されます。例として、このリンクをクリックしてください。

トピックID

トピックIDとマップ・ファイルの生成をサポートするために、各HTMLコンテンツ・ファイルでMETAタグを使用する場合があります。topic-idというMETAタグでは、このトピックのトピックIDを指定します。

次に例を示します。

  <META name="topic-id" content="topic1">

OHJで提供されるAuthoring Wizardを使用してこのファイルを処理した場合、トピックIDが読み取られ、トピックIDと実際のトピック・ファイル名が関連付けられて、マップ・ファイルが作成されます。詳細は、「マップ・ファイル(.xml)」を参照してください。

ウィンドウ・タイプ

OHJでは、トピックとウィンドウ・タイプを関連付ける際にもマップ・ファイルが使用されます。ウィンドウ・タイプのオーサリングをサポートするために、各HTMLコンテンツ・ファイルでMETAタグを使用する場合があります。window-typeというMETAタグでは、このトピックのウィンドウ・タイプを指定します。次に例を示します。

  <META name="window-type" content="tutorial">

Authoring Wizardを実行すると、トピックIDのMETAタグとともにウィンドウ・タイプが読み取られ、それを使用してマップ・ファイルが作成されます。詳細は、「ヘルプセット・ファイル(.hs)」<wintype>セクション」や、「トピックID」および「マップ・ファイル(.xml)」などを参照してください。

旧リリースのOHJでは、OHJの表示エンジンが実際にMETAタグを読み取り、使用していることに注意してください。現在の仕様は変更されており、この情報はマップ・ファイルで集中管理されています。


  Previous topic
前へ
Next topic
次へ