_____________                 ___________________
| Northern.CA \               / 0.2 - 02-Aug-2001 |
 --= Presents =----------------=================--
   
                     XSpell
	 
     http://www.northern.ca/projects/xspell/

Contents:
1. Intro
2. Legal
3. Requirements
4. Installing
5. Credits

--=  Intro   =-----------------=================--
XSpell is a web forms spell checker.

It works by calling an XML-RPC service on 
a server to see if words are misspelled.

It is composed of two pieces: 
i) A browser XML-RPC client written in Javascript
that uses DOM to parse a XML response from the 
server piece.

ii) A server side PHP 4+ script that uses Useful 
inc's XML-RPC server classes to offer an XML-RPC
spell checking service.

--= How it works =-------------=================--
A person fills in a browser form text area, and hit's 
a "spell check" button.  

The contents of that text area are packaged up into 
an XML-RPC XML message call to a function called 
"XSpell.spellCheck". 

XSpell.spellCheck breaks the text block down into 
words and checks the words against a system spell 
checker dictionary, if errors are found a list of 
suggestions are compiled and returned to the user's 
browser.    

The browser then takes the user to a corrections 
window, where the user may pick from a list of 
possible corrections to the word or type over 
the mistake - if desired.

--=  Legal   =-----------------=================-- 
XSpell is governed by a modified QPL license
(http://www.opensource.org/licenses/qtpl.html).

The differences are:
i)   Northern Magic (Northern.CA) is the software 
     copyright holder.
ii)  This license shall be governed by the Laws of 
     Canada. 
iii) Disputes shall be settled by Toronto Municipal 
     Court.

Other licensing arrangements can be made through Northern 
Magic - Contact: ironstorm@users.sourceforge.net   

--=  Requirements =------------=================--
* Internet Explorer 5+

* PHP 4.05+
  http://www.php.net/
	
* Useful Inc's XML-RPC server classes 1.0b9+ 
  http://xmlrpc.usefulinc.com/

* PSpell 12.2
  http://pspell.sourceforge.net/

--=  Installing =--------------=================--
* Compile pspell, test and install pspell.

* Compile PHP with pspell support, install, restart 
  web server.

* Extract the server and client code into a public 
  directory on your web server.

* Put copies of xmlrpc.inc and xmlrpcs.inc in the same
  directory or somewhere in your PHP include path. 

* Surf to the directory with the XSpellClient.html page
  and try it out. 

--= Credits =------------------=================--
ironstorm@users.sourceforge.net (http://www.northern.ca)


  [ This document was checked with XSpell 0.2 ]