launchpad help|
Size: 3900
Comment:
|
Size: 9206
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 14: | Line 14: |
| Importantly, Launchpad's simple web interface makes it easy for anyone to help translate your software, while its support of the popular GNU GetText file formats makes it easy to integrate their work into your project. | Importantly, Launchpad's simple web interface provides a friendly environment in which non-technical people can help translate your software, while its support of the popular GNU GetText file formats makes it easy to integrate their work into your project. {i} '''Note:''' if you want to help translate Ubuntu, take a look at the [https://wiki.ubuntu.com/TranslatingUbuntu Ubuntu translations page]. |
| Line 20: | Line 22: |
| 1. Enable translation on your project's ```Change details``` page - ```https://launchpad.net/<yourproject>/+edit``` 1. Upload a translation template. |
1. Enable translation for on your project's ```Change details``` page - ```https://launchpad.net/<yourproject>/+edit``` 1. Upload a translation template and any existing translation files to the series you want to translate. |
| Line 24: | Line 26: |
| Let's take a look at those last two, in turn. | Let's take a look at those in more detail. |
| Line 26: | Line 28: |
| = Uploading a translation template = | == Preparing your software for translation == |
| Line 31: | Line 33: |
| * '''.po:''' the translations for a particular language. * '''.mo:''' |
* '''.po:''' translations for one language in a human-readable and editable form. * '''.mo:''' a compiled binary form of a .po file. You can find out more about these file formats and using GNU GetText in the [http://www.gnu.org/software/gettext/manual/gettext.html GetText manual]. (!) '''Tip:''' you may also find Malcolm Tredinnick's [http://www.gnome.org/~malcolm/i18n/ Gnome internationalisation guide] useful, although some of the Gnome policies mentioned in that guide are now out of date. == Uploading translation files == To make your project available for translation, you must upload a .pot translation template file. This files tells Launchpad which English strings appear in your software. You can also, optionally, upload any existing .po translations files; to upload a template and existing translation files together, you should create a tar archive of them. == Concurrent translation efforts for different series == In Launchpad, a series is a line of development, such as your development trunk, a previous but still supported release or your next planned stable release. Launchpad calls these [:Projects/SeriesMilestonesReleases#series:series]. Each series of your project has its own translation effort. This is great if, for example, your community wants to start work translating a forthcoming release while independently still maintaining translation of your current release. Uploading files is easy: visit ```https://translations.launchpad.net/<your-project>``` and select the series to which you want to upload the template and translations. Once you've uploaded these files, a member of the Launchpad team will check that they're suitable before importing them into Launchpad. Launchpad should accept future uploads automatically, although it will === Ensuring a successful import === You can help ensure your files are imported by checking that: * there isn't already a translation effort in Launchpad for that project * you have permission from the upsteam project, if that's not you. There are also some common problems that can cause a template or translation file import to fail. For translation templates: * Make sure each message id - i.e. the English strings - is unique. * Use real English strings - for example ```Save the file``` - rather than identifiers, such as ```click_save_z339```. For translation files: * Ensure consistent formatting: for example, if "%d" appears in an original English string, make sure it's also in each language's equivalent. * Use consistent paths within your tarball: locate all your .po translation files under the same directory structure. * Name individual language .po files using the ISO language code. Only append the country code in the following circumstances: * variants of international English: for example, ```en_gb.po``` * Brazillian Portugese: ```pt_br.po``` (Brazillian Portugese), rather than ```pt.po``` for European Portugese * Chinese: traditional ```zh_tw.po``` and simplified ```zh_cn.po``` Launchpad will email you to let you know if your import was a success or a failure. |
| Line 35: | Line 80: |
| = Maintaining quality = | |
| Line 36: | Line 82: |
| Before anyone can translate your project, you need to upload your software's English user-interface text. | There are a couple of ways that Launchpad helps you to balance making it easy for people to contribute to your project's translations, while maintaining quality control: |
| Line 38: | Line 84: |
| By default, translation is switched off for all new projects. This helps avoid wasted work. | * '''permission policies:''' choose one of four ready-made policies, each with a different balance between spontaneous contribution and review of work * '''translations groups:''' an umbrella group of Launchpad teams, who have certain permissions to work on your project's translations. == Translations groups == |
| Line 40: | Line 89: |
| To enable translations for your project, visit | Depending on which permissions policy you choose, it's more than likely that anyone will be able to suggest translations for your project. However, to maintain the quality of your project's localisation, you should find someone you trust who can review those translations. |
| Line 42: | Line 91: |
| Translation groups are are a convenient way to delegate responsibility for reviewing translations. The important thing to remember about them is that they're independent of any one project. So, as a project owner, you can either choose to work with an existing translation group or create your own. | |
| Line 43: | Line 93: |
| Use the first two paragraphs to summarise all the important points about this article. | Within each translation group, an individual or team is assigned to look after one or more languages. When you choose a translation group, you're entrusting the review of your project's translations to its members. Not only must you be certain that you're comfortable with the people already involved in the group but you must also be sure that you're happy with their methods of vetting new recruits. |
| Line 45: | Line 95: |
| Tell the reader if this is the information they need as soon as possible. | The advantage of working with an existing translation group is that they should already have established teams for several languages, as well as the community processes necessary to ensure efficient review. However, selecting a translation group is not the same as persuading people to review translation made in your project! |
| Line 47: | Line 97: |
| = Instructional text = | === An example translation group === |
| Line 49: | Line 99: |
| Where appropriate, use step by step instructions: | Let's take a look at an example translation group, the biggest in Launchpad: [https://translations.launchpad.net/+groups/ubuntu-translators Ubuntu Translators]. |
| Line 51: | Line 101: |
| '''Step 1:''' Give concise and unambiguous instructions. | By visiting the group's overview page, you can see which: |
| Line 53: | Line 103: |
| '''Step 2:''' Try not to state the obvious, unless you're writing for a novice user. | * individual or team owns the group * individuals and teams are assigned to which languages * projects and distributions have delegated their translation review to Ubuntu Translators. |
| Line 55: | Line 107: |
| {i} '''Note:''' Highlight important information with a note. | === Working with an existing translation group === |
| Line 57: | Line 109: |
| '''Step 3:''' Use a well cropped screen shot if it will help orient the reader. Don't let the screen shot replace instructional text: not everyone can see your screen shot. Don't worry about borders or annotation for small, cropped screen shots such as this. | To choose an existing translation group, visit ```https://launchpad.net/<your-project>/+changetranslators```. |
| Line 59: | Line 111: |
| attachment:screen-shot.png | Although many projects find that people spontaneously contribute translations to their projects, you now need to encourage the teams within your chosen group to review translations in your project. |
| Line 61: | Line 113: |
| {i} '''Warning:''' If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them. | === Creating your own translation group === |
| Line 63: | Line 115: |
| If you have specific requirements for the people who review your project's translations, you may want to create your own translation group. | |
| Line 64: | Line 117: |
| == Full screen shots == | The only way to do that is to [https://answers.edge.launchpad.net/rosetta/+addquestion file a support request] with the Launchpad administrators. |
| Line 66: | Line 119: |
| ||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">attachment:proj-announce.png|| ||<style="text-align: center;">'''Describe the screen shot here'''|| |
== Choosing a permissions policy == |
| Line 69: | Line 121: |
| Some screen shots will be better placed to the right of your text. As they're not placed directly below the text that they support, use a border and short description. | Launchpad offers you four ready-made permissions structures to help you choose who can submit and review translations for your project: |
| Line 71: | Line 123: |
| Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam sagittis. Aliquam eros dui, scelerisque id, consequat in, accumsan vitae, pede. Suspendisse neque ligula, scelerisque ac, mattis ut, aliquam quis, odio. Proin nunc nisi, fringilla ac, congue ac, luctus eu, lacus. Maecenas ac purus. Cras felis metus, ultricies non, euismod ac, accumsan eleifend, leo. Quisque imperdiet tempus tellus. Ut euismod, diam nec adipiscing interdum, tortor orci fringilla nisi, vel blandit erat magna at nisi. Fusce hendrerit odio non metus. Mauris nisl massa, dapibus id, feugiat quis, blandit a, quam. Integer tincidunt feugiat nunc. Curabitur iaculis egestas elit. Nam imperdiet suscipit odio. |
* '''Open:''' anyone can submit translations directly to your project in Launchpad. Great for encouraging drive-by contributions. * '''Restricted:''' if your project's translation group has assigned an individual or team to a particular language, only that person or members of that team can review and accept translation strings for that language. Anyone can suggest a translation for those languages, though. For languages that aren't associated with a translation group, anyone can directly submit a translation. * '''Structured:''' similar to ``restricted``, except that translations are closed on languages that don't have an individual or team assigned to it within the translation group. * '''Closed:''' only people or teams appointed in the appropriate translation group can suggest or make translations. Translation is closed to everyone else. This is ideal if your project requires an agreement to transfer copyright before starting work. Set your project's permissions policy at ```https://launchpad.net/<your-project>/+changetranslators```. |
DRAFT: this page is a work in progress. Please [:Feedback:seek further help] or check the [:TitleIndex:wiki index] for a complete page on this topic.
Overview
While development usually takes place in English, free software is used by people in hundreds of different languages across the globe.
Launchpad applies two of the great benefits of the open source development model to translating your software:
- anyone can translate or suggest translations
- translations are automatically shared between projects.
Importantly, Launchpad's simple web interface provides a friendly environment in which non-technical people can help translate your software, while its support of the popular GNU GetText file formats makes it easy to integrate their work into your project.
Note: if you want to help translate Ubuntu, take a look at the [https://wiki.ubuntu.com/TranslatingUbuntu Ubuntu translations page].
Getting started
You need to do three things before people can use Launchpad to translate your project:
Enable translation for on your project's Change details page - https://launchpad.net/<yourproject>/+edit
- Upload a translation template and any existing translation files to the series you want to translate.
- Choose a permissions policy - i.e. decide who can make what sorts of changes to your translations.
Let's take a look at those in more detail.
Preparing your software for translation
Launchpad uses GNU GetText's file formats to import and and export translations:
.pot: a template that includes the English text that you want people to translate.
.po: translations for one language in a human-readable and editable form.
.mo: a compiled binary form of a .po file.
You can find out more about these file formats and using GNU GetText in the [http://www.gnu.org/software/gettext/manual/gettext.html GetText manual].
Tip: you may also find Malcolm Tredinnick's [http://www.gnome.org/~malcolm/i18n/ Gnome internationalisation guide] useful, although some of the Gnome policies mentioned in that guide are now out of date.
Uploading translation files
To make your project available for translation, you must upload a .pot translation template file. This files tells Launchpad which English strings appear in your software. You can also, optionally, upload any existing .po translations files; to upload a template and existing translation files together, you should create a tar archive of them.
Concurrent translation efforts for different series
In Launchpad, a series is a line of development, such as your development trunk, a previous but still supported release or your next planned stable release. Launchpad calls these [:Projects/SeriesMilestonesReleases#series:series].
Each series of your project has its own translation effort. This is great if, for example, your community wants to start work translating a forthcoming release while independently still maintaining translation of your current release.
Uploading files is easy: visit https://translations.launchpad.net/<your-project> and select the series to which you want to upload the template and translations.
Once you've uploaded these files, a member of the Launchpad team will check that they're suitable before importing them into Launchpad. Launchpad should accept future uploads automatically, although it will
Ensuring a successful import
You can help ensure your files are imported by checking that:
- there isn't already a translation effort in Launchpad for that project
- you have permission from the upsteam project, if that's not you.
There are also some common problems that can cause a template or translation file import to fail.
For translation templates:
- Make sure each message id - i.e. the English strings - is unique.
Use real English strings - for example Save the file - rather than identifiers, such as click_save_z339.
For translation files:
- Ensure consistent formatting: for example, if "%d" appears in an original English string, make sure it's also in each language's equivalent.
- Use consistent paths within your tarball: locate all your .po translation files under the same directory structure.
- Name individual language .po files using the ISO language code. Only append the country code in the following circumstances:
variants of international English: for example, en_gb.po
Brazillian Portugese: pt_br.po (Brazillian Portugese), rather than pt.po for European Portugese
Chinese: traditional zh_tw.po and simplified zh_cn.po
Launchpad will email you to let you know if your import was a success or a failure.
Maintaining quality
There are a couple of ways that Launchpad helps you to balance making it easy for people to contribute to your project's translations, while maintaining quality control:
permission policies: choose one of four ready-made policies, each with a different balance between spontaneous contribution and review of work
translations groups: an umbrella group of Launchpad teams, who have certain permissions to work on your project's translations.
Translations groups
Depending on which permissions policy you choose, it's more than likely that anyone will be able to suggest translations for your project. However, to maintain the quality of your project's localisation, you should find someone you trust who can review those translations.
Translation groups are are a convenient way to delegate responsibility for reviewing translations. The important thing to remember about them is that they're independent of any one project. So, as a project owner, you can either choose to work with an existing translation group or create your own.
Within each translation group, an individual or team is assigned to look after one or more languages. When you choose a translation group, you're entrusting the review of your project's translations to its members. Not only must you be certain that you're comfortable with the people already involved in the group but you must also be sure that you're happy with their methods of vetting new recruits.
The advantage of working with an existing translation group is that they should already have established teams for several languages, as well as the community processes necessary to ensure efficient review. However, selecting a translation group is not the same as persuading people to review translation made in your project!
An example translation group
Let's take a look at an example translation group, the biggest in Launchpad: [https://translations.launchpad.net/+groups/ubuntu-translators Ubuntu Translators].
By visiting the group's overview page, you can see which:
- individual or team owns the group
- individuals and teams are assigned to which languages
- projects and distributions have delegated their translation review to Ubuntu Translators.
Working with an existing translation group
To choose an existing translation group, visit https://launchpad.net/<your-project>/+changetranslators.
Although many projects find that people spontaneously contribute translations to their projects, you now need to encourage the teams within your chosen group to review translations in your project.
Creating your own translation group
If you have specific requirements for the people who review your project's translations, you may want to create your own translation group.
The only way to do that is to [https://answers.edge.launchpad.net/rosetta/+addquestion file a support request] with the Launchpad administrators.
Choosing a permissions policy
Launchpad offers you four ready-made permissions structures to help you choose who can submit and review translations for your project:
Open: anyone can submit translations directly to your project in Launchpad. Great for encouraging drive-by contributions.
Restricted: if your project's translation group has assigned an individual or team to a particular language, only that person or members of that team can review and accept translation strings for that language. Anyone can suggest a translation for those languages, though. For languages that aren't associated with a translation group, anyone can directly submit a translation.
Structured: similar to restricted, except that translations are closed on languages that don't have an individual or team assigned to it within the translation group.
Closed: only people or teams appointed in the appropriate translation group can suggest or make translations. Translation is closed to everyone else. This is ideal if your project requires an agreement to transfer copyright before starting work.
Set your project's permissions policy at https://launchpad.net/<your-project>/+changetranslators.
