You are here

README.txt in Views Slideshow 7.3

Same filename in this branch
  1. 7.3 README.txt
  2. 7.3 contrib/views_slideshow_cycle/README.txt
Same filename and directory in other branches
  1. 5 README.txt
  2. 6.3 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
Views Slideshow
===============

The Views Slideshow module is a Views Style Plugin that can be used to output
Views in a jQuery slideshow.

This module contains an api module "Views Slideshow" and one implementation of
that api in "Views Slideshow Cycle".

Installation
=============

1) Assure that you are using Views 3.x. http://drupal.org/project/views
2) Upload/install the Libraries API module. http://drupal.org/project/libraries
3) Upload/install the ctools library. http://drupal.org/project/ctools
4)If enabling via drush, the libraries will be automatically downloaded. Otherwise, you will need to manually download the library.
  a) Create a sites/all/libraries directory on your server.
  b) Create a directory within sites/all/libraries named jquery.cycle.
  c) Locate/download the jQuery cycle plugin. http://malsup.com/jquery/cycle
  d) Upload/install the jQuery cycle plugin: place it inside the jquery.cycle
   directory.
5) There are also a few optional libraries to improve/increase options:
  a) jQuery.easing:
    http://gsgd.co.uk/sandbox/jquery/easing/jquery.easing.1.3.js, should be
    saved as libraries/jquery.easing/jquery.easing.1.3.js.
6) Enable the Views slideshow and Views Slideshow: Cycle modules
7) You should now see the new views style option called "Slideshow"

Upgrading from 2.x
===================

There is no supported upgrade path between Views slideshow 2.x and Views
slideshow 3.x. If you need to upgrade, follow the steps listed here, and if you
find deficiencies, please post an issue.

1) Assure that you are using Views 3.x
2) Disable the views slideshow module, views slideshow thumbnail hover module,
   and views slideshow singleframe modules. (Disabling these modules should not
   require uninstalling)
3) Delete/remove the Views slideshow 2.x module folder and all files within.
4) Upload/install the Views slideshow 3.x module folder and all files within.
5) Upload/install the ctools module. http://drupal.org/project/ctools
6) Upload/install the Libraries API module. http://drupal.org/project/libraries
7) Create a sites/all/libraries directory on your server.
8) Create a directory within sites/all/libraries named jquery.cycle
9) Locate/download the jQuery cycle plugin from github: https://raw.githubusercontent.com/malsup/cycle/3.0.3/jquery.cycle.all.js
10) Upload/install the jQuery cycle plugin: place it inside the jquery.cycle
   directory.
11) Enable the Views slideshow and Views Slideshow: Cycle modules
12) Update all your views that were previously using the slideshow style.
    (note: updating from views 2.x to views 3.x may also break other parts of
    your view not related to slideshows, check everything especially number of
    items per page, and pager settings.)


Requirements
============

* Views 3
* Libraries
* Ctools

Views Slideshow Cycle
* jQuery Cycle library


Description
===========

This module will create a View type of Slideshow that will display nodes in a
jQuery slideshow.

Settings are available for fade, timing, mode, and more.

Known Issues
============

* Do not use the block cache for Views Slideshow blocks as this may prevent the
JavaScript from being added to the page. See https://www.drupal.org/node/1460766
and https://www.drupal.org/node/2448157.

Authors/maintainers
===================

Original Author:

Aaron Winborn (winborn at advomatic dot com)
https://drupal.org/user/33420

-maintainers:

NickWilde
https://www.drupal.org/u/nickwilde

redndahead
https://drupal.org/user/160320

psynaptic
https://drupal.org/user/93429


Support
=======

Issues should be posted in the issue queue on drupal.org:

https://drupal.org/project/issues/views_slideshow

File

