Translations

elementary.io Blog Human Interface Guidelines Contributor Guide
Search…
Translations
Now that you've learned about Meson, the next step is to make your app able to be translated to different languages. The first thing you need to know is how to mark strings in your code as translatable. Here's an example:
1
stdout.printf ("Not Translatable string");
2
stdout.printf (_("Translatable string!"));
3
​
4
string normal = "Another non-translatable string";
5
string translated = _("Another translatable string");
Copied!
See the difference? We marked the string as translatable by adding _() around it. Go back to your project and make all your strings translatable by adding _().
Now we have to make some changes to our Meson build system and add a couple new files to describe which files we want to translate and which languages we want to translate into.
1.Open up your "meson.build" file and add these lines below your project declaration:
1
# Include the translations module
2
i18n = import('i18n')
3
​
4
# Set our translation domain
5
add_global_arguments('-DGETTEXT_PACKAGE="@[email protected]"'.format (meson.project_name()), language:'c')
Copied!
2.Remove the lines that install your .desktop and appdata files and replace them with the following:
1
#Translate and install our .desktop file
2
i18n.merge_file(
3
    input: 'data' / 'hello-again.desktop.in',
4
    output: meson.project_name() + '.desktop',
5
    po_dir: meson.source_root() / 'po',
6
    type: 'desktop',
7
    install: true,
8
    install_dir: get_option('datadir') / 'applications'
9
)
10
​
11
#Translate and install our .appdata file
12
i18n.merge_file(
13
    input: 'data' / 'hello-again.appdata.xml.in',
14
    output: meson.project_name() + '.appdata.xml',
15
    po_dir: meson.source_root() / 'po',
16
    install: true,
17
    install_dir: get_option('datadir') / 'metainfo'
18
)
Copied!
The merge_file method combines translating and installing files, similarly to how the executable method combines building and installing your app. You might have noticed that this method has both an input argument and an output argument. We can use this instead of the rename argument from the install_data method.
3.Still in this file, add the following as the last line:
1
subdir('po')
Copied!
4.You might have noticed in step 2 that the merge_file method has an input and output. We're going to append the additional extension .in to our .desktop and .appdata.xml files so that this method can take the untranslated files and produce translated files with the correct names.
1
git mv data/hello-again.desktop data/hello-again.desktop.in
2
git mv data/hello-again.appdata.xml data/hello-again.appdata.xml.in
Copied!
We use the git mv command here instead of renaming in the file manager or with mv so that git can keep track of the file rename as part of our revision history.
5.Now, Create a directory named "po" in the root folder of your project. Inside of your po directory you will need to create another "meson.build" file. This time, its contents will be:
1
 i18n.gettext(meson.project_name(),
2
     args: '--directory=' + meson.source_root(),
3
     preset: 'glib'
4
 )
Copied!
6.Inside of "po" create another file called "POTFILES" that will contain paths to all of the files you want to translate. For us, this looks like:
1
src/Application.vala
2
data/hello-again.desktop.in
3
data/hello-again.appdata.xml.in
Copied!
7.We have one more file to create in the "po" directory. This file will be named "LINGUAS" and it should contain the two-letter language codes for all languages you want to provide translations for. As an example, let's add German and Spanish
1
de
2
es
Copied!
8.Now it's time to go back to your build directory and generate some new files using Terminal! The first one is our translation template or .pot file:
1
ninja com.github.yourusername.yourrepositoryname-pot
Copied!
After running this command you should notice a new file in the po directory containing all of the translatable strings for your app.
9.Now we can use this template file to generate translation files for each of the languages we listed in the LINGUAS file with the following command:
1
ninja com.github.yourusername.yourrepositoryname-update-po
Copied!
You should notice two new files in your po directory called de.po and es.po. These files are now ready for translators to localize your app!
10.Last step. Don't forget to add all of the new files we created in the po directory to git:
1
git add src/Application.vala meson.build po/ data/
2
git commit -am "Add translations"
3
git push
Copied!
That's it! Your app is now fully ready to be translated. Remember that each time you add new translatable strings or change old ones, you should regenerate your .pot and po files using the -pot and -update-po build targets from the previous two steps. If you want to support more languages, just list them in the LINGUAS file and generate the new po file with the -update-potarget. Don't forget to add any new po files to git!
If you're having trouble, you can view the full example code here on GitHub​
Translators Comments
Sometimes detailed descriptions in the context of translatable strings are necessary for disambiguation or to help in the creation of accurate translations. For these situations use /// TRANSLATORS: comments.
1
/// TRANSLATORS: The first %s is search term, the second is the name of default browser
2
title = _("Search for %s in %s").printf (query, get_default_browser_name ());
Copied!
The Build System
Icons
Last modified 4mo ago
Export as PDF
Copy link
Contents
Translators Comments