Konteksthjælp - editor

Kontekstbetinget hjælp er en mekanisme, der linker en del af brugergrænsefladen sammen med et specifikt hjælpeemne. Når brugeren aktiverer den tilknyttede del i brugergrænsefladen, bliver hjælpesiden vist i det dynamiske hjælpeområde. Brugergrænsefladen og hjælpesiden kan knyttes sammen på to måder: i en statisk XML-fil eller en dynamisk kontekstudbyder. Ved statisk tilknytning af sider skal der oprettes en XML-fil med konteksthjælp. Editoren til konteksthjælp hjælper med at oprette disse sider.

Siden Definition i editoren indeholder en grafisk oversigt over XML-filen inddelt i to kolonner. Kolonnen til venstre har navnet Konteksthjælp og viser XML-elementerne i træstrukturformat sammen funktioner, der bruges til at tilføje, flytte og fjerne dem. Den anden kolonne indeholder mere detaljerede oplysninger om det element, der er valgt i den venstre kolonne, og gør det muligt at redigere oplysningerne.

Siden Kilde i editoren indeholder en oversigt over XML-filen i tekstformat. XML-teksten kan redigeres direkte, og gyldige ændringer afspejles på den grafiske side, Definition.

Tilføj nye hjælpekontekster

Editor til hjælpekontekst med udfyldte felter

Klik på knappen Tilføj kontekst for at tilføje en ny kontekst. Derved tilføjes en ny kontekstindgang til XML-teksten, og den vises i træstrukturen på siden Definition. Den nye kontekst vil være valgt, så der åbnes et detaljeafsnit i højre kolonne i editoren. I detaljeafsnittet kan du angive mere detaljerede oplysninger om konteksten, herunder:

Tilføj hjælpeemner og kommandoer

Ved tilføjelse af en kontekst til filen får den dynamiske hjælp en grundlæggende beskrivelse, som kan vises for brugeren. Du vil nok ofte tilføje link til relaterede emner i hjælpesystemet. Det gør du ved at tilføje emner og kommandoer til XML-filen.

Editor til hjælpekontekst med udfyldte detaljerede felter

Ved at klikke på knappen Tilføj emne kan du tilføje en ny emneindgang til XML-teksten under en af hjælpekonteksterne. Et emne vises for brugeren som et link. Når et nyt emne er oprettet, kan du vælge det for at åbne afsnittet Emneoplysninger i højre kolonne på siden Definition. I oplysningsafsnittet kan du ændre den etiket, der vises for brugeren, og placeringen af den fil, der oprettes et link til. I de fleste tilfælde vil den sammenkædede fil være en HTML-side i hjælpesystemet. Du kan bruge knappen Gennemse... til at søge efter en fil, der skal oprettes et link til.

Ud over emner vil du måske også tilføje en kommando. For brugeren ser en kommando ud på samme måde som et emne. Når linket aktiveres, udføres imidlertid en kodekommando, i stedet for at der åbnes en fil. Kommandoer kan bruges til at åbne indstillingssider og udføre andre funktioner.

Tilføj-kommando i hjælpekonteksteditoren

Klik på knappen Tilføj kommando for at tilføje en ny kommando. Du kan redigere oplysningerne om kommandoer på samme måde, som du redigerer emner.

Kommandoerne Fjern, Op, Ned

Der er tre ekstra knapper på siden Definition, som kan bruges til at ændre elementernes rækkefølge på kontekstlisten eller til at slette elementerne.

Hjælpekontekst med knapper

Der er følgende knapper:

Registrér filen med konteksthjælp

Før Eclipse kan genkende XML-filen med konteksthjælp som kilde i det dynamiske hjælpesystem, skal filen registreres via udvidelsespunktet org.eclipse.help.contexts. Editoren gør det muligt at registrere konteksthjælpefilen automatisk. I øverste højre hjørne af editoren er der et link med teksten "Registrér denne konteksthjælpefil". Når du klikker på linket, tilføjes den rigtige indgang til filen plugin.xml.