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 |
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) |
format | html format of an image (default: <a href="$origurl"><img src="$imageurl" title="$comment" width="$width" height="$height"/></a>) |
titles | toggles image and thumnail titles on and off (default: on) |
title | html format of an image title; "off" will hide the image's title (default: $comment ($imgnr/$nrimgs) $reddot) |
thumbtitle | html format of a thumbnail title; "off" will hide the thumbnail's title (default: $comment $reddot) |
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) |
topic
is meaningful to %NRIMAGES%.
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 |
$reddot | render a red-dot anchor to access the attachment |
$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 |
igpAlert | span surrounding error messages |
igpNavigation | table cell of the navigation bar |
igpPicture | table cell of the display image |
igpPictureTable | table of the display image and the navigation bar |
igpPictureTitle | division of the title of the display image |
igpRedDot | span surrounding the red dot |
igpThumbNail | table cell of one thumbnail image |
igpThumbNails | division of all thumbnails |
igpThumbNailsTable | table of thumbnail images |
igpThumbNailTitle | table cell of the thumbnail title |
<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.
File: | Description: |
---|---|
data/TWiki/ImageGalleryPlugin.txt | |
lib/TWiki/Plugins/ImageGalleryPlugin/Core.pm | |
lib/TWiki/Plugins/ImageGalleryPlugin.pm | |
pub/TWiki/ImageGalleryPlugin/style.css |
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
Plugin Author: | TWiki:Main.MichaelDaum, TWiki:Main.WillNorris |
Copyright: | © 2002-2003, Will Norris; © 2005-2008, Michael Daum http://michaeldaumconsulting.com; © 2008-2011 TWiki:TWiki.TWikiContributor |
License: | GPL (GNU General Public License) |
Plugin Version: | 2011-07-21 - v3.74 |
Change History: | |
2011-07-21 | TWikibug:Item6772: No images found error if image name has dots in name -- TWiki:Main.JoshuaTharp; change global package variables from "use vars" to "our" -- TWiki:Main.PeterThoeny |
2010-04-26 | TWikibug:Item6433: Doc improvements -- TWiki:Main.PeterThoeny |
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 Aurélio 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 TWiki-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 TWiki:Main/MartinCleaver; 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 TWiki:Main/MarcelTrap; added support for multiple topics (proposed by TWiki:Main/MartinCleaver; 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 posted to TWiki.org |
15 Mar 2002 | Initial (internal) version |
CPAN Dependencies: | CPAN:Image::Magick or CPAN:Graphics::Magick |
Other Dependencies: | none |
Perl Version: | 5.8 |
Plugin Home: | TWiki:Plugins/ImageGalleryPlugin |
Feedback: | TWiki:Plugins/ImageGalleryPluginDev |
Appraisal: | TWiki:Plugins/ImageGalleryPluginAppraisal |