Contribution à des documents d'aide XHTML

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 :

Format d'inclusion XHTML

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 :

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