DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Image Rotation

Author:Clemens Riccabona
Created:2006-09-28T23:12:51
Changed:2008-05-02T20:40:48
Classification:ric_rotation
Description:ric_rotation
Keywords:ric_rotation
Info 1:office@riccabona.biz
Info 2:Clemens Riccabona
Info 3:
Info 4:

EXT: Image Rotation

Extension Key: ric_rotation

Copyright 2000-2007, Clemens Riccabona, <office@riccabona.biz>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Image Rotation 1

Introduction 1

What does it do? 1

Most important features: 1

Screen shots 2

Users manual 2

Installation 2

Adding images and flash 2

Administration 4

FAQ 4

Configuration 4

FAQ 4

Reference 4

Known problems 5

To-Do list 5

Change log 5

Introduction

What does it do?

  • This extension is based upon macina_banners by wb@macina.com . It allows backend users to add banners (images and flash) to their website and to manage them. Since version 1.9.x this extension is able also to handle database records of type 'slideshow'.
  • For an example, more options in use, with great images in flash- slideshow mode: http://www.mountainstar.info/
  • Another, small example on our own page: http://www.pakfeifer- riccabona.com/

Most important features:

  • Support for Flash
  • Support for self composed Flash slideshows with ext:slideshow
  • Flash detection based upon 'ufo' – unobtrusive flash objects (look at ufo.js for further information about ufo)
  • Support for animated GIFs (be careful with resizing/-sampling!)
  • Most common image formats are supported (JPG, GIF, PNG, ...)
  • Images can be linked to internal and external pages.
  • Publishing of images and flash controlled by time.
  • Publishing of images and flash controlled by clicks - counter!
  • Publishing of images and flash controlled by views – counter!
  • Tow modes for displaying banners (random, all).
  • Full template support!
  • You can insert it directly in typo script (my preferred mode) or just as a PlugIn on page.
  • Banners can be grouped by positions (top, bottom, left, right).

Screen shots

- You can find the screen shots within the documentation! Don't worry!

Users manual

Installation

img-1

Just get it from the online repository and install it with a click on the gray bullet in the extension manager. If the bullet turns to green, you successfully installed the extension.

Adding images and flash

  • For better maintenance create a sysfolder first, where you put in all your banners. Just call it banner, or rotation images or something like that. But if you don't like a sysfolder for the banners, you can put it to every page you want. If you have a multi language page, create a translation of the sysfolder. The extension supports multiple languages.
  • Now click on the 'Create a new record' button and select the record type 'Banner':

img-2

Choose file type for your banner (image or SWF).

a

Choose file type for your banner (image or SWF).

If you choose type 'Flash slideshow' you first have to compose a flash slideshow with the extension 'slideshow'. If you created such a slideshow, you can insert this db record to ric_rotation. Anything else is done like with normal flashs, but with some more options like the style of transition etc.!

Flash banners

a

img-4 Screenshot how to include a flash banner

img-4 Screenshot how to include a flash banner

  • Point the File wizard to your Flash file.

a

  • Point the File wizard to your Flash file.

  • Enter the width of your Flash file.

    Note: Mandatory entry!

  • Enter the height of your Flash file.

    Note: Mandatory entry!

  • You can insert even a link!

Image banners
Image text

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

All banners:
Placement

Choose the location where banner will appear on websiteNote: (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”

Don't 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)

Click count

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

Click Quota

This is the maximum number of times a banner can be clicked before it is hidden from the frontend. Leave empty or 0 if you don't need this.

View Quota

This is the maximum number of times a banner is shown, until it is hidden from the frontend. Leave empty or 0 if you don't need this.

Start Stop

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

Access

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

Administration

FAQ

Configuration

FAQ

Sub headlines

Reference

pidList

Property

pidList

Data type

Array of integer values

Description

Here you define where your records are stored

Default

empty

recursive

Property

recursive

Data type

Integer

Description

Here you decide how many levels beneath your storage folder will be searched for records recursivley

Default

0

placement

Property

placement

Data type

String

Description

Possible values: top, bottom, left, right

Default

top

::

Property

mode

Data type

String

Description

Possible values: all, random

Default

all

::

Property

results_at_a_time

Data type

Integer

Description

How many items should be shown at one time. Only in mode 'all' available

Default

100

::

Property

image.file.maxW

Data type

Integer

Description

Maximum width of image in pixels

Default

800

::

Property

image.file.maxH

Data type

Integer

Description

Maximum hight of image in pixels

Default

::

Property

flash.file.maxW

Data type

Integer

Description

Maximum width of flash files in pixels

Default

800

::

Property

flash.file.maxH

Data type

Integer

Description

Maximum height of flash files in pixels

Default

100

[tsref:(cObject).TEST]

((generated))
Example

There are two possibiltities to show the rotating items (image, flash, slideshow) on your frontend. The first one is, to include ric_rotation static to your template, and then make a Content Element of type 'Bannermodule'. Only few options are to set here. The startingpoint is the sysfolder where you are storing your banners.

A better way to include the rotation, is the way with typoscript. As an example, directly taken from http://www.pakfeifer-riccabona.com/

objPage = PAGE

objPage.typeNum = 0

objPage {

includeLibs.gmenu_layers = fileadmin/ric_gmenu_layers-4.0.php

includeLibs.tmenu_layers = fileadmin/ric_tmenu_layers-4.0.php

headerData.1 < plugin.meta

headerData.2 < plugin.tx_cssselect_pi1

shortcutIcon = fileadmin/favicon.ico

stylesheet = fileadmin/styles.css

1013 < plugin.tx_deaddbodyjscript_pi1

10 = TEMPLATE

10 {

template = FILE

template.file = fileadmin/design.tmpl

workOnSubpart = CR_DOCUMENT

marks {

CR_NAV_TOP < temp.objNavTop

CR_LOGO = IMAGE

CR_LOGO {

file = fileadmin/logo.gif

stdWrap.wrap < temp.logoWrap

}

CR_BANNER_TOP < plugin.tx_ricrotation_pi1

CR_BANNER_TOP {

placement=top

mode=random

pidList=5

recursive=0

image.file.maxW=750

image.file.maxH=110

}

CR_CONTENT < plugin.tx_rlmptmplselector_pi1

CR_NAV_SERVICE < temp.objNavService

CR_ICON_HOME < temp.objHome

CR_ICON_PDF < temp.objPdf

CR_ICON_PRINT < temp.objPrint

CR_ICON_SEARCH < temp.objSearch

CR_TIP_A_FRIEND < temp.objTipAFriend

}

}

}

Known problems

No problems at the moment, but some feature requests. Look at the To- Do list!

To-Do list

  • By now, the flash rotation integration is done through the extension 'slideshow' and this makes ric_rotation dependend from slideshow. This 'lack of beauty' should be corrected with upcoming major version 2.0. Even the latest version of the jpgrotatator.swf (imagerotator.swf called now) should be integrated.
  • More swf-player options should be configureable through the flexform and TypoScript.
  • Wrapping table should be replaced with a div container.
  • Basic click and view statistics, probably on a 'per month' base.
  • Import tool for users who want to switch from macina_banners.

Change log

Version 1.9.13

Version

Version 1.9.13

Changes

Switched to better onload-handler (for huge flashs); Added ID of flash to html and js-function call for having more than one flash item on same page (takes only effect if you are updating your own templates, or using the defaults); Thanks to Peter Embacher for providing the solution; Changed raised dependencies of php and TYPO3; Updated manual;

Version 1.9.12

Version

Version 1.9.12

Changes

Some code cleanings; (should now hopefully work with dbal too). New feature alternative image for flash items (one global via TS and separate images on each flashitem through editor possible; linked to adobe flashplayer download). Flash width and height now set by default from TS to w=800, h=100

Version 1.9.11

Version

Version 1.9.11

Changes

Workaround for IE domReady bug while creating flash object. ATTENTION: If you made your own temlates, you may have to update them if you want to have the new workaround running (it wont break your installation, the workaround just would be ignored).

Version 1.9.10

Version

Version 1.9.10

Changes

Corrected typo3 and php dependencies, code cleaning.

Version 1.9.9

Version

Version 1.9.9

Changes

1. Security issue, possible mysql injection, thanx to Georg Ringer; 2. Major Flashversion default set back to 7; 3. Changed flash-alternative p-tag to div - SEO issue;

Version 1.9.8

Version

Version 1.9.8

Changes

Special version for world-direct.at with required Flashversion set back to 8.0.

Version 1.9.7

Version

Version 1.9.7

Changes

Also .flv files now are allowed, changed swf wrapping element ID from 'player' to 'ric-rotation-swf', updated manual, updated typo3 version dependency typo3 4.0 – typo3 4.1

Version 1.9.6

Version

Version 1.9.6

Changes

  • Added classnames to wrapping table, tr and td
  • Added some Flash Params (e.g. wmode=transparent) to the template to allow imagelightbox, etc. to be 'on' the flash

Version 1.9.5

Version

Version 1.9.5

Changes

This Version of ric_rotatation should now bugfree provide flashs form EXT:slideshow. Flashdetection now xhtml and crossbrowser compatible. Dependencies now: EXT:slideshow!

Version 1.9.2

Version

Version 1.9.2

Changes

Fixed dependency error api_macmade. Now, this extension requires api_macmade.

Version 1.9.1

Version

Version 1.9.1

Changes

Sorry, a bad mistake, only slideshows with the uid1 were displayed, now fixed :-)

Version 1.9.0

Version

Version 1.9.0

Changes

- Added possibility using ext:slideshow for composing own flashs

- More fields now exclusive fields, you may need re-configure your users!

- If flash selected, only swf files are allowed now!

Version 1.2.7

Version

Version 1.2.7

Changes

Updated Manual; Fixed bug – Clicktag and RealURL problem, Thanks to Alexander Heidl!

Version 1.2.6

Version

Version 1.2.6

Changes

Hopefully the manual would now be rendered correct ;)

Version 1.2.5

Version

Version 1.2.5

Changes

Testupload for providing a manual, changes to version compatibility concerning typo3 ver: 4.0.2

Version 1.2.4

Version

Version 1.2.4

Changes

Bug fixed: Senseless logging of huge cObj array on stderr

Version 1.2.3

Version

Version 1.2.3

Changes

Some changes for upcoming major version (2.0.0)

Version 1.2.1

Version

Version 1.2.1

Changes

Added a file which is doing nothing at the moment. (Preparations for upcoming major version)

Version 1.2.0

Version

Version 1.2.0

Changes

Now it is possible to set a maximum amount of views and a maximum amount of clicks (also called quotas) for each banner. If the maximum is reached the banner is set to hidden. If set to null the behavior is like in former versions.

Version 1.1.1

Version

Version 1.1.1

Changes

Correct compatibility settings concerning typo3 and PHP; More detailed informations in list of page view which should improve the backend usability.

img-5 EXT: Image Rotation - 6