1. Download spellcheck files

2. Install the spellcheck files

3. Add the spellcheck context to tomcat

1. Stop tomcat: This is important! server.xml should not be edited while Tomcat is running!
   /m1/voyager/{xxxdb}/tomcat/tsvrctl stop
2. Back up server.xml:
   cd /m1/voyager/{xxxdb}/tomcat/conf
   cp server.xml server.xml.bak
   Note: To reduce downtime, you can also edit the server.xml.bak file, then stop Tomcat, then rename the server.xml files, then restart Tomcat.
3. Edit server.xml:
   1. Copy the vwebv context in server.xml (highlighted here in yellow).
   2. Paste a copy below the vwebv context to create a new context.
   3. Make the changes indicated in red to the new context:

   
   <Context className="org.apache.catalina.core.StandardContext"
       path="/vwebv"
       cachingAllowed="true"
       charsetMapperClass="org.apache.catalina.util.CharsetMapper"
       cookies="true"
       crossContext="false"
       displayName="Voyager WebVoyage"
       docBase="/m1/voyager/xxxdb/tomcat/vwebv/context/vwebv"
           privileged="true"
           reloadable="false"
           swallowOutput="false"
           useNaming="true"
           wrapperClass="org.apache.catalina.core.StandardWrapper">
   </Context>
       
   <Context className="org.apache.catalina.core.StandardContext"
       path="/spellcheck"
       cachingAllowed="true"
       charsetMapperClass="org.apache.catalina.util.CharsetMapper"
       cookies="true"
       crossContext="false"
       displayName="Voyager WebVoyage Spellcheck"
       docBase="/m1/voyager/xxxdb/tomcat/vwebv/spellcheck"
           privileged="true"
           reloadable="false"
           swallowOutput="false"
           useNaming="true"
           wrapperClass="org.apache.catalina.core.StandardWrapper">
   </Context>
   

4. Tell apache to allow tomcat to display the new context by ading the code in red

1. Find the apache configuration files:
   cd /m1/shared/apache2/conf/ConfiguredVirtualHosts
2. Back up xxxdb_vwebv_httpd.conf:
   cp xxxdb_vwebv_httpd.conf xxxdb_vwebv_httpd.conf.bak
3. Back up xxxdb.jkmounts.conf:
   cp xxxdb.jkmounts.conf xxxdb.jkmounts.conf.bak
4. Edit xxxdb_vwebv_httpd.conf thusly:

Alias /vwebv/ui/ "/m1/voyager/xxxdb/tomcat/vwebv/context/vwebv/ui/"
Alias /spellcheck/ "/m1/voyager/xxxdb/tomcat/vwebv/spellcheck/"

5. Edit xxxdb.jkmounts.conf by adding the following line to the bottom of the list:

   JkMount /vwebv/vwe* ajp13_lb_xxxdb_vwebv
   JkMount /spellcheck* ajp13_lb_xxxdb_vwebv

6. Don't forget to change xxxdb to your database name.
7. Restart Apache server /etc/init.d/httpd2 stop; /etc/init.d/httpd2 start
8. Start Tomcat server /m1/voyager/{xxxdb}/tomcat/tsvrctl start

6. Configure WebVoyage to use the spellchecker by adding the code in red in the designated files:

1. In /m1/voyager/{xxxdb}/tomcat/vwebv/context/vwebv/ui/{skin}/xsl/userTextConfigs/pageProperties.xml, make the following changes (I have it all on one line in our file, but it runs off the page in printing, so it is split over 4 lines in the instructions):

<pageMsg errorCode="searchResults.noHits">Search resulted in no hits.
<span id='spellcheck_message'></span>
<span id="close_box" onclick="hide_spelling()">X</span>
<script type='text/javascript'>spellcheck();</script>
</pageMsg>

2. In /m1/voyager/{xxxdb}/tomcat/vwebv/context/vwebv/ui/{skin}/xsl/pageTools/frameWork.xsl, make the following changes: (This will load the JavaScript only if a search page is hit.)

<script type="text/javascript" src="{$jscript-loc}ajaxUtils.js"/>
<xsl:variable name="searchPages" select="'page.searchBasic page.searchAdvanced page.searchSubject page.searchAuthor' "/>
<xsl:if test="contains($searchPages,/page:page/@nameId)">
   <script type="text/javascript" src="{$jscript-loc}spellcheck.js"/>
</xsl:if>

3. In /m1/voyager/{xxxdb}/tomcat/vwebv/context/vwebv/ui/{skin}/xsl/pageTools/tools.xsl, make the following changes: (This lets us control the noHits area with JavaScript.)

<p class="{$messageClass}" id="{$messageClass}">

4. In /m1/voyager/{xxxdb}/tomcat/vwebv/context/vwebv/ui/{skin}/css/searchPages.css, add:

p.noHitsError
{
   background:#FFFF90 none repeat scroll 0%;
   border:1px solid red;
   color:#FF0000;
   font-weight:bold;
   padding:5px;
   text-align:center;
   width:300px; 
   position:relative;
}
#close_box {position:absolute;right:1px;top:1px;border:1px solid red;cursor:pointer;}

5. Turn off your Show XML button:
   In /m1/voyager/{xxxdb}/tomcat/vwebv/context/vwebv/ui/{skin}/xsl/pageTools/frameWork.xsl, make sure debug is set to false:

   <!-- ## DEBUG ## -->
   <xsl:variable name="debugEnabled" select="'false'"/>  <!-- ## set to 'true' to enable ## -->
   

6. Test your spellchecker by doing a WebVoyage Basic Search for comonly mispelled wordz

7. Customize your dictionaries