Innholdsfortegnelsefiler (TOC-filer)

Nå som vi har eksempelinnholdsfiler kan vi opprette en innholdsfortegnelsefil (TOC-fil). En TOC-fil definerer hovedinngangspunktene til HTML-innholdsfilene ved å tilordne en emneetikett til en referanse i en av HTML-filene. 

Applikasjoner som migreres til plattformen, kan bruke eksisterende dokumentasjon på nytt ved å definere inngangspunkter til dokumentasjonen ved hjelp av TOC-filen.

En plugin-modul kan ha en eller flere TOC-filer. Eksempeldokumentasjonen vår er delt inn i tre hovedkategorier: begreper, oppgaver og referanse. Hvordan lager vi TOC-filer med en slik struktur?

Vi kan lage en stor TOC-fil eller opprette en TOC-fil for hver hovedkategori av innhold. Hvordan dette løses avhenger av måten dokumentasjonsgruppen din arbeider på. Hvis de ulike kategoriene eies av ulike forfattere, kan det være hensiktsmessig å holde TOC-filene atskilt for hver kategori. Dette er ikke definert av plattformarkitekturen.

I dette eksempelet skal vi opprette en TOC-fil for hver hovedkategori av innhold. Med så få filer er det ikke nødvendig å ha separate TOC-filer for hver kategori. Vi bygger dette eksempelet som om vi har mange filer eller separate forfattere som eier hver sin innholdskategori.

Filene ser slik ut:

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>

Et emne kan være en enkel link til innhold.  For eksempel oppgir "Task1" en label og en linking til innhold gjennom href. Et emne kan også være en hierarkisk gruppering av underemner, og uten eget innhold. For eksempel har "Fun Stuff" bare en label og underemner, men ingen href. Emner kan også være begge deler. "Concept1" har en href og underemner.

Dynamisk innhold

Dynamisk innhold er tilgjengelig for innholdsfortegnelsen i form av filtre og ankere. Du ønsker kanskje at et emne bare skal vises i innholdsfortegnelsen når du kjører et bestemt operativsystem.

Inkluderinger støttes ikke her fordi de ikke er nødvendige. Bruk linker i stedet.