=== Plugin Name ===
Contributors: c3mdigital
Tags: coda slider, featured content, jquery, slider, js, no conflict, shortcode, coda, panic slider
Donate link: http://c3mdigital.com/donations/
Requires at least: 3.0
Tested up to: 3.1
Stable tag: 0.2.3.1
Add a jQuery Coda Slider in no conflict mode to any WordPress page, post or custom post type using shortcodes or template tags.
== Description ==
WP Coda Slider is a plugin that adds Niall Doherty's jQuery Coda-Slider v2.0 plugin to WordPress using shortcodes. The only change made to the original jQuery plugin was to make it compatible with WordPress's built in jQuery in no-conflict mode. This means that it wont conflict with other WordPress plugins and doesn't add unnecessary js files to your site. The js and CSS are only called on pages that contain the plugin shortcode.
= Demo: =
The WP Coda Slider Demos can be found at http://wp-performance.com/wp-coda-slider/
= Shortcode: =
The short code accepts the following arguments: id, cat, show, args.
id= a unique name for each slider that will be assigned as the div id
cat= the category containing the posts to display in the slider
show= the number of posts to show in the slider
args= the settings for the slider which can be found at http://www.ndoherty.biz/forums/viewtopic.php?f=4&t=2
= Example: =
`[wpcodaslider id=myslider cat=4 show=6 args=autoSlide:true, dynamicTabs:false, autoSlide:true]`
This would add a slider with the `
` showing 6 posts from the category id of 6 with dynamic tabs set to false, auto slide set to true with an autoslide interval of 8000 milliseconds.
= Template Tag =
Add ``
to any of your themes templates.
you must supply the variables when you add the function to your template.
``
this would add a slider with the id of myslider and show 4 posts from category 81 with dynamic arrows set to false.
all the variables must be present and in the same order.
== Installation ==
1. Upload the `wp-coda-slider` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Add shortcode to any post or page you want to display your slider on. Make sure to specify the category id, slider id(each slider requires you to give it a unique id) and the number of posts to show.
ie: `[wpcodaslider id=myslidername cat=4 show=3 args=autoSlide: true]` This would display a slider containing the first 3 posts in a category with the id of 4 with autoslide set to true.
Shortcode & Template tag args:
The args= is optional.(For the template tag you must supply at least one arg)
If none are set the plugin will use the default values specified below:
Here is a full listing of settings you can add to args=
* autoHeight
Values: true, false, 1, 0
Default: true
Description: Dynamically adjusts slider height according to the height of the content in each panel.
Notes: If set to false or 0, the height of the slider will be set to the height of the tallest panel.
* autoHeightEaseDuration
Values: Any amount of milliseconds.
Default: 1000
Description: Duration of autoHeight easing effect.
Notes: Ideally, this should use the same value as slideEaseDuration (see below). Depends on autoHeight being set to true or 1.
* autoHeightEaseFunction
Values: See Robert Penner's Equations Visualizer for the full list.
Default: "easeInOutExpo"
Description: Easing method used for autoHeight effect.
Notes: Value must be enclosed in quotes. Depends on autoHeight being set to true or 1.
* autoSlide
Values: true, false, 1, 0
Default: false
Description: Specifies whether slider should move between panels automatically.
* autoSlideInterval
Values: Any amount of milliseconds.
Default: 7000
Description: Time to wait before auto sliding.
Notes: Depends on autoSlide being set to true or 1.
* autoSlideStopWhenClicked
Values: true, false, 1, 0
Default: true
Description: Determines whether the autoSlide function should stop when user interacts with the slider.
Notes: Depends on autoSlide being set to true or 1.
* crossLinking
Values: true, false, 1, 0
Default: true
Description: Allows permalinking to each slider panel via a URL hash (e.g. http://www.myslider.com/#4).
Notes: Works best if autoSlide (see above) is disabled. Only numbers can be used for the hash values; they are automatically generated by the script. If this cross-linking is enabled and a valid URL hash is presnt, and setting specified for firstPanelToLoad (see below) will be overruled.
* dynamicArrows
Values: true, false, 1, 0
Default: true
Description: Places left and right buttons alongside the slider.
Notes: Set this to false or 0 and you can still hardcode the left and eight buttons in the HTML, giving you more flexibility with positioning. See Example 4 in the demos.
* dynamicArrowLeftText
Values: Anything you want.
Default: "« left"
Description: The anchor text used for the dynamic "slide left" button.
Notes: Depends on dynamicArrows being set to true or 1.
* dynamicArrowRightText
Values: Anything you want.
Default: "right »"
Description: The anchor text used for the dynamic "slide right" button.
Notes: Depends on dynamicArrows being set to true or 1.
* dynamicTabs
Values: true, false, 1, 0
Default: true
Description: Adds tabbed navigation to the slider.
Notes: panelTitleSelector (see below) lets you specify what anchor text is used in each tab.
* dynamicTabsAlign
Values: "center", "left", "right"
Default: "center"
Description: Specifies the horizontal alignment of the tabbed navigation, relative to the slider.
Notes: Depends on dynamicTabs being set to true or 1. Value must be enclosed in quotes.
* dynamicTabsPosition
Values: "bottom", "top"
Default: "top"
Description: Specifies whether the tabbed navigation should appear above or below the slider.
Notes: Depends on dynamicTabs being set to true or 1. Value must be enclosed in quotes.
* externalTriggerSelector
Values: Pretty much any jQuery selector, but best to reference an anchor.
Default: "a.xtrig"
Description: Specifies the selector for elements on the page, apart from the usual navigation elements, which should trigger a slide.
Notes: Value must be enclosed in quotes. The external trigger must have a rel attribute to specify the id of the slider which it should affect. If cross linking is required, also be sure to include a href attribute, specifying the appropriate URL hash. See Example 3 in the demos.
* firstPanelToLoad
Values: Any integer corresponding to a panel (e.g. use 2 if you want the second panel to load first).
Default: 1
Description: Specifies the panel that should be loaded first, in the absence of cross-linking.
Notes: See Example 5 in the demos.
* panelTitleSelector
Values: Pretty much any jQuery selector.
Default: "h2.title"
Description: Specifies which element within each panel the tabbed navigation anchor text should be copied from.
Notes: Depends on dynamicTabs being set to true or 1. Value must be enclosed in quotes.
* slideEaseDuration
Values: Any amount of milliseconds.
Default: 1000
Description: Duration of slide easing effect.
Notes: Ideally, this should use the same value as autoHeightEaseDuration (see above). Depends on autoHeight being set to true or 1.
* slideEaseFunction
Values: See Robert Penner's Equations Visualizer for the full list.
Default: "easeInOutExpo"
Description: Easing method used for slide effect.
Notes: Value must be enclosed in quotes.
== Frequently Asked Questions ==
= What does the id argument do? =
The id argument is the div id that will be assigned to the slider. Make sure each slider has a unique id.
= What is the cat argument? =
This is the WordPress post category the slider will pull from and display in your slider.
= Where can I use the shortcode? =
The short code will work on posts, pages, and Wordpress 3.0 custom post types.
= How can I change the style of the slider or modify the width? =
Open the coda-slider-2.0.css located in the css folder of the plugin and make any changes you wish. The CSS file is well documented on where changes can be made.
= Where can I find all the values available for the shortcode args? =
The full description of the shortcode arguments can be found on the orginal jQuery plugin page at: http://www.ndoherty.biz/forums/viewtopic.php?f=4&t=2
= Where can I get support or help? =
Support will be provided on the WordPress.org support forums and may also ask for support at http://wp-performance.com/wp-coda-slider/
== Screenshots ==
See demo at: http://wp-performance.com/wp-coda-slider/
== Changelog ==
= 0.2.3 =
Bug fixes:
Fixed documentation error for template tag function call Props:Bira
Fixed path to ajax-loader.gif Props:shootingstar.co.uk
Added direction:ltr; to css for compatability with rtl languages Props:Bira
= 0.2.2.1 =
Add a template tag method to call the slider to use when calling posts that contain other shortcodes.
= 0.2.1 =
Added the description for the arguments in the shortcode
= 0.2 =
Fixed the readme file to display full description
== Upgrade Notice ==
= 0.2.2.1 =
Upgrade to have option to use template tags or shortcodes. Using template tags allows posts containing other shortcodes to work.
= 0.2.1 =
Please upgrade and check the readme.txt file for a full description on using the plugin shortcode arguments
= 0.1 =
Hey this is the first version. No need to upgrade until a new version comes out