CONTENTS OF THIS FILE
----------------------
* Introduction
* Installation
* Adding Lightbox Functionality to your Images
- No Grouping
- With Grouping
- Turning the Image Caption into a Link
* Known Issues
- Lightbox vs Google Analytics in Firefox
- Lightbox Lite in IE
INTRODUCTION
------------
Maintainers:
Mark Ashmead (http://drupal.org/user/52392)
Stella Power (http://drupal.org/user/66894)
Documentation: http://drupal.org/node/144469
Licensed under the GNU/GPL License
Based on Lightbox v2.03.3 by Lokesh Dhakar
Originally written to make use of the Prototype framework, and Script.acalo.us,
now altered to use jQuery.
Permission has been granted to Mark Ashmead & other Drupal Lightbox2 module
maintainers to distribute the original lightbox.js via Drupal.org under this
license scheme. This file has been subsequently modified to make use of jQuery
instead of prototype / script.acalo.us.
This module enables the use of lightbox2 which places images above your
current page, not within. This frees you from the constraints of the layout,
particularly column widths.
This module will include the lightbox CSS and JS files in your Drupal
Installation without the need to edit the theme. The module comes with a
Lightbox2 Lite option which does not use the jQuery libraries; it is therefore
less likely to conflict with anything else.
INSTALLATION
------------
1. Copy lightbox2 folder to modules directory.
2. At admin/build/modules enable the lightbox2 module.
3. Enable permissions at admin/user/permissions.
4. Configure the module at admin/settings/lightbox2.
5. Modify your image links to open in a lightbox where necessary, see "Adding
Lightbox Functionality to your Images' section below.
ADDING LIGHTBOX FUNCTIONALITY TO YOUR IMAGES
--------------------------------------------
No Grouping
===========
Add rel="lightbox" attribute to any link tag to activate the lightbox.
For example:
image #1
Optional: Use the title attribute if you want to show a caption.
With Grouping
==============
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:
image #1
image #2
image #3
No limits to the number of image sets per page or how many images are allowed
in each set. Go nuts!
If you have a set of images that you would like to group together in a
lightbox, but only wish for one of these images to be visible on your page, you
can assign the "lightbox_hide_image" class to hide the additional images. For
example:
image #1
image #2
image #3
Turning the Image Caption into a Link
=====================================
If you wish to turn the caption into a link, format your caption in the
following way:
image #1
KNOWN ISSUES
------------
Lightbox vs Google Analytics in Firefox
---------------------------------------
There is a conflict between Lightbox2 and Google Analytics module in Drupal 6.x
which happens only in the Firefox browser. When an image is clicked on, the
lightbox briefly appears but then the image is opened in a new page. So far,
cases have only been reported with Firefox 2 and it's possible that it may be
fixed in Firefox 3 beta. This conflict is due to the newer version of jQuery
(1.2.3) used in Drupal 6.x and doesn't happen with the older version in Drupal
5.x. Turning off the download tracker in the Google Analytics module fixes the
problem. Alternatively, there is a workaround patch in issue #224442, along
with details on the problem.
Lightbox Lite in IE
--------------------
There is an issue with Lightbox Lite in IE browsers but only for sites where
Drupal is installed in a subdirectory. In such instances, the overlay.png image
can not be found. To overcome this issue you will need to edit the
lightbox2/css/lightbox_lite.css file and change the path to this image. By
default the line is set to:
filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src="../images/overlay.png", sizingMethod="scale");
You will need to change the image path on this line to be the full path, e.g.
filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src="/sites/all/modules/lightbox2/images/overlay.png", sizingMethod="scale");
See http://drupal.org/node/185866 for more details.