Übersetzen

Dieser Leitfaden erklärt, wie Du zur Übersetzung des Subway Builder Modded Wikis beitragen kannst. Übersetzer sind dafür verantwortlich, dass ihr Beitrag präsize, klar und übereinstimmend mit dem Original bleibt. Alle Beiträge müssen sich an die richtige Grammatik halten, die Formatierung beibehalten und via Pull Request (PR) zur Überprüfung eingereicht werden.

Inhalt

1. Zu einer bestehenden Sprache beitragen
2. Eine neue Sprache anlegen
3. MDX & i18n Leitfaden für Übersetzer
4. Sprachspezifische Anmerkungen
5. Wichtige Anmerkungen
6. Aktualisieren von Übersetzungen

---

important

In diesem Leitfaden bezieht sich DEIN_LOCALE_CODE auf die Sprache, die Du bearbeitest. Beispielsweise wäre das de für Deutsch, oder en für Englisch. Eine Liste mit allen Codes gibt es hier.

Zu einer bestehenden Sprache beitragen

Wenn Du zu einer Übersetzung beitragen willst, die in diesem Projekt schon existiert:

1. Navigiere zum entsprechenden Ordner Deiner Sprache in i18n/YOUR_LOCALE_CODE. Beispielsweise befinden sich die deutschen Übersetzungen in i18n/de-DE.

2. Du bist verantwortlich für alle Dateien in dem Ordner, einschließlich aber nicht nur:

• code.json
• tags.yml
• Sämtliche andere .json oder .yml Dateien

3. Stelle sicher, dass jeder Text richtig übersetzt wird und die Formatierung dabei intakt bleibt. (Überschriften, Listen, Codeblöcke, Anmerkungen, Tips, Warnungen und Bilder).

4. PR Anforderungen:

• Jede PR, die jemand mit dem Tag needs-translating zusammenlegt, muss in Deine Sprache übersetzt werden.
• Übersetzungs-PRs müssen mit dem Prefix [Translation - DEIN_LOCALE_CODE] beginnen.

5. Reiche deine Änderunge via Pull Request ein. Ein Wikiinstandhalter wird deine Einreichung vor der Übernahme überprüfen.

---

Eine neue Sprache anlegen

Wenn Du eine komplett neue Sprache hinzufügen möchtest:

Schritt 1 - Richte Dein Locale ein

1. Öffne docusaurus.config.js.

2. Füge Deine Spache im Abschnitt localeConfigs hinzu. Beispiel für Italienisch:

locales: ['en', 'es', 'fr', 'it'],
localeConfigs: {
  en: {
    label: 'English',
    htmlLang: 'en-US',
  },
  es: {
    label: 'Español',
    htmlLang: 'es-ES',
  },
  fr: {
    label: 'Français',
    htmlLang: 'fr-FR',
  },
  it: {
    label: 'Italiano',
    htmlLang: 'it-IT',
  },
},

important

Wenn Du einen regionalen Dialekt einer bereits vorhandenen Sprache benutzt (wie bei Chinesisch mit zh-CN und zh-TW), nutze lieber diese Bezeichnungen anstelle eines Codes aus zwei Buchstaben wie fr. Beispiel:

locales: ['en', 'es', 'zh-CN', 'zh-TW'],
localeConfigs: {
  en: {
    label: 'English',
    htmlLang: 'en-US',
  },
  es: {
    label: 'Español',
    htmlLang: 'es-ES',
  },
  zh-CN: {
    label: '中文（简体）',
    htmlLang: 'zh-CN',
  },
  zh-TW: {
    label: '中文（繁體）',
    htmlLang: 'zh-TW',
  },
},

3. Datei speichern.

Schritt 2 - Erstelle Ordner für die Übersetzung

Führe den folgenden Befehl aus um die Struktur zu erzeugen:

npx docusaurus write-translations --locale DEIN_LOCALE_CODE

Schritt 3 - Organisiere deinen Arbeitsplatz

1. In docusaurus-plugin-content-docs und docusaurus-plugin-content-modding-docserstellst Du den Ordner current.

2. Kopiere alle Dateien aus docs/ und modding-docs/ in current.

3. Starte mit dem Übersetzen dieser Dateien. Behalte die ursprüngliche Formatierung bei, einschließlich:

• Überschriften
• Listen
• Codeblöcke
• Anmerkungen (:::note)
• Tips (:::tip)
• Wichtige Warnungen (:::important)
• Bilder und Bildbeschreibungen

4. Übersetze alle anderen Dateien im Verzeichnis, wie code.json und tags.yml.

5. Denk daran, dass Links, Seiten-IDs, Namen und Bildverweise nicht übersetzt werden dürfen.

Schritt 4 - Reiche deine PR ein

• Wenn alle Dateien übersetzt sind, starte eine Pull Request.
• Ein Wikiinstandhalter wird deine Übersetzung vor der Übernahme prüfen.
• Denk daran, dass Du für alles im Ordner Deiner Sprache verantwortlich bist.
• Stell sicher, dass alle Übersetzungen präsize, klar und übereinstimmend mit dem Original bleiben.
• PRs für Übersetzungen müssen mit [Translation - YOUR_LOCALE_CODE] starten.

---

MDX & i18n Leitfaden für Übersetzer

