Hjelp

Eclipse-plattformens hjelpefunksjoner inneholder de ubehandlede byggeblokkene du trenger for å strukturere og bidra med dokumentasjonen i plattformen. Du bestemmer selv hvilken struktur eller hvilket detaljnivå dokumentasjonen skal ha. Du kan velge dokumentasjonsverktøy og -struktur som dekker dine behov. Plugin-modulen for hjelp gjør det mulig å beskrive dokumentasjonsstrukturen for plattformen ved hjelp av en fil for innholdsfortegnelse (.toc-fil).

Du finner plugin-hjelpen via utvidelsespunktet org.eclipse.help.toc. Du kan enten oppgi hjelpen som en del av plugin-modulen for kode, eller oppgi den separat i en egen plugin-modul for dokumentasjon.

Det kan være nyttig å ha dokumentasjonen i en separat plugin-modul hvis koden og dokumentasjonsteamene er forskjellige grupper eller hvis du vil begrense koblingen mellom dokumentasjonen og koden.

Avanserte funksjoner i hjelpen omfatter kontekstavhengig hjelp med referanselinker og funksjonalitet for starting av plattformkoden fra dokumentasjonen. Med en nettleser for hjelp kan du vise, skrive ut og søke i dokumentasjonen.Siden versjon 3.1 har den nye Hjelp-visningen dynamisk hjelp og funksjonalitet for søking i forent informasjon.

Det er enklest å vise hvordan hjelpen bidrar med innhold, ved å opprette en plugin-modul for dokumentasjon.