modules/slideshow_creator/README.txt

// $Id: README.txt,v 1.1.1.3 2007/08/01 14:26:36 brmassa Exp $
********************************************************************************
                     D R U P A L    M O D U L E
********************************************************************************
Module Name        : Slideshow Creator
Original Author    : Bruno Massa http://drupal.org/user/67164
General Links:
Project Page       : http://drupal.org/project/slideshow_creator
Support Queue      : http://drupal.org/project/issues/slideshow_creator

********************************************************************************


DESCRIPTION
-----------

Slideshow Creator creates a true slideshows using any image over internet with many other features.
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
--------

* CCK: Slideshow Creator has its own widget to CCK
* Automaticaaly extract images from a given directory
* Convenient: can be inserted in any node type
* Customize: add as many images you want, rotate speed and even more than one slideshow per page
* Lightweight: the JavaScript file is very small
* Themable: use a CSS to customize the look
* Usable: JavaScript enhance the slideshow, but it is not required
* Valid: the code is XHTML 1.0 Strict


USE
---

In any node, add the string:
[slideshow:VERSION, rotate=ROTATE_SPEED, blend=BLEND, layout=LAYOUT, name=SLIDESHOW_NAME, height=HEIGHT, width=WIDTH, img=|IMAGE_URL|LINK|TITLE|DESCRIPTION|TARGET|, img=|IMAGE_URL|LINK|TITLE|DESCRIPTION|TARGET|]

where:
VERSION [required]: the slideshow filter version: currently 2
ROTATE_SPEED [optional]: the speed, in seconds, to rotate images (0 to not rotate at all)
SLIDESHOW_NAME [optional]: you can theme your slideshow thru CSS giving it a class name
HEIGHT [optional]: all images will be at the same height
WIDTH [optional]: all images will be at the same width
BLEND [optional]: how long will take the fading transaction between images
LAYOUT [optional]: the buttons, title and description can be displayed under several combinations. You can choose between top, bottom, reverse or default.

than, for each image you want to insert, use:
IMAGE_URL [required]: the image itself
LINK [optional]: if you want to provide a link to some page, put the URL here
TITLE [optional]: often the bold text over the image
DESCRIPTION [optional]: often the text under the image
TARGET [optional]: where the linked page will show: _blank (default) will show on another window, _parent and _top is only used when pages have frames, _self shows on the very window or you can use a window name.

New feature: automatically extract images from a given directory
You can create a normal slideshow, but you can scan for more images using dir=|DIR_IMAGE|DIR_RECURSIVE|DIR_LINK|TITLE|DESCRIPTION|TARGET|

where:
DIR_IMAGE [required]: the diretory that you want to scan for images
DIR_RECURSIVE [optional]: "yes" if you want to scan recursively or leave it blank
DIR_LINK [optional]: "yes" if you want link all images to their own path or leave it blank
TITLE,DESCRIPTION and TARGET are applied to all images

