home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / t / today / !Today / !Help < prev    next >
Encoding:
Text File  |  1996-07-24  |  9.9 KB  |  217 lines
  1.                                   !Today
  2.                                  ========
  3.  
  4.      This is an extension of the original program for the PC, that was
  5. ported onto the Arc by James Noad. Although the original Arc version was
  6. very good it did have some draw-backs.
  7.  
  8.           -  It was not possible to select another date other than Today.
  9.              Although the program was designed for the current day, the
  10.              original PC version did allow you to change the day.
  11.  
  12.           -  To add new days you had to use edit and put in all the codes
  13.              for date, year, type and day yourself. Although this would be
  14.              possible I thought that it would be better if the program
  15.              could do it.
  16.  
  17.           -  The Arc version (although run from the desktop) was not fully
  18.              multitasking and I wanted a multitasking version to make it 
  19.              even easier to use with other programs (e.g. copy the data 
  20.              onto a word-processor).
  21.  
  22.      This new program has all of these features. When it is run by double-
  23. clicking its icon in the filer window you get a main window with all  the
  24. records for the day that you run it on. There is also a line of icons
  25. across the top.
  26.  
  27.      The first 2 that you can use alter the month and day (Select will
  28. increase and Adjust will decrease). The next icon (Scanfiles) will take
  29. the new date that you have selected and bring up all the records for that
  30. date. Scan Today is the same but will first reset the date to 'today'.
  31.  
  32.      The Search icon will bring up a window allowing you to perform searches
  33. in the files for specified items. See the section Searching for more
  34. details. The Add Date icon will show a window allowing you to add data to
  35. the files on disk. This will then allow them to be found at a later date by
  36. the program.
  37.  
  38.      The Save icon will save a text file of the events in the main window.
  39. The data is saved to a file MM/DD in the directory containing !Today. Not
  40. 'Style Guide Compliant' I know but it was a 'Quick Fix'. The Print icon will
  41. print the events (probably better to save and print from a text editor where
  42. you have more control over the output).
  43.  
  44. Searching
  45. ---------
  46.  
  47.      To perform a search you must first setup the search string. This can
  48. be anything that could be in the text. The program will then scan through
  49. all the files for any record with  your search string in it. There is also
  50. a control code, a '?' means a single character but of any type.
  51.  
  52. eg.  H?M will find any three of more letters which have an H and an M with 
  53.      one letter between them.
  54.  
  55.      You can select whether it is case sensitive (Whether an 'a' is the
  56. same as an 'A') and you run it by clicking on the yellow icon. All
  57. references will then come up in the main window.
  58.  
  59.      The three option icons on the right of the window allow you to
  60. select the types of record allowed. Any type that is unselected will be
  61. ignored.
  62.  
  63.      The range facility will allow you to ignore records that are outside
  64. a range that is specified. To make this facility work you have to select
  65. the 'In Range' icon.
  66.  
  67.      There is a maximum of 255 records or a little more than 30 kilobytes of
  68. search text, going above either of these will cause an error. But if you are
  69. being specific enough these will not occur.
  70.  
  71.      The Save icon will save a text file of the events in the search window.
  72. The data is saved to a file SearchDate in the directory containing !Today.
  73. The Print icon will print the events (probably better to save and print from a
  74. text editor where you have more control over the output).
  75.  
  76.  
  77. Adding
  78. ------
  79.  
  80.      This allows you to simply add records to the files. You select the
  81. date for the entry with the 3 white icons on the left. The type can be set
  82. with the 4 option icons. The 'Own File' and 'Month File' allow to set
  83. which file it will be added to.
  84.  
  85.      The special day section allows you to select whether to have a
  86. special day and which day it will be be. Having a special day allows you
  87. to have dates which will only show on a certain day. For instance if  you
  88. were to have 7 dates with the same record but with a special day of Sunday,
  89. the record would only come up if the date selected was a sunday.  This
  90. allows you to put dates in that are on the first sunday of a month, or on
  91. specific days like fathers day.
  92.  
  93.      The Record date icon allows you to save it to file and the Clear Text
  94. icon will clear the 5 text icons at the bottom of the window.
  95.  
  96. Editing
  97. -------
  98.  
  99.      You can edit the text files in a text editor providing that each line
  100. is followed by a newline character and also that at the end of the file
  101. there is only one newline character at the end of the file.The format for an
  102. item is as follows:-
  103.  
  104.  Column 1: The record type which can be a B for birthdays,
  105.            S for special dates in history, R for a reminder or D for a death.
  106.  
  107.  Cols 2-5: Month and day as MMDD with leading zeros.  Zeros
  108.            for either month or day cause ALL months or days
  109.            to match when being scanned.  For example  0001
  110.            would match the first of every month while 0400
  111.            would match every day of April.
  112.  
  113.  Cols 6-9: The full year of the event as four digits.
  114.            May be left blank, msg will move left.
  115.  
  116. Column 10: A special processing flag.  Values may be:
  117.            -BLANK for no special processing.
  118.            -C to continue a message from the previous line.
  119.             Note, that you MUST repeat the date fields.
  120.            -DAY-OF-WEEK DIGIT where 1=Sunday ... 7=Saturday
  121.             This will cause the message to display only if the
  122.             date falls on a certain day of the week.  Look in
  123.             the November file for voting day examples.
  124.             
  125.      Rest: Text followed by a newline character.
  126.  
  127.      If you want to add items with a text editor you must make sure the
  128. format is correct because the program will not check for you (it takes too
  129. much time when it has a search to perform and there is a perfectly good date
  130. adding function built in).
  131.  
  132. Higlights
  133. ---------
  134.  
  135.      On the menu is an item 'Highlight'. If this is set any events in the
  136. main or search windows which came from the own file will be drawn in red and
  137. not black.
  138.  
  139. Updates
  140. -------
  141.  
  142.      2.00 (8-Jun-91) The original multitasking basic version. Solved the
  143.           problems of the original but was very slow. 
  144.  
  145.      2.01 (16-Jun-91) Wrote it in RISC code. Much faster but there was a
  146.           bug so any continued day did not work. Added a section that will
  147.           break lines if they go above 62 characters in length. This makes
  148.           it much more readable.
  149.  
  150.      2.02 (18-Jun-91) Removed the bug in the code (Now the continue codes
  151.           are used properly. 
  152.  
  153.      2.04 (21-Jun-91) Started adding the search option to make it easier
  154.           to find records about specific items.
  155.  
  156.      2.05 (25-Jun-91) Sorted out a bug in the code so now the main today
  157.           window shows data correctly. Also changed my mind about the
  158.           display. Now any record without a specified year has a '????'
  159.           icon instead of a year. Before it was confusing and looked like
  160.           a continuation of the previous record.
  161.  
  162.      2.06 (31-Jun-91) Added the type facility to the search to make it
  163.           easier to specify records. Also added print to the search and
  164.           the main windows. 
  165.  
  166.      2.07 (4-Jul-91) Added the range facility to the search. It now  will
  167.           allow you to specify pretty accurately what you want so you
  168.           minimize the records that you get.
  169.  
  170.      2.08 (9-Jul-91) Tidied the code so it ran faster (and was shorter).
  171.           This has allowed me to make the maximum number of records 80 and
  172.           increase the data it can handle for a search to 9000 bytes.
  173.  
  174.      2.09 (25-May-92) Gave it an icon-bar icon and a menu with quit. Now you
  175.           cannot quit by closing the windows. Tidied up the WIMP interface
  176.           and made it more user friendly. Also cured a couple of bugs in the
  177.           save routines (one that wouldn't allow saving to the month file
  178.           and one that caused the event type to be saved wrongly). Increased
  179.           the maximum records to 100 and made it force the first letter of a
  180.           string to uppercase when it is displayed in the main window or the
  181.           search window.
  182.  
  183.      2.10 (19-Aug-94) Thanks to Charlie Alford, a few bug fixes and
  184.           improvements have been made. Buffer overflow errors no longer
  185.           happen when !Today is run. Also the maximum ammount of text for
  186.           one day has been increased to 8K and the maximum for a scan to
  187.           more than 30K. Also the file handling has been tidied up and made
  188.           a little less fussy about the way a file is saved.
  189.  
  190.      2.11 (13-Apr-95) Another buffer overflow problem fixed when adding
  191.           dates to October, Novenmber or December. New data files from
  192.           Charlie Alford added.
  193.           
  194.      2.12 (6-Jul-96) Fixed problem with case sensitive icon in search window.
  195.           Fixed background colours of text on RiscPC. Fixed loaders to cope
  196.           with blank lines in the data files. Added a new event type of death.
  197.           Fixed bug in code for searching in a range. Added the Scan Today
  198.           option.
  199.  
  200.      2.13 (24-Jul-96) Put code to justify the text in the Main window and the
  201.           Search window when outline fonts are used on a RiscPC. Widened icons
  202.           for dates in main and search windows because it looked too tight with
  203.           fonts on a RiscPC. Shrunk the code lots by altering the way windows
  204.           are created. Got main/search windows to alter size to fit screen.
  205.           Put code to allow saving of main and search windows. Got caret to
  206.           move into first icon when opening search window. Got menu to stay
  207.           open when adjust used. Added highlights of events in own file. Made
  208.           search code match a blank string to nothing and not everything.
  209.  
  210.           
  211.      If you want to write to me with bug-fixes (or money for a Risc PC) you
  212. can contact me at..
  213.  
  214.                  James Miskin
  215.                   23 Hardwick Drive
  216.                    Loughborough
  217.                     LE11 4TJ