misskey/docs/translate.en.md

28 lines
1.6 KiB
Markdown
Raw Normal View History

Misskey's Translation - English version
============
How to add a new language?
----------------------
Please copy a language file to /locales and rename it to the name of the language you want to add and edit.
If you find an untranslated part on Misskey:
-------------------------------
1. Please look for untranslated parts from Misskey source code.
- For instance, if you find an untranslated part in: `src/client/app/mobile/views/pages/home.vue`.
2. Replace the untranslated portion with a character string of the form `%i18n:@hoge%`.
- In fact, `hoge` should be a word that is appropriate for the situation and is easy to understand in English.
- For example, if the untranslated portion is the text「タイムライン」you must write: `%i18n:@timeline%`.
3. Open each language file in /locales, check whether the <strong>file name (path)</strong> found in step 1 exists, if not, create it.
- Do not put `src/client/app/`.
- For example, in this case we want to modify untranslated parts of `src/client/app/mobile/views/pages/home.vue`, so the key is `mobile/views/pages/home.vue`.
4. Add the translated text property using the `hoge` key below the path that you found or created in step 2. Beside, please enter in quotation marks the value of your translation in each language file.
- For example, in this case we add timeline: `timeline: "Timeline"` to `locales/en.yml`, and `timeline: "タイムライン"` to `locales/ja.yml`.
5. It's done
For more details, please refer to this [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c).