ナビゲーション・ヘッダーをスキップ
Oracle Helpのファイル形式 Table of Contents
目次
Previous topic
前へ
Next topic
次へ

ファイルについて

Oracle Help for Java(OHJ)とOracle Help for the Web(OHW)では、どちらも次のファイル使用します。

次のメタデータ・ファイルでは、ヘルプ・システムの構造および操作に関する情報を提供します。

次のヘルプ情報ファイルには、ヘルプ・システムのコンテンツに関する情報が含まれます。

トピック・ファイルは、ヘルプ・システムのコンテンツを含むHTMLファイルです。トピック・ファイルで使用される機能には、トピックIDによるリンク、関連リンク、ポップアップ、トピックIDおよびウィンドウ・タイプがあります。

これらのファイルに加えて、OHWではOHWサーブレットを構成するためのOHW構成ファイルを使用します。

Oracle Helpのファイル形式は、Sun社のJavaHelp 1.0の仕様に基づいています。詳細は、「JavaHelpのファイル形式との比較」を参照してください。

ファイル名の拡張子について

初期リリースのOHJではHelpBookが使用されていましたが、現在のリリースのOracle Helpでは、ヘルプセットが推奨されています。 (OHJをプログラミングする際のHelpBookとヘルプセットの違いの詳細は、「ヘルプ・データの追加」を参照してください。 HelpBookおよびヘルプセットを使用するOHWの構成の詳細は「OHW構成ファイル」を参照してください。)

HelpBookを使用する場合は、OHJでもOHWでも、サポートされているファイル形式に対応する拡張子(TOC、TOK、HHC、HHK、OHTおよびIDX)の付いたファイルが、指定したディレクトリ内で検索されます。Oracle Helpでは、今でもHelpBookとそれに関連付けられたファイル形式がサポートされています。OHJまたはOHWでHelpBookを使用する場合、制御ファイルには適切な拡張子を使用する必要があります。

ヘルプセットを使用する場合、対応する制御ファイルの名前に特定の拡張子を使用する必要はありません。ただし、そのファイルを参照する際には必ず正しいファイル名(拡張子を含む)を使用する必要があります。次の表は、ヘルプセットに関連付けられているファイル形式の慣用的な(必須ではない)拡張子を示したものです。正しいファイル名および拡張子が使用されていることを確認できるように、これらのファイルを参照している場所も示してあります。

ファイル・タイプ 慣用的な拡張子 参照されている場所
ヘルプセット .hs

OHJでは、ヘルプを起動するJavaプログラムからのコール。

OHWでは、OHW構成ファイルの次のセクション。


<books>
 <helpSet location="filename.hs" />
</books>
サブヘルプセットとして使用されるヘルプセット .hs マスター・ヘルプセット内の次の記述
<subhelpset location="filename.hs"/> 
マップ .xml ヘルプセット・ファイル内の次の記述
<maps>
  <mapref>filename.xml</mapref>
</maps>
  
目次 .xml ヘルプセット・ファイル内の次の記述
<view>
  <data engine="oracle.help.engine.XMLTOCEngine">filename.xml</data>
</view>
索引 .xml ヘルプセット・ファイル内の次の記述
<view>
  <data engine="oracle.help.engine.XMLIndexEngine">filename.xml</data>
</view>
リンク .xml ヘルプセット・ファイル内の次の記述
<links>
  <linkref>filename.xml</linkref>
</links>
検索インデックス .idx ヘルプセット・ファイル内の次の記述
<view>
  <data engine="oracle.help.engine.SEearchEngine">filename.idx</data>
</view>