From 5105981e93ee6995e5953ab9eb6476cb3220d28f Mon Sep 17 00:00:00 2001 From: syuilo Date: Fri, 9 Nov 2018 03:54:45 +0900 Subject: [PATCH] [Doc] Update docs --- CONTRIBUTING.md | 3 --- docs/translate.en.md | 27 --------------------------- docs/translate.fr.md | 23 ----------------------- docs/translate.ja.md | 23 ----------------------- 4 files changed, 76 deletions(-) delete mode 100644 docs/translate.en.md delete mode 100644 docs/translate.fr.md delete mode 100644 docs/translate.ja.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80fe89c11..f56d271ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,6 @@ Feature suggestions and bug reports are filed in https://github.com/syuilo/missk Before creating a new issue, please search existing issues to avoid duplication. If you find the existing issue, please add your reaction or comment to the issue. -## Internationalization (i18n) -Please see [Translation guide](./docs/translate.en.md). - ## Localization (l10n) Please use [Crowdin](https://crowdin.com/project/misskey) for localization. diff --git a/docs/translate.en.md b/docs/translate.en.md deleted file mode 100644 index 3c17ebe68..000000000 --- a/docs/translate.en.md +++ /dev/null @@ -1,27 +0,0 @@ -Misskey's Translation -===================== - -If you find an untranslated part on Misskey: --------------------------------------------- - -1. Look for untranslated parts in the misskey's 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:@foo%`. - - In fact, `foo` 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 following "タイムライン" you must write: `%i18n:@timeline%`. - -3. Open the `locales/ja-JP.yml`, check whether the file name (path) found in step 1 exists, if not, create it. - - Do not put the beginning of the path `src/client/app/` in the locale file. - - 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 text property using the `foo` keyword below the path that you found or created in step 2. Make sure to type your text in quotation marks. Text should always be inside of quotes. - - For example, in this case we add timeline: `timeline: "タイムライン"` to `locales/ja-JP.yml`. - -5. When you add text to the ja-JP file (of syuilo/misskey), it will automatically be applied to all other local language files within 24-48 hours. Translations added in ja-JP file should contain the original Japanese strings (example see step 4). - -6. The new strings will automatically appear in the localized language files in the original Japanese text. After that, please go to [CrowdIn](https://crowdin.com/project/misskey) to do the localized translations in your language. - -7. And done！ - -For more details, please refer to this [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c). diff --git a/docs/translate.fr.md b/docs/translate.fr.md deleted file mode 100644 index 940055602..000000000 --- a/docs/translate.fr.md +++ /dev/null @@ -1,23 +0,0 @@ -Traduction de Misskey -===================== - -Si vous trouvez un segment non-traduit sur Misskey : ----------------------------------------------------- - -1. Veuillez chercher des parties non-traduites dans le code source de Misskey. - - Par exemple, supposons que vous trouviez un segment non-traduit dans : `src/client/app/mobile/views/pages/home.vue`. - -2. Remplacez la portion non-traduite par une chaîne de caractères de type `%i18n:@foo%`. - - En fait, `foo` doit être un mot approprié à la situation et facile à comprendre en français. - - Par exemple, si le segment non-traduit est「タイムライン」on peut écrire : `%i18n:@timeline%`. - -3. Ouvrez chaque fichier linguistique dans /locales, vérifiez si le nom du fichier (chemin) trouvé dans l'étape 1 existe, sinon créez-le. - - Ne mettez pas le début du chemin `src/client/app/` dans les fichiers /locales. - - Par exemple, dans ce cas de figure, nous voulons modifier le segment non-traduit de : `src/client/app/mobile/views/pages/home.vue`donc il faut juste écrire : `mobile/views/pages/home.vue` dans les fichiers linguistiques. - -4. Ajoutez la propriété du texte traduit grâce à la clef `foo`, en-dessous du chemin correspondant à votre modification que vous avez trouvé ou créé dans l'étape 2. À côté, veuillez indiquer entre "guillemets" la valeur de votre traduction. - - Par exemple, dans ce cas de figure, nous ajoutons la propriété et la traduction `timeline: "Timeline"` à `locales/fr.yml`, mais aussi la propriété et la version originale `timeline: "タイムライン"` à `locales/ja-JP.yml`. - -5. Vous avez réussi à traduire une portion de misskey ！ - -Pour plus de détails, veuillez vous référer à ce [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c). diff --git a/docs/translate.ja.md b/docs/translate.ja.md deleted file mode 100644 index d59dc2a4a..000000000 --- a/docs/translate.ja.md +++ /dev/null @@ -1,23 +0,0 @@ -Misskeyの翻訳 -============ - -Misskey内の未翻訳箇所を見つけたら -------------------------------- - -1. Misskeyのソースコード内から未翻訳箇所を探してください。 - - 例えば`src/client/app/mobile/views/pages/home.vue`で未翻訳箇所を見つけたとします。 - -2. 未翻訳箇所を`%i18n:@foo%`のような形式の文字列に置換してください。 - - `foo`は実際にはその場に適したわかりやすい(英語の)名前にしてください。 - - 例えば未翻訳箇所が「タイムライン」というテキストだった場合、`%i18n:@timeline%`のようにします。 - -3. `locales/ja-JP.yml`を開き、1.で見つけたファイル名(パス)のキーが存在するか確認し、無ければ作成してください。 - - パスの`src/client/app/`は省略してください。 - - 例えば、今回の例では`src/client/app/mobile/views/pages/home.vue`の未翻訳箇所を修正したいので、キーは`mobile/views/pages/home.vue`になります。 - -4. そのキーの直下に2.で置換した`foo`の部分をキーとし、テキストを値とするプロパティを追加します。 - - 例えば、今回の例で言うと`locales/ja-JP.yml`に`timeline: "タイムライン"`を追加します。 - -5. 完了です！ - -詳しくは、[このコミット](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c)などを参考にしてください。