web commit by http://arpitjain11.myopenid.com/
[ikiwiki.git] / doc / plugins / contrib / gallery.mdwn
1 This plugin would create a nice looking gallery of the images. It has been build over the img plugin in Ikiwiki
2
3 SVN repository of plugin is located at <http://ned.snow-crash.org:8080/svn/ikiwiki-gallery>
4
5
6 USAGE : 
7 \[[gallery imagedir="images" option="value"]]
8
9 Available options : <br>
10     * 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>
11     * thumbnailsize(optional,Default=200x200) => Size of the thumbnail that you want to generate for the gallery.<br>
12     * resize(optional, Default=>800x600) => Width and Height to resize image to. resize="0" for turning resizing off.<br>
13     * alt(optional) => If image can not be displayed, it will display the text contained in alt argument.<br>
14     * cols(optional,Default=3) => Number of columns of thumbnails that you want to generate.<br>
15     * rows(optional, Default=>3) => Number of Rows on a gallery page.<br>
16     * title(optional) => Title of the gallery.<br>
17     * sort(optional) => "asc" or "desc" . You can sort in ascending or descending order of names of images. <br>
18     * 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>
19     * exif(optional, Default=>0) => Specify whether to Display exif information or not.<br>
20
21 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.
22
23 Features of the Gallery Plugin:<br>
24 * You can go the next image by clicking on the right side of the image or by pressing 'n'.<br>
25 * Similary, you can go the previous image by clicking on the left side of the image or by pressing 'p'.<br>
26 * Press esc to close the gallery.<br>
27 * While on image, nearby images are preloaded in the background, so as to make the browsing fast.<br>
28
29 It uses templated named [Lightbox](http://www.hudddletogether.com).
30 For any feedback or query, feel free to mail me at arpitjain11 [AT] gmail.com 
31
32 Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikigallery.html).
33
34 -- [[arpitjain]]
35
36 [[tag plugins]] [[tag patch]] [[tag soc]] [[tag wishlist]]