目次 (toc) ファイル

サンプルのコンテンツ・ファイルを作成したら、目次 (toc) ファイルを作成することができます。 toc ファイルは、HTML コンテンツ・ファイルのうちの 1 つの参照にトピック・ラベルをマッピングすることによって、 キー・エントリー・ポイントをそれらの HTML ファイルに定義します。 

プラットフォームに移行されるアプリケーションは、toc ファイルを使用して既存のドキュメンテーションにエントリー・ポイントを定義することによって、 そのドキュメンテーションを再利用することができます。

プラグインは 1 つ以上の toc ファイルを持つことができます。 サンプルのドキュメンテーションは、概念、タスク、および参照という 3 つの主要カテゴリーに編成されます。 この構造を表す toc ファイルを作成するにはどのようにすればよいのでしょうか?

1 つの大きな toc ファイルを作成するか、または主要なコンテンツ・カテゴリーごとに個別の toc ファイルを作成することができます。 ドキュメンテーション・チームの共同作業の仕方に従って、この決定を下す必要があります。 所有する作成者がカテゴリーごとに異なる場合は、カテゴリーごとに個別の toc ファイルを保持することが望ましいでしょう。  これはプラットフォームのアーキテクチャーによっては決定されません。

次の例では、主要なコンテンツ・カテゴリーごとに toc ファイルを作成します。 このようにファイル数が少ない場合には、カテゴリーごとに個別の toc ファイルを持つ必要がないこともあります。  ここでは、多くのファイルがある場合か、または複数の作成者が個別にコンテンツ・カテゴリーを所有している場合を想定して、このサンプルをビルドします。

ファイルは次のようになっています。

toc_Concepts.xml

   <toc label="Concepts">
      <topic label="Concept1" href="html/concepts/concept1.html">
         <topic label="Concept1_1" href="html/concepts/concept1_1.html"/>
         <topic label="Concept1_2" href="html/concepts/concept1_2.html"/>
      </topic>
   </toc>

toc_Tasks.xml

   <toc label="Tasks">
      <topic id="plainTasks" label="Plain Stuff">
         <topic label="Task1" href="html/tasks/task1.html"/>
         <topic label="Task2" href="html/tasks/task2.html"/>
      </topic>
      <topic id="funTasks" label="Fun Stuff" >
         <topic label="Task3_1" href="html/tasks/task3_1.html"/>
         <topic label="Task3_2" href="html/tasks/task3_2.html"/>
      </topic>
   </toc>

toc_Ref.xml

   <toc label="Reference">
      <topic label="Ref1" href="html/ref/ref1.html"/>
      <topic label="Ref2" href="html/ref/ref2.html"/>
   </toc>

トピックを、コンテンツへの単純リンクにすることができます。  例えば、"Task1" は、label と、コンテンツにリンクする href を指定しています。  トピックを、それ自体のコンテンツを持たない、サブトピックの階層グループにすることもできます。  例えば、"Fun Stuff" には label とサブトピックのみが存在し、href は存在しません。  トピックは、両方を行うこともできます。  "Concept1" には href とサブトピックが存在します。

 

Copyright IBM Corporation and others 2000, 2003.