När vi nu har våra innehållsexempelfiler kan vi skapa en innehållsfil (toc). En toc-fil definierar de viktigaste ingångspunkterna till HTML-innehållsfilerna genom att avbilda en avsnittsetikett på en referens i en av HTML-filerna.
Tillämpningar som migreras till plattformen kan återanvända befintlig dokumentation genom att använda toc-filen till att definiera ingångspunkter in i dokumentationen.
Ett insticksprogram kan ha en eller flera toc-filer. Vår exempeldokumentation är organiserad i tre huvudkategorier: koncept, åtgärder och referens. Hur skapar vi toc-filer som representerar den strukturen?
Vi skulle kunna skapa en stor toc-fil, eller så skulle vi kunna skapa en separat toc-fil för varje huvudkategori innehåll. Det beslutet bör fattas i enlighet med hur dokumentationsgrupperna arbetar ihop. Om olika författare äger de olika kategorierna kan det vara bättre att behålla separata toc-filer för varje kategori. Det styrs inte av plattformens arkitektur.
I det här exemplet skapar vi en toc-fil för varje huvudinnehållskategori. För ett så litet antal filer är det inte nödvändigt att ha separata toc-filer för varje kategori. Vi kommer att bygga det här exemplet som om vi hade många fler filer eller separata författare som äger var sin innehållskategori.
Våra filer ser ut så här:
<toc label="Koncept"> <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="Åtgärder"> <topic id="plainTasks" label="Enkla åtgärder"> <topic label="Task1" href="html/tasks/task1.html"/> <topic label="Task2" href="html/tasks/task2.html"/> </topic> <topic id="funTasks" label="Roliga åtgärder" > <topic label="Task3_1" href="html/tasks/task3_1.html"/> <topic label="Task3_2" href="html/tasks/task3_2.html"/> </topic> </toc>
<toc label="Referens"> <topic label="Ref1" href="html/ref/ref1.html"/> <topic label="Ref2" href="html/ref/ref2.html"/> </toc>
Ett avsnitt kan vara en enkel länk till innehåll. Till exempel ger "Task1" en label och en href som länkar till innehållet. Ett avsnitt kan även vara en hierarkisk gruppering av underavsnitt utan eget innehåll. Till exempel har "Roliga åtgärder" bara en label och underavsnitt, men ingen href. Avsnitt kan även ha både och. "Concept1" har en href och underavsnitt.
Dynamiskt innehåll
Dynamiskt innehåll är tillgängligt för innehållsförteckningen i form av filter och ankare. Du kan till exempel välja att ett avsnitt visas i innehållsförteckningen endast i ett visst operativsystem.
Det finns inga funktioner för includes här eftersom de inte behövs. Använd links i stället.