home *** CD-ROM | disk | FTP | other *** search
/ The Arcade BBS / arcadebbs.zip / arcadebbs / BBSVERSE.ZIP / TODAYBBS.DOC < prev    next >
Encoding:
Text File  |  1988-08-02  |  8.3 KB  |  176 lines
  1.                             TODAYBBS
  2.                         by Michael Conley
  3.  
  4.                        Release 1.50 8/01/88
  5.  
  6. This  program determines the current date, then reads data  files 
  7. containing  historical facts and produces a file  of  interesting 
  8. information about the current date.  It is intended for use in  a 
  9. BBS  system  where the file can be created as a part of  a  daily 
  10. maintenance routine.
  11.  
  12. NEW FEATURES/CHANGES:
  13.  
  14. Beginning with version 1.50, TODAYBBS will optionally output a
  15. second file with ANSI color escape sequences included.  This has
  16. required a change in the configuration file, TDCONFIG.DAT, adding
  17. a seventh line which is the name of the color file (Wildcat! users
  18. might want to call the ANSI file HELLO3.SCR and the ASCII file 
  19. HELLO3.BBS, so the selection will follow the user's choice of 
  20. whether to use ANSI display files where available.  If you're 
  21. upgrading from 1.40, you must add the name of the COLOR file as
  22. the 7th line of the TDCONFIG.DAT file, or place the word NONE there
  23. if you don't want to make a color file.  The ASCII file is always
  24. generated when the program is run.
  25.  
  26. Beginning with version 1.40, TODAYBBS will read optional header
  27. and tail file(s) and place their contents before (or after) the
  28. program's output.  In order to use this feature, you need to place
  29. either one or both files in the SAME directory with your TODAY.XXX
  30. monthly data files.  A file named TDHEADER.DAT will be placed at the
  31. front of the output file, and a file named TDTAIL.DAT will be added
  32. to the end of the output file.  You may use any combination of these
  33. files ... none, either, or both.
  34.  
  35. Beginning with version 1.30, TODAYBBS will read a file created just
  36. for your system, called "TODAY.LCL" and placed in the same path as
  37. the other TODAY.xxx files.  Only one file is allowed, but entries 
  38. for the entire year may be included by following the format of the
  39. sample file.  In this way, you may "customize" your display with any
  40. special events or reminders you desire, without having to edit the
  41. monthly files.
  42.  
  43. If TODAY.LCL is found, its entries will be read and displayed on the
  44. appropriate dates as the first entries in each of the categories. If
  45. the file is not present, it will be skipped.
  46.  
  47.  
  48. NOTE ON UPGRADING:
  49.  
  50. If you are already running TODAYBBS and are converting to the new
  51. version, you MUST make a change in the TDCONFIG.DAT file.  Line 7
  52. has been added (see sample below or use the included sample file in
  53. this archive.)  This is the name of the ANSI COLOR output file, or
  54. if you don't want a color file, line 7 must be the word NONE.
  55.  
  56. Because the WILDCAT! software changed its data structure with the
  57. release of version 1.12, TODAYBBS needs to know WHICH VERSION of 
  58. WILDCAT! you are running.  We suggest that you replace your 
  59. TDCONFIG.DAT file with the new one included in this distribution, 
  60. and edit it to suit your needs, paying particular attention to 
  61. the entry on line 3, the version.
  62.  
  63. As distributed, release 1.50 supports WILDCAT! versions from 1.03
  64. through 1.12.  If you have an earlier version, check with Mustang 
  65. Software about upgrading your WILDCAT!  If you receive a later 
  66. version, you may test TODAYBBS to see if it's compatible.  Place 
  67. the new version number in the TDCONFIG.DAT file.  If the structure 
  68. of the USERINFO file has NOT changed, this will continue to work.  
  69. If it HAS changed, the program will simply not report users' 
  70. birthdays.  Whenever a change takes place, we'll plan on issuing 
  71. an update to TODAYBBS to cover the new version of WILDCAT!
  72.  
  73.  
  74. SETTING UP:
  75.  
  76. The only elements that need to be set up to operate this  program 
  77. are  the  TODAY.LCL file and the TDCONFIG.DAT  file.  This file MUST 
  78. be  located  in  the currently  logged directory whenever TODAYBBS is  
  79. executed.   The first seven lines of the file define the operating 
  80. parameters,  and the  FORMAT MUST BE FOLLOWED EXACTLY.  A sample 
  81. of this  file  is included here for your convenience.   
  82. Remember  to use  an editor which will NOT include any special 
  83. formatting characters, as some word processing programs may do.
  84.  
  85.  
  86. C:\TODAY\
  87. Charlatan's Cabin
  88. 1.12
  89. Y
  90. C:\WILDCAT\USERINFO.DAT
  91. C:\WILDCAT\DISPLAY\HELLO3.BBS
  92. C:\WILDCAT\DISPLAY\HELLO3.SCR
  93. ;
  94. ;
  95. ;Line 1 is the full drive and path name where the "TODAY.xxx" files are kept.
  96. ;Line 2 is the name of the BBS as you would like it to appear in the output.
  97. ;Line 3 is the Wildcat! version number you are running.  Data files have
  98. ;       changed format from time to time, and this information is necessary
  99. ;       to allow the program to access Wildcat! data files properly.
  100. ;
  101. ;IMPORTANT:  If you are NOT using Wildcat! and wish to run this program
  102. ;            you may do so by placing an uppercase N on line 3.
  103. ;    
  104. ;Line 4 is either Y or N to indicate whether Users' birthdays (without
  105. ;       the year) should be included in the output file.  It works ONLY if
  106. ;       used in a WILDCAT! system.
  107. ;Line 5 is the full drive and pathname to the WILDCAT! user information file,
  108. ;       usually USERINFO.DAT.
  109. ;Line 6 is the full drive and pathname for the program ASCII output file.  
  110. ;       If used with WILDCAT! we suggest using  C:\WILDCAT\HELLO3.BBS  
  111. ;    (substituting the appropriate path name if different) so that 
  112. ;    the file is displayed automatically at the end of your signon 
  113. ;    sequence.
  114. ;Line 7 is the full drive and pathname for the program ANSI output file.
  115. ;       If used with WILDCAT! we suggest using  C:\WILDCAT\HELLO3.SCR
  116. ;    (substituting the appropriate path name if different) so that 
  117. ;    the file is displayed automatically at the end of your signon 
  118. ;    sequence.  If you DO NOT WISH to create an ANSI file, place the
  119. ;    word  NONE  on line 7.
  120. ;    
  121. ;
  122. ;IMPORTANT:  All lines must be included in the file. Obviously certain
  123. ;          combinations will not utilize all of the lines, but they are
  124. ;         read by the program and tested before the program creates the
  125. ;         output file and must conform to the above specifications even
  126. ;         if not used!  The notes after the last line are not required
  127. ;         and may be deleted, but they will not cause a problem.
  128. ;
  129. ;THIS FILE must reside in the currently logged path (directory) when the
  130. ;program (TODAYBBS) is called.
  131.  
  132. TESTING:
  133.  
  134. To test the program, simply type TODAYBBS<enter> and the output
  135. file you have named in the TDCONFIG.DAT file will be created or
  136. overwritten if it already exists.
  137.  
  138. You may wish to test various dates.  For convenience, TODAYBBS 
  139. will accept dates from the command line.  Since the year is not
  140. used, enter the date as 4 digits in the form:  MMDD.  Leading
  141. and internal zeroes must be used, e.g., TODAYBBS 0307<enter>
  142. will produce a file from the information located for March 7.
  143.  
  144. OPERATION:
  145.  
  146. If your BBS has a provision for automatic daily maintenance, such
  147. as the WILDCAT! program by Mustang Software, include the following
  148. line(s) in the maintenance batch file, and schedule it to run as
  149. soon as possible after midnight:
  150.  
  151. CD \WILDCAT   <--- You should change this to the directory where 
  152.                    TDCONFIG.DAT will be located.
  153. TODAYBBS      <--- Next, execute the program, which will get the
  154.                    date from the system clock and produce the 
  155.                    output file(s) as specified in TDCONFIG.DAT.
  156.  
  157. SPECIAL NOTE:
  158.  
  159. This program uses data files which are based on a data format and 
  160. content used by Patrick Kincaid in his program TODAY-PC.  
  161. The files were updated and revised when this program was released, 
  162. and will no doubt be updated and revised further as users run these 
  163. programs, and as history marches on.  The files are available 
  164. separately as TODAYDAT.ARC, and are periodically updated.  In
  165. addition, other sources produce data files compatible with this
  166. format, and you may wish to merge them into these files.  A word
  167. of warning:  Avoid duplication, or both entries will be displayed
  168. in your output file.  Also, be cautious about SORTING the new entries,
  169. as the SORT routine may be confused by the sequence of some of the
  170. multiple line entries in these or other data files.
  171.  
  172. Comments and suggestions are invited.  Please leave electronic
  173. mail to Michael Conley, SYSOP of the Charlatan's Cabin, at 
  174. (213) 654-7337, or on CompuServe EMail address 70250,220.
  175.  
  176.