Fedora Localization Guide on Zanata(Draft)
This page describes some basic steps on how to join Fedora Project L10n team, how to begin translation on new L10n platform - Zanata, as well as some simple sugestions on translation proofreading and test.
How to become a Fedora translator
L10n is not just about translation, but if you want to contribute on L10n, then start from a translator is a good choice. You need to follow the steps below to complete:
- Create a Fedora account
- Subscribe to the mailing lists
- Introduce Yourself(It's a good idea to do it on all mailing list you have subscribed)
- Login to Zanata with your FAS account
- Find your language team and join in
Your self-introduction is important. It raises your chances to be approved for write access. You may also want to create a Bugzilla account to work on bugs reported by users.
Create a Fedora account
- Open https://admin.fedoraproject.org/accounts and click the New Account link.
- Fill in each required parts and click Sign up. A password will be emailed to you, and you can change it later.
- Now visit https://admin.fedoraproject.org/accounts again and log in with your password.
- The account system will remind you that CLA is not completed.
Signing the CLA
To begin translation, you must complete the Contributors License Agreement, or CLA.
- Visit https://admin.fedoraproject.org/accounts and login your account using your user name and password obtained from the previous process.
- In the Welcome page, click complete the CLA or go to https://admin.fedoraproject.org/accounts/user/edit.
- If the information of telephone number and postal address have not been provided yet, the Edit Account (user_name) page will be appeared and you need to fill in each of them. Otherwise Fedora Contributor License Agreement page will be displayed. Read through the agreement carefully and click I agree if you are happy to do so.
- Now click Save! located at the bottom of this page to save your information.
- The user-view page is appeared and shows the CLA: field as CLA Done.
Subscribe to the Mailing Lists
Main L10n mailing list
- Visit trans mailing list subscribe page and subscribe it.
- You won't be able to send message to the list until you are approved by the admin of the mailing list. You will receive a confirmation email which contains a link to confirm your subscription. Click the link to confirm your subscription.
Your team mailing list
- Visit https://fedoraproject.org/wiki/L10N/Teams and find your language team(s)
- Subscribe the mailing list(s) for your language(s)
- Create a personal page at https://fedoraproject.org/wiki/User:Username.
- Make a short self-introduction to the mailing lists you have subscribed. If you don't know what to introduce, here is a template: https://fedoraproject.org/wiki/L10N_Self_introduction.
The above two steps are very useful for Fedora contributors get to know and contact each other. The second step also helps your language coordinator to identify you and approve you as a translator of the team.
Login to Zanata with your FAS account
- Open https://fedora.zanata.org/ and click the blue 'Log In' button on the top-right of the page.
- Then it will guides you to FedOAuth page in which you can Login with your FAS account and password you have registered in last section.
- Then you will be directed to a authentication page, click 'Approve'.
- A 'new user' page will be opened.
You should enter your full name, username(FAS username) and your email address. Note: Please use your true email address but not your Fedora project alias(firstname.lastname@example.org). When you finish them, click the Save button. A activation email will be sent immediately to your email address. Please find the mail in your inbox and open the activation link that is provided in the mail. Then login with your FAS username and password. You won't need to follow this step again when you login next time. It's only necessary for new user login.
Find your language team and join in
- Click Languages at the top of https://fedora.zanata.org, then you will see all the available languages.
- Find the language you want to translate and click the language code.
- Click the blue button Request To Join Team on the left side of the page.
- You should choose the role(s) you want to be and click Send Message. Additional message is optional. Here I use Afrikaans as example in screenshot below.
- The team coordinator will receive a email notification about your request. You will be the team member as long as he/she approves your request. However, the coordinator may not approve each of your role request. In other words, if you request to be Translator, Reviewer and Coordinator, he/she may only approve you as a translator.
Translating online on Zanata
Finding your project
There are three ways of finding your translation files on Zanata:
Option 1 : Project search
If you know the title of your translation project, you can look for it thanks to the project search box,
then select the appropriate project to see the available versions for translation.
Option 2 : Projects Page
Click on the “Projects” link located at the top of the page to access all projects on the Projects page. The table of projects can be sorted by name, creation date or current activity status by clicking the arrows in the table headings. Click the name of a project to see the available versions for translation.
Option 3 : User Dashboard
If you are a maintainer for a project or have translated part of a project, you can get to the project from the User Dashboard. For a project you have translated recently, look under “Activity” and look for the name of the project you translated. You can access a string, the document, the version or the whole project by clicking the relevant links in the message.
After finding and selecting your project, the following editor will open:
2. String details Allows you to view the details of a specific source text, including comments.
3. Filtering The strings can be filtered by state: Incomplete, Complete and Invalid (containing a warning or error). For example, to display all Untranslated (empty), Fuzzy (draft) and Rejected strings, check the Incomplete box. To display only a specific type of Incomplete strings, check the corresponding box, e.g. Fuzzy.
4. Copy message from source language. This function is useful when the source text contains a lot of tags, numbers or product names that will remain the same in the target language.
5. Profile icon Click on this icon to log out or access your dashboard. The left part of the dashboard displays the number of words/messages/documents translated for the current day/week/month. The right part of the dashboard displays two tabs: - Activity, i.e when and in which file you translated last - Settings, from where you can access your user information.
6. Document list To go back to the list of documents for this project
7. Editor This button allows you to revert to the editor from any other page you are in, e.g. from the Project-wide Search & Replace page.
8. Project-wide Search & Replace Use this option to search and replace specific terms or phrases throughout the whole file. To do so: Enter a term in the search box, set the search filter “search target”, and check the “Case sensitive” case if applicable. In the second text box, enter the term you would like to use instead. Then either check “Select all” or select the string(s) you would like to apply this change to and click “Replace” to apply your changes.
9. Available Keyboard Shortcuts From the text editor page, click this button to view a list of all the shortcuts available.
10. Notification Click on this button to view the latest notifications, including the date, row number, id number of each modified string.
11. Chat room Use this function to interact with other translators
12. Options This function allows you to modify a few options in order to customize your translating experience. For example, check the “Enter key saves immediately” box to use the Enter key to save strings.
13. Validation options
14. Save as translated Saving can either be done by clicking on this icon, clicking inside another string or by pressing Ctrl + Enter or the Enter key only (if the box “Enter key saves immediately” is checked in the Editor options (see 10.))
15. Save as fuzzy You can use this button to set the current string as draft and indicate it needs further work.
16. Cancel Use this button if you wish to cancel your changes.
17. History This button takes you to a Translation History page allowing you to: - leave a comment - view the history of the translation for this specific string, including modification dates and user names - compare different versions (simply click on “Compare” for the two strings you wish to compare and click on the “Compare vers. X and X” tab to view the comparison. Screenshots
18. Translation memory The Translation Memory (TM) is a tool that searches for translations that are equal (100%) or similar (<100%) to the currently selected source string. Matches can be copied to the translation text box and used as-is or modified before saving. To copy TM matches to the selected text box, click the “Copy” button (19), or use Ctrl+Alt+1 to Ctrl+Alt+4 keyboard shortcuts to copy the first to fourth match in the list. You can also search the TM for other phrases by entering them in the TM text box and clicking “Search”.
19. Glossary If a glossary has been uploaded for your language, each word in the currently selected row will be searched for a glossary entry.
There are two methods that allow you to translate offline:
Method 1: Zanata-cli
1. Installing zanata-cli
Go to http://zanata.org/help/
Under “Cli” - Select “Installing the client ”
You can install the client in two ways:
- install from yum if you are using Fedora by running the following command:
sudo yum install zanata-client
- or install with Ivy:
Click on the “Zanata Ivy Client on github” link
Run the appropriate command depending on the system you use (Fedora, RHEL or other systems)
Once Ivy installed, click the zanata-cli file.
Copy and paste the content of the executable file into your text editor and save as “zanata-cli”.
2. Configuring the client
Configuring the client requires two actions:
2.1 Configuring the user:
Start by creating or opening zanata.ini in ~/.config/ with your preferred text editor.
2.1.1. Creation of an API key
From your Zanata account, go to your dashboard and click “Settings”.
Then select Client
If you do not have one, generate an API key.
2.1.2. Copy the contents of the text-box labeled “Configuration [zanata.ini]” into your previously created zanata.ini file and save the file.
2.2 Configuring the project:
To add project-version configuration to your project directory, navigate to your translation project in Zanata, for example:
Fedora Installation Guide - f20 - select your locale - on the upper right corner, click the arrow and select “Download config file”
Save the zanata.xml file in your preferred location.
3. Downloading the files to your machine
Before running the following command in your command-line, make sure you are in the directory containing the zanata.xml file.
zanata-cli pull -s src -t trans -l <language code> --pull-type both
The source and translated files will be created into src (source) and trans (translated) files in your directory.
You can now open your files with your preferred translation editor and translate your project.
4. Uploading the files to Zanata
To push the translated files back to Zanata, run the following command:
zanata-cli push -s src -t trans -l <language code> --push-type trans
Your translation has now been pushed back to Zanata and the TM has been updated with your changes.
Method 2: Through the User Interface
Login to https://translate.zanata.org/
Search for your project, for example the Fedora Installation Guide.
Select your language
To download the entire project, click on the arrow located in the top right corner of the page (next to "sort") and click "Download All (zip)".
To download one file only, click on the arrow located on the left of the filename, and select "Download Translated [.po]."
Save the file to your preferred location.
Translate the file.
Once finished, upload the file(s) back to Zanata, selecting “Upload translation”.
Note: Although it is possible to download a whole project, the upload is only possible file by file, by clicking the arrow located on the left of the filename, and selecting “Upload translation”.
It is very difficult for translators to find a typo or minor mistake within numbers of translated strings. So proofreading is very important. General speaking, proofreading only refers to the translated strings. However PO file plays a big role through L10n and i18n workflows. So translators should keep the PO file validate during translation process, so other translators and maintainers can use them without any problem.
PO File Validation
Online translation editor provided by Zanata has a validation feature to check each string. If you prefer translating online, this feature will help you much. The Validation options locates at the right side of the online editor. It provides several validation options for checking.
In this example, ending tag
is written as
, the editor raises warnings, suggests that there exists unexpected tag. When you find warnings like this during online translation, you'd better double check your translation.
If you prefer translating offline, you should always check your file's validity before you submit. The basic command to do this is:
msgfmt -cvo /dev/null po_file_to_check.po
Make sure that there is no error message.
Validation tool is only useful to check the validities of tags, variables or something that is related to coding language. You can't expect it to check your real translated strings.
For example, I mistakenly translated English word "He" to Chinese "它"(The right one is "他"), the validation tool will not warning you that there exists mistake. It's your job and responsbility to make the translation without mistake.
Read the strings you have translated is a good habit for proofreading.