Speller Pages

File Release Notes and Changelog

Release Name: 0.4.1

Notes:
==========================================================================
Speller Pages 0.4.1 Installation Instructions
==========================================================================


REQUIREMENTS

    1.  GNU Aspell version 0.50.1 or greater. Available for Unix/Linux and 
        Windows from http://aspell.net. For Windows, it is recommended that
        you use the "Full Installer." Please note that to use Aspell you
        must also install at least one of the dictionaries. 

    2.  Web server capable of executing PHP scripts. 

    3.  To use Speller Pages 0.4.1, the end user needs a relatively modern Web 
        browser. Speller Pages 0.4.1 has been tested on IE 6 and Mozilla 1.3. 


INSTALLATION AND USAGE

    1.  Download spellerpages-0.4.1.tar.gz

    2.  Decompress the package and extract the files. For example:

        $ gzip -d spellerpages-0.4.1.tar.gz
        $ tar -xvf spellerpages-0.4.1.tar

    3.  Copy the "speller" directory (in spellerpages-0.4.1) to your Web 
        server's root directory. 

    4.  Choose between the PHP version of the server script and the Perl/CGI
        version. 

        PHP checklist (the default):

            -   Ensure that the "speller/server-scripts" directory on your 
                Web server is writable by the Web server's account (the PHP 
                script writes a temp file to that location). If it is 
                unnacceptable to allow write access to this directory, edit
                the $tempfiledir variable in spellchecker.php (line 10) to an 
                appropriate local directory path. 

            -   Verify the path to the aspell command in the spellchecker.php
                source (line 6). By default the $aspell_prog variable is set
                to "aspell" - which will work fine if the aspell executable
                is in your PATH. If this doesn't work, modify it to suit your 
                system's local path to aspell. 

            -   Ensure that spellchecker.php has the proper read, write and
                execute permissions for your system.

        Perl/CGI checklist:

            -   Copy "speller/server-scripts/spellchecker.pl" to your Web
                server's cgi-bin directory. Make sure spellchecker.pl is 
                executable by your Web server's account. 

            -   Modify "speller/spellChecker.js" (line 19) to point to
                spellchecker.pl's virtual path. 

            -   Verify the path to the aspell command in the spellchecker.pl
                source (line 9). By default the $aspell_cmd variable is set
                to "aspell" - which will work fine if the aspell executable
                is in your PATH. If this doesn't work, modify it to suit your 
                system's local path to aspell. 

    5.  Test the spell checker by visiting http://yoursite/speller/index.html
        (or equivelent URL). 

    6.  You can use the HTML source of "index.html" (above) as a guide for 
        integrating Speller Pages into your own application. Just perform
        the following steps on the Web page containing a textarea input to
        evaluate for spelling:

        a.  Source the spellChecker.js file, as in:

                <script src="spellChecker.js"></script>

        b.  Create a button or hyperlink to check spelling.

        c.  When the user clicks the button, create an instance of the 
            spellChecker object, passing in a reference to the textarea 
            input: 

                var speller = new spellChecker( txt );

            And then call the spellChecker object's openChecker() method:

                speller.openChecker();

            Note: version 0.4 allows for checking more than one text input. 
            To check more than one, just pass a list of text input references
            to the spellChecker object's constructor, such as:

                var speller = new spellChecker( txt1, txt2 [ , ... ] );



Changes:
ENHANCEMENTS

    [ 843522 ] Perl/CGI version for 0.4

               This release includes a Perl/CGI version of the
               server script. Everything else is identical to
               version 0.4 (besides the one bug fix).

BUG FIXES

    [ 844161 ] Speller Pages 0.4 not working on Mac

               An issue was caused with 0.4 that caused Speller
               Pages to break when run in a browser on Mac
               platforms. A workaround is available (see notes
               in bug 844161) but it's fixed in this release.

KNOWN ISSUES

    [ 805832 ] Double-byte characters not handled. 

    [ 839285 ] Open smart quotation breaks Speller Pages.