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

索引ファイル

索引ファイルは、索引のナビゲータ(通常「索引」タブとしてレンダリングされる)に対して、索引の内容およびレイアウトを指定するXMLファイルです。次の表では、索引ファイルで使用される要素を説明します。

要素 説明
<index> 索引の定義。<indexitem>タグおよび<indexentry>タグを含めることができます。
<indexitem> キーワード・リストに表示される索引項目の定義。index_item_1をindex_item_2の中にネストした場合、index_item_1はindex_item_2の下位階層に含まれ、索引ではindex_item_2の下にインデントして表示されます。Oracle Helpで現在サポートされているキーワードは、2レベルまでです。2レベルを超えてネストされた索引項目があると、索引表示は正常に表示されません。

特定の索引項目に、複数のトピックを関連付ける必要がある場合、これらのトピックは<indexentry>要素で定義される索引エントリとしてリストする必要があります。

<indexitem>要素には、次の属性があります。

target - エントリを選択した際に表示されるトピックのトピックID(マップ・ファイルで定義)。

<indexentry> キーワード・リストで親の索引項目が選択された際に、トピック・リストに表示される索引エントリの定義。このタグには次の属性を使用します。

target - エントリを選択した際に表示されるトピックのトピックID(マップ・ファイルで定義)。

この例では、短い索引ファイルを定義します。


  <?xml version='1.0' ?>
  <index version="1.0">

  <indexitem target="Add_Icon"
      text="Add Icon Command">
    <indexitem target="addtosheet"
        text="Adding an icon to a sheet />
    <indexitem target="addtoworkbook"
        text="Adding an icon to a workbook" />
  </indexitem>

  <indexitem target="Sheet_Background"
       text="Adding a background to a sheet" />

  <indexitem text="Adding a new sheet to a workbook">
    <indexentry target="New_Sheet_command"
        text="New Sheet Command />
    <indexentry target="Add_new_sheet"
        text="To add a new sheet to a workbook" />
  </indexitem>

  <indexitem target="Add_item_to_sheet"
      text="Adding an item to a sheet" />
  </index>

この例のファイルにより、次の索引リストが作成されます。

  Add Icon Command
    Adding an icon to a sheet
    Adding an icon to a workbook
  Adding a background to a sheet
  Adding a new sheet to a workbook
  Adding an item to a sheet

ユーザーがこのリストから「Adding a new sheet to a workbook」を選択した場合、次のトピックのリストが表示されます。

  New Sheet Command
  To add a new sheet to a workbook

このトピック・リストは、索引ペイン上部のキーワード・リスト内にインデントして表示されるトピック(「adding an icon to a sheet」および「adding an icon to a workbook」)とは別に、索引ペインの下部(トピック・リスト)に表示されます。

索引エントリを持たず、ターゲットが直接関連付けられているキーワード(「adding an item to a sheet」など)の場合、トピック・リストにもキーワード・リストと同じテキストが表示されます。Oracle Helpにおいて索引が表示される方法により、<indexitem>タグ内ではtargetを使用せず、かわりに<indexentry>タグを使用して<indexitem>に関連付けるトピックを指定する方が使用しやすくなります(そのキーワードのターゲットが1つのみの場合も同様です)。

つまり、


  <indexitem text="sheet backgrounds">
    <indexentry target="Sheet_Background"
        text="adding a background to a sheet" />
  </indexitem>

とすると、次のように指定するより使用しやすくなります。


  <indexitem target="Sheet_Background"
      text="adding a background to a sheet" />