Annotation of capa/capa51/pProj/capa.config.structure, revision 1.1.1.1

1.1       albertel    1: Part 1. General description
                      2: 
                      3: Generally comments begin with a hash mark (#) in the first column.
                      4: 
                      5: When specifying the value of a variable there must be a space before
                      6: the := or = . In all parts except for the capatools configuration use
                      7: an = to set a value. In the capatools section depending on the action
                      8: either a := or an = is required.
                      9: 
                     10: When specifying a value that has spaces in it surround it with double
                     11: quotes.
                     12: 
                     13: Example:
                     14: 
                     15: some_variable = "some value with spaces"
                     16: 
                     17: 
                     18: ---
                     19: Part 2. class structure
                     20: 
                     21: The first two keywords are used by capalogin, capasbin/capahtml (WWW
                     22: programs) and capatools, the last two keywords are used only by
                     23: capatools.
                     24: 
                     25: exam_path = /usr/users/teacher/CAPA45/xns111f8
                     26: 
                     27: exam_path specifies the directory that the exams are in for this class.
                     28: 
                     29: quiz_path = /usr/users/teacher/CAPA45/qns111f8
                     30: 
                     31: quiz_path specifies the directory that the quizzes are in for this
                     32: class. 
                     33: 
                     34: supp_path   = /usr/users/teacher/CAPA45/sns111f8
                     35: others_path = /usr/users/teacher/CAPA45/fci111f8
                     36: 
                     37: 
                     38: ---
                     39: Part 3. Command specifications
                     40: 
                     41: These 5 values specify where programs can be found, the settings are
                     42: used by Quizzer and capatools.
                     43: 
                     44: latex_command = latex
                     45: 
                     46: Specify how to run latex on your machine.
                     47: 
                     48: dvips_command = dvips
                     49: 
                     50: Specify how to run dvips on your machine.
                     51: 
                     52: mail_command = /usr/bin/mailx
                     53: 
                     54: Specify what mail program to use on your machine.
                     55: 
                     56: allcapaid_command = /usr/users/teacher/CAPA45/allcapaid
                     57: 
                     58: Specify where the allcapaid program has been installed
                     59: 
                     60: qzparse_command = /usr/users/teacher/CAPA45/qzparse
                     61: 
                     62: Specify where the qzparse program has been installed.
                     63: 
                     64: 
                     65: ---
                     66: Part 4. Printing configuration
                     67: 
                     68: There are three keywords here which are used by capatools, Quizzer and
                     69: Grader to control how printing happens.
                     70: 
                     71: printer_option = postscript1
                     72: printer_option = postscript2
                     73: 
                     74: the first keyword may appear multiple times. It specifies all of the
                     75: printing queues you may select. When printing the list of thes queues
                     76: will be presented from which you can select the print queue you wish
                     77: to use.
                     78: 
                     79: lprOneSided_command = "/usr/bin/lpr -P$Printer_selected"
                     80: lprTwoSided_command = "/usr/bin/lpspr -K2 $PS_file | /usr/bin/lpr -P$Printer_selected"
                     81: 
                     82: The next two keywords lprOneSided_command and lprTwoSided_command
                     83: specify how to print one sided pieces of paper and two-sided sheets
                     84: respectively. As can seen by the above examples the needn't be a
                     85: single command, and can be a series of commands piped together. The
                     86: special variable $PS_file will be replaced with the name of the file
                     87: when this command is used, ad the special variable $Printer_selected
                     88: will be replaced with the name of the printer queue that is going to
                     89: be used.
                     90: 
                     91: 
                     92: ---
                     93: Part 5. capalogin settings (telnet connection)
                     94: 
                     95: There are three values to be defined for capalogin. All have default
                     96: values if they are unspecified.
                     97: 
                     98: capalogin_goodby_delay = 10
                     99: 
                    100: The delay time in seconds that CAPA waits at goodbye screen before
                    101: closing the connection. The default time is 5 seconds.
                    102: 
                    103: capalogin_inactivity_delay = 35
                    104: 
                    105: The delay time in minutes before CAPA closes a connection that has
                    106: been inactive. If the student fails to press any key in 35 minutes the
                    107: connection will be automatically closed. The default value is 60
                    108: minutes. To disable this feature set the delay to be zero and the
                    109: student will never be timed out
                    110: 
                    111: capalogin_show_summary_score = none
                    112: 
                    113: This value will inhibit the show of the summary line in view previous
                    114: sets. If it is set to any value other than none it will show the total
                    115: score. By default this option is set such that the summary line will
                    116: be shown.
                    117: 
                    118: 
                    119: ---
                    120: Part 6. Quizzer settings
                    121: 
                    122: There is on quizzer setting right now. It is what is outputed by
                    123: pressing the "Std. Header" button.
                    124: 
                    125: Everything taht appears between the keywords
                    126: BeginStandardQuizzerHeader
                    127: EnStandardQuizzerHeader
                    128: is entered into the current .qz file when this button is pressed.
                    129: 
                    130: 
                    131: ---
                    132: Part 7. Units section
                    133: 
                    134: Three subsections seperated by special idetifiers.
                    135: 
                    136: --
                    137: Subsection 7.1 Base Units
                    138: 
                    139: Base Units are the units which are the basis of all of the other units
                    140: derived.
                    141: 
                    142: Special identifier:
                    143: << Base Unit >>
                    144: 
                    145: 3 columns, all are required
                    146: 
                    147: name  symbol comment
                    148: 
                    149: The name must be oneword. No spaces are allowed. 
                    150: 
                    151: The next column, symbol also cannot contain spaces. This is the name
                    152: that used in derived units to refer to this base unit.
                    153: 
                    154: The third column is a comment it begins with a hash mark (#) and ends
                    155: when a return is seen. It is required.
                    156: 
                    157: 
                    158: --
                    159: Subsection 7.2 Prefixes
                    160: 
                    161: Prefixes allow one to affix a single letter onto a base or Derived
                    162: unit to change it by a multiplicative offset. 
                    163: I.e mm is milli meters = 10^-3 * m
                    164: 
                    165: Special identifier:
                    166: << Prefix >>
                    167: 
                    168: 3 columns, all required
                    169: 
                    170: name  symbol  factor
                    171: 
                    172: The name must be one word. No spaces are allowed.
                    173: 
                    174: The symbol must be a single character.
                    175: 
                    176: The factor is the multiplicative shift this prefix is.  
                    177: 
                    178: 
                    179: --
                    180: Subsection 7.3 Derived Units
                    181: 
                    182: Units that are combinations of the base units, each base unit can
                    183: occur no more than once in the definition of a derived unit. This
                    184: restriction is not true when attempting to answer a question using
                    185: units, it only holds in defining new derived units.
                    186: 
                    187: Derived units can be specified in terms of other previously defined
                    188: derived units.
                    189: 
                    190: Special identifier:
                    191: <<Derived Unit>>
                    192: 
                    193: 4 columns all required
                    194: 
                    195: first column is a name, it must not contain any spaces.
                    196: 
                    197: The next column is the symbol, it can be multiple characters but
                    198: cannot contain spaces.
                    199: 
                    200: The third column is the derivation of the unit, it contains an
                    201: optional multiplicative offset and then a specification in terms of
                    202: other base units and other previously defined derived units. 
                    203: 
                    204: The fourth column is a comment. It begins with a hash mark (#) and
                    205: ends with a return. It is required.
                    206: 
                    207: 
                    208: --
                    209: Subsection 8.4 Example
                    210: 
                    211: << Base Unit >>
                    212: 
                    213: meter           m      # length
                    214: kilogram        kg     # mass
                    215: second          s      # time
                    216: 
                    217: << Prefix >>
                    218: 
                    219: exa              E         10^{18}
                    220: hecto            h         10^2
                    221: 
                    222: deci             d         10^-1
                    223: centi            c         10^-2
                    224: pico             p         10^{-12}
                    225: 
                    226: <<Derived Unit>>
                    227: gram            g      0.001 kg      # mass
                    228: pound           lb     0.45359237 kg # mass
                    229: inch            in     2.54 cm       # length
                    230: foot            ft     12 in         # length
                    231: litre           L      10^3/cm^3     # volume
                    232: radian          rad    m /m            # plane angle
                    233: astroUnit       AU     1.49598E11 m  # mean distance earth to sun
                    234: newton          N      m*kg/s^2      # force
                    235: pascal          Pa     N/m^2           # pressure, stress
                    236: bar             bar    1E5 Pa          # pressure
                    237: 
                    238: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>