You are here

Home » API reference » Views Slideshow Xtra 8.4

README.txt in Views Slideshow Xtra 8.4

Same filename in this branch
  1. 8.4 README.txt
  2. 8.4 modules/views_slideshow_overlay/README.txt
  3. 8.4 modules/views_slideshow_examples/README.txt
Views Slideshow Examples
========================

Project site: http://drupal.org/project/views_slideshow_xtra

Code: https://drupal.org/project/views_slideshow_xtra/git-instructions

Issues: https://drupal.org/project/issues/views_slideshow_xtra

What Is Views Slideshow Examples?
---------------------------------

The Views Slideshow Examples module is a sub-module of the Views Slideshow Xtra project. 
The module serves as a "Starter Kit", in that enabling the module creates working
slideshows, which can be used as a starting point for your slideshows. Currently
this includes two example slideshows. The first example is of a basic slideshow
created using just the Views Slideshow module.  The second example uses the
Views Slideshow Overlay module, providing an example of a slideshow that has
multiple overlays. 

Installation
------------

To install the Views Slideshow Examples module, download the Views Slideshow Xtra module
(https://www.drupal.org/project/views_slideshow_xtra, currently 8.x-4.0 Alpha),
and install the Views Slideshow Examples module in the normal way from admin/modules,
or using Drush (drush -y en views_slideshow_examples).  DO NOT install the
Views Slideshow Xtra module, it is just a placeholder module for the included sub-modules.

When the module is installed, it creates a Slide content type, Slideshow taxonomy, 
Slideshow view, and example Slide content.  The Slideshow view has two displays,
one for each of the example slideshows.

The Slide content type is pre-populated with Slide nodes for the two examples.
The Slideshow taxonomy has a term for each slideshow.

The basic slideshow example will be found at the path /basic-slideshow.  The overlay
slideshow example will be found at the path /overlay-slideshow.

Un-installing
-------------

Removal of the Slide content type, Slideshow taxonomy, and Slideshow view was
omitted from this module's uninstall process, with the idea that users could enable
the module and use them for their own slideshows, after deleting the example content.
Thus, uninstalling this module does not delete the Slide content type, Slideshow
taxonomy, or Slideshow view.  The example slide content may be manually deleted from
Admin >> Content, and the Slide content type may be deleted from
Admin >> Structure >> Content Types.  The Slideshow view may be deleted from
Admin >> Structure >> Views.

Custom CSS
----------

If this module is disabled, and you want to continue using the slideshow it
creates, be sure to copy the CSS in views_slideshow_xtra_example.css
to one of your site's CSS files, as this CSS file will no longer be available,
once this module is disabled.

File

modules/views_slideshow_examples/README.txt
View source 
  1. Views Slideshow Examples

  2. ========================

  3. 

  4. Project site: http://drupal.org/project/views_slideshow_xtra

  5. 

  6. Code: https://drupal.org/project/views_slideshow_xtra/git-instructions

  7. 

  8. Issues: https://drupal.org/project/issues/views_slideshow_xtra

  9. 

  10. What Is Views Slideshow Examples?

  11. ---------------------------------

  12. 

  13. The Views Slideshow Examples module is a sub-module of the Views Slideshow Xtra project. 

  14. The module serves as a "Starter Kit", in that enabling the module creates working

  15. slideshows, which can be used as a starting point for your slideshows. Currently

  16. this includes two example slideshows. The first example is of a basic slideshow

  17. created using just the Views Slideshow module.  The second example uses the

  18. Views Slideshow Overlay module, providing an example of a slideshow that has

  19. multiple overlays. 

  20. 

  21. Installation

  22. ------------

  23. 

  24. To install the Views Slideshow Examples module, download the Views Slideshow Xtra module

  25. (https://www.drupal.org/project/views_slideshow_xtra, currently 8.x-4.0 Alpha),

  26. and install the Views Slideshow Examples module in the normal way from admin/modules,

  27. or using Drush (drush -y en views_slideshow_examples).  DO NOT install the

  28. Views Slideshow Xtra module, it is just a placeholder module for the included sub-modules.

  29. 

  30. When the module is installed, it creates a Slide content type, Slideshow taxonomy, 

  31. Slideshow view, and example Slide content.  The Slideshow view has two displays,

  32. one for each of the example slideshows.

  33. 

  34. The Slide content type is pre-populated with Slide nodes for the two examples.

  35. The Slideshow taxonomy has a term for each slideshow.

  36. 

  37. The basic slideshow example will be found at the path /basic-slideshow.  The overlay

  38. slideshow example will be found at the path /overlay-slideshow.

  39. 

  40. Un-installing

  41. -------------

  42. 

  43. Removal of the Slide content type, Slideshow taxonomy, and Slideshow view was

  44. omitted from this module's uninstall process, with the idea that users could enable

  45. the module and use them for their own slideshows, after deleting the example content.

  46. Thus, uninstalling this module does not delete the Slide content type, Slideshow

  47. taxonomy, or Slideshow view.  The example slide content may be manually deleted from

  48. Admin >> Content, and the Slide content type may be deleted from

  49. Admin >> Structure >> Content Types.  The Slideshow view may be deleted from

  50. Admin >> Structure >> Views.

  51. 

  52. Custom CSS

  53. ----------

  54. 

  55. If this module is disabled, and you want to continue using the slideshow it

  56. creates, be sure to copy the CSS in views_slideshow_xtra_example.css

  57. to one of your site's CSS files, as this CSS file will no longer be available,

  58. once this module is disabled.

  59.