
ZapSpell - Spelling for Zap
---------------------------

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

(The GPL is supplied as !ZapSpell.Copying. Source should be available from
wherever you got ZapSpell or Zap; if you have difficulty, get in touch with
the maintainer, below.)


Features
--------

The module provides an interface between Zap and the 'Impress'n Spell'
spell-checking module (supplied).  It provides spell-checking of entire files 
and selections, and can also perform spell checking dynamically, as you type. 
It offers an interface using throwback of misspelled words and a misspelled
word dialogue.


Operation
---------

The front end may be activated by the SPELL command.  This brings up a window
which has a number of action buttons on it.

The top of the window shows the word being examined. This word will be selected
in the file, and the cursor placed after it.

Underneath that there is a list of possible suggestions. You can click on
these words to copy them into the writable icon; double clicking also causes
the same action as the Replace button. 

A writable icon follows, where the word to be replaced may be typed. As you type
into this icon, the list of suggestions is updated.

"Replace" replaces the selected word with the contents of the writable icon and
moves onto the next misspelled word.

"Add" permanently adds the word to the user dictionary. To remove a word later, 
see the IMPRESSONSPELL_DELWORD command.

"Ignore" ignores this word and moves onto the next.

"Cancel" cancels the spell check and moves the cursor back to where it was when
the spell check began.


Certain keypresses also control the spell checker: cR, cA, cI and cC operate the
Replace, Add, Ignore and Cancel functions respectively. Escape will also close 
the dialogue.



Impression Spell
----------------

   1992-1996 Computer Concepts Ltd
   2003 X-Ample Technology bv

The 'Impress'n Spell' module was originally created by Computer Concepts. The
rights to the Impression family - including 'Impress'n Spell' - were aquired
by X-Ample Technology bv of the Netherlands in September 2003.

Please note that this module is not public domain, it must not be passed
on or distributed in any way without permission from X-Ample Technology bv.
It is however allowed to extract the module from Zap for personal use with
other programs.


Installation
------------

Copy the !ZapSpell application into the !Zap.Modules directory, then restart Zap.


Commands
--------

Details of the commands provided may be found in the HelpData file.
Most of the functionality can be accessed through the front end provided by
the 'SPELL' command.


Clients
-------

Zap colouring modes can interact with ZapSpell to help check words - for
example, ZapEmail allows only the sections of the email which aren't in the
header/signature or in quoted sections of the text to be checked.

For more information, it is recommended that you look in the respective
mode's !Help file.


Technical
---------
ZapSpell uses some reason codes with e_init to confirm spelling queries with
the owning mode. These are described in the E-Entry file.



History
-------

2.00 03-Jan-04		Created

Christian Ludlam	christian@zap.tartarus.org

