The personal user dictionary can be managed via simple user interface of the Settings dialog on the Dictionary tab. It allows users to create personal dictionaries with custom words (complex words, acronyms, proper names etc.) and use them while working with the system. All the words added to a personal dictionary will not be considered as misspellings and these words will also be available in the suggestions list. The user has the ability to look through the full list of the words that have been added to this dictionary and also manage the words from a simple user interface. The words can be added either from the context menu Add word or directly on the Dictionary tab.
Dictionary preferences
By default all the words added to the personal dictionary are stored in the browser local storage on the user side. As soon as the user creates a new dictionary, all new words and the words from the browser local storage will added to this dictionary and stored on the system server. It allows the user to use this personal dictionary from the different browsers and machines (or devices) while working with the system. Thus, users are not limited by one particular browser on their side as in case with the words stored in the browser local storage.
You have an option to set a predefined User Dictionary on your web-page for a particular editable element. With such an approach all the words added using Add word by your end users will be saved and stored in the dictionary that you predefined. Just specify a necessary User Dictionary parameter and set your predefined dictionary as a value.
Product Integration | User Dictionary Parameter |
---|---|
SCAYT plugin for CKEditor 4 | |
WSC plugin for CKEditor 4 | |
SCAYT plugin for Froala Editor | userDictionaryName |
WProofreader | userDictionaryName |
The Server version of the WebSpellChecker application provides a list of options for advanced User Dictionaries administration.
All the created personal user dictionaries are saved and stored on the server where the WebSpellChecker application is installed and running. These dictionaries are saved as simple text files in *.txt format with UTF-8 encoding.
There is a list of the Web API commands available that allows administrators of the application to operate the User Dictionary functionality. The full list of Web API commands for User Dictionary can be found in the Using WebSpellChecker Server Web API#4.UserDictionaryCommand manual.
There is a special mechanism available for the User Dictionary functionality which allows working with personal user dictionaries on the environment running under a load balancer. It is aimed at synchronizing the work of the User Dictionary functionality among a number of the WebSpellChecker application servers running at the same time.
In a nutshell, with such an approach, one of the WebSpellChecker application servers should be defined as a User Dictionary Server. All personal user dictionaries created by end users will be stored only on this particular server. The rest WebSpellChecker application servers will be considered as User Dictionary Clients which will access a defined User Dictionary Server in case of any operations with User Dictionary functionality.
This approach can be easily configured in your environment. Just follow the steps-by-step instructions below.
On this step you need to appoint a User Dictionary Server role to one of the WebSpellChecker application servers. The rest application servers will be User Dictionary Clients that will be connected with the appointed User Dictionary Server. Here are steps that needs to be performed to configure a User Dictionary Server.
<Port>2881</Port> |
appserver_port = 2881 |
As soon as the User Dictionary Server is defined, the next step is configure the rest application servers that will be considered as User Dictionary Clients.
<UserDictServers> <EnableUserDictServer>true</EnableUserDictServer> <UserDictHost>127.0.0.1:2880</UserDictHost> </UserDictServers> |
Actions described in Step 2 must be performed for each copy of the WebSpellChecker application server which is working as User Dictionary Client. |
Follow the steps below to verify the work of the remote User Dictionary Server.