                                ThumbIndex: Batch File Description

ThumbIndex ver 1.30 batch files have the following structure:

; comment lines begin with ;
- continuation lines begin with - (you may need these with HEADER and FOOTER)
var = val ;
var = val ;

                        ----------------

1) Short Descriptions

The currently used VARiables are:

     IMGDIR     =   x:\dir\subdir
     SEL        =  /dir1/subdir1
     NOT_HTTP   =  [0,1,2]
     CREATE     =  [0,1]
     DOSUB      =  [0,1]
     OVERWRITE  =  [0,1]
     AUTOGIF    =  [0,1]
     INCLUSION  =  [*,JPG,GIF,BMP,TIF,PNG]        
     TSIZE      =  nn
     DESC       =  a description
     MAKE_SNAP  =  [0,1]
     COMMENT    =  filename  a-commment
     LISTNAME   =  filename or 0
     MAPNAME    =  filename or 0
     SMAPNAME   =  filename or 0
     THUMBTEXT  =  [DATE,SIZE,NAME]
     HEADER     =  header-stuff
     FOOTER     =  footer-stuff


                        ----------------


2) Short Descriptions

> These are used to specify what image files you wish to "process", and where
  to store the thumbnails.

   IMGDIR = optional: a fully qualified directory
        The directory that contains the images you want to process.
        If NOT specified, then the SEL subdirectory of the WWW_DIR 
        (a user configurable parameter set in THUMINDX.CMD) is where 
        the images are assumed to be.

        Example: 
           IMGDIR=E:\MYFILES\PHOTOS\AUGUST
        
   SEL = selector 
       The URI to use to point to the images you wish to make thumbnails of.
       If IMGDIR is NOT specified, then this subddirectory of the WWW_DIR 
       contains the images.
       If IMGDIR is specified, then your server must map SEL to IMGDIR.
       
       Example:
          SEL= /PHOTOS/AUGUST

       The default is /

       Example:
         If the images are found in F:\MYFILES\PHOTOS\AUGUST00
         If the "selector" that points to F:\MYFILES\PHOTOS\AUGUST00
         is  /PERSONAL/AUG_PHOTOS
         Then set
             SEL=/PERSONAL/AUG_PHOTOS
             IMGDIR= F:\MYFILES\PHOTOS\AUGUST00
        
       Alternatively,
         If the images are found in F:\WWW\PHOTOS\AUGUST00
         If the "selector" that points to F:\WWW\PHOTOS\AUGUST00
         is  /PHOTOS/AUGUST00
         If the root of the web tree, as set in the WWW_DIR parameter, is F:\WWW
         Then set
             SEL=/PHOTOS/AUGUST00
         That is, in this case you do not need to specify the IMGDIR.

   NOT_HTTP = 2, 1 or 0

       If 1, then the index files will be built using local disk addresses,
       rather then URLs. For example, you can use this to create indices for 
       set of photos to be distributed on a CD (the thumbnail links will point to
       files on the CD).

       NOT_HTTP=0 : 
          Create URI style links (NOT_HTTP is ignored).

       NOT_HTTP=1 :
          Thumbnails will be stored in the THUMBNAIL_DIR (set in the
          user configurable parameters section of THUMINDX.CMD).

       NOT_HTTP=2 :
           2 is similar to 1, but it over rides THUMBNAIL_DIR -- thumbnails are 
           stored in the THUMINDX subdirectory of the IMGDIR (THUMINDX will be
           created if necessary).  If IMGDIR is not specified, using 2 causes
           an error.

         In general, we highly recommend using NOT_HTTP=2 instead of NOT_HTTP=1.

      If 0, NOT_HTTP is ignored.

> This is used when creating thumbnails.
   CREATE=1 or 0
        If 1, then create (or recreate) thumbnails and  a database (of images in
        specified by WWWDIR and SEL).
        Otherwise, use an existing set of thumbnails and database (of images in
        specified by WWWDIR and SEL).

> These are used when CREATE=1
   DOSUB =0  or 1
      If DOSUB=1 is specified, then also examine all subdirectories of SEL
      Default is 0
   OVERWRITE=0 or 1
      If OVERWRITE=1 is specified, then old thumbnails (and databases) will be overwritten
      Default is 1
   AUTOGIF=1 or 0
      If AUTOGIF=1, then if a thumbnail can not be found in the extended attributes, try to
      create one. Default is 1
  INCLUSION=EXT
      EXT can be one of * JPG GIF BMP TIF PNG        
      You can include several instances of INCLUSION=EXT
      Default is *.
   TSIZE=nn
      nn is the pixel height (and width) of the thumbnails to be created
      Examples include 16, 32,  64, or 96
      Default is 64
  DESC= a description
      Description of this directory of images
      Default is "Thumbnails"

