Using Different Dictionaries with Ephox EditLive! for XML

Using Different Dictionaries with Ephox EditLive! for XML
Prev	Chapter 12. Internationalization Support	Next

Introduction

Ephox EditLive! for XML can be configured to use different spell checkers so that it can be used in different countries and regions. The specification of the spell checker to use with EditLive! for XML is performed via the EditLive! for XML configuration file.

Users can also add words to the local dictionary. These customizations to the EditLive! for XML dictionary are particular to a single client as the customizations are preserved on the client. To customize the dictionary on the server please refer to the article on Creating Custom Dictionaries for EditLive! for XML.

Setting the Spell Checker for EditLive! for XML

The spell checkers for EditLive! for XML for different languages are each packaged as separate files. In order to configure EditLive! for XML to use a spell checker the program must be informed of the location of the relevant spell checking package, this occurs via the EditLive! for XML configuration. The <spellCheck> element of the EditLive! for XML configuration provides EditLive! for XML with the location of the spell checker package which it is to use. The location is specified as a URL which can be either relative or absolute.

Dictionaries for the EditLive! for XML spell checker can be found in the webfolder/redistributables/editlivexml/dictionariesfolder of your EditLive! for XML install. In order to use these dictionaries with EditLive! for XML the <spellCheck>element of the EditLive! for XML configuration should be modified to reflect the location of the dictionary to be used.

Note

The file name of the .jar file for the spell checker dictionary for use with EditLive! for XML must use all lower case letters.

Adding Words to the Local Dictionary

Users can also add words to the dictionary which are then stored locally on the client. Any words added to the local dictionary by users will persist on the client even when the dictionary is updated on the server. Words are added to the local dictionary when a user clicks the Add Word option on the spell checker.

Example

The following example demonstrates how to configure EditLive! for XML to use the United States English spell checking package as its spell checker. In this example the relevant package can be found via the URL redistributables/editlivexml/dictionaries/en_us_3_0.jar. This example is a partial EditLive! for XML configuration document.

<editLive> 
  ... 
  <spellCheck jar="redistributables/editlivexml/dictionaries/en_us_3_0.jar" /> 
  ... 
</editLive>

Available Spell Checkers

en_us_3_0.jar: English (US)
en_br_3_0.jar: English (UK)
pb_3_0.jar: Brazilian Portuguese
da_3_0.jar: Danish
du_3_0.jar: Dutch
fi_3_0.jar: Finnish
fr_3_0.jar: French - European and Canadian
ge_3_0.jar: German
it_3_0.jar: Italian
no_3_0.jar: Norwegian
po_3_0.jar: Portuguese (Iberian)
sp_3_0.jar: Spanish - European, Mexican and South American
sw_3_0.jar: Swedish

Summary

The spell checker for EditLive! for XML can be configured according to the language which you wish to use with EditLive! for XML. Each spell checker for EditLive! for XML is provided as an individual package separate from the EditLive! for XML applet package. In order to specify the spell checker to be used with EditLive! for XML the XML configuration for the relevant instance of EditLive! for XML must include a URL indicating the spell checking package in the <spellCheck>element.