~ubuntu-manual/ubuntu-translations-quickstart/booklet

« back to all changes in this revision

Viewing changes to ubuntu-translations-quickstart.xml

  • Committer: David Planella
  • Date: 2010-07-01 12:13:36 UTC
  • Revision ID: david.planella@ubuntu.com-20100701121336-gtpyiz0m0ya1c9yi
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
 
4
<article>
 
5
  <articleinfo>
 
6
    <title>Translations Quickstart Guide</title>
 
7
 
 
8
    <author>
 
9
      <firstname>David</firstname>
 
10
 
 
11
      <surname>Planella</surname>
 
12
 
 
13
      <affiliation>
 
14
        <orgname></orgname>
 
15
      </affiliation>
 
16
    </author>
 
17
 
 
18
    <pubdate></pubdate>
 
19
  </articleinfo>
 
20
 
 
21
  <para>Ubuntu is translated by a large community of volunteers that every day
 
22
  contribute to make the Operating System more accessible to millions of users
 
23
  in their own language.</para>
 
24
 
 
25
  <para>Ubuntu is Free Software, which means that you can also participate. Do
 
26
  you know languages? Come and join the Ubuntu Translators and make it
 
27
  possible to use Ubuntu in your own.</para>
 
28
 
 
29
  <para>Here you'll find a quick introduction that will help you getting
 
30
  started and guide you in your first stept to contributing to Ubuntu
 
31
  Translations in just a few minutes.</para>
 
32
 
 
33
  <section>
 
34
    <title>What You'll Need</title>
 
35
 
 
36
    <para>One of the key values in Ubuntu is the low entry barrier for
 
37
    contribution, so that participating in improving Ubuntu is both easy and
 
38
    fun. Therefore you won't need much to start translating from day one: no
 
39
    need to install special tools and no previous technical knowledge. You'll
 
40
    be using <ulink url="https://launchpad.net/">Launchpad</ulink>, an easy to
 
41
    use yet powerful online translation tool.</para>
 
42
 
 
43
    <para>Here are the minimum requirements to start translating
 
44
    Ubuntu:</para>
 
45
 
 
46
    <para><itemizedlist>
 
47
        <listitem>
 
48
          <para><emphasis role="strong">Internet</emphasis>: a device with
 
49
          Internet connection. This can be from home, an Internet cafe, a
 
50
          public access point... - basically anywhere you can use the Internet
 
51
          from.</para>
 
52
        </listitem>
 
53
 
 
54
        <listitem>
 
55
          <para><emphasis>E-mail</emphasis>: a stable e-mail address that
 
56
          Launchpad can use to contact you</para>
 
57
        </listitem>
 
58
 
 
59
        <listitem>
 
60
          <para><emphasis>Language knowledge</emphasis>: knowledge of English
 
61
          and the language you are going to translate. English will always be
 
62
          the source language.</para>
 
63
        </listitem>
 
64
 
 
65
        <listitem>
 
66
          <para><emphasis>Spare time</emphasis>: some time to dedicate to the
 
67
          translation of Free Software. You decide how much you want to get
 
68
          involved - from some spare minutes to some hours a week </para>
 
69
        </listitem>
 
70
 
 
71
        <listitem>
 
72
          <para><emphasis>Be collaborative</emphasis>: be keen to work
 
73
          collaboratively and be part of the awesome Ubuntu translation
 
74
          teams!</para>
 
75
        </listitem>
 
76
      </itemizedlist></para>
 
77
  </section>
 
78
 
 
79
  <section>
 
80
    <title>First Steps</title>
 
81
 
 
82
    <para>Before you can start translating, you'll need to set up Launchpad
 
83
    and tell it which language or languages you are interested in translating.
 
84
    This will take just a few minutes and you'll only need to do it once.
 
85
    </para>
 
86
 
 
87
    <section>
 
88
      <title>Creating a Launchpad Account</title>
 
89
 
 
90
      <para>The first thing you'll need is a Launchpad account. This will
 
91
      allow you to translate Ubuntu online using an intuitive web interface,
 
92
      and will also give you access to all of the free tools from the
 
93
      Launchpad software collaboration platform.<itemizedlist>
 
