You are here

Home » API reference » jCarousel 7.3

README.txt in jCarousel 7.3

Same filename and directory in other branches
  1. 8.5 README.txt
  2. 8.3 README.txt
  3. 8.4 README.txt
  4. 5 README.txt
  5. 6.2 README.txt
  6. 6 README.txt
  7. 7.2 README.txt
                                jCarousel Module
Description
-----------

This module provides Views plugins to use the jCarousel jQuery plugin. For more
information about jCarousel, visit the official project page:
http://sorgalla.com/jcarousel/

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

1) Place this module and it's dependencies in your modules folder. This will
   usually be sites/all/modules/contrib/.

2) Download jCarousel v0.3 from the project download page
   (http://sorgalla.com/jcarousel/dist/) and place it in sites/all/libraries/
   so that it is available as:
   sites/all/libraries/jcarousel/jcarousel.jquery.js or
   sites/all/libraries/jcarousel/jcarousel.jquery.min.js

3) Enable the module within your Drupal site at Administer -> Site Building ->
   Modules (admin/build/modules).

Usage
-----

The jCarousel module is most commonly used with the Views module to turn
listings of images or other content into a carousel.

1) Install the Views module (http://drupal.org/project/views) on your Drupal
   site if you have not already.

2) Add a new view at Administration -> Structure -> Views
   (admin/structure/views).

3) Change the "Display format" of the view to "jCarousel". Disable the
   "Use pager" option, which cannot be used with the jCarousel style. Click the
   "Continue & Edit" button to configure the rest of the View.

4) Click on the "Settings" link next to the jCarousel Format to configure the
   options for the carousel such as the animation speed and skin.

5) Add the items you would like to include in the rotator under the "Fields"
   section, and build out the rest of the view as you would normally. Note that
   the preview of the carousel within Views probably will not appear correctly
   because the necessary JavaScript and CSS is not loaded in the Views
   interface. Save your view and visit a page URL containing the view to see
   how it appears.

Authors
-------

Nate Haug (http://quicksketch.org)
Matt Farina (http://www.mattfarina.com)
Wim Leers (work@wimleers.com | http://wimleers.com/work)
Rob Loach (http://www.robloach.net)

File

README.txt
View source 
  1.                                 jCarousel Module

  2. Description

  3. -----------

  4. 

  5. This module provides Views plugins to use the jCarousel jQuery plugin. For more

  6. information about jCarousel, visit the official project page:

  7. http://sorgalla.com/jcarousel/

  8. 

  9. Installation

  10. ------------

  11. 

  12. 1) Place this module and it's dependencies in your modules folder. This will

  13.    usually be sites/all/modules/contrib/.

  14. 

  15. 2) Download jCarousel v0.3 from the project download page

  16.    (http://sorgalla.com/jcarousel/dist/) and place it in sites/all/libraries/

  17.    so that it is available as:

  18.    sites/all/libraries/jcarousel/jcarousel.jquery.js or

  19.    sites/all/libraries/jcarousel/jcarousel.jquery.min.js

  20. 

  21. 3) Enable the module within your Drupal site at Administer -> Site Building ->

  22.    Modules (admin/build/modules).

  23. 

  24. Usage

  25. -----

  26. 

  27. The jCarousel module is most commonly used with the Views module to turn

  28. listings of images or other content into a carousel.

  29. 

  30. 1) Install the Views module (http://drupal.org/project/views) on your Drupal

  31.    site if you have not already.

  32. 

  33. 2) Add a new view at Administration -> Structure -> Views

  34.    (admin/structure/views).

  35. 

  36. 3) Change the "Display format" of the view to "jCarousel". Disable the

  37.    "Use pager" option, which cannot be used with the jCarousel style. Click the

  38.    "Continue & Edit" button to configure the rest of the View.

  39. 

  40. 4) Click on the "Settings" link next to the jCarousel Format to configure the

  41.    options for the carousel such as the animation speed and skin.

  42. 

  43. 5) Add the items you would like to include in the rotator under the "Fields"

  44.    section, and build out the rest of the view as you would normally. Note that

  45.    the preview of the carousel within Views probably will not appear correctly

  46.    because the necessary JavaScript and CSS is not loaded in the Views

  47.    interface. Save your view and visit a page URL containing the view to see

  48.    how it appears.

  49. 

  50. Authors

  51. -------

  52. 

  53. Nate Haug (http://quicksketch.org)

  54. Matt Farina (http://www.mattfarina.com)

  55. Wim Leers (work@wimleers.com | http://wimleers.com/work)

  56. Rob Loach (http://www.robloach.net)