| -rw-r--r-- | docs/usermanual/usermanual.sgm | 194 |
1 files changed, 72 insertions, 122 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm index bfa09fb..0232cd3 100644 --- a/docs/usermanual/usermanual.sgm +++ b/docs/usermanual/usermanual.sgm @@ -1,2 +1,4 @@ -<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN"> +<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ +<!ENTITY arrow "-->"> +]> <book><title>Opie User Manual</title> @@ -7,5 +9,5 @@ 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 which could +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 bassed 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, @@ -32,5 +34,5 @@ not install X, as it is not necessary, and will only take up space). <para> -Note: If you had qpe/qtopia installed previously, \emph{completely} remove it, -and remove the src line for it from your /etc/ipkg.conf file before attempting -to install opie. +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> @@ -72,4 +74,2 @@ 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 - - of apps at once (you can always uninstall individual apps individually). You @@ -84,4 +84,2 @@ 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 @@ -106,4 +104,2 @@ 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 @@ -119,5 +115,3 @@ click usually does on a desktop interface. <para> -The Launcher behaves like the "desktop" on most PC GUIs. When no applications - - +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 @@ -130,4 +124,2 @@ 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 @@ -136,4 +128,2 @@ 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 @@ -145,6 +135,4 @@ 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 \ref{docadd} on page \pageref{docadd} +Documents tab see the <xref linkend="adddoc">. </para> @@ -188,4 +176,2 @@ 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). @@ -212,4 +198,2 @@ 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 @@ -237,4 +221,5 @@ work for, etc. <para> -To Add a user, go to <GUImenu>Contact</GUImenu><GUIMenuItem>Add</GUIMenuItem>, -or click the add icon in the toolbar (looks like a blank piece of paper). +To Add a user, go to +<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>, +or click the add icon in the toolbar (looks like a blank piece of paper). First, you need to give the person a name. You can do this by either entering @@ -270,6 +255,6 @@ edit their profile later), click the "x" to cancel, and not add the contact. To edit the contacts, select the person you want to edit, anc click the pencil -icon, or go to <GUIMenu>Contact</GUIMenu><GUIMenuItem>Edit</GUIMenuItem>, and it -will open up the same dialog used to add a user, except their information that -is already entered will already be filled in. To finalise the changes, click -"Ok", or to cancel them, click "x". +icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>, +and it will open up the same dialog used to add a user, except their information +that is already entered will already be filled in. To finalise the changes, +click "Ok", or to cancel them, click "x". </para> @@ -280,7 +265,5 @@ is already entered will already be filled in. To finalise the changes, click To delete a contact, select the person from the list of contacts, and click the -trash can icon, or go to Contact \begin{math}\rightarrow\end{math}Delete. A -dialog will pop up asking if you want to actually delete that contact, click yes - - -to delete it, no will cancel. +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> @@ -291,12 +274,12 @@ to delete it, no will cancel. To find a specific person, click the find icon (green magnifying glass), or go -to <GUIMenu>Contact</GUIMenu><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". +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> @@ -349,4 +332,2 @@ represent the days of the current week, and on the left and right sides of the navigation bar are arrows, which allow you to move one day in that direction. If - - you are on the last day of the week, pressing the arrow will bring you into the @@ -360,4 +341,2 @@ hour. If you select one, any new appointments will automatically default to begining at that time and ending an hour later (which you can, of course, change - - when you create the appointment). @@ -377,4 +356,2 @@ each day of the week, and rows, representing each hour of the day. In the navigation bar at the top, there are two scroll boxes, the one on the left shows - - the current year, and the one to the right shows which week it is of that year. @@ -388,5 +365,3 @@ see a blue square which represents an appointment, which you can press to see details of the appointment. If you press anywhere in the free space, you will go - - -to the day of the column that you clicked in. +to the day of the column that you clicked in. </para> @@ -400,4 +375,2 @@ between them. This is convinient if you need to see a list of all your appointments, but do not need to see how your time is mapped out. The navigation - - bar has an arrow button on either side, allowing you to move to the next or @@ -406,4 +379,2 @@ year. Pressing the week number button will bring up a calendar dialog, which allows you to select the week you are viewing. Selecting a day from the calendar - - will bring you to the week that day is in. To the right of that is a button with @@ -419,9 +390,5 @@ itself will bring you to the day view for that day. Under each day is a list of all the appointments for that day, as well as their start times. If you click on - - an appointment, you will go to an edit dialog for that appointment, which lets -you view its details. Next to each day heading is a "+" sign, clicking it will - - -create a new appointment for that day. +you view its details. Next to each day heading is a "+" sign, clicking it will +create a new appointment for that day. </para> @@ -432,8 +399,4 @@ create a new appointment for that day. The month view looks like a normal monthly calendar, allowing you to see on what - - days of the month you have appointments. In the navigation bar, there are two pairs of arrows. The pair with an arrow and a vertical line will take you to the - - first or last month of the currently selected year, while the normal arrow @@ -446,4 +409,2 @@ The main view is divided up into a grid, where the columns are the days of the week, and the rows are the weeks (just like an ordinary calendar). The currently - - selected day has a bold box drawn around it, and if the day has an appointment, @@ -461,4 +422,2 @@ day. To add an appointment, click on the add appointment button in the toolbar at the - - top of the window (an image of a blank page), and a dialog will open up, @@ -472,4 +431,2 @@ short description of the appointment, or select a common one from the dropdown list. The location field allows you to do the same. The category dropdown allows - - you to assign the appointment to a category, which you can use later to view @@ -487,4 +444,2 @@ minutes field for the start time, it will automatically set the minutes field for the end time to the same thing, but you can change this by selecting the end - - field and giving it its own minutes field. Because of this, it is fastest to set @@ -500,8 +455,4 @@ and then set the number of minutes before the appointment that you want the 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. @@ -515,4 +466,2 @@ interface below, to represent the available options for that type of repetition 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 @@ -561,16 +510,17 @@ a certain time. <para> -Go to Data \begin{math}\rightarrow\end{math}New Task, or click on the new task -icon (blank page). The priority drop down menu lets you select the priority of -the task. The lower the number, the more important it is. The categories behave -in much the same way that they do in Calendar, you can select the category from -the drop down menu, or you can click the "..." button to add, delete, or edit -categories. To give the task a due date, check the "Due" checkbox, and then -click the button next to it (it should contain the current date). That will open -a calendar from which you can select the due date. The "Completed" check box -is the same as the checkbox next to each item in the main view. The "Summary" -field is for a short summary that will be visible in the main view, as well as -in the Today application. The down arrow next to it will copy the text in the -"Summary" field into the large text field below it, which is used for a more -detailed description of the task. Click "ok" in the upper right to add the -new task, or "x" to close the window without adding the new task. +Go to <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>New Task<GUIMenuItem>, or click +on the new task icon (blank page). The priority drop down menu lets you select +the priority of the task. The lower the number, the more important it is. The +categories behave in much the same way that they do in Calendar, you can select +the category from the drop down menu, or you can click the "..." button to add, +delete, or edit categories. To give the task a due date, check the "Due" +checkbox, and then click the button next to it (it should contain the current +date). That will open a calendar from which you can select the due date. The +"Completed" check box is the same as the checkbox next to each item in the main +view. The "Summary" field is for a short summary that will be visible in the +main view, as well as in the Today application. The down arrow next to it will +copy the text in the "Summary" field into the large text field below it, which +is used for a more detailed description of the task. Click "ok" in the upper +right to add the new task, or "x" to close the window without adding the new +task. </para> @@ -580,3 +530,3 @@ new task, or "x" to close the window without adding the new task. To edit a task, you can select it, and then go to -<GUIMenu>Data</GUIMenu><GUIMenuItem>Edit +<GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same @@ -592,3 +542,3 @@ the way it was. To delete a task, first select it, and then either select -<GUIMenu>Data</GUIMenu> +<GUIMenu>Data</GUIMenu>&arrow; <GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of @@ -601,13 +551,12 @@ click yes to delete it, or no to cancel. To find a task, either go to -<GUIMenu>Options</GUIMenu><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 +<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). @@ -629,3 +578,3 @@ 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> +check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow; <GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will @@ -717,3 +666,3 @@ is actually a text file). -<section><title>Adding to "Documents"</title> +<section id="adddoc"><title>Adding to "Documents"</title> <para> @@ -753,4 +702,5 @@ 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 \underline{Running Linux} for a comprehensive look at Linux for the -beginner). I will, however, give a quick overview of using a Linux shell. +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> @@ -794,3 +744,3 @@ 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> +You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; <GUIMenuItem>Command List.</GUIMenuItem> @@ -875,6 +825,6 @@ directory (usually /home/username or /root for the root user). To move files around, you need to use the "cp" (copy) and "mv" (move) -commands. Both of these are run the same way: \verb+command originalfile -newfile+. The only difference is that cp creates a new file without touching -the old one, while mv deletes the original file. The two path names can be -either absolute or relative. If you only specify a directory for the +commands. Both of these are run the same way: <userinput>command originalfile +newfile</userinput>. The only difference is that cp creates a new file without +touching the old one, while mv deletes the original file. The two path names +can be either absolute or relative. If you only specify a directory for the destination, and no filename, it will use the filename for the original file. @@ -922,3 +872,3 @@ install an ipkg package file that resides on the local filesystem. <para> -Note: There is a bug in oipkg that prevents it from installing packages +There is a bug in oipkg that prevents it from installing packages properly. There is, however, a workaround for it. Simply run oipkg from @@ -930,3 +880,3 @@ Embedded Konsole to avoid the bug. <para> -To install software, first select "Opie" from the "Section" pulldown menu, +To install software, first select "Opie" from the "Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view. This will show all |