XHTML-Help-documenten aanleveren

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:

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:

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