home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / dates409.zip / DATES.DOC < prev    next >
Text File  |  1994-09-04  |  11KB  |  261 lines
  1. DATES.DOC
  2. 09/04/94
  3.  
  4. This program keeps track of birthdays, anniversaries, coming events, etc giving
  5. you advance warning so you can send out cards, leave town, etc.  Features of
  6. this program:
  7.  
  8.   * Initially defaults to showing all events happening within 14 days
  9.   * You can set up multiple date files, each with their own day threshold;
  10.     for example, one file for birthdays, another for business meetings, etc
  11.   * This program can be included in your AUTOEXEC.BAT file to provide notices
  12.     every time you turn on your PC.
  13.   * Vague dates can be entered (e.g. "11/XX/XX Thanksgiving) when the exact
  14.     day varies from year to year
  15.   * Dates can be in the United States format (/DATE=mm/dd/yy) or in most other
  16.     formats (e.g. /DATE=dd-mm-yy)
  17.   * Months can be entered as sequential months (1 for January, 2 for February,
  18.     etc) or else entered as the months themselves (JAN, FEB, etc)
  19.   * Dates don't have to be padded (9/6/94, 09/06/94, and SEP/06/1994 are all
  20.     accepted)
  21.   * The program will show you the weekday and age of the event if desired
  22.   * Comment lines can be displayed if desired (e.g. "Events relating to work:")
  23.  
  24. The dates file is a simple ASCII text file, created and maintained with any text
  25. editor.  Each record should begin with a date (typically in mm/dd/yy format)
  26. followed by a description of the event.  For example:
  27.  
  28.         05/05/93 Lucy Baines
  29.  
  30. Blank lines or any line which begins with a colon (":") or semi-colon (";") are
  31. ignored by the program.  Lines which begin with an asterisk ("*") are printed
  32. verbatim (minus the asterisk); add spacing after the asterisk if you want the
  33. lines to be indented upon display.
  34.  
  35. For the date portion of the record, you have some flexibility.  Initially by
  36. default, the program expects dates to be in a mm/dd/yy format.  So August 5,
  37. 1993 is "08/05/93".
  38.  
  39. You can change the sequence of the numbers by using the "/DATE=format" option.
  40. For example, you can specify "/DATE=dd-mm-yy" if you want.
  41.  
  42. Typically, most date formats will use one of the delimiters "-", ".", or "/"
  43. between all various day, month, and year fields.  For example, /DATE=dd.mm.yy
  44. instead of /DATE=dd.mm/dd.  If this is done, your input fields can entered in a
  45. very flexible manner.  The routine will parse the date field based on the
  46. delimiters and accept fields with or without padding, years with or without the
  47. century, and alphabetic months instead of just numeric ones.  For example, using
  48. /DATE=dd.mm.yy, all of the following September 5, 1994 events as the same:
  49.  
  50.         05.09.94 Big event
  51.         5.9.94 Same event
  52.         5.sep.1994 Still the same thing
  53.         05.september.1994 And yet again the same event
  54.  
  55.  
  56. The month portion of the date *has* to be filled in.  The day and year portions
  57. can be "xx" if desired.  If a day is "xx", you will be given the notice for the
  58. entire month and for 15 days before the start of the month.  For dates which
  59. vary from year to year (e.g.  Thanksgiving), you can either use the "xx" option
  60. for the day or revise the file every year.
  61.  
  62. Records in the file don't have to be in any particular order.  The dates will be
  63. presented in the order they appear in the file so putting them in chronological
  64. order makes the most sense.
  65.  
  66. A sample DATES.TXT file is provided and consists of the following lines:
  67.  
  68.         01/01/xx New Year's Day
  69.         01/20/xx -ish Martin Luther King's birthday
  70.         02/14/xx Valentine's Day
  71.         03/17/xx St. Patrick's Day
  72.         03/30/xx -ish Easter
  73.         04/07/xx -ish Daylight Savings Time begins
  74.         05/10/xx -ish Mother's Day
  75.         05/30/xx -ish Memorial Day
  76.         05/31/57 Bruce Guthrie
  77.         07/04/xx July 4th
  78.         09/02/xx -ish Labor Day
  79.         10/27/xx -ish Daylight Savings Time ends
  80.         10/31/xx Halloween
  81.         11/xx/xx Thanksgiving
  82.         11/11/xx Veteran's Day
  83.         11/20/xx -ish Thanksgiving
  84.         12/25/xx Christmas
  85.  
  86.  
  87.  
  88. Multiple input files with different date restrictions:
  89.  
  90. You can specify multiple date input files.  They are processed in the order
  91. they are entered.  By default, each will have the initial date restriction
  92. (typically 14 days).  You can override the date restriction for a specific file
  93. by including the date restriction after the file name.  For example:
  94.  
  95.         DATES DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  96.  
  97. Given a default 14-day restriction, the date restrictions will be 14 days for
  98. DATE1.TXT and DATE3.TXT, 10 days for DATE2.TXT.  If you want to override the
  99. date restriction for all files, include that date restriction before the file
  100. name.  For example:
  101.  
  102.         DATES /D5 DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  103.  
  104. In this case, the date restriction will be 5 days for DATE1.TXT and DATE3.TXT
  105. and 10 days for DATE2.TXT.
  106.  
  107.  
  108. The DATES.INI file:
  109.  
  110. DATES will read a DATES.INI file if one is found.  (You can specify a different
  111. file name if desired.) The file is an ASCII text file that can be created
  112. maintained by hand.  The file can consist or one or more command line
  113. parameters (only those that begin with a "/"), one statement per line.
  114.  
  115. The file can also contain comments which are blank lines or any line beginning
  116. with:
  117.         ;    (semi-colon)
  118.         :    (colon)
  119.         '    (quote)
  120.  
  121. DATES looks for the initialization file in your default subdirectory first.  It
  122. then searches for it in the subdirectory where the executable was and then goes
  123. through your DOS path.
  124.  
  125. Passing in "/INULL" skips loading the DATES.INI file.
  126.  
  127.  
  128.  
  129. Syntax:
  130.  
  131.     DATES [ date_file [...] ] [ /Ddays ] [ /-AGE | /AGE ] [ /COLOR=nnn nnn nnn ]
  132.       [ /CLS | /-CLS ] [ /Q | /-Q ] [ /Iinitfile | /-I ] [ /R ]
  133.       [ /DAY | /-DAY ] [ /MONO | /COLOR ] [ /SKIP | /-SKIP ]
  134.       [ /DATE=format ] [ /? ] [ > filename ]
  135.  
  136. where:
  137.  
  138. "date_file" is the name of the input text file.  It can contain drive and path
  139. information if desired.  This defaults to DATES.TXT.  If no filename is
  140. specified, the program will check for it along your DOS path beginning with your
  141. default subdirectory.  Multiple date files and date restrictions are allowed.
  142. See the notes above about this.
  143.  
  144. "/Ddays" (or "days") are the number of days in advance you want the warning.
  145. Initially defaults to /D14.  Note that generic days ("11/xx/xx") are not
  146. affected by this setting; you automatically get the notice 14 (or whatever) days
  147. before the beginning of the month.
  148.  
  149. "/AGE" shows the age of the event when it's printed.  This is only done for
  150. entries that have a specific year.  This is the default.
  151.  
  152. "/-AGE" skips showing the age of the event.  The default is /AGE.
  153.  
  154. "/COLOR=nnn nnn nnn" specifies the color settings to use for (in order) regular
  155. text, dates happening today, and the ages of dates happening today.  Any input
  156. lines which begin with an asterisk are printed using the third color set.  Each
  157. setting must consist of three digits, the first two being the foreground color
  158. and the last being the background color.  The foreground color should be padded
  159. on the left with a 0 if it is only one digit in length.  Defaults to "COLOR=070
  160. 150 090".
  161.  
  162. Foreground colors:
  163.  
  164.         Low intensity           High intensity
  165.  
  166.         0 = black                8 = dark grey
  167.         1 = blue                 9 = light blue
  168.         2 = green               10 = light green
  169.         3 = cyan                11 = light cyan
  170.         4 = red                 12 = light red
  171.         5 = magenta             13 = light magenta
  172.         6 = brown               14 = light yellow
  173.         7 = white               15 = bright white
  174.  
  175. Adding 16 to any color will make the text blink.  Background colors can consist
  176. of 0 to 7 above.  Bright white on blue, for example, would be "151".
  177.  
  178. "/CLS" clears the display before showing the results.
  179.  
  180. "/-CLS" does not clear the display first.  This is the default.
  181.  
  182.  
  183. "/Q" stops the printing every message except for the actual date lines.  This
  184. option is automatically invoked if redirection is used.
  185.  
  186. "/-Q" turns back on the printing of almost every message.  This is the default
  187. unless redirection is used.
  188.  
  189. "/Iinitfile" specifies the name of the initialization file to try to load.
  190. Defaults to "/IDATES.INI".
  191.  
  192. "/-I" says to skip reading the initialization file even if present.
  193.  
  194. "/R" sets a DOS return code equal to the number of dates found.
  195.  
  196. "/DAY" shows the day of the week if possible.
  197.  
  198. "/-DAYS" skips showing the day of the week.  This is initially the default.
  199.  
  200. "/MONO" suppresses all screen color settings.
  201.  
  202. "/COLOR" allows screen color settings and is initially the default.
  203.  
  204. "/SKIP" says to print a message (unless /Q is specified) but otherwise ignore
  205. it if one or more of the date input files is not found.
  206.  
  207. "/-SKIP" says to abort if any of the input files are not found.
  208.  
  209. "/DATE=format" specifies the format that the date is to have.  The date must
  210. consist of pairs of "mm" (month), "dd" (day), and "yy" (year) characters in any
  211. order.  If a delimiter is used between the pairs, it can be any non-space
  212. character (like "-" or "/").  If your delimiter is the same between the three
  213. sets of date portions (e.g.  /DATE=mm/dd/yy or /DATE=dd.mm.yy), you have a
  214. considerable amount of flexibility in terms of what sort of entries can appear.
  215. See the notes at the beginning of this documentation.  Initially defaults to
  216. "/DATE=mm/dd/yy".
  217.  
  218. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  219.  
  220. "> filename" redirects the output to a DOS file.  This is standard DOS
  221. redirection.  Automatically invokes /Q option and turns off the last of the
  222. status messages.
  223.  
  224.  
  225. Return codes:
  226.  
  227. DATES returns the following ERRORLEVEL codes:
  228.       255 = syntax problems, or /? requested
  229.  
  230. If /R is specified, the ERRORLEVEL code will be the number of hits found.
  231.  
  232.  
  233.  
  234. Author:
  235.  
  236. This program was written by Bruce Guthrie of Wayne Software.  It is free for use
  237. and redistribution provided relevant documentation is kept with the program, no
  238. changes are made to the program or documentation, and it is not bundled with
  239. commercial programs or charged for separately.  People who need to bundle it in
  240. for-sale packages must pay a $50 registration fee to "Wayne Software" at the
  241. following address.
  242.  
  243. Additional information about this and other Wayne Software programs can be found
  244. in the file BRUCEymm.DOC which should be included in the original ZIP file.
  245. ("ymm" is replaced by the last digit of the year and the two digit month of the
  246. release.  BRUCE312.DOC came out in December 1993.  This same naming convention
  247. is used in naming the ZIP file that this program was included in.) Comments and
  248. suggestions can also be sent to:
  249.  
  250.                 Bruce Guthrie
  251.                 Wayne Software
  252.                 113 Sheffield St.
  253.                 Silver Spring, MD 20910
  254.  
  255.                 fax: (301) 588-8986
  256.  
  257. See BRUCEymm.DOC file for additional contact information.
  258.  
  259. Foreign users:  Please provide an Internet e-mail address in all correspondence.
  260.  
  261.