Proč používat XHTML?
Systém nápovědy nabízí schopnost produkovat dynamický obsah nápovědy anotováním markupu XHTML pomocí speciálních značek pro filtry, vkládané soubory a uvádět kotvy pro rozšíření. Při použití HTML nejsou tyto funkce dostupné.
Jak přispívat XHTML
Dokumenty nápovědy XHTML jsou přispívány téměř stejně jako HTML s tím, že existuje několik důležitých rozdílů, které podmiňují podporu dynamického obsahu a vyhledávání. Tyto požadované úpravy jsou uvedeny níže:
Musíte vytvořit vazbu mezi účastníkem hledání XHTML a vaším modulem plug-in dokumentace.
Implementace nápovědy Eclipse používá k indexaci dokumentů za účelem zrychlení vyhledávání Lucene. Aby Lucene dokázal dokument indexovat, musí být schopen číst jeho formát. Eclipse již nabízí účastníka hledání pro indexaci dokumentů XHTML, takže jednoduše musíte říci systému nápovědy, aby ho pro vaše dokumenty používal. Přidejte následující rozšíření do manifestu vašeho modulu plug-in:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Pokud používáte dynamický obsah, musíte vytvořit vazbu producentu dynamického obsahu XHTML s vaším modulem plug-in dokumentace.
Chcete-li produkovat dynamický obsah pomocí anotací XML, musíte říci systému nápovědy, že by měl zpracovat vaše dokumenty. To se provádí vazbou producentu dynamického obsahu XHTML s vaším modulem plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Formát vkládaných souborů XHTML
Chcete-li používat ve vašem XHTML vkládané soubory,
formát atributu cesta
vypadá takto: (vysvětleno níže)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Kde pole mají následující význam:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
za daný prvek (např.
my.element.id
)
Chcete-li například zahrnout odstavec (prvek <p>
)
s ID my_copyright
ze souboru /copyrights/copyright.xhtml
do modulu plug-in my.product.plugin
, měli byste uvést následující:
my.product.plugin/copyrights/copyright.xhtml/my_copyright