Contents

Overviews

Introduction

Files

Copyright and disclaimer

Registration

Information

Developers

Network setup

Setup.inf

Problems (FAQ)

Coming soon...

About the Author

Dialog boxes

Add type

Spelling

Options

Edit Custom Dictionary

Configure Types

BuildScd


Files

You should have received the following:

readme.1st	-  Latest information and license.  Make sure you have read this.

spell.exe	-  Setup and options program.

setup.inf	-  Setup information and default options

 	buildscd.exe	-  Add to or create main dictionaries.

spelledt.dll	-  Functions used to check edit boxes.

spellchk.dll	-  Generic module to supply spelling checking.

spell.hlp	-  This help file.

order.txt	-  Order form.

spell.pgp	-  A pgp encryption key for ordering.

file_id.diz	-  Program description.

If any of these files are missing please obtain a new copy.

Plus at least one of the following dictionary files:

ukeng.scd	-  UK English dictionary

useng.scd	-  US English dictionary

german.scd	-  German dictionary (In beta release)

french.scd	-  French dictionary (In beta release)

If you have internet access you can obtain the latest version plus additional dictionary files by ftp from:

ftp.demon.co.uk/pub/ibmpc/windows/spell
ftp.clever.net/pub/quinion/spell

or see:

http://clever.net/quinion/spell/where.html
http://metro.turnpike.net/B/BriQui/where.html

for information on other ftp sites.


Introduction

This program is designed to provide spelling checker facilities to any application that uses the standard edit control or which can export text via the clipboard. The checker is started using a predefined short cut key, or for programs there are a range of documented interfaces for different levels of control.

Dictionaries are carefully checked to ensure that they do not contain mistakes, although there are omissions.

Any comments, suggestions or bug reports can be send to:

spell@quinion.demon.co.uk

My thanks go to:

Alain Falanga for his translation to French of the application.

And:
David Douglas
Jim Davis
Robert Gitzendanner
Robert Kaplan
Rudolf Kunzli
Ian Lynagh
Alfred "Speedy" Mercer
Rich Renomeron
Paul Tremblay

Who have all done an excellent job of Beta testing this version.


Spell

This will start the options box if no command line parameters are specified.

Available command line parameters:

/run	Check the current control.  The windows with the focus will be checked as if the hot key has been pressed.  This option can be used very effectively with programs that use toolbars or for instance the program SmartBar.


BuildScd

Click on the part of the image you want more information on.

Use this application to add to existing dictionaries and to create new dictionaries. If you are creating a new dictionary you should enter a title.  The wordlist should be formatted with one word on each line separated with a linefeed, carriage return combination.  The size of the dictionary is limited only by the available memory, you should be able to handle wordlists in the area of 200 000 with 4mb of memory, and around 500 000 with 8mb.


The full path of the file containing the words to be added or used in creating the new dictionary.


The full path of the dictionary file to be updated or created.


Create a new dictionary using the title specified and the word list, overwrite any existing dictionary of the same name.


Add the wordlist to the existing dictionary.


The title of the dictionary to be created.


Dialog: Add type

Click on the part of the image you want more information on.

If the way that a type of window should be treated has not been set then this box will be displayed. You should select the way that spell will treat the box in future.

Standard edit box:	The preferred setting, this window responds to all the standard edit box messages.  With this setting the program has greater control over the text box, and can handle extended selections and starting part way through an edit box.  The clipboard is not effected.
HTML and rich text are not supported for this type.

Non-standard:	The currently selected text (or if there is no current selection the whole text box) is copied to the clipboard and checked.  Clipboard formats that are supported are Rich Text Format, Text, OEM Text or HTML Format. (Normal text will be treated as HTML if the tag <HTML> is found at the start of the selection)
The Configure types box will be opened so that the key presses for copy paste and select all and be defined.  NOTE:  You can set the key presses for select all to anything you like, for instance instead of selecting the whole box just one page or one line could be selected.

Fail always:	Ignore the hot key in future when it is used in this box.

The program will select Standard edit box if it is possible that the box is compatible, otherwise it will default to Non-standard and disable the standard selection.  If you select Standard and then have problems you should change to non-standard using the Configure types box


Treat the box as a standard edit box, using the normal windows messages and leaving the clipboard alone.  The preferred type if the control is compatible, but may be selected when the window is not in which case you should use the Configure types box to change it to a non-standard box.


Use the clipboard to copy text from the control by sending pre-defined key presses to the window.  The program is capable of checking text in either rich text format or windows standard text formats.  If this type is selected it is virtually certain that the box is not compatible with a standard edit box.


This type of window will be completely ignored by spell checker.  Useful if you wish to use the spell checker hot key to do something else in some programs.


Dialog: Spelling

Click on the part of the image you want more information on.

