home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 613b.lha / SpellCheck_v1.2 / SpellCheck.doc < prev    next >
Text File  |  1992-02-22  |  8KB  |  226 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10. SPELLCHECK V1.2        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, and as long
  15.             as you do not make a profit by selling it.
  16.  
  17.         
  18.             FILES:         SpellCheck
  19.                     SpellCheck.info
  20.                     SpellCheck.doc
  21.                     SpellCheck.font
  22.  
  23.             NEEDED FILES:    LIBS:arp.library
  24.                     LIBS:diskfont.library
  25.                     C:run(*)                    
  26.                     SYS:SYSTEM/SetMap(*)
  27.     
  28.             (*) If you want to use the 'Select keymap'
  29.             function.
  30.  
  31.  
  32.  
  33. What is SPELLCHECK?    SPELLCHECK is a handy program, which enables you to
  34.             use your computer to learn new words, whether it be
  35.             German strong verbs, French words, or Spanish. You
  36.             type in the words you want to be heard in, and the
  37.             computer shows you the english word and asks you to
  38.             type in the german/french/spanish. (You can of course
  39.             use any languages).
  40.  
  41. How do I use it?    The program is very easy to use, so the simples way
  42.             to find out how it works is to try it out. If you
  43.             should want to use some of the more advanced
  44.             features, you should turn to this documentation for
  45.             an explanation. The program will run both from the
  46.             Workbench and from the CLI. From the CLI you can
  47.             specify a filename after SpellCheck (ie SpellCheck
  48.             <filename>) and SPELLCHECK will load that file.
  49.  
  50. Requirements:        SPELLCHECK will refuse to run, if not arp.library
  51.             and diskfont.library are present in libs: It is also
  52.             a must to have RUN in C: and SETMAP in Sys:System to
  53.             make full use of the program. If a font named
  54.             "SpellCheck"  lies  in fonts:  SPELLCHECK will load
  55.             and use it. Make sure that it is an 8*8 pixels font. 
  56.  
  57. Questions?        If you have any questions on the use of this program,
  58.             comments, bugreports, or suggestions on how to
  59.             improve it, please write to: PANTHEON SOFTWORKS,
  60.             Po. Box 2049-Høllen, 4641 SØGNE, NORWAY.
  61.  
  62.  
  63. The functions available from SPELLCHECK are listed here, as they appear in
  64. the menus in the program
  65.  
  66. THE "PROJECT" MENU:
  67.  
  68.     * CLEAR ALL will clear all the words you have typed in or loaded
  69.     into the program. You will get a requester, and have to click 'YES'
  70.     or type 'Y' on the keyboard to clear all the words.
  71.  
  72.     * LOAD (you can also click on the gadget, or press F1) will prompt
  73.     you with a requester, and you can select a file to load. The file
  74.     should be a file saved from SPELLCHECK previously.
  75.  
  76.     * SAVE (also a gadget for this one, or F2). You will also get a
  77.     requester here, you can type in a filename or select one.
  78.  
  79.     * APPEND (shortcut: Amiga+A). This function will add a SPELLCHECK
  80.     file to the words that are in memory at the time. The new words will
  81.     be put at the end of the other words. You will get a requester to
  82.     select the file.
  83.  
  84.     * LIST (also a gadget for this one, or F3) will open a new window,
  85.     where you can scroll up and down, and look at all the words that
  86.     are in memory. There are four gadgets on the bottom of the window:
  87.     CLOSE, which brings you back to the normal window, SWAP, DELETE and
  88.     SEARCH. When you click on a word with the mousepointer, there will
  89.     come up a requester in which you can edit that word. (From here
  90.     you have the following shortcuts: [M] for modify, [RERURN] or
  91.     [ESC] to exit.) If the SWAP gadget is pressed down, and you click
  92.     on a word, the two words (for instance English and German) will be
  93.     swapped. If the DELETE gadget is pressed down, the word you click
  94.     will be deleted. If you click SEARCH (or press 'S' on the keyboard),
  95.     you will be prompted with a requester, where you can type in a word
  96.     to search for. Shortcuts: [S] to search, [ESC] or [RETURN] to exit.
  97.     You can use normal (ARP) wildcards here: (* and ?). Note that upper
  98.     and lower case differs.
  99.  
  100.     * ABOUT
  101.  
  102.     * QUIT
  103.  
  104. THE "SPECIAL" MENU:
  105.  
  106.     * SELECT KEYMAP will enable you to select a new keymap, and load
  107.     it (a filerequester will come up). To use this function, you need
  108.     RUN in C: and SETMAP in Sys:System.
  109.  
  110.     * PREFERENCES enables you to select your favorite colours, and to
  111.     make SPELLCHECK load a special keymap, whenever you start it. Your
  112.     preferences can be saved. (To the file devs:SpellCheck.prefs).
  113.  
  114.     * SHORTCUTS brings up a list over the shortcuts available in the
  115.     program from the normal window.
  116.  
  117.     * LOW<>UPPERCASE. Normally SPELLCHECK will look at uppercase and
  118.     lowercase letters as different, when it asks you in words. If you
  119.     want uppercase and lowercase to be the same, select this menuitem,
  120.     and it will change to LOW=UPPERCASE.
  121.  
  122.     * HELP OFF. If you select this menuitem, it will read HELP ON, and
  123.     when you are being asked in words, you can get some help, by using
  124.     the menu, or shortcut Amiga+H. First the program will display how
  125.     many letters the word you are supposed to type in has, then is
  126.     you press Amiga+H once more (or select Help in the menu) you will
  127.     get the first letter, press once more, and you will get the next,
  128.     and so on...
  129.  
  130. THE "WORDS" MENU:
  131.  
  132.     * SWAP will swap all the words that lie in the memory. If you
  133.     want to swap just one word, read about LIST in the "PROJECT" menu.
  134.  
  135.     * UPPERCASE will turn all the letters in the words into uppercase.
  136.  
  137.     * LOWERCASE will turn all the letters in the words into lowercase.
  138.  
  139.     * SAVE ASCII will save the words in ASCII format (handy, if you
  140.     want to print your words). (SPELLCHECK uses a simpler way for
  141.     saving normally - so SPELLCHECK's files will be a good deal
  142.     larger).
  143.  
  144.     * IMPORT ASCII will load an ASCII file and add it to the words
  145.     that are already in the memory (at the bottom). The ASCII file
  146.     must be in this format: (For example)
  147.                 EnglishWord=GermanWord<RETURN>
  148.     If the words does not follow this format, you will get a prompt.
  149.  
  150.     * PATTERN. Here you can type in a pattern which all the words you
  151.     will be asked in must match. If, for instance you have loaded in
  152.     a file containing lots of german words, but only want to be heard
  153.     in the male words, type in "der*" in the stringgadget. (That is,
  154.     when you are being heard in german words, ie. typing in the german
  155.     word).
  156.  
  157. THE "ASK MODE: MENU:
  158.  
  159.     Here choose between two ways to be asked words in: (Select the
  160.     current, and the other will appear).
  161.  
  162.     * AUTOMATIC. (normal) You have only one chance to write the word
  163.     correctly, and the program continues after a couple of seconds
  164.     after you have pressed return.
  165.  
  166.     * MANUAL. You get two chances to write the word correctly, and
  167.     have to press <SPACE> after you have delivered the second answer,
  168.     and want to proceed.
  169.  
  170. That was the menus, now the gadgets: (that have not already been explained):
  171.  
  172.     * ASK will ask you in the words you select in the requester which
  173.     pops up when you click this gadget (or press F4). 
  174.  
  175.     * INSERT will enable you to type in new words. The shortcut for this
  176.     gadget is F5
  177.  
  178.  
  179. THE SHORTCUTS AVAILABLE FROM SPELLCHECK:
  180.  
  181.         F1 - LOAD        Amiga+A - APPEND
  182.         F2 - SAVE        Amiga+Q - QUIT
  183.         F3 - LIST           HELP - SHORTCUTS
  184.         F4 - ASK
  185.         F5 - INSERT
  186.  
  187. IN THE LIST WINDOW:
  188.  
  189.         ESC - BACK TO NORMAL WINDOW
  190.         S   - SEARCH FOR A WORD
  191.  
  192.  
  193. Limitations:        SPELLCHECK has a maximum capacity of 384 words.
  194.             This should be sufficient in most cases. In
  195.             SPELLCHECK the words can only be 40 characters.
  196.             (or 80 for 'english' and 'foreign'-words).
  197.  
  198. In General:        To get out of the list-window or most of the
  199.             requesters, you can simply press <ESCAPE>. In
  200.             some, you can also press <RETURN> to make them
  201.             disappear. There are normally shortcuts to press
  202.             in the requesters as well. The first letter in
  203.             the gadget-text is usually a shortcut.
  204.  
  205. Technical Info:        SPELLCHECK only takes up about 40kB of disk-space
  206.             (uncrunched), it was written in assembly language,
  207.             using DevPac2. It makes use of arp.library and
  208.             diskfont.library. If you want the source-code for
  209.             SPELLCHECK, or a laser-printed hard-copy of this
  210.             manual, send £5 or NKR 50 to Pantheon Softworks.
  211.  
  212.  
  213. Special thanks to:    Christian Fiott
  214.             Tor-Martin Tveit
  215.             Preben Randhol
  216.             Ole Ingart Karlsen
  217.             Jan Reinert Karlsen
  218.             Sigmund Vik
  219.             Kjell Heimdal
  220.             Jarl Nemeth
  221.  
  222.  
  223.  
  224.  
  225.     PANTHEON SOFTWORKS, PO BOX 2049-HØLLEN, 4641 SØGNE, NORWAY.
  226.