home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / poll110.zip / POLL.DOC < prev    next >
Text File  |  1994-06-20  |  13KB  |  269 lines
  1.                                The Polling Place
  2.  
  3.                                Version 1.10
  4.  
  5.                              A Voting Booth Program
  6.  
  7.                                       for
  8.  
  9.                            Remote Access 1.11 and 2.0X
  10.  
  11.               Copyright 1994 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 1.11 and 2.0X.
  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.0x.
  29.   - Detects and Gives Up Time Slices with DESQView.
  30.   - Safe for use with Multi-Line BBS's using file sharing and record locking.  
  31.   - Mandatory mode to force users to vote on questions chose by Sysop.
  32.   - Up to 30 questions, with 30 answers for each question.
  33.   - Configurable path for data files, can have as many question sets as
  34.      desired.
  35.   - Users are allowed to add their own answer to question.
  36.   - Easy setup, with on-line help for each step of configuration.
  37.   - Many functions available locally to Sysop, including: Chat Mode, Dos Shell,
  38.      and user time editing.
  39.   - Nightly mainentance program which
  40.       - Deletes user records not found in RA's user file.
  41.       - Removes questions after a configurable number of days, and
  42.         posts them as messages in either Hudson, JAM, or *.MSG format.
  43.       - Sets flags in RA's Users.bbs, so that users who have not voted for
  44.         a mandatory question are forced to vote for it. (See installation)
  45.  
  46.   Registered Version
  47.   ------------------
  48.  
  49.   - Removes 5 second pauses and displays Sysop Name and BBS Name.
  50.   - Sysop function to choose whether the User can add a new answer to a
  51.      question.
  52.   - Ability to give Co-Sysop access to sysop functions.     
  53.  
  54.     The Polling Place has been tested and run on many computers, from a 80286 to 
  55. a 486 DX-2 66. It runs well under Netware Lite, and Lantastic 5.0. It has also
  56. been tested under Desqview 2.61, 2.62,and 2.63, and has been run under
  57. MS-DOS 5.0 and 6.0. 
  58.  
  59.  
  60. +-----------------------------------------------------------------------------+
  61. +_____ Licensing Information _________________________________________________+
  62. +-----------------------------------------------------------------------------+
  63.      
  64.      HartSoft programs are marketed under the "Shareware" concept. You are
  65. allowed to install this program on Your system and evaluate it before deciding
  66. whether to  purchase a license to continue using it. This program is not public
  67. domain or freeware. If you use this program for more than 30 days after
  68. successful installation, you are legally required to register it or remove all
  69. working copies from your system.
  70.  
  71.      The User Supported or Shareware concept works only if the users of the
  72. program support it. If you find this program useful, you can register it for
  73. only $10.00 in U.S. funds. This will help offset the development costs, and
  74. encourage us to write other programs that might be useful to you. After all, no
  75. one likes to work for free! A Registration Form is included in the distribution
  76. archive. 
  77.  
  78.      The Polling Place is Copyright 1993,94 by HartSoft Productions, ALL RIGHTS
  79. RESERVED. You may copy this program and documentation for backup purposes. You
  80. also are encouraged to share UNMODIFIED copies of the original program archive.
  81. The copyright notice  must remain attached to all copies.
  82.  
  83.      You  may not sell HartSoft products for a fee, or distribute them along
  84. with other products  without written permission of HartSoft productions, nor
  85. may you modify or remove the Copyright Notice from the program or the
  86. documentation. BBS operators who charge for  access to their systems are exempt
  87. from this provision as long as no additional payment is required for access to
  88. HartSoft products beyond basic file access.
  89.  
  90.      All HartSoft products are extensively tested before being publicly
  91. released, but as with any software, bugs may still occur. HartSoft products are
  92. provided  as is, and neither HartSoft Productions nor any BBS operator
  93. distributing  this software is responsible for any  damage incurred during the
  94. operation of the program. You  are advised to test all  HartSoft products
  95. thoroughly on a backup copy of your BBS before putting them on-line.
  96.  
  97.      The Author reserves the right to stop development of new versions  at any
  98. time, and no future releases are guaranteed.
  99.  
  100.      Comments, suggestions and bug reports are welcome.  If you have any, you
  101. may call the support BBS listed in the SUPPORT.TXT file found in the
  102. distribution archive, or address Netmail to Chris Hartung at the Final Frontier
  103. FidoNet Node 1:282/4027. I can also be reached on the Doorware Echo and the
  104. Remote Access Utilities Echo.
  105.  
  106.  
  107.  
  108. +-----------------------------------------------------------------------------+
  109. +_____ Setup _________________________________________________________________+
  110. +-----------------------------------------------------------------------------+
  111.  
  112.   Set Up and Configuration
  113.   ----------
  114.  
  115.      First unzip the archive into a directory; if running multi-node I
  116. reccomend making the .exe files read only. Next, run POLLCFG.EXE. After the 
  117. program name, type in the name for the configuration file you want to
  118. create (EX: POLLCFG  POLL.CFG). If running multinode, make a config file for
  119. each node, and call them POLL1.CFG, POLL2.CFG, ... etc.
  120.  
  121.    
  122.    The first menu in POLLCFG is BBS Software. Set this depending on whether
  123. you are running RA 1.11 or 2.0x.
  124.  
  125.    Next, access the PATHS menu choice. Under this there are various 
  126. paths that need to be defined.
  127.  
  128. MAIN BBS DIRECTORY --This is the path to your main BBS directory. If you
  129.      are running single line, then this is the directory from which the BBS 
  130.      info will be read.
  131.  
  132. LINE DIRECTORY--If you are running Multi-Node, then this is the directory 
  133.      from which the exit info will be read. If you are running single
  134.      node, then leave this field blank.
  135.      
  136. DATA FILE PATH--This is the path where the data files will be stored. If left
  137.      blank, then the data files will be stored in the executable directory. 
  138.      This allows you to have as many different sets of questions as you do 
  139.      disk space. You can have one for adult users, and one for other users, 
  140.      and a general set for everyone. This is one feature you won't find in
  141.      other voting booth programs.
  142.  
  143. USER FILES PATH--This is the path where RA's USERS.BBS and USERSIDX.BBS can
  144.      be found. This is required both for POLL.EXE and for PMU.EXE.
  145.  
  146. HUDSON MESSAGE BASE PATH-- THis is the path in which the Hudson message base
  147.      files can be found.
  148.  
  149. LOG FILE Path-- This is the path in which to store the log file. If left blank,
  150.      the log file will be created in the directory from which POLL.EXE is
  151.      executed. If desired, you can use the same log as RA uses. 
  152.  
  153. PMU LOG PATH-- This is the path and NAME of the logfile that PMU will write
  154.      to.
  155.  
  156. The other area that needs to be configured is the DEFAULTS area.
  157.  
  158. SYSOP NAME-- The name of the sysop, which must be exactly the same as the
  159.      name used when registering.
  160.  
  161. BBS NAME-- The name of the BBS, must be exactly the same as the name used
  162.      when registering.
  163.  
  164. CO-SYSOP NAME-- This will give the user entered here access to the sysop
  165.      maintenance functions (+ Registered Only).
  166.  
  167. NODE NUMBER-- This is the node number for which this configuration file
  168.      will be used.
  169.  
  170. INACTIVITY TIMEOUT-- This is the amount of time to wait for user activity
  171.      before hanging up on the user.
  172.  
  173. NEW QUESTION SECURITY LEVEL -- This is the security level which a user is 
  174.      required to have to add new questions.
  175.  
  176. SET MANDATORY FLAGS-- This Sub-menu brings up a window showing the RA flags.     
  177.     When PMU is run, any question which has mandatory status set will cause 
  178.     PMU to set the flags as configured here for each user that has not voted
  179.     for the specific question.
  180.  
  181. DAYS TO RUN QUESTIONS-- This is the number of days to run questions before 
  182.     removing them from the question data file. The next menu choice allows
  183.     you to do several things with removed questions.
  184.  
  185. OLD QUESTION SAVE FORMAT-- This is a sub-menu with four choices of how PMU
  186.     handles questions that were deleted after running the configured number 
  187.     of days. The choices are :
  188.         NONE  : Delete the question, do nothing with it.
  189.         HUDSON : Writes question and results to HMB, require HMB board #.
  190.         JAM : Writes question to JAM message area, requires path and name
  191.               of JAM area. (No Extensions).
  192.         FIDO *.MSG  : Write question in FIDO *.MSG format, requires path to
  193.               write to.
  194.  
  195.      Lastly add The Polling Place to your menu in the BBS. If you are using
  196. Remote Access, then you can add it as Type 7 exit, and use a batch file
  197. (included in distribution archive). If necessary, use the *m command to have
  198. Remote Access swap out of memory, although the polling place does not use much
  199. memory. For example:
  200.  
  201.      *c /c c:\bbs\ra\poll.bat *N *m
  202.  
  203. The *c /c calls up command.com, and the *m swaps Remote Access out of memory. If
  204. The *N sends the node number to the batch file, which then chooses the  
  205. appropriate config file to use.
  206.  
  207.  
  208.   Running POLL.EXE - Command Line Parameters
  209.   ------------------------------------
  210.  
  211.   Example:  POLL.EXE  POLL1.CFG /Mand
  212.  
  213.      There are only two command line parameters that The Polling Place
  214. understands. The first is the path and name of the configuration file. This
  215. must be the first parameter, and the door will not run without it. The other
  216. option is Mandatory Mode. Currently, the only way that mandatory mode may be
  217. forced is through the command line parameter. A good place to run mandatory mode
  218. would be in the Remote Access TOP menu as an automatic execution. Use PMU to   
  219. set the flags on all user who have not voted for a question. Then, have a menu
  220. in RA's top menu with those flags enabled, with /MAND as a command line 
  221. parameter. This will start the Polling Place in mandatory mode, and cycle 
  222. through all mandatory questions for which the user has not voted.
  223.  
  224. +-----------------------------------------------------------------------------+
  225. +_____ The Polling Place______________________________________________________+
  226. +-----------------------------------------------------------------------------+
  227.  
  228.      The Polling Place currently supports up to 30 questions, and up to 30
  229. answers are allowed for each question. Users are given 4 menu choices. They can
  230. vote on a question, add new questions, and see the results of questions they
  231. have voted on. When voting on a question, users are given the option to add an
  232. answer if there is room, and if it has not been disabled by the sysop
  233. <+ Disable New Answer is a Registered Only Function>. Available to the Sysop
  234. and Co-Sysop are the ability to delete questions, change the mandatory status
  235. of questions, and configure whether the user is allowed to add new answers.
  236.      
  237.      The Polling Place can also be run in mandatory mode, which will read the
  238. questions, and will force the user to vote on all mandatory questions that the
  239. user has not already voted for. If there are none, then nothing will be
  240. displayed to the screen.
  241.  
  242.      There are several different Status-Bars available. F1 displays User
  243. Information, F2 is BBS info, F3 is other information, F4 lists the Sysop  keys,
  244. F10 will shut off the status bar. There are also several Sysop  keys available,
  245. including chat mode, dos shell, and time adjusting.
  246.  
  247. +-----------------------------------------------------------------------------+
  248. +_____ Poll Maintenance Utility (PMU)_________________________________________+
  249. +-----------------------------------------------------------------------------+
  250.  
  251.      PMU is a program which can be run either nightly or weekly. It will do 
  252. the following:
  253.    -Delete users from its data file who can not be found in the RA user file.
  254.    -Set Flags for Users who have not voted for mandatory questions.
  255.    -Remove questions after a certain number of days, and if desired write
  256.     them to either Hudson, JAM, or *.MSG message areas.
  257.    -Packs the Polling Place data files.
  258.  
  259.  
  260.  
  261.  
  262. A special thanks to all those who have helped me to program this, and also to
  263. the users on The Final Frontier who helped test the first alpha version and
  264. sometimes entered the same question in many times.
  265.  
  266. --Chris Hartung
  267. --HartSoft Productions
  268.  
  269.