====== colorbox Plugin ======

---- plugin ----
description: Integrates Colorbox (a jQuery lightbox)
author     : tom_c 
email      : tcafferty@glocalfocal.com 
type       : syntax, action
lastupdate : 2012-12-23
compatible : Angua, Binky
depends    : 
conflicts  : 
similar    : lightbox,lightboxv2
tags       : lightbox

downloadurl: https://github.com/TomCafferty/plugin-colorbox/zipball/master
bugtracker : https://github.com/TomCafferty/plugin-colorbox/issues
sourcerepo : https://github.com/TomCafferty/plugin-colorbox
donationurl: 
----

The colorbox plugin uses [[http://www.jacklmoore.com/colorbox|ColorBox]] to provide a jQuery lightbox. ColorBox supports photos, grouping, slideshow, ajax, inline, and iframed content.

===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[http://www.jacklmoore.com/colorbox|ColorBox]] - from the download you need only the following two files
     - jquery.colorbox-min from the main download file
     - colorbox.css from any one of the example folders

  - Install ColorBox. The action plugin looks for the following ColorBox files
    * lib/scripts/colorbox/colorbox.css
    * lib/scripts/colorbox/jquery.colorbox-min.js
  - Install the colorbox plugin using the Plugin Manager and the download URL above. If you install this plugin manually, make sure it is installed in lib/plugins/colorbox/
  - Put the downloaded Colorbox files in the plugins/colorbox folder 

Notes: 
  * The colorbox files can be placed anywhere with appropriate changes to the colorbox action plugin. 
  * Only the colorbox files listed above are necessary and not all that are provided in the ColorBox download.

===== Examples/Usage =====

A colorbox to open the Colorbox site:

<code>
<colorbox>&class=iframe&link=http://www.jacklmoore.com/colorbox&name=ColorBox&</colorbox>
</code>

The file linkColorbox.js is a specific example implementation of Colorbox using an iframe content. Look at the downloaded ColorBox examples for various implementations.

The example can be seen at [[http://clean.glocalfocal.com/doku.php?id=start|Plugin Examples Site]] FIXME

===== Syntax =====

Basic syntax:
<code><colorbox>&class=type&link=href&name=title&</colorbox></code>

The colorbox parameters are
  * class - the content type. Supported types include iframe, inline, ajax, html and photo. See the ColorBox documentation for possible uses.
  * link - the link to the displayed content
  * name - the displayed link name

===== Configuration and Settings =====
 The default colorbox.css has the backgound set to white.Ichanged the following in the colorbox.css to get a black background
  #cboxOverlay{background:#000;}

===== Development =====


=== Change Log ===

{{rss>https://github.com/TomCafferty/plugin-colorbox/commits/master.atom date}}

=== Known Bugs and Issues ===


=== ToDo/Wish List ===
  - The command line should allow specification of the specific implementation that is now done in linkColorBox.js.This would eliminate the need for a linkColorBox.js file.


===== FAQ =====

I can't use the <colorbox></colorbox>. Everytime i try to use it it put's the text between the two colorboxed on that position. how can i make it work? do i have to add a script to the linkColorbox.js first? Or is it restricted to specific browsers?
===== Discussion =====


===== BUG! Broken upgrade =====

If i click on "upgrade" button in plugin manager, this will get reinstalled, but stays listed as "upgradeable". Dokuwiki still thinks that there is upgrade available even when it's the same old version.