Tartalomjegyzék (toc) fájlok

Most, hogy már rendelkezünk példa tartalomfájlokkal, létrehozhatunk egy tartalomjegyzék (toc) fájlt. A toc fájl megadja a HTML tartalomfájlok fontos belépési pontjait a témakörcímke hivatkozásra leképezésével a HTML fájlok egyikében. 

A platformra átállítandó alkalmazások újból használhatják a meglévő dokumentációt úgy, hogy a toc fájl segítségével hivatkozási pontokat adnak meg ebben a dokumentációban.

A bedolgozó egy vagy több toc fájlt tartalmazhat. A példadokumentáció három fő kategóriába van szervezve: alapelvek, feladatok és hivatkozás. Hogyan hozható létre a struktúrát ábrázoló toc fájl?

Létrehozhatunk egy nagy toc fájlt, vagy létrehozhatunk egy különálló toc fájlt a tartalom összes fő kategóriájához. Ezt a döntést a dokumentációs csapat együttműködési módjának megfelelően kell meghozni. Ha minden kategória más szerző birtokában van, akkor érdemesebb lehet külön toc fájlt tárolni minden kategóriához. Ezt a platformarchitektúra nem írja elő.

Ebben a példában minden fő tartalomkategóriához létrehozunk egy toc fájlt. Ilyen kisszámú fájl esetén minden kategóriához különálló toc fájlra lehet szükség. Ezt a példát hozzuk létre, ha számos fájl áll rendelkezésre, vagy külön szerzők birtokolják a tartalomkategóriát.

A fájlok az alábbi módon néznek ki:

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>

A témakör lehet egy egyszerű tartalomra mutató hivatkozás.  A "Task1" például egy címkét és egy href hivatkozást biztosít a tartalomhoz.  A témakör lehet a témakörök egy hierarchikus csoportosítása saját tartalom nélkül. A "Fun Stuff" például csak egy címkével és egy altémakörrel rendelkezik, href-fel nem. A témakörök mindegyiket végrehajthatják.  "Concept1" rendelkezik egy href-fel és altémakörökkel.