You are here

Home » API reference » Lightbox2 8

README.txt in Lightbox2 8

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
CONTENTS OF THIS FILE
----------------------

  * Introduction
  * Installation
  * Adding Lightbox Functionality to your Images
    - No Grouping
    - With Grouping
    - Slideshow
    - Video
    - HTML Content Support
    - Inline Content Support
    - Turning the Image Caption into a Link
  * Keyboard Shortcuts
  * Translation of Configured Strings
  * Known Issues
    - Keyboard Shortcuts in Opera


INTRODUCTION
------------
Maintainers:
  Stella Power (http://drupal.org/user/66894)
  Daniel F. Kudwien (http://drupal.org/user/54136)
  Mark Ashmead (http://drupal.org/user/52392)
  Fernando Correa da Conceição (http://drupal.org/user/889254)

Documentation: http://drupal.org/node/144469

Licensed under the GNU/GPL License
Based on Lightbox v2.03.3 by Lokesh Dhakar
<http://www.huddletogether.com/projects/lightbox2/>

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/modules enable the lightbox2 module.
3. Enable permissions at admin/people/permissions.
4. Configure the module at admin/config/user-interface/lightbox2.
5. Modify your image links to open in a lightbox where necessary, see "Adding
   Lightbox Functionality to your Images' section below.
6. If you need to play flv files, then you may need to install a FLV player.
   There are a number of freely available ones on the Internet, including
   http://www.jeroenwijering.com/


ADDING LIGHTBOX FUNCTIONALITY TO YOUR IMAGES
--------------------------------------------
No Grouping
===========
Add rel="lightbox" attribute to any link tag to activate the lightbox.
For example:
<a href="images/image-1.jpg" rel="lightbox">image #1</a>
<a href="images/image-1.jpg" rel="lightbox[][my caption]">image #1</a>

Optional: To show a caption either use the title attribute or put in the second
set of [] of the rel attribute.

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:

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

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:

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

Slideshow
=========
This is very similar to the grouping functionality described above.  The only
difference is that "rel" attribute should be set to "lightshow" instead of
"lightbox".  Using the same example as above, we could launch the images in a
slideshow by doing:

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

Video
=====
It's possible to show video content in the lightbox.  In this case the "rel"
attribute should be set to "lightvideo".  It's possible to group videos and 
to control the size of the lightbox by setting the 'width' and 'height
properties.  The properties can be configured like
"lightvideo[group|width:300px; height: 200px;]" and
"lightvideo[|width:300px; height: 200px;][my caption]".  The properties should
all be of the format "property: value;" - note the closing semi-colon.  If no
properties are set, then the default width and height of 400px will be used.
See below for more detailed examples.

Basic example:
<a href="http://video.google.com/videoplay?docid=1811233136844420765"
rel="lightvideo">Google video example - default size</a>

Basic example with caption:
<a href="http://video.google.com/videoplay?docid=1811233136844420765"
rel="lightvideo[][my caption]">Google video example - default size</a>

Grouped example:
<a href="http://video.google.com/videoplay?docid=29023498723974239479"
rel="lightvideo[group][caption 1]">Grouped example 1</a>
<a href="http://video.google.com/videoplay?docid=1811233136844420765"
rel="lightvideo[group][caption 2]">Grouped example 2</a>

Controlling lightbox size example:
<a href="http://video.google.com/videoplay?docid=1811233136844420765"
rel="lightvideo[|width:400px; height:300px;][my caption]">Google video example -
custom size</a>

Supported Video Formats
asx, wmv, mov and swf videos should all be supported.  A number of video
providers are also supported, for example YouTube and Google Video. For full
details on how to integrate these with lightbox, please see the online
documentation.

HTML Content Support
====================
It's possible to show webpage content in the lightbox, using iframes.  In this
case the "rel" attribute should be set to "lightframe".  Again it's possible to
group the content, (e.g. "lightframe[search]") but in addition to that, it's
possible to control some of the iframe properties.  It's possible to set the
'width', 'height' and 'scrolling' properties of the iframe.  The properties are
separated from the group name by a '|', for example
"lightframe[search|width:100px;]" and
"lightframe[search|width:100px;][my caption]".  If no grouping is being used,
then the '|' is still used and the format would be "lightframe[|width:100px;]".
The properties should all be of the format "property: value;" - note the closing
semi-colon.  If no iframe properties are set, then the default width and height
of 400px will be used. See below for more detailed examples.

Basic example:
<a href="http://www.google.com" rel="lightframe">Search google</a>

Basic example with caption:
<a href="http://www.google.com" rel="lightframe[][my caption]">Search google</a>

Grouped example:
<a href="http://www.google.com" rel="lightframe[search]">Search google</a>
<a href="http://www.yahoo.com" rel="lightframe[search][Search Yahoo]">Search yahoo</a>

Controlling iframe property example:
<a href="http://www.google.com" rel="lightframe[|width:400px; height:300px; scrolling: auto;]">Search google</a>

Controlling iframe property when grouped example:
<a href="http://www.google.com" rel="lightframe[search|width:400px; height:300px; scrolling: auto;][Search Google]">Search google</a>
<a href="http://www.yahoo.com" rel="lightframe[search|width:400px; height:300px;]">Search yahoo</a>
<a href="http://www.yahoo.com" rel="lightframe[search|width:400px; height:300px;][Search Yahoo]">Search yahoo</a>

Inline Content Support
=======================
It's possible to show HTML snippets in the lightbox, that is on the same domain.
In this case the "rel" attribute should be set to "lightmodal".  Again it's
possible to group the content, (e.g. "lightmodal[search]") but in addition to
that, it's possible to control some of the inline / modal properties.  It's
possible to set the 'width', 'height' and 'scrolling' properties of the inline
content.  The properties are separated from the group name by a '|', for example
"lightmodal[search|width:100px;]" and
"lightmodal[search|width:100px;][my caption]".  If no grouping is being used,
then the '|' is still used and the format would be "lightmodal[|width:100px;]".
The properties should all be of the format "property: value;" - note the closing
semi-colon.  If no properties are set, then the default width and height of
400px will be used. See below for more detailed examples.

Basic example:
<a href="search.php" rel="lightmodal">Search</a>

Basic example with caption:
<a href="search.php" rel="lightmodal[][my caption]">Search</a>

Grouped example:
<a href="search.php" rel="lightmodal[search]">Search</a>
<a href="search.php?status=1" rel="lightmodal[search][published]">Search published content</a>

Controlling modal property example:
<a href="search.php" rel="lightmodal[|width:400px; height:300px; scrolling: auto;]">Search</a>

Controlling modal property when grouped example:
<a href="search.php" rel="lightmodal[search|width:400px; height:300px; scrolling: auto;]">Search</a>
<a href="search.php?status=1" rel="lightmodal[search|width:400px; height:300px;][Search published]">Search published content</a>
<a href="search.php?status=0" rel="lightmodal[search|width:400px; height:300px;][Search Unpublished]">Search unpublished content</a>



Turning the Image Caption into a Link
=====================================
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[][&lt;a href=\"http://www.yourlink.com\"&gt;Clicky Visit Link&lt;/a&gt;'>image #1</a>

Note, the < and > characters have been changed to their HTML entities, and the "
have been escaped.


KEYBOARD SHORTCUTS
------------------
Not all of the default keyboard shortcuts work in the Opera browser, for example
'z' for toggling the zoom and 'spacebar' for toggling play / pause in
slideshows.  This can be overcome by updating your shortcut settings in the
Opera preferences editor.

The default keyboard shortcuts are listed below.  You can override these on
admin/settings/lightbox2.

Close : x, o, c, ESC
Previous Image : p, Left Arrow
Next Image : n, Right Arrow
Toggle Zoom : z (not available in slideshow)
Toggle Play / Pause : Spacebar (slideshow only)


TRANSLATION OF CONFIGURED STRINGS
----------------------------------
In order to translate the lightbox2 configuration strings, such as the text for
the "View Image Details" link and the image count, please install the i18n:
internationalization module and follow the instructions at 
http://drupal.org/node/134002.


KNOWN ISSUES
------------

Keyboard Shortcuts in Opera
---------------------------
Not all of the default keyboard shortcuts work in the Opera browser, for example
'z' for toggling the zoom and 'spacebar' for toggling play / pause in
slideshows.  This can be overcome by updating your shortcut settings in the
Opera preferences editor.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ----------------------

  3. 

  4.   * Introduction

  5.   * Installation

  6.   * Adding Lightbox Functionality to your Images

  7.     - No Grouping

  8.     - With Grouping

  9.     - Slideshow

  10.     - Video

  11.     - HTML Content Support

  12.     - Inline Content Support

  13.     - Turning the Image Caption into a Link

  14.   * Keyboard Shortcuts

  15.   * Translation of Configured Strings

  16.   * Known Issues

  17.     - Keyboard Shortcuts in Opera

  18. 

  19. 

  20. INTRODUCTION

  21. ------------

  22. Maintainers:

  23.   Stella Power (http://drupal.org/user/66894)

  24.   Daniel F. Kudwien (http://drupal.org/user/54136)

  25.   Mark Ashmead (http://drupal.org/user/52392)

  26.   Fernando Correa da Conceição (http://drupal.org/user/889254)

  27. 

  28. Documentation: http://drupal.org/node/144469

  29. 

  30. Licensed under the GNU/GPL License

  31. Based on Lightbox v2.03.3 by Lokesh Dhakar

  32. 

  33. 

  34. Originally written to make use of the Prototype framework, and Script.acalo.us,

  35. now altered to use jQuery.

  36. 

  37. Permission has been granted to Mark Ashmead & other Drupal Lightbox2 module

  38. maintainers to distribute the original lightbox.js via Drupal.org under this

  39. license scheme.  This file has been subsequently modified to make use of jQuery

  40. instead of prototype / script.acalo.us.

  41. 

  42. This module enables the use of lightbox2 which places images above your

  43. current page, not within. This frees you from the constraints of the layout,

  44. particularly column widths.

  45. 

  46. This module will include the lightbox CSS and JS files in your Drupal

  47. Installation without the need to edit the theme. The module comes with a

  48. Lightbox2 Lite option which does not use the jQuery libraries; it is therefore

  49. less likely to conflict with anything else.

  50. 

  51. 

  52. INSTALLATION

  53. ------------

  54. 1. Copy lightbox2 folder to modules directory.

  55. 2. At admin/modules enable the lightbox2 module.

  56. 3. Enable permissions at admin/people/permissions.

  57. 4. Configure the module at admin/config/user-interface/lightbox2.

  58. 5. Modify your image links to open in a lightbox where necessary, see "Adding

  59.    Lightbox Functionality to your Images' section below.

  60. 6. If you need to play flv files, then you may need to install a FLV player.

  61.    There are a number of freely available ones on the Internet, including

  62.    http://www.jeroenwijering.com/

  63. 

  64. 

  65. ADDING LIGHTBOX FUNCTIONALITY TO YOUR IMAGES

  66. --------------------------------------------

  67. No Grouping

  68. ===========

  69. Add rel="lightbox" attribute to any link tag to activate the lightbox.

  70. For example:

  71. image #1

  72. image #1

  73. 

  74. Optional: To show a caption either use the title attribute or put in the second

  75. set of [] of the rel attribute.

  76. 

  77. With Grouping

  78. ==============

  79. If you have a set of related images that you would like to group, follow step

  80. one but additionally include a group name between square brackets in the rel

  81. attribute. For example:

  82. 

  83. image #1

  84. image #2

  85. image #3

  86. 

  87. No limits to the number of image sets per page or how many images are allowed

  88. in each set. Go nuts!

  89. 

  90. If you have a set of images that you would like to group together in a

  91. lightbox, but only wish for one of these images to be visible on your page, you

  92. can assign the "lightbox_hide_image" class to hide the additional images.  For

  93. example:

  94. 

  95. image #1

  96. image #2

  97. image #3

  98. 

  99. Slideshow

  100. =========

  101. This is very similar to the grouping functionality described above.  The only

  102. difference is that "rel" attribute should be set to "lightshow" instead of

  103. "lightbox".  Using the same example as above, we could launch the images in a

  104. slideshow by doing:

  105. 

  106. image #1

  107. image #2

  108. image #3

  109. 

  110. Video

  111. =====

  112. It's possible to show video content in the lightbox.  In this case the "rel"

  113. attribute should be set to "lightvideo".  It's possible to group videos and 

  114. to control the size of the lightbox by setting the 'width' and 'height

  115. properties.  The properties can be configured like

  116. "lightvideo[group|width:300px; height: 200px;]" and

  117. "lightvideo[|width:300px; height: 200px;][my caption]".  The properties should

  118. all be of the format "property: value;" - note the closing semi-colon.  If no

  119. properties are set, then the default width and height of 400px will be used.

  120. See below for more detailed examples.

  121. 

  122. Basic example:

  124. rel="lightvideo">Google video example - default size

  125. 

  126. Basic example with caption:

  128. rel="lightvideo[][my caption]">Google video example - default size

  129. 

  130. Grouped example:

  132. rel="lightvideo[group][caption 1]">Grouped example 1

  134. rel="lightvideo[group][caption 2]">Grouped example 2

  135. 

  136. Controlling lightbox size example:

  138. rel="lightvideo[|width:400px; height:300px;][my caption]">Google video example -

  139. custom size

  140. 

  141. Supported Video Formats

  142. asx, wmv, mov and swf videos should all be supported.  A number of video

  143. providers are also supported, for example YouTube and Google Video. For full

  144. details on how to integrate these with lightbox, please see the online

  145. documentation.

  146. 

  147. HTML Content Support

  148. ====================

  149. It's possible to show webpage content in the lightbox, using iframes.  In this

  150. case the "rel" attribute should be set to "lightframe".  Again it's possible to

  151. group the content, (e.g. "lightframe[search]") but in addition to that, it's

  152. possible to control some of the iframe properties.  It's possible to set the

  153. 'width', 'height' and 'scrolling' properties of the iframe.  The properties are

  154. separated from the group name by a '|', for example

  155. "lightframe[search|width:100px;]" and

  156. "lightframe[search|width:100px;][my caption]".  If no grouping is being used,

  157. then the '|' is still used and the format would be "lightframe[|width:100px;]".

  158. The properties should all be of the format "property: value;" - note the closing

  159. semi-colon.  If no iframe properties are set, then the default width and height

  160. of 400px will be used. See below for more detailed examples.

  161. 

  162. Basic example:

  163. Search google

  164. 

  165. Basic example with caption:

  166. Search google

  167. 

  168. Grouped example:

  169. Search google

  170. Search yahoo

  171. 

  172. Controlling iframe property example:

  173. Search google

  174. 

  175. Controlling iframe property when grouped example:

  176. Search google

  177. Search yahoo

  178. Search yahoo

  179. 

  180. Inline Content Support

  181. =======================

  182. It's possible to show HTML snippets in the lightbox, that is on the same domain.

  183. In this case the "rel" attribute should be set to "lightmodal".  Again it's

  184. possible to group the content, (e.g. "lightmodal[search]") but in addition to

  185. that, it's possible to control some of the inline / modal properties.  It's

  186. possible to set the 'width', 'height' and 'scrolling' properties of the inline

  187. content.  The properties are separated from the group name by a '|', for example

  188. "lightmodal[search|width:100px;]" and

  189. "lightmodal[search|width:100px;][my caption]".  If no grouping is being used,

  190. then the '|' is still used and the format would be "lightmodal[|width:100px;]".

  191. The properties should all be of the format "property: value;" - note the closing

  192. semi-colon.  If no properties are set, then the default width and height of

  193. 400px will be used. See below for more detailed examples.

  194. 

  195. Basic example:

  196. Search

  197. 

  198. Basic example with caption:

  199. Search

  200. 

  201. Grouped example:

  202. Search

  203. Search published content

  204. 

  205. Controlling modal property example:

  206. Search

  207. 

  208. Controlling modal property when grouped example:

  209. Search

  210. Search published content

  211. Search unpublished content

  212. 

  213. 

  214. 

  215. Turning the Image Caption into a Link

  216. =====================================

  217. If you wish to turn the caption into a link, format your caption in the

  218. following way:

  219. 

  220. image #1

  221. 

  222. Note, the < and > characters have been changed to their HTML entities, and the "

  223. have been escaped.

  224. 

  225. 

  226. KEYBOARD SHORTCUTS

  227. ------------------

  228. Not all of the default keyboard shortcuts work in the Opera browser, for example

  229. 'z' for toggling the zoom and 'spacebar' for toggling play / pause in

  230. slideshows.  This can be overcome by updating your shortcut settings in the

  231. Opera preferences editor.

  232. 

  233. The default keyboard shortcuts are listed below.  You can override these on

  234. admin/settings/lightbox2.

  235. 

  236. Close : x, o, c, ESC

  237. Previous Image : p, Left Arrow

  238. Next Image : n, Right Arrow

  239. Toggle Zoom : z (not available in slideshow)

  240. Toggle Play / Pause : Spacebar (slideshow only)

  241. 

  242. 

  243. TRANSLATION OF CONFIGURED STRINGS

  244. ----------------------------------

  245. In order to translate the lightbox2 configuration strings, such as the text for

  246. the "View Image Details" link and the image count, please install the i18n:

  247. internationalization module and follow the instructions at 

  248. http://drupal.org/node/134002.

  249. 

  250. 

  251. KNOWN ISSUES

  252. ------------

  253. 

  254. Keyboard Shortcuts in Opera

  255. ---------------------------

  256. Not all of the default keyboard shortcuts work in the Opera browser, for example

  257. 'z' for toggling the zoom and 'spacebar' for toggling play / pause in

  258. slideshows.  This can be overcome by updating your shortcut settings in the

  259. Opera preferences editor.