home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / cal / !Cal / !Help < prev    next >
Text File  |  1996-07-06  |  11KB  |  312 lines
  1.  
  2.  
  3.  
  4.              Cal                          © copyright 1996, Dr. Ian Palmer
  5.              ===
  6.              
  7.              
  8.              
  9. Introduction
  10. ------------
  11.  
  12. Cal is a combined Calendar and Diary application for RiscOS. It allows the
  13. user to maintain details of future events, aniversaries, holidays,
  14. appointments, business trips, etc.
  15.  
  16. Cal also has inbuilt knowledge of all British public holidays, and other
  17. standard diary entries.
  18.  
  19.  
  20. Running Cal
  21. -----------
  22.  
  23. When you first run Cal it installs itself on the iconbar and opens a calendar
  24. window in the top left of the screen showing the current month's calendar.
  25.  
  26. The current day is highlighted in red, and the current date in full is
  27. displayed at the bottom of the calendar. Either side of the full date are two
  28. icons for moving the display back/forward one month at a time.
  29.  
  30. As well as highlighting the current date (number displayed in red) other
  31. dates may be highlighted as follows:
  32.  
  33.   - Public holidays in blue
  34.   - Sundays in green
  35.   - Notable dates in darker grey
  36.   
  37. These are all inbult dates, if you have diary entries set up (see below) for
  38. any of the days in the month then these too will be highlighted, only this
  39. time with a change to background colour:
  40.  
  41.   - Events are highlighted in light blue
  42.   - Holidays are highlighted in orange
  43.   - Appointments are highlighted in a darker grey
  44.   - Aniversaries are highlighted in bright yellow
  45.   - Buisiness trips are highlighted in pale yellow
  46.  
  47. If you press SELECT over any of the dates in the current month displayed in
  48. the calendar then the diary page will be opened for that date. This shows the
  49. entries in the diary for that date in full.
  50.  
  51.  
  52. Setting up Diary entries
  53. ------------------------
  54.  
  55. You can enter a diary entry in two ways. First pressing ADJUST on the iconbar
  56. icon, second by pressing ADJUST over one of the calendar entries.
  57.  
  58. When you perform either of these a window is opened allowing you to specify a
  59. new diary entry, or edit exsisting entries.
  60.  
  61. At the top right of this window is an icon specifying the type of diary entry
  62. (event, holiday, appointment, aniversary or business trip are the default
  63. types). To change the type either press MENU over this icon, or SELECT the
  64. menu display icon to its right. This brings up a menu with the possible
  65. options.
  66.  
  67. Once you have selected the diary entry type you can specify the date(s)
  68. and/or time(s) of the entry. What needs to be specified depends upon the
  69. entry type:
  70.  
  71.   - For an event the date, month and year need to be specified
  72.   - For a holiday start and end date, month and year entires are required
  73.   - For an appointment the date, month and year and also start and end
  74.     times must be entered
  75.   - For an aniversary only date and month are required
  76.   - Buisiness trips are the same as holidays (above)
  77.   
  78. The entries that don't need to be specified are greyed out accordingly.
  79.  
  80. After setting the date(s) and time(s) you can enter up to two lines of text
  81. to be associated with the entry. Then SELECT the 'Save' icon to save the
  82. entry.
  83.  
  84.  
  85. Other icons on the window allow you to move through the entries ('Prev' and
  86. 'Next' move to the previous and next entries), as well 'Delete' an entry,
  87. create a 'New' entry and also 'Update' an exsisting entry after making
  88. changes.
  89.  
  90. Note: Month and Year fields can both contail the value 'All' to make more
  91. general entries, and the date field can contain entries such as 'every Mon'
  92. or '3rd Tue'. These values can be located by moving past the standard entries
  93. using the up/down arrows.
  94.  
  95.  
  96. The Calendar
  97. ------------
  98.  
  99. The Calendar window, as mentioned above, displays a complete month with
  100. highlights for events, etc.
  101.  
  102. Clicking SELECT over a given date displayes the diary page for that date.
  103. Clicking ADJUST over a given date allows a diary entry to be created for that
  104. date.
  105. Clicking MENU over the window brings up a window allowing you to select any
  106. month/year combination for diaplay.
  107.  
  108. Clicking the '<' or '>' icons in the Calendar window move backwards and
  109. forewards one month at a time.
  110.  
  111.  
  112. The Diary Page
  113. --------------
  114.  
  115. Clicking SELECT on any date in the current month displayed in the calendar
  116. window will open the diary page for that date. The diary page gives a list of
  117. all dairy entries for that date, including built in dates.
  118.  
  119. The built in dates include all UK public holidays (many relevant to the rest
  120. of the world) as well as many notable dates (eg. Christmas Eve). These events
  121. can be switched off using the configuration window if they are not required
  122. (see below).
  123.  
  124.  
  125. Cal's Main Menu
  126. ---------------
  127.  
  128. Clicking MENU over Cal's iconbar icon brings up Cal's main menu. This
  129. contails the following options:
  130.  
  131.   Info       ->   Standard Information Window
  132.   Save       ->   Save window for saving your Diary (see below)
  133.   Tidy            Remove all past events from your diary
  134.   Look Ahead ->   Look ahead a number of days (see below)
  135.   Configure       Open configuration window
  136.   Quit            Quit Cal
  137.  
  138.  
  139. Configuration
  140. -------------
  141.  
  142. The configuration window allows you to set a few options. These are:
  143.  
  144.   Auto Save
  145.       Causes Cal to automatically save your diary when it quits.
  146.       
  147.   Auto Tidy
  148.       Causes Cal to perform a tidy operation each time it loads your diary.
  149.       
  150.   UK Hols
  151.       Specifies whether you are interested in inbuilt UK Public Holidays
  152.       (eg. May Day Bank Holiday)
  153.       
  154.   UK Notes
  155.       Specifies whether you are interested in inbuilt UK Notable dates
  156.       (eg. St. Georges Day)
  157.       
  158.   General Hols
  159.       Specifies whether you are interested in inbuilt general holiday
  160.       (eg. Christmas Day)
  161.       
  162.   General Notes
  163.       Specifies whether you are interested in inbuilt general notable dates
  164.       (eg. Ash Wednesday)
  165.       
  166.   Open today's diary on startup
  167.       Specifies whether you wish for today's diary to be opened when Cal
  168.       is run.
  169.  
  170.   Open Calendar on startup
  171.       Specifies whether you wish for the calendar to be opened when Cal
  172.       is run.
  173.  
  174. The 'OK' icon sets the configuration, 'Save' saves the configuration in Cal's
  175. configuration file so that the options are remembered for next time you run
  176. Cal.
  177.  
  178.  
  179. Saving Your Diary
  180. -----------------
  181.  
  182. By default Cal saves your diary in a file inside the Cal application
  183. directory. You can save the diary either by having 'Auto Save' set in the
  184. configuration or by selecting the 'Save' option in the main menu.
  185.  
  186. You can also save your diary in a different location by using the save window
  187. off the main menu. You can then view this diary file by double clicking on
  188. it.
  189.  
  190.  
  191. Looking Ahead
  192. -------------
  193.  
  194. You can cause the diary pages for the next few days/weeks to be displayed in
  195. a single window by using the look ahead option (in the main menu). This has
  196. options for looking ahead 5 days, 1 week, 2 weeks, 4 weeks or a user defined
  197. number of days.
  198.  
  199.  
  200. Diary Page on Bootup
  201. --------------------
  202.  
  203. You can add running Cal to your boot up sequence and have it open your diary
  204. page automatically by selecting the relevant configuration option.
  205.  
  206. However there are better options that can be supplied on the command line
  207. used to run Cal (placed in your system's !Boot file, or
  208. !Boot.Choices.Boot.Desktop file on a Risc PC)
  209.  
  210. For example add the following line to your relevant boot file:
  211.  
  212. Run ADFS::HardDisc4.$.Apps.!Cal.!Run -today
  213.  
  214. (assuming !Cal is in ADFS::HardDisc4.$.Apps) will run Cal and force today's
  215. diary page to be opened (irrespective of the configuration options).
  216.  
  217. A full list of command line options are:
  218.  
  219.   -noicon    - causes Cal to not place an icon on the iconbar
  220.   -quit      - (see below)
  221.   -today     - causes Cal to open todays diary page
  222.   -nocal     - stops Cal opening the Calendar window on startup
  223.   -daily     - causes Cal to open todays diary page (once a day)
  224.   -note      - (see below)
  225.   -look n    - causes Cal to look ahead n days
  226.   <file>     - causes Cal to use <file> instead of default diary file
  227.   
  228.   
  229. The -quit option can be used in conjunction with the -today or -daily options
  230. to force Cal to quit if no diary entries are relevant for today. The -note
  231. option stops notable events being included in the calculation as to whether
  232. there are events for today.
  233.  
  234. Thus the command line options:
  235.  
  236.     -nocal -daily -note -quit
  237.  
  238. causes Cal to prov