aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/gallery.mdwn
blob: 72df13bd0b06a47d05a5b79834d85d9ac32e0a77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
[[!template id=plugin name=gallery author="[[arpitjain]]"]]

This plugin would create a nice looking gallery of the images. It has been build over the img plugin in Ikiwiki

GIT repo of the plugin is located at <http://github.com/joeyh/ikiwiki/tree/gallery>


USAGE : 
\[[!gallery imagedir="images" option="value"]]

Available options : <br>
    * imagedir(required) => Directory containing images. It will scan all the files with jpg|png|gif extension from the directory and will put it in the gallery.<br>
    * thumbnailsize(optional,Default=200x200) => Size of the thumbnail that you want to generate for the gallery.<br>
    * resize(optional, Default=>800x600) => Width and Height to resize image to. resize="0" for turning resizing off.<br>
    * alt(optional) => If image can not be displayed, it will display the text contained in alt argument.<br>
    * cols(optional,Default=3) => Number of columns of thumbnails that you want to generate.<br>
    * rows(optional, Default=>3) => Number of Rows on a gallery page.<br>
    * title(optional) => Title of the gallery.<br>
    * sort(optional) => "asc" or "desc" . You can sort in ascending or descending order of names of images. <br>
    * vcs(optional,Default=1) => This value decides whether to put the images out of IkiWiki's tree. If you set vcs=0, then you can specify a directory outside IkiWiki tree also to lookup. In that case you can also give absolute link of the image directory.<br>
    * exif(optional, Default=>0) => Specify whether to Display exif information or not.<br>

Additionaly, you can put Comment file filename.comm in image directory where filename is name of the image. Comments would then be displayed in the gallery.

Features of the Gallery Plugin:<br>
* You can go the next image by clicking on the right side of the image or by pressing 'n'.<br>
* Similary, you can go the previous image by clicking on the left side of the image or by pressing 'p'.<br>
* Press esc to close the gallery.<br>
* While on image, nearby images are preloaded in the background, so as to make the browsing fast.<br>

It uses templated named [Lightbox](http://www.hudddletogether.com).
For any feedback or query, feel free to mail me at arpitjain11 [AT] gmail.com 

Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikigallery.html).
> That link is broken. --[[JosephTurian]]

-- [[arpitjain]]

[[!tag plugins]] [[!tag patch]] [[!tag soc]] [[!tag wishlist]]