Pourquoi utiliser le langage XHTML ?
Le système d'aide permet de fournir du contenu dynamique d'aide en annotant votre marquage XHTML avec des balises spéciales dans le but de filtrer, d'utiliser des éléments include et indiquer des ancrages pour les extensions. Ces fonctions ne sont pas disponibles avec le marquage HTML.
Comment contribuer à des documents XHTML ?
Les documents d'aide XHTML sont enrichis de la même manière que les documents HTML, à l'exception faite de quelques différences nécessaires pour prendre en charge le contenu dynamique et la recherche. Ces modifications obligatoires sont les suivantes :
Vous devez associer le participant à la recherche XHTML à votre plug-in de document.
L'implémentation de l'aide Eclipse utilise Lucene pour indexer ses documents en vue d'accélérer la recherche. Pour indexer un document, Lucene doit être en mesure de lire le format. Eclipse fournit déjà un participant à la recherche pour l'indexation de documents XHTML. Par conséquent, il vous suffit simplement d'indiquer au système d'aide de l'utiliser pour vos documents. Ajoutez l'extension suivante à votre manifeste de plug-in :
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Si vous utilisez du contenu dynamique, vous devez associer le fournisseur de contenu dynamique XHTML à votre plug-in de document.
Si vous souhaitez fournir du contenu dynamique à l'aide d'annotations XML, vous devez indiquer au système d'aide qu'il doit traiter vos documents. Pour ce faire, vous devez associer le fournisseur de contenu dynamique XHTML à votre plug-in.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Pour utiliser des éléments include dans votre document XHTML, le format de l'attribut path
est le suivant : (expliqué ci-dessous)
<id_plugin>/<chemin_accès_fichier_xhtml>/<nom_fichier_xhtml>/<id_élément>
Les champs ont les valeurs suivantes :
org.eclipse.help
)
/mon_dossier/mon_sous_dossier/
)
mon_fichier.xhtml
)
id
à cet élément (par ex. mon.id.élément
)
Par exemple, pour inclure le paragraphe (élément <p>
) portant l'ID mon_copyright
à partir du fichier /copyrights/copyright.xhtml
dans le plug-in mon.plugin_produit
, vous devez indiquer les éléments suivants :
mon.plugin.produit/copyrights/copyright.xhtml/mon_copyright