home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WILDCAT / POSTER29.ZIP / POSTER.DOC < prev    next >
Text File  |  1994-03-30  |  24KB  |  562 lines
  1.  ┌───────────────────────────────────────────────────────────────────────────┐
  2.  │                      Poster 2.9  - (C) 1990,93 Bill Bolden                │
  3.  └───────────────────────────────────────────────────────────────────────────┘
  4.  
  5.                                License Agreement
  6.  
  7. Poster is (C)1990,94 Bill Bolden. This program is offered using the shareware
  8. system of program evaluation.  Using this system, the user is given the
  9. opportunity to test this program for a reasonable period of time which I
  10. consider one month or 30 days. After this period, it is required that you
  11. register the program as outlined in REGISTER.DOC or discontinue its use.
  12. Poster is neither Freeware nor Public Domain.
  13.  
  14.                                  Distribution
  15.  
  16. You are free to distribute POSTER as long as no files are deleted or modified
  17. in the .ZIP.  Poster can not be distributed by anyone who charges a specific
  18. fee for the program or if POSTER is bundled with any other program in any way.
  19.  
  20.                                  Registration
  21.  
  22. Registration of Poster is $11.00 but a discount is available. Please see the
  23. REGISTER.DOC that should be with the .ZIP that contained POSTER.  I reserve
  24. the right to add features that are only available to registered users.
  25. Registration of POSTER is separate from TIME DOOR.  POSTER's prize function
  26. will not work unless you have a registered copy of Time Door. However, the
  27. rest of the functions will still work. You can register POSTER online by
  28. calling Crown Jewel BBS and registering with your Mastercard, Visa, or
  29. American Express.
  30.  
  31.                                     Support
  32.  
  33. Support of POSTER is done through Crown Jewel BBS in Lake Wales Florida
  34. (813)696-2444/7246. You can also reach support through the Internet by
  35. sending E-Mail to bill.bolden@cjewel.com.
  36.  
  37.                                 What is Poster?
  38.  
  39. Long ago there was a local BBS run on an Apple using some software that I have
  40. forgotten. This BBS was filled with messages mainly because the sysop had a
  41. top poster list.  Well, shortly after, I wrote a program that would create a
  42. Top Ten List for our BBS. Even though I was asked to release the program, I
  43. never did because Time Door was taking up a good portion of my time. When
  44. Wildcat! 3.0 came out, I decided to rewrite Poster with the intention of
  45. releasing it.  Since Wildcat! 3.0 keeps track of the number of messages
  46. posted, you may wonder why you would need this program. Well, there are two
  47. good reasons to use Poster. First of all, Poster is a monthly, weekly or bi-
  48. weekly contest.  The advantage of a contest that is reset often is that new
  49. users have a chance and your better posters are not allowed to rest on their
  50. past success.  Second, Poster will give your users PRIZES of time, bytes
  51. and/or downloads if you are a Registered user of Time Door.  Poster writes the
  52. bulletins. Poster keeps track of the contest and Poster gives the prizes.
  53. This means you can basically set the program up, let it run and forget about
  54. it.
  55.  
  56. Make sure you read the section on "Running a successful Posting Contest" for
  57. some hints on making this program do its job for you.
  58.  
  59.                                  Requirements
  60.  
  61. A REGISTERED copy of Time Door is required for the prize function to work.
  62. Poster will still create its bulletins and keep track of winners even if you
  63. don't have a copy of Time Door.
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                          How to interact with Poster.
  70.  
  71. Poster is COMMAND LINE DRIVEN.  To get a list of command line options, just
  72. type POSTER without any command line.
  73.  
  74.  
  75.                                   POSTER EDIT
  76.  
  77. POSTER EDIT will allow you to edit user entries. This is to lower or raise
  78. user's number of messages posted. You can also delete users using this option.
  79. When you type POSTER EDIT, you will be shown a scroll window with all users.
  80. Move the highlight bar to the user you want to edit and press ENTER. Follow
  81. the prompts from there.
  82.  
  83.                                POSTER CONFIGURE
  84.  
  85. This will allow you to configure POSTER. Please see the section entitled
  86. "Configuring Poster" for complete details on this option.
  87.  
  88.                               POSTER FILENAME.EXT
  89.  
  90. POSTER FILENAME.EXT will read the file FILENAME.EXT for messages. Of course,
  91. you would replace FILENAME.EXT with your activity log names (with complete
  92. paths). For example, POSTER ACTIVITY.001 will read ACTIVITY.001 and then
  93. create all your bulletins.  If you don't want to create the bulletins after
  94. you read the logs then add a /R after the file name. If you have a multinode
  95. system, please read the section on Multinode systems for more information on
  96. the /R switch.  You can use wildcards when specifying file names. For example,
  97. POSTER ACTIVITY.* would read all your activity logs and create the bulletins.
  98. WARNING, when using wildcards, be very careful to not include files that you
  99. don't want read. For example, if a file called ACTIVITY.EXE existed using
  100. POSTER ACTIVITY.* would cause POSTER to read the .EXE file.
  101.  
  102.  
  103.                                 POSTER BULLETIN
  104.  
  105. POSTER BULLETIN will create all bulletins as specified in CONFIGURE.
  106.  
  107. Poster assumes that you delete your activity logs on a daily basis and that
  108. you are running a single line system. If that description doesn't fit your
  109. BBS, don't worry as POSTER offers options to take care of multinode systems
  110. and systems that don't delete their activity logs on a daily basis.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.                               Configuring Poster
  135.  
  136. To configure POSTER, you type POSTER CONFIGURE from the DOS prompt.  You will
  137. then be given a MENU of configuration options. This section explains those
  138. options.
  139.  
  140.                                General Settings
  141.  
  142. General settings is the most important part of the configuration. You should
  143. check this section before running Poster in your event.  This section
  144. describes all the configuration fields. To go from field to field you can use
  145. the arrow keys. When you are done configuring the door, press ESCape to save
  146. the changes.
  147.  
  148. Path to top 10 Bulletin: This is the full name and path to the bulletin that
  149. will be created daily. This bulletin lists your top 10 posters and some
  150. message totals.  It is recommended that you make this bulletin a HELLOX type
  151. bulletin.  If this field is left blank, this bulletin will not be created.
  152. Example: C:\WC30\DISP\HELLO1.BBS
  153.  
  154. Path to Bulletin #2: This bulletin contains a alphabetized list of all posters
  155. on your system for the contest. This bulletin can get big and it is
  156. recommended that you make this a bulletin available from your bulletin menu.
  157. If this field is left blank, this bulletin will not be created.
  158. Example: C:\WC30\BULL\BULL1.BBS
  159.  
  160. Path to Time Door: This is the path to your Time Door directory. Poster
  161. reads and writes to your TIME.DAT and TIME.PRZ and it needs this directory to
  162. find those files. If this field is left blank, time prizes will not be given.
  163. If you don't use Time Door, leave this field blank.
  164. Example: C:\DOOR\TIMEDOOR\  NOTE: the last "\" is important and necessary.
  165.  
  166. Before: Anything put in this field will be put before your Top Ten bulletin
  167. and the Winner Bulletin. Use this field to add Wildcat! codes to your liking.
  168. On our system, we like to clear the screen before the bulletin and make the
  169. bulletin unstoppable by the space bar. So we use the example on our system.
  170. Example: @CLS@@NOSTOP@
  171.  
  172. After: Anything put in this field will be put AFTER your Top Ten Bulletin and
  173. the Winner Bulletin. Use this field to add Wildcat! codes after the bulletins.
  174. On our system, we put a pause after the bulletins and use the example.
  175. Example: @PAUSE@
  176.  
  177. Reset Day: This is the day of the month that the contest is reset. When this
  178. day of the month is reached, the Winner Bulletin is created, the Time Prizes
  179. are given (if applicable) and the contest is reset.  This happens whenever the
  180. program is run for any reason on the correct day.  On our system, we reset the
  181. contest on the 2nd so we set this field to 2.
  182. Example: 2
  183.  
  184. Last Winner: This is the last person to win the monthly contest. You can
  185. change this field if you wish but it serves no configuration purpose.
  186.  
  187. Part of Log to read: This tells Time Door which part of the LOG you want to
  188. read.  If you set this to WHOLE, the whole log will be read. If you set it to
  189. YESTERDAY, only messages posted yesterday will count.  See "Using Poster on
  190. Large Activity Logs" for more information on this field. Press the Space Bar
  191. to toggle this option.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.                             General Settings (cont)
  201.  
  202. Header: This is the top banner for the daily Top Ten bulletin.
  203. Example: Crown Jewel BBS's Monthly Top Ten Poster Contest
  204.  
  205. Footer: This is the bottom banner for the daily Top Ten Bulletin.
  206. Example: Win time in Time Door by just being on this list!
  207.  
  208. Ascii Winners List: This file is created on the reset day and contains
  209. a list of the top ten names in ASCII format with one name per line.
  210. You can use this as an import list for Dave Cody's Postmaster program which
  211. would allow you to send a letter to every user congratulating them for
  212. being in the top ten.  With a couple commands in your batch file, you
  213. can do this unattended.
  214.  
  215. Path to Winner Bulletin: At the end of the monthly contest, Time Door will
  216. create a bulletin listing all the previous winners. We suggest you copy this
  217. to a HELLOXN or bulletin file.
  218. Example: C:\WC30\DISP\HELLO1N.BBS
  219.  
  220. Create RIP Bulletins: Poster will create RIP versions of all bulletins if this
  221. is set to YES. Set this to NO, if you are not using RIP graphics to save disk
  222. space. Press Space Bar to toggle.
  223.  
  224. Reset Frequency: You can have Poster reset monthly, weekly (every 7 days) or
  225. bi-weekly (every 14 days). The busier your system, the more you should reset
  226. the contest. Press the Space Bar to toggle.
  227.  
  228.  
  229.                Setting Prizes (F2 from the Configuration Screen)
  230.  
  231. When you press F2, you are given the option to edit the prizes given to
  232. your users.  You can enter time, bytes and downloads for every place. If you
  233. want to give time but not give bytes and downloads, just enter zero for the
  234. part of the prize you don't want to give. You will then be asked for the
  235. number of days to give the prize. For example, if you reset on the first and
  236. you give a prize for 15 days, the user can pick up that prize every day until
  237. the 16th of the month. Entering 0 for the days means the prize will be a one
  238. time prize that will be given to the user the next time they enter Time Door.
  239. It is important to understand the difference between giving the prize for 0
  240. days and 1 days. If a prize is given for 1 day, they will only be given the
  241. prize on the day the contest is reset. If they don't log in that day, they
  242. will lose the prize. If you give the prize for 0 days as a one time prize,
  243. they can pick up the prize at any time.
  244.  
  245.                 Conference Weighting  (registered version only)
  246.  
  247. At times you may want to encourage users to post messages in a conference.
  248. This section will allow you to set "weight" certain conferences heavier.
  249. To do this, first select the conference weighting option. You will then
  250. see a list of your current conference weights.  Pick the conference you
  251. want to change and a window will appear.
  252.  
  253. When asked for the weighting, enter a positive integer value. For example,
  254. 0,1,2,3,4. Values like -1 or 1.2 will not work.  When a user posts a message
  255. in a weighted conference, that message will be multiplied by the weight.
  256. So if the conference weight is 2 and a user posts a message for 10 lines, they
  257. will be credited with 2 messages and 20 lines.
  258.  
  259. You can also use the conference weighting to discourage your users to post
  260. messages in a specific conference. For example, by setting the conference
  261. weight to "0", you will be essentially making any message posted in that
  262. conference worthless.   If you have a private mail conference, this is a
  263. good thing to do that conference.
  264.  
  265.  
  266. This option works best when Poster is run in the same directory as your
  267. CONFDESC.DAT which is located in your node home directory.  So, you should run
  268. Poster from your node home directory but its NOT necessary.
  269.  
  270. CAVEATS!
  271.  
  272. Poster has limits of about 32,000 messages and lines by a single user. I
  273. recommend that the conference weighting set no larger than 2 possibly 3.
  274.  
  275. Also, be careful about setting too many conferences to zero. Your users will
  276. get discouraged if every conference they post in starts to not count.
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.                     Excluding Users And/Or Security Levels
  333.  
  334. If you want to exclude certain users (like sysops) and/or certain security
  335. levels (important on a TNET system), Poster offers a way to exclude users and
  336. security levels. This option will give you a screen with 15 blanks that you
  337. can use to exclude users and security levels in the following fashion.
  338.  
  339. For example, If I wanted to exclude Bill Bolden, David Waldrop and any user
  340. with the SYSOP security level I would add the following lines...
  341.  
  342. BILL BOLDEN
  343. DAVID WALDROP
  344. SYSOP
  345.  
  346. Order does not matter in the file. Messages for any excluded user or excluded
  347. security level will not be counted.
  348.  
  349.                          Register Your Copy of Poster
  350.  
  351. Use this option, to register your copy of Poster AFTER you have received
  352. your code from us.
  353.  
  354.                         Multinode System use of Poster
  355.  
  356. If you are running on a Multi-Node system, you will need to read the activity
  357. logs from all nodes using POSTER FILENAME.EXT /R over and over until all logs
  358. are read.  For example on a 4 node system, you would add the following lines
  359. to your event batch file...
  360.  
  361. POSTER ACTIVITY.001 /R
  362. POSTER ACTIVITY.002 /R
  363. POSTER ACTIVITY.003 /R
  364. POSTER ACTIVITY.004    <───┐
  365.  ┌─────────────────────────┘
  366.  │
  367. Notice that the final call to POSTER doesn't have the /R switch.  This will
  368. mean that the bulletins will be written. You could write the bulletins after
  369. reading each node but that would slow the process down considerably.
  370.  
  371. You can use Wildcards also. For example, you could also use
  372.  
  373. POSTER ACTIVITY.00? and accomplish the same goal.
  374.  
  375.                       Using POSTER on Large Activity Logs
  376.  
  377. It is suggested that you delete your activity logs after they are read by all
  378. your statistics programs like WCPRO and POSTER.  Poster will run much faster
  379. if you do this but its not necessary.  There is an option in POSTER CONFIGURE
  380. that allows you to read either the WHOLE log or YESTERDAY's data.  If you
  381. delete your logs daily, set the option to read the WHOLE log before you
  382. perform the deletion. However, if you don't delete your activity logs, set
  383. this option to read YESTERDAY's data. Its important that you run your event at
  384. about the same time every day to be sure you don't miss messages using this
  385. method.
  386.  
  387. Here is a quick tip that will let you keep all your logs while still while
  388. still being able to delete your main activity.XXX on a daily basis. On Crown
  389. Jewel BBS, we have a file called ACTIVITY.OLD. In our nightly event, we have
  390. the following lines...
  391.  
  392. COPY ACTIVITY.OLD + ACTIVITY.001
  393. DEL ACTIVITY.001
  394.  
  395. So we have one big file called ACTIVITY.OLD that has all our old data.
  396.  
  397.  
  398.                                 Using Templates
  399.                                ─────────────────
  400.  
  401. NOTE: This is a registered user only option.
  402.  
  403. Some people may be less than thrilled with my ability to draw ANSI screens. To
  404. allow sysops to create their own ANSI screens in place of Poster's internal
  405. bulletins, you can create templates that Poster will use. You can create any
  406. bulletin you wish with these templates.
  407.  
  408. First of all, the templates can only be made for the TopTen bulletin and the
  409. winners bulletin. The template for the top ten bulletin is PTEMPLAT.001. To
  410. create a template, you first draw our ANSI screen using '@' color codes using
  411. any one of the many drawing programs for Wildcat! screens. YOU CAN'T have ANSI
  412. codes in your template. Poster must know where to put the information, so the
  413. following "@" codes are available. They are all replacement type codes that
  414. will take up the exact amount of space both in the template and the final
  415. product. Some of the codes act differently depending on the bulletin so be
  416. careful.
  417.  
  418.                       @ Codes Available in the Templates
  419.                      ────────────────────────────────────
  420.  
  421. @PLACEx    @: This code is replaced by the user who is in place x and the
  422. number of messages the user has posted seperated by .... to fill the space
  423. between the two @ marks. This may sound complicated but here is an example...
  424.  
  425. @PLACE1          @  would be replaced by  ....
  426. @Bill Bolden....50
  427.  
  428. Note the information filled the space between the two @'s. You can put these
  429. two @'s any distance apart and the program will fill the space between them.
  430. This makes editing the bulletin easy because you KNOW what space is going
  431. to be used. NOTE: you should seperate the two @'s so that there is enough
  432. room to put a name and a number of messages.
  433.  
  434. @NAMEx   @: This is similar to the above but it simply puts the name of the
  435. person in the xth place in between the two @ marks. Once again, you should
  436. seperate the two @'s so that a name can fit.
  437.  
  438. @MSGSx   @: This is the number of messages posted by the user in place x. This
  439. would usually be used in conjunction with the @NAMEx   @ and offers a little
  440. more flexibility than the PLACE.
  441.  
  442. @TOTALINE@: This is the total number of lines posted by all users. No extra
  443. spaces should be added and the data will overwrite this code completely.
  444.  
  445. @TOTALMSG@: This is the total number of messages posted by all users. Once
  446. again, no extra spaces should be added and the data will overwrite this code
  447. completely.
  448.  
  449. @LAST#1   @: This will be replaced by the name of the person who was first
  450. place last period. It shouldn't be used in the winners bulletin and you can
  451. seperate the @'s by any distance BUT (I'm sure you know the melody by now),
  452. you should leave enough seperation for a name to fit into.
  453.  
  454. @COPYWRITE@: This needs to be at the beginning of one line. On that line, the
  455. copywrite along with your registration will be displayed. Nothing else needs
  456. to be on this line. If you leave this out, Poster will add it automatically.
  457. You DON'T have to add a copywrite to the winners bulletin but you can if you
  458. wish.
  459.  
  460. If you use a template, the configuration options that allow you to add a
  461. header and a footer are not used.
  462.  
  463.  
  464. A file called TEMPLATE.SMP is included with the .ZIP. This file is a sample
  465. template that is similar to the internal bulletin created by Poster on a daily
  466. basis. If you were to rename this file to PTEMPLAT.001, Poster would not use
  467. its own internal bulletin. It would use the template which you can change any
  468. way you want.
  469.  
  470.                              Files used by Poster
  471.  
  472. POSTER.EXE - The main executable.
  473. POSTER.DAT - (DATA) The file that contain's the user's totals. Delete this
  474.              file to reset the contest. The reset is done automatically on the
  475.              reset day.
  476. POSTER.CFG - (CONFIGURATION) The configuration file for Poster. This file
  477.              must be present for Poster to run.
  478. POSTER.EXC - (CONFIGURATION) The list of excluded users and security levels.
  479. POSTER.WGT - (CONFIGURATION) The data file containing the conference weights.
  480.              Erase this file to reset all conference weights to 1.
  481. PTEMPLAT.001 - The template for the top ten bulletin.
  482. PTEMPLAT.002 - The template for the end of period bulletin.
  483.  
  484.  
  485.  
  486.                         What happens on the reset day?
  487.                        ────────────────────────────────
  488.  
  489. On the reset day, POSTER will create a special bulletin that lists all your
  490. winners for the previous period. If you are running a registered version of
  491. Time Door, it will then award special POSTER time prizes. The user will need
  492. to go into Time Door to pick up their prize. Upon thier entry into Time Door,
  493. Time Door will congratulate them for their posting and give them their prize.
  494. You can create special screens to send your users when they pick up their
  495. prize.  Simply create a file called POSTERXX.BBS where XX is the place in the
  496. top ten.  The file must be ASCII (NO ANSI is ALLOWED) and it must reside in
  497. the Time Door directory.  For example, if you wanted to create a screen to
  498. send to the top poster, create an ASCII file called POSTER1.BBS. You can
  499. create one for every place if you want. In most cases, the message that Time
  500. Door sends should suffice.
  501.  
  502. If you run a weekly or bi-weekly contest, the reset day will change in order
  503. that Poster can keep track of when it should reset the contest. If the contest
  504. is a monthly contest, the reset date will not change.
  505.  
  506.                                  RIP Graphics
  507.                                 ──────────────
  508.  
  509. Under general settings, you can turn on RIP graphics which means that Poster
  510. will create RIP versions of every bulletin. Those bulletins will be like the
  511. .BBS bulletin with a .RIP extension. RIP graphics require that I have a
  512. general idea of where they will end up on a system so I can program the proper
  513. look and feel. Because of this, if you are going to put the bulletins in
  514. different places, you should consider not using .RIP graphics. I have assumed
  515. that the daily and winners bulletin will be a log-in type bulletin and that
  516. the big bulletin (complete posting list) would be put on the bulletin menu.
  517. Future versions of Poster should support RIP templates so you can create your
  518. own rip screens with your own look and feel.
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.               ┌────────────────────────────────────────────────┐
  531.            ┌──┘                                                └──┐
  532.            │   Hints on Running a Successful Top Poster Contest   │
  533.            └──┐                                                ┌──┘
  534.               └────────────────────────────────────────────────┘
  535.  
  536. We have been running various version of POSTER for three years on Crown Jewel
  537. BBS.  It has worked very well at times and has caused us a few head aches at
  538. other times.  Here is what we learned
  539.  
  540. 1) Give the program time to do its thing. At first, your users may have no
  541.    idea what the top posters list is. After a while, they will get the idea
  542.    and start competing.
  543. 2) Don't exclude heavy posters. Whenever you get a user who does well on a
  544.    monthly basis, you may be tempted to exclude that user. Often the good user
  545.    will ask to be removed from the list because your Top Posters tend to be
  546.    your better and more humble users. Don't exclude your heavy posters!  If
  547.    you do this, you will lower the goal your other users are trying to reach.
  548. 3) Keep the contest positive. This is very important! This program creates the
  549.    exact opposite mood of programs like the ones that list users that drop
  550.    carrier. If you treat this contest in an uptight manor, it will not work.
  551.    This program uses positive reinforcement.
  552. 4) At times, some users will post small and stupid messages to get higher on
  553.    the contest. Our experience shows that if you crack down on this, the
  554.    users will quit posting altogether. If you ignore it, it usually stops.
  555.    However, you always have the POSTER EDIT option if you want to take those
  556.    messages off.
  557. 5) Set the program up and forget about it. It is meant to work on its own
  558.    without your intervention.
  559.  
  560. We have followed these guidelines and the Top Poster List has helped our
  561. small system have an active message base. It can do the same for you.
  562.