<we:banner>
Since version: 2.3.0.0 | Requires endtag: no | Required modules: banner
Description
The <we:banner> tag is a feature of the Banner/Statistics module and is used to include a banner on a Web page.
Attributes
name
Default value: - | since version: 2.3.0.0 | required: yes
The name attribute works like a reference for the banner tag. If you want to display more than one banner on a template, every <we:banner> tag must have a different name.
width
Default value: - | since version: 2.3.0.0 | required: no
Enter the width of the banners you want to display.
height
Default value: - | since version: 2.3.0.0 | required: no
Enter the height of the banners you want to display.
paths
Default value: - | since version: 2.3.0.0 | required: no
If you want to display only one or more specific banners, you have to write the paths of the banners as commaseparated values. You can also write the path of a banner group to display the banners of that group.
type
Default value: js | since version: 2.3.0.0 | required: no
If you select "js" as the type, or leave this attribute empty, the banner will be displayed using JavaScript on static pages. If JavaScript is disabled in the browser, the banner will be displayed as normal HTML (with an <a>- and an <img> tag). The browser uses a cookie to store the reference of the last shown banner, so that a user will be redirected to the correct page when clicking on the banner.
On dynmaic pages, the banner will be displayed as normal HTML (with an <a>- and an <img> tag). The reference of the banner will be passed with the URL.
If you select "iframe" as the type, the banner will be shown using an iframe, and on Nestcape 4 an ilayer. On browsers which do not understand an iframe or ilayer, the banner will be displayed as normal HTML (with a <a>- and a <img> tag). The browser uses a cookie to store the reference of the shown banner, so that with a click on the banner a user will be redirected to the correct page.
Allowed values:
jsiframecookiepixel
target
Default value: - | since version: 2.3.0.0 | required: no
Enter the target for the banner's link.
Allowed values:
Allowed values:
| Value | Description |
|---|---|
_top | The user agent should load the document into the full, original window (thus canceling all other frames). This value is equivalent to "_self" if the current frame has no parent. |
_parent | The user agent should load the document into the immediate FRAMESET parent of the current frame. This value is equivalent to "_self" if the current frame has no parent. |
_self | The user agent should load the document in the same frame as the element that refers to this target. |
_blank | The user agent should load the designated document in a new, unnamed window. |
link
Default value: true | since version: 2.3.0.0 | required: no
If set to "false", the banner will be displayed without a link.
Allowed values:
truefalse
clickscript
Default value: - | since version: 2.3.0.0 | required: no
Usually webEdition uses the file "/webEdition/bannerclick.php" as the "href" attribute for the <a> tag. If you want to protect the webEdition directory with an htaccess password or if you do not want to use the original script, you can make a PHP-script (external or as internal HTML page with extension .php) which includes "/webEdition/bannerclick.php". In this case, the path of the script has to be entered in this attribute.
getscript
Default value: - | since version: 2.3.0.0 | required: no
Usually webEdition uses the file "/webEdition/getBanner.php" as the "src" attribute for the <img>- and <iframe> tag. If you want to protect the webEdition directory with an htaccess password or if you do not wish to use the original script, you can make a PHP-script (external or as internal HTML page with extension .php) which includes "/webEdition/getBanner.php". In this case, the path of the script has to be entered in this attribute.
page
Default value: - | since version: 2.3.0.0 | required: no
Usually, the path of the page where a banner is displayed is shown in the statistics area of the banner module. If you want to display another path for the statistics, you can set the path in this attribute. This is useful if the statistic function is to be used in conjunction with the Newsletter Module on newsletter templates.
xml
Default value: - | since version: - | required: no
Setting this attribute to "true" generates code conforming to the XHTML standard. Leaving it unset or setting it to "false" generates HTML code.
Allowed values:
truefalse
cachelifetime
Default value: 0 | since version: 4.2.0.0 | required: no
With this attribute you define the validity of the Cache in seconds for this we:Tag. This attribute is used only if cache type defined in the template is we:Tag Cache or Cache is disabled.
Syntax
<we:banner name="attribute" [width="attribute"] [height="attribute"] [paths="attribute"] [type="js|iframe|cookie|pixel"] [target="_top|_parent|_self|_blank"] [link="true|false"] [clickscript="attribute"] [getscript="attribute"] [page="attribute"] [xml="true|false"] [cachelifetime="attribute"] />
Examples
Example 1 - Banner displayed with JavaScript
<we:banner name="banner1" type="js" width="468" height="60"/> or <we:banner name="banner1" width="468" height="60"/>
Example 2 - Displaying the banner in an iframe
<we:banner name="banner1" type="iframe" width="468" height="60" />
Example 3 - Displaying specific banners
<we:banner name="banner1" paths="/banner1,/group1/banner2,/group2" width="468" height="60"/>