Fordi plugin-moduler tilfører funksjoner til plattformen, er det vanlig å legge til dokumentasjon som beskriver den nye funksjonen. Hvordan kan denne dokumentasjonen struktureres på en slik måte at brukeren opplever dokumentasjonen som sammenhengende og komplett, og ikke som mange enkeltstående deler? Definisjonen av innholdsfortegnelsen inneholder funksjoner for å bygge dokumentasjon både ovenfra og ned og nedenfra og opp.
Nesting ovenfra og ned viser til metoden med å definere en master-TOC-fil som refererer til andre TOC-filer som er inkludert. Nesting ovenfra og ned er en enkel metode som deler innholdet inn i mindre deler. Ved slik nesting brukes link-attributtet i definisjonen av innholdsfortegnelsen for å referere til linkede TOC-filer i stedet for å oppgi en href.
<toc label="Online Help Sample" topic="html/book.html"> <topic label="Concepts"> <link toc="toc_Concepts.xml" /> </topic> <topic label="Tasks"> <link toc="toc_Tasks.xml" /> </topic> <topic label="Reference"> <link toc="toc_Ref.xml" /> </topic> </toc>
Den grunnleggende strukturen er uforandret (Begreper, Oppgaver, Referanse), men de enkelte TOC-filene kan fritt utvikles. De kan også linke til andre underliggende TOC-filer.
Denne komposisjonen er mer fleksibel fordi nye plugin-moduler kan bestemme hvor dokumentasjonen skal legges i strukturen med TOC-filer. Du lager en slik komposisjon ved å bruke anchor-attributter. En TOC-fil definerer navngitte forankringspunkter der andre plugin-moduler kan legge til dokumentasjon. I vårt eksempel kan vi legge til forankringspunkt slik at plugin-moduler kan legge til ytterligere materiell mellom de ulike delene med begreper, oppgaver og referanser.
<toc label="Online Help Sample" topic="html/book.html"> <topic label="Concepts"> <link toc="toc_Concepts.xml" /> <anchor id="postConcepts" /> </topic> <topic label="Tasks"> <link toc="toc_Tasks.xml" /> <anchor id="postTasks" /> </topic> <topic label="Reference"> <link toc="toc_Ref.xml" /> <anchor id="postReference" /> </topic> </toc>
Andre plugin-moduler kan også bidra med dokumentasjon i forankringspunktet. Dette gjøres ved hjelp av attributtet link_to når du definerer en TOC-fil.
<toc link_to="../com.example.helpexample/toc.xml#postConcepts" label="Late breaking info about concepts"> <topic> ... </topic> </toc>