Dokumentation: include

Einbetten von Ressourcen in die aktuelle Seite.

Vererbte WebTML-Attributes sind ausgeblendet -> Anzeigen
Name	Wert(e)	Verwendung
ajax	true\|false	Aktiviert bei type="portlet" die AJAX-Funktionalität für das einzubettende Portlet
designdb	Datenbank-Schlüssel	Bestimmt aus welcher Design-Datenbank ein einzubindendes WebTML-Modul entnommen werden soll
encoding	Textkodierung	Forciert bei type="url" eine Textkodierung in welcher die URL-Ressource geladen werden soll
keepoptions	Options-Name, Option-Name, ...	Spezifiziert WebTML-Optionen mit lokalem Scope, welche einem einzubindenden WebTML-Modul zur Verfügung gestellt werden sollen.
key	Portlet-Key	Bestimmt bei type="portlet" den Schlüssel des Portlets welches eingebettet werden soll
linkaction	Action-ID	Leitet alle Links/URLs im eingebetten TML-Modul so um, dass sie anstelle des verlinkten Dokumentes die hier spezifizierte TML-Aktion aufrufen.
medium	Medienkey	Bei type="tml\|innerlayout\|portlet": Wenn angegeben wird das eingebundene Layout in diesem Medium gerendert.
name	Portlet-Name	Adressiert ein einzubettendes Portlet per Portlet-Namen
o_option	Optionswert	Kurzform zur Definition von WebTML-Options
ref	WebTML-Modul \| URL	Referenz auf die einzubettende Ressource
timeout	Millisekunden	Gibt bei type="url" einen Timeout an nach welchem das Laden der URL-Ressource abgebrochen werden soll.
type="innerlayout"	innerlayout	Bettet das WebTML-Modul ein, welches im Seitentypen des aktuellen Dokumentes als inneres Layout definiert ist. Über das Attribut medium kann optional das Medium dieses Layouts angegeben werden.
type="portlet"	portlet	Bettet ein WebTML-Portlet ein
type="tml"	tml	Einbetten des in Attribut ref angegebenen WebTML-Moduls
type="url"	url	Einbetten von anderen Webseiten per URL.

Über diesen Tag können weitere Ressourcen in die aktuelle WebTML-Seite eingebettet werden, wie andere WebTML-Module oder HTML-Seiten die per URL herangezogen werden.

Die häufigste Verwendung ist es jedoch, per type="tml" ein beliebiges WebTML-Modul einzubinden, welches per Attribut ref angegeben wird.

<tml:include ref="sidebar"/>

Für diese Verwendungsform gibt es eine Abkürzung, in welcher sie den Namen des addressierten WebTML-Moduls direkt als Tagnamen - eingeschlossen von eckigen Klammern "[]" - verwenden:

<tml:[sidebar]/>

Der Inhalt des Include-Tags wird häufig verwendet, um dem eingebundenen Modul per Tag <tml:option> WebTML-Optionen mit auf den Weg zu geben, welche sein Verhalten konfigurieren sollen:

<tml:include ref="sidebar">
    <tml:option name="type">plain</tml:option>
</tml:include>

Auch hierfür existiert eine Kurzform, in welcher sie den Optionsnamen mit Präfix "o_" als Attribut des Include-Tags benutzen, dessen Wert zum Optionswert wird. Kombiniert mit der vorherigen Kurzform sähe dies wie folgt aus:

<tml:[sidebar] o_type="plain"/>

Die Verwendung der beiden Kurzformen kann beliebig kombiniert werden.

Der Textinhalt des Include-Tags wird dem eingebundenen WebTML-Modul automatisch als WebTML-Option "body" übergeben (falls nicht schon anderweitig eine Option "body" definiert wurde). Die beiden folgenden Include-Verwendungen sind also (bis auf geringfügige Whitespace-Unterschiede) identisch:

<tml:include ref="sidebar">
    <tml:option name="body">
        MyBody
    </tml:option>
</tml:include>

<tml:include ref="sidebar">
    MyBody
</tml:include>

Die implizite Option "body" ist grundsätzlich von lokalem Scope.

<tml:include ref="tml-element"/>

included das TML-Designelement "tml-element".

<tml:include type="url" ref="http://www.innovationgate.com"/>

Fügt den Inhalt der Site "www.innovationgate.de" in die Seite ein.

<tml:include ref="windowview">

Hallo Welt

</tml:include>

fürgt das TML-Designelement "windowview" in die Seite ein. Dem TML-Designelement wird der Paremeter "body" übergeben.

<tml:include>