-rw-r--r-- | docs/usermanual/i18n.sgm | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm index 3c81d6c..d2a1f37 100644 --- a/docs/usermanual/i18n.sgm +++ b/docs/usermanual/i18n.sgm | |||
@@ -1,190 +1,190 @@ | |||
1 | <chapter> | 1 | <chapter> |
2 | <title>Translations</title> | 2 | <title>Translations</title> |
3 | <para> | 3 | <para> |
4 | The &opie;-Project tries to offer the support for as many languages | 4 | The &opie;-Project tries to offer the support for as many languages |
5 | as possible. In this chapter the process of translating &opie; and its | 5 | as possible. In this chapter the process of translating &opie; and its |
6 | documentation is explained. | 6 | documentation is explained. |
7 | </para> | 7 | </para> |
8 | <para> | 8 | <para> |
9 | To ensure that &opie; can be used by as many people as possible the | 9 | To ensure that &opie; can be used by as many people as possible the |
10 | &opie;-project aims to be translated in as many languages as possible. Of | 10 | &opie;-project aims to be translated in as many languages as possible. Of |
11 | course, as there are so many different languages, there is always a lot | 11 | course, as there are so many different languages, there is always a lot |
12 | work to do. Furthermore, &opie; evolves and thus most likely there are | 12 | work to do. Furthermore, &opie; evolves and thus most likely there are |
13 | translations for applications which should be updated. In this tutorial | 13 | translations for applications which should be updated. In this tutorial |
14 | you will learn how to help &opie; to be available in as many languages as | 14 | you will learn how to help &opie; to be available in as many languages as |
15 | possible and see how easy it is to give something very much respected to | 15 | possible and see how easy it is to give something very much respected to |
16 | the open-source community. | 16 | the open-source community. |
17 | </para> | 17 | </para> |
18 | 18 | ||
19 | <section> | 19 | <section> |
20 | <title>Preferences</title> | 20 | <title>Preferences</title> |
21 | 21 | ||
22 | <para> | 22 | <para> |
23 | In order to translate for &opie; you need an editor to edit the | 23 | In order to translate for &opie; you need an editor to edit the |
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 notice | 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 | <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to | 39 | <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to |
40 | translate you will see the language code in that directory. For example, | 40 | translate you will see the language code in that directory. For example, |
41 | for german this is <programlisting>de</programlisting> and for danish it is | 41 | for german this is <programlisting>de</programlisting> and for danish it is |
42 | <programlisting>da</programlisting>. If not, you should contact the coordinator | 42 | <programlisting>da</programlisting>. If not, you should contact the coordinator |
43 | <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname> | 43 | <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname> |
44 | so that everything will be set up for your language. | 44 | so that everything will be set up for your language. |
45 | </para> | 45 | </para> |
46 | </section> | 46 | </section> |
47 | 47 | ||
48 | <section> | 48 | <section> |
49 | <title>Styleguide</title> | 49 | <title>Styleguide</title> |
50 | <para> | 50 | <para> |
51 | To ensure a high quality of the translations the translatiors have to keep certain things | 51 | To ensure a high quality of the translations the translatiors have to keep certain things |
52 | in mind. | 52 | in mind. |
53 | </para> | 53 | </para> |
54 | <itemizedlist mark='opencircle'> | 54 | <itemizedlist mark='opencircle'> |
55 | <listitem> | 55 | <listitem> |
56 | <para> | 56 | <para> |
57 | The applications do not speak to the user. This means that for example it should not | 57 | The applications do not speak to the user. This means that for example it should not |
58 | be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>. | 58 | be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>. |
59 | </para> | 59 | </para> |
60 | </listitem> | 60 | </listitem> |
61 | <listitem> | 61 | <listitem> |
62 | <para> | 62 | <para> |
63 | Try not to use exclamationmarks. If the users sees them to often the ! looses it function | 63 | Try not to use exclamationmarks. If the users sees them to often the ! looses it function |
64 | as a amplifier of a warning. | 64 | as a amplifier of a warning. |
65 | </para> | 65 | </para> |
66 | </listitem> | 66 | </listitem> |
67 | <listitem> | 67 | <listitem> |
68 | <para> | 68 | <para> |
69 | Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" insteadt | 69 | Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" instead |
70 | of "this is a demonstation !". | 70 | of "this is a demonstation !". |
71 | </para> | 71 | </para> |
72 | </listitem> | 72 | </listitem> |
73 | </itemizedlist> | 73 | </itemizedlist> |
74 | </section> | 74 | </section> |
75 | 75 | ||
76 | <section> | 76 | <section> |
77 | <title>Examplecode</title> | 77 | <title>Examplecode</title> |
78 | 78 | ||
79 | <para> | 79 | <para> |
80 | In the next paragraph you see an example of how the XML looks like. | 80 | In the next paragraph you see an example of what the XML looks like. |
81 | </para> | 81 | </para> |
82 | <!-- | 82 | <!-- |
83 | <programlisting> | 83 | <programlisting> |
84 | <message> | 84 | <message> |
85 | <source>New</source> | 85 | <source>New</source> |
86 | <translation>Neu</translation> | 86 | <translation>Neu</translation> |
87 | </message> | 87 | </message> |
88 | <message> | 88 | <message> |
89 | <source>Today</source> | 89 | <source>Today</source> |
90 | <translation>Heute</translation> | 90 | <translation>Heute</translation> |
91 | </message> | 91 | </message> |
92 | <message> | 92 | <message> |
93 | <source>Day</source> | 93 | <source>Day</source> |
94 | <translation type="unfinished"></translation> | 94 | <translation type="unfinished"></translation> |
95 | </message> | 95 | </message> |
96 | </programlisting> | 96 | </programlisting> |
97 | --> | 97 | --> |
98 | <para> | 98 | <para> |
99 | As you can see the markup is very simple. The part between two source-tags is | 99 | As you can see the markup is very simple. The part between two source-tags is |
100 | the english text which appears if there is no translation yet. In the first | 100 | the english text which appears if there is no translation yet. In the first |
101 | case this is <quote>New</quote>. The next row is where the translated string | 101 | case this is <quote>New</quote>. The next row is where the translated string |
102 | would be. The first two messages are already translated, the third is | 102 | would be. The first two messages are already translated, the third is |
103 | not. This is marked by the <programlisting>type="unfinished"</programlisting>. | 103 | not. This is marked by the <programlisting>type="unfinished"</programlisting>. |
104 | </para> | 104 | </para> |
105 | <para> | 105 | <para> |
106 | If you choose to use an editor like VIM instead of the prefered tool | 106 | If you choose to use an editor like VIM instead of the prefered tool |
107 | -Linguist- you have to remove that mark and add the translated string | 107 | -Linguist- you have to remove that mark and add the translated string |
108 | between the two <programlisting>translation</programlisting>-tags. | 108 | between the two <programlisting>translation</programlisting>-tags. |
109 | </para> | 109 | </para> |
110 | <para> | 110 | <para> |
111 | It might happen that you see <programlisting>type="obsolete"</programlisting> in a | 111 | It might happen that you see <programlisting>type="obsolete"</programlisting> in a |
112 | .ts-file. You should not translate these stings as they do no longer appear in the | 112 | .ts-file. You should not translate these stings as they do no longer appear in the |
113 | application. The translationcoordinator removes those strings from time to time. In | 113 | application. The translationcoordinator removes those strings from time to time. In |
114 | Linguist those strings are grey and not translatable. | 114 | Linguist those strings are grey and not translatable. |
115 | </para> | 115 | </para> |
116 | </section> | 116 | </section> |
117 | 117 | ||
118 | <section> | 118 | <section> |
119 | <title>Filetypes</title> | 119 | <title>Filetypes</title> |
120 | <para> | 120 | <para> |
121 | As a translator one need to know three different filetypes. | 121 | As a translator one needs to know three different filetypes. |
122 | 122 | ||
123 | <filename class='extension'>ts</filename> | 123 | <filename class='extension'>ts</filename> |
124 | .ts-files are the most important files for translators. In these files are all strings which | 124 | .ts-files are the most important files for translators. In these files are all strings which |
125 | need to be translated and the translations themselfs. All .ts-files are located in | 125 | need to be translated and the translations themselfs. All .ts-files are located in |
126 | <filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de). | 126 | <filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de). |
127 | In theory .ts-files are the only ones a translator needs to know. | 127 | In theory .ts-files are the only ones a translator needs to know. |
128 | 128 | ||
129 | <filename class='extension'>pro</filename> | 129 | <filename class='extension'>pro</filename> |
130 | Every application has a .pro-file from which the Makefiles are generated. As a translator | 130 | Every application has a .pro-file from which the Makefiles are generated. As a translator |
131 | you need to check if in every .pro-file is a line for the language you would to | 131 | you need to check if in every .pro-file is a line for the language you want to translate to. |
132 | translate for. A line like this should look this way: | 132 | This line should look like:: |
133 | 133 | ||
134 | <programlisting> | 134 | <programlisting> |
135 | ../../../i18n/de/today.ts \ | 135 | ../../../i18n/de/today.ts \ |
136 | </programlisting> | 136 | </programlisting> |
137 | 137 | ||
138 | Usually the translationcoordinator takes care of these entries so you should not | 138 | Usually the translationcoordinator takes care of these entries so you should not |
139 | need to edit them. | 139 | need to edit them. |
140 | 140 | ||
141 | <filename class='extension'>qm</filename> | 141 | <filename class='extension'>qm</filename> |
142 | These are binary files used by &opie; to display the translated strings. They are | 142 | These are binary files used by &opie; to display the translated strings. They are |
143 | automatically generated by calling the command <command>make lrelease</command>. Of course, | 143 | automatically generated by calling the command <command>make lrelease</command>. Of course, |
144 | you need to have the binary of <application>lrelease</application> which comes with &qt;. | 144 | you need to have the binary of <application>lrelease</application> which comes with &qt;. |
145 | </para> | 145 | </para> |
146 | </section> | 146 | </section> |
147 | 147 | ||
148 | <section> | 148 | <section> |
149 | <title>Do's and don'ts</title> | 149 | <title>Do's and don'ts</title> |
150 | <para> | 150 | <para> |
151 | There are certain things that should only be done be the | 151 | There are certain things that should only be done be the |
152 | translationcoordinator or one of the core developers. | 152 | translationcoordinator or one of the core developers. |
153 | <itemizedlist mark='opencircle'> | 153 | <itemizedlist mark='opencircle'> |
154 | <listitem> | 154 | <listitem> |
155 | <para> | 155 | <para> |
156 | The translationfiles should never be updated by the translators. Only the | 156 | The translationfiles should never be updated by the translators. Only the |
157 | translationcoordinator updates the repository. This is to avoid merging conflicts. | 157 | translationcoordinator updates the repository. This is to avoid merging conflicts. |
158 | </para> | 158 | </para> |
159 | </listitem> | 159 | </listitem> |
160 | <listitem> | 160 | <listitem> |
161 | <para> | 161 | <para> |
162 | The binary .qm-files are created by either the translationcoordinator or by the feed-manager. | 162 | The binary .qm-files are created by either the translationcoordinator or by the feed-manager. |
163 | Of course, the translators can created them as described above for testingpurposes but | 163 | Of course, the translators can create them as described above for testing purposes but |
164 | the official files will be provided. | 164 | the official files will be provided. |
165 | </para> | 165 | </para> |
166 | </listitem> | 166 | </listitem> |
167 | <listitem> | 167 | <listitem> |
168 | <para> | 168 | <para> |
169 | Whenever you find a typo or an incorrect message contact the author of the application | 169 | Whenever you find a typo or an incorrect message, contact the author of the application |
170 | and/or use our bugtrackingsystem (Mantis) to make sure this string will be fixed. | 170 | and/or use our bug tracking system (Mantis) to make sure this string will be fixed. |
171 | </para> | 171 | </para> |
172 | </listitem> | 172 | </listitem> |
173 | <listitem> | 173 | <listitem> |
174 | <para> | 174 | <para> |
175 | If you find a string like "Form1" contact the translationcoordinator. These strings | 175 | If you find a string like "Form1" contact the translation coordinator. These strings |
176 | should not be in the translationfiles. You don't need to translate them. | 176 | should not be in the translationfiles. You don't need to translate them. |
177 | </para> | 177 | </para> |
178 | </listitem> | 178 | </listitem> |
179 | <listitem> | 179 | <listitem> |
180 | <para> | 180 | <para> |
181 | If you check you translation and see a not translated string even though you translationfile | 181 | If you check you translation and see an un-translated string even though your translationfile |
182 | is 100% translated use the bugtrackingsystem and/or contact the author of that application | 182 | is 100% translated use the bug tracking system and/or contact the author of that application |
183 | directly so that this bug is fixed. | 183 | directly so that this bug is fixed. |
184 | </para> | 184 | </para> |
185 | </listitem> | 185 | </listitem> |
186 | </itemizedlist> | 186 | </itemizedlist> |
187 | </para> | 187 | </para> |
188 | </section> | 188 | </section> |
189 | 189 | ||
190 | </chapter> | 190 | </chapter> |