README
1 _ _ _
2(_)_ __ ___ __ _ __ _ ___(_)_ __ __| | _____ __
3| | '_ ` _ \ / _` |/ _` |/ _ \ | '_ \ / _` |/ _ \ \/ /
4| | | | | | | (_| | (_| | __/ | | | | (_| | __/> <
5|_|_| |_| |_|\__,_|\__, |\___|_|_| |_|\__,_|\___/_/\_\
6 |___/
7
8 ...a digital photo gallery tool
9
10README for version 2.0
11
12
13FEATURES
14
15 o Index, detail, slide, and frame views
16 o Simple, uncluttered output
17 o Static HTML output for ease of copying/archiving
18 o Uses captions from comments embedded in the image files
19 (utility provided). Captions will never be lost as long as you have
20 the image file itself.
21 o Keeps generated images up to date, removes stale files,
22 only generates needed thumbs, etc.
23 o Digital photo details extracted from EXIF data
24 o Can optionally recurse directory trees and make montage images of
25 directory contents
26 o Easily configurable, can use an rc file.
27 o CSS is used for fonts/styles.
28 o Can handle many image file formats
29 o NEW! Now supports video files (mplayer required for support)
30 o Pages pass W3C specs.
31
32
33REQUIREMENTS
34
35 o perl 5.003_05 or newer
36 o ImageMagick and the Image::Magick perl module
37 o Optional; needed if you want to see EXIF data from the images
38 - Image::Info from CPAN
39 - which needs IO::String as well
40 o mplayer (at least 0.9.88 or newer) is required if you want support for
41 processing video files
42
43
44QUICK USAGE SUMMARY
45
46Please see the comments at the top of the file or run "imageindex -help" to
47see all of the command line options
48
49Examples:
50
51 imageindex
52 Index the images in the current directory
53
54 imageindex -noslide -x 200 -y 200 /path/to/images
55 Index the images in specified dir, without slideshow files, and
56 override the configured thumbnail size
57
58 imageindex -recurse -destdir /tmp/gallery
59 Index images, include subdirs, and export the results to different directory
60
61 imageindex -caption <file> "Some really cool picture"
62 Embed caption in a file and exit
63
64
65CONFIGURATION
66
67Edit any of the variables in configuration section at the top of the
68script.
69
70If you'd like, you can store any of these you'd like to override in a
71~/.imageindexrc file. (Use a '1;' as the last line of the file so it can
72be require-d by the script.)
73
74
75MISCELLANEOUS
76
77The "autocaption" script provided is a quick hack to iterate over a
78directory full of photos, show them to you, and interactively prompt to
79apply embedded captions. (Captions use the JPEG comment field). This utility
80will eventually be replaced with something more GUI-based.
81
82
83ABOUT/CREDITS
84
85Yes, there are other similar programs available. The ones we saw produced
86cluttered or (IMHO) ugly output for the most part, relied on some sort of
87server processing, and didn't handle image comments in a concise manner.
88We did this just for our own purposes, but hopefully someone else can get
89some use out of it.
90
91
92Edwin Huffstutler
93John Reynolds
94
95
96
97Local Variables:
98mode: flyspell
99end:
100