summaryrefslogtreecommitdiff
path: root/docs/usermanual
authorspiralman <spiralman>2002-08-12 21:27:47 (UTC)
committer spiralman <spiralman>2002-08-12 21:27:47 (UTC)
commit598c77cf0a0f934b0835498ba2ac9710cf60d8ca (patch) (side-by-side diff)
treeb981a244863697df17dc828d4ad7d7265508eb08 /docs/usermanual
parent6a83ebf59b68cd8b87f03ef15f07d39748726408 (diff)
downloadopie-598c77cf0a0f934b0835498ba2ac9710cf60d8ca.zip
opie-598c77cf0a0f934b0835498ba2ac9710cf60d8ca.tar.gz
opie-598c77cf0a0f934b0835498ba2ac9710cf60d8ca.tar.bz2
added info on beaming contacts, tasks, and appointments, plus files from the documents tab.
Diffstat (limited to 'docs/usermanual') (more/less context) (show whitespace changes)
-rw-r--r--docs/usermanual/calendar.sgm9
-rw-r--r--docs/usermanual/contacts.sgm9
-rw-r--r--docs/usermanual/irda.sgm13
-rw-r--r--docs/usermanual/todo.sgm9
4 files changed, 39 insertions, 1 deletions
diff --git a/docs/usermanual/calendar.sgm b/docs/usermanual/calendar.sgm
index 3257ae0..99a810c 100644
--- a/docs/usermanual/calendar.sgm
+++ b/docs/usermanual/calendar.sgm
@@ -142,49 +142,58 @@ Underneath this you can set the timezone of the appointment from the dropdown
list. To change the available timezones, click the world icon, and it will open
the City Time application. Refer to its documentation for changing the
timezones. If you want to have an alarm go off, check the "alarm" checkbox,
and then set the number of minutes before the appointment that you want the
alarm to sound. If you set the dropdown list next to that to "silent" you will
only be given a visual alarm, wheras if you set the alarm to "Loud", there
will be an alarm sound as well. Note: opie-alarm must be installed for alarms to
work.
</para>
<para>
To set whether the appointment repeats, click the "Repeat" button and a new
dialog will open up. At the top is a row of buttons, which lets you set how
often the appointment repeats. Selecting one of these buttons will change the
interface below, to represent the available options for that type of repetition
(selecting "None" will turn off repetition if you turned it on and no longer
want it). When you are done, click "ok" in the upper right to select that type
of repetition, or "x" to set it back to what it was (none if it is a new
appointment).
</para>
<para>
Finally, you can add notes to the appointment by clicking the "Notes..."
button which will open a dialog with a text entry field for adding notes. Press
"ok" to accept the changes to the notes, "x" to cancel.
</para>
<para>
When you are done setting up the appointment, click "ok" in the top right of
the window, or "x" to cancel adding the appointment.
</para>
</section>
<section><title>Editing Appointments</title>
<para>
How you start editing an appointment varies depending on what view you are in,
but they will all open the same dialog. The dialog is the same as the Add
Appointment dialog, except that the fields will already be filled in with the
information that the appointment contains. Clicking "ok" will keep your
changes, "x" will revert them to what they were before you edited them.
</para>
</section>
<section><title>Finding Appointments</title>
<para>
To find a specific appointment, click the find button in the toolbar (small
green magnifying glass) and it will open a find dialog. Here you can enter the
text you want to search for, as well as the category you want to search for, as
well as the start date, and whether you want the search to be case sensitive.
Click "Find" to find the next appointment that matches your criteria.
</para>
</section>
+
+<section><title>Beaming Appointments</title>
+<para>
+To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA
+Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to
+send in the Day View, and select Beam from the menu that appears. Opie will then send the appointment to any
+waiting device.
+</para>
+</section>
</chapter> \ No newline at end of file
diff --git a/docs/usermanual/contacts.sgm b/docs/usermanual/contacts.sgm
index a3ad34a..8ba7674 100644
--- a/docs/usermanual/contacts.sgm
+++ b/docs/usermanual/contacts.sgm
@@ -44,56 +44,65 @@ To edit the contacts, select the person you want to edit, anc click the pencil
icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>,
and it will open up the same dialog used to add a user, except their information
that is already entered will already be filled in. To finalise the changes,
click "Ok", or to cancel them, click "x".
</para>
</section>
<section><title>Deleting Contacts</title>
<para>
To delete a contact, select the person from the list of contacts, and click the
trash can icon, or go to <GUIMenu>Contact</GUIMenu>
&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you
want to actually delete that contact, click yes to delete it, no will cancel.
</para>
</section>
<section><title>Editing Contacts</title>
<para>
To find a specific person, click the find icon (green magnifying glass), or go
to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog
will pop up, and in the "Find what" input, enter the string you want to search
for. You can also select if you want the search to be case sensative, and if you
want it to search backwards from the currently selected user. The Category drop
down menu lets you search only a specific category ("All" to search all of
them). When you click "Find", it will start search for the string in all the
fields in all the contacts. When it finds a match, it will highlight the user in
the main view. You can use this to search for (as an example) who a certain
phone number belongs to, by entering the phone number in the "find what" field,
and clicking "Find".
</para>
</section>
<section><title>Viewing Contacts</title>
<para>
To view only the contacts in a certain category, go to the View menu, and check
the categories you want to view.
</para>
<para>
The list of letters on the bottom of the window lets you look at only the
contacts who's names begin with that letter. These work much like entering text
on a mobile phone. For example, to view all the contacts whos name starts with
"B", press the "ABC" group twice (since "B" is the second letter in that
group). To go back to displaying all of the letters, click it two more times
(pressing it four times brings you back to all the letters, so you pressed it 2
times to get to "B" and 2 more times to get back to all letters. 2+2=4).
</para>
</section>
+<section><title>Beaming Contacts</title>
+<para>
+To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it.
+(see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the
+beam icon in the toolbar, or select Contact&arrow;Beam Entry. Opie will then send the contact using the IrDA and
+OBEX protocols to any waiting device.
+</para>
+</section>
+
<section><title>Personal Details</title>
<para>
Change your personal details by going to <GUIMenu>Contact </GUIMenu>
<GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to
display who the device belongs to, as well as other apps.
</para>
</section>
</chapter> \ No newline at end of file
diff --git a/docs/usermanual/irda.sgm b/docs/usermanual/irda.sgm
index 2ca48c6..a2f084c 100644
--- a/docs/usermanual/irda.sgm
+++ b/docs/usermanual/irda.sgm
@@ -1,34 +1,45 @@
-<chapter><title>IrDA Applet</title>
+<chapter id=irda><title>IrDA Applet</title>
<para>
The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA
protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that
can use infra red to communicate.
</para>
<section><title>Starting IrDA</title>
<para>
To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and
clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed
properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using.
</para>
</section>
<section><title>Recieving Files</title>
<para>
If you want to recieve files like images or contact information from another device, you need to tell your device to
start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A
green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from
the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then
have the other device send the file, and Opie should recieve it and open the file in whatever application is
appropriate.
</para>
<para>
When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the
IrDA Applet's menu so that you are not wasting system resources.
</para>
</section>
+<section><title>Beaming Files</title>
+<para>
+Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar,
+and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the
+file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the
+Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you
+havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for
+the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this
+button, and Opie will beam the file to any waiting devices.
+</para>
+</section>
<section><title>Stoping IrDA</title>
<para>
Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this,
select "Disable IrDA" from the IrDA applet's menu.
</para>
</section>
</chapter> \ No newline at end of file
diff --git a/docs/usermanual/todo.sgm b/docs/usermanual/todo.sgm
index f7c5f11..18138d9 100644
--- a/docs/usermanual/todo.sgm
+++ b/docs/usermanual/todo.sgm
@@ -38,49 +38,58 @@ the way it was.
</section>
<section><title>Deleting Tasks</title>
<para>
To delete a task, first select it, and then either select
<GUIMenu>Data</GUIMenu>&arrow;
<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of
a trash can). A dialog should pop up, asking if you want to delete the task,
click yes to delete it, or no to cancel.
</para>
</section>
<section><title>Finding Tasks</title>
<para>
To find a task, either go to
<GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>
, or click the find icon (an image of a green magnifying glass), and a dialog
should pop up. Enter the text you want to search for in the description, and
select the category that you want it to search through (this will speed the
search up, if you know what category it is in). You can also select "case
sensative" which makes the search pay attention to the case of what you type (so
if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search
Backwards" will search backwards from the currently selected task. Click "Find"
to initiate the search, when it finds a task that matches the string, it will
select it. If you click Find again, it will find the next one in the list (or
the previous one, if "Search backwards" is selected).
</para>
</section>
<section><title>Viewing Tasks</title>
<para>
To only view tasks filled under certain categories, go to the Category menu, and
check the categories you want to view. Also, under the Options menu, you can
select whether or not you want completed tasks to be visible, and whether or not
you want to see the deadline.
</para>
</section>
<section><title>Completing Tasks</title>
<para>
To mark a task as completed without deleting it, you can either check the
checkbox next to it in the main view, or edit it, and check the "completed"
check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow;
<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will
disapear when you mark it completed. but do not worry, it is not gone forever,
just check Completed tasks in the options menu, and you can see and edit it
again.
</para>
</section>
+
+<section><title>Beaming Tasks</title>
+<para>
+To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA
+Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select
+press the Beam icon in the toolbar, or select Data&arrow;Beam. Opie will then send the task to any waiting
+device.
+</para>
+</section>
</chapter> \ No newline at end of file