=== Shadowbox JS === Contributors: sivel Donate Link: http://sivel.net/donate Tags: shadowbox-js, shadowbox, js, javascript, overlay, images, movies, audio, youtube, formatting, links, post, posts, lightbox, thickbox, lightview Requires at least: 2.7 Tested up to: 2.9 Stable tag: 3.0.0.3 Shadowbox is an online media vieiwing application similar to Lightbox and Thickbox but with more functionality. Supports all types of media. == Description == Shadowbox is an online media viewing application that supports all of the web's most popular media publishing formats. Shadowbox is written entirely in JavaScript and CSS and is highly customizable. Using Shadowbox, website authors can display a wide assortment of media in all major browsers without navigating users away from the linking page. This plugin uses [Shadowbox](http://www.shadowbox-js.com/) written by [Michael J. I. Jackson](http://mjijackson.com). Javascript libraries supported are: None, YUI, Prototype, jQuery, Ext, Dojo and MooTools. Ext is included with the plugin, Prototype and jQuery are used from the Javascript libraries included with Wordpress, YUI is loaded from Yahoo APIs, Dojo and Mootools are loaded from Google APIs. This plugin can also be used as a drop in lightbox replacement, without requiring you to edit posts already using lightbox. By default this plugin will use Shadowbox for all image links, movie links, audio links and YouTube/Google Video links including those generated by the [gallery] shortcode. Shadowbox is licensed under the terms of the [Shadowbox.js License](http://shadowbox-js.com/LICENSE). This license grants personal, non-commercial users the right to use Shadowbox without paying a fee. It also provides an option for users who wish to use Shadowbox for commercial purposes. You are encouraged to review the terms of the license before using Shadowbox. If you would like to use Shadowbox for commercial purposes, you can purchase a license from [http://www.shadowbox-js.com/](http://www.shadowbox-js.com/). This plugin also makes use of the [JW FLV Player](http://www.longtailvideo.com/players/jw-flv-player/). JW FLV Player is licensed under the terms of the [Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/). If you would like to use JW FLV Player for commercial purposes, you can purchase a license from [https://www.longtailvideo.com/players/order2](https://www.longtailvideo.com/players/order2). Please use the Shadowbox JS [support forum](http://wordpress.org/tags/shadowbox-js) for problems or questions with this plugin. Support questions will be ignored if left as comments on my site, through my contact form or by email. The only supported location for support questions is [http://wordpress.org/tags/shadowbox-js](http://wordpress.org/tags/shadowbox-js). = Translations: = * Dutch * Russian == Installation == 1. Upload the `shadowbox-js` folder to the `/wp-content/plugins/` directory or install directly through the plugin installer. 1. Activate the plugin through the 'Plugins' menu in WordPress or by using the link provided by the plugin installer 1. Optional: Visit the settings page in the Admin at `Settings -> Shadowbox JS` == Frequently Asked Questions == = What image file types will this plugin automatically add Shadowbox to? = bmp, gif, png, jpg, and jpeg = What movie file types will this plugin automatically add Shadowbox to? = swf, flv, f4v, dv, mov, moov, movie, mp4, asf, wm, wmv, avi, mpg and mpeg = What audio file types will this plugin automatically add Shadowbox to? = mp3 and aac = When I click on my YouTube links I see the full YouTube web site and not just my video. What is wrong? = You have probably used the wrong form of the YouTube URL. If you used something like `http://www.youtube.com/watch?v=3D3kFn_3xRY` that will disaply the YouTube website and not just the video. To just get the video use a link that looks like `http://www.youtube.com/v/3D3kFn_3xRY`. = How can I use a custom Shadowbox skin without having to worry about it being deleted during the upgrade process? = In version 3.0.0.0 there are now 2 parts to the skin, the markup file and the CSS. Place your custom skin in a location where it will not get removed. For example in your current themes directory. Below is an example: `wp-content/themes/yourthemename/shadowbox-custom-skin` Once you have placed the skin in this directory you will need to add a few lines to your themes functions.php file. Below is some sample code: ` function shadowbox_custom_markup($markup) { $markup = 'http://example.org/wp-content/themes/yourthemename/shadowbox-custom-skin/markup.js'; return $markup; } add_filter('shadowbox-markup', 'shadowbox_custom_markup'); function shadowbox_custom_css($css) { $css = 'http://example.org/wp-content/themes/yourthemename/shadowbox-custom-skin/shadowbox.css'; return $css; } add_filter('shadowbox-css', 'shadowbox_custom_css'); ` You do not necessarily have to do both. It is possible to only load a custom markup or only a custom css. = Can I selectively load Shadowbox on pages that need it? = Yes. However this functionality requires WordPress 2.8. If you are running WordPress 2.8 and you would like to enable this functionality visit `Settings -> Shadowbox JS` and set `Enable Smart Loading` to `true`. = Why isn't this plugin working? = Check to make sure that you have `` in your themes header.php and `` in your themes fotoer.php. See the default WordPress theme for examples. Also see the FAQ below. = This plugin has stopped working since I installed another plugin or another plugin has stopped working since I installed this plugin. What can I do? = Try changing the Javascript Library used by this plugin to something other than 'None' on the Shadowbox JS settings page in the WordPress admin. == Screenshots == 1. An Image 2. A Website 3. A YouTube Video == Upgrade == 1. Use the plugin updater in WordPress or... 1. Deactivate the Shadowbox JS plugin 1. Delete the previous `shadowbox-js` folder from the `/wp-content/plugins/` directory 1. Upload the new `shadowbox-js` folder to the `/wp-content/plugins/` directory 1. Activate the Shadowbox JS plugin 1. Optional: Visit the settings page in the WordPress admin at `Settings -> Shadowbox JS` == Usage == 1. By default this plugin will add the activator attribute to all image links, movie links, audio links and YouTube/Google Video links that do not already have the activator attribute. Meaning basically, by default all images in the posts on your site will automatically be displayed using Shadowbox. If you want more fine grain control over the links continue with the next steps. 1. Create a link in your post in the following format (This link can be to pretty much anything including websites, video files, YouTube, Google Video and inline content): `<a href="http://domain.tld/directory/to/image.jpg" rel="shadowbox[album]">Image</a>` 1. Be sure to include `rel="shadowbox"` as this activates the plugin. 1. If `rel="shadowbox[album]"` is included the portion listed here as `[album]` will group multiple pictures into an album called album. Do not use `[gallery]` to define an album as WordPress has a shortcode that will interfere. 1. If you are using this as a lightbox replacement you do not need to change `rel="lightbox"` to `rel="shadowbox"`. Shadowbox.js supports `rel="lightbox"` natively. 1. If you want to make a gallery/album and only want one link to display you can use `class="hidden"` to hide the additional links. 1. See [http://shadowbox-js.com/doc/usage.html#markup](http://shadowbox-js.com/doc/usage.html#markup) for detailed markup instructions. 1. If you are using using Shadowbox globally for all images but have an image you do not wish to use Shadowbox on use `rel="nobox"` in your image link. = NOTE: = Do not use the visual editor for doing the above. Use the code editor. When modifying this post in the future do not use the visual editor; please use the code editor always. To disable the visual editor for all users see the [Easy Disable Visual Editor](http://wordpress.org/extend/plugins/easy-disable-visual-editor/) plugin. == Changelog == = 3.0.0.3 (2009-11-07): = * Fix empty options on activation for new installs = 3.0.0.2 (2009-10-30): = * Update shadowbox.js build from upstream * Add option to disable sizzle.js * Enhance Upgrade Logic * Add Dutch translation * Update to not start anything until init at earliest * Split FLV from Auto Movies so that we can force certain file types to use the FLV player * Replace logic to use the video height and width for all videos by defualt, not just Youtube and Google Video = 3.0.0.1 (2009-06-30): = * Bring back PHP4 support * Increase speed by reducing the number of queries * Code cleanup * Add changelog output to upgrade notice in admin. Requires WordPress 2.8 * Do not display majority of the settings page form if the options have been removed from the database * Fix broken localization directory name in code and update localization template * Remove unused javascript files * Add Russian translation = 3.0.0.0 (2009-06-10): = * Updated Shadowbox to 3.0b1 * Code cleanup and optimization, will only load the code into memory that is needed * Removed IE8 hack since Shadowbox 3.0 now supports IE8 * Added options to the admin page for modifying the default size of YouTube videos * Full screen in YouTube videos is now supported * Added options to the admin page for modifying flashVars, flashParams and minimum flash version required * Added option to the admin page for disabling Shadowbox.setup so that Shadowbox.setup can be run from another script to allow image maps through area tags * Disabled the FLV player by default since it has a non-commercial license. Must enable FLV player after accepting licensing in the admin * Added capability for loading shadowbox only when needed. Requires WordPress 2.8. * Added capability for only loading the shadowbox players you want. = 2.0.4.1 (2009-03-24): = * Add IE8 support by way of the X-UA-Compatibile meta tag = 2.0.4.0 (2009-03-18): = * Use domready events for javascript libraries other than None for intialization of shadowbox so that shadowbox works before the page is completely loaded * Initial support for WordPress 2.8, more updates will finalized as WordPress 2.8 is finalized * Bulgarian translation for shadowbox.js added (Thanks [Method-X](http://method-x.net/) for the translation) * Code cleanup * Change default size for Youtube videos * Add automation to the_excerpt so links in custom excerpts can utilize shadowbox * Support for custom skins using a filter (see the FAQ) = 2.0.3.3 (2009-01-23): = * Fix issue where replacement was trying to be done when no replacements were necessary * Add feature to attempt to automatically set Shadowbox language based on defined WordPress language * Only load the required javascript in the admin when on the shadowbox-js settings page * Clean up code = 2.0.3.2 (2008-12-26): = * Fix animate and animateFade select options, were true/true, now true/false * Fix PHP warnings about non-existent $_POST array indexes = 2.0.3.1 (2008-12-23): = * Updated invalid php start tag = 2.0.3.0 (2008-12-23): = * Added options page to admin interface * Added support to automatically use Shadowbox for movie, audio and YouTube/Google Video links. = 2.0.2.1 (2008-09-22): = * Fixed typo in variable name containing the previous rel attribute of the link = 2.0.2 (2008-09-22): = * Added support to automatically use Shadowbox to display all images in your posts including those generated by the [gallery] shortcode. * Added deactivator rel attribute. Use rel="nobox" to not use Shadowbox to display an image when global activation is configured. = 2.0.1 (2008-08-25): = * updated code for readability * Added support for [gallery] shortcode = 2.0 (2008-08-11): = * Updated shadowbox.js to version 2.0 * Added various options and changes to support shadowbox.js version 2.0 * Updated javascript library locations to use Google APIs and Yahoo APIs where applicable. * Changed versioning of the plugin to match that of the shadowbox.js version = 0.4 (2008-04-10): = * Updated to use assetURL for location to shadowbox files * Cleaned up code and added extended comments * Added extras.css with support for hidden class * Added support to not include javascript libraries = 0.3 (2008-02-26): = * Updated Shadowbox.js to version 1.0 Final * Added support for Ext, Dojo and MooTools Javascript Libraries * Removed lightbox2shadowbox function/filter as Shadowbox.js now natively supports rel="lightbox" * Consolidated repetitive code * Removed images that were not in use * Selected MooTools as the default as it contains the smallest payload = 0.2 (2008-02-22): = * Initial Public Release