From 098bc780b2f9c9dc7bafe55230cfdbfcb2746ea8 Mon Sep 17 00:00:00 2001 From: spessasus Date: Thu, 31 Oct 2024 18:42:07 +0100 Subject: [PATCH] update locale guide --- src/website/js/locale/locale_files/README.md | 25 +++++++++++--------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/src/website/js/locale/locale_files/README.md b/src/website/js/locale/locale_files/README.md index 62a47c9..ef85708 100644 --- a/src/website/js/locale/locale_files/README.md +++ b/src/website/js/locale/locale_files/README.md @@ -20,21 +20,24 @@ I welcome contributions from translators! To add a new locale, please follow the - Translate all the strings in the `locale.js` file and all `.js` files in the folders. Make sure to leave the object keys unchanged. - You may add comments to indicate who translated the text, e.g., `// translated by: XYZ`. - -5. **Update `locale_list.js`** + - **Note:** Strings containing placeholders, like `Channel {0}`, should keep the placeholders intact. They are used for + formatting and should not be altered. + - **Note 2:** The code sets `textContent` property, so doing HTML characters like `<` + is not needed. + For new line, use `\n` + +5. **Verify your work** + - [Minify the website](../../../../README#app) + - Change the language to the translated language. + - Test your changes in the Local Edition! + - Remember to hover over various controls to see the translated descriptions. + +6. **Update `locale_list.js`** - Open `locale_list.js`. - Add a new entry for your locale. For example, for German, add: `"de": localeGerman,`. -6. **Submit a Pull Request** +7. **Submit a Pull Request** - After completing the translation and updates, create a pull request with your changes. Thank you for helping SpessaSynth! *If you have any questions about this guide or something is unclear, let me know by opening an issue!* - - -**Note:** Strings containing placeholders, like `Channel {0}`, should keep the placeholders intact. They are used for - formatting and should not be altered. - -**Note 2:** The code sets `textContent` property, so doing HTMl characters like `<` -is not needed. -For new line, use `\n`