LayerSlider WP - The WordPress Parallax Slider from Kreatura Media - 20Script

# LayerSlider WP 4.1.1

## The WordPress Parallax Slider with 3D & 2D transitions

### Documentation

- Overview
  - Thank you
  - Features
  - Changelog
- Requirements
  - WordPress
  - Browser Support
- Installation
  - Installation via WP plugin installer
  - Installation via FTP
- How do I update the plugin?
  - Is there any auto-update mechanism?
  - How do I update the plugin?
  - How do I get the new features of an update?
- How to translate the plugin
- Backward compatibility since version 3.5
- Credits
- The rest of this documentation
- Documentation for Developers
- Contact

### Overview

## This is a WordPress plugin of the LayerSlider! You can create as many slides and layers as you want. You can use unlimited images with links. The script is very user-friendly, you can add global settings or local (per slide) settings to each slide or layer. You can change delay times, easing types, durations and much more.

### Thank you

Thank you for purchasing this product. If you have any questions that are beyond the scope of this documentation, please feel free to email us.

### Features

- Over 170 breathtaking 3D & 2D hardware accelerated transitions with transition gallery!
- Easy-to-use visual transition builder - Create your own custom transitions and use it with your slider!
- 5 displaying modes (normal, responsive, full-width, full-width + responsive & full-width + responsiveUnder.
- Smart resizing and repositioning image, video and also text layers in responsive modes including font-sizes, line-heights, etc.)
- Unlimited types of usage (image slider, image slider with text, content slider, video gallery slider, mixed content slider, etc...)
- Unlimited variations of hardware accelerated animations (sliding from / to 4 directions or fading in / out (layers only) with countless easing types and layers can slide or fade out before other layers appear)
- 3 types of navigation controls (thumbnail mode, hover thumbnails with buttons & buttons only) with auto hide feature
- Use with ANY content you want (images, HTML elements, Flash movies, YouTube videos, etc.)
  (best view with semi-transparent PNG images or CSS3 styled HTML elements)
- Unlimited number of slides / layers
- Stunning WYSIWYG editor (Real-time dragging, reordering, styling, duplicating, disabling slides and layers) with real-time preview feature!
- Deep linking slides
- Automatic slideshow feature (optional: Backwards-Slideshow) with start with a random layer feature
- Random slideshow feature
- Smart features for full screen sliders (responsiveUnder & sublayerContainer)
- Image preload feature
- Auto-play embedded YouTube and Vimeo videos (configurable)
- Auto-pause slideshow while videos are playing
- Auto-preview images to YouTube and Vimeo videos
- Loops feature
- Customizable UI
- Easy link to another layer or to an URL
- Powerful API with callback functions
- Keyboard navigation
- Touch control for mobile devices (iOS tested)
- yourLogo feature with link option
- Skin support with 8 pre-defined skins (layered PSD file of the skins is included)
- SEO friendly
- Multiple browser support (IE 7+, Safari 3+, Chrome 3+, Firefox 3+, Opera 10+, Mobile browsers)
- Detailed Documentation with examples
- Sample Sliders included
- Free future updates with optional auto-update feature and free support!

### Changelog

4.1.1

- Fixed the jQuery.noConflict() issue

4.1.0

- Fixed video issues in Firefox
- Fixed an issue that caused slowness in the transition gallery
- Fixed an issue with the "animateFirstLayer" that caused the slideshow to stop
- Fixed an issue with the cbAnimStop if there is only one slide
- Added jQuery version number check
- Fixed an issue that caused the LayerSlider notices to embed each other
- Improved the "Put JS includes to body" option to fix the easing JS errors as well
- Fixed some style settings
- Fixed API documentation

4.0.2

- Fixed an issue that broke some page functionality in some cases
- Fixed the Media Library with the YourLogo feature in the Global Settings

4.0.1

- Improved CSS overrides to prevent the theme applying global CSS style settings on the slider and its elements
- Fixed an issue which caused the slider to freeze if the navigation area was set to hidden
- We are now using wp_remote_post() instead of file_get_contents() in auto-updates to bypass security restrictions of some hosting services

4.0.0

- New features
  - We added new transition feature with more than 170 predefined 3D and 2D transitions
  - We are now using hardware acceleration to give you killer performance on mobile devices
  - We added Transition Builder, an easy-to-use visual editor to create your own kind of transitions with almost infinite possibilities
  - We added a style editor to the layer options, so you can now easily customize the appearance of your layers
  - Added auto-updates
  - Added a public PHP function to insert sliders from your template files with filtering options
  - Added troubleshooting options to workaround common WP theme issues such as jQuery duplicates
  - Added an option to specify a custom capability with you can give access to the plugin on your WP admin interface to other users than admins
  - Added option to link to whole slide
  - Added REL attribute for layers, so you can use a LightBox or other plugins on them which uses this attribute
  - Added loading indicator
