OS/2 Shareware BBS: 5 Edit/05-Edit.zip/splgrd.zip/spellgrd.inf

OS/2 Help File | 1995-12-06 | 18KB | 507 lines

ΓòÉΓòÉΓòÉ 1. What is SpellGuard? ΓòÉΓòÉΓòÉ

SpellGuard is a program that interactively checks your spelling i.e. as you
type.  After a mistake is found, if requested, it will attempt to give you
matches from the dictionary of over 56,000 words.


ΓòÉΓòÉΓòÉ 2. Installation ΓòÉΓòÉΓòÉ

Unzip the file into a directory.  Type INSTALL and follow the prompts.

 The current version of this install program will not install the SpellGuard
dictionary.  If the dictionary was supplied in a separate zip file then you
must unzip it into the SpellGuard directory.  If the dictionary was supplied in
the same zip file as the SpellGuard executable, then you must copy the
dictionary file, SPELLGRD.DCT from the installation directory to the SpellGuard
directory.


ΓòÉΓòÉΓòÉ 3. Operation ΓòÉΓòÉΓòÉ

SpellGuard  is quite simple, it starts checking your spelling as soon as you
start it up.  When you make an error in spelling, or you spell a word that is
not in the dictionary, the SpellGuard window will float to the top of the
screen, but it will not interfere will your typing.  At the next keystroke,
SpellGuard will float back out of sight (these settings can be changed - see
Settings ).

Pressing CTRL+PAGEUP will bring SpellGuard back to the top of all windows and
give it the focus.

Pressing CTRL+PAGEDOWN will bring focus back to the window that you last typed
into.

Selecting the system menu choice, Settings ,will give you a notebook that will
configure SpellGuard The system menu choice, About displays the product
information dialog box. The Add pushbutton adds a word to the dictionary and
the The Match pushbutton tries to match a misspelled word to a word in the
dictionary.


ΓòÉΓòÉΓòÉ 4. Main Window ΓòÉΓòÉΓòÉ

 The main window of SpellGuard is made up of the following controls:

      Spell Check on checkbox
      Word combo box
      Add pushbutton
      Match pushbutton


ΓòÉΓòÉΓòÉ 4.1. Spell Check On ΓòÉΓòÉΓòÉ

 Selecting and deselecting this will turn the spell checking on and off.


ΓòÉΓòÉΓòÉ 4.2. Incorrect Word combo box ΓòÉΓòÉΓòÉ

 This combo box lists all the words that have been incorrectly spelled.
Pressing Match will bring up the Match dialog and place this word in it's Word
entry field


ΓòÉΓòÉΓòÉ 4.3. Add pushbutton ΓòÉΓòÉΓòÉ

 This will add the word in the Word combo box to the dictionary.


ΓòÉΓòÉΓòÉ 4.4. Match pushbutton ΓòÉΓòÉΓòÉ

This will start a search of the best match in the dictionary to the word in the
combo box and bring up the Match dialog.


ΓòÉΓòÉΓòÉ 5. Dialogs ΓòÉΓòÉΓòÉ

 The following dialogs are found in SpellGuard

      Match dialog
      Settings notebook
      Product Information dialog


ΓòÉΓòÉΓòÉ 5.1. Match dialog. ΓòÉΓòÉΓòÉ

This will show you the best match in the database. The original word is placed
in the entry field  and the matches are in the listbox. Pressing Match will
start a search again, Replace will dismiss the dialog, give the focus to the
application where you spelled the word wrong, backspace over the incorrectly
spelled word and replace it with the selected word. Copy will copy the selected
word to the clipboard and dismiss the dialog and Cancel will just return you to
the SpellGuard main dialog.

Moving the Exactness slider to the right will cause the search to become more
exact, to the left, less exact.


ΓòÉΓòÉΓòÉ 5.1.1. Match Pushbutton ΓòÉΓòÉΓòÉ

Pressing this button will start a best match search for the word that is
currently in the Word entry field


ΓòÉΓòÉΓòÉ 5.1.2. Replace Pushbutton ΓòÉΓòÉΓòÉ

Replace will dismiss the Match dialog, give the focus to the application where
you spelled the word wrong, backspace over the incorrectly spelled word and
replace it with the selected word,

SpellGuard does not keep track of what characters you've typed after the
misspelled word.  In order for this to work correctly, your cursor must be one
character past the misspelled word i.e. after the keystroke that triggered the
spell check. SpellGuard will be enhanced in a future release to remove this
limitation.

Note:  Due to an OS/2 limitation, this feature does not work for DOS and
WinOS/2 programs.


