Installing Custom Dictionaries

Brightspot comes with a US English dictionary for spell checking. You need to install a custom dictionary in the following situations:

  • You want to use non-US spelling in spell check.
  • You want to spell check in a language other than English.

In any of the above circumstances, you need to install a custom Hunspell dictionary.

  1. Download or create the Hunspell dictionary, both a .dic file and an .aff file. Give each file a base name HunspellDictionary_xx.
    • The last two letters of the base name must be a language code that Java recognizes. For a list of two-letter language codes, see Codes for the Representation of Names of Languages.
    • Example: HunspellDictionary_fr.dic and HunspellDictionary_fr.aff
    • Installing a dictionary HunspellDictionary_en replaces Brightspot’s internal US English dictionary.
  2. Place the files in /src/main/resources/.
  3. Rebuild your Brightspot project.

Brightspot uses the installed dictionary for users with the matching locale. For example, if you installed a dictionary HunspellDictionary_fr.dic, and a user’s locale is French, Brightspot spell checks the user’s text in French. If a user selects a locale for which there is no matching dictionary, Brightspot does not perform any spell checking.

See also: