It's better when it's simple

User Tools

Site Tools


colorbox Plugin

Compatible with DokuWiki

Angua, Binky

plugin Integrates Colorbox (a jQuery lightbox)

Last updated on
Syntax, Action

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to lightbox, lightboxv2

Tagged with lightbox

The colorbox plugin uses ColorBox to provide a jQuery lightbox. ColorBox supports photos, grouping, slideshow, ajax, inline, and iframed content.


:!: External requirements: This plugin requires the following additional components that must be installed separately:

  • ColorBox - from the download you need only the following two files
    1. jquery.colorbox-min from the main download file
    2. colorbox.css from any one of the example folders
  1. Install ColorBox. The action plugin looks for the following ColorBox files
    • lib/scripts/colorbox/colorbox.css
    • lib/scripts/colorbox/jquery.colorbox-min.js
  2. 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/
  3. Put the downloaded Colorbox files in the plugins/colorbox folder


  • 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.


A colorbox to open the Colorbox site:


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 Plugin Examples Site FIXME


Basic syntax:


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



Change Log

Known Bugs and Issues

ToDo/Wish List

  1. 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.


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?


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.

plugin/colorbox.txt · Last modified: 2019-01-28 08:35 by harvie

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki