Information for translators
OpenPLi is always looking for help to have it translated properly in many languages. But we kindly ask you to translate in your native language or in a language that you are really familiar with. OpenPLi is not looking for automated translation jobs.
Quick start guide
- We recommend that you download and install PoEdit from this site (please consider to register it if you appreciate it): https://poedit.net/
- Once installed go into: Preferences - Advanced - suppress the wrap line option and untick preserve original file format
- Download the language file you want to work on from: https://github.com/OpenPLi/enigma2/tree/develop/po (click on the file name, it will show you the file content, press the RAW button and save it locally on your disk).
- Open it up with PoEdit
- You can start translating the file
- Save it, you will get 2 files xx.po and xx.mo (where xx is your language code)
- Upload your updated xx.po file to the forum and we will put it back into github for you: https://forums.openpli.org/forum/55-en-enduser-support/ (we don't need to xx.mo file only the xx.po is important for us).
How can I test my translation on my OpenPLi?
In order to test you translation work on you receiver, you will need a FTP access to it.
You can get a free FTP client from: https://filezilla-project.org/ (or any FTP client of your choice).
Advice: if you use FileZilla client go into Parameters - Transferts - FTP: file type : set it to Binary (this will avoid you many problems when using FTP).
- You have a local file that you have worked on called: xx.mo (where xx is your language code) rename it into: enigma2.mo
- Connect to your receiver and go to this path: /usr/share/enigma2/po
- There you will see a series of folders, one per language, enter the language that you are working on: /usr/share/enigma2/po/xx/LC_MESSAGES
- Rename the file already existing on your receiver enigma2.mo into enigma2.bak (this step is important if you want to be able to rollback your changes)
- Transfert your own enigma2.mo file
- Restart your receiver
- Enjoy your translation
My enigma2.mo gives trouble: how to rollback?
- If you have followed the previous step carefully, connect with FTP to you receiver go back into the folder, delete your enigma2.mo and rename the enigma2.bak into enigma2.mo
- Restart you receiver.
What are Fuzzy lines in PoEdit?
The po files are generated based on the translatable strings that are in the source code, but the source code evolves and the strings are subject to change.
So when the script detect that an already translated string is changed in the source code, it is marked as fuzzy, this mean that the string must be reviewed by the translators.
It can happen that the translation is still correct, so don't forgot to untick the fuzzy flag in PoEdit because a fuzzy string is never displayed, only validated translation are.
There is a mistake in the original strings that I want to translate, how can I fix it?
If you find a mistake in the original strings / sentences that you need to translate it is useless to try to fix it in the po file. The correction must done in the source code.
So please report the error on the OpenPLi forum and wait to have it fixed into the source code and the po files including the correction to be generated again.
You can continue to translate in between, just skip the erroneous strings.
Do I need to translate every strings?
Some strings, perhaps, doesn't need to be translated, you can of course decide to skip those strings and leave them untranslated. From my side, I'd like to have the po file that I manage always translated at 100%. Why? Because I'd like to see immediately the strings that I still need to translate, otherwise you will read over and over the untranslated strings. But it's up to you to decide.
My plugins are not translated, can I add manually the missing strings in the OpenPLi po files to have it translated too?
No never add manually missing strings/sentences into OpenPLi file to translate, for exemple plugin, because the po files are generated on a regular basis and every strings/sentences that is included in a po file but not found in the OpenPLi source code will just deleted. So you will lose your work.
Remark: I will explain later on how to properly translated plugins (stay tuned).
Can I edit po file without using PoEdit?
po files are just plain text, so yes of course any linux compatible text editor can do the job but PoEdit is real help to avoid some common mistake that you can make when editing it with a text editor.
PoEdit report warning in my po file, is it normal?
Yes, PoEdit can report warning that are not mistakes, for exemple a capital letter set when it is not in the original string, this is not blocking. If you are happy with you translation, don't care about warnings.
But if PoEdit report errors then you need to fix them, errors are important and will prevent you from saving the file. So you need to fix them all.
How to easily unwrap my file with PoEdit?
The po file that I proposed generates thousands of changed lines in github, is it normal?
Not really (except if you start a translation from scratch and work very hard).
po files can have 2 format:
- the wrapped lines version where the editor wrap a big line into several smaller ones
- the unwrapped lines where the long line are remains untouched.
OpenPLi choose to include in there git the unwrapped version of the po file, so if you propose a wrapped po file this will generates thousands of changes.
But it is possible to easily unwrap your file with PoEdit:
- Please open PoEdit, go into Preferences - Advanced - do not enable the wrap line after xx chars option and also do not select the preserve original file format.
- Open up your po file and save it.
The new version will be an unwrapped version (size will be slightly smaller too).
To be continued...
