home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / graphics / dslide / dslide.doc next >
Text File  |  1985-11-17  |  13KB  |  272 lines
  1.    ========================================================================
  2.      Deluxe SlideShow v2.0    (c)1988 Advanced Software    by John Brochu
  3.                            released: March 20, 1988
  4.    ========================================================================
  5.  
  6.          Version 2.0 of Deluxe SlideShow is distributed as SHAREWARE,
  7.           please do not distribute without this documentation file.
  8.  
  9.    ------------------------------------------------------------------------
  10.  
  11.  
  12.  
  13.    Changes from Version 1.1
  14.    ------------------------------------------------------------------------
  15.         o Spectrum 512 .SPC and .SPU support
  16.         o Reworked and enhanced keyboard/mouse commands
  17.         o Built-in help screen
  18.         o New single-step mode with advance/reverse, restart, and
  19.             first/last commands
  20.         o Directories are now searched once at the start of the
  21.             program and when a RESTART command is encountered,
  22.             rather than as the show progresses.  A maximum of
  23.             256 slides can be displayed.
  24.  
  25.  
  26.    Features
  27.    ------------------------------------------------------------------------
  28.         Deluxe SlideShow is an attempt to combine all the currently popular
  29.    ST  graphics  formats into one compact, but flexible slide show program.
  30.    The  program  includes  support  for NeoChrome, DEGAS, DEGAS compressed,
  31.    Tiny,  and Spectrum format pictures.  Any pic can be displayed on EITHER
  32.    monitor  (Spectrum  pics  can  only be displayed on color systems).  The
  33.    color  to  hi-res  monochrome  conversions  use a dithering algorithm to
  34.    represent  the varying color intensities.  Mono to color uses gray-level
  35.    approximation  to  closely  simulate  the  different  dot densities of a
  36.    hi-res screen.
  37.  
  38.         The  user  has  full  control  over slide speed, titling, and slide
  39.    order  through  the  use  of  an  optional script file.  You can specify
  40.    multiple search paths and/or filenames with full wildcard expansion.
  41.  
  42.         o Neo, DEGAS, DEGAS compressed, Tiny & Spectrum support
  43.         o Fully automatic res-switching
  44.         o Fully programmable
  45.         o Optional script files with separate mono & color scripts
  46.         o Mouse and keyboard slide controls
  47.         o Integral Help screen
  48.         o Optional titles
  49.         o Supports command line input, with wildcards
  50.         o Full color-animation support (4 channels for DEGAS Elite pics)
  51.  
  52.  
  53.    File Formats
  54.    ------------------------------------------------------------------------
  55.         DSLIDE.PRG will display pics with the following extenders...
  56.              NEO............ NeoChrome
  57.              PI1-3.......... DEGAS
  58.              PC1-3.......... DEGAS compressed
  59.              TNY or TN1-3... Tiny
  60.              SPU or SPC..... Spectrum 512
  61.         Spectrum files are only displayed on color systems.
  62.  
  63.  
  64.    Search Algorithm
  65.    ------------------------------------------------------------------------
  66.         When  DSLIDE  is first run, the command line is checked for a valid
  67.    pathname, if one is found, the path is searched for valid picture files,
  68.    and  an  internal  list  is  built of the files present in the specified
  69.    directory.
  70.  
  71.         If the command line is empty, DSLIDE looks for a script file in the
  72.    current directory.  If the program is run in color, a "DSLIDEC.INF" file
  73.    is  used,  if  monochrome "DSLIDEM.INF" is used.  If one of these is not
  74.    found,  the  default "DSLIDE.INF" file is used.  This allows you to have
  75.    separate  color  and  mono  script  files on the same disk, showing, for
  76.    instance, only color slides on a color system, and mono slides on a mono
  77.    system.   If no .INF file is found, the program assumes the current path
  78.    is  to be searched for all picture files.  All specified directories are
  79.    then  searched  in order of appearance in the .INF file, and an internal
  80.    file list is built up of all the valid picture files found.
  81.  
  82.         The  file  list  is only constructed once when the program is first
  83.    run, so DSLIDE knows at all times which files are to be displayed and in
  84.    what  order.   If  a  file  in the list is not found when its time comes
  85.    (shouldn't  happen!),  the  file search is automatically restarted and a
  86.    new  file  list  is  built  up.   This can also be forced by hitting the
  87.    ClrHome key at any time.  This allows you to pause the slideshow, switch
  88.    disks, and restart the show with the files on the new disk.
  89.  
  90.         If  no  picture files are found in the directories, you are allowed
  91.    the  option of retrying [ClrHome or left mouse button], viewing the Help
  92.    screen [Help], or aborting [Undo or right mouse button].
  93.  
  94.         The maximum number of slides allowed in a show is 256.
  95.  
  96.  
  97.    Script Files
  98.    ------------------------------------------------------------------------
  99.         Script  files  may  contain the following fields (all are optional,
  100.    and can be in any order), default settings are given in brackets:
  101.         NAME:  title the slides? (yes/no) [no]
  102.         CONT:  continue after one cycle? (yes/no/pause) [yes]
  103.         MODE:  slideshow mode (cycle/step) [cycle]
  104.         TIME:  delay between pics in cycle mode (in seconds) [2]
  105.         PATH:  Pathname list [current directory]
  106.         FILE:  Filename list [all files]
  107.  
  108.         For  the  NAME,  CONT, and MODE fields, only the first character of
  109.    the  string  is  checked,  and  it  can  be either upper or lower case.
  110.    However, it is suggested you use the entire string for readability.
  111.  
  112.         The  'NAME:'  field is a character string, a 'yes' response ('Y' or
  113.    'y')  indicates  the  pictures  will  be  titled  at  the bottom center,
  114.    anything  else  will  be  taken  as  a  'no' (and this is the default).
  115.    Titling can also be toggled on and off with the [Insert] key.
  116.  
  117.         The  'CONT:'  field is a string that determines if the pics will be
  118.    cycled  continuously  (yes),  if  the program will abort after one cycle
  119.    (no),  or  pause  after  one  cycle  (pause).   Valid  entries  here are
  120.    therefore 'y', 'n', or 'p' (upper or lower case), all else is taken as a
  121.    'yes'.
  122.  
  123.         The  'MODE:' field is a string that sets the mode the show will run
  124.    in.   This  can  also  be  toggled  with the [CapsLock] key.  Cycle mode
  125.    continuously cycles through all slides in the show, with a pause between
  126.    slides as specified in the TIME field or set with the function keys, and
  127.    with  the  CONT  field  determining  what will happen after all pics are
  128.    cycled  through.   Step  mode suspends the show after each slide.  Valid
  129.    entries are 'c' for cycle mode and 's' for step mode.
  130.  
  131.         The  'TIME:'  field  is  a  numeric string specifying the number of
  132.    seconds to display each picture when in cycle mode.
  133.  
  134.         The  'PATH:'  field  consists of a list of pathnames to be searched
  135.    one after another.  If a full pathname is present (ie. "A:\PICS\*.PI1"),
  136.    then  that  is  the  search  path  used.  If a path is present without a
  137.    filename  ("A:\PICS\"),  then  the FILE list is scanned one at a time to
  138.    complete  the  full  pathname.   Wildcards  may  be used in the filename
  139.    only.
  140.  
  141.         The  'FILE:'  field  consists of a list of filenames (and filenames
  142.    ONLY,  paths  will  be  stripped,  ie.  "A:\PICS\*.PC?"  will be read as
  143.    "*.PC?")  to  be  processed  one  at  a  time.   Again,  you may include
  144.    wildcards or use full filenames.
  145.  
  146.         The field names MUST BE UPPER CASE and MUST CONTAIN THE COLON.
  147.  
  148.         Blank  lines  are  ignored,  and all text before the first field is
  149.    ignored, so that comments can be used at the start of a script file.
  150.  
  151.         The following is a sample script file:
  152.  
  153.    ---------cut here----------
  154.    This is a sample DSLIDE script file...
  155.    Any text before the first field is ignored!
  156.    CONT:
  157.    pause
  158.    TIME:
  159.    5
  160.    NAME:
  161.    yes
  162.    PATH:
  163.    c:\pics\*.tny
  164.    c:\images\
  165.    #:
  166.    FILE:
  167.    *.p??
  168.    *.neo
  169.    *.tny
  170.    ----------cut here----------
  171.  
  172.         This script will display the pics titled with a 5 sec delay between
  173.    slides,  and  will go into pause after all the pics have been displayed.
  174.    The first PATH entry will cause all Tiny pics found in the "pics" folder
  175.    on  drive  C  to  be displayed.  Since this is a full pathname, the file
  176.    list  is  ignored  for  this  path, and the pathname is searched as-is.
  177.    After this is completed the second PATH entry is processed.  Since it is
  178.    a  pathname  only  (no  filename),  each  of the FILE entries in turn is
  179.    appended to the path to form the complete search pathname (ie. the first
  180.    path  searched  will  be  "c:\images\*.p??", then "c:\images\*.neo", and
  181.    finally "c:\images\*.tny").  Finally, the third PATH entry is processed,
  182.    again  since it is not a complete pathname, the FILE list is scanned one
  183.    at a time to complete the search pathname.  The '#' character is used to
  184.    denote the current drive (drive the program was run from).
  185.  
  186.         Note  you  can  also specify the pics to display by name, in either
  187.    the  PATH  or  FILE fields, if you wish to display the pics in a certain
  188.    order, such as:
  189.  
  190.    -----------cut here-----------
  191.    PATH:
  192.    a:\pics\
  193.    FILE:
  194.    cat.pi1
  195.    house.pi1
  196.    dog.pi1
  197.    sketch.pi2
  198.    -----------cut here-----------
  199.  
  200.    or:
  201.  
  202.    -----------cut here-----------
  203.    PATH:
  204.    a:\pics\cat.pi1
  205.    a:\pics\house.pi1
  206.    a:\pics\dog.pi1
  207.    a:\pics\sketch.pi2
  208.    -----------cut here-----------
  209.  
  210.    There  is  a  limit  of  100 pathnames and 100 filenames for each script
  211.    file, and the script file itself can be no longer than 8K.
  212.  
  213.  
  214.    The Command Line
  215.    ------------------------------------------------------------------------
  216.         A  'PATH:' or 'FILE:' entry can also be entered on the command line
  217.    when  running  DSLIDE.   To do this, rename DSLIDE.PRG to DSLIDE.TTP, or
  218.    install  it as a Tos Takes Parameters application from the desktop.  You
  219.    can  also  install it with a certain file type and then display a single
  220.    pic at a time by double-clicking on the picture file's icon.
  221.  
  222.  
  223.    Keyboard Commands
  224.    ------------------------------------------------------------------------
  225.         The  following  key  commands  are  accepted while the slideshow is
  226.    running:
  227.  
  228.              SPACE/Left button... pause/resume if in cycle mode, step to
  229.                                   the next slide if in step mode
  230.              CapsLock............ toggle step mode
  231.              ESC................. display the next slide immediately,
  232.                                   cancels step mode and pause
  233.              Insert.............. toggle titles on/off
  234.              ClrHome............. restart show from the beginning,
  235.                                   research all directories
  236.              Left arrow.......... reverse advance
  237.              Right arrow......... forward advance
  238.              Up arrow............ go to first slide
  239.              Down arrow.......... go to last slide
  240.              Help................ display the Help screen
  241.              UNDO/Right button... abort Deluxe SlideShow
  242.              F1-F10.............. change slide display time as follows:
  243.                           F1..... 0 sec
  244.                           F2..... 1 sec
  245.                           F3..... 2 sec
  246.                           F4..... 4 sec
  247.                           F5..... 8 sec
  248.                           F6.... 15 sec
  249.                           F7.... 30 sec
  250.                           F8..... 1 min
  251.                           F9..... 2 min
  252.                           F10.... 4 min
  253.  
  254.  
  255.    That's All Folks!
  256.    ------------------------------------------------------------------------
  257.         Deluxe  SlideShow  2.0  is  distributed as SHAREWARE.  Feel free to
  258.    spread  it  around,  but  please  send  us  something  for our trouble.
  259.    Advanced  Software has released many pd/shareware programs over the past
  260.    few  years, including PicSwitch 0.5/0.6/0.7, EZSqueeze, ST Unpit, Dslide
  261.    1.0/1.1/2.0,  and  others under development.  We continue to support our
  262.    products  with  enhancements  and on-line support.  If you'd like to see
  263.    more from us, please support us!
  264.  
  265.         If  you  have  any  comments on Deluxe SlideShow or suggestions for
  266.    future  enhancement,  I'd  like  to  here from you.  I can be reached on
  267.    GEnie [JAKOB], CIS [70376,1235], or Delphi [JAKOB], or by mail at:
  268.  
  269.              Advanced Software
  270.              21 Northend Street
  271.              Peabody, MA  01960
  272.