Internationalization and localization instructions

Basic Terms

pot-file: Text file automatically generated with rake task (rake updatepo) or rgettext that shows all the original messages (msgid) inside the app code. Developers should generate this files and send them to translators as a template to write the po files (translated version of the pot file for a language).

po-file: Text file which is language-specific. It includes msgid(Original message) and msgstr(Translated message)

mo-file: Binary Files which are created from po-files with rake task (rake makemo) or rmsgfmt. The Ruby-GetText-Package library reads this compiled mo-files, not po-files.

File Maintenance

To do I18n maintenance, you need to install ruby-gettext-package

As it is not in the gem repository, you need to:
1) Download ruby-gettext-package- from here
2) Extract ruby-gettext-package-
3) Go to the extracted directory and run “sudo ruby setup.rb”

How to add a new language?:

1) create language directory inside “po” folder (eg: es/)
2) Go inside new language folder and run: msginit -i ../ur_application_name.pot -o ur_application_name.po

How to update po files (when new keys are added or modified)?:
1) Go to app folder and run: rake updatepo

To recompile files (when you get new/modifed po files translated)
1) Go to app folder and run: rake makemo

How to add i18n to a Page?

Basics

If you want to translate a text. Eg. “This text” You need to simple call _(). E.g _(“This text”).

The key will be added to the po file and someone will translate it later. If the key is already in the po file (and compiled in the mo file) it will appear translated. You should choose keys that make sense and that might be reusable. Try not to pick very long texts as keys.

• If you need to include arguments to your strings, check: http://www.yotabanana.com/hiki/ruby-gettext-howto.html#String+with+arguments
• If you need to use plural forms (eg. “you have 1 new message”), check: http://www.yotabanana.com/hiki/ruby-gettext-howto.html#How+to+use+GetText.n_(msgid%2C+msgid_plural%2C+n)
• If you need to define constants in the po file, use N_() (eg, attribute accesors in model) you can use N_(“Password”). This functions does nothing but allows you to include the key in the po file.
• If you need to include a context specific key (eg: “File|Open”, “Printer|Open”), check s_() function: http://www.yotabanana.com/hiki/ruby-gettext-howto.html#How+to+use+GetText.s_(msgid%2C+div+%3D+%22|%22)

Model: All field names are automatically added to the po file from the database (whith the rake task). If you need to define constants or translate new error messages, you can use the N_() function. For more information, check: http://www.yotabanana.com/hiki/ruby-gettext-howto-rails.html