=== Lightbox Plus ===
Contributors: dzappone
Donate link: http://www.23systems.net/donate/
Tags: lightbox, images, photo, image, ajax, picture, gallery, automatic, colorbox, overlay
Requires at least: 2.5
Tested up to: 2.8
Stable tag: 1.5.2
Lightbox Plus permits users to view larger versions of images from the current page and display simple slide shows, all in an overlay.
== Description ==
Lightbox Plus implements ColorBox as a lightbox image overlay tool for WordPress. ColorBox was created by Jack Moore of Color Powered and is licensed under the MIT License. Lightbox Plus permits users to view larger versions of images without having to leave the current page, and is also able to display simple slide shows. The use of the dark or light background, which dims the page over which the image has been overlaid, also serves to highlight the image being viewed. Lightbox Plus captures the image title for display in the overlay.
Lightbox Plus uses WordPress's built in jQuery library.
Read the FAQ first if you are having problems.
Lightbox Plus DOES NOT work with WordPress' built in gallery feature.
= IMPORTANT 1.5 UPGRADE INFORMATION =
See the change log for information regarding this upgrading to version 1.5 of Lightbox Plus. There are significant differences from previous versions.
= Usage =
Note that getting the caption to appear in the overlay image by using the caption options built into WordPress Lightbox Plus uses the image title which is generated by "Edit Image Title" field and not the "Edit Caption Field." You can also manually add lightbox tags to your images using the following instructions.
1. Add a rel="lightbox[uniqueID|filename]" attribute to any link tag to activate the lightbox, include a name between square brackets in the rel attibute. For example:
image #1
Optional: Use the title attribute if you want to show a caption.
2. 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:
image #1
image #2
image #3
== Installation ==
1. Extract lightbox-plus.zip to your `wp-content/plugins` directory.
2. In the admin panel under plugins activate Lightbox Plus.
3. In the admin panel under Design/Appearance click on Lightbox Plus to configure to your taste.
4. It should now be completely set up and functional
= Upgrade Issues =
* 1.5.X upgrades are not always properly removing old styles, JavaScript and image files
* Issue Fixed: Well, mostly, as of version 1.5.2 the reset button will remove the old files assuming the permissions are set correctly.
* 1.5.X upgrades are sometimes failing
* Workaround:Remove the plugin and install a new copy. Use the reset button afterwards to remove old setting and instantiate new ones.
= Caveats =
Flash (i.e. YouTube videos, etc.) will sit atop the Lightbox Plus display not matter what the z-index is. This is an issue with Flash.
See Flash content displays on top of all DHTML layers at Adobe for details.
To work around this issue you will need to add something like the following to your <param /> and <embed></embed> tags:
<object><param name="wmode" value="opaque" /><embed wmode="opaque" [all other embed settings, file src etc.]></embed></object>
== Frequently Asked Questions ==
= I can't get Lightbox Plus to work, why not? =
The problem may be with your Wordpress theme, mangling image display properties. Try using another theme, that doesn't interfere with posted images. You may be lacking wp_head() function in your header.php of your Wordpress theme. Look at the default theme to see how it is implemented.
Alternately you may have other plugins that conflict with Lightbox Plus. Try disabling your other plugins and see if that helps. If it does, re-enable each plugin, one at a time to see which one is causing the conflict. Please let me know which plugin is causing the problem.
Finally, it seems that recent version of WordPress (or perhaps the plugin is causing this in some way I am not aware of) do not automatically add the link to the full size image. You must also make sure that when you are adding an image from the WordPress media dialog control you must make sure there is a link to the image in the Link URL field. The easiest way to get the correct link is to click on the link to image button beneath the field. Visual depiction of what is required when adding images in order for lightbox to function correctly.
= Lightbox Plus doesn't work properly in browser X, Y, or Z (Chrome, Safari, Firefox, Opera, Explorer 6, 7, etc)? =
Yes it does, the problems are the same as above. It has been tested in Firefox 2, 3, Safari 3, 4, Opera 9, 10, Chrome 1, 2, Internet Explorer 6, 7, 8 on Windows and Firefox 2, 3, Safari 3, 4 and Opera 9 on OS X and Firefox 2, 3, Opera 9, and Konqueror on Linux.
= Can I use this plugin and Lightview Plus, Lightbox 2 (either one), WP lightbox JS Plugin at the same time? =
No other lightbox plugins can be used, they will most likely interfere with each other as they all modify the image URLs. Other image overlay plugins may possibly be compatible.
= Can I add my own styles and images for the overlay? =
Yes, you can easily create additional styles by adding a new folder to the CSS directory under wp-content/plugins/lightbox-plus/css/ by duplicating and modifying any of the existing theme folders or using them as examples to create your own.
= How does Lightbox Plus differ from other Lightbox plugins for WordPress? =
Performance wise the ColorBox jQuery plugin is smaller and generally faster and has more options than most lightbox JavaScript plugins. The regular expressions that handle the text are more robust handling a wider variety of characters and in addition it will also grab the image title from the image to use for the overlay image caption.
= Lightbox Plus does not work correctly with WordPress' built-in gallery features, how do I make it work =
At present it does not. WordPress' built in gallery has its own method for dispaying image within WordPress' base framework. I am still working on an option that will allow Lightbox Plus to override this. In the meantime of you would like to use Lightbox Plus with a gallery I suggest you try one of the many gallery plugins that support lightbox, NextGEN Gallery, Lazyest Gallery, or Inline Gallery for example.
= When resetting/re-initializing LBP the setting do not appear correctly when the page reloads, what gives? =
This problem is only apparent in Chrome and Opera. It seems to works fine in Internet Explorer, Firefox and Safari. There may be browser related issues and I am investigating the problem at this time. For Chrome the settings are being saved but not displayed immediately, click on the Lightbox Plus link under appearance and you will see the current settings. Opera for whatever reason is completely failing to save re-initialization settings, you must manually set and save them or use another browser. And, no, it doesn't make sense since it's server side activity.
= Other Problems =
If you have read and tried the above and you are still having problems, then, please post your issues, in detail (links, error messages) to my site.
http://www.23systems.net/plugins/lightbox-plus/
== Screenshots ==
1. Lightbox Plus
== Change Log ==
= 1.5.2 =
* Reset/re-initialize button on the plugin page will now remove the old files that were not removed during upgrade to 1.5.x from pre 1.5 versions.
* Fixed the slideshow timing to display and save correctly - any amountof time over 5000 milliseconds was displaying as 13000 milliseconds.
* Miscellaneous cosmetic fixes and text adjustments
= 1.5.1 =
* Fixed the need to have class="imagebox" added to image links
= 1.5 =
* Rebuilt Lightbox Plus to utilize ColorBox for its image overlay functions
* Supports photos, photo groups, slideshow, ajax, inline, and iframed content.
* Appearance is completely controlled through CSS so users can restyle the box.
* Written in jQuery plugin format and can be chained with other jQuery commands.
* Generates W3C valid XHTML and CSS, adds no JS global variables & passes JSLint.
* README! - If you are upgrading from a previous version you will need to reset your Lightbox Plus settings as they have all changed and the old values are no longer useful.
* README! - There is a reset button that will remove your old options and replace them with the new options, Lightbox Plus will act funny until you either reset it or update the settings.
* README! - If you have custom styles back them up before proceeding. You will need to convert them to the new directory and ColorBox format to use them again.
* README! - Only the black and white existing styles have been ported to the new format, it is very easy to convert any of the other color styles to the new format.
* Added reset button to allow for resetting to default settings.
* Tested In: Firefox 2, 3, Safari 3, 4, Opera 9, 10, Chrome 1, 2, Internet Explorer 6, 7, 8.
= 1.4 =
* There is no version 1.4
= 1.3.4 =
* Updated to work with WordPress 2.8
= 1.3.3 =
* Fixed another problem with JavaScript error causing script not to work correctly.
= 1.3.2 =
* Fixed problem with JavaScript error on IE7.
* Added some additional color styles.
= 1.3.1 =
* Updated lightbox.js to allow better control from the admin panel - lightbox was failing sometimes due to duplicate JavaScript.
= 1.3.0 =
* Added ability to configure Lightbox options from the admin panel
* Initializes base options on load
* Modified and rewrote code for better readability and functionality
= 1.1.1 =
* Moved admin panel under Design/Appearance
* Minor code formatting for better readability
= 1.1.0 =
* Fixed absolute pathing - should now work in blog residing in subdirectories
* Rolled code into class structure
= 1.0.1 =
* Modifications to regular expression usage for image linking
= 1.0 =
* Initial release
== Road Map ==
1. Attempt to add enhanced features for use with and WordPress' built in gallery.
2. Class based option - can be set to work with all images or just selected images.
3. Add languages for which I have completed translations.
4. Solicit and implement additional language translations.
== Special Thanks ==
Dirk Schmitz (for pointing out an obvious bug that I kept overlooking), Ken Williams (for testing version 1.5), Melanie Sallis for needing a lightbox for her site which prompted me to create this plugin, Jack Moore for creating the awesome jQuery plugin, ColorBox, and everyone who has contributed to the support in developing this plugin.