This box varies slightly depending on the settings.  If sample text has been selected then not only will the current not found word be displayed but text before and after.  The word currently being checked is selected.

If the possible mistake is a duplicate word then the 'Not found' prompt will be replaced with 'Repeated'.


Displays the word that was not found	 or is repeated.  Sample text before and after the word may also be displayed is the options is chosen.


Type in the text that you wish to change the word to


The list of suggested words.  This will be auto filled if you have selected Auto Suggest


Use this to select your current user dictionary from the list


Add the Not Found word to the current user dictionary


Produce a list of suggestions for the word in the Change To box


Open the options dialog box


Ignore the current word and go onto the next


Ignore the current word and any future occurrences (during this session)


Change the current word to the one in the Change To box


Undo the last operation


Dialog: Options

Click on the part of the image you want more information on.

The options box is available via the Spelling box or by running the Spell program.


A list of all the current custom dictionaries.


Add a new custom dictionary.  You will be asked to select the file name, then the Edit Custom Dictionary dialog will appear.


Edit the current custom dictionary.  The Edit Custom Dictionary dialog will appear.


Delete the current custom dictionary.


Select the current language from the dictionaries available.


Determine if text should be converted from ASCII to ANSI to be checked.  The following conversions are made:

À	A`	Á	A'	Â	A^	Ã	A~
Ä	A"	Ç	C/	È	E`	É	E'
Ê	E^	Ë	E"	Ì	I`	Í	I'
Î	I^	Ï	I"	Ñ	N~	Ò	O`
Ó	O'	Ô	O^	Õ	O~	Ö	O~
Ù	U`	Ú	U'	Û	U^	Ü	U~
Ý	Y'	Ÿ	Y"	ß	SS


Allows you to remove/install the driver.  You can only remove or install the program when you have opened the options box using the setup program.  If you remove the driver you will be asked to restart windows and the driver will not be removed until you do.


Ignore all lines that start with this text.


Select the shortcut key to start the spell checker.  Just select the control and press the key combination.


Choose if you want spell to auto fill the suggest box


The program can search the custom dictionaries for suggestions, but on some machines this may be slow if there are a large number of custom words.  Try it and see.  NOTE: The program buildscd.exe can be used to add words to a dictionary.


Maintain the position of the spelling checker window between sessions.


Allow words to be split by some extra characters, normally treated as punctuation.  Useful if the edit box contains tagging which is causing words to be incorrectly marked queried.


Display a prompt before the clipboard contents are over written.  Displayed only when checking non-standard edit boxes.


Show a progress indicator in the top right of the screen.


Display the box giving version and copyright information on startup at the bottom right of the screen.


Always use ctl3d to display dialog boxes - there is a small performance penalty at startup.


When the spelling check is complete the program can either put up a message telling you, beep, or do nothing.  Your choice.


Dialog: Configure types

Click on the part of the image you want more information on.

The options box is available from the options screen by pressing the button 'Configure types'.

Standard edit boxes require little configuration although you can specify that sample text should be shown.

When using a non-standard box you should specify a series of keyboard keys that should be simulated in order to place text into the clipboard.  'Copy' will be used to move the current selection to the clipboard, 'Select all' will be sent to select the entire text box and 'Paste' will be used to replace the current selection with the contents of the clipboard.  NOTE: if your word processor does not overwrite a selection with text from the clipboard you may have to include a combination to delete the current selection first.

Several defaults are available from the drop down lists.

The following 'special' keys are recognised when used in the Copy, Paste or Select all boxes:

CAPSLOCK	NUMLOCK	SCROLLOCK	INSERT
ENTER	PRTSC	TAB	BREAK
CLEAR	BACKSPACE or BKSP	DELETE or  DEL	ESCAPE or ESC
LEFT	RIGHT	UP	DOWN
PGUP	PGDN	HOME	END
F1	F2	F3	F4
F5	F6	F7	F8
F9	F10	F11	F12
F13	F14	F15	F16
'normal' keys should be specified by entering them straight. (eg 'abced')

%	Alt

+	Shift

^	Control

are used to indicate that one (or more) control keys should be held down while the key following them is pressed.


The file path where the custom dictionary is stored


Remove the selected type.


Treat the box as a standard edit box, using the normal windows messages and leaving the clipboard alone.  This is the preferred type if the control is compatible.  The 'Add type' box will select this is possible.


Use the clipboard to copy text from the control by sending the pre-defined key presses to the window.  The program is capable of checking text in either rich text format, HTML or windows standard text formats.  The 'Add type' box will select this if the control is not compatible with the standard edit box.


This type of window will be completely ignored by spell checker.  Useful if you wish to use the spell checker hot key to do something else in some programs.


Display a sample of the text surrounding the word that was not found.  This option can not be disabled for non-standard edit boxes.


Send this key combination to the window to cause text to be placed in the clipboard.


Send this key combination to the window to REPLACE the current selection with text from the clipboard.


Send this key combination to select the entire text area that you wish to check.  Although this is called select all you can make it select any area that you wish.  If a selection is already present when the spell checker is started the selection only will be checked.


Display a confirmation message before any changes to the text are pasted back to the original document.


Dialog: Edit Custom Dictionaries

Click on the part of the image you want more information on.

Use this to change the name of the dictionary and to edit the words in the custom dictionary.


The file path where the custom dictionary is stored


The name of the dictionary


Specify the languages that the dictionary will be used with.  If this is All then the dictionary will be used with all languages.


A list of all the words in the custom dictionary.  You can use this box to edit what is in the custom dictionary.  If you want to send in a list of extra words the easiest way is just to pull the words straight out of the list into a text file using the clipboard.  Use Ctrl-Insert to copy to the clipboard from the edit control.  Please do not attempt to spell check this list.


Make the custom dictionary read only.  It will still be checked to see if a word is in it but you will not be able to add to it.


Tells you how many words are in the dictionary and how many bytes it takes up.


Temporarily disable the use of this dictionary.  It will be ignored completely.


Move the dictionary file and update pointers to this file.


Copyright and disclaimer

Spell checker for edit boxes has been written by and is copyright © 1995 by Brian Quinion. All rights reserved.

Whilst every care has been taken in the compilation of this application, it is provided 'as is' and the author shall not be held responsible for any error, omission or consequential loss.

Spell Checker for Edit Boxes is free for private and educational use for commercial licence see the form.

This software may be freely copied and used as long as no charge is made (except minimal handling costs).  This package has been released free for private use in an attempt to improve the literacy level of communication on the net, and to remove all excuse for bad spelling.

If you like this product, please write to me and tell me so, if you don't like it tell me that too.


Problems
Problems (or the FAQ)

Q:	Do I need to copy the program to the startup group to get it to run every time?

A:	You don't need to and should not.  The program installs itself using a different method.

Q:	I moved the program and now I can't get it to work?

A:	The directory pointers that it has installed may no longer work.  You will need to run setup, and press the 'Remove' button and then when it changes to 'Install' hit it again.  Spell should be installed either when you close setup, or if things are more corrupt when you restart windows.

Q:	I can't get the spelling checker to start using the hot key, nothing at all happens.

A:	You have probably uninstalled the program by accident.  Go to the Options box and look for a button marked either 'Install' or 'Remove'.  If it says Install click it and follow the instructions, it should work.  Otherwise you could check the file system.ini, in the first section there is an entry marked 'drivers'.  Look for the spelling check entry in that line and see if it looks 'strange'.

Q:	I can't get any languages to appear in the Language box, but I've installed the dictionary.

A:	There seems to be a strange bug that results in the language occasionally vanishing.  Load the file 'spelledt.ini' into notepad (or some other editor) and add/change the line 'Language=' to 'Langauge=FILENAME.SCD'.

Q:	Will it work with XXXXX?

A:	Yes, read the help information for Add Type and  Configure types.

Q:	I want to include your program inside my VB application.  How do I do it?

A:	See the developers guide.

These are the most asked questions of the moment,  I'll try to keep it up to date


Coming Soon...

The wish list:

Faster checking and suggestion list
Compressed language files
Multi-language .scd files
Change all (I've even left a gap for it!)

Not much at the moment because most of the previous wish list has gone into this version!  Anything else I get requests for will be considered.


Developers

The spellchk.dll module used by this program and edit box interface spelledt.dll can be integrated into any windows program that requires spelling checking facilities.  Freeware and shareware products can use this free of charge, for commercial software please contact me to arrange a licence.

Information on integrating spell check into other programs, function definitions and code examples are provided in the file devel300.zip.  Full code examples are provided for C, and partial example for VB and MS Access.

For more details contact me or see the file devel300.zip which also contains information on the price charged for a license.  Developer information is available by ftp as:

ftp.demon.co.uk/pub/ibmpc/windows/spell/devel300.zip
ftp.clever.net/pub/quinion/spell/devel300.zip

or see:

http://clever.net/quinion/spell/where.html
http://metro.turnpike.net/B/BriQui/where.html


Registration

What do you get

If you are a commercial user you will need to register to continue to use this package past the 30 day trial period, if you are a private user registration is optional.  You will receive a registration code by fax, email or post.  If you are requesting master disks the registration code will be sent with them.  Your registration code will be valid for future versions (at least up to 3.99 and at my descression beyond) whatever changes are made.

How

Either print out the registration form or use order.txt,  send the completed form to Michael Quinion Associates:

By post:	18 Pittville Close, Thornbury, BRISTOL, BS12 1SE, UK

By Tel/Fax:	+44 1454 411128

By email:	sales@quinion.demon.co.uk
Please use the PGP encryption key supplied.  In your own interests, do not send credit card details in open text email

By WWW:	http://clever.net/quinion/spell/order.htm
This secure order form should be available shortly

Please help to support a struggling student and register this software.


Registration form
Registration order form

Your Details

  Name:	______________________________________

  Company/Org'n:	______________________________________

  Address:	______________________________________

______________________________________

______________________________________

  Posttown:	______________________________________

  State/County:	______________________________________

  Country:	______________________________________

  Zip/Post code:	______________________________________

  Email Address:	______________________________________

  Phone Number:	______________________________________

  Fax Number:	______________________________________

Registration

Number of copies	Cost per copy
1 - 9	£15
10 - 49	£10
50 - 99	£7
100 - 999	£4
1000 - 4999	£2
5000 +	£1
  Number of copies: ___________   Registration cost:  £ ___________

Master disks

If you would like master disks to be posted to you, these are available when registering at cost (£2.50 each within Europe, £3.00 outside Europe).  If you are not registering there is an additional handling charge of £5.00.

Enter the number of master disks of each language you want:

      English (UK and US) ____     French ____     German ____

Each master disk contains the dictionaries indicated plus the program files in the same language (except for the German version, which has a German dictionary but program files in English; a German version will follow).

  Total number of master discs: _______  Total cost:  £_____________

Total cost

  Registration:	£_____________

  Master disks:	£_____________

  Handling charge (if not registering):	£_____________

  Within Europe add 17.5% VAT:	£_____________

  Total amount due:	£_____________

  Please tick if you require an invoice:     [   ]

Payment

You may either pay in pounds sterling by means of a cheque drawn on a UK bank (allow three additional days for clearance), or by one of the following credit or debit cards:

  Visa [  ]     Mastercard [  ]     Eurocard [  ]     Delta [  ]     Switch [   ]

 Name and initials: __________________________________________

 Card Number: _______________________     Expiry date: _________

  I agree to pay the above total amount:

  Signed: __________________________________________________

  Thank you for your order.


Network setup

The most efficient method to setup this program on a network is to place a single copy of the program on a publicly accessible network drive/directory.  Users can install the program individually as they require it by running spell.exe

You may want to edit setup.inf to customise the default settings, add extra window types specific to your system or include the registration information so that it will automatically be copied onto each machine (You should register is you are doing this).  Custom dictionaries should either be removed from the setup.inf file or given an absolute path that will be valid for all uses (eg if the users local file area was access with the drive letter 'g' you might change the default to g:\windows\default.dic) otherwise the program will attempt to create them in the directory containing the program files.


Setup.inf

The easiest way to setup the setup.inf file is to install the program on one machine, get it setup how you want it and then copy over the settings from spelledt.ini to setup.inf.  You should be aware that the setup.inf file will always be deleted after use (unless it is read only - no error will be generated).

[Version]

Number	Required, it should be the same as the number in the standard setup.inf  (3.00)

[Options]

Language	The filename of the current dictionary

bAutoSuggest	Auto suggest 1=Yes 0=No

bSuggestCustom	Suggest from custom dictionaries

bBreakOnPunctuation	Let punctuation break words

bShowOnCheck	Show the progress indicator

bAnsiToAscii	Convert ASCII to ANSI and back

bIgnoreLines	Ignore lines if they start with:

szIgnoreLines	Lines starting with this will be ignored

bStoreWinPos	Preserve the windows position

iXPos	The position the window will be opened in (X)

iYPos	The position the window will be opened in (Y)

iAfterCheck	After a check do 0 = Message box, 1 = Beep, 2 = Nothing

[Register]

Name	Registration name

Code	The registration code associated with the name

[Custom]

Number	Number of default custom dictionaries

Path0	Dictionary filename.  If a full path is given it is used, otherwise it is place the program directory

Name0	Name of the dictionary (20 chars max)

Lang0	The language that this dictionary will be used with (or All)

[Types]

Types0=Edit	The name of the type of control

Types1=MSWRITE_DOC

[Edit]	How that type will be treated

Do=0

ShowSample=0

[MSWRITE_DOC]

Do=1

ShowSample=1

Copy=^c

Paste=^v

BoxSelect=^{HOME}+^{END}

bConfirmPaste=0


About the Author

I am currently a second year A level student at the Castle School, Thornbury, which is near Bristol in the UK.  I will shortly be starting a software engineering course at either Sheffield or Bradford university.

Contact:

 I can be contacted by Email at either:

spell@quinion.demon.co.uk

By mail:

18 Pittville Close,
Thornbury,
BRISTOL
BS12 1SE
UK

If I am on-line I will probably be on IRC as Brique.

The latest is always available:

http://clever.net/quinion/
http://metro.turnpike.net/B/BriQui/

These pages give the latest contact information, changes to the FAQ and information on other programs.  Announcements will be made of new releases and updates or you can join the list server.