home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / audio / samples / vote10.lha / VOTE.doc < prev    next >
Encoding:
Text File  |  1992-04-02  |  5.3 KB  |  136 lines
  1.                            --------------------
  2.                            THE VOTING BOOTH 1.0
  3.                            --------------------
  4.                                     by
  5.                                Tom Warkentin
  6.                             Copyright (C) 1992
  7.  
  8. -----------------------------------------------------------------------------
  9. This software is FREEWARE and may distributed so long as the following
  10. files are included in the archive:
  11.  
  12.     VOTE         -        the executable file
  13.     VOTE.doc     -        docs on setting it up
  14.     README       -        this file
  15.  
  16. Any archiving method may be used, however nothing can be added or ommitted
  17. from the archive. Furthermore, the files mentioned above may not be modified
  18. in any way.  Under no circumstances can a fee be charged for the distribution
  19. of the files!
  20. -----------------------------------------------------------------------------
  21. INSTALLATION:
  22.  
  23.     The executable can be placed anywhere you want it, however you
  24. must assign VOTE: to the directory where you've placed the file.  Also
  25. keep in mind that the Voting Booth will create subdirectories and data
  26. files, therefore I would recommend you placing it in it's own directory.
  27. For DLG owners, your best bet is to place it in the DOORS: directory.
  28. Here's how I set it up on my hard drive.
  29.  
  30.     CD DOORS:
  31.     MAKEDIR VOTE
  32.     ASSIGN VOTE: DOORS:VOTE
  33.  
  34. Now make sure you place the executable in VOTE: and create a menu item
  35. so users can access it from the BBS.  Also, you might want to take some
  36. time to setup some topics and choices so the users have an idea of what
  37. you want added to the booth.
  38.  
  39. ADDING MENU ITEM:
  40.  
  41.     I'll go through the setup for DLG owners. If you're using some
  42. other BBS package, you should get the general idea from reading the
  43. setup procedure.
  44.  
  45. 1) Select the command type as Executable.
  46.  
  47.     USAGE:
  48.  
  49.         VOTE %UNAME "%ALIAS" %LEVEL %ANSI %SCWIDTH 1
  50.  
  51.     The Voting Booth uses the underscored username to ensure that a
  52. user will not vote twice for a topic.  The alias part may be replaced by
  53. the users real name. Whatever you decide to put in quotations is what the
  54. user will actually see as the names of users using the booth.  The user
  55. level must be included to control access to the SysOp configuration menu
  56. as well as to control user additions to the booth (must be an integer).
  57. The ansi flag is either "color" or "mono" depending on the users current
  58. settings.  Screen width is used to either print two columns of menu items
  59. or single columns.  The "1" on the end of the line is used to determine
  60. which config file to use for the booth and where to look for the data
  61. files.  If you plan on running multiple booths, you should choose a
  62. unique number for each.
  63.  
  64. 2) Executable name [VOTE:VOTE %UNAME "%ALIAS" %LEVEL %ANSI %SCWIDTH 1]
  65. 3) Enable Echo
  66.  
  67. DATA FILES:
  68.  
  69.     Once you've run the booth for a while, you'll probably figure out
  70. the way the data files are setup.  I won't bother explaining it in the
  71. documentation because I want to discourage people from editing the files
  72. behind the scenes.  If you plan on editing them in your favorite text
  73. editor, make sure you understand the format completely or the program may
  74. crash.  I've put in some error checking if the files are missing, but if
  75. they exist and have been tampered with, your computer may crash.
  76.  
  77. DISCLAIMER:
  78.  
  79.     This software comes with absolutely no guarantee and I will not
  80. be held responsible for it destroying your computer and munching your
  81. hard drive.  USE IT AT YOUR OWN RISK!  Having said that, I can assure
  82. you that I haven't had any problems with it on my system.  If you do find
  83. a problem with the software, I'd appreciate knowing about it so I can fix
  84. it!
  85.  
  86. FINAL NOTE:
  87.  
  88.     As of yet, I have no plans to continue revising the software.
  89. Basically I thought I'd throw it out there and see what kind of a response
  90. I get.  It is freeware, however if you want to encourage me to keep writing
  91. more utilities like it, you could always send me something... ANYTHING 8^)
  92. (ie cookies, postcards, A3000's, HD's, $$$, encouragement, criticisms,
  93. bug reports <ICK>, whatever...)
  94.  
  95.     If this generates enough interest, complaints, or suggestions,
  96. I'll do whatever I can to add more to it.  I've got some more ideas kicking
  97. around like:  keeping a log of user activity, allowing a user to change his
  98. vote, graphing the results... but let me know if you'd like to see them
  99. added.
  100.  
  101. You can reach me by sending email to:
  102.  
  103.         tom@manning.cs.ualberta.ca
  104.  
  105. or calling:
  106.  
  107.         The Spectre BBS (2400 soon 14.4)
  108.         (403) 435-9486
  109.         Edmonton, AB
  110.  
  111. or sending snail mail to:
  112.  
  113.         Tom Warkentin
  114.         1016 Buchanan Place
  115.         Edmonton, AB
  116.         T6R 2A7
  117.  
  118. ---------------------------------------------------------------------------
  119. HISTORY:
  120.  
  121. v1.0  -  added color, finished up SysOp menu, fixed a bug that didn't print
  122.      a [-] in the Review a Topic menu for those topics the user had not
  123.      voted for.
  124. v0.7  -  finished "Add New Topic", "Delete Topic", and started on the SysOp
  125.      menu.
  126. v0.5  -  started working on user additions.
  127. v0.1  -  beautiful moment when the data files were read in properly and the
  128.      first and only menu was displayed correctly.
  129. ---------------------------------------------------------------------------
  130. THANK YOU's:
  131.  
  132.     Paul for the late night calls on how to fix bugs in C, even though
  133. he's never programmed anything in C himself :)! Yusuf for the ideas for the
  134. voting booth.  Cam for displaying an interest in the completion of the
  135. booth.
  136.