Administration of Weblate is done through standard Django admin interface, which is available under /admin/ URL.
All translation resources need to be available as Git repositories and are organized as project/subproject structure.
Weblate supports wide range of translation formats supported by translate toolkit, for example:
To add new resource to translate, you need to create translation project first. The project is sort of shelf, in which real translations are folded. All subprojects in same project share suggestions and dictionary, also the translations are automatically propagated through the all subproject in single project.
The project has only few attributes giving translators information about project.
Subproject is real resource for translating. You enter Git repository location and file mask which files to translate and Weblate automatically fetches the Git and finds all translated files.
Should the language definition for translation be missing, empty definition is created and named as “cs_CZ (generated)”. You should adjust the definition and report this back to Weblate authors so that missing language can be included in next release.
The subproject contains all important parameters for working with Git and getting translations out of it:
As setup of translation project includes fetching Git repositories, you might want to preseed these, repos are stored in path defined by GIT_ROOT in settings.py in <project>/<subproject> directories.
You should set up some way how backend repositories are updated from their source. You can either use hooks (see Notification hooks) or just regularly run ./manage.py updategit –all.
With Gettext po files, you might be often bitten by conflict in PO file headers. To avoid it, you can use shipped merge driver (examples/git-merge-gettext-po). To use it just put following configuration to your .gitconfig:
[merge "merge-gettext-po"] name = merge driver for gettext po files driver = /path/to/weblate/examples/git-merge-gettext-po %O %A %B
And enable it’s use by defining proper attributes in given repository (eg. in .git/info/attribute):
This merge driver assumes the changes in POT files always are done in brach we’re trying to merge.
Each project can have configured push URL and in such case Weblate offers button to push changes to remote repo in web interface.
I case you will use SSH for pushing, you need to have key without passphrase (or use ssh-agent for Django) and the remote server needs to be verified by you first, otherwise push will fail.
Weblate makes it easy to interact with others using it’s API.
Weblate uses privileges system based on Django. It defines following extra privileges:
The default setup (after you run ./manage.py setupgroups) consists of two groups Users and Managers which have privileges as descibed above. All new users are automatically added to Users group.
To customize this setup, it is recommended to remove privileges from Users group and create additional groups with finer privileges (eg. Translators group, which will be allowed to save translations and manage suggestions) and add selected users to this group. You can do all this from Django admin interface.
Default behaviour (configured by LAZY_COMMITS) of Weblate is to group commits from same author into one if possible. This heavily reduces number of commits, however you might need to do implicit sync to get Git repository in sync (you can do this in admin interface).
The changes are in this mode committed once one of following conditions happen:
Weblate comes with wide range of consistency checks (see Checks), though they might not 100% cover all you want to check. The list of performed checks can be adjusted using CHECK_LIST and you can also add custom checks. All you need to do is to subclass trans.checks.Check, set few attributes and implement either check or check_single methods (first one if you want to deal with plurals in your code, the latter one does this for you). You will find below some examples.
This is pretty simple check which just checks whether translation does not contain string “foo”.
from weblate.trans.checks import Check from django.utils.translation import ugettext_lazy as _ class FooCheck(Check): # Used as identifier for check, should be unique check_id = 'foo' # Short name used to display failing check name = _('Foo check') # Description for failing check description = _('Your translation is foo') # Real check code def check_single(self, source, target, flags, language, unit): return 'foo' in target
Check using language information to verify that two plural forms in Czech language are not same.
from weblate.trans.checks import Check from django.utils.translation import ugettext_lazy as _ class PluralCzechCheck(Check): # Used as identifier for check, should be unique check_id = 'foo' # Short name used to display failing check name = _('Foo check') # Description for failing check description = _('Your translation is foo') # Real check code def check(self, sources, targets, flags, language, unit): if self.is_language(language, ['cs']): return targets == targets return False