home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / spell / sp2help.ini < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.6 KB  |  135 lines
  1.  
  2. -- Instructions for modifing/enhancing this Help file are
  3. -- found in the readme_first.doc file
  4. 1 HELP
  5. This is the Help Facility for the Speller. More information
  6. on specific topics may be obtained by entering the leading portion
  7. of the name of any of the topics.
  8.  
  9. To get the list of topics available at any time, enter a ? at
  10. the prompt.
  11.  
  12. To list the information on all topics below the current topic, enter
  13. a * at the prompt.
  14.  
  15. To exit the Help Facility, enter a <CR> for each level of information.
  16. 2 BATCH
  17. A direct batch operation is accomplished in the following manner:
  18.  
  19.   (1) Enter the following command
  20.  
  21.       speller F=document_name,W=word_list_name[,M,A,[U=user dictionary,...]]
  22.  
  23.       The parameters  may be entered positionally and/or by using
  24.       named parameter association. NOTE: Once named parameter association
  25.       is used on one of the parameters all remaining parameters MUST
  26.       use named parameter association.
  27.  
  28.       Defaults are as follows :
  29.  
  30.       Master dictionary is enabled   - enter M parameter to disable
  31.       Acronym dictionary is disabled - enter A parameter to enable
  32.       No user dictionaries           - enter U=dictionary_file_name
  33.                                                parameter (maximum of 6)
  34.  
  35.   (2) If the required file names (document_name and word_list_name) are
  36.       both missing and no other parameters are entered the operation
  37.       defaults to interactive. If one of the required file names is
  38.       missing the operation terminates with an error message.
  39.  
  40. 2 CREATING_A_USER_DICTIONARY
  41.  A dictionary may be created to include user specific words not found
  42.  in the master dictionary or the acronym dictionary included with
  43.  the Speller.
  44.  
  45.  A dictionary file is a sequential file containing one word per line.
  46.  It may be created using any editor.
  47.  
  48.  Another method to create a dictionary is:
  49.  
  50.     (1)  disable all dictionaries.
  51.     (2)  disable the Speller Corrector.
  52.     (3)  spell check a document containing the words
  53.          to be included in the newly created dictionary.
  54.     (4)  the file containing words not found during the spell check
  55.          will be in dictionary form and can be used as a user
  56.          dictionary file.
  57.  
  58.  When a dictionary is created, it is automatically enabled and will be
  59.  searched when a document is checked.
  60.  
  61. 2 LIST
  62.  List will produce a listing of a dictionary either to the screen or
  63.  to a user defined file.
  64.  
  65.  The terminal may be selected by entering a single space character in
  66.  response to the prompt.
  67.  
  68. 2 MERGE
  69.  Merge will merge two dictionary files to form a single dictionary
  70.  file. The two input dictionaries are deleted when the merge is
  71.  complete.
  72.  
  73.  The merge will maintain the lexical order of the two input files.
  74.  
  75.  A response of a carriage return is interpreted as a request to terminate
  76.  the operation.
  77.  
  78. 2 SPELL
  79.  Spell is an interactive process that facilitates the correction of
  80.  suspect words found in the document. The corrections will be made
  81.  and reflected in the document as they are encountered.
  82.  
  83. 3 ENABLE_DICTIONARY
  84.  A dictionary must be enabled to be included in the dictionary search
  85.  list used to find words in a document.
  86.  
  87. 3 DISABLE_DICTIONARY
  88.  A dictionary that has been disabled will not be used in the dictionary
  89.  search list used to find words in a document.
  90.  
  91. 3 REPLACE
  92.  Replacements can be indicated by looking up possible candidates or
  93.  by entering the chosen spelling directly through the keyboard.
  94.  The two types of REPLACE are:
  95.  
  96.        [R]eplace this occurrence and all future occurrences.
  97.  
  98.        [O]nly replace this occurrence.
  99.  
  100. 3 ACCEPT
  101.  Accept indicates the spelling of the word will not be changed.
  102.  The two types of ACCEPT are:
  103.  
  104.        [A]ccept this spelling as correct for this occurrence and all
  105.           future occurrences.
  106.  
  107.        [T]his is the only occurrence to accept.
  108.  
  109. 3 LOOKUP
  110.  Lookup provides a list of possibly correct spellings from which to choose.
  111.  Choices can be made by number.
  112.  
  113. 3 UPDATE
  114.  Update a user dictionary by adding this word.
  115.  
  116.  If there is more than one user dictionary presently enabled, a list of
  117.  enabled dictionaries from which to choose will be given.
  118.  
  119.  If there is only one user dictionary, the word is added to this dictionary.
  120.  
  121. 3 DELETE
  122.  Delete allows for the deletion of a word from a user dictionary.
  123.  
  124.  If there is more than one user dictionary presently enabled, a list of
  125.  enabled dictionaries from which to choose will be given.
  126.  
  127.  If there is only one user dictionary, the word is deleted from this
  128.  dictionary.
  129.  
  130. 3 QUIT
  131.  Quit terminates the session without the current modifications.
  132.  
  133. 2 QUIT
  134.  Quit indicates the user wishes to terminate this session.
  135.