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