Prints all banners from one or more banner groups.

Description

To select a particular banner group, use either the group's ID number (by setting the group attribute) or the manually set codename (by setting the name attribute).

To print banners from multiple groups, indicate as the group or name attribute's value the ID numbers or codenames of all relevant groups separated by the pipe character.

The default content of the {Banner} tag is printed for each banner by default. To modify the output as you see fit, use banner tags in the helper attribute.

Learn more about banners from our user guide.

Syntax

{Banners(
    group: int,
    name: string,
    limit: int,
    sort: string,
    helper: string,
    classes: string
)}

Scope

Required scope: globaali

Scope in helper attribute: banneri

Tags with global scope can be used on any template and in any tag.

Attribuutit

group:

The ID numbers of selected groups separated by pipes.

Allowed values: a list of integers separated by pipes

E.g. group: 2 or group: '2|4|7'

name:

The codenames of selected groups separated by pipes.

The codenames can be found in the banner groups' details in the admin panel.

Allowed values: a pipe-separated list of strings

E.g. name: 'etusivu' or name: 'etusivu | tuoteryhmasivu'

limit:

Sets the maximum length limit to the list to be printed. If there are more banners than allowed by the maximum length, the banners to be printed will be selected based on the sort attribute.

If you don't give any value to the limit attribute, all banners will be printed.

Allowed values:integers

sort:

Defines how the banner list should be sorted.

Allowed values:

helper:

Defines the content and output format of a single list element.

Allowed values: the Interface and HTML markup that define the output's markup and content.

The helper attribute can be used in two ways:

  1. you can indicate the desired markup directly as the attribute's value, or
  2. you can indicate a reference to a file with the desired markup as the attribute's value.

    The reference should be indicated in relation to the theme's root directory.

See also detailed instructions on using the helper attribute.

classes:

Class names that are given to every list element.

Allowed values: class names as strings.

Use space characters to separate the classes that are to be given to the same element. Use pipes to separate the classes that are to be given to different list elements.

E.g. classes:'ekaLuokka tokaLuokka | jokaToisenLuokka jokaToisenTokaLuokka'

See also detailed instructions on how to define list class names.

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:The HTML and Interface markup

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:The HTML and Interface markup

E.g. or:'Sisältöä ei löytynyt.'