435f45d2a80cf99c9b8719e65c9c591a73eccb82
[ikiwiki.git] / doc / todo / Gallery.mdwn
1 New Version of gallery is available now. Few more features have been added like support for multiple pages, sorting and resizing of images etc.
2
3 SVN repository of plugin is located at http://ned.snow-crash.org:8080/svn/ikiwiki-gallery
4
5 --[[arpitjain]]
6
7 ---- 
8
9 creating a gallery of a bunch of images: 
10
11 * Display Exif informations
12 * Display Image informations (like size, date, resolution, compression...)
13 * Create CSS data for customizing
14 * Create Thumbnails (maybe in more than one size, eg: full,1024x768,800x600,640x480)
15 * Descriptions for every image
16 * Comments
17 * Ratings
18 * Watermarks
19 * Some javascript for easy navigation (see [photon](http://www.saillard.org/programs_and_patches/photon/) for a good example)
20
21 It should be possible to disable every feature for every directory. 
22
23 ----
24
25 This could be split into two distinct projects. One would be to modify the [[plugins/img]] plugin to support some of these ideas for extracting and using information such as exif out of images. The other project would be to design something that handles setting up a gallery, which could be just some regular wiki pages using the img plugin, and perhaps some other custom plugins for things like ratings and javascript), and adding new images to a gallery as they are added to the wiki.
26
27 That's one way to do it, and it has some nice benefits, like being able to edit the gallery pages like any wiki page, to add comments about images, links, etc. An example of ikiwiki being used like that: <http://kitenet.net/~family/pics/guaimaca.html> (still room for improvement, clearly).
28
29 --[[Joey]]
30
31 [[tag soc]]
32
33 [[tag wishlist]]
34
35 ----
36
37 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. 
38
39 Plugin can be downloaded from [here](http://myweb.unomaha.edu/~ajain/gallery.tar). 
40
41 It can be used as : <br>
42 \[[gallery imagedir="images" thumbnailsize="200x200" cols="3" alt="Can not be displayed" title="My Pictures"]]
43
44 where-<br>
45 * 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>
46 * thumbnailsize(optional) => Size of the thumbnail that you want to generate for the gallery.<br>
47 * alt(optional) => If image can not be displayed, it will display the text contained in alt argument.<br>
48 * cols(optional) => Number of columns of thumbnails that you want to generate.<br>
49 * title(optional) => Title of the gallery.<br>
50
51 Features of the Gallery Plugin:<br>
52 * You can go the next image by clicking on the right side of the image or by pressing 'n'.<br>
53 * Similary, you can go the previous image by clicking on the left side of the image or by pressing 'p'.<br>
54 * Press esc to close the gallery.<br>
55 * While on image, nearby images are preloaded in the background, so as to make the browsing fast.<br>
56
57 Right now, it features only one template namely [Lightbox](http://www.hudddletogether.com). Later on, I will add few more templates.<br>
58 For any feedback or query, feel free to mail me at arpitjain11 [AT] gmail.com 
59
60 Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikigallery.html).
61
62 [[tag patch]]
63
64 > I'd love to merge this into ikiwiki.
65
66 > However, lightbox.js is licensed under a non-free (Creative Commons) license. :-(
67
68 > Since I don't much like the lightbox effects anyway (too much resizing
69 > motion, too slow), I wonder if another template could be added, perhaps
70 > a free one? 
71
72 > --[[Joey]]