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: Photogallery

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Christian Ehret
Changed:2007-12-23T15:18:51
Email:chris@ehret.name
Info 2:Christian Ehret
Info 3:
Info 4:

EXT: Photogallery

Extension Key: ce_gallery

Copyright 2007, Christian Ehret, <chris@ehret.name>

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

((generated))

Table of Contents

Copyright 2

Credits 2

Sponsors 2

Introduction 3

What does it do? 3

Screenshots 4

Requirements 8

Users Manual 9

Administration 12

Known Problems 16

To-Do List 17

Change Log 18

Introduction

What does it do?

The photo gallery extension provides the functionality to create a web based photo gallery. It uses the Digital Asset Management (DAM) of TYPO3 to store and manage the pictures and only takes care to display the photos in albums (which are DAM categories). There are two possibilities to display the detail pages. One possibility uses “regular” HTML for the detail page and a Javascript based slide show, the other possibility uses AJAX for the display page and also for the slide show.

For the Javascript-based slide show the MOO.FX library ( http://moofx.mad4milk.net/ ) and a modified version of jondesign's smooth slide show ( http://smoothslideshow.jondesign.net/ ) is used.

The AJAX Version uses the slimbox extension of Peter Klein which can be downloaded from the TER ( http://typo3.org/extensions/repository/ )

The look and feel of the display pages can be influenced with cascading style sheets (CSS) – some parameters like the sizes of the images or how many images per row are displayed can easily be configured with flex forms. To save system resources the images are automatically resized and stored on the first time they are displayed. The next time the scaled images are used.

Screenshots

((generated))

View albums

img-1

A list of the selected albums, with a thumbnail, the name of the category, the date of the last entry – and if necessary – the page browser.

View contents of an album

img-2 The photos of an album are listed with their title and – if selected – a link to the original file. The name of the album (the title of the DAM category and the description are shown. A link for the slideshow and back to the overview are above the photos. If necessary, the page browser is also displayed.

Detail views

There are three kind of detail views depending on the configuration of the plugin. The title and description are provided by the DAM.

Detail view (no AJAX)

img-3

Detail view (Smooth Slideshow)

img-4

Detail view (Slimbox)

img-5

Slideshows

There are two slideshow variants available depending on you slimbox selection.

Slideshow – no Slimbox
img-6
Slideshow - Slimbox

img-7

Requirements

Extension Photoalbum (extension key: ce_gallery) requires TYPO3 4.0.0+ and PHP 4.1.0+.

Extensions Media (DAM) (dam) and Media>Categories (dam_catedit) are a prerequisite.

For the slimbox functionality PMK Slimbox (pmkslimbox) has to be installed – we recommend to use version 2.0.0+

Users Manual

The extension uses the DAM so first of all make sure that the extensions dam and dam_catedit are installed. You can download them from the TER http://typo3.org/extensions/repository/ Then the photos have to be uploaded and indexed within the DAM. Please consult the documentation of the DAM if you need any assistance how to do this.

At the moment ce_gallery uses the following fields from the DAM object:

  • Title
  • Description
  • Creation Date
  • Alt Text (www)

A DAM category specifies an album in ce_gallery. For each album one category has to be defined. You can place this categories anywhere in the category tree.

Install ce_gallery with the Extension Manager. You are asked for the Type ID for the slideshow – if you use that ID for any other functionality you can change it – otherwise leave it like it is:

img-8

To insert the gallery on a page you should first check your template. You can do this modifications on the root template of your site or on an extension template of the page where the gallery sits in.

If you would like to get a CSS include the static template “Photogallery (CSS) (ce_gallery) – you get some ideas on how the CSS could be look like. You can use this CSS as it is, override some settings with your own CSS or only use your own CSS (you do not need to include the static template then):

img-9

If you would like to use slimbox the following static templates has to be included in the given order:

img-10

Next you have to insert a plugin on the page where you want to place the photo gallery:

img-11

Chose “Photogallery” from the dropdown of the plugin settings

img-12

and confirm the dialog.

A flex form with four tabs makes it possible to easily configure the display of the gallery in the frontend.

((generated))

((generated))

General

img-13

On the “General” Tab you make the decision if you want to use the Slimbox functionality or not. If you select it, you can define the delay for the Slideshow. If you like random images on the album overview pages, check the checkbox for “Random album image”.

Thumbnails

img-14

First of all you can set the dimensions and the quality of the thumbnails. This information is used for creating the scaled thumbs. Then you can specify how many thumbnails you like on one page and how many in one row. The “Order by” selection gives you several choices for the sorting of the images in one album. This sorting is also used for the slideshows. You can insert a link to the original image (not scaled) with selecting “Fullscreen link”.

Detail view

img-15

You can specify the dimensions of the pictures in the detail view. These dimensions are also used for the slideshows.

Categories

img-16

On the right hand side you see the DAM category tree. You can select one or more category on sort them on the left hand side. If you select “Recursive” albums of the next level are automatically inserted – in the example the “Scheffauer” album will be displayed. If you view this album in the frontend you will see the two child albums “Aufstieg” and “Abstieg” and – if avaiable – the photos of the album “Scheffauer” itself. This logic only works on one sublevel. If you select “Directly jump to first album if there is just one” and you selected only one category there will be no overview page – the detail page is displayed directly.

Administration

There is not a lot to mention here. The extension has to be installed with the Extension Manager (described in the Users manual). For resizing images make sure that even ImageMagick or GD Lib is working and configured in the TYPO3 setup.

The cached images are stored in typo3temp/ce_gallery/ in the following format:

type_uid_width_height_quality.extenstion (type: d for detail t for thumbnail) e.g.:

t_12_370_370_90.JPG Thumbnail for picture with the DAM uid 12, width 370, height 370, quality 90

d_12_370_370_90.JPG Detail for picture with the DAM uid 12, width 370, height 370, quality 90

At the moment only English, German, Romanian and Russian are provided by the extension but additional languages can easily be added by modifying the language XML Files (please provide these translations to the author of this document).

((generated))

((generated))

Upgrading from 1.x.x to 2.0.0

Because of changes in the flexform it is necessary that you “re-save” your plugin configurations. This can be simply done by opening the plugin, checking the values and settings and save it. If you skip this, it could be possible that you do not get any output in the frontend. If you use realUrl please update the configuration – we now use the pi_Vars guidelines.

RealURL

RealURL became a very famous extension when talking about SEO. We would like to provide an example on how a RealURL configuration for the ce_gallery could look like. You can skip this step, if you do not use RealURL. If you need more information about how to configure RealURL, please have a look at the RealURL manual. You find some sample configuration code in “realurl.txt” a file you can find in the doc directory of the ce_gallery extension.

We recommend to use tslib_patcher when using RealURL for better caching experience. With the newer RealURL it should be ok only to enable TSLib Content and TSLibMenu in the configuration of TSLib Patcher:

img-17

Minimal Setup

This is a “minimal setup” you can try if you have any troubles using ce_gallery:

Create a new page. Create a new template on this page. It should look like this one:

img-18

img-19

Next insert the plugin in the “normal” column with the default settings and select your DAM categories. You should now see a “plain” ce_gallery :-)

Known Problems

All known problems are listed on http://bugs.typo3.org .- project “tx_cegallery”. If you would like to report a new problem please report it there.

To-Do List

There are a lot of additional features you could add, e.g.

  • send a postcard
  • rating
  • display of additional fields from DAM
  • menu of album tree

You may sponsor further development of this extension by contacting the author of this document.

Change Log

1.1.0

Version

1.1.0

Changes

Initial version of this document.

Smooth slide show integrated

use ce_gallery/pi1/static/setup.txt for CSS

1.1.1

Version

1.1.1

Changes

Fixed Problems with manual to get rendered correctly on TYPO3.org

1.1.2

Version

1.1.2

Changes

Added Russian translation.

1.1.3

Version

1.1.3

Changes

Advanced page browser.

1.1.4

Version

1.1.4

Changes

Bugfix for use with Tidy

1.2.0

Version

1.2.0

Changes

Some small bugfixes, new functionality (e.g. Slimbox, more configuration options)

1.2.1

Version

1.2.1

Changes

Slimbox Detailview now shows all photos of an album – not only the ones of the page shown

2.0.0

Version

2.0.0

Changes

Cleanup release – caching and pi_vars optimized, better configuration options, strictly divided no slimbox from slimbox version

2.0.1

Version

2.0.1

Changes

Possibility to directly jump into the detail view if there is only one category selected and this option is selected in the flexform

2.0.2

Version

2.0.2

Changes

Bugfixes:

- sorting Issue (bugtracker: 7031)

- issue with simulate static documents and slimbox (bugtracker: 7021)

- amount of subgalleries per page is not correct (bugtracker: 7022)

2.0.3

Version

2.0.3

Changes

Bugfixes:

- XHTML cleanup

- issue when installing the gallery in a subdirectory

- missed piVars scheme update (back link on JS slideshow page) (bugtracker: 7034)

- error on JS gallery: link for fullscreen link

- do not show categories that do not consist of any image

img-20 EXT: Photogallery - 18