home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / calendar / a149_1 / !Calenary / !Help next >
Text File  |  1992-07-21  |  9KB  |  211 lines
  1.  
  2.  
  3.              Calenary                       © copyright 1992, Ian Palmer.
  4.              --------
  5.  
  6.  
  7.             Please read '!Licence' file for copyright details.
  8.  
  9.  
  10. Calenary supplies a combined calendar and diary which runs on the desktop.
  11. It allows simple viewing of diary entries on, or within a specified number
  12. of days of, a specific date.
  13.  
  14. When you run Calenary it will install itself on the icon bar. If you press
  15. the left mouse button when the pointer is over its icon, then the 'Calendar'
  16. window will be opened. The right mouse button opens the 'Diary' window.
  17.  
  18.  
  19. The 'Diary' Window
  20. ------------------
  21.  
  22. This window allows the user to enter, view and delete diary items. The
  23. window is divided into three main parts. At the top are options to allow
  24. specification of the date, in the middle are 5 lines in which to enter the
  25. text to be associated with that date, and at the bottom are options to save,
  26. delete and move between diary items.
  27.  
  28. Date specification is simply a matter of altering the date displayed
  29. (initially the current date) to the date required by simply using the up and
  30. down arrows associated with each part.
  31.  
  32. Dates specified can either be very specific (an exact date) or general. Both
  33. the month and year can be set to 'All', and the date within the month can be
  34. set as a specific date (eg. 26th) or a day of the week (eg. every monday, or
  35. the 2nd Wednesday, etc.).
  36.  
  37. Date specification requires the setting of four parts. Date specification
  38. area has the following layout :
  39.  
  40.  
  41.        ⇩ (part1) ⇧    ⇩ (part2) ⇧    ⇩ (part3) ⇧    ⇩ (part4) ⇧
  42.                                                               •
  43.  
  44. (part4) - is the year (eg. 1992). To set to 'All' select the '•' option.
  45.           the '⇧' and '⇩' options move up and down the years.
  46.  
  47. (part3) - is the month. To set to 'All' you need to keep selecting
  48.           '⇧' until you move past December.
  49.  
  50.  
  51. (part1) and (part2) depend on what date format you require.
  52.  
  53. For an exact date (eg. 26th) you need to set (part1) to blank (the lowest
  54. option). Then (part2) needs to be set to the date required (ie. 26).
  55.  
  56. For a day of the week you need to set (part1) to one of 'All', '1st', '2nd',
  57. etc. and then set (part2) to the correct day of the week (eg. Sun).
  58.  
  59. Once you have selected the date, and entered the text for that date, you need
  60. to select 'Save' (bottom right) to enter the diary entry into the database.
  61. Once you select 'Save' you will then be presented with a new blank entry.
  62.  
  63. To view the diary entries use the '⇦' and '⇨' options (bottom middle) to
  64. move backwards and forwards through the entries (note the blank entry is at
  65. the far right hand end).
  66.  
  67. To delete an entry from the database, simply display it (using the '⇦' and
  68. '⇨' options) and select the 'Delete' option (bottom right). 
  69.  
  70.  
  71. The 'Calendar' window
  72. ---------------------
  73.  
  74. When you first open the 'Calendar' window you will be shown the current
  75. month's calendar. This takes the form of a table of 7 columns (one for each
  76. day of the week). The current date can be seen easily by the fact that it's
  77. entry in the calendar is labelled in blue.
  78.  
  79. At the bottom of the window are two arrows, one pointing to the left, the
  80. other to the right. Selecting these will make the current displayed month go
  81. backwards and forwards respectively.
  82.  
  83. Another way to change the current month, or year, is via the relevant menu
  84. option. Clicking 'Menu' over either Calenary's icon or the 'Calendar' window
  85. will bring up the main menu.
  86.  
  87. This menu contains 6 options. There are the normal 'Info' and 'Quit'
  88. options, as well as two sub-menus for setting the current month and year for
  89. the calendar. The final two menu items are 'Search' and 'Tidy' - these will
  90. be described later.
  91.  
  92. If you move the mouse pointer over one of the dates on the calendar, and
  93. press the left mouse button, then this date will become the 'current
  94. selected date'. When a date is selected the database is scanned and any
  95. entries relating to that date will be displayed in the 'Display' window.
  96.  
  97. This 'Display' window is only shown when there is something to show. When
  98. there is nothing to show, it goes into hiding. 
  99.  
  100. There is no need to limit the database search to just the current selected
  101. date. You can have it search the current selected date plus a specified
  102. number of dates beyond that. This is done by setting the 'Search Look
  103. Ahead'. This is set by selecting the 'Search' sub-menu from the main menu,
  104. and entering the number of days in the 'Days Ahead' option. Note that a
  105. value of '1' entered in this menu item will limit the search to just the
  106. current selected date, and a value of 2 will include the day after, and so
  107. on.
  108.  
  109. This sub-menu also includes two quick short cuts, called 'Today' and 'This
  110. Week'. Selecting 'Today' will display this month's calendar, with todays
  111. date selected, and set the look ahead to '1'.
  112.  
  113. Selecting 'This Week' performs the same as the 'Today' option, only the look
  114. ahead is set to 7 days.
  115.  
  116. The final item on the Search sub-menu is a general search which searches the
  117. text within the database, and will display date and text entries which
  118. contain a match. This search is case insensitive for convenience.
  119.  
  120.  
  121. The 'Tidy' function
  122. -------------------
  123.  
  124. So that your diary database does not fill up with unnecessary past events,
  125. there is a 'Tidy' function which will sift through the database and remove
  126. any out of date entries. This function, however, needs to be initiated by
  127. the user, and this is done by simply selecting the 'Tidy' option on the main
  128. menu.
  129.  
  130. This function can only remove things that it can work out as being out of
  131. date. Thus it can not remove any items which have the year set to 'All'. It
  132. can however remove diary items with anything other than the year set to
  133. 'All'.
  134.  
  135.  
  136. Command Line Options
  137. --------------------
  138.  
  139. There are several option which you can specify when loading Calenary, and
  140. these options allow certain features to be set. The options available are :
  141.  
  142.     -reminder           This option makes Calenary start up in 'Reminder'
  143.                         mode. In this mode as soon as Calenary starts up
  144.                         the database is searched for the current date.
  145.                         If any matches are made these are displayed.
  146.                         If no matches are made, or when you close the
  147.                         display window, the program automatically exits.
  148.  
  149.     -daily              This option can be used in conjunction with
  150.                         the -reminder option. When set it keeps a note of
  151.                         when the reminder option has been used, and only
  152.                         allows it to occur once a day. If you have already
  153.                         used the -reminder and -daily combination that day
  154.                         the program will just quit. This option uses a file
  155.                         (pointed to by the variable <Calenary$Daily>) to note
  156.                         when you last used this option.
  157.  
  158.     -days num           This option sets the initial look ahead (default 1).
  159.  
  160.     -data file          This option set the file to be used as the diary
  161.                         database. By default the file used is specified by
  162.                         the variable Calenary$File which is setup in the
  163.                         !Run file within the Calenary application.
  164.  
  165.     -2D                 By default Calenary adds a 3D look to its windows
  166.                         as far as it can. Under RiscOS 2 only the Calendar
  167.                         and Display windows will have this look, but under
  168.                         RiscOS 3 the Diary window will also have a 3D
  169.                         look. However some people don't like this look, and
  170.                         so adding this option will force a 2D look to ALL
  171.                         the windows.
  172.  
  173.  
  174. Technical Stuff
  175. ---------------
  176.  
  177. Variables :      <Calenary$Dir>    This is used for loading sprites and
  178.                                    templates, etc.
  179.  
  180.                  <Calenary$File>   Points to data file to use to store
  181.                                    diary. This file does not need to exist
  182.                                    but will be created when items are placed
  183.                                    in the diary.
  184.  
  185.                  <Calenary$Daily>  Points to a file, which does not need to
  186.                                    exist. It is used by Calenary to ascertain
  187.                                    when you last used the '-daily' option.
  188.  
  189.  
  190. Memory : Calenary starts off with a wimpslot size of 96k to hold the
  191.          application. Diary data is loaded on top of this, and so the wimpslot
  192.          size will actually be larger than this. As more memory is needed,
  193.          more memory is requested automatically by the program. Thus there is
  194.          no need to worry about large diary files, unless there is not enough
  195.          memory left in the computer to handle them.
  196.  
  197.  
  198. Calenary and years gone by
  199. --------------------------
  200.  
  201. Although Calenary is designed for the future, it can display the calendar
  202. for any month, in any year. However in the past, different calendars were in
  203. use, and there were different ways of working out certain aspects, such as
  204. leap years.
  205.  
  206. Calenary assumes the current leap year calculation for all years, and thus
  207. will be incorrect you years before this calculation came into use. It does,
  208. however, know about the transition between calendars that occurred in
  209. September 1752.
  210.  
  211.