Vi startet dette eksempelet med å opprette plugin-modulen og dokumentfilene. Deretter opprettet vi TOC-filer som beskrev hvordan innholdet var ordnet. Det som gjenstår nå er å sette alt sammen til en master-TOC-fil og oppdatere plugin.xml slik at den legger til master-TOC-filen.
Vi begynner med å opptrette filen toc.xml for å oppgi de tre TOC-filene vi opprettet først. I stedet for å oppgi en href for hvert emne, bruker vi link-attributtet til å referere til de eksisterende TOC-filene.
<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>
Deretter oppdaterer vi plugin.xml for å legge til master-TOC-filen.
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Merk deg bruken av primary-attributtet. Ved å sette dette attributtet til
"true", angir du at innholdsfortegnelsen alltid skal vises i navigeringsområdet, selv om
ingen andre TOC-filer refererer til den. Dette sikrer altså at "master"-TOC-filen
alltid vises i emnelisten. Den vises på toppnivålisten over bøker
siden ingen andre TOC-filer refererer til den.
Merk: Hvis innholdsfortegnelsen er tilknyttet flere filer som ikke vises i navigeringsområdet, og filene er linket fra
andre emner, må vi gjøre emnene tilgjengelig i søkemotoren ved hjelp av extradir-attributtet i TOC-filen.
Til sist oppgir vi de enkelte TOC-filene.
<extension point="org.eclipse.help.toc"> <toc file="toc_Concepts.xml" /> <toc file="toc_Tasks.xml" /> <toc file="toc_Reference.xml" /> </extension>
Disse TOC-filene blir ikke vist i toppnivålisten over bøker fordi vi ikke har angitt primary-attributtet. TOC-filer som ikke er angitt som primære, vises bare i den webbaserte dokumentasjonen hvis en primær TOC-fil refererer til dem eller de er linket av en primær TOC-fil.
Det var det hele. Hvis du kopierer plugin-katalogen til plattformens plugin-katalog, starter plattformen og velger Hjelp->Innhold i Hjelp, vil eksempelet ditt bli vist på listen over bøker. Hvis du klikker på "Online Help Sample", vises innholdsfortegnelsestrukturen: