Argument | Description |
---|---|
topic | comma separated list of topics whose attachments should be displayed (default: the current topic) |
limit | maximum number of images to display (default: 0, meaning no limit). |
include | regular expression an image must match to be part of the gallery |
exclude | regular expression an image must not match to be part of the gallery |
frontend | select gallery interface, possible values are default , slimbox , prettyphoto , photoswipe and html ; NOTE, specifying a frontend disables the format parameter (see below for an explanation) |
field | specify which property of the image has to match using include or exclude ; possible values: name, comment (default: name) |
size | the thumbnail size, the actual geometries of a size can be configured below; possible values: tiny, small, medium, large, huge (default: medium) |
columns | number of thumbnails to be displayed in one row of the gallery (default: 4) |
docrels | flag to disable/enable document relations between images; possible values are on, off, 0, 1 (default: on) |
maxwidth | maximal display width of an image; images are scaled not to exceed this limit while preserving aspect ratio (default: 640) |
maxheight | maximal display height of an image (default: 480) |
minwidth | minimal display width of an image; images are scaled not to fall below this limit while preserving aspect ratio (default: 0) |
minheight | minimal display height of an image (default: 0) |
header | header part of the gallery; only used if there is a format |
format | html format of an image (default: <a href="$origurl"><img src="$imageurl" title="$comment" width="$width" height="$height"/></a>) |
footer | footer part of the gallery; only used if there is a format |
titles | toggles image and thumnail titles on and off (default: off) |
title | html format of an image title; "off" will hide the image's title (default: $comment ($imgnr/$nrimgs)) |
thumbtitle | html format of a thumbnail title; "off" will hide the thumbnail's title (default: $comment) |
sort | set the initial order of the images, can be name, date, size or comment (default:date) |
reverse | invert the initial order of the images, can be on or off (default:off) |
class | add an additional css class attribute to the image gallery wrapper; might be used to add additional features such as in %IMAGEGALLERY{class="jqPhotoSwipe jqMasonry"}% |
topic
is meaningful to %NRIMAGES%.
frontend
parameter specifies which user interface to use to display the lightbox in the browser:
default
: use the best user interface given other extensions installed; it checks for photoswipe, prettyphoto, and slimbox in the given order and uses the first available on the system
photoswipe
: you need to install JQPhotoSwipeContrib to use this interface
prettyphoto
: you need to install JQPrettyPhotoContrib to use this interface
slimbox
: this is a default lightbox interface shipped with Foswiki
html
: use an html interface to render the gallery without using any javascript frontend; NOTE: this works best with AngularSkin/AngularPlugin to still render the gallery as a single-page application
frontend
or format
parameter specified will the system use the best interface available.
Variable | Description |
---|---|
$web | the web the image is located |
$topic | the topic the image is located |
$nrimages | the total number of images in the gallery |
$n | a linefeed |
$width | the display width of the image |
$height | the display height of the image |
$thumbwidth | the thumbnail width of the image |
$thumbheight | the thumbnail height of the image |
$origwidth | the original width of the image |
$origheight | the original height of the image |
$size | the size of the image |
$sizeK | the size of the image in kilobytes |
$comment | the comment of the image (with its sequence number stripped off) |
$imgnr | the sequence number of the image |
$date | the date when the image has been uploaded |
$version | the version of the image attachment |
$name | the filename of the image |
$wikiusername | the wikiusername who uploaded the image |
$username | the username who uploaded the image |
$imageurl | the url path of the display image |
$thumburl | the url path of the thumbnail image |
$origurl | the url path pointing to the original image attachment |
Class | Description |
---|---|
igp | division for the complete output of the image gallery |
igpThumbNails | division of all thumbnails |
igpThumbNailsTable | table of thumbnail images |
igpThumbNail | table cell of one thumbnail image |
igpThumbNailTitle | table cell of the thumbnail title |
igpPictureTable | table of the display image and the navigation bar |
igpPicture | table cell of the display image |
igpPictureTitle | division of the title of the display image |
igpNavigation | table cell of the navigation bar |
igpRedDot | span surrounding the red dot |
igpAlert | span surrounding error messages |
<nr>
if its attachment comment has the format
<nr><space>-<space><comment>Note, that the $comment variable will only display
<comment>
, that is with
<nr><space>-<space>
stripped off.
configure
, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.
Name | Version | Description |
---|---|---|
Image::Magick | >=6.2.4.5 | Required. |
Graphics::Magick | >=1.1.11 | Optional. |
Foswiki::Plugins::JQueryPlugin | >=3.74 | Optional |
05 Dec 2016 | added option {DefaultSize} |
27 May 2016 | added support for Foswiki:Extensions/JQPhotoSwipeContrib and Foswiki:Extensions/AngularSkin; improved support for Foswiki:Extensions/LazyLoadPlugin; fixed frontend parameter; added class parameter |
31 Aug 2015 | fixing deprecated unescaped left brace in regexes |
16 Dec 2014 | add support for svg, tiff, xcf and psd |
28 Aug 2014 | only render the first frame of a gif animation generating thumbnails; fix orientation of thumbnail as specified in the EXIF metadata |
29 Nov 2012 | removed useless call to expandCommonVariables ; removed non-functional UserListByPhotograph |
06 Jun 2011 | added support for Foswiki:Extensions/LazyLoadPlugin and Foswiki:Extensions/JQPrettyPhotoContrib; deferring expansion of IMAGEGALLERY until other plugins have updated the page |
12 Feb 2010 | new frontend parameter defaulting to "lightbox" when Foswiki:Extensions/JQueryPlugin is installed |
03 Jul 2009 | shipping minified and compressed css files now |
24 Apr 2009 | converted to foswiki plugin |
12 Feb 2009 | interface improvements; creating more accurate thumbnails |
31 Jan 2009 | added VarIMAGEGALLERY and VarNRIMAGES documentation topics |
29 Dec 2008 | temporary fix to work under Foswiki |
14 Nov 2008 | made format string for galleries more flexible |
16 Jul 2008 | don't crash on images that start with a digits pattern |
07 Jul 2008 | fixing use of string as hash |
03 Jul 2008 | applying patch by Aurelio A. Heckert (see Bugs:Item5753); using Resize instead of Scale for higher quality thumbnails; hiding reddot when the user has no edit access to the target topic |
03 Mar 2008 | make implementation of image mage configurable, defaulting to Graphics::Magick as Image::Magick has got issues using perl accellerators like mod_perl, speedy-cgi |
17 Jan 2008 | default to sorting by name instead of by date |
13 Nov 2007 | replaced plugin topic settings with configure settings |
19 Sep 2007 | store auto-computed images in an images subdir of its own |
19 Feb 2007 | make proper use T*-4 API; don't use inline css, put them into the html header instead |
24 Jul 2006 | working around Image::Magick crashes reading svg image files |
20 Mar 2006 | added sort and reverse arguments; fixed updating thumbnails when a new image version is created |
20 Feb 2006 | added include , exclude and field arguments |
16 Feb 2006 | renamed thumbnail so that it does not interfer with auto-attachment |
14 Sep 2005 | don't strictly depend on normalizeFilename() |
15 June 2005 | new release |
10 May 2005 | fixed igp id clash error found by Martin Cleaver; capture ImageMagick error messages; don't trust attachment info, check for attachment existence as well; added refresh query parameter to recompute images |
09 May 2005 | fixed errors reported by Marcel Trap; added support for multiple topics (proposed by Martin Cleaver; added %NRIMAGES% tag |
fix error when called from within rename view | |
03 May 2005 | fixed thumbnail resizing; reintroduced titles parameter; support for multiple galleries per topic |
27 Apr 2005 | complete rewrite |
01 Aug 2003 | Updates from feedback from a Windows installation |
25 Jul 2003 | Initial version |
15 Mar 2002 | Initial (internal) version |
Author | Michael Daum, Will Norris |
Version | 7.20 |
Release | 05 Dec 2015 |
Description | Displays image gallery with auto-generated thumbnails from attachments |
Repository | https://github.com/foswiki/ImageGalleryPlugin |
Copyright | 2002-2009, Will Norris; 2005-2016, Michael Daum http://michaeldaumconsulting.com |
License | GPL (GNU General Public License) |
Home | Foswiki:Extensions/ImageGalleryPlugin |
Support | Foswiki:Support/ImageGalleryPlugin |