OpenWGA 5.4 - WebTML reference

WebTML tags


Description :
Including resources into the current page.
Derived from: Attributes:
show inherited attributes ...
Name Value(s) Purpose
ajax true|false Enables AJAX for included portlets if type="portlet"
designdb database key Defines from which application a WebTML module should be included
encoding Textkodierung Defines the text encoding of a URL resource if type="url"
keepoptions Options-Name, Option-Name, ... Specifies WebTML options with a local scope, which are provided in the included WebTML module.
key Portlet-Key Defines, if type="portlet", the key of the portlet to inculde
linkaction Action-ID Redirects all links and URLs in the portlet to a WebTML action
linkmedium mediakey Determines the media key that included WebTML code uses to generate links
medium Medienkey used with type="tml|innerlayout|portlet": if defined the layout will be rendered in this medium 
name Portlet-Name Addresses the included portlet per portlet name
o_option value Shorthand for defining WebTML-Options
portletmode portlet mode Defines on type="portlet" the basic portlet mode to set for the included portlet.
ref WebTML-Modul | URL reference to included resource
timeout Millisekunden Defines a timeout for loading URL resources if type="url".
tmlscope scope Sets the WebTML scope for the WebTML Tags of an included WebTML module
type="innerlayout" innerlayout Includes the WebTML module which is defined as inner layout in the content type of the current document. With the attribute medium the medium of the layout could be chosen.
type="portlet" portlet Includes a WebTML portlet
type="tml" tml Includes the WebTML modul given in the attribute  ref.
type="url" url Embedding of externa Websites with URL.

With this tag you war able to include resources in the current WebTML page like other WebTML pages or HTML pages(per URL).

In most cases it is used with attribute type="tml" (default) to include WebTML modules by their name with attribute ref.
<tml:include ref="sidebar"/>

There is also a short form.

With the tag <tml:option> you can configure the behavior of an included TML module
<tml:include ref="sidebar">
    <tml:option name="type">plain</tml:option>

There is also a short form.
<tml:[sidebar] o_type="plain"/>

The use of two short forms can be combined.

The text body of the include tag will be accessible in the included WebTML module via WebTML option "body" (if there is no other option named "body") The following two code segments are equal.
<tml:include ref="sidebar">
    <tml:option name="body">

<tml:include ref="sidebar">

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

includes the TML designelement "tml-element".

<tml:include type="url" ref=""/>

adds the content of the page "" to the current

<tml:include ref="windowview">

    <tml:option name="body">
      Hallo Welt

Iincludes the TML designelement "windowview" into the current page. The TML design element gets the parameter via "body"