Editor voor specifieke Help

Contextgevoelige Help is een mechanisme dat een deel van de gebruikersinterface koppelt aan een bepaald Help-onderwerp. Wanneer de gebruiker het betreffende deel van de gebruikersinterface activeert, wordt de Help-pagina afgebeeld in het gebied voor dynamische Help. De gebruikersinterface en de Help-pagina's zijn op twee manieren aan elkaar gekoppeld: Met een statisch XML-bestand of met een dynamische contextprovider. Om de pagina's statisch aan elkaar te koppelen moet er een XML-bestand met specifieke Help worden gemaakt. Met behulp van de editor voor specifieke Help kunt u deze bestanden maken.

De pagina Definitie van de editor bevat een grafische weergave van het XML-bestand verdeeld over twee kolommen. De linkerkolom heeft de titel Specifieke Help en bevat de XML-elementen in een boomstructuur en de acties waarmee u elementen kunt toevoegen, verplaatsen of verwijderen. De andere kolom bevat meer informatie over het element dat in de linkerkolom is geselecteerd. In deze kolom kunt u de details aanpassen.

De pagina Bron van de editor bevat een tekstuele weergave van het XML-bestand. De XML kan rechtstreeks worden gewijzigd en geldige wijzigingen worden weergegeven op de grafische pagina Definitie.

Nieuwe Help-context toevoegen

Help-contexteditor met ingevulde velden

Om nieuwe context toe te voegen, klikt u op de knop Context toevoegen. Hierdoor wordt een nieuw contextitem toegevoegd aan de XML en weergegeven in de structuur op de pagina Definitie. De nieuwe context wordt geselecteerd en een gegevenssectie wordt geopend in de rechterkolom van de editor. In deze gegevenssectie kunt u meer gedetailleerde informatie opgeven over de context, bijvoorbeeld:

Help-onderwerpen en -opdrachten toevoegen

Door een context toe te voegen aan het bestand, beschikt dynamische Help over een basisbeschrijving om aan de gebruiker te presenteren. Doorgaans wilt u aanvullende koppelingen verstrekken naar verwante onderwerpen in het Help-systeem. U doet dit door onderwerpen en opdrachten toe te voegen aan het XML-bestand.

Help-contexteditor met ingevulde detailvelden

Door op de knop Onderwerp toevoegen te klikken, voegt u een nieuw onderwerpitem toe aan de XML onder een van de Help-contexten. Een onderwerp wordt aan de gebruiker gepresenteerd als een koppeling. Zodra een nieuw onderwerp is gemaakt, kunt u het selecteren om de sectie Onderwerpgegevens te openen in de rechterkolom van de pagina Definitie. In de gegevenssectie kunt u het label wijzigen dat aan de gebruiker wordt gepresenteerd en de locatie van het bestand dat wordt gekoppeld. Het gekoppelde bestand is meestal een HTML-pagina in het Help-systeem. Gebruik de knop Bladeren... om een te koppelen bestand te zoeken.

U wilt mogelijk niet alleen onderwerpen, maar ook een opdracht toevoegen. Een opdracht ziet er voor de gebruiker hetzelfde uit als een onderwerp. Als de koppeling echter wordt geactiveerd, wordt er geen bestand geopend maar een codeopdracht uitgevoerd. Gebruik opdrachten om voorkeurenpagina's te openen en andere acties uit te voeren.

Opdracht toevoegen aan Help-contexteditor

Door op de knop Opdracht toevoegen te klikken wordt een nieuwe opdracht toegevoegd. U kunt de gegevens van opdrachten op dezelfde manier wijzigen als onderwerpen.

Opdrachten Verwijderen, Omhoog en Omlaag

Op de pagina Definitie zijn er nog drie knoppen waarmee u de volgorde van items in de contextlijst kunt aanpassen of items kunt verwijderen.

Help-context met manipulatieknoppen

De volgende knoppen zijn beschikbaar:

Bestand met specifieke Help registreren

Het XML-bestand met specifieke Help kan door Eclipse alleen als bron voor het dynamische Help-systeem worden herkend, als het is geregistreerd via het extensiepunt org.eclipse.help.contexts. De editor biedt een manier om het bestand met specifieke Help automatisch te registreren. In de rechterbovenhoek van de editor is er een koppeling met de naam "Dit bestand met specifieke Help registreren". Als u op deze koppeling klikt, wordt het juiste item aan het bestand plugin.xml toegevoegd.