_                            _           _
(_)_ __ ___   __ _  __ _  ___(_)_ __   __| | _____  __
| | '_ ` _ \ / _` |/ _` |/ _ \ | '_ \ / _` |/ _ \ \/ /
| | | | | | | (_| | (_| |  __/ | | | | (_| |  __/>  <
|_|_| |_| |_|\__,_|\__, |\___|_|_| |_|\__,_|\___/_/\_\
                   |___/

                   ...a digital photo gallery tool

README for version 1.1


FEATURES

 o Index, detail, slide, and frame views
 o Simple, uncluttered output
 o Static HTML output for ease of copying/archiving
 o Uses captions from comments embedded in the image files
   (utility provided).  Captions will never be lost as long as you have
   the image file itself.
 o Keeps generated images up to date, removes stale files,
   only generates needed thumbs, etc.
 o Digital photo details extracted from EXIF data
 o Can optionally recurse directory trees and make montage images of
   directory contents
 o Easily configurable, can use an rc file.  
 o CSS is used for fonts/styles.
 o Can handle many image file formats
 o NEW! Now supports video files (mplayer required for support)
 o Pages pass W3C specs.


REQUIREMENTS

 o perl 5.003_05 or newer
 o ImageMagick and the Image::Magick perl module
 o Optional; needed if you want to see EXIF data from the images
     - Image::Info from CPAN
     - which needs IO::String as well
 o mplayer (at least 0.9.88 or newer) is required if you want support for
   processing video files


QUICK USAGE SUMMARY

Please see the comments at the top of the file or run "imageindex -help" to
see all of the command line options

Examples:

  imageindex
    Index the images in the current directory

  imageindex -noslide -x 200 -y 200 /path/to/images
    Index the images in specified dir, without slideshow files, and
    override the configured thumbnail size

  imageindex -recurse -destdir /tmp/gallery
    Index images, include subdirs, and export the results to different directory

  imageindex -caption <file> "Some really cool picture"
    Embed caption in a file and exit


CONFIGURATION

Edit any of the variables in configuration section at the top of the
script.

If you'd like, you can store any of these you'd like to override in a
~/.imageindexrc file.  (Use a '1;' as the last line of the file so it can
be require-d by the script.)


MISCELLANEOUS

The "autocaption" script provided is a quick hack to iterate over a
directory full of photos, show them to you, and interactively prompt to
apply embedded captions.  (Captions use the JPEG comment field). This utility
will eventually be replaced with something more GUI-based.


ABOUT/CREDITS

Yes, there are other similar programs available.  The ones we saw produced
cluttered or (IMHO) ugly output for the most part, relied on some sort of
server processing, and didn't handle image comments in a concise manner.
We did this just for our own purposes, but hopefully someone else can get
some use out of it.


Edwin Huffstutler
John Reynolds



Local Variables:
mode: flyspell
end: