attempt to support utf8 better
[mkgallery.git] / README
diff --git a/README b/README
index 0e074612ddaf2d931a70f1593a9ccacf8a493841..d34f3c4668b09b06136e5cd52e4534cfa34a6c79 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@
 
   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
 mkgallery.pl traverses directory tree starting from current directory
 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
+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.  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).
+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 ".gallery2"
 at the root of your image gallery, or somewhere upstairs in the
-document tree, and put there files from the subdirectory "include"
+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,
@@ -48,12 +48,9 @@ command-line options:
  --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.
+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
@@ -71,27 +68,11 @@ Homepage:
 http://www.average.org/mkgallery/
 
 TODO:
+- support gestures. Make the interface more mobile-friendly
+- make jumping to adjacent albums possible (via parameter to upper index.html)
 - make index.html depend of .title and directory timestamps
-- new javascript slideshow:
-  - On show image: find this and next urls; put in place
-    those that are already here; free unneeded; initiate download of
-    the rest; if needed image is ready then initiate "transitioning", else
-    initiate "loading".
-  - On load complete: if this is the target image, initiate "transitioning".
-  - On "loading": show "loading" image
-  - On "transitioning": hide "loading" image; initiate FX animation to the
-    needed image.
-  - On animation complete: blank previous image; if "playing" then schedule
-    autoswitch to next image in the future.
-  - On autoswitch to next image: if "playing" then switch to next image.
-  - On switch to next image: if next exists, show next image, else show
-    "last image" message.
-  - On switch to prev image: if prev exists, show prev image, else show
-    "first image" message.
-  - On "play": make "playing"; switch to next image.
-  - On "stop": if "playing" cancel autoswitch; break "playing".
-  - On "start show": set up things; set "playing" state; show needed image.
-  - On "stop show": cancel any schedules, hide things.
-- make "controls" and "slideshow" two "co-routine" style classes.
+- rebuild htmls in .html when directory timestamp changes (images added)
+- try to make showwin "Extending: Element" and get rid of domelement()
+  dummy getter and getCoordinates() replacement function (?)
 
 Eugene Crosser <crosser at average dot org>