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

OS/2 Help File | 1997-03-29 | 23KB | 649 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 70,000 words.


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

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

SpellGuard searches for the dictionary( SPELLGRD.DCT )and user words (
WORDS.USR ) in the current directory and in any directories specified in the
DPATH environment variable.  SpellGuard also will search the paths indicated by
the environment variables SG_DICT_PATH and SG_USER_PATH

 To use the  SpellGuard environment variables, if the fully qualified
dictionary name was C:\SPELLGRD\DICT\SPELLGRD.DCT and the user words file was
C:\SPELLGRD\USER\WORDS.USR then the lines in your CONFIG.SYS would look like:

      SET SG_DICT_PATH=C:\SPELLGRD\DICT
      SET SG_USER_PATH=C:\SPELLGRD\USER


ΓòÉΓòÉΓòÉ 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+ALT+P will bring SpellGuard back to the top of all windows and
give it the focus.

Pressing CTRL+ALT+L will bring focus back to the window that you last typed
into. (These hotkeys can be changed in the Settings notebook).

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 user word list
and the Match pushbutton tries to match a misspelled word to a word in the
dictionary or user word list.


ΓòÉΓòÉΓòÉ 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 user word list: WORDS.USR.


ΓòÉΓòÉΓòÉ 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 up to 50 matches from the dictionary. 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 misspelled the word, 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 misspelled the word, 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 or
pressing Replace will backspace over the incorrect word and replace it with the
selected word.


ΓòÉΓòÉΓòÉ 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.

These are the major notebook pages:

      Misspelled page
      Beep/Wav page
      Exclusion page
      Inclusion page
      Miscellaneous options page
      Hotkeys page
      Abbreviations page


ΓòÉΓòÉΓòÉ 5.2.1. Misspelled 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. Beep/Wav 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.

Or you can have SpellGuard beep when a word is flagged.  Select a setting in
the custom spin box if you wish modify the sound of the beep.  The frequency
entry field will allow you to change the sound of the beep while the duration
entry field will allow you to change the length of the beep.

 You can also have a double beep by filling in the pause entry field along with
the 2nd Beep frequency and duration fields.  If you do not want a 2nd Beep,
enter a 0 in the above fields.


ΓòÉΓòÉΓòÉ 5.2.3. Exclusion/Inclusion page ΓòÉΓòÉΓòÉ

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

The Inclusion pages allow you to specify what executables or window titles you
want to spell check *ONLY*.

If there are any inclusions defined then the exclusions are ignored.

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

 Select a line in the listbox  and press Delete to remove it from the 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 or inclusion does not work,
first run your program and then PSTAT.EXE to to see what exe name your program
is using.


ΓòÉΓòÉΓòÉ 5.2.4. HotKey page ΓòÉΓòÉΓòÉ

This page allows you to customize the hotkeys that SpellGuard watches for to
give itself the focus.

The hotkeys active lets you turn the hotkeys on or off.

The Functions listbox lists the available functions that can be activated via
hotkey.

 A hotkey is defined by Ctrl  and Alt or Shift along with a letter or number
from the key dropdown combo box.  You then press Bind to bind the specified
hotkey to the selected function.


ΓòÉΓòÉΓòÉ 5.2.5. Miscellaneous options page ΓòÉΓòÉΓòÉ

The backspace settings tells 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 and you can choose to have
an audible click sound when it does.

You can have SpellGuard start minimized or off

Select Apostrophe is part of a word if you want the apostrophe not to stop
spell checking.

And you can opt to turn on the fast backspace option.


ΓòÉΓòÉΓòÉ 5.2.6. Abbreviations page ΓòÉΓòÉΓòÉ

This page allows you to create abbreviations which SpellGuard will expand in
place (up to 50 characters).

To create an abbreviation, put the abbreviated entry in the Abbreviation entry
field, it's expanded counterpart in the Expands to entry field and press Add
to. Your entry gets added to the Abbreviation to container.

To delete an abbreviation, select it from the Abbreviation  container. and
press Add.

For example if you put rmah in the Abbreviation field and [e-mail]
in the Expands to field and press Add , anytime you type rmah followed by a
space (or any other word ending character) it will backspace over the rmah and
replace it with [e-mail].

 This feature can come in very handy if you always know you spell a certain
word incorrectly.

Note:   Abbreviations are not meant to be used with "speed typing". Since
SpellGuard does it's work in the background, it cannot be sure exactly where
you are when you are typing quickly so an "on-the-fly" replacement is unlikely
to be successful.  For best results, type the abbreviation, press space and
wait for SpellGuard to replace the characters.


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

This brings up the About dialog where you can register  To enter the
registration number press CTRL+ALT+R, enter the registration number in the
entry field and press Enter.


ΓòÉΓòÉΓòÉ 5.4. SpellGuard controls ΓòÉΓòÉΓòÉ

 This lists all the SpellGuard controls and what they do.


ΓòÉΓòÉΓòÉ 5.4.1. 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.4.2. 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.4.3. Float forever ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.4. Popup minimized ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.5. 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.4.6. 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.4.7. 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.

To activate MMPM you must uncheck the beep checkbox and check the "Use MMPM if
available" checkbox.


ΓòÉΓòÉΓòÉ 5.4.8. 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.4.9. 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.4.10. Click on reset ΓòÉΓòÉΓòÉ

 Selecting this will cause a small click or beep to be emitted when the word is
reset.


ΓòÉΓòÉΓòÉ 5.4.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.4.12. Exclusion/Inclusion entry field ΓòÉΓòÉΓòÉ

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

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

