Skip to content

Commit

Permalink
Merge pull request #773 from creativecommons/cc-translation
Browse files Browse the repository at this point in the history
update translation information
  • Loading branch information
TimidRobot authored Apr 3, 2024
2 parents 66af9c4 + 7a1d18c commit 4271783
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 68 deletions.
1 change: 1 addition & 0 deletions content/community/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The channels most relevant to CC's developer community are:
| `#cc-dev-wordpress` | [wp-plugin-creativecommons][wp-plugin-creativecommons] project (creativecommons WordPress plugin) |
| `#cc-dev-workprograms` | **GSoC, GSoD, Outreachy, and other [work programs][workprograms] or internships** |
| `#cc-developers` | **general technical issues, new tech blog posts, etc.** |
| `#cc-translation` | Coordinating translation efforts |
| `#cc-usability` | general usability issues, seeking feedback on new releases of CC products from the community, etc. |

[legaldb]: https://github.com/creativecommons/legaldb
Expand Down
150 changes: 82 additions & 68 deletions content/contributing-code/translation-guide/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ and many useful tools. Let's see how you can join us there and get started.
TL;DR: We have a [video version](https://www.youtube.com/watch?v=Rta2AlPww8M)
of this tutorial if you prefer that as the medium of instruction.


## For translators

* **Sign up on Transifex**
* Visit the Transifex [sign up page](https://www.transifex.com/signup/) and
- **Sign up on Transifex**
- Visit the Transifex [sign up page](https://www.transifex.com/signup/) and
fill out the form to create an account.
* You can create a new account using your email address, a username and a
- You can create a new account using your email address, a username and a
password.
* Alternatively you can link an existing account from GitHub, Google or
- Alternatively you can link an existing account from GitHub, Google or
LinkedIn to avoid having to remember another password.
* During the sign up process, you will be asked for the languages you speak.
- During the sign up process, you will be asked for the languages you speak.
Remember to fill it as comprehensively as possible.

<p style="text-align: center;">
Expand All @@ -38,12 +39,12 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_signup.png">
</p>

* **Verify your email**
- **Verify your email**
You will receive an email from Transifex on the email address you signed up.
Clicking the link in the email will verify that you used an authentic email to
sign up and enable all the features on your account.

* **Visit the CC Organisation page**
- **Visit the CC Organisation page**
The [organisation page](https://www.transifex.com/creativecommons/public/)
contains links to all CC projects currently in translation.

Expand All @@ -54,7 +55,7 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_org_page.png">
</p>

* **Choose a project**
- **Choose a project**
Choose any project from the list that you would like to translate. Click on
the project name to go to the project page.

Expand All @@ -65,18 +66,21 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_summit.png">
</p>

* **Join the team**
* You can see a list of languages that each project has been translated into.
- **Join the team**
- You can see a list of languages that each project has been translated into.
Not all languages are visible. Click on the 'Display all languages' button
to see them all.
* If your language isn't present in the list, you can request for it by
- If your language isn't present in the list, you can request for it by
clicking the 'Request language' button. You will have to go to the previous
step and find a different project till your language request is approved.
* If your language is present, click on the 'Join team' button to join the
- If your language is present, click on the 'Join team' button to join the
team that's translating this project.
* In the modal choose your language and click the 'Join' button. You'll
receive a notification that a request has been submitted. Wait for an
administrator to add you to the team.
- In the modal choose your language and click the 'Join' button. You'll
receive a notification that a request has been submitted.
- Notify the `cc-translation` channel on Slack
- See [Join the CC Developer Community — Creative Commons Open
Source](/community/) for instructions on joining Slack
- Wait for an administrator to add you to the team.

<p style="text-align: center;">
<img
Expand All @@ -85,12 +89,12 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_modal.png">
</p>

* **Getting around**
* You'll receive an email when your request has been accepted.
* When you log back in to Transifex, you'll see some changes in the UI.
* You'll have Creative Commons mentioned in the organisation dropdown.
* You'll see CC projects in the left sidebar.
* Click on the project of your choice from the sidebar.
- **Getting around**
- You'll receive an email when your request has been accepted.
- When you log back in to Transifex, you'll see some changes in the UI.
- You'll have Creative Commons mentioned in the organisation dropdown.
- You'll see CC projects in the left sidebar.
- Click on the project of your choice from the sidebar.

<p style="text-align: center;">
<img
Expand All @@ -99,13 +103,13 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_member_view.png">
</p>

* **Translate the strings**
* Find your language from the list of languages. Hovering over the name will
- **Translate the strings**
- Find your language from the list of languages. Hovering over the name will
reveal a 'View resource' button.
* Click on the 'View resource' button. That should take you to the page of
- Click on the 'View resource' button. That should take you to the page of
that particular language. It contains the resources that you need to
translate.
* Clicking on the resource opens a modal describing the words and strings that
- Clicking on the resource opens a modal describing the words and strings that
remain to be translated. Here onwards you have three paths for translating
the site.
- Transifex editor UI, by clicking the 'Translate' button
Expand All @@ -119,18 +123,20 @@ of this tutorial if you prefer that as the medium of instruction.
src="./transifex_resource_modal.png">
</p>

* * **Method 1: Translating using the Transifex editor UI**
* To do this, click on the 'Translate' button from the resource modal. You
will be taken to a list of all the strings from the website.
* Switch the language to your target language using the menu bar on the
upper side of the screen.
* Click on any string, enter the translation in the lower box and click
the 'Save Translation' button to commit the change.
* Some text has HTML tags in it. In those cases you can click on the tags in
the source text to copy them over in the translated text. You can also
drag to move them around as needed.
* Keep [these instructions](https://wiki.creativecommons.org/wiki/Translating_CC_Deeds#General_Notes_About_Translating)
in mind.
- **Method 1: Translating using the Transifex editor UI**
- To do this, click on the 'Translate' button from the resource modal. You
will be taken to a list of all the strings from the website.
- Switch the language to your target language using the menu bar on the upper
side of the screen.
- Click on any string, enter the translation in the lower box and click the
'Save Translation' button to commit the change.
- Some text has HTML tags in it. In those cases you can click on the tags in
the source text to copy them over in the translated text. You can also drag
to move them around as needed.
- Keep these instructions in mind: [General Notes About Translating -
Translating CC Deeds - CC Public Wiki][wiki-translate-notes]

[wiki-translate-notes]: https://wiki.creativecommons.org/wiki/Translating_CC_Deeds#General_Notes_About_Translating

<p style="text-align: center;">
<img
Expand All @@ -139,16 +145,16 @@ of this tutorial if you prefer that as the medium of instruction.
src="transifex_editor_ui.png">
</p>

* * **Method 2: Translating using the Transifex live UI**
* To do this, click on the 'Live' button from the resource modal. You will
be taken to the website rendered in the Transifex page and you can edit
the text directly.
* Switch the language to your target language using the sidebar on the right
side of the screen.
* All the text is green boxes can be translated. Click on the pencil icon
that appears when you move your mouse over the green boxes.
* Enter your translated string in the lower box and press the 'Save' button
to confirm the translation.
- **Method 2: Translating using the Transifex live UI**
- To do this, click on the 'Live' button from the resource modal. You will be
taken to the website rendered in the Transifex page and you can edit the
text directly.
- Switch the language to your target language using the sidebar on the right
side of the screen.
- All the text is green boxes can be translated. Click on the pencil icon
that appears when you move your mouse over the green boxes.
- Enter your translated string in the lower box and press the 'Save' button
to confirm the translation.

<p style="text-align: center;">
<img
Expand All @@ -157,28 +163,29 @@ of this tutorial if you prefer that as the medium of instruction.
src="transifex_live_ui.png">
</p>

* * **Method 3: Translating strings locally**
* To do this, you can download the JSON file that maps English strings to
their counterparts in your language by clicking the 'Download file to
translate' button.
* For the untranslated strings, both key and value will be the same.
```json
{ "Hello, World!": "Hello, World!" }
```
* Change the JSON values to the translated text.
```json
{ "Hello World": "नमस्ते, दुनिया!" }
```
* Upload the translated JSON file using the 'Upload file' button.
- **Method 3: Translating strings locally**
- To do this, you can download the JSON file that maps English strings to
their counterparts in your language by clicking the 'Download file to
translate' button.
- For the untranslated strings, both key and value will be the same.
```json
{ "Hello, World!": "Hello, World!" }
```
- Change the JSON values to the translated text.
```json
{ "Hello World": "नमस्ते, दुनिया!" }
```
- Upload the translated JSON file using the 'Upload file' button.

Your translations will go live as soon as they are approved by the admins.


## For admins

* **Approve team join requests**
* Click on the person's name to see their profile. That could help in
- **Approve team join requests**
- Click on the person's name to see their profile. That could help in
determining the credibility of the candidate.
* Click the 'Accept' button if you want to add the collaborator to the team.
- Click the 'Accept' button if you want to add the collaborator to the team.
You'll receive a notification confirming the acceptance of the translator.

<p style="text-align: center;">
Expand All @@ -188,17 +195,24 @@ Your translations will go live as soon as they are approved by the admins.
src="./transifex_join_request.png">
</p>

* **Review translations**
* Navigate to the resource as described for translators in the 'Translate the
- **Review translations**
- Navigate to the resource as described for translators in the 'Translate the
strings' section.
* In the resource modal that appears, click on the 'View strings online'
- In the resource modal that appears, click on the 'View strings online'
button. You will be taken to the strings page.
* Click on the 'Unreviewed' tab. Approve or decline the translation as
- Click on the 'Unreviewed' tab. Approve or decline the translation as
applicable.

<p style="text-align: center;">
<img
style="max-height: 503px; border: 1px solid #ccc;"
alt="Screenshot of the Transifex 'Unreviewed translations' page"
src="./transifex_review_translation.png">
</p>
</p>


## Additional resources

- [Translate - CC Public Wiki][wiki-translate]

[wiki-translate]: https://wiki.creativecommons.org/wiki/Translate

0 comments on commit 4271783

Please sign in to comment.