From Fedora Project Wiki
Line 107: Line 107:
  
 
Once Ivy installed, click the zanata-cli file.  
 
Once Ivy installed, click the zanata-cli file.  
 +
 
[[File:zanata.cli.png]]
 
[[File:zanata.cli.png]]
  
Line 130: Line 131:
  
 
From your Zanata account, go to your dashboard and click “Settings”.
 
From your Zanata account, go to your dashboard and click “Settings”.
 +
 +
 +
[[File:Dashboard-settings.png]]
 +
  
 
Then select Client  
 
Then select Client  
 +
 +
 +
[[File:Client.png]]
 +
  
 
If you do not have one, generate an API key.
 
If you do not have one, generate an API key.
Line 143: Line 152:
  
 
Fedora Installation Guide -  f20 - select your locale - on the upper right corner, click the arrow and select “Download config file”  
 
Fedora Installation Guide -  f20 - select your locale - on the upper right corner, click the arrow and select “Download config file”  
 +
 +
 +
[[File:Download config file.png]]
 +
  
 
Save the zanata.xml file in your preferred location.
 
Save the zanata.xml file in your preferred location.
Line 180: Line 193:
  
 
To download the entire project, click on the arrow located in the top right corner of the page (next to  
 
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) ».  
+
"sort") and click "Download All (zip)".  
 +
 
 +
 
 +
[[File:Projet entier.png]]
 +
 
 +
 
 +
 
 +
To download one file only, click on the arrow located on the left of the filename, and select "Download Translated [.po]."
  
To download one file only, click on the arrow located on the left of the filename, and select “Download Translated [.po]. ”
+
[[File:Download translated.png]]
  
 
Save the file to your preferred location.  
 
Save the file to your preferred location.  

Revision as of 00:58, 2 February 2015

Fedora Localization Guide on Zanata(Draft)

Introduction

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:

  1. Create a Fedora account
  2. Subscribe to the mailing lists
  3. Introduce Yourself(It's a good idea to do it on all mailing list you have subscribed)
  4. Login to Zanata with your FAS account
  5. 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

  1. Open https://admin.fedoraproject.org/accounts and click the New Account link.
  2. Fill in each required parts and click Sign up. A password will be emailed to you, and you can change it later.
  3. Now visit https://admin.fedoraproject.org/accounts again and log in with your password.
  4. 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.

  1. Visit https://admin.fedoraproject.org/accounts and login your account using your user name and password obtained from the previous process.
  2. In the Welcome page, click complete the CLA or go to https://admin.fedoraproject.org/accounts/user/edit.
  3. 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.
  4. Now click Save! located at the bottom of this page to save your information.
  5. The user-view page is appeared and shows the CLA: field as CLA Done.
Note.png
Note
Telephone Number and Postal Address information is NOT accessible by others except admin groups. Please refer to Fedora Privacy Policy at https://fedoraproject.org/wiki/Legal:PrivacyPolicy. Other fields will be displayed by any other member by visiting the user's view page.
Idea.png
More about FAS
You can visit https://fedoraproject.org/wiki/Account_System for more details about Fedora account system.

Subscribe to the Mailing Lists

Main L10n mailing list

Note.png
Note
Use English on this mailing list
  1. Visit trans mailing list subscribe page and subscribe it.
  2. 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

Note.png
Note
Use your mother language is better on this mailing list
  1. Visit https://fedoraproject.org/wiki/L10N/Teams and find your language team(s)
  2. Subscribe the mailing list(s) for your language(s)
Important.png
Mailing list guidelines
You are recommended to read this guidelines before you post messages to a mailing list.

Introduce Yourself

  1. Create a personal page at https://fedoraproject.org/wiki/User:Username.
  2. 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

Zanata login.png

  • 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.

Fedoauth.png

  • Then you will be directed to a authentication page, click 'Approve'.

Fas approve.png

  • 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(username@fedoraproject.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

Zanata Languages.png

  • 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.

Zanata join team.png

  • 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.

Zanata join.png

  • 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

Translating online on Zanata

Translating offline

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.

Zanata.cli.png

Copy and paste the content of the executable file into you 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.

Two steps:

2.1.1. Creation of an API key


From your Zanata account, go to your dashboard and click “Settings”.


Dashboard-settings.png


Then select Client


Client.png


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”


Download config file.png


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.

Run:

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)".


Projet entier.png


To download one file only, click on the arrow located on the left of the filename, and select "Download Translated [.po]."

Download translated.png

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”.

Proofreading

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.

Zanata validation options.png

In this example, ending tag

</command>

is written as

</comd>

, 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.

Zanata proofreading error.png

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.

Translation Proofreading

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.

Testing

Credits