If you define an exclusion 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.

 An inclusion allows you to specify what exes or window  titles to spell check.
If an inclusion is defined, SpellGuard will only check those entries.

 If inclusions and exclusions are both defined, the exclusions are ignored.

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/inclusion.


ΓòÉΓòÉΓòÉ 5.4.13. Exclusion Add pushbutton ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.14. Exclusion Delete pushbutton ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.15. Exclusion/inclusion listbox ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.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.4.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.4.18. Start minimized ΓòÉΓòÉΓòÉ

 Checking this option will start SpellGuard in the minimized state.


ΓòÉΓòÉΓòÉ 5.4.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.4.20. Apostrophe ΓòÉΓòÉΓòÉ

 When "apostrophe is part of the word" is not checked SpellGuard will cause the
word to be spell checked when an apostrophe or single quote character ' is
pressed.

 When checked the apostrophe is considered part of the word.

For example if the option is checked and you type wouldn't. SpellGuard will
spell check wouldn't

If the option was not checked then the quote char would cause SpellGuard to
spell check wouldn.


ΓòÉΓòÉΓòÉ 5.4.21. Fast backspace ΓòÉΓòÉΓòÉ

During beta testing it was discovered that a couple of programs had problems
with fast backspacing.  So as a default the backspacing has a small delay.
Select this option to turn on the fast backspacing.


ΓòÉΓòÉΓòÉ 5.4.22. Beep ΓòÉΓòÉΓòÉ

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


ΓòÉΓòÉΓòÉ 5.4.23. Custom ΓòÉΓòÉΓòÉ

 Choose a Note,Warning or Custom beep sound.  The custom beep allows you to
change the 1st beep's frequency. and the duration. along with allowing you to
have a pause. before a 2nd beep.  The 2nd beep can be customized by modifying
the frequency. and duration.

A zero in the 2nd beep's fields will turn it off.


ΓòÉΓòÉΓòÉ 5.4.24. 1st beep frequency ΓòÉΓòÉΓòÉ

 Enter the frequency of the first custom beep.


ΓòÉΓòÉΓòÉ 5.4.25. 1st beep duration ΓòÉΓòÉΓòÉ

 Enter the duration in milliseconds of the first custom beep.


ΓòÉΓòÉΓòÉ 5.4.26. Pause ΓòÉΓòÉΓòÉ

 Enter the number of millseconds to pause between beeps.


ΓòÉΓòÉΓòÉ 5.4.27. 2nd beep frequency ΓòÉΓòÉΓòÉ

 Enter the frequency of the second custom beep.


ΓòÉΓòÉΓòÉ 5.4.28. 2nd beep duration ΓòÉΓòÉΓòÉ

 Enter the duration in milliseconds of the second custom beep.


ΓòÉΓòÉΓòÉ 5.4.29. Hotkeys active checkbox ΓòÉΓòÉΓòÉ

 Check this if you want to use hotkeys.


ΓòÉΓòÉΓòÉ 5.4.30. Hotkey Functions ΓòÉΓòÉΓòÉ

 Lists the functions available to bind to a hotkey.


ΓòÉΓòÉΓòÉ 5.4.31. Shift radiobutton ΓòÉΓòÉΓòÉ

 Select this to use the Shift key along with the Ctrl key in a hotkey
combination.


ΓòÉΓòÉΓòÉ 5.4.32. Alt radiobutton ΓòÉΓòÉΓòÉ

 Select this to use the Alt key along with the Ctrl key in a hotkey
combination.


ΓòÉΓòÉΓòÉ 5.4.33. Keys listbox ΓòÉΓòÉΓòÉ

 Lists the available keys to use in a hotkey combination.


ΓòÉΓòÉΓòÉ 5.4.34. Bind ΓòÉΓòÉΓòÉ

 Binds the specified hotkey combo to the selected function


ΓòÉΓòÉΓòÉ 5.4.35. UnBind ΓòÉΓòÉΓòÉ

 Removes the hotkey association from the selected function


ΓòÉΓòÉΓòÉ 5.4.36. Abbreviation entry field ΓòÉΓòÉΓòÉ

 Enter the the characters you would like to trigger the replacement.


ΓòÉΓòÉΓòÉ 5.4.37. Expands to entry field ΓòÉΓòÉΓòÉ

 Enter the  the characters you would like have have replace the abbreviation.


ΓòÉΓòÉΓòÉ 5.4.38. Abbreviation container ΓòÉΓòÉΓòÉ

 This lists the abbreviations you have defined.


ΓòÉΓòÉΓòÉ 5.4.39. Abbreviation Add pushbutton ΓòÉΓòÉΓòÉ

 Pressing this adds the defined abbreviations to the abbreviations container.


ΓòÉΓòÉΓòÉ 5.4.40. Abbreviation Delete pushbutton ΓòÉΓòÉΓòÉ

 Pressing this removes the defined abbreviations from the abbreviations
container.


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

These are the 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
      Abbreviations is a shortcut to turn on or off the Abbreviations
      Hotkeys is a shortcut to turn on or off the Hotkeys

  The Abbreviation and Hotkeys menu item settings are not saved.  They are
 there so you can quickly turn them on or off. If you want the toggled state to
 persist across program invocations, you must change them in the Settings
 notebook.


ΓòÉΓòÉΓòÉ 7. 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!


ΓòÉΓòÉΓòÉ 8. 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]
        http://www.bmtmicro.com

 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.