Les éléments include servent à inclure des parties d'autres documents dans votre document. Le marquage indique le document ainsi que l'élément à inclure, et avant que le document ne soit affiché à l'utilisateur, l'élément include est remplacé par l'élément auquel il se rapporte.
Par exemple, vous souhaitez afficher un droit d'auteur à la fin de chaque document d'aide que vous fournissez. Vous pouvez le copier, puis le coller dans chaque document, mais si le droit d'auteur change (par exemple, l'année du droit d'auteur), vous devez modifier chacun de vos documents.
Comme alternative, vous pouvez placer le droit d'auteur dans un fichier XHTML séparé appelé copyright.xhtml
et lui attribuer un identificateur unique, comme suit :
<p id="copyright"> Copyright 2006 Ma société. Tous droits réservés. </p>
Pour chaque document, il vous suffit d'inclure le paragraphe du droit d'auteur :
<p> Il s'agit de mon document. Il doit comporter un droit d'auteur à la fin. </p> <include path="my.plugin.id/path/copyright.xhtml/copyright"/>
Avant que le document ne soit envoyé au navigateur pour être affiché, l'élément include
sera remplacé par le paragraphe du droit d'auteur.
Reportez-vous au paragraphe ci-dessous pour obtenir la liste des types de document dans lesquels l'élément include peut être utilisé. Le format de l'élément path
de l'élément include dépend du type de
document à partir duquel vous effectuez l'inclusion. Comme le montre l'exemple ci-dessus, le format des documents d'aide XHTML est
"<plugin_id>/<path_to_file>/<element_id>"
. Reportez-vous aux liens suivants pour identifier le format de votre type de document.