=== Plugin Name ===
Contributors: nathanrice
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5553118
Tags: slideshow, images, jquery cycle
Requires at least: 2.7
Tested up to: 2.8
Stable tag: 0.1

This plugin creates an image slideshow in your theme, using the jQuery Cycle plugin. You can upload/delete images via the administration panel, and display the images in your theme by using the <code>wp_cycle();</code> template tag, which will generate all the necessary HTML for outputting the rotating images.

== Description ==

The WP-Cycle plugin allows you to upload images from your computer, which will then be used to generate a jQuery Cycle Plugin slideshow of the images.

Each image can also be given a URL which, when the image is active in the slideshow, will be used as an anchor wrapper around the image, turning the image into a link to the URL you specified.  The slideshow is set to pause when the user hovers over the slideshow images, giving them ample time to click the link.

Images can also be deleted via the plugins Administration page.

== Installation ==

1. Upload the entire `wp-cycle` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Configure the plugin, and upload/edit/delete images via the WP-Cycle menu within the Plugins tab
1. Place `<?php wp_cycle(); ?>` in your theme where you want the slideshow to appear

== Frequently Asked Questions ==

= My images won't upload. What should I do? =

The plugin uses built in WordPress functions to handle image uploading. Therefore, you need to have [correct permissions](http://codex.wordpress.org/Changing_File_Permissions "Changing File Permissions") set for your uploads directory.

Also, a file that is not an image, or an image that does not meet the minimum height/width requirements, will not upload. Images larger than the dimensions set in the Settings of this plugin will be scaled down to fit, but images smaller than the dimensions set in the Settings will NOT be scaled up. The upload will fail and you will be asked to try again with another image.

= I'm getting an error message that I don't understand. What should I do? =

Please [email me](http://www.nathanrice.net/contact/ "email Nathan Rice") or [@nathanrice](http://twitter.com/nathanrice) me on Twitter. This plugin is still in early alpha stages, and I'm looking for good error reporting. I'll try to fix errors as soon as I possibly can.

= How can I style the slideshow further? =
In the settings of the plugin, you're able to set a custom DIV ID for the slideshow. Use that DIV ID to style the slideshow however you want using CSS.

= In what order are the images shown during the slideshow? =

Chronologically, from the time of upload. For instance, the first image you upload will be the first image in the slideshow. The last image will be the last, etc.

= Can I reorder the images? =

Not at the moment, but this is a feature I do want to include in the plugin soon.

= Can I rotate anything other than images with this plugin? =

No. This is an image slideshow. Enjoy it for what it is.

= Do you have future plans for this plugin? =
Yes. Here are some things that I want to eventually include:

* Add ability to reorder the images
* Add new effects to the slideshow
* Add options for the user to define the duration of the effect, and the time between effects via the Settings
* Add the ability to override settings by using function arguments: `<?php wp_cycle('rotate=1&effect=fade&img_width=300&img_height=200&div=slideshow'); ?>`
* Add shortcode ability so that you can rotate images attached to a post
* Possibly add widget support so that you can put a slideshow in a widget area

== Using this plugin with themes ==

If you are a theme author and what to make your theme compatible with this plugin, you have a couple of options.

First of all, the theme settings defaults are filterable.  Therefore, you have the ability, from within your theme's functions.php file, to set the defaults for this plugin.  The filter you want to use is `wp_cycle_defaults` and you need to set your return function to return an array.  For example:

`
<?php
add_filter('wp_cycle_defaults', 'my_theme_wp_cycle_defaults');
function my_theme_wp_cycle_defaults() {
	$defaults = array(
		'rotate' => 1,
		'effect' => 'fade',
		'img_width' => 300,
		'img_height' => 200,
		'div' => 'rotator'
	);
	return $defaults;
}
?>
`


Change the array values to what you need for your theme.  The user will be able to change them, if they so desire, but you'll be able to at least start them off right.