home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DTRAK16.ZIP / DOORTRAK.DOC < prev    next >
Encoding:
Text File  |  1993-04-05  |  8.5 KB  |  180 lines
  1.                             Door Usage Tracker
  2.                                 Version 1.6
  3.                          Release Date: Nov 11, 1992
  4.  
  5.                   A Door Usage Bulletin Generator for Spitfire
  6.   
  7.                             (c) WidowWare, 1992
  8.                          Written By Gary Goldstein
  9.  
  10. Disclaimer: Every effort has been made to debug this  utility.  However,
  11.             should one of those little critters be found, please contact 
  12.             the author so that it may be exterminated.
  13.  
  14.             This program is considered Shareware. That is, try it before
  15.             you buy it.  If  you like it and want to contribute  to  the
  16.             author's starving family, then please send the $5.00 
  17.             registration fee to the address on the registration form.
  18.             More on the registration later.
  19.  
  20. Program Description:
  21. -------------------
  22. This program will generate a bulletin for you letting you and your callers
  23. know how many times your doors are played.  It will allow you to define up 
  24. to 32 doors to report on. It will even allow you to select doors which are
  25. run from the SFEXTMNU.BAT extension in your doors section.
  26.  
  27. Set Up:
  28. ------
  29. You can place the program anywhere you like on your hard drive.The command 
  30. line will direct the program to the files it needs. There  are  two files,
  31. which must be in the same directory as  the main program.  These  are  the 
  32. files called DOORS.DAT and DOORSTAT.DAT. More on these later.
  33.  
  34. Command Line usage is:
  35. ---------------------
  36.     DOORTRAK <Callers.log file location> <Name of bulletin to be generated
  37.                                             (without extension name)>
  38.  
  39. Thus, as an example...
  40.  
  41.     DOORTRAK c:\sf\work\callers.log bullet6
  42.  
  43. will  tell the program to use the Callers.log file found in the c:\sf\work
  44. subdirectory  and generate the files BULLET6.CLR and BULLET6.BBS.  You can
  45. then move the  bulletin files wherever  you want or you  can even  specify
  46. where to generate  the bulletins directly.  Do not specify file extensions
  47. for the bulletin names as this utility will generate an ANSI bulletin with 
  48. the extension of .CLR and an ASCII bulletin with an extension of .BBS.
  49. This will keep in line  with the file extensions used by  Spitfire for the
  50. display of bulletins.
  51.  
  52. So,
  53.  
  54.    DOORTRAK c:\sf\work\callers.log c:\sf\display\bullet6 
  55.  
  56. will also work just fine (notice the bulletin path).
  57.  
  58. You MUST, however, specify the 2 required parameters otherwise the program
  59. will not even attempt to run.
  60.  
  61. If  you want to build the bulletin for the past month... simple. Specify a 
  62. file such as JAN92.LOG as your CALLERS.LOG  file and DOORTRAK will do  the 
  63. rest. You may run the program daily as the program will keep track of  the 
  64. last date it read and pick up only information from subsequent dates.
  65.  
  66. Important Note!!  Once you have run the program, do not attempt to run the 
  67. program using a prior month's backup file as, if you will remember, the 
  68. program keeps track of the last date it read. If you try to use a file 
  69. containing only records for dates earlier than the date it has saved, it 
  70. will return "No records found".
  71. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  72.  
  73. Required Files:
  74. --------------
  75. DOORSTAT.DAT - This file will be created by the program as in it are stored
  76.                the cumulative totals for each door. If you delete this file
  77.                then the program will start to accumulate the totals from
  78.                scratch.
  79.  
  80.                If you get a 'Corrupt Summary file' error, you can always go
  81.                into this file using any good ASCII editor and edit the file
  82.                to your liking.  The program will convert these numbers into
  83.                a form that it can use.
  84.  
  85. DOORS.DAT    - This is a file YOU must create. In it you define the doors
  86.                you want reported on. Follow the example shown below. This
  87.                file can be created with any text editor / processor.
  88.  
  89.                Each line of this file must contain the following information
  90.                in the exact order and format displayed here. You may only
  91.                enter 32 lines. Any more will simply be ignored by the
  92.                program.
  93.  
  94.                (I have provided a sample DOORS.DAT file for you to examine
  95.                 or just tailor it for your own BBS).
  96.  
  97.                A,B,Trade Wars 2002
  98.                ^ ^    ^
  99.                | |    |______ The Name of the door (22 character maximum)
  100.                | |___________ The letter of the door
  101.                |_____________ The letter of the door extension
  102.  
  103.                Now, for the explanation. The first letter represents the door
  104.                extension menu letter if you use it. So, if you are running
  105.                an SFMNUEXT.BAT from Door A, you would place the 'A' here. The
  106.                next letter represents the door letter the game will be run
  107.                under IF run under the 'A' door extension. Thus, if your Trade
  108.                Wars game is run from Door 'B' under Extension 'A', your first
  109.                line would look like the above example. I hope this is clear.
  110.                If not, feel free to log on to my board to get an idea of what
  111.                I'm talking about as I run an extension under Door A.
  112.                
  113.                { Spitfire is generally thought to be limited to using only 22
  114.                doors.  However, with the door extension menus, you can run 22
  115.                doors  under each extension. Thus, your doors are virtually
  116.                unlimited. (I dont think there are that many door games in
  117.                existence - are there?).}
  118.  
  119.                What do I do if I am not running door extensions?
  120.                Simple. Put a '0' where you see the 'A' in the example and the
  121.                program will simply ignore the extension and treat the door
  122.                you describe as being from the main door menu.
  123.  
  124. Important!     The positions of the letters and the commas are critical to
  125.                proper operation of the program. You will have 'unpredictable'
  126.                results otherwise.
  127.  
  128.                However, you may place your door definition lines in any order
  129.                you wish within DOORS.DAT. If you'd like to alphabetize them,
  130.                then feel free to. 
  131.  
  132. Important!     You must remember, however, that once you start the program
  133.                you cannot change the order of the door names within 
  134.                DOORS.DAT. You can only do this if you delete your 
  135.                DOORSTAT.DAT file and start over.
  136.  
  137.                I am not too sure if the program will report properly using
  138.                3rd party programs like Wildfire as I do not know what kind
  139.                of information they write to the callers log.
  140.  
  141.                   
  142. Multiple Log Files (Registered version only):
  143. ---------------------------------------------
  144. Ah, here is where the beauty of the program becomes apparent. You may use
  145. as many previous log files as you wish to accumulate data with. HOWEVER,
  146. you must also remember that the log files must be read into the program in
  147. chronological order otherwise the program will return "No new records
  148. found." Remember, it keeps track of the date it last read. Of course, if
  149. you know what you are doing, you could always edit the DOORSTAT.DAT file
  150. but I've found that it's more trouble than it's worth.
  151.  
  152. Limitations:
  153. -----------
  154. The only limits here are the lengths of the parameters. As of now, the input
  155. parms are set to a 30 character maximum. However, when (and if) you register,
  156. I can modify that to whatever you need. Also, you must limit the name of the
  157. door within the DOORS.DAT file to 22 characters. You can use more but the 
  158. program will only read the first 22.
  159.  
  160. That's all there is to it. If you have any questions about the program,
  161. feel free to leave me a note on my board.
  162.  
  163. Registration:
  164. ------------
  165. Oh, yes. One more thing. The registration. It's only $5 to register the
  166. program and  this will get a 'customized' version for use  strictly  on 
  167. your BBS. It will also allow you to input as many log files as you wish. 
  168. In the unregistered version, the totals will be zeroed out whenever the 
  169. month changes.
  170. (Well, I had to do SOMETHING to entice you to part with $5.00 didn't I??).
  171.  
  172. You may send in your reg form to the address on the reg form.
  173.  
  174. Feel free to contact me with any problems you are having at my BBS,
  175.  
  176. Thanks for trying it.  Gary.
  177.  
  178. The Spider's Web
  179. 702-647-5989
  180. USR HST Dual standard, 24hrs / 7 days