94
          <listitem>
 
95
            <para>To create a new account, simply go to the <ulink
 
96
            url="https://launchpad.net/+login">account sign-up page</ulink>,
 
97
            click on the <guibutton>Create a new account</guibutton> link and
 
98
            follow the instructions.</para>
 
99
          </listitem>
 
100
        </itemizedlist></para>
 
101
 
 
102
      <para><mediaobject>
 
103
          <imageobject>
 
104
            <imagedata fileref="img/1-new-account.png" scale="80" />
 
105
          </imageobject>
 
106
        </mediaobject><note>
 
107
          <para>For more information about how to personalize your account,
 
108
          check out the <ulink
 
109
          url="https://help.launchpad.net/YourAccount/NewAccount">Launchpad
 
110
          help</ulink></para>
 
111
        </note></para>
 
112
    </section>
 
113
 
 
114
    <section>
 
115
      <title>Telling Launchpad About Your Preferred Languages</title>
 
116
 
 
117
      <para>Once you've set up your account, you'll only need to log in and
 
118
      tell Launchpad which languages you're interested to translate into.
 
119
      </para>
 
120
 
 
121
      <para><itemizedlist>
 
122
          <listitem>
 
123
            <para>To set your preferred languages in Launchpad, go to the
 
124
            <ulink url="???">Launchpad Translations page</ulink> and click on
 
125
            the <guibutton>Change your preferred languages</guibutton> link.
 
126
            Once you've done that, you'll be ready to start
 
127
            translating.</para>
 
128
          </listitem>
 
129
        </itemizedlist></para>
 
130
 
 
131
      <para><mediaobject>
 
132
          <imageobject>
 
133
            <imagedata fileref="img/3-edit-my-languages.png" scale="80" />
 
134
          </imageobject>
 
135
        </mediaobject></para>
 
136
    </section>
 
137
  </section>
 
138
 
 
139
  <section>
 
140
    <title>Starting to Translate</title>
 
141
 
 
142
    <para>At this point you've got a Launchpad account and you're all set and
 
143
    hopefully eager to start translating. What we need to do now is to find
 
144
    the Ubuntu applications we want to translate, get familiar with the
 
145
    interface and submit the first translation suggestions. </para>
 
146
 
 
147
    <para>We'll start by going to the main <ulink
 
148
    url="https://translations.launchpad.net/">Launchpad Translations</ulink>
 
149
    page. There you'll see that Launchpad allows you to translate two
 
150
    categories of software: <guilabel>Operating Systems</guilabel> and
 
151
    <guilabel>Projects</guilabel>.</para>
 
152
 
 
153
    <para>We're interested in translating Ubuntu as a collection of integrated
 
154
    applications, so we'll go to the <guilabel>Operating Systems
 
155
    </guilabel>category and we'll click on the latest
 
156
    <guilabel>Ubuntu</guilabel> version.<mediaobject>
 
157
        <imageobject>
 
158
          <imagedata fileref="img/4-translate-ubuntu.png" scale="80" />
 
159
        </imageobject>
 
160
      </mediaobject>The next step is to choose the language to translate into.
 
161
    You should only initially see the language or languages chosen as
 
162
    preferred. On that page you can also see some translation
 
163
    statistics.</para>
 
164
 
 
165
    <para>Click on the link to your language to proceed to the translatable
 
166
    applications.</para>
 
167
 
 
168
    <para><mediaobject>
 
169
        <imageobject>
 
170
          <imagedata fileref="img/5-translate-language.png" scale="80" />
 
171
        </imageobject>
 
172
      </mediaobject>On the next step the full list of translatable
 
173
    applications for Ubuntu is shown. These applications are often named
 
174
    <emphasis>templates</emphasis> using the translation jargon, and are the
 
175
    translatable units which you can work on to localize Ubuntu in your
 
176
    language.</para>
 
177
 
 
178
    <para>You can browse through the list of templates to explore and get
 
179
    familiar with them. Do not get overwhelmed by how many of them there are:
 
180
    you'll find that taking things step to step and working in a translation
 
181
    community, completing translations is easier than it seems.</para>
 
