You are here

INSTALL.txt in Shadowbox 5

REQUIREMENTS
------------

This module depends on jquery_update 5.x-2.x-dev.

INSTALLATION
------------

1. Place the shadowbox directory in your modules directory

2. Download the 'full' Shadowbox distribution:
   http://freestylesystems.co.uk/files/shadowbox-1.0.tgz

3. Extract the download, rename the shadowbox-1.0 directory to just 'shadowbox'
   and place it in the shadowbox module directory

4. Enable the Shadowbox module

5. Visit the Shadowbox configuration page to review the settings
   (admin/settings/shadowbox)

USAGE
-----

The Drupal 5.x version of this module has integration with imagefield and 
imagecache.

To manually activate Shadowbox for a link, you must inject the required rel
attribute. To open any link in shadowbox you need to add a rel attribute with a
value of shadowbox (for compatibility with Lightbox you can also use a value of
lightbox). Depending on your specific needs you may need to inject the required
attribute in the theme layer.

Single image
------------

The important thing to note here is the rel attribute. This tells Shadowbox you
wish to activate it for this link. The title attribute is optional and can be
used to give a caption to the instance.

  <a href="/files/image.jpg" title="Caption" rel="shadowbox">Click me</a>

Multiple instances (gallery mode)
---------------------------------

Media can be grouped into a gallery using shadowbox[name] where name is any name
you wish to apply. The value of [name] is only used internally by Shadowbox and
won't be shown to the user.

  <a href="/files/image1.jpg" title="Caption 1" rel="shadowbox[gallery]">Image</a>
  <a href="/files/image2.jpg" title="Caption 2" rel="shadowbox[gallery]">Image</a>
  <a href="/files/image3.jpg" title="Caption 3" rel="shadowbox[gallery]">Image</a>

External URL
------------

A powerful feature of Shadowbox is the ability to open web pages directly on top
of the current page (in an iframe).

  <a href="http://google.com" title="Google" rel="shadowbox">Google</a>

Advanced usage
--------------

Shadowbox allows you to specify options on a per-instance basis by using a
JSON-formatted parameter. More information on this feature can be found on the
Shadowbox usage page: http://mjijackson.com/shadowbox/doc/usage.html#markup

  <a href="http://google.com" rel="shadowbox;width=740;height=400;
    options={overlayColor:'#012',overlayOpacity:1,resizeDuration:0.2};">Google</a>
  

File

INSTALL.txt
View source
  1. REQUIREMENTS
  2. ------------
  3. This module depends on jquery_update 5.x-2.x-dev.
  4. INSTALLATION
  5. ------------
  6. 1. Place the shadowbox directory in your modules directory
  7. 2. Download the 'full' Shadowbox distribution:
  8. http://freestylesystems.co.uk/files/shadowbox-1.0.tgz
  9. 3. Extract the download, rename the shadowbox-1.0 directory to just 'shadowbox'
  10. and place it in the shadowbox module directory
  11. 4. Enable the Shadowbox module
  12. 5. Visit the Shadowbox configuration page to review the settings
  13. (admin/settings/shadowbox)
  14. USAGE
  15. -----
  16. The Drupal 5.x version of this module has integration with imagefield and
  17. imagecache.
  18. To manually activate Shadowbox for a link, you must inject the required rel
  19. attribute. To open any link in shadowbox you need to add a rel attribute with a
  20. value of shadowbox (for compatibility with Lightbox you can also use a value of
  21. lightbox). Depending on your specific needs you may need to inject the required
  22. attribute in the theme layer.
  23. Single image
  24. ------------
  25. The important thing to note here is the rel attribute. This tells Shadowbox you
  26. wish to activate it for this link. The title attribute is optional and can be
  27. used to give a caption to the instance.
  28. Click me
  29. Multiple instances (gallery mode)
  30. ---------------------------------
  31. Media can be grouped into a gallery using shadowbox[name] where name is any name
  32. you wish to apply. The value of [name] is only used internally by Shadowbox and
  33. won't be shown to the user.
  34. Image
  35. Image
  36. Image
  37. External URL
  38. ------------
  39. A powerful feature of Shadowbox is the ability to open web pages directly on top
  40. of the current page (in an iframe).
  41. Google
  42. Advanced usage
  43. --------------
  44. Shadowbox allows you to specify options on a per-instance basis by using a
  45. JSON-formatted parameter. More information on this feature can be found on the
  46. Shadowbox usage page: http://mjijackson.com/shadowbox/doc/usage.html#markup
  47. Google