Location: PHPKode > scripts > WP-Galleriffic > wp-galleriffic/readme.txt
=== WP-Galleriffic ===
Contributors: cadeyrn
Tags: jQuery, gallery, flickr, galleriffic
Requires at least: 3.0
Tested up to: 3.2.1
Stable tag: 1.0.1

WordPress attachment / Flickr image gallery based on Galleriffic JS.

== Description ==
WP-Galleriffic is an image gallery plugin to extend WordPress. The JavaScript code is based on [Galleriffic](http://www.twospy.com/galleriffic/ "Galleriffic"), but modified at some small points for bugfix.

It started as a fork of [Photospace](http://thriveweb.com.au/blog/photospace-wordpress-gallery-plugin/ "Photospace") plugin (v1), but it became very different approach.

There are two ways to use the plugin:

1. Attachment image gallery
The plugin adds two additional image sizes using the built-in functions of WordPress. The sizes can be modified at the plugin's settings panel. The missing images be generated on-demand (for example: images uploaded before the plugin was installed or the sizes have been modified), but for large quantities I'd recommend the [Regenerate Thumbnails](http://wordpress.org/extend/plugins/regenerate-thumbnails/ "Regenerate Thumbnails") plugin. 
Versions before 1.0 used an own cache and image resizing module, but this has been eliminated due to better potentials in the core WordPress code, better Multisite compatibility, faster processing and cleaner filesystem.

2. Flickr image gallery
Flick Set can be added as source to a galleriffic shortcode. An API key is bundled with the plugin, registered for this purpose, but you can change it. It is vital, Flick requires it for the API to work. The display order is the same in Flickr. There is a chance to select the source Flickr image for both the thumbnail and the preview image. Also, if required, the Flickr images can be resized as well with a local copy of the image. The plugin grabs the images from Flickr, resizes them and serves locally.

*Note: if you change the size settings, the previously generated images ones will not be deleted. You have to make a cleanup manually.*

= Usage =
Place `[wp-galleriffic]` shortcode into anywhere in the post for attachment gallery. *Currently only one galleriffic gallery is supported per page!*
For Flickr gallery, add the set ID as: `[wp-galleriffic set=SET#]`, where SET# is the ID of the set. You can get it by navigating to the Set's page at Flickr and take a look at the end of the URL.

== Installation ==
1. Upload contents of `wp-galleriffic.zip` to the `/wp-content/plugins/` directory
2. Activate the plugin through the `Plugins` menu in WordPress
3. Fine tune the settings in `Settings` -> `wp-galleriffic` menu in WordPress

== Frequently Asked Questions ==

== Screenshots ==

1. Default CSS with CSS fix enabled ( pictures are copyrighted by the author of the plugin )

== Changelog ==

= 1.0 =

* function-based structure converted to Class-based structure.
* redesigned image processing for Flickr cache
* removed crop function from Flickr resampling: removed "border" settings, removed sharpening
* local attachment images generated with WordPress core functions next to the same places as built-in files
* new readme.txt
* added tons'o comments :)

= 0.4 =

* First public release
* Duplicated image fix is solved with “enable CSS fix”
* Duplicated caption fix is solved with “this.$captionContainer.empty();”
* Added default CSS

= 0.3 =

* Admin panel redesign
* Added “CSS fix” parameter
* Added border color fields and support
* Modifications in default parameter handling
* Added cache flushing on settings change

= 0.2 =

* Added Flickr set support.

= 0.1 =

* Initial release
Return current item: WP-Galleriffic