Redigerare för kontexthjälp

Kontexthjälp är en del av ett användargränssnitt till ett viss hjälpavsnitt. När användaren aktiverar den associerade delen av användargränssnittet, visas hjälpsidan i det dynamiska hjälpområdet. Användargränssnittet och hjälpsidorna kan associeras med varandra på två sätt: via en statisk XML-fil eller en dynamisk kontextleverantör. Om du vill associera sidor statiskt måste en xml-fil för kontexthjälp skapas. Kontexthjälpens redigerare hjälper till att skapa dessa sidor.

Redigerarens sida Definition visar XML-filen i en grafisk vy med två kolumner. Kolumnen till vänster har rubriken Kontexthjälp och visar XML-elementen i trädformat tillsammans med de åtgärder med vilka de kan läggas till, flyttas och tas bort. Den andra kolumnen visar mer detaljerad information om det element som är markerat i den vänstra kolumnen, och gör det möjligt att ändra detaljerna.

Källsidan för redigeraren visar xml-filen i en textvy. Xml-koden kan redigeras direkt och ändras. Om den sedan är giltig, återspeglas den på den grafiska definitionssidan.

Lägga till ny hjälpkontext

Redigeraren för hjälpkontext med ifyllda fält

Om du vill lägga till en ny kontext klickar du på knappen Lägg till kontext. Då läggas en ny kontextpost till i xml-koden som visas i trädet på definitionssidan. Den nya kontexten markeras och öppnas i ett detaljavsvnitt i redigerarens högra kolumn. I detta detaljavsnitt kan du ange mer utförlig information om kontexten, bland annat:

Lägga till hjälpavsnitt och kommandon

Genom att lägga till en kontext i filen kan du tillhandahålla dynamisk hjälp med en grundläggande beskrivning som visas för användaren. Vanligen vill man tillhandahålla ytterligare länkar till närliggande avsnitt i hjälpsystemet. För att åstadkomma detta måste man lägga till avsnitt och kommandon i xml-filen.

Redigeraren för hjälpkontext med ifyllda fält

Genom att klicka på knappen Lägg till avsnitt lägger du till en ny avsnittspost i xml-koden under en av hjälpkontexterna. Ett avsnitt visas för användaren som en länk. När ett nytt avsnitt skapas kan du välja att öppna det för att öppna avsnittsdetaljavsnittet i den högra kolumnen på definitionssidan. I detaljavsnittet kan du ändra den etikett som visas för användaren och platsen för den fil som det länkas till. I de flesta fall är den länkade filen en html-sida i hjälpsystemet. Du kan använda knappen Bläddra om du vill söka efter en fil att länka till.

Förutom avsnitt kan du även lägga till ett kommando. Ett kommando har samma utseende som ett avsnitt för användaren. När länken aktiveras körs ett kommando i stället för att en fil öppnas. Med kommandon kan du öppna inställningssida och utföra andra åtgärder.

Redigerare för hjälpkontext och kommando

Klicka på knappen Lägg till kommando om du vill lägga till ett nytt kommando. Du kan redigera standardvärdena för kommandon på samma sätt som du redigerar avsnitt.

Ta bort, flytta kommandot uppåt eller nedåt

Det finns tre ytterligare knappar på definitionssidan som du kan använda för att manipulera objektens ordning i kontextlistan eller ta bort objekten.

Hjälpkontext med ändringsknappar

Följande knappar finns:

Registrera kontexthjälpfilen

För att Eclipse ska känna igen kontexthjälpfilen som en källa för det dynamiska hjälpsystemet måste den registreras via utökningspunkten org.eclipse.help.contexts. Redigeraren tillhandahåller ett sätt att registrera kontexthjälpfilen automatiskt. Längst upp till höger i redigeraren finns länken "Registrera den här kontexthjälpfilen". Om du klickar på den här länken läggs den korrekta posten in i filen plugin.xml.