home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / education / spell / !Spell / !Help < prev    next >
Text File  |  1991-10-19  |  5KB  |  163 lines
  1.  
  2.  
  3.                         Help file for !Spell
  4.                         ~~~~~~~~~~~~~~~~~~~~
  5.  
  6.  
  7.  
  8.                                 USER GUIDE
  9.                                 ~~~~~~~~~~
  10. Introduction
  11. ~~~~~~~~~~~~
  12. !Spell provides a RISC-OS environment for the SpellMaster relocatable module
  13. from Computer Concepts. Entering 'Help SpellMaster' will list the command
  14. line options that the module provides: !Spell uses SpellMaster's SWI
  15. interface.
  16.  
  17. !Spell is a fast, versatile, spelling checker. It can check a document at
  18. about a page per second.
  19.  
  20. !Spell has a built in dictionary, which cannot be modified, and the ability
  21. to load, create, and update user dictionaries. This release of !Spell
  22. includes an example dictionary aimed at GCal users.
  23.  
  24. To check the spelling in a file
  25. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  26. Either drag the file's icon in the filer onto the !Spell icon, or drag the
  27. icon from the 'Save' dialogue box within Edit.
  28.  
  29. If the file contains spelling errors these will be listed in an Edit window,
  30. together with the relevant line number.
  31.  
  32.  
  33. Make dictionary
  34. ~~~~~~~~~~~~~~~
  35. Create a dictionary by dragging a text file onto the icon when 'Make
  36. dictionary' has been selected.
  37.  
  38. The text file should contain a list of words, separated by a space, line
  39. feed or carriage return. The list does not have to be in alphabetical order.
  40. Only new words will actually be added.
  41.  
  42. If the dictionary exists already on disc, it will be overwritten. If a
  43. dictionary of the same name is currently loaded, the new dictionary will
  44. not be created and a warning will be given. 
  45.  
  46.  
  47. Load dictionary
  48. ~~~~~~~~~~~~~~~
  49. Dictionaries are kept in <SDicts$Dir>. This is set to !Spell.Dicts in the
  50. !Run file. Selecting 'Load dictionary' will display this directory: Double
  51. click on a dictionary to load it. Once a dictionary has been loaded it will
  52. be used with other loaded dictionaries and the built in dictionary when
  53. searching for words.
  54.  
  55.  
  56. List dictionary
  57. ~~~~~~~~~~~~~~~
  58. This lists the contents of the selected dictionary in an Edit window. Once
  59. in Edit the list can be manipulated, added to, saved, etc.
  60.  
  61.  
  62. Remove dictionary
  63. ~~~~~~~~~~~~~~~~~
  64. Remove a dictionary from memory.
  65.  
  66.  
  67. Info
  68. ~~~~
  69. Gives program information.
  70.  
  71.  
  72. Browse
  73. ~~~~~~
  74. This is the fastest way of checking a word's spelling. Browse can be
  75. selected by a left button click on the icon, or by selecting 'Browse' from
  76. the menu. Keys are:
  77.  
  78.   A-Z or a-z or ' (quote): Build up browse word and scroll appropriately
  79.   <Delete> or <Back Space>: Delete last letter from browse word
  80.   <Esc>: Delete browse word completely
  81.  
  82. Note, however, that SpellMaster does not keep words in strict alphabetical
  83. order, so you may have to complete a word's spelling before you can be
  84. certain that it is spelled incorrectly, or is not in a loaded dictionary.
  85.  
  86.  
  87. Add word and Delete word
  88. ~~~~~~~~~~~~~~~~~~~~~~~~
  89. 'Add word' and 'Delete word' menu choices are used to add or delete a word
  90. to or from a specified dictionary. A dictionary can be saved to disc
  91. automatically after it has been modified if the 'Save' option is on. By
  92. default 'Save' is selected.
  93.  
  94. If you have a large number of words to add to a dictionary it is more
  95. efficient to list the dictionary (using the 'List dictionary' option), add
  96. the new words to the end of it, select 'Make dictionary', then drag or save
  97. this modified dictionary to the !Spell icon.
  98.  
  99.  
  100. Check word
  101. ~~~~~~~~~~
  102. Use this to check the spelling of a word. 
  103.  
  104.  
  105. Notes
  106. ~~~~~
  107. Currently !Spell ignores one or two lettered words (ie it assumes they are
  108. spelt correctly) - this can be changed if needed.
  109.  
  110.  
  111.                         SPELLMASTER ANNOYANCES
  112.                         ~~~~~~~~~~~~~~~~~~~~~~~
  113. System dictionary not accessible.
  114.  
  115. SWI Spell_CheckWord returns the carry flag: should return a reg value.
  116.  
  117. SWI Spell_FileToUser hangs if dictionary already exists.
  118.  
  119. System dictionary contains some ridiculous words: ADFS, baa, David, Fred.
  120. Also two versions of same word: caramelising/caramelizing, realise/realize.
  121. This is very bad.
  122.  
  123. SWI calls do not appear to return errors.
  124.  
  125. Dictionary names must be less than 10 characters: this conflicts with
  126. RISC-OS. Also forced to upper case.
  127.  
  128. All strings (including file leaf names) handed to the SWI calls must be in
  129. upper case - this is not documented.
  130.  
  131. Added words do not appear in alphabetical order.
  132.  
  133. SWI Spell_CreateUser hangs if the dictionary is already loaded. 
  134.  
  135. Spell master cannot handle prefixed quotes.
  136.  
  137.  
  138. Bugs, things to do and concerns
  139. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140. Prefixed quote: DON'T try checking/adding/deleting a word that has a
  141. prefixed quote (eg 'abit). It will stiff the machine. This is to do with
  142. SpellMaster.
  143.  
  144. Add warning to indicate that a dictionary has been modified
  145.  
  146. Case sensitivity to be added: word prefixed by 'xx', followed by three or
  147. four characters which define the UC/LC case pattern of the word, followed by
  148. the word itself. Decode() and Encode() routines needed.
  149.  
  150. <Wimp$Scrap> file not deleted following an Edit to Spell transfer. 
  151.  
  152. 'Ignore' dictionary is currently ignored - which is the best thing for it.
  153.  
  154.  
  155.                                 CHANGES
  156.                                 ~~~~~~~
  157. 0.02      First released version
  158. 13 Jul 89 
  159.  
  160. 0.03      Use of SpellMaster error numbers to remove 'Internal error 5' bug
  161. 27 Jul 89 and duplication of typo list when no match found in 'CheckWord'.
  162.  
  163.           'List Dictionary' now lists words separated by LFs, not CRs.