{"version": "1.6","name": "Revolution Responsive jQuery Slider","subline": "The Documentation","username": "ThemePunch","created": "06/22/2012","website": "http://www.codecanyon.com/user/themepunch?ref=themepunch","update": "06/28/2012","update_today": true,"email": "info@themepunch.com","intro": "For support please checkout http://themepunch.ticksy.com !","sections": [{"title": "Install","id": "install","content": "

\tThis chapter will gives you general instructions on how to install the slider and setup the  options. Later chapters will be more detailed if needed.

\n

\t 

\n

\n\t00 What files do I need to upload to my server?

\n

\tPlease upload the rs-plugin folder to your server. In this folder you will find the following subfolders containing all of the items content:

\n\n

\tYou could use your own jQuery but we recommend loading it directly from the Google ressources (see later in this documentation).

\n

\tYou will find an example index.html and index-fullwidth.html in your downloaded zip. 

\n

\n\t01 Implement the jQuery

\n

\tAdd the following lines to your HTML Head: 

\n
\n<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js>
\n

\t 

\n

\n\t 

\n

\n\t02 Add Revolution js and css files to your HTML page

\n
\n\t 
\n
\n\tAlso in the <HEAD> section:
\n
\n\t 
\n
\n\t
\n<!-- jQuery REVOLUTION Slider  -->\n<script type="text/javascript" src="rs-plugin/js/jquery.themepunch.plugins.min.js"></script>\n<script type="text/javascript" src="rs-plugin/js/jquery.themepunch.revolution.min.js"></script>\n\n<!-- REVOLUTION BANNER CSS SETTINGS -->\n<link rel="stylesheet" type="text/css" href="rs-plugin/css/settings.css" media="screen" />\n
\n\t
\n\t\t 
\n
\n
\n\tThis contains the JS and CSS for the Slider itself  and some helping modules .
\n
\n\t 
\n
\n\t 
\n
\n\t

\n\t\t03 A Create the surrounding DIV for your Slider (Responsive, none Full Width)

\n\t
\n\t\t 
\n\t
\n\t\tPut it in the HTML:
\n\t
\n\t\t 
\n\t
\n<div class="banner-container"> \n\n   <div class="banner">...</div>\n\n</div>\n
\n\t
\n\t\t 
\n\t
\n\t\t

\n\t\t\t03 B Create the surrounding DIV for your Slider (Responsive, Full Width Slider)

\n\t\t
\n\t\t\t 
\n\t\t
\n\t\t\tPut it in the HTML:
\n\t\t
\n\t\t\t 
\n\t\t
\n<div class="fullwidthbanner-container"> \n\n   <div class="fullwidthbanner">...</div>\n\n</div>\n\n
\n\t\t
\n\t\t\t 
\n\t\t

\n\t\t\t 

\n\t
\n\t
\n\t\t

\n\t\t\t04 Put an unordered list inside to hold the different slides as list elements

\n\t\t

\t\t\t 

\n\t\t
\n<ul>\n<!-- THE BOXSLIDE EFFECT EXAMPLES  WITH LINK ON THE MAIN SLIDE EXAMPLE -->\n\n <li data-transition="boxslide" data-slotamount="7" data-link="http://www.google.de"> \n   <img src="images/slides/image1.jpg">\n   <div class="caption sft big_white"  data-x="400" data-y="100" data-speed="700" data-start="1700" data-easing="easeOutBack">KICKSTART YOUR WEBSITE</div>\n   <div class="caption sfb big_orange"  data-x="400" data-y="142" data-speed="500" data-start="1900" data-easing="easeOutBack">WITH SLIDER REVOLUTION!</div>\n   <div class="caption lfr medium_grey"  data-x="510" data-y="210" data-speed="300" data-start="2000">UNLIMITED TRANSITIONS</div>\n </li>\n...\n</ul>
\n\t\t
\n\t\t\t 
\n\t\t

\n\t\t\t05 Call the jQuery Plugin to build the Slider

\n\t\t

\t\t\t 

\n\t\t
\n<script type="text/javascript">\n      var tpj=jQuery;               // MAKE JQUERY PLUGIN CONFLICTFREE\n      tpj.noConflict();\n               \n      tpj(document).ready(function() {\n               \n                   if (tpj.fn.cssOriginal!=undefined)   // CHECK IF fn.css already extended\n                   tpj.fn.css = tpj.fn.cssOriginal;\n\n                    tpj('.banner').revolution(\n                        {    \n                            delay:9000,                                                \n                            startheight:490,                            \n                            startwidth:890,\n                           \n                            hideThumbs:200,\n                           \n                            thumbWidth:100,                            \n                            thumbHeight:50,\n                            thumbAmount:5,\n                           \n                            navigationType:"both",                   \n                            navigationArrows:"nexttobullets",        \n                            navigationStyle:"round",                \n                            touchenabled:"on",                       \n                            onHoverStop:"on",                        \n                           \n                            navOffsetHorizontal:0,\n                            navOffsetVertical:20,\n                           \n                            shadow:1,\n                            fullWidth:"off"    \n                                                       \n                        });    \n</script>\n\n\n
\n\t
\n
\n

\t 

\n"},{"title": "Markup","id": "markup","content": "

\tThe items markup uses javascript/jQuery to transform a block of HTML markup into the slider, all customization is done trough the use of HTML5 data attributes and CSS. The markup is valid for HTML5 rules and the content will be fully indexed by search engines. The general structure of markup follows this schema:

\n

\t 

\n

\n\t01 Two surrounding DIVs are the basic holder for your Slider:

\n
\n\tPut it in the HTML for Responsive but none FullWidth version:
\n
\n\t 
\n
\n<div id="banner_container">\n   <div id="banner" >...</div>\n</div>\n
\n
\n\t
\n\t\tPut it in the HTML for Responsive And FullWidth version:
\n\t
\n\t\t 
\n\t
\n<div id="fullwidthbanner-container">\n   <div id="fullwidthbanner" >...</div>\n</div>\n\n
\n\t
\n\t\t 
\n
\n
\n\tThe outside container could be used by one of your divs in your page and is needed for the responsive part.
\n\tTo get more know about the fullwidth and/or responsive containers, see our style.css examples.
\n
\n\t 
\n

\n\t02 An unordered list inside holds the different slides as list elements

\n
\n\t 
\n
\n\t
\n<ul>\n<!-- THE BOXSLIDE EFFECT EXAMPLES  WITH LINK ON THE MAIN SLIDE EXAMPLE -->\n\n <li data-transition="boxslide" data-slotamount="7" data-link="http://www.google.de"> \n   <img src="images/slides/image1.jpg">\n   <div class="caption sft big_white"  data-x="400" data-y="100" data-speed="700" data-start="1700" data-easing="easeOutBack">KICKSTART YOUR WEBSITE</div>\n   <div class="caption sfb big_orange"  data-x="400" data-y="142" data-speed="500" data-start="1900" data-easing="easeOutBack">WITH SLIDER REVOLUTION!</div>\n   <div class="caption lfr medium_grey"  data-x="510" data-y="210" data-speed="300" data-start="2000">UNLIMITED TRANSITIONS</div>\n </li>\n...\n</ul>
\n
\n
\n\t 
\n
\n\t 
\n
\n\tThe next chapter describes the inner of this list elements.
\n
\n\t 
\n
\n\tThe more advanced users will have no problems in customizing the slider up to every detail and create their own sliders with using the CSS files.
\n
\n\t 
\n
\n\tThe CSS file responsible for the layout of your slider is the settings.css. Find All Responsive Settings and Docu later in "Responsive Captions".
\n"},{"title": "Layout","id": "layout","content": "

\n\t01 The Default parameters of the Plugin

\n
\n\t\n
\n
\n\t 
\n

\n\t02 Slider items

\n
\n\t 
\n
\n\t<li> - Every list item represents a new banner/slider item.
\n
\n\t 
\n
\n\tTransition effects and a possible slide link are defined here:
\n\n
\n\t 
\n
\n\tEach List item must include:
\n\n

\tEach List item can include:

\n\n
\n\t
\n<li data-transition="boxslide" data-slotamount="7" data-link="http://www.google.de"> \n   <img src="images/slides/image1.jpg">\n   <div class="caption sft big_white"  data-x="400" data-y="100" data-speed="700" data-start="1700" data-easing="easeOutBack">KICKSTART YOUR WEBSITE</div>\n   <div class="caption sfb big_orange"  data-x="400" data-y="142" data-speed="500" data-start="1900" data-easing="easeOutBack">WITH SLIDER REVOLUTION!</div>\n   <div class="caption lfr medium_grey"  data-x="510" data-y="210" data-speed="300" data-start="2000">UNLIMITED TRANSITIONS</div>\n </li>\n
\n
\n
\n\t 
\n

\n\t03 Captions

\n
\n\t 
\n
\n\tCaptions are Containers which can be customized via CSS, classes for the start animation and some data options.
\n
\n\t 
\n
\n\tThe CSS for the caption added in the settings.css file because it depends strongly on the responsive Sizing. 
\n
\n\tThere are 4 Steps of Responsive Contents which are written later below under the Responsive Dependencies Caption.
\n
\n\t 
\n
\n\tYou find an example in the settings.css of our item download.
\n
\n\t 
\n
\n\tThe options are in detail:
\n\n
\n\t\"\"
\n
\n\t 
\n

\n\t
\n\t04 Videos

\n
\n\t 
\n
\n\tIn order to embed videos in the slider you can embed videos via iframe of your favorite video site that allows this kind of embedding. An example with Vimeo:
\n
\n\t 
\n
\n\t
\n<li data-transition="slideup" data-slotamount="20"> \n<img src="images/slides/image20.jpg"  >\n                                <div class="caption lfb boxshadow" data-x="70" data-y="120" data-speed="900" data-start="500" data-easing="easeOutBack"><iframe src="http://player.vimeo.com/video/29298709?title=0&amp;byline=0&amp;portrait=0" width="460" height="259"></iframe></div>\n\n                                <div class="caption lfb medium_grey"  data-x="550" data-y="258" data-speed="300" data-start="1600" data-easing="easeOutExpo">to your Slides</div>\n\n</li>
\n
\n

\t 

\n

\t 

\n

\n\t
\n\t05 Banner Timer

\n
\n\t 
\n
\n\tIn order to use a banner timer, you will need to add the markup within the banner or fullwidthbanner divs.
\n
\n\tThe markup should look like :
\n
\n\t 
\n
\n\t<div class="tp-bannertimer"></div>
\n
\n\t 
\n
\n\tTo remove this timer just simple remove the markup from the container, and that is it.
\n"},{"title": "Responsive Basic","id": "responsive_basic","content": "

\tResponsive means that the slider will adjust to every screen width.

\n
\n\tTo achieve that you have to set a bunch of mediaqueries that will adjust the whole slider when a certain window size is used, or you will need to use our fullwidth style version, to let the banner always resize itself.
\n
\n\t 
\n
\n\tThe basic containers are build like this ( in none Fullwidth, but 4 Level Responsive Version):
\n
\n\t 
\n
\n\t
\n .bannercontainer {\n    padding:5px;\n    background-color:#fff;\n    width:890px;\n    position:relative;\n    margin-left:auto;\n    margin-right:auto;\n}\n\n.banner{\n    width:890px;    // MUST BE THE SAME AS IN THE OPTIONS startwidth \n    height:490px;    // MUST BE THE SAME AS IN THE OPTIONS startheight\n    position:relative;\n    overflow:hidden;\n}\n\n\n\n\n
\n\t
\n\t\t 
\n\t
\n\t\t 
\n\t
\n\t\tThe media queries that build the screen dependend container sizes:
\n\t
\n\t\t 
\n\t
\n@media only screen and (min-width: 768px) and (max-width: 959px) {\n   .banner, .bannercontainer{  width:750px; height:412px;}\n    .bannershadow {width:750px;}\n}\n\n@media only screen and (min-width: 480px) and (max-width: 767px) {\n  .banner, .bannercontainer{width:470px; height:258px;}   \n  .bannershadow {width:470px;}\n}\n\n@media only screen and (min-width: 0px) and (max-width: 479px) {\n   .banner, .bannercontainer{width:300px;height:165px;}\n   .bannershadow {width:300px; margin-top:-5px;}\n}
\n
\n

\t 

\n"},{"title": "Fullwidth","id": "fullwidth","content": "

\tThis slider can go fullwidth too. We have added an index-fullwidth.html example for you in the zip.

\n

\tPlease note the basic change in the markup.

\n

\tThe surrounding containers are:

\n
\n<div class="fullwidthbanner-container"> \n\n   <div class="fullwidthbanner">...</div>\n\n</div>
\n

\t 

\n

\tThe CSS is not splitted with Media-Queries but has a basic 100% value for width:

\n

\t 

\n
\n.fullwidthbanner-container{\n   width:100% !important; \n   position:relative;\n   padding:0; \n   max-height:450px !important;  // Same value as in OPTIONS the startheight parameter\n   overflow:hidden;\n} \n
\n

\t 

\n"},{"title": "Licenses","id": "licenses","content": "

\tUsed Assets

\n\n

\t 

\n"},{"title": "Support","id": "support","content": "

\tIf you face problems with the installation or customization of our product please do not hesitate to contact us via our support ticket system:

\n

\thttp://themepunch.ticksy.com

\n"}],"use_sub": false,"logo": "http://www.themepunch.com/codecanyon_wp/wp-content/uploads/2012/04/logo.png","favicon": "","customcss": "","easing": "easeOutQuart","easingduration": "913","bgimage": "http://www.themepunch.com/codecanyon_wp/wp-content/themes/config/images/website_bg_tile-21.gif","bgrepeat": "repeat","bgattachment": "scroll","bgcolor": "A8A7A7","textcolor": "363636","linkcolor": "830909","hrcolor1": "858484","hrcolor2": "CFCDCD","sidebarbgimage": "","sidebarbgrepeat": "repeat","sidebarbgcolor": "363636","sidebartextcolor": "A8A7A7","sidebarlinkcolor": "A8A7A7","sidebaractivecolor": "404040","sidebaractivetextcolor": "B50D0D","sidebarhrcolor1": "242424","sidebarhrcolor2": "575757","cufon": "","itemURL": "","sendJSON": "","sendZIP": "","sendPWD": ""}