-rw-r--r-- | docs/usermanual/calendar.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/contacts.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/embeddedkonsole.sgm | 4 | ||||
-rw-r--r-- | docs/usermanual/gettingaround.sgm | 12 | ||||
-rw-r--r-- | docs/usermanual/i18n.sgm | 183 | ||||
-rw-r--r-- | docs/usermanual/installation.sgm | 14 | ||||
-rw-r--r-- | docs/usermanual/irda.sgm | 4 | ||||
-rw-r--r-- | docs/usermanual/keypebble.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/software.sgm | 8 | ||||
-rw-r--r-- | docs/usermanual/today.sgm | 22 | ||||
-rw-r--r-- | docs/usermanual/todo.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/upgrading.sgm | 8 | ||||
-rw-r--r-- | docs/usermanual/usermanual.sgm | 7 | ||||
-rw-r--r-- | docs/usermanual/whatisopie.sgm | 10 |
14 files changed, 199 insertions, 81 deletions
diff --git a/docs/usermanual/calendar.sgm b/docs/usermanual/calendar.sgm index 99a810c..d8df4c6 100644 --- a/docs/usermanual/calendar.sgm +++ b/docs/usermanual/calendar.sgm @@ -147,53 +147,53 @@ alarm to sound. If you set the dropdown list next to that to "silent" you will only be given a visual alarm, wheras if you set the alarm to "Loud", there will be an alarm sound as well. Note: opie-alarm must be installed for alarms to work. </para> <para> To set whether the appointment repeats, click the "Repeat" button and a new dialog will open up. At the top is a row of buttons, which lets you set how often the appointment repeats. Selecting one of these buttons will change the interface below, to represent the available options for that type of repetition (selecting "None" will turn off repetition if you turned it on and no longer want it). When you are done, click "ok" in the upper right to select that type of repetition, or "x" to set it back to what it was (none if it is a new appointment). </para> <para> Finally, you can add notes to the appointment by clicking the "Notes..." button which will open a dialog with a text entry field for adding notes. Press "ok" to accept the changes to the notes, "x" to cancel. </para> <para> When you are done setting up the appointment, click "ok" in the top right of the window, or "x" to cancel adding the appointment. </para> </section> <section><title>Editing Appointments</title> <para> How you start editing an appointment varies depending on what view you are in, but they will all open the same dialog. The dialog is the same as the Add Appointment dialog, except that the fields will already be filled in with the information that the appointment contains. Clicking "ok" will keep your changes, "x" will revert them to what they were before you edited them. </para> </section> <section><title>Finding Appointments</title> <para> To find a specific appointment, click the find button in the toolbar (small green magnifying glass) and it will open a find dialog. Here you can enter the text you want to search for, as well as the category you want to search for, as well as the start date, and whether you want the search to be case sensitive. Click "Find" to find the next appointment that matches your criteria. </para> </section> <section><title>Beaming Appointments</title> <para> To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to -send in the Day View, and select Beam from the menu that appears. Opie will then send the appointment to any +send in the Day View, and select Beam from the menu that appears. &opie; will then send the appointment to any waiting device. </para> </section> </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 @@ -48,61 +48,61 @@ click "Ok", or to cancel them, click "x". </para> </section> <section><title>Deleting Contacts</title> <para> To delete a contact, select the person from the list of contacts, and click the trash can icon, or go to <GUIMenu>Contact</GUIMenu> &arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you want to actually delete that contact, click yes to delete it, no will cancel. </para> </section> <section><title>Editing Contacts</title> <para> To find a specific person, click the find icon (green magnifying glass), or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog will pop up, and in the "Find what" input, enter the string you want to search for. You can also select if you want the search to be case sensative, and if you want it to search backwards from the currently selected user. The Category drop down menu lets you search only a specific category ("All" to search all of them). When you click "Find", it will start search for the string in all the fields in all the contacts. When it finds a match, it will highlight the user in the main view. You can use this to search for (as an example) who a certain phone number belongs to, by entering the phone number in the "find what" field, and clicking "Find". </para> </section> <section><title>Viewing Contacts</title> <para> To view only the contacts in a certain category, go to the View menu, and check the categories you want to view. </para> <para> The list of letters on the bottom of the window lets you look at only the contacts who's names begin with that letter. These work much like entering text on a mobile phone. For example, to view all the contacts whos name starts with "B", press the "ABC" group twice (since "B" is the second letter in that group). To go back to displaying all of the letters, click it two more times (pressing it four times brings you back to all the letters, so you pressed it 2 times to get to "B" and 2 more times to get back to all letters. 2+2=4). </para> </section> <section><title>Beaming Contacts</title> <para> To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it. (see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the -beam icon in the toolbar, or select Contact&arrow;Beam Entry. Opie will then send the contact using the IrDA and +beam icon in the toolbar, or select Contact&arrow;Beam Entry. &opie; will then send the contact using the IrDA and OBEX protocols to any waiting device. </para> </section> <section><title>Personal Details</title> <para> Change your personal details by going to <GUIMenu>Contact </GUIMenu> <GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to display who the device belongs to, as well as other apps. </para> </section> </chapter> 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,115 +1,115 @@ <chapter><title>Embedded Konsole</title> <para> -EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much +EmbeddedKonsole is &opie;'s terminal emulator. From here you can do pretty much anything (since Linux is actually a command line based OS by itself). I will not go into much detail on using the linux command line, as that is covered in many other places (http://www.tldp.org is a good place to start, or read O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux for the beginner). I will, however, give a quick overview of using a Linux shell. </para> <section><title>Using Embedded Konsole</title> <para> Along the top of the window is a row of menus and icons. The "Font" menu lets you select the font size that you want the console to use, while the Options menu lets you select various options. Below this row of menus and icons is a pulldown list with various common commands in it. </para> <section><title>Options Menu</title> <para> The first submenu in the options menu is the "Command List" menu, which lets you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on bottom" (depending on which is currently enabled) allows you to select where the tabs representing multiple terminal sessions are drawn. The "Colors" submenu lets you select from a color scheme, or make your own, and the "Scroll Bar" submenu lets you select where or if the scroll bar is drawn. </para> </section> <section><title>Icons</title> <para> The row of icons to the right of the menus allows you to type common keystrokes without having an input method visible, as well as some other things. </para> <para> The icon all the way on the left will open a new terminal session in a new tab, while the icon all the way on the right will paste text from the clipboard into the terminal. </para> <para> The other icons are the same as typing (from left to right) enter, space, tab (for tab completion), up, and down (for the command history). </para> </section> <section><title>Command List</title> <para> The command list is a pulldown menu with a list of commonly used commands. Selecting one will type the command into the terminal wherever the cursor is. You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; <GUIMenuItem>Command List.</GUIMenuItem> </para> </section> </section> <section><title>What is a Shell</title> <para> A shell is a program that accepts input from a user, and runs commands. Each "command" in the shell is actually a separate program (unless you are using a shell like BusyBox, which makes some of the more common commands part of its own program in order to save space). Shells can actually be very powerful, and many of them allow you to write something called "shell scripts" which are just a sequence of commands, sometimes with some flow control statements, saved to a file and run each time the script is run. For the most part, the average user -does not need to know about any of this, though. If you are running Opie on the +does not need to know about any of this, though. If you are running &opie; on the Familiar distribution, it is advisable to install the bash shell (ipkg install bash) because it offers things like tab completion, use of the backspace key, and a command history, as well as offering a more advanced scripting languauge than most other shells. </para> </section> <section><title>Running Programs</title> <para> To run a program or a command (remember, a command is just another program), you simply type the name of the program and hit "Return" (in Linux, program names do not have a special suffix like they do in windows, in fact the "." character has no special meaning unless it is at the begining of a filename, in which case it makes the file "hidden"). When you type a program name and hit "Return" the shell looks in a special list of directories called your "path", and if it cannot find it in any of those directories, it stops looking and tells you it could not find them. If you want to run a program that is not in your path, you must specify an absolute or relative path to that program. For instance, to run a program that is in the directory you are currently in, you would type <literal>./program</literal> ("./" is a special directory that is explained below), or to run a program in /home/username/ you would call <literal>/home/username/program</literal>. </para> <para> Most programs take "arguments" when run from the command line. An argument is a string that contains no spaces that changes how the program behaves (a text editor, for instance, might take a single argument, which would be the name of the file you wish to edit). Usually, you can use the arguments "-h" or "--help" to get a list of the common arguments that that program takes, along with a short usage description, and a short description of what each argument does. </para> </section> <section><title>Basic Navigation</title> <para> The command that you will use most often in the shell is probably the "cd" command, which stands for "change directory." With this command, you can move around in the file system, by issuing the command like this: <userinput>cd <replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new directory]</replaceable> is the directory you want to move to. This directory name does not have to include the entire directory structure, but can be "relative" which means it assumes you are talking about directories relative to the directory you are in. For example, if you are in a directory called /home/username and you want to move to the directory /home/username/other/dir you could simply type <userinput>cd other/dir</userinput> and you would end up in /home/username/other/dir. You can also specify a full, or "absolute" path, by specifying the entire path name 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 @@ -<chapter><title>Using Opie</title> +<chapter><title>Using &opie;</title> <para> -Now that Opie is installed and running, it's time to start using it. When you -first start Opie, you will see the "Launcher" from which you can start all of +Now that &opie; is installed and running, it's time to start using it. When you +first start &opie;, you will see the "Launcher" from which you can start all of your Applications, and the "Taskbar" along the bottom, where you can see all the running applications, select an input method, and interact with the installed "applets". </para> <section><title>Getting Around</title> <para> -Getting around in Opie is very easy, you simply click your stylus on whatever +Getting around in &opie; is very easy, you simply click your stylus on whatever icon or button you want to click on. The main difference between using the stylus and using a mouse is that you cannot right click with a stylus, so things that require a right click are kept to a minimum. However, it is sometimes necessary to right click, and this is implemented with a "press and hold". Any time you want to do something that you think would require a right click on a normal pc, try pressing the stylus down and holding it still for a few seconds. This usually opens up a context sensative menu, much like a right click usually does on a desktop interface. </para> </section> <section><title>Launcher</title> <para> The Launcher behaves like the "desktop" on most PC GUIs. When no applications are running or visible, you will have access to the Launcher. You can also map a hardware key to bring the Launcher to the top without closing any of the running applications (this is similar to "minimising" all the applications that are running). </para> <para> Along the top of the Launcher you will see a list of tabs which function as categories for your applications. You can click on the tab for the category you want to view, and then click on the icon for the application that you wish to launch. By default, there will be an Applications tab and a Settings tab (if you install any games, they will appear in the Games tab). When new applications are installed, they will usually appear in one of these three tabs, or in a tab of their own. To add or delete tabs or to move applications between the tabs, you can use the Tab Manager application, or you can edit them by hand, by changing the directories in /opt/QtPalmtop/apps. </para> <para> There is also a tab to the far right called the "Documents" tab, which allows you to quickly open your most often used documents. You can click on a document to open it up in the proper application. For help on adding files to the Documents tab see the <xref linkend="adddoc">. </para> </section> <section><title>Taskbar</title> <para> -Opie has a "Taskbar" that always runs along the bottom of the screen in Opie, +&opie; has a "Taskbar" that always runs along the bottom of the screen in &opie;, except for a few "fullscreen" applications that cover it up. The Taskbar is what lets you select which input method you would like to use, shows what applications are running, and is also where the "applets" draw their icons. On the left of the Taskbar is an "O" button that opens a menu which has an entry for every tab in the Launcher, allowing you to star an applications without going back to the Launcher, or quiting the application that you are running. On the right hand side of the Taskbar, you will probably see a clock (unless you installed task-opie-minimal), which is actually just another applet that draws the time instead of an icon. </para> <para> When an application is run, it adds its icon to the Taskbar, starting from the right side of the input method icon, with new application's icons appearing to the right. If you click on the icon for an application, it will be brought to the screen, allowing you to interact with it. </para> <para> To the right of the "O" menu you will see an icon for the currently selected input method. Clicking this will bring up the input method, allowing you to type into the currently running application. To the right of the input method icon is a small arrow pointing up, which will open a menu of all the currently installed input methods when clicked. When you select one of these, it will become the current input method, with its icon replacing the previous one. </para> </section> <section><title>Dialogs</title> <para> -In Opie, dialogs, as well as some applications, have a button labeled "Ok" on +In &opie;, dialogs, as well as some applications, have a button labeled "Ok" on the right side of the window title bar, in addition to the normal "x". For dialogs, the "Ok" button will apply your changes and close the window, while the "x" will cancel them before closing the window (for people used to most desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons you would normally see in the bottom right of the dialog window). </para> <para> For applications that have an "Ok" button as well as the "x" button that all applications have, the "Ok" button will usually save the current file and then close the application, while the "x" button will close the application without saving. </para> </section> </chapter>
\ 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 @@ -<chapter id=i18n><title>Translations</title> +<chapter id=i18n> +<section> + <title>Translations</title> + <para> - The OPIE-Project tries to offer the support for as many languages as possible. - In this chapter the process of translating OPIE and its documentation is explained. + The &opie;-Project tries to offer the support for as many languages + as possible. In this chapter the process of translating &opie; and its + documentation is explained. </para> -<section> - <title>Introduction</title> <para> - To ensure that OPIE can be used by as many people as possible the OPIE-project - aims to be translated in as many languages as possible. Of course, as there are so many - different languages, there is always a lot work to do. Furthermore, OPIE evolves and thus - most likely there are translations for applications which should be updated. In this tutorial - you will learn how to help OPIE to be availeble in as many languages as possible and see how - easy it is to give something very much respected to the open-source community. + To ensure that &opie; can be used by as many people as possible the + &opie;-project aims to be translated in as many languages as possible. Of + course, as there are so many different languages, there is always a lot + work to do. Furthermore, &opie; evolves and thus most likely there are + translations for applications which should be updated. In this tutorial + you will learn how to help &opie; to be available in as many languages as + possible and see how easy it is to give something very much respected to + the open-source community. </para> </section> + <section> <title>Preferences</title> + <para> - In order to translate for OPIE you need an editor to edit the translationfile - and preferably access to cvs. The preferred editor is Linguist. That is an application which - comes with Qt. It has a intuitive GUI and is very easy to use. A tutorial can be found here: - <link>http://doc.trolltech.com/3.1/linguist-manual-3.html</link>. + In order to translate for &opie; you need an editor to edit the + translationfile and preferably access to cvs. The preferred editor + is Linguist. That is an application which comes with &qt;. It has a + intuitive GUI and is very easy to use. A tutorial can be found <ulink + url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>. </para> <para> - However, you can use every editor which works with UTF8, for example VIM or EMACS. The advantage - of Linguist is that its GUI is optimized for OPIEs translationfiles and can help you be - proposing a translation and notice you if there is an error within the translation. + However, you can use every editor which works with UTF8, for example VIM or + EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s + translationfiles and can help you by proposing a translation and notice + you if there is an error within the translation. </para> <para> - CVS is a tool which the developers and most translators use to get the source of OPIE. If you - already have an anonymous account for the OPIE-cvs you should go to $OPIEDIR/i18n and do <code>cvs up</code>. - If there is already a translation for the language you would like to translate you will see - the language code in that directory. For example, for german this is <code>de</code> and for danish - it is <code>da</code>. If not you should contact the coordinator Carsten Niehaus so that - everything will be set up for your language. + CVS is a tool which the developers and most translators use to get the source + of &opie;. If you already have an anonymous account for the &opie;-cvs you + should go to <filename class='directory'>OPIEDIR/i18n</filename> and do + <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to + translate you will see the language code in that directory. For example, + for german this is <programlisting>de</programlisting> and for danish it is + <programlisting>da</programlisting>. If not, you should contact the coordinator + <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname> + so that everything will be set up for your language. </para> </section> + +<section> + <title>Styleguide</title> + <para> + To ensure a high quality of the translations the translatiors have to keep certain things + in mind. + </para> + <itemizedlist mark='opencircle'> + <listitem> + <para> + The applications do not speak to the user. This means that for example it should not + be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>. + </para> + </listitem> + <listitem> + <para> + Try not to use exclamationmarks. If the users sees them to often the ! looses it function + as a amplifier of a warning. + </para> + </listitem> + <listitem> + <para> + Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" insteadt + of "this is a demonstation !". + </para> + </listitem> + </itemizedlist> +</section> + <section> <title>Examplecode</title> + <para> In the next paragraph you see an example of how the XML looks like. </para> - <!-- + + <programlisting> <message> <source>New</source> <translation>Neu</translation> </message> <message> <source>Today</source> <translation>Heute</translation> </message> <message> <source>Day</source> <translation type="unfinished"></translation> </message> - --> + </programlisting> + + </para> + <para> + As you can see the markup is very simple. The part between two source-tags is + the english text which appears if there is no translation yet. In the first + case this is <quote>New</quote>. The next row is where the translated string + would be. The first two messages are already translated, the third is + not. This is marked by the <programlisting>type="unfinished"</programlisting>. </para> <para> - As you can see the markup is very simple. The part between two source-tags is the english - text which appears if there is no translation yet. In the first case this is <quote>New</quote>. - In the next row is where the translation would be. The first two messages are already translated, - the third is not. This is marked by the <code>type="unfinished"</code>. + If you choose to use an editor like VIM instead of the prefered tool + -Linguist- you have to remove that mark and add the translated string + between the two <programlisting>translation</programlisting>-tags. </para> <para> - If you choose to use an editor like vim instead of the prefered tool -Linguist- you have to remove - that mark and add the translated string between the two <code>translation</code>-tags. + It might happen that you see <programlisting>type="obsolete"</programlisting> in a + .ts-file. You should not translate these stings as they do no longer appear in the + application. The translationcoordinator removes those strings from time to time. In + Linguist those strings are grey and not translatable. </para> </section> + +<section> + <title>Filetypes</title> + <para> + As a translator one need to know three different filetypes. + + <filename class='extension'>ts</filename> + .ts-files are the most important files for translators. In these files are all strings which + need to be translated and the translations themselfs. All .ts-files are located in + <filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de). + In theory .ts-files are the only ones a translator needs to know. + + <filename class='extension'>pro</filename> + Every application has a .pro-file from which the Makefiles are generated. As a translator + you need to check if in every .pro-file is a line for the language you would to + translate for. A line like this should look this way: + + <programlisting> + ../../../i18n/de/today.ts \ + </programlisting> + + Usually the translationcoordinator takes care of these entries so you should not + need to edit them. + + <filename class='extension'>qm</filename> + These are binary files used by &opie; to display the translated strings. They are + automatically generated by calling the command <command>make lrelease</command>. Of course, + you need to have the binary of <application>lrelease</application> which comes with &qt;. + </para> +</section> + <section> <title>Do's and don'ts</title> + There are certain things that should only be done be the + translationcoordinator or one of the core developers. + <itemizedlist mark='opencircle'> + <listitem> + <para> + The translationfiles should never be updated by the translators. Only the + translationcoordinator updates the repository. This is to avoid merging conflicts. + </para> + </listitem> + <listitem> + <para> + The binary .qm-files are created by either the translationcoordinator or by the feed-manager. + Of course, the translators can created them as described above for testingpurposes but + the official files will be provided. + </para> + </listitem> + <listitem> + <para> + Whenever you find a typo or an incorrect message contact the author of the application + and/or use our bugtrackingsystem (Mantis) to make sure this string will be fixed. + </para> + </listitem> + <listitem> + <para> + If you find a string like "Form1" contact the translationcoordinator. These strings + should not be in the translationfiles. You don't need to translate them. + </para> + </listitem> + <listitem> <para> - There are certain things that should only be done be the translationcoordinator or one of the - core developers. + If you check you translation and see a not translated string even though you translationfile + is 100% translated use the bugtrackingsystem and/or contact the author of that application + directly so that this bug is fixed. </para> + </listitem> + </itemizedlist> </section> + </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 @@ <chapter><title>Installation</title> <section><title>iPAQ</title> <para> To install opie on an iPAQ, you will need a fresh Familiar installation (ie, install Familiar, and stop before you do ipkg install task-complete or ipkg install task-x), go to http://familiar.handhelds.org to get the latest version, and to get installation instructions (again, stop after the initial boot and do not install X, as it is not necessary, and will only take up space). </para> <note> <para> If you had qpe/qtopia installed previously, <emphasis>completely</emphasis> remove it, and remove the src line for it from your /etc/ipkg.conf file before attempting to install opie. </para> </note> <para> Once you have Familiar installed, set up a network connection between your iPAQ and the ouside world (again, see the Familiar site for instructions on this), and then run this command: <informalexample> <literallayout> echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ >> /etc/ipkg.conf </literallayout> </informalexample> then, run: <informalexample> <literallayout> ipkg update && ipkg install task-opie </literallayout> </informalexample> If you have a 3100 or 3800 series iPAQ, run: <informalexample> <literallayout> ipkg install qt-embedded-rotation </literallayout> </informalexample> -finally, start Opie with: +finally, start &opie; with: <informalexample> <literallayout> /etc/init.d/opie start </literallayout> </informalexample> </para> <para> -Opie should now be running (if you should have to reboot, which is rare, Opie +&opie; should now be running (if you should have to reboot, which is rare, &opie; will start automatically). From here, you can use either the "Software" application in the Settings tab, or run ipkg from the command line to install -other Opie apps. Check out the various task-opie-* ipkgs to install various sets +other &opie; apps. Check out the various task-opie-* ipkgs to install various sets of apps at once (you can always uninstall individual apps individually). You will probably want to install opie-embeddedkonsole first, so you have access to -the command line in Opie. +the command line in &opie;. </para> </section> <section><title>Zaurus</title> <para> -To completely install Opie on the Zaurus, you will have to install OpenZaurus, -which includes Opie. However, individual Opie applications will work fine on the -default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM +To completely install &opie; on the Zaurus, you will have to install OpenZaurus, +which includes &opie;. However, individual &opie; applications will work fine on the +default Zaurus rom. Do not install &opie;'s launcher on a default Zaurus ROM though. </para> </section> </chapter>
\ 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 @@ <chapter id=irda><title>IrDA Applet</title> <para> The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that can use infra red to communicate. </para> <section><title>Starting IrDA</title> <para> To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using. </para> </section> <section><title>Recieving Files</title> <para> If you want to recieve files like images or contact information from another device, you need to tell your device to start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then -have the other device send the file, and Opie should recieve it and open the file in whatever application is +have the other device send the file, and &opie; should recieve it and open the file in whatever application is appropriate. </para> <para> When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the IrDA Applet's menu so that you are not wasting system resources. </para> </section> <section><title>Beaming Files</title> <para> Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar, and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this -button, and Opie will beam the file to any waiting devices. +button, and &opie; will beam the file to any waiting devices. </para> </section> <section><title>Stoping IrDA</title> <para> Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this, select "Disable IrDA" from the IrDA applet's menu. </para> </section> </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,51 +1,51 @@ <chapter><title>VNC Viewer</title> <para> -The OPIE VNC Viewer allows you to connect to servers that are compatible with +The &opie; VNC Viewer allows you to connect to servers that are compatible with the Remote Frame Buffer (RFB) protocol, most commonly used by the VNC remote access software. </para> <section><title>Adding a bookmark</title> <para> To add a new bookmark to your bookmark list, lick the New icon on the window's toolbar. The "VNC Viewer Connection" dialog will appear. Enter the hostname or IP address of the computer you would like to connect to in the "Host Name" field. In the "Display Number" field, enter the number of the display you would like to connect to. If you are connecting to a Windows or Mac OS server, you typically select display 0. Unix servers typically use display 1 or higher. You must also enter the password for the server you would like to connect to if it requires one. If you are having difficulties entering the password, you can select "Show Password" to show the password you are entering. You must also add a descriptive name for the bookmark if you would like it to be saved. You can then either select the OK button to save the bookmark and connect to the server, or the cancel button to return to the bookmark list. </para> </section> <section><title>Connecting to a bookmarked server</title> <para> To connect to a server that has already been bookmarked, select the bookmark from the list and press the "Open" icon on the toolbar. The "VNC Viewer Connection" dialog will appear, and you will have the chance to modify the bookmark before actually connecting. Pressing the OK button will connect to the server, and pressing the cancel button will return to the bookmark list. </para> </section> <section><title>Deleting a bookmark</title> <para> To delete a bookmark, choose the bookmark that you would like to delete, and select the delete item from the toolbar. </para> </section> <section><title>Advanced Connection Options</title> <para> In addition to the display number, hostname, and password, you can choose many advanced options from the "VNC Viewer Connection" dialog box that will affect the performance of the connection. </para> <para> On the options tab you can set the delay in between requesting updates to the screen, a higher value will result in a more up to date screen, but you will use more bandwidth. You can also choose to restrict your connection to 8 bit color, which is much faster than using the color depth of the remote server at the cost of image quality. Requesting a shared session tells the RFB server 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,183 +1,183 @@ <chapter><title>Software</title> <para> The "Software" application, also called oipkg, is what is used to install and remove software. It is actually a frontend to the command line program "ipkg" so most things you can do with oipkg you can also do with ipkg. Oipkg can install things either remotely from a web server (called a "feed") or it can install an ipkg package file that resides on the local filesystem. </para> <important> <para> If you are using a version of ipkg lower than 0.99.20 there is a bug that prevents oipkg from working properly. If you see errors in the installation log about not being able to kill the old gunzip process, you can get around this by starting oipkg from Embedded Konsole. </para> </important> <section><title>Installing Software</title> <para> There are several way to install a software package, depending on how you are accessing the package. </para> <para> -To install software from a feed (see <xref linkend=feed>), first select "Opie" from the +To install software from a feed (see <xref linkend=feed>), first select "&opie;" from the "Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view. -This will show all the available Opie packages (you can change which packages +This will show all the available &opie; packages (you can change which packages to view by selecting something else from the "Section" pulldown). Installed packages are marked with a blue circle, while packages that are not installed are marked with a red box. If you click on the icon for an uninstalled package, it will turn into an open box, with a blue circle coming out of it, indicating that you have marked this package to be installed. Mark as many packages as you wish this way, and then press the "Apply" icon (same red box and blue dot icon) to install all the marked packages. It will also remove any packages marked for removal (see below). Clicking this will open a window showing all the packages marked to be removed and installed, with some check boxes on the bottom, which represent arguments to be sent to ipkg, which you can usually ignore. After verifying that all the packages to be installed are correct, press "Ok" in the upper right corner (or press "x" to cancel and go back to the package selection window). The packages should then install, and you should see their icons -appear in the Launcher, if they are Opie applications. +appear in the Launcher, if they are &opie; applications. </para> <para> If you would like to install software that is not avaialable in a feed, you can download it to your device, and open Filemanger to the directory that it is in. You can then press and hold on the file name, and select "Open in Software", and oipkg will be started, with the package already marked to install. Confirm that it is the correct package, and check any options that you may need and press "Ok" to install the package. </para> <para> If you would like to install a package but are not sure where to find it, and it is not in any of the feeds that you are using, you can try to have oipkg search for it. You can enter a query in the "Search" field in the toolbars, and then press the magnifying glass icon. Oipkg will then search a list of feeds as well as some software websites, and show you all the packages that it thinks might be what you are looking for, and displays them under the "ipkgfind&killefiz" section in the Package view. You can then select the packages that you would like to install from that list and install them as you normally would install packages from a feed. </para> </section> <section><title>Removing Software</title> <para> Removing software is the same as installing software, except you will press the blue circle icon of an installed package, and it will have a red "X" over it. Then press the apply icon, and "Ok". You can install and remove packages at the same time by marking the ones you want to install and the ones you want to remove, and then pressing apply. </para> </section> <section id=feed><title>Servers</title> <para> When you install software normally, ipkg downloadins the packages automatically from ipkg servers (also called "Feeds") and installing them. The list of servers and where they are is stored in a file called ipkg.conf in /etc/. Oipkg is capable of maintaining this list, as well as adding or deleting feeds from it. </para> <section><title>Selecting Servers</title> <para> To select which feeds you want to be able to see and install packages from, go to Settings&arrow;Setups. There will be a box with a list of servers in it called "Used Servers". Servers that are highlighted will be used to install software from, while servers that are not highlighted will be ignored. You can click on a server to toggle its status. When a server is disabled, the information about that server such as its name and location is kept, so that you can resume using it without having to reenter this data. "Ok" will save the changes, and "x" will cancel them. </para> </section> <section><title>Adding Servers</title> <para> You can add a server to your list of available servers by going to Settings&arrow;Servers. Click on the button labeled "New" and enter the name and URL into the appropriate fields at the bottom of the window. The name is only for your convinience, so name it whatever makes sense to you. The URL is the URL of the feed, so the URL for the opie feed would be "http://131.152.105.154/feeds/ipaq/unstable". When you are done, click "Ok" to save the new server, or "x" to cancel adding it. </para> </section> <section><title>Editing Servers</title> <para> To change the URL or name of a server, go to Settings&arrow;Servers, and select the server that you want to edit. The current Name and URL should appear in the appropriate fields, and you can change them to the new values. Once you are done, click "Ok" to save, or "x" to cancel. </para> </section> <section><title>Deleting Servers</title> <para> If you no longer need to use a server, this can be done by going to Settings&arrow;Servers. You can then select the server you wish to delete and press the "Remove" button. "Ok" will save the deletion, and "x" will cancel it. </para> </section> </section> <section><title>Destinations</title> <para> Software is distributed in a format called "ipkg" which contains all the necessary files for the program, as well as information on where to put them. However, this information is only half complete, as it tells the package manager where in the "destination" to put the files, but the package manager must know where this "destination" is. The default destination is "/" (called "root") so if the package says to install a file in opt/QtPalmtop/ then the file will be installed in /opt/QtPalmtop/. However, if ask the package manger to use a destination at /mnt/hda/ (this is typically where a compact flash card would be) then the files will be installed in /mnt/hda/opt/QtPalmtop/. </para> <para> The problem with installing file in a destination other than root is that the -software usually does not know where to fine the installed files, and Opie does +software usually does not know where to fine the installed files, and &opie; does not know where to find the information that tells it how to display the program in the Launcher. To get around this, the package manager creates links <footnote><para>See <xref linkend=symlink> for more information on symbolic links in Linux</para></footnote> from where the files would be if they were installed in root to where they are actually installed. This means that no more space is taken up where the files would normally be installed, but any programs can still find the files where they think they should be. </para> <section><title>Using Destinations</title> <para> To mark a single package to be installed to a destination other than the default, you can press and hold on it, and select the destination you would like to use from the "Install to" menu. That package will then be installed in that destination. </para> <para> To install a group of packages in a destination other than root, go to Settings&arrow;Setups to open the settings dialog to the Setups tab. From here you can select the destination you would like to install the package to from the pulldown menu at the bottom. You will also want to check "Link to root destination" so that links are properly made. Once you have selected the destination you want to install the package to, click the dialog's "Ok" button, and all packages that you mark for install will be installed in the selected feed (The destination will not be changed for the packages already marked for installation). </para> <para> You can also change the default destination by checking View&arrow;Destinations to add the Destination toolbar to your toolbars. You can then select the default destination from the pulldown menu, as well as use the checkbox to select whether the packages should be linked to the root destination or not. </para> </section> <section><title>Adding Destinations</title> <para> To add a destination, go to Settings&arrow;Destinations to bring up the settings dialog at the Destinations tab, and press the "New" button to add a new Destination to the list. The new destination should be highlighted automatically, and you can then change the name and the URL with the two text entry fields below it. The name is only for easy display of the destination, so name it whatever makes the most sense to you. The URL is the location that you want the destination to have. So, if you want all your software to be installed under /usr/directory then you would set the URL to that. You can then click "Ok" to save, or "x" to cancel the changes. </para> </section> <section><title>Editing Destinations</title> <para> 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 @@ -<chapter><title>Today</title> +<chapter><title>&today;</title> <para> -The Today application is a convenient way to view both the appointments from the Calendar and the tasks from the +The &today; application is a convenient way to view both the appointments from the Calendar and the tasks from the Todo application for the current day, as well as seeing what e-mail is available. It provides no interface for editing your appointments, or your tasks, but if you click the icon of the application, it will be launched. For those familiar with -PocketPC, this is similar to the Today application included with that. +PocketPC, this is similar to the &today; application included with that. </para> <section><title>Configuration</title> <para> -You can configure the Today application by pressing the wrench icon in the bottom left corner of the window. This will +You can configure the &today; application by pressing the wrench icon in the bottom left corner of the window. This will open the configuration dialog, from which you can change various settings related to display, amongst other things. </para> <section><title>Calendar</title> <para> The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed. </para> <para> The first field allows you to select the number of appointments to be shown in the Calendar section of the application. If you add more appointments, you will be taking away screen space from the other sections. The "Should location be shown?" is for determining exactly that. If checked, the location field of the appointment -will be shown in the Today main view. +will be shown in the &today; main view. "Show only later appoinmtnets" will only show appointments that begin after the current time. Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible in the main view. </para> </section> <section><title>Tasks</title> <para> -The Tasks tab lets you change how tasks are displayed in the Today main view. +The Tasks tab lets you change how tasks are displayed in the &today; main view. </para> <para> The first field lets you chose how many tasks to display in the main view. The more that are shown, the more space is taken from the other categories. </para> </section> <section><title>Miscellaneous</title> <para> The Misc. tab allows you to set global settings that affect the entire application. </para> <para> The "Clip after how many letters" field lets you change the number of characters from each appointment or task that are displayed in the main view. The "Should today be autostarted on resume" checkbox lets you set whether or not -the Today application should be started each time you resume from a suspend or not.<note><para>This only works -if you have a full installation of Opie. If you are running Today on some other environment (Qtopia, for example) +the &today; application should be started each time you resume from a suspend or not.<note><para>This only works +if you have a full installation of &opie;. If you are running &today; on some other environment (Qtopia, for example) this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set -the number of minutes that the device must be suspended before the Today application will start automatically on +the number of minutes that the device must be suspended before the &today; application will start automatically on resume. For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the -Today application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state -for 6 minutes, then Today will be started automatically upon resume. +&today; application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state +for 6 minutes, then &today; will be started automatically upon resume. </para> </section> </section> </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 @@ -43,53 +43,53 @@ To delete a task, first select it, and then either select <GUIMenu>Data</GUIMenu>&arrow; <GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of a trash can). A dialog should pop up, asking if you want to delete the task, click yes to delete it, or no to cancel. </para> </section> <section><title>Finding Tasks</title> <para> To find a task, either go to <GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem> , or click the find icon (an image of a green magnifying glass), and a dialog should pop up. Enter the text you want to search for in the description, and select the category that you want it to search through (this will speed the search up, if you know what category it is in). You can also select "case sensative" which makes the search pay attention to the case of what you type (so if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search Backwards" will search backwards from the currently selected task. Click "Find" to initiate the search, when it finds a task that matches the string, it will select it. If you click Find again, it will find the next one in the list (or the previous one, if "Search backwards" is selected). </para> </section> <section><title>Viewing Tasks</title> <para> To only view tasks filled under certain categories, go to the Category menu, and check the categories you want to view. Also, under the Options menu, you can select whether or not you want completed tasks to be visible, and whether or not you want to see the deadline. </para> </section> <section><title>Completing Tasks</title> <para> To mark a task as completed without deleting it, you can either check the checkbox next to it in the main view, or edit it, and check the "completed" check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow; <GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will disapear when you mark it completed. but do not worry, it is not gone forever, just check Completed tasks in the options menu, and you can see and edit it again. </para> </section> <section><title>Beaming Tasks</title> <para> To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select -press the Beam icon in the toolbar, or select Data&arrow;Beam. Opie will then send the task to any waiting +press the Beam icon in the toolbar, or select Data&arrow;Beam. &opie; will then send the task to any waiting device. </para> </section> </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 @@ <chapter><title>Upgrading</title> <para> -First, you should shutdown Opie from the "Shutdown" app in the Settings tab. +First, you should shutdown &opie; from the "Shutdown" app in the Settings tab. Normally, simply running <informalexample> <literallayout> ipkg update && ipkg upgrade </literallayout> </informalexample> -will upgrade Opie. However, if you currently have a version with the 1.5.0 -version number, you will have to upgrade it differently, because Opie now uses a +will upgrade &opie;. However, if you currently have a version with the 1.5.0 +version number, you will have to upgrade it differently, because &opie; now uses a different version number (the 1.5.0 was Qtopia's version number, we now use our own). To upgrade from one of these older versions, run: <informalexample> <literallayout> ipkg update ipkg install opie-update </literallayout> </informalexample> -Opie should then be upgraded. +&opie; should then be upgraded. </para> </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 @@ <!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ <!ENTITY arrow "-->"> <!ENTITY whatis SYSTEM "whatisopie.sgm"> <!ENTITY installation SYSTEM "installation.sgm"> <!ENTITY gettingaround SYSTEM "gettingaround.sgm"> <!ENTITY upgrading SYSTEM "upgrading.sgm"> <!ENTITY contacts SYSTEM "contacts.sgm"> <!ENTITY calendar SYSTEM "calendar.sgm"> <!ENTITY todo SYSTEM "todo.sgm"> <!ENTITY filemanager SYSTEM "filemanager.sgm"> <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> <!ENTITY software SYSTEM "software.sgm"> <!ENTITY today SYSTEM "today.sgm"> <!ENTITY irda SYSTEM "irda.sgm"> <!ENTITY keypebble SYSTEM "keypebble.sgm"> <!ENTITY i18n SYSTEM "i18n.sgm"> +<!ENTITY opie "OPIE"> +<!ENTITY todayapp "Today"> +<!ENTITY qt "Qt"> ]> -<book><title>Opie User Manual</title> +<book><title>&opie; User Manual</title> <bookinfo><authorgroup><collab> -<collabname>The Opie Team</collabname> +<collabname>The &opie; Team</collabname> </collab></authorgroup></bookinfo> <part><title>Getting Started</title> &whatis; &installation; &gettingaround; &upgrading; </part> <part><title>Applications</title> &contacts; &calendar; &todo; &today; &filemanager; &embeddedkonsole; &keypebble; </part> <part><title>Settings</title> &software; </part> <part><title>Applets</title> &irda; </part> <part><title>Technical Details</title> &i18n; </part> </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 @@ -<chapter><title>What is Opie?</title> +<chapter><title>What is &opie;?</title> <para> -Opie is a GUI (Graphical User Interface) for the Linux operating system (and +&opie; is a GUI (Graphical User Interface) for the Linux operating system (and might work on other OSes as well). It was originally designed for handheld computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could probably function well in other environments requiring a light GUI, such as an -old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, +old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech, which is in turn a graphical environment designed for embedded applications, -based upon the QT toolkit. +based upon the &qt; toolkit. </para> <para> -Opie has been designed for devices with small screens, and a touchscreen input +&opie; has been designed for devices with small screens, and a touchscreen input device (ie, only one mouse click, and no constant mouse position), as well as designed to fit in a relatively small amount of storage space (about 5 megabytes for the base libraries and the launcher). </para> </chapter>
\ No newline at end of file |