Wherein I detail how human language translation is incorporated into software packages as a part of the build process.
Two Translation Build Environments
The grandaddy package for integrating i18n translations into software is GNU gettext. First released in 1995, gettext initially focused on providing translation services for software written in ‘C’. While it includes copious documentation on details of its many components, the expectation seems to be that most developers interact with gettext by way of autotools.
The ‘C’/Autotools focus for gettext was perhaps the driving force for the development of intltool by freedesktop.org. Intltool acts as a wrapper around gettext, simplifying the interface while at the same time expanding the types of files supported (at least historically). The core intltool documentation consists of the included man pages of the components.
There are also other environments available for working in this same space. Generally, these are more limited in scope, and often not as well supported.
While learning these environments, I felt that both gave too little emphasis on the big picture. This became most acute as I was dealing with the limited built-in i18n support for some languages other than ‘C’.
So, here’s how human language translation support gets built into your package. For each step, I’ll show the commands in both intltool and gettext to perform the action. In the case of gettext, I’m making a stab here. I use intltool exclusively.
Two Translation Strategies
For software, translation information is compiled into binary, language-specific .mo files. Those files are consulted at run time, as needed, to convert English strings into appropriate localized ones.
For text and data files, all of the translated strings are often added to the source file at build time. XML files and .desktop files fall into this category.
Though the build process handles both cases at the same time, we’ll consider them separately.
The Build Steps (run-time translation)
Step 1 - String identification in software source
The means to do this are similar-but-different across software languages. For Python, the following is required at the top of the file:
import locale import gettext locale.setlocale(locale.LC_ALL, '') gettext.textdomain(<package name>) _ = gettext.gettext
After that, use the underscore function you just created to both identify and convert text strings to the appropriate language:
print(_("Please print this in my language"))
Step 2 - Create the Translation Template (.POT) file
$ cd po; xgettext -f POTFILES.in -f <package name>.pot -a
$ cd po; intltool-update --pot --gettext-package=<package name>
In both cases there must first be a po/ directory in your source tree, and a po/POTFILES.in file which defines the source files to be processed, relative to the root of the project.
The result is a po/<package name>.pot file (example), which contains all of the strings to be translated.
‘POT’ stands for “Portable Object Template”, if that helps.
Step 3 - Transform the POT to individual (.PO) translation files
This is essentially a manual process. For each target language, the po/<package name>.pot file is copied to po/<language>.po, or to po/<language>-<COUNTRY>.po, where <language> is an ISO 639-1 two-letter language code, and <COUNTRY>.po is a two-letter ISO 3166-1 (capitalized) two-letter country code (po example).
The resulting text file is hand-edited to add the translation strings. This can be done with an ordinary text editor, though there are special editors for the job. Poedit is a popular choice.
The skill set required for this step is obviously very different than for other software development tasks. A number of communities have been set up to facilitate those with the ability to do this job well. Ubuntu has done a good job of this, for software which is stored in their source control system. Debian also has a means to collect and status all of the software in the distribution which supports i18n. It’s not difficult to host a translation development environment on your own.
Step 4 - Update the PO files
Using gettext, for every <language>[-<COUNTRY>].po file present in /po:
$ cd po; msgmerge -u --backup=none <language>.po <package name>.pot
Using intltool, for every <language>[-<COUNTRY>] PO file present in /po:
$ cd po; intltool-update --dist --gettext-package=<package name> <language>
Once created, the .po files need to be updated whenever there are changes to the .pot file. These command will do that - refreshing the strings to be translated and their source line numbers.
Beyond that, the steps up to this point do not need to be executed with every build.
Step 5 - Transform the PO files to binary (.MO) translation files
Using gettext, for every <language>[-<country>].po file present in /po:
$ msgfmt po/<language>[-<COUNTRY>].po -o <build_dir>/mo/<language>[-<COUNTRY>]/<package name>.mo
Intltool uses the same command.
Step 6 - Incorporate the MO files into the package
Each .mo file gets installed with the package, to the path /usr/share/locale/<language>[-<COUNTRY>]/LC_MESSAGES/<package name>.mo.
The Build Steps (build-time translation)
Step 1 - String identification in text source
Every <file> in the build environment which is going to be translated is renamed to <file>.in.
Edit the .in files to identify translatable strings. For desktop files, prepend the translatable entries with an underscore:
[Desktop Entry] _Name=My Package _GenericName=Doing Software Right _Comment=Integrate GMail with your desktop MimeType=application/mbox;message/rfc822;x-scheme-handler/mailto; ...
For XML files, prepend translatable tags with an underscore. After translation, they will be repeated in the file for each language, with an “xml:lang” attribute identifying the language.
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE default-apps SYSTEM "gnome-da-list.dtd"> <default-apps> <mail-readers> <mail-reader> <_name>My Package</_name> ...
Steps 2 through 4 - Manage POT and PO files
These steps are identical to the ones listed above. Add the <file>.in files to POTFILES.in, and run as described.
Step 5 - Translate the text files
$ msgfmt <flag> --template=<file>.in -d po -o <file>
$ intltool-merge -u -c ./po/.intltool-merge-cache ./po <flag> <file>.in <file>
Note that <flag> defines the text file format. See the corresponding man pages for details. Also note that msgfmt expects a po/LINGUAS file to list all of the PO files present.
A Special Case - GUI Definition Files
Translations are handled differently by different GUI environments. Refer to the documentation for the environment you are using.
For Glade, translatable strings are flagged using the Glade editor. The Glade file is added to po/POTFILES.in, and processed normally to the MO translation files.
The process described here will leave a <file> for every <file>.in, the <build>/mo directory tree, and a po/.intltool-merge-cache file. These will need to be cleaned up.
At this point, your program supports translation. To demonstrate, first, add support for another language to your system:
$ sudo apt-get install language-pack-<language>
$ sudo dpkg-reconfigure locales
List the locales available:
$ locale -a C C.UTF-8 en_US.utf8 fr_FR.utf8 POSIX
Use an alternative locale to run your program:
$ LC_ALL=fr_FR.utf8 my-program
If life is good, you’ll see your work in a different language.