README.gallery

   1 Project IkiWiki::gallery.pm
   2 ===========================
   3 Version 0.9
   4
   5 This plugin creates a nice looking gallery of the images.
   6
   7 SVN Repository of plugin is at http://ned.snow-crash.org:8080/svn/ikiwiki-gallery
   8
   9 USAGE:
  10 ======
  11
  12 Plugin can be used as
  13 [[gallery imagedir="images" option="value"]]
  14
  15 Available options :
  16 - 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.
  17 - thumbnailsize(optional,Default=200x200) => Size of the thumbnail that you want to generate for the gallery.
  18 - resize(optional, Default=>800x600) => Width and Height to resize image to or resize="0" for no resize
  19 - alt(optional) => If image can not be displayed, it will display the text contained in alt argument.
  20 - cols(optional,Default=3) => Number of columns of thumbnails that you want to generate.
  21 - rows(optional, Default=>3) => Number of Rows on a gallery page.
  22 - title(optional) => Title of the gallery.
  23 - sort(optional) => "asc" or "desc" . You can sort in ascending or descending order of names of images.
  24 - 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.
  25 - exif(optional, Default=>0) => Specify whether to Display exif information or not.
  26
  27 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.
  28
  29 --Arpit Jain (arpitjain11 AT gmail.com)
  30