Pootle

From OLPC
Revision as of 12:52, 30 October 2007 by 198.54.202.250 (talk) (→‎Show checks: Add info about modifying check behaviour)
Jump to navigation Jump to search
IRC #olpc-pootle, #olpc-content

UPDATE
The test has gone forward and we are in the process of establishing the workflow to make it the Localization platform of the XO.
WANTED
Volunteers both for translating and coordinating. If interested sign-up as a volunteer!

These are the notes taken and rough sketches for the processes involved in the localization effort in order to use Pootle as a more liberal L10n platform.

There are several scenarios that depend on the roles and their associated responsibilities (ie: translators, coders, administrators, etc). Below we outline the two most important ones from the POV of the translators that we could classify as either the opportunistic translator (fixing a typo or translating a few missing strings) and a registered translator (that is somehow more committed with the whole l10n reality).

If we consider that in the ultimate case children will be dealing with code (thus with gettext), we want things and processes to be as simple and straight forward as possible, so that in the end anybody will be able to translate or at least localize content to some degree. With this in mind, we aim for an environment that will:

  • allow anybody to make suggestions,
  • allow registered and trusted users to review and make translations, and
  • administrators to commit.

i18n & L10n

Most people will argue that localization (L10n / l10n) concerns and issues should be tackled way before coding is finished, and quite a few will categorically say that it will be too late by then. Avoiding the philosophical and formal aspects, and taking a more pragmatic approach, the truth is that L10n is more often than not an afterthought and internationalization (i18n) an annoying pre-requisite... that has to be done.

In the context of the OLPC XO software and activities, and for practical purposes will avoid the debate on exactly where does L10n meets the code and start from the point where the output of i18n is used as the input for the l10n process. In other words, we'll elaborate based on the simplistic model that goes along the line:

  1. generate POT from the source code (output of the i18n process)
  2. generate PO based on POT
  3. translate / populate the PO with locale specific content
  4. generate the final PO (or MO) (output of the l10n process)
  5. the executable code uses the PO (or MO) to comunicate with the final user

Developers

see Wikipedia's overview, the Translate project's guide, KDE i18n guide, GNU gettext manual and other sources

Developers willing to read a bit more about i18n & L10n, should review the links above. Regardless of how much or how good the i18n effort is, the bottom line from Pootle's point of view is that it needs one (or more) .POT files. Needless to say, developers should be aware that localization is NOT just about strings, as it includes plurals, numbers, dates, currencies, text-flow, scripts, fonts... and that it needs to be tested (ie: pseudolocalization testing) that needs to be considered in the overal development cycle. Also, if you want your activity to be properly localized, think about commenting your strings.

Translators

see L10n guide, translation guide, more links to come...

Being able to understand or grasp the intended meaning of some text in a language does not make you a translator, but "In the land of the blind, the one-eyed man is king." and all collaborations are welcome, although we also recommend reading some guidelines and documentation that may at least help you avoid some of the basic or typical errors and pitfalls.

Basic Scenarios

The basic idea is to allow the participation of anybody willing to put some effort while trying to keep a given quality of the translations.

  • You can download the PO, so there's no forcing of the on-line UI (although you need the upload right to inject it back. So before going the offline road please coordinate with the admins.
  • In the translation interface, fuzzy entries are grayed out and there's a gray vertical line separating the terms

Opportunistic translator

This user just wants to help. She/he doesn't want to get tangled in the administrative tasks. The only possible collaboration available is to suggest translations (which will be reviewed by users who have been granted the Review permission in a particular language).

After navigating to the olpc pootle server project: olpc language: spanish to finally reach a file (ie: TamTamSynthLab)

