Inhoudsopgavebestanden (TOC's)

Nu u een aantal voorbeeldcontentbestanden hebt, kunt u een inhoudsopgavebestand (toc) maken. In een inhoudsopgavebestand definieert u de sleutelingangspunten in de HTML-contentbestanden door een onderwerplabel (topic label) te koppelen aan een verwijzing in een van de HTML-bestanden. 

Als u toepassingen naar het platform wilt migreren, kunt u bestaande documentatie hergebruiken door ingangspunten in de documentatie te definiëren aan de hand van het inhoudsopgavebestand.

Een plugin kan een of meer inhoudsopgavebestanden hebben. Onze voorbeelddocumentatie is ingedeeld in drie hoofdcategorieën: concepten, taken en naslaginformatie. Hoe maakt u inhoudsopgavebestanden waarin deze structuur wordt weerspiegeld?

U kunt ofwel één groot inhoudsopgavebestand maken ofwel een afzonderlijk inhoudsopgavebestand voor elke hoofdcategorie maken. Kies de methode die voor u het meest geschikt is, afhankelijk van de manier waarop uw documentatieteams samenwerken. Als ieder soort documentatie door een ander team wordt geschreven, is het wellicht beter om de inhoudsopgavebestanden gescheiden te houden en per categorie in te delen. De platformarchitectuur is niet gebonden aan een methode.

In het onderstaande voorbeeld wordt voor elke hoofdcategorie een inhoudsopgavebestand gemaakt. Bij een dergelijk klein aantal bestanden is het meestal niet nodig om voor elke categorie een afzonderlijk inhoudsopgavebestand te maken. Voor dit voorbeeld doen we echter alsof we veel meer bestanden of voor elke contentcategorie een ander team van auteurs hebben.

Onze bestanden zien er als volgt uit:

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>

Een 'topic' (onderwerp) kan bestaan uit een eenvoudige link naar content. Zo wordt bij "Task1" een label en een href-link naar de content aangeleverd. Een topic kan ook bestaan uit een hiërarchische groep van subtopics zonder dat het topic zelf aan content gekoppeld is. Zo ziet u bij "Fun Stuff" bijvoorbeeld wel een label en subtopics, maar geen href-link. U kunt ook een onderwerp hebben met een combinatie van beide. "Concept1" heeft bijvoorbeeld zowel een href-link als subtopics.

Dynamische content

Dynamische content is beschikbaar voor de inhoudsopgave in de vorm van filters en ankers. U kunt bijvoorbeeld instellen dat een onderwerp alleen in de inhoudsopgave wordt weergegeven als een bepaald besturingssysteem wordt gebruikt.

Insluitingen worden hier niet ondersteund omdat deze niet nodig zijn. In plaats daarvan gebruikt u links.