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

目次ファイル

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

要素 説明
<toc>

目次の定義。この要素には、<tocitem>要素が含まれます。<toc>要素では、次の属性がサポートされています。

version - 目次ファイルの形式の仕様のバージョン。ここで宣言されているバージョンは1.0です。

<tocitem>

目次のエントリの定義。<tocitem>要素に他の<tocitem>要素を含めてトピックの階層を作成できます。tocitem_1をtocitem_2の中にネストした場合、tocitem_1はtocitem_2の下位階層に含まれます。<tocitem>要素では、次の属性がサポートされています。

target - このアイテムがユーザーに選択された場合に表示されるトピックのトピックID。トピックIDはマップ・ファイルで保持されます。親ノード(つまり、他のアイテムを下位階層に含むアイテム)はtargetを含む場合と含まない場合があります。targetを含まない場合、このノードを選択すると、子アイテムおよび子ノードが表示されます。

text - このアイテムについて、目次に表示されるテキスト。

image - このアイテムの横に表示される画像。この属性の値は、マップ・ファイルで指定されている画像IDです。

目次ファイルの短い例を示します。


  <?xml version='1.0'?>
  <toc version="1.0">
  <tocitem text="Introduction to My Product">
    <tocitem target="aboutmyp" text="About My Product" />
    <tocitem target="architec" text="My Product Architecture" />
    <tocitem target="feature1" text="About Feature One" />
    <tocitem target="feature2" text="About Feature Two" />
    <tocitem target="feature3" text="About Feature Three" />
    <tocitem text="Learning My product">
      <tocitem target="qtour" text="Quick Tour" />
      <tocitem target="docguide" text="Guide to Documentation" />
    </tocitem>
  </tocitem>
  <tocitem text="Step-by-step Procedures">
    <tocitem text="Basic Tasks">
      <tocitem target="task1" text="To..." />
      <tocitem target="task2" text="To..." />
      <tocitem target="task3" text="To..." />
    </tocitem>
    <tocitem text="Working with ...">
      <tocitem target="task4" text="To..." />
      <tocitem target="task5" text="To..." />
    </tocitem>
  </tocitem>
  </toc>

この定義では、次のようなTOC階層が生成されます。