182
 
 
183
    <para>There are several statistics on that page, most of which are self
 
184
    explanatory. The most important for now are the green colour in the graph,
 
185
    which means translated messages in the template, and red, which means
 
186
    untranslated (or need review, more on that later).</para>
 
187
 
 
188
    <para>As a new translator you should concentrate on completing the
 
189
    <guilabel>Untranslated</guilabel> messages (or
 
190
    <emphasis>strings</emphasis> in translation jargon). Navigate to a
 
191
    template with untranslated strings and click on the link with the
 
192
    number.</para>
 
193
 
 
194
    <para><tip>
 
195
        <para>If you already know the Ubuntu application you'd like to
 
196
        translate, you can use a quicker way to go to its translation page.
 
197
        Try this: start the application and then go to <menuchoice>
 
198
            <guimenu>Help</guimenu>
 
199
 
 
200
            <guimenuitem>Translate this application...</guimenuitem>
 
201
          </menuchoice>, which will open a browser for you and take you
 
202
        directly to the translation</para>
 
203
      </tip></para>
 
204
 
 
205
    <para><mediaobject>
 
206
        <imageobject>
 
207
          <imagedata fileref="img/6-translate-untranslated.png" scale="80" />
 
208
        </imageobject>
 
209
      </mediaobject></para>
 
210
 
 
211
    <para>Now you are finally at the step where you can submit your first
 
212
    translation suggestion. The translatable messages look like the one below:
 
213
    they are pairs consisting of original messages in English and translations
 
214
    in your language. In the web UI, <guilabel>English</guilabel> is the
 
215
    original to translate from, <guilabel>Current</guilabel> is the currently
 
216
    used translation, and <guilabel>New suggestion</guilabel> is where you can
 
217
    submit your translation.</para>
 
218
 
 
219
    <para>Try this: find a message you think you can translate and enter your
 
220
    translation in the text box. Once you've done that, scroll down to the
 
221
    bottom of the page and click on the <guibutton>Save</guibutton>
 
222
    button.</para>
 
223
 
 
224
    <para>You've now submitted your first translation suggestion.
 
225
    Congratulations!</para>
 
226
 
 
227
    <para>You'll find that the interface is very intuitive and
 
228
    self-explanatory, so try to get a bit more familiar with it before
 
229
    submitting more suggestions.</para>
 
230
 
 
231
    <para><mediaobject>
 
232
        <imageobject>
 
233
          <imagedata fileref="img/7-translate.png" scale="80" />
 
234
        </imageobject>
 
235
      </mediaobject>Once you are comfortable with the basic functionality, you
 
236
    might want to explore other aspects:</para>
 
237
 
 
238
    <para><itemizedlist>
 
239
        <listitem>
 
240
          <para><emphasis>Guidelines</emphasis>: at the top of a translation
 
241
          page there are often guidelines on the conventions for translating
 
242
          your language or on how the team responsible for translations works,
 
243
          accepts new members, etc. Do check them: they will make the
 
244
          translation process easier and will help you resolving doubts and
 
245
          getting in touch with other translators if you want to.</para>
 
246
        </listitem>
 
247
 
 
248
        <listitem>
 
249
          <para><emphasis>Navigation</emphasis>: the
 
250
          <guilabel>First</guilabel>/<guilabel>Last</guilabel> and
 
251
          <guilabel>Previous</guilabel>/<guilabel>Next</guilabel> in the user
 
252
          interface will allow you to navigate through the messages in a
 
253
          template.</para>
 
254
        </listitem>
 
255
 
 
256
        <listitem>
 
257
          <para><emphasis>Saving</emphasis>: remember to save your work by
 
258
          pressing on the <guibutton>Save</guibutton> button at the bottom of
 
259
          the page. Only then your suggestions will be recorded</para>
 
260
        </listitem>
 
261
 
 
262
        <listitem>
 
263
          <para><emphasis>Filters</emphasis>: there are filters which allow
 
264
          you to view only a subset of the messages for easier navigation. Try
 
265
          using the drop-down box next to the <guilabel>Translating</guilabel>
 
266
          label. For now, you'll find the <guimenuitem>untranslated
 