ΓòÉΓòÉΓòÉ 5.1.3. Copy Pushbutton ΓòÉΓòÉΓòÉ

Pressing this button will copy the highlighted word in the listbox to the
clipboard and exit the Match dialog.


ΓòÉΓòÉΓòÉ 5.1.4. Word Entry Field ΓòÉΓòÉΓòÉ

The incorrectly spelled word from the SpellGuard dialog's combo box is placed
here and a best match search is made on this word.


ΓòÉΓòÉΓòÉ 5.1.5. Match Listbox ΓòÉΓòÉΓòÉ

The best matches from the incorrectly spelled word get placed in this listbox.
Selecting a word and pressing Copy will copy the word to the clipboard.


ΓòÉΓòÉΓòÉ 5.1.6. Cancel Pushbutton ΓòÉΓòÉΓòÉ

This will end the current search and exit the Match dialog.


ΓòÉΓòÉΓòÉ 5.1.7. Search Exactness slider ΓòÉΓòÉΓòÉ

This controls the exactness of the search.  Moving the slider to the right will
cause the search to become more exact, to the left, less exact. It is currently
set to 75 (out of 100)

For example, searching on SIMILER will get you 17 matches at 75.  A search
exactness of 85 will get you 5 matches.


ΓòÉΓòÉΓòÉ 5.2. Settings ΓòÉΓòÉΓòÉ

This notebook allows you to configure the behavior of SpellGuard.

There are 4 major notebook pages:

      Misspelled page
      MMPM page
      Exclusion page
      Miscellaneous options page


ΓòÉΓòÉΓòÉ 5.2.1. Mispelled page ΓòÉΓòÉΓòÉ

When a word is misspelled,  You can have it Beep and you can have the
SpellGuard window float to the top of the screen so you can see what was
misspelled. It can float until you press a Key, float for a certain number of
Seconds, or it can float forever.

You can even have it popup even if SpellGuard is minimized.

 You can have the SpellGuard window cycle through the system colors.


ΓòÉΓòÉΓòÉ 5.2.2. MMPM page ΓòÉΓòÉΓòÉ

The MMPM checkbox allows you to use MMPM if it is loaded. You can specify what
WAV file to play if you spell a word incorrectly and when you type something
vulgar


ΓòÉΓòÉΓòÉ 5.2.3. Exclusion page ΓòÉΓòÉΓòÉ

These two pages allow you to specify what executables or window titles you do
not want to spell check.

 Enter an exe name or window title in then entry field and press Add to add it
to the exclusion listbox.

 Select a line in the exclusion listbox and press Delete to remove it from the
exclusion list.

Note:  OS/2 Windows are tricky things.  Any program run in an OS/2 Window will
register to SpellGuard as PMSHELL.EXE that includes a CMD.EXE process running
in an OS/2 Window. In these cases use the Window title exclusion.

Note:  Some programs are just stubs and start the real program (for example,
view.exe starts viewdoc.exe).  If the exclusion does not work, first run your
program and then PSTAT.EXE to to see what exe name your program is using.


ΓòÉΓòÉΓòÉ 5.2.4. Miscellaneous options page ΓòÉΓòÉΓòÉ

The backspace settings tell SpellGuard whether you want your backspace key to
be a destructive backspace.

The Vulgarity Indicator lets you choose whether you want to be warned if you've
typed something rude.

The minimum length spin button allows you to determine how long is a word.

The word can be RESET after a certain amount of time.

You can have SpellGuard start minimized or off


ΓòÉΓòÉΓòÉ 5.2.5. SpellGuard controls ΓòÉΓòÉΓòÉ

 This lists all the SpellGuard controls and what they do.


ΓòÉΓòÉΓòÉ 5.2.5.1. Beep ΓòÉΓòÉΓòÉ

Selecting this controls whether SpellGuard will beep when a word is misspelled.
It can be set for No Beep, a Warning beep or a Note beep.  The Warning and Note
beeps are system settings.


ΓòÉΓòÉΓòÉ 5.2.5.2. Float until key pressed ΓòÉΓòÉΓòÉ

Selecting this controls whether SpellGuard will float above all other windows
until a key is pressed when a word is misspelled.


ΓòÉΓòÉΓòÉ 5.2.5.3. Float for x seconds ΓòÉΓòÉΓòÉ

Selecting this controls whether SpellGuard will float above all other windows
for a specified number of seconds when a word is misspelled.


ΓòÉΓòÉΓòÉ 5.2.5.4. Float forever ΓòÉΓòÉΓòÉ

Selecting this controls whether SpellGuard will continuously float above all
other windows.


