{module_adrotator}

Description

This module outputs the individual Ad-Rotator, which randomly displays a group of HTML, images or Flash media when your browser is refreshed.

Syntax

{module_adrotator render="item" collection="my_custom_collection_name" adrotatorid="123" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet. Along with that you cannot use template="" to suppress the output and use the Liquid collection in the same page due to caching capabilities of BC.

Parameters

  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • collection - use this if you need to access the module's Liquid output tags
  • ID - this parameter is assigned by the system and should nor be altered
  • template - render the module using a custom template.

This module can be rendered using:

  • a single image nested in a hyperlink - when the user clicks the image he is taken to the URL specified in the "Click-Thru URL" field.
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Description
{{id}} The Ad rotator's ID
{{itemLabel}} The image's label
{{itemSource}} The URL of the image currently on display
{{itemClickUrl}} The URL the site is redirected after clicking the image
{{itemId}} The individual ID of the image
{{itemFrame}} Whether the "Click-Thru URL" is opened in a new window or in the current one
{{itemWidth}} The image width
{{itemHeight}} The image height
{{itemType}} The item's type (image, Flash or HTML)

Examples

  • {module_adrotator adrotatorid="15264"} - This generates the ad rotator with the ID 15264

Syntax

{module_adrotator,ID}

Parameters

  • ID - this parameter is assigned by the system and should nor be altered

Examples

  • {module_adrotator,15264} - This generates the ad rotator with the ID 15264