X-Git-Url: http://www.average.org/gitweb/?p=mkgallery.git;a=blobdiff_plain;f=README;h=354dfd5ca29a3f158d934bfbf01167fb8d182e3d;hp=91baef4c08bbdd91b65a7d6f66523f1dbb1dcec8;hb=f7b9a9ba521a5b36685838e275e70e759d281177;hpb=85bc0cd23c8f241132bed5dd83d9a873a3acbcde diff --git a/README b/README index 91baef4..354dfd5 100644 --- a/README +++ b/README @@ -21,46 +21,61 @@ 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 -slideshow pages (and info pages for non-javascript clients). +downwards, and in each directory creates an 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 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 files from the subdirectory "include" +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. "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: -- 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 +- implement header and footer insertion +- make index.html depend of .title and directory timestamps +- rebuild htmls in .html when directory timestamp chnges (images added) +- make links in the rss file relative +- try to make showwin "Extending: Element" and get rid of domelement() + dummy getter and getCoordinates() replacement function Eugene Crosser