You are here

Home » API reference » Shadowbox 6

INSTALL.txt in Shadowbox 6

Same filename and directory in other branches
  1. 8 INSTALL.txt
  2. 5.2 INSTALL.txt
  3. 5 INSTALL.txt
  4. 6.4 INSTALL.txt
  5. 6.2 INSTALL.txt
  6. 6.3 INSTALL.txt
  7. 7.4 INSTALL.txt
  8. 7.3 INSTALL.txt
INSTALLATION
------------

1. Place the shadowbox directory in your modules directory

2. Download the 'full' Shadowbox distribution:
   http://mjijackson.com/shadowbox/download.php?full

3. Extract the download, rename the shadowbox-1.x 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
-----

Currently, to activate Shadowbox for a link, you must manually inject the
required 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. Try out the example and see how the site still functions as
normal on top of the originating page.

  <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

File

INSTALL.txt
View source 
  1. 

  2. INSTALLATION

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

  4. 

  5. 1. Place the shadowbox directory in your modules directory

  6. 

  7. 2. Download the 'full' Shadowbox distribution:

  8.    http://mjijackson.com/shadowbox/download.php?full

  9. 

  10. 3. Extract the download, rename the shadowbox-1.x directory to just 'shadowbox'

  11.    and place it in the shadowbox module directory

  12. 

  13. 4. Enable the Shadowbox module

  14. 

  15. 5. Visit the Shadowbox configuration page to review the settings

  16.    (admin/settings/shadowbox)

  17. 

  18. USAGE

  19. -----

  20. 

  21. Currently, to activate Shadowbox for a link, you must manually inject the

  22. required attribute. To open any link in shadowbox you need to add a rel

  23. attribute with a value of shadowbox (for compatibility with Lightbox you can

  24. also use a value of lightbox). Depending on your specific needs you may need to

  25. inject the required attribute in the theme layer.

  26. 

  27. Single image

  28. ------------

  29. 

  30. The important thing to note here is the rel attribute. This tells Shadowbox you

  31. wish to activate it for this link. The title attribute is optional and can be

  32. used to give a caption to the instance.

  33. 

  34.   Click me

  35. 

  36. Multiple instances (gallery mode)

  37. ---------------------------------

  38. 

  39. Media can be grouped into a gallery using shadowbox[name] where name is any name

  40. you wish to apply. The value of [name] is only used internally by Shadowbox and

  41. won't be shown to the user.

  42. 

  43.   Image

  44.   Image

  45.   Image

  46. 

  47. External URL

  48. ------------

  49. 

  50. A powerful feature of Shadowbox is the ability to open web pages directly on top

  51. of the current page. Try out the example and see how the site still functions as

  52. normal on top of the originating page.

  53. 

  54.   Google

  55. 

  56. Advanced usage

  57. --------------

  58. 

  59. Shadowbox allows you to specify options on a per-instance basis by using a

  60. JSON-formatted parameter. More information on this feature can be found on the

  61. Shadowbox usage page: http://mjijackson.com/shadowbox/doc/usage.html#markup