Hjælp

Eclipse-platformens hjælpefunktioner indeholder bl.a. de rå byggeklodser, du kan bruge til at strukturere og levere dokumentation til platformen. Dokumentationens struktur og detaljeringsgrad bestemmer du selv. Du vælger de værktøjer og den struktur til dokumentationen, som passer dig bedst. Ved hjælp af hjælpe-plugin'en kan du beskrive dokumentationsstrukturen over for platformen via en indholdsfortegnelsesfil (toc).

Plugin'ens onlinehjælp leveres vha. udvidelsespunktet org.eclipse.help.toc. Du kan enten levere onlinehjælpen som en del af kode-plugin'en, eller du kan levere den i en separat dokumentations-plugin.

I visse situationer kan det være nyttigt at udskille dokumentationen i en separat plugin, f.eks. hvis kode og dokumentationsteams er forskellige grupper, eller hvis du vil reducere parring mellem dokumentationen og koden.

De udvidede indstillinger i hjælpen omfatter kontekstafhængig hjælp med referencelink og muligheden for at starte platformkode fra dokumentationen. Ved hjælp af en hjælpebrowser kan du få vist, udskrive og søge i dokumentationen. Siden version 3.1 omfatter den nye hjælp dynamisk hjælp og muligheden for fødereret oplysningssøgning.

Den bedste måde at vise den leverede hjælp på er at oprette en dokumentations-plugin.