Skip to content
This repository
Browse code

Merge pull request #4 from jordanlev/master

cleaned up the README file (no changes to code)
  • Loading branch information...
commit 6f5ec4e247e7d9d19db5391e99633109442d3865 2 parents a8777fc + 3be9481
Jamy authored August 18, 2011

Showing 1 changed file with 7 additions and 6 deletions. Show diff stats Hide diff stats

  1. 13  README.markdown
13  README.markdown
Source Rendered
@@ -43,20 +43,20 @@ A jQuery content slider that is easily configurable and can easily be switched b
43 43
 
44 44
 ## Using Navigation Functions
45 45
 
46  
-If you wish to be able to navigate the slides via code (for example, if you have alterantive or additional pagination controls besides the ones that are automatically generated by the slider), you need to initialize the slider in a slightly different way:
  46
+If you wish to be able to navigate the slides via code (for example, if you have alternative or additional pagination controls besides the ones that are automatically generated by the slider), you need to initialize the slider in a slightly different way:
47 47
     var slider = null;
48 48
     
49 49
     $(document).ready(function(){
50 50
         slider = new $.plusSlider($('#slider'), {});
51 51
     });
52 52
     slider.toSlide('next); //move slider to next slide
53  
-    slider.nextSlide('prev'); //move slider to previous slide
  53
+    slider.toSlide('prev'); //move slider to previous slide
54 54
     slider.toSlide(3); //move slider to arbitrary index (first slide is 0, second is 1, etc.)
55 55
 
56 56
 
57 57
 ## Pagination Thumbnails
58 58
 
59  
-The thumbnails are dynamically created. This will make your life a lot easier as you won't have to create seperate smaller images for each slide. This functionality is slightly more advanced than the rest and requires a bit of CSS knowledge/experience to manipulate as desired. The pagination thumbnails functionality relies heavily on the transform: scale(x,y) CSS property and value. If this property is not applied, the 'thumbnails' will be the same size as the slides and therefore render it useless. This option will not run on browsers that don't support it. So feel free to use it for progressive enhancement.
  59
+The thumbnails are dynamically created (note that this feature does not work in IE8 or lower). If you aren't using a CMS or other back-end code that generates thumbnails for you, this will make your life a lot easier as you won't have to create separate smaller images for each slide. This functionality is slightly more advanced than the rest and requires a bit of CSS knowledge/experience to manipulate as desired. The pagination thumbnails functionality relies heavily on the transform: scale(x,y) CSS property and value. If this property is not applied, the 'thumbnails' will be the same size as the slides and therefore render it useless. This option is automatically disabled for browsers that don't support it, so it is safe to use for progressive enhancement.
60 60
 
61 61
 ## Customizing PlusSlider
62 62
 
@@ -64,6 +64,7 @@ The default example is a great demonstration of what you can do with PlusSlider,
64 64
 To see the bare minimum of styles that are required for a functioning slider, look at the "minimal.html" and "minimal.css" example files. These have all but the most essential styles stripped away so you can easily identify what is and isn't needed for your own custom slider design.
65 65
 
66 66
 Some things to note about widths and heights:
  67
+
67 68
 * The slider div must have specific width+height set in either CSS **OR** via the "width" and "height" javascript options.
68 69
 * Every piece of interior content must **ALSO** have explicit widths + heights set via CSS (these cannot be set by the "width" and "height" javascript options). Each interior content piece's width + padding-left + padding-right + margin-left + margin-right should equal the slider div's width, and each interior content piece's height + padding-top + padding-bottom + margin-top + margin-bottom should equal the slider div's height.
69 70
 * If the interior content is just an image, the image tag's "width" and "height" attributes can be used instead of CSS width and height.
@@ -74,9 +75,9 @@ Some things to note about widths and heights:
74 75
 
75 76
 ### Version 1.3
76 77
 * Added `nextText` and `prevText` options
77  
-* Added the `paginationThumbnails` option
78  
-* Added the `nextSlide()` functionality to `toSlide()`
79  
-* Removed the `nextSlide()` function - Redundant
  78
+* Added the `paginationThumbnails` option 
  79
+* Added the `nextSlide()` functionality to `toSlide()` (accepts 'next' and 'prev' as arg values)
  80
+* Removed the `nextSlide()` function (now that it's functionality is in toSlide())
80 81
 
81 82
 ### Version 1.2.6
82 83
 * Added a paginationTitle

0 notes on commit 6f5ec4e

Please sign in to comment.
Something went wrong with that request. Please try again.