home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 495a.lha / AZspell_v1.02 / AZspell.DOC.pp / AZspell.DOC
Text File  |  1991-04-06  |  13KB  |  280 lines
  1.  
  2.  
  3.                                  AZSPELL
  4.                                  -------
  5.  
  6.                         The Amiga spelling checker
  7.                         --------------------------
  8.  
  9.                                    by
  10.  
  11.                               Danny Hartley
  12.  
  13.                      Copyright © Danny Hartley, 1990.
  14.  
  15.  
  16.     AZspell and AZmerge can be used and distributed freely, but they are not
  17.     public domain. The author retains copyright. They may not be sold for
  18.     profit, or included with any commercial product without prior permission
  19.     from the author. This document must be supplied with the programs and
  20.     must not be modified.
  21.  
  22.     AZdictionary is supplied 'as is' for public domain, and may be modified
  23.     and redistributed in a modified form - no guarantee is expressed or
  24.     implied as to the correctness of the words contained in the file. 
  25.  
  26.  
  27.  
  28.     AZspell and AZmerge were written in 68000 assembly language using the
  29.     excellent HiSoft Devpac2 assembler.
  30.  
  31.  
  32.  
  33.     The files supplied are:
  34.  
  35.        AZspell        -  The spelling checker program
  36.        AZmerge        -  The dictionary update program
  37.        AZassign       -  A script to assign AZspell:
  38.        AZdictionary   -  The dictionary
  39.  
  40.     and their associated icons (.info files)
  41.  
  42.  
  43.        If you, like me, have great problems with spelling and/or your
  44.     typing fingers tend to hit every key except the one that your brain
  45.     told them to hit, then this is the program for you. A quick and simple
  46.     to use spelling checker.
  47.        All the files supplied have icons attached so that they may be
  48.     moved from volume to volume from the Workbench screen.
  49.  
  50.        When a document is checked, words that cannot be found in the
  51.     dictionary can be simply added to the dictionary so that they are
  52.     remembered for the next time. The program uses an intermediate file
  53.     called AZupdate to allow you to check the words, should you need to,
  54.     before committing them to the main dictionary. The intermediate file
  55.     also has several more uses (see AZmerge and AZspell:Special Mode).
  56.  
  57.  
  58.     INSTALLING THE SPELLER
  59.     ----------------------
  60.  
  61.        For the speller to be most useful, that is, to allow words to be
  62.     added to the dictionary, it is best installing it onto a separate
  63.     disc. Installation is very simple.
  64.  
  65.        If you require the speller to be kept on it's own disc, then format
  66.     a disc (initialize it), and rename it to AZspell. Once you have done that
  67.     then copy the files AZspell, AZmerge and AZdictionary onto the disc (by
  68.     dragging the icons from this drawer onto the new disc). As the disc is
  69.     called AZspell the program AZassign is not needed.
  70.  
  71.        If you require the speller to be in a drawer on part of a disc, as
  72.     you would for a hard disc, then create the drawer for it (dragging
  73.     Empty from a Workbench disc would do), and copy the files AZspell,
  74.     AZmerge, AZassign and AZdictionary into the drawer. AZassign has to
  75.     be in the same drawer that AZdictionary is in, AZspell and AZmerge
  76.     could in fact be anywhere you choose to place them (except the bin!).
  77.  
  78.        If you use AZassign then you will also need the following
  79.     Workbench V1.3 commands (in the C: directory) :
  80.  
  81.       Run, FailAt, Execute, CD, IconX, Assign and Echo.
  82.  
  83.  
  84.  
  85.     AZassign
  86.     --------
  87.  
  88.        To allow maximum flexibility of speller configuration, ie. where
  89.     it is - from it's own separate floppy disc to a directory on a hard
  90.     disc, the speller uses a logical device name of AZspell: to store the
  91.     dictionary and update files on. If the speller resides on it's own disc
  92.     with a volume name of AZspell then you can ignore this program. If not
  93.     then copy AZassign along with AZspell, AZmerge and AZdictionary to the
  94.     drawer where you wish the speller to be.
  95.        Whenever you need to use AZspell or AZmerge then run AZassign first
  96.     by double clicking on the AZassign icon. After AZassign has run then
  97.     whenever you run AZspell or AZmerge they will be able to find the
  98.     dictionary.
  99.  
  100.        NOTE: AZassign only has to be run once and of course after
  101.              the Amiga has been reset/turned off etc.
  102.  
  103.  
  104.     AZspell
  105.     -------
  106.  
  107.        AZspell is the spelling checker program. To run it just double click
  108.    on it's icon. Once it has loaded the dictionary a window will appear
  109.    prompting you for the name of the document that you wish to check.
  110.        Just type the name of your document then press Enter, the name will
  111.    normally have to include the drive and/or directory of where the document
  112.    is, eg. df0:reports/report1. If the file could not be found or could not
  113.    be loaded an error message is displayed along with an AmigaDOS error
  114.    code, to allow you decide what is wrong.
  115.  
  116.        The main part of the program is the checking window. It consists of
  117.    several sections.
  118.        The first section is the word stats, how many words are in the
  119.    dictionary and document (file). How many words have been checked so far,
  120.    how many were not found and how many are only used once. Please note to
  121.    make the checker check words quickly and only stop at words it can't find
  122.    the last three stats are only refreshed whenever the program has to wait
  123.    for a response from the user (you).
  124.        Underneath the stats is a correction box that allows you to type in
  125.    a new word whenever a word cannot be found.
  126.        At the bottom is a line from the document with the current word being
  127.    checked highlighted in the centre.
  128.        On the right hand side is a suggestions box. When a word can't be
  129.    found then a list of thirty closest possible words is generated. The
  130.    list takes words from the dictionary (including the word(s) added) and
  131.    any from the words ignored (they are remembered). This process takes
  132.    several seconds to complete. When the list has been compiled the words
  133.    are listed in order from the closest word at the top. To move the
  134.    list up and down use the Up and Do boxes respectively. Usually the word
  135.    you are looking for will be in the top few. If you wish to use one of
  136.    the words from the list of suggestions then just click on the word. It
  137.    will then be copied into the correction box, to allow it to be used for
  138.    correction.
  139.        A valid word (one that will be checked) is defined as a group of two
  140.    or more characters, the initial character must be alphabetic, the
  141.    remaining characters can be alphabetic, an apostrophe or a hyphen.
  142.    Anything that is not a valid word is not checked by the program.
  143.        The final section is the four boxes in the middle. These are for
  144.    instructing the program what to do when it can't find a word.
  145.  
  146.       Add to dictionary - If the highlighted word in the document is not
  147.                           already in the dictionary then it will be added
  148.                           to the dictionary (via AZupdate).
  149.  
  150.       Ignore word       - Ignores the highlighted word but remembers it.
  151.                           If you ignore a word then any further occurrences
  152.                           of the word will also be ignored.
  153.  
  154.       Correct word      - Corrects the word with the word(s)/characters in
  155.                           the correction box. If the correction box contains
  156.                           a single valid word that is not already in the 
  157.                           dictionary then it will be remembered.
  158.  
  159.                           Correct word also has another mode. If the
  160.                           correction box is empty then the word will be
  161.                           completely ignored and not remembered.
  162.  
  163.       Correct and Add   - As Correct word but the correction box must only
  164.                           contain a single valid word. If the word is not
  165.                           already in the dictionary then it will be added
  166.                           to the dictionary (via AZupdate).
  167.  
  168.        The spelling checker can be stopped before all the words have been
  169.    checked by clicking on the close gadget.
  170.  
  171.        When all the words have been checked (or you have stopped the speller
  172.    part way through) and words in the document have been corrected then a
  173.    window will appear asking you for the name to save the document under.
  174.        If words have been added to the dictionary then the words are saved
  175.    to the AZspell disc/directory in the file AZspell:AZupdate.
  176.        If you click on the close gadget when asked for the name to save the
  177.    document under then the document save AND the AZupdate save will both
  178.    be aborted.
  179.  
  180.    Special Mode
  181.  
  182.        AZspell has a special mode that allows the automatic collection of
  183.    mis-spelled/not found words in a document. This mode is only available
  184.    from the CLI/Shell as normally the machine would be left unattended,
  185.    controlled from a script. The command line format is:
  186.  
  187.        AZSPELL [<file> [!]]
  188.  
  189.        If the filename <file> is not specified then AZspell behaves as
  190.    normal just as if you had run it from the Workbench. If <file> is given
  191.    then it is loaded but otherwise nothing different. If a ! is given after
  192.    the filename, then the file is loaded, the checking window appears, but
  193.    if a word can't be found then it is automatically added to the dictionary
  194.    just as if you had click in the 'Add to dictionary' box. When AZspell
  195.    has completed then the file AZupdate can be examined to find any suitable
  196.    words for adding to the dictionary. In this way a large and thorough
  197.    dictionary can be easily built up.
  198.  
  199.        If you do use this on a lot of documents and leave your Amiga running
  200.    while you watch Neighbours, then the script below should provide a
  201.    suitable starting point.
  202.  
  203.            echo >ram:fried_egg "** file1 **"
  204.            azspell file1 !
  205.            join azspell:azupdate ram:fried_egg to ram:spam
  206.            echo >>ram:spam "** file2 **"
  207.            azspell file2 !
  208.            join azspell:azupdate ram:spam to ram:fried_egg
  209.            echo >>ram:fried_egg "** file3 **"
  210.            azspell file3 !
  211.            join azspell:azupdate ram:fried_egg to ram:spam
  212.  
  213.       and so on...
  214.  
  215.  
  216.    AZmerge
  217.    -------
  218.  
  219.        This program merges the words in AZupdate with the main dictionary
  220.    AZdictionary. After checking a document and you are sure that the words
  221.    that you have added to the dictionary (using Add to dictionary/Correct
  222.    and Add) are all correct then run this program by simply double clicking
  223.    on it's icon. A window will appear to tell you that it is running.
  224.  
  225.        If you wish to add many words to the dictionary and don't want to
  226.    go through AZspell clicking 'Add to dictionary' all the time, then
  227.    using your favourite text editor, create a file of words and save it
  228.    as AZspell:AZupdate.
  229.        There must only be one word per line, each word must have two or
  230.    more characters, the initial must be alphabetic, each remaining character
  231.    can only be alphabetic, a hyphen or apostrophe - case doesn't matter,
  232.    any lower case letters are converted to upper case. AZupdate does not
  233.    need to be sorted.
  234.        Once AZupdate has been created then run AZmerge. Any words that are
  235.    already in the dictionary will be ignored, similarly if a word occurs
  236.    two or more times then only the first occurrence will be used.(This 
  237.    could be used to join another dictionary with the main one)
  238.  
  239.    AZdictionary
  240.    ------------
  241.  
  242.        This is the actual dictionary that AZspell uses to determine if a
  243.    word is correct or not, or isn't in the dictionary. The dictionary has
  244.    currently almost 12000 words which is hardly the whole English language
  245.    but does contain the most used words, so should be good for most of the
  246.    time unless you use very exotic words a lot. I should like to point out
  247.    that even though I have personally checked the whole dictionary, a task
  248.    only slightly more interesting than watching paint dry, the odd word or
  249.    two may have slipped past my bleary eyes, so I make no claim that the
  250.    dictionary is 100% correct.
  251.  
  252.                         **  YOU HAVE BEEN WARNED  **
  253.    
  254.        You should always have a dictionary close to hand in any case.
  255.  
  256.        The dictionary is purely a simple text file, and can be viewed (and
  257.    edited) with any text editor. All the words contain two or more
  258.    characters, are in upper case with one word per line and in strict ASCII
  259.    ascending order. If you decide to edit the dictionary then ensure that
  260.    the above is still true, particularly ensure there are no empty lines,
  261.    especially at the end of the file.
  262.  
  263.  
  264.  
  265.  
  266.    Any queries, suggestions, spare cash, beer, etc. to:
  267.  
  268.      Danny Hartley
  269.      1 Alexandra Drive
  270.      Prestatyn
  271.      Clwyd
  272.      LL19 8BW
  273.      U.K.
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.