Dateien für Inhaltsverzeichnis (Table of Contents, toc)

Nachdem die Beispielinhaltsdateien fertig gestellt worden sind, können Sie jetzt eine Datei mit einem Inhaltsverzeichnis (TOC) erstellen. Eine TOC-Datei definiert die Schlüsseleingangspunkte in die HTML-Inhaltsdateien, indem einem Verweis in einer der HTML-Dateien eine Themenbezeichnung zugeordnet wird. 

Anwendungen, die auf die Plattform migriert werden, können vorhandene Dokumentation erneut verwenden, wenn in der TOC-Datei Eingangspunkte in diese Dokumentation definiert werden.

Ein Plug-in kann über eine oder mehrere TOC-Dateien verfügen. Die Beispieldokumentation ist in drei Hauptkategorien unterteilt: Konzepte, Tasks und Referenzinformationen. Diese Struktur soll nun in den TOC-Dateien dargestellt werden.

Zu diesem Zweck könnten Sie entweder eine große TOC-Datei oder aber separate TOC-Dateien für jede Hauptkategorie des Inhalts erstellen. Die Entscheidung sollte darauf basieren, wie Ihre Dokumentationsteams zusammenarbeiten. Wenn jede Kategorie einen anderen Autor hat, kann es sinnvoll sein, für jede Kategorie separate TOC-Dateien beizubehalten.  Vorgegeben wird dies durch die Plattformarchitektur jedoch nicht.

Im Beispiel wird für jede Hauptkategorie des Inhalts eine TOC-Datei erstellt. Bei so wenigen Dateien ist es möglicherweise nicht erforderlich, separate TOC-Dateien zu verwenden. Die Erstellung im Beispiel erfolgt so, als ob weitaus mehr Dateien oder separate Autoren für jede Inhaltskategorie vorhanden wären.

Die Dateien sehen so aus:

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="Vollständiger Inhalt">
         <topic label="Task1" href="html/tasks/task1.html"/>
         <topic label="Task2" href="html/tasks/task2.html"/>
      </topic>
      <topic id="funTasks" label="Wissenswertes" >
         <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>

Ein Thema kann ein einfacher Link zu Inhalt sein.  Beispielsweise liefert "Task1" einen Kennsatz für eine href-Verbindungsfunktion zum Inhalt.  Ein Thema kann auch eine hierarchische Gruppierung von Unterthemen ohne eigenen Inhalt sein.  So hat beispielsweise "Fun Stuff" nur einen Kennsatz und Unterthemen, aber kein Attribut href.  Themen können auch beide Funktionen ausführen.  "Concept1" verfügt über ein Attribut href und Unterthemen.