summaryrefslogtreecommitdiff
path: root/docs/usermanual/calendar.sgm
Unidiff
Diffstat (limited to 'docs/usermanual/calendar.sgm') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/calendar.sgm190
1 files changed, 190 insertions, 0 deletions
diff --git a/docs/usermanual/calendar.sgm b/docs/usermanual/calendar.sgm
new file mode 100644
index 0000000..3257ae0
--- a/dev/null
+++ b/docs/usermanual/calendar.sgm
@@ -0,0 +1,190 @@
1<chapter><title>Calendar</title>
2<para>
3The Calendar is a way to keep track of all your appointments, birthdays,
4meetings, or any other event that you would put in a calendar.
5</para>
6
7<section><title>Navigation</title>
8<para>
9Navigation in the Calendar is simple. Along the top are five different buttons
10that allow you to set the type of view, which correspond to the five items in
11the "View" menu. Each one (except for "Today") changes the amount of time
12shown on the screen. "Day" shows one day, "Week" one week, etc. Today is the
13same as Day, except that it automatically sets the view to the current day.
14</para>
15<section><title>The Day view</title>
16<para>
17The day view shows your day divided up into blocks representing each hour. At
18the top is the navigation bar, wher you will see a row of buttons, which
19represent the days of the current week, and on the left and right sides of the
20navigation bar are arrows, which allow you to move one day in that direction. If
21you are on the last day of the week, pressing the arrow will bring you into the
22first day of the next week (or vice-versa if you are going backwards). There is
23also a button that lists the current day, which you can press to select a day to
24view from a calendar dialog.
25</para>
26<para>
27In the main view, there is a collumn of buttons, each of which represents one
28hour. If you select one, any new appointments will automatically default to
29begining at that time and ending an hour later (which you can, of course, change
30when you create the appointment).
31</para>
32<para>
33Clicking on an appointment will open a menu that lets you edit, delete or beam
34the appointment. Beam will beam the appointment to any device supporting the
35Obex protocol (PalmOS based devices, cellphones, etc). libopieobex must be
36installed to use this feature.
37</para>
38</section>
39
40<section><title>The Week View</title>
41<para>
42The week view allows you to see your week divided up into columns, representing
43each day of the week, and rows, representing each hour of the day. In the
44navigation bar at the top, there are two scroll boxes, the one on the left shows
45the current year, and the one to the right shows which week it is of that year.
46To the right of both of those is a label which shows the date range for the
47currently selected week.
48</para>
49<para>
50In the main view, you see the week divided up into rows and collumns
51representing the days of the week, and hours of the day. In each cell, you will
52see a blue square which represents an appointment, which you can press to see
53details of the appointment. If you press anywhere in the free space, you will go
54to the day of the column that you clicked in.
55</para>
56</section>
57
58<section><title>The Week List View</title>
59<para>
60The week list view shows you all the appointments that you have that week
61without graphically representing how long they are or showing the free time
62between them. This is convinient if you need to see a list of all your
63appointments, but do not need to see how your time is mapped out. The navigation
64bar has an arrow button on either side, allowing you to move to the next or
65previous week, as well as a button which gives the current week number for that
66year. Pressing the week number button will bring up a calendar dialog, which
67allows you to select the week you are viewing. Selecting a day from the calendar
68
69will bring you to the week that day is in. To the right of that is a button with
70a "2" in it. When this is depressed, the main view will show two weeks at a
71time, instead of one. The last item is a label which shows the range of dates
72for the currently selected week.
73</para>
74<para>
75The main view is comprised of several rows, each of which represents a day of
76the week. If you have an appointment on that day, the date will be red,
77otherwise it will be black (the current day is blue). Clicking on the date
78itself will bring you to the day view for that day. Under each day is a list of
79all the appointments for that day, as well as their start times. If you click on
80an appointment, you will go to an edit dialog for that appointment, which lets
81you view its details. Next to each day heading is a "+" sign, clicking it will
82create a new appointment for that day.
83</para>
84</section>
85
86<section><title>The Month View</title>
87<para>
88The month view looks like a normal monthly calendar, allowing you to see on what
89
90days of the month you have appointments. In the navigation bar, there are two
91pairs of arrows. The pair with an arrow and a vertical line will take you to the
92first or last month of the currently selected year, while the normal arrow
93buttons will take you to the next or previous month. There is a dropdown menu
94which allows you to select the month, and a entry field which allows you to
95select the year (press the up or down arrows, or enter in your own year).
96</para>
97<para>
98The main view is divided up into a grid, where the columns are the days of the
99week, and the rows are the weeks (just like an ordinary calendar). The currently
100selected day has a bold box drawn around it, and if the day has an appointment,
101there will be a small blue square in the bottom right corner of it (that square
102will have a smaller white square if it is a recurring appointment). If the
103appointment is an all day event, it will be drawn as a green dot instead. When
104you click on the sqaure of a day, you will be taken to the day view for that
105day.
106</para>
107</section>
108</section>
109
110<section><title>Adding Appointments</title>
111<para>
112To add an appointment, click on the add appointment button in the toolbar at the
113top of the window (an image of a blank page), and a dialog will open up,
114allowing you to enter information about the appointment (depending on the
115current view, and what you may have selected, there may be certain default
116settings).
117</para>
118<para>
119At the top of the window is the description field, where you can enter in a
120short description of the appointment, or select a common one from the dropdown
121list. The location field allows you to do the same. The category dropdown allows
122
123you to assign the appointment to a category, which you can use later to view
124only some of your appointments. The button labeled "..." to the right of that
125will open up a dialog where you can add, delete, or edit certain categories.
126</para>
127<para>
128To enter a start and end time, select the date for each from the dropdown menu,
129and then you can either manually enter a time, or you can use the three rows of
130numbers to more quickly enter it in. To use the fast input method, first click
131in the text entry field of the time you want to edit, then you need to select
132the hour. The first two rows are the hours, click whichever one you want. The
133third row of numbers are the minutes, in units of five. When you select the
134minutes field for the start time, it will automatically set the minutes field
135for the end time to the same thing, but you can change this by selecting the end
136field and giving it its own minutes field. Because of this, it is fastest to set
137the start time first and then the end time. There is also an "all day"
138checkbox, which will make the appointment take up the entire day.
139</para>
140<para>
141Underneath this you can set the timezone of the appointment from the dropdown
142list. To change the available timezones, click the world icon, and it will open
143the City Time application. Refer to its documentation for changing the
144timezones. If you want to have an alarm go off, check the "alarm" checkbox,
145and then set the number of minutes before the appointment that you want the
146alarm to sound. If you set the dropdown list next to that to "silent" you will
147only be given a visual alarm, wheras if you set the alarm to "Loud", there
148will be an alarm sound as well. Note: opie-alarm must be installed for alarms to
149work.
150</para>
151<para>
152To set whether the appointment repeats, click the "Repeat" button and a new
153dialog will open up. At the top is a row of buttons, which lets you set how
154often the appointment repeats. Selecting one of these buttons will change the
155interface below, to represent the available options for that type of repetition
156(selecting "None" will turn off repetition if you turned it on and no longer
157want it). When you are done, click "ok" in the upper right to select that type
158of repetition, or "x" to set it back to what it was (none if it is a new
159appointment).
160</para>
161<para>
162Finally, you can add notes to the appointment by clicking the "Notes..."
163button which will open a dialog with a text entry field for adding notes. Press
164"ok" to accept the changes to the notes, "x" to cancel.
165</para>
166<para>
167When you are done setting up the appointment, click "ok" in the top right of
168the window, or "x" to cancel adding the appointment.
169</para>
170</section>
171<section><title>Editing Appointments</title>
172<para>
173How you start editing an appointment varies depending on what view you are in,
174but they will all open the same dialog. The dialog is the same as the Add
175Appointment dialog, except that the fields will already be filled in with the
176information that the appointment contains. Clicking "ok" will keep your
177changes, "x" will revert them to what they were before you edited them.
178</para>
179</section>
180
181<section><title>Finding Appointments</title>
182<para>
183To find a specific appointment, click the find button in the toolbar (small
184green magnifying glass) and it will open a find dialog. Here you can enter the
185text you want to search for, as well as the category you want to search for, as
186well as the start date, and whether you want the search to be case sensitive.
187Click "Find" to find the next appointment that matches your criteria.
188</para>
189</section>
190</chapter> \ No newline at end of file