web commit by http://arpitjain11.myopenid.com/
[ikiwiki.git] / doc / patchqueue / Gallery_Plugin_for_Ikiwiki.mdwn
1 I have implemented the first version of the Gallery Plugin for Ikiwiki as part of [[soc]]. This plugin would create a nice looking gallery of the images once the directory containing images is specified with some additional parameters. It has been build over the img plugin. 
2
3 Plugin can be downloaded from [here](http://myweb.unomaha.edu/~ajain/gallery.tar). 
4
5 It can be used as : <br>
6 \[[gallery imagedir="images" thumbnailsize="200x200" cols="3" alt="Can not be displayed" title="My Pictures"]]
7
8 where-<br>
9 * imagedir  => 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>
10 * thumbnailsize(optional) => Size of the thumbnail that you want to generate for the gallery.<br>
11 * alt(optional) => If image can not be displayed, it will display the text contained in alt argument.<br>
12 * cols(optional) => Number of columns of thumbnails that you want to generate.<br>
13 * title(optional) => Title of the gallery.<br>
14
15 Features of the Gallery Plugin:<br>
16 * You can go the next image by clicking on the right side of the image or by pressing 'n'.<br>
17 * Similary, you can go the previous image by clicking on the left side of the image or by pressing 'p'.<br>
18 * Press esc to close the gallery.<br>
19 * While on image, nearby images are preloaded in the background, so as to make the browsing fast.<br>
20
21 Right now, it features only one template namely [Lightbox](http://www.hudddletogether.com). Later on, I will add few more templates.<br>
22 For any feedback or query, feel free to mail me at arpitjain11 [AT] gmail.com 
23
24 Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikigallery.html).