README.txt
View source
  1. Views Slideshow
  2. ===============
  3. The Views Slideshow module is a Views Style Plugin that can be used to output
  4. Views in a jQuery slideshow.
  5. This module contains an api module "Views Slideshow" and one implementation of
  6. that api in "Views Slideshow Cycle".
  7. Installation
  8. =============
  9. 1) Assure that you are using Views 3.x. http://drupal.org/project/views
  10. 2) Upload/install the Libraries API module. http://drupal.org/project/libraries
  11. 3) Upload/install the ctools library. http://drupal.org/project/ctools
  12. 4)If enabling via drush, the libraries will be automatically downloaded. Otherwise, you will need to manually download the library.
  13. a) Create a sites/all/libraries directory on your server.
  14. b) Create a directory within sites/all/libraries named jquery.cycle.
  15. c) Locate/download the jQuery cycle plugin. http://malsup.com/jquery/cycle
  16. d) Upload/install the jQuery cycle plugin: place it inside the jquery.cycle
  17. directory.
  18. 5) There are also a few optional libraries to improve/increase options:
  19. a) jQuery.easing:
  20. http://gsgd.co.uk/sandbox/jquery/easing/jquery.easing.1.3.js, should be
  21. saved as libraries/jquery.easing/jquery.easing.1.3.js.
  22. 6) Enable the Views slideshow and Views Slideshow: Cycle modules
  23. 7) You should now see the new views style option called "Slideshow"
  24. Upgrading from 2.x
  25. ===================
  26. There is no supported upgrade path between Views slideshow 2.x and Views
  27. slideshow 3.x. If you need to upgrade, follow the steps listed here, and if you
  28. find deficiencies, please post an issue.
  29. 1) Assure that you are using Views 3.x
  30. 2) Disable the views slideshow module, views slideshow thumbnail hover module,
  31. and views slideshow singleframe modules. (Disabling these modules should not
  32. require uninstalling)
  33. 3) Delete/remove the Views slideshow 2.x module folder and all files within.
  34. 4) Upload/install the Views slideshow 3.x module folder and all files within.
  35. 5) Upload/install the ctools module. http://drupal.org/project/ctools
  36. 6) Upload/install the Libraries API module. http://drupal.org/project/libraries
  37. 7) Create a sites/all/libraries directory on your server.
  38. 8) Create a directory within sites/all/libraries named jquery.cycle
  39. 9) Locate/download the jQuery cycle plugin from github: https://raw.githubusercontent.com/malsup/cycle/3.0.3/jquery.cycle.all.js
  40. 10) Upload/install the jQuery cycle plugin: place it inside the jquery.cycle
  41. directory.
  42. 11) Enable the Views slideshow and Views Slideshow: Cycle modules
  43. 12) Update all your views that were previously using the slideshow style.
  44. (note: updating from views 2.x to views 3.x may also break other parts of
  45. your view not related to slideshows, check everything especially number of
  46. items per page, and pager settings.)
  47. Requirements
  48. ============
  49. * Views 3
  50. * Libraries
  51. * Ctools
  52. Views Slideshow Cycle
  53. * jQuery Cycle library
  54. Description
  55. ===========
  56. This module will create a View type of Slideshow that will display nodes in a
  57. jQuery slideshow.
  58. Settings are available for fade, timing, mode, and more.
  59. Known Issues
  60. ============
  61. * Do not use the block cache for Views Slideshow blocks as this may prevent the
  62. JavaScript from being added to the page. See https://www.drupal.org/node/1460766
  63. and https://www.drupal.org/node/2448157.
  64. Authors/maintainers
  65. ===================
  66. Original Author:
  67. Aaron Winborn (winborn at advomatic dot com)
  68. https://drupal.org/user/33420
  69. -maintainers:
  70. NickWilde
  71. https://www.drupal.org/u/nickwilde
  72. redndahead
  73. https://drupal.org/user/160320
  74. psynaptic
  75. https://drupal.org/user/93429
  76. Support
  77. =======
  78. Issues should be posted in the issue queue on drupal.org:
  79. https://drupal.org/project/issues/views_slideshow