Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide outlines the main steps on how to exclude certain words from the dictionary by creating a special exclude dictionary. Such a dictionary is similar to the global custom dictionaries. You can find it useful when excluding certain words from any supported language dictionaries. For more details, refer to this article

Prerequisites

You can start adding and configuring excluded words after you have installed the server version of WebSpellChecker application of the WebSpellChecker application to the server.  It is not enabled in the [WebSpellChecker installation folder]/AppServer/AppServerX.xml file by default. You can enable it using the procedure described below where we excluded certain words for from the English language dictionary.  

...

  1. Navigate to the [WebSpellChecker_installation_folder]/AppServer directory. 
  2. Create a .tlx file and add the words intended for excluding to it. To do so, in the "[WebSpellChecker_installation_folder]/AppServer/LanguageDictionaries" folder, create the "en_exclude.tlx" file and add the word 'mango' to it.
    The required file format for excluding wordlists is a text file saved with *.tlx extension. 

    Note

    The required file format for excluding wordlists is a text file saved with *.tlx extension. A wordlist must be in UTF-8 format where each  word is located in a new line.


  3. Stop AppServer before editing the AppServerX.xml file.
  4. In the [WebSpellChecker_installation_folder]/AppServer directory, navigate to the AppServerX.xml file.

  5. Find the language tag with a setting with for a required language, in . In our case, this is American English. In this tag, add a new tag with the path to a newly created file (see step 2) containing the list of words for excluding in these tags

    Code Block
    languagexml
    themeEmacs
    <!-- Add words to exclude from the main dictionary.-->
    <Dictionary FullPath="LanguageDictionaries/en_exclude.tlx">


  6. Activate the exclude functionality specifying the <ForExclude>true</ForExclude> tag.

    Code Block
    languagexml
    themeEmacs
     <Language Id="en_US">
    	<Alias>en</Alias>
    	<Alias>am</Alias>
    	<GrammarCheckProviderOptions>en-US</GrammarCheckProviderOptions>
    	<ThesaurusEnabled>true</ThesaurusEnabled>
    	<SpellEngineOptions>
    		<Locale>am</Locale>
    		<SpellCheckProvider>ssce</SpellCheckProvider>
    			<Dictionary FullPath="ssceam2.clx">
    				<ForSuggest>no</ForSuggest>
    			</Dictionary>
    			<Dictionary FullPath="ssceam2s.clx">
    				<ForSuggest>yes</ForSuggest>
    			</Dictionary>
    			<Dictionary FullPath="LanguageDictionaries/en_exclude.tlx"> 	
    				<ForExclude>true</ForExclude>
    			</Dictionary>
    			<Dictionary FullPath="keywords.clx"/>
    			<Dictionary FullPath="ssceam.tlx"/>
    		</SpellEngineOptions>
    </Language>


  7. Start AppServer for the changes to take effect.
    The word 'mango' should become an excluded one: it will be considered as a misspelling and red-marked accordingly.