Skip to content

Commit ccbf99e

Browse files
committed
Synchronized build
1 parent 799e4d3 commit ccbf99e

File tree

1 file changed

+84
-89
lines changed

1 file changed

+84
-89
lines changed

contributing-code/translation-guide/index.html

Lines changed: 84 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>Our Work Relies On You!</h2>
119119
<header>
120120
<h1>Translation Guide</h1>
121121
<p>Our translation files are hosted and managed on
122-
<a href="https://www.transifex.com">Transifex</a>. It is very easy to sign up for an
122+
<a href="https://www.transifex.com/">Transifex</a>. It is very easy to sign up for an
123123
account and start translation Creative Commons (CC) services into another
124124
language.</p>
125125

@@ -213,6 +213,22 @@ <h2>On this page</h2>
213213
<li>
214214
<a href="#for-translators">For translators</a>
215215

216+
<ul>
217+
218+
<li>
219+
<a href="#signing-up">
220+
Signing up
221+
</a>
222+
</li>
223+
224+
<li>
225+
<a href="#using-transifex">
226+
Using Transifex
227+
</a>
228+
</li>
229+
230+
</ul>
231+
216232
</li>
217233

218234
<li>
@@ -232,15 +248,14 @@ <h2>On this page</h2>
232248
<div class="content">
233249
<!-- disregard: vim syntax highlighting fix_ -->
234250

