home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DVOTE10A.ZIP / DOORVOTE.DOC < prev    next >
Text File  |  1997-10-03  |  9KB  |  194 lines
  1. ────────────────────────────────────────────────────────────────────────────
  2.  
  3.                               DoorVote v1.0a
  4.                                by SaltySoft
  5.  
  6.                     Copyright (C) 1997 David Kiesling
  7.                            All rights reserved.
  8.  
  9.  
  10.                                Support BBS:
  11.                  Shoe Salt BBS  707-465-3087  33.6 kbps
  12.  
  13.                               World Wide Web:
  14.                       http://www.vpdev.com/saltysoft
  15.  
  16.                                          SaltySoft Software
  17.           Internet Email:                c/o David Kiesling
  18.         saltysoft@vpdev.com              550 Sandhill Rd.
  19.                                          Crescent City, CA 95531 USA
  20. ────────────────────────────────────────────────────────────────────────────
  21.  
  22.  
  23.  
  24. Table of Contents
  25.  
  26.      I. Introduction
  27.     II. Setup
  28.    III. Samples & Examples
  29.     IV. Support
  30.      V. Attention Programmers!
  31.     VI. A Few Last Words
  32.  
  33.  
  34. ------------------------------ Disclaimer ------------------------------
  35.  
  36.  The author of this program and his affiliates cannot be held legally
  37.  responsible for any damage caused as a result of the use or misuse of
  38.  this program, nor for the precious bytes it takes up on your HD.
  39.  
  40. ------------------------------------------------------------------------
  41. -------------------------- License Agreement ---------------------------
  42.  
  43.  This program is distributed under the shareware concept. You are granted
  44.  a license to use and distribute this program as you wish. However, the
  45.  contents of the compressed .ZIP archive or the uncompressed EXE file may
  46.  NOT be modified in any respect by anyone other than the author.
  47.  
  48. ------------------------------------------------------------------------
  49.  
  50. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  51.  I.  Introduction
  52. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  53.  
  54.  Requirements:  * BBS that can call a batch file to run a door
  55.                 * 8086 or higher processor (I know, I'm pushing it!)
  56.  
  57.  Sysops normally have to do a lot of guesswork on the popularity of
  58.  certain doors on their BBS. Face it, most users just don't want to
  59.  bother giving the sysop feedback on anything.
  60.  As each user exits a certain door, DoorVote bluntly asks users how
  61.  they liked it, giving them a list of answers to choose from. It
  62.  records their answer and tabulates all the votes in a Vote Results
  63.  File, viewable by the sysop. A Log File is also created so the sysop
  64.  can find out exactly who chose which option.
  65.  
  66.  Once a user has voted, DoorVote will not ask them to vote again.
  67.  
  68.  
  69. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  70.  II.  Setup
  71. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  72.  
  73.  DoorVote is run with the following syntax:
  74.  
  75.        doorvote.exe <config file>
  76.  ex:   doorvote.exe doorvote.cfg
  77.  
  78.  For multiple nodes, simply create a config file for each node. The
  79.  config filenames can be anything you like.
  80.  
  81.  You also can just have a separate config file for each door you set
  82.  DoorVote up with, rather than having more than one copy of DoorVote on your
  83.  system. But remember to have a different name for the Logfile and Voting
  84.  Results File for each door, so that the results don't get mixed up.
  85.  
  86.  Layout of Config File:
  87.  ----------------------
  88.   LINE 1: David Kiesling        <- Sysop Name
  89.   LINE 2: Shoe Salt             <- BBS Name
  90.   LINE 3: 0000000000            <- Registration Code
  91.   LINE 4: C:\TRIBBS\DOOR.SYS    <- Full path to DOOR.SYS file
  92.   LINE 5: 0                     <- Non-standard IRQ for the comport
  93.                                    0 = use the standard IRQ for the port
  94.   LINE 6: 5                     <- Maximum minutes allowed in door
  95.                                    0 = read minutes left from dropfile
  96.   LINE 7: 5                     <- Keyboard input timeout in minutes. If
  97.                                    user hasn't press a key in this amount
  98.                                    of time, Fake Bulletin will terminate.
  99.                                    0 = disable this feature
  100.   LINE 8: doorvote.log          <- Log filename to use
  101.                                    (for sysop to view voting log)
  102.   LINE 9: doorvote.dat          <- Voting results filename to use
  103.                                    (for sysop to view voting results)
  104.  LINE 10: votehead.ans          <- ANSI file to display at top of screen
  105.                                    above menu
  106.  LINE 11: votehead.bbs          <- Same as above, except ASCII instead of
  107.                                    ANSI, for if caller has ANSI turned off
  108.  
  109.  LINES 12-21:                   <- Voting choices available to user.
  110.                                    Minimum of 2 and maximum of 10 choices.
  111.                                    See doorvote.cfg for example.
  112.  
  113.    Doorvote.cfg contained in this archive is a sample config file
  114.    and contains short notes reminding you what each line is for.
  115.  
  116.    IMPORTANT!!
  117.    Remember to delete doorvote.log and doorvote.dat every time you modify
  118.    the voting choices in the config file. Otherwise it will get confused
  119.    and do crazy stuff. These two files are not only used as report files
  120.    for the sysop, they're also used as records that the program reads. So
  121.    if you decide to modify those files in any way, don't say I didn't
  122.    warn you. In short - Don't do it!
  123.  
  124.  
  125. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  126.  III. Samples & Examples
  127. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  128.  
  129.  Votehead.ans and Votehead.bbs are sample ANSI and ASCII files for use
  130.  as a menu header. Votehead.ans is displayed if the caller has ANSI
  131.  enabled and votehead.bbs is displayed if not. You can modify or
  132.  replace either as you wish, but note that only the first 5 lines of
  133.  either file will be displayed above the menu, simply because more
  134.  than that won't fit!
  135.  
  136.  Now you're probably wondering how to set DoorVote up to run after a
  137.  certain door before it returns to the BBS. You just put it in the
  138.  door's batch file to run right after the door. Here's a sample batch
  139.  file for the classic doorgame Trade Wars 2002:
  140.  
  141.      cd\tribbs\doors\tws        <- change to door directory
  142.      tw2002.exe                 <- run door
  143.      cd\tribbs\doorvote         <- change to DoorVote directory
  144.      doorvote doorvote.cfg      <- run DoorVote
  145.      cd\tribbs                  <- change to BBS directory
  146.      board                      <- restart the BBS
  147.  
  148.  Pretty easy, huh? I think that's a good enough explanation, but if you
  149.  don't have much experience with this kinda thing I'd be happy to help
  150.  you out.
  151.  
  152.  
  153. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  154.  IV. Support
  155. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  156.  
  157.  You don't have to be a registered user to recieve support for
  158.  DoorVote. Please contact me in any of the ways mentioned at the
  159.  beginning of this file for support. I'd love to hear any and all
  160.  comments, questions, or suggestions.
  161.  
  162.  
  163. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  164.  V. Attention Programmers!
  165. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  166.  
  167.  Are you a programmer?
  168.  
  169.  The new owner (as of 01/01/97) of TriBBS, Gary Price, has made a
  170.  new API for PowerBASIC for easier creation of programs that access
  171.  TriBBS's data files. I've used it for recent TriBBS utilities I've
  172.  made. It's completely FREE for anyone that wants it and I highly
  173.  recommend it. It is strictly for PowerBASIC 3.2. You may contact
  174.  Gary Price:
  175.  
  176.  by email - gwprice@worldnet.att.net
  177.  by BBS   - Freejack's Place (Home of TriBBS) 207-739-7121
  178.  by web   - http://www.tribbs.com
  179.  
  180.  PowerBasic is a programming language which is quickly rising in
  181.  popularity, containing elements of both C and Pascal and even some
  182.  built-in Assembly. Although 99% compatible with QuickBasic 4.5, it's
  183.  far more advanced. It sells for $150 but a free demo may be picked
  184.  up from their web site at http://www.powerbasic.com
  185.  
  186.            
  187. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  188.  VI. A Few Last Words
  189. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  190.  
  191.  Special thanks to the DoorVote beta testers:
  192.  
  193.       Chris Richardson
  194.