Funkce zahrnutí se používá pro zahrnutí částí jiných dokumentů do vašeho dokumentu. Markup určuje dokument a prvek pro zahrnutí a před zobrazení dokumentu uživateli je prvek zahrnutí nahrazen prvkem, na který je odkazováno.
Můžete například chtít zobrazit copyright na konci každého vámi poskytovaného dokumentu nápovědy. Mohli byste jej zkopírovat a vložit do každého dokumentu, ale pokud se copyright změní (např. jeho rok), budete muset upravit každý dokument zvlášť.
Namísto toho můžete vložit copyright do samostatného souboru XHTML nazvaného
copyright.xhtml
a přiřadit mu jedinečný identifikátor takto:
<p id="copyright"> Copyright 2006 Moje společnost. Všechna práva vyhrazena. </p>
Potom do každého dokumentu jednoduše zahrňte odstavec copyrightu:
<p> Toto je můj dokument. Na konci by měl mít copyright. </p> <include path="my.plugin.id/path/copyright.xhtml/copyright"/>
Před odesláním dokumentu prohlížeči pro zobrazení bude prvek include
nahrazen odstavcem copyrightu.
Níže v tomto textu najdete seznam typů dokumentů, ve kterých lze použít zahrnutí. Formát prvku path
zahrnutí závisí na typu dokumentu, ze kterého provádíte zahrnutí. Jak můžete vidět ve výše uvedeném příkladu, formát pro dokumenty nápovědy XHTML je
"<plugin_id>/<path_to_file>/<element_id>"
. Pro formát vašeho typu dokumentu viz níže uvedené odkazy.