- Improvements
  - Revised admin user interface with added tooltips, popups, modal dialog boxes, new color picker, better documentation, and other helpful things
  - We improved the Preview feature on your admin area, so now it starts faster and give you better performance for seamless animations
  - Improved "Animate first layer" feature, it doesn't animate the background now
  - We are now support the value "-1" for distance level (formerly known as P. Level) to position your layers exactly out of the frame
  - You can add percentage values of the width and height of your layers
  - Full jQuery 1.9 compatibility
  - Improved various style settings
- Bug fixes
  - Fixed an issue in the data storage which limited the maximum size of the plugin data and might caused data loss in some very rare cases
  - Fixed an issue in Firefox when the browser forgets the chosen type for text layers in some cases
  - Fixed an issue in theme integration when the plugin tried to load a non-existent image
  - Fixed an issue in linked layers with fade effect which resulted the sublayer disappearance
  - Fixed an issue on mobile devices regarding the thumbnail images touch detection
  - Fixed an issue in the LayerSlider API when the "data" object wasn't passed for some callback functions
  - Fixed an issue in the cbAnimStop() callback function of the LayerSlider API which contained some invalid values regarding the slides

3.6.2

- Bug fix: fixed an issue with the WP content filters messing with the inline Javascript code in some themes

3.6.1

- Improvement: added support for the new WP 3.5 Media Library with bulk image uploading
- Bug fix: fixed the global background image option
- Bug fix: fixed the navigation buttons on RTL sites

3.6.0

- New features
  - Multisite ready with network-wide activation and handling new sites in the network
  - Localization ready, you can translate the entire plugin, including the admin user interface
  - Support for translation plugins (like qTranslate) to create multilingual sliders
  - Skin editor, you can now modify the LayerSlider WP skins from your WordPress admin area
- Improvements
  - Workaround for the duplicating init code
  - Better compatibility with WordPress 3.5 (fixed buttons, colorpicker, etc...)
  - Improved debug mode
- Bug fixes
  - Some minor bug fixes

3.5.0

- New features
  - Added two types of fully customizable thumbnail navigation
  - Ability to set custom thumbnail image for thumbnail navigation
  - Added three new skins
  - Thumbnail navigation added to all (new and old) skins
  - Added randomSlideshow feature
  - Added responsiveUnder feature for full width sliders (slider will switch into responsive mode when you reduce the screen size under a given size)
  - Added sublayerContainer feature for full width sliders (layers are positioned inside a centered container)
  - Added hoverPrevNext feature (prev and next buttons will shown only on hover)
  - Added hoverBottomNav feature (bottom navigation will shown only on hover)
  - Added debug mode
- Improvements
  - Huge performance improvements
  - For a faster and more reliable solution, the new version uses different data storage
  - Deleting a slider won't rearrange their IDs anymore
  - Compatibility for the upcoming WordPress 3.5 version
  - Better handling of deep linking, the page won't scroll away now
  - Changes in the sample sliders
  - Replaced the skin text field with a select box which automatically detects new skins
- Bug fixes
  - Fixed slideDelay when animateFirstLayer is enabled
  - Fixed slideIn and slideOut animations when there is only one layer in the slider
  - Fixed yourLogo percentage positioning
  - The slider won't fail to load when the skin isn't available now
  - Restored sliderStyle field to apply your custom style setting on the slider
  - Positioning layers in the WYSIWYG editor with percentage values is now fixed
  - Fixed relative URLs option
- Other
  - Added documentation for developers

3.0.2

- moved the plugin resources to the head because a lot of themes doesn't trigger wp_footer()
- fixed notices in debug mode

3.0.1

- fixed a packaging issue

3.0.0

- New features
  - Entirely new admin user interface
  - Built-in Preview feature in the WYSIWYG Editor
  - Added smart resizing in responsive modes: resizing and repositioning image, video and also text(!) layers in responsive mode including font-sizes, line-heights, etc.)
  - Included free sample sliders
  - Better documentation included with the WP contextual help menus
  - Duplicating and disabling sliders, slides and layers
  - 'Show until' feature (layers can now fade / slide out before other layers appear)
  - Deep linking feature
  - Option to start with a random layer
  - Adding IDs for slides
  - Added text fields for HTML default element attributes such as title or alt
