Lightbox Module - Added line about CVS.
[project/lightbox2.git] / README.txt
1 LIGHTBOX V2 MODULE Version 1.0
2 -----------------
3
4 Drupal Lightbox V2 Module:
5 By: Mark Ashmead
6 Mailto: bugzie@gmail.com
7
8 Licensed under the GNU/GPL License
9
10 This module enables the use of lightbox V2 which places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths..
11
12 ---------------------------------------------------------------------------------------------------------
13
14 Installation
15 ------------
16 1. Copy lightbox folder to modules directory
17 2. At admin/modules enable the module
18 3. Add rel="lightbox" attribute to any link tag to activate the lightbox. For example:
19
20 <a href="images/image-1.jpg" rel="lightbox" title="my caption">image #1</a>
21
22 Optional: Use the title attribute if you want to show a caption.
23
24 4. If you have a set of related images that you would like to group, follow step one but additionally include a group name between square brackets in the rel attribute. For example: 
25
26 <a href="images/image-1.jpg" rel="lightbox[roadtrip]">image #1</a>
27 <a href="images/image-2.jpg" rel="lightbox[roadtrip]">image #2</a>
28 <a href="images/image-3.jpg" rel="lightbox[roadtrip]">image #3</a>
29
30 No limits to the number of image sets per page or how many images are allowed in each set. Go nuts! 
31
32
33
34 Information
35 -------------
36
37 This module will include the lightbox CSS and JS files in your Drupal Installation without the need to edit the theme.
38
39
40 TODO
41 -------------
42
43 Create a seperate module to introduce the scriptaculous library to Drupal. This will allow porting of other modules without conflict.