Topdata Topdata Docs

TopdataMachineTranslationsSW6 v1.2.0

Dies ist eine ältere Version des Handbuchs. Neueste Version anzeigen

Systemanforderungen

  • Shopware 6.4+
  • PHP 8.0+
  • MySQL/MariaDB 10.3+
  • 500 MB freier Festplattenspeicher für Backups
  • Netzwerkzugriff auf api-free.deepl.com

Installationsschritte

  1. Plugin installieren
bin/console plugin:refresh
bin/console plugin:install --activate TopdataMachineTranslationsSW6
  1. DeepL API-Key konfigurieren

Dauerhafte Konfiguration (empfohlen):

# Zur Umgebungskonfiguration hinzufügen (z.B. .env)
DEEPL_FREE_API_KEY=Ihr-API-Key-hier

Temporäre Verwendung:

DEEPL_FREE_API_KEY=Ihr-Key-hier bin/console topdata:translate [...]
  1. Installation überprüfen
bin/console topdata:translate --list-languages

Nach der Installation

  • Backup-Verzeichnis: /tmp/database-backups (über Plugin-Einstellungen konfigurierbar)
  • Empfehlung für Erstinstallation: --table-Option zum Testen einzelner Tabellen verwenden

Umgebungsvariablen

DEEPL_FREE_API_KEY

  • Erforderlich: Ja
  • Beschreibung: DeepL API-Authentifizierungsschlüssel
  • Format: Zeichenkette
  • Beispiel: export DEEPL_FREE_API_KEY=Ihr-Key-hier

Befehlsoptionen

--table

  • Typ: Mehrfachangaben möglich
  • Beschreibung: Spezifische zu übersetzende Tabellen
  • Beispiel: --table=product_translation --table=category_translation

--from

  • Standard: de-DE
  • Beschreibung: Quellsprache (4-stelliger Code)
  • Unterstützte Formate: xx-XX oder xx

--to

  • Standard: cs-CZ
  • Beschreibung: Zielsprache (4-stelliger Code)
  • Hinweis: Wird automatisch in 2-stelliges Format für DeepL API konvertiert

--no-backup

  • Typ: Flag
  • Beschreibung: Deaktiviert automatische Backups
  • Risiko: In Produktivumgebungen nicht empfohlen

Backup-Einstellungen

  • Speicherort: /tmp/database-backups
  • Aufbewahrung: Manuelle Bereinigung erforderlich
  • Format: SQL-Dump pro Tabelle mit Zeitstempel

Übersetzungseinstellungen

  • Ausgenommene Spalten:
    • Felder mit Endung _id oder _config
    • created_at/updated_at Zeitstempel
  • Batch-Größe: Einzelne Zeilenverarbeitung
  • Fehlerbehandlung: Überspringt fehlgeschlagene Übersetzungen, setzt mit nächster Spalte fort

Konfigurations-XML Übersetzungsbefehl

Der Befehl topdata:machine-translations:translate-config-xml übersetzt Konfigurations-XML-Dateien mit dem DeepL-Übersetzungsdienst. Dieser Befehl wurde entwickelt, um bestimmte Textelemente in Shopware 6 Konfigurations-XML-Dateien automatisch in verschiedene Zielsprachen zu übersetzen.

Zweck

Dieser Befehl verarbeitet Shopware 6 Konfigurations-XML-Dateien und übersetzt übersetzbare Textelemente in die angegebenen Zielsprachen. Er unterstützt die Übersetzung von:

  • <title> Elementen
  • <label> Elementen
  • <helpText> Elementen
  • <resetOption> Elementen

Voraussetzungen

Bevor Sie diesen Befehl verwenden, stellen Sie sicher:

  • DeepL API-Schlüssel ist als DEEPL_FREE_API_KEY Umgebungsvariable konfiguriert
  • Die XML-Datei existiert und ist gültig
  • Quell- und Zielsprachcodes sind korrekt formatiert (z.B. de-DE, cs-CZ, en-GB)

Verwendung

bin/console topdata:machine-translations:translate-config-xml <datei> --from=<quelle> --to=<ziel1> [--to=<ziel2> ...] [optionen]

Argumente

ArgumentErforderlichBeschreibung
fileJaPfad zur zu übersetzenden XML-Datei

Optionen

OptionKurzformErforderlichBeschreibung
--from-fJaQuellsprachcode (z.B. de-DE)
--to-tJaZielsprachcode(n). Kann mehrfach angegeben werden (z.B. --to=cs-CZ --to=sk-SK)
--force-NeinÜbersetzung erzwingen, auch wenn Übersetzung bereits existiert
--no-backup-NeinKeine Sicherungskopie der Originaldatei erstellen

Beispiele

Grundlegende Übersetzung

Eine deutsche Konfigurationsdatei ins Tschechische übersetzen:

bin/console topdata:machine-translations:translate-config-xml config.xml --from=de-DE --to=cs-CZ

Mehrere Zielsprachen

Auf einmal in mehrere Sprachen übersetzen:

bin/console topdata:machine-translations:translate-config-xml config.xml --from=de-DE --to=cs-CZ --to=sk-SK --to=en-GB

Bestehende Übersetzungen überschreiben

Bestehende Übersetzungen für angegebene Sprachen überschreiben:

bin/console topdata:machine-translations:translate-config-xml config.xml --from=de-DE --to=cs-CZ --force

Ohne Sicherungskopie

Ohne Erstellung einer Sicherungsdatei übersetzen:

bin/console topdata:machine-translations:translate-config-xml config.xml --from=de-DE --to=cs-CZ --no-backup

Verhaltensdetails

Sicherungskopie-Erstellung

Standardmäßig erstellt der Befehl eine Sicherungskopie der Originaldatei vor Änderungen. Die Sicherungsdatei folgt dem Muster:

<dateiname>.backup.JJJJ-MM-TT_HH-MM-SS

Übersetzungslogik

  1. Quelltext-Erkennung: Der Befehl sucht zuerst nach untergeordneten <text> Elementen mit der angegebenen Quellsprache (--from). Falls keine gefunden werden, wird der Textinhalt des übergeordneten Elements verwendet.
  2. Bestehende Übersetzungsprüfung: Vor der Übersetzung wird geprüft, ob bereits eine Übersetzung für die Zielsprache existiert. Bestehende Übersetzungen werden übersprungen.