slideshow.module ($Id: README.txt,v 1.4 2006/07/14 13:28:34 timcn Exp $)
================



  === DESCRIPTION ===
slideshow.module provides basic slideshow capabilities. It transforms
[slideshow: ...] commands inside any node type thru a filter in slideshows.
If the user does not have JavaScript enabled, it degrades
to a "regular" slideshow where the "next" button points to the next
image and a whole new page is loaded.



  === FEATURES ===
* Convenient: Can be inserted in any node type
* Customize: add as many imagens you want, rotate speed and even more than one slideshow per page
* Lightweight: The JavaScript file weighs only 2.2 kB
* Themable: use a CSS or just modify one small theme function
* Usable: Users with JavaScript enabled don't have to reload the page



  === INSTALLATION ===
Just copy the folder to your /modules/ folder and activate the
module in your Drupal installation.

Go to administer > input formats and add slideshow filter in any
filter type yout site have.



  === USE ===
In any node, add the string:
[slideshow:VERSION,ROTATE_SPEED,|IMAGE_URL|LINK|TITLE|DESCRIPTION|,|IMAGE_URL|LINK|TITLE|DESCRIPTION|]
where:
VERSION: the slideshow filter version: use always 1
ROTATE_SPEED: the speed, in seconds, to rotate images (0 to not rotate at all)

than, for each image you want to insert, use:
IMAGE_URL: the image itself
LINK: if you want to provide a link to some page, put the url here
TITLE: often the bold text over the image
DESCRIPTION: often the text under the image

ie:
[slideshow:1,4,|http://drupal.org/drupal.png|drupal.org|Drupal|The ultimate CMS. Download it now!|,|/files/images/mysql.gif|http://www.mysql.com|MySQL|Free and reliable SQL server and client.|]



  === DEVELOPMENT ===
Due to it's simpleness, slideshow.module doesn't provide a bunch
of features. It just does what it's supposed to do. It doesn't have
transitions or a lot of settings you can change.

slideshow.module is in development. There are some features I'd like
to implement that aren't available yet. Planned features include the
possibility to rearrange images, to add fade in/out effects (cross browser),
rework on style and css to become really customizable...

If you have suggestions, don't hesitate to post your suggestions as
an issue on drupal.org. Feel free to supply patches. I'll definitely
review them and roll them in if they are sensible enhancements to
this module.

