README

   1   $Id$
   2
   3   README document for mkgallery script
   4
   5   Copyright (c) 2006 Eugene G. Crosser
   6
   7   This software is provided 'as-is', without any express or implied
   8   warranty.  In no event will the authors be held liable for any damages
   9   arising from the use of this software.
  10
  11   Permission is granted to anyone to use this software for any purpose,
  12   including commercial applications, and to alter it and redistribute it
  13   freely, subject to the following restrictions:
  14
  15   1. The origin of this software must not be misrepresented; you must not
  16      claim that you wrote the original software. If you use this software
  17      in a product, an acknowledgment in the product documentation would be
  18      appreciated but is not required.
  19   2. Altered source versions must be plainly marked as such, and must not be
  20      misrepresented as being the original software.
  21   3. This notice may not be removed or altered from any source distribution.
  22
  23 mkgallery.pl traverses directory tree starting from current directory
  24 downwards, and in each directory creates index.html file with the list
  25 of subdirectories and the list of image files in the directory.
  26 Fielsystem objects starting with '.' are not processed.  For every directory,
  27 a file ".title" is checked, and created if absent, with the title for this
  28 album.  Two subdirectories are created with scaled down versions of the
  29 images: ".640" and ".160", and a direcotory named ".html" containging
  30 slideshow pages (and info pages for non-javascript clients).
  31
  32 For the thing to work, you must create a subdirectory named ".include"
  33 at the root of your image gallery, or somewhere upstairs in the
  34 document tree, and put there files from the subdirectory "include" of
  35 this distribution.  Then, chdir to the root of your gallery and run
  36 "mkgallery.pl" script.  First time, you will be asked to enter titles
  37 for all subdirectories ("Albums"); if you wish to recreate the titles,
  38 remove ".title" files.  If you *don't* want "index.html" to be generated
  39 in some directory, create a file ".noindex".  This way you can preserve
  40 index created by hand or by some other script like "mkindex.pl".
  41
  42 command-line options:
  43  --debug:       print a lot of debugging info to stdout as you run
  44  --asktitle:    ask to edit subalbum titles even if there are ".title" files
  45  --noasktitle:  don't ask to enter subalbum titles even where ".title"
  46                 files are absent.  Use partial directories as titles.
  47
  48 The only way to specify titles for individual pictures is to write
  49 comments into the image files.
  50
  51 "mkindex.pl" is a simple script that is completely unrelated to the
  52 gallery (theoretically).  If your tree starts with YYYY/DD (four
  53 digit year and two-digit month, this script will create a compact
  54 table with references to individual months, and then a separate list
  55 for subdirectories that are not four-digit.
  56
  57 Requirements:
  58 Image::Info
  59 Image::Magick (optional. If not present, will run djeg|pnmscale|cjpeg pipe)
  60 Term::ReadLine
  61
  62 Download:
  63 svn co svn://svn.average.org/mkgallery/trunk mkgallery
  64
  65 TODO:
  66 - any ideas?
  67
  68 Eugene Crosser <crosser at average dot org>