Roundabout_XH - a CMSimple_XH Plugin

Roundabout_XH (aka. "Dances with galleries") displays image galleries as a carousel. It does so with JavaScript only – no Flash or similar plugin is required. It has no built-in facilities for managing those galleries; instead it uses galleries created with KissGallery_XH or FotoGalerie_XH.

Please do read this documentation before you encounter any problems!

Important Notice

Roundabout_XH couldn't be tested so far in various environments. It is a so called release candidate. Use with caution!

back to top

Requirements

Roundabout_XH is a plugin for CMSimple_XH. It requires a UTF-8 encoded version and jQuery4CMSimple.

back to top

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 roundabout/ to your server to CMSimple_XH's plugins directory.
  4. Set write permissions to the subdirectories config/, css/, languages/ and the gallery folder.
  5. Switch to "Roundabout" in the back-end to check if all requirements are fulfilled.
back to top

Settings

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

You can change the default settings of Roundabout_XH in "Config". Hints for the options will be displayed when hovering over the help icon with your mouse. The most important settings are "gallery data", "gallery images" and "gallery separator"; the default is configured for FotoGalerie_XH. Change it, if you have changed the storage folder of FotoGalerie_XH, or you want to use Roundabout_XH with KissGallery_XH.

Localization is done in "Language". You can translate the character strings to your own language, or customize them according to your needs.

The look of Roundabout_XH can be customized in "Stylesheet".

back to top

Usage

To show a carousel with all images of a gallery, just call the plugin with the gallery ID resp. album ID as parameter, e.g. on a page:

{{{PLUGIN:roundabout(1);}}}

Or in the template:

<?php echo roundabout(1);?>

Clicking any of the images will display the full sized image in a lightbox.

back to top

Limitations

To be able to see the roundabout, JavaScript has to be enabled in the visitor's browser. Otherwise a message will be displayed, which can be configured in the lanugage settings.

The same gallery must not be called more than once on any page (no matter whether it's called from the content, a newsbox or the template).

back to top

License

Roundabout_XH is licensed under GPLv3.

© 2012-2013 Christoph M. Becker

Czech translation © 2012 Josef Němec
Danish translation © 2012 Jens Maegard
Slovak translation © 2012 Dr. Martin Sereday

back to top

Credits

Roundabout_XH was inspired by Jerry Jakobsfeld's Gallery Collection series. Many thanks for having the great idea of creating alternative gallery viewers, that use the same back-end.

Roundabout_XH is powered by jQuery Carousel and ColorBox. Many thanks to Erik Stelzer resp. Jack Moore for publishing these nice jQuery plugins under MIT license.

The plugin icon is designed by schollidesign. Many thanks for publishing this icon under GPL.

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 Peter Harteg, the "father" of CMSimple, and to all developers of CMSimple_XH, without whom this amazing CMS wouldn't exist.

back to top