We have a strong opinion about how an application in general, and more especially a Rails application, should be internationalized. A lot of people use the default Rails Internationalization API (I18n) but we don’t really think this is an ideal solution for big projects.
1. It’s painful to “make up” keys.
The welcome title of the main page may be as simple as
but you can end up with very verbose things like
2. Not trivial to search text in code.
When you want to change a text, you have to look for its key in the codebase, then find the text itself in the corresponding YAML file. It doesn’t sound very practical to us.
With GetText, editing a text is just a matter of finding it and updating it, right in place. No need to switch between many files.
3. Difficult coevolution between keys and associated text.
You’ve found a nice, short and descriptive key name for a given text. A few weeks later the customer asks for a significant change in the source language of that text. In such a situation you also need to change the key according to its new signification. Sometimes you won’t, or you will forget. Then you will probably end up with a key name not representative of its content.
4. Difficult to know if all the keys are really used in the application.
All the translation keys are located at the same place: in YAML file(s).
They are also organized as a tree. When the key is used in the code, it is
formatted with a dot syntax like
my.key. When you are in a YAML file, it’s
not easy to perform a “find in project” with your editor to see if it is still
used or not. Because you have to convert the path in the tree to dot syntax
With the GetText paradigm, unused strings will be automatically detected at
POT file generation. And with Translation.io you can
safely remove all unused strings with the
rake translation:sync_and_purge task.
5. YAML can contain values that are not translations.
Rails YAML files contain not only translation strings but also localization values (integers, arrays, booleans) in the same place and that’s bad. For example : date formats, number separators, default currency or measure units, etc.
A translator is supposed to translate, not localize. That’s not his role to choose how you want your dates or numbers to be displayed, right? Moreover, this special keys often contain special constructions (e.g., with percent signs or spaces) that he might break.
We think localization is part of the configuration of the app and it should not reach the translator UI at all. That’s why these localization keys are detected and separated on a dedicated YAML file with Translation.io.
6. GetText is a standard in the Open-Source community.
GNU GetText has been around since 1995 and is the de-facto translation solution for many projects. So why not using it in Rails applications?
7. GetText syntax is nice.
GetText syntax looks optimal to us: short method names because used everywhere in the codebase and easy to remember.
However, YAML has some advantages too.
1. Pre-translated YAML files for Gems.
It’s easier to ship the translatable strings of a Gem as a YAML file. No dependency at all because Rails ships with YAML. But if you don’t code a gem, this argument is weak.
2. Allows to copywrite text in the source language.
Certainly the biggest argument in favor of YAML. You can use YAML keys in your code as placeholders for text and then allow some people (clients? marketing team?) to edit the text in all languages, including the source one, without changing the source code.
We allow this feature in Translation.io. It’s called Copywriting
We propose two ways for translating your applications and both ways can be used at the same time without any issue. But we strongly encourage you to use GetText as your main workflow since your translation process will be way smoother.
The only exception is when you need to delegate the source edition of the text to an external person or team. In that specific case, use a well-named YAML key and use our copywriting feature.