update... not perfect though

author: cniehaus <cniehaus> 2002-12-14 18:26:22 (UTC)
committer: cniehaus <cniehaus> 2002-12-14 18:26:22 (UTC)
commit: ade8c5fddf3f125ee276c4c19d1646a9ef4cab08 (patch) (unidiff)
tree: f2efa560296cc6b433ac7f458cc81313b496e496
parent: 7c854ad1b909f37c7314ef4ac2061500d02af16d (diff)
download: opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.zip
opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.tar.gz
opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.tar.bz2
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm
index 9ebdf6d..d55ebd0 100644
--- a/docs/usermanual/i18n.sgm
+++ b/docs/usermanual/i18n.sgm
@@ -56,80 +56,79 @@
        <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!" instead
                        of "this is a demonstation !".
                </para>
                </listitem>
        </itemizedlist>
 </section>
 <section>
        <title>Examplecode</title> 
        
        <para>
                In the next paragraph you see an example of what the XML looks like.
        </para>
-<!--
+<literallayout>
-        <programlisting>
+                &lt;message&gt;
-                <message> 
+                        &lt;source&gt;New&lt;/source&gt; 
-                        <source>New</source> 
+                        &lt;translation&gt;Neu&lt;/translation&gt;
-                        <translation>Neu</translation>
+                &lt;/message&gt; 
-                </message> 
+                &lt;message&gt; 
-                <message> 
+                        &lt;source&gt;Today&lt;/source&gt;
-                        <source>Today</source>
+                        &lt;translation&gt;Heute&lt;/translation&gt;
-                        <translation>Heute</translation>
+                &lt;/message&gt;
-                </message>
+                &lt;message&gt; 
-                <message> 
+                        &lt;source&gt;Day&lt;/source&gt; 
-                        <source>Day</source> 
+                        &lt;translation type="unfinished"&gt;&lt;/translation&gt; 
-                        <translation type="unfinished"></translation> 
+                &lt;/message&gt;
-                </message>
+</literallayout>
-        </programlisting>
-->
        <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>
                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 translation-tags.
        </para>
        <para>
                It might happen that you see <emphasis>type="obsolete"</emphasis> 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 needs 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).
author	cniehaus <cniehaus>	2002-12-14 18:26:22 (UTC)
committer	cniehaus <cniehaus>	2002-12-14 18:26:22 (UTC)
commit	ade8c5fddf3f125ee276c4c19d1646a9ef4cab08 (patch) (unidiff)
tree	f2efa560296cc6b433ac7f458cc81313b496e496
parent	7c854ad1b909f37c7314ef4ac2061500d02af16d (diff)
download	opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.zip opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.tar.gz opie-ade8c5fddf3f125ee276c4c19d1646a9ef4cab08.tar.bz2

diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm index 9ebdf6d..d55ebd0 100644 --- a/docs/usermanual/i18n.sgm +++ b/docs/usermanual/i18n.sgm
@@ -56,80 +56,79 @@
56	<para>	56	<para>
57	To ensure a high quality of the translations the translatiors have to keep certain things	57	To ensure a high quality of the translations the translatiors have to keep certain things
58	in mind.	58	in mind.
59	</para>	59	</para>
60	<itemizedlist mark='opencircle'>	60	<itemizedlist mark='opencircle'>
61	<listitem>	61	<listitem>
62	<para>	62	<para>
63	The applications do not speak to the user. This means that for example it should not	63	The applications do not speak to the user. This means that for example it should not
64	be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>.	64	be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>.
65	</para>	65	</para>
66	</listitem>	66	</listitem>
67	<listitem>	67	<listitem>
68	<para>	68	<para>
69	Try not to use exclamationmarks. If the users sees them to often the ! looses it function	69	Try not to use exclamationmarks. If the users sees them to often the ! looses it function
70	as a amplifier of a warning.	70	as a amplifier of a warning.
71	</para>	71	</para>
72	</listitem>	72	</listitem>
73	<listitem>	73	<listitem>
74	<para>	74	<para>
75	Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" instead	75	Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" instead
76	of "this is a demonstation !".	76	of "this is a demonstation !".
77	</para>	77	</para>
78	</listitem>	78	</listitem>
79	</itemizedlist>	79	</itemizedlist>
80	</section>	80	</section>
81		81
82	<section>	82	<section>
83	<title>Examplecode</title>	83	<title>Examplecode</title>
84		84
85	<para>	85	<para>
86	In the next paragraph you see an example of what the XML looks like.	86	In the next paragraph you see an example of what the XML looks like.
87	</para>	87	</para>
88	<!--	88	<literallayout>
89	<programlisting>	89	<message>
90	<message>	90	<source>New</source>
91	<source>New</source>	91	<translation>Neu</translation>
92	<translation>Neu</translation>	92	</message>
93	</message>	93	<message>
94	<message>	94	<source>Today</source>
95	<source>Today</source>	95	<translation>Heute</translation>
96	<translation>Heute</translation>	96	</message>
97	</message>	97	<message>
98	<message>	98	<source>Day</source>
99	<source>Day</source>	99	<translation type="unfinished"></translation>
100	<translation type="unfinished"></translation>	100	</message>
101	</message>	101	</literallayout>
102	</programlisting>	102
103	-->
104	<para>	103	<para>
105	As you can see the markup is very simple. The part between two source-tags is	104	As you can see the markup is very simple. The part between two source-tags is
106	the english text which appears if there is no translation yet. In the first	105	the english text which appears if there is no translation yet. In the first
107	case this is <quote>New</quote>. The next row is where the translated string	106	case this is <quote>New</quote>. The next row is where the translated string
108	would be. The first two messages are already translated, the third is	107	would be. The first two messages are already translated, the third is
109	not. This is marked by the	108	not. This is marked by the
110		109
111	<programlisting>type="unfinished"</programlisting>	110	<programlisting>type="unfinished"</programlisting>
112		111
113	</para>	112	</para>
114	<para>	113	<para>
115	If you choose to use an editor like VIM instead of the prefered tool	114	If you choose to use an editor like VIM instead of the prefered tool
116	-Linguist- you have to remove that mark and add the translated string	115	-Linguist- you have to remove that mark and add the translated string
117	between the two translation-tags.	116	between the two translation-tags.
118	</para>	117	</para>
119	<para>	118	<para>
120	It might happen that you see <emphasis>type="obsolete"</emphasis> in a	119	It might happen that you see <emphasis>type="obsolete"</emphasis> in a
121	.ts-file. You should not translate these stings as they do no longer appear in the	120	.ts-file. You should not translate these stings as they do no longer appear in the
122	application. The translationcoordinator removes those strings from time to time. In	121	application. The translationcoordinator removes those strings from time to time. In
123	Linguist those strings are grey and not translatable.	122	Linguist those strings are grey and not translatable.
124	</para>	123	</para>
125	</section>	124	</section>
126		125
127	<section>	126	<section>
128	<title>Filetypes</title>	127	<title>Filetypes</title>
129	<para>	128	<para>
130	As a translator one needs to know three different filetypes.	129	As a translator one needs to know three different filetypes.
131		130
132	<filename class='extension'>ts</filename>	131	<filename class='extension'>ts</filename>
133	.ts-files are the most important files for translators. In these files are all strings which	132	.ts-files are the most important files for translators. In these files are all strings which
134	need to be translated and the translations themselfs. All .ts-files are located in	133	need to be translated and the translations themselfs. All .ts-files are located in
135	<filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de).	134	<filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de).