00f431c50e
- add german translation (following the changes in https://github.com/maplibre/maputnik/pull/929) - using an alphabecial order for the languages - update the documentation with a step-by-step guide - add myself as a helping person for german - move the helping-users list to the implementation of new features - update CHANGELOG.md - add a link to the l18n README in the root README 
2.2 KiB
Internationalization
The process of internationlization is pretty straight forward for Maputnik.
Add a new language
1. Edit configuration
In order to add a new translation you'll need to add it to the configuration files. Please put it in alphabetical order.
- Open /i18next-parser.config.ts and add the ISO Code of your language to the
localesarray. - Now, open /src/i18n.ts and add the ISO Code and localized name to the supported languages.
2. Add the localized strings
Refresh the localization to generate a new directory under /src/locales/ for your new language.
npm install
npm run i18n:refresh
Replace every __STRING_NOT_TRANSLATED__ value in the newly generated translation.json file with the according translation.
Make sure all the keys are translated.
3. Test your new locale
Finally, test your language locally by starting a local instance of Maputnik.
npm run start
Consider adding your name as a helping person for the translation of new features.
Add localization for a new feature
If you happen to add a feature which needs some text to be translated, update the translation files. After running, check your working copy for files and add/correct as needed.
npm run i18n:refresh
The following users can help you with the relevant languages:
| ISO Code | Language | User |
|---|---|---|
| de | German | @josxha |
| en | English | @HarelM |
| fr | French | @lhapaipai |
| hr | Hebrew | @HarelM |
| ja | Japanese | @keichan34 |
| zh | Simplified Chinese | @jieme |
You can test the UI in different languages using the dropdown in the top menu Note that Maputnik automatically localize based on browser language settings and stores this language in local storage. You can use incognito mode to check a first time usage.