From 74083805608bb6a96da680ee59a622600a2f3ae8 Mon Sep 17 00:00:00 2001 From: kolaente Date: Thu, 24 Jun 2021 00:14:29 +0200 Subject: [PATCH] Add translation docs --- .../translation-instructions-german.md | 53 ++++++++++++++++++ docs/content/doc/development/translations.md | 54 +++++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 docs/content/doc/development/translation-instructions-german.md create mode 100644 docs/content/doc/development/translations.md diff --git a/docs/content/doc/development/translation-instructions-german.md b/docs/content/doc/development/translation-instructions-german.md new file mode 100644 index 0000000000..0a347cd894 --- /dev/null +++ b/docs/content/doc/development/translation-instructions-german.md @@ -0,0 +1,53 @@ +--- +title: "German Translation Instructions" +date: 2021-06-23T23:47:34+02:00 +draft: false +--- + +# German Translation Instructions + +
+NOTE: This document contains translation instructions specific to the german translation of Vikunja. +For instructions applicable to all languages, check out the }}">general translation instructions. +
+ +{{< table_of_contents >}} + +## Allgemein + +Anrede: Wenig förmlich: + +* “Du”-Form +* Keine “Amtsdeusch“-Umschreibungen, einfach so als ob man den Nutzer direkt persönlich ansprechen würde + +Genauer definiert: + +* “falsch” anstatt “nicht korrekt/inkorrekt” +* “Wende dich an …” anstatt “kontaktiere …” +* In derselben Zeit übersetzen (sonst wird aus dem englischen “is“ das deutsche “war”) +* Richtige Anführungszeichen verwenden. Also „“ statt '' oder ' oder ` oder ´ + * `„` für beginnende Anführungszeichen, `“` für schließende Anführungszeichen + +Es gelten Artikel und Worttrennungen aus dem [Duden](https://duden.de). + +## Gendern + +Wo möglich, sollte eine geschlechtsneutrale Anrede verwendet werden. +Falls diese sehr umständlich würden (siehe oben „Amtsdeutsch-Umschreibungen“), soll mit *Doppelpunkt* gegendert werden. + +Beispiel: „Benutzer:in“ + +## Formulierungen in Modals und Buttons + +Es sollten die gleichen Formulierungen auf Buttons und Modals verwendet werden. + +Beispiel: Wenn der Button mit `löschen` beschriftet ist, sollte im Modal die Frage lauten `Willst du das wirklich löschen?` und nicht `Willst du das wirklich entfernen?`. +Gleiches gilt für Erfolgs/Fehlermeldungen nach der Aktion. + +## Trennungen + +* E-Mail-Adresse (siehe Duden) + +## Weiterführende Links + +* http://docs.translatehouse.org/projects/localization-guide/en/latest/guide/translation_guidelines_german.html diff --git a/docs/content/doc/development/translations.md b/docs/content/doc/development/translations.md new file mode 100644 index 0000000000..36cf0a4e27 --- /dev/null +++ b/docs/content/doc/development/translations.md @@ -0,0 +1,54 @@ +--- +title: "Translations" +date: 2021-06-23T22:52:06+02:00 +draft: false +menu: + sidebar: + parent: "development" +--- + +# Translations + +This document provides documentation about how to translate Vikunja. + +{{< table_of_contents >}} + +## Where to translate + +Translation happen at [weblate](https://hosted.weblate.org/projects/vikunja/frontend/). + +Currently, only the frontend (and by extension, the desktop app) is translatable. + +## Translation Instructions + +> These are the instructions for translating Vikunja in another language. +> For information about how to add new translation strings, see below. + +For all languages these translation guidelines should be applied when translating: + +* Use a less-formal style, as if you were talking to a friend. +* If the source string contains characters like `&` or `…`, the translated string should contain them as well. + +More specific instructions for some languages can be found below. + +### Wrong translation strings + +If you encounter a wrong original translation string while translating, please don't correct it in the translation. +Instead, translate it to reflect the original meaning in the translated string but add a comment under the source string to discuss potential changes. + +### Language-specific instructions + +* [German]({{< ref "./translation-instructions-german.md">}}) + +## How to add new translation strings + +All translation strings are stored in `src/i18n/lang/`. +New strings should be added only in the `en.json` file. +Strings in other languages will be synced through weblate and should not be added directly as a PR/commit in the frontend repo. + +## Requesting a new language + +If you want to start translating Vikunja in a language not yet available in Vikunja, please request the language through the weblate interface. +If you have issues with this or need a discussion before doing so, pleace [contact us](https://vikunja.io/contact/) or [start a discussion in the forum](https://community.vikunja.io). + +Once at least 50% of all translation strings are translated and approved, they will be added and distributed with the Vikunja frontend for users to select and use Vikunja with them.