home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 62 / af062sub.adf / AmigaDiary / AmigaDiary.DOC < prev    next >
Text File  |  1992-09-02  |  9KB  |  249 lines
  1.  
  2.  
  3.                ********************************************
  4.                *                                          *
  5.                *     Program : AmigaDiary version 1.13    *
  6.                *                                          *
  7.                *     Author  : Andrew K. Pearson          *
  8.                *                                          *
  9.                *     Machine : Commodore Amiga            *
  10.                *                                          *
  11.                *                                          *
  12.                *        (c) Andrew Pearson 1992/93        *
  13.                *                                          *
  14.                ********************************************
  15.  
  16.  
  17. AmigaDiary is freeware. That is, it may be freely copied and distributed
  18. but remains copyright (c) Andrew K. Pearson. Everything in this 
  19. distribution must be kept together in its original, unmodified form. No 
  20. commercial usage is permitted without written permission from the author.
  21.  
  22.  
  23. Program History
  24. ===============
  25.  
  26.  v1.0  : The 'original'. Finished around spring '93.
  27.  
  28.  v1.1  : Finished 20/3/93. Added some features not originally intended,
  29.          eg. hotkeys. This version on July '93 Amiga Computing coverdisk.
  30.  
  31.  v1.11 : Removed a few bugs present in v1.1 Thanks to all the people 
  32.          who pointed them out to me.
  33.  
  34.  v1.12 : Fixed the following bugs: (21/6/93)
  35.          1. When the diary starts up, the whole entry for today is
  36.             displayed, not just the most recently added one.
  37.          2. After loading a file, the correct entries are displayed, and
  38.             the day shown in the window is today's date - not the last
  39.             day loaded from the file.
  40.          3. The Edit gadget in the scribblepad window no longer has the
  41.             E underlined. (Hotkeys only work in the main window).
  42.          4. (Not a bug) I never expected people to want to insert entries
  43.             in the past, so I made the lookup date routine add 2000 to the
  44.             year if it was less than 90. It would seem, however, that 
  45.             if you were keeping records or something then you might want
  46.             entries in previous years. Now, only years less than 30 are
  47.             21st century. Any others go to 20th century, so for example if
  48.             you entered 69 it would become 1969, not 2069. This means the
  49.             diary can be used up until 2030. If anyone is still using it
  50.             after that don't expect help from me!
  51.          5. The program now correctly sets the topaz 8 font in each window
  52.             that uses the graphics library text function.
  53.          6. Diary now correctly handles years. (This was a major bug - 
  54.             whoops!)
  55.  
  56.  v1.13 : Thanks to Peter Wesson for pointing this out. If the date given
  57.          in the LookUp Date window is an old date eg. in 1959, the day is
  58.          wrong. This was because the exec function datestamp returns the
  59.          date as the number of seconds since midnight, 1st Jan 1978. When
  60.          I changed the range of years allowed in to 1930 onwards (v1.12), I
  61.          forgot to take this into consideration, so any date before 1.1.78
  62.          would give the wrong day. This has now been fixed.   (28/6/93)
  63.  
  64.  
  65. Known Bugs
  66. ==========
  67.  
  68. AmigaDiary seems to cause problems for ToolsDaemon v2.0b - I don't know
  69. why. The error reported is "can't find .info!" when I try to select a
  70. menu option. I think the problem lies in ToolsDaemon, though, because 
  71. I have had this error when AmigaDiary has not even been running. 
  72.  
  73.  
  74.  
  75. Future Additions
  76. ================
  77.  
  78. Version 1.13 was really just v1.0 with the bugs removed. I plan to release
  79. a version 2 at some point in the future, so here are some features that I
  80. may or may not include. Some of these were suggested to me by other people.
  81. Thanks to all those who wrote to me.
  82.  
  83. 1. A print facility. This is doubtful as I do not have a printer, and have
  84.    no experience of writing printer routines. However, it will be 
  85.    interesting to try.
  86.  
  87. 2. A calendar facility so you can see which days have entries at a glance.
  88.    This was a very good suggestion, and I will definitely include this.
  89.  
  90. 3. Font selection facility. This is useful also, as not everybody likes the
  91.    faithful topaz 8 font (Though I for one still use it).
  92.  
  93. 4. Requestor prompting saving any changes before quitting. Originally, I 
  94.    tried to keep the program so small that I didn't really think requestors
  95.    such as this and "Are you sure you want to quit?" were really necessary.
  96.    However, they aren't that hard to do, and they don't add much to the
  97.    program size - so watch out for them.
  98.  
  99. 5. Adding entries without going back to the main window and selecting Add
  100.    Entry again. Nice one - why didn't I think of that?
  101.  
  102. 6. Inclusion of standard entries. For example, if you played squash at 
  103.    7pm every Tuesday, you would not want to have to add it again and again.
  104.    This facility should allow you to enter it only once.
  105.  
  106. 7. Reminders, eg. birthdays, should pop up a requestor if it gets near the
  107.    time. Possibly specify the time eg. day, week, month in advance.
  108.  
  109. 8. A search facility with wildcards to search for, eg. "#? birthday"
  110.  
  111. 9. A real time clock, visible from the main and shrink windows.
  112.  
  113.  
  114. Documentation    28/6/93
  115. ======================
  116.  
  117.  
  118.     AmigaDiary is a handy workbench tool of the type that currently 
  119. abound office PC's. It is a mouse driven diary capable of storing all
  120. personal events and is the perfect solution to all those forgotten 
  121. birthdays, missed appointments etc.
  122.  
  123.  
  124. Getting Started
  125. ---------------
  126.  
  127.     AmigaDiary can be started by double clicking the diary icon 
  128. from the workbench, or by typing "run AmigaDiary" from the CLI. If you
  129. wish a default file to be loaded each time you start up, save your
  130. entries file in the s directory as "diary.def".
  131.  
  132.  
  133. The Interface
  134. -------------
  135.  
  136.     The main diary display shows open 'pages' of the diary. The 
  137. current date is displayed in the centre of the display. There are four 
  138. arrows under the pages - these represent (left to right) week backward, 
  139. day backward, day forward, week forward - and are used to move to 
  140. dates within close proximity to the current date. 
  141.     The eight gadgets at the bottom of the screen represent the 
  142. main diary functions :
  143.  
  144.  
  145. LOOKUP    This gadget is used to go immediately to a date that is without 
  146. ------    having to use the arrow gadgets. If clicked, a requestor will 
  147.      appear prompting the user for the day in the format shown.
  148.  
  149.  
  150. ADD    This gadget allows the user to add an entry into the diary which,
  151. ---    heck, I suppose is quite vital. A window will appear with gadgets 
  152.     to input and manipulate your entry. More about this under 'The 
  153.     Add Entry window'.
  154.  
  155.  
  156. EDIT    This allows the user to alter, or delete any entries in the diary.
  157. ----    When clicked, it opens an edit window which is used to step through
  158.     the entries for that day. To edit an entry, you must go to that 
  159.     date first, using either the arrow gadgets or the LOOKUP gadget. 
  160.     More editing under 'The Edit Entry window'.
  161.  
  162.  
  163. SCRIBBLE The ScribblePad is used to jote down notes, reminders, and any
  164. -------- entry which does not have a specific date eg. 'get a haircut'.
  165.      Scribblepad entries are added in the same way as diary entries,
  166.      to activate the appropriate window, select SCRIBBLE, then select
  167.      ADD from the scribblepad gadgets. Note - scribblepad entries have
  168.      no time option.
  169.  
  170.  
  171. LOAD    Allows the user to load a previously stored, AmigaDiary file.
  172. ----
  173.  
  174.  
  175. SAVE    Allows the user to save all information in the diary, including
  176. ----    the scribblepad, in an external file.
  177.  
  178.  
  179. ABOUT    Information about the program and author. 
  180. -----
  181.  
  182.  
  183. SHRINK    Reduces the diary to a small window. This allows you to 'pop' it in
  184. ------    the background without having to quit. The diary can be 'unshrunk'
  185.     by closing the shrink window.
  186.  
  187.  
  188.  
  189. THE ADD ENTRY WINDOW
  190. --------------------
  191.  
  192.     This window supplies the gadgets to add diary entries. 
  193.  
  194.  
  195. Entry        : This string gadget is for the entry text
  196. Hours        : Supply a time in hours (24hr clock) for the entry, if required
  197. Mins         : Supply a time in minutes, if required
  198. Include time : Entries do not necessarily need a time, eg. 'Go shopping' 
  199.                could apply at any time. These entries are displayed at the 
  200.                bottom of the diary page.
  201. Add          : Creates an entry from the inputs given, and inserts it into 
  202.                the diary.
  203. Clear        : Clears all the inputs in the gadgets.
  204. Cancel       : Cancels choice, ie. closes the window without adding the 
  205.                entry.
  206.  
  207.  
  208.  
  209. THE EDIT ENTRY WINDOW
  210. ---------------------
  211.  
  212.     This window supplies the gadgets to edit diary entries.
  213.  
  214. Entry          : as above
  215. Hours        : as above
  216. Mins        : as above
  217. Include Time    : as above
  218. Prev        : Retrieves the next diary entry for that day
  219. Next        : Retrieves the previous diary entry for that day
  220. Delete        : Removes the entry from the diary
  221. Clear        : Clears the gadget values
  222. Change        : Applies the changes to the entry
  223. Done        : Finish, ie. close the edit entry window
  224.  
  225.  
  226.  
  227. HOTKEYS
  228. -------
  229.  
  230.     The letters that are underlined in the program gadgets indicate
  231. the keys that can activate the gadget by pressing along with CONTROL.
  232. (not SHIFT as was wrongly stated in earlier docs!)
  233.  
  234.  
  235.  
  236.     If you have any suggestions, bug reports, etc. please send them
  237.     to :-
  238.  
  239.         Andrew Pearson
  240.         216 Deeside Gardens,
  241.         Aberdeen AB1 7PS
  242.         Scotland
  243.  
  244.         OR:   email   akp@uk.ac.ed.dcs
  245.  
  246.  
  247.  
  248.  
  249.