This is used to create snapshots

  MAKE_SNAP=1

     If MAKE_SNAP =1, then snapshots are created, and stored in 
     the SNPS subdirectory of the IMGDIR. 
     If MAKESNAP=0, then do NOT attempt to create snapshots.

     Notes:
       *  Snapshots are "VGA quality" images: 640x480, highly compresssed, 
          JPEG images.

       *  To make and use snapshots, the IMGDIR must be on an non-FAT drive
          (they must be on a drive that supports long filenames).
 
This is used to add comments 
  COMMENT= filename  a commment
      You can have many FILE= a comment statements -- one for each file in the SEL.
      The filename should be relative to the WWWDIR and SEL. 
      Thus,
         if you want to include  a comment for E:\WWW\PHOTOS\ANIMALS\HORSES.JPG, 
         and WWWDIR=E:\WWW
         and SEL='/PHOTOS/ANIMALS'
         then you could use
           COMMENT= horses.jpg These fine horses are ready to run

These are used to write the html "index" files.
  LISTNAME= name for "linear list index". If not specified, INDEX2.HTM (in
               the SEL directory) is used. 
                 To suppress use LISTNAME=0.
                 Do NOT include directory (filename only)
                 Default is INDEX2.HTM.
  MAPNAME = name for "imagemap index". If not specified, INDEX.HTM (in
               the SEL directory) is used. To suppress use MAPNAME=0.
               Do NOT include directory (filename only)
      
  SMAPNAME = name for "simple imagemap index". If not specified, 
               INDEX1.HTM (in the SEL directory) is used. To suppress use 
               SMAPNAME=0. Do NOT include directory (filename only)

  THUMBTEXT = xxx
       What sort of info to write on bottom of thumbnail (in the imagemap).
       xxx can be DATE, SIZE, or NAME. If not specified, then no info is written.

  HEADER= header stuff
        A header, which may include $Codes. This is added to the beginning of each
        html "index" file.

  FOOTER= footer stuff
        Footer info, which may include $codes. This is added to the end of each
        html "index" file.


                        ----------------


3) Examples:

  IMGDIR=e:\www
  sel=photos/wedding
  create=1
  comment= image01 This is the bride
  comment= image13 This is the limousine
  DESC = My best friend's wedding
  ; don't bother with the simple imagemap
  smapname=0
  header= $DESC 
  ;note the use of the continuation line (it's part of the FOOTER)
  footer= This document was created on $CREATION
  - <p> Contact Me for More Info! 

Example #2:
   ; sample thumbindex options file
   imgdir=f:\photos\00nov
   sel=/photos1/misc/
   create=1
   desc= Some photos from november
   comment= 00000110.jpg Jen 12
   tsize=64
   header=$link_Other <br> $Desc 
   footer=Created by me, on $creation <br> $resize 
   smapfile=0
   verbose=0

                        ----------------

4)    $CODE substitutions 

In both headers and footers, the following codes are replaced (codes start 
with a $ sign, and must NOT contain spaces). 

    $BOTTOM : jump to bottom of screen
 
    $CREATION : the database creation date (i.e.; 04/10/01 08:19:12)
 
    $DESC : the "database" description (i.e.; SOFTBALL PICTURES )
 
    $DATE : today's date (i.e; 3 MAY 2001)
 
    $DIR : the WWW directory the database contains thumbnails for 
 
    $FILE=FILENAME : insert a file
    The inserted contents will ALSO be subject to $CODE replacement (but only 
    one $FILE= replacement per footer or per header) 
 
    $LINK_OTHER : a link to the "other" indices (for example, in index.htm, 
     include a link to both index1.htm and index2.htm) 
 
    $NUM : the number of thumbnails contained in this database 
 
    $RESIZE : include a 'resize images' option (used only in the regular 
     imagemap index; it is NOT used in the simple imagemap index) 
 
    $TIME : current time (i.e.; 16:32:56)
 
    $TOP : jump to top of screen 