ΓòÉΓòÉΓòÉ 5.2.5.5. Popup minimized ΓòÉΓòÉΓòÉ

Selecting this causes SpellGuard to popup when a word is misspelled even if
minimized.


ΓòÉΓòÉΓòÉ 5.2.5.6. Backspace ΓòÉΓòÉΓòÉ

The backspace checkbox tells SpellGuard whether you want your backspace key to
be a destructive backspace.

Sorry,this is system wide so SpellGuard may make some wrong calls if one
application has a destructive backspace and another has a non-destructive
backspace.


ΓòÉΓòÉΓòÉ 5.2.5.7. Vulgarity Indicator ΓòÉΓòÉΓòÉ

This lets you choose whether you want to be warned if you've typed something
rude. It's best if you've got a sound card and MMPM/2 installed.


ΓòÉΓòÉΓòÉ 5.2.5.8. MMPM Support ΓòÉΓòÉΓòÉ

If MMPM is loaded on your system then SpellGuard can play a wav file if a word
is spelled wrong or if you have typed something vulgar.


ΓòÉΓòÉΓòÉ 5.2.5.9. Word Length ΓòÉΓòÉΓòÉ

 You can tell SpellGuard how long a string of characters is to make a word.
The options are 2,3,4, and 5.

For example if you have a setting of 4, then SpellGuard will not attempt to
spell check TEH.  If you have a setting of 5, then it will not try to spell
check THSI.


ΓòÉΓòÉΓòÉ 5.2.5.10. Reset Word ΓòÉΓòÉΓòÉ

 You can tell SpellGuard to reset the word after a certain amount of time.
This will clear whatever is in SpellGuard's word buffer.  This can be useful if
you use some software that uses letters to navigate i.e. newsreaders.


ΓòÉΓòÉΓòÉ 5.2.5.11. Change Colors ΓòÉΓòÉΓòÉ

 You can tell the SpellGuard window to cycle through the system colors after a
word is misspelled.  The colors will change until you press a key.


ΓòÉΓòÉΓòÉ 5.2.5.12. Exclusion entry field ΓòÉΓòÉΓòÉ

 Enter the executable name or window title you would like to exclude from spell
checking.

The executable is to be entered without the .EXE extension.

SpellGuard will not spell check any window that contains a sub string of the
window title entered.  For example if you specify Window SpellGuard will not
spell check anything in a window titled OS/2 Window or DOS Window or anything
that contains Window in the title.

Note:  OS/2 Windows are tricky things.  Any program run in an OS/2 Window will
register to SpellGuard as PMSHELL.EXE that includes a CMD.EXE process running
in an OS/2 Window. In these cases use the Window title exclusion.


ΓòÉΓòÉΓòÉ 5.2.5.13. Exclusion Add pushbutton ΓòÉΓòÉΓòÉ

 Press this to add the word in the exclusion entry field to the listbox.


ΓòÉΓòÉΓòÉ 5.2.5.14. Exclusion Delete pushbutton ΓòÉΓòÉΓòÉ

 Press this to delete the word in the exclusion listbox  This will remove the
item from the exclusion list.


ΓòÉΓòÉΓòÉ 5.2.5.15. Exclusion listbox ΓòÉΓòÉΓòÉ

 This lists the executable names or window titles that will be excluded from
spell checking.


ΓòÉΓòÉΓòÉ 5.2.5.16. Incorrect word Wav ΓòÉΓòÉΓòÉ

 Enter the name of the WAV file you would like played when a word is spelled
