author | cniehaus <cniehaus> | 2002-12-13 14:19:04 (UTC) |
---|---|---|
committer | cniehaus <cniehaus> | 2002-12-13 14:19:04 (UTC) |
commit | bef11d6339311a7ec04d7905f374d84be9ca5e7e (patch) (unidiff) | |
tree | 6628f19112adfb625f2ebc19a31289f8a2ce7e0f | |
parent | 8b1c25e608e7255199dc97ad8269ac66d40beede (diff) | |
download | opie-bef11d6339311a7ec04d7905f374d84be9ca5e7e.zip opie-bef11d6339311a7ec04d7905f374d84be9ca5e7e.tar.gz opie-bef11d6339311a7ec04d7905f374d84be9ca5e7e.tar.bz2 |
update. Spiralman?
-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 | 223 | ||||
-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 | 12 |
14 files changed, 220 insertions, 102 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 | |||
@@ -99,101 +99,101 @@ The main view is divided up into a grid, where the columns are the days of the | |||
99 | week, and the rows are the weeks (just like an ordinary calendar). The currently | 99 | week, and the rows are the weeks (just like an ordinary calendar). The currently |
100 | selected day has a bold box drawn around it, and if the day has an appointment, | 100 | selected day has a bold box drawn around it, and if the day has an appointment, |
101 | there will be a small blue square in the bottom right corner of it (that square | 101 | there will be a small blue square in the bottom right corner of it (that square |
102 | will have a smaller white square if it is a recurring appointment). If the | 102 | will have a smaller white square if it is a recurring appointment). If the |
103 | appointment is an all day event, it will be drawn as a green dot instead. When | 103 | appointment is an all day event, it will be drawn as a green dot instead. When |
104 | you click on the sqaure of a day, you will be taken to the day view for that | 104 | you click on the sqaure of a day, you will be taken to the day view for that |
105 | day. | 105 | day. |
106 | </para> | 106 | </para> |
107 | </section> | 107 | </section> |
108 | </section> | 108 | </section> |
109 | 109 | ||
110 | <section><title>Adding Appointments</title> | 110 | <section><title>Adding Appointments</title> |
111 | <para> | 111 | <para> |
112 | To add an appointment, click on the add appointment button in the toolbar at the | 112 | To add an appointment, click on the add appointment button in the toolbar at the |
113 | top of the window (an image of a blank page), and a dialog will open up, | 113 | top of the window (an image of a blank page), and a dialog will open up, |
114 | allowing you to enter information about the appointment (depending on the | 114 | allowing you to enter information about the appointment (depending on the |
115 | current view, and what you may have selected, there may be certain default | 115 | current view, and what you may have selected, there may be certain default |
116 | settings). | 116 | settings). |
117 | </para> | 117 | </para> |
118 | <para> | 118 | <para> |
119 | At the top of the window is the description field, where you can enter in a | 119 | At the top of the window is the description field, where you can enter in a |
120 | short description of the appointment, or select a common one from the dropdown | 120 | short description of the appointment, or select a common one from the dropdown |
121 | list. The location field allows you to do the same. The category dropdown allows | 121 | list. The location field allows you to do the same. The category dropdown allows |
122 | 122 | ||
123 | you to assign the appointment to a category, which you can use later to view | 123 | you to assign the appointment to a category, which you can use later to view |
124 | only some of your appointments. The button labeled "..." to the right of that | 124 | only some of your appointments. The button labeled "..." to the right of that |
125 | will open up a dialog where you can add, delete, or edit certain categories. | 125 | will open up a dialog where you can add, delete, or edit certain categories. |
126 | </para> | 126 | </para> |
127 | <para> | 127 | <para> |
128 | To enter a start and end time, select the date for each from the dropdown menu, | 128 | To enter a start and end time, select the date for each from the dropdown menu, |
129 | and then you can either manually enter a time, or you can use the three rows of | 129 | and then you can either manually enter a time, or you can use the three rows of |
130 | numbers to more quickly enter it in. To use the fast input method, first click | 130 | numbers to more quickly enter it in. To use the fast input method, first click |
131 | in the text entry field of the time you want to edit, then you need to select | 131 | in the text entry field of the time you want to edit, then you need to select |
132 | the hour. The first two rows are the hours, click whichever one you want. The | 132 | the hour. The first two rows are the hours, click whichever one you want. The |
133 | third row of numbers are the minutes, in units of five. When you select the | 133 | third row of numbers are the minutes, in units of five. When you select the |
134 | minutes field for the start time, it will automatically set the minutes field | 134 | minutes field for the start time, it will automatically set the minutes field |
135 | for the end time to the same thing, but you can change this by selecting the end | 135 | for the end time to the same thing, but you can change this by selecting the end |
136 | field and giving it its own minutes field. Because of this, it is fastest to set | 136 | field and giving it its own minutes field. Because of this, it is fastest to set |
137 | the start time first and then the end time. There is also an "all day" | 137 | the start time first and then the end time. There is also an "all day" |
138 | checkbox, which will make the appointment take up the entire day. | 138 | checkbox, which will make the appointment take up the entire day. |
139 | </para> | 139 | </para> |
140 | <para> | 140 | <para> |
141 | Underneath this you can set the timezone of the appointment from the dropdown | 141 | Underneath this you can set the timezone of the appointment from the dropdown |
142 | list. To change the available timezones, click the world icon, and it will open | 142 | list. To change the available timezones, click the world icon, and it will open |
143 | the City Time application. Refer to its documentation for changing the | 143 | the City Time application. Refer to its documentation for changing the |
144 | timezones. If you want to have an alarm go off, check the "alarm" checkbox, | 144 | timezones. If you want to have an alarm go off, check the "alarm" checkbox, |
145 | and then set the number of minutes before the appointment that you want the | 145 | and then set the number of minutes before the appointment that you want the |
146 | alarm to sound. If you set the dropdown list next to that to "silent" you will | 146 | alarm to sound. If you set the dropdown list next to that to "silent" you will |
147 | only be given a visual alarm, wheras if you set the alarm to "Loud", there | 147 | only be given a visual alarm, wheras if you set the alarm to "Loud", there |
148 | will be an alarm sound as well. Note: opie-alarm must be installed for alarms to | 148 | will be an alarm sound as well. Note: opie-alarm must be installed for alarms to |
149 | work. | 149 | work. |
150 | </para> | 150 | </para> |
151 | <para> | 151 | <para> |
152 | To set whether the appointment repeats, click the "Repeat" button and a new | 152 | To set whether the appointment repeats, click the "Repeat" button and a new |
153 | dialog will open up. At the top is a row of buttons, which lets you set how | 153 | dialog will open up. At the top is a row of buttons, which lets you set how |
154 | often the appointment repeats. Selecting one of these buttons will change the | 154 | often the appointment repeats. Selecting one of these buttons will change the |
155 | interface below, to represent the available options for that type of repetition | 155 | interface below, to represent the available options for that type of repetition |
156 | (selecting "None" will turn off repetition if you turned it on and no longer | 156 | (selecting "None" will turn off repetition if you turned it on and no longer |
157 | want it). When you are done, click "ok" in the upper right to select that type | 157 | want it). When you are done, click "ok" in the upper right to select that type |
158 | of repetition, or "x" to set it back to what it was (none if it is a new | 158 | of repetition, or "x" to set it back to what it was (none if it is a new |
159 | appointment). | 159 | appointment). |
160 | </para> | 160 | </para> |
161 | <para> | 161 | <para> |
162 | Finally, you can add notes to the appointment by clicking the "Notes..." | 162 | Finally, you can add notes to the appointment by clicking the "Notes..." |
163 | button which will open a dialog with a text entry field for adding notes. Press | 163 | button which will open a dialog with a text entry field for adding notes. Press |
164 | "ok" to accept the changes to the notes, "x" to cancel. | 164 | "ok" to accept the changes to the notes, "x" to cancel. |
165 | </para> | 165 | </para> |
166 | <para> | 166 | <para> |
167 | When you are done setting up the appointment, click "ok" in the top right of | 167 | When you are done setting up the appointment, click "ok" in the top right of |
168 | the window, or "x" to cancel adding the appointment. | 168 | the window, or "x" to cancel adding the appointment. |
169 | </para> | 169 | </para> |
170 | </section> | 170 | </section> |
171 | <section><title>Editing Appointments</title> | 171 | <section><title>Editing Appointments</title> |
172 | <para> | 172 | <para> |
173 | How you start editing an appointment varies depending on what view you are in, | 173 | How you start editing an appointment varies depending on what view you are in, |
174 | but they will all open the same dialog. The dialog is the same as the Add | 174 | but they will all open the same dialog. The dialog is the same as the Add |
175 | Appointment dialog, except that the fields will already be filled in with the | 175 | Appointment dialog, except that the fields will already be filled in with the |
176 | information that the appointment contains. Clicking "ok" will keep your | 176 | information that the appointment contains. Clicking "ok" will keep your |
177 | changes, "x" will revert them to what they were before you edited them. | 177 | changes, "x" will revert them to what they were before you edited them. |
178 | </para> | 178 | </para> |
179 | </section> | 179 | </section> |
180 | 180 | ||
181 | <section><title>Finding Appointments</title> | 181 | <section><title>Finding Appointments</title> |
182 | <para> | 182 | <para> |
183 | To find a specific appointment, click the find button in the toolbar (small | 183 | To find a specific appointment, click the find button in the toolbar (small |
184 | green magnifying glass) and it will open a find dialog. Here you can enter the | 184 | green magnifying glass) and it will open a find dialog. Here you can enter the |
185 | text you want to search for, as well as the category you want to search for, as | 185 | text you want to search for, as well as the category you want to search for, as |
186 | well as the start date, and whether you want the search to be case sensitive. | 186 | well as the start date, and whether you want the search to be case sensitive. |
187 | Click "Find" to find the next appointment that matches your criteria. | 187 | Click "Find" to find the next appointment that matches your criteria. |
188 | </para> | 188 | </para> |
189 | </section> | 189 | </section> |
190 | 190 | ||
191 | <section><title>Beaming Appointments</title> | 191 | <section><title>Beaming Appointments</title> |
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> |
199 | </chapter> | 199 | </chapter> |
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 | |||
@@ -1,108 +1,108 @@ | |||
1 | <chapter><title>Contacts</title> | 1 | <chapter><title>Contacts</title> |
2 | <para> | 2 | <para> |
3 | Contacts is a way to keep track of all the people you know, and how to contact | 3 | Contacts is a way to keep track of all the people you know, and how to contact |
4 | them. as well as other information, such as their birthday, the company they | 4 | them. as well as other information, such as their birthday, the company they |
5 | work for, etc. | 5 | work for, etc. |
6 | <para> | 6 | <para> |
7 | 7 | ||
8 | <section><title>Adding Contacts</title> | 8 | <section><title>Adding Contacts</title> |
9 | <para> | 9 | <para> |
10 | To Add a user, go to | 10 | To Add a user, go to |
11 | <GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>, | 11 | <GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>, |
12 | or click the add icon in the toolbar (looks like a blank piece of paper). | 12 | or click the add icon in the toolbar (looks like a blank piece of paper). |
13 | First, you need to give the person a name. You can do this by either entering | 13 | First, you need to give the person a name. You can do this by either entering |
14 | their name in the name field, or by pressing "Full Name...", which will open | 14 | their name in the name field, or by pressing "Full Name...", which will open |
15 | up a new dialog that lets you enter each part of their name individually. Three | 15 | up a new dialog that lets you enter each part of their name individually. Three |
16 | of the entry fields have pulldown menus instead of labels that let you set which | 16 | of the entry fields have pulldown menus instead of labels that let you set which |
17 | parameter these input fields control. The File As field lets you control how | 17 | parameter these input fields control. The File As field lets you control how |
18 | their name is displayed in the main view, use the pulldown arrow to select from | 18 | their name is displayed in the main view, use the pulldown arrow to select from |
19 | some common ways of ordering their first and last names, or type in a custom | 19 | some common ways of ordering their first and last names, or type in a custom |
20 | one. You can also select a category for the user to be filed under, and clicking | 20 | one. You can also select a category for the user to be filed under, and clicking |
21 | the button labeled "..." lets you edit the available catagories (these are | 21 | the button labeled "..." lets you edit the available catagories (these are |
22 | convinient for displaying just the contacts you want when you have a lot of | 22 | convinient for displaying just the contacts you want when you have a lot of |
23 | them). | 23 | them). |
24 | </para> | 24 | </para> |
25 | <para> | 25 | <para> |
26 | The address tab lets you edit the contact's buisness and home addresses (select | 26 | The address tab lets you edit the contact's buisness and home addresses (select |
27 | which one you want to change from the pulldown menu at the top). The bottom | 27 | which one you want to change from the pulldown menu at the top). The bottom |
28 | field behaves just like the three custom fields in the "General" tab (and if | 28 | field behaves just like the three custom fields in the "General" tab (and if |
29 | you select the same thing from the pulldown list, it will modify the same | 29 | you select the same thing from the pulldown list, it will modify the same |
30 | parameter). | 30 | parameter). |
31 | </para> | 31 | </para> |
32 | <para> | 32 | <para> |
33 | The Details tab is used for miscelaneous things like the person's position, the | 33 | The Details tab is used for miscelaneous things like the person's position, the |
34 | name of their spouse, etc. | 34 | name of their spouse, etc. |
35 | </para> | 35 | </para> |
36 | <para> | 36 | <para> |
37 | When you are done, click "Ok" in the top right of the screen (you can always | 37 | When you are done, click "Ok" in the top right of the screen (you can always |
38 | edit their profile later), click the "x" to cancel, and not add the contact. | 38 | edit their profile later), click the "x" to cancel, and not add the contact. |
39 | </para> | 39 | </para> |
40 | </section> | 40 | </section> |
41 | <section><title>Editing Contacts</title> | 41 | <section><title>Editing Contacts</title> |
42 | <para> | 42 | <para> |
43 | To edit the contacts, select the person you want to edit, anc click the pencil | 43 | To edit the contacts, select the person you want to edit, anc click the pencil |
44 | icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>, | 44 | icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>, |
45 | and it will open up the same dialog used to add a user, except their information | 45 | and it will open up the same dialog used to add a user, except their information |
46 | that is already entered will already be filled in. To finalise the changes, | 46 | that is already entered will already be filled in. To finalise the changes, |
47 | click "Ok", or to cancel them, click "x". | 47 | click "Ok", or to cancel them, click "x". |
48 | </para> | 48 | </para> |
49 | </section> | 49 | </section> |
50 | 50 | ||
51 | <section><title>Deleting Contacts</title> | 51 | <section><title>Deleting Contacts</title> |
52 | <para> | 52 | <para> |
53 | To delete a contact, select the person from the list of contacts, and click the | 53 | To delete a contact, select the person from the list of contacts, and click the |
54 | trash can icon, or go to <GUIMenu>Contact</GUIMenu> | 54 | trash can icon, or go to <GUIMenu>Contact</GUIMenu> |
55 | &arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you | 55 | &arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you |
56 | want to actually delete that contact, click yes to delete it, no will cancel. | 56 | want to actually delete that contact, click yes to delete it, no will cancel. |
57 | </para> | 57 | </para> |
58 | </section> | 58 | </section> |
59 | 59 | ||
60 | <section><title>Editing Contacts</title> | 60 | <section><title>Editing Contacts</title> |
61 | <para> | 61 | <para> |
62 | To find a specific person, click the find icon (green magnifying glass), or go | 62 | To find a specific person, click the find icon (green magnifying glass), or go |
63 | to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog | 63 | to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog |
64 | will pop up, and in the "Find what" input, enter the string you want to search | 64 | will pop up, and in the "Find what" input, enter the string you want to search |
65 | for. You can also select if you want the search to be case sensative, and if you | 65 | for. You can also select if you want the search to be case sensative, and if you |
66 | want it to search backwards from the currently selected user. The Category drop | 66 | want it to search backwards from the currently selected user. The Category drop |
67 | down menu lets you search only a specific category ("All" to search all of | 67 | down menu lets you search only a specific category ("All" to search all of |
68 | them). When you click "Find", it will start search for the string in all the | 68 | them). When you click "Find", it will start search for the string in all the |
69 | fields in all the contacts. When it finds a match, it will highlight the user in | 69 | fields in all the contacts. When it finds a match, it will highlight the user in |
70 | the main view. You can use this to search for (as an example) who a certain | 70 | the main view. You can use this to search for (as an example) who a certain |
71 | phone number belongs to, by entering the phone number in the "find what" field, | 71 | phone number belongs to, by entering the phone number in the "find what" field, |
72 | and clicking "Find". | 72 | and clicking "Find". |
73 | </para> | 73 | </para> |
74 | </section> | 74 | </section> |
75 | 75 | ||
76 | <section><title>Viewing Contacts</title> | 76 | <section><title>Viewing Contacts</title> |
77 | <para> | 77 | <para> |
78 | To view only the contacts in a certain category, go to the View menu, and check | 78 | To view only the contacts in a certain category, go to the View menu, and check |
79 | the categories you want to view. | 79 | the categories you want to view. |
80 | </para> | 80 | </para> |
81 | <para> | 81 | <para> |
82 | The list of letters on the bottom of the window lets you look at only the | 82 | The list of letters on the bottom of the window lets you look at only the |
83 | contacts who's names begin with that letter. These work much like entering text | 83 | contacts who's names begin with that letter. These work much like entering text |
84 | on a mobile phone. For example, to view all the contacts whos name starts with | 84 | on a mobile phone. For example, to view all the contacts whos name starts with |
85 | "B", press the "ABC" group twice (since "B" is the second letter in that | 85 | "B", press the "ABC" group twice (since "B" is the second letter in that |
86 | group). To go back to displaying all of the letters, click it two more times | 86 | group). To go back to displaying all of the letters, click it two more times |
87 | (pressing it four times brings you back to all the letters, so you pressed it 2 | 87 | (pressing it four times brings you back to all the letters, so you pressed it 2 |
88 | times to get to "B" and 2 more times to get back to all letters. 2+2=4). | 88 | times to get to "B" and 2 more times to get back to all letters. 2+2=4). |
89 | </para> | 89 | </para> |
90 | </section> | 90 | </section> |
91 | 91 | ||
92 | <section><title>Beaming Contacts</title> | 92 | <section><title>Beaming Contacts</title> |
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> |
100 | 100 | ||
101 | <section><title>Personal Details</title> | 101 | <section><title>Personal Details</title> |
102 | <para> | 102 | <para> |
103 | Change your personal details by going to <GUIMenu>Contact </GUIMenu> | 103 | Change your personal details by going to <GUIMenu>Contact </GUIMenu> |
104 | <GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to | 104 | <GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to |
105 | display who the device belongs to, as well as other apps. | 105 | display who the device belongs to, as well as other apps. |
106 | </para> | 106 | </para> |
107 | </section> | 107 | </section> |
108 | </chapter> | 108 | </chapter> |
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,163 +1,163 @@ | |||
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 |
7 | O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux | 7 | O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux |
8 | for the beginner). I will, however, give a quick overview of using a Linux | 8 | for the beginner). I will, however, give a quick overview of using a Linux |
9 | shell. | 9 | shell. |
10 | </para> | 10 | </para> |
11 | 11 | ||
12 | <section><title>Using Embedded Konsole</title> | 12 | <section><title>Using Embedded Konsole</title> |
13 | <para> | 13 | <para> |
14 | Along the top of the window is a row of menus and icons. The "Font" menu lets | 14 | Along the top of the window is a row of menus and icons. The "Font" menu lets |
15 | you select the font size that you want the console to use, while the Options | 15 | you select the font size that you want the console to use, while the Options |
16 | menu lets you select various options. Below this row of menus and icons is a | 16 | menu lets you select various options. Below this row of menus and icons is a |
17 | pulldown list with various common commands in it. | 17 | pulldown list with various common commands in it. |
18 | </para> | 18 | </para> |
19 | 19 | ||
20 | <section><title>Options Menu</title> | 20 | <section><title>Options Menu</title> |
21 | <para> | 21 | <para> |
22 | The first submenu in the options menu is the "Command List" menu, which lets | 22 | The first submenu in the options menu is the "Command List" menu, which lets |
23 | you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on | 23 | you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on |
24 | bottom" (depending on which is currently enabled) allows you to select where | 24 | bottom" (depending on which is currently enabled) allows you to select where |
25 | the tabs representing multiple terminal sessions are drawn. The "Colors" | 25 | the tabs representing multiple terminal sessions are drawn. The "Colors" |
26 | submenu lets you select from a color scheme, or make your own, and the "Scroll | 26 | submenu lets you select from a color scheme, or make your own, and the "Scroll |
27 | Bar" submenu lets you select where or if the scroll bar is drawn. | 27 | Bar" submenu lets you select where or if the scroll bar is drawn. |
28 | </para> | 28 | </para> |
29 | </section> | 29 | </section> |
30 | <section><title>Icons</title> | 30 | <section><title>Icons</title> |
31 | <para> | 31 | <para> |
32 | The row of icons to the right of the menus allows you to type common keystrokes | 32 | The row of icons to the right of the menus allows you to type common keystrokes |
33 | without having an input method visible, as well as some other things. | 33 | without having an input method visible, as well as some other things. |
34 | </para> | 34 | </para> |
35 | <para> | 35 | <para> |
36 | The icon all the way on the left will open a new terminal session in a new tab, | 36 | The icon all the way on the left will open a new terminal session in a new tab, |
37 | while the icon all the way on the right will paste text from the clipboard into | 37 | while the icon all the way on the right will paste text from the clipboard into |
38 | the terminal. | 38 | the terminal. |
39 | </para> | 39 | </para> |
40 | <para> | 40 | <para> |
41 | The other icons are the same as typing (from left to right) enter, space, tab | 41 | The other icons are the same as typing (from left to right) enter, space, tab |
42 | (for tab completion), up, and down (for the command history). | 42 | (for tab completion), up, and down (for the command history). |
43 | </para> | 43 | </para> |
44 | </section> | 44 | </section> |
45 | <section><title>Command List</title> | 45 | <section><title>Command List</title> |
46 | <para> | 46 | <para> |
47 | The command list is a pulldown menu with a list of commonly used commands. | 47 | The command list is a pulldown menu with a list of commonly used commands. |
48 | Selecting one will type the command into the terminal wherever the cursor is. | 48 | Selecting one will type the command into the terminal wherever the cursor is. |
49 | You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; | 49 | You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; |
50 | <GUIMenuItem>Command List.</GUIMenuItem> | 50 | <GUIMenuItem>Command List.</GUIMenuItem> |
51 | </para> | 51 | </para> |
52 | </section> | 52 | </section> |
53 | </section> | 53 | </section> |
54 | 54 | ||
55 | <section><title>What is a Shell</title> | 55 | <section><title>What is a Shell</title> |
56 | <para> | 56 | <para> |
57 | A shell is a program that accepts input from a user, and runs commands. Each | 57 | A shell is a program that accepts input from a user, and runs commands. Each |
58 | "command" in the shell is actually a separate program (unless you are using a | 58 | "command" in the shell is actually a separate program (unless you are using a |
59 | shell like BusyBox, which makes some of the more common commands part of its own | 59 | shell like BusyBox, which makes some of the more common commands part of its own |
60 | program in order to save space). Shells can actually be very powerful, and many | 60 | program in order to save space). Shells can actually be very powerful, and many |
61 | 61 | ||
62 | 62 | ||
63 | 63 | ||
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 |
71 | than most other shells. | 71 | than most other shells. |
72 | </para> | 72 | </para> |
73 | </section> | 73 | </section> |
74 | 74 | ||
75 | <section><title>Running Programs</title> | 75 | <section><title>Running Programs</title> |
76 | <para> | 76 | <para> |
77 | To run a program or a command (remember, a command is just another program), you | 77 | To run a program or a command (remember, a command is just another program), you |
78 | simply type the name of the program and hit "Return" (in Linux, program names | 78 | simply type the name of the program and hit "Return" (in Linux, program names |
79 | do not have a special suffix like they do in windows, in fact the "." | 79 | do not have a special suffix like they do in windows, in fact the "." |
80 | character has no special meaning unless it is at the begining of a filename, in | 80 | character has no special meaning unless it is at the begining of a filename, in |
81 | which case it makes the file "hidden"). When you type a program name and hit | 81 | which case it makes the file "hidden"). When you type a program name and hit |
82 | "Return" the shell looks in a special list of directories called your | 82 | "Return" the shell looks in a special list of directories called your |
83 | "path", and if it cannot find it in any of those directories, it stops looking | 83 | "path", and if it cannot find it in any of those directories, it stops looking |
84 | and tells you it could not find them. If you want to run a program that is not | 84 | and tells you it could not find them. If you want to run a program that is not |
85 | in your path, you must specify an absolute or relative path to that program. | 85 | in your path, you must specify an absolute or relative path to that program. |
86 | For instance, to run a program that is in the directory you are currently in, | 86 | For instance, to run a program that is in the directory you are currently in, |
87 | you would type <literal>./program</literal> ("./" is a special directory that | 87 | you would type <literal>./program</literal> ("./" is a special directory that |
88 | is explained below), or to run a program in /home/username/ you would call | 88 | is explained below), or to run a program in /home/username/ you would call |
89 | <literal>/home/username/program</literal>. | 89 | <literal>/home/username/program</literal>. |
90 | </para> | 90 | </para> |
91 | <para> | 91 | <para> |
92 | Most programs take "arguments" when run from the command line. An argument is | 92 | Most programs take "arguments" when run from the command line. An argument is |
93 | a string that contains no spaces that changes how the program behaves (a text | 93 | a string that contains no spaces that changes how the program behaves (a text |
94 | editor, for instance, might take a single argument, which would be the name of | 94 | editor, for instance, might take a single argument, which would be the name of |
95 | the file you wish to edit). Usually, you can use the arguments "-h" or | 95 | the file you wish to edit). Usually, you can use the arguments "-h" or |
96 | "--help" to get a list of the common arguments that that program takes, along | 96 | "--help" to get a list of the common arguments that that program takes, along |
97 | with a short usage description, and a short description of what each argument | 97 | with a short usage description, and a short description of what each argument |
98 | does. | 98 | does. |
99 | </para> | 99 | </para> |
100 | </section> | 100 | </section> |
101 | 101 | ||
102 | <section><title>Basic Navigation</title> | 102 | <section><title>Basic Navigation</title> |
103 | <para> | 103 | <para> |
104 | The command that you will use most often in the shell is probably the "cd" | 104 | The command that you will use most often in the shell is probably the "cd" |
105 | command, which stands for "change directory." With this command, you can move | 105 | command, which stands for "change directory." With this command, you can move |
106 | around in the file system, by issuing the command like this: <userinput>cd | 106 | around in the file system, by issuing the command like this: <userinput>cd |
107 | <replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new | 107 | <replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new |
108 | directory]</replaceable> is the directory you want to move to. | 108 | directory]</replaceable> is the directory you want to move to. |
109 | This directory name does not have to include the entire directory structure, but | 109 | This directory name does not have to include the entire directory structure, but |
110 | can be "relative" which means it assumes you are talking about directories | 110 | can be "relative" which means it assumes you are talking about directories |
111 | relative to the directory you are in. For example, if you are in a directory | 111 | relative to the directory you are in. For example, if you are in a directory |
112 | called /home/username and you want to move to the directory | 112 | called /home/username and you want to move to the directory |
113 | /home/username/other/dir you could simply type <userinput>cd | 113 | /home/username/other/dir you could simply type <userinput>cd |
114 | other/dir</userinput> and you would end up in /home/username/other/dir. You can | 114 | other/dir</userinput> and you would end up in /home/username/other/dir. You can |
115 | also specify a full, or "absolute" path, by specifying the entire path name | 115 | also specify a full, or "absolute" path, by specifying the entire path name |
116 | starting with / ( / is a special directory called the "root" directory, and does | 116 | starting with / ( / is a special directory called the "root" directory, and does |
117 | not have a "parent" directory, which means that it is not in any other | 117 | not have a "parent" directory, which means that it is not in any other |
118 | directory). There are also two special directories called "./" and "../". | 118 | directory). There are also two special directories called "./" and "../". |
119 | The "./" directory is the current directory you are in, and you will probably | 119 | The "./" directory is the current directory you are in, and you will probably |
120 | never use this in conjunction with the cd command (why would you want to move to | 120 | never use this in conjunction with the cd command (why would you want to move to |
121 | the directory you are already in?). The "../" directory represents the parent | 121 | the directory you are already in?). The "../" directory represents the parent |
122 | directory of the directory you are currently in, so if you are in | 122 | directory of the directory you are currently in, so if you are in |
123 | /home/username, ../ is the same as /home. You can string several ../'s | 123 | /home/username, ../ is the same as /home. You can string several ../'s |
124 | together, so if you are in /home/username/dir/ ../../ represents /home. There | 124 | together, so if you are in /home/username/dir/ ../../ represents /home. There |
125 | is one other special directory, called "~/" that points to your home | 125 | is one other special directory, called "~/" that points to your home |
126 | directory (usually /home/username or /root for the root user). | 126 | directory (usually /home/username or /root for the root user). |
127 | </para> | 127 | </para> |
128 | </section> | 128 | </section> |
129 | 129 | ||
130 | <section><title>Moving Files</title> | 130 | <section><title>Moving Files</title> |
131 | <para> | 131 | <para> |
132 | To move files around, you need to use the "cp" (copy) and "mv" (move) | 132 | To move files around, you need to use the "cp" (copy) and "mv" (move) |
133 | commands. Both of these are run the same way: <userinput>command originalfile | 133 | commands. Both of these are run the same way: <userinput>command originalfile |
134 | newfile</userinput>. The only difference is that cp creates a new file without | 134 | newfile</userinput>. The only difference is that cp creates a new file without |
135 | touching the old one, while mv deletes the original file. The two path names | 135 | touching the old one, while mv deletes the original file. The two path names |
136 | can be either absolute or relative. If you only specify a directory for the | 136 | can be either absolute or relative. If you only specify a directory for the |
137 | destination, and no filename, it will use the filename for the original file. | 137 | destination, and no filename, it will use the filename for the original file. |
138 | </para> | 138 | </para> |
139 | </section> | 139 | </section> |
140 | 140 | ||
141 | <section><title>Deleting Files</title> | 141 | <section><title>Deleting Files</title> |
142 | <para> | 142 | <para> |
143 | To delete a file, run the "rm" command, and to delete a directory, run the | 143 | To delete a file, run the "rm" command, and to delete a directory, run the |
144 | "rmdir" command, each of them take the file to be removed as their only | 144 | "rmdir" command, each of them take the file to be removed as their only |
145 | argument. The rmdir command requires the directory to be empty, so if you want | 145 | argument. The rmdir command requires the directory to be empty, so if you want |
146 | to delete a directory that is not empty, along with all its contents, run | 146 | to delete a directory that is not empty, along with all its contents, run |
147 | <userinput>rm -r dir</userinput>. | 147 | <userinput>rm -r dir</userinput>. |
148 | </para> | 148 | </para> |
149 | </section> | 149 | </section> |
150 | 150 | ||
151 | <section id=symlink><title>Linking Files</title> | 151 | <section id=symlink><title>Linking Files</title> |
152 | <para> | 152 | <para> |
153 | In Linux, you can have a special file called a "symbolic link" that acts just | 153 | In Linux, you can have a special file called a "symbolic link" that acts just |
154 | like a copy of another file, except it takes up less space. This is convinient | 154 | like a copy of another file, except it takes up less space. This is convinient |
155 | if two applications are looking for the same file in two separate places, | 155 | if two applications are looking for the same file in two separate places, |
156 | because the file can be in both places at once, without taking up any extra | 156 | because the file can be in both places at once, without taking up any extra |
157 | space, and any change to one is automatically applied to the other (really, | 157 | space, and any change to one is automatically applied to the other (really, |
158 | there is only one file, the link is just a file pointing to the original file). | 158 | there is only one file, the link is just a file pointing to the original file). |
159 | This is also useful for naming applications independant of their version number. | 159 | This is also useful for naming applications independant of their version number. |
160 | For instance, you could have a link called "application" that points to | 160 | For instance, you could have a link called "application" that points to |
161 | "application1.0". To create a link, use the following command: | 161 | "application1.0". To create a link, use the following command: |
162 | <userinput>ln -s originalfile link</userinput>. | 162 | <userinput>ln -s originalfile link</userinput>. |
163 | </para> | 163 | </para> |
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,96 +1,96 @@ | |||
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". |
8 | </para> | 8 | </para> |
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 |
16 | necessary to right click, and this is implemented with a "press and hold". | 16 | necessary to right click, and this is implemented with a "press and hold". |
17 | Any time you want to do something that you think would require a right click on | 17 | Any time you want to do something that you think would require a right click on |
18 | a normal pc, try pressing the stylus down and holding it still for a few | 18 | a normal pc, try pressing the stylus down and holding it still for a few |
19 | seconds. This usually opens up a context sensative menu, much like a right | 19 | seconds. This usually opens up a context sensative menu, much like a right |
20 | click usually does on a desktop interface. | 20 | click usually does on a desktop interface. |
21 | </para> | 21 | </para> |
22 | </section> | 22 | </section> |
23 | 23 | ||
24 | <section><title>Launcher</title> | 24 | <section><title>Launcher</title> |
25 | <para> | 25 | <para> |
26 | The Launcher behaves like the "desktop" on most PC GUIs. When no applications | 26 | The Launcher behaves like the "desktop" on most PC GUIs. When no applications |
27 | are running or visible, you will have access to the Launcher. You can also map | 27 | are running or visible, you will have access to the Launcher. You can also map |
28 | a hardware key to bring the Launcher to the top without closing any of the | 28 | a hardware key to bring the Launcher to the top without closing any of the |
29 | running applications (this is similar to "minimising" all the applications | 29 | running applications (this is similar to "minimising" all the applications |
30 | that are running). | 30 | that are running). |
31 | </para> | 31 | </para> |
32 | <para> | 32 | <para> |
33 | Along the top of the Launcher you will see a list of tabs which function as | 33 | Along the top of the Launcher you will see a list of tabs which function as |
34 | categories for your applications. You can click on the tab for the category you | 34 | categories for your applications. You can click on the tab for the category you |
35 | want to view, and then click on the icon for the application that you wish to | 35 | want to view, and then click on the icon for the application that you wish to |
36 | launch. By default, there will be an Applications tab and a Settings tab (if | 36 | launch. By default, there will be an Applications tab and a Settings tab (if |
37 | you install any games, they will appear in the Games tab). When new | 37 | you install any games, they will appear in the Games tab). When new |
38 | applications are installed, they will usually appear in one of these three tabs, | 38 | applications are installed, they will usually appear in one of these three tabs, |
39 | or in a tab of their own. To add or delete tabs or to move applications between | 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, | 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. | 41 | by changing the directories in /opt/QtPalmtop/apps. |
42 | </para> | 42 | </para> |
43 | <para> | 43 | <para> |
44 | There is also a tab to the far right called the "Documents" tab, which allows | 44 | There is also a tab to the far right called the "Documents" tab, which allows |
45 | you to quickly open your most often used documents. You can click on a document | 45 | you to quickly open your most often used documents. You can click on a document |
46 | to open it up in the proper application. For help on adding files to the | 46 | to open it up in the proper application. For help on adding files to the |
47 | Documents tab see the <xref linkend="adddoc">. | 47 | Documents tab see the <xref linkend="adddoc">. |
48 | </para> | 48 | </para> |
49 | </section> | 49 | </section> |
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. |
57 | On the left of the Taskbar is an "O" button that opens a menu which has an | 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 | 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 | 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 | 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 | 61 | (unless you installed task-opie-minimal), which is actually just another applet |
62 | that draws the time instead of an icon. | 62 | that draws the time instead of an icon. |
63 | </para> | 63 | </para> |
64 | <para> | 64 | <para> |
65 | When an application is run, it adds its icon to the Taskbar, starting from the | 65 | When an application is run, it adds its icon to the Taskbar, starting from the |
66 | right side of the input method icon, with new application's icons appearing to | 66 | right side of the input method icon, with new application's icons appearing to |
67 | the right. If you click on the icon for an application, it will be brought to | 67 | the right. If you click on the icon for an application, it will be brought to |
68 | the screen, allowing you to interact with it. | 68 | the screen, allowing you to interact with it. |
69 | </para> | 69 | </para> |
70 | <para> | 70 | <para> |
71 | To the right of the "O" menu you will see an icon for the currently selected | 71 | To the right of the "O" menu you will see an icon for the currently selected |
72 | input method. Clicking this will bring up the input method, allowing you to | 72 | input method. Clicking this will bring up the input method, allowing you to |
73 | type into the currently running application. To the right of the input method | 73 | type into the currently running application. To the right of the input method |
74 | icon is a small arrow pointing up, which will open a menu of all the currently | 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 | 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. | 76 | become the current input method, with its icon replacing the previous one. |
77 | </para> | 77 | </para> |
78 | </section> | 78 | </section> |
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 |
86 | desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons | 86 | desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons |
87 | you would normally see in the bottom right of the dialog window). | 87 | you would normally see in the bottom right of the dialog window). |
88 | </para> | 88 | </para> |
89 | <para> | 89 | <para> |
90 | For applications that have an "Ok" button as well as the "x" button that all | 90 | 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 | 91 | 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 | 92 | close the application, while the "x" button will close the application without |
93 | saving. | 93 | saving. |
94 | </para> | 94 | </para> |
95 | </section> | 95 | </section> |
96 | </chapter> \ No newline at end of file | 96 | </chapter> \ No newline at end of file |
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,77 +1,192 @@ | |||
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 |
24 | </para> | 30 | url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>. |
31 | </para> | ||
32 | <para> | ||
33 | However, you can use every editor which works with UTF8, for example VIM or | ||
34 | EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s | ||
35 | translationfiles and can help you by proposing a translation and notice | ||
36 | you if there is an error within the translation. | ||
37 | </para> | ||
25 | <para> | 38 | <para> |
26 | However, you can use every editor which works with UTF8, for example VIM or EMACS. The advantage | 39 | CVS is a tool which the developers and most translators use to get the source |
27 | of Linguist is that its GUI is optimized for OPIEs translationfiles and can help you be | 40 | of &opie;. If you already have an anonymous account for the &opie;-cvs you |
28 | proposing a translation and notice you if there is an error within the translation. | 41 | should go to <filename class='directory'>OPIEDIR/i18n</filename> and do |
42 | <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to | ||
43 | translate you will see the language code in that directory. For example, | ||
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. | ||
29 | </para> | 48 | </para> |
49 | </section> | ||
50 | |||
51 | <section> | ||
52 | <title>Styleguide</title> | ||
30 | <para> | 53 | <para> |
31 | CVS is a tool which the developers and most translators use to get the source of OPIE. If you | 54 | To ensure a high quality of the translations the translatiors have to keep certain things |
32 | already have an anonymous account for the OPIE-cvs you should go to $OPIEDIR/i18n and do <code>cvs up</code>. | 55 | in mind. |
33 | If there is already a translation for the language you would like to translate you will see | ||
34 | the language code in that directory. For example, for german this is <code>de</code> and for danish | ||
35 | it is <code>da</code>. If not you should contact the coordinator Carsten Niehaus so that | ||
36 | everything will be set up for your language. | ||
37 | </para> | 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> | ||
38 | </section> | 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> | ||
44 | <!-- | ||
45 | <message> | ||
46 | <source>New</source> | ||
47 | <translation>Neu</translation> | ||
48 | </message> | ||
49 | <message> | ||
50 | <source>Today</source> | ||
51 | <translation>Heute</translation> | ||
52 | </message> | ||
53 | <message> | ||
54 | <source>Day</source> | ||
55 | <translation type="unfinished"></translation> | ||
56 | </message> | ||
57 | --> | ||
58 | </para> | 84 | </para> |
85 | |||
86 | <programlisting> | ||
87 | <message> | ||
88 | <source>New</source> | ||
89 | <translation>Neu</translation> | ||
90 | </message> | ||
91 | <message> | ||
92 | <source>Today</source> | ||
93 | <translation>Heute</translation> | ||
94 | </message> | ||
95 | <message> | ||
96 | <source>Day</source> | ||
97 | <translation type="unfinished"></translation> | ||
98 | </message> | ||
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>. | ||
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 | |||
70 | <section> | 122 | <section> |
71 | <title>Do's and don'ts</title> | 123 | <title>Filetypes</title> |
72 | <para> | 124 | <para> |
73 | There are certain things that should only be done be the translationcoordinator or one of the | 125 | As a translator one need to know three different filetypes. |
74 | core developers. | 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;. | ||
75 | </para> | 149 | </para> |
76 | </section> | 150 | </section> |
151 | |||
152 | <section> | ||
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> | ||
183 | <para> | ||
184 | If you check you translation and see a not translated string even though you translationfile | ||
185 | is 100% translated use the bugtrackingsystem and/or contact the author of that application | ||
186 | directly so that this bug is fixed. | ||
187 | </para> | ||
188 | </listitem> | ||
189 | </itemizedlist> | ||
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 | |||
@@ -1,67 +1,67 @@ | |||
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 fresh Familiar installation (ie, | 4 | To install opie on an iPAQ, you will need a fresh Familiar installation (ie, |
5 | install Familiar, and stop before you do ipkg install task-complete or ipkg | 5 | install Familiar, and stop before you do ipkg install task-complete or ipkg |
6 | install task-x), go to http://familiar.handhelds.org to get the latest version, | 6 | install task-x), go to http://familiar.handhelds.org to get the latest version, |
7 | and to get installation instructions (again, stop after the initial boot and do | 7 | and to get installation instructions (again, stop after the initial boot and do |
8 | not install X, as it is not necessary, and will only take up space). | 8 | not install X, as it is not necessary, and will only take up space). |
9 | </para> | 9 | </para> |
10 | 10 | ||
11 | <note> | 11 | <note> |
12 | <para> | 12 | <para> |
13 | If you had qpe/qtopia installed previously, | 13 | If you had qpe/qtopia installed previously, |
14 | <emphasis>completely</emphasis> remove it, and remove the src line for it from | 14 | <emphasis>completely</emphasis> remove it, and remove the src line for it from |
15 | your /etc/ipkg.conf file before attempting to install opie. | 15 | your /etc/ipkg.conf file before attempting to install opie. |
16 | </para> | 16 | </para> |
17 | </note> | 17 | </note> |
18 | <para> | 18 | <para> |
19 | Once you have Familiar installed, set up a network connection between your iPAQ | 19 | Once you have Familiar installed, set up a network connection between your iPAQ |
20 | and the ouside world (again, see the Familiar site for instructions on this), | 20 | and the ouside world (again, see the Familiar site for instructions on this), |
21 | and then run this command: | 21 | and then run this command: |
22 | <informalexample> | 22 | <informalexample> |
23 | <literallayout> | 23 | <literallayout> |
24 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ | 24 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ |
25 | >> /etc/ipkg.conf | 25 | >> /etc/ipkg.conf |
26 | </literallayout> | 26 | </literallayout> |
27 | </informalexample> | 27 | </informalexample> |
28 | then, run: | 28 | then, run: |
29 | <informalexample> | 29 | <informalexample> |
30 | <literallayout> | 30 | <literallayout> |
31 | ipkg update && ipkg install task-opie | 31 | ipkg update && ipkg install task-opie |
32 | </literallayout> | 32 | </literallayout> |
33 | </informalexample> | 33 | </informalexample> |
34 | If you have a 3100 or 3800 series iPAQ, run: | 34 | If you have a 3100 or 3800 series iPAQ, run: |
35 | <informalexample> | 35 | <informalexample> |
36 | <literallayout> | 36 | <literallayout> |
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 |
44 | </literallayout> | 44 | </literallayout> |
45 | </informalexample> | 45 | </informalexample> |
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> |
67 | </chapter> \ No newline at end of file | 67 | </chapter> \ No newline at end of file |
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 | |||
@@ -1,45 +1,45 @@ | |||
1 | <chapter id=irda><title>IrDA Applet</title> | 1 | <chapter id=irda><title>IrDA Applet</title> |
2 | <para> | 2 | <para> |
3 | The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA | 3 | The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA |
4 | protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that | 4 | protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that |
5 | can use infra red to communicate. | 5 | can use infra red to communicate. |
6 | </para> | 6 | </para> |
7 | <section><title>Starting IrDA</title> | 7 | <section><title>Starting IrDA</title> |
8 | <para> | 8 | <para> |
9 | To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and | 9 | To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and |
10 | clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed | 10 | clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed |
11 | properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using. | 11 | properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using. |
12 | </para> | 12 | </para> |
13 | </section> | 13 | </section> |
14 | <section><title>Recieving Files</title> | 14 | <section><title>Recieving Files</title> |
15 | <para> | 15 | <para> |
16 | If you want to recieve files like images or contact information from another device, you need to tell your device to | 16 | If you want to recieve files like images or contact information from another device, you need to tell your device to |
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> |
24 | When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the | 24 | When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the |
25 | IrDA Applet's menu so that you are not wasting system resources. | 25 | IrDA Applet's menu so that you are not wasting system resources. |
26 | </para> | 26 | </para> |
27 | </section> | 27 | </section> |
28 | <section><title>Beaming Files</title> | 28 | <section><title>Beaming Files</title> |
29 | <para> | 29 | <para> |
30 | Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar, | 30 | Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar, |
31 | and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the | 31 | and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the |
32 | file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the | 32 | file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the |
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> |
40 | <para> | 40 | <para> |
41 | Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this, | 41 | Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this, |
42 | select "Disable IrDA" from the IrDA applet's menu. | 42 | select "Disable IrDA" from the IrDA applet's menu. |
43 | </para> | 43 | </para> |
44 | </section> | 44 | </section> |
45 | </chapter> \ No newline at end of file | 45 | </chapter> \ No newline at end of file |
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,63 +1,63 @@ | |||
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> |
7 | 7 | ||
8 | <section><title>Adding a bookmark</title> | 8 | <section><title>Adding a bookmark</title> |
9 | <para> | 9 | <para> |
10 | To add a new bookmark to your bookmark list, lick the New icon on the | 10 | To add a new bookmark to your bookmark list, lick the New icon on the |
11 | window's toolbar. The "VNC Viewer Connection" dialog will appear. Enter the | 11 | window's toolbar. The "VNC Viewer Connection" dialog will appear. Enter the |
12 | hostname or IP address of the computer you would like to connect to in the | 12 | hostname or IP address of the computer you would like to connect to in the |
13 | "Host Name" field. In the "Display Number" field, enter the number of the | 13 | "Host Name" field. In the "Display Number" field, enter the number of the |
14 | display you would like to connect to. If you are connecting to a Windows or | 14 | display you would like to connect to. If you are connecting to a Windows or |
15 | Mac OS server, you typically select display 0. Unix servers typically use | 15 | Mac OS server, you typically select display 0. Unix servers typically use |
16 | display 1 or higher. You must also enter the password for the server you | 16 | display 1 or higher. You must also enter the password for the server you |
17 | would like to connect to if it requires one. If you are having difficulties | 17 | would like to connect to if it requires one. If you are having difficulties |
18 | entering the password, you can select "Show Password" to show the password | 18 | entering the password, you can select "Show Password" to show the password |
19 | you are entering. You must also add a descriptive name for the bookmark if | 19 | you are entering. You must also add a descriptive name for the bookmark if |
20 | you would like it to be saved. You can then either select the OK button to | 20 | you would like it to be saved. You can then either select the OK button to |
21 | save the bookmark and connect to the server, or the cancel button to return | 21 | save the bookmark and connect to the server, or the cancel button to return |
22 | to the bookmark list. | 22 | to the bookmark list. |
23 | </para> | 23 | </para> |
24 | </section> | 24 | </section> |
25 | <section><title>Connecting to a bookmarked server</title> | 25 | <section><title>Connecting to a bookmarked server</title> |
26 | <para> | 26 | <para> |
27 | To connect to a server that has already been bookmarked, select the bookmark | 27 | To connect to a server that has already been bookmarked, select the bookmark |
28 | from the list and press the "Open" icon on the toolbar. The "VNC Viewer | 28 | from the list and press the "Open" icon on the toolbar. The "VNC Viewer |
29 | Connection" dialog will appear, and you will have the chance to modify the | 29 | Connection" dialog will appear, and you will have the chance to modify the |
30 | bookmark before actually connecting. Pressing the OK button will connect to | 30 | bookmark before actually connecting. Pressing the OK button will connect to |
31 | the server, and pressing the cancel button will return to the bookmark list. | 31 | the server, and pressing the cancel button will return to the bookmark list. |
32 | </para> | 32 | </para> |
33 | </section> | 33 | </section> |
34 | <section><title>Deleting a bookmark</title> | 34 | <section><title>Deleting a bookmark</title> |
35 | <para> | 35 | <para> |
36 | To delete a bookmark, choose the bookmark that you would like to delete, and | 36 | To delete a bookmark, choose the bookmark that you would like to delete, and |
37 | select the delete item from the toolbar. | 37 | select the delete item from the toolbar. |
38 | </para> | 38 | </para> |
39 | </section> | 39 | </section> |
40 | <section><title>Advanced Connection Options</title> | 40 | <section><title>Advanced Connection Options</title> |
41 | <para> | 41 | <para> |
42 | In addition to the display number, hostname, and password, you can choose many | 42 | In addition to the display number, hostname, and password, you can choose many |
43 | advanced options from the "VNC Viewer Connection" dialog box that will affect | 43 | advanced options from the "VNC Viewer Connection" dialog box that will affect |
44 | the performance of the connection. | 44 | the performance of the connection. |
45 | </para> | 45 | </para> |
46 | <para> | 46 | <para> |
47 | On the options tab you can set the delay in between requesting updates to the | 47 | On the options tab you can set the delay in between requesting updates to the |
48 | screen, a higher value will result in a more up to date screen, but you will | 48 | screen, a higher value will result in a more up to date screen, but you will |
49 | use more bandwidth. You can also choose to restrict your connection to 8 bit | 49 | use more bandwidth. You can also choose to restrict your connection to 8 bit |
50 | color, which is much faster than using the color depth of the remote server | 50 | color, which is much faster than using the color depth of the remote server |
51 | at the cost of image quality. Requesting a shared session tells the RFB server | 51 | at the cost of image quality. Requesting a shared session tells the RFB server |
52 | that you are willing to let other users connect at the same time. You can use | 52 | that you are willing to let other users connect at the same time. You can use |
53 | the scaling factor on fit more of the remote screen into the space available on | 53 | the scaling factor on fit more of the remote screen into the space available on |
54 | your PDA, if you are willing to accept the performance hit involved in the | 54 | your PDA, if you are willing to accept the performance hit involved in the |
55 | scaling. | 55 | scaling. |
56 | </para> | 56 | </para> |
57 | <para> | 57 | <para> |
58 | The Encodings tab allows you to select which of the supported encodings you would | 58 | The Encodings tab allows you to select which of the supported encodings you would |
59 | would like the VNC Viewer to use to communicate with the remote server. In most | 59 | would like the VNC Viewer to use to communicate with the remote server. In most |
60 | cases you don't need to modify anything on this tab. | 60 | cases you don't need to modify anything on this tab. |
61 | </para> | 61 | </para> |
62 | </chapter> | 62 | </chapter> |
63 | 63 | ||
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 | |||
@@ -1,199 +1,199 @@ | |||
1 | <chapter><title>Software</title> | 1 | <chapter><title>Software</title> |
2 | 2 | ||
3 | <para> | 3 | <para> |
4 | The "Software" application, also called oipkg, is what is used to install and | 4 | The "Software" application, also called oipkg, is what is used to install and |
5 | remove software. It is actually a frontend to the command line program "ipkg" | 5 | remove software. It is actually a frontend to the command line program "ipkg" |
6 | so most things you can do with oipkg you can also do with ipkg. Oipkg can | 6 | so most things you can do with oipkg you can also do with ipkg. Oipkg can |
7 | install things either remotely from a web server (called a "feed") or it can | 7 | install things either remotely from a web server (called a "feed") or it can |
8 | install an ipkg package file that resides on the local filesystem. | 8 | install an ipkg package file that resides on the local filesystem. |
9 | </para> | 9 | </para> |
10 | <important> | 10 | <important> |
11 | <para> | 11 | <para> |
12 | If you are using a version of ipkg lower than 0.99.20 there is a bug that prevents | 12 | If you are using a version of ipkg lower than 0.99.20 there is a bug that prevents |
13 | oipkg from working properly. If you see errors in the installation log about not being | 13 | oipkg from working properly. If you see errors in the installation log about not being |
14 | able to kill the old gunzip process, you can get around this by starting oipkg from | 14 | able to kill the old gunzip process, you can get around this by starting oipkg from |
15 | Embedded Konsole. | 15 | Embedded Konsole. |
16 | </para> | 16 | </para> |
17 | </important> | 17 | </important> |
18 | 18 | ||
19 | <section><title>Installing Software</title> | 19 | <section><title>Installing Software</title> |
20 | <para> | 20 | <para> |
21 | There are several way to install a software package, depending on how you are | 21 | 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 |
31 | open box, with a blue circle coming out of it, indicating that you have marked | 31 | open box, with a blue circle coming out of it, indicating that you have marked |
32 | this package to be installed. Mark as many packages as you wish this way, and | 32 | this package to be installed. Mark as many packages as you wish this way, and |
33 | then press the "Apply" icon (same red box and blue dot icon) to install all | 33 | then press the "Apply" icon (same red box and blue dot icon) to install all |
34 | the marked packages. It will also remove any packages marked for removal (see | 34 | the marked packages. It will also remove any packages marked for removal (see |
35 | below). Clicking this will open a window showing all the packages marked to be | 35 | below). Clicking this will open a window showing all the packages marked to be |
36 | removed and installed, with some check boxes on the bottom, which represent | 36 | removed and installed, with some check boxes on the bottom, which represent |
37 | arguments to be sent to ipkg, which you can usually ignore. After verifying | 37 | 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 |
45 | download it to your device, and open Filemanger to the directory that it is in. You | 45 | download it to your device, and open Filemanger to the directory that it is in. You |
46 | can then press and hold on the file name, and select "Open in Software", and oipkg | 46 | can then press and hold on the file name, and select "Open in Software", and oipkg |
47 | will be started, with the package already marked to install. Confirm that it is the | 47 | will be started, with the package already marked to install. Confirm that it is the |
48 | correct package, and check any options that you may need and press "Ok" to install | 48 | correct package, and check any options that you may need and press "Ok" to install |
49 | the package. | 49 | the package. |
50 | </para> | 50 | </para> |
51 | <para> | 51 | <para> |
52 | If you would like to install a package but are not sure where to find it, and it is not in | 52 | If you would like to install a package but are not sure where to find it, and it is not in |
53 | any of the feeds that you are using, you can try to have oipkg search for it. You can | 53 | any of the feeds that you are using, you can try to have oipkg search for it. You can |
54 | enter a query in the "Search" field in the toolbars, and then press the magnifying | 54 | enter a query in the "Search" field in the toolbars, and then press the magnifying |
55 | glass icon. Oipkg will then search a list of feeds as well as some software websites, | 55 | glass icon. Oipkg will then search a list of feeds as well as some software websites, |
56 | and show you all the packages that it thinks might be what you are looking for, and | 56 | and show you all the packages that it thinks might be what you are looking for, and |
57 | displays them under the "ipkgfind&killefiz" section in the Package view. You can | 57 | displays them under the "ipkgfind&killefiz" section in the Package view. You can |
58 | then select the packages that you would like to install from that list and install them | 58 | then select the packages that you would like to install from that list and install them |
59 | as you normally would install packages from a feed. | 59 | as you normally would install packages from a feed. |
60 | </para> | 60 | </para> |
61 | </section> | 61 | </section> |
62 | 62 | ||
63 | <section><title>Removing Software</title> | 63 | <section><title>Removing Software</title> |
64 | <para> | 64 | <para> |
65 | Removing software is the same as installing software, except you will press the | 65 | Removing software is the same as installing software, except you will press the |
66 | blue circle icon of an installed package, and it will have a red "X" over it. | 66 | blue circle icon of an installed package, and it will have a red "X" over it. |
67 | Then press the apply icon, and "Ok". You can install and remove packages at | 67 | Then press the apply icon, and "Ok". You can install and remove packages at |
68 | the same time by marking the ones you want to install and the ones you want to | 68 | the same time by marking the ones you want to install and the ones you want to |
69 | remove, and then pressing apply. | 69 | remove, and then pressing apply. |
70 | </para> | 70 | </para> |
71 | </section> | 71 | </section> |
72 | 72 | ||
73 | <section id=feed><title>Servers</title> | 73 | <section id=feed><title>Servers</title> |
74 | <para> | 74 | <para> |
75 | When you install software normally, ipkg downloadins the packages automatically | 75 | When you install software normally, ipkg downloadins the packages automatically |
76 | from ipkg servers (also called "Feeds") and installing them. The list of | 76 | from ipkg servers (also called "Feeds") and installing them. The list of |
77 | servers and where they are is stored in a file called ipkg.conf in /etc/. Oipkg | 77 | servers and where they are is stored in a file called ipkg.conf in /etc/. Oipkg |
78 | is capable of maintaining this list, as well as adding or deleting feeds from | 78 | is capable of maintaining this list, as well as adding or deleting feeds from |
79 | it. | 79 | it. |
80 | </para> | 80 | </para> |
81 | <section><title>Selecting Servers</title> | 81 | <section><title>Selecting Servers</title> |
82 | <para> | 82 | <para> |
83 | To select which feeds you want to be able to see and install packages from, go | 83 | To select which feeds you want to be able to see and install packages from, go |
84 | to Settings&arrow;Setups. There will be a box with a list of servers in it | 84 | to Settings&arrow;Setups. There will be a box with a list of servers in it |
85 | called "Used Servers". Servers that are highlighted will be used to install | 85 | called "Used Servers". Servers that are highlighted will be used to install |
86 | software from, while servers that are not highlighted will be ignored. You can | 86 | software from, while servers that are not highlighted will be ignored. You can |
87 | click on a server to toggle its status. When a server is disabled, the | 87 | click on a server to toggle its status. When a server is disabled, the |
88 | information about that server such as its name and location is kept, so that | 88 | information about that server such as its name and location is kept, so that |
89 | you can resume using it without having to reenter this data. "Ok" will save the | 89 | you can resume using it without having to reenter this data. "Ok" will save the |
90 | changes, and "x" will cancel them. | 90 | changes, and "x" will cancel them. |
91 | </para> | 91 | </para> |
92 | </section> | 92 | </section> |
93 | <section><title>Adding Servers</title> | 93 | <section><title>Adding Servers</title> |
94 | <para> | 94 | <para> |
95 | You can add a server to your list of available servers by going to | 95 | You can add a server to your list of available servers by going to |
96 | Settings&arrow;Servers. Click on the button labeled "New" and enter the name | 96 | Settings&arrow;Servers. Click on the button labeled "New" and enter the name |
97 | and URL into the appropriate fields at the bottom of the window. The name is | 97 | and URL into the appropriate fields at the bottom of the window. The name is |
98 | only for your convinience, so name it whatever makes sense to you. The URL is | 98 | only for your convinience, so name it whatever makes sense to you. The URL is |
99 | the URL of the feed, so the URL for the opie feed would be | 99 | the URL of the feed, so the URL for the opie feed would be |
100 | "http://131.152.105.154/feeds/ipaq/unstable". When you are done, click "Ok" to | 100 | "http://131.152.105.154/feeds/ipaq/unstable". When you are done, click "Ok" to |
101 | save the new server, or "x" to cancel adding it. | 101 | save the new server, or "x" to cancel adding it. |
102 | </para> | 102 | </para> |
103 | </section> | 103 | </section> |
104 | <section><title>Editing Servers</title> | 104 | <section><title>Editing Servers</title> |
105 | <para> | 105 | <para> |
106 | To change the URL or name of a server, go to Settings&arrow;Servers, and select | 106 | To change the URL or name of a server, go to Settings&arrow;Servers, and select |
107 | the server that you want to edit. The current Name and URL should appear in the | 107 | the server that you want to edit. The current Name and URL should appear in the |
108 | appropriate fields, and you can change them to the new values. Once you are | 108 | appropriate fields, and you can change them to the new values. Once you are |
109 | done, click "Ok" to save, or "x" to cancel. | 109 | done, click "Ok" to save, or "x" to cancel. |
110 | </para> | 110 | </para> |
111 | </section> | 111 | </section> |
112 | <section><title>Deleting Servers</title> | 112 | <section><title>Deleting Servers</title> |
113 | <para> | 113 | <para> |
114 | If you no longer need to use a server, this can be done by going to | 114 | If you no longer need to use a server, this can be done by going to |
115 | Settings&arrow;Servers. You can then select the server you wish to delete and | 115 | Settings&arrow;Servers. You can then select the server you wish to delete and |
116 | press the "Remove" button. "Ok" will save the deletion, and "x" will cancel it. | 116 | press the "Remove" button. "Ok" will save the deletion, and "x" will cancel it. |
117 | </para> | 117 | </para> |
118 | </section> | 118 | </section> |
119 | </section> | 119 | </section> |
120 | 120 | ||
121 | <section><title>Destinations</title> | 121 | <section><title>Destinations</title> |
122 | <para> | 122 | <para> |
123 | Software is distributed in a format called "ipkg" which contains all the | 123 | Software is distributed in a format called "ipkg" which contains all the |
124 | necessary files for the program, as well as information on where to put them. | 124 | necessary files for the program, as well as information on where to put them. |
125 | However, this information is only half complete, as it tells the package manager | 125 | However, this information is only half complete, as it tells the package manager |
126 | where in the "destination" to put the files, but the package manager must know | 126 | where in the "destination" to put the files, but the package manager must know |
127 | where this "destination" is. The default destination is "/" (called "root") so | 127 | where this "destination" is. The default destination is "/" (called "root") so |
128 | if the package says to install a file in opt/QtPalmtop/ then the file will be | 128 | if the package says to install a file in opt/QtPalmtop/ then the file will be |
129 | installed in /opt/QtPalmtop/. However, if ask the package manger to use a | 129 | installed in /opt/QtPalmtop/. However, if ask the package manger to use a |
130 | destination at /mnt/hda/ (this is typically where a compact flash card would be) | 130 | destination at /mnt/hda/ (this is typically where a compact flash card would be) |
131 | then the files will be installed in /mnt/hda/opt/QtPalmtop/. | 131 | 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 |
139 | links in Linux</para></footnote> from where the files would be if they were | 139 | links in Linux</para></footnote> from where the files would be if they were |
140 | installed in root to where they are actually installed. This means that no more | 140 | installed in root to where they are actually installed. This means that no more |
141 | space is taken up where the files would normally be installed, but any programs | 141 | space is taken up where the files would normally be installed, but any programs |
142 | can still find the files where they think they should be. | 142 | can still find the files where they think they should be. |
143 | </para> | 143 | </para> |
144 | 144 | ||
145 | <section><title>Using Destinations</title> | 145 | <section><title>Using Destinations</title> |
146 | <para> | 146 | <para> |
147 | To mark a single package to be installed to a destination other than the default, you | 147 | To mark a single package to be installed to a destination other than the default, you |
148 | can press and hold on it, and select the destination you would like to use from the | 148 | can press and hold on it, and select the destination you would like to use from the |
149 | "Install to" menu. That package will then be installed in that destination. | 149 | "Install to" menu. That package will then be installed in that destination. |
150 | </para> | 150 | </para> |
151 | <para> | 151 | <para> |
152 | To install a group of packages in a destination other than root, go to | 152 | To install a group of packages in a destination other than root, go to |
153 | Settings&arrow;Setups to open the settings dialog to the Setups tab. From here | 153 | Settings&arrow;Setups to open the settings dialog to the Setups tab. From here |
154 | you can select the destination you would like to install the package to from the | 154 | you can select the destination you would like to install the package to from the |
155 | pulldown menu at the bottom. You will also want to check "Link to root | 155 | pulldown menu at the bottom. You will also want to check "Link to root |
156 | destination" so that links are properly made. Once you have selected the | 156 | destination" so that links are properly made. Once you have selected the |
157 | destination you want to install the package to, click the dialog's "Ok" button, | 157 | destination you want to install the package to, click the dialog's "Ok" button, |
158 | and all packages that you mark for install will be installed in the selected feed | 158 | and all packages that you mark for install will be installed in the selected feed |
159 | (The destination will not be changed for the packages already marked for | 159 | (The destination will not be changed for the packages already marked for |
160 | installation). | 160 | installation). |
161 | </para> | 161 | </para> |
162 | <para> | 162 | <para> |
163 | You can also change the default destination by checking View&arrow;Destinations | 163 | You can also change the default destination by checking View&arrow;Destinations |
164 | to add the Destination toolbar to your toolbars. You can then select the default | 164 | to add the Destination toolbar to your toolbars. You can then select the default |
165 | destination from the pulldown menu, as well as use the checkbox to select whether | 165 | destination from the pulldown menu, as well as use the checkbox to select whether |
166 | the packages should be linked to the root destination or not. | 166 | the packages should be linked to the root destination or not. |
167 | </para> | 167 | </para> |
168 | </section> | 168 | </section> |
169 | <section><title>Adding Destinations</title> | 169 | <section><title>Adding Destinations</title> |
170 | <para> | 170 | <para> |
171 | To add a destination, go to Settings&arrow;Destinations to bring up the settings | 171 | To add a destination, go to Settings&arrow;Destinations to bring up the settings |
172 | dialog at the Destinations tab, and press the "New" button to add a new | 172 | dialog at the Destinations tab, and press the "New" button to add a new |
173 | Destination to the list. The new destination should be highlighted | 173 | Destination to the list. The new destination should be highlighted |
174 | automatically, and you can then change the name and the URL with the two text | 174 | automatically, and you can then change the name and the URL with the two text |
175 | entry fields below it. The name is only for easy display of the destination, so | 175 | entry fields below it. The name is only for easy display of the destination, so |
176 | name it whatever makes the most sense to you. The URL is the location that you | 176 | name it whatever makes the most sense to you. The URL is the location that you |
177 | want the destination to have. So, if you want all your software to be installed | 177 | want the destination to have. So, if you want all your software to be installed |
178 | under /usr/directory then you would set the URL to that. You can then click | 178 | under /usr/directory then you would set the URL to that. You can then click |
179 | "Ok" to save, or "x" to cancel the changes. | 179 | "Ok" to save, or "x" to cancel the changes. |
180 | </para> | 180 | </para> |
181 | </section> | 181 | </section> |
182 | <section><title>Editing Destinations</title> | 182 | <section><title>Editing Destinations</title> |
183 | <para> | 183 | <para> |
184 | You can edit a destination by going to Settings&arrow;Destinations and selecting | 184 | You can edit a destination by going to Settings&arrow;Destinations and selecting |
185 | the destination that you would like to edit. Then you can edit the Name and URL | 185 | the destination that you would like to edit. Then you can edit the Name and URL |
186 | fields in the same manner as when you added a destination. To save, click "Ok" | 186 | fields in the same manner as when you added a destination. To save, click "Ok" |
187 | or cancel by clicking "x". | 187 | or cancel by clicking "x". |
188 | </para> | 188 | </para> |
189 | </section> | 189 | </section> |
190 | <section><title>Deleting Destinations</title> | 190 | <section><title>Deleting Destinations</title> |
191 | <para> | 191 | <para> |
192 | Deleting a destination is very easy. Go to Settings&arrow;Destinations and | 192 | Deleting a destination is very easy. Go to Settings&arrow;Destinations and |
193 | select the Destination that you would like to delete in the dialog that appears. | 193 | select the Destination that you would like to delete in the dialog that appears. |
194 | Press the "Remove" button to delete the destination, and press "Ok" to save the | 194 | Press the "Remove" button to delete the destination, and press "Ok" to save the |
195 | changes, or "x" to cancel them. | 195 | changes, or "x" to cancel them. |
196 | </para> | 196 | </para> |
197 | </section> | 197 | </section> |
198 | </section> | 198 | </section> |
199 | </chapter> | 199 | </chapter> |
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,53 +1,53 @@ | |||
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> |
14 | <para> | 14 | <para> |
15 | The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed. | 15 | The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed. |
16 | </para> | 16 | </para> |
17 | <para> | 17 | <para> |
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. |
25 | </para> | 25 | </para> |
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 |
33 | is taken from the other categories. | 33 | is taken from the other categories. |
34 | </para> | 34 | </para> |
35 | </section> | 35 | </section> |
36 | <section><title>Miscellaneous</title> | 36 | <section><title>Miscellaneous</title> |
37 | <para> | 37 | <para> |
38 | The Misc. tab allows you to set global settings that affect the entire application. | 38 | The Misc. tab allows you to set global settings that affect the entire application. |
39 | </para> | 39 | </para> |
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> |
53 | </chapter> | 53 | </chapter> |
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 | |||
@@ -1,95 +1,95 @@ | |||
1 | <chapter><title>Todo</title> | 1 | <chapter><title>Todo</title> |
2 | <para> | 2 | <para> |
3 | Todo is designed for storing information about things you need to do, but which | 3 | Todo is designed for storing information about things you need to do, but which |
4 | arent going to happen at a specific time, like "change the oil" or "mow the | 4 | arent going to happen at a specific time, like "change the oil" or "mow the |
5 | lawn". You can also give todo items a deadline, if they have to be completed by | 5 | lawn". You can also give todo items a deadline, if they have to be completed by |
6 | a certain time. | 6 | a certain time. |
7 | </para> | 7 | </para> |
8 | 8 | ||
9 | <section><title>Adding Tasks</title> | 9 | <section><title>Adding Tasks</title> |
10 | <para> | 10 | <para> |
11 | Go to <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>New Task<GUIMenuItem>, or click | 11 | Go to <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>New Task<GUIMenuItem>, or click |
12 | on the new task icon (blank page). The priority drop down menu lets you select | 12 | on the new task icon (blank page). The priority drop down menu lets you select |
13 | the priority of the task. The lower the number, the more important it is. The | 13 | the priority of the task. The lower the number, the more important it is. The |
14 | categories behave in much the same way that they do in Calendar, you can select | 14 | categories behave in much the same way that they do in Calendar, you can select |
15 | the category from the drop down menu, or you can click the "..." button to add, | 15 | the category from the drop down menu, or you can click the "..." button to add, |
16 | delete, or edit categories. To give the task a due date, check the "Due" | 16 | delete, or edit categories. To give the task a due date, check the "Due" |
17 | checkbox, and then click the button next to it (it should contain the current | 17 | checkbox, and then click the button next to it (it should contain the current |
18 | date). That will open a calendar from which you can select the due date. The | 18 | date). That will open a calendar from which you can select the due date. The |
19 | "Completed" check box is the same as the checkbox next to each item in the main | 19 | "Completed" check box is the same as the checkbox next to each item in the main |
20 | view. The "Summary" field is for a short summary that will be visible in the | 20 | view. The "Summary" field is for a short summary that will be visible in the |
21 | main view, as well as in the Today application. The down arrow next to it will | 21 | main view, as well as in the Today application. The down arrow next to it will |
22 | copy the text in the "Summary" field into the large text field below it, which | 22 | copy the text in the "Summary" field into the large text field below it, which |
23 | is used for a more detailed description of the task. Click "ok" in the upper | 23 | is used for a more detailed description of the task. Click "ok" in the upper |
24 | right to add the new task, or "x" to close the window without adding the new | 24 | right to add the new task, or "x" to close the window without adding the new |
25 | task. | 25 | task. |
26 | </para> | 26 | </para> |
27 | </section> | 27 | </section> |
28 | <section><title>Editing Tasks</title> | 28 | <section><title>Editing Tasks</title> |
29 | <para> | 29 | <para> |
30 | To edit a task, you can select it, and then go to | 30 | To edit a task, you can select it, and then go to |
31 | <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit | 31 | <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit |
32 | Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same | 32 | Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same |
33 | dialog should apear as if you were adding a task, but the information for that | 33 | dialog should apear as if you were adding a task, but the information for that |
34 | task should already be filled in. You can change any of it you want to, and then | 34 | task should already be filled in. You can change any of it you want to, and then |
35 | click "ok" in the top right corner to save the changes, or "x" to go back to | 35 | click "ok" in the top right corner to save the changes, or "x" to go back to |
36 | the way it was. | 36 | the way it was. |
37 | </para> | 37 | </para> |
38 | </section> | 38 | </section> |
39 | 39 | ||
40 | <section><title>Deleting Tasks</title> | 40 | <section><title>Deleting Tasks</title> |
41 | <para> | 41 | <para> |
42 | To delete a task, first select it, and then either select | 42 | To delete a task, first select it, and then either select |
43 | <GUIMenu>Data</GUIMenu>&arrow; | 43 | <GUIMenu>Data</GUIMenu>&arrow; |
44 | <GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of | 44 | <GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of |
45 | a trash can). A dialog should pop up, asking if you want to delete the task, | 45 | a trash can). A dialog should pop up, asking if you want to delete the task, |
46 | click yes to delete it, or no to cancel. | 46 | click yes to delete it, or no to cancel. |
47 | </para> | 47 | </para> |
48 | </section> | 48 | </section> |
49 | <section><title>Finding Tasks</title> | 49 | <section><title>Finding Tasks</title> |
50 | <para> | 50 | <para> |
51 | To find a task, either go to | 51 | To find a task, either go to |
52 | <GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem> | 52 | <GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem> |
53 | , or click the find icon (an image of a green magnifying glass), and a dialog | 53 | , or click the find icon (an image of a green magnifying glass), and a dialog |
54 | should pop up. Enter the text you want to search for in the description, and | 54 | should pop up. Enter the text you want to search for in the description, and |
55 | select the category that you want it to search through (this will speed the | 55 | select the category that you want it to search through (this will speed the |
56 | search up, if you know what category it is in). You can also select "case | 56 | search up, if you know what category it is in). You can also select "case |
57 | sensative" which makes the search pay attention to the case of what you type (so | 57 | sensative" which makes the search pay attention to the case of what you type (so |
58 | if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search | 58 | if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search |
59 | Backwards" will search backwards from the currently selected task. Click "Find" | 59 | Backwards" will search backwards from the currently selected task. Click "Find" |
60 | to initiate the search, when it finds a task that matches the string, it will | 60 | to initiate the search, when it finds a task that matches the string, it will |
61 | select it. If you click Find again, it will find the next one in the list (or | 61 | select it. If you click Find again, it will find the next one in the list (or |
62 | the previous one, if "Search backwards" is selected). | 62 | the previous one, if "Search backwards" is selected). |
63 | </para> | 63 | </para> |
64 | </section> | 64 | </section> |
65 | 65 | ||
66 | <section><title>Viewing Tasks</title> | 66 | <section><title>Viewing Tasks</title> |
67 | <para> | 67 | <para> |
68 | To only view tasks filled under certain categories, go to the Category menu, and | 68 | To only view tasks filled under certain categories, go to the Category menu, and |
69 | check the categories you want to view. Also, under the Options menu, you can | 69 | check the categories you want to view. Also, under the Options menu, you can |
70 | select whether or not you want completed tasks to be visible, and whether or not | 70 | select whether or not you want completed tasks to be visible, and whether or not |
71 | you want to see the deadline. | 71 | you want to see the deadline. |
72 | </para> | 72 | </para> |
73 | </section> | 73 | </section> |
74 | 74 | ||
75 | <section><title>Completing Tasks</title> | 75 | <section><title>Completing Tasks</title> |
76 | <para> | 76 | <para> |
77 | To mark a task as completed without deleting it, you can either check the | 77 | To mark a task as completed without deleting it, you can either check the |
78 | checkbox next to it in the main view, or edit it, and check the "completed" | 78 | checkbox next to it in the main view, or edit it, and check the "completed" |
79 | check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow; | 79 | check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow; |
80 | <GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will | 80 | <GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will |
81 | disapear when you mark it completed. but do not worry, it is not gone forever, | 81 | disapear when you mark it completed. but do not worry, it is not gone forever, |
82 | just check Completed tasks in the options menu, and you can see and edit it | 82 | just check Completed tasks in the options menu, and you can see and edit it |
83 | again. | 83 | again. |
84 | </para> | 84 | </para> |
85 | </section> | 85 | </section> |
86 | 86 | ||
87 | <section><title>Beaming Tasks</title> | 87 | <section><title>Beaming Tasks</title> |
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> |
95 | </chapter> | 95 | </chapter> |
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,22 +1,22 @@ | |||
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> |
15 | <literallayout> | 15 | <literallayout> |
16 | ipkg update | 16 | ipkg update |
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 | |||
@@ -1,46 +1,49 @@ | |||
1 | <!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ | 1 | <!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ |
2 | <!ENTITY arrow "-->"> | 2 | <!ENTITY arrow "-->"> |
3 | <!ENTITY whatis SYSTEM "whatisopie.sgm"> | 3 | <!ENTITY whatis SYSTEM "whatisopie.sgm"> |
4 | <!ENTITY installation SYSTEM "installation.sgm"> | 4 | <!ENTITY installation SYSTEM "installation.sgm"> |
5 | <!ENTITY gettingaround SYSTEM "gettingaround.sgm"> | 5 | <!ENTITY gettingaround SYSTEM "gettingaround.sgm"> |
6 | <!ENTITY upgrading SYSTEM "upgrading.sgm"> | 6 | <!ENTITY upgrading SYSTEM "upgrading.sgm"> |
7 | <!ENTITY contacts SYSTEM "contacts.sgm"> | 7 | <!ENTITY contacts SYSTEM "contacts.sgm"> |
8 | <!ENTITY calendar SYSTEM "calendar.sgm"> | 8 | <!ENTITY calendar SYSTEM "calendar.sgm"> |
9 | <!ENTITY todo SYSTEM "todo.sgm"> | 9 | <!ENTITY todo SYSTEM "todo.sgm"> |
10 | <!ENTITY filemanager SYSTEM "filemanager.sgm"> | 10 | <!ENTITY filemanager SYSTEM "filemanager.sgm"> |
11 | <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> | 11 | <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> |
12 | <!ENTITY software SYSTEM "software.sgm"> | 12 | <!ENTITY software SYSTEM "software.sgm"> |
13 | <!ENTITY today SYSTEM "today.sgm"> | 13 | <!ENTITY today SYSTEM "today.sgm"> |
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; |
24 | &installation; | 27 | &installation; |
25 | &gettingaround; | 28 | &gettingaround; |
26 | &upgrading; | 29 | &upgrading; |
27 | </part> | 30 | </part> |
28 | <part><title>Applications</title> | 31 | <part><title>Applications</title> |
29 | &contacts; | 32 | &contacts; |
30 | &calendar; | 33 | &calendar; |
31 | &todo; | 34 | &todo; |
32 | &today; | 35 | &today; |
33 | &filemanager; | 36 | &filemanager; |
34 | &embeddedkonsole; | 37 | &embeddedkonsole; |
35 | &keypebble; | 38 | &keypebble; |
36 | </part> | 39 | </part> |
37 | <part><title>Settings</title> | 40 | <part><title>Settings</title> |
38 | &software; | 41 | &software; |
39 | </part> | 42 | </part> |
40 | <part><title>Applets</title> | 43 | <part><title>Applets</title> |
41 | &irda; | 44 | &irda; |
42 | </part> | 45 | </part> |
43 | <part><title>Technical Details</title> | 46 | <part><title>Technical Details</title> |
44 | &i18n; | 47 | &i18n; |
45 | </part> | 48 | </part> |
46 | </book> | 49 | </book> |
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,17 +1,17 @@ | |||
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). |
16 | </para> | 16 | </para> |
17 | </chapter> \ No newline at end of file | 17 | </chapter> |