Specifieke Help wordt beschreven door het context-ID dat in de gebruikersinterfacecode is gedeclareerd te koppelen aan een beschrijving en een lijst met links naar verwante onderwerpen in de online Help. Deze koppelingen worden gemaakt in een XML-bestand. U kunt zo veel XML-bestanden met specifieke Help-koppelingen voor elke plugin maken als u wilt. De beschrijving en de links voor elk context-ID wordt gemaakt in <context>-elementen in het XML-bestand. Elk contextelement kan worden gekoppeld aan een <description>-element, dat wordt gebruikt als beschrijving voor het gebruikersinterfaceobject en elk gewenst aantal <topic>-elementen met een link naar de online documentatie.
Vanaf 3.1 kunt u desgewenst met een context-element de standaardtitel waaronder de specifieke Help-informatie in de Help-view wordt afgebeeld, overschrijven.
<contexts> <context id="panic_button" title="Panic Button Title"> <description>This is the panic button.</description> <topic href="tasks/pushing_the_panic_button.htm" label="Pushing the panic button"/> <topic href="reference/panic_button.htm" label="Panic Button Reference"/> </context> ... </contexts>
Als u de contexten hebt beschreven in het XML-bestand (of de XML-bestanden), bent u zover dat u naar de contextbestanden in uw pluginmanifest kunt verwijzen. Merk op dat het context-ID hierboven niet volledig is gekwalificeerd. Dit is toegestaan, mits het contextbestand wordt aangeleverd in het manifest van de plugin waarmee het context-ID is gedefinieerd. Met andere woorden, het context-ID wordt omgezet naar het ID van de plugin die het XML-bestand heeft aangeleverd.
Een plugin levert contextbestanden aan met het extensiepunt org.eclipse.help.contexts.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" /> </extension>
U kunt verwijzen naar contextbestanden uit andere plugins door gebruik te maken van het kenmerk plugin. Zo kunt u al uw documentatie, inclusief specifieke Help, onderbrengen in één plugin en hiernaar verwijzen vanuit de plugin met gebruikersinterfacecode of een andere gerelateerde plugin.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" plugin="com.example.helpExample" /> </extension>
Zoals u ziet, kunt u uw contexten flexibel indelen in een of meer bestanden in een of meer plugins. Het belangrijkste hierbij is dat de context-ID's in de bestanden op de juiste wijze kunnen worden omgezet. Als u een context-ID niet volledig kwalificeert, moet u de context-XML-bestanden aanleveren via de plugin waarmee de context-ID's zijn gedeclareerd. Als u volledig gekwalificeerde context-ID's in uw context-XML-bestand gebruikt, hebt u alle keuzevrijheid wat betreft de locatie van uw XML-bestanden en de plugin die de contexten aanlevert.
Een ander flexibiliteitsvoordeel is de mogelijkheid om voor een en hetzelfde context-ID specifieke Help aan te leveren uit verschillende plugins. Dit kan goed van pas komen bij verschillende sets met documentatieplugins die al dan niet geïnstalleerd zijn in de configuratie van een gebruiker. Zo kunnen per documentatieplugin verschillende contexten worden gedeclareerd. De eindgebruiker ziet dan de samengevoegde specifieke Help-content voor alle plugins die contexten voor het ID van de desbetreffende widget hebben aangeleverd.
Hierbij moet wel de volledig gekwalificeerde context-ID voor de widget worden gebruikt, aangezien het context-ID door geen van de documentatieplugins wordt gedeclareerd. Wanneer meerdere plugins specifieke Help voor hetzelfde context-ID aanleveren, wordt de content die is gedefinieerd in de plugin waardoor de context (de gebruikersinterfaceplugin) wordt gedeclareerd, als eerste afgebeeld. De overige beschrijvingen en links worden daar in willekeurige volgorde aan toegevoegd.
Dynamische content
Dynamische content is beschikbaar voor de specifieke Help in de vorm van filters voor links naar specifieke Help-onderwerpen. U kunt bijvoorbeeld instellen dat een link naar een specifiek Help-onderwerp alleen in de inhoudsopgave wordt weergegeven als een bepaald besturingssysteem wordt gebruikt.