Nu hvor vi har et eksempel på indholdsfiler, kan vi oprette en indholdsfortegnelsesfil (toc). En indholdsfortegnelsesfil definerer hovedindgangspunkterne i HTML-indholdsfilerne ved at tilknytte en emneetiket til en reference i en af HTML-filerne vha. mapping.
Programmer, der overføres til platformen, kan genbruge eksisterende dokumentation ved at bruge toc-filen til at definere indgangspunkter i dokumentationen.
En plugin kan have en eller flere toc-filer. Dokumentationseksemplet er organiseret i tre overordnede kategorier: begreber, opgaver og reference. Hvordan kan man få toc-filerne til at repræsentere denne struktur?
Der kan oprettes en stor toc-fil eller en separat toc-fil for hver overordnet indholdskategori. Denne beslutning skal træffes i henhold til den måde, dokumentationsteamet arbejder sammen på. Hvis det er forskellige forfattere, der ejer hver sin kategori, kan det være nyttigt at have separate toc-filer for hver kategori. Det dikteres ikke af platformarkitekturen.
I dette eksempel oprettes en toc-fil for hver overordnet indholdskategori. For et så lille antal filer er det ikke nødvendigt med separate toc-filer for hver kategori. Det antages i dette eksempel, at der er mange flere filer, eller at det er forskellige forfattere, der ejer hver sin indholdskategori.
Vores filer ser ud på følgende måde:
<toc label="Begreber"> <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 label="Opgaver"> <topic id="plainTasks" label="Generelt"> <topic label="Task1" href="html/tasks/task1.html"/> <topic label="Task2" href="html/tasks/task2.html"/> </topic> <topic id="funTasks" label="Sjov" > <topic label="Task3_1" href="html/tasks/task3_1.html"/> <topic label="Task3_2" href="html/tasks/task3_2.html"/> </topic> </toc>
<toc label="Reference"> <topic label="Ref1" href="html/ref/ref1.html"/> <topic label="Ref2" href="html/ref/ref2.html"/> </toc>
Et emne kan være et link til indhold. "Task1" stiller f.eks. én label og én href til rådighed, som har link til indholdet. Et emne kan også være en hierarkisk gruppering af underemner uden eget indhold. "Sjov" har f.eks. kun én label og underemner, men ingen href. Emner kan også begge dele. "Concept1" har én href og underemner.
Dynamisk indhold
Dynamisk indhold er tilgængeligt for indholdsfortegnelse i form af filtre og ankre. Du kan f.eks. ønske, at et emne kun vises i indholdsfortegnelsen, når der anvendes et bestemt styresystem.
Inkluderinger understøttes ikke her, fordi de ikke er nødvendige. Brug link i stedet for.