home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / wp_dtp / spellche.lha / SpellCheck / SpellCheck.doc < prev    next >
Text File  |  1992-08-03  |  12KB  |  376 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10. SPELLCHECK V1.3        Written by Torgeir Dingsøyr 1991-1992. FREEWARE.
  11.  
  12.  
  13.             Freely distributable, as long as this documentation
  14.             is distributed along with the program.
  15.  
  16.         
  17.             FILES:         SpellCheck
  18.                     SpellCheck.info
  19.                     SpellCheck.doc
  20.                     SpellCheck.font
  21.  
  22.             REQUIRED FILES:    LIBS:arp.library
  23.                     LIBS:diskfont.library
  24.                     LIBS:powerpacker.library
  25.                     (C:run)                    
  26.                     (SYS:SYSTEM/SetMap)
  27.     
  28.  
  29.  
  30.  
  31.  
  32. CONTENTS OF THIS MANUAL:
  33. ­­­­­­­­­­­­­­­­­­­­­­­­
  34.  
  35. INTRODUCTION
  36.     What is SPELLCHECK?
  37.     How do I use it?
  38.     Requirements
  39.     Questions?    
  40.             
  41. 1.0 The "Project" Menu            
  42.     1.1 Clear All
  43.     1.2 Load
  44.     1.3 Append
  45.     1.4 Save
  46.     1.5 Save As
  47.     1.6 List
  48.     1.7 Info
  49.     1.8 About
  50.     1.9 Quit
  51.  
  52. 2.0 The "Special" Menu
  53.     2.1 Select Keymap
  54.     2.2 Preferences
  55.     2.3 Shortcuts
  56.     2.4 Low<>Uppercase
  57.     2.5 Help Off
  58.     
  59. 3.0 The "Words" Menu
  60.     3.1 Save ASCII
  61.     3.2 Import ASCII
  62.     3.3 Pattern
  63.     3.4 Uppercase
  64.     3.5 Lowercase
  65.     3.6 Swap
  66.     
  67. 4.0 The "Ask Mode" Menu
  68.     4.1 Automatic
  69.     4.2 Manual
  70.     
  71. 5.0 The Gadgets
  72.     5.1 Load
  73.     5.2 Save
  74.     5.3 List
  75.     5.4 Ask
  76.     5.5 Insert
  77.     
  78. APPENDIX A:    Shortcuts
  79. APPENDIX B:    Error Codes
  80. APPENDIX C:    Printing SPELLCHECK files
  81. APPENDIX D:    Additional information                
  82.             Limitations
  83.             In General
  84.             Technical Info
  85.             How to load 1.2 files
  86.             Wanted
  87.             Special Thanks
  88.  
  89.  
  90.  
  91.  
  92. INTRODUCTION.
  93. ­­­­­­­­­­­­­
  94.  
  95. What is SPELLCHECK?
  96. SPELLCHECK is a handy program, which enables you to use your computer to
  97. learn new words, whether it be German strong verbs, French words, or
  98. Spanish. You type in the words you want to be heard in, and the computer
  99. shows you the explanationand asks you to type in the german/french/
  100. spanish. (You can of course use any languages).
  101.  
  102. How do I use it?
  103. The program is very easy to use, so the simplest way to find out how it
  104. works is to try it out. If you should want to use some of the more advanced
  105. features, you should turn to this documentation for an explanation. The
  106. program will run both from the Workbench and from the CLI. From the CLI
  107. you may specify a filename after SpellCheck (ie SpellCheck <filename>)
  108. and SPELLCHECK will load that file.
  109.  
  110. Requirements:
  111. SPELLCHECK will refuse to run, if not arp.library, diskfont.library and
  112. powerpacker.library are present in libs: It is also a must to have RUN
  113. in C: and SETMAP in Sys:System to make full use of the program. If a
  114. font named "SpellCheck" lies in fonts: SPELLCHECK will load and use it.
  115. Make sure that the size is 8*8. 
  116.  
  117. Questions?
  118. If you have any questions concerning the use of this program, comments,
  119. bugreports, or suggestions on how to improve it, please write to: PANTHEON
  120. SOFTWORKS, Po. Box 2049-Høllen, 4641 SØGNE, NORWAY. If you want an answer,
  121. we kindly ask you to enclose an international reply coupon. (Or stamps, if
  122. you live in Norway).
  123.  
  124.  
  125. The functions available from SPELLCHECK are listed here, as they appear in
  126. the menus in the program.
  127.  
  128.  
  129. 1.0: THE "PROJECT" MENU:
  130. ­­­­­­­­­­­­­­­­­­­­­­­­
  131.  
  132. 1.1:    * CLEAR ALL will clear all the words you have typed in or loaded
  133.     into the program. You will get a requester, and have to click 'YES'
  134.     or type 'Y' on the keyboard to clear all the words. To clear just
  135.     one word read about LIST (1.6).
  136.  
  137. 1.2:    * LOAD (you can also click on the gadget, or press F1) will prompt
  138.     you with a requester, and you can select a file to load. The file
  139.     should be a file saved from SPELLCHECK previously. SPELLCHECK
  140.     will now load files crunched with PowerPacker.
  141.  
  142. 1.3:    * APPEND (shortcut: Amiga+A). This function will add a SPELLCHECK
  143.     file to the words that are in memory at the time. The new words will
  144.     be put at the end of the existing words. You will get a requester to
  145.     select the file.
  146.  
  147. 1.4:    * SAVE (shortcut: Amiga+S) will save the file under the existing
  148.     name. If no name is specified, the function will be the same as
  149.     SAVE AS.
  150.  
  151. 1.5:    * SAVE AS (shortcut: F2, also a gadget) You will have to select
  152.     a filename in a filerequester. The file will be saved in SPELLCHECK
  153.     format. You may also save the file as ASCII, using the function
  154.     "Save ASCII" in the "Words" menu. (see 3.1)
  155.  
  156. 1.6:    * LIST (also a gadget for this one, or F3) will open a new window,
  157.     where you can scroll up and down, and look at all the words that
  158.     are in memory. There are four gadgets at the bottom of the window:
  159.     CLOSE, which brings you back to the normal window, SWAP, DELETE and
  160.     SEARCH. When you click on a word with the mousepointer, there will
  161.     pop up a requester in which you can edit that word. If the SWAP
  162.     gadget is pressed down, and you click on a word, the two words
  163.     (for instance English and German) will be swapped. If the DELETE
  164.     gadget is pressed down, the word you click on will be deleted. If
  165.     you click SEARCH (or press 'S' on the keyboard), you will be
  166.     prompted with a requester, where you can type in a word to search
  167.     after. You can use normal (ARP) wildcards here: (* and ?).
  168.     For instance to search for all words that begin with "le", you
  169.     type "le *" in the requester. 
  170.  
  171. 1.7:    * INFO gives you some information. The size of the file in memory
  172.     is shown. (Size in memory, not on disk). The number of words in
  173.     the file, free memory, and the comment on the current file are
  174.     also displayed.
  175.  
  176. 1.8:    * ABOUT
  177.  
  178. 1.9:    * QUIT
  179.  
  180.  
  181. 2.0: THE "SPECIAL" MENU:
  182. ­­­­­­­­­­­­­­­­­­­­­­­­
  183.  
  184. 2.1:    * SELECT KEYMAP will enable you to select a new keymap, and load
  185.     it (a filerequester will come up). To use this function, you need
  186.     RUN in C: and SETMAP in Sys:System.
  187.  
  188. 2.2:    * PREFERENCES enables you to select your favorite colours, and to
  189.     make SPELLCHECK load a special keymap, whenever you start it. Your
  190.     preferences can be saved. (To the file devs:SpellCheck.prefs).
  191.  
  192. 2.3:    * SHORTCUTS brings up a list over the shortcuts available from
  193.     program.
  194.  
  195. 2.4:    * LOW<>UPPERCASE. Normally SPELLCHECK will look at uppercase and
  196.     lowercase letters as different, when it asks you in words. If you
  197.     want uppercase and lowercase to be the same, select this menuitem,
  198.     and it will change to LOW=UPPERCASE.
  199.  
  200. 2.5:    * HELP OFF. If you select this menuitem, it will read HELP ON, so
  201.     when you are being questioned by SPELLCHECK, you can get some help,
  202.     by using the menu, or shortcut Amiga+H. First the program will display how
  203.     many letters the word you are supposed to type in contains. Then if
  204.     you press Amiga+H once more (or select Help in the menu) you will
  205.     get the first letter, press once more, and you will get the next,
  206.     and so on...
  207.  
  208.  
  209. 3.0: THE "WORDS" MENU:
  210. ­­­­­­­­­­­­­­­­­­­­­­
  211.  
  212. 3.1:    * SAVE ASCII will save the words in ASCII format (handy, if you
  213.     want to print your words). (SPELLCHECK uses a simpler way for
  214.     saving normally - so SPELLCHECK's files will be a good deal
  215.     larger).
  216.  
  217. 3.2:    * IMPORT ASCII will load an ASCII file and add it to the words
  218.     that are already in the memory (at the bottom). The ASCII file
  219.     must be in this format: (For example)
  220.                 Explanation=Word<RETURN>
  221.     If the words do not follow this format, you will get a prompt.
  222.  
  223. 3.3:    * PATTERN. Here you can type in a pattern which all the words you
  224.     will be asked in must match. If, for instance, you have loaded
  225.     a file containing lots of german words, but only want to be heard
  226.     in the male nouns, type in "der *" in the stringgadget.
  227.         
  228. 3.4:    * UPPERCASE will turn all the letters in all the words into
  229.     uppercase (ABCD).
  230.  
  231. 3.5:    * LOWERCASE will turn all the letters in the all words into
  232.     lowercase (abcd).
  233.  
  234. 3.6:    * SWAP will swap all the words that lie in the memory. If you
  235.     want to swap just one word, read about LIST in the "PROJECT" menu.
  236.  
  237.  
  238. 4.0: THE "ASK MODE: MENU:
  239. ­­­­­­­­­­­­­­­­­­­­­­­­­
  240.  
  241.     Here choose between two ways inwhich to be asked: (Select the
  242.     current, and the other will appear).
  243.  
  244. 4.1:    * AUTOMATIC. (default) You have only one chance to write the word
  245.     correctly, if the answer was not correct, the program will show
  246.     the right answer for a couple of seconds. (Hold down right mouse
  247.     button to "pause" the program).
  248.  
  249. 4.2:    * MANUAL. You get two chances to write the word correctly, and if
  250.     you have answered incorrectly, you have to press <SPACE> to
  251.     proceed.
  252.  
  253.  
  254. 5.0: GADGETS.
  255. ­­­­­­­­­­­­­
  256.  
  257. That was the menus, now the gadgets:
  258.  
  259. 5.1:    * LOAD look under 1.2.
  260.     
  261. 5.2:    * SAVE look under 'Save As', 1.5.
  262.     
  263. 5.3:    * LIST look under 1.6.
  264.  
  265. 5.4:    * ASK will ask you in the words you select in the requester which
  266.     pops up when you click this gadget (or press F4). If you have set
  267.     a pattern (see 3.3), the words you will be questioned in must
  268.     match that. Press 'A' for all or 'O' for OK.
  269.  
  270. 5.5:    * INSERT will enable you to type in new words. The shortcut for this
  271.     gadget is F5.
  272.  
  273.  
  274. APPENDIX A: SHORTCUTS.
  275. ­­­­­­­­­­­­­­­­­­­­­­
  276.  
  277.         F1 - LOAD        Amiga+A - APPEND
  278.         F2 - SAVE AS        Amiga+S - SAVE
  279.         F3 - LIST        Amiga+Q - QUIT
  280.         F4 - ASK              I - IMPORT ASCII
  281.         F5 - INSERT              X - SAVE ASCII
  282.                        HELP - SHORTCUTS
  283.  
  284. In the list-window:
  285.  
  286.          ESC - RETURN TO NORMAL WINDOW
  287.         HOME - (7 on keypad) GOTO TOP OF LIST
  288.          END - (1 on keypad) GOTO BOTTOM OF LIST
  289.             ARROW UP - GO UP ONE WORD
  290.           ARROW DOWN - GO DOWN ONE WORD
  291.                    S - SEARCH FOR WORD
  292.  
  293.  
  294. APPENDIX C: ERROR CODES.
  295. ­­­­­­­­­­­­­­­­­­­­­­­­
  296.  
  297. File Errors:
  298.  
  299. FILE ERROR 1: Unable to open file.
  300. FILE ERROR 2: Unable to load file.
  301. FILE ERROR 3: The file is too big.
  302. FILE ERROR 4: Not SpellCheck V1.3+.
  303. FILE ERROR 5: Can not find Sys:System/SetMap.
  304. FILE ERROR 6: Unable to save file.
  305. FILE ERROR 7: Unable to save devs:SpellCheck.prefs.
  306.  
  307. Other Errors:
  308.  
  309. NOT ENOUGH MEMORY: Unable to get memory for the window. Try to close some
  310. other tasks to free memory. If you still can not open the window, you will
  311. have to save and restart.
  312. LIBRARY ERROR: SPELLCHECK was unable to open either arp.library,
  313. diskfont.library or powerpacker.library. Ensure that they are in LIBS:
  314.  
  315.  
  316. APPENDIX C: PRINTING SPELLCHECK FILES.
  317. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  318.  
  319. To print your words, you must first save them as ASCII (see 3.1) and then
  320. type in the CLI: "type <filename> to PRT:". If you want to print the words
  321. in a more fashionable style, load the file into your favourite word-
  322. processor, and print them from there.
  323.  
  324.  
  325. APPENDIX D: ADDITIONAL INFORMATION.
  326. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  327.  
  328. Limitations:
  329. SPELLCHECK has a maximum capacity of 384 words. This should be sufficient
  330. for most users. Each word can only contain 40 characters (that is 40
  331. characters for the 'explanation' and 40 for the 'word'). This will be
  332. changed in later versions of the program.
  333.  
  334. In General:
  335. To get out of the list-window and most of the other requesters, you can
  336. simply press <ESCAPE>. In some, you can also press <RETURN> to make them
  337. disappear. There are usually shortcuts to press in the requesters as
  338. well. The first letter in the gadget-text is usually a shortcut. SPELLCHECK
  339. makes use of string-gadgets to get input from the user. To clear the
  340. contents of a string gadget, press RIGHT-AMIGA-X. To get back the text,
  341. press RIGHT-AMIGA-Q.
  342.  
  343. Technical Info:
  344. SPELLCHECK only takes up about 40kB of disk-space (uncrunched), it was
  345. written in assembly language, using DevPac2 and DevPac 3. It makes use of
  346. arp.library, diskfont.library and powerpacker. library from disk. If you
  347. want the latest version and the source-code for SPELLCHECK, or a laser-
  348. printed hard-copy of this manual, send £5 or NKr 50, or equivalent in
  349. international reply coupons to Pantheon Softworks. A new version of
  350. SPELLCHECK specifically for V2.0 will appear shortly.
  351.  
  352. How to load 1.2 files:    
  353. If you have some old SPELLCHECK files that are saved with version 1.2 or
  354. lower, you cannot load them into directly SPELLCHECK v1.3. You will have
  355. to save them as ASCII and load them as ASCII again. A program which will
  356. convert old files is soon to be released.
  357.  
  358. Wanted:
  359. Are you willing to translate this manual and the text in SPELLCHECK into
  360. another language? (German/French/Spanish in particular). If you are,
  361. please contact Pantheon Softworks.
  362.  
  363.  
  364. Special thanks to:    Christian Fiott
  365.             Tor-Martin Tveit
  366.             Preben Randhol
  367.             Ole Ingarth Karlsen
  368.             Jan Reinert Karlsen
  369.             Sigmund Vik
  370.             Kjell Heimdal
  371.             Jarl Nemeth
  372.  
  373.  
  374.  
  375.  
  376.     PANTHEON SOFTWORKS, PO BOX 2049-HØLLEN, 4641 SØGNE, NORWAY.