Soubory s obsahem

Teď, když máme své soubory se vzorovým obsahem, můžeme vytvořit soubor s obsahem (toc). Soubor s obsahem definuje klíčové vstupní body do souborů obsahujících HTML mapováním popisu tématu na odkaz v jednom ze souborů HTML. 

Aplikace převedené migrací do platformy mohou znovu využít stávající dokumentaci pomocí souboru s obsahem k definici vstupních bodů do takové dokumentace.

Modul plug-in může mít jeden nebo více souborů s obsahem. Dokumentace v našem příkladu je uspořádána do tří hlavních kategorií: koncepty, úlohy a odkazy. Jak připravíme soubory s obsahem, aby reprezentovaly tuto strukturu?

Mohli bychom vytvořit jeden rozsáhlý soubor s obsahem, nebo bychom mohli vytvořit oddělené soubory s obsahem pro každou hlavní kategorii obsahu. Toto rozhodnutí by se mělo udělat v souladu s tím, jakým způsobem společně pracuje váš dokumentační tým. Pokud různí autoři vlastní různé kategorie, bylo by výhodnější ponechat pro každou kategorii oddělené soubory s obsahem.  Není to diktováno architekturou platformy.

V tomto příkladu vytvoříme soubor s obsahem pro každou hlavní kategorii obsahu. Pro takový malý počet souborů nemusí být nezbytné mít oddělené soubory s obsahem pro každou kategorii.  Sestavíme ale tento příklad tak, jako bychom měli mnohem více souborů nebo samostatné autory vlastnící jednotlivé kategorie obsahu.

Naše soubory vypadají takto:

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>

Téma může představovat jednoduchý odkaz na obsah.  Například "Úloha1" obsahuje label a odkaz href vedoucí k obsahu.  Téma může také být hierarchickým seskupením vnořených témat bez obsahu jako takového.  Například "Fun Stuff" má pouze label a vnořená témata, ale žádný odkaz href .  Témata mohou také představovat obojí.  "Koncept1" má href i vnořená témata.