Skip to content

Commit d62fff5

Browse files
TimidRobotTimidRobot
authored
Merge pull request #966 from creativecommons/trans-guide
Improve/fix formatting of Translation Guide
2 parents 9af905f + dba67a1 commit d62fff5

File tree

1 file changed

+88
-122
lines changed

1 file changed

+88
-122
lines changed

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

Lines changed: 88 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@ _template: page-with-toc.html
55
title: Translation Guide
66
---
77
description: Our translation files are hosted and managed on
8-
[Transifex](https://www.transifex.com). It is very easy to sign up for an
8+
[Transifex](https://www.transifex.com/). It is very easy to sign up for an
99
account and start translation Creative Commons (CC) services into another
1010
language.
1111
---
1212
body: <!-- disregard: vim syntax highlighting fix_ -->
1313

14-
CC applications such as CC Search and the CC Chooser are used by millions of
15-
users worldwide. Translating these services into the languages our users speak
16-
and read is integral to making these services accessible to our diverse user
17-
base.
14+
CC applications are used by millions of users worldwide. Translating these
15+
services into the languages our users speak and read is integral to making
16+
these services accessible to our diverse user base.
1817

1918
We use Transifex to manage our translation files. It provides an intuitive UI
2019
and many useful tools. Let's see how you can join us there and get started.
@@ -25,105 +24,86 @@ of this tutorial if you prefer that as the medium of instruction.
2524

2625
## For translators
2726

28-
- **Sign up on Transifex**
29-
- Visit the Transifex [sign up page](https://www.transifex.com/signup/) and
30-
fill out the form to create an account.
31-
- You can create a new account using your email address, a username and a
32-
password.
33-
- Alternatively you can link an existing account from GitHub, Google or
34-
LinkedIn to avoid having to remember another password.
35-
- During the sign up process, you will be asked for the languages you speak.
36-
Remember to fill it as comprehensively as possible.
37-
38-
<p style="text-align: center;">
39-
<img
40-
style="max-height: 508px; border: 1px solid #ccc;"
41-
alt="Screenshot of the Transifex sign up page"
42-
src="./transifex_signup.png">
43-
</p>
44-
45-
- **Verify your email**
46-
You will receive an email from Transifex on the email address you signed up.
47-
Clicking the link in the email will verify that you used an authentic email to
48-
sign up and enable all the features on your account.
49-
50-
- **Visit the CC Organisation page**
51-
The [organisation page](https://www.transifex.com/creativecommons/public/)
52-
contains links to all CC projects currently in translation.
53-
54-
<p style="text-align: center;">
55-
<img
56-
style="max-height: 508px; border: 1px solid #ccc;"
57-
alt="Screenshot of the Transifex 'CC' organisation page"
58-
src="./transifex_org_page.png">
59-
</p>
60-
61-
- **Choose a project**
62-
Choose any project from the list that you would like to translate. Click on
63-
the project name to go to the project page.
64-
65-
<p style="text-align: center;">
66-
<img
67-
style="max-height: 508px; border: 1px solid #ccc;"
68-
alt="Screenshot of the Transifex 'Summit website' project page"
69-
src="./transifex_summit.png">
70-
</p>
71-
72-
- **Join the team**
73-
- You can see a list of languages that each project has been translated into.
74-
Not all languages are visible. Click on the 'Display all languages' button
75-
to see them all.
76-
- If your language isn't present in the list, you can request for it by
77-
clicking the 'Request language' button. You will have to go to the previous
78-
step and find a different project till your language request is approved.
79-
- If your language is present, click on the 'Join team' button to join the
80-
team that's translating this project.
81-
- In the modal choose your language and click the 'Join' button. You'll
82-
receive a notification that a request has been submitted.
83-
- Notify the `# Translation` channel on [Zulip](/community/#zulip)
84-
- Wait for an administrator to add you to the team.
85-
86-
<p style="text-align: center;">
87-
<img
88-
style="border: 1px solid #ccc;"
89-
alt="Screenshot of the Transifex 'Join project' modal"
90-
src="./transifex_modal.png">
91-
</p>
27+
### Signing up
28+
29+
1. **Sign up on Transifex**
30+
- Visit the Transifex [sign up page](https://www.transifex.com/signup/) and
31+
fill out the form to create an account.
32+
- You can create a new account using your email address, a username and a
33+
password.
34+
- Alternatively you can link an existing account from GitHub, Google or
35+
LinkedIn to avoid having to remember another password.
36+
- During the sign up process, you will be asked for the languages you speak.
37+
Remember to fill it as comprehensively as possible.
38+
<img
39+
style="max-height: 508px; border: 1px solid #ccc;"
40+
alt="Screenshot of the Transifex sign up page"
41+
src="./transifex_signup.png">
42+
2. **Verify your email**
43+
- You will receive an email from Transifex on the email address you signed
44+
up. Clicking the link in the email will verify that you used an authentic
45+
email to sign up and enable all the features on your account.
46+
3. **Visit the CC Organisation page**
47+
- The [organisation page](https://www.transifex.com/creativecommons/public/)
48+
contains links to all CC projects currently in translation.
49+
<img
50+
style="max-height: 508px; border: 1px solid #ccc;"
51+
alt="Screenshot of the Transifex 'CC' organisation page"
52+
src="./transifex_org_page.png">
53+
4. **Choose a project**
54+
- Choose any project from the list that you would like to translate. Click
55+
on the project name to go to the project page.
56+
<img
57+
style="max-height: 508px; border: 1px solid #ccc;"
58+
alt="Screenshot of the Transifex 'Summit website' project page"
59+
src="./transifex_summit.png">
60+
5. **Join the team**
61+
- You can see a list of languages that each project has been translated
62+
into. Not all languages are visible. Click on the 'Display all languages'
63+
button to see them all.
64+
- If your language isn't present in the list, you can request for it by
65+
clicking the 'Request language' button. You will have to go to the
66+
previous step and find a different project till your language request is
67+
approved.
68+
- If your language is present, click on the 'Join team' button to join the
69+
team that's translating this project.
70+
- In the modal choose your language and click the 'Join' button. You'll
71+
receive a notification that a request has been submitted.
72+
- Notify the `# Translation` channel on [Zulip](/community/#zulip)
73+
- Wait for an administrator to add you to the team.
74+
<img
75+
style="border: 1px solid #ccc;"
76+
alt="Screenshot of the Transifex 'Join project' modal"
77+
src="./transifex_modal.png">
78+
79+
### Using Transifex
9280

9381
- **Getting around**
9482
- You'll receive an email when your request has been accepted.
9583
- When you log back in to Transifex, you'll see some changes in the UI.
9684
- You'll have Creative Commons mentioned in the organisation dropdown.
9785
- You'll see CC projects in the left sidebar.
9886
- Click on the project of your choice from the sidebar.
99-
100-
<p style="text-align: center;">
101-
<img
102-
style="max-height: 508px; border: 1px solid #ccc;"
103-
alt="Screenshot of the Transifex 'Summit website' member view"
104-
src="./transifex_member_view.png">
105-
</p>
106-
87+
<img
88+
style="max-height: 508px; border: 1px solid #ccc;"
89+
alt="Screenshot of the Transifex 'Summit website' member view"
90+
src="./transifex_member_view.png">
10791
- **Translate the strings**
10892
- Find your language from the list of languages. Hovering over the name will
10993
reveal a 'View resource' button.
11094
- Click on the 'View resource' button. That should take you to the page of
11195
that particular language. It contains the resources that you need to
11296
translate.
113-
- Clicking on the resource opens a modal describing the words and strings that
114-
remain to be translated. Here onwards you have three paths for translating
115-
the site.
97+
- Clicking on the resource opens a modal describing the words and strings
98+
that remain to be translated. Here onwards you have three paths for
99+
translating the site.
116100
- Transifex editor UI, by clicking the 'Translate' button
117101
- Transifex live UI, by clicking the 'Live' button
118102
- Local string translation, by clicking the download and upload buttons
119-
120-
<p style="text-align: center;">
121-
<img
122-
style="border: 1px solid #ccc;"
123-
alt="Screenshot of the Transifex resource modal"
124-
src="./transifex_resource_modal.png">
125-
</p>
126-
103+
<img
104+
style="border: 1px solid #ccc;"
105+
alt="Screenshot of the Transifex resource modal"
106+
src="./transifex_resource_modal.png">
127107
- **Method 1: Translating using the Transifex editor UI**
128108
- To do this, click on the 'Translate' button from the resource modal. You
129109
will be taken to a list of all the strings from the website.
@@ -136,16 +116,10 @@ of this tutorial if you prefer that as the medium of instruction.
136116
to move them around as needed.
137117
- Keep these instructions in mind: [General Notes About Translating -
138118
Translating CC Deeds - CC Public Wiki][wiki-translate-notes]
139-
140-
[wiki-translate-notes]: https://wiki.creativecommons.org/wiki/Translating_CC_Deeds#General_Notes_About_Translating
141-
142-
<p style="text-align: center;">
143-
<img
144-
style="max-height: 508px; border: 1px solid #ccc;"
145-
alt="Screenshot of the Transifex editor UI"
146-
src="transifex_editor_ui.png">
147-
</p>
148-
119+
<img
120+
style="max-height: 508px; border: 1px solid #ccc;"
121+
alt="Screenshot of the Transifex editor UI"
122+
src="transifex_editor_ui.png">
149123
- **Method 2: Translating using the Transifex live UI**
150124
- To do this, click on the 'Live' button from the resource modal. You will be
151125
taken to the website rendered in the Transifex page and you can edit the
@@ -156,14 +130,10 @@ of this tutorial if you prefer that as the medium of instruction.
156130
that appears when you move your mouse over the green boxes.
157131
- Enter your translated string in the lower box and press the 'Save' button
158132
to confirm the translation.
159-
160-
<p style="text-align: center;">
161-
<img
162-
style="max-height: 508px; border: 1px solid #ccc;"
163-
alt="Screenshot of the Transifex live UI"
164-
src="transifex_live_ui.png">
165-
</p>
166-
133+
<img
134+
style="max-height: 508px; border: 1px solid #ccc;"
135+
alt="Screenshot of the Transifex live UI"
136+
src="transifex_live_ui.png">
167137
- **Method 3: Translating strings locally**
168138
- To do this, you can download the JSON file that maps English strings to
169139
their counterparts in your language by clicking the 'Download file to
@@ -177,8 +147,9 @@ of this tutorial if you prefer that as the medium of instruction.
177147
{ "Hello World": "नमस्ते, दुनिया!" }
178148
```
179149
- Upload the translated JSON file using the 'Upload file' button.
150+
- Your translations will go live as soon as they are approved by the admins.
180151

181-
Your translations will go live as soon as they are approved by the admins.
152+
[wiki-translate-notes]: https://wiki.creativecommons.org/wiki/Translating_CC_Deeds#General_Notes_About_Translating
182153

183154

184155
## For admins
@@ -188,32 +159,27 @@ Your translations will go live as soon as they are approved by the admins.
188159
determining the credibility of the candidate.
189160
- Click the 'Accept' button if you want to add the collaborator to the team.
190161
You'll receive a notification confirming the acceptance of the translator.
191-
192-
<p style="text-align: center;">
193-
<img
194-
style="max-height: 503px; border: 1px solid #ccc;"
195-
alt="Screenshot of the Transifex 'Join requests' page"
196-
src="./transifex_join_request.png">
197-
</p>
198-
162+
<img
163+
style="max-height: 503px; border: 1px solid #ccc;"
164+
alt="Screenshot of the Transifex 'Join requests' page"
165+
src="./transifex_join_request.png">
199166
- **Review translations**
200167
- Navigate to the resource as described for translators in the 'Translate the
201168
strings' section.
202169
- In the resource modal that appears, click on the 'View strings online'
203170
button. You will be taken to the strings page.
204171
- Click on the 'Unreviewed' tab. Approve or decline the translation as
205172
applicable.
206-
207-
<p style="text-align: center;">
208-
<img
209-
style="max-height: 503px; border: 1px solid #ccc;"
210-
alt="Screenshot of the Transifex 'Unreviewed translations' page"
211-
src="./transifex_review_translation.png">
212-
</p>
173+
<img
174+
style="max-height: 503px; border: 1px solid #ccc;"
175+
alt="Screenshot of the Transifex 'Unreviewed translations' page"
176+
src="./transifex_review_translation.png">
213177

214178

215179
## Additional resources
216180

217181
- [Translate - CC Public Wiki][wiki-translate]
182+
- [Transifex Help Center][transifex-help]
218183

219184
[wiki-translate]: https://wiki.creativecommons.org/wiki/Translate
185+
[transifex-help]: https://help.transifex.com/

0 commit comments

Comments
 (0)