home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / dev / asm / tbsource / questions / final / questions.doc < prev    next >
Encoding:
Text File  |  1993-12-21  |  13.9 KB  |  424 lines
  1.  
  2. 12/09-91                 Questions v. N/A (0.99b)
  3.  
  4. Updated:  12/09-91      - for preliminary versions
  5.  
  6.   Copyright (C) Tomi Blinnikka 1991, All rights reserved.
  7.                                      ^^^^^^^^^^^^^^^^^^^
  8.  
  9. This program is freely distributable. This means that you can copy it and
  10. give it to all your friends, upload it to a BBS or include it in a
  11. PD-library (FISH etc.). The only restrictions are that all of the files
  12. are included in their original form without additions, deletitions, or
  13. modifications of any kind and that it IS NOT SOLD. THIS INCLUDES GERMAN
  14. PD DISTRIBUTERS. If you want to use program for commercial purposes you
  15. need written permission from the holder of the copyright. The Questions
  16. program is provided "AS IS" without warranty of any kind, and the author
  17. is not responsible for any damage (of any kind) the software may cause.
  18.  
  19. WHAT DOES THIS PROGRAM DO?
  20. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  21. This program is designed to help students learn. It will ask questions
  22. from the student, verify it with the correct answer(s) and tell the
  23. student whether or not he/she was correct. It will also keep score of
  24. the students progress and there is a possibility to save the scores onto
  25. disk (Not available yet).
  26.  The program is divided into the parts or modes. The first, student
  27. mode, asks the questions, and the second, teacher mode, allows the
  28. teacher, or students, to make the questions that are to be asked.
  29.  
  30. WHAT DO YOU NEED?
  31. ~~~~~~~~~~~~~~~~~
  32. For the current versions:
  33.  
  34.                         An Amiga computer running on
  35.                         Kickstart 2.0 or higher O.S.
  36.                         Minimum memory required 512 KB
  37.  
  38. And if you intend to write your own questions, you'll need a lot of
  39. imagination! PLEASE NOTE: Copying questions from school books etc. is
  40. usually illegal! Please check copyright notices from book etc.
  41.  
  42. HOW TO USE QUESTIONS
  43. ~~~~~~~~~~~~~~~~~~~~
  44.  
  45. Starting the program
  46. --------------------
  47. From the Command Line Interface (CLI) or Shell use:
  48.  
  49. CLIPrompt> Questions <RETURN>
  50.  
  51. (The Workbench interface is not implemented yet.)
  52. From the Workbench click twice on the icon under which reads
  53. 'Questions'. To load a questions set at the same time, hold down the
  54. SHIFT-key, click once on the question sets icon and double click on the
  55. programs icon.
  56.  
  57.  
  58. Main screen
  59. -----------
  60. In the main screen you have several options. These include the following:
  61.  
  62.         Menu    Item            Short cut/key combination
  63.         ----    ----            -------------------------
  64.         Main-menu
  65.                 Start           Amiga-G
  66.                 Enter name      Amiga-E
  67.                 Load...         Amiga-L
  68.                 Save            Amiga-S
  69.                 Save as...      Amiga-W
  70.                (Help...         Amiga-H, HELP-key)
  71.                 About...        Amiga-?
  72.                 Quit            Amiga-Q
  73.  
  74.         Edit-menu
  75.                 Add             Amiga-A
  76.                 Undo            Amiga-U
  77.  
  78.         Edit all-menu
  79.                 Clear           Amiga-C
  80.  
  81.         Move-menu
  82.                 First           Amiga-F
  83.                 Last            Amiga-.
  84.                 Previous        Amiga-P
  85.                 Next            Amiga-N
  86.  
  87.         Mode-menu
  88.                 Student         Amiga-1
  89.                 Teacher         Amiga-2
  90.  
  91.         Preferences-menu
  92.                 Set prefs...    Amiga-3
  93.                (Load prefs      Amiga-4)
  94.                (Save prefs      Amiga-5)
  95.                (Get defaults    Amiga-6)
  96.  
  97.  
  98. Main screen options
  99. -------------------
  100. This sections describes all the functions available from the main
  101. screen. Some of the functions are available at certain times (like the
  102. save functions are available only in the teacher mode).
  103.  
  104. Main-menu:
  105.  
  106.  - Start
  107.  
  108. This starts the asking of questions. If the student hasn't given there
  109. name yet, the program will ask for it first. If there is no question set
  110. loaded, again the program will ask the user for it first and load it.
  111.  
  112.  
  113.  - Enter name
  114.  
  115. When this is selected, the screen is cleared and a box appears in the
  116. middle of the screen. The user is asked to type in their name for
  117. further references (saving it to disk). It will not allow a blank name.
  118. You must input something.
  119.  
  120.  
  121.  - Load
  122.  
  123. This allows the user to load a question set. A requester (a box with
  124. filenames in it) appears onscreen waiting for input. The question files
  125. usually have the ending '.QUE'. By default, no other files will be
  126. shown, making it easier to find the question files. Using the
  127. requester is not explained here, it should be taught along with other
  128. basics of using the Amiga computer.
  129.  
  130.  
  131.  - Save (teacher mode only)
  132.  
  133. After making changes to questions or after writing them, you will most
  134. likely want to save them for later use. This option saves the questions
  135. with the current filename (i.e. the file name given via 'Save as'
  136. earlier, or via 'Load').
  137.  
  138.  
  139.  - Save as (teacher mode only)
  140.  
  141. This is basically the same as 'Save' except it prompts for the filename
  142. first. The same type of requester that is used with load pops up asking
  143. for the file name. The program does not add the extension '.QUE' which
  144. indicates that this file is a question file. It is not nessesary, but
  145. prefered since the load requester normally shows only files that have
  146. the extension.
  147.  
  148.  
  149.  - Help
  150.  
  151. The help function built into the program is simply a reference to help
  152. the user check what a function does or how it works. Using the help
  153. utility is simple. If in need of help on help, press the help key. Could
  154. it be simpler? Below is a list of functions available under help:
  155.  
  156. - Gadgets (buttons) from left to right
  157.  
  158. Prev                    - Go to PREVious page
  159. Quit                    - Quit help and go back to main program
  160. Next                    - Go to NEXT page
  161.  
  162. The close gadget at the top left of the window acts also as quit.
  163.  
  164. - Menus
  165.  
  166.         Menu    Item            Short cut/key combination
  167.         ----    ----            -------------------------
  168.         Main-menu
  169.                 Previous        Amiga-P
  170.                 Next            Amiga-N
  171.                 Help            Amiga-H (HELP-key)
  172.                 Quit            Amiga-Q
  173.  
  174. - Keys
  175.  
  176. TO GO TO PREVIOUS PAGE:
  177. P, arrow left, arrow down, - (minus)
  178.  
  179. TO QUIT BACK TO MAIN PROGRAM:
  180. Q, ESCape
  181.  
  182. TO GO TO NEXT PAGE:
  183. N, arrow right, arrow up, + (plus)
  184.  
  185.  
  186.  - About
  187.  
  188. This simply brings up a requester with a copyright notice, version
  189. number and tells the author. Future versions may have information on the
  190. state of available memory, but this is uncertain.
  191.  
  192.  
  193.  - Quit
  194.  
  195. While in the student mode, this function quits the program. It will ask
  196. if you are sure or not and if so quits. If however, you are in the teacher
  197. mode, it will return you back to student mode, thus it acts the same as
  198. selecting 'Student' from the 'Mode'-menu.
  199.  
  200.  
  201. Edit-Menu: (Teacher mode only)
  202.  
  203.  
  204.  - Add
  205.  
  206. This will add a question to the begining of all questions (NOTE: This WILL
  207. change! In future versions the question will be inserted after the
  208. current question). It prepares an empty question and answer and goes to it.
  209.  
  210.  - Undo
  211.  
  212. Selecting this causes changes made to the description and current
  213. question, after any other action (like Previous, Next, First, etc.), to
  214. be erased, returning the questions and description to its previous
  215. states.
  216.  
  217. Edit all-menu: (Teacher mode only)
  218.  
  219.  - Clear
  220.  
  221. The name of this function may change. It actually should be something
  222. like RESET. Selecting this causes all questions and answers and
  223. the description to be cleared.
  224.  
  225.  
  226. Move-menu: (Teacher mode only)
  227.  
  228.  - First
  229.  
  230. This searches the first question, goes to it and displays it onscreen.
  231.  
  232.  - Last
  233.  
  234. This does same as 'First' except it goes to the last question.
  235.  
  236.  - Previous
  237.  
  238. Goes to the previous question.
  239.  
  240.  - Next
  241.  
  242. Goes to the next question.
  243.  
  244.  
  245. Mode-menu:
  246.  
  247.  - Student
  248.  
  249. This changes the mode to student mode. If already in student mode, this
  250. has no effect.
  251.  
  252.  - Teacher
  253.  
  254. This changes the mode to teacher mode. If already in teacher mode, this
  255. has no effect.
  256.  
  257.  
  258. Preferences:
  259.  
  260.  - Set prefs
  261.  
  262. This opens up a window, in which you can change certain things that
  263. affect the way the program behaves. You can change whether or not you
  264. would like speech, what the speech file is (will be changed to allow use
  265. of different devices), what to say, and screen colors.
  266.  
  267. - Gadgets
  268.   - boxes with a checkmark when active
  269.  
  270. Speech                  - Speech on/off. Default OFF
  271. System messages         - Say programs actions, disk errors etc. Default
  272.                           ON
  273. Descriptions            - Say descriptions. Default ON
  274. Questions               - Say questions. Default OFF
  275. Answers                 - Say answers. Default OFF
  276. Score                   - Say score. Default OFF
  277.  
  278.   - boxes with text in it (string gadget)
  279.  
  280. Speech 'file'           - to which 'file' or 'device' to direct speech
  281.                           to. Default 'SPEAK:'
  282.  
  283.   - normal 'click-on' gadgets
  284.  
  285. Set colors              - opens a requester in which you can change the
  286.                           colors used.
  287. Defaults                - changes all preferences to the defaults
  288.                           programmed into the program
  289. Save                    - saves the preferences with the current name,
  290.                           again given by 'load' or 'save as'.
  291.  
  292. - Menus
  293.  
  294.         Menu    Item            Short cut       Explanation
  295.         ----    ----            ---------       -----------
  296.         Preferences
  297.                 Load...         Amiga-L         Load prefs
  298.                 Save            Amiga-S         Save with current name
  299.                 Save as...      Amiga-W         Save given with name
  300.                 Get defaults    Amiga-D         Use defaults
  301.                 Quit            Amiga-Q         Go to main program
  302.         Edit
  303.                 Colors          Amiga-C         Edit colors
  304.  
  305. Preferences-menu:
  306.  
  307.  - Load
  308.  
  309. This allows the user to load saved preferences. A requester (a box with
  310. filenames in it) appears onscreen waiting for input. The default
  311. directory for the preferences file is ENVARC:. All other system
  312. preferences are stored here, so so are the Questions programs. The
  313. default name for the file is 'Questions.prefs'. Again like with the
  314. question files, other files are not shown. In this case only files which
  315. have the extension '.prefs' are shown. Using the requester is not
  316. explained here, it should be taught along with other basics of using the
  317. Amiga computer.
  318.                                                               
  319.  - Save
  320.  
  321. After making changes to the preferences, you will most likely want
  322. to save them for later use. This option saves the questions with the
  323. current filename (i.e. the file name given via 'Save as' earlier, or
  324. via 'Load').
  325.  
  326.  - Save as
  327.  
  328. This is basically the same as 'Save' except it prompts for the filename
  329. first. The same type of requester that is used with load pops up asking
  330. for the file name. The program does not add the extension '.prefs' which
  331. indicates that this file is a preferences file. It is not nessesary, but
  332. prefered since the load requester normally shows only files that have
  333. the extension. NOTE: Since the program loads its preferences on startup,
  334. in order the program to use your preferences, the name of the file must
  335. be (including path) 'ENVARC:Questions.prefs', i.e. the default.
  336.  
  337.  - Get defaults
  338.  
  339. This resets all options to the preferences that are programmed into the
  340. program. The colors are changed to standard Kickstart/Workbench colors
  341. (version 37.175(KS)/37.59(WB)) and the speech gadgets to preferable
  342. configurations.
  343.  
  344.  - Quit
  345.  
  346. Quits back to the main program.
  347.  
  348.  
  349. Edit-menu:
  350.  
  351.  - Colors
  352.  
  353. This function brings up a so called 'color requester'. In it you can see
  354. fours boxes, three sliders and a few other gadgets. To choose the color
  355. to edit, click on one of the four colored boxes. After that simply use
  356. the sliders to change the color components of that color. The first
  357. slider changes the color component red, the second green and the last
  358. blue.
  359.  
  360. - Keys
  361.  
  362. TO QUIT PREFERENCES:
  363. Q, ESCape
  364.  
  365. THE TWO MODES
  366. ~~~~~~~~~~~~~
  367. As said before there are two modes in the program. They are the student
  368. mode and the teacher mode. The student mode is the mode normally used.
  369. The teacher mode is infact an editor.
  370.  
  371. STUDENT MODE
  372. ------------
  373. In this mode the questions are asked. The screen is divided into three
  374. parts, information, question and answer. The top box is the description
  375. box. It is divided into two parts, the text side, the bigger part and
  376. the indicator box, which tells the student various things to note. In
  377. this box you can see 'PUNC.', 'CASE' and 'ORDER'. These tell whether or
  378. not to make sure of PUNCtuation, case and order if there are multiple
  379. answers.
  380.  The next part informs of score, number of questions and whether or not
  381. there is a timer and if is the time left to answer the question.
  382.  After this comes a two line box in which the question appears. Below
  383. the question is a ten line box, in which the answer is displayed and
  384. maybe in the future a multiple select box, from which to choose the
  385. correct answer(s). Below this is the answer box, in which the student is
  386. to answer.
  387.  
  388.  
  389. TEACHER MODE
  390. ------------
  391. In this mode your are able to make your own question sets. The screen is
  392. almost the same as in the student mode. The only differences are the
  393. extra gadgets and that the answer gadget from the bottom of the screen
  394. is missing. The gadgets are, starting from the left and top in the first
  395. box, First, below that, Last, Prev and Next. In the next box
  396.  
  397. BUG REPORTS ETC...
  398. ~~~~~~~~~~~~~~~~~~
  399. Please send donations, bug reports, and list of features you would like to
  400. have included in future versions to
  401.  
  402. Tomi Blinnikka
  403. Syystie 10
  404. 00780 Helsinki
  405. FINLAND
  406.  
  407. If you want the source code (it has some examples how to take care of
  408. command line inputs, PublicScreen stuff, libraries with special 2.0
  409. things), contact me at the address above or you can also contact me on the
  410. following BBS:
  411.  
  412. MITS +358-0-458 2066
  413. MITS +358-0-458 2077
  414. MITS +358-0-458 2088 (Sec. level 40 or higher ONLY) 
  415.  
  416. "...trademark of Xerox Corporations. Reading legal mush can turn your
  417. brain to guacamole! Epson is registered trademark of Epson America
  418. ..." -Amiga RKRM Includes & AutoDocs, fourth page.
  419.  
  420.  
  421.                         Tomi Blinnikka
  422.  
  423.                         docbliny@mits.mdata.fi
  424.