home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / apps / word / spel32 / spell.asc < prev    next >
Text File  |  1991-04-04  |  31KB  |  827 lines

  1.                        Spell/ST User Guide                   v3.2
  2.                  Murray Langton and David Tilley
  3.                            April, 1991   
  4.  
  5.   A versatile English spelling checker and dictionary maintainer
  6.  
  7.        Text enclosed in square brackets and the Appendices
  8.                 may be skipped at a first reading 
  9.  
  10.      0 INTRODUCTION                2 USING MAKEDICT.PRG
  11.         0.0 Distribution              2.0 Introduction
  12.         0.1 System Requirements       2.1 The 'Desk' Menu 
  13.         0.2 Files You Need            2.2 The 'Dictionaries' Menu
  14.         0.3 Overview                  
  15.         0.4 Limitations                 
  16.         0.5 Your Comments          APPENDICES
  17.      1 USING SPELL.PRG               A What is a Word?
  18.         1.0 Introduction             B Dictionary Format
  19.         1.1 The 'Desk' Menu          C Fatal Error Messages 
  20.         1.2 The 'File' Menu          D Background Information
  21.         1.3 The 'Options' Menu       E Known Bugs
  22.         1.4 The 'Dictionaries' Menu  F Improvements
  23.  
  24. 0 INTRODUCTION
  25.  
  26. 0.0 Distribution
  27.  
  28. Spell/ST and MakeDict are Copyright 1991 Murray Langton and David   
  29. Tilley.
  30.  
  31. Spell/ST and MakeDict are in the public domain. Commercial use of 
  32. all  or  any  part  of  this software or its dictionaries is for-
  33. bidden.
  34.  
  35. Spell/ST's dictionaries were accumulated from many  sources  over 
  36. the  years, too  many  to acknowledge individually.  However, the 
  37. following deserve special mention:
  38.  
  39.   Users and staff of the University of London Computer Centre
  40.   Jeff Horne's 'Codebreaker' disc of UK telephone exchange codes 
  41.  
  42. Mistakes in Spell/ST's dictionaries remain our fault, although we 
  43. accept no liability for them. We also accept no liability for use
  44. of the Spell/ST and MakeDict programs.
  45.  
  46. All manufacturers' trademarks are acknowledged. 
  47.  
  48. 0.1 System Requirements
  49.  
  50. You need an Atari ST with at least 400 kilobytes' free memory  to 
  51. run  Spell/ST.  On  a 520 ST or a 1040 ST, you may have to remove 
  52. one or more of your  desktop  accessories  before  Spell/ST  will 
  53. work.  MakeDict requires at least 360 kilobytes' free memory. 
  54.  
  55. Since neither program has been tested on an STE or on versions of  
  56. TOS  later  than  1.0  (1985), we would appreciate reports on how  
  57. they behave with such systems.
  58.  
  59. Both Spell/ST and MakeDict work with  Atari's  high-  or  medium-
  60. resolution monitor, but not in low resolution. They have not been
  61. tested with large screens.  
  62.  
  63. Spell/ST  and  MakeDict  are designed to be run from hard disc or 
  64. ram disc; they are very slow when used from diskette.
  65.  
  66. Because MakeDict needs access to the '.WRD' files and enough disc
  67. space to create the MASTER.DIC and MASTER.IND  files,  it  cannot 
  68. run  satisfactorily  on  systems  having  only  one  single-sided  
  69. diskette drive.
  70.  
  71. 0.2 Files You Need
  72.  
  73. Before using Spell/ST, you should ensure that you have the  foll-
  74. owing six files:
  75.      
  76.   File name      Description
  77.   
  78.   MASTER.DIC     Spell/ST's master dictionary (binary)
  79.   MASTER.IND     Index to Spell/ST's master dictionary (binary)
  80.   READ.ME        Information not in SPELL.ASC
  81.   SPELL.ASC      This document
  82.   SPELL.PRG      Executable Spell/ST program 
  83.   SPELL.RSC      Spell/ST's resource file
  84.  
  85. All should be placed in the same folder as SPELL.PRG  or  in  the 
  86. root directory of the drive containing it.
  87.  
  88. Before  using  MakeDict, you should ensure that you have at least
  89. the following eight files: 
  90.  
  91.   File name      Description
  92.   
  93.   COMPUTER.WRD   Dictionary of computerese terms (text)    
  94.   MAIN.WRD       Dictionary of English words (text)
  95.   MAKEDICT.ASC   This document (same as SPELL.ASC)
  96.   MAKEDICT.PRG   Executable MakeDict program  
  97.   MAKEDICT.RSC   MakeDict's resource file
  98.   MAKEDICT.SET   Default location of '.WRD',  '.DIC'  and  '.IND'  
  99.                  files (not to be edited)
  100.   NAMES.WRD      Dictionary of names and places (text)
  101.   READ.ME        Information not in MAKEDICT.ASC
  102.  
  103. All should be placed in the same folder as MAKEDICT.PRG or in the
  104. root directory of the drive containing it.
  105.  
  106. You do not need MakeDict to run Spell/ST.  They could be supplied
  107. separately by your BBS or archive system. 
  108.  
  109. 0.3 Overview
  110.  
  111. Spell/ST reads text from a file, breaks that text up into  words, 
  112. looks up each word in a dictionary, and displays those words that 
  113. it couldn't find.  It has some knowledge of plurals, suffixes and 
  114. prefixes.  Spell/ST  ignores  some  text-formatting  commands and 
  115. works on 1st. Word Plus '.DOC' files. It also detects consecutive
  116. duplicate words and most common split infinitives. 
  117.  
  118. Various optional facilities are available:
  119.  
  120.   o  four formats for the display of unrecognised words 
  121.  
  122.   o  ignore words containing only upper-case letters, digits, and
  123.      special characters 
  124.  
  125.   o  suggestions for the correct spelling of unrecognised words 
  126.  
  127.   o  supply up to three personal dictionaries to  supplement  the
  128.      standard dictionaries
  129.  
  130.   o  supply a personal 'reject' dictionary containing words which
  131.      are  to  be  treated as unrecognised, even if they appear in
  132.      another dictionary
  133.  
  134.   o  which, if any, of the dictionaries should be used
  135.  
  136.   o  create a dictionary
  137.  
  138.   o  log unrecognised words
  139.   
  140.   o  add Spell/ST's report to a file
  141.   
  142. There are many words which can be  spelt  with  either  'ise'  or
  143. 'ize' at the end, recognise or recognize, for example.   For such 
  144. words,  Spell/ST  will accept either form (or most variants), but 
  145. will report those words which are spelt inconsistently  within  a 
  146. document.
  147.  
  148. The master dictionary used by Spell/ST is constructed from  three
  149. smaller dictionaries for ease of maintenance. The 'main' diction-
  150. ary  contains English words (but not words valid only in American
  151. English), the 'names' dictionary names of people and places,  and 
  152. the 'computer' dictionary computing terms. A few words may appear 
  153. in more than one dictionary. The master dictionary may optionally
  154. contain  a  reject  dictionary  and three other dictionaries con-
  155. structed by you. 
  156.  
  157. As far as Spell/ST is concerned, all dictionaries  are  contained 
  158. by  one  file called MASTER.DIC.  The MakeDict program is used to 
  159. construct a MASTER.DIC file from the various '.WRD'  files  supp-
  160. lied  with Spell/ST or constructed by you.  MakeDict is described 
  161. in chapter two. 
  162.  
  163. 0.4 Limitations
  164.  
  165. Please note that Spell/ST merely reports words  from  a  document
  166. which were not found in a dictionary; these represent _potential_ 
  167. spelling mistakes rather than actual mistakes. In practice, there 
  168. will be some spelling mistakes, some technical terms, some abbre- 
  169. viations, and some  words which are correctly spelt but which are 
  170. not (yet) in a dictionary.
  171.  
  172. Spell/ST cannot locate mistakes which produce some other correct-
  173. ly spelt word, nor does it check context, grammar or punctuation.
  174.  
  175. Spell/ST has no facilities for interactive spelling correction.
  176.  
  177. Areas where Spell/ST is known to be weak include the following:
  178.  
  179.   o  No distinction is made between upper- and lower-case letters
  180.      
  181.   o  No attempt is made to check that  's  is used  correctly  at
  182.      the  end of a word, though other abbreviations using  '  are
  183.      checked
  184.      
  185.   o  Hyphenated words are not always  recognised,  especially  if
  186.      they are split at the end of a line
  187.  
  188. Please see Appendices D, E and F for further discussion.
  189.  
  190. 0.5 Your Comments
  191.  
  192. Comments  on  how  Spell/ST or MakeDict may be improved should be  
  193. e-mailed to David Tilley at:
  194.  
  195.     DRT10@UK.AC.CAM.PHX                  on JANET 
  196. or  DRT10%PHX.CAM.AC.UK@CUNYVM.CUNY.EDU  on Internet
  197.  
  198. or telephoned to +44 (0)81-399 8372; but please see  Section  0.4 
  199. and  Appendices D, E and F before making them.  Your  suggestions 
  200. for additions or corrections to Spell/ST's dictionaries should be 
  201. sent by e-mail; other people could benefit from them in  a  later 
  202. release.
  203.  
  204. 1 USING SPELL.PRG
  205.  
  206. 1.0 Introduction
  207.  
  208. Double-click on the SPELL.PRG icon.  You will then see the titles
  209. of five drop-down menus.  Their functions are described below. 
  210.  
  211. 1.1 The 'Desk' Menu
  212.  
  213. The 'Desk' menu looks something like the following: 
  214.  
  215.     ----
  216.    |Desk|
  217.    |-------------------
  218.    | About Spell/ST... |
  219.     -------------------
  220.  
  221. Our copyright notice and Spell/ST's  version number are displayed 
  222. when you click on the 'About Spell/ST...' item.
  223.  
  224. 1.2 The 'File' Menu
  225.  
  226. The 'File' menu looks something like the following:
  227.  
  228.     ----
  229.    |File|
  230.    |-------------------
  231.    |  Scan document... |
  232.    |  Report to disc   |
  233.    |-------------------|
  234.    |  Quit Spell/ST    |
  235.     -------------------
  236.  
  237. Scan document: 
  238. Use this item to bring up the usual (or your preferred) file sel- 
  239. ector.  Choose the name of the file  containing  the  text  whose
  240. spelling  is  to  be  checked.  The first time you use this item, 
  241. Spell/ST loads its master dictionary;  this takes about four sec-
  242. onds from hard disc, and about fifty seconds from  diskette.  You 
  243. can use this item to check in turn as many documents as you wish.
  244.  
  245. The  time  taken to produce a complete report varies according to 
  246. the size of a document and your equipment.  For example, Spell/ST 
  247. took  about  one minute to scan a copy of this guide held on hard 
  248. disc and about one-and-a-quarter minutes for a copy on diskette.         
  249.  
  250. Report to disc:
  251. Spell/ST normally sends its reports to a scrolling  window  only. 
  252. By  clicking  on  this  item,  the report will also be added to a 
  253. file, SPELL.REP in the folder from which SPELL.PRG was executed. 
  254.  
  255. The report produced by Spell/ST will contain:  
  256.  
  257.   o  the location of split infinitives and consecutive  duplicate 
  258.      words
  259.  
  260.   o  the number of lines and words in the file being checked 
  261.  
  262.   o  the time taken to check the file
  263.  
  264.   o  how many unrecognised words were found
  265.  
  266.   o  a list, in alphabetical order, of unrecognised words  
  267.  
  268. By default, only the 'main' English dictionary is used.  You  can 
  269. stop a report by pressing 'q' or 'Q' at the 'More...' prompt. 
  270.  
  271. You can use the 'Options'  and  'Dictionaries'  menus,  described 
  272. below,  to  alter  the  format  and  content of the report and to   
  273. select additional dictionaries. 
  274.  
  275. Quit Spell/ST:
  276. When  you're  finished, click on this item to return to the desk-
  277. top.
  278.  
  279. 1.3 The 'Options' Menu
  280.  
  281. The 'Options' menu looks something like the following:
  282.  
  283.     -------
  284.    |Options|
  285.    |----------------------
  286.    |  Alphabetical order  |    This item will have a tick mark...
  287.    |  Order of occurrence |
  288.    |  Words in context    |
  289.    |----------------------|
  290.    |  Duplicates          |    ...so will this...
  291.    |  Split infinitives   |    ...and this...  
  292.    |  Make suggestions    |  
  293.    |  Ignore u/c words    |
  294.    |----------------------|
  295.    |  Statistics          |    ...and this
  296.    |  Frequency counts    |
  297.    |----------------------|
  298.    |  Log unknown words   |
  299.     ----------------------
  300.  
  301. Items marked with ticks are Spell/ST's default options. 
  302.  
  303. Alphabetical order:
  304. This item causes an alphabetical list of all  unrecognised  words 
  305. to  be  produced.   Note than a frequency count of how many times 
  306. each word appeared is not included; see  the  'Frequency  counts' 
  307. option  below.  [Because  Spell/ST  has  to sort all unrecognised 
  308. words into alphabetical order, it will take longer to start prod-
  309. ucing a report compared with the 'Order of occurrence' and 'Words 
  310. in context' options (see below).]
  311.  
  312. Order of occurrence:
  313. List all unrecognised words in order of occurrence with each word
  314. preceded by the number of the line in which it occurs.  Note that 
  315. all occurrences of any unrecognised word will be displayed.
  316.  
  317. Words in context:
  318. Display all lines containing an  unrecognised  word,  preceded by 
  319. their  line  number,  and  underline  each unrecognised word with 
  320. carets (^).
  321.  
  322. Duplicates:
  323. Report consecutive duplicate words and their line number.
  324.  
  325. [A  common  mistake,  especially after a document has been edited
  326. several times, is to have two consecutive words the same. Genuine 
  327. duplicated words are rare in English, so Spell/ST will report any
  328. duplicated words and the relevant line number.  One of  the  dup-  
  329. licates may be at the end of the previous line. Since blank lines
  330. are not significant to Spell/ST, repetitions can be unnecessarily 
  331. reported between a section heading and  the  text  which  follows 
  332. it, for example.]
  333.  
  334. Split infinitives:
  335. Report split infinitives and their line number.
  336.  
  337. Make suggestions:
  338. Use this item to ask Spell/ST to make suggestions for the correct 
  339. spelling  of unrecognised words.  Unrecognised words for which no
  340. plausible suggestions can be made will be listed next  in  alpha- 
  341. betical  order.  We  recommended  you  use the 'Ignore u/c words'  
  342. option  (see  below)  when you use the 'Make suggestions' option; 
  343. this could help Spell/ST save time trying to find correct  spell-
  344. ings for file names and computerese, for example. 
  345.  
  346. Ignore u/c words:
  347. Use  this  item  to  make  Spell/ST  ignore words containing only 
  348. upper-case letters, digits and  special  characters.  This  could 
  349. help Spell/ST avoid checking non-existent words like file names.
  350.  
  351. Statistics:
  352. Produce  statistical  information  on  the file whose spelling is 
  353. being checked.
  354.  
  355. Frequency counts:
  356. Against each unrecognised word reported add the number  of  times 
  357. it occurred in the document. This is of use only with the 'Alpha-
  358. betical order' option.
  359.  
  360. Log unknown words:
  361. Cause  Spell/ST to add unrecognised words to a file, NEWWORDS.LOG 
  362. in the folder from which SPELL.PRG  is  executed.  Note  that  no 
  363. words  will be added unless the main, names and computerese dict-
  364. ionaries are selected.
  365.  
  366. [Unrecognised words are added to the log  in  alphabetical  order  
  367. and  the  name  of  the source document is not recorded.  You can
  368. periodically add valid words from NEWWORDS.LOG to  your  diction- 
  369. aries.]  
  370.  
  371. 1.4 The 'Dictionaries' Menu
  372.  
  373. The 'Dictionaries' menu looks something like the following:
  374.  
  375.     ------------
  376.    |Dictionaries|
  377.    |--------------
  378.    |  Main        |            This item will have a tick mark
  379.    |  Names       |             
  380.    |  Computerese |
  381.    |  Reject      |
  382.    |--------------|
  383.    |  User 1      |
  384.    |  User 2      |
  385.    |  User 3      |
  386.    |--------------|
  387.    |  All         |            or 'None'
  388.    |--------------|
  389.    |  Create...   |
  390.     -------------- 
  391.    
  392. A tick indicates Spell/ST's default dictionary.
  393.    
  394. Main:
  395. Select the dictionary of English words.
  396.  
  397. Of  the  three  dictionaries supplied with Spell/ST, we recommend 
  398. you use only the English dictionary when you first check a  docu-
  399. ment.
  400.  
  401. Names:
  402. Select the dictionary of names and places.
  403.  
  404. If you select the extensive  'names'  dictionary  without  having  
  405. previously  scanned your document without it, Spell/ST could fail 
  406. to detect a misspelling.  For example, 'bangor' could  be  recog-
  407. nised as valid when you really meant 'banger'.
  408.  
  409. Computerese:
  410. Select the dictionary of computerese words.
  411.  
  412. If you select the extensive 'computerese' dictionary without hav-
  413. ing  previously  scanned your document without it, Spell/ST could 
  414. fail to detect a misspelling.  For  example,  'pascal'  could  be 
  415. recognised as valid when you really meant 'rascal'.
  416.  
  417. There  are  many technical words which would not appear in a nor-
  418. mal dictionary. Spell/ST can be instructed to check words against  
  419. personal dictionaries supplied by you, besides checking its  own.  
  420. The following four options may be selected if you wish such dict-
  421. ionaries  to  be  used.   Please  note  that,  to  use  your  own 
  422. dictionaries, you'll have to construct a  new  master  dictionary 
  423. from them with the MakeDict program.
  424.  
  425. Reject:
  426. Select your dictionary of words to be rejected.
  427.  
  428. [You  may  often mistype a word as some other valid word, 'my' as    
  429. 'mu' or 'trial' as 'trail', for example.  To avoid  changing  the
  430. standard dictionaries to cope with this situation, you may  cons-
  431. truct  a  dictionary  containing  words  which  are  always to be  
  432. treated as unrecognised, regardless of  whether  they  appear  in 
  433. another  dictionary.  A  reject  dictionary could also be used to   
  434. cause  the  rejection  of  English  words  which  are  invalid in 
  435. American English; this could be used with a user dictionary  (see  
  436. below)  containing   words  which  are valid in American, but not 
  437. English, English.
  438.  
  439. You  could  construct Spell/ST dictionaries for another language.  
  440. The only restriction is that its alphabet  should  be  reasonably 
  441. represented by ASCII.] 
  442.  
  443. User 1:
  444. Select your first dictionary.
  445.  
  446. User 2:
  447. Select your second dictionary.
  448.  
  449. User 3:
  450. Select your third dictionary.
  451.  
  452. All:
  453. Cause all the above dictionaries to  be  selected,  if  they  are 
  454. present.
  455.  
  456. None:
  457. Cause all the above dictionaries to be de-selected.
  458.  
  459. [When  all  dictionaries are de-selected, Spell/ST will recognise 
  460. no words in your document.  'None' may be used with  the  'Alpha-
  461. betical order' option (see above) to produce an alphabetical list 
  462. of all the words in your document.]
  463.  
  464. The following menu item will be of interest to those who wish  to 
  465. maintain Spell/ST dictionaries.
  466.  
  467. [Create:
  468. This  menu item is used to instruct Spell/ST to prepare to create 
  469. a dictionary.  Fill the file-selector with the name of  a  '.WRD' 
  470. file.  When  you next use 'Scan document', the unrecognised words 
  471. in the document will be written to the '.WRD' file you specified. 
  472. That file will be suitable for adding to  the  master  dictionary 
  473. with MakeDict.
  474.  
  475. It  is a good idea to select all Spell/ST's standard dictionaries 
  476. - and all your own as well - when you use 'Create'.
  477.  
  478. If you selected a 'User 1' dictionary, it will be  extended  into
  479. the '.WRD' file with the unknown words from your document.  Words
  480. added  will  be marked to the right with '<', aiding the location
  481. and checking of the new words. 
  482.  
  483. Please note there is a limit of about 700 on the  number  of  un-
  484. known words which may added with 'Create'.]
  485.  
  486. 2 USING MAKEDICT.PRG
  487.  
  488. 2.0 Introduction
  489.  
  490. The MakeDict program is a utility for maintaining a Spell/ST mas-
  491. ter dictionary.  It reads some or all of the various '.WRD' files 
  492. supplied with Spell/ST - or amended or  provided  by  you  -  and 
  493. makes from them two files, MASTER.DIC and MASTER.IND. The idea is 
  494. regularly  to  add  to the '.WRD' files and occasionally to apply 
  495. MakeDict to them.
  496.  
  497. [Those who wish to maintain Spell/ST dictionaries should  consult
  498. Appendices A and B.  It is often easier to maintain your personal 
  499. dictionaries, not those supplied with Spell/ST.  Incidentally, we 
  500. recommend Tempus 2 for editing large '.WRD' files.] 
  501.  
  502. A  complete run of MakeDict takes a long time: about three-and-a-
  503. quarter minutes from hard disc and about  ten-and-a-half  minutes 
  504. from diskette, so it's not something you'll want to do too often.
  505. However, it is  worthwhile if you regularly use Spell/ST and wish 
  506. its dictionaries accurately to reflect your needs. You'll have to 
  507. use MakeDict if you wish Spell/ST to use any of the four personal  
  508. dictionaries.
  509.  
  510. 2.1 The 'Desk' Menu
  511.  
  512. MakeDict's 'Desk' menu looks something like the following:
  513.  
  514.     ----
  515.    |Desk|
  516.    |-------------------
  517.    | About MakeDict... |
  518.     -------------------
  519.  
  520. Our copyright notice and MakeDict's version number are  displayed 
  521. when you click on the 'About MakeDict...' item. 
  522.  
  523. 2.2 The 'Dictionaries' Menu
  524.  
  525. The 'Dictionaries' menu looks something like the following:
  526.  
  527.     ------------
  528.    |Dictionaries|
  529.    |----------------
  530.    | Select...      |            
  531.    | Save setup     |     This item is disabled on first entry... 
  532.    | Make           |     ...as is this...
  533.    | Information... |     ...and this
  534.    |----------------|
  535.    | Quit MakeDict  |
  536.     ----------------   
  537.     
  538. The disabled items will be activated later.
  539.  
  540. Select:
  541. When you click on this item, a multiple file-selector is display-
  542. ed which you fill with the  names  of  the  '.WRD'  files  to  be  
  543. included  in  your master dictionary; at least one must be speci-
  544. fied and you must supply a path for these.  The selector is  also 
  545. used  to  locate your master dictionary and its index.  Note that 
  546. their path may be different from that of the '.WRD' files.  Click
  547. on the 'Okay' button when you've made  your  selection.  MakeDict 
  548. will  complain  if you've typed incorrect path names or the names 
  549. of non-existent '.WRD' files. 
  550.  
  551. Save setup:
  552. Once  you  have  decided  which '.WRD' files to use, click on the 
  553. 'Save setup' item to save your selections for the next time.
  554.  
  555. Make:
  556. Click on this item to generate a master dictionary. This can take
  557. some time - see Section 2.0.
  558.  
  559. Information:
  560. Once the generation of the master dictionary is  complete,  click 
  561. on  the  'Information' item to obtain the following statistics on 
  562. the dictionaries you have used:
  563.  
  564.   o  the time taken to read or write a dictionary
  565.   
  566.   o  the number of words each dictionary contains
  567.   
  568.   o  the number of 'variants' (see Appendix  B)  each  dictionary 
  569.      contains
  570.  
  571.   o  the number of bytes occupied by each dictionary
  572.   
  573. Quit MakeDict:
  574. When  you're  finished, click on this item to return to the desk- 
  575. top.
  576.  
  577. APPENDIX A What is a Word?
  578.  
  579. Spell/ST usually considers each line  of  the  source  file  sep-
  580. arately.  The  exception  is when a word appears to be hyphenated 
  581. at the end of a line, in which case that line and  the  following 
  582. line are effectively joined and the hyphen removed.
  583.  
  584. Lines and/or words will be ignored when:
  585.  
  586.   o  a line starts with a full stop  
  587.  
  588.   o  a word is preceded by '\' or '|'  (text  in  round  brackets 
  589.      after such a word is also ignored)
  590.  
  591.   o  a letter is preceded by '$' 
  592.  
  593.   o  the first two characters in a line are '//' or '/*'
  594.  
  595. The  first  three  avoid  the  text-formatting  commands of GCAL,  
  596. LaTeX, PROFF, TeX and Tidy, whilst the last avoids MVS JCL.
  597.  
  598. Within a line, a word is a sequence of characters satisfying  the
  599. following conditions:
  600.  
  601.   o  each word is as long as possible
  602.  
  603.   o  a word starts with a  letter,  or  a  digit  followed  by  a
  604.      letter,  or the digit 1  followed by a digit followed  by  a
  605.      letter, and may contain letters and digits
  606.  
  607.   o  a  word  may  also  contain   full   stops,   hyphens,   and
  608.      apostrophes,  provided  that  each such special character is
  609.      preceded and followed by a letter or digit
  610.  
  611. Note that upper-case letters are effectively converted to  lower- 
  612. case  and  words  truncated  to a maximum of 26 characters.  One- 
  613. letter words and the two-character sequence 's at the  end  of  a 
  614. word are ignored. 
  615.  
  616. APPENDIX B Dictionary Format
  617.  
  618. Within  a  Spell/ST  dictionary  (with  a name ending in '.WRD'), 
  619. words are ordered first by length  (shortest  words  first),  and 
  620. then  alphabetically,  one word per line, with no leading spaces.  
  621. All letters are treated as if they were in lower case.  A  '.WRD'
  622. dictionary  may  contain comment lines preceded by an exclamation
  623. mark.
  624.  
  625. If you use Spell/ST's 'create' facility to extend a '.WRD'  file,
  626. the comments it contains will not appear in its extension. 
  627.  
  628. Spell/ST's master dictionary, contained in MASTER.DIC  and  cons-
  629. tructed  by  MakeDict  from the various '.WRD' files, is a binary 
  630. file not readable by you.  MakeDict issues a warning if the  size
  631. of  a master dictionary grows to within one per cent of the maxi-
  632. mum allowed, 290,000 bytes, at  present.  The  master  dictionary
  633. supplied  with  Spell/ST  has room for about a further 275 eight-
  634. letter  words,  excluding  variants.  Versions  of  Spell/ST  and 
  635. MakeDict having  larger  or  smaller  dictionary  capacities  are  
  636. available on request - see Section 0.5. 
  637.  
  638. Alphabetical order is as follows:
  639.  
  640.      . - ' abcdefghijklmnopqrstuvwxyz 0123456789
  641.  
  642. The size of the main dictionary has been reduced by a  factor  of 
  643. about 2.5 by attaching affix flags to word stems.  
  644.  
  645. A backslash '\' separates the word from the affix flags.  Various
  646. letters after the backslash represent rules for deriving affixes,
  647. as shown in the table which follows these examples:
  648.  
  649.   Word\flags        Represents
  650.  
  651.   stare\abc         stare, stares, staring, stared;
  652.   pose\bcstw        pose, posing, posed, unposed, repose,
  653.                     reposing, reposed, dispose, disposing,
  654.                     disposed;
  655.   divide\abcfhims   divide, divides, dividing, divided, divider,
  656.                     division, dividers, divisions, undivided;
  657.   affect\abchlmqs   affect, affects, affecting, affected,
  658.                     affection, affectation, affections,
  659.                     affectations, unaffected.
  660.  
  661. The affix flags, listed below, are ordered  so  that  prefix  and 
  662. suffix flags appear in separate groups arranged in order of freq-
  663. uency of occurrence.
  664.  
  665.  Flag   Action/condition           Prefix/suffix
  666.  
  667.    a    add                        -s
  668.    b    replace       -ee     by   -eeing
  669.         else replace  -e      by   -ing
  670.         else add                   -ing
  671.    c    replace -<consonant>y by   -ied
  672.         else replace  -e      by   -ed
  673.         else add                   -ed
  674.    d    replace       -ic     by   -ically
  675.         else replace  -y      by   -ily
  676.         else add                   -ly
  677.    e    replace       -y      by   -ies
  678.         else replace  -f      by   -ves
  679.         else replace  -fe     by   -ves
  680.         else add                   -es
  681.    f    replace -<consonant>y by   -ier
  682.         else replace  -e      by   -er
  683.         else add                   -er
  684.    g    replace       -ate    by   -acy
  685.         else replace  -ant    by   -ancy
  686.         else replace  -ent    by   -ency
  687.         else replace  -e      by   -y
  688.         else add                   -y
  689.    h    replace       -mit    by   -mission
  690.         else replace  -ibe    by   -iption
  691.         else replace  -ume    by   -umption
  692.         else replace  -de     by   -sion
  693.         else replace  -e      by   -ion
  694.         else add                   -ion
  695.    i    apply rule f,  then   add  -s
  696.    j    double last letter,   add  -ed   or  -ing
  697.    k    replace       -y      by   -iness
  698.         else add                   -ness
  699.    l    replace       -e      by   -ation
  700.         else replace  -y      by   -ication
  701.         else add                   -ation
  702.    m    apply rule h,  then   add  -s
  703.    n    replace       -ble    by   -bility
  704.         else replace  -acious by   -acity
  705.         else replace  -ous    by   -ity
  706.         else replace  -e      by   -ity
  707.         else add                   -ity
  708.    o    replace -<consonant>y by   -iable
  709.         else replace  -e      by   -able
  710.         else add                   -able
  711.    p    replace       -e      by   -est
  712.         else replace  -y      by   -iest
  713.         else add                   -est
  714.    q    apply rule l,  then   add  -s
  715.    r    apply rule b,  then   add  -s
  716.    s    add prefix               un-    apply rules c,j(-ed) only
  717.    t    add prefix               re-    apply rules a-r,x
  718.    u    add prefix               un-    apply rules a-r,x
  719.    v    add prefix               in-    apply rules a-r,x
  720.    w    add prefix              dis-    apply rules a-r,x
  721.    x    check consistent use of    -ise  and  -ize
  722.  
  723. APPENDIX C Fatal Error Messages
  724.  
  725. Spell/ST 
  726.  
  727. "A line is longer than 256 characters."                     
  728.   The document being scanned has at least one line containing 
  729.   more than 256 characters.
  730.   Solution: shorten the offending line(s).
  731.  
  732. "Can't find <filename>!"                                    
  733.   where <filename> is MASTER.DIC, MASTER.IND or SPELL.RSC. 
  734.   Solution: read Section 0.2.
  735.  
  736. "Error <letter> at address <address> {message}"             
  737.   If this occurs, please supply us with full details.
  738.  
  739. "The master dictionary is too big."                         
  740.   This occurs if MASTER.DIC is larger than 290,000 bytes.
  741.   Solution: apply MakeDict to fewer and/or smaller '.WRD' files.
  742.  
  743. "There are too many unknown words."                         
  744.   Possible solutions: select more dictionaries, use the 'Ignore 
  745.   u/c words' option, or correct some spelling mistakes. 
  746.  
  747. "Spell doesn't run at low resolution."    
  748.   Solution: select medium resolution or use a monochrome monitor.
  749.  
  750. MakeDict
  751.  
  752. "A dictionary word is too short."
  753.   Solution: remove the one-letter word from the offending '.WRD'
  754.   file.
  755.  
  756. "Can't find <filename>!"
  757.   where <filename> is MAKEDICT.RSC or MAKEDICT.SET.
  758.   Solution: read Section 0.2.
  759.  
  760. "Dictionary not ordered by size around line <line>."
  761.   Solution: relocate the word in the offending '.WRD' file.
  762.  
  763. "MakeDict doesn't run at low resolution."    
  764.   Solution: select medium resolution or use a monochrome monitor.
  765.  
  766. "The master dictionary will be too big."
  767.   Solution: select fewer and/or smaller '.WRD' files.
  768.  
  769. APPENDIX D Background Information
  770.  
  771. SPELL, implemented on mainframes  under  MVS  and  VM  by  Murray 
  772. Langton, doesn't have to worry about how much memory is used. The 
  773. dictionaries  are  held  in  human-readable form and converted to 
  774. internal form each time SPELL is used.
  775.  
  776. SPELL, implemented for  the  Atari  ST  micro-computer  by  David 
  777. Tilley, has been split into two parts: MakeDict takes the  human-
  778. readable dictionaries and converts them to internal form (includ-
  779. ing  index  construction).  Spell/ST  can then read the converted 
  780. dictionaries more quickly.  Split infinitive detection  has  been
  781. added.
  782.  
  783. The  problems  with SPELL on a micro-computer are the size of the 
  784. dictionaries and indices (some 300 kilobytes) and the time  taken 
  785. to  read them, especially from diskette.  We are considering ways
  786. of alleviating these problems.
  787.  
  788. In the meantime, we offer you a versatile, if rather  cumbersome,  
  789. package.
  790.  
  791. APPENDIX E Known Bugs
  792.  
  793. Spell/ST and MakeDict: window actions are sluggish immediately on 
  794. exit.  They soon recover, however.
  795.  
  796. Spell/ST's  'stack' was increased from 4 to 32 kilobytes to allow 
  797. for the detection of a very large number of unknown words.   This 
  798. may prove insufficient for some documents when the message 'There 
  799. are too many unknown words' appears.
  800.  
  801. If  you try to use 'Create' to add more than ~700 words, Spell/ST 
  802. can crash, after which the machine hangs.
  803.  
  804. In medium resolution only, if you click on  the  'About Spell/ST' 
  805. menu item _after_ scanning a document, the resulting form is cor-
  806. rupted and Spell/ST exits. This annoying bug is proving difficult 
  807. to track down but, fortunately, the machine doesn't hang.
  808.  
  809. Please report bugs via e-mail (see Section 0.5).
  810.  
  811. APPENDIX F Improvements
  812.  
  813. The following improvements to Spell/ST come to mind:
  814.   
  815.   Reduce size of master dictionary. )
  816.   Speed up document scan.           ) see Appendix D
  817.   Save on memory.                   )
  818.   Provide a Spell/ST desk accessory.  No point until the above
  819.     improvements are made.
  820.   Allow a dot in a MakeDict folder name.
  821.   Highlight unknown words in context output instead of using ^.
  822.   Improve treatment of end-of-line hyphens.
  823.   Provide interactive correction.
  824.  
  825. *** End of document ***
  826.  
  827.