Slideshow_XH – a CMSimple_XH Plugin

Plugin
Icon

Slideshow_XH facilitates displaying all images in a given folder as a slideshow. The slideshows don't allow any interaction of the visitor. Multiple slideshows with different effects and timings are possible.

Please do read this documentation before you encounter any problems!

Important Notice

Slideshow_XH couldn't be tested so far in various environments. It is a so called BETA version. Use with caution!

Requirements

Slideshow_XH is a plugin for CMSimple_XH ≥ 1.6. It requires PHP ≥ 5.2.0.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory slideshow/ to your server into CMSimple_XH's plugins directory.
  4. Set write permissions to the subdirectories config/ and languages/.
  5. Switch to "Slideshow" in the back-end to check if all requirements are fulfilled.

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select "Slideshow" from "Plugins".

You can change the default settings of Slideshow_XH in "Config". Hints for the options will be displayed when hovering over the help icons with your mouse.

Localization is done in "Language". You can translate the character strings to your own language if there is no appropriate language file available, or customize them according to your needs.

Usage

To show a slideshow on all pages insert into the template:

<?php echo slideshow('%FOLDER%', '%OPTIONS%');?>

To show a slideshow on a single page or in a newsbox insert into the page:

{{{PLUGIN:slideshow('%FOLDER%', '%OPTIONS%');}}}

The parameters have the following meaning:

%FOLDER%
The path of a folder relative to CMSimple_XH's image folder. All JPEG, PNG and GIF images inside this folder will be used for the slideshow; there must be at least two images inside this folder. All images should have the same aspect ratio.
%OPTIONS%
Any given option will override the respective value in the "default" section of the plugin configuration. The format of this parameter is the same as a "query string" (see the examples below). The options can be given in any order. If you want to stick with the defaults, you can omit this parameter. The following options are available:
order
The order of the images: "fixed" (alphabetically ordered; start with first image), "sorted" (alphabetically sorted; start with randomly chosen image) oder "random" (randomly ordered).
effect
The kind of the transition: "fade", "slide", "curtain" or "random".
easing
The acceleration effect: "linear", "easeIn", "easeOut" or "easeInOut".
delay
The initial delay in ms until the slideshow starts.
pause
The duration of the pause between the transitions in ms.
duration
The duration of the transition effect in ms.

Examples

To show the images inside of userfiles/images/banners/ with the default settings on every page:

<?php echo slideshow('banners');?>

To show images in a treatmill fashion:

{{{slideshow('slides/run/', 'effect=slide&pause=0&duration=2000');}}}

To show images as calm, slowly cross-fading slideshow:

{{{slideshow('slides/slow/', 'effect=fade&pause=5000&duration=100');}}}

To show appropriate images in a flip-book style:

{{{slideshow('slides/flip/', 'order=fixed&effect=fade&pause=100&duration=100');}}}

Limitations

The slideshows can only be played, when JS is enabled in the visitor's browser. Otherwise only the first image will be shown. The transition effects are CPU-intensive, particularly for large images. So you should restrain yourself to only a few slideshows with small or medium-sized images on the same page, to avoid stuttering slideshows for visitors with little processing power.

License

Slideshow_XH is licensed under GPLv3.

© 2012-2014 Christoph M. Becker

Danish translation © 2012 Jens Maegard
Czech translation © 2012-2013 Josef Němec
Slovak translation © 2013 Dr. Martin Sereday
French translation © 2014 Patrick Varlet

Credits

Slideshow_XH was inspired by Joe.

The plugin icon is designed by Mischa McLachlan. Many thanks for publishing this icon under a liberal license.

This plugin uses free applications icons from Aha-Soft. Many thanks for making these icons freely available.

Many thanks to the community at the CMSimple_XH-Forum for tips, suggestions and testing.

And last but not least many thanks to Peter Harteg, the "father" of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.