Include (SP-Tag): Unterschied zwischen den Versionen

Aktuelle Version vom 16. März 2016, 14:43 Uhr

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>

@@ Zeile 1: / Zeile 1: @@
 ==Name==
-<sp:include> - Inkludiert ein anderes Template
+<sp:include> - Includiert ein anderes Template
 ==Syntax==
@@ Zeile 8: / Zeile 8: @@
 ==Beschreibung==
-Mit dem Include Tag ist es möglich innerhalb eines Templates andere bereits erstellte Templates einzubinden. Es kann entweder der [[Anchor]] oder eine Variable mit einer [[Template-ID]] angegeben werden. <code>sp:include</code> wird schliesslich durch die Ausgabe des eingebundenen Templates ersetzt.
+Mit dem Include Tag ist es möglich innerhalb eines Templates andere, bereits erstellte Templates oder SPML-Seiten von [[Webapplication|Webapplikationen]] einzubinden. Es kann über das <code>template</code>-Attribut entweder der [[Anchor]] oder eine Variable mit einer [[ID|Template-ID]] angegeben werden. Zu includende SPML-Seiten werden über das <code>uri</code>-Attribut angegeben. <code>sp:include</code> wird durch die Ausgabe des eingebundenen Templates oder der SPML-Seite ersetzt.
 ==Attribute==
-{| class="prettytable"
+{| class="prettytable sortable"
 |- class="hintergrundfarbe1"
 ! Name || Type || Required || Default || ab IES Version
@@ Zeile 21: / Zeile 21: @@
 | 1
 |-
-| <code>ancor</code>
+| <code>anchor</code>
 | [[Anchor]]
 | Ja oder template oder uri
@@ Zeile 34: / Zeile 34: @@
 |-
 | <code>context</code>
+| [[Text]]
+| Nein
+| None
+| 1
+|-
+| <code>module</code>
 | [[Text]]
 | Nein
@@ Zeile 44: / Zeile 50: @@
 | None
 | 1
+|-
+| <code>arguments</code>
+| [[Map]]
+| Nein
+| None
+| 2.14.2
+|-
+| <code>return</code>
+| [[Text]]
+| Nein
+| None
+| 2.13
 |}
@@ Zeile 53: / Zeile 71: @@
 ;<code>uri</code>
-:URI einer Seite die inkludiert werden soll. Dieser muß im gleichen IES-Modul (Web-Applikation) liegen. Weiter kann mit dem context-Attribute ein anderes IES-Modul angegeben werden, dessen Seite inkludiert werden soll.
+:URI einer Seite die includiert werden soll. Dieser muss in der gleichen [[Webapplication|Webapplikation]] liegen. Weiterhin kann mit dem <code>context</code>-Attribut oder dem </code>module</code>-Attribut eine andere [[Webapplication|Webapplikation]] angegeben werden, deren Seite includiert werden soll.
 ;<code>context</code>
-:Soll mit dem URI-Attribut eine Seite inkludiert werden die nicht im gleichen IES-Modul (Web-Applikation) liegt, so kann mit diesem Attribut der Context eines anderen IES-Moduls (Web-Applikation) angegeben werden.
+:SPML-Seiten sind immer Teil einer [[Webapplication|Webapplikation]]. Die mit dem Attribut <code>uri</code> 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 <code>module</code> zu empfehlen, da hier die ID der Webapplikation angegeben wird.
+;<code>module</code>
+:SPML-Seiten sind immer Teil einer [[Webapplication|Webapplikation]]. Die mit dem Attribut <code>uri</code> 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 <code>context</code> vorzuziehen, da sich der Context einer Webapplikation ändern kann.
 ;<code>mode</code>
-:Mit diesem Attribut kann angegeben werden in welchem Moduls die includete SPML-Seite oder das includete Template ausgeführt werden soll.
+: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 Seite im [[In-Modus]] aus.
+::Führt das Template oder die SPML-Seite im [[Template-Modus|In-Modus]] aus.
 :;out
-::Führt das Template oder die Seite im [[Out-Modus]] aus.
+::Führt das Template oder die SPML-Seite im [[Template-Modus|Out-Modus]] aus.
+;<code>arguments</code>
+:Mit diesem Attribut können Argumente in Form einer [[Map]] übergeben, die mit <code>system.arguments</code> 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.
+;<code>return</code>
+: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====
+===Einfügen von Templates===
 Template Quelltext
@@ Zeile 86: / Zeile 113: @@
 <noinclude>
 [[Category:SP-Tags]]
-[[Category:Qualität_des_Inhalts_prüfen]]
-[[Category:Qualität_der_Sprache_prüfen]]
 [[Category:Qualität_des_Codes_prüfen]]
+[[Category:Beispiel_überarbeiten_testen]]
 </noinclude>