|
| 1 | +# Information for Community Translations |
| 2 | + |
| 3 | +## General overview |
| 4 | + |
| 5 | +Translating our software is handled through [weblate](https://localize.scootkit.net/engage/scnx/), a continues |
| 6 | +localization platform. |
| 7 | + |
| 8 | +To get started with contributing to translations, please create an account by singing in |
| 9 | +on [Weblate](https://localize.scootkit.net/engage/scnx/). |
| 10 | + |
| 11 | +If you only want to report issues, please either use [this form](https://scnx.app/typo) or suggest a correction to a |
| 12 | +string on weblate. |
| 13 | + |
| 14 | +## Strings and their usage |
| 15 | + |
| 16 | +Each sentence or word displayed on our platforms is added on weblate as a string. When translating, it might not be |
| 17 | +obvious where the string will appear on our platforms. Due to this, please review the string name and (if applicable) |
| 18 | +description and screenshots. |
| 19 | + |
| 20 | +## Template strings |
| 21 | + |
| 22 | +String might include "templates" that are replaced by our software when displaying the string. |
| 23 | + |
| 24 | +For example, the string "**%u** has been given **%m** money." will be displayed as "scderox has been given 200 money.". |
| 25 | +Due to this, do not translate, change or edit these parameters (bold). You can move their position in the string, but |
| 26 | +they need to be included without changing their capitalization's. Depending on the project, these template strings might have different formats. |
| 27 | + |
| 28 | +Some used formats include |
| 29 | +* `%parameterName` |
| 30 | +* `%parameterName%` |
| 31 | +* `{parameterName}` |
| 32 | +* `{{parameterName}}` |
| 33 | + |
| 34 | +Some template strings might also be marked a such in weblate, but that is not always the case, so please think twice when seeing these parameters. |
| 35 | + |
| 36 | +## Guidelines for translations |
| 37 | + |
| 38 | +Please follow the following rules when translating: |
| 39 | + |
| 40 | +* DO translate the *meaning* of a string instead of translating word-for-word. In general, it might be a good idea to |
| 41 | + rephrase the structure of the english sentence to a structure that is more widely used in your native language. |
| 42 | +* DO use your brain to translate things - always check the meaning and context of any translations you make. |
| 43 | +* If you use translating software, DO check if the translated sentence makes sense before saving the changes. |
| 44 | +* DO use the comments for clarification if if you are unsure t know how to translate a string or the context is unclear. |
| 45 | +* DO NOT post about unannounced features or strings. Keep these features confidential. |
| 46 | +* DO NOT translate strings that are part of the checkout process or include legally relevant information. |
| 47 | + |
| 48 | +Before translating in a particular project, you'll need to sign a CLA ("Contributor Agreement"). Please review this |
| 49 | +document closely as their include important information about your rights regarding your translation. The CLA is a |
| 50 | +binding legal document, and you might be asked to provide personal data to sign the document. If this is the case, your |
| 51 | +data will be processed in accordance with our [Privacy Policy](https://scootk.it/scnx-privacy). |
| 52 | + |
| 53 | +## How to use weblate |
| 54 | + |
| 55 | +We do not have capacity to provide extensive training on the use of weblate. Please |
| 56 | +use [this guide](https://docs.weblate.org/en/latest/user/translating.html) for reference. |
0 commit comments