Docusaurus nutzt i18n um Übersetzungen zu verwalten und unser Wiki nutzt MDX für die Formatierung. Übersetzer müssen beides verstehen und beherrschen.

Hauptverantwortlichkeiten

• Übersetze sämtliche Textinhalte in Deinem Sprachordner, einschließlich code.json, tags.yml, .mdx Dateien und alle Metadaten.
• Behalte sämtliche MDX Fortmatierung bei:
  • Seiten Header (id und title) müssen unverändert bleiben, außer für übersetzte Titel.
  • Listen, Überschriften, Codeblöcke und Blockzitate müssen konsequent bleiben.
  • Hinweise (Anmerkungen, Tips, wichtige Warnungen):

:::note

Dies ist eine Anmerkung. Du kannst den Text darin übersetzen.

:::

• Bilder und Bildbeschreibungen: Übersetze keine Dateinamen oder Bezeichnugen, die sich auf solche beziehen.
• Seiten IDs, Links und Dateiverweise dürfen nicht übersetzt werden.
• Halte Dich an korrekte Grammatik und Rechtschreibung für Deine Sprache.
• Alle Überschriften sollten Statisch sein. Das Bedeutet, dass Du anstelle von ### Responsibilitieslieber ### Responsibilities {#responsibilities} (Auf Groß-/Kleinschreibung achten) benutzen solltest. Die Namen der Überschriften können übersetzt werden, der statische Anker nicht.

MDX Beispiel

---
id: example-page
title: Beispielseite
---

## Überschrift \{#heading}

Textinhalte hier.

:::tip

Hier steht ein Tip für den Leser.

:::

• Sämtliche Texte in MDX-Inhalten können übersetzt werden, einschließlich Hinweise, Listen und Absätze.
• Übersetze nichts innerhalb von Codeblöcken, Dateinamen, Links oder IDs.

---

Sprachspezifische Anmerkungen

Hier sind die Anforderungen für alle derzeit unterstützten Sprachen:

• Spanisch (es-ES)

  • Nutze standardeuropäische Rechtschreibung und Grammatik.
  • Vermeide lateinamerikanische Ausdrücke.
  • Stelle sicher, dass Akzente und Sonderzeichen (ñ, á, é, í, ó, ú) richtig sind.

• Katalanisch (ca-ES)

  • Nutze Standardkatalanische Rechtschreibung und Grammatik.
  • Behalte richtige Akzente und diakritische Zeichen bei (à, ç, é, è, í, ï, ó, ò, ú, ü).
  • Vermeide das Vermischen mit spanischen Ausdrücken, behalte den Satzbau natürlich für katalanische Leser.

• Französisch (fr-FR)

  • Nutze formelle Sprache, vermeide zu umgangssprachliche Ausdrücke.
  • Beachte geschlechtsspezifische Wörter und Übereinstimmung.

• Deutsch (de-DE)

  • Nutze Hochdeutsch.
  • Behalte die Großschreibung von Nomen bei.
  • Komposita müssen korrekt verbunden werden.

• Italian (it-IT)

  • Nutze standarditalienische Rechtschreibung.
  • Behalte den korrekten Nutzen von Akzenten bei.
  • Bleib bei konsequent formeller Sprache.

• Dänisch (da-DK)

  • Nutze standarddänische Rechtschreibung und Grammatik.
  • Beachte Sonderzeichen (æ, ø, å).

• Schwedisch (sv-SE)

  • Nutze normales Schwedisch, achte auf Komposita.
  • Achte auf richtige Akzente und Sonderzeichen (å, ä, ö).

• Norwegisch (nb-NO)

  • Nutze Bokmål (not Nynorsk), außer explizit anders verlangt.
  • Achte auf korrekte Sonderzeichen (æ, ø, å).

• Mandarin (zh-CN)

  • Nutze vereinfachtes Chinesisch.
  • Stelle sicher, dass Zeichensetzung den chinesischen Vorgaben entspricht.

---

Wichtige Anmerkungen

• Pull Requests notwendig: Alle Übersetzungen müssen via PR eingereicht und durch einen Wikiinstandhalter überprüft werden.
• PR Benennung: Übersetzungs-PRs müssen mit [Translation - DEIN_LOCALE_CODE] beginnen.
• Needs-Translating Tag: Sämtliche PR mit dem needs-translating Tag müssen von Mithelfern übersetzt werden.
• Formatierung ist wichtig: Behalte Codeblöcke, Anmerkungen, Überschriften, Listen und Bildreferenzen genau wie in den Originaldateien bei.
• Verantwortung: Übersetzer sind verantwortlich für die korrekte und vollständige Übersetzung ihres Sprachordners.
• Einschränkungen von Updates: Automatische Updates von Docusaurus können nicht übersetzt werden. Fokussiere Dich auf die manuelle Übersetzung der Inhalte.

---

Aktualisieren und Übersetzungen

1. Synchronisiere die neuesten Änderungen aus dem Hauptverzeichnis (main brach).

2. Überprüfe neue oder überarbeitete Dateien in docs/ und modding-docs/.

3. Übersetze neue Inhalte in deinem Sprachordner.

4. Reiche Updates via PR ein und benutze den [Translation - DEIN_LOCALE_CODE] Präfix.

5. Wiederhole den Prüfprozess mit einem Wikiinstandhalter vor der Übernahme.