235-
<p>CC applications such as CC Search and the CC Chooser are used by millions of
236-
users worldwide. Translating these services into the languages our users speak
237-
and read is integral to making these services accessible to our diverse user
238-
base.</p>
251+
<p>CC applications are used by millions of users worldwide. Translating these
252+
services into the languages our users speak and read is integral to making
253+
these services accessible to our diverse user base.</p>
239254
<p>We use Transifex to manage our translation files. It provides an intuitive UI
240255
and many useful tools. Let's see how you can join us there and get started.</p>
241256
<p>TL;DR: We have a <a href="https://www.youtube.com/watch?v=Rta2AlPww8M">video version</a>
242257
of this tutorial if you prefer that as the medium of instruction.</p>
243-
<h2 id="for-translators">For translators</h2><ul>
258+
<h2 id="for-translators">For translators</h2><h3 id="signing-up">Signing up</h3><ol>
244259
<li><strong>Sign up on Transifex</strong><ul>
245260
<li>Visit the Transifex <a href="https://www.transifex.com/signup/">sign up page</a> and
246261
fill out the form to create an account.</li>
@@ -249,104 +264,93 @@ <h2 id="for-translators">For translators</h2><ul>
249264
<li>Alternatively you can link an existing account from GitHub, Google or
250265
LinkedIn to avoid having to remember another password.</li>
251266
<li>During the sign up process, you will be asked for the languages you speak.
252-
Remember to fill it as comprehensively as possible.</li>
253-
</ul>
254-
</li>
255-
</ul>
256-
<p style="text-align: center;">
267+
Remember to fill it as comprehensively as possible.
257268
<img
258269
style="max-height: 508px; border: 1px solid #ccc;"
259270
alt="Screenshot of the Transifex sign up page"
260-
src="./transifex_signup.png">
261-
</p><ul>
262-
<li><p><strong>Verify your email</strong>
263-
You will receive an email from Transifex on the email address you signed up.
264-
Clicking the link in the email will verify that you used an authentic email to
265-
sign up and enable all the features on your account.</p>
266-
</li>
267-
<li><p><strong>Visit the CC Organisation page</strong>
268-
The <a href="https://www.transifex.com/creativecommons/public/">organisation page</a>
269-
contains links to all CC projects currently in translation.</p>
271+
src="./transifex_signup.png"></li>
272+
</ul>
270273
</li>
274+
<li><strong>Verify your email</strong><ul>
275+
<li>You will receive an email from Transifex on the email address you signed
276+
up. Clicking the link in the email will verify that you used an authentic
277+
email to sign up and enable all the features on your account.</li>
271278
</ul>
272-
<p style="text-align: center;">
279+
</li>
280+
<li><strong>Visit the CC Organisation page</strong><ul>
281+
<li>The <a href="https://www.transifex.com/creativecommons/public/">organisation page</a>
282+
contains links to all CC projects currently in translation.
273283
<img
274284
style="max-height: 508px; border: 1px solid #ccc;"
275285
alt="Screenshot of the Transifex 'CC' organisation page"
276-
src="./transifex_org_page.png">
277-
</p><ul>
278-
<li><strong>Choose a project</strong>
279-
Choose any project from the list that you would like to translate. Click on
280-
the project name to go to the project page.</li>
286+
src="./transifex_org_page.png"></li>
281287
</ul>
282-
<p style="text-align: center;">
288+
</li>
289+
<li><strong>Choose a project</strong><ul>
290+
<li>Choose any project from the list that you would like to translate. Click
291+
on the project name to go to the project page.
283292
<img
284293
style="max-height: 508px; border: 1px solid #ccc;"
285294
alt="Screenshot of the Transifex 'Summit website' project page"
286-
src="./transifex_summit.png">
287-
</p><ul>
295+
src="./transifex_summit.png"></li>
296+
</ul>
297+
</li>
288298
<li><strong>Join the team</strong><ul>
289-
<li>You can see a list of languages that each project has been translated into.
290-
Not all languages are visible. Click on the 'Display all languages' button
291-
to see them all.</li>
299+
<li>You can see a list of languages that each project has been translated
300+
into. Not all languages are visible. Click on the 'Display all languages'
301+
button to see them all.</li>
292302
<li>If your language isn't present in the list, you can request for it by
293-
clicking the 'Request language' button. You will have to go to the previous
294-
step and find a different project till your language request is approved.</li>
303+
clicking the 'Request language' button. You will have to go to the
304+
previous step and find a different project till your language request is
305+
approved.</li>
295306
<li>If your language is present, click on the 'Join team' button to join the
296307
team that's translating this project.</li>
297308
<li>In the modal choose your language and click the 'Join' button. You'll
298309
receive a notification that a request has been submitted.</li>
299310
<li>Notify the <code># Translation</code> channel on <a href="/community/#zulip">Zulip</a></li>
300-
<li>Wait for an administrator to add you to the team.</li>
301-
</ul>
302-
</li>
303-
</ul>
304-
<p style="text-align: center;">
311+
<li>Wait for an administrator to add you to the team.
305312
<img
306313
style="border: 1px solid #ccc;"
307314
alt="Screenshot of the Transifex 'Join project' modal"
308-
src="./transifex_modal.png">
309-
</p><ul>
315+
src="./transifex_modal.png"></li>
316+
</ul>
317+
</li>
318+
</ol>
319+
<h3 id="using-transifex">Using Transifex</h3><ul>
310320
<li><strong>Getting around</strong><ul>
311321
<li>You'll receive an email when your request has been accepted.</li>
312322
<li>When you log back in to Transifex, you'll see some changes in the UI.<ul>
313323
<li>You'll have Creative Commons mentioned in the organisation dropdown.</li>
314324
<li>You'll see CC projects in the left sidebar.</li>
315325
</ul>
316326
</li>
317-
<li>Click on the project of your choice from the sidebar.</li>
318-
</ul>
319-
</li>
320-
</ul>
321-
<p style="text-align: center;">
327+
<li>Click on the project of your choice from the sidebar.
322328
<img
323329
style="max-height: 508px; border: 1px solid #ccc;"
324330
alt="Screenshot of the Transifex 'Summit website' member view"
325-
src="./transifex_member_view.png">
326-
</p><ul>
331+
src="./transifex_member_view.png"></li>
332+
</ul>
333+
</li>
327334
<li><strong>Translate the strings</strong><ul>
328335
<li>Find your language from the list of languages. Hovering over the name will
329336
reveal a 'View resource' button.</li>
330337
<li>Click on the 'View resource' button. That should take you to the page of
331338
that particular language. It contains the resources that you need to
332339
translate.</li>
333-
<li>Clicking on the resource opens a modal describing the words and strings that
334-
remain to be translated. Here onwards you have three paths for translating
335-
the site.<ul>
340+
<li>Clicking on the resource opens a modal describing the words and strings
341+
that remain to be translated. Here onwards you have three paths for
342+
translating the site.<ul>
336343
<li>Transifex editor UI, by clicking the 'Translate' button</li>
337344
<li>Transifex live UI, by clicking the 'Live' button</li>
338-
<li>Local string translation, by clicking the download and upload buttons</li>
345+
<li>Local string translation, by clicking the download and upload buttons
346+
<img
347+
style="border: 1px solid #ccc;"
348+
alt="Screenshot of the Transifex resource modal"
349+
src="./transifex_resource_modal.png"></li>
339350
</ul>
340351
</li>
341352
</ul>
342353
</li>
343-
</ul>
344-
<p style="text-align: center;">
345-
<img
346-
style="border: 1px solid #ccc;"
347-
alt="Screenshot of the Transifex resource modal"
348-
src="./transifex_resource_modal.png">
349-
</p><ul>
350354
<li><strong>Method 1: Translating using the Transifex editor UI</strong><ul>
351355
<li>To do this, click on the 'Translate' button from the resource modal. You
352356
will be taken to a list of all the strings from the website.</li>
@@ -358,16 +362,13 @@ <h2 id="for-translators">For translators</h2><ul>
358362
the source text to copy them over in the translated text. You can also drag
359363
to move them around as needed.</li>
360364
<li>Keep these instructions in mind: <a href="https://wiki.creativecommons.org/wiki/Translating_CC_Deeds#General_Notes_About_Translating">General Notes About Translating -
361-
Translating CC Deeds - CC Public Wiki</a></li>
362-
</ul>
363-
</li>
364-
</ul>
365-
<p style="text-align: center;">
365+
Translating CC Deeds - CC Public Wiki</a>
366366
<img
367367
style="max-height: 508px; border: 1px solid #ccc;"
368368
alt="Screenshot of the Transifex editor UI"
369-
src="transifex_editor_ui.png">
370-
</p><ul>
369+
src="transifex_editor_ui.png"></li>
370+
</ul>
371+
</li>
371372
<li><strong>Method 2: Translating using the Transifex live UI</strong><ul>
372373
<li>To do this, click on the 'Live' button from the resource modal. You will be
373374
taken to the website rendered in the Transifex page and you can edit the
@@ -377,16 +378,13 @@ <h2 id="for-translators">For translators</h2><ul>
377378
<li>All the text is green boxes can be translated. Click on the pencil icon
378379
that appears when you move your mouse over the green boxes.</li>
379380
<li>Enter your translated string in the lower box and press the 'Save' button
380-
to confirm the translation.</li>
381-
</ul>
382-
</li>
383-
</ul>
384-
<p style="text-align: center;">
381+
to confirm the translation.
385382
<img
386383
style="max-height: 508px; border: 1px solid #ccc;"
387384
alt="Screenshot of the Transifex live UI"
388-
src="transifex_live_ui.png">
389-
</p><ul>
385+
src="transifex_live_ui.png"></li>
386+
</ul>
387+
</li>
390388
<li><strong>Method 3: Translating strings locally</strong><ul>
391389
<li>To do this, you can download the JSON file that maps English strings to
392390
their counterparts in your language by clicking the 'Download file to
@@ -400,40 +398,37 @@ <h2 id="for-translators">For translators</h2><ul>
400398
<li>Upload the translated JSON file using the 'Upload file' button.</li>
401399
</ul>
402400
</li>
401+
<li>Your translations will go live as soon as they are approved by the admins.</li>
403402
</ul>
404-
<p>Your translations will go live as soon as they are approved by the admins.</p>
405403
<h2 id="for-admins">For admins</h2><ul>
406404
<li><strong>Approve team join requests</strong><ul>
407405
<li>Click on the person's name to see their profile. That could help in
408406
determining the credibility of the candidate.</li>
409407
<li>Click the 'Accept' button if you want to add the collaborator to the team.
410-
You'll receive a notification confirming the acceptance of the translator.</li>
411-
</ul>
412-
</li>
413-
</ul>
414-
<p style="text-align: center;">
408+
You'll receive a notification confirming the acceptance of the translator.
415409
<img
416410
style="max-height: 503px; border: 1px solid #ccc;"
417411
alt="Screenshot of the Transifex 'Join requests' page"
418-
src="./transifex_join_request.png">
419-
</p><ul>
412+
src="./transifex_join_request.png"></li>
413+
</ul>
414+
</li>
420415
<li><strong>Review translations</strong><ul>
421416
<li>Navigate to the resource as described for translators in the 'Translate the
422417
strings' section.</li>
423418
<li>In the resource modal that appears, click on the 'View strings online'
424419
button. You will be taken to the strings page.</li>
425420
<li>Click on the 'Unreviewed' tab. Approve or decline the translation as
426-
applicable.</li>
427-
</ul>
428-
</li>
429-
</ul>
430-
<p style="text-align: center;">
421+
applicable.
431422
<img
432423
style="max-height: 503px; border: 1px solid #ccc;"
433424
alt="Screenshot of the Transifex 'Unreviewed translations' page"
434-
src="./transifex_review_translation.png">
435-
</p><h2 id="additional-resources">Additional resources</h2><ul>
425+
src="./transifex_review_translation.png"></li>
426+
</ul>
427+
</li>
428+
</ul>
429+
<h2 id="additional-resources">Additional resources</h2><ul>
436430
<li><a href="https://wiki.creativecommons.org/wiki/Translate">Translate - CC Public Wiki</a></li>
431+
<li><a href="https://help.transifex.com/">Transifex Help Center</a></li>
437432
</ul>
438433

439434
</div>

0 commit comments

Comments
 (0)