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! Support might not be given otherwise. It's generally a good idea to read the documentation, before you encounter any problems!

Important Notice

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

back to top

Requirements

Roundabout_XH is a plugin for CMSimple_XH. It requires a UTF-8 encoded version, jQuery4CMSimple and Javascript to be enabled in the visitors browser.

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 "Plugin Config". Hints for the options will be displayed when hovering over the help icon with your mouse. The most important settings are "gallery folder" 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 "Plugin 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 "Plugin Stylesheet".

back to top

Usage

To show a carousel with all images of a gallery, just call roundabout() on a page with the gallery ID (= album ID) as parameter, e.g.:

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

The result looks similar to the following screenshot:

screenshot

Click on any of the images and the full sized image will be displayed in a lightbox.

back to top

Limitations

It's not possible to call roundabout() from the template.

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

Roundabout_XH currently relies on the data and images of the gallery to be stored in the same parent folder.

back to top

License

Roundabout_XH is licensed under GPLv3.

© 2012 Christoph M. Becker

back to top

Credits

Roundabout_XH was inspired by Jerry's Gallery Collection series. Many thanks for having the great idea of creating alternative gallery viewers.

Roundabout_XH is powered by jQuery Carousel. Many thanks to Erik Stelzer for publishing this nice jQuery plugin under MIT license.

Roundabout_XH uses Colorbox. Many thanks to Jack Moore for developing this fine jQuery plugin and distributing it 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.

And last but not least many thanks to all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.

back to top