home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / PRVIEW14.ZIP / PREVIEW.DOC < prev    next >
Text File  |  1992-11-29  |  15KB  |  317 lines
  1. GIF Previewer Ver 1.3
  2.  
  3. The GIF Previewer Door is a door written that allows a user to select up to
  4. 79 GIFs and create one GIF and download that GIF so he/she can examine the
  5. GIFs to see if they really want to download these GIFs.
  6.  
  7. Preview Features:
  8.  
  9.    1. Entry of a logo into the array created
  10.    2. File search and listing capabilities
  11.    3. External transfer protocol support
  12.    4. Custom menus
  13.  
  14.  
  15. Set Up
  16.  
  17.    1. Create a config file that contains the following information
  18.       1 - Complete path to door.sys file
  19.           (See operations section for file types supported.)
  20.       2 - The name of your BBS
  21.       3 - Sysop's first name
  22.       4 - Sysop's last name
  23.  
  24. ====[  This section is imperitive.  ]==========================================
  25.  
  26. NOTE: There are 2 additional lines necessary when using GTUSER.BBS. Since
  27.       this file does not provide the ComPort% and NodeNum% variables, advise
  28.       your Door users to add them to this .CFG file on lines 5 and 6
  29.       respectively. Both variables will default to 1.
  30.  
  31. ===============================================================================
  32.  
  33.       5 - Complete path to the work directory that Preview will place the
  34.           arrays for download.  This directory must be dedicated to Preview as
  35.           it erased every time the door is run.  This directory is also used as
  36.           a scratch dir for Preview.
  37.       6 - Complete path and file name to Preview main menu
  38.       7 - Complete path and file name to Preview dir menu
  39.       8 - Complete path and file name to Preview welcome screen
  40.       9 - Complete path and file name to Preview help screen
  41.      10 - Complete path and file name to PCB index file or blank if not
  42.           operating under PCB or you do not desire to use PCB's index
  43.           capability.
  44.      11 - Name of GIF created by GIFDESK.  Limited to six characters or less.
  45.           As each collage is created, it is named COLLAG1, COLLAG2, ECT...
  46.      12 - The total number of GIFs allowed per collage.  See Operations section
  47.           for more information.
  48.      13 - The total number of GIF directories that the door will process
  49.      14 - Complete path and file name of first GIF DIR file
  50.      15 - Complete path to GIF directory that is linked to entry 12
  51.      16,17 - Same as 14 and 15
  52.  
  53.       If you have an entry of 4 in line 13 then you must have 8 entries
  54.       following.  Each two lines after line 13 is the board DIR file and it's
  55.       linked directory.  A sample config file is included.
  56.  
  57.    3. Create the file PROT.DAT in the PREVIEW directory.  This file is the list
  58.       of transfer protocols, their corresponding letter in the protocol menu
  59.       displayed to users, the batch file calling the protocol and whether the
  60.       protocol is batch transfer capable.  See the Operations section for the
  61.       exact lay out of this file.
  62.  
  63.    4. Create a file to execute the Preview Door
  64.  
  65.       @ECHO OFF
  66.       CD D:\PCB1\DOORS\PREVIEW
  67.       PREVIEW PREVIEW.CFG
  68.       BOARD1
  69.  
  70.    5. Add the Preview Door entry to your doors list file
  71.  
  72. ====[  This section is imperitive.  ]==========================================
  73. =                                                                              =
  74. =  6. Set the environment variable GIFDESK=FILE.  This is required so GIFDesk =
  75. =  can opearte under any graphics card/monitor configuration to include a     =
  76. =  monochrome system.  I recommend setting this variable in you AUTOEXEC.BAT  =
  77. =  file.  Please note that if this envirnment variable is not set, the door   =
  78. =  will not operate properly if at all!                                       =
  79. =                                                                             =
  80. ===============================================================================
  81.  
  82. Operation
  83.  
  84.       There are certain circumstances that will override the total number of
  85.       GIFs per collage specified in the configuration file.  If the user has
  86.       selected a 640x480 resolution, then the collage is limited to 29 GIFs.
  87.       If the user has selcted 800x600 resolution then the collage is limited to
  88.       47 GIFs and if the user has selected 1024x768, then up to 79 GIFs per
  89.       collage can be created.  Please note that 640x480 is the default.
  90.  
  91. NOTE: The following sysop functions are available when a user is logged in
  92.       PREVIEW
  93.  
  94.       F3 - Toggle Printer On/Off
  95.       F4 - Toggle Sysop Page Status
  96.       F5 - Shell to DOS
  97.       F7 - Toggle Caller Alarm
  98.       F8 - Dump User Back To BBS
  99.       F9 - Toggle Display On/Off
  100.       F10 - Initiate Sysop Chat.  When in chat mode, ESC will terminate chat
  101.       ALT N - Sets Sysop On Next Flag
  102.       ALT X - Sets Exit To DOS flag
  103.       Up Arrow - Increase User Time
  104.       Dn Arrow - Decrease User Time
  105.       Rt Arrow - Increase User Security Level
  106.       Lt Arrow - Decrease User Security Level
  107.  
  108.    If a user selects 3 or fewer GIFs then Preview will create a four GIF array
  109.    and if he/she selects between 4 and 8, Preview will create a nine GIF array.
  110.    If the user selects nine or more GIFs, Previewer will create a 30, 48 or 80
  111.    array GIF depending on what resolution (s)he has selcted. When 29 GIFs at
  112.    640x480 resolution are selected, the GIF created will be about 90K.
  113.  
  114.    If you wish to include a logo in each array generated then create a GIF and
  115.    place it in the Preview work directory.  This GIF must be named A.GIF.  This
  116.    is currently hard coded into Preview so it will be the first GIF in the
  117.    array.  This was done because GIFDESK sorts the GIFs in the array and there
  118.    is currently no way to prevent this.  I recommend a simple logo with two or
  119.    three colors so it will always look relatively the same for each array
  120.    generated.
  121.  
  122.    All custom screens support an ansi version by appending a g to the file name
  123.    specified in the config file.  For example, if you had a menu screen called
  124.    MENU then to send an ansi version of that screen create that screen and name
  125.    it MENUG.
  126.  
  127. ====[ This section is imperitive  ]============================================
  128.  
  129.    When saving ansi screens, use the Block Save function when using TheDraw or
  130.    the equivelent for whatever ansi pgm you are using.  When marking the block,
  131.    do not use column 80.
  132.  
  133. ===============================================================================
  134.  
  135.    Preview has the capability to utilize PCBoard's file indexs to speed up
  136.    operations as well as save wear and tear on CD Roms and hard drives.  To
  137.    utilize this, set entry 10 in the config file to the complete path and file
  138.    name to the index file.  If you aren't operating under PCB or do not desire
  139.    to use the index file, then leave this line blank.  Note that when
  140.    operating under PCB and utilizing the index capability, the wild card
  141.    function does not support the question mark, only the asterik.  This is not
  142.    true if your not using the index file.  Both the question mark and asterik
  143.    are supported.
  144.  
  145.    Set up on a multitasking or network environemnt is painless.  Simply create
  146.    a config file with a different work directory.  The work dir must be
  147.    different for each node of operation.
  148.  
  149.    THE PROT.DAT file consists of four entries per line.  The first entry is the
  150.    letter selecting the protocol, the second entry is the actual batch file
  151.    calling the external protocol, the third entry is the description of the
  152.    protocol displayed in the protocol menu and the fourth entry is whether or
  153.    not the protocol is batch capable.  The PROT.DAT file can contain up to 15
  154.    separate protocols.  A sample file is included along with the calling batch
  155.    files.  Four variables are passed to the batch file: %1 is the active comm
  156.    port, %2 is the callers connect speed, %3 is the file name and %4 is the
  157.    computer to modem connect speed.  Sample batch files utilizing DSZ are
  158.    provided for XModem, XModem-1K, YModem(g) and ZModem
  159.  
  160.    The door currently supports six different door file types:
  161.  
  162.       PCBOARD.SYS  - PCBoard 14.5a
  163.       CALLINFO.BBS - Wildcat system prior to ver 3
  164.       USERINFO.BBS - Wildcat systems ver 3.x
  165.       DOOR.SYS     - For systems that support DOOR.SYS
  166.       DORINFOx.DEF - QBBS/RBBS/RA (change x to reflect node number)
  167.       SFDOORS.DAT  - Spitfire systems
  168.  
  169.     PREVIEW has been tested to operate succesfully on PCB, Wildcat, and VBBS
  170.     systems. The only consideration to operate on a non PCB system is the text
  171.     file that is linked to each GIF dir.  Simply create a text file from your
  172.     DIR files. The only requirement is that only file names be in column 1. PCB
  173.     systems do not have to create seperate text files, they can use their
  174.     existing DIR files.  All other systems must create a text file for each GIF
  175.     dir.
  176.  
  177.     The door supports standard comm ports 1 - 4
  178.  
  179.       Port 3 on 3E8/IRQ4 and Port 4 on 2E8/IRQ3
  180.  
  181.       Non-standard comm port interrupts are also supported.  To utilize IRQ 5
  182.       your command line to call the door should look like this:
  183.  
  184.       PREVIEW PREVIEW.CFG /5
  185.  
  186.       If your using DSZ/GSZ to support the file transfers then your batch file
  187.       to call DSZ using COM 3 on address 3E8 using interrupt 5 should look
  188.       something like this:
  189.  
  190.       DSZ ha bo portx 3E8,5 est 0 %2 sz %3.
  191.  
  192.       Batch files for standard com ports are provided.  If you use non-standard
  193.       IRQs then I suggest reading the docs that came with your protocol.
  194.  
  195.    The following files must be in your DOS path, GIFDESK.EXE and the batch files
  196.    that call each seperate transfer protocol.
  197.  
  198. Commands Available In Door
  199.  
  200.     F - Display file directories. Displays a menu in which the user selects
  201.         what DIR file to display.  Once the user has selected the DIR file,
  202.         then (s)he select files to put in the collage.  Standard DOS wild cards
  203.         are supported when selecting files.
  204.  
  205.         Available in registered veriosn only.
  206.  
  207.         *More than one name can be given at a time. For example, ASBI000?
  208.         ASVI000? will place all files matching that criteria in the collage.
  209.         Up to ten different names can be given at one time
  210.  
  211.     C - Once the user has selected files for the collage, he uses this command
  212.         to create the collage.
  213.  
  214.     D - This allows the user to download the collage created.  If more than one
  215.         collage was made and the user selects a batch capable protocol then no
  216.         further intervention is neseccary.  If the user selects a non batch
  217.         capable protocol and has created more than one collage then (s)he must
  218.         be there to start each individual transfer.
  219.  
  220.     H - Help, displays help file
  221.  
  222.     R - Return to BBS.  Door will issue warning if user has selected files for
  223.         a collage or has created a collage and not downloaded it.
  224.  
  225.     S - Allows the user to search all file directories on a key word.  If the
  226.         key word is found then the GIF file and it's entire description is
  227.         displayed.
  228.  
  229.     E - Allows user to enter a file name to add to the collage.  Standard DOS
  230.         wild cards are supported as well as multiple file names.  Please review
  231.         command F for more details on wild cards and multiple file
  232.         specifications.
  233.  
  234. *   + - Allows the user to increase the resolution output of the collage
  235.         created.  This in turn allows more GIFs per collage.
  236.  
  237. *   - - Allows the user to decrease the resolution output of the collage
  238.         created.
  239.  
  240. *EDIT - Allows the user to remove GIFs from the collage that (s)he has
  241.         previously selected.  The user is shown a list of GIFs currently
  242.         selected and (s)he supplies the number of the GIF to remove.  If the
  243.         user enters ALL, then all GIFs are removed from the collage.
  244.  
  245. Note - Items with an * next to them are available in the registered version
  246.        only.  But note, all features are available when the sysop is logged
  247.        into the door so (s)he can make a proper evaluation of the door.
  248.  
  249.  
  250. In the Future
  251.  
  252.     Create own index utility to improve operations under all BBS types.
  253.  
  254. Warranty
  255.  
  256.     This product is provided "as is" without warranty of any kind. The entire
  257.     risk as to the results and  performance of the program is assumed by you.
  258.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  259.     representations regarding  the use of,  or the  results of the use of the
  260.     program,  and you  rely on the  program and  results  solely at  your own
  261.     risk.  The author  cannot and  will not accept  responsibility for system
  262.     damage, loss of profit, or any other special, consequential or incidental
  263.     damages  resulting  from  the  use  or  inability  to  use this  product.
  264.  
  265. Copyright
  266.  
  267.     GIF Previewer Copyright (c) 1992 by  Chris Gifford  is being distributed as
  268.     Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  269.     version for a reasonable period of  time for evaluation  after which you
  270.     must either register your copy or discontinue  usage.  This time period is
  271.     set for 60 days.
  272.  
  273. Registration:
  274.  
  275.     Registration gets you support via tha Antares Sector BBS (801) 544-7613.
  276.     A registration fee of $20 is required.  Please send all registrations to:
  277.  
  278.       Chris Gifford
  279.       189 S. Main, #40
  280.       Layton, UT  84041
  281.  
  282.     Please include exactly how you want your name to appear when the door first
  283.     opens.  You are limited to 35 characters or less.  Please include your BBS
  284.     number so I can upload the latest version of PREVIEW and the key to remove
  285.     to opening delay.
  286.  
  287.     Once you have registered and obtained your key then place the key in the
  288.     PREVIEW home directory.
  289.  
  290. Support
  291.  
  292.     I believe in supporting any software that I develop, whether the user has
  293.     registered the software or not.  Support for PREVIEW can be obtained at two
  294.     different BBS's:
  295.  
  296.     The Antares Sector (801) 544-7613 via the support conference, USR HST D/S
  297.  
  298.     The GIFfer BBS - (813) 969-2761 14.4
  299.                      (813) 969-2956 14.4
  300.                      (813) 969-1829 14.4
  301.                      (813) 969-1089 14.4
  302.  
  303.     If you use the GIFfer BBS for Preview support, please leave all messages to
  304.     Robert Perreault.
  305.  
  306. Credits
  307.  
  308.    Preview was developed under DFRAME, a doors development kit for MS Basic 7.X
  309.    PDS and is copyrighted by Ted Freeman of MicroNet BBS (615) 626-1620.
  310.  
  311.    All trademarks are copyrighted by their respective owners.
  312.  
  313.    Credit where credit is due:
  314.  
  315.    Many thanks go to Robert Perreault of PC-Lynk BBS.  With out his help and
  316.    input PREVIEW would not have come along as fast as it has.
  317.