Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

1.4. Configuration

Please read the chapter you need.

rgslideshow in “Text with images”

If you followed the installation steps you only need to activate the check box “rgslideshow”.

A click on the image will do nothing. If you enable “click 'n' enlarge”, you will get the big image in a popup. If you want a cool Lightbox, follow the next steps.

Usage of pmkslimbox

Demonstration: http://www.rggooglemap.com/dev/rgslideshow/slideshow-mit-pmkslimbox.html

Install the extension pmkslimbox and use the static TS file “Slideshow & pmkslimbox”. Now just enable the “click 'n' enlarge” checkbox.

Note: Don't include both files!

Usage of perfectlightbox

Demonstration: http://www.rggooglemap.com/dev/rgslideshow/slideshow-mit-perfectlightbox.html

Install the extension perfectlightbox and use the static TS file “Slideshow & perfectlightbox”. It is necessary to use Mootools and not prototype. This is already preconfigured by me. Now just activate the correct checkboxes!

Note: Don't include both files!

rgslideshow as teaser (with the plugin)

Examples for tt_news, fe_users & tt_content are available online.

To use the rgslideshow as record teaser you just need to follow the installation steps and the administration chapter. After that you can insert the plugin on your page and select any (allowed) record you want to.

The image will link to the original record but you need to achieve this you need to configure the extension first. I already set up 3 examples. Every configuration follows a strict schema:

# TS Code
01 plugin.tx_rgslideshow_pi1 {
02 # Enable the slideshow for records of the table tt_products
03tt_products = 1
04tt_products {
05# The position in the image filed, here the 1st image (starts with 1!)
06position = 1
07# The field name where the title is saved
08titleField = title
09# The field name where the description is saved
10descriptionField = note
11# The field name where the image is saved
12imageField = image
13
14# Enable the link to the record
15link = 1
16link {
17# Link configuration is a normal typolink, everything is possible here
18
19# The uid of the detail page
20parameter = 52
21# use the chash
22useCacheHash = 1
23# add the necessary parameters
24additionalParams = &tx_ttproducts_pi1[product]={field:tx_rgslideshowUid}&tx_ttproducts_pi1[backPID]=53
25additionalParams.insertData =1
26
27# some extra attributes for the link
28ATagParams = title="{field:tx_rgslideshowTitle}" alt="{field:tx_rgslideshowTitle} {field:tx_rgslideshowDescription}"
29ATagParams.insertData = 1
30}
31}
32 }

Some further explanations

Line-Numbers

Description

03

Defines the used table

06

You could define that always the 2nd image is taken (if not available, the 1st is used as fall back)

08-12

Which field names should be taken to build the image teaser. You need to add valid values because otherwise you will get SQL errors

15

Enable a link for the image. This is not required because you can also just show images without linking to anything

17-29

This is a normal typolink function and you will find all information about it in the TsRef: http://typo3.org/documentation/document-library/references/doc_core_tsref/4.1.0/view/5/8/

To enable links to a detail page you have some extra fields available which you can use you like it:

  1. tx_rgslideshowTable: The used tablename

  2. tx_rgslideshowPid: The pid of the record (not of the plugin!)

  3. tx_rgslideshowUid: The uid of the record

  4. tx_rgslideshowTitle: The title from the specified field (titleField)

  5. tx_rgslideshowDescription: The description from the specified field (descriptionField)

  6. tx_rgslideshowFile: The path and file name to the actual image

Advanced configuration

Besides of the cool possibilities you already get there is still more. The title and description of every image got full stdWrap functionalities!

Example 1

Take a look at this page: http://www.rggooglemap.com/dev/rgslideshow/slideshow-teaser-von-tt-content.html to get an idea of what I mean. The description is getting overwritten by the url to the page where the content is shown.

plugin.tx_rgslideshow_pi1 {
  # link config for content elements
        tt_content = 1
        tt_content {
                position = 1
                titleField = header
                descriptionField = uid
                imageField = image
                link = 1
                link {
                        parameter.field = tx_rgslideshowPid
                        parameter.wrap =|#{field:tx_rgslideshowUid}
                        parameter.insertData = 1
                        useCacheHash = 1
                }
                description.override.cObject = COA
                description.override.cObject {
                        10 = TEXT
                        10.noTrimWrap=| Dieser Content ist auf dieser Seite:| |
                        20 = TEXT
                        20.typolink.parameter.field = tx_rgslideshowPid
                        20.typolink.returnLast = url      
                }       
        }   
}

