home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SWAP40.ZIP / HOLIDAYV.DOC < prev    next >
Text File  |  1995-06-01  |  10KB  |  199 lines
  1.                         *****  SWAP v4.0  *****
  2.                               (01 Jun 95)
  3.  
  4.             GOODBYE/HELLO/HOLIDAY Screen Rotator for Wildcat!
  5.  
  6.                         Written By: Terry Atkinson
  7.                                     Adsum Wildcat! BBS
  8.                                     Dartmouth, NS
  9.                                  ====================
  10.                                    SPECIAL DOCUMENT
  11.                             USE OF VARIABLE HOLIDAY LISTS
  12.                                  ====================
  13.  
  14.  
  15. Review of SWAP.CFG (default name)
  16. ==================
  17.  
  18. CONFIGURATION ITEM            COMMENT
  19. ==================            =======
  20. C:\WILDCAT\ROTATE\HELLO\     1'INPUT Path to HELLO.BBS screen (ASCII)
  21. C:\WILDCAT\ROTATE\HELLO\     2'INPUT Path to HELLO.SCR screen (ANSI)
  22. C:\WILDCAT\ROTATE\RIP\       3'INPUT Path to HELLO.RIP screen (RIP)
  23. C:\WILDCAT\ROTATE\GOODBYE\   4'INPUT Path to GOODBYE.BBS screen (ASCII)
  24. C:\WILDCAT\ROTATE\GOODBYE\   5'INPUT Path to GOODBYE.SCR screen (ANSI)
  25. C:\WILDCAT\ROTATE\RIP\       6'INPUT Path to GOODBYE.RIP screen (RIP)
  26. C:\WILDCAT\ROTATE\HOLIDAYS\  7'INPUT Path to HOLIDAY.BBS screen (ASCII)
  27. C:\WILDCAT\ROTATE\HOLIDAYS\  8'INPUT Path to HOLIDAY.SCR screen (ANSI)
  28. C:\WILDCAT\ROTATE\RIP\       9'INPUT Path to HOLIDAY.RIP screen (RIP)
  29. C:\WILDCAT\ROTATE\HOLIDAYS\ 10'INPUT Path to HOLIDAYV.BBS screen (ASCII)
  30. C:\WILDCAT\ROTATE\HOLIDAYS\ 11'INPUT Path to HOLIDAYV.SCR screen (ANSI)
  31. C:\WILDCAT\ROTATE\RIP\      12'INPUT Path to HOLIDAYV.RIP screen (RIP)
  32. C:\WILDCAT\ROTATE\MUSIC\    13'INPUT Path to MUSIC.MUS files
  33. C:\WILDCAT\DISP\HELLO1.BBS  14'Output Path/Filename for HELLO (ASCII)
  34. C:\WILDCAT\DISP\HELLO1.SCR  15'Output Path/Filename for HELLO (ANSI)
  35. C:\WILDCAT\DISP\HELLO1.RIP  16'Output Path/Filename for HELLO (RIP)
  36. C:\WILDCAT\DISP\GOODBYE.BBS 17'Output Path/Filename for GOODBYE (ASCII)
  37. C:\WILDCAT\DISP\GOODBYE.SCR 18'Output Path/Filename for GOODBYE (ANSI)
  38. C:\WILDCAT\DISP\GOODBYE.RIP 19'Output Path/Filename for GOODBYE (RIP)
  39. C:\WILDCAT\DISP\HELLO1.BBS  20'Output Path/Filename for HOLIDAY F (ASCII)
  40. C:\WILDCAT\DISP\HELLO1.SCR  21'Output Path/Filename for HOLIDAY F (ANSI)
  41. C:\WILDCAT\DISP\HELLO1.RIP  22'Output Path/Filename for HOLIDAY F (RIP)
  42. C:\WILDCAT\DISP\HELLO1.BBS  23'Output Path/Filename for HOLIDAY V (ASCII)
  43. C:\WILDCAT\DISP\HELLO1.SCR  24'Output Path/Filename for HOLIDAY V (ANSI)
  44. C:\WILDCAT\DISP\HELLO1.RIP  25'Output Path/Filename for HOLIDAY V (RIP)
  45. C:\WILDCAT\DISP\DOORS.SCR   26'Output Path/Filename for MUSIC file
  46. HELLO1.LST                  27'List of HELLO screens (BBS/SCR)
  47. GOODBYE.LST                 28'List of GOODBYE screens (BBS/SCR)
  48. RIP.LST                     29'List of RIP files (hello,goodbye)
  49. HOLIDAYF.LST                30'List of fixed date holiday screens (BBS/SCR/RIP)
  50. HOLIDAYV.LST                31'List of variable holiday screens (BBS/SCR/RIP)
  51. MUSIC.LST                   32'List of MUSIC files
  52. DOORSSCR.BAK                33'File to PREpend .MUS to
  53. COPYIT.BAT                  34'Batch file to create.
  54. SWAP.LOG                    35'LOG file, or NONE if no logging required.
  55.  
  56.      In this document, DAYofWEEK will refer to a number corresponding
  57. to the name of the DAY of the week as follows:
  58. SUN=1, MON=2, TUE=3, WED=4, THU=5, FRI=6, SAT=7
  59.  
  60.      If you are conversant with Michael Conley's TODAYBBS program and
  61. associated TODAY.xxx files, this is going to be a snap. If you are not
  62. familiar with it, don't worry about it. You probably won't have a
  63. difficult time grasping the concepts presented below anyway. They are
  64. straight forward.
  65.  
  66. My definition of HOLIDAY:
  67. ========================
  68.  
  69.      As far as this program and documentation goes, HOLIDAY refers to
  70. ANY SPECIFIC DAY for which you want to rotate a SPECIFIED screen. It
  71. could be Christmas Day, Labour Day, Mother's/Father's Day or even your
  72. own birthday or anniversary.
  73.  
  74.      There are two types of HOLIDAYS. One type is the old familiar
  75. FIXED-DATE holidays such as Christmas Day, New Year's Day, Halloween,
  76. etc. They always fall on the same DATE every year (ie. 25 Dec, 1 Jan,
  77. 31 Oct respectively). These types of holidays are put into the
  78. HOLIDAYF.LST (default filename). See the SWAP.DOC file for more
  79. information.
  80.  
  81.      The second kind is a VARIABLE-DATE holiday - such as Mother's Day
  82. (falling on the 2nd Sunday in May) or Labour Day (falling on the 1st
  83. Monday in September). They do NOT fall on the same DATE every year.
  84. This document explains how to set up a HOLIDAYV.LST (default filename)
  85. to compensate for variable date holidays.
  86.  
  87.      A text file called HOLIDAYV.TXT is included with this archive. It
  88. gives some major variable date holidays and when they occur. You might
  89. want to get a copy of this to your printer for quick reference as we
  90. go along. (Note: HOLIDAYF.TXT is a file giving major FIXED holidays).
  91.  
  92.  
  93. Example HOLIDAY (VARIABLE) rotation list (default - HOLIDAYV.LST)
  94. ========================================
  95. DATE   SCREENS                          COMMENT
  96. ====   =======                          =======
  97. 01152,MLKING.BBS,MLKING.SCR,MLKING.RIP  Martin L. King Day [3rd Mon in Jan]
  98. 05081,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP  Mother's Day [2nd Sun in May]
  99.  
  100. Explanation:
  101.      Martin Luther King day falls on the 3rd Monday in January. Find
  102. the MAXIMUM date by assuming that the 1st of the month is a TUESDAY.
  103. This makes the 3rd Monday fall on 21 Jan.  Note this date.
  104. Then assume the 1st of the month is on a Monday.  MLK day would then
  105. fall on the 15th of Jan. Note this date.  Of course you can now
  106. realize that the 3rd Monday *could* fall on any DATE between the 15th
  107. and 21st of Jan inclusive. Your VARIABLE DATE HOLIDAY LIST must
  108. compensate for this by REPRODUCING the range of dates with a qualifier
  109. following it.
  110.  
  111.      The example above for MLK is 01152. This is to say:
  112. 01 = January (leading zeros are necessary)
  113. 15 = date
  114. 2 = qualifier -- day 2 is MONDAY (see above)
  115. , = separator
  116. MLKING.BBS = BBS (ASCII) screen to rotate today IF it is a Monday
  117. , = separator
  118. MLKING.SCR = SCR (ANSI) screen to rotate today IF it is a Monday
  119. , = separator
  120. MLKINGRIP = RIP screen to rotate today IF it is a Monday
  121.  
  122.      You may have comments in this file providing they are separated
  123. from the filenames by AT LEAST one space. "Martin L. King Day [3rd Mon
  124. in Jan]" is a comment. Given this example, the entire listing for this
  125. day would look as shown below:
  126. DATE   SCREENS                         COMMENT
  127. ====   =======                         =======
  128. 01152,MLKING.BBS,MLKING.SCR,MLKING.RIP Martin L. King Day [3rd Mon in Jan]
  129. 01162,MLKING.BBS,MLKING.SCR,MLKING.RIP
  130. 01172,MLKING.BBS,MLKING.SCR,MLKING.RIP
  131. 01182,MLKING.BBS,MLKING.SCR,MLKING.RIP
  132. 01192,MLKING.BBS,MLKING.SCR,MLKING.RIP
  133. 01202,MLKING.BBS,MLKING.SCR,MLKING.RIP
  134. 01212,MLKING.BBS,MLKING.SCR,MLKING.RIP
  135. 05081,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP Mother's Day [2nd Sun in May]
  136.  
  137.      Our second example is Mother's Day falling on the 2nd Sunday in
  138. May. Assuming that the 1st of the month is on a MONDAY, the 2nd Sunday
  139. would be on the 14th of May. Assume that a SUNDAY is the 1st day of
  140. the week. Mother's Day would then fall on the 8th. Your "Mother's Day"
  141. entries must reflect that range of dates: 8th to the 14th inclusive. 
  142.  
  143. The entire listing for Mother's Day would look something like:
  144.  
  145. 05081,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP    Mother's Day [2nd Sun in May]
  146. 05091,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  147. 05101,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  148. 05111,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  149. 05121,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  150. 05131,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  151. 05141,MOMDAY.BBS,MOMDAY.SCR,MOMDAY.RIP
  152.  
  153.      Given those examples, I'm sure you can work out almost any
  154. variable holiday. 
  155.  
  156.      The dates (ie. 0508x above) must be in the format MMDDx. This
  157. program will not work if not in this format. It does not affect the
  158. remainder of the program. Your DOS must also return the date in the
  159. standardized format of MM-DD-YYYY. You may put comments in the .LST
  160. files providing they are separated from the file listing by at least
  161. ONE space as shown above. This is handy for those who wish to NUMBER
  162. their screens. i.e. 1.BBS, 2.BBS, 3.SCR,  109A44.BBS, and want to make
  163. a small comment of what these are. Note that the dates do NOT have to
  164. be in chronological order as the ENTIRE file is read and checked for a
  165. date coincident with your system date. The FIRST CORRECT DATE
  166. encountered will be used, and the program will exit.
  167.  
  168.      The DATE/DAYofWEEK flag and the BBS filename MUST be separated by
  169. a comma. Likewise the BBS filename and the SCR filename and the SCR
  170. filename and the RIP filename. If either are not used, insert a comma 
  171. anyway. ie. [See example .LST files]
  172.  
  173. 01152,,MLKING.SCR,MLKING.RIP  Martin L. King Day [3rd Mon in Jan] (no .BBS)
  174. 05081,MOMDAY.BBS,,MOMDAY.RIP  Mother's Day [2nd Sun in May] (no .SCR)
  175.  
  176. (MLKING.SCR will be used but no .BBS file will be used, MOMDAY.BBS
  177. file will be used but there is no .SCR file.
  178.      Those using only .BBS screens with "@" codes on a WC3.x+ system
  179. will find this feature handy. You may have as many holiday screens as
  180. you wish. The BBS filename and the SCR filename do not have to match,
  181. ie.
  182.  
  183. 05081,MOTHER1.BBS,MOMDAY.SCR,MOM.RIP     Mother's Day [2nd Sun in May]
  184.  
  185.      You do not have to put dates before the files if you want to
  186. maintain a list of available files for later assignment. Those files
  187. will be ignored, ie.
  188.  
  189. EASTRMON.BBS,EASTERMON.SCR         Easter Monday
  190. FATHRDAY.BBS,FATHRDAY.SCR          Father's Day
  191.  
  192.  
  193. Beg for $$$
  194. ===========
  195.      Details for registering are in the SWAP.DOC file.
  196.  
  197. My address and/or where I can be contacted is in the SWAP.DOC file.
  198.  
  199.