home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / POLL103.ZIP / POLL.DOC < prev    next >
Encoding:
Text File  |  1993-08-15  |  9.9 KB  |  214 lines
  1.                                The Polling Place
  2.  
  3.                                Version 1.0 Beta
  4.  
  5.                              A Voting Booth Program
  6.  
  7.                                       for
  8.  
  9.                           Remote Access and Quick BBS
  10.  
  11.               Copyright 1993 Chris Hartung, HartSoft Productions
  12.  
  13.                               All Rights Reserved
  14.  
  15.  
  16.  
  17. +_____ Introduction __________________________________________________________+
  18. +-----------------------------------------------------------------------------+
  19. +-----------------------------------------------------------------------------+
  20.      This is HartSoft's Voting Booth program for Remote Access and Quick BBS.
  21. It is the result of many hours of programming and testing, and is the author's
  22. first venture into Shareware programming. With your support the author can
  23. continue to develop this program, and other programs.
  24.  
  25.   Shareware Version
  26.   -----------------
  27.  
  28.   - Works with Remote Access V1.1x and V2.00, and Quick BBS 2.6-2.75 (?).
  29.   - Detects and Gives Up Time Slices with DESQView.
  30.   - Safe for use with Multi-Line BBS's (using an in-use file), although it does
  31.       not yet support true File Sharing ( to be included in next release).
  32.   - Mandatory mode to force users to vote on questions chose by Sysop.
  33.   - Up to 20 questions, with 15 answers for each question.
  34.   - Users are allowed to add their own answer to question.
  35.   - Easy setup, with on-line help for each step of configuration.
  36.   - Many functions available locally to Sysop, including: Chat Mode, Dos Shell,
  37.      and user time editing.
  38.   - Sysop can edit questions, and users can edit a new question they have 
  39.       before they save it.  
  40.   
  41.   Registered Version
  42.   ------------------
  43.  
  44.   - Gets rid of 5 second pauses and displays Sysop Name and BBS Name.
  45.   - Sysop function to choose whether the User can add a new answer to a
  46.      question.
  47.   - Ability to give Co-Sysop access to sysop functions.     
  48.  
  49.  
  50. +-----------------------------------------------------------------------------+
  51. +_____ Licensing Information _________________________________________________+
  52. +-----------------------------------------------------------------------------+
  53.      
  54.      HartSoft programs are marketed under the "Shareware" concept. You are
  55. allowed to install this program on Your system and evaluate it before deciding
  56. whether to  purchase a license to continue using it. This program is not public
  57. domain or freeware. If you use this program for more than 30 days after
  58. successful installation, you are legally required to register it or remove all
  59. working copies from your system.
  60.  
  61.      The User Supported or Shareware concept works only if the users of the
  62. program support it. If you find this program useful, you can register it for
  63. only $7.00 in U.S. funds. This will help offset the development costs, and
  64. encourage us to write other programs that might be useful to you. After all, no
  65. one likes to work for free! A Registration Form is included in the distribution
  66. archive.
  67.  
  68.      The Polling Place is Copyright 1993 by HartSoft Productions, ALL RIGHTS
  69. RESERVED. You may copy this program and documentation for backup purposes. You
  70. also are encouraged to share UNMODIFIED copies of the original program archive.
  71. The copyright notice  must remain attached to all copies.
  72.  
  73.      You  may not sell HartSoft products for a fee, or distribute them along
  74. with other products  without written permission of HartSoft productions, nor
  75. may you modify or remove the Copyright Notice from the program or the
  76. documentation. BBS operators who charge for  access to their systems are exempt
  77. from this provision as long as no additional payment is required for access to
  78. HartSoft products beyond basic file access.
  79.  
  80.      All HartSoft products are extensively tested before being publicly
  81. released, but as with any software, bugs may still occur. HartSoft products are
  82. provided  as is, and neither HartSoft Productions nor any BBS operator
  83. distributing  this software is responsible for any  damage incurred during the
  84. operation of the program. You  are advised to test all  HartSoft products
  85. thoroughly on a backup copy of your BBS before putting them on-line.
  86.  
  87.      The Author reserves the right to stop development of new versions  at any
  88. time, and no future releases are guaranteed.
  89.  
  90.      Comments, suggestions and bug reports are welcome.  If you have any, you
  91. may call the support BBS listed in the SUPPORT.TXT file found in the
  92. distribution archive, or address Netmail to Chris Hartung at the Final Frontier
  93. FidoNet Node 1:282/4027. I can also be reached on the Doorware Echo and the
  94. Remote Access Utilities Echo.
  95.  
  96. +-----------------------------------------------------------------------------+
  97. +_____Registration____________________________________________________________+
  98. +-----------------------------------------------------------------------------+
  99.      For registration info see the POLL.REG file included in the archive.         
  100.  
  101.  
  102.  
  103. +-----------------------------------------------------------------------------+
  104. +_____ Setup _________________________________________________________________+
  105. +-----------------------------------------------------------------------------+
  106.  
  107.   Set Up and Configuration
  108.   ----------
  109.  
  110.      First unzip the archive into a directory; if running multi-node a copy of
  111. POLL.EXE must go in a separate directory for each node. Next, run POLLCFG.EXE.
  112. After the program name, type in the name for the configuration file you want to
  113. create (EX: POLLCFG  POLL.CFG).
  114.  
  115.    Once you have entered the  configuration program, choose the Directories
  116. Sub-Menu. Under this there are various paths the need to be defined.
  117.  
  118.      MAIN BBS DIRECTORY --This is the path to your main BBS directory. If you
  119. are running single line, then this is the directory from which the BBS info
  120. will be read.
  121.  
  122.      LINE DIRECTORY--If you are running Multi-Node, then this is the
  123. directory from which the exit info will be read. If you are running single
  124. node, then leave this field blank.
  125.      
  126.      DATA FILES--This is the path where the data files will be stored. If left
  127. blank, then the data files will be stored in the executable directory. This
  128. allows you to keep different sets of questions if you wish to.
  129.  
  130.      LOG FILE-- This is the path in which to store the log file. If left blank,
  131. the log file will be created in the executable directory.
  132.  
  133.  
  134.  
  135.    The other area that need to be configured is the DEFAULTS area.
  136.  
  137.      SYSOP NAME-- The name of the sysop, which must be exactly the same as the
  138. name used when registering.
  139.  
  140.      BBS NAME-- The name of the BBS, must be exactly the same as the name used
  141. when registering.
  142.  
  143.      CO-SYSOP NAME-- This will give the user entered here access to the sysop
  144. maintenance functions (+ Registered Only).
  145.  
  146.      NODE NUMBER-- This is the node number for which this configuration file
  147. will be used.
  148.  
  149.      INACTIVITY TIMEOUT-- This is the amount of time to wait for user activity
  150. before hanging up on the user.
  151.  
  152.  
  153.  
  154.      Lastly add The Polling Place to your menu in the BBS. If you are using
  155. Remote Access, then you can add it as Type 7 exit, and use a batch file
  156. (included in distribution archive). If necessary, use the *m command to have
  157. Remote Access swap out of memory, although the polling place does not use much
  158. memory. For example:
  159.  
  160.      *c /c c:\bbs\ra\poll.bat *m
  161.  
  162. The *c /c calls up command.com, and the *m swaps Remote Access out of memory. If
  163. you are using QBBS, I'm not too sure how to set it up, and would appreciate
  164. input, but this should give you a good start.     
  165.  
  166.  
  167.  
  168.   Running POLL.EXE - Command Line Parameters
  169.   ------------------------------------
  170.  
  171.   Example:  POLL.EXE  POLL1.CFG /Mand
  172.  
  173.      There are only two command line parameters that The Polling Place
  174. understands. The first is the path and name of the configuration file. This
  175. must be the first parameter, and the door will not run without it. The other
  176. option is Mandatory Mode. Currently, the only way that mandatory mode may be
  177. forced is through the command line parameter. A good place to run mandatory mode
  178. would be in the Remote Access TOP menu as an automatic execution. If there are
  179. no new mandatory questions for the user to vote on, then it will not display
  180.  anything, otherwise it will force the user to vote on all mandatory questions.
  181.  
  182.  
  183. +-----------------------------------------------------------------------------+
  184. +_____ The Polling Place______________________________________________________+
  185. +-----------------------------------------------------------------------------+
  186.  
  187.      The Polling Place currently supports up to 20 questions, and up to 15
  188. answers are allowed for each question. Users are given 4 menu choices. They can
  189. vote on a question, add new questions, and see the results of questions they
  190. have voted on. When voting on a question, users are given the option to add an
  191. answer if there is room, and if it has not been disabled by the sysop
  192. <+ Disable New Answer is a Registered Only Function>. Available to the Sysop
  193. and Co-Sysop are the ability to delete questions, change the mandatory status
  194. of questions, and configure whether the user is allowed to add new answers.
  195.      
  196.      The Polling Place can also be run in mandatory mode, which will read the
  197. questions, and will force the user to vote on all mandatory questions that the
  198. user has not already voted for. If there are none, then nothing will be
  199. displayed to the screen.
  200.  
  201.      There are several different Status-Bars available. F1 displays User
  202. Information, F2 is BBS info, F3 is other information, F4 lists the Sysop  keys,
  203. F10 will shut off the status bar. There are also several Sysop  keys available,
  204. including chat mode, dos shell, and time adjusting.
  205.  
  206.  
  207. A special thanks to all those who have helped me to program this, and also to
  208. the users on The Final Frontier who helped test the first alpha version and
  209. sometimes entered the same question in many times.
  210.  
  211. --Chris Hartung
  212. --HartSoft Productions
  213.  
  214.