home *** CD-ROM | disk | FTP | other *** search
/ The Devil's Doorknob BBS Capture (1996-2003) / devilsdoorknobbbscapture1996-2003.iso / Dloads / SYSOP / CGSS300.ZIP / CGSS300.DOC < prev    next >
Text File  |  1993-11-09  |  15KB  |  352 lines
  1.                Caller Greeting & System Statistics v3.00
  2.                  Copyright (C) David Stidham 1992-1993
  3.                           All Rights Reserved
  4.  
  5.  
  6. OVERVIEW:
  7.         Caller Greeting & System Statistics for WWIV bulletin board
  8. systems (hereafter referred to as CGSS) is a means of providing a colorful
  9. greeting to the caller and allowing him/her the option of view some of the
  10. systems more interesting statistics.
  11.  
  12.         CGSS is a configurable logon event that offers the following
  13. areas for the user to view:
  14.  
  15.                 o Random Greetings
  16.                 o System Bulletins
  17.                 o Today's System Statistics
  18.                 o Past Thirty Days Statistics
  19.                 o Top Ten Users in Eight Categories
  20.                 o Their Account Statistics
  21.                 o Show Network Statistics (if applicable)
  22.  
  23. You may elect to offer one, some, or none of the above for user display.
  24. If you opt for none, the program will merely greet the user with the
  25. time and day of their call and their particular caller status.  Each
  26. feature is covered in detail later.
  27.  
  28.  
  29. REQUIREMENTS:
  30.         CGSS v3.xx requires WWIV v4.22 (or later) and NET32 (or later)
  31. to operate.  CGSS requires approximately 92Kb for storage and 130Kb RAM.
  32. CGSS creates two support files;
  33.                 CGSSBULL.DAT (6400 bytes)
  34.                 CGSSLAST.DAT (6 bytes)
  35.  
  36.  
  37. INSTALLATION:
  38.         Installation as a Logon event:
  39.  
  40.                 1) Quit your BBS to DOS.
  41.                 2) Have a copy of CGSS300.EXE, CGSS.CFG, and CGSSGRT.TXT
  42.                         in your BBS directory.
  43.                 3) Execute the WWIV INIT.EXE program.
  44.                         a) Enter area 6.
  45.                         b) Supply "CGSS300.EXE %1" for the Logon Event.
  46.                         c) Exit the INIT.EXE program.
  47.                 4) Bring the BBS back up again.
  48.  
  49.         Installation as a Door/Chain:
  50.  
  51.                 1) Have a copy of CGSS300.EXE, CGSS.CFG, and CGSSGRT.TXT
  52.                         in your BBS directory.
  53.                 2) Bring the BBS up.
  54.                 3) Enter the CHAINEDIT menu.
  55.                         a) Create a new entry.
  56.                         b) Enter the following data:
  57.  
  58. A. Description  : Caller Greeting & System Statistics v3.00
  59. B. Filename     : CGSS300.EXE %1
  60. C. SL           : *
  61. D. AR           : *
  62. E. ANSI         : Optional
  63. F. DOS Interrupt: Used
  64. G. 300 Baud     : Allowed
  65. H. Shrink       : No
  66. I. Disable pause: *
  67. J. Local Only   : No
  68.  
  69. (* = your choice)
  70.  
  71.                 4) Exit the CHAINEDIT menu.
  72.  
  73.  
  74. CONFIGURATION:
  75.         Following is a sample configuration.  The file CGSS.CFG is
  76. identical to this example.  You will need to edit the file to reflect
  77. your system configuration and operational preferences.
  78.  
  79. --- Sample Configuration file ---
  80. John Q. Sysop
  81. 123456789
  82. 1
  83. 1
  84. 1
  85. 1
  86. 1
  87. 1
  88. 1
  89. 1
  90. 1
  91. C:\BBS\NEWS.TXT
  92. ---------------------------------------
  93. Line 1  : Your name as it appears on registration form.
  94. Line 2  : Your registration code as it appeared on registration card.
  95.                 Case Sensitive!
  96. Line 3  : Use random greeting strings (True = 1 / False = 0)
  97. Line 4  : Show users system bulletins (True = 1 / False = 0)
  98. Line 5  : Show users today's system statistics (True = 1 / False = 0)
  99. Line 6  : Show users past 30 days stats (True = 1 / False = 0)
  100. Line 7  : Show users top 10 user categories (True = 1 / False = 0)
  101. Line 8  : Show users their account statistics (True = 1 / False = 0)
  102. Line 9  : Show users network statistics, if applicable (True = 1 / False = 0)
  103. Line 10 : Allow #1 user (sysop) into top 10 lists (True = 1 / False = 0)
  104. Line 11 : Allow all 255 SL holders into top 10 lists (True = 1 / False = 0)
  105. Line 12 : Full path/file name for system news.
  106. --- End Sample Configuration file ---
  107.  
  108.         You are allowed 40 charactes for your Sysop Name, I doubt that
  109. many people will exceed this length (not to mention that WWIV doesn't
  110. support a length greater than 40 characters).  The path/file name
  111. information for the System News is limited to a length of 80 characters.
  112. Again, I don't think many people will exceed this limit.
  113.  
  114.         The configuration file contains the supplemental lines following
  115. the path/file name for the system news (line 11) merely as an aid for
  116. you.  These additional lines are not required and may safely be deleted
  117. should you decide you do not need them.
  118.  
  119.  
  120. DATA TABULATION:
  121.         There are two areas that require data to be read and tabulated.
  122. Today's System Statistics and Top Ten Users listing.  If a user enters
  123. either area, there will be a small delay while data is read from the
  124. files and tabulated.  Once this has been done, it isn't required again.
  125. So, if the user were to enter both areas, that user would only be
  126. delayed once, for the first area selected.  This one time collection and
  127. tabulation of data provides the program with the fastest overall
  128. operational time, and still provide the user with the most current data
  129. in these two areas.
  130.  
  131.  
  132. RANDOM GREETINGS:
  133.         The file CGSSGRT.TXT is an ASCII text file that contains the
  134. greeting strings for the random greetings portion of the program.  If
  135. you elect to disable this feature, you will not need this file.
  136. However, if you enable this feature, the program will search for this
  137. file in the main BBS directory.  If this file is not found, then CGSS
  138. will print the same default greeting each time it is executed.
  139.  
  140.         The format for CGSSGRT.TXT is simple.  The first line is a
  141. numeric value that corresponds the number of strings within the file.
  142. The file enclosed with the package has 15 strings, total, so line 1 is
  143. "15".  The file is straight ASCII text and can be maintained with your
  144. favorite full screen editor.  The file can support WWIV color code use.
  145.  
  146.  
  147. SYSTEM BULLETINS:
  148.         The system bulletins area supports up to forty bulletin entries.
  149. Each entry can be configured in the following ways:
  150.  
  151.                 o Minimum SL
  152.                 o Maximum SL
  153.                 o AR
  154.  
  155. If a user matches the defined parameters, then they will be able to view
  156. the bulletin.  A bulletin may be toggled as a required read, and ALL
  157. users that match the parameters for viewing will be required to read the
  158. bulletin.  Each bulletin is an ASCII text file that you create with your
  159. favorite full screen editor.  It is recommended that each line be no
  160. longer than 79 characters.  Other than this recommendation, there are no
  161. special format requirements for the bulletin files themselves.  They may
  162. include WWIV color codes to add some flair.
  163.  
  164.  
  165. SYSTEM NEWS FILE:
  166.         The System News file is an ASCII text file that has one small
  167. format requirement; each entry is preceeded by the "date" for the entry
  168. and starts on a new line.  The date MUST be eight characters long and be
  169. preceeded by a tilde (~ - ASCII code 126).  The following is a sample of
  170. two entries:
  171.  
  172. --- Begin Sample ---
  173.  
  174. ~01/01/93
  175.         Greetings!  This is a sample entry in the NEWS.TXT file.  This
  176. would be for January 1, 1993.
  177.  
  178. ~12/31/92
  179.         This, too, is a sample entry in the NEWS.TXT file.  While the
  180. date is chronologically earlier than the first entry, it doesn't have to
  181. follow.  It could be the first entry and the newer entry could be
  182. following.
  183.  
  184. --- End Sample ---
  185.  
  186.         You can use any full screen editor to create and maintain the
  187. file.  WWIV color and centering codes are supported.  The order for the
  188. entries is up to you.  I tend to place newer entries to the beginning of
  189. the file, as the sample illustrates, however, you can place the newer
  190. entries at the end of the file.  The sequence is up to you, although,
  191. with the newer entries toward the beginning of the file, the search for
  192. new news is performed a little faster.
  193.  
  194.  
  195. TODAY'S SYSTEM STATISTICS:
  196.         This feature will display the statistics for the system for that
  197. particular day.  The user is presented with the following statistical
  198. information:
  199.  
  200.                 o Version of WWIV in operation
  201.                 o Registration number of WWIV (if registered)
  202.                 o Activity for the day (hours/minutes and percent)
  203.                 o Number of Messages
  204.                 o Number of EMails
  205.                 o Number of Feedbacks
  206.                 o Number of Uploads
  207.                 o Number of Calls
  208.                 o Last date BBS ran
  209.                 o Last date GFiles updated
  210.                 o Total calls to date
  211.                 o Total Male users
  212.                 o Total Female users
  213.                 o Average age of user
  214.                 o Total Users
  215.                 o Configured maximum user slots
  216.                 o External event trigger time (if configured for one)
  217.                 o Network traffic window (if configured for one)
  218.                 o Sysop Availability window (if configured for one)
  219.  
  220.  
  221. PAST THIRTY DAYS STATISTICS:
  222.         This is merely a colorized version of the internal WWIV ZLog
  223. information, with the exception that it will only display thirty days
  224. worth of information.
  225.  
  226.  
  227. TOP TEN USERS:
  228.         This covers eight different categories:
  229.  
  230.                 o Posters                       o E-Mailers
  231.                 o Callers                       o Time Online
  232.                 o Uploaders (Files)             o Uploaders (KB)
  233.                 o Downloaders (Files)           o Downloaders (KB)
  234.  
  235.  
  236. USER ACCOUNT STATISTICS:
  237.         This will display nearly ALL the user account variable values.
  238. If you don't require your users to supply you with their address or
  239. their data phone line, then these lines will remain blank, however, the
  240. field identifier will still be displayed.  Moreover, there are a few
  241. fields that were introduced in WWIV v4.22 that aren't utilized until
  242. v4.23, so these areas won't change and they are numerical in nature.
  243.  
  244.  
  245. NETWORK STATISTICS:
  246.         This is a more detailed version of the internal WWIV Pending
  247. command.  If your system isn't involved in a WWIVnet type network, then
  248. this area isn't available regardless of your enabling the feature in the
  249. configuration.
  250.  
  251.  
  252. FULL SCREEN EDITOR:
  253.         Each text file described above can be maintained with WWIVEdit,
  254. and if you wish to use WWIV color and centering codes, WWIVEdit is a
  255. logical choice.  However, any full screen editor can be used, and you
  256. can manually embed the WWIV color and centering codes yourself.  The
  257. centering code is ASCII code 2 (the solid smiling face), and each of
  258. the WWIV color codes is preceeded by ASCII code 3 (the solid heart) and
  259. then the numeric value of the color code itself (0-7 for WWIV v4.22 or
  260. 0-9 for WWIV v4.23+).
  261.  
  262.         One note on use of WWIVEdit, however, and that is for lengthy
  263. files (such as the system news file), WWIVEdit appears to place an
  264. arbitrary number of blank lines in the file after each load, and reload
  265. of the file.  These blank lines appear following a line that is
  266. "maximum" characters in length (79) and has WWIV color codes in use.
  267. This is in v2.05 of WWIVEdit, and may be corrected with later versions
  268. of this editor.  You can clean these blank lines out manually with
  269. another full screen editor, but, you can not do so with WWIVEdit.
  270. Strange, I agree, but it does happen.
  271.  
  272.  
  273. DISCLAIMER:
  274.         David Stidham makes no warranty of any kind, either expressed or
  275. implied, including, but not limited to, implied warranties of
  276. marchantability and fitness for a particular purpose, with respect to
  277. this software and accompanying documentation.
  278.  
  279.         IN NO EVENT SHALL DAVID STIDHAM BE LIABLE FOR ANY DAMAGES
  280. (INCLUDING DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
  281. INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS)
  282. ARISING OUT OF THE USE OF OR INABILITY TO USE THIS PROGRAM, EVEN IF
  283. DAVID STIDHAM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  284.  
  285.  
  286. LICENCE:
  287.         Caller Greeting & System Statistics is Copyright (C) 1992-1993
  288. by David Stidham.
  289.  
  290.         Caller Greeting & System Statistics is being released as
  291. SHAREWARE.  What this means is that you may "Try before you buy".  You
  292. are granted a period of thirty (30) days to evaluate the program.
  293. After this evaluation period expires, you must either register the
  294. program, or cease to use it completely.  Please see the enclosed
  295. REGISTER.FRM for registration cost information.
  296.  
  297.         Distribution of Caller Greeting & System Statistics is allowed
  298. provided there is absolutely no modification performed on the program
  299. and/or documentation and that no fee is charged for the program.
  300.  
  301.  
  302. REGISTRATION BENEFITS:
  303.         By registering this program you will gain the satisfaction of
  304. doing your part in making the Shareware principle work.  You will also
  305. gain product support, should you encounter any problems with the program
  306. operation.  Lastly, you will be encouraging me to continue development
  307. of this, and other, programs.
  308.  
  309.  
  310. ACKNOWLEDGEMENTS:
  311.         WWIV Copyright (C) by Wayne Bell.
  312.  
  313.         WWIVEdit Copyright (C) by Adam Caldwell.
  314.  
  315.         Turbo Pascal and Borland C++ Copyright (C) by Borland,
  316. International.
  317.  
  318.  
  319. SUPPORT:
  320.         David Stidham may be contacted for support of CGSS by one of
  321. three means:
  322.         (1) US Postal service
  323.                 David Stidham
  324.                 c/o TC Software & Simulations
  325.                 2958 Rockaway Ct. Suite 203
  326.                 Tampa, FL 33610-1468
  327.  
  328.         (2) calling the BBS
  329.                 Ko Ro Ba
  330.                 (813)237-0152
  331.                 PCPursuit [FLTAM]
  332.                 300-19200 v.32/v.32bis/v.42/v.42bis/HST
  333.  
  334.         (3) sending network email over either WWIVNet or IceNET
  335.                 WWIVNet: 1@8350
  336.                 IceNET : 1@8360
  337.  
  338.  
  339. HISTORY:
  340.         v3.00           Written to use a configuration file.
  341.                         Incorporated system news and bulletins.
  342.                         Name shortened from WWIVCGSS to CGSS.
  343.                         Released as Shareware as opposed to Freeware
  344.                           9 NOV 93.
  345.         v2.01           Corrected problem where new WWIV systems to
  346.                           networking were unable to view network
  347.                           statistics.  Released 19 FEB 93.
  348.         v2.00           Written in Borland C++ and released 17 FEB 93.
  349.         v1.00d          Never publicly released.
  350.         v1.00a-c        Written in Turbo Pascal and released during the
  351.                           last quarter of 1992.  Worked with WWIV v4.21.
  352.