Weblate Documentation Release 2.13
Total Page:16
File Type:pdf, Size:1020Kb
Weblate Documentation Release 2.13 Michal Cihaˇ rˇ Apr 12, 2017 Contents 1 About Weblate 3 1.1 Project goals...............................................3 1.2 Project name...............................................3 1.3 Project website..............................................3 1.4 Authors..................................................3 2 Translators guide 5 2.1 Weblate basics..............................................5 2.2 Registration and user profile.......................................5 2.3 Translating using Weblate........................................ 10 2.4 Downloading and uploading translations................................ 17 2.5 Checks and fixups............................................ 20 3 Application developer guide 25 3.1 Starting with internationalization.................................... 25 3.2 Managing translations.......................................... 29 3.3 Reviewing source strings......................................... 29 3.4 Promoting the translation........................................ 33 3.5 Translation progress reporting...................................... 33 4 Administrators guide 37 4.1 Quick setup guide............................................ 37 4.2 Installation instructions......................................... 38 4.3 Weblate deployments........................................... 58 4.4 Upgrading Weblate............................................ 67 4.5 Authentication.............................................. 74 4.6 Access control.............................................. 78 4.7 Translation projects........................................... 83 4.8 Language definitions........................................... 93 4.9 Continuous translation.......................................... 93 4.10 Translation process............................................ 100 4.11 Checks and fixups............................................ 107 4.12 Machine translation........................................... 112 4.13 Configuration............................................... 115 4.14 Sample configuration........................................... 126 4.15 Management commands......................................... 136 4.16 Whiteboard messages.......................................... 145 i 4.17 Advertisement.............................................. 147 4.18 Component Lists............................................. 148 4.19 Optional Weblate modules........................................ 148 5 Frequently Asked Questions 151 5.1 Configuration............................................... 151 5.2 Usage................................................... 154 5.3 Troubleshooting............................................. 155 5.4 Features.................................................. 157 6 Supported formats 159 6.1 Automatic detection........................................... 159 6.2 GNU Gettext............................................... 159 6.3 XLIFF.................................................. 161 6.4 Java properties.............................................. 161 6.5 Joomla translations............................................ 161 6.6 Qt Linguist .ts.............................................. 162 6.7 Android string resources......................................... 162 6.8 Apple OS X strings............................................ 162 6.9 PHP strings................................................ 163 6.10 JSON files................................................ 163 6.11 .Net Resource files............................................ 164 6.12 CSV files................................................. 164 6.13 YAML files................................................ 164 6.14 Others.................................................. 165 7 Version control integration 167 7.1 Accessing repositories.......................................... 167 7.2 Git.................................................... 169 7.3 GitHub.................................................. 170 7.4 Mercurial................................................. 171 7.5 Subversion................................................ 171 8 Weblate’s Web API 173 8.1 REST API................................................ 173 8.2 Notification hooks............................................ 191 8.3 Exports.................................................. 192 8.4 RSS feeds................................................. 193 9 Weblate Client 195 9.1 Installation................................................ 195 9.2 Synopsis................................................. 195 9.3 Description................................................ 195 9.4 Files................................................... 197 9.5 Examples................................................. 198 10 Weblate’s Python API 199 10.1 Instalation................................................ 199 10.2 wlc .................................................... 199 10.3 wlc.config .............................................. 200 10.4 wlc.main ................................................ 200 11 Changes 201 11.1 weblate 2.13............................................... 201 11.2 weblate 2.12............................................... 201 ii 11.3 weblate 2.11............................................... 202 11.4 weblate 2.10.1.............................................. 202 11.5 weblate 2.10............................................... 202 11.6 weblate 2.9................................................ 203 11.7 weblate 2.8................................................ 203 11.8 weblate 2.7................................................ 204 11.9 weblate 2.6................................................ 204 11.10 weblate 2.5................................................ 205 11.11 weblate 2.4................................................ 206 11.12 weblate 2.3................................................ 207 11.13 weblate 2.2................................................ 207 11.14 weblate 2.1................................................ 208 11.15 weblate 2.0................................................ 208 11.16 weblate 1.9................................................ 209 11.17 weblate 1.8................................................ 209 11.18 weblate 1.7................................................ 209 11.19 weblate 1.6................................................ 210 11.20 weblate 1.5................................................ 211 11.21 weblate 1.4................................................ 211 11.22 weblate 1.3................................................ 212 11.23 weblate 1.2................................................ 212 11.24 weblate 1.1................................................ 213 11.25 weblate 1.0................................................ 213 11.26 weblate 0.9................................................ 214 11.27 weblate 0.8................................................ 214 11.28 weblate 0.7................................................ 215 11.29 weblate 0.6................................................ 215 11.30 weblate 0.5................................................ 215 11.31 weblate 0.4................................................ 216 11.32 weblate 0.3................................................ 216 11.33 weblate 0.2................................................ 216 11.34 weblate 0.1................................................ 216 12 Contributing 217 12.1 Code and development.......................................... 217 12.2 Starting with our codebase........................................ 218 12.3 Earning money by coding........................................ 218 12.4 Translating................................................ 218 12.5 Funding Weblate development...................................... 218 13 License 219 14 Indices and tables 221 HTTP Routing Table 223 Python Module Index 225 iii iv Weblate Documentation, Release 2.13 Contents: Contents 1 Weblate Documentation, Release 2.13 2 Contents CHAPTER 1 About Weblate Project goals Web based translation with tight git integration supporting wide range of file formats and makes it easy for translators to contribute. The translations should be kept within same repository as source code and translation process should closely follow development. There is no plan in heavy conflict resolution as these should be primarily handled on git side. Project name The project is named as mixture of words web and translate. Project website You can find project website at <https://weblate.org/>, there is also demonstration server at <https://demo.weblate. org/>. This documentation can be browsed on <https://docs.weblate.org/>. Authors This tool was written by Michal Cihaˇ rˇ <[email protected]>. 3 Weblate Documentation, Release 2.13 4 Chapter 1. About Weblate CHAPTER 2 Translators guide Weblate basics Projects structure Each project can contain various components. The reason for this structure is that all components in a project are expected to have a lot in common. Whenever translation is made in single component, it is automatically propagated to others within same project (this is especially useful when translating more version of same project, but can be disabled, see Component configuration). Registration and user profile Registration While 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 following two simple steps: