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

目次ファイル(.xml)

目次(TOC)ファイルでは、目次の内容およびレイアウトを指定します。このファイルはXMLを使用し、JavaHelp 1.0の仕様で規定されている目次ファイルの形式に従います。OHJの目次ファイルではxml:lang属性はサポートされないので注意してください。

目次ファイルの簡単な例を示します。

  <?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>

この定義では、次のような目次ツリーが生成されます。

  + Introduction to My Product
    o About My Product
    o My Product Architecture
    o About Feature One
    o About Feature Two
    o About Feature Three
    + Learning My Product
      o Quick Tour
      o Guide to Documentation
  + Step-by-step Procedures
    + Basic Tasks
      o To ...
      o To ...
      o To ...
    + Working with ...
      o To ...
      o To ...

目次ファイルのタグ

OHJでサポートされている目次ファイルのタグは、次のとおりです。

タグ 説明
<toc> 目次の定義。<tocitem>タグを含みます。
<tocitem> 目次のエントリの定義。エントリ1をエントリ2の中にネストした場合、エントリ1はエントリ2の下位階層に含まれます。target属性で、エントリを選択した際に表示されるコンテンツ・ファイルのトピックIDを指定します。

IDは、マップ・ファイルで(URLに関連付けて)定義します。image属性がサポートされています。image属性では、マップ・ファイルで定義した画像ファイルと関連付けられたIDを指定します。JavaHelp 1.0の仕様で規定されているxml:lang属性は、OHJではサポートされていないため、無視されます。


  Previous topic
前へ
Next topic
次へ