1 ================================================================================
5 (c) 2004--2012 Martin Mares <mj@ucw.cz>
7 ================================================================================
9 This is a simple photo gallery for my web pages, or rather a set of bricks
10 from which you can create one. It can be freely used and distributed according
11 to the terms of the GNU GPL v2 or newer.
15 Perl with the following non-core modules:
17 o UCW::CGI (see http://www.ucw.cz/libucw/)
25 o gal -- a front-end script for maintenance of galleries. All other programs
26 are run as sub-commands of this script. Try "gal --help".
28 o gallery.cf -- all programs expect that the current directory contains
29 a configuration file. In fact, the config file is a perl script, whose
30 sole purpose is to set up paths, construct a gallery object and set its
31 options. Also, it usually attaches an appropriate web front-end.
33 A simple example looks as follows:
36 use UCW::Gallery::Web::Plain;
38 my $gal = UCW::Gallery->new;
39 UCW::Gallery::Web::Plain->attach($gal);
41 $gal->set(Title => 'A Gallery', SubTitle => '(an example)');
44 o gallery.list -- a list of original photos together with per-photo parameters.
45 Usually created by "gal scan", then tweaked manually. See `FORMATS' for
46 description of file syntax.
48 o Originals directory -- original images, from which the gallery is generated.
50 o Photo directory -- keeps processed (usually down-scaled) versions of the original
51 images. These are the images shown to the user.
53 o Cache directory -- keeps various cached data, like thumbnails of all photos.
55 o gallery.cgi -- interfaces the gallery to your web server. E.g.:
59 use lib "../path/to/gallery/modules";
62 my $gal = UCW::Gallery->load_config();
63 $gal->get('WebFe')->dispatch();
70 o gal scan /path/to/originals -- this creates gallery.list, populates it with
71 descriptions of all photos and reads rotation from EXIF tags.
73 o vi gallery.list -- edit image descriptions and other options.
75 o gal gen -- generate photos from the originals (after this, the originals are no
78 o gal cache -- generate cached data.
80 o Later, the gallery can be updated:
82 - When you edit image descriptions, re-run "gal cache".
83 - When you edit image options (rotation etc.), re-run "gal gen".
84 - When you want to add new images, re-run "gal scan". Give it the new list
85 of images and it will try to re-use as much information from the previous
86 gallery.list as possible.