summaryrefslogtreecommitdiff
path: root/docs/usermanual
authorcniehaus <cniehaus>2002-12-13 22:44:24 (UTC)
committer cniehaus <cniehaus>2002-12-13 22:44:24 (UTC)
commitb90d33132c1191fd299e902da9684e51615d1c41 (patch) (unidiff)
treec80b1756bcd3c4d0fde8d368c333bf0243f7945a /docs/usermanual
parent1f7551e3f68040b3c24f6c5b39d9fc59bdbd9f7a (diff)
downloadopie-b90d33132c1191fd299e902da9684e51615d1c41.zip
opie-b90d33132c1191fd299e902da9684e51615d1c41.tar.gz
opie-b90d33132c1191fd299e902da9684e51615d1c41.tar.bz2
some bugfixes in the markup
Diffstat (limited to 'docs/usermanual') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/i18n.sgm21
1 files changed, 15 insertions, 6 deletions
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm
index d2a1f37..9ebdf6d 100644
--- a/docs/usermanual/i18n.sgm
+++ b/docs/usermanual/i18n.sgm
@@ -23,37 +23,43 @@
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 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 <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to 39
40 <programlisting>cvs up</programlisting>
41
42 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, 43 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 44 for german this is <programlisting>de</programlisting> and for danish it is
42 <programlisting>da</programlisting>. If not, you should contact the coordinator 45
43 <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname> 46 <programlisting>da</programlisting>
47
48 If not, you should contact the coordinator
49 <personname><firstname>Carsten</firstname> <surname>Niehaus</surname></personname>
44 so that everything will be set up for your language. 50 so that everything will be set up for your language.
45 </para> 51 </para>
46</section> 52</section>
47 53
48<section> 54<section>
49 <title>Styleguide</title> 55 <title>Styleguide</title>
50 <para> 56 <para>
51 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
52 in mind. 58 in mind.
53 </para> 59 </para>
54 <itemizedlist mark='opencircle'> 60 <itemizedlist mark='opencircle'>
55 <listitem> 61 <listitem>
56 <para> 62 <para>
57 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
58 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>.
59 </para> 65 </para>
@@ -87,41 +93,44 @@
87 </message> 93 </message>
88 <message> 94 <message>
89 <source>Today</source> 95 <source>Today</source>
90 <translation>Heute</translation> 96 <translation>Heute</translation>
91 </message> 97 </message>
92 <message> 98 <message>
93 <source>Day</source> 99 <source>Day</source>
94 <translation type="unfinished"></translation> 100 <translation type="unfinished"></translation>
95 </message> 101 </message>
96 </programlisting> 102 </programlisting>
97--> 103-->
98 <para> 104 <para>
99 As you can see the markup is very simple. The part between two source-tags is 105 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 106 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 107 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 108 would be. The first two messages are already translated, the third is
103 not. This is marked by the <programlisting>type="unfinished"</programlisting>. 109 not. This is marked by the
110
111 <programlisting>type="unfinished"</programlisting>
112
104 </para> 113 </para>
105 <para> 114 <para>
106 If you choose to use an editor like VIM instead of the prefered tool 115 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 116 -Linguist- you have to remove that mark and add the translated string
108 between the two <programlisting>translation</programlisting>-tags. 117 between the two translation-tags.
109 </para> 118 </para>
110 <para> 119 <para>
111 It might happen that you see <programlisting>type="obsolete"</programlisting> in a 120 It might happen that you see <emphasis>type="obsolete"</emphasis> in a
112 .ts-file. You should not translate these stings as they do no longer appear in the 121 .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 122 application. The translationcoordinator removes those strings from time to time. In
114 Linguist those strings are grey and not translatable. 123 Linguist those strings are grey and not translatable.
115 </para> 124 </para>
116</section> 125</section>
117 126
118<section> 127<section>
119 <title>Filetypes</title> 128 <title>Filetypes</title>
120 <para> 129 <para>
121 As a translator one needs to know three different filetypes. 130 As a translator one needs to know three different filetypes.
122 131
123 <filename class='extension'>ts</filename> 132 <filename class='extension'>ts</filename>
124 .ts-files are the most important files for translators. In these files are all strings which 133 .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 134 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). 135 <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. 136 In theory .ts-files are the only ones a translator needs to know.