Insluitingen worden gebruikt om onderdelen van andere documenten in een document in te voegen. In de markup geeft u op welk document en element u wilt invoegen. Voordat het document wordt afgebeeld, wordt het ingesloten element vervangen door het element waarnaar wordt verwezen.
Stel, u wilt aan het einde van elk Help-document een tekst met copyright-informatie afbeelden. U kunt de tekst natuurlijk kopiëren en vervolgens in elk afzonderlijk document plakken, maar als het copyright (bijvoorbeeld het jaar) dan verandert kunt u elk document gaan aanpassen.
In plaats daarvan kunt u het copyright beter opslaan in een afzonderlijk XHTML-bestand
met de naam copyright.xhtml
en hier een uniek ID aan toekennen, bijvoorbeeld:
<p id="copyright"> Copyright 2006 Mijn bedrijf. Alle rechten voorbehouden. </p>
Vervolgens neemt u de alinea met het copyright op in elk document:
<p> Dit is mijn document. Onderaan staat een tekst met copyright-informatie. </p> <include path="my.plugin.id/path/copyright.xhtml/copyright"/>
Voordat het document in de browser wordt weergegeven, wordt het ingesloten
element
vervangen door de alinea met het copyright.
Verderop in dit document vindt u een lijst met typen documenten waarin items kunnen worden opgenomen.
De syntaxis van het path
-element is afhankelijk van het type document
waarvan content wordt ingevoegd. Zoals u in het bovenstaande voorbeeld
kunt zien, is de syntaxis voor Help-documenten in XHTML-indeling
"<plugin_id>/<path_to_file>/<element_id>"
. Klik op de volgende links voor informatie over de juiste indeling voor uw documenttype.