Modul für benutzerdefinierte Rechtschreibprüfung

Mit diesem Modul kannst du benutzerdefinierte Rechtschreibprüfungen hinzufügen, um Übersetzungen anhand bestimmter Regeln zu überprüfen, die standardmäßig nicht unterstützt werden.

Jede Sprache kann nur einer aktiven Rechtschreibprüfung zugewiesen werden. Wenn mehrere benutzerdefinierte Rechtschreibprüfungen verwendet werden, werden die für eine bestimmte Rechtschreibprüfung ausgewählten Sprachen automatisch von allen anderen Rechtschreibprüfungen getrennt. Sprachen, die keiner der benutzerdefinierten Rechtschreibprüfungen zugewiesen sind, werden von der standardmäßigen Crowdin-Rechtschreibprüfung verarbeitet.

Zugriff

Du kannst Zugriff auf dieses Modul für eine der folgenden Benutzerkategorien gewähren:

• Nur Organisationsadministratoren
• Alle Benutzer in den Projekten der Organisation
• Ausgewählte Benutzer

Struktur

manifest.json

{
  "modules": {
    "custom-spellchecker": [
      {
        "key": "custom-spellchecker",
        "name": "Custom Spellchecker",
        "description": "Description",
        "checkSpellingUrl": "/check",
        "listSupportedLanguagesUrl": "/languages",
        "url": "/setup.html"
      }
    ]
  }
}

Eigenschaften

key	Typ: string Erforderlich: ja Beschreibung: Kennung des Moduls innerhalb der Crowdin-App.
name	Typ: string Erforderlich: ja Beschreibung: Der für Menschen lesbare Name des Moduls.
description	Typ: string Beschreibung: Die für Menschen lesbare Beschreibung der Funktion des Moduls. Die Beschreibung wird in der Crowdin-Enterprise-Benutzeroberfläche angezeigt.
checkSpellingUrl	Typ: string Erforderlich: ja Beschreibung: Die relative URL, die ausgelöst wird, wenn Texte zur Rechtschreibprüfung gesendet werden.
listSupportedLanguagesUrl	Typ: string Erforderlich: ja Beschreibung: Die relative URL, die beim Abrufen der vom Modul unterstützten Sprachen ausgelöst wird.
url	Typ: string Erforderlich: ja Beschreibung: Die relative URL zur Einrichtungsseite des Moduls.
environments	Typ: string Zulässige Werte: crowdin-enterprise Beschreibung: Menge der Umgebungen, in denen ein Modul installiert werden kann. Dieser Parameter wird für produktübergreifende Anwendungen benötigt.

Kommunikation zwischen der App für die benutzerdefinierte Rechtschreibprüfung und Crowdin

Das System sendet Texte zur Rechtschreibprüfung über checkSpellingUrl, entweder aus dem Editor während der Übersetzung oder wenn die Qualitätssicherungsprüfungen Übersetzungen validieren. Die App verarbeitet die Texte und antwortet dem System mit einer von zwei möglichen Antwortarten: ohne Rechtschreibfehler und mit Rechtschreibfehlern. In einigen Fällen muss das System die vom Modul unterstützten Sprachen überprüfen (z. B. beim Konfigurieren der Sprachen für die benutzerdefinierte Rechtschreibprüfung in den Organisationseinstellungen). In diesen Fällen sendet Crowdin über listSupportedLanguagesUrl eine Anfrage an die App, und die App antwortet mit den Daten zu den von ihr unterstützten Sprachen.

Anfrage von Crowdin an die App für checkSpellingUrl

Beispiel für die Nutzlast der Anfrage:

{
  "language": "uk",
  "texts": [
    "Збререгти якк...",
    "Ноаий файд"
  ]
}

Erwartete Antwort der App (ohne Rechtschreibfehler)

Beispiel für die Nutzlast der Antwort:

{
  "data": [
    {
      "text": "Зберегти як...",
      "matches": []
    },
    {
      "text": "Новий файл",
      "matches": []
    }
  ]
}

Erwartete Antwort der App (mit Rechtschreibfehlern)

Beispiel für die Nutzlast der Antwort:

{
  "data": [
    {
      "text": "Збререгти якк...",
      "matches": [
        {
          "category": "typos",
          "message": "Знайдено потенційну орфографічну помилку.",
          "shortMessage": "Орфографічна помилка",
          "offset": 0,
          "length": 9,
          "replacements": [
            "Зберегти"
          ]
        },
        {
          "category": "typos",
          "message": "Знайдено потенційну орфографічну помилку.",
          "shortMessage": "Орфографічна помилка",
          "offset": 10,
          "length": 3,
          "replacements": [
            "як"
          ]
        }
      ]
    },
    {
      "text": "Ноаий файд",
      "matches": [
        {
          "category": "typos",
          "message": "Знайдено потенційну орфографічну помилку.",
          "shortMessage": "Орфографічна помилка",
          "offset": 0,
          "length": 5,
          "replacements": [
            "Новий"
          ]
        },
        {
          "category": "typos",
          "message": "Знайдено потенційну орфографічну помилку.",
          "shortMessage": "Орфографічна помилка",
          "offset": 6,
          "length": 4,
          "replacements": [
            "файл"
          ]
        }
      ]
    }
  ]
}

Erwartete Kategorietypen:

• typography
• casing
• grammar
• typos
• spelling
• punctuation
• confused_words
• redundancy
• style
• gender_neutrality
• semantics
• colloquialisms
• wikipedia
• barbarism
• misc

Antwort der App an Crowdin für listSupportedLanguagesUrl

Beispiel für die Nutzlast der Antwort:

{
  "data": [
    {
      "code": "uk",
      "name": "Ukrainian"
    },
    {
      "code": "kab",
      "name": "Kabul"
    },
    {
      "code": "en",
      "name": "English"
    }
  ]
}

Die Struktur der Antworten der App muss den dargestellten Beispielen entsprechen. Andernfalls betrachtet Crowdin sie als ungültig.

Sprachen, die in der Organisation nicht verfügbar sind, werden in der Sprachenliste des Moduls nicht angezeigt. Um solche Sprachen anzuzeigen, füge sie als benutzerdefinierte Sprachen hinzu.

Weitere Informationen findest du unter Benutzerdefinierte Sprachen.