Difference between revisions of "Translating with Pootle"

From Creative Commons
Jump to: navigation, search
(How to handle ${} strings)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Developer]]
+
Creative Commons uses the online tool [http://translate.sourceforge.net/wiki/pootle/index Pootle] at [http://translate.creativecommons.org/ translate.creativecommons.org] to manage translations of our software projects. (To translate pages on this wiki, see [[CC Wiki:Translate]].)
[[Category:Opensource]]
 
[[Category:I18n]]
 
 
 
  {{Translations|
 
    articles=Id:Translating with Pootle
 
  }}
 
 
 
 
 
Creative Commons uses the online tool [http://translate.sourceforge.net/wiki/pootle/index Pootle] to manage translations of our software projects. NOTE: To translate pages on this wiki, see [[CcWiki:Translate]].
 
 
 
The Creative Commons installation of Pootle is maintained at http://translate.creativecommons.org.  This page describes how to use Pootle to edit translations, make suggestions, and see what the changes look like.
 
  
 
Applications currently managed by '''translate.creativecommons.org''' are:
 
Applications currently managed by '''translate.creativecommons.org''' are:
Line 19: Line 8:
 
* [[CcHost|ccHost]]
 
* [[CcHost|ccHost]]
  
= Video tutorials =
+
= Tutorials =
  
There are three video tutorials available:
+
There are three Pootle tutorials you can watch and read:
  
* Tutorial 1: [http://www.archive.org/details/TranslatingWithPootle Setting up your account]
+
# [[Translating with Pootle/Setting up your account|Setting up your account]]
* Tutorial 2: [http://www.archive.org/details/TranslatingWithPootle Making translations and suggestions with Pootle]
+
# [[Translating with Pootle/Making translations and suggestions|Making translations and suggestions]]
* Tutorial 3: [http://www.archive.org/details/TranslatingWithPootle Admins: Managing suggestions and previewing at staging.creativecommons.org]
+
# [[Translating with Pootle/Admins: managing suggestions and previewing|Managing suggestions and previewing at staging]]
  
Be sure to select the one you want to watch.
+
= Other information =
 
 
= Setting up your account =
 
 
 
The next two subsections explain how to properly register with Pootle. If you already have an account that lets you translate or make suggestions, skip to section 2, "Making translations and suggestions." (In this document, we italicize things to look for, like ''button names'' or the words ''used in a link'', and we mark '''page names''' in bold.)
 
 
 
== Creating an account ==
 
 
 
Before you can contribute translations or suggestions, you need to create an account.  Go to http://translate.creativecommons.org and click the ''Log in'' link in the upper right-hand corner.  Enter your desired username and password and click ''Register''. This will take you to the full registration page, which will ask you for your password again, your full name, and your email address.  Click ''Register'' once more, and Pootle will send an activation code to the email address you specified.  Follow the link to the activation page, and copy your activation code into the ''Activation Code'' box. Click ''Activate Account'', and your account is now activated.
 
 
 
Now you can log in by clicking the ''Log in'' button in the upper-right corner.
 
 
 
== Your user page ==
 
 
 
Every time you log in, you will be taken to your user page:
 
 
 
[[Image:Pootle_user_page.png|frame|A clean user page in Pootle.]]
 
 
 
If you would like to translate a particular language or project, you need to let us know by choosing it in your user preferences. You must do this before we can grant you permissions to save and commit your work.
 
 
 
To do that, look in the Quick Links column on the left side of your "My Account" page. Because you have nothing specified yet, Pootle tells you to  ''choose your languages and projects''. This takes you to the same place a the ''Change options'' link. This takes you to the '''Options page'''.
 
 
 
[[Image:Pootle_options_page.png|frame|A blank user options page in Pootle.]]
 
 
 
There are three sections to this page, each with their own separate ''Save changes'' buttons. This is a little counter-intuitive.
 
 
 
The ''Personal Details'' section lets you change information related to how you log in to Pootle. If you make any changes, be sure to hit ''Save changes'' and ensure they appear again after the page reloads.
 
 
 
The ''Translation Interface Configuration'' section is worth a look. We urge you to configure an ''alternative source language''. Pootle generally shows you the English text when doing translations; the language you choose here as an alternative source will appear underneath the English. This can be very useful if you are, for example, localizing Spanish into Colombian Spanish, or if you are fluent in two languages. Again, if you make changes, be sure to ''Save changes''.
 
 
 
The ''Projects and languages configuration'' section is crucial.
 
 
 
Select all the ''projects'' you are interested in. (You can choose more than one by pressing and holding Ctrl on the keyboard and clicking on many, or by just dragging the mouse over the ones you want to select.) We suggest choosing all of our projects. Do the same to select the ''languages'' you wish to translate. '''Note''' that we cannot grant you special privileges on a language until you have selected it here.
 
 
 
(Languages currently need to be assigned to projects by server administrators.  If you are interested in translating a project into a new language, or adding a completely new language, email the project you're interested in and the language to webmaster@creativecommons.org.)
 
  
= Making translations and suggestions =
 
 
This section covers the steps needed to make basic use of the Pootle translation service once you have registered.
 
 
== Starting from the front page: Choosing what to translate ==
 
 
Be sure that you are logged in when you start translating.
 
 
When you load the Pootle front page, you will see a list of available projects and languages.
 
 
[[Image:Project_list.png|frame|Project list displayed after logging into Pootle.]]
 
 
Every table on the front page has a neat feature: Click on a column, and the table will be sorted by that column. For example, after one click on "Overall completion" in the projects table, we see:
 
 
[[Image:Sorted_projects_list.png|frame|Projects list sorted by overall completion]]
 
 
One more click would reverse the order of the sort.
 
 
You can approach the task of translating either by starting with the languages you want to translate into, or by starting with the project you wish to translate.
 
 
=== The project page ===
 
 
We'll start by clicking on the ''cc_org'' project. Pootle presents us with the list of available languages for the project.
 
 
[[Image:Project_lang_list.png|frame|List of available languages for the cc_org project.]]
 
 
Click on the language you would like to work on translating. If you do not see the language you want to work on listed, see the instructions below on adding a new language.
 
 
=== Permissions ===
 
 
Note that by default, all you can do is make suggestions. If you want to be able to contribute translations without having someone else approve them, or if you want the ability to grant those privileges to tohers, please email us at webmaster@creativecommons.org.
 
 
=== The message catalogs page ===
 
 
When you click on the language you'll be shown a list of message catalogs (.po files) for the selected project.  (Most projects have a single message catalog; [[CcPublisher|ccPublisher]] has two; in that project, each is listed, along with links for translating them.)
 
 
[[Image:Project_language_details.png|frame|Translation details and links for the project language.]]
 
 
=== The translation screen ===
 
 
If you want to edit or view all strings, you can simply click on the .po file you wish to edit. If you wish to view only the untranslated strings, click the link showing how many words are not yet translated. For this demonstration, we will review the untranslated strings.
 
 
[[Image:Quick_translate.png|frame|Quick translating untranslated strings.]]
 
 
You can double-click any entry to quickly modify it (but note that your alternative source language will not appear). An untranslated string will be marked with ''Add translation''. Once you have written a translation, you can ''Submit'' it (or ''suggest'' if you do not have translate privileges). The standard editing interface is always available from the ''Edit'' link on the right-hand side.
 
 
= Language administrator tasks =
 
 
There are a few things that only administrators of the language can do: accepting suggestions as translations, and committing translations to see how they look at staging.creativecommons.org.
 
 
== Accepting suggestions ==
 
 
Handling suggestions in Pootle is very easy. If on in the '''translation screen''' you see a message reading, ''View Suggestions'', you can click it to show the suggestions that have been made as well as the name of the user who made the suggestion.
 
 
[[Image:Pootle_view_suggestions_dropped_down.png|frame|The ''View Suggestions'' option available next to a message.]]
 
 
If you want to act on those suggestions, click the ''Edit'' link at the end of the row. This will bring you to the full edit screen with that message selected.
 
 
[[Image:Pootle_edit_screen_with_suggestion.png|frame|The edit screen with a suggestion visible.]]
 
 
You can click on the green check-mark or the red X; they will accept or reject the suggestion respectively. If you want to accept a modified version of the suggestion, you can click the green check-mark to accept the suggestion and then edit it in the translation field. Be sure to hit ''submit'' afterwards.
 
 
== Creative Commons' "Staging" website ==
 
 
We run an experimental clone of the Creative Commons website at http://staging.creativecommons.org/. The ''cc_org'' translation catalog is made available in near-real-time in two places.
 
 
* The staging license chooser at [http://staging.creativecommons.org/license http://creativecommons.org/license/] allows you to preview questions users see when they choose a license.
 
* The staging deeds at, for example, [http://staging.creativecommons.org/licenses/by-sa/3.0/no/ http://staging.creativecommons.org/licenses/by-sa/3.0/no/] show the localized versions of the human-readable license deeds.
 
 
For both of these, appending ?lang=no lets you see the Norwegian translation; that should work for any short language code.
 
 
== Committing translations ==
 
 
Language editors can use the ''commit'' facility in Pootle to permanently store their changes. Each commit is a permanent snapshot of the PO file. In addition, we only update ''staging.creativecommons.org'' once you commit.
 
 
As a result, the commit feature is very useful as as "preview" feature. To use it, you must have the commit privilege to a language in Pootle.
 
 
Start at the message catalogs page, as seen below:
 
 
[[Image:Pootle_show_editing_functions.png|frame|The message catalogs page with ''Show Editing Functions'' highlighted]]
 
 
Follow the link to '''Show Editing Functions'', and you arrive at a page like this:
 
 
[[Image:Pootle_editing_functions.png|frame|The editing functions page]]
 
 
Click on "Commit," and after a somewhat substantial wait, you will see a message indicating that some files were committed. (If there are no changes, then Pootle will not actually perform a commit.) You can then expect that ''staging.creativecommons.org'' is up-to-date with respect to the language you are working on.
 
 
== Pushing to the live site ==
 
 
WHen you are happy with your changes as they appear on ''staging.creativecommons.org'', email webmaster@creativecommons.org to request that we update the main creativecommons.org website with your translations. You should expect a response saying it's done within a couple of work days at the longest.
 
 
== Granting permissions ==
 
 
As a language administrator, you can grant privileges to other translators who have shown their ability to provide good-quality text. To do that,
 
 
= Other information =
 
 
== Getting Help ==
 
== Getting Help ==
  
Line 167: Line 26:
 
* [[Translating with Pootle/Administration]]
 
* [[Translating with Pootle/Administration]]
  
== Using suggestions ==
+
== How to handle ${} or %() strings ==
* ?
 
 
 
= How to handle ${} strings =
 
  
When you see ${license_name} in a string, that indicates a substitution (for the real license name). These are placeholders that the translation machinery uses; if you modify this placeholder, the real license name will never be substituted into your string.
+
When you see "${license_name}" or "%(license_name)s" in a string, that indicates a substitution (for the real license name). These are placeholders that the translation machinery uses; if you modify this placeholder, the real license name will never be substituted into your string.
  
 
As a result, '''DO NOT''':
 
As a result, '''DO NOT''':
Line 179: Line 35:
 
* Remove the text
 
* Remove the text
 
* Reverse the order of characters because you have a right-to-left language (ie, "{license_name}$")
 
* Reverse the order of characters because you have a right-to-left language (ie, "{license_name}$")
 +
* If the text uses the %(), do not remove the trailing character after the close of the parenthesis (i.e. the 's' in "%(license_name)s")
 +
 +
== Whitespace Characters ==
 +
 +
Sometimes you'll see <code>\t</code> or <code>\n</code> in strings.  These are left-over from the source files and can be safely omitted.
 +
 +
== Wiki Links ==
 +
 +
Some text contains links to the CC Wiki for more information (ie, issues surrounding fair use, public domain, etc).  If you would like to translate those pages in the CC Wiki, you may do so and substitute the link to the translated page in the translation.  See [[CC Wiki:Translate]] for instructions on translating wiki pages.
 +
 +
{{Translations
 +
| articles = Id:Translating with Pootle
 +
}}
 +
 +
[[Category:Developer]]
 +
[[Category:Opensource]]
 +
[[Category:I18n]]

Latest revision as of 14:25, 29 April 2011

Creative Commons uses the online tool Pootle at translate.creativecommons.org to manage translations of our software projects. (To translate pages on this wiki, see CC Wiki:Translate.)

Applications currently managed by translate.creativecommons.org are:

Tutorials

There are three Pootle tutorials you can watch and read:

  1. Setting up your account
  2. Making translations and suggestions
  3. Managing suggestions and previewing at staging

Other information

Getting Help

If you have questions about using Pootle or about the translation process, you can ask in the IRC channel, or by sending an email to webmaster@creativecommons.org. If you are a CC affiliate on the CCi mailing list, you can use that instead.

Administering translations

How to handle ${} or %() strings

When you see "${license_name}" or "%(license_name)s" in a string, that indicates a substitution (for the real license name). These are placeholders that the translation machinery uses; if you modify this placeholder, the real license name will never be substituted into your string.

As a result, DO NOT:

  • Translate the text ("license_name") into your own language
  • Remove the text
  • Reverse the order of characters because you have a right-to-left language (ie, "{license_name}$")
  • If the text uses the %(), do not remove the trailing character after the close of the parenthesis (i.e. the 's' in "%(license_name)s")

Whitespace Characters

Sometimes you'll see \t or \n in strings. These are left-over from the source files and can be safely omitted.

Wiki Links

Some text contains links to the CC Wiki for more information (ie, issues surrounding fair use, public domain, etc). If you would like to translate those pages in the CC Wiki, you may do so and substitute the link to the translated page in the translation. See CC Wiki:Translate for instructions on translating wiki pages.