This module allows you to add custom spellcheckers to verify translations against specific rules that are not supported by default.
Each language can be assigned to only one active spellchecker. When using multiple custom spellcheckers, languages selected for a specific spellchecker are automatically unassigned from all other spellcheckers. Languages not assigned to any of the custom spellcheckers will be processed by the default Crowdin spellchecker.
You can grant access to this module to one of the following user categories:
{
"custom-spellchecker": [
{
"key": "custom-spellchecker",
"name": "Custom Spellchecker",
"description": "Description",
"checkSpellingUrl": "/check",
"listSupportedLanguagesUrl": "/languages",
"url": "/setup.html"
}
]
}
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: The human-readable description of what the module does. |
checkSpellingUrl | Type: Required: yes Description: The relative URL triggered when sending texts for spell checking. |
listSupportedLanguagesUrl | Type: Required: yes Description: The relative URL triggered when retrieving the list of languages supported by the module. |
url | Type: Required: yes Description: The relative URL to the module setup page. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The system sends texts for spell checking using checkSpellingUrl either from the Editor during translation or when the QA Checks validate translations. The app then processes the texts and responds back to the system with one of the two possible types of responses: without spelling issues, and with spelling issues. There are cases when the system needs to check the languages supported by the module (e.g., when configuring languages for Custom Spellchecker in the Organization Settings). In these cases, Crowdin sends a request to the app using listSupportedLanguagesUrl and the app responds with the data about the languages it supports.
Request payload example:
{
"language": "uk",
"texts": [
"Збререгти якк...",
"Ноаий файд"
]
}
Response payload example:
{
"data": [
{
"text": "Зберегти як...",
"matches": []
},
{
"text": "Новий файл"
"matches": []
}
]
}
Response payload example:
{
"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": [
"файл"
]
}
]
}
]
}
Response payload example:
{
"data": [
{
"code": "uk",
"name": "Ukrainian"
},
{
"code": "kab",
"name": "Kabul"
},
{
"code": "en",
"name": "English"
}
]
}
The structure of the responses from the app should correspond to the presented examples, otherwise Crowdin will consider them invalid.
Languages that are not available in the organization won’t be displayed in the module’s language list. To display such languages, add them as custom languages.
Read more about Custom Languages.