summaryrefslogtreecommitdiff
Side-by-side diff
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--docs/usermanual/usermanual.sgm3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 0232cd3..f691889 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,388 +1,391 @@
<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [
<!ENTITY arrow "-->">
]>
<book><title>Opie User Manual</title>
+<bookinfo><authorgroup><collab>
+<collabname>The Opie Team</collabname>
+</collab></authorgroup></bookinfo>
<part><title>Getting Started</title>
<chapter><title>What is Opie?</title>
<para>
Opie is a GUI (Graphical User Interface) for the Linux operating system (and
might work on other OSes as well). It was originally designed for handheld
computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
probably function well in other environments requiring a light GUI, such as an
old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech,
which is in turn a graphical environment designed for embedded applications,
based upon the QT toolkit.
</para>
<para>
Opie has been designed for devices with small screens, and a touchscreen input
device (ie, only one mouse click, and no constant mouse position), as well as
designed to fit in a relatively small amount of storage space (about 5 megabytes
for the base libraries and the launcher).
</para>
</chapter>
<chapter><title>Installation</title>
<section><title>iPAQ</title>
<para>
To install opie on an iPAQ, you will need a fresh Familiar installation (ie,
install Familiar, and stop before you do ipkg install task-complete or ipkg
install task-x), go to http://familiar.handhelds.org to get the latest version,
and to get installation instructions (again, stop after the initial boot and do
not install X, as it is not necessary, and will only take up space).
</para>
<note>
<para>
If you had qpe/qtopia installed previously,
<emphasis>completely</emphasis> remove it, and remove the src line for it from
your /etc/ipkg.conf file before attempting to install opie.
</para>
</note>
<para>
Once you have Familiar installed, set up a network connection between your iPAQ
and the ouside world (again, see the Familiar site for instructions on this),
and then run this command:
<informalexample>
<literallayout>
echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
>> /etc/ipkg.conf
</literallayout>
</informalexample>
then, run:
<informalexample>
<literallayout>
ipkg update && ipkg install task-opie
</literallayout>
</informalexample>
If you have a 3100 or 3800 series iPAQ, run:
<informalexample>
<literallayout>
ipkg install qt-embedded-rotation
</literallayout>
</informalexample>
finally, start Opie with:
<informalexample>
<literallayout>
/etc/init.d/opie start
</literallayout>
</informalexample>
</para>
<para>
Opie should now be running (if you should have to reboot, which is rare, Opie
will start automatically). From here, you can use either the "Software"
application in the Settings tab, or run ipkg from the command line to install
other Opie apps. Check out the various task-opie-* ipkgs to install various sets
of apps at once (you can always uninstall individual apps individually). You
will probably want to install opie-embeddedkonsole first, so you have access to
the command line in Opie.
</para>
</section>
<section><title>Zaurus</title>
<para>
To completely install Opie on the Zaurus, you will have to install OpenZaurus,
which includes Opie. However, individual Opie applications will work fine on the
default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM
though.
</para>
</section>
</chapter>
<chapter><title>Using Opie</title>
<para>
Now that Opie is installed and running, it's time to start using it. When you
first start Opie, you will see the "Launcher" from which you can start all of
your Applications, and the "Taskbar" along the bottom, where you can see all
the running applications, select an input method, and interact with the
installed "applets".
</para>
<section><title>Getting Around</title>
<para>
Getting around in Opie is very easy, you simply click your stylus on whatever
icon or button you want to click on. The main difference between using the
stylus and using a mouse is that you cannot right click with a stylus, so things
that require a right click are kept to a minimum. However, it is sometimes
necessary to right click, and this is implemented with a "press and hold".
Any time you want to do something that you think would require a right click on
a normal pc, try pressing the stylus down and holding it still for a few
seconds. This usually opens up a context sensative menu, much like a right
click usually does on a desktop interface.
</para>
</section>
<section><title>Launcher</title>
<para>
The Launcher behaves like the "desktop" on most PC GUIs. When no applications
are running or visible, you will have access to the Launcher. You can also map
a hardware key to bring the Launcher to the top without closing any of the
running applications (this is similar to "minimising" all the applications
that are running).
</para>
<para>
Along the top of the Launcher you will see a list of tabs which function as
categories for your applications. You can click on the tab for the category you
want to view, and then click on the icon for the application that you wish to
launch. By default, there will be an Applications tab and a Settings tab (if
you install any games, they will appear in the Games tab). When new
applications are installed, they will usually appear in one of these three tabs,
or in a tab of their own. To add or delete tabs or to move applications between
the tabs, you can use the Tab Manager application, or you can edit them by hand,
by changing the directories in /opt/QtPalmtop/apps.
</para>
<para>
There is also a tab to the far right called the "Documents" tab, which allows
you to quickly open your most often used documents. You can click on a document
to open it up in the proper application. For help on adding files to the
Documents tab see the <xref linkend="adddoc">.
</para>
</section>
<section><title>Taskbar</title>
<para>
Opie has a "Taskbar" that always runs along the bottom of the screen in Opie,
except for a few "fullscreen" applications that cover it up. The Taskbar is
what lets you select which input method you would like to use, shows what
applications are running, and is also where the "applets" draw their icons.
On the left of the Taskbar is an "O" button that opens a menu which has an
entry for every tab in the Launcher, allowing you to star an applications
without going back to the Launcher, or quiting the application that you are
running. On the right hand side of the Taskbar, you will probably see a clock
(unless you installed task-opie-minimal), which is actually just another applet
that draws the time instead of an icon.
</para>
<para>
When an application is run, it adds its icon to the Taskbar, starting from the
right side of the input method icon, with new application's icons appearing to
the right. If you click on the icon for an application, it will be brought to
the screen, allowing you to interact with it.
</para>
<para>
To the right of the "O" menu you will see an icon for the currently selected
input method. Clicking this will bring up the input method, allowing you to
type into the currently running application. To the right of the input method
icon is a small arrow pointing up, which will open a menu of all the currently
installed input methods when clicked. When you select one of these, it will
become the current input method, with its icon replacing the previous one.
</para>
</section>
<section><title>Dialogs</title>
<para>
In Opie, dialogs, as well as some applications, have a button labeled "Ok" on
the right side of the window title bar, in addition to the normal "x". For
dialogs, the "Ok" button will apply your changes and close the window, while
the "x" will cancel them before closing the window (for people used to most
desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons
you would normally see in the bottom right of the dialog window).
</para>
<para>
For applications that have an "Ok" button as well as the "x" button that all
applications have, the "Ok" button will usually save the current file and then
close the application, while the "x" button will close the application without
saving.
</para>
</section>
</chapter>
<chapter><title>Upgrading</title>
<para>
First, you should shutdown Opie from the "Shutdown" app in the Settings tab.
Normally, simply running
<informalexample>
<literallayout>
ipkg update && ipkg upgrade
</literallayout>
</informalexample>
will upgrade Opie. However, if you currently have a version with the 1.5.0
version number, you will have to upgrade it differently, because Opie now uses a
different version number (the 1.5.0 was Qtopia's version number, we now use our
own). To upgrade from one of these older versions, run:
<informalexample>
<literallayout>
ipkg update
ipkg install opie-update
</literallayout>
</informalexample>
Opie should then be upgraded.
</para>
</chapter>
</part>
<part><title>Applications</title>
<chapter><title>Contacts</title>
<para>
Contacts is a way to keep track of all the people you know, and how to contact
them. as well as other information, such as their birthday, the company they
work for, etc.
<para>
<section><title>Adding Contacts</title>
<para>
To Add a user, go to
<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>,
or click the add icon in the toolbar (looks like a blank piece of paper).
First, you need to give the person a name. You can do this by either entering
their name in the name field, or by pressing "Full Name...", which will open
up a new dialog that lets you enter each part of their name individually. Three
of the entry fields have pulldown menus instead of labels that let you set which
parameter these input fields control. The File As field lets you control how
their name is displayed in the main view, use the pulldown arrow to select from
some common ways of ordering their first and last names, or type in a custom
one. You can also select a category for the user to be filed under, and clicking
the button labeled "..." lets you edit the available catagories (these are
convinient for displaying just the contacts you want when you have a lot of
them).
</para>
<para>
The address tab lets you edit the contact's buisness and home addresses (select
which one you want to change from the pulldown menu at the top). The bottom
field behaves just like the three custom fields in the "General" tab (and if
you select the same thing from the pulldown list, it will modify the same
parameter).
</para>
<para>
The Details tab is used for miscelaneous things like the person's position, the
name of their spouse, etc.
</para>
<para>
When you are done, click "Ok" in the top right of the screen (you can always
edit their profile later), click the "x" to cancel, and not add the contact.
</para>
</section>
<section><title>Editing Contacts</title>
<para>
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>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>
<chapter><title>Calendar</title>
<para>
The Calendar is a way to keep track of all your appointments, birthdays,
meetings, or any other event that you would put in a calendar.
</para>
<section><title>Navigation</title>
<para>
Navigation in the Calendar is simple. Along the top are five different buttons
that allow you to set the type of view, which correspond to the five items in
the "View" menu. Each one (except for "Today") changes the amount of time
shown on the screen. "Day" shows one day, "Week" one week, etc. Today is the
same as Day, except that it automatically sets the view to the current day.
</para>
<section><title>The Day view</title>
<para>
The day view shows your day divided up into blocks representing each hour. At
the top is the navigation bar, wher you will see a row of buttons, which
represent the days of the current week, and on the left and right sides of the
navigation bar are arrows, which allow you to move one day in that direction. If
you are on the last day of the week, pressing the arrow will bring you into the
first day of the next week (or vice-versa if you are going backwards). There is
also a button that lists the current day, which you can press to select a day to
view from a calendar dialog.
</para>
<para>
In the main view, there is a collumn of buttons, each of which represents one
hour. If you select one, any new appointments will automatically default to
begining at that time and ending an hour later (which you can, of course, change
when you create the appointment).
</para>
<para>
Clicking on an appointment will open a menu that lets you edit, delete or beam
the appointment. Beam will beam the appointment to any device supporting the
Obex protocol (PalmOS based devices, cellphones, etc). libopieobex must be
installed to use this feature.
</para>
</section>
<section><title>The Week View</title>
<para>
The week view allows you to see your week divided up into columns, representing
each day of the week, and rows, representing each hour of the day. In the
navigation bar at the top, there are two scroll boxes, the one on the left shows
the current year, and the one to the right shows which week it is of that year.
To the right of both of those is a label which shows the date range for the
currently selected week.
</para>
<para>
In the main view, you see the week divided up into rows and collumns
representing the days of the week, and hours of the day. In each cell, you will
see a blue square which represents an appointment, which you can press to see
details of the appointment. If you press anywhere in the free space, you will go
to the day of the column that you clicked in.
</para>
</section>
<section><title>The Week List View</title>
<para>
The week list view shows you all the appointments that you have that week
without graphically representing how long they are or showing the free time
between them. This is convinient if you need to see a list of all your
appointments, but do not need to see how your time is mapped out. The navigation
bar has an arrow button on either side, allowing you to move to the next or
previous week, as well as a button which gives the current week number for that
year. Pressing the week number button will bring up a calendar dialog, which
allows you to select the week you are viewing. Selecting a day from the calendar
will bring you to the week that day is in. To the right of that is a button with
a "2" in it. When this is depressed, the main view will show two weeks at a
time, instead of one. The last item is a label which shows the range of dates
for the currently selected week.
</para>
<para>
The main view is comprised of several rows, each of which represents a day of
the week. If you have an appointment on that day, the date will be red,
otherwise it will be black (the current day is blue). Clicking on the date