Skip to content

Commit 589ef47

Browse files
committed
Document the Transifex usage guide with plenty of images
1 parent bd851d3 commit 589ef47

11 files changed

+189
-0
lines changed

content/contributing-code/translation-guide/contents.lr

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,192 @@ description: Our translation files are hosted and managed on [Transifex](https:/
88
---
99
body:
1010

11+
CC applications such as CC Search and the CC License Chooser are used by
12+
millions of users worldwide. Translating these services into the languages our
13+
users speak and read is integral to making these services accessible to our
14+
diverse user base.
15+
16+
We use Transifex to manage our translation files. It provides an intuitive UI
17+
and many useful tools. Let's see how you can join us there and get started.
18+
19+
## For translators
20+
21+
* **Sign up on Transifex**
22+
* Visit the Transifex [sign up page](https://www.transifex.com/signup/) and
23+
fill out the form to create an account.
24+
* You can create a new account using your email address, a username and a
25+
password.
26+
* Alternatively you can link an existing account from GitHub, Google or
27+
LinkedIn to avoid having to remember another password.
28+
* During the sign up process, you will be asked for the languages you speak.
29+
Remember to fill it as comprehensively as possible.
30+
31+
<p style="text-align: center;">
32+
<img
33+
style="max-height: 508px; border: 1px solid #ccc;"
34+
alt="Screenshot of the Transifex sign up page"
35+
src="./transifex_signup.png">
36+
</p>
37+
38+
* **Verify your email**
39+
You will receive an email from Transifex on the email address you signed up.
40+
Clicking the link in the email will verify that you used an authentic email to
41+
sign up and enable all the features on your account.
42+
43+
* **Visit the CC Organisation page**
44+
The [organisation page](https://www.transifex.com/creativecommons/public/)
45+
contains links to all CC projects currently in translation.
46+
47+
<p style="text-align: center;">
48+
<img
49+
style="max-height: 508px; border: 1px solid #ccc;"
50+
alt="Screenshot of the Transifex 'CC' organisation page"
51+
src="./transifex_org_page.png">
52+
</p>
53+
54+
* **Choose a project**
55+
Choose any project from the list that you would like to translate. Click on
56+
the project name to go to the project page.
57+
58+
<p style="text-align: center;">
59+
<img
60+
style="max-height: 508px; border: 1px solid #ccc;"
61+
alt="Screenshot of the Transifex 'Summit website' project page"
62+
src="./transifex_summit.png">
63+
</p>
64+
65+
* **Join the team**
66+
* You can see a list of languages that each project has been translated into.
67+
Not all languages are visible. Click on the 'Display all languages' button
68+
to see them all.
69+
* If your language isn't present in the list, you can request for it by
70+
clicking the 'Request language' button. You will have to go to the previous
71+
step and find a different project till your language request is approved.
72+
* If your language is present, click on the 'Join team' button to join the
73+
team that's translating this project.
74+
* In the modal choose your language and click the 'Join' button. You'll
75+
receive a notification that a request has been submitted. Wait for an
76+
administrator to add you to the team.
77+
78+
<p style="text-align: center;">
79+
<img
80+
style="border: 1px solid #ccc;"
81+
alt="Screenshot of the Transifex 'Join project' modal"
82+
src="./transifex_modal.png">
83+
</p>
84+
85+
* **Getting around**
86+
* You'll receive an email when your request has been accepted.
87+
* When you log back in to Transifex, you'll see some changes in the UI.
88+
* You'll have Creative Commons mentioned in the organisation dropdown.
89+
* You'll see CC projects in the left sidebar.
90+
* Click on the project of your choice from the sidebar.
91+
92+
<p style="text-align: center;">
93+
<img
94+
style="max-height: 508px; border: 1px solid #ccc;"
95+
alt="Screenshot of the Transifex 'Summit website' member view"
96+
src="./transifex_member_view.png">
97+
</p>
98+
99+
* **Translate the strings**
100+
* Find your language from the list of languages. Hovering over the name will
101+
reveal a 'View resource' button.
102+
* Click on the 'View resource' button. That should take you to the page of
103+
that particular language. It contains the resources that you need to
104+
translate.
105+
* Clicking on the resource opens a modal describing the words and strings that
106+
remain to be translated. Here onwards you have three paths for translating
107+
the site.
108+
- Transifex editor UI, by clicking the 'Translate' button
109+
- Transifex live UI, by clicking the 'Live' button
110+
- Local string translation, by clicking the download and upload buttons
111+
112+
<p style="text-align: center;">
113+
<img
114+
style="border: 1px solid #ccc;"
115+
alt="Screenshot of the Transifex resource modal"
116+
src="./transifex_resource_modal.png">
117+
</p>
118+
119+
* * **Method 1: Translating using the Transifex editor UI**
120+
* To do this, click on the 'Translate' button from the resource modal. You
121+
will be taken to a list of all the strings from the website.
122+
* Switch the language to your target language using the menu bar on the
123+
upper side of the screen.
124+
* Click on any string, enter the translation in the lower box and click
125+
the 'Save Translation' button to commit the change.
126+
* Some text has HTML tags in it. In those cases you can click on the tags in
127+
the source text to copy them over in the translated text. You can also
128+
drag to move them around as needed.
129+
130+
<p style="text-align: center;">
131+
<img
132+
style="max-height: 508px; border: 1px solid #ccc;"
133+
alt="Screenshot of the Transifex editor UI"
134+
src="transifex_editor_ui.png">
135+
</p>
136+
137+
* * **Method 2: Translating using the Transifex live UI**
138+
* To do this, click on the 'Live' button from the resource modal. You will
139+
be taken to the website rendered in the Transifex page and you can edit
140+
the text directly.
141+
* Switch the language to your target language using the sidebar on the right
142+
side of the screen.
143+
* All the text is green boxes can be translated. Click on the pencil icon
144+
that appears when you move your mouse over the green boxes.
145+
* Enter your translated string in the lower box and press the 'Save' button
146+
to confirm the translation.
147+
148+
<p style="text-align: center;">
149+
<img
150+
style="max-height: 508px; border: 1px solid #ccc;"
151+
alt="Screenshot of the Transifex live UI"
152+
src="transifex_live_ui.png">
153+
</p>
154+
155+
* * **Method 3: Translating strings locally**
156+
* To do this, you can download the JSON file that maps English strings to
157+
their counterparts in your language by clicking the 'Download file to
158+
translate' button.
159+
* For the untranslated strings, both key and value will be the same.
160+
```json
161+
{ "Hello, World!": "Hello, World!" }
162+
```
163+
* Change the JSON values to the translated text.
164+
```json
165+
{ "Hello World": "नमस्ते, दुनिया!" }
166+
```
167+
* Upload the translated JSON file using the 'Upload file' button.
168+
169+
Your translations will go live as soon as they are approved by the admins.
170+
171+
## For admins
172+
173+
* **Approve team join requests**
174+
* Click on the person's name to see their profile. That could help in
175+
determining the credibility of the candidate.
176+
* Click the 'Accept' button if you want to add the collaborator to the team.
177+
You'll receive a notification confirming the acceptance of the translator.
178+
179+
<p style="text-align: center;">
180+
<img
181+
style="max-height: 503px; border: 1px solid #ccc;"
182+
alt="Screenshot of the Transifex 'Join requests' page"
183+
src="./transifex_join_request.png">
184+
</p>
185+
186+
* **Review translations**
187+
* Navigate to the resource as described for translators in the 'Translate the
188+
strings' section.
189+
* In the resource modal that appears, click on the 'View strings online'
190+
button. You will be taken to the strings page.
191+
* Click on the 'Unreviewed' tab. Approve or decline the translation as
192+
applicable.
193+
194+
<p style="text-align: center;">
195+
<img
196+
style="max-height: 503px; border: 1px solid #ccc;"
197+
alt="Screenshot of the Transifex 'Unreviewed translations' page"
198+
src="./transifex_review_translation.png">
199+
</p>
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)