This page is still a beta!

1.2. Users manual

Installation

To use the extension, connect to the Extension Repository through your extension manager and install it by clicking the “plus” Icon (extkey:macina_banners).

Installation Configuration

activateDefaultCategories

If set macina_banners will provide default categories e.g. top

renderMode

Decide how the categories should be selected:two_boxes

singlebox

checkbox

Add Banner Categories

To group your banners, or for better maintenance create a sysfolder: Call it “Banner” and create your banner records in there.Note: Bannercategories can be added only to sysfolders. Note: To use the localization feature in the List Module create a translation of the sysfolder.

Click the “Create new record” and select Record Type “Banner Category”.

Edit the following data in the Categoriy Form

Description

Choose a description for your categorieNote: This field can be used in TypoScript for “placement”

Icon

Choose an that stands for your categoryNote: The Icon is only rendered in the forms if renderMode is “checkbox” ( See Installation )

Add Banners

To group your banners and categories, or for better maintenance create a sysfolder: Call it “Banner” and create your banner records in there.Note: Banners can be added to every page, not only to sysfolders. Note: To use the localization feature in the List Module create a translation of the sysfolder.

Click the “Create new record” and select Record Type “banner”.

Edit the folowing data in the FlexForm (see  Image 1)

Banner type

choose file type for your banner (image or swf)

Flash banners:

Flash banner

Point the File wizard to your Flash file.

Width of Flash movie

Enter the width of your Flash file.Note: Mandatory entry.

Height of Flash movie

Enter the height of your Flash file.Note: Mandatory entry.

Click count

Auto-incrementing field which counts the clicks of the Banner. (Don't enter anything).

Image banners:

Banner image

Point the file wizard to your banner file.

Image text

Enter the text which will be shown as alttext on the banner

HTML banners:

HTML

Add your custom HTML Banner Code

All banners:

Parameters

Enter a list of parameter names with values, one parameter per line. For Example: RegionID_cbo = 13,17 will enable the banner if the URL Parameter : RegionID_cbo has the value 13 or 17.Note: To enable this feature you have to set the TS Parameter enableParameterRestriction to 1. CAUTION! If enableParameterRestriction is set to 1, ONLY Banners with matching Parameters are displayed. If you set enableParameterRestriction, the page will not be cached!

Link

Point the link wizard to an internal or external target

Placement

Choose the location where banner will appear on website Note: (Locations must exist in the Template or banner plugin in order for the banner to be shown!)

Show banner on Pages ONLY

Point link wizard to the pages where the banner will appear.Note: If no pages are selected, the banner will appear on ALL Pages

Including Subpages

Check this and the banner will be visible on all subpages of the selected pages in “Show banner on Pages ONLY”

DONT show Banner on THESE Pages

Point link wizard to the pages where the banner will not appear.

Customer

Enter the name of your advertising customer. For maintenance only; will not be shown.

Impressions

Auto-incrementing field which counts the number of impressions of the banner. (Don't enter anything)

Start Stop

Enter date/times to create a timeframe for the banner to be shown.

Access

Limit access by entering Frontend groupsNote: Banner will only be shown if this group is logged in!

Add banner module as content element

Switch to your Typo3 Backend and point the page module to the page where you want to add the Bannermodule.Click “new content”.Choose Bannermodule from the Plugins section:

Plugin

Shows Bannermodule as a plugin

Placement

Select Plugin PositionNote: With this selection  you decide which banners the plugin will show. Select top to show all banners which are assigned to Top.

Mode

Choose if module shows ALL, or a single random banner or All Banners in random orderNote: If you choose random, the page with the random banner will not be cached!

Startingpoint

Point the link wizard to the pages where your banners are storedNote: The plugin will only show banners from this locations

Recursive

Choose the depth to search for banners.

Add Clicktracking to Flash banners

To add click tracking to your Flash banner, use the 2 Variables “clickTag” and “target” which are passed to the Flash banner via the OBJECT EMBED Tag.

Create a MovieClip with the InstanceName “content” and assign the following handler to the onRelease Event:

ActionScript 2 Code:

if (clickTAG.substr(0, 5) == "http:" || clickTAG.substr(0, 6) == "https:") {
contentClip.onRelease = function() {
getURL(clickTAG, target);
};
}

Or create a Button and put the following script to your Button:

ActionScript 1 Code:

on (release) {
if (clickTAG.substr(0,5) == "http:"| | clickTAG.substr(0, 6) == "https:") {
getURL(_root.clickTAG, _root.target);
}
}

Note: The ActionScript in this Flash banner is verifying that the clickTAG URL begins with "http:" or “https:”. This is an important security measure. If you do not take this precaution, a malicious HTML page could source your SWF and pass a clickTAG URL that begins with "javascript:" or another scripting pseudo-protocol. If your ActionScript code were to call getURL with a maliciously crafted JavaScript URL, it would be possible for the site serving the malicious HTML page to obtain the contents of your HTTP cookies or perform other actions on your site's behalf.

Add banner module to template

As an alternative to the plugin method, you can add the banner module with TypoScript to your template.Note: You can add multiple modules to the page to use different locations like left, right, top and bottom.

EXAMPLE

To add the banner module to your site template, create a marker in your HTML template:  ###bannertop###.

Add this code to your main TS Template to substitute the marker with the plugin:

temp.bannertop < plugin.tx_macinabanners_pi1
temp.bannertop {
# show banners with this attribute, default options are: "top, left, bottom, right", all Descriptions of Banner Categories can be used
placement = top
#mode to show banners. Options are: all, random
mode = all
# list of page IDs where the banners should be taken from (comma seperated. i.e.: 1,5,7)
pidList = 18
# levels of recursion to search for banners
recursive = 0
# Limit number of banners
results_at_a_time = 3
}
marks.bannertop < temp.bannertop

IMAGE

Example how to use the image configuration with GIFBUILDER:

temp.bannertop < plugin.tx_macinabanners_pi1
temp.bannertop {image { file = GIFBUILDER file { XY = 468,60 10 = IMAGE 10.file = field_image 10.file.maxW = 468 10.file.minW = 468 10.file.maxH = 60 10.file.minH = 60 10.altText = field_alttext10.align = c,c}}} 

Note: The Parameters:  field_image and field_alttext are Placeholders for the actual “Bannerimage” and “Image Text” from the Banner Record.