Ubuntu Development > Internationalization Guide > Packaging
Packages in main and restricted don't contain translations (*.mo) files themselves, they are stripped during the build on the Launchpad buildds and put into language-pack-* packages instead. This is done in an attempt to bundle the translations you're interested in and cut down the occupied space.
Once a package is promoted to main, it only needs to be rebuilt the first time after promotion so that pkgbinarymangler can strip the translations. After this, import to Launchpad Translations and export in language packs "will just happen"
For pkgstriptranslations (in the pkgbinarymangler package) to do the job right and translations to be imported into Launchpad, please make sure that your package in main or restricted generates a POT translation template during the build. It does not necessarily need to be shipped in the source or in the binary package. Generating it during the build is good enough.
If your package does not generate a POT template on build, its translations will remain as Blocked in the Launchpad Translations import queue and will not be imported
The most common approaches are running either of the following in debian/rules:
- For packages using CDBS and automake:
You just need to include /usr/share/cdbs/1/rules/langpack.mk in debian/rules
If the package is a GNOME one, and you are using the gnome.mk CDBS class already, you should be good to go, since it already includes langpack.mk
- KDE packages: TODO
- If for some reason the POT template cannot be generated during the build, see the sections below.
Other packages, using intltool usually require:
A call to intltool-update -p in debian/rules, or
- a call to an already existing Makefile target to build the POT (this does exist quite often in fact).
Packages which don't use intltool:
- Need to get fixed individually
Usually by adding a call to xgettext and po/POTFILES.in, or
Finding an already existing Makefile target. e.g. Use $(MAKE) -C po update-po instead of (cd po; make update-po; cd ..). Example in the debian/rules file from upower:
common-post-build-arch:: make -C po upower.pot
Packages which use python-distutils-extra:
Template creation should happen automagically
- TODO: explanation of the command and auto modules
Other translation files
Translations of desktop entries (.desktop files) are also stripped out and included in language packs.
Contrary to what other distros do (except currently OpenSUSE), the translations are not expected to be in the .desktop files themselves (static translations), but rather in the same .mo file of the application, from which they are then loaded at runtime. We do this in order to be able to translate them in Launchpad and to ship them in language packs, so that they can be edited and updated by Ubuntu translators.
The runtime loading is done by patches to patch glib and kdelibs, which recognises the the X-Ubuntu-Gettext-Domain additional key we add to all Ubuntu .desktop files and adds gettext support when loading them. Note that if the .desktop file already contains translations, these static translations will be preferred.
Adding the X-Ubuntu-Gettext-Domain= key is done during build time in the packaging either automatically with the package build system or (increasingly rarely) with patches.
Method for adding key
kde.mk includes /usr/lib/kubuntu-desktop-i18n/kubuntu.mk which adds the key using the package name (or an environment variable specified in debian/rule)
KDE old CDBS
Older packages may will use /usr/share/cdbs/1/class/kde4.mk, which add the key, this is deprecated in favour of /usr/share/pkg-kde-tools/makefiles/1/cdbs/kde.mk
KDE Debhelper 7
/usr/share/pkg-kde-tools/makefiles/1/debhelper/kde.mk includes /usr/lib/kubuntu-desktop-i18n/debhelper/kubuntu.mk which adds the key based on the package name (or an environment variable)
gnome.mk includes langpack.mk, the catalogue name comes from po/Makefile
GNOME Debhelper 7
The .desktop files are patched directly e.g. transmission
For KDE the translations themselves are downloaded as part of the packaging process of the upstream kde-l10n-xx language packs.
The patch to glib is being submitted upstream (using the key X-GNOME-Gettext-Domain) but has not yet been accepted. The Ubuntu glib version supports both keys, it first checks for X-GNOME- and then X-Ubuntu-.
In summary, for packages in main we strip the translations out of the .desktop files, and glib/kdelibs carry a distro patch to load translations from the .mo file. They use the X-Ubuntu-Gettext-Domain key to figure out where to get the translation from.
$ for i in `ls /usr/share/polkit-1/actions/`; do dpkg -S $i; done
Interactive upgrade hooks
After certain upgrades (most notably upgrades between Ubuntu releases), there are follow-up actions which should be taken by the user. These are not logically part of the upgrade, but should be dealt with at some point after the upgrade is complete.
They take the form of helper scripts that can be called by the package's postinst script, and can be internationalized through language packs.
Here's an example showing how these can be internationalized:
_Name: The great UTF-8 Migration Priority: Medium Command: bc Terminal: True GettextDomain: hwdb-clinet DisplayIf: shell-command Title: Change the default title here DontShowAfterReboot: False _Description: This command will convert your stuff into UTF-8. Use this command if you want a working gnome desktop and you feel the world should be a better place.
This is a notification description file as it should be put into a source package. NB the '_' prefix for fields that should be translated. For getting these strings into the package's PO template, you should add a stanza like this to po/POTFILES.in:
[type: gettext/rfc822deb] debian/utf8-migration.installnote
The file should be shipped in /usr/share/packagename and the package's postinst script should install it if the notification should be displayed. At that time it needs to remove the '_' prefixes:
install -d /var/lib/update-notifier/user.d/ sed 's/^_//' /usr/share/utf8-migration-tool/utf8-migration.installnote > /var/lib/update-notifier/user.d/utf8-migration
Verifying translation uploads
This information is intended to help package maintainers to optimize their packages, so that translation related files get automatically imported into Launchpad.
Testing the package locally
To test if your package conforms to the requirements of the import script in Launchpad, please do the following:
In /etc/pkgbinarymangler/striptranslations.conf set enable: to true
Optionally, install any build dependencies: sudo apt-get build-dep $PKGNAME
Build the package with debuild -uc -us -b
You will find a <pkgname>-translations.tar.gz tarball along with the .deb package(s)
- Untar that tarball into a temporary directory
- Compare if the directory structure and the .pot and .po files conform to the requirements listed below
If the application uses gettext, like most GTK and GNU applications do:
Template name and domain: the filename of the template (.pot file) should be the same as what the expected translation domain is.
Translation filenames: the actual translations (.po files) must have a filename of the format $LANGUAGECODE.po or $LOCALECODE.po (e.g. de.po, pt_BR.po, zh_TW.po)
Template and translations location: all translation-related files (the .pot template and its corresponding .po templates) must end up in the same (sub-)directory if possible.
Multiple domains: if the application has multiple translation domains (i.e. multiple .pot files), each .pot file and their corresponding .po files should end up in a separate subdirectory (e.g. po/nautilus/nautilus.pot and po/libnautilus/libnautilus.pot)
Recommended translations layout: it is recommended that templates and translations for the main application or library are located in the po/ directory.
Recommended help layout: it is recommended that templates and translations for help files are located in the help/po/ directory. Note: they will be ignored by Launchpad, since we currently have no infrastructure to deal with them properly.
Recommended documentation layout: it is recommended that templates and translations for documentation files are located in the doc/po/ directory. Note: they will also be ignored by Launchpad for the same reason as the help translations.
Obsolete translations: if there are .po files present in the package but no associated .pot template, please remove them, since they cannot be used without a .pot template. There might be a bug in the package or in the source code whereby the .pot file doesn't get generated, so make sure to double-check that as well.
Valid POT template: please check if the .pot file has any meaningful content. Empty .pot files should be removed and the package build rules be fixed.
Templates generated by patches: if your package contains patches and those patches result into extra templates, like patches.pot, please merge those changes into the main template, as we have no use for patch .pot files. Such .pot files should not exist in the final tarball.
Multiple templates merged into one: if the package generates multiple .pot files and later merges them into one, only the final .pot file should be present in the final tarball.
Architecture-dependent templates: if the package creates the same .pot file in architecture-dependent subdirectories, please consider to merge them, as we can only deal with one single .pot per translation domain.
Test templates: test routines and test files should not generate any .pot template or ship any .po file. If such files are present, please remove them.
Use UTF-8 encoding: if you have multiple .po files for a language, each in a different encoding, please consider renaming the ones encoded in UTF-8 to be the main .po file for that language and discard the other ones. They might be interesting for Windows users, but not for Linux ones, since translations get converted with iconv into the encoding the user is runnning anyway. And nowadays UTF-8 is the default encoding on Linux. E.g.: if you have zh_TW.po (Big5 encoding), zh_TW.UTF-8.po and zh_TW.cp960.po, please remove zh_TW.po and zh_TW.cp960.po and rename zh_TW.UTF-8.po to zh_TW.po.
Obsolete no locale: the no locale is obsolete. If you find no.po files, please look into it and find out if it's Norwegian Bokmål or Nynorsk. Usually it's Bokmål. Please rename the file to the proper language code: nb.po for Bokmål, nn.po for Nynorsk. If nb.po and nn.po are already present, remove no.po.
English US translations: If you have an en_US.po file, please investigate if it really contains translations (i.e. if the source code uses en_GB or another language) and if not, you can safely discard it.
Converting xml to PO with xml2po
- Launchpad import
Packages not using the Gettext format
UbuntuDevelopment/Internationalisation/Packaging (last edited 2010-08-03 18:00:26 by 0)