home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / FREDV19A.LHA / FrexxEd / fpl / Ispell.FPL.README < prev    next >
Encoding:
Text File  |  1995-08-29  |  5.8 KB  |  168 lines
  1. #############################################################################
  2. File:        Ispell.FPL
  3. Author:        Jesper Skov
  4. Email:          jskov@iesd.auc.dk    ******
  5. Short:          Interface to Ispell. *Very* powerful spell checking!
  6. Version:        1.3                  ******
  7. Date:        29.08.95
  8. Local settings:    ispell_activeLanguage
  9. Global settings:
  10. Keysequence:    (Menu)
  11. Type:        Function/interface
  12. Prereq:        Ispell-3.1.18 Amiga patch 2+
  13. Copyright:    © 1995, Jesper Skov
  14. #############################################################################
  15.  
  16. FUNCTION
  17.  Have you ever wanted an easy way to check if a word is spelled correct? 
  18.  Well, with this interface to Ispell you get a more powerful spell checking
  19.  system than you would ever have believed possible! Also, you will most
  20.  likely not understand how you have survived until now without Ispell 8o)
  21.  
  22.  You need to get the Ispell3.1.18bin.lha archive which should be available
  23.  from AmiNet. In this archive is included an English dictionary, but Ispell
  24.  can also handle other languages.
  25.  
  26.  System requirements:
  27.  You should be aware that Ispell takes up 1MB+ of your RAM. Also, it uses
  28.  ixemul.library which in itself takes some 150KB+ of RAM.
  29.  
  30.  Consult the Ispell documents for a description of Ispell. I assume you have a
  31.  general understanding of Ispell for the remainder of this document.
  32.  
  33.  -*- Pull-down menus -*-
  34.  
  35.  * Preferences (customizing->program->ispell):
  36.  
  37.    ispell_bin:
  38.    ~~~~~~~~~~~
  39.     The name and path to the ispell binary.
  40.  
  41.    ispell_flags:
  42.    ~~~~~~~~~~~~~
  43.     Ispell flags. "-r" is always set (server mode), as is "-d" (language)
  44.     control and "-p" is set if you have specified a private dictionary.
  45.  
  46.    ispell_languages:
  47.    ~~~~~~~~~~~~~~~~~
  48.     What languages should selectable from the editor. You should
  49.     (obviously) have dictionaries for the languages.
  50.     Language names should be separated with "|", e.g. "english|dansk".
  51.  
  52.    ispell_personalDict:
  53.    ~~~~~~~~~~~~~~~~~~~~
  54.     Personal dictionary if you don't want one for each language (default
  55.     is ".ispell_<language>").
  56.  
  57.    ispell_gui:
  58.    ~~~~~~~~~~~
  59.     Check this if you prefer a GUI interface over the "raw" keyboard
  60.     interface.
  61.  
  62.  
  63.  
  64.  * Control (Ispell->...)
  65.  
  66.    Check Word:
  67.    ~~~~~~~~~~~
  68.     Check the word immediately under or in front of the cursor. If the
  69.     word is recognized you will be informed of this in the status line of
  70.     the active buffer.
  71.     If the word is not recognized, you have multiple choices. See below.
  72.  
  73.    Check Block:
  74.    ~~~~~~~~~~~~
  75.     Check all the words in the marked block. For each miss spelled word
  76.     you will be offered the same options as with "Check Word".
  77.     Because of the manner in which this function has been implemented,
  78.     you may be asked to verify the same word multiple times. The
  79.     function should be smart enough to skip most of these cases though.
  80.  
  81.    Check File:
  82.    ~~~~~~~~~~~
  83.     Checks the entire file (buffer) like "Check Block".
  84.  
  85.    Kill server:
  86.    ~~~~~~~~~~~~
  87.     If you want to un-load the server. This will also flush the
  88.     dictionary to disk.
  89.     This function will automatically be called at exit if you have added
  90.     any words to your personal dictionary.
  91.  
  92.  
  93.  -*- Alternative words menu -*-
  94.  
  95.  If Ispell does not directly recognize a word you give it, there will be
  96.  opened a buffer with a multiple choice menu:
  97.  
  98.  < > : (0) alternative (1) alternative ... (9) alternative
  99.  
  100.  The "<" and ">" identify that there are other alternatives than the ones
  101.  listed at this line. Press "," and "." to scroll through alternatives. When
  102.  you get to one of the ends of the buffer, the respective direction marker
  103.  will disappear; if there is only on line of alternatives there will be no
  104.  direction markers.
  105.  The alternative words are numbered 0..9. Pressing this number, the word will
  106.  be replaced with the respective alternative word. Example:
  107.  
  108.  You check the word "TODO". The result could be:
  109.  
  110.     : (0) TODD (1) TOGO (2) TO (3) TOTO (4) TO DO (5) TO-DO
  111.  
  112.  That is; no other alternatives than the ones showed (both "<" and ">" are
  113.  deleted). If you now press "4" the word you checked would be replaced with
  114.  "TO DO".
  115.  
  116.  If you don't see a correct alternative you have a set of other options;
  117.  
  118.  SPC:    Accept this time; if the word is met again you will be prompted again.
  119.  
  120.  "i":    Insert word in private dictionary.
  121.  
  122.  "a":    Accept this session; if the word is met again in this session (i.e.
  123.     if you don't kill the server or reset the machine) it will be
  124.     accepted as a correct word.
  125.  
  126.  "r":    Replace word; you will be prompted with a string requester where you
  127.     may enter a correct spelling of the word. The entered word will be
  128.     checked again.
  129.  
  130.  "u":    Like "i", but the word is lower cased before it is inserted.
  131.  
  132.  "q":    Quit (works like SPC if you are just checking a single word, but
  133.     stops checking if working on a buffer).
  134.  
  135.  "?":    The control keys above are showed in the status line of the Ispell
  136.     buffer (in two sets). Press "?" to switch between the help strings.
  137.  
  138.  -*- Alternative words menu (GUI) -*-
  139.  
  140.  If you use the GUI interface, the alternatives will be listed in a request
  141.  window. In the window are also check markers for the commands listed above.
  142.  If you double click on a word in the list, it will replace the misspelled
  143.  word.
  144.  
  145.  There are some limitations to the GUI interface;
  146.  If you want to enter a replacement word yourself, do it in the string
  147.  gadget. This string will *not* be rechecked! Also, if you select more of the
  148.  above listed commands, they will all be executed!
  149.  
  150.  
  151.  
  152. HISTORY (REV)
  153.  29.08.95 (3)    Added highlighting of misspelled word.
  154.  29.08.95 (2)    Added GUI per request from Kjell (used a bit of his code too).
  155.  01.08.95 (1)    Added block and file check.
  156.         Added dictionary autosave at exit.
  157.  17.07.95 (0)    Works pretty well. Still needs some work though.
  158.  
  159. BUGS
  160.  If a word in column 1 at line 1 is misspelled and you are checking
  161.  block/file, the shit hits the fan. Don't really know what to do about it,
  162.  except (of course :) to add a dirty hack.
  163.  
  164. TODO
  165.  
  166. SEE ALSO
  167.  Ispell documentation (not included).
  168.