For the complete documentation index, see llms.txt. This page is also available as Markdown.

Languages and dictionaries

Default language

The default language is 'auto', which detects the input language automatically. Auto-detection covers around 80 languages and requires at least three correctly spelled words.

To set a specific language for all users, use a locale code from the supported languages list:

lang: 'de_DE',

Users can change the language from the Settings dialog, but after a page reload, the admin-defined default is restored (unless options storage is enabled for lang).

Language auto-detection priorities

When lang is set to 'auto', the detected language maps to a default dialect. To override which dialect is used for a detected language:

autoLangPriorities: {
  en: 'en_GB',
  fr: 'fr_CA'
},

In this example, when auto-detection identifies English, it uses British English instead of the default American English.

UI localization

The WProofreader interface defaults to English (localization: 'en'). To change it:

localization: 'de',

To auto-detect the localization language from browser settings:

detectLocalizationLanguage: true,

If auto-detection fails, the value in localization (or the default) is used as a fallback.

User dictionary

To assign a shared user dictionary for all users:

All words added by users via the Add word command go to this dictionary. If your app has authentication, you can assign different dictionaries per user.

To prevent users from creating, renaming, or deleting dictionaries while still allowing them to add and remove words, combine it with:

Organization dictionary

To connect organization dictionaries by their IDs (comma-separated):

For the Cloud version, dictionary IDs are assigned automatically when you create a dictionary on the Custom dictionary page in the admin panel. For self-hosted, you assign dictionary IDs manually. For details, refer to the Organization dictionary overview.

Last updated

Was this helpful?