Versions Compared

Key

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

The suggestion prioritization mechanism is designed to allow the admins to influence and change the default behavior of how the corrections are generated and showed shown to end users. Using this mechanism, the admins can create a list of rules which will be used during the process of generating corrections.

...

  • Common spelling errors (e.g. “teh” –> “the”)
  • Synonyms and alternatives

Rules

...

categories

There is a list of main categories that can be used to create your custom rules for the suggestion prioritization.

Category
Name
nameDescription
ANY_POSITIONAny position in a word
WORD_INITIALThe first letter in a word
FIRST_OR_SECONDThe first or the second letter in a word
MIDDLE_OF_THE_WORDNot the first and not the last letter in a word
END_OF_THE_WORDThe last letter in a word (end of a word)
ENTIRE_WORDThe entire word

Syntax and

...

configuration File

All the rules should be written in a special *.ini configuration file. 

Configuration

...

file

The configuration file for the suggestion prioritization mechanism must match the next requirements.

...

You can have more than one configuration file with rules for different languages. Also, you can reuse a single file with rules for a list of languages which might have the same rules (e.g. English dialects).

Syntax

The syntax of the configuration file with rules for the suggestion prioritization must follow the next requirements.

...

Code Block
END_OF_THE_WORD
z s
ENTIRE_WORD
teh the

Getting

...

started

Once a new configuration file with the rules is ready and placed in the [WebSpellChecker_Installation_Folder]/AppServer/ folder. The next step is to enable the suggestion prioritization mechanism in the AppServerX.xml file.

...