Wat is het nut van XHTML?
Het Help-systeem biedt u de mogelijkheid om dynamische Help-content te maken door uw XHTML-markup te voorzien van speciale tags voor filters, insluitingen en ankers voor extensies. Deze features zijn niet beschikbaar bij gebruik van HTML.
Procedure voor aanlevering van XHTML
XHTML-Help-documenten worden op vrijwel dezelfde wijze aangeleverd als HTML, maar er zijn enkele belangrijke verschillen die noodzakelijk zijn om dynamische content te kunnen ondersteunen en opzoeken. De vereiste wijzigingen worden hieronder beschreven:
U moet de XHTML-zoekdeelnemer koppelen aan uw documentatieplugin.
Eclipse maakt gebruik van Lucene om Help-documenten te indexeren zodat deze sneller kunnen worden opgezocht. Om een document te kunnen indexeren, moet de bestandsindeling door Lucene kunnen worden gelezen. Eclipse bevat al een zoekdeelnemer om XHTML-documenten te indexeren, dus u hoeft het Help-systeem voor uw documenten alleen maar op deze zoekdeelnemer in te stellen. Voeg de volgende extensie toe aan uw pluginmanifest:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Als u dyamische content gebruikt, moet u de producent van dynamische XHTML-content koppelen aan uw documentatieplugin.
Als u dynamische content wilt produceren met behulp van XML-annotaties, moet u het Help-systeem instellen voor de verwerking van uw documenten. U doet dit door de producent van de dynamische XHTML-content aan uw plugin te koppelen.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Indeling voor insluiting van XHTML
Als u insluitingen in uw XHTML wilt opnemen,
moet de indeling van het kenmerk path
er als volgt uitzien (de bijbehorende uitleg staat eronder):
<plugin_id>/<pad_naar_xhtml_bestand>/<bestandsnaam_xhtml>/<element_id>
Verklaring van de velden:
org.eclipse.help
)
/mijn_map/mijn_submap/
)
mijn_bestand.xhtml
)
id
-kenmerk aan dat element toe te voegen (bijvoorbeeld mijn.element.id
)
Als u bijvoorbeeld de alinea (een <p>
-element) met het ID
mijn_copyright
uit het bestand /copyrights/copyright.xhtml
wilt invoegen in de plugin mijn.product.plugin
, geeft u het volgende op:
mijn.product.plugin/copyrights/copyright.xhtml/mijn_copyright