The interface will display a series of PO entries (one will have the focus—if it doesn't, you can double click the entry, or hovering over one will make an 'Edit' link appear that enables it—showing an entry field, and the following controls:

a picture is worth 1000 words

  • Back & Skip buttons — jump to the previous or next entry
  • Copy button — copies the original (msgid) value and continues in edit mode
  • Suggest button — the actual collaboration of suggesting a translation
  • Fuzzy checkbox — denotes that the suggested translation is/is not 100% trustworthy
  • Special characters specific to the language (see #Languages)
  • grow / shrink — allows growing and shrinking of the entry field (see #User options
  • Translator comments field — comments either extracted from the source code, or added by other translators

The opportunistic translator then proceeds to navigate the file/s entering suggestions (to be processed later by the reviewers).

Admin notes
The Suggest permission must be granted on a per-language-project basis.
Each language may have specific or special characters that are may not be available in the user's keyboard, but can be provided for in the #Language specification.

Registered translator

Except for the mandatory pre-condition to register, which enables the extra [Submit] button when translating, the overall process is quite similar to that of the #Opportunistic translator. On the other hand, several user-specific permissions may apply (ie: off-line translation) and the GUI will adapt and offer them. Also, as a registered translator, you may be assigned specific files or strings to translate and/or review, allowing to better coordinate the overall effort.

Admin notes
In a collaborative and low-entry-barrier process, the administrator/s should enable the default user to actually translate — Navigation: admin | projects | project_name | language | permissions +Translate.
The default #user permissions apply to any registered user (unless they are overridden in a case-by-case approach). In the out-of-the-box install they include: View, Suggest, Archive & Compile PO files

User Scenarios

Register as a translator

  1. Head towards the pootle site
  2. Follows the register link where you fill the following fields: Username, Password, Confirm password, Full Name & Email Address, clicking on the [Register Account] button that will send a confirmation message to the email address with the activation code.
  3. Following the link in the email will activate the newly created account. After which it will ask you to login and take you to your user page.

User options

In your user page there's a link to Change options that will allow you define some things:

  • Projects you wish to participate (for the moment only olpc should be considered a valid option)
  • Languages you wish to collaborate in. If you don't find your language, as an administrator you can associate it to the project (see #Languages) or as a mere mortal, you should contact an administrator.
  • Other options like personal data & translation UI are present.

After configuring, don't forget to hit the [Save changes] button to make them effective, after which you can return to your #user page by means of the Home Page link.

User page

aka: 'Home', or 'My account' page.

You can reach your user page following the Home or My account link (depending on where you are) and it will show the appropriate links to the selected projects grouped by languages:

  • The language link takes you to the statistics page per project
  • the project-in-a-language link takes you the the statistics page displaying all its files

Advanced User Scenarios

Reviewer

A user who has been granted the Review permission, may accept or reject the suggestions made by users (who must have the Suggest permission). The way to do this is there another? is to go to a language/project combination (ie: spanish-olpc) and follow the Show Editing Functions. Here you have two alternatives: review the whole set of suggestions in the language-project set, or work on the suggestions present in a specific file (ie: all suggestions or TamTamSynthLab suggestions).

Once in the review UI, the reviewer has four options: Accept, Reject, Back or Skip which are self evident, but nevertheless will mention:

Accept the reviewer translator accepts the suggestion and is registered
Reject the suggested translation is rejected does that mean erased for the user or the file?
Back goes to the previous suggestion assume a previous non-accepted/rejected suggestion
Skip goes to the next available suggestion

In the case where multiple suggestions have been made, each one has its Accept & Reject buttons, while only the last will have the Back & Skip buttons.

Regardless of the multiplicity of suggestions, each suggested string will be diffed with the current string highlighting the changes. It also displays (if available) the name of the user that made the suggestion.

Editing functions

This section of the UI displays on a per-file basis several functionalities that depend on the permissions of the user:

Translate My Strings enter the translate UI limiting the visibility to those strings assigned to the user. explore
Quick Translate My Strings same as above, unknown difference. explore
Quick Translate enter the translate UI over the whole set? explore
Translate All explore
PO file used for off-line translators in order to retrieve the whole .PO file.
XLIFF file used for off-line translators and interfaces to retrieve the whole file in said format. explore
Qt .ts file explore
CSV file explore

Show checks

For more information on the quality checks, see the documentation.

This functionality is a real helper (at least for latin scripts) as it runs a series of checks on the translations. So Pootle besides the obvious verification of translated+fuzzy+untranslated check, it verifies:

  • simplecaps — for extra capital letters
  • startcaps — initial capital letter matches between source & translation
  • startpunc — if the original doesn't start with a letter, the translation probably shouldn't either
  • unchanged — the source & translation are the same
  • others!! — there are several others! Apparently, from traces in a somefile.po.stats the checks performed are:
    check-validchars, check-numbers, check-unchanged, check-doublespacing, check-purepunc, check-isreview, check-nplurals, check-brackets, blank, check-endpunc, check-xmltags, check-escapes, check-spellcheck, check-endwhitespace, check-functions, check-doublewords, check-singlequoting, check-simplecaps, check-blank, check-emails, check-startwhitespace, check-accelerators, check-long, check-musttranslatewords, has-suggestion, check-puncspacing, check-notranslatewords, check-variables, check-doublequoting, check-kdecomments, check-short, fuzzy, check-untranslated, check-simpleplurals, check-sentencecount, check-isfuzzy, check-startpunc, check-compendiumconflicts, check-tabs, check-newlines, check-urls, check-filepaths, check-startcaps, translated, check-printf, check-acronyms, and sourcewordcounts, targetwordcounts.

Obviously, these checks, as any automated language process, are to be taken as a guidance and not as a rule. The check behaviour can be adjusted for a language, e.g. simplecaps could be disabled for a language that does not have a concept of capitals, doublequoting to make the checker aware of quote characters used in a language. These are changed by providing a lang module in the Translate Toolkit e.g. Japanese and French.

Zip of folder

Actually, any 'grouping' of PO files may be downloaded as a ZIP file if the user has the archive right. In other words, you can download the files in a language, goal, file, etc. It may be possible that Pootle extracts and recombines from several files in order to provide the zip with say 'My Strings' for offline work.

Administration

See Pootle/Administration

User permissions

See Pootle/Administration#User permissions

Sign-up

If interested in the Localization effort, please sign up below. Although we are focusing on Amharic, Arabic, English, Spanish, French, Hausa, Hindi, Igbo, Nepali, Portuguese, Romanian, Russian, Kinyarwanda, Thai, Urdu, & Yoruba, any other language is welcome. If you are not subscribed to localization@lists.laptop.org we strongly suggest you do so.

Role Name Comments
[ar] — Arabic language — العربية
T Khaled Hosny
[el] — Greek language — Ελληνικά
T Simos Xenitellis
[mk] — Macedonian language — македонски
OTRA Arangel Angov
[es] — Spanish language — español
OTRA Xavier Alvarez
[ru] — Russian language — русский
T Maxim Osipov
[ne] — Nepali language — नेपाली
T Shankar Pokharel
[zh-TW] — Chinese language — 中文（臺灣）
OTRA Yuan Chao
Role key
O-pportunistic
if you would be willing to make suggestions only to the translations (ie: fixing typos or alternative wordings that would be reviewed)
T-ranslator
actually translate strings
R-eviewer
process suggestions made by opportunistic volunteers and overall checking of translated strings.
A-dministrate
a particular language (or a particular project in a given language). It involves reviewing and other tasks (like determining #user permissions, interfacing with d.l.o, etc).

See also

Retrieved from "http://wiki.laptop.org/mediawiki/index.php?title=Pootle&oldid=74335"