› Home › Support › Translation › Instructions

Instructions

Once you are registered as a translator, you can start translating strings on our online tool at http://wocts.waterproof.fr/. Log in, select the PHPEdit 3.X project, click on "Go to translate" and you're ready to go.

Avoiding common mistakes

Will translating strings it's very important to respect the format of the original string:

Keep single line strings single line: They might be intended to appear on a single line output, like the status bar. If you put your text on several lines it won't appear;
Keep multi line strings multi line: Sometime strings finish with an empty line, because when they are used in the code they will be concatenated to an other string, and an empty line is required for readability;
Special format characters must be kept: some strings will be formated before being displayed to the user, so they contain special character sequences for this. This sequences are in the .NET format: {0}, {1:d}, etc... These sequences must all appear in exactly the same syntax in the translated string. If you are unsure, don't hesitate to contact us for help;
Strings should not be escaped manually: Type your strings normally, as they should appear to the user. The system will escape the characters that need escaping automatically. There is one exception: if the string is a format string (see previous), curly braces outside of a format sequence need to be doubled: use {{ and }} to have a curly brace in your format string. Don't use this syntax with a normal string.

Reporting errors

Several kind of errors can be discovered in the translation process, and understand it will help solving these errors quicker.

Let's say, PHPEdit build 1234 is about to be released:

The waterproof team will launch the build process. All the strings found in the PHPEdit code, and some other PHPEdit files, will be sent to the online interface. So if you have build 1234, you see a string in it, but you don't see it in the online interface, then there's an extraction problem. You can report it in the bug tracker as you would any other bug.
The second step of the build process is retrieving all the last translated strings. If you have translated a string in the online interface before build 1234 was made, but you still see it untranslated in build 1234, there's either a bug with the retrieval of strings, or in PHPEdit when it translates the strings. This should be reported in the tracker too.

Other possible problems can be typos in the original english text, or strings that shouldn't be translated, for example:

!999;1;_
H
bt1
tooltip1

If you see a string like that, don't hesitate to contact us, we'll remove it if needed.

When reporting problems in the bugtracker, they are to be reported in the "PHPEdit" project, "Graphical user interface" -> "Localization", or by using PHPEdit's "Submit bug report" dialog.

Testing the translation

If you're anxious to test the translation you have done, and can't wait for the next build to see the result, can you use your translation manually:

Use the "Export this translation" button in the online interface to save it in the .po format;
Compile the .po file to the .mo format, using for example Poedit. Simply opening the .po file in Poedit and saving it will create the .mo file in the same directory;
Copy the .mo file in your PHPEdit installation dir, as "locale\[language code]\LC_MESSAGES\default.mo";
Start PHPEdit, you should be able to select your translation in the settings dialog, and see the results right away.

Getting the reward

As mentionned in the parent page, by translating 25% of the strings, of reviewing all of the strings, you get a complete set of licenses for PHPEdit and all of it's extensions existing at the time of the translation.

The attribution of the licenses is not done automatically, you need to request them to us by mail once you are finished.