- Improvements
  - Option to use absolute or relative URLs for images
  - Modified LayerSlider API make easier your job if you want to create something unique
  - Changes in importing sliders, it is now just adding the new ones and leave the old sliders
  - Positioning with percentage values is more reliable
  - LayerSlider WP now generate less code and they are only included when necessary
  - We now adding special classes to the slider GUI elements, so you can make more complex skins
  - Preventing WordPRess to wrap your layers in <code> or <p> elements
  - Workaround for the post_max_vars issue, LayerSlider WP now can handle unlimited number of slides and layers
- Bug fixes
  - Flickering when the slider loading is now fixed
  - Fixed the IE tooltip issue
  - Fixed the white gap between the slides when the slider commencing slide change
  - Fixed linkTo feature

2.0.0

- added loops feature
- added autoPlay feature for embedded YouTube and Vimeo videos
- added autoPauseSlideshow feature while videos are playing
- added auto-preview image feature to YouTube and Vimeo videos
- added linkTo feature
- added import / export feature
- you can now easily add an ID to any sublayer
- LayerSlider WP is now parsing shortcodes
- added some GUI improvements
- included two new skins
- touch control now can be disabled
- changed one layer mode (not duplicating it now)
- fixed a wrong variable
- fixed a wrong function in forceResponsive mode
- fixed yourLogo style settings, reset and yourLogoTarget
- fixed global background setting
- fixed saving method
- changed from absolute to relative URLs
- https aware
- fixed a bug when a new image sublayer is reordered
- fixed a bug in forceResponsive mode
- the bottom side of the slider (next to the controls) is now clickable
- a lot of minor bugfixes and improvements

1.8.0

