| 1 |
$Id: INSTALL.txt,v 1.4 2008/05/12 22:39:42 psynaptic Exp $
|
| 2 |
|
| 3 |
REQUIREMENTS
|
| 4 |
------------
|
| 5 |
|
| 6 |
This module requires Drupal 6.x
|
| 7 |
|
| 8 |
Why no 5.x version?
|
| 9 |
|
| 10 |
A Drupal 5.x version is unlikely due to the old version of jQuery that ships
|
| 11 |
with core. jquery_update does not update to the required version for Shadowbox
|
| 12 |
to function correctly. There seems to be a conflict between older versions of
|
| 13 |
jQuery and the 'animate' setting within Shadowbox that stops it from working
|
| 14 |
properly. I may consider releasing a version that doesn't use the animate
|
| 15 |
feature.
|
| 16 |
|
| 17 |
INSTALLATION
|
| 18 |
------------
|
| 19 |
|
| 20 |
1. Place the shadowbox directory in your modules directory
|
| 21 |
|
| 22 |
2. Download the 'full' Shadowbox distribution:
|
| 23 |
http://mjijackson.com/shadowbox/download.php?full
|
| 24 |
|
| 25 |
3. Extract the download, rename the shadowbox-1.x directory to just 'shadowbox'
|
| 26 |
and place it in the shadowbox module directory
|
| 27 |
|
| 28 |
4. Enable the Shadowbox module
|
| 29 |
|
| 30 |
5. Visit the Shadowbox configuration page to review the settings
|
| 31 |
(admin/settings/shadowbox)
|
| 32 |
|
| 33 |
USAGE
|
| 34 |
-----
|
| 35 |
|
| 36 |
Currently, to activate Shadowbox for a link, you must manually inject the
|
| 37 |
required attribute. To open any link in shadowbox you need to add a rel
|
| 38 |
attribute with a value of shadowbox (for compatibility with Lightbox you can
|
| 39 |
also use a value of lightbox). Depending on your specific needs you may need to
|
| 40 |
inject the required attribute in the theme layer.
|
| 41 |
|
| 42 |
Single image
|
| 43 |
------------
|
| 44 |
|
| 45 |
The important thing to note here is the rel attribute. This tells Shadowbox you
|
| 46 |
wish to activate it for this link. The title attribute is optional and can be
|
| 47 |
used to give a caption to the instance.
|
| 48 |
|
| 49 |
<a href="/files/image.jpg" title="Caption" rel="shadowbox">Click me</a>
|
| 50 |
|
| 51 |
Multiple instances (gallery mode)
|
| 52 |
---------------------------------
|
| 53 |
|
| 54 |
Media can be grouped into a gallery using shadowbox[name] where name is any name
|
| 55 |
you wish to apply. The value of [name] is only used internally by Shadowbox and
|
| 56 |
won't be shown to the user.
|
| 57 |
|
| 58 |
<a href="/files/image1.jpg" title="Caption 1" rel="shadowbox[gallery]">Image</a>
|
| 59 |
<a href="/files/image2.jpg" title="Caption 2" rel="shadowbox[gallery]">Image</a>
|
| 60 |
<a href="/files/image3.jpg" title="Caption 3" rel="shadowbox[gallery]">Image</a>
|
| 61 |
|
| 62 |
External URL
|
| 63 |
------------
|
| 64 |
|
| 65 |
A powerful feature of Shadowbox is the ability to open web pages directly on top
|
| 66 |
of the current page. Try out the example and see how the site still functions as
|
| 67 |
normal on top of the originating page.
|
| 68 |
|
| 69 |
<a href="http://google.com" title="Google" rel="shadowbox">Google</a>
|
| 70 |
|
| 71 |
Advanced usage
|
| 72 |
--------------
|
| 73 |
|
| 74 |
Shadowbox allows you to specify options on a per-instance basis by using a
|
| 75 |
JSON-formatted parameter. More information on this feature can be found on the
|
| 76 |
Shadowbox usage page: http://mjijackson.com/shadowbox/doc/usage.html#markup
|
Parent Directory
| 
Revision Log
| 
Revision Graph