hi_ShutterReloaded 1.0

A little CMSimple-plugin which includes and activates the Shutter Reloaded Lightbox-Clone to your CMSimple-Website.

The plugin is free for use on your website, commercial or not commerial. But If you deliver it as part of your paid service to your customers or use it in a commercial scope, please be fair and support the project
with a small donation via paypal !

Features

Includes all necessary javascripts and stylesheets (no changes in the template necessary)
The JS is only about 8KB in size and does not require any external libraries
Supports single images and grouped images
Easy activation (no source-code editing)
Can use Lightbox-style activation (rel=lightbox[group])
Multi-Language support
Compatible with lb_Gallery

Requirements

CMSimple or CMSimple_XH with a working Pluginloader. Recommended Pluginloader-Version is >= 2.1)
Your document should have a valid DocType

Installation

Always make a backup of your installation before adding a new plug-in.
Unzip the archive and copy the files and folders into your plugins-folder.
It should look like this:
- [Root]
  - [(2lang)]
  - [cmsimple]
  - ...
  - [plugins]
    - ...
    - [pluginloader]
    - [hi_shutter_reloaded]
      
      [config]
      
      [help]
      
      [languages]
      
      [libs]
      
      admin.php
      
      index.php
    - index.php
  - [...]
  - index.php

The file plugins/hi_shutter_reloaded/config/config.php needs to be set writable.

(To edit the languages online do the same with the language files in plugins/hi_shutter_reloaded/languages.)

You're ready to use the plugin!

Configuration

Login to your CMSimple site
Select the "hi_Shutter_Reloaded-Plugin" from the list of available plugins
Click on "Plugin Config" to view and edit the configuration settings

There are hints for every configuration option available, if you hover with your mouse over the little blue questionmark.

Activation

To load the plugin by default on every page, go to the plugin - configuration and set

"autoinclude" to "1".

To load the plugin on a single page, use classic CMSimple-Scripting in the page-content:

#CMSimple $output.=hi_shutter();#

With CMSimple_XH, you can use the new plugin-call

{{{plugin:hi_shutter();}}}

too, but be sure to integrate the call after all links and plugin-output in the content.

Example:
To use lb_Gallery and hi_Shutter_Reloaded together call the plugins in CMSimple_XH with this code in the content:

{{{plugin:lb_gallery('path/to/gallery');}}}

{{{plugin:hi_shutter();}}}

It's also possible to use hi_PD_Scripting - Plugin, but include Shutter_Reloaded as the last plugin in the list or use a placeholder at the page-bottom!

Usage

By default Shutter is activated on all links pointing to an image, with thumbnail or not. There’s no need for any changes to the page, just activate the plugin like described above.
It will display each image separately and will create sets for image links that have either class=”shutterset”, class=”shutterset_setname” or rel=”lightbox[setname]“.

For controlling which images are displayed, Shutter can be activated with a mode-parameter.

Set the config-parameter "mode" to "sh"

or call the plugin in the content with

#CMSimple $output.=hi_shutter('sh');#

Next step is to add class=”shutter”, “shutterset” or “shutterset_setname” to the links pointing to the images you want to display.

class="shutter" will display one image at a time
class="shutterset" will combine all image links in a single set
class="shutterset_setname", where setname is a short word and/or number, will create multiple sets on the page.

If you want to add css styles to the links, you can include a second class, but “shutterset” should be first. Example: class="shutterset_setname my-class".

Shutter Reloaded can also use Lightbox style activation and sets. You can activate it with mode "lb" and use rel="lightbox" for singe image display, or rel="lightbox[setname]" for sets of images.

Use the title-attribute to add a caption to the image.

There’s no limitations to the number of images or the number of sets on the page.

How to use together with lb_Gallery

To use Shutter Reloaded together with my lb_Gallery-Plugin, just do the following settings in lb_Gallery configuration:

on the fly images : false
use external lib : must be empty
use lightbox : true
use rel attrib : lightbox[]

you're done ;-).

Acknowledgment

Shutter Reloaded is written by Andrew Ozz.
This plugin uses a modified version 2.4.1 of the Shutter Reloaded Wordpress-Plugin wich is licensed under the GPL version 2 or newer, http://www.gnu.org/copyleft/gpl.html

Plugin-License

hi_Shutter_Reloaded for CMSimple(_XH) is released under the GPL version 2 or newer, http://www.gnu.org/copyleft/gpl.html

Need help?

... visit cmsimpleforum.com.

 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED 
 IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
 THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.