Installation & Deployment

1. To use RapidSpell Web, you must add the RapidSpellWeb.jar and RapidSpellMDict.jar files to the

lib directory of your web application.

2. Register a Servlet in your web.xml file. To do this;

i) Open web.xml under /web-inf (for an example of a complete web.xml file with this, please see the RapidSpellDemo application included with this product)

ii) Add this block (if other <servlet> sections exist, add it directly below them), inside the <web-app> elements.

<servlet>

<description>Handles requests for RapidSpell Web</description>

<servlet-name>RapidSpellWebHandlerServlet</servlet-name>

<servlet-class>com.keyoti.rapidSpell.web.ControlServlet</servlet-class>

<init-param>

<param-name>licenseKey</param-name>

<param-value></param-value>

</init-param>

</servlet>

iii) Add this block below it (if other <servlet-mapping> sections exist, add it directly below them)

<servlet-mapping>

<servlet-name>RapidSpellWebHandlerServlet</servlet-name>

<url-pattern>*.rapidspellweb</url-pattern>

</servlet-mapping>

iv) Add this block below it (if other <context-param> sections exist, add it below them) - this setting is explained in the user dictionary section.

<context-param>
        <param-name>RapidSpellUserDictionaryDirs</param-name>
        <param-value>~/</param-value>
</context-param>
Please note that in some server contexts (such as WAR files that are not 'exploded' on deployment) we may not be able to automatically resolve '~/' to the application root, in this case please set the param RapidSpellBaseDir.
<context-param>
        <param-name>RapidSpellBaseDir</param-name>
        <param-value>c:\path\to\app root\</param-value>
</context-param>

v) For an example of a complete web.xml file with this, please see the demo application included with the product.

3. There are two ways to use RapidSpell Web; from Javascript or from JSP tags.

Licensing The Components

RapidSpell Web requires a license key to be set in the application, if a key is not set, the

component will only run when the application is accessed through “localhost”. Furthermore, if the

RapidSpellChecker class is used separately, it too must have a license key set (in it’s constructor).

Evaluation Keys

Time limited evaluation keys can be generated automatically at

http://keyoti.com/products/evaluation-key-generator

Purchased Keys

If you have purchased licenses, please see the accompanying file “license-keys.txt” which explains in

detail how to generate “deployment keys”.

Setting A License Key

Security And Other Configuration Settings

User Dictionary Files

Please see the user dictionary examples, for the inline and popup spell checkers, for important information on configuration.

Dict File Warnings

To prevent exceptions being reported about problems loading the Dict File (which could be a security risk as it could provide information about the existence of system files), please disable warnings when deploying to production.

1. Set a paramter called RapidSpellHideDictFileExceptions in web.xml to "true".

eg.

<?xml version="1.0" encoding="UTF-8"?>

<web-app ...>

    <context-param>
        <param-name>RapidSpellHideDictFileExceptions</param-name>
        <param-value>true</param-value>
    </context-param>

....
</web-app>

It may be necessary to restart the app. server after changing the web.xml, for it to have effect.