- facelifted admin page for better usage
- added an option to style your LayerSlider container from admin
- added "auto" options by default to slidedirection and slideoutdirection properties of layers
- added forceResponsive feature (LayerSlider WP now can "get out" from your wp theme, so it's width can be real responsive now)
- changed back to normal PHP opening tags from short opening tags
- fixed the "create new slider" width bug
- fixed some animations
- reset buttons now real-time modifying backgrounds
- added background-images of slides to preload
- modified some CSS styles
- some parts of the source code rewritten
- added yourLogoLink feature
- added yourLogoTarget feature
- added noskin feature

1.7.0

- fixed fading bug (layers now appears if sliding in after fading out)
- fixed preload bug with layers with gradient backgrounds
- fixed working delayout of slides (From now, if you add a delayout to a layer, layers of that layer will be animating out immediately, but the layer (and the next layer) will be delayed by the delayout time of the current layer. So, you can animate out all layers BEFORE the parent layer will begin the animation.)
- fixed imagepreload bug
- added an option to animating the first slide instead of fading in
- the script is now fully responsive! (You can add % instead of pixels to left and top properties of layers and width or height properties of LayerSlider container.)
- fixed globalimage bug
- added LayerSlider API Callback functions to WYSIWYG editor
- added yourLogo feature (You can now display your fixed logo above the LayerSlider container.)
- some minor bugfixes and improvements

1.6.0

- now supports any HTML content with CSS styling!
- now layers supports fading transition
- added slideoutdirection property to layers
- added global background color / background image support
- added a possibility to name and reorder slides
- fixed LayerSlider widget
- fixed '1px gap' bug
- fixed one layer bug
- fixed empty sublayer bug
- fixed swing, linear and easeInOutQuint animations
- fixed hover on pause / stop bug
- fixed wrong directions of animations if navigating by slidebuttons
- fixed durationout property for layers
- fixed reordering layers

1.5.1

- minor bugfixes

1.5.0

- first release

### Requirements

### WordPress

- WordPress 3.3+

### Browser Support

- Chrome 10+
- Firefox 3+
- Safari 3+
- Opera 10+
- Internet Explorer 7+ (some rendering problems may appear in IE7)
- iOS Safari
- Android Browser
- Other mobile browsers

### Browser Support for the 3D Transitions *

- Chrome 12+
- Chrome for iOS
- Chrome for Android 18+
- Firefox 10+
- Firefox for Android 18+
- Safari 4+
- iOS Safari 3.2+

* Browsers which don't support 3D transitions will use 2D transitions instead as fallback mode.

Please note, that Internet Explorer 10 and some versions of Android browsers has CSS3 3D support but they don't support the 'preserve-3d' CSS3 property well, which is required for the correct 3D transitions - so they will be using 2D transitions. In old browsers some animations (for example fading the transparent PNGs) are missing, but the plugin is fully functional.

### Installation

#### Installation via WP plugin installer

1. Extract the plugin package on your machine that you downloaded from CodeCanyon.
2. Hover over the plugins menu item on your left sidebar in your WordPress admin area and select "Add New".
3. In the new page click on the "Upload" menu item on top of the page.
4. Choose the "layersliderwp-4.1.1.installable.zip" file that you extracted from the downloaded package and click "Install Now".
5. WordPress may ask you to type your FTP login credentials to install the plugin. Click on "Proceed" when you finished.
6. The plugin is now installed, click on the "Activate Plugin" button.

#### Installation via FTP

1. Extract the plugin package on your machine that you downloaded from CodeCanyon.
2. Find the "layersliderwp-4.1.1.installable.zip" file in the extracted content and extract it also.
3. Open your favourite FTP application and connect and navigate to your "/wp-content/plugins/" folder
4. Copy over the extracted "layersliderwp-4.1.1.installable.zip" file
5. Navigate to your plugins page on your WordPress admin area and click the "Activate" button below LayerSlider WP

### How do I update the plugin?

#### Is there any auto-update mechanism?

Since LayerSlider WP 4.0.0 we are supporting auto-updates. The auto-update feature requires a valid item purchase code, you can find it by navigating to your CodeCanyon downloads page and clicking on the "Licence Certificate" button of corresponding item. This will download you a text file which contains your item purchase code. Please enter this code at the LayerSlider WP main plugin page in the "Auto-updates" box.

#### How do I update the plugin manually?

If you downloaded the most recent version, you can go ahead to deactivate and remove the old version, then install the new one. Your sliders and settings are in the database, removing the plugin won't touch them. The new version always has backward compatiblity, so you don't have to worry about anything.

#### How do I get the new features of an update?

Depending on the default settings, you may have to enable or disable some settings related with the new features. If you experience any unwanted behaviour change after an update, it is always a good idea to check the settings of your sliders, there are probably new options to control these changes.

### How to translate the plugin

LayerSlider WP is translation and localization ready, you can easily translate the entire plugin for your native language. To do this, please follow the steps below:

- Download Poedit
  Poedit is a multiplatform application which you can use to translate .PO files easily and compile them into .MO files. You can download it from here.
- Start translating
  Launch Poedit and open the default .PO file (LayerSlider-en_US.po) for editing. It can be found in your "/wp-content/plugins/LayerSlider/languages/" folder. When you open this file, you will have a list of the all the available strings for translating. When you save your work, Poedit will generate an MO file, WordPress will use this file to load your translation.
- Use your translation
  When you finished, you need to rename your new .PO and .MO files, so WordPress will be able to identify the corresponsing language that you made your work for. You have to include in their file name the name of the plugin followed by a dash and the language and country identifier spearated with an underscore. Here you can find all the language codes, and here are the country identifiers. For example, your new files will be: LayerSlider-fr_FR.po and LayerSlider-fr_FR.mo.
  After that, you need to copy your new files into your "/wp-content/plugins/LayerSlider/languages" folder.
  And that's it, you are ready to go. Please note that your WordPress installation needs to be set to the extact same locale as you specified in your file names. This settings can be found in your wp-config.php file. If you are using WordPress in your native language, you don't have to worry about this setting.
- Publish your work
  If you translated the plugin, you can help to other users from your country. You can send us the .PO and .MO files, and we will include them in the next update of the plugin, so your translations will be available for every other users. Our email address is: contact@kreaturamedia.com

### Backward compatibility since version 3.5

The new version of LayerSlider WP is fully compatible with older versions of the plugin. However, in version 3.5 there are major changes under the hood that you should know about.
If you install the plugin for the first time, you don't have to read this section of the documentation.

- Converting the plugin data for version 3.5 and above
  LayerSlider WP 3.5 uses a different data storage which is faster and more reliable. The plugin requires you to convert your data associated with the plugin and it will prompt you with a banner on the top of your WP admin page. It is fully automatic, your sliders and settings will remain still, it only takes a click on the "Convert Data" button.
- Importing from older versions
  The new data storage doesn't affect importing, LayerSlider WP 3.5 and above accepts any export codes, even from older versions. However, if you want to import sliders from older installations, it isn't a bad idea to update the plugin first, then export your sliders, although it isn't necessary.

### Credits

- We are using FatCow's icon theme. This is an amazing set of beautiful icons, you should check it out. Thanks guys for made this available for us, we love your work!

### The rest of this documentation

This documentation only covers the basic things you need to know such as the plugin installation. We are using the WordPress contextual help menus to integrate our documentation directly into the admin area where you will work on your sliders. It is much more convenient for everybody, and also, you can access to the documentation quickly. And because it is contextual, it only shows the things you will need to work with.
You can find the rest of our documentation in the LayerSlider WP admin area. You can access it with the "Help" menu item on the top right corner of the page.

### Documentation for Developers

If you are a developer, you probably want to check out our documentation for integrating LayerSlider WP into your theme. Please click here.

### Contact us!

## If you like our works.
If you need a help in using one of our CodeCanyon items.
If you have a great idea which we can work together.