summaryrefslogtreecommitdiff
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/gettingaround.sgm160
-rw-r--r--docs/usermanual/installation.sgm45
2 files changed, 133 insertions, 72 deletions
diff --git a/docs/usermanual/gettingaround.sgm b/docs/usermanual/gettingaround.sgm
index 90aa3cf..34ef403 100644
--- a/docs/usermanual/gettingaround.sgm
+++ b/docs/usermanual/gettingaround.sgm
@@ -1,82 +1,136 @@
<chapter><title>Using &opie;</title>
+
+<section><title>Running &opie; for the first time</title>
+<para>
+If everything was installed as described in the previous section, &opie; should
+now start up and present a screen to calibrate the touchscreen. Using the stylus,
+press firmly in the middle of the cross-hairs as they appear on the screen. This
+usually needs to be done only once, however the screen can be re-calibrated at any
+time, if needed, by choosing the Calibrate application on the Settings tab.
+</para>
+
<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".
+Once the screen has been calibrated, &opie; will now start up. If the opie-login
+package is installed (which is installed with the default installation), a screen
+will appear requiring a person to log in before any applications can be accessed.
+The standard &opie; installation currently requires the user to log in as the
+'root' user in order for all functions to work correctly. Refer to the Familiar
+website (http://familiar.handhelds.org) for the default password for the version
+installed.
</para>
+<para>
+Once the correct password has been entered, &opie; should now be running. When
+rebooted however, &opie; will start automatically. To install and remove
+applications, the "Packages" application (located on the Settings tab) or the
+command line ipkg application can be used. There are several task-opie packages
+which allow the installation of whole categories (e.g. games, PIM, settings, etc.)
+of software at once. It also might be helpful to install either opie-embeddedkonsole
+or opie-console first to allow access a command line from within &opie;.
+</para>
+</section>
+
<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.
+Now that &opie; is installed and running, it is time to start using it. When &opie;
+is started (after logging in), the following will be visible: the "Launcher" from
+which all of the applications can be started, and the "Taskbar" along the bottom, where
+all running applications can be accessed, select an input method, and interact with the
+installed applets.
+</para>
+
+<para>
+Getting around in &opie; is very easy. Using the stylus, simply click on whatever
+icon, button or control desired. The main difference between using the stylus and using
+a mouse is that there is not an intuitive way to "right click" with the stylus. However in
+&opie;, by pressing and holding the stylus down on the screen for approximately one second
+(i.e. commonly referred to as "click and hold") a right mouse button click is generated.
+This allows the user to perform common actions such as display context sensitive menus.
+</para>
+
+<para>
+Also included in several &opie; applications is context sensitive help. If there is a icon
+with a question mark on the left side of the application's title bar, then this option
+is available. Clicking on this icon will display instructions on using this feature.
+Click and hold the icon, until the window title changes to "What's this..." and then
+click on a part of the application window to display the context sensitive help.
</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).
+The Launcher is where applications can be started, and is similar in concept to the desktop
+found in most computer graphical user interfaces. When no other applications are running,
+it is visible, occupying most of the screen.
</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.
+Along the top of the Launcher is a series of tabs which function as categories for all
+installed applications. By default, there are the following tabs: PIM, Applications and
+Settings. If any games are installed, there will also appear a Games tab. To launch an
+application, click once on the application icon or name. The icon will darken and an
+hour glass will appear on the taskbar at the bottom of the screen to indicate that the
+application is launching. Most applications take 1 or 2 seconds to start.
</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">.
+There is also a tab to the far right named Documents. It contains a listing of the
+documents found on the handheld device, allowing easy access. Documents are organized
+by document type and category. At the bottom of the Document tab are 2 selection boxes
+which allow the list of docuemnts to be filtered by these criteria. For instructions on
+adding and removing documents from this tab, see the <xref linkend="adddoc">.
</para>
+
+<para>
+The Launcher Settings application on the Settings tab allows each tab's appearance to
+be customized. Items that can be configured include background color/image, font, icon
+size and more. See the Launcher Settings section for more information.
+</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.
+The Taskbar is the small, horizontal section which appears at the bottom of the
+screen, below the Launcher. It is almost always visible while applications are
+running. The Taskbar provides the following functions (from left to right):
</para>
+
+<para>
+1. "O" menu - provides a listing of all installed applications, allowing them to be
+started if Launcher is not visible. It also provides an options to display Launcher
+if there are applications running, power off the handheld device and log out of &opie;.
+</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.
+2. Input methods - allows the selection of an input method. Each input method has its
+own, unique icon, and the current one selected is shown on the Taskbar. Click on the icon
+to display or hide the input method. If more than one method is installed, a small upward
+pointing arrow is shown to the right of the icon. Click on this arrow to select a
+different input method.
</para>
+
+<para>
+3. Running applications - if any applications are running, their icon will appear immediately
+to the right of the input method icon. Clicking on an icon will bring that application to
+the front so it can be viewed. When the application is exited, the icon will disappear from
+this area.
+</para>
+
+<para>
+4. Applets - applets are "mini" applications which appear on the right side of the Taskbar.
+Some applets provide quick access to information (e.g. PC cards installed, wireless nework,
+etc.), while others provide frequently used functions (e.g. notepad, voice memo recorder).
+Clicking on an applet's icon usually provides a menu or window to access its features.
+</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.
+5. Clock - in reality just another applet, displays the current time. Clicking on the clock
+displays a dialog box which allows the time to be manually updated or syncronized over the
+Internet using the NTP protocol.
</para>
</section>
<section><title>Dialogs</title>
<para>
In &opie;, dialogs, as well as some applications, have a button labeled "Ok" on
@@ -90,7 +144,7 @@ you would normally see in the bottom right of the dialog window).
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> \ No newline at end of file
+</chapter>
diff --git a/docs/usermanual/installation.sgm b/docs/usermanual/installation.sgm
index 24d973f..ce1d07b 100644
--- a/docs/usermanual/installation.sgm
+++ b/docs/usermanual/installation.sgm
@@ -1,27 +1,44 @@
<chapter><title>Installation</title>
<section><title>&ipaq;</title>
<para>
-To install &opie; on an &ipaq;, you will need a recent Familiar installation (i.e.
-install the Familiar "bootstrap" image, and do not install task-complete or 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).
+To install &opie; on an &ipaq;, a recent Familiar installation will be needed. Go to
+the Familiar project homepage (http://familiar.handhelds.org) to download the latest
+version of the "bootstrap" image (do not install the bootstrap-opie or bootstrap-gpe
+images). Follow the instructions on the Familiar website to install the image. Do not
+install the task-complete or task-x packages as they are not needed to run &opie; and
+will unnecessarily occupy space on the &ipaq;.
+</para>
+
+<para>
+A network connection needs to be configured on the &ipaq; in order to download the
+&opie; packages from the feed. The Familiar site provides instructions for connecting
+to the Internet in a variety of ways.
+</para>
+
+<para>
+&opie; requires the libpng3 package to be installed. Prior to installing &opie;, ensure
+that this package is installed. It is available in the Familiar feed and can be installed
+by running this command:
+<informalexample>
+<literallayout>
+ ipkg install libpng3
+</literallayout>
+</informalexample>
</para>
<note>
<para>
If you had QPE/QTopia installed previously, <emphasis>completely</emphasis> remove
it, and then remove the source line for that feed 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:
+Once you have Familiar installed (including libpng3), and the network connection
+between the &ipaq; and the outside world, run the following command:
<informalexample>
<literallayout>
echo src opie "http://opie.handhelds.org/feed/ipaq/unstable/" \
>> /etc/ipkg.conf
</literallayout>
</informalexample>
@@ -41,33 +58,23 @@ 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 "Packages"
-application in the Settings tab, or run ipkg from the command line to install
-other &opie; applications. Check out the various task-opie-* packages to install
-various sets of applications all at once (you can always uninstall individual
-applications individually). You will probably want to install opie-embeddedkonsole
-or opie-console first, so you have access to the command line in &opie;.
-</para>
</section>
<section><title>&zaurus;</title>
<para>
&opie; applications will install and run on the default &zaurus; ROM with no problems,
except for Launcher. It is not compatible with the default ROM, and should not be
installed.
</para>
<para>
Another option is to replace the default &zaurus; ROM with the OpenZaurus
-ROM. OpenZaurus is a openly developed Linux distribution designed to run on the
+ROM image. OpenZaurus is a openly developed Linux distribution designed to run on the
&zaurus;, and uses &opie; as its default user interface. For more information and
installation instructions, please visit their site, http://www.openzaurus.org/.
</para>
</section>
</chapter>