example: (you can copy and paste)
[slideshow: 2, rotate=2, blend=1, img=|http://drupal.org/themes/bluebeach/logos/drupal.org.png|drupal.org|Drupal|The ultimate CMS. Download it now!|Drupal|, img=|http://www.mysql.com/common/logos/mysql_100x52-64.gif|http://www.mysql.com|MySQL|Free and reliable SQL server and client.|_self|, dir=|files/|yes||Generic Photos|Arent they great?||]


INSTALLATION
------------
1* Just copy the folder to your /modules/ folder
2* Activate the module in your Drupal installation. Go to administer > modules (on Drupal 4.7) or administer > site building > modules (on Drupal 5.0)
3* Go to administer > input formats (on Drupal 4.7) or administer > site configuration > input formats (on Drupal 5.0) and add slideshow filter in any filter type your site have.


KNOWN ISSUES AND SPECIAL SITUATIONS
-----------------------------------
1* on Drupal 4.7, on node's trimmed version, the filter can be broken in the middle, so always add a "<!--break-->" after the desired point.
2* the "target" feature is only available thru JavaScript, in order to maintain the page XHTML 1.0 Strict
3* blend feature don't work on Konqueror browser 3.x, unfortunately
4* you want to hide the buttons? put the name=BLABLABLA on [slideshow..] tag and, on CSS, put
.BLABLABLA .ssc-previous,.BLABLABLA .ssc-next,.BLABLABLA .ssc-index,.BLABLABLA {display:none;}


DEVELOPMENT
-----------

If you have suggestions or complains, don't hesitate to post your suggestions as an issue on drupal.org.
If you know PHP and Drupal and want to help on this module, post your code now!
Translations are also welcome! I will include all translated code and documentation.

This module is sponsored by the brazilian company Titan Atlas (titanatlas.com).
1	// $Id: README.txt,v 1.1.1.3 2007/08/01 14:26:36 brmassa Exp $
2	********************************************************************************
3	D R U P A L M O D U L E
4	********************************************************************************
5	Module Name : Slideshow Creator
6	Original Author : Bruno Massa http://drupal.org/user/67164
7	General Links:
8	Project Page : http://drupal.org/project/slideshow_creator
9	Support Queue : http://drupal.org/project/issues/slideshow_creator
10
11	********************************************************************************
12
13
14	DESCRIPTION
15	-----------
16
17	Slideshow Creator creates a true slideshows using any image over internet with many other features.
18	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.
19
20
21	FEATURES
22	--------
23
24	* CCK: Slideshow Creator has its own widget to CCK
25	* Automaticaaly extract images from a given directory
26	* Convenient: can be inserted in any node type
27	* Customize: add as many images you want, rotate speed and even more than one slideshow per page
28	* Lightweight: the JavaScript file is very small
29	* Themable: use a CSS to customize the look
30	* Usable: JavaScript enhance the slideshow, but it is not required
31	* Valid: the code is XHTML 1.0 Strict
32
33
34	USE
35	---
36
37	In any node, add the string:
38	[slideshow:VERSION, rotate=ROTATE_SPEED, blend=BLEND, layout=LAYOUT, name=SLIDESHOW_NAME, height=HEIGHT, width=WIDTH, img=\|IMAGE_URL\|LINK\|TITLE\|DESCRIPTION\|TARGET\|, img=\|IMAGE_URL\|LINK\|TITLE\|DESCRIPTION\|TARGET\|]
39
40	where:
41	VERSION [required]: the slideshow filter version: currently 2
42	ROTATE_SPEED [optional]: the speed, in seconds, to rotate images (0 to not rotate at all)
43	SLIDESHOW_NAME [optional]: you can theme your slideshow thru CSS giving it a class name
44	HEIGHT [optional]: all images will be at the same height
45	WIDTH [optional]: all images will be at the same width
46	BLEND [optional]: how long will take the fading transaction between images
47	LAYOUT [optional]: the buttons, title and description can be displayed under several combinations. You can choose between top, bottom, reverse or default.
48
49	than, for each image you want to insert, use:
50	IMAGE_URL [required]: the image itself
51	LINK [optional]: if you want to provide a link to some page, put the URL here
52	TITLE [optional]: often the bold text over the image
53	DESCRIPTION [optional]: often the text under the image
54	TARGET [optional]: where the linked page will show: _blank (default) will show on another window, _parent and _top is only used when pages have frames, _self shows on the very window or you can use a window name.
55
56	New feature: automatically extract images from a given directory
57	You can create a normal slideshow, but you can scan for more images using dir=\|DIR_IMAGE\|DIR_RECURSIVE\|DIR_LINK\|TITLE\|DESCRIPTION\|TARGET\|
58
59	where:
60	DIR_IMAGE [required]: the diretory that you want to scan for images
61	DIR_RECURSIVE [optional]: "yes" if you want to scan recursively or leave it blank
62	DIR_LINK [optional]: "yes" if you want link all images to their own path or leave it blank
63	TITLE,DESCRIPTION and TARGET are applied to all images
64
65	example: (you can copy and paste)
66	[slideshow: 2, rotate=2, blend=1, img=\|http://drupal.org/themes/bluebeach/logos/drupal.org.png\|drupal.org\|Drupal\|The ultimate CMS. Download it now!\|Drupal\|, img=\|http://www.mysql.com/common/logos/mysql_100x52-64.gif\|http://www.mysql.com\|MySQL\|Free and reliable SQL server and client.\|_self\|, dir=\|files/\|yes\|\|Generic Photos\|Arent they great?\|\|]
67
68
69	INSTALLATION
70	------------
71	1* Just copy the folder to your /modules/ folder
72	2* Activate the module in your Drupal installation. Go to administer > modules (on Drupal 4.7) or administer > site building > modules (on Drupal 5.0)
73	3* Go to administer > input formats (on Drupal 4.7) or administer > site configuration > input formats (on Drupal 5.0) and add slideshow filter in any filter type your site have.
74
75
76	KNOWN ISSUES AND SPECIAL SITUATIONS
77	-----------------------------------
78	1* on Drupal 4.7, on node's trimmed version, the filter can be broken in the middle, so always add a "<!--break-->" after the desired point.
79	2* the "target" feature is only available thru JavaScript, in order to maintain the page XHTML 1.0 Strict
80	3* blend feature don't work on Konqueror browser 3.x, unfortunately
81	4* you want to hide the buttons? put the name=BLABLABLA on [slideshow..] tag and, on CSS, put
82	.BLABLABLA .ssc-previous,.BLABLABLA .ssc-next,.BLABLABLA .ssc-index,.BLABLABLA {display:none;}
83
84
85	DEVELOPMENT
86	-----------
87
88	If you have suggestions or complains, don't hesitate to post your suggestions as an issue on drupal.org.
89	If you know PHP and Drupal and want to help on this module, post your code now!
90	Translations are also welcome! I will include all translated code and documentation.
91
92	This module is sponsored by the brazilian company Titan Atlas (titanatlas.com).