You are here

Home » API reference » Lightbox2 5

README.txt in Lightbox2 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 5.2 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
LIGHTBOX V2 MODULE

------------------

Drupal Lightbox V2 Module:
By: Mark Ashmead
Mailto: bugzie@gmail.com
Co-maintainer: Stella Power (http://drupal.org/user/66894)

Licensed under the GNU/GPL License

Permission has been granted by Lokesh Dhakar to distribute the lightbox.js file via Drupal.org under this license scheme, as allowed by the Creative Commons License.

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.

---------------------------------------------------------------------------------------------------------

Pre-Installation
----------------

Due to variation in licensing, you will need to download the
Scriptaculous/Prototype libraries seperately. Please visit:
http://www.stellapowerdesign.net/scriptaculous-drupal.zip - and download the latest version of the libraries. You will then need to copy the files located in \lib and \src directories of this download into the \lightbox2\js\ directory of the LightboxV2 module. 

The files required are: 

\lib\prototype.js
\src\builder.js
\src\dragdrop.js
\src\effects.js
\src\scriptaculous.js
\src\slider.js
\src\unittest.js

When copied, the directory should look like:

\lightbox2\js\prototype.js
\lightbox2\js\builder.js
\lightbox2\js\dragdrop.js
\lightbox2\js\effects.js
\lightbox2\js\scriptaculous.js
\lightbox2\js\slider.js
\lightbox2\js\unittest.js


Installation
------------
1. Copy lightbox2 folder to modules directory
2. At admin/modules enable the module
3. Add rel="lightbox" attribute to any link tag to activate the lightbox. For example:

<a href="images/image-1.jpg" rel="lightbox" title="my caption">image #1</a>

Optional: Use the title attribute if you want to show a caption.

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: 

<a href="images/image-1.jpg" rel="lightbox[roadtrip]">image #1</a>
<a href="images/image-2.jpg" rel="lightbox[roadtrip]">image #2</a>
<a href="images/image-3.jpg" rel="lightbox[roadtrip]">image #3</a>

No limits to the number of image sets per page or how many images are allowed in each set. Go nuts! 

5. If you wish to turn the caption into a link, format your caption in the following way:

<a href="images/image-1.jpg" rel="lightbox" title='<a href="http://www.yourlink.com">Clicky Visit Link</a>'>image #1</a>


Information
------------

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 Scriptaculous/Prototype libraries; it is therefore less likely to conflict with anything else.

File

README.txt
View source 
  1. LIGHTBOX V2 MODULE

  2. 

  3. ------------------

  4. 

  5. Drupal Lightbox V2 Module:

  6. By: Mark Ashmead

  7. Mailto: bugzie@gmail.com

  8. Co-maintainer: Stella Power (http://drupal.org/user/66894)

  9. 

  10. Licensed under the GNU/GPL License

  11. 

  12. Permission has been granted by Lokesh Dhakar to distribute the lightbox.js file via Drupal.org under this license scheme, as allowed by the Creative Commons License.

  13. 

  14. 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.

  15. 

  16. ---------------------------------------------------------------------------------------------------------

  17. 

  18. Pre-Installation

  19. ----------------

  20. 

  21. Due to variation in licensing, you will need to download the

  22. Scriptaculous/Prototype libraries seperately. Please visit:

  23. http://www.stellapowerdesign.net/scriptaculous-drupal.zip - and download the latest version of the libraries. You will then need to copy the files located in \lib and \src directories of this download into the \lightbox2\js\ directory of the LightboxV2 module. 

  24. 

  25. The files required are: 

  26. 

  27. \lib\prototype.js

  28. \src\builder.js

  29. \src\dragdrop.js

  30. \src\effects.js

  31. \src\scriptaculous.js

  32. \src\slider.js

  33. \src\unittest.js

  34. 

  35. When copied, the directory should look like:

  36. 

  37. \lightbox2\js\prototype.js

  38. \lightbox2\js\builder.js

  39. \lightbox2\js\dragdrop.js

  40. \lightbox2\js\effects.js

  41. \lightbox2\js\scriptaculous.js

  42. \lightbox2\js\slider.js

  43. \lightbox2\js\unittest.js

  44. 

  45. 

  46. Installation

  47. ------------

  48. 1. Copy lightbox2 folder to modules directory

  49. 2. At admin/modules enable the module

  50. 3. Add rel="lightbox" attribute to any link tag to activate the lightbox. For example:

  51. 

  52. image #1

  53. 

  54. Optional: Use the title attribute if you want to show a caption.

  55. 

  56. 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: 

  57. 

  58. image #1

  59. image #2

  60. image #3

  61. 

  62. No limits to the number of image sets per page or how many images are allowed in each set. Go nuts! 

  63. 

  64. 5. If you wish to turn the caption into a link, format your caption in the following way:

  65. 

  66. image #1

  67. 

  68. 

  69. Information

  70. ------------

  71. 

  72. 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 Scriptaculous/Prototype libraries; it is therefore less likely to conflict with anything else.