chiark / gitweb /
Update POT and PO files (after fixing #655153)
[developers-reference.git] / l10n.dbk
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "" [
4   <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
5 ]>
6 <chapter id="l10n">
7 <title>Internationalization and Translations</title>
8 <para>
9 Debian supports an ever-increasing number of natural languages.  Even if you
10 are a native English speaker and do not speak any other language, it is part of
11 your duty as a maintainer to be aware of issues of internationalization
12 (abbreviated i18n because there are 18 letters between the 'i' and the 'n' in
13 internationalization).  Therefore, even if you are ok with English-only
14 programs, you should read most of this chapter.
15 </para>
16 <para>
17 According to <ulink
18 url="&url-i18n-intro;">Introduction to
19 i18n</ulink> from Tomohiro KUBOTA, I18N (internationalization) means
20 modification of a software or related technologies so that a software can
21 potentially handle multiple languages, customs, and so on in the world,  while
22 L10N (localization) means implementation of a specific language for an already
23 internationalized software.
24 </para>
25 <para>
26 l10n and i18n are interconnected, but the difficulties related to each of them
27 are very different.  It's not really difficult to allow a program to change the
28 language in which texts are displayed based on user settings, but it is very
29 time consuming to actually translate these messages.  On the other hand,
30 setting the character encoding is trivial, but adapting the code to use several
31 character encodings is a really hard problem.
32 </para>
33 <para>
34 Setting aside the i18n problems, where no general guideline can be given, there
35 is actually no central infrastructure for l10n within Debian which could be
36 compared to the buildd mechanism for porting.  So most of the work has to be
37 done manually.
38 </para>
39 <section id="l10n-handling">
40 <title>How translations are handled within Debian</title>
41 <para>
42 Handling translation of the texts contained in a package is still a manual
43 task, and the process depends on the kind of text you want to see translated.
44 </para>
45 <para>
46 For program messages, the gettext infrastructure is used most of the time.
47 Most of the time, the translation is handled upstream within projects like the
48 <ulink url="&url-l10n-tp;">Free Translation
49 Project</ulink>, the <ulink
50 url="&url-l10n-gnome;">Gnome translation
51 Project</ulink> or the <ulink url="&url-l10n-kde;">KDE one</ulink>.  The
52 only centralized resource within Debian is the <ulink
53 url="&url-l10n;">Central Debian translation
54 statistics</ulink>, where you can find some statistics about the translation
55 files found in the actual packages, but no real infrastructure to ease the
56 translation process.
57 </para>
58 <para>
59 An effort to translate the package descriptions started long ago, even if very
60 little support is offered by the tools to actually use them (i.e., only APT can
61 use them, when configured correctly).  Maintainers don't need to do anything
62 special to support translated package descriptions; translators should use the
63 <ulink url="&url-ddtp;">Debian Description Translation Project (DDTP)</ulink>.
64 </para>
65 <para>
66 For <systemitem role="package">debconf</systemitem> templates, maintainers
67 should use the <systemitem role="package">po-debconf</systemitem> package to ease
68 the work of translators, who could use the DDTP to do their work (but the
69 French and Brazilian teams don't).  Some statistics can be found both on the
70 <ulink url="&url-ddtp;">DDTP site</ulink> (about what is actually translated),
71 and on the <ulink url="&url-l10n;">Central Debian translation
72 statistics</ulink> site (about what is integrated in the packages).
73 </para>
74 <para>
75 For web pages, each l10n team has access to the relevant VCS, and the
76 statistics are available from the Central Debian translation statistics site.
77 </para>
78 <para>
79 For general documentation about Debian, the process is more or less the same as
80 for the web pages (the translators have access to the VCS), but there are no
81 statistics pages.
82 </para>
83 <para>
84 For package-specific documentation (man pages, info documents, other formats),
85 almost everything remains to be done.
86 </para>
87 <para>
88 Most notably, the KDE project handles translation of its documentation in the
89 same way as its program messages.
90 </para>
91 <para>
92 There is an effort to handle Debian-specific man pages within a <ulink
93 url="&url-cvsweb;manpages/?cvsroot=debian-doc">specific VCS
94 repository</ulink>.
95 </para>
96 </section>
98 <section id="l10n-faqm">
99 <title>I18N &amp; L10N FAQ for maintainers</title>
100 <para>
101 This is a list of problems that maintainers may face concerning i18n and l10n.
102 While reading this, keep in mind that there is no real consensus on these
103 points within Debian, and that this is only advice.  If you have a better idea
104 for a given problem, or if you disagree on some points, feel free to provide
105 your feedback, so that this document can be enhanced.
106 </para>
107 <section id="l10n-faqm-tr">
108 <title>How to get a given text translated</title>
109 <para>
110 To translate package descriptions or <systemitem role="package">debconf</systemitem> templates, you have nothing to do;
111 the DDTP infrastructure will dispatch the material to translate to volunteers
112 with no need for interaction from your part.
113 </para>
114 <para>
115 For all other material (gettext files, man pages, or other documentation), the
116 best solution is to put your text somewhere on the Internet, and ask on
117 debian-i18n for a translation in different languages.  Some translation team
118 members are subscribed to this list, and they will take care of the translation
119 and of the reviewing process.  Once they are done, you will get your translated
120 document from them in your mailbox.
121 </para>
122 </section>
124 <section id="l10n-faqm-rev">
125 <title>How to get a given translation reviewed</title>
126 <para>
127 From time to time, individuals translate some texts in your package and will
128 ask you for inclusion of the translation in the package.  This can become
129 problematic if you are not fluent in the given language.  It is a good idea to
130 send the document to the corresponding l10n mailing list, asking for a review.
131 Once it has been done, you should feel more confident in the quality of the
132 translation, and feel safe to include it in your package.
133 </para>
134 </section>
136 <section id="l10n-faqm-update">
137 <title>How to get a given translation updated</title>
138 <para>
139 If you have some translations of a given text lying around, each time you
140 update the original, you should ask the previous translator to update the
141 translation with your new changes.  Keep in mind that this task takes time; at
142 least one week to get the update reviewed and all.
143 </para>
144 <para>
145 If the translator is unresponsive, you may ask for help on the corresponding
146 l10n mailing list.  If everything fails, don't forget to put a warning in the
147 translated document, stating that the translation is somehow outdated, and that
148 the reader should refer to the original document if possible.
149 </para>
150 <para>
151 Avoid removing a translation completely because it is outdated.  Old
152 documentation is often better than no documentation at all for non-English
153 speakers.
154 </para>
155 </section>
157 <section id="l10n-faqm-bug">
158 <title>How to handle a bug report concerning a translation</title>
159 <para>
160 The best solution may be to mark the bug as forwarded to upstream, and forward
161 it to both the previous translator and his/her team (using the corresponding
162 debian-l10n-XXX mailing list).
163 <!-- TODO: add the i18n tag to the bug? -->
164 </para>
165 </section>
167 </section>
169 <section id="l10n-faqtr">
170 <title>I18N &amp; L10N FAQ for translators</title>
171 <para>
172 While reading this, please keep in mind that there is no general procedure
173 within Debian concerning these points, and that in any case, you should
174 collaborate with your team and the package maintainer.
175 </para>
176 <section id="l10n-faqtr-help">
177 <title>How to help the translation effort</title>
178 <para>
179 Choose what you want to translate, make sure that nobody is already working on
180 it (using your debian-l10n-XXX mailing list), translate it, get it reviewed by
181 other native speakers on your l10n mailing list, and provide it to the
182 maintainer of the package (see next point).
183 </para>
184 </section>
186 <section id="l10n-faqtr-inc">
187 <title>How to provide a translation for inclusion in a package</title>
188 <para>
189 Make sure your translation is correct (asking for review on your l10n mailing
190 list) before providing it for inclusion.  It will save time for everyone, and
191 avoid the chaos resulting in having several versions of the same document in
192 bug reports.
193 </para>
194 <para>
195 The best solution is to file a regular bug containing the translation against
196 the package.  Make sure to use the 'PATCH' tag, and to not use a severity
197 higher than 'wishlist', since the lack of translation never prevented a program
198 from running.
199 </para>
200 </section>
202 </section>
204 <section id="l10n-best">
205 <title>Best current practice concerning l10n</title>
206 <itemizedlist>
207 <listitem>
208 <para>
209 As a maintainer, never edit the translations in any way (even to reformat the
210 layout) without asking on the corresponding l10n mailing list.  You risk for
211 example breaking the encoding of the file by doing so.  Moreover, what you
212 consider an error can be right (or even needed) in the given language.
213 </para>
214 </listitem>
215 <listitem>
216 <para>
217 As a translator, if you find an error in the original text, make sure to report
218 it.  Translators are often the most attentive readers of a given text, and if
219 they don't report the errors they find, nobody will.
220 </para>
221 </listitem>
222 <listitem>
223 <para>
224 In any case, remember that the major issue with l10n is that it requires
225 several people to cooperate, and that it is very easy to start a flamewar about
226 small problems because of misunderstandings.  So if you have problems with your
227 interlocutor, ask for help on the corresponding l10n mailing list, on
228 debian-i18n, or even on debian-devel (but beware, l10n discussions very often
229 become flamewars on that list :)
230 </para>
231 </listitem>
232 <listitem>
233 <para>
234 In any case, cooperation can only be achieved with <emphasis
235 role="strong">mutual respect</emphasis>.
236 </para>
237 </listitem>
238 </itemizedlist>
239 </section>
241 </chapter>