Page History

2. User

Dictionaries UI Overview

2.1.

 Accessing Personal User Dictionaries and Adding New Words in WProofreader

To access personal user dictionaries: 

1. Locate the orange badge in the lower-right corner of your web application with integrated WProofreader and hover your mouse over it.

2. In the menu which appears, click a button with gears. 

3. In the WProofreader dialog which opens, navigate to the  the WProofreader Settings > Dictionaries options group. 

Image Added

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

Accessing Personal User Dictionaries and Adding New Words in SCAYT Plugin for CKEditor 4

To add the words By default all the words added to the personal user 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.

in SCAYT plugin for CKEditor 4:

1. Click the Check Spell as You Type button on the toolbar and then click Dictionaries.

2. In the SCAYT dialog which opens, click the Dictionaries tab. 

3. Type the new dictionary name and click either Create button to create a brand new dictionary or click Dictionary Preferences, and then click Connect to connect with already existing server user dictionary. 
   Now all new words are added to the server personal user dictionary which is shared between the web application users or new words are added to the already existing predefined dictionary.

Image Added

3. Using Predefined User Dictionary in Web Application

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.

<script> window.WEBSPELLCHECKERCONFIG = 
			{ .... userDictionaryName: ‘predefineduser_dictionary’

			}; 
</script>

<script>
    window.WEBSPELLCHECKER_CONFIG = {
        ....
		userDictionaryName: ‘predefined_user_dictionary’,
		disableDictionariesPreferences: true,
		...
   };
</script>

4. Administrate User Dictionary on Server

The Server version of the WebSpellChecker application provides a list of options for advanced User Dictionaries administration. 

4.1. Location of User Dictionaries on Server

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. 

4.2. User Dictionaries Web API Commands 

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.

5.

Set up User Dictionary on a Remote Server 

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 step-by-step instructions below.

Step 1.  Define and Configure User Dictionary Server

On this step you need to appoint assign 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 assigned User Dictionary Server. Here are steps that needs need to be performed to configure a User Dictionary Server.

Stage 1: Edit in AppServerX.xml file to specify a unique port number for a personal user dictionary server.

To do so:

1. Stop AppServer before editing the AppServerX.xml file. To do so, refer to Main AppServer Commands guide, Stop AppServer section.

2. Open <WebSpellChecker_Installation_Path>/AppServer/AppServerX.xml of the WebSpellChecker application server that will be used as a User Dictionary Server address.

3. Locate the <Port> tag and change the default port value to any available (e.g.

2882) as shown below.

<Port>2882</Port>

4. Start AppServer. To do so, refer to Main AppServer Commands guide, Start AppServer section.

Stage 2:  Edit the ssrv.ini file. To do so:

1. Open the <WebSpellChecker_Installation_Path>/WebComponents/WebInterface/script/ssrv.ini file.

2. Locate appserver_port parameter and change the default port value to

2882 (the same as on the previous step). 

appserver_port = 2881

• As soon as the modifications are completed, you are required to restart the WebSpellChecker application server (AppServer) for the changes to take effect.

288

3. Restart your web or Java application server after the changes made to the ssrv.ini file

.

Step 2. Configure User Dictionary Clients

As soon as the User Dictionary Server is defined, the next step is configure other application servers that will be considered as User Dictionary Clients.

• Stop AppServer before editing the AppServerX.xml file. To do so, refer to Main AppServer Commands guide, Stop AppServer section.
• Open <WebSpellChecker_Installation_Path>/AppServer/AppServerX.xml of each application server that should work as a User Dictionary Client.
• Locate the <UserDictServers> tag.
• In the tag, set the <EnableUserDictServer> tag value as true and specify the default <UserDictHost> tag providing an IP a host address and port number of a designated User Dictionary Server.

<UserDictServers>
	<EnableUserDictServer>true</EnableUserDictServer>
    <UserDictHost>127.0.0.1:2880<2882</UserDictHost>
</UserDictServers>

• As soon as the modifications are completed, restart the WebSpellChecker application server (AppServer) for the changes to take effect.

•  For details, refer to Main AppServer Commands guide, Start AppServer section.

Step 3. Verify Work of Remote User Dictionary

Follow the steps below to verify the work of the remote User Dictionary Server.

• Go to WebSpellChecker Samples shipped with the installation package: http(s)://your_host_name:port_number/wscservice/samples/
• Open any demo sample, e.g. SCAYT for Content Editable tagsWProofreader for Rich Text Editors, for example, CKEditor 4 with Proofreader.
• Create a sample user dictionary. Open the SCAYT context menu and go to Settings –> Dictionaries tab –> Dictionary Preferences –> Create a new user dictionary named “Test”dictionary and add some words to this dictionary. To do so:  
  • Locate the orange badge in the lower-right corner of your web application with integrated WProofreader and hover your mouse over it.
  • In the menu which appears, click an icon with gears.
  • In the WProofreader dialog which opens, navigate to the Dictionaries options area, type a new dictionary name, for example, “Test” and click Create.
  • In the Add new word area, type some words to be added to this newly created personal user dictionary and either press Enter or click theAdd word button.
• Go to User Dictionaries folder (UserDictionaries) of each copy of the WebSpellChecker application server that is configured as a User Dictionary Client. This folder shouldn't contain a newly created user dictionary named “Test” .  Excerpt IncludeIN:_include_wsc500_user_dictionary_folderIN:_include_wsc500_user_dictionary_foldernopaneltrue
Go to User Dictionary folder (UserDictionaries) of the WebSpellChecker application server which is set as User Dictionary Server. This UserDictionaries folder must contain the newly created dictionary named “Test”. Moreover, you may add several words to this user dictionary via user interface and after that verify that those words are recorded in the saved user dictionary “Test”.
• and words you have added to it.