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: 3X Album¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Dmitry Dulepov |
Changed: | 2007-10-06T15:52:33 |
Author: | Dmitry Dulepov |
Email: | dmitry@typo3.org |
Info 3: | |
Info 4: |
EXT: 3X Album¶
Extension Key: album3x
Copyright 2000-2002, Dmitry Dulepov, <dmitry@typo3.org>
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: My Extension 1
Introduction 1
What does it do? 1
Screenshots 1
Users manual 1
FAQ 1
Adminstration 1
FAQ 2
Configuration 2
FAQ 2
Reference 2
Tutorial 2
Known problems 2
To-Do list 2
Changelog 2
Introduction¶
What does it do?¶
This extension makes an album from photos displaying a list of thumbnails, single mid-size image and full-size image in a popup. It also allows to put title and description for each image.
Extension comes with ready template and stylesheet. It also has special code to ensure search-engine friendly URLs for images in the album.
Screenshots¶
A reference to real demo will be here.
Users manual¶
User operations involve putting images on pages using Web>List view. Images are stored as "3X Album image" records. Extension will pick them up automatically.
FAQ¶
None yet.
Adminstration¶
Album is displayed by a plugin of type "3X Album". This plugin should be inserted on a page and page that contains images should be set in album's configuration. This way each page may represent its own album.
Alternatively plugin can be inserted through TypoScript and parameters can be set through TypoScript.
FAQ¶
None.
Configuration¶
Extension can be configured either as content element or through TypoScript. Content element configuration is self-explanatory. TypoScript configuration is described below.
FAQ¶
None yet
Reference¶
TypoScript configuration of the extension¶
thumbnailWidth¶
Property
thumbnailWidth
Data type
int
Description
Maximum width of the thumbnail. Thumbnail will fit to the box described by thumbnailWidth and thumbnailHeight
Default
150
thumbnailHeight¶
Property
thumbnailHeight
Data type
int
Description
Maximum height of the thumbnail. Thumbnail will fit to the box described by thumbnailWidth and thumbnailHeight
Default
112
midImageWidth¶
Property
midImageWidth
Data type
int
Description
Maximum width of mid-size image. Image will fit to the box described by midImageWidth and midImageHeight
Default
450
midImageHeight¶
Property
midImageHeight
Data type
int
Description
Maximum height of mid-size image. Image will fit to the box described by midImageWidth and midImageHeight
Default
335
columns¶
Property
columns
Data type
int
Description
Number of columns in the thumbnail view
Default
4
rows¶
Property
rows
Data type
int
Description
Number of rows in the thumbnail view
Default
3
storagePid¶
Property
storagePid
Data type
int
Description
uid of the page where images for this album are stored
Default
templateFile¶
Property
templateFile
Data type
resource
Description
Path to template file relative to site root. Can have "EXT:" prefix
Default
EXT:album3x/res/pi1.html
thumbnailCObj¶
Property
thumbnailCObj
Data type
COBJECT
Description
This cObject is used to generate thumbnail.
The following constants will be substituted with values from configuration:
$width – thumbnailWidth
$height – thumbnailHeight
$image – original image file name
Default
object
midImageCObj¶
Property
midImageCObj
Data type
COBJECT
Description
This cObject is used to generate mid-size image. See also thumbnailCObj for the description of special constants
Default
object
RealURL configuration¶
The following should be added to RealURL configuration "postVarSets" section:
'page' => array(
array(
'GETvar' => 'tx_album3x_pi1[page]',
),
),
'image' => array(
array(
'GETvar' => 'tx_album3x_pi1[showUid]',
'userFunc' => 'EXT:album3x/class.tx_album3x_realurl.php:&tx_album3x_realurl->main',
),
),
URLs will look like this assuming that album is located on the page entitled "Album":
http://yourdomain.tld/album/page/5/
http://yourdomain.tld/album/image/my_image_title/
If image has no title, than image file name will be converted to a valid variable segment. In case if title is not unique, underscope and image uid will be appended to the next image's URL segment with the same image title:
http://yourdomain.tld/album/image/my_image_title_5/
Tutorial¶
Coming...
Known problems¶
None known.
To-Do list¶
None yet