Include (SP-Tag)

Name

<sp:include> - Includiert ein anderes Template

Syntax

<sp:include anchor="anchor.example"/>

Beschreibung

Mit dem Include Tag ist es möglich innerhalb eines Templates andere, bereits erstellte Templates oder SPML-Seiten von Webapplikationen einzubinden. Es kann über das template-Attribut entweder der Anchor oder eine Variable mit einer Template-ID angegeben werden. Zu includende SPML-Seiten werden über das uri-Attribut angegeben. sp:include wird durch die Ausgabe des eingebundenen Templates oder der SPML-Seite ersetzt.

Attribute

Name	Type	Required	Default	ab IES Version
`template`	Variable	Ja oder anchor oder uri	None	1
`anchor`	Anchor	Ja oder template oder uri	None	1
`uri`	Text	Ja oder template oder anchor	None	1
`context`	Text	Nein	None	1
`module`	Text	Nein	None	1
`mode`	Text	Nein	None	1
`arguments`	Map	Nein	None	2.14.2
`return`	Text	Nein	None	2.13

template: Zu includendes Template (Variable mit einer Template-ID).

anchor: Anchor-Name des zu includenden Templates.

uri: URI einer Seite die includiert werden soll. Dieser muss in der gleichen Webapplikation liegen. Weiterhin kann mit dem context-Attribut oder dem module-Attribut eine andere Webapplikation angegeben werden, deren Seite includiert werden soll.

context: SPML-Seiten sind immer Teil einer Webapplikation. Die mit dem Attribut uri angegebene SPML-Seite bezieht sich immer auf die aktuelle Webapplikation. Soll eine Seite einer anderen Webapplikation eingebunden werden, so wird mit diesem Attribut der Context der Webapplikation angegeben. Da sich der Context einer Webapplikation ändern kann, ist in den meisten Fällen die Verwendung des Attributes module zu empfehlen, da hier die ID der Webapplikation angegeben wird.

module: SPML-Seiten sind immer Teil einer Webapplikation. Die mit dem Attribut uri angegebenen SPML-Seite bezieht sich immer auf die aktuelle Webapplikation. Soll eine Seite einer anderen Webapplikation eingebunden werden, so wird mit diesem Attribut die ID der Webapplikation angegeben. Dieses Attribut ist dem Attribut context vorzuziehen, da sich der Context einer Webapplikation ändern kann.

mode

Mit diesem Attribut kann angegeben werden, in welchem Modus die includete SPML-Seite oder das includete Template ausgeführt werden soll.

in: Führt das Template oder die SPML-Seite im In-Modus aus.
out: Führt das Template oder die SPML-Seite im Out-Modus aus.

arguments: Mit diesem Attribut können Argumente in Form einer Map übergeben, die mit system.arguments in der includierten SPML-Datei wieder ausgelesen werden können. Zusätzlich kann noch sp:argument verwendet werden. Mit diesem Tag werden ggf. Argumente der Map überschrieben.

return: Mit diesem Attribut wird der Name der Variable definiert, in der der Rückgabe-Wert des inkludierten Templates abgelegt wird. Inkludierte Templates können sp:return verwenden um Rückgabe-Werte zu definieren. (Siehe auch Eigene Funktionen)

Beispiele

Einfügen von Templates

Template Quelltext

<html>
   <head>
      <title>Template Include</title>
   </head>
   <body>
      <sp:include anchor="html.header"/>
      <sp:include template="currentTemplate"/>
      <sp:include anchor="html.footer"/>
   </body>
</html>