267
          items</guimenuitem> and <guimenuitem>items with new
 
268
          suggestions</guimenuitem> the most useful</para>
 
269
        </listitem>
 
270
 
 
271
        <listitem>
 
272
          <para><emphasis>Search</emphasis>: you can use the
 
273
          <guilabel>Search</guilabel> box to look for a string in a template.
 
274
          It is powerful and easy to use: it returns results for the searched
 
275
          strings both in the original and translated messages</para>
 
276
        </listitem>
 
277
      </itemizedlist>What you've just been doing now is to submit
 
278
    <emphasis>translation suggestions</emphasis>. These translations will not
 
279
    be used in Ubuntu until they have been first reviewed by another
 
280
    translator, which is where Ubuntu <emphasis>translation teams</emphasis>
 
281
    come in. You can learn more about them in the next section</para>
 
282
  </section>
 
283
 
 
284
  <section>
 
285
    <title>Joining a Translation Team</title>
 
286
 
 
287
    <para>Translating Ubuntu is a rewarding experience: it allows you to bring
 
288
    a localized system in your language to potentially millions of people.
 
289
    This also carries a degree of responsibility: we want to provide the best
 
290
    applications with the best translations around, which is why we put an
 
291
    emphasis on their quality.</para>
 
292
 
 
293
    <para>Everyone with a Launchpad account can submit translation
 
294
    suggestions. While this is great for collaboration and for lowering the
 
295
    barrier to contribution, it is necessary to have some kind of peer
 
296
    reviewing mechanism to make sure these suggestions are correct and that
 
297
    the final user will understand them when using Ubuntu.</para>
 
298
 
 
299
    <para>The role of translation teams is to have a set of members who are
 
300
    experienced translators review these suggestions, accept them if
 
301
    appropriate and come back to the submitter for feedback. They also take
 
302
    care of helping new translators get their bearings on their journey to
 
303
    becoming full-fledged Ubuntu translators.</para>
 
304
 
 
305
    <para>Even if you don't want to join a translation team, it is always
 
306
    recommended to get in touch with them when you've finished submitting some
 
307
    suggestions, so that they are aware of them and they can review
 
308
    them.</para>
 
309
 
 
310
    <para>It's very easy to get in touch with them: on every translation page
 
311
    there is a link to the team. You can scroll down to the bottom of the page
 
312
    and click on the link after the <guilabel>This translation is managed
 
313
    by</guilabel> label, which will take you to the team's home page in
 
314
    Launchpad, containing info on how to contact them.</para>
 
315
 
 
316
    <para><mediaobject>
 
317
        <imageobject>
 
318
          <imagedata fileref="img/8-translation-team.png" scale="80" />
 
319
        </imageobject>
 
320
      </mediaobject><note>
 
321
        <para>If there is no <ulink
 
322
        url="https://translations.launchpad.net/+groups/ubuntu-translators">Ubuntu
 
323
        translation team</ulink> for your language, you can <ulink
 
324
        url="https://wiki.ubuntu.com/Translations/KnowledgeBase/StartingTeam">create
 
325
        one</ulink></para>
 
326
      </note></para>
 
327
  </section>
 
328
 
 
329
  <section>
 
330
    <title>There's More</title>
 
331
 
 
332
    <para>This guide covers only the basic aspects of getting started
 
333
    translating Ubuntu. If you are interested in learning more, you can find
 
334
    much more information here:</para>
 
335
 
 
336
    <para><itemizedlist>
 
337
        <listitem>
 
338
          <para><ulink url="https://wiki.ubuntu.com/Translations/">Ubuntu
 
339
          Translations Wiki</ulink></para>
 
340
        </listitem>
 
341
 
 
342
        <listitem>
 
343
          <para><ulink
 
344
          url="https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators">Ubuntu
 
345
          Translators Mailing List</ulink></para>
 
346
        </listitem>
 
347
 
 
348
        <listitem>
 
349
          <para><ulink url="https://help.launchpad.net/Translations">Launchpad
 
350
          Translations Help</ulink></para>
 
351
        </listitem>
 
352
      </itemizedlist></para>
 
353
  </section>
 
354
</article>