summaryrefslogtreecommitdiff
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/i18n.sgm31
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
@@ -24,144 +24,143 @@
24 translationfile and preferably access to cvs. The preferred editor 24 translationfile and preferably access to cvs. The preferred editor
25 is Linguist. That is an application which comes with &qt;. It has a 25 is Linguist. That is an application which comes with &qt;. It has a
26 intuitive GUI and is very easy to use. A tutorial can be found <ulink 26 intuitive GUI and is very easy to use. A tutorial can be found <ulink
27 url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>. 27 url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>.
28 </para> 28 </para>
29 <para> 29 <para>
30 However, you can use every editor which works with UTF8, for example VIM or 30 However, you can use every editor which works with UTF8, for example VIM or
31 EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s 31 EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s
32 translationfiles and can help you by proposing a translation and warn 32 translationfiles and can help you by proposing a translation and warn
33 you if there is an error within the translation. 33 you if there is an error within the translation.
34 </para> 34 </para>
35 <para> 35 <para>
36 CVS is a tool which the developers and most translators use to get the source 36 CVS is a tool which the developers and most translators use to get the source
37 of &opie;. If you already have an anonymous account for the &opie;-cvs you 37 of &opie;. If you already have an anonymous account for the &opie;-cvs you
38 should go to <filename class='directory'>OPIEDIR/i18n</filename> and do 38 should go to <filename class='directory'>OPIEDIR/i18n</filename> and do
39 39
40 <programlisting>cvs up</programlisting> 40 <programlisting>cvs up</programlisting>
41 41
42 If there is already a translation for the language you would like to 42 If there is already a translation for the language you would like to
43 translate you will see the language code in that directory. For example, 43 translate you will see the language code in that directory. For example,
44 for german this is <programlisting>de</programlisting> and for danish it is 44 for german this is <programlisting>de</programlisting> and for danish it is
45 45
46 <programlisting>da</programlisting> 46 <programlisting>da</programlisting>
47 47
48 If not, you should contact the coordinator 48 If not, you should contact the coordinator
49 <personname><firstname>Carsten</firstname> <surname>Niehaus</surname></personname> 49 <personname><firstname>Carsten</firstname> <surname>Niehaus</surname></personname>
50 so that everything will be set up for your language. 50 so that everything will be set up for your language.
51 </para> 51 </para>
52</section> 52</section>
53 53
54<section> 54<section>
55 <title>Styleguide</title> 55 <title>Styleguide</title>
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 &lt;message&gt;
90 <message> 90 &lt;source&gt;New&lt;/source&gt;
91 <source>New</source> 91 &lt;translation&gt;Neu&lt;/translation&gt;
92 <translation>Neu</translation> 92 &lt;/message&gt;
93 </message> 93 &lt;message&gt;
94 <message> 94 &lt;source&gt;Today&lt;/source&gt;
95 <source>Today</source> 95 &lt;translation&gt;Heute&lt;/translation&gt;
96 <translation>Heute</translation> 96 &lt;/message&gt;
97 </message> 97 &lt;message&gt;
98 <message> 98 &lt;source&gt;Day&lt;/source&gt;
99 <source>Day</source> 99 &lt;translation type="unfinished"&gt;&lt;/translation&gt;
100 <translation type="unfinished"></translation> 100 &lt;/message&gt;
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).
136 In theory .ts-files are the only ones a translator needs to know. 135 In theory .ts-files are the only ones a translator needs to know.
137 136
138 <filename class='extension'>pro</filename> 137 <filename class='extension'>pro</filename>
139 Every application has a .pro-file from which the Makefiles are generated. As a translator 138 Every application has a .pro-file from which the Makefiles are generated. As a translator
140 you need to check if in every .pro-file is a line for the language you want to translate to. 139 you need to check if in every .pro-file is a line for the language you want to translate to.
141 This line should look like:: 140 This line should look like::
142 141
143 <programlisting> 142 <programlisting>
144 ../../../i18n/de/today.ts \ 143 ../../../i18n/de/today.ts \
145 </programlisting> 144 </programlisting>
146 145
147 Usually the translationcoordinator takes care of these entries so you should not 146 Usually the translationcoordinator takes care of these entries so you should not
148 need to edit them. 147 need to edit them.
149 148
150 <filename class='extension'>qm</filename> 149 <filename class='extension'>qm</filename>
151 These are binary files used by &opie; to display the translated strings. They are 150 These are binary files used by &opie; to display the translated strings. They are
152 automatically generated by calling the command <command>make lrelease</command>. Of course, 151 automatically generated by calling the command <command>make lrelease</command>. Of course,
153 you need to have the binary of <application>lrelease</application> which comes with &qt;. 152 you need to have the binary of <application>lrelease</application> which comes with &qt;.
154 </para> 153 </para>
155</section> 154</section>
156 155
157<section> 156<section>
158 <title>Do's and don'ts</title> 157 <title>Do's and don'ts</title>
159 <para> 158 <para>
160 There are certain things that should only be done be the 159 There are certain things that should only be done be the
161 translationcoordinator or one of the core developers. 160 translationcoordinator or one of the core developers.
162 <itemizedlist mark='opencircle'> 161 <itemizedlist mark='opencircle'>
163 <listitem> 162 <listitem>
164 <para> 163 <para>
165 The translationfiles should never be updated by the translators. Only the 164 The translationfiles should never be updated by the translators. Only the
166 translationcoordinator updates the repository. This is to avoid merging conflicts. 165 translationcoordinator updates the repository. This is to avoid merging conflicts.
167 </para> 166 </para>