Shekyl daemon internationalization

The Shekyl command line tools can be translated in various languages. If you wish to contribute and need help/support, contact the project's localization channel or open an issue in the repository.

The project uses Qt Linguist translation files (same workflow as many CryptoNote-based projects). To avoid Qt dependencies at runtime, a custom loader reads those files at runtime.

Tools for translators

In order to create, update or build translations files, you need to have Qt tools installed. For translating, you need either the Qt Linguist GUI (part of Qt Creator or a 3rd-party standalone version), or another tool that supports Qt ts files, such as Transifex. The files are XML, so they can be edited in any plain text editor if needed.

Creating / modifying translations

You do not need anything from Qt in order to use the final translations.

To update ts files after changing source code:

./utils/translations/update-translations.sh

To add a new language, eg Spanish (ISO code es):

cp translations/shekyl.ts translations/shekyl_es.ts

To edit translations for Spanish:

linguist translations/shekyl_es.ts

To build translations after modifying them:

./utils/translations/build-translations.sh

To test a translation:

LANG=es ./build/release/bin/shekyl-cli

To add new translatable strings in the source code:

Use the tr(string) function if possible. If the code is in a class, and this class doesn't already have a tr() static function, add one, which uses a context named after what lupdate uses for the context, usually the fully qualified class name (eg, cryptonote::simple_wallet). If you need to use tr() in code that's not in a class, you can use the fully qualified version (eg, simple_wallet::tr) of the one matching the context you want. Use QT_TRANSLATE_NOOP(string) if you want to specify a context manually.

If you're getting messages of the form:

Class 'cryptonote::simple_wallet' lacks Q_OBJECT macro

all is fine, we don't actually need that here.