DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:colorbox

This is an old revision of the document!


colorbox Plugin

Compatible with DokuWiki

Angua

plugin Integrates Colorbox (a jQuery lightbox)

Last updated on
2012-12-23
Provides
Syntax, Action
Repository
Source
Requires
keywords

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.

Installation

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

  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. Move file linkColorbox.js from plugin installation to lib/scripts/colorbox/linkColorbox.js
  4. Install Keywords plugin if not already installed

Notes:

  • The /lib/scripts folder is expected to reside in your dokuwiki install 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.

Examples/Usage

A colorbox to map a run:

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

The keywords plugin is used to identify that this page contains the colorbox plugin. This allows the action plugin to only add the javascript for those pages.

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

Syntax

Basic syntax:

<colorbox>&class=type&link=href&name=title&</colorbox>

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

Development

Change Log

Known Bugs and Issues

ToDo/Wish List

  1. The example file linkColorBox.js should be moved back to the plugin folder that it is dowloaded in and the action.php file updated to point to that folder. This would be a cleaner installation keeping the ColorBox libraries separate from the system implementation.
  2. 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

Discussion

plugin/colorbox.1370659798.txt.gz · Last modified: 2013-06-08 04:49 by tom_c

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