modules/slideshow/README.txt

slideshow.module ($Id: README.txt,v 1.5 2006/09/14 13:13:52 timcn Exp $)
================


  === DESCRIPTION ===
slideshow.module provides basic slideshow capabilities. It transforms
images attached to nodes to a JavaScript enabled slideshow. 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.
Any post can contain a slideshow: Enable slideshow for a content type
at Administer >> Content management >> Content types >> [content type]


  === FEATURES ===
* Convenient: Just attach an image to the slideshow node
* Lightweight: The JavaScript file weighs only 1.6 kB
* Themable: Just modify three small theme functions
* 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.

If you do not have enabled the upload module, do it now as this
module (obviously) depends on it.


  === CONFIGURATION ===
Also, you need to configure the upload.module properly. Make sure 
that the path specified unter "administer --> settings --> File system 
settings" exists. The default installation does not come with the 
preconfigured 'files' directory. You have to create that directory 
manually or specify another directory name that exists.

If you don't want to see the files listing below the content of the
slideshow you have to uncheck the checkbox in the "List" column
left to each file in the "Attachments" table.


  === 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 include images from image nodes,
a more flexible image resize system...

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.

1	slideshow.module ($Id: README.txt,v 1.5 2006/09/14 13:13:52 timcn Exp $)
2	================
3
4
5
6	=== DESCRIPTION ===
7	slideshow.module provides basic slideshow capabilities. It transforms
8	images attached to nodes to a JavaScript enabled slideshow. If the user does not
9	have JavaScript enabled, it degrades to a "regular" slideshow where the "next"
10	button points to the next image and a whole new page is loaded.
11	Any post can contain a slideshow: Enable slideshow for a content type
12	at Administer >> Content management >> Content types >> [content type]
13
14
15
16	=== FEATURES ===
17	* Convenient: Just attach an image to the slideshow node
18	* Lightweight: The JavaScript file weighs only 1.6 kB
19	* Themable: Just modify three small theme functions
20	* Usable: Users with JavaScript enabled don't have to reload the page
21
22
23
24	=== INSTALLATION ===
25	Just copy the folder to your modules folder and activate the
26	module in your Drupal installation.
27
28	If you do not have enabled the upload module, do it now as this
29	module (obviously) depends on it.
30
31
32
33	=== CONFIGURATION ===
34	Also, you need to configure the upload.module properly. Make sure
35	that the path specified unter "administer --> settings --> File system
36	settings" exists. The default installation does not come with the
37	preconfigured 'files' directory. You have to create that directory
38	manually or specify another directory name that exists.
39
40	If you don't want to see the files listing below the content of the
41	slideshow you have to uncheck the checkbox in the "List" column
42	left to each file in the "Attachments" table.
43
44
45
46
47
48	=== DEVELOPMENT ===
49	Due to it's simpleness, slideshow.module doesn't provide a bunch
50	of features. It just does what it's supposed to do. It doesn't have
51	transitions or a lot of settings you can change.
52
53	slideshow.module is in development. There are some features I'd like
54	to implement that aren't available yet. Planned features include the
55	possibility to rearrange images, to include images from image nodes,
56	a more flexible image resize system...
57
58	If you have suggestions, don't hesitate to post your suggestions as
59	an issue on drupal.org. Feel free to supply patches. I'll definitely
60	review them and roll them in if they are sensible enhancements to
61	this module.
62