-rw-r--r-- | docs/usermanual/gettingaround.sgm | 160 | ||||
-rw-r--r-- | docs/usermanual/installation.sgm | 45 |
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 @@ | |||
1 | <chapter><title>Using &opie;</title> | 1 | <chapter><title>Using &opie;</title> |
2 | |||
3 | <section><title>Running &opie; for the first time</title> | ||
4 | <para> | ||
5 | If everything was installed as described in the previous section, &opie; should | ||
6 | now start up and present a screen to calibrate the touchscreen. Using the stylus, | ||
7 | press firmly in the middle of the cross-hairs as they appear on the screen. This | ||
8 | usually needs to be done only once, however the screen can be re-calibrated at any | ||
9 | time, if needed, by choosing the Calibrate application on the Settings tab. | ||
10 | </para> | ||
11 | |||
2 | <para> | 12 | <para> |
3 | Now that &opie; is installed and running, it's time to start using it. When you | 13 | Once the screen has been calibrated, &opie; will now start up. If the opie-login |
4 | first start &opie;, you will see the "Launcher" from which you can start all of | 14 | package is installed (which is installed with the default installation), a screen |
5 | your Applications, and the "Taskbar" along the bottom, where you can see all | 15 | will appear requiring a person to log in before any applications can be accessed. |
6 | the running applications, select an input method, and interact with the | 16 | The standard &opie; installation currently requires the user to log in as the |
7 | installed "applets". | 17 | 'root' user in order for all functions to work correctly. Refer to the Familiar |
18 | website (http://familiar.handhelds.org) for the default password for the version | ||
19 | installed. | ||
8 | </para> | 20 | </para> |
9 | 21 | ||
22 | <para> | ||
23 | Once the correct password has been entered, &opie; should now be running. When | ||
24 | rebooted however, &opie; will start automatically. To install and remove | ||
25 | applications, the "Packages" application (located on the Settings tab) or the | ||
26 | command line ipkg application can be used. There are several task-opie packages | ||
27 | which allow the installation of whole categories (e.g. games, PIM, settings, etc.) | ||
28 | of software at once. It also might be helpful to install either opie-embeddedkonsole | ||
29 | or opie-console first to allow access a command line from within &opie;. | ||
30 | </para> | ||
31 | </section> | ||
32 | |||
10 | <section><title>Getting Around</title> | 33 | <section><title>Getting Around</title> |
11 | <para> | 34 | <para> |
12 | Getting around in &opie; is very easy, you simply click your stylus on whatever | 35 | Now that &opie; is installed and running, it is time to start using it. When &opie; |
13 | icon or button you want to click on. The main difference between using the | 36 | is started (after logging in), the following will be visible: the "Launcher" from |
14 | stylus and using a mouse is that you cannot right click with a stylus, so things | 37 | which all of the applications can be started, and the "Taskbar" along the bottom, where |
15 | that require a right click are kept to a minimum. However, it is sometimes | 38 | all running applications can be accessed, select an input method, and interact with the |
16 | necessary to right click, and this is implemented with a "press and hold". | 39 | installed applets. |
17 | Any time you want to do something that you think would require a right click on | 40 | </para> |
18 | a normal pc, try pressing the stylus down and holding it still for a few | 41 | |
19 | seconds. This usually opens up a context sensative menu, much like a right | 42 | <para> |
20 | click usually does on a desktop interface. | 43 | Getting around in &opie; is very easy. Using the stylus, simply click on whatever |
44 | icon, button or control desired. The main difference between using the stylus and using | ||
45 | a mouse is that there is not an intuitive way to "right click" with the stylus. However in | ||
46 | &opie;, by pressing and holding the stylus down on the screen for approximately one second | ||
47 | (i.e. commonly referred to as "click and hold") a right mouse button click is generated. | ||
48 | This allows the user to perform common actions such as display context sensitive menus. | ||
49 | </para> | ||
50 | |||
51 | <para> | ||
52 | Also included in several &opie; applications is context sensitive help. If there is a icon | ||
53 | with a question mark on the left side of the application's title bar, then this option | ||
54 | is available. Clicking on this icon will display instructions on using this feature. | ||
55 | Click and hold the icon, until the window title changes to "What's this..." and then | ||
56 | click on a part of the application window to display the context sensitive help. | ||
21 | </para> | 57 | </para> |
22 | </section> | 58 | </section> |
23 | 59 | ||
24 | <section><title>Launcher</title> | 60 | <section><title>Launcher</title> |
25 | <para> | 61 | <para> |
26 | The Launcher behaves like the "desktop" on most PC GUIs. When no applications | 62 | The Launcher is where applications can be started, and is similar in concept to the desktop |
27 | are running or visible, you will have access to the Launcher. You can also map | 63 | found in most computer graphical user interfaces. When no other applications are running, |
28 | a hardware key to bring the Launcher to the top without closing any of the | 64 | it is visible, occupying most of the screen. |
29 | running applications (this is similar to "minimising" all the applications | ||
30 | that are running). | ||
31 | </para> | 65 | </para> |
66 | |||
32 | <para> | 67 | <para> |
33 | Along the top of the Launcher you will see a list of tabs which function as | 68 | Along the top of the Launcher is a series of tabs which function as categories for all |
34 | categories for your applications. You can click on the tab for the category you | 69 | installed applications. By default, there are the following tabs: PIM, Applications and |
35 | want to view, and then click on the icon for the application that you wish to | 70 | Settings. If any games are installed, there will also appear a Games tab. To launch an |
36 | launch. By default, there will be an Applications tab and a Settings tab (if | 71 | application, click once on the application icon or name. The icon will darken and an |
37 | you install any games, they will appear in the Games tab). When new | 72 | hour glass will appear on the taskbar at the bottom of the screen to indicate that the |
38 | applications are installed, they will usually appear in one of these three tabs, | 73 | application is launching. Most applications take 1 or 2 seconds to start. |
39 | or in a tab of their own. To add or delete tabs or to move applications between | ||
40 | the tabs, you can use the Tab Manager application, or you can edit them by hand, | ||
41 | by changing the directories in /opt/QtPalmtop/apps. | ||
42 | </para> | 74 | </para> |
75 | |||
43 | <para> | 76 | <para> |
44 | There is also a tab to the far right called the "Documents" tab, which allows | 77 | There is also a tab to the far right named Documents. It contains a listing of the |
45 | you to quickly open your most often used documents. You can click on a document | 78 | documents found on the handheld device, allowing easy access. Documents are organized |
46 | to open it up in the proper application. For help on adding files to the | 79 | by document type and category. At the bottom of the Document tab are 2 selection boxes |
47 | Documents tab see the <xref linkend="adddoc">. | 80 | which allow the list of docuemnts to be filtered by these criteria. For instructions on |
81 | adding and removing documents from this tab, see the <xref linkend="adddoc">. | ||
48 | </para> | 82 | </para> |
83 | |||
84 | <para> | ||
85 | The Launcher Settings application on the Settings tab allows each tab's appearance to | ||
86 | be customized. Items that can be configured include background color/image, font, icon | ||
87 | size and more. See the Launcher Settings section for more information. | ||
88 | </para> | ||
89 | |||
49 | </section> | 90 | </section> |
50 | 91 | ||
51 | <section><title>Taskbar</title> | 92 | <section><title>Taskbar</title> |
52 | <para> | 93 | <para> |
53 | &opie; has a "Taskbar" that always runs along the bottom of the screen in &opie;, | 94 | The Taskbar is the small, horizontal section which appears at the bottom of the |
54 | except for a few "fullscreen" applications that cover it up. The Taskbar is | 95 | screen, below the Launcher. It is almost always visible while applications are |
55 | what lets you select which input method you would like to use, shows what | 96 | running. The Taskbar provides the following functions (from left to right): |
56 | applications are running, and is also where the "applets" draw their icons. | ||
57 | On the left of the Taskbar is an "O" button that opens a menu which has an | ||
58 | entry for every tab in the Launcher, allowing you to star an applications | ||
59 | without going back to the Launcher, or quiting the application that you are | ||
60 | running. On the right hand side of the Taskbar, you will probably see a clock | ||
61 | (unless you installed task-opie-minimal), which is actually just another applet | ||
62 | that draws the time instead of an icon. | ||
63 | </para> | 97 | </para> |
98 | |||
99 | <para> | ||
100 | 1. "O" menu - provides a listing of all installed applications, allowing them to be | ||
101 | started if Launcher is not visible. It also provides an options to display Launcher | ||
102 | if there are applications running, power off the handheld device and log out of &opie;. | ||
103 | </para> | ||
104 | |||
64 | <para> | 105 | <para> |
65 | When an application is run, it adds its icon to the Taskbar, starting from the | 106 | 2. Input methods - allows the selection of an input method. Each input method has its |
66 | right side of the input method icon, with new application's icons appearing to | 107 | own, unique icon, and the current one selected is shown on the Taskbar. Click on the icon |
67 | the right. If you click on the icon for an application, it will be brought to | 108 | to display or hide the input method. If more than one method is installed, a small upward |
68 | the screen, allowing you to interact with it. | 109 | pointing arrow is shown to the right of the icon. Click on this arrow to select a |
110 | different input method. | ||
69 | </para> | 111 | </para> |
112 | |||
113 | <para> | ||
114 | 3. Running applications - if any applications are running, their icon will appear immediately | ||
115 | to the right of the input method icon. Clicking on an icon will bring that application to | ||
116 | the front so it can be viewed. When the application is exited, the icon will disappear from | ||
117 | this area. | ||
118 | </para> | ||
119 | |||
120 | <para> | ||
121 | 4. Applets - applets are "mini" applications which appear on the right side of the Taskbar. | ||
122 | Some applets provide quick access to information (e.g. PC cards installed, wireless nework, | ||
123 | etc.), while others provide frequently used functions (e.g. notepad, voice memo recorder). | ||
124 | Clicking on an applet's icon usually provides a menu or window to access its features. | ||
125 | </para> | ||
126 | |||
70 | <para> | 127 | <para> |
71 | To the right of the "O" menu you will see an icon for the currently selected | 128 | 5. Clock - in reality just another applet, displays the current time. Clicking on the clock |
72 | input method. Clicking this will bring up the input method, allowing you to | 129 | displays a dialog box which allows the time to be manually updated or syncronized over the |
73 | type into the currently running application. To the right of the input method | 130 | Internet using the NTP protocol. |
74 | icon is a small arrow pointing up, which will open a menu of all the currently | ||
75 | installed input methods when clicked. When you select one of these, it will | ||
76 | become the current input method, with its icon replacing the previous one. | ||
77 | </para> | 131 | </para> |
78 | </section> | 132 | </section> |
79 | 133 | ||
80 | <section><title>Dialogs</title> | 134 | <section><title>Dialogs</title> |
81 | <para> | 135 | <para> |
82 | In &opie;, dialogs, as well as some applications, have a button labeled "Ok" on | 136 | 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). | |||
90 | For applications that have an "Ok" button as well as the "x" button that all | 144 | For applications that have an "Ok" button as well as the "x" button that all |
91 | applications have, the "Ok" button will usually save the current file and then | 145 | applications have, the "Ok" button will usually save the current file and then |
92 | close the application, while the "x" button will close the application without | 146 | close the application, while the "x" button will close the application without |
93 | saving. | 147 | saving. |
94 | </para> | 148 | </para> |
95 | </section> | 149 | </section> |
96 | </chapter> \ No newline at end of file | 150 | </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 @@ | |||
1 | <chapter><title>Installation</title> | 1 | <chapter><title>Installation</title> |
2 | <section><title>&ipaq;</title> | 2 | <section><title>&ipaq;</title> |
3 | <para> | 3 | <para> |
4 | To install &opie; on an &ipaq;, you will need a recent Familiar installation (i.e. | 4 | To install &opie; on an &ipaq;, a recent Familiar installation will be needed. Go to |
5 | install the Familiar "bootstrap" image, and do not install task-complete or task-x), | 5 | the Familiar project homepage (http://familiar.handhelds.org) to download the latest |
6 | go to http://familiar.handhelds.org to get the latest version, and to get installation | 6 | version of the "bootstrap" image (do not install the bootstrap-opie or bootstrap-gpe |
7 | instructions (again, stop after the initial boot and do not install X, as it is not | 7 | images). Follow the instructions on the Familiar website to install the image. Do not |
8 | necessary, and will only take up space). | 8 | install the task-complete or task-x packages as they are not needed to run &opie; and |
9 | will unnecessarily occupy space on the &ipaq;. | ||
10 | </para> | ||
11 | |||
12 | <para> | ||
13 | A network connection needs to be configured on the &ipaq; in order to download the | ||
14 | &opie; packages from the feed. The Familiar site provides instructions for connecting | ||
15 | to the Internet in a variety of ways. | ||
16 | </para> | ||
17 | |||
18 | <para> | ||
19 | &opie; requires the libpng3 package to be installed. Prior to installing &opie;, ensure | ||
20 | that this package is installed. It is available in the Familiar feed and can be installed | ||
21 | by running this command: | ||
22 | <informalexample> | ||
23 | <literallayout> | ||
24 | ipkg install libpng3 | ||
25 | </literallayout> | ||
26 | </informalexample> | ||
9 | </para> | 27 | </para> |
10 | 28 | ||
11 | <note> | 29 | <note> |
12 | <para> | 30 | <para> |
13 | If you had QPE/QTopia installed previously, <emphasis>completely</emphasis> remove | 31 | If you had QPE/QTopia installed previously, <emphasis>completely</emphasis> remove |
14 | it, and then remove the source line for that feed from your /etc/ipkg.conf file before | 32 | it, and then remove the source line for that feed from your /etc/ipkg.conf file before |
15 | attempting to install &opie;. | 33 | attempting to install &opie;. |
16 | </para> | 34 | </para> |
17 | </note> | 35 | </note> |
18 | <para> | 36 | <para> |
19 | Once you have Familiar installed, set up a network connection between your &ipaq; | 37 | Once you have Familiar installed (including libpng3), and the network connection |
20 | and the ouside world (again, see the Familiar site for instructions on this), | 38 | between the &ipaq; and the outside world, run the following command: |
21 | and then run this command: | ||
22 | <informalexample> | 39 | <informalexample> |
23 | <literallayout> | 40 | <literallayout> |
24 | echo src opie "http://opie.handhelds.org/feed/ipaq/unstable/" \ | 41 | echo src opie "http://opie.handhelds.org/feed/ipaq/unstable/" \ |
25 | >> /etc/ipkg.conf | 42 | >> /etc/ipkg.conf |
26 | </literallayout> | 43 | </literallayout> |
27 | </informalexample> | 44 | </informalexample> |
@@ -41,33 +58,23 @@ finally, start &opie; with: | |||
41 | <informalexample> | 58 | <informalexample> |
42 | <literallayout> | 59 | <literallayout> |
43 | /etc/init.d/opie start | 60 | /etc/init.d/opie start |
44 | </literallayout> | 61 | </literallayout> |
45 | </informalexample> | 62 | </informalexample> |
46 | </para> | 63 | </para> |
47 | |||
48 | <para> | ||
49 | &opie; should now be running (if you should have to reboot, which is rare, &opie; | ||
50 | will start automatically). From here, you can use either the "Packages" | ||
51 | application in the Settings tab, or run ipkg from the command line to install | ||
52 | other &opie; applications. Check out the various task-opie-* packages to install | ||
53 | various sets of applications all at once (you can always uninstall individual | ||
54 | applications individually). You will probably want to install opie-embeddedkonsole | ||
55 | or opie-console first, so you have access to the command line in &opie;. | ||
56 | </para> | ||
57 | </section> | 64 | </section> |
58 | 65 | ||
59 | <section><title>&zaurus;</title> | 66 | <section><title>&zaurus;</title> |
60 | <para> | 67 | <para> |
61 | &opie; applications will install and run on the default &zaurus; ROM with no problems, | 68 | &opie; applications will install and run on the default &zaurus; ROM with no problems, |
62 | except for Launcher. It is not compatible with the default ROM, and should not be | 69 | except for Launcher. It is not compatible with the default ROM, and should not be |
63 | installed. | 70 | installed. |
64 | </para> | 71 | </para> |
65 | 72 | ||
66 | <para> | 73 | <para> |
67 | Another option is to replace the default &zaurus; ROM with the OpenZaurus | 74 | Another option is to replace the default &zaurus; ROM with the OpenZaurus |
68 | ROM. OpenZaurus is a openly developed Linux distribution designed to run on the | 75 | ROM image. OpenZaurus is a openly developed Linux distribution designed to run on the |
69 | &zaurus;, and uses &opie; as its default user interface. For more information and | 76 | &zaurus;, and uses &opie; as its default user interface. For more information and |
70 | installation instructions, please visit their site, http://www.openzaurus.org/. | 77 | installation instructions, please visit their site, http://www.openzaurus.org/. |
71 | </para> | 78 | </para> |
72 | </section> | 79 | </section> |
73 | </chapter> | 80 | </chapter> |