この章では、Oracle Help for Java (OHJ)およびOracle Help for the Web (OHW)で使用する、各種のファイル形式(メタデータ・ファイル、情報ファイル、トピック・ファイルなど)について説明します。
この章の構成は、次のとおりです。
Oracle Help for Java (OHJ)およびOracle Help for the Web (OHW)では、次の種類のファイルを使用します。
メタデータ・ファイル: ヘルプ・システムの構造および動作に関する情報が含まれます。詳細は、第5章「メタデータ・ファイル」を参照してください。
ヘルプ情報ファイル: ヘルプ・システムのコンテンツに関する情報が含まれます。詳細は、第6章「ヘルプ情報ファイル」を参照してください。
トピック・ファイル: ヘルプ・システムのコンテンツが含まれるHTMLファイルです。詳細は、第7章「トピック・ファイル」を参照してください。
OHWでは、これらのファイルに加えて、サーブレット・フィルタを構成する構成ファイルも使用します。詳細は、第8章「Oracle Help for the Web構成ファイル」を参照してください。
Oracle Helpのファイル形式は、JavaHelp (tm)の仕様に基づいています。Java HelpとOracle Helpのファイル形式の相違点については、付録A「Oracle HelpおよびJavaHelpのファイル形式」を参照してください。
ヘルプセットを使用する場合、関連する制御ファイルの名前に、指定された拡張子を使用する必要はありません。ただし、ファイルの参照時には、正しいファイル名と拡張子が使用されていることを確認する必要があります。
表4-1に、ヘルプセットに関連するファイル形式の標準的な拡張子(必須ではない)を示します。また、正しい名前と拡張子を使用していることを確認できるように、これらのファイルが参照されている場所も示します。
表4-1 OHJおよびOHWのファイル
ファイルのタイプ | 標準的な拡張子 | 参照元 |
---|---|---|
ヘルプセット |
|
OHJの場合: ヘルプを起動するJavaプログラムからのコール。 OHWの場合: 構成ファイルの次の場所 <books> <helpSet location="filename.hs" /> </books> |
サブヘルプセットとして使用されるヘルプセット |
|
次の場所にあるマスター・ヘルプセット・ファイル <subhelpset location="filename.hs"/> |
マップ |
|
次の場所にあるヘルプセット・ファイル <maps> <mapref>filename.xml</mapref> </maps> |
TOC |
|
次の場所にあるヘルプセット・ファイル <maps> <view> <data engine="oracle.help.engine.XMLTOCEngine">filename.xml</data> </view> |
キーワード索引 |
|
次の場所にあるヘルプセット・ファイル <view> <data engine="oracle.help.engine.XMLIndexEngine">filename.xml</data> </view> |
リンク |
|
次の場所にあるヘルプセット・ファイル <links> <linkref>filename.xml</linkref> </links> |
検索索引 |
|
次の場所にあるヘルプセット・ファイル <view> <data engine="oracle.help.engine.SeearchEngine">filename.idx</data> </view> |