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