update. Spiralman?

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
@@ -194,3 +194,3 @@ To beam an appointment to another device using the IrDA and OBEX protocols, you
 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.
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
@@ -95,3 +95,3 @@ To beam a contact to another device, you must first have the IrDA Applet install
 (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.
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
@@ -2,3 +2,3 @@
 <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
@@ -66,3 +66,3 @@ 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
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,5 +1,5 @@
-<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
@@ -11,3 +11,3 @@ installed "applets".
 <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
@@ -52,3 +52,3 @@ Documents tab see the <xref linkend="adddoc">.
 <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
@@ -81,3 +81,3 @@ become the current input method, with its icon replacing the previous one.
 <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 
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> 
+
 <section>
-	<title>Preferences</title>
+	<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>.
-	</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 <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 &opie;s
+		translationfiles and can help you by proposing a translation and notice
+		you if there is an error within the translation.
+	</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.
+		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>
-		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.
+		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>
+	<title>Examplecode</title> 
+	
 	<para>
-		In the next paragraph you see an example of how the XML looks like. 
-	</para>
-	<!--
-	<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>
-	-->
+		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> 
+
 <section>
-	<title>Do's and don'ts</title>
+	<title>Filetypes</title>
 	<para>
-		There are certain things that should only be done be the translationcoordinator or one of the
-		core developers.
+		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>
+			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
@@ -39,3 +39,3 @@ If you have a 3100 or 3800 series iPAQ, run:
 </informalexample>
-finally, start Opie with:
+finally, start &opie; with:
 <informalexample>
@@ -48,9 +48,9 @@ finally, start Opie with:
 <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>
@@ -60,5 +60,5 @@ the command line in Opie.
 <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.
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
@@ -19,3 +19,3 @@ green dot should appear in the upper right hand corner of the IrDA Applet icon.
 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.
@@ -35,3 +35,3 @@ havent already (see <xref linkend="adddoc">).  Then, go to the Documents tab and
 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>
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
@@ -2,3 +2,3 @@
 <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 
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
@@ -24,5 +24,5 @@ accessing the package.
 <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 
@@ -40,3 +40,3 @@ 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>
@@ -134,3 +134,3 @@ then the files will be installed in /mnt/hda/opt/QtPalmtop/.
 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 
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,7 +1,7 @@
-<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>
@@ -9,3 +9,3 @@ PocketPC, this is similar to the Today application included with that.
 <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.
@@ -20,3 +20,3 @@ If you add more appointments, you will be taking away screen space from the othe
 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.
@@ -28,3 +28,3 @@ in the main view.
 <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>
@@ -42,9 +42,9 @@ The "Clip after how many letters" field lets you change the number of characters
 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>
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
@@ -90,3 +90,3 @@ To beam a task to another device using the IrDA and OBEX protocols, you must fir
 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.
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
@@ -2,3 +2,3 @@
 <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
@@ -9,4 +9,4 @@ Normally, simply running
 </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
@@ -19,3 +19,3 @@ own). To upgrade from one of these older versions, run:
 </informalexample>
-Opie should then be upgraded.
+&opie; should then be upgraded.
 </para>
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
@@ -16,6 +16,9 @@
 <!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>
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,4 +1,4 @@
-<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
@@ -6,8 +6,8 @@ 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
@@ -16,2 +16,2 @@ for the base libraries and the launcher).
 </para>
-</chapter>
\ No newline at end of file
+</chapter>