home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 3 / hamradioversion3.0examsandprograms1992.iso / misc / studyaid / q&asa.doc < prev    next >
Text File  |  1988-08-07  |  66KB  |  1,811 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                 Q & A Study Aid (Q&ASA)
  18.  
  19.                                       Version 2.1
  20.  
  21.                                      July 31, 1988
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.                                      Hal Endresen
  38.                                  Quid Pro Quo Software
  39.                                   1703 Marlbrook Lane
  40.                                   Lansdale, PA 19446
  41.         Q&A Study Aid User's Guide
  42.  
  43.  
  44.  
  45.         Revision Information
  46.         --------------------
  47.  
  48.         Version 1.0    January 7, 1988
  49.  
  50.                        Initial release.
  51.  
  52.         Version 2.0    March 22, 1988
  53.  
  54.                        Major enhancements to allow Q&ASA to be used in a formal
  55.                        classroom   environment.  Among  the  changes  are   the
  56.                        following:
  57.  
  58.                        * Optional  logging  of scoring information  to  a  disk
  59.                          file.
  60.                        * Compiled  database  eliminates  run-time   interpreter
  61.                          errors and permits the database to be encrypted.
  62.                        * Display of the database name as the window title.
  63.                        * Faster response when loading questions.
  64.                        * Greatly  improved  help system  allows  selection  and
  65.                          viewing of any help category at any time.
  66.                        * Optional  locking  of  selected mode  and  lockout  of
  67.                          certain commands.
  68.                        * Ability  to assign a weight to each question and  have
  69.                          this weight determine the number of points awarded for
  70.                          a correct answer to a question.
  71.                        * Ability  to  specify  a  time  limit  to  answer   all
  72.                          questions.
  73.                        * Elimination of all index files.
  74.  
  75.         Version 2.1    July 31, 1988
  76.  
  77.                        Minor enhancements to help system.
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 1
  102.         Q&A Study Aid User's Guide
  103.  
  104.  
  105.  
  106.         Introduction
  107.         ------------
  108.  
  109.         Q&ASA is a general-purpose program designed to present questions from a
  110.         database.  The  user  is  then  prompted  for  an  answer  and   graded
  111.         accordingly.
  112.  
  113.         Q&ASA provides two methods of reading the questions from the  database:
  114.         sequential and random. The program starts up in sequential mode.
  115.  
  116.         A  menu-driven  command  interface is provided  with  pull-down  menus.
  117.         Filenames  are  selected  from a directory by  pointing.  It  is  never
  118.         necessary to type in a filename.
  119.  
  120.         Q&ASA  supports an elaborate context-sensitive help  system  accessible
  121.         via  the F1 key. Help is provided by a single support file,  Q&ASA.HLP.
  122.         This  file may be located in the current directory or in any  directory
  123.         specified  in  the PATH environment variable. Q&ASA  may  therefore  be
  124.         placed  in  the \bin (or equivalent) directory and  accessed  from  any
  125.         other  directory, provided that PATH includes \bin. If you place  Q&ASA
  126.         in a directory that is not in the PATH string such that it is unable to
  127.         locate its help file, Q&ASA will, as a last resort, pop up a window and
  128.         ask you to enter the name of directory containing the help file.
  129.  
  130.         Q&ASA  now uses a compiled database. The database compiler is  included
  131.         with the package to allow you to create and compile your own databases.
  132.         The  database compiler is called Q&AC.EXE. Both Q&ASA.EXE and  Q&AC.EXE
  133.         are written in the C language.
  134.  
  135.         This package contains the following files:
  136.  
  137.              Q&ASA.EXE      Q&ASA main program
  138.              Q&AC.EXE       Q&ASA database compiler
  139.              Q&ASA.HLP      help file
  140.              Q&ASA.DOC      documentation file
  141.              REGISTER       program registration form
  142.  
  143.              SAMPLE.Q&A     sample database (compiled)
  144.              SAMPLE.DEF     database definition file for SAMPLE.Q&A
  145.  
  146.         The  Q&A  Study  Aid package is SHAREWARE and  is  copyrighted  by  the
  147.         author. If Q&ASA meets your needs, you are expected to register and pay
  148.         for its use. The SHAREWARE concept allows users to obtain high  quality
  149.         software  at  bargain prices, and rewards authors  for  their  efforts.
  150.         Please support this distribution concept by registering your copy.  You
  151.         will  find  a registration form at the back of this  manual.  You  have
  152.         unlimited  rights  to  copy and distribute the  program,  provided  you
  153.         distribute  it  as  the complete archive  STDYAID2.ARC.  Comments,  bug
  154.         reports, or other information that may help me improve this program are
  155.         welcome.
  156.  
  157.         Q&ASA is offered as is. There is no guarantee that it will work on your
  158.         particular  system; however, it has been tested with CGA, MDA  and  EGA
  159.         monitors  on both PCs and ATs. Text mode is used; no graphics  card  is
  160.  
  161.  
  162.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 2
  163.         Q&A Study Aid User's Guide
  164.  
  165.  
  166.         needed. Q&ASA will NOT use an EMM if one is present. A minimum of  128K
  167.         of  available RAM is needed by the program; it will tell you if you  do
  168.         not have sufficient memory to execute it.
  169.  
  170.         All  I/O is performed through system calls, with the exception  of  the
  171.         screen, which is controlled by direct writes to the regen buffer. Under
  172.         Microsoft  (c)  Windows, you must give Q&ASA control of the  screen.  A
  173.         command  has  been provided to control the screen  updating  method  to
  174.         eliminate any 'snow'. Q&ASA will start in the FAST screen mode, meaning
  175.         that  it will not wait for any synchronizing signals before writing  to
  176.         the screen. This is the best mode for use with EGA systems.
  177.  
  178.         Q&ASA  assumes  that your screen is set to 80x25 text  mode  (color  or
  179.         monochrome).  If not, it will NOT reset the mode. If your screen is  in
  180.         any of the graphics modes when Q&ASA is invoked, you will see  garbage.
  181.         Exit Q&ASA using the /FX command and reset the mode manually.
  182.  
  183.  
  184.         User Interface
  185.         --------------
  186.  
  187.         Commands are entered into Q&ASA via a pull-down two-level menu  system.
  188.         The uppermost screen region is the menu system. Each word group on  the
  189.         menu  line is the title block of a pull-down menu. Whenever one of  the
  190.         titles  is selected, the menu expands to display any options  available
  191.         under it.
  192.  
  193.         Under  most  conditions,  Q&ASA will be prompting for an  answer  to  a
  194.         question.  Some means must therefore be provided to break out and  into
  195.         the  menu system so that an option can be selected or a command  given.
  196.         There  are  two  ways  of doing this: via an ALT  key  sequence  or  by
  197.         pressing the menu escape character, the forward slash ('/').
  198.  
  199.         If  an ALT sequence is used, it is only necessary to press one  or  two
  200.         ALT  keys  to  select  any command  option.  A  top-level  selector  is
  201.         specified  by  ALT-shifting the highlighted letter.  For  example,  the
  202.         "Mode / Sequential" command is executed with ALT-M/ALT-S.
  203.  
  204.         If  you  use the '/' menu escape character, the word  MENU  will  first
  205.         appear  at the right of the menu line to indicate that you are  in  the
  206.         menu  system.  At  this  point,  any  combination  of  highlighted  and
  207.         underscored  letters  and cursor keys can be used to select  a  command
  208.         option.  Note that F1 will always get help no matter where you may  be,
  209.         in  or  out  of  the menu system. Once  the  desired  option  has  been
  210.         selected,  RETURN  executes  it. Note that neither the  slash  nor  the
  211.         RETURN are necessary when using ALT-key sequences.
  212.  
  213.         Q&ASA's commands are listed on the following page.
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 3
  224.         Q&A Study Aid User's Guide
  225.  
  226.  
  227.  
  228.         Q&ASA Command List
  229.         ------------------
  230.  
  231.              /FS       select database
  232.              /FD       specify directory containing database file(s)
  233.              /FX       exit to DOS
  234.              /MS       set mode to sequential
  235.              /MA       set mode to pseudorandom
  236.              /MC       clear score
  237.              /N        enter name
  238.              /SF       select FAST screen updates (no sync delay)
  239.              /SM       select MEDIUM screen updates (horizontal sync)
  240.              /SS       select SLOW screen updates (vertical sync)
  241.  
  242.  
  243.         /FD - Specify Database Directory
  244.         --------------------------------
  245.  
  246.         If  your Q&ASA database file or files are located in a directory  other
  247.         than  the  directory Q&ASA is invoked from, then you  must  tell  Q&ASA
  248.         which  directory to use with this command. When selected, a data  entry
  249.         window  will pop up and prompt for the directory name. DO NOT  enter  a
  250.         filename - just the name of the directory. You may prefix the directory
  251.         name  with a drive letter and colon if you wish. The directory will  be
  252.         verified  as such, and you will receive an error if the directory  does
  253.         not  exist.  The  directory you specify need not be on  the  same  disk
  254.         drive.  However, if you give the name of a directory on a floppy  disk,
  255.         you must have the floppy in the drive with the door closed or you  will
  256.         get an error.
  257.  
  258.  
  259.         /FS - Select Database File
  260.         --------------------------
  261.  
  262.         This  option is used to specify the name of the database file you  want
  263.         Q&ASA  to  use. Once selected, a list of all of the  compiled  database
  264.         files  in the directory you specified with the /FD command will  appear
  265.         in a selection window along with a selector bar. Q&ASA will NOT display
  266.         any files other than compiled database files.
  267.  
  268.         To select a compiled database file, move the selection bar to it  using
  269.         the  cursor  keys,  page up and down, or home and end.  Each  of  these
  270.         permits traveling up and down the scrollable list in larger increments.
  271.         Alternatively, you may also press a letter key that corresponds to  the
  272.         first  character  of the database filename; Q&ASA will find  the  first
  273.         file beginning with that letter. Successive depressions of the same key
  274.         will  step  to each filename that begins with that letter.  The  search
  275.         stops at the last file that begins with that letter. The search  always
  276.         proceeds  down the list; to restart the search, press HOME to move  the
  277.         selector back to the first file in the list.
  278.  
  279.         Once  you  have  pointed  to the file you  desire,  press  RETURN.  The
  280.         compiled  database  file index will be loaded. If  the  optional  score
  281.         logging  has been enabled in the database, Q&ASA will request that  you
  282.  
  283.  
  284.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 4
  285.         Q&A Study Aid User's Guide
  286.  
  287.  
  288.         enter your name for the score file. The first question will then appear
  289.         on  the screen, along with the number of questions in the  database  in
  290.         the scoring window. The name of the database will also be shown in  the
  291.         center  of  the  top  border of the question  window  if  it  has  been
  292.         specified  in the database. If not, then the window title will  default
  293.         to "Question".
  294.  
  295.         Each  time  you load a database file with score file  logging  enabled,
  296.         Q&ASA will request your name, even if you have already entered it. This
  297.         is  to allow other users to reload the same database without using  the
  298.         same  name for all users. If score file logging is not  enabled,  Q&ASA
  299.         doesn't force you to enter your name. You may do this anyway using  the
  300.         /N  (Name)  command, and Q&ASA will display it when  it  displays  your
  301.         final score.
  302.  
  303.         If the database you load has a time limit associated with it, the  time
  304.         remaining  will  be displayed in the status window  under  the  heading
  305.         'Time  Left',  and the clock will start. The time is  counted  down  to
  306.         zero,  and always shows the time you have remaining before Q&ASA  stops
  307.         you and calculates your final score. If the database does not specify a
  308.         time  limit,  the 'Time Left' will be displayed as 'No Limit'.  If  you
  309.         allow the time to count down to zero, it will change to 'Time Out'.
  310.  
  311.         To permit Q&ASA to utilize relatively large databases (>3000  questions
  312.         and  their answers), Q&ASA loads an index into memory rather  than  the
  313.         database  file itself. The database index is created by Q&AC and  is  a
  314.         header in the database file itself.
  315.  
  316.         The  database  file (.Q&A) should never be changed directly, as  it  is
  317.         encrypted  to  prevent  users from typing the file to  the  screen  and
  318.         thereby  viewing the answers. If you wish to create a new  database  or
  319.         alter  an  existing  one, you must edit the  database  definition  file
  320.         (.DEF) and recompile it using Q&AC. Q&AC will create a (.Q&A) file from
  321.         your (.DEF) file. Q&AC will not permit you to use the .Q&A extension on
  322.         a  definition file, so you cannot accidentally overwrite  a  definition
  323.         file.
  324.  
  325.         You  must  create the database definition file and  compile  it  before
  326.         Q&ASA  can be used. Instructions for doing this are in a later  section
  327.         of  this document. Note that this package contains a compiled  database
  328.         that  you  may  use to test and evaluate Q&ASA.  This  file  is  called
  329.         SAMPLE.Q&A.  The database definition file it was created from  is  also
  330.         included, and is called SAMPLE.DEF.
  331.  
  332.  
  333.         /FX - Exit to DOS
  334.         -----------------
  335.  
  336.         Use  this command to quit a Q&ASA session and return to  the  operating
  337.         system  command  level.  If you have loaded a  database  but  have  not
  338.         answered  all  questions,  the score file will  be  updated  with  your
  339.         current  score  and  a notation that you quit Q&ASA.  You  cannot  exit
  340.         Q&ASA,  clear  the  database, or reload the  current  or  new  database
  341.         without  updating your score file. This prevents extending time  limits
  342.         and/or starting a quiz over again.
  343.  
  344.  
  345.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 5
  346.         Q&A Study Aid User's Guide
  347.  
  348.  
  349.  
  350.  
  351.         /MS - Sequential Mode
  352.         ---------------------
  353.  
  354.         The  sequential  mode option tells Q&ASA that you wish  to  answer  the
  355.         questions  in the same order as they appear in the database file.  When
  356.         selected,  the new mode will appear in the scoring window. This  option
  357.         does  NOT cause Q&ASA to start reading from the beginning of the  file;
  358.         it simply changes the method used to determine the next question.  This
  359.         allows switching between modes.
  360.  
  361.         When  all questions have been answered, Q&ASA will update the  optional
  362.         score file and display the final score.
  363.  
  364.         Note  that  this command may be locked out by an option  given  in  the
  365.         database definition file. If this is the case, the command will  simply
  366.         be  ignored. No warning will be given indicating the command is  locked
  367.         out.
  368.  
  369.  
  370.         /MA - Pseudorandom Mode
  371.         -----------------------
  372.  
  373.         This  mode  is  used when you want Q&ASA to  choose  the  questions  at
  374.         random.  The  random number generator is seeded on each  invocation  of
  375.         Q&ASA  by  using  the  BIOS  time-of-day  clock  to  insure  that   the
  376.         pseudorandom sequence is different each time the program is run.
  377.  
  378.         In  this mode, Q&ASA will select the next question at random  from  the
  379.         set  of  unanswered questions. It will not, therefore, ask  a  question
  380.         twice.
  381.  
  382.         When  all questions have been answered, Q&ASA will update the  optional
  383.         score file and display the final score.
  384.  
  385.         Note  that  this command may be locked out by an option  given  in  the
  386.         database definition file. If this is the case, the command will  simply
  387.         be  ignored. No warning will be given indicating the command is  locked
  388.         out.
  389.  
  390.  
  391.         /MC - Clear
  392.         -----------
  393.  
  394.         Use the Clear option to reset your score back to zero and to reset  the
  395.         question index back to the beginning of the file. The question index is
  396.         cleared only here and when the database is initially loaded.
  397.  
  398.         Note  that  this command may be locked out by an option  given  in  the
  399.         database definition file. If this is the case, the command will  simply
  400.         be  ignored. No warning will be given indicating the command is  locked
  401.         out.
  402.  
  403.  
  404.  
  405.  
  406.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 6
  407.         Q&A Study Aid User's Guide
  408.  
  409.  
  410.  
  411.         /N - Name
  412.         ---------
  413.  
  414.         This command is used to enter your name, which is placed into the score
  415.         file and also displayed when the session is completed.
  416.  
  417.         When this command is given, a data entry window will pop up and  prompt
  418.         for  your name and any other identifying information. You may enter  up
  419.         to 35 characters.
  420.  
  421.         If  you have not given your name when the session is terminated,  Q&ASA
  422.         will  force you to enter it before you will be permitted to  enter  any
  423.         other command.
  424.  
  425.  
  426.         /SF - Select FAST Screen Mode
  427.         -----------------------------
  428.  
  429.         This command selects the FAST screen mode. In this mode, Q&ASA will not
  430.         wait for any screen synchronizing signals, thereby updating the  screen
  431.         at the fastest possible rate.
  432.  
  433.         This  is the default screen mode, and may cause 'snow' when  used  with
  434.         CGA graphics cards.
  435.  
  436.  
  437.         /SM - Select MEDIUM Screen Mode
  438.         -------------------------------
  439.  
  440.         This  command  instructs Q&ASA to write to the screen only  during  the
  441.         horizontal  blanking interval. It will slow down the  screen  somewhat,
  442.         but may be used to minimize the effects of 'snow'.
  443.  
  444.  
  445.         /SS - Select SLOW Screen Mode
  446.         -----------------------------
  447.  
  448.         This  is the slowest of the three screen updating modes.  It  instructs
  449.         Q&ASA to update the screen only during the vertical blanking  interval.
  450.         It will eliminate all effects of 'snow'.
  451.  
  452.  
  453.         Scoring Window
  454.         --------------
  455.  
  456.         The  scoring  window  always shows the current state of  both  you  and
  457.         Q&ASA. The items that appear in the scoring window are described below.
  458.  
  459.              Time Left      This  shows  the  time  remaining  to  answer   all
  460.                             questions  in the database. It will be blank  until
  461.                             you  load a database with the /FS command.  If  the
  462.                             database  has a time limit associated with it,  you
  463.                             will see this time counting down to zero. At  zero,
  464.                             it  will change to 'Time Out'. If the database  has
  465.  
  466.  
  467.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 7
  468.         Q&A Study Aid User's Guide
  469.  
  470.  
  471.                             no  time  limit,  this will  be  displayed  as  'No
  472.                             Limit'.
  473.  
  474.              Mode           This  is  the current question-indexing  mode,  and
  475.                             will  be  "Random" or  "Sequential".  Q&ASA  always
  476.                             starts up in sequential mode.
  477.  
  478.              Questions      When  a database has been loaded,  this  represents
  479.                             the total number of questions in the database.
  480.  
  481.              Answered       Tells  the  number  of  questions  that  you   have
  482.                             answered. When it equals the number of questions in
  483.                             the database, you final score will be displayed.
  484.  
  485.              Correct        This  is  the  number of questions  that  you  have
  486.                             answered correctly.
  487.  
  488.              Score          Your  score  is  a simple ratio of  the  number  of
  489.                             possible  points  to  the  number  you  have   been
  490.                             awarded, and is displayed in percent.
  491.  
  492.  
  493.         Answering Questions
  494.         -------------------
  495.  
  496.         Q&ASA  no  longer requires you to answer questions in the  order  Q&ASA
  497.         presents  them (as defined by the mode). Q&ASA will determine the  next
  498.         question using the mode you select, but once the question is displayed,
  499.         you  may elect to skip it (intending to come back to it later) and  let
  500.         Q&ASA present the next one.
  501.  
  502.         Skipping  a  question is done simply by pressing the  ESCape  key  when
  503.         Q&ASA prompts for an answer. The question will not be scored, but Q&ASA
  504.         will  present  it again after you have answered all  of  the  remaining
  505.         questions.  You may not omit a question, but you may  essentially  scan
  506.         through the questions and answer them in the order you choose.
  507.  
  508.         If  you choose to answer a question, you must enter a  response.  Q&ASA
  509.         will not accept a blank answer.
  510.  
  511.         Q&ASA  will always display the number of points you will be awarded  if
  512.         you  answer correctly at the right of the answer window. The number  of
  513.         points  displayed  is the ratio of the total number of  points  to  the
  514.         weight of the question in points, defined in the compiled database.  If
  515.         you answer incorrectly, you are awarded zero points.
  516.  
  517.  
  518.         Creating a Database
  519.         -------------------
  520.  
  521.         The database is the heart of Q&ASA. Q&ASA receives virtually all of the
  522.         information  it  needs  to  present and score  your  answers  from  the
  523.         database.
  524.  
  525.         The  database is created from a plain ASCII, or 'flat' file,  and  then
  526.  
  527.  
  528.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 8
  529.         Q&A Study Aid User's Guide
  530.  
  531.  
  532.         compiled  using the database compiler Q&AC. The input given to Q&AC  is
  533.         called the database definition file; the output of Q&AC is the compiled
  534.         database.  Q&AC  creates  and  destroys one  intermediate  file  as  it
  535.         compiles the database definition file.
  536.  
  537.         Q&AC supports a large number of options that may be used to control the
  538.         quiz session. Each option is specified using a keyword followed by zero
  539.         or  more lines of text. It is important to remember that keywords  must
  540.         be on a line by themselves with no other text.
  541.  
  542.         If  you use a word processor program to create the database  definition
  543.         file, be sure to use its 'nondocument' mode to insure that it won't put
  544.         in any formatting codes. A plain ASCII text editor is recommended.
  545.  
  546.         To  enable  Q&ASA to handle all of the common question  formats  except
  547.         'essay'  questions, a very general database arrangement is  used.  Q&AC
  548.         expects  each question to be followed by the correct answer,  which  it
  549.         uses to check the answer typed in by the user.
  550.  
  551.         Q&ASA  can  handle multiple-choice, true/false,  and  fill-in-the-blank
  552.         questions with equal ease.
  553.  
  554.         The database must contain one instance of each of two keywords for each
  555.         question in the database. These keywords are, exactly, in quotes:
  556.  
  557.              "Q="
  558.              "A="
  559.  
  560.         As  you  might  expect, these stand for "question"  and  "answer".  The
  561.         question  MUST  precede  the  answer.  Q&AC  will  complain  about  any
  562.         irregularities it finds in the database when it constructs the compiled
  563.         database file.
  564.  
  565.         The  following  is a simple example of a question and  answer  as  they
  566.         might  appear in the database definition file. It is a  multiple-choice
  567.         question.  The following text is entered into the  database  definition
  568.         file:
  569.  
  570.         Q=
  571.         Multiple-choice:
  572.  
  573.         What is the capital of Pennsylvania?
  574.         A. Philadelphia
  575.         B. Washington, D.C.
  576.         C. Harrisburg
  577.         D. None of the above
  578.  
  579.         A=
  580.         C
  581.  
  582.         Considering Q&AC and Q&ASA together as a unit, what will happen is that
  583.         Q&ASA  will  display  the question beginning on  the  line  immediately
  584.         following the 'Q=' line. The end of the question is marked by the 'A='.
  585.         All  lines  between these markers form the question, which  Q&ASA  will
  586.         display  exactly  as it appears in the database.  You  may,  therefore,
  587.  
  588.  
  589.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 9
  590.         Q&A Study Aid User's Guide
  591.  
  592.  
  593.         format  your  questions  any way that you wish. Q&ASA  will  impose  NO
  594.         restrictions  other  than  the number of lines; you may use  up  to  15
  595.         lines.  If  the question is longer than that, the extra lines  will  be
  596.         discarded.  Blank lines between the end of the actual question and  the
  597.         'A=' line are effectively discarded.
  598.  
  599.         Note  that  the  'Multiple-choice' prompt is actually  a  part  of  the
  600.         database  - NOT hard-coded into Q&ASA. You may include this as part  of
  601.         your database or omit it if you wish.
  602.  
  603.         The answer follows beginning on the line immediately after the 'A='. In
  604.         this  example,  it is 'C'. All this means is that Q&ASA will  score  as
  605.         correct any response to the question that is exactly 'C' OR 'c' -  case
  606.         is insignificant. Q&ASA does some preformatting of these strings  prior
  607.         to  the  comparison, however. Both the answer in the database  and  the
  608.         answer typed in by you are processed the same way:
  609.  
  610.              1. All leading whitespace is removed. This means that
  611.                   C
  612.                 and
  613.                                  C
  614.                 are equivalent and are themselves equivalent to the 'C' in  the
  615.                 example above.
  616.  
  617.              2. All  trailing  whitespace,  including  newline  characters,  is
  618.                 removed.
  619.  
  620.              3. All whitespace (blanks and tabs) between words is collapsed  to
  621.                 a single space;
  622.                 "hello   there"
  623.                 and
  624.                 "hello            there"
  625.                 are equivalent.
  626.  
  627.              4. All  characters  are folded to uppercase; 'Yes' and  'yes'  are
  628.                 therefore equivalent.
  629.  
  630.         These steps insure that a response will not be scored as incorrect  due
  631.         to  the position of any part of the response in either your  answer  or
  632.         that in the database.
  633.  
  634.         Note  that  these  same rules are also applied to  the  'Q='  and  'A='
  635.         markers. They may, therefore, appear anywhere on the line. You  cannot,
  636.         however, insert anything between 'Q' and '='; nor can you put  anything
  637.         else on the line with the marker.
  638.  
  639.         In the example above, one correct answer was specified. The only answer
  640.         that  will be scored as correct is 'C' (and 'c', of course). Note  that
  641.         we  could just as well have used numbers as selectors and given '3'  as
  642.         the  answer. Q&ASA makes no attempt to interpret this  information;  it
  643.         simply looks for an exact match based on the criteria outlined above.
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 10
  651.         Q&A Study Aid User's Guide
  652.  
  653.  
  654.  
  655.  
  656.         This next example will demonstrate a true/false question.
  657.  
  658.         Q=
  659.  
  660.  
  661.  
  662.                 Answer true or false:
  663.  
  664.                 Q&ASA understands the information in the database.
  665.                       A=
  666.         False
  667.  
  668.         Note  the (legal) position of the 'A='. This time we have indented  the
  669.         question  using  tabs. When Q&AC compiles the question, it  expand  the
  670.         tabs  automatically to maintain the alignment as it is in the  database
  671.         definition  file. We also have three blank lines after the  'Q=';  this
  672.         serves  to  shift the question down toward the center of  the  question
  673.         window to make it look nicer.
  674.  
  675.         This  example  is  not  good practice (although  it  will  be  compiled
  676.         correctly),  since the 'A=' would be easy to miss if the database  were
  677.         edited,  and the indentation is inconsistent. It does, however, have  a
  678.         more  serious  drawback: to get the question right, you  must  type  in
  679.         'false', all 5 characters - and 'false' is one word I just cannot  type
  680.         (it always comes out 'flase')!
  681.  
  682.         For  a  true/false question, one would be likely to respond  with  'T',
  683.         'F', 'yes', 'y', or possibly '1' and '0'. To accommodate these options,
  684.         Q&ASA allows more than one correct answer. In fact, every nonblank line
  685.         between 'A=' and the next 'Q=' is a correct answer. The second  example
  686.         above, then, would be more appropriately given by
  687.  
  688.  
  689.         Q=
  690.  
  691.  
  692.  
  693.           Answer true or false:
  694.  
  695.           Q&ASA understands the information in the database.
  696.  
  697.         A=
  698.  
  699.         False
  700.         F
  701.         No
  702.         N
  703.         0
  704.  
  705.         This permits any of the five answers to be regarded as correct.
  706.  
  707.         If  you  give an incorrect response to a question or one  that  is  not
  708.         among  the  list  of correct answers, Q&ASA will  display  the  correct
  709.  
  710.  
  711.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 11
  712.         Q&A Study Aid User's Guide
  713.  
  714.  
  715.         answer  for you (as well as omit a point from your score).  When  Q&ASA
  716.         displays the correct answer, it uses the first one given in the  answer
  717.         list  (blank  lines are ignored). What this means is  that  Q&ASA  will
  718.         display
  719.  
  720.              Incorrect. The correct answer is
  721.                          False
  722.                 Press any key to continue.
  723.  
  724.         which is more formal than 'N', for example.
  725.  
  726.         This  feature  adds  a  lot of versatility to  Q&ASA.  Since  Q&ASA  is
  727.         intended  to  be  a  study aid,  it  should  provide  reinforcement  of
  728.         incorrect  answers  by permitting a more complete  correct  answer.  To
  729.         demonstrate this, we'll use a third example; this time, a  fill-in-the-
  730.         blank question:
  731.  
  732.  
  733.         Q=
  734.              The speed of light is ______ km/sec.
  735.  
  736.         A=
  737.              Light travels at 300,000 km/sec.
  738.              300000
  739.              300,000
  740.              300K
  741.  
  742.         In this example, an incorrect response will elicit
  743.  
  744.              Incorrect. The correct answer is
  745.              Light travels at 300,000 km/sec.
  746.                Press any key to continue.
  747.  
  748.         Of  course, this is also a correct answer in itself, but not  a  likely
  749.         one.  If  you  do enter it, it will be scored as  correct.  You  would,
  750.         however, be required to include the period.
  751.  
  752.         There  are  three  more  plausible correct  answers  that  Q&ASA  would
  753.         consider  to  be correct. Any one of them is sufficient to  credit  the
  754.         answer to you.
  755.  
  756.         When creating a large database definition file, it is annoying to  have
  757.         to  type the four or more common answers to a true/false  question.  To
  758.         make  this easier, Q&AC supports simple macros. A macro is a  block  of
  759.         text  that  is  inserted  in place of  the  macro  identifier.  We  may
  760.         therefore  create a macro for 'true' and a macro for 'false',  and  use
  761.         the  macro  identifier instead of typing all four answer  lines.  These
  762.         macros would look something like this:
  763.  
  764.         M=
  765.         $TRUE$
  766.         true
  767.         t
  768.         yes
  769.         y
  770.  
  771.  
  772.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 12
  773.         Q&A Study Aid User's Guide
  774.  
  775.  
  776.  
  777.         M=
  778.         $FALSE$
  779.         false
  780.         f
  781.         no
  782.         n
  783.  
  784.         Q=
  785.  
  786.           Answer true or false:
  787.  
  788.           Q&ASA understands the information in the database.
  789.  
  790.         A=
  791.         $FALSE$
  792.  
  793.         The  "M=" is the macro keyword and tells Q&AC that the following  lines
  794.         form a macro definition. The first line following the macro keyword  is
  795.         the  macro  identifier.  You may use any character string  as  a  macro
  796.         identifier,  provided  it does not contain blanks or tabs.  The  dollar
  797.         signs  are  not necessary, but serve nicely to identify  $FALSE$  as  a
  798.         macro  invocation. When Q&AC reads the identifier, it  will  substitute
  799.         all lines following the macro identifier up to the first blank line  or
  800.         keyword, whichever is found first. Note that Q&ASA will display "false"
  801.         as the correct answer if the question is answered incorrectly, as it is
  802.         the first answer in the answer list formed by expanding the macro.
  803.  
  804.         The  above  is a short introduction to creating a  database  definition
  805.         file. The following section describes the Q&AC compiler in detail.
  806.  
  807.  
  808.         The Q&AC Database Compiler
  809.         -------------------------
  810.  
  811.         Q&AC  is a separate program that is used only when a database is  first
  812.         created.  Once  the database definition file has been  created,  it  is
  813.         compiled  with  Q&AC,  and the compiled database  file  (which  has  an
  814.         extension  of .Q&A) is distributed to the users of the  Q&ASA  program.
  815.         This offers several advantages, among them:
  816.  
  817.         1. The  database is encrypted. A user of Q&ASA cannot look in the  file
  818.            using  any  viewing,  listing,  or debugging  program  and  see  the
  819.            questions  and  answers.  Q&ASA  knows  the  encryption  method  and
  820.            decrypts the database as it reads it.
  821.  
  822.         2. The  author of the database definition file may specify a number  of
  823.            options to control the quiz session. These options cannot be seen or
  824.            modified by the user of Q&ASA.
  825.  
  826.         3. Since  the  database  has been preprocessed  by  Q&AC,  loading  and
  827.            display  of questions is faster. It is not necessary to perform  any
  828.            formatting at run time.
  829.  
  830.  
  831.  
  832.  
  833.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 13
  834.         Q&A Study Aid User's Guide
  835.  
  836.  
  837.  
  838.         Using Q&AC
  839.         ---------
  840.  
  841.         Q&AC has a simple invocation syntax, as follows:
  842.  
  843.              Q&AC <database definition filename> <ENTER>
  844.  
  845.         There are no command-line options.
  846.  
  847.         Q&AC  expects  you  to  use  an extension  of  .DEF  for  the  database
  848.         definition file. If you use this extension, you do not have to type it.
  849.         If  you use any other extension, you must specify the entire  filename.
  850.         For example, the sample database definition file is called  SAMPLE.DEF.
  851.         To compile it, type
  852.  
  853.              Q&AC SAMPLE <ENTER>
  854.  
  855.         If  the  database definition file were named SAMPLE.TXT,  however,  you
  856.         will be required to type
  857.  
  858.              Q&AC SAMPLE.TXT <ENTER>
  859.  
  860.         If  you  give the database definition file an extension of  .Q&A,  Q&AC
  861.         will  reject  it, as this extension is reserved for  compiled  database
  862.         files.  The  reason  this extension is reserved is so  that  Q&ASA  may
  863.         filter  the  files  in the directory when  it  displays  the  available
  864.         databases.
  865.  
  866.         Q&AC will not make any changes to the database definition file. It will
  867.         create  a  compiled database file of the same base name,  but  with  an
  868.         extension  of .Q&A. In the examples above, the compiled database  files
  869.         would  all be named SAMPLE.Q&A. If the compiled database  file  already
  870.         exists,  it is overwritten by Q&AC, and the original contents  will  be
  871.         lost. Q&AC will NOT warn you of this.
  872.  
  873.         When Q&AC is finished, it will display the options you selected in  the
  874.         definition  file.  The  output on the following page  was  produced  by
  875.         compiling the sample database SAMPLE.DEF.
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 14
  895.         Q&A Study Aid User's Guide
  896.  
  897.  
  898.  
  899.         Q&A Study Aid Database Compiler Version 1.3 (SHAREWARE)
  900.         Copyright (C) 1988 Quid Pro Quo Software. All Rights Reserved.
  901.  
  902.         File SAMPLE.DEF compiled to file SAMPLE.Q&A
  903.  
  904.         Configuration
  905.  
  906.            Name ............... "Sample Database"
  907.            Total weight ....... 29
  908.            Score filename ..... "q&a.scr"
  909.            Time limit ......... 00:05:00
  910.            Mode lock .......... (none)
  911.            Clear command ...... Enabled
  912.  
  913.         Macros
  914.  
  915.            $FALSE$
  916.            $TRUE$
  917.  
  918.         345 Source lines
  919.         20 Questions
  920.  
  921.  
  922.         Q&AC Language Syntax
  923.         --------------------
  924.  
  925.         Q&AC,  being  a  true  compiler,  requires  that  you  follow   certain
  926.         syntactical rules when creating a database definition file. The  syntax
  927.         was  made as simple and forgiving as possible to minimize the  learning
  928.         time.
  929.  
  930.         The  Q&AC language is line-oriented, meaning that Q&AC views its  input
  931.         in  terms  of  whole lines. You may not,  therefore,  put  two  keyword
  932.         markers on the same line, for example.
  933.  
  934.         The following is a short summary of the keywords that Q&AC uses.
  935.  
  936.              Q=   question text
  937.              A=   answer list
  938.              N=   quiz name
  939.              M=   macro definition
  940.              T=   time limit
  941.              C=   clear NOT allowed
  942.              S=   lock in sequential mode
  943.              R=   lock in random mode
  944.              F=   output score filename
  945.              W=   assign weighting
  946.  
  947.         Each of these keywords is described in the following paragraphs.
  948.  
  949.         Q&AC  scans and discards all text in the database definition file  that
  950.         is not part of a keyword interpretation. This means that you may insert
  951.         comments  almost  anywhere, without using special  comment  delimiters.
  952.         Since Q&AC is line-oriented, you may not, of course, place a comment on
  953.  
  954.  
  955.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 15
  956.         Q&A Study Aid User's Guide
  957.  
  958.  
  959.         the  same  line with any keyword or its associated text.  Comments  are
  960.         otherwise unrestricted.
  961.  
  962.  
  963.         The Q= and A= Keywords
  964.         ----------------------
  965.  
  966.         As mentioned previously, Q= and A= are the keywords for 'question'  and
  967.         'answer', respectively. Each has the same basic syntax:
  968.  
  969.         Q= (or A=)
  970.         <text>
  971.         <text>
  972.         <text>
  973.         <termination>
  974.  
  975.         For  all Q&AC keywords that take multiple lines of text  as  arguments,
  976.         with  the single exception of the Q= keyword, the <termination> is  the
  977.         same:  a  blank  line,  another keyword, or  end-of-file.  For  the  Q=
  978.         keyword,  a  blank  line is NOT a termination; only  the  'A='  keyword
  979.         terminates  a  question. This is to allow blank lines in  the  question
  980.         text. You must be careful not to place comment lines immediately  after
  981.         the  text  for  a question, since it will be regarded as  part  of  the
  982.         question and displayed on the Q&ASA screen.
  983.  
  984.         A question may not have more than 15 lines of text associated with  it,
  985.         and you are limited to 76 characters per line. Within this  rectangular
  986.         boundary,  you  are unrestricted. If you exceed the allowed  number  of
  987.         lines  or  if a line contains more than 76 characters  (after  tab  and
  988.         macro expansion), Q&AC will display an error message and stop.
  989.  
  990.         You  are  permitted  any number of answer lines, limited  only  by  the
  991.         amount of memory available in the PC running Q&ASA. If the PC has  128K
  992.         bytes or more of available memory (free memory above DOS and all TSRs),
  993.         you  are  essentially unrestricted unless your database  is  especially
  994.         large.
  995.  
  996.  
  997.         The N= Keyword
  998.         --------------
  999.  
  1000.         The  N= keyword is used to specify the quiz name. The name must  appear
  1001.         on  the line following the keyword, and may be up to 70  characters  in
  1002.         length.  When the database is loaded into Q&ASA, this name  appears  in
  1003.         the top border of the center (question) window.
  1004.  
  1005.         For example, to name a quiz on American history as such, you would use
  1006.  
  1007.         N=
  1008.         American History Quiz
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 16
  1017.         Q&A Study Aid User's Guide
  1018.  
  1019.  
  1020.  
  1021.         The M= Keyword
  1022.         --------------
  1023.  
  1024.         The  M= keyword is the macro definition keyword, and indicates to  Q&AC
  1025.         that  the following lines are a macro definition. The macro  definition
  1026.         takes the following form:
  1027.  
  1028.         M=
  1029.         <macro identifier>
  1030.         <first macro line>
  1031.         <second macro line>
  1032.         <Nth macro line>
  1033.         <termination>
  1034.  
  1035.         Macros  are expanded recursively, so if you place the macro  identifier
  1036.         in  any  of  the  macro  definition lines,  you  will  create  a  self-
  1037.         referential  macro  that will be expanded endlessly. The  recursion  is
  1038.         allowed  so that you may build complex macros from simple ones  if  you
  1039.         wish.
  1040.  
  1041.         For  example,  to build a macro for 'TRUE' from two  other  macros,  we
  1042.         could use:
  1043.  
  1044.         M=
  1045.         $T$
  1046.         True
  1047.         T
  1048.         M=
  1049.         $Y$
  1050.         Yes
  1051.         Y
  1052.         M=
  1053.         $TRUE$
  1054.         $T$
  1055.         $Y$
  1056.  
  1057.         We  have  defined  three macros, "$T$", "$Y$", and  "$TRUE$".  If  Q&AC
  1058.         encounters  $TRUE$ in the database definition file, it will replace  it
  1059.         with
  1060.  
  1061.         True
  1062.         T
  1063.         Yes
  1064.         Y
  1065.  
  1066.         because  "True"  and "T" are expansions of $T$ and "Yes"  and  "Y"  are
  1067.         expansions  of $Y$. Note that blank lines are unnecessary  between  the
  1068.         macro  definitions, since each is terminated by the M= keyword  of  the
  1069.         following macro.
  1070.  
  1071.         You may use a macro identifier anywhere in the database definition file
  1072.         except  within  its own definition, as has been pointed  out.  However,
  1073.         macros invocations MUST be surrounded by whitespace. For example,  many
  1074.         multiple-choice  questions may use the blanket selectors "none  of  the
  1075.  
  1076.  
  1077.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 17
  1078.         Q&A Study Aid User's Guide
  1079.  
  1080.  
  1081.         above"  and  "all of the above". You may therefore  use  the  following
  1082.         macros:
  1083.  
  1084.         M=
  1085.         $NONE$
  1086.         None of the above.
  1087.         M=
  1088.         $ALL$
  1089.         All of the above.
  1090.  
  1091.         and write a multiple-choice question as:
  1092.  
  1093.         Q=
  1094.         Multiple-choice:
  1095.  
  1096.         In what year did Christopher Columbus land in the New World?
  1097.  
  1098.              1. 1592
  1099.              2. 1492
  1100.              3. 1066
  1101.              4. $NONE$
  1102.              5. $ALL$
  1103.  
  1104.         A=
  1105.         2. 1492
  1106.         2
  1107.         1492
  1108.  
  1109.         Q&AC will expand this to:
  1110.  
  1111.         Q=
  1112.         Multiple-choice:
  1113.  
  1114.         In what year did Christopher Columbus land in the New World?
  1115.  
  1116.              1. 1592
  1117.              2. 1492
  1118.              3. 1066
  1119.              4. None of the above.
  1120.              5. All of the above.
  1121.  
  1122.         A=
  1123.         2. 1492
  1124.         2
  1125.         1492
  1126.  
  1127.  
  1128.  
  1129.  
  1130.  
  1131.  
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 18
  1139.         Q&A Study Aid User's Guide
  1140.  
  1141.  
  1142.  
  1143.         Remember  that Q&AC is line-oriented, however. If you put the  following
  1144.         in the database definition file:
  1145.  
  1146.         M=
  1147.         $NW$
  1148.         New World
  1149.  
  1150.         Q=
  1151.         Multiple-choice:
  1152.  
  1153.         In what year did Christopher Columbus land in the $NW$?
  1154.  
  1155.              1. 1592
  1156.              2. 1492
  1157.              3. 1066
  1158.              4. None of the above.
  1159.              5. All of the above.
  1160.  
  1161.         Q&AC will NOT expand it because there is no whitespace between the $NW$
  1162.         and the '?'. If, however, you use
  1163.  
  1164.         M=
  1165.         $NW$
  1166.         New World
  1167.  
  1168.         Q=
  1169.         Multiple-choice:
  1170.  
  1171.         In what year did Christopher Columbus land in the $NW$ ?
  1172.  
  1173.              1. 1592
  1174.              2. 1492
  1175.              3. 1066
  1176.              4. None of the above.
  1177.              5. All of the above.
  1178.  
  1179.         Q&AC will expand it to
  1180.  
  1181.         Q=
  1182.         Multiple-choice:
  1183.  
  1184.         In what year did Christopher Columbus land in the New World
  1185.          ?
  1186.              1. 1592
  1187.              2. 1492
  1188.              3. 1066
  1189.              4. None of the above.
  1190.              5. All of the above.
  1191.  
  1192.         because  the  macro definition includes the newline.  You  should  not,
  1193.         therefore, attempt to use a macro in the middle of a block of text.
  1194.  
  1195.         Macros  must be defined before they can be used. If you place  a  macro
  1196.         definition  in the middle of the database definition file and  use  the
  1197.  
  1198.  
  1199.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 19
  1200.         Q&A Study Aid User's Guide
  1201.  
  1202.  
  1203.         macro identifier before and after it, then the identifiers that  appear
  1204.         before  the macro definition will NOT be expanded. Define all  of  your
  1205.         macros before entering the first question.
  1206.  
  1207.  
  1208.         The T= Keyword
  1209.         --------------
  1210.  
  1211.         This  is the time limit keyword. Include it in the database  definition
  1212.         file  to  specify  a  time limit. If you omit it,  the  time  limit  is
  1213.         infinite.
  1214.  
  1215.         The syntax is as follows:
  1216.  
  1217.         T=
  1218.         HH:MM:SS
  1219.  
  1220.         where HH is hours, MM is minutes, and SS is seconds. If the time  limit
  1221.         is  less than an hour, you may omit the hours field; similarly, if  the
  1222.         time  limit is less than a minute, you may omit the hours  and  minutes
  1223.         fields.  The  sample  database  definition  file  contains  a  5-minute
  1224.         timeout, given by
  1225.  
  1226.         T=
  1227.         5:00
  1228.  
  1229.  
  1230.         The C= Keyword
  1231.         --------------
  1232.  
  1233.         This keyword is used to disable the Clear command. An individual taking
  1234.         a  quiz  with Q&ASA can use the Clear command to reset  the  score  and
  1235.         essentially  do the quiz twice. The author of the  database  definition
  1236.         file may prevent this by entering
  1237.  
  1238.         C=
  1239.  
  1240.         in  the database definition file. When this is done, Q&ASA will  ignore
  1241.         the Clear command completely.
  1242.  
  1243.         Note  that  if  the Clear command is allowed, by  omission  of  the  C=
  1244.         keyword,  and the score file is enabled with the F= keyword  (described
  1245.         later),  then  a  score  record  will be  written  to  the  score  file
  1246.         indicating that the user cleared the score and restarted the quiz.
  1247.  
  1248.  
  1249.         The S= and R= Keywords
  1250.         ----------------------
  1251.  
  1252.         These are the mode lock keywords, where S= stands for "sequential"  and
  1253.         R=  stands  for  "random". These keywords  are  mutually  exclusive;  a
  1254.         database definition may not contain both keywords. If it does, an error
  1255.         will be generated by Q&AC and compilation will stop.
  1256.  
  1257.         These  keywords  are used to lock Q&ASA in the mode  specified  by  the
  1258.  
  1259.  
  1260.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 20
  1261.         Q&A Study Aid User's Guide
  1262.  
  1263.  
  1264.         keyword.  If you do not give either keyword, then the user of Q&ASA  is
  1265.         able to use the Mode command to change modes.
  1266.  
  1267.         For example, to lock Q&ASA in sequential mode, use the following:
  1268.  
  1269.         S=
  1270.  
  1271.         and to lock Q&ASA in random mode:
  1272.  
  1273.         R=
  1274.  
  1275.         There are no other arguments. The lock remains in effect until  another
  1276.         database is loaded.
  1277.  
  1278.  
  1279.         The F= Keyword
  1280.         --------------
  1281.  
  1282.         The  F= keyword controls logging of score information to a  disk  file.
  1283.         Logging  is enabled by specifying a filename with the F=  keyword,  and
  1284.         disabled if you omit the keyword.
  1285.  
  1286.         The  filename  you  specify may be any valid DOS  pathname,  up  to  64
  1287.         characters  in length. All scoring records are appended to the file  if
  1288.         it  already  exists, and the file will be created automatically  if  it
  1289.         does not exist.
  1290.  
  1291.         The score logging file may exist on a file server of a networked system
  1292.         if  desired. However, Q&ASA DOES NOT SUPPORT FILE  SHARING.  Typically,
  1293.         and  networked  system will require that a file be locked while  it  is
  1294.         being  updated so that no other network user may access the file  until
  1295.         the  updating  has  been completed. If Q&ASA is  used  in  a  networked
  1296.         system, the networking extensions to DOS must provide this function.
  1297.  
  1298.         If  networking is to be used, but the network does not perform  locking
  1299.         on  a file level (such as Corvus System's OmniNet(c)), then you  should
  1300.         specify a score logging file on the local drive of each PC, and collect
  1301.         these files at a later time. Otherwise, you may end up with a corrupted
  1302.         score file.
  1303.  
  1304.         All score log records are plain ASCII. An example is reproduced on  the
  1305.         following page.
  1306.  
  1307.  
  1308.  
  1309.  
  1310.  
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.  
  1319.  
  1320.  
  1321.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 21
  1322.         Q&A Study Aid User's Guide
  1323.  
  1324.  
  1325.  
  1326.  
  1327.         Student Name:         John Q. Public
  1328.         Database Name:        Sample Database
  1329.         Final Score:          72.41%
  1330.         Termination:          TIME LIMIT
  1331.  
  1332.         Started:              Sun Mar 20 15:44:44 1988
  1333.         Completed:            Sun Mar 20 15:46:45 1988
  1334.         Elapsed Time:         00:02:00
  1335.  
  1336.         Database File:        SAMPLE.Q&A
  1337.         Total Questions:      20
  1338.         Possible Points:      29
  1339.         Points Awarded:       21
  1340.  
  1341.         Point Matrix:
  1342.                        1     2     3     4     5     6     7     8     9    10
  1343.         0001-0010  10.34  3.45  3.45   ???  3.45   ---   ???   ---  3.45  3.45
  1344.         0011-0020   6.90  3.45  6.90  3.45   ---  3.45  3.45  6.90  3.45  6.90
  1345.  
  1346.         **********************************************************************
  1347.  
  1348.  
  1349.         The '*****....*****' forms a separator between individual records.
  1350.  
  1351.         The  first  block  contains  summary  information  regarding  the  quiz
  1352.         session.  The quiz taker's name is listed along with  the name  of  the
  1353.         database (given by the N= keyword), the final score, and the reason the
  1354.         score  record  was written to the score file. In this  example,  it  is
  1355.         given as 'TIME LIMIT'. This means that the quiz taker used up the  time
  1356.         allotted by the T= keyword. The possible reasons for termination are:
  1357.  
  1358.              Completed      The  user  answered  all  questions  in  the   time
  1359.                             allotted by the T= keyword.
  1360.  
  1361.              TIME LIMIT     The  user  exceeded  the time allotted  by  the  T=
  1362.                             keyword. This reason can only be produced if a time
  1363.                             limit was given.
  1364.  
  1365.              ABORTED        This indicates that the user quit the Q&ASA session
  1366.                             before  answering  all  questions  using  the   /FX
  1367.                             command.
  1368.  
  1369.              CLEARED        The Clear command (/MC) was used to clear the score
  1370.                             and  restart  the  quiz.  This  reason  cannot   be
  1371.                             produced  if the C= keyword is used to disable  the
  1372.                             Clear command.
  1373.  
  1374.              RELOADED       The   user  reloaded  the  database  or  loaded   a
  1375.                             different   database  before  all  questions   were
  1376.                             answered.
  1377.  
  1378.         The final score is always the ratio of the number of possible points to
  1379.         the  total number of points awarded by answering  correctly.  Questions
  1380.  
  1381.  
  1382.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 22
  1383.         Q&A Study Aid User's Guide
  1384.  
  1385.  
  1386.         that were not answered are scored as incorrect.
  1387.  
  1388.         The log record also specifies the time the database was loaded (thereby
  1389.         starting  the timer, if a time limit was given), the time the quiz  was
  1390.         completed  or  stopped (for any of the reasons given  above),  and  the
  1391.         elapsed  time. With this information and a low score due  to  incorrect
  1392.         answers, it would be relatively easy to spot random guessing.
  1393.  
  1394.         The  third block of the record gives the name of the compiled  database
  1395.         file,  the number of questions in the file, and the number of  possible
  1396.         points  with  the  number of points awarded.  Because  Q&AC  and  Q&ASA
  1397.         support weighting, the number of possible points may be different  from
  1398.         the number of questions.
  1399.  
  1400.         The  last  block is the point matrix. This shows the  results  of  each
  1401.         question  in  the database, ten questions per line. Each  question  may
  1402.         have three possible outcomes:
  1403.  
  1404.         1. The question was answered, and answered correctly. The point  matrix
  1405.            will  show the number of points awarded as a ratio of the number  of
  1406.            possible points.
  1407.  
  1408.         2. The  question  was  answered, but answered  incorrectly.  The  point
  1409.            matrix will show that no points were awarded with '---'.
  1410.  
  1411.         3. The  question  was not answered, either by skipping over  it  or  by
  1412.            exceeding  the allotted time. The point matrix will show  this  with
  1413.            '???'. No points were awarded.
  1414.  
  1415.         In the example score record shown above, you can see that questions  6,
  1416.         8,  and  15  were  answered incorrectly, questions 4  and  7  were  not
  1417.         answered (due to the time limit given as the reason), and the remaining
  1418.         15  questions  were  answered correctly. The point  breakdown  will  be
  1419.         described the following section on weighting.
  1420.  
  1421.  
  1422.         The W= Keyword
  1423.         --------------
  1424.  
  1425.         This keyword is used to assign weights to each question. The  weighting
  1426.         system  you  use is entirely arbitrary and up to you.  Q&AC  and  Q&ASA
  1427.         impose only the restriction that you use integer weights, and that  you
  1428.         use numbers between 1 and 32767 inclusive.
  1429.  
  1430.         The syntax of the W= keyword is as follows:
  1431.  
  1432.         W=
  1433.         <weight>
  1434.  
  1435.         When  Q&AC encounters this keyword, it reads the weight and assigns  it
  1436.         to all the questions that follow it. If Q&AC encounters the W=  keyword
  1437.         again, it will change the weight to the new weight, and assign the  new
  1438.         weight  to  all following questions. As each question is  processed  by
  1439.         Q&AC,  Q&AC  keeps  track  of the total weight.  When  Q&ASA  scores  a
  1440.         question,  it determines the point score to be the ratio of  the  total
  1441.  
  1442.  
  1443.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 23
  1444.         Q&A Study Aid User's Guide
  1445.  
  1446.  
  1447.         weight to that of the question in percent. This point score is added to
  1448.         the running score shown in the scoring window, and also appears in  the
  1449.         point matrix in the score file.
  1450.  
  1451.         If  you  do not specify a weight anywhere in  the  database  definition
  1452.         file, all questions will be weighted as one point by default.
  1453.  
  1454.         Note that this arrangement allows you total flexibility in setting up a
  1455.         weighting system. You do not have to weight each question as a fraction
  1456.         of 100, for example. Q&AC and Q&ASA do this for you.
  1457.  
  1458.         The  sample database weights each 'fill-in' question as  three  points,
  1459.         each  true/false as 2 points, and each multiple-choice question as  one
  1460.         point.  There is one 'fill-in' question, 7 'true/false' questions,  and
  1461.         12 'multiple-choice' questions. The points are calculated as follows:
  1462.  
  1463.         fill-in             1    times     3 points  = 3  points
  1464.         true/false          7    times     2 points  = 14 points
  1465.         multiple-choice     12   times     1 point   = 12 points
  1466.         Total:              20                         29
  1467.  
  1468.         There are therefore 29 possible points (as shown in the score file).  A
  1469.         'fill-in'  question  is  therefore worth 3/29 points  or  10.34  points
  1470.         relative  to 100. A 'true/false' question is worth 2/29 points or  6.90
  1471.         points  relative to 100, and a 'multiple-choice' question 1/29 or  3.45
  1472.         points  relative  to  100. In the example score record,  the  user  was
  1473.         awarded  a total of 21 out of 29 possible points, for a score of  21/29
  1474.         or  72.41%.  Adding all of the points shown in the  point  matrix  will
  1475.         produce the same result.
  1476.  
  1477.  
  1478.         Conclusion
  1479.         ----------
  1480.  
  1481.         Most  of these examples can be found in the sample database  definition
  1482.         file,  SAMPLE.DEF.  Experiment with it (remember to recompile  it  with
  1483.         Q&AC  if  you change it), but please don't pass on a modified  copy  to
  1484.         someone else.
  1485.  
  1486.                                       The author
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.  
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 24
  1505.         Q&A Study Aid User's Guide
  1506.  
  1507.  
  1508.  
  1509.         Appendix
  1510.         --------
  1511.  
  1512.         Q&AC Error Messages
  1513.         -------------------
  1514.  
  1515.         Usage: Q&AC <definition filename>
  1516.  
  1517.              This error will be generated if you invoke Q&AC without specifying
  1518.              the name of a database definition file.
  1519.  
  1520.         Illegal definition filename: <filename>
  1521.  
  1522.              This  error is generated if you supply a database definition  file
  1523.              with an extension of .Q&A.
  1524.  
  1525.         Cannot find database definition file <filename>
  1526.  
  1527.              This  error indicates that Q&AC was not able to open the  database
  1528.              definition file you specified.
  1529.  
  1530.         Unable to create temporary file <filename>
  1531.  
  1532.              This  error  indicates  that  Q&AC was  not  able  to  create  its
  1533.              intermediate temporary file.
  1534.  
  1535.         File <def file> : Line <line> : Answer omitted
  1536.  
  1537.              You  specified a question without an accompanying answer, or  your
  1538.              syntax is such that Q&AC could not determine where the answer is.
  1539.  
  1540.         File <definition file> : Line <line> : Question omitted
  1541.  
  1542.              You  specified  an answer without a preceding  question,  or  your
  1543.              syntax  was such that Q&AC could not determine where the  question
  1544.              is.
  1545.  
  1546.         File <def file> : Line <line> : Macro name missing
  1547.  
  1548.              You  specified the macro definition keyword M=, but the next  line
  1549.              is blank.
  1550.  
  1551.         File <def file> : Line <line> : Weight definition missing
  1552.  
  1553.              You  specified  the  weighting keyword W=, but the  next  line  is
  1554.              blank.
  1555.  
  1556.         File <def file> : Line <line> : Invalid weight
  1557.  
  1558.              You  specified  a weight that was outside the  range  1..32767  or
  1559.              entered alphabetical characters.
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 25
  1566.         Q&A Study Aid User's Guide
  1567.  
  1568.  
  1569.  
  1570.         File <def file> : Line <line> : Title missing
  1571.  
  1572.              You specified the name keyword N=, but the next line is blank.
  1573.  
  1574.         File <def file> : Line <line> : Title too long - truncated
  1575.  
  1576.              The  name  you  entered after the N= keyword  is  longer  than  70
  1577.              characters.
  1578.  
  1579.         File <def file> : Line <line> : Time limit definition missing
  1580.  
  1581.              You  specified  the time limit keyword T=, but the  next  line  is
  1582.              blank.
  1583.  
  1584.         File <def file> : Line <line> : Invalid time limit
  1585.  
  1586.              The  time limit you specified following the T= keyword is  not  in
  1587.              the form HH:MM:SS.
  1588.  
  1589.         File <def file> : Line <line> : Mode lock already set
  1590.  
  1591.              You  specified  S=  and R= in the same definition  file.  Q&AC  is
  1592.              complaining about the second occurrence.
  1593.  
  1594.         File <def file> : Line <line> : Filename missing
  1595.  
  1596.              You  specified an output score file with the F= keyword,  but  the
  1597.              next line is blank.
  1598.  
  1599.         File <def file> : Line <line> : Illegal filename
  1600.  
  1601.              You  specified  a filename after the F= keyword that  has  invalid
  1602.              characters or longer than 64 characters.
  1603.  
  1604.         File <def file> : Line <line> : Question line exceeds 76 characters
  1605.  
  1606.              You  entered  a line in a question block that will  not  fit  into
  1607.              Q&ASA's window.
  1608.  
  1609.         File <def file> : Line <line> : Question exceeds 15 lines
  1610.  
  1611.              You entered a question that has too many lines.
  1612.  
  1613.         File <def file> : Line <line> : Answer line exceeds 76 characters
  1614.  
  1615.              You  entered an answer line that will not fit into Q&ASA's  answer
  1616.              window.
  1617.  
  1618.         Cannot create database output file <filename>
  1619.  
  1620.              Q&AC was unable to create the compiled database output file.
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 26
  1627.         Q&A Study Aid User's Guide
  1628.  
  1629.  
  1630.  
  1631.         Cannot open temporary file <filename>
  1632.  
  1633.              Q&AC was unable to create its temporary file.
  1634.  
  1635.         File <def file> : Line <line> : Insufficient memory
  1636.  
  1637.              Q&AC  ran  out of memory while processing your database.  If  this
  1638.              happens, you have several options. You may:
  1639.  
  1640.              1. Reduce  the  number  of questions or split  the  database  into
  1641.                 two files.
  1642.              2. Reduce the number of macros.
  1643.  
  1644.  
  1645.  
  1646.  
  1647.  
  1648.  
  1649.  
  1650.  
  1651.  
  1652.  
  1653.  
  1654.  
  1655.  
  1656.  
  1657.  
  1658.  
  1659.  
  1660.  
  1661.  
  1662.  
  1663.  
  1664.  
  1665.  
  1666.  
  1667.  
  1668.  
  1669.  
  1670.  
  1671.  
  1672.  
  1673.  
  1674.  
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682.  
  1683.  
  1684.  
  1685.  
  1686.  
  1687.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 27
  1688.         Q&A Study Aid User's Guide
  1689.  
  1690.  
  1691.  
  1692.                                     COPYRIGHT
  1693.  
  1694.  
  1695.         This  program is copyright (C) 1987, 1988 by Hal  Endresen,  Quid
  1696.         Pro Quo Software. All rights reserved.
  1697.  
  1698.         Q&A  Study  Aid is distributed as  SHAREWARE,  or  User-Supported
  1699.         Software.  I encourage you to try  the program and share it  with
  1700.         friends, provided that:
  1701.  
  1702.              The  program  is  distributed  in  unmodified  form  as  the
  1703.              complete  archive STDYAID2.ARC, complete with  documentation
  1704.              and this registration form.
  1705.  
  1706.              No  fee,  charge or  other consideration   is  requested  or
  1707.              accepted.
  1708.  
  1709.              The  program  is not  distributed in  conjunction  with  any
  1710.              other product.
  1711.  
  1712.  
  1713.                                   REGISTRATION
  1714.                                   ------------
  1715.  
  1716.         If  you  intend to use Q&A Study Aid on a regular  basis,  please
  1717.         register  it and show your support for the  author.   Commercial,
  1718.         business   or  governmental  use  by  non-registered   users   is
  1719.         prohibited.
  1720.  
  1721.  
  1722.                          Q&A STUDY AID REGISTRATION FORM
  1723.                          -------------------------------
  1724.  
  1725.         Name __________________________________________________________
  1726.  
  1727.         Address _______________________________________________________
  1728.  
  1729.         City _____________________________  State ______ Zip __________
  1730.  
  1731.         Phone _________________________________________________________
  1732.  
  1733.         To register, send this form and a check for $20 to:
  1734.  
  1735.  
  1736.         Quid Pro Quo Software
  1737.         1703 Marlbrook Lane
  1738.         Lansdale, PA 19446
  1739.  
  1740.  
  1741.         Registered  users  will receive notification of upgrades  of  Q&A
  1742.         Study Aid.
  1743.  
  1744.  
  1745.  
  1746.  
  1747.  
  1748.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 28
  1749.         Q&A Study Aid User's Guide
  1750.  
  1751.  
  1752.  
  1753.  
  1754.                              USER SUPPORTED SOFTWARE
  1755.                              -----------------------
  1756.  
  1757.         The  user  supported software  concept  (usually referred  to  as
  1758.         SHAREWARE)  is an attempt to provide software at low  cost.   The
  1759.         cost  of  offering a  new  product  by  conventional   means   is
  1760.         staggering,  and  hence dissuades many independent  authors   and
  1761.         small  companies  from developing  and  promoting   their  ideas.
  1762.         User  supported  software  is  an  attempt  to  develop   a   new
  1763.         marketing  channel,  where products can be  introduced   at   low
  1764.         cost.
  1765.  
  1766.         If user supported software works, then everyone will benefit. The
  1767.         user  will benefit by receiving quality  products  at  low  cost,
  1768.         and  by being able to "test drive"  software   thoroughly  before
  1769.         purchasing it.  The author benefits by  being able  to enter  the
  1770.         commercial software  arena  without  first  needing large sources
  1771.         of venture capital.
  1772.  
  1773.         But  it can only work  with  your  support. If you find that  you
  1774.         are   still  using  Q&A Study Aid after a couple of  weeks,  then
  1775.         obviously   it   is   worth  something to  you,  and  you  should
  1776.         register.
  1777.  
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795.  
  1796.  
  1797.  
  1798.  
  1799.  
  1800.  
  1801.  
  1802.  
  1803.  
  1804.  
  1805.  
  1806.  
  1807.  
  1808.  
  1809.         Copyright (C) 1987, 1988 Quid Pro Quo Software     Page 29
  1810.  
  1811.