forked from linuslundahl/sexyCycle-for-WordPress
-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
93 lines (64 loc) · 4.17 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
=== sexyCycle for WordPress ===
Contributors: linuslundahl
Donate link:
Tags: simple, image, gallery, slideshow, jQuery
Requires at least: 2.9
Tested up to: 3.0
Stable tag: 0.4.1
sexyCycle is a lightweight yet very sleek jQuery plugin for making sliding image galleries. This plugin adds that functionality to WP galleries.
== Description ==
sexyCycle is a lightweight yet very sleek jQuery plugin for making sliding image galleries. And to quote it's creator: "One of the good things about sexyCycle is that you're not forced to stick with a fixed width of all images. It's actually quite nice to use different width on each image." Actually, it's now also possible to use different height thanks to Nick O'Neill.
This WordPress plugin makes it possible to add this image sliding functionality to galleries in WP, you can simply just override the `[gallery]` shortcode generated by WP or you can use it's own `[sexy-gallery]` shortcode. Galleries are handled the same way as usual by the 'Add an Image -> Gallery function'.
It's now possible to use per gallery settings, see the [Installation page](http://wordpress.org/extend/plugins/sexycycle-for-wordpress/installation/) for documentation.
Examples of sexyCycle in action can be seen at [sexyCycle image jQuery plugin](http://www.suprb.com/apps/sexyCycle/). (These examples are not implemented in WordPress, but they show the functionality)
sexyCycle for WordPress created and maintained by [Linus Lundahl](http://unwise.se/).
sexyCycle jQuery plugin created by [Andreas Pihlström](http://suprb.com/).
Contributions by [Nick O'Neill](http://thewebpreneur.com/).
== Installation ==
1. Upload `sexycycle-for-wordpress` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to 'Settings -> sexyCycle' to setup the plugin.
4. Upload images on a page / post and insert your gallery, alternatively insert `[sexy-gallery]` manually in html mode.
= Different settings for galleries =
Using variables in the shortcode enables you to setup galleries differently from post to post.
= Example: =
`[sexy-gallery size="small" animation="easeInExpo"]`
This setting would use small images and the animation easeInExpo instead of the defaults.
= Settings available: =
* __Animation:__ `animation=` "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeInElastic", "easeOutElastic", "easeInOutElastic", "easeInBack", "easeOutBack", "easeInOutBack", "easeInBounce", "easeOutBounce", "easeInOutBounce"
* __Animation speed:__ `speed=` "int" (milliseconds)
* __Auto cycle speed:__ `interval=` "int" (milliseconds)
* __Use controls:__ `controls=` "0", "before", "under", "beforeafter"
* __Image click:__ `imgclick=` "0", "image", "nothing" (0 = swap to next image)
* __Previous text:__ `prev=` "string"
* __Next text:__ `next=` "string"
* __Use stop:__ `controls_stop=` "boolean" (0/1)
* __Stop text:__ `stop=` "string"
* __Use caption:__ `caption=` "0", "caption", "desc"
* __Show counter:__ `counter=` "boolean" (0/1)
* __Disable cycle at end:__ `cycle=` "boolean" (0/1)
== Frequently Asked Questions ==
__Does sexyCycle support video?__
No, there is no video support.
= Known Issues =
* Captions disappear and reappear when cycling restarts.
== Screenshots ==
1. The settings page.
== Changelog ==
= 0.4.1 =
Minor bugfixes
= 0.4 =
Gallery now supports images with both different height and width
Added image counter
Added possibility to show the controls before the gallery
= 0.3.4 =
Added possibility to choose image click behavior, defaults to "Swap to next image". Other options are "Link to original image" and "Do nothing".
= 0.3.3 =
Fix bug that only made per gallery settings available for the [gallery] shortcode, and not the [sexy-gallery] shortcode.
= 0.3.2 =
Added per gallery settings.
Added possibility to add a stop button to auto cycling galleries.
= 0.3.1 =
Fix bug that broke the gallery in IE.
= 0.3 =
First version released to the public.