incorrectly. (As long as  the "Use MMPM if available  checkbox  is checked.)

 If no path is given SpellGuard will look for the file in the current
directory.


ΓòÉΓòÉΓòÉ 5.2.5.17. Vulgar word Wav ΓòÉΓòÉΓòÉ

 Enter the name of the WAV file you would like played when a vulgar word is
typed.  (As long as the "Use MMPM if available"  checkbox  and "Vulgarity
warning"  checkbox  is checked.)

 If no path is given SpellGuard will look for the file in the current
directory.


ΓòÉΓòÉΓòÉ 5.2.5.18. Start minimized ΓòÉΓòÉΓòÉ

 Checking this option will start SpellGuard in the minimized state.


ΓòÉΓòÉΓòÉ 5.2.5.19. Start Off ΓòÉΓòÉΓòÉ

 Checking this option will start SpellGuard in the off state. Spell Checking
will not occur until you check the Spell Checker On checkbox


ΓòÉΓòÉΓòÉ 5.3. About ΓòÉΓòÉΓòÉ

This will bring up the Product Information dialog box.


ΓòÉΓòÉΓòÉ 6. Menu Options ΓòÉΓòÉΓòÉ

There are three extra menu options available on the system menu.

      Settings brings up the Settings notebook.
      About brings up the Product Information dialog box.
      Help brings you here


ΓòÉΓòÉΓòÉ 7. SpellGuard Dictionary Browser ΓòÉΓòÉΓòÉ

PMDICT.EXE, the dictionary browser for SpellGuard allows you to view, add, or
delete words in the SpellGuard Dictionary


ΓòÉΓòÉΓòÉ 8. Operation ΓòÉΓòÉΓòÉ

 Double-clicking the SpellGuard Dictionary Browser icon will  start the
browser.

 Enter a word in the word  stem  entry field and press  Search .  The
Dictionary Browser will search the dictionary for all words  that start with
the word stem you entered.  The  Search  button turns into a STOP button during
the search so you can abort the search at any time.

You can type a word in the  stem  entry field and press and press  Add  to add
the word to the dictionary.

 Selecting a word from the  listbox  and pressing  Delete  will delete the word
from the dictionary.

 Pressing  Exit  will exit the Dictionary Browser.


ΓòÉΓòÉΓòÉ 8.1. Word stem entry field ΓòÉΓòÉΓòÉ

 Enter a word stem to search the dictionary.  For example entering bog will
find BOGUS and BOGGLE (among others).


ΓòÉΓòÉΓòÉ 8.2. Search push button ΓòÉΓòÉΓòÉ

 Press this to start the search.  After the search is started, it changes to
STOP so you can abort the search


ΓòÉΓòÉΓòÉ 8.3. Add push button ΓòÉΓòÉΓòÉ

 This will add the word in the  word stem  entry field to  the dictionary.


ΓòÉΓòÉΓòÉ 8.4. Delete push button ΓòÉΓòÉΓòÉ

 This will delete the words selected in the  words  listbox  from the
dictionary.


ΓòÉΓòÉΓòÉ 8.5. Word listbox ΓòÉΓòÉΓòÉ

 The word listbox lists all the words in the dictionary that match the word in
the  word stem  entry field

 Select a word and press the  delete  pushbutton to delete a word from the
dictionary.


ΓòÉΓòÉΓòÉ 8.6. Exit push button ΓòÉΓòÉΓòÉ

 This will exit the SpellGuard Dictionary Browser.


ΓòÉΓòÉΓòÉ 9. Add words to Dictionary program ΓòÉΓòÉΓòÉ

ADD2DICT.EXE is a program that will add a list of words in a file to the
dictionary.  The usage is ADD2DICT <infile> where <infile> is the name of the
file with the words you want to add to the dictionary.

 Since SpellGuard adds all the words you add to the dictionary to the file
WORDS.USR, in the unlikely event that the SpellGuard dictionary gets corrupted
or deleted, you can re-install the dictionary and apply all the words you added
back to the dictionary by running ADD2DICT WORDS.USR.


ΓòÉΓòÉΓòÉ 10. Support ΓòÉΓòÉΓòÉ

SpellGuard  will be supported via:

      Email:
      Internet: [e-mail]
      CIS:    73142,2765

      Newsgroups:
      CIS:
      OS2SHARE section 1, OS/2 shareware forum
      Internet:
      comp.os.os2.utilities - put SpellGuard in the title

      Visit 2Rud Software's Home page at:

      http://www.netusa.net/~rmahoney/

      The latest upgrades to SpellGuard can be found there as well as some cool
      FREE utilities!


ΓòÉΓòÉΓòÉ 11. Registration ΓòÉΓòÉΓòÉ

SpellGuard costs US$25.00 and entitles you to free v1.XX upgrades.

 All software is to distributed electronically.

SpellGuard can be registered via CIS - GO SWREG id 5200, credit cards are
accepted by BMT Micro:

      BMT Micro
        452 Horn Road
        Wilmington, NC 28412-2411
        - U.S.A. -

        Phone: [phone] (7 days/week)
        Phone: [phone] (Orders only!)
        FAX:  [phone]
        BBS:  [phone] (10 lines >=14.4K)
        BBS:  [phone] (direct 28.8K)
        E-Mail: [e-mail]

 or checks can be filled out and sent snail mail to :

      Robert Mahoney
      27 E. Jackson Ave
      Babylon,New York 11702

  After registering, you will receive a registration number.  To enter the
 registration number, bring up the About dialog box and press CTRL+ALT+R. Enter
 the registration number in the entry field and press Enter.

 Upon registration, SpellGuardwill display the About dialog box only for the
 length of time specified in the system logo setting.