README document for mkgallery script
- Copyright (c) 2006 Eugene G. Crosser
+ Copyright (c) 2006-2009 Eugene G. Crosser
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
3. This notice may not be removed or altered from any source distribution.
mkgallery.pl traverses directory tree starting from current directory
-downwards, and in each directory creates index.html file with the list
-of subdirectories and the list of image files in the directory.
-Fielsystem objects starting with '.' are not processed. For every directory,
-a file ".title" is checked, and created if absent, with the title for this
-album. Two subdirectories are created with scaled down versions of the
-images: ".640" and ".160", and a direcotory named ".html" containging
+downwards, and in each directory creates an index.html file with the
+list of subdirectories and the list of image files in the directory.
+Filesystem objects starting with '.' are not processed. For every
+directory, a file ".title" is checked, and created if absent, with the
+title for this album. Subdirectories are created with scaled down
+versions of the images, and a directory named ".html" containging
slideshow pages (and info pages for non-javascript clients).
-For the thing to work, you must create a subdirectory named ".include"
+For the thing to work, you must create a subdirectory named ".gallery2"
at the root of your image gallery, or somewhere upstairs in the
-document tree, and put there files from the subdirectory "include" of
-this distribution. Then, chdir to the root of your gallery and run
+document tree, and put there the files from the "include" subdirectory
+of this distribution. Then, chdir to the root of your gallery and run
"mkgallery.pl" script. First time, you will be asked to enter titles
for all subdirectories ("Albums"); if you wish to recreate the titles,
-remove ".title" files. If you *don't* want "index.html" to be generated
-in some directory, create a file ".noindex". This way you can preserve
-index created by hand or by some other script.
+remove ".title" files or specify "--asktitles". If you *don't* want
+"index.html" to be generated in some directory, create a file ".noindex"
+there. This way you can preserve index created by hand or by some other
+script like "mkindex.pl".
+
+command-line options:
+ --help: print help message and exit
+ --incpath: do not try to find .gallery2 diretory upstream, use
+ specified path (absolute or relavive). Use with causion.
+ --debug: print a lot of debugging info to stdout as you run
+ --asktitle: ask to edit album titles even if there are ".title" files
+ --noasktitle: don't ask to enter album titles even where ".title"
+ files are absent. Use partial directory names as titles.
+ --rssfile: partial name of rss file. Must be reachable from the
+ current directory or from one of upper directories.
+ First must be created with mkgalrss.pl script.
+
+The only way to specify titles for individual pictures is to write
+comments into the image files (in UTF-8 encoding).
"mkindex.pl" is a simple script that is completely unrelated to the
gallery (theoretically). If your tree starts with YYYY/DD (four
-digit year and two-digit month, this script will create a compact
+digit year and two-digit month), this script will create a compact
table with references to individual months, and then a separate list
-for subdirectories that are not four-digit.
+of subdirectories that are not four-digit.
Requirements:
Image::Info
-Image::Magick (might get rid of that later)
-Term::ReadLine (not at this moment but planned)
+Image::Magick (optional. If not present, will run djeg|pnmscale|cjpeg pipe)
+Term::ReadLine
+XML::RSS (optional. If not present, will refuse to make RSS feed)
-Download:
-svn co svn://svn.average.org/mkgallery/trunk mkgallery
+Homepage:
+http://www.average.org/mkgallery/
TODO:
-- in slide show, use original image if it was not scaled down
-- center info window relative to scroll position
-- tooltips for info and full image links
-- try to get get info from APP12 marker for non-EXIF files
-- really create info files
-- make slideshow "stylish", i.e. use CSS
-- make Image::Magick optional
-- make title editor based on Term::ReadLine
-- anything else that I forgot
+- make index.html depend of .title and directory timestamps
+- rebuild htmls in .html when directory timestamp changes (images added)
+- make links in the rss file work
+- try to make showwin "Extending: Element" and get rid of domelement()
+ dummy getter and getCoordinates() replacement function (?)
Eugene Crosser <crosser at average dot org>
projects / mkgallery.git / blobdiff