draw plan

[mkgallery.git] / README

diff --git a/README b/README
index 7f8b7ed9b0c47552e684474e2d9b3fc1224fd0fb..0e074612ddaf2d931a70f1593a9ccacf8a493841 100644 (file)
--- a/README
+++ b/README
@@ -29,7 +29,7 @@ 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
@@ -42,12 +42,15 @@ script like "mkindex.pl".
 
 command-line options:
  --help:       print help message and exit
- --incpath:    do not try to find .include diretory upstream, use
+ --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.
@@ -62,12 +65,33 @@ Requirements:
 Image::Info
 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)
 
 Homepage:
 http://www.average.org/mkgallery/
 
 TODO:
 - make index.html depend of .title and directory timestamps
-- any ideas?
+- 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.
 
 Eugene Crosser <crosser at average dot org>