annotate modules/contrib/views_slideshow/README.txt @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents c69a71b4f40f
children
rev   line source
Chris@5 1 INTRODUCTION
Chris@5 2 ------------
Chris@5 3
Chris@5 4 * Views Slideshow can be used to create a slideshow of any content (not just
Chris@5 5 images) that can appear in a View. Powered by jQuery, it is heavily
Chris@5 6 customizable: you may choose slideshow settings for each View you create.
Chris@5 7
Chris@5 8
Chris@5 9 REQUIREMENTS
Chris@5 10 ------------
Chris@5 11
Chris@5 12 * Views Slideshow 8.x-4.x requires Drupal 8 & the core views module enabled.
Chris@5 13
Chris@5 14 * There is no upgrade path from views slideshow for Drupal 7.
Chris@5 15
Chris@5 16
Chris@5 17 INSTALLATION
Chris@5 18 ------------
Chris@5 19 * Install as you would normally install a contributed Drupal module. See the
Chris@5 20 <a href='http://drupal.org/documentation/install/modules-themes/modules-8'>
Chris@5 21 Drupal 8 instructions</a> if required in the Drupal documentation for further
Chris@5 22 information. Note there are two modules included in this project; "Views
Chris@5 23 Slideshow" & "Views Slideshow Cycle". In most cases you will need/want to
Chris@5 24 enable both of them.
Chris@5 25
Chris@5 26 * You will also need to download some JavaScript libraries. You can do this
Chris@5 27 semi-automatically via drush using `drush dl-cycle-lib` or if preferred,
Chris@5 28 manually from the sources.
Chris@5 29
Chris@5 30 * Required libraries
Chris@5 31 * https://malsup.github.io/jquery.cycle.all.js
Chris@5 32 * https://raw.githubusercontent.com/briancherne/jquery-hoverIntent/master/jquery.hoverIntent.js
Chris@5 33 * https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
Chris@5 34
Chris@5 35 * an example of code you could run in your Drupal root directory to download
Chris@5 36 to the right place:
Chris@5 37
Chris@5 38 ```
Chris@5 39 mkdir -p libraries/jquery.cycle && cd $_ && wget https://malsup.github.io/jquery.cycle.all.js \
Chris@5 40 && mkdir -p ../../libraries/jquery.hoverIntent && cd $_ && wget https://raw.githubusercontent.com/briancherne/jquery-hoverIntent/master/jquery.hoverIntent.js \
Chris@5 41 && mkdir -p ../../libraries/json2 && cd $_ && wget https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
Chris@5 42 ```
Chris@5 43
Chris@5 44 CONFIGURATION
Chris@5 45 -------------
Chris@5 46
Chris@5 47 * Configuration is on a per view/display basis. Select 'Slideshow' as the
Chris@5 48 display format and then configure settings as desired under Format
Chris@5 49 Settings.
Chris@5 50
Chris@5 51 * See also:
Chris@5 52 https://www.ostraining.com/blog/drupal/drupal-8-slideshows
Chris@5 53
Chris@5 54
Chris@5 55 MAINTAINERS
Chris@5 56 -----------
Chris@5 57
Chris@5 58 Current maintainers:
Chris@5 59
Chris@5 60 * vbouchet (https://www.drupal.org/u/vbouchet) (Initial port & primary 8.x-4.x maintainer)
Chris@5 61
Chris@5 62 * NickWilde (https://www.drupal.org/u/nickwilde) (Secondary 8.x-4.x maintainer)
Chris@5 63
Chris@5 64 * aaron (https://www.drupal.org/u/aaron)
Chris@5 65
Chris@5 66 * xiukun.zhou (https://www.drupal.org/u/xiukun.zhou)
Chris@5 67
Chris@5 68 * wangqizhong (https://www.drupal.org/u/wangqizhong)