-rw-r--r-- | docs/usermanual/calendar.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/contacts.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/embeddedkonsole.sgm | 4 | ||||
-rw-r--r-- | docs/usermanual/gettingaround.sgm | 12 | ||||
-rw-r--r-- | docs/usermanual/i18n.sgm | 183 | ||||
-rw-r--r-- | docs/usermanual/installation.sgm | 14 | ||||
-rw-r--r-- | docs/usermanual/irda.sgm | 4 | ||||
-rw-r--r-- | docs/usermanual/keypebble.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/software.sgm | 8 | ||||
-rw-r--r-- | docs/usermanual/today.sgm | 22 | ||||
-rw-r--r-- | docs/usermanual/todo.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/upgrading.sgm | 8 | ||||
-rw-r--r-- | docs/usermanual/usermanual.sgm | 7 | ||||
-rw-r--r-- | docs/usermanual/whatisopie.sgm | 10 |
14 files changed, 199 insertions, 81 deletions
diff --git a/docs/usermanual/calendar.sgm b/docs/usermanual/calendar.sgm index 99a810c..d8df4c6 100644 --- a/docs/usermanual/calendar.sgm +++ b/docs/usermanual/calendar.sgm | |||
@@ -192,7 +192,7 @@ Click "Find" to find the next appointment that matches your criteria. | |||
192 | <para> | 192 | <para> |
193 | To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA | 193 | To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA |
194 | Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to | 194 | Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to |
195 | send in the Day View, and select Beam from the menu that appears. Opie will then send the appointment to any | 195 | send in the Day View, and select Beam from the menu that appears. &opie; will then send the appointment to any |
196 | waiting device. | 196 | waiting device. |
197 | </para> | 197 | </para> |
198 | </section> | 198 | </section> |
diff --git a/docs/usermanual/contacts.sgm b/docs/usermanual/contacts.sgm index 8ba7674..b0afe73 100644 --- a/docs/usermanual/contacts.sgm +++ b/docs/usermanual/contacts.sgm | |||
@@ -93,7 +93,7 @@ times to get to "B" and 2 more times to get back to all letters. 2+2=4). | |||
93 | <para> | 93 | <para> |
94 | To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it. | 94 | To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it. |
95 | (see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the | 95 | (see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the |
96 | beam icon in the toolbar, or select Contact&arrow;Beam Entry. Opie will then send the contact using the IrDA and | 96 | beam icon in the toolbar, or select Contact&arrow;Beam Entry. &opie; will then send the contact using the IrDA and |
97 | OBEX protocols to any waiting device. | 97 | OBEX protocols to any waiting device. |
98 | </para> | 98 | </para> |
99 | </section> | 99 | </section> |
diff --git a/docs/usermanual/embeddedkonsole.sgm b/docs/usermanual/embeddedkonsole.sgm index 838e705..1564408 100644 --- a/docs/usermanual/embeddedkonsole.sgm +++ b/docs/usermanual/embeddedkonsole.sgm | |||
@@ -1,6 +1,6 @@ | |||
1 | <chapter><title>Embedded Konsole</title> | 1 | <chapter><title>Embedded Konsole</title> |
2 | <para> | 2 | <para> |
3 | EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much | 3 | EmbeddedKonsole is &opie;'s terminal emulator. From here you can do pretty much |
4 | anything (since Linux is actually a command line based OS by itself). I will | 4 | anything (since Linux is actually a command line based OS by itself). I will |
5 | not go into much detail on using the linux command line, as that is covered in | 5 | not go into much detail on using the linux command line, as that is covered in |
6 | many other places (http://www.tldp.org is a good place to start, or read | 6 | many other places (http://www.tldp.org is a good place to start, or read |
@@ -64,7 +64,7 @@ program in order to save space). Shells can actually be very powerful, and many | |||
64 | of them allow you to write something called "shell scripts" which are just a | 64 | of them allow you to write something called "shell scripts" which are just a |
65 | sequence of commands, sometimes with some flow control statements, saved to a | 65 | sequence of commands, sometimes with some flow control statements, saved to a |
66 | file and run each time the script is run. For the most part, the average user | 66 | file and run each time the script is run. For the most part, the average user |
67 | does not need to know about any of this, though. If you are running Opie on the | 67 | does not need to know about any of this, though. If you are running &opie; on the |
68 | Familiar distribution, it is advisable to install the bash shell (ipkg install | 68 | Familiar distribution, it is advisable to install the bash shell (ipkg install |
69 | bash) because it offers things like tab completion, use of the backspace key, | 69 | bash) because it offers things like tab completion, use of the backspace key, |
70 | and a command history, as well as offering a more advanced scripting languauge | 70 | and a command history, as well as offering a more advanced scripting languauge |
diff --git a/docs/usermanual/gettingaround.sgm b/docs/usermanual/gettingaround.sgm index 88103bb..90aa3cf 100644 --- a/docs/usermanual/gettingaround.sgm +++ b/docs/usermanual/gettingaround.sgm | |||
@@ -1,7 +1,7 @@ | |||
1 | <chapter><title>Using Opie</title> | 1 | <chapter><title>Using &opie;</title> |
2 | <para> | 2 | <para> |
3 | Now that Opie is installed and running, it's time to start using it. When you | 3 | Now that &opie; is installed and running, it's time to start using it. When you |
4 | first start Opie, you will see the "Launcher" from which you can start all of | 4 | first start &opie;, you will see the "Launcher" from which you can start all of |
5 | your Applications, and the "Taskbar" along the bottom, where you can see all | 5 | your Applications, and the "Taskbar" along the bottom, where you can see all |
6 | the running applications, select an input method, and interact with the | 6 | the running applications, select an input method, and interact with the |
7 | installed "applets". | 7 | installed "applets". |
@@ -9,7 +9,7 @@ installed "applets". | |||
9 | 9 | ||
10 | <section><title>Getting Around</title> | 10 | <section><title>Getting Around</title> |
11 | <para> | 11 | <para> |
12 | Getting around in Opie is very easy, you simply click your stylus on whatever | 12 | Getting around in &opie; is very easy, you simply click your stylus on whatever |
13 | icon or button you want to click on. The main difference between using the | 13 | icon or button you want to click on. The main difference between using the |
14 | stylus and using a mouse is that you cannot right click with a stylus, so things | 14 | stylus and using a mouse is that you cannot right click with a stylus, so things |
15 | that require a right click are kept to a minimum. However, it is sometimes | 15 | that require a right click are kept to a minimum. However, it is sometimes |
@@ -50,7 +50,7 @@ Documents tab see the <xref linkend="adddoc">. | |||
50 | 50 | ||
51 | <section><title>Taskbar</title> | 51 | <section><title>Taskbar</title> |
52 | <para> | 52 | <para> |
53 | Opie has a "Taskbar" that always runs along the bottom of the screen in Opie, | 53 | &opie; has a "Taskbar" that always runs along the bottom of the screen in &opie;, |
54 | except for a few "fullscreen" applications that cover it up. The Taskbar is | 54 | except for a few "fullscreen" applications that cover it up. The Taskbar is |
55 | what lets you select which input method you would like to use, shows what | 55 | what lets you select which input method you would like to use, shows what |
56 | applications are running, and is also where the "applets" draw their icons. | 56 | applications are running, and is also where the "applets" draw their icons. |
@@ -79,7 +79,7 @@ become the current input method, with its icon replacing the previous one. | |||
79 | 79 | ||
80 | <section><title>Dialogs</title> | 80 | <section><title>Dialogs</title> |
81 | <para> | 81 | <para> |
82 | In Opie, dialogs, as well as some applications, have a button labeled "Ok" on | 82 | In &opie;, dialogs, as well as some applications, have a button labeled "Ok" on |
83 | the right side of the window title bar, in addition to the normal "x". For | 83 | the right side of the window title bar, in addition to the normal "x". For |
84 | dialogs, the "Ok" button will apply your changes and close the window, while | 84 | dialogs, the "Ok" button will apply your changes and close the window, while |
85 | the "x" will cancel them before closing the window (for people used to most | 85 | the "x" will cancel them before closing the window (for people used to most |
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm index 1964f50..b1ac33a 100644 --- a/docs/usermanual/i18n.sgm +++ b/docs/usermanual/i18n.sgm | |||
@@ -1,47 +1,89 @@ | |||
1 | <chapter id=i18n><title>Translations</title> | 1 | <chapter id=i18n> |
2 | <section> | ||
3 | <title>Translations</title> | ||
4 | |||
2 | <para> | 5 | <para> |
3 | The OPIE-Project tries to offer the support for as many languages as possible. | 6 | The &opie;-Project tries to offer the support for as many languages |
4 | In this chapter the process of translating OPIE and its documentation is explained. | 7 | as possible. In this chapter the process of translating &opie; and its |
8 | documentation is explained. | ||
5 | </para> | 9 | </para> |
6 | <section> | ||
7 | <title>Introduction</title> | ||
8 | <para> | 10 | <para> |
9 | To ensure that OPIE can be used by as many people as possible the OPIE-project | 11 | To ensure that &opie; can be used by as many people as possible the |
10 | aims to be translated in as many languages as possible. Of course, as there are so many | 12 | &opie;-project aims to be translated in as many languages as possible. Of |
11 | different languages, there is always a lot work to do. Furthermore, OPIE evolves and thus | 13 | course, as there are so many different languages, there is always a lot |
12 | most likely there are translations for applications which should be updated. In this tutorial | 14 | work to do. Furthermore, &opie; evolves and thus most likely there are |
13 | you will learn how to help OPIE to be availeble in as many languages as possible and see how | 15 | translations for applications which should be updated. In this tutorial |
14 | easy it is to give something very much respected to the open-source community. | 16 | you will learn how to help &opie; to be available in as many languages as |
17 | possible and see how easy it is to give something very much respected to | ||
18 | the open-source community. | ||
15 | </para> | 19 | </para> |
16 | </section> | 20 | </section> |
21 | |||
17 | <section> | 22 | <section> |
18 | <title>Preferences</title> | 23 | <title>Preferences</title> |
24 | |||
19 | <para> | 25 | <para> |
20 | In order to translate for OPIE you need an editor to edit the translationfile | 26 | In order to translate for &opie; you need an editor to edit the |
21 | and preferably access to cvs. The preferred editor is Linguist. That is an application which | 27 | translationfile and preferably access to cvs. The preferred editor |
22 | comes with Qt. It has a intuitive GUI and is very easy to use. A tutorial can be found here: | 28 | is Linguist. That is an application which comes with &qt;. It has a |
23 | <link>http://doc.trolltech.com/3.1/linguist-manual-3.html</link>. | 29 | intuitive GUI and is very easy to use. A tutorial can be found <ulink |
30 | url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>. | ||
24 | </para> | 31 | </para> |
25 | <para> | 32 | <para> |
26 | However, you can use every editor which works with UTF8, for example VIM or EMACS. The advantage | 33 | However, you can use every editor which works with UTF8, for example VIM or |
27 | of Linguist is that its GUI is optimized for OPIEs translationfiles and can help you be | 34 | EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s |
28 | proposing a translation and notice you if there is an error within the translation. | 35 | translationfiles and can help you by proposing a translation and notice |
36 | you if there is an error within the translation. | ||
29 | </para> | 37 | </para> |
30 | <para> | 38 | <para> |
31 | CVS is a tool which the developers and most translators use to get the source of OPIE. If you | 39 | CVS is a tool which the developers and most translators use to get the source |
32 | already have an anonymous account for the OPIE-cvs you should go to $OPIEDIR/i18n and do <code>cvs up</code>. | 40 | of &opie;. If you already have an anonymous account for the &opie;-cvs you |
33 | If there is already a translation for the language you would like to translate you will see | 41 | should go to <filename class='directory'>OPIEDIR/i18n</filename> and do |
34 | the language code in that directory. For example, for german this is <code>de</code> and for danish | 42 | <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to |
35 | it is <code>da</code>. If not you should contact the coordinator Carsten Niehaus so that | 43 | translate you will see the language code in that directory. For example, |
36 | everything will be set up for your language. | 44 | for german this is <programlisting>de</programlisting> and for danish it is |
45 | <programlisting>da</programlisting>. If not, you should contact the coordinator | ||
46 | <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname> | ||
47 | so that everything will be set up for your language. | ||
37 | </para> | 48 | </para> |
38 | </section> | 49 | </section> |
50 | |||
51 | <section> | ||
52 | <title>Styleguide</title> | ||
53 | <para> | ||
54 | To ensure a high quality of the translations the translatiors have to keep certain things | ||
55 | in mind. | ||
56 | </para> | ||
57 | <itemizedlist mark='opencircle'> | ||
58 | <listitem> | ||
59 | <para> | ||
60 | The applications do not speak to the user. This means that for example it should not | ||
61 | be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>. | ||
62 | </para> | ||
63 | </listitem> | ||
64 | <listitem> | ||
65 | <para> | ||
66 | Try not to use exclamationmarks. If the users sees them to often the ! looses it function | ||
67 | as a amplifier of a warning. | ||
68 | </para> | ||
69 | </listitem> | ||
70 | <listitem> | ||
71 | <para> | ||
72 | Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" insteadt | ||
73 | of "this is a demonstation !". | ||
74 | </para> | ||
75 | </listitem> | ||
76 | </itemizedlist> | ||
77 | </section> | ||
78 | |||
39 | <section> | 79 | <section> |
40 | <title>Examplecode</title> | 80 | <title>Examplecode</title> |
81 | |||
41 | <para> | 82 | <para> |
42 | In the next paragraph you see an example of how the XML looks like. | 83 | In the next paragraph you see an example of how the XML looks like. |
43 | </para> | 84 | </para> |
44 | <!-- | 85 | |
86 | <programlisting> | ||
45 | <message> | 87 | <message> |
46 | <source>New</source> | 88 | <source>New</source> |
47 | <translation>Neu</translation> | 89 | <translation>Neu</translation> |
@@ -54,24 +96,97 @@ | |||
54 | <source>Day</source> | 96 | <source>Day</source> |
55 | <translation type="unfinished"></translation> | 97 | <translation type="unfinished"></translation> |
56 | </message> | 98 | </message> |
57 | --> | 99 | </programlisting> |
100 | |||
101 | </para> | ||
102 | <para> | ||
103 | As you can see the markup is very simple. The part between two source-tags is | ||
104 | the english text which appears if there is no translation yet. In the first | ||
105 | case this is <quote>New</quote>. The next row is where the translated string | ||
106 | would be. The first two messages are already translated, the third is | ||
107 | not. This is marked by the <programlisting>type="unfinished"</programlisting>. | ||
58 | </para> | 108 | </para> |
59 | <para> | 109 | <para> |
60 | As you can see the markup is very simple. The part between two source-tags is the english | 110 | If you choose to use an editor like VIM instead of the prefered tool |
61 | text which appears if there is no translation yet. In the first case this is <quote>New</quote>. | 111 | -Linguist- you have to remove that mark and add the translated string |
62 | In the next rowis where the translation would be. The first two messages are already translated, | 112 | between the two <programlisting>translation</programlisting>-tags. |
63 | the third is not. This is marked by the <code>type="unfinished"</code>. | ||
64 | </para> | 113 | </para> |
65 | <para> | 114 | <para> |
66 | If you choose to use an editor like vim instead of the prefered tool -Linguist- you have to remove | 115 | It might happen that you see <programlisting>type="obsolete"</programlisting> in a |
67 | that mark and add the translated string between the two <code>translation</code>-tags. | 116 | .ts-file. You should not translate these stings as they do no longer appear in the |
117 | application. The translationcoordinator removes those strings from time to time. In | ||
118 | Linguist those strings are grey and not translatable. | ||
68 | </para> | 119 | </para> |
69 | </section> | 120 | </section> |
121 | |||
122 | <section> | ||
123 | <title>Filetypes</title> | ||
124 | <para> | ||
125 | As a translator one need to know three different filetypes. | ||
126 | |||
127 | <filename class='extension'>ts</filename> | ||
128 | .ts-files are the most important files for translators. In these files are all strings which | ||
129 | need to be translated and the translations themselfs. All .ts-files are located in | ||
130 | <filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de). | ||
131 | In theory .ts-files are the only ones a translator needs to know. | ||
132 | |||
133 | <filename class='extension'>pro</filename> | ||
134 | Every application has a .pro-file from which the Makefiles are generated. As a translator | ||
135 | you need to check if in every .pro-file is a line for the language you would to | ||
136 | translate for. A line like this should look this way: | ||
137 | |||
138 | <programlisting> | ||
139 | ../../../i18n/de/today.ts \ | ||
140 | </programlisting> | ||
141 | |||
142 | Usually the translationcoordinator takes care of these entries so you should not | ||
143 | need to edit them. | ||
144 | |||
145 | <filename class='extension'>qm</filename> | ||
146 | These are binary files used by &opie; to display the translated strings. They are | ||
147 | automatically generated by calling the command <command>make lrelease</command>. Of course, | ||
148 | you need to have the binary of <application>lrelease</application> which comes with &qt;. | ||
149 | </para> | ||
150 | </section> | ||
151 | |||
70 | <section> | 152 | <section> |
71 | <title>Do's and don'ts</title> | 153 | <title>Do's and don'ts</title> |
154 | There are certain things that should only be done be the | ||
155 | translationcoordinator or one of the core developers. | ||
156 | <itemizedlist mark='opencircle'> | ||
157 | <listitem> | ||
158 | <para> | ||
159 | The translationfiles should never be updated by the translators. Only the | ||
160 | translationcoordinator updates the repository. This is to avoid merging conflicts. | ||
161 | </para> | ||
162 | </listitem> | ||
163 | <listitem> | ||
164 | <para> | ||
165 | The binary .qm-files are created by either the translationcoordinator or by the feed-manager. | ||
166 | Of course, the translators can created them as described above for testingpurposes but | ||
167 | the official files will be provided. | ||
168 | </para> | ||
169 | </listitem> | ||
170 | <listitem> | ||
171 | <para> | ||
172 | Whenever you find a typo or an incorrect message contact the author of the application | ||
173 | and/or use our bugtrackingsystem (Mantis) to make sure this string will be fixed. | ||
174 | </para> | ||
175 | </listitem> | ||
176 | <listitem> | ||
177 | <para> | ||
178 | If you find a string like "Form1" contact the translationcoordinator. These strings | ||
179 | should not be in the translationfiles. You don't need to translate them. | ||
180 | </para> | ||
181 | </listitem> | ||
182 | <listitem> | ||
72 | <para> | 183 | <para> |
73 | There are certain things that should only be done be the translationcoordinator or one of the | 184 | If you check you translation and see a not translated string even though you translationfile |
74 | core developers. | 185 | is 100% translated use the bugtrackingsystem and/or contact the author of that application |
186 | directly so that this bug is fixed. | ||
75 | </para> | 187 | </para> |
188 | </listitem> | ||
189 | </itemizedlist> | ||
76 | </section> | 190 | </section> |
191 | |||
77 | </chapter> | 192 | </chapter> |
diff --git a/docs/usermanual/installation.sgm b/docs/usermanual/installation.sgm index 82834a6..62874bb 100644 --- a/docs/usermanual/installation.sgm +++ b/docs/usermanual/installation.sgm | |||
@@ -37,7 +37,7 @@ If you have a 3100 or 3800 series iPAQ, run: | |||
37 | ipkg install qt-embedded-rotation | 37 | ipkg install qt-embedded-rotation |
38 | </literallayout> | 38 | </literallayout> |
39 | </informalexample> | 39 | </informalexample> |
40 | finally, start Opie with: | 40 | finally, start &opie; with: |
41 | <informalexample> | 41 | <informalexample> |
42 | <literallayout> | 42 | <literallayout> |
43 | /etc/init.d/opie start | 43 | /etc/init.d/opie start |
@@ -46,21 +46,21 @@ finally, start Opie with: | |||
46 | </para> | 46 | </para> |
47 | 47 | ||
48 | <para> | 48 | <para> |
49 | Opie should now be running (if you should have to reboot, which is rare, Opie | 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 "Software" | 50 | will start automatically). From here, you can use either the "Software" |
51 | application in the Settings tab, or run ipkg from the command line to install | 51 | application in the Settings tab, or run ipkg from the command line to install |
52 | other Opie apps. Check out the various task-opie-* ipkgs to install various sets | 52 | other &opie; apps. Check out the various task-opie-* ipkgs to install various sets |
53 | of apps at once (you can always uninstall individual apps individually). You | 53 | of apps at once (you can always uninstall individual apps individually). You |
54 | will probably want to install opie-embeddedkonsole first, so you have access to | 54 | will probably want to install opie-embeddedkonsole first, so you have access to |
55 | the command line in Opie. | 55 | the command line in &opie;. |
56 | </para> | 56 | </para> |
57 | </section> | 57 | </section> |
58 | 58 | ||
59 | <section><title>Zaurus</title> | 59 | <section><title>Zaurus</title> |
60 | <para> | 60 | <para> |
61 | To completely install Opie on the Zaurus, you will have to install OpenZaurus, | 61 | To completely install &opie; on the Zaurus, you will have to install OpenZaurus, |
62 | which includes Opie. However, individual Opie applications will work fine on the | 62 | which includes &opie;. However, individual &opie; applications will work fine on the |
63 | default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM | 63 | default Zaurus rom. Do not install &opie;'s launcher on a default Zaurus ROM |
64 | though. | 64 | though. |
65 | </para> | 65 | </para> |
66 | </section> | 66 | </section> |
diff --git a/docs/usermanual/irda.sgm b/docs/usermanual/irda.sgm index a2f084c..9e58e2d 100644 --- a/docs/usermanual/irda.sgm +++ b/docs/usermanual/irda.sgm | |||
@@ -17,7 +17,7 @@ If you want to recieve files like images or contact information from another dev | |||
17 | start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A | 17 | start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A |
18 | green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from | 18 | green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from |
19 | the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then | 19 | the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then |
20 | have the other device send the file, and Opie should recieve it and open the file in whatever application is | 20 | have the other device send the file, and &opie; should recieve it and open the file in whatever application is |
21 | appropriate. | 21 | appropriate. |
22 | </para> | 22 | </para> |
23 | <para> | 23 | <para> |
@@ -33,7 +33,7 @@ file type. To do this, you can use either AdvancedFM (yet to be documented), or | |||
33 | Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you | 33 | Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you |
34 | havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for | 34 | havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for |
35 | the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this | 35 | the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this |
36 | button, and Opie will beam the file to any waiting devices. | 36 | button, and &opie; will beam the file to any waiting devices. |
37 | </para> | 37 | </para> |
38 | </section> | 38 | </section> |
39 | <section><title>Stoping IrDA</title> | 39 | <section><title>Stoping IrDA</title> |
diff --git a/docs/usermanual/keypebble.sgm b/docs/usermanual/keypebble.sgm index a4ebfdf..92b3628 100644 --- a/docs/usermanual/keypebble.sgm +++ b/docs/usermanual/keypebble.sgm | |||
@@ -1,6 +1,6 @@ | |||
1 | <chapter><title>VNC Viewer</title> | 1 | <chapter><title>VNC Viewer</title> |
2 | <para> | 2 | <para> |
3 | The OPIE VNC Viewer allows you to connect to servers that are compatible with | 3 | The &opie; VNC Viewer allows you to connect to servers that are compatible with |
4 | the Remote Frame Buffer (RFB) protocol, most commonly used by the VNC remote | 4 | the Remote Frame Buffer (RFB) protocol, most commonly used by the VNC remote |
5 | access software. | 5 | access software. |
6 | </para> | 6 | </para> |
diff --git a/docs/usermanual/software.sgm b/docs/usermanual/software.sgm index 8b82118..a0a8264 100644 --- a/docs/usermanual/software.sgm +++ b/docs/usermanual/software.sgm | |||
@@ -22,9 +22,9 @@ There are several way to install a software package, depending on how you are | |||
22 | accessing the package. | 22 | accessing the package. |
23 | </para> | 23 | </para> |
24 | <para> | 24 | <para> |
25 | To install software from a feed (see <xref linkend=feed>), first select "Opie" from the | 25 | To install software from a feed (see <xref linkend=feed>), first select "&opie;" from the |
26 | "Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view. | 26 | "Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view. |
27 | This will show all the available Opie packages (you can change which packages | 27 | This will show all the available &opie; packages (you can change which packages |
28 | to view by selecting something else from the "Section" pulldown). Installed | 28 | to view by selecting something else from the "Section" pulldown). Installed |
29 | packages are marked with a blue circle, while packages that are not installed are marked with a red | 29 | packages are marked with a blue circle, while packages that are not installed are marked with a red |
30 | box. If you click on the icon for an uninstalled package, it will turn into an | 30 | box. If you click on the icon for an uninstalled package, it will turn into an |
@@ -38,7 +38,7 @@ arguments to be sent to ipkg, which you can usually ignore. After verifying | |||
38 | that all the packages to be installed are correct, press "Ok" in the upper | 38 | that all the packages to be installed are correct, press "Ok" in the upper |
39 | right corner (or press "x" to cancel and go back to the package selection | 39 | right corner (or press "x" to cancel and go back to the package selection |
40 | window). The packages should then install, and you should see their icons | 40 | window). The packages should then install, and you should see their icons |
41 | appear in the Launcher, if they are Opie applications. | 41 | appear in the Launcher, if they are &opie; applications. |
42 | </para> | 42 | </para> |
43 | <para> | 43 | <para> |
44 | If you would like to install software that is not avaialable in a feed, you can | 44 | If you would like to install software that is not avaialable in a feed, you can |
@@ -132,7 +132,7 @@ then the files will be installed in /mnt/hda/opt/QtPalmtop/. | |||
132 | </para> | 132 | </para> |
133 | <para> | 133 | <para> |
134 | The problem with installing file in a destination other than root is that the | 134 | The problem with installing file in a destination other than root is that the |
135 | software usually does not know where to fine the installed files, and Opie does | 135 | software usually does not know where to fine the installed files, and &opie; does |
136 | not know where to find the information that tells it how to display the program | 136 | not know where to find the information that tells it how to display the program |
137 | in the Launcher. To get around this, the package manager creates links | 137 | in the Launcher. To get around this, the package manager creates links |
138 | <footnote><para>See <xref linkend=symlink> for more information on symbolic | 138 | <footnote><para>See <xref linkend=symlink> for more information on symbolic |
diff --git a/docs/usermanual/today.sgm b/docs/usermanual/today.sgm index d77921c..4c96af0 100644 --- a/docs/usermanual/today.sgm +++ b/docs/usermanual/today.sgm | |||
@@ -1,13 +1,13 @@ | |||
1 | <chapter><title>Today</title> | 1 | <chapter><title>&today;</title> |
2 | <para> | 2 | <para> |
3 | The Today application is a convenient way to view both the appointments from the Calendar and the tasks from the | 3 | The &today; application is a convenient way to view both the appointments from the Calendar and the tasks from the |
4 | Todo application for the current day, as well as seeing what e-mail is available. It provides no interface for editing your | 4 | Todo application for the current day, as well as seeing what e-mail is available. It provides no interface for editing your |
5 | appointments, or your tasks, but if you click the icon of the application, it will be launched. For those familiar with | 5 | appointments, or your tasks, but if you click the icon of the application, it will be launched. For those familiar with |
6 | PocketPC, this is similar to the Today application included with that. | 6 | PocketPC, this is similar to the &today; application included with that. |
7 | </para> | 7 | </para> |
8 | <section><title>Configuration</title> | 8 | <section><title>Configuration</title> |
9 | <para> | 9 | <para> |
10 | You can configure the Today application by pressing the wrench icon in the bottom left corner of the window. This will | 10 | You can configure the &today; application by pressing the wrench icon in the bottom left corner of the window. This will |
11 | open the configuration dialog, from which you can change various settings related to display, amongst other things. | 11 | open the configuration dialog, from which you can change various settings related to display, amongst other things. |
12 | </para> | 12 | </para> |
13 | <section><title>Calendar</title> | 13 | <section><title>Calendar</title> |
@@ -18,7 +18,7 @@ The Calendar tab in the configuration dialog lets you change the settings for ho | |||
18 | The first field allows you to select the number of appointments to be shown in the Calendar section of the application. | 18 | The first field allows you to select the number of appointments to be shown in the Calendar section of the application. |
19 | If you add more appointments, you will be taking away screen space from the other sections. | 19 | If you add more appointments, you will be taking away screen space from the other sections. |
20 | The "Should location be shown?" is for determining exactly that. If checked, the location field of the appointment | 20 | The "Should location be shown?" is for determining exactly that. If checked, the location field of the appointment |
21 | will be shown in the Today main view. | 21 | will be shown in the &today; main view. |
22 | "Show only later appoinmtnets" will only show appointments that begin after the current time. | 22 | "Show only later appoinmtnets" will only show appointments that begin after the current time. |
23 | Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible | 23 | Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible |
24 | in the main view. | 24 | in the main view. |
@@ -26,7 +26,7 @@ in the main view. | |||
26 | </section> | 26 | </section> |
27 | <section><title>Tasks</title> | 27 | <section><title>Tasks</title> |
28 | <para> | 28 | <para> |
29 | The Tasks tab lets you change how tasks are displayed in the Today main view. | 29 | The Tasks tab lets you change how tasks are displayed in the &today; main view. |
30 | </para> | 30 | </para> |
31 | <para> | 31 | <para> |
32 | The first field lets you chose how many tasks to display in the main view. The more that are shown, the more space | 32 | The first field lets you chose how many tasks to display in the main view. The more that are shown, the more space |
@@ -40,13 +40,13 @@ The Misc. tab allows you to set global settings that affect the entire applicati | |||
40 | <para> | 40 | <para> |
41 | The "Clip after how many letters" field lets you change the number of characters from each appointment or task that | 41 | The "Clip after how many letters" field lets you change the number of characters from each appointment or task that |
42 | are displayed in the main view. The "Should today be autostarted on resume" checkbox lets you set whether or not | 42 | are displayed in the main view. The "Should today be autostarted on resume" checkbox lets you set whether or not |
43 | the Today application should be started each time you resume from a suspend or not.<note><para>This only works | 43 | the &today; application should be started each time you resume from a suspend or not.<note><para>This only works |
44 | if you have a full installation of Opie. If you are running Today on some other environment (Qtopia, for example) | 44 | if you have a full installation of &opie;. If you are running &today; on some other environment (Qtopia, for example) |
45 | this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set | 45 | this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set |
46 | the number of minutes that the device must be suspended before the Today application will start automatically on | 46 | the number of minutes that the device must be suspended before the &today; application will start automatically on |
47 | resume. For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the | 47 | resume. For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the |
48 | Today application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state | 48 | &today; application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state |
49 | for 6 minutes, then Today will be started automatically upon resume. | 49 | for 6 minutes, then &today; will be started automatically upon resume. |
50 | </para> | 50 | </para> |
51 | </section> | 51 | </section> |
52 | </section> | 52 | </section> |
diff --git a/docs/usermanual/todo.sgm b/docs/usermanual/todo.sgm index 18138d9..223de7b 100644 --- a/docs/usermanual/todo.sgm +++ b/docs/usermanual/todo.sgm | |||
@@ -88,7 +88,7 @@ again. | |||
88 | <para> | 88 | <para> |
89 | To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA | 89 | To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA |
90 | Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select | 90 | Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select |
91 | press the Beam icon in the toolbar, or select Data&arrow;Beam. Opie will then send the task to any waiting | 91 | press the Beam icon in the toolbar, or select Data&arrow;Beam. &opie; will then send the task to any waiting |
92 | device. | 92 | device. |
93 | </para> | 93 | </para> |
94 | </section> | 94 | </section> |
diff --git a/docs/usermanual/upgrading.sgm b/docs/usermanual/upgrading.sgm index 310b99b..787d4dd 100644 --- a/docs/usermanual/upgrading.sgm +++ b/docs/usermanual/upgrading.sgm | |||
@@ -1,14 +1,14 @@ | |||
1 | <chapter><title>Upgrading</title> | 1 | <chapter><title>Upgrading</title> |
2 | <para> | 2 | <para> |
3 | First, you should shutdown Opie from the "Shutdown" app in the Settings tab. | 3 | First, you should shutdown &opie; from the "Shutdown" app in the Settings tab. |
4 | Normally, simply running | 4 | Normally, simply running |
5 | <informalexample> | 5 | <informalexample> |
6 | <literallayout> | 6 | <literallayout> |
7 | ipkg update && ipkg upgrade | 7 | ipkg update && ipkg upgrade |
8 | </literallayout> | 8 | </literallayout> |
9 | </informalexample> | 9 | </informalexample> |
10 | will upgrade Opie. However, if you currently have a version with the 1.5.0 | 10 | will upgrade &opie;. However, if you currently have a version with the 1.5.0 |
11 | version number, you will have to upgrade it differently, because Opie now uses a | 11 | version number, you will have to upgrade it differently, because &opie; now uses a |
12 | different version number (the 1.5.0 was Qtopia's version number, we now use our | 12 | different version number (the 1.5.0 was Qtopia's version number, we now use our |
13 | own). To upgrade from one of these older versions, run: | 13 | own). To upgrade from one of these older versions, run: |
14 | <informalexample> | 14 | <informalexample> |
@@ -17,6 +17,6 @@ own). To upgrade from one of these older versions, run: | |||
17 | ipkg install opie-update | 17 | ipkg install opie-update |
18 | </literallayout> | 18 | </literallayout> |
19 | </informalexample> | 19 | </informalexample> |
20 | Opie should then be upgraded. | 20 | &opie; should then be upgraded. |
21 | </para> | 21 | </para> |
22 | </chapter> \ No newline at end of file | 22 | </chapter> \ No newline at end of file |
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm index 6adc963..5a7e6c0 100644 --- a/docs/usermanual/usermanual.sgm +++ b/docs/usermanual/usermanual.sgm | |||
@@ -14,10 +14,13 @@ | |||
14 | <!ENTITY irda SYSTEM "irda.sgm"> | 14 | <!ENTITY irda SYSTEM "irda.sgm"> |
15 | <!ENTITY keypebble SYSTEM "keypebble.sgm"> | 15 | <!ENTITY keypebble SYSTEM "keypebble.sgm"> |
16 | <!ENTITY i18n SYSTEM "i18n.sgm"> | 16 | <!ENTITY i18n SYSTEM "i18n.sgm"> |
17 | <!ENTITY opie "OPIE"> | ||
18 | <!ENTITY todayapp "Today"> | ||
19 | <!ENTITY qt "Qt"> | ||
17 | ]> | 20 | ]> |
18 | <book><title>Opie User Manual</title> | 21 | <book><title>&opie; User Manual</title> |
19 | <bookinfo><authorgroup><collab> | 22 | <bookinfo><authorgroup><collab> |
20 | <collabname>The Opie Team</collabname> | 23 | <collabname>The &opie; Team</collabname> |
21 | </collab></authorgroup></bookinfo> | 24 | </collab></authorgroup></bookinfo> |
22 | <part><title>Getting Started</title> | 25 | <part><title>Getting Started</title> |
23 | &whatis; | 26 | &whatis; |
diff --git a/docs/usermanual/whatisopie.sgm b/docs/usermanual/whatisopie.sgm index 2a51429..e60897c 100644 --- a/docs/usermanual/whatisopie.sgm +++ b/docs/usermanual/whatisopie.sgm | |||
@@ -1,15 +1,15 @@ | |||
1 | <chapter><title>What is Opie?</title> | 1 | <chapter><title>What is &opie;?</title> |
2 | <para> | 2 | <para> |
3 | Opie is a GUI (Graphical User Interface) for the Linux operating system (and | 3 | &opie; is a GUI (Graphical User Interface) for the Linux operating system (and |
4 | might work on other OSes as well). It was originally designed for handheld | 4 | might work on other OSes as well). It was originally designed for handheld |
5 | computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could | 5 | computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could |
6 | probably function well in other environments requiring a light GUI, such as an | 6 | probably function well in other environments requiring a light GUI, such as an |
7 | old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, | 7 | old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech, |
8 | which is in turn a graphical environment designed for embedded applications, | 8 | which is in turn a graphical environment designed for embedded applications, |
9 | based upon the QT toolkit. | 9 | based upon the &qt; toolkit. |
10 | </para> | 10 | </para> |
11 | <para> | 11 | <para> |
12 | Opie has been designed for devices with small screens, and a touchscreen input | 12 | &opie; has been designed for devices with small screens, and a touchscreen input |
13 | device (ie, only one mouse click, and no constant mouse position), as well as | 13 | device (ie, only one mouse click, and no constant mouse position), as well as |
14 | designed to fit in a relatively small amount of storage space (about 5 megabytes | 14 | designed to fit in a relatively small amount of storage space (about 5 megabytes |
15 | for the base libraries and the launcher). | 15 | for the base libraries and the launcher). |