home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / beehive / utilitys / today.arc / README.DOC next >
Text File  |  1991-08-11  |  6KB  |  134 lines
  1.  
  2.                                      TODAY                       
  3.                              For CP/M. Version 1.0
  4.  
  5.      This  is the CP/M version of the TODAY program that is floating  around 
  6.    on the I.B.M. PC's. It's written in Turbo Pascal and should be quite easy 
  7.    to  adapt to any system that has hardware Real Time Clock fitted.  If you 
  8.    don't  have a RTC,  you can still use TODAY by specifying the  date  when 
  9.    running  the  program eg.  TODAY 0501 tells you what happend on May  1st.
  10.  
  11.                                  INSTALLATION
  12.  
  13.      Extract the files from the library and uncrunch them. Then decide where 
  14.    you  want  to keep the the data files,  on my system i keep them  out  of 
  15.    sight  in  user  area 13.   This can be changed to suit  your  system  by 
  16.    altering the value assigned to the constant "user" at the begining of the 
  17.    code.
  18.  
  19.      The program expects the year,month and day values (supplied by your own 
  20.    clock read routine) to be integers. Don't worry about the day of the week 
  21.    as it works it out by itself. 
  22.  
  23.                               DATE FILE STRUCTURE
  24.  
  25.      There are 13 data files used in the TODAY program.  The first 12  files 
  26.    have  extensions named after each month to identify them.  The 13th  file 
  27.    has  the  .OWN extension and this where you can store your  own  personal 
  28.    dates  instead of having to spread them out through the other files.  All 
  29.    the  data files are in plain ASCII and can be changed in any text  editor 
  30.    eg. WordStar (non-document mode). The format is as follows:
  31.  
  32.    Column 1:   This  column has 3 record types,  which signify what the line 
  33.                is going to do.  It can be a B for birthdays,  S for  special 
  34.                dates in history or R for a reminder.
  35.  
  36.    Cols 2-5:   Month  and day as MMDD with leading zeros.   Zeros for either 
  37.                month  or  day cause ALL months or days to match  when  being 
  38.                scanned.   For  example  0001 would match the first of  every 
  39.                month while 0400 would match every day of April.
  40.  
  41.    Cols 6-9:   The  full year of the event as four digits.   It may be  left 
  42.                blank or, for Reminders only, you may enter another MMDD that 
  43.                is  an  ending  date corresponding to the  starting  date  in 
  44.                columns 2-5. See REMINDER FORMAT below for details.
  45.  
  46.    Column 10:  A special processing flag.  Values may be:
  47.  
  48.                BLANK for no special processing. C to continue a message from 
  49.                the previous line. Note, that MMDD field MUST be repeated.
  50.  
  51.                DAY-OF-WEEK DIGIT where 1 = Sunday ... 7 = Saturday This will 
  52.                cause  the  message  to display only if the date falls  on  a 
  53.                certain  day  of the week.   Look in the  November  file  for 
  54.                voting day examples.
  55.  
  56.    Cols 11-70: The message to be displayed for this date.
  57.  
  58.                                    EXAMPLES
  59.  
  60.    *mmddyyyy Birthdays
  61.    *-------- ------------------------------------------------------------
  62.    B09011875 Edgar Rice Burroughs, novelist, Ah-ee-ah-ee-ah!
  63.    B09021838 Queen Liliuokalani (last queen of Hawaii).
  64.    B09021952 Jimmy Connors, tennis brat
  65.  
  66.    *mmddyyyy Events
  67.    *-------- ------------------------------------------------------------
  68.    S09011939 Germany invades Poland, starts World War II.
  69.    S09011952 Sutro Baths purchased by George Whitney.
  70.    S0901    2Labor Day, a legal holiday
  71.    S09021620 The Mayflower sets sail from Plymouth with
  72.    S09021620C102 Pilgrims.
  73.  
  74.    *mmddyyyy Reminders
  75.    *-------- ------------------------------------------------------------
  76.    R0001     Pay the mortgage!
  77.    R0401     Taxes due in two weeks.
  78.    R0415     Last day to pay taxes!
  79.  
  80.      Note  that  Labor day must be on a Monday and the  Mayflower  gets  two 
  81.    lines of coverage befitting that momentous event.
  82.  
  83.      This  format  applies  to TODAY.OWN also.   You can put  in  birthdays, 
  84.    anniversaries, holidays etc.  Messages in your personal file will tend to 
  85.    be only Birthdays and Reminders.   Also,  try putting in reminders a  few 
  86.    days BEFORE the date in question to give youself some warning.
  87.  
  88.                                 REMINDER FORMAT
  89.  
  90.      If you want to reminded for a few days in a row then here is how you do 
  91.    it.  The  four  columns immediately following the month and day  normally 
  92.    hold  a four digit year or blanks.  But by putting a beginning month  and 
  93.    day in columns 2-5 and an ending month and day in columns 6-9.   This way 
  94.    you don't have to put in a separate reminder for every day.   It saves  a 
  95.    lot of typing!  For example:
  96.  
  97.                R12101224 Christmas is nearly here. Better buy some presents
  98.                R1225     Hope you remembered the presents, or else!
  99.  
  100.    reminds  me not to forget about buying christmas presents every day  from 
  101.    December  10 to December 24.   Then on the 25th,  there is the usual  one 
  102.    shot reminder.
  103.  
  104.      Another  nice  feature  is the monthly reminder.   Just set  the  month 
  105.    portion  of the date to zero and the reminder will appear every month  on 
  106.    the days you specify.  For example:
  107.  
  108.                R00050014 First mortgage due on the 15th.
  109.  
  110.      But it gets even better!   What if the date you need to be reminded  of 
  111.    falls  on the 5th of the month and you want to be reminded from the  27th 
  112.    of  one month to the 4th of the following month?   No problem!   If TODAY 
  113.    sees  that the day of the month for the second date is less than the  day 
  114.    in  the first date,  it assumes that the second date is in the  following 
  115.    month.  Not bad eh?  Here's how:
  116.  
  117.                R00270004 Second mortgage due on the 5th.
  118.  
  119.    and if TODAY sees the day and month in the second column greater than the 
  120.    first column it assumes the second date is in the following year.
  121.  
  122.                R12200113 Msg will be display from Dec 27th to Jan 13th.
  123.  
  124.    -------------------------------------------------------------------------
  125.    
  126.      As far as i can see, it emulates the I.B.M version correctly, so if you 
  127.    find  any  differences or bugs, please let  me  know.
  128.  
  129.                      Mick Howland (VK6ZMH) c/o Perth Omen.
  130.  
  131.  
  132.  on the 15th.
  133.  
  134.      But it gets even better!