aboutsummaryrefslogtreecommitdiff
path: root/doc/patchqueue/Gallery_Plugin_for_Ikiwiki.mdwn
blob: 6e6f560bf48b03e27f40af6b70491634e9147a4c (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
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. 

Plugin can be downloaded from [here](http://myweb.unomaha.edu/~ajain/gallery.tar). 

It can be used as : <br>
\[[gallery imagedir="images" thumbnailsize="200x200" cols="3" alt="Can not be displayed" title="My Pictures"]]

where-<br>
* 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>
* thumbnailsize(optional) => Size of the thumbnail that you want to generate for the gallery.<br>
* alt(optional) => If image can not be displayed, it will display the text contained in alt argument.<br>
* cols(optional) => Number of columns of thumbnails that you want to generate.<br>
* title(optional) => Title of the gallery.<br>

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>

Right now, it features only one template namely [Lightbox](http://www.hudddletogether.com). Later on, I will add few more templates.<br>
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).