Translation
Translation team
Only the names of those who regularly contribute to the translation are listed here:
- English (US ou GB) : Rory O'Farrell, Mark Coolen
- Catalan : Emili Cid
- Spanish : Stephan Miralles Díaz
- Esperanto : favdb
- Hungarian : Sinkovics Vivien
En partenariat avec Permondo:
Ces traductions ont été possibles grâce au projet PerMondo. Traduction gratuite pour les sites web et les documents au profit d'organisations non gouvernementales et bénévoles. Un projet géré par Mondo Agit.
- German : Lena Huber
- Bulgarian : Siyana Raycheva
- Chinese : Feier Yang
- Korean : Kyunghee Jung
- Danish : Kira Petersen
- Greek : Dimitra Andrikou
- Italian : Flavia Guadagnino
- Dutch : Reineke Van Mierlo
- Polish : Kamila El Khayati
- Portuguses : Isabella Schiavon
- Romanian : Agnes Erika Stan
- Russian : Iryna Zubata (Зубата Ирина)
- Czech : Linda Blättler
- Turkish : Şeyma Aydın
- Ukrainian : Roksolana Pavlyshyn
How to translate oStorybook?
1) Which files need to be translated?
There's just one file that contains all the messages that can be translated. This is the messages.properties located in the src/i18n/msg directory of the source code.
2) How to proceed?
The first step is to retrieve the application's source code. If you have no intention of working on other aspects of the software, you can limit yourself to the files concerned. These are the messages.properties file, for the software's basic language, and the messages_??.properties file. Replace the ?? with the ISO 639-1 language code (2-character lowercase code). If the file doesn't exist, you'll need to create it. Download this file(s) into one of your local folders, and I suggest calling it ... oStorybook (original, isn't it?). We'll call this method "the manual method".
You can also use oStorybook to perform this translation, a recommended procedure since version 5.00.02. Select menu Help > Translate UI. We'll call this method "the integrated method".
3) Some rules
Each oStorybook message is introduced by a key followed by the equal sign. The left part of the line, to the left of the equal sign, is therefore not to be modified. On the right-hand side of the line, some special elements may appear:
- n: represents a line feed.
- t : represents a tabulation, i.e. a jump of 4 to 5 characters.
- {0} (may also include {1} {2} etc...): some messages include a variable parameter (or parameters) depending on the context.
These special elements must be preserved.
4) I've got the files, what do I do with them?
If you've created the translation file, you've probably done so by making a copy of the base file. With a standard editor, which uses the same text file specifications as under Unix/Linux (UTF-8, simple CR), all you have to do is modify the right-hand side of the equal sign (=). Be careful, however, as some messages can take up several lines.
You can also use dedicated tools rather than a simple text editor. For example, you can use the I18N software. Of course, there's also NetBeans.
If you encounter any difficulties, or have any questions, please don't hesitate to ask on the forum.
5) That's it, I've finished, what do I do now?
So you've spent a looooong time making your translation (not all that long, mind you). Now it's time to integrate it into the application. Ideally, you'd like to integrate it officially: just let us know that your translation is ready, and make it available for download somewhere. If you're a member of the development team, no problem, you'll do a commit and a push.
But you may want to test your work before releasing it. You can do this without having to install Netbeans, or recompile the entire software. All you have to do is start oStorybook by adding a parameter item on the command line, like this:
java -jar oStorybook --msg /home/me/oStorybook/messages_ru
In this example, I'll test the translated file for Russian.
If you're not a command-line enthusiast, since version 5.05.00 you've had an option in the Preferences via the "Change language file" button.
Finaly
If you would like to join our team of translators, please subscribe to our mailing list. Traffic on this mailing list is very moderate, less than a dozen messages a year.