Element "include"

Mit Elementen "include" können Sie Teile anderer Dokumente in Ihre eigenen Dokumente aufnehmen. Die Markup-Formatierung gibt das Dokument und das aufzunehmende Element an. Bevor das Dokument für den Benutzer angezeigt wird, wird das Element "include" durch das Element ersetzt, auf das verwiesen wird.

Beispiel: Sie wollen am Ende jedes Dokuments, das Sie bereitstellen, einen Copyright-Vermerk anzeigen. Sie könnten diese Angabe kopieren und in jedes Dokument einfügen. Falls sich der Copyright-Vermerk jedoch ändert (z. B. das Jahr des Copyrights), müssen Sie jedes Ihrer Dokumente ändern.

Stattdessen können Sie den Copyright-Vermerk als separate XHTML-Datei namens copyright.xhtml bereitstellen und dieser Datei eine eindeutige Kennung wie die Folgende zuordnen:

   <p id="copyright">
      Copyright 2006 Meine Firma. Alle Rechte vorbehalten.
   </p>

Anschließend nehmen Sie in jedes Dokument einfach den Copyright-Absatz auf:

   <p>
      Dies ist mein Dokument. Es soll am Ende einen Copyright-Vermerk enthalten.
   </p>
   <include path="my.plugin.id/path/copyright.xhtml/copyright"/>

Bevor das Dokument zum Anzeigen an den Browser gesendet wird, wird das Element include durch den Copyright-Absatz ersetzt.

Einsatzmöglichkeiten für Elemente "include"

Die folgende Liste enthält die Dokumenttypen, in denen Elemente "include" verwendet werden können. Das Format des Elements path im Element "include" richtet sich nach dem Typ des Dokuments, aus dem die Angabe eingefügt wird. Wie aus dem obigen Beispiel hervorgeht, lautet das Format für XHTML-Hilfedokumente "<plugin-id>/<dateipfad>/<element-id>". Nach Auswahl der folgenden Links wird das Format für Ihren Dokumenttyp angezeigt.