Redigeringsprogram for konteksthjelp

Kontekstavhengig hjelp er en mekanisme som gjør det mulig å linke en del av et brukergrensesnitt til et bestemt hjelpeemne. Når brukeren aktiverer den tilknyttede delen av brukergrensesnittet, vises hjelpesiden i et dynamisk hjelpeområde. Brukergrensesnittet og hjelpesidene er knyttet til hverandre på to måter: en statisk XML-fil eller en dynamisk kontekstleverandør. For å tilknytte sidene statisk må du opprette en XML-fil for konteksthjelp. Redigeringsprogrammet for konteksthjelp hjelper til med opprettelsen av disse sidene.

Siden Definisjon i redigeringsprogrammet gir en grafisk visning av XML-filen, delt inn i to kolonner. Kolonnen til venstre har tittelen Konteksthjelp og viser XML-elementene i treformat sammen med handlinger for å tilføye, flytte og fjerne dem. Den andre kolonnen inneholder mer detaljert informasjon om elementet som er valgt i venstre kolonne, og gjør det mulig å redigere detaljene.

Siden Kilde i redigeringsprogrammet har en tekstvisning av XML-filen. XML-filen kan redigeres direkte, og gyldige endringer vil bli gjenspeilet på den grafiske siden Definisjon.

Legge til nye hjelpekontekster

Redigeringsprogram for hjelpekontekst med utfylte felt

Du legger til en ny kontekst ved å klikke på Legg til kontekst. Dermed legges en ny kontekst til XML-filen, og den blir vist i treet på siden Definisjon. Den nye konteksten blir valgt, og det blir åpnet en detaljseksjon i høyre kolonne i redigeringsprogrammet. I denne detaljseksjonen kan du oppgi mer detaljerte opplysninger om konteksten, inkludert:

Legge til hjelpeemner og kommandoer

Hvis du legger til en kontekst i filen, får den dynamiske hjelpen en grunnleggende beskrivelse som vises for brukeren. Du vil typisk sørge for ytterligere linker til beslektede emner i hjelpesystemet. For å gjøre det må du legge til emner og kommandoer i XML-filen.

Redigeringsprogram for hjelpekontekst med utfylte detaljfelt

Ved å klikke på knappen Legg til emne legger du til en ny emneoppføring i XML-filen under en av hjelpekontekstene. Et emne blir vist for brukeren som en link. Straks et nytt emne blir opprettet, kan du velge det og åpne seksjonen Emnedetaljer i høyre kolonne på siden Definisjon. I detaljseksjonen kan du endre etiketten som vises for brukeren, og plasseringen til filen som skal linkes. I de fleste tilfeller er den linkede filen en HTML-side i hjelpesystemet. Du kan bruke knappen Bla gjennom... til å søke etter en fil å linke til.

I tillegg til emner kan du ønske å legge til en kommentar. En kommando har samme utseende for brukeren som et emne har. Når linken aktiveres, utføres imidlertid en kommando i stedet for at en fil åpnes. Kommandoer kan brukes til å åpne preferansesider og utføre andre handlinger.

Redigeringsprogram for hjelpekontekst og kommando

Klikke på Legg til kommando for å legge til en ny kommando. Du kan redigere detaljene for kommandoer på samme måte som du redigerer emner.

Kommandoene Fjern, Opp, Ned

Det finnes ytterligere tre knapper på siden Definisjon som gjør det mulig å endre rekkefølgen til elementene på kontekstlisten eller slette elementer.

Redigeringsprogram for hjelpekontekst med knapper for manipulering

Dette er knappene:

Registrere konteksthjelpefilen

For at Eclipse skal gjenkjenne XML-filen for konteksthjelp som kilde til det dynamiske hjelpesystemet, må den registreres via utvidelsespunktet org.eclipse.help.contexts. Redigeringsprogrammet har en måte å registrere konteksthjelpfilen på automatisk. Øverst til høyre i redigeringsprogrammet er det en link kalt "Registrer denne konteksthjelpefilen". Når du klikker på denne linken, blir riktig oppføring lagt til i filen plugin.xml.