The Weblate Manual Release 3.10.1 Michal Čihař Jan 09, 2020 User docs 1 User docs 1 1.1 Weblate basics .......................................... 1 1.2 Registration and user profile .................................. 1 1.3 Translating using Weblate ................................... 8 1.4 Downloading and uploading translations ........................... 16 1.5 Checks and fixups ........................................ 17 1.6 Searching ............................................. 28 1.7 Application developer guide ................................... 29 1.8 Translation workflows ...................................... 43 1.9 Frequently Asked Questions .................................. 46 1.10 Supported file formats ...................................... 53 1.11 Version control integration ................................... 68 1.12 Weblate’s Web API ....................................... 74 1.13 Weblate Client .......................................... 98 1.14 Weblate’s Python API ...................................... 101 2 Administrator docs 103 2.1 Installation instructions ..................................... 103 2.2 Configuration instructions ................................... 125 2.3 Weblate deployments ...................................... 145 2.4 Upgrading Weblate ....................................... 146 2.5 Backing up and moving Weblate ................................ 152 2.6 Authentication .......................................... 157 2.7 Access control .......................................... 164 2.8 Translation projects ....................................... 171 2.9 Language definitions ....................................... 181 2.10 Continuous localization ..................................... 181 2.11 Licensing translations ...................................... 190 2.12 Translation process ....................................... 191 2.13 Checks and fixups ........................................ 197 2.14 Machine translation ....................................... 204 2.15 Addons .............................................. 209 2.16 Translation Memory ....................................... 218 2.17 Configuration ........................................... 220 2.18 Sample configuration ...................................... 236 2.19 Management commands ..................................... 252 2.20 Whiteboard messages ...................................... 263 2.21 Component Lists ......................................... 265 2.22 Optional Weblate modules ................................... 266 2.23 Customizing Weblate ...................................... 270 2.24 Django admin interface ..................................... 272 i 2.25 Getting support for Weblate .................................. 278 3 Contributor docs 279 3.1 About Weblate .......................................... 279 3.2 Contributing ........................................... 280 3.3 Debugging Weblate ....................................... 283 3.4 Internals ............................................. 284 3.5 License .............................................. 285 3.6 Legal documents ......................................... 285 4 Change History 287 4.1 Weblate 3.10.1 .......................................... 287 4.2 Weblate 3.10 ........................................... 287 4.3 Weblate 3.9.1 ........................................... 288 4.4 Weblate 3.9 ............................................ 288 4.5 Weblate 3.8 ............................................ 289 4.6 Weblate 3.7.1 ........................................... 290 4.7 Weblate 3.7 ............................................ 290 4.8 Weblate 3.6.1 ........................................... 291 4.9 Weblate 3.6 ............................................ 292 4.10 Weblate 3.5.1 ........................................... 292 4.11 Weblate 3.5 ............................................ 293 4.12 Weblate 3.4 ............................................ 293 4.13 Weblate 3.3 ............................................ 294 4.14 Weblate 3.2.2 ........................................... 294 4.15 Weblate 3.2.1 ........................................... 294 4.16 Weblate 3.2 ............................................ 295 4.17 Weblate 3.1.1 ........................................... 295 4.18 Weblate 3.1 ............................................ 295 4.19 Weblate 3.0.1 ........................................... 296 4.20 Weblate 3.0 ............................................ 296 4.21 Weblate 2.x series ........................................ 296 4.22 Weblate 1.x series ........................................ 307 4.23 Weblate 0.x series ........................................ 312 Python Module Index 315 HTTP Routing Table 316 Index 318 ii CHAPTER 1 User docs 1.1 Weblate basics 1.1.1 Project structure In Weblate translations are organized into projects and components. Each project can contain number of components and those contain translations into individual languages. The component corresponds to one translatable file (for example GNU Gettext or Android string resources). The projects are there to help you organize component into logical sets (for example to group all translations used within one application). Internally, each project has translations to common strings propagated across other components within it by default. This lightens the burden of repetitive and multi version translation. Disable it as per Component configuration, still producing errors for seemingly inconsistent resulting translations. 1.2 Registration and user profile 1.2.1 Registration While by default everybody can browse projects, view translations or suggest them, only registered users are allowed to actually save changes and are credited for every translation made. You can register by following a few simple steps: 1. Fill out the registration form with your credentials 2. Activate registration by following the link in the e-mail you receive 3. Possibly adjust your profile to choose which languages you know 1.2.2 Dashboard When you log in to Weblate, you will see an overview of projects and components as well as their translation progress. New in version 2.5. 1 The Weblate Manual, Release 3.10.1 By default, this will show the components of projects you are watching, cross-referenced with your preferred languages. You can switch to different views using the navigation tabs. The menu will show several options: • Projects > Browse all projects in the main menu (or menu Tools > All projects in the Dashboard) will show translation status of all projects on the Weblate instance. • Selecting a language in the main menu Languages will show translation status of all projects, filtered by one of your primary languages. • Watched translations in the Dashboard will show translation status of only those projects you are watching, filtered by your primary languages. In addition, the drop-down can also show any number of component lists, sets of project components preconfigured by the Weblate administrator, see Component Lists. You can configure your default dashboard view in the Preferences section of your user profile settings. Note: When Weblate is configured for a single project using SINGLE_PROJECT in the settings.py file (see Configuration), the dashboard will not be shown as the user will be redirected to a single project or component. 2 Chapter 1. User docs The Weblate Manual, Release 3.10.1 1.2.3 User profile The User profile is accessible by clicking your user icon in the far-right of the top menu, thenthe Settings menu. User profile contains your preferences, name and e-mail. Name and e-mail are being usedinVCS commits, so keep this information accurate. Note: All language selections offer only languages which are currently being translated. If youwant to translate to another language, please request it first on the project you want to translate. Translated languages Choose here which languages you prefer to translate. These will be offered to you on the main pageof watched projects so that you have easier access to these translations. Secondary languages You can define secondary languages, which will be shown to you, while translating, together withthe source language. Example can be seen on the following image, where Hebrew language is shown as secondary: 1.2. Registration and user profile 3 The Weblate Manual, Release 3.10.1 Default dashboard view On the Preferences tab, you can pick which of the available dashboard views will be displayed by default. If you pick Component list, you have to select which component list will be displayed from the Default component list drop-down. See also: Component Lists Avatar Weblate can be configured to show avatar for each user (depending on ENABLE_AVATARS). These images are obtained using https://gravatar.com/. Editor link By default Weblate does display source code in the web browser configured in the Component configura- tion. By setting Editor link you can override this to use your local editor to open the source code where translated strings are being used. You can use Template markup. Usually something like editor://open/?file={{filename}}&line={{line}} is a good option. See also: You can find more information on registering custom URL protocols for editorin nette documentation. 4 Chapter 1. User docs The Weblate Manual, Release 3.10.1 1.2.4 Notifications You can subscribe to various notifications on Subscriptions tab. You will receive notifications for selected events on watched or administered projects. Some of the notifications