Example 2

The 2nd examples adds the tablename to the title. This can be seen here: http://www.rggooglemap.com/dev/rgslideshow/slideshow-teaser-gemischt.html

plugin.tx_rgslideshow_pi1 {
        fe_users = 1
        fe_users {
                ...
                title.stdWrap.dataWrap=  | ({field:tx_rgslideshowTable})
        }      
        tt_news = 1
        tt_news {       
                ....
                title.stdWrap.dataWrap= | ({field:tx_rgslideshowTable})
        }
}

rgslideshow as image slideshow (with the plugin)

Since version 1.1.0 it is possible to just show some images with the slideshow.

Insert the plugin at your page and select at the flexforms “Pick your images” or “Pick your directory” and select either plain images  or a directory. Use the extension rgfolderselector to get a directory picker.

Add a description

You are able to add a description to every image which will get shown underneath each image (as in the screenshots shown) by using the description field with the following syntax:

<Title > | <Description> | <Link>

You can link e very image by just adding a link parameter. Take a page-ID or an url or an emailadress (it is just a typolink).

Add a Lightbox to the slideshow

It is very easy to use the Lightbox-feature for the slideshow. Install and include the extension perfectlightbox  and configure it to use Mootools with the following code. You also need the extension t3mootools (Take a look at its manual for help configuring it):

# TS CONSTANTS (!)
plugin.perfectlightbox.libraryToUse = mootools
plugin.perfectlightbox.includeJSLibrarys = 1
plugin.perfectlightbox.mootoolsPath = EXT:t3mootools/res/mootoolsv1.11.js

Now you need to enable the lightbox

# TS Code (Setup)
plugin.tx_rgslideshow_pi1.image {
#enable imageLinkWrap to the Image
imageLinkWrap =1
  imageLinkWrap { 
  enable =1
  typolink {
  # Link to the Image in big
  parameter.override.cObject = IMG_RESOURCE
  parameter.override.cObject.file {
  import.field = tx_rgslideshowFile
  maxH  = 400
  maxW = 700
  }
# Either use "[lb{field:uid}]" , "[presentlb{field:uid}]" , "[lb{field:uid}slideshow]" or "[{field:uid}slideshow]"
# to get the different possibilities of the perfectlightbox
ATagParams = rel="lightbox[presentlb{field:uid}]"
ATagParams.insertData = 1
title = {field:tx_rgslideshowTitle}: {field:tx_rgslideshowDescription}
title.insertData = 1
  }
  }
}

If you want to use another Lightbox extension light pmk_slimbox, just change the TS code accordingly to this extension.

Reference

rgslideshow inside a content element and rgslidehow as teaser need to be configured independently from each other. Both can be configured through the Constant Editor:

  1. Choose RGSLIDESHOW for inside content elements

  2. Choose RGSLIDESHOW_PLUGIN for the usage in plugins.

Property:

Data type:

Description:

Default:

slideInterval

int

For an automatic slideshow enter the time in ms (2000 = 2 secs!)

0

bigNavigation

boolean

Enable the small navigation consisting of 2 images at the sides of the image

1 in a CE

0 in the plugin

smallNavigation

boolean

Enable the small navigation consisting of a previous & next link/icon

1 in a CE

0 in the plugin

imageBrowser

boolean

Enable the image browser below the images

1 in a CE

0 in the plugin

prevText

string

The text of the link to the previous image

"&laquo; "

nextText

string

The text of the link to the next image

" &raquo;"

playText

string

The text of the link to start the slideshow

"&infin;"

stopText

string

The text of the link to stop the slideshow

"&phi;"

width

string

The width of the images/plugin

Just available for the plugin-version!

400

height

string

The height of the images/plugin

Just available for the plugin-version!

300

image

stdWrap

Manipulate the whole  image using stdWrap, Take a look at the lightbox-snippet to know  how.

respectProportions

boolean

If enabled, to resize the images maxW/maxH is taken instead of width/height

Just available for the plugin-version!

0

pathToMootools

string

The path to the Mootools library

EXT:rgslideshow/res/mootools.v1.11.js

pathToScript

string

The path to the JavaScript for the slideshow

EXT:rgslideshow/res/rgslideshow.js

pathToCSS

string

The path to the CSS file for the slideshow  

EXT:rgslideshow/res/rgslideshow.css

[tsref:plugin.rgslideshowPLugin ]

[tsref:plugin.rgslideshow ]