目录(toc)文件

由于我们已经有了样本内容文件,所以可以创建目录(toc)文件了。目录文件通过将主题标签映射至其中一个 HTML 文件中的引用来将键入口点定义到 HTML 内容文件中。 

迁移到平台的应用程序可以通过使用目录文件来将入口点定义到该文档中来重用现有文档。

插件可以具有一个或多个目录文件。我们的示例文档分成三个主要类别:概念、任务和引用。如何生成表示此结构的目录文件?

可以生成一个大型目录文件,也可以为每种主要内容类别创建单独的目录文件。应当根据文档小组在一起工作的方式来作出决定。如果每个类别由不同的作者所有,则为每个类别保存单独的目录文件可能会更可取。它不是由平台体系结构来控制的。

在此示例中,将为每个主要的内容类别创建目录文件。对于这样的少量文件,可能不需要让每个类别具有单独的目录文件。我们将构建此示例,并假设我们还有许多文件或者有拥有每个内容类别的不同作者。

我们的文件为如下所示;

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”提供标签,而 href 链接至内容。主题也可能是本身没有内容的子主题的层次结构组合。例如,“Fun Stuff”只有标签和子主题,没有 href。主题也可以两者都是。“Concept1”就具有 href 和子主题。