doc/gutshtml/SessionOn2.html - view

File: [LON-CAPA] / doc / gutshtml / SessionOn2.html
Revision 1.1: download - view: text, annotated - select for diffs
Fri Jun 28 20:30:29 2002 UTC (22 years ago) by www
Branches: MAIN
CVS tags: version_0_99_3, version_0_99_2, version_0_99_1, version_0_99_0, version_0_6_2, version_0_6, version_0_5_1, version_0_5, version_0_4, stable_2002_july, conference_2003, STABLE, HEAD

HTML version of GUTS manual. Individual files will still need cleanup.

1: <html> 2: <head> 3: <meta name=Title 4: content="Session One: Problem Engine/Special Targets (grade, edit, print) (Guy)"> 5: <meta http-equiv=Content-Type content="text/html; charset=macintosh"> 6: <link rel=Edit-Time-Data href="Session%20On2_files/editdata.mso"> 7: <title>Session One: Problem Engine/Special Targets (grade, edit, print) (Guy)</title> 8: <style> 23: </style> 24: </head> 25: <body bgcolor=#FFFFFF link=blue vlink=purple class="Normal" lang=EN-US> 26: <div class=Section1> 27: <h2>Session One: Problem Engine/Special Targets (grade, edit, print) (Guy)</h2> 28: <h3><a name="_Toc421867127">Tags</a></h3> 29: <ul type=disc> 30: <li>Response tags </li> 31: </ul> 32: Arguments for all response tags 33: <ul type=disc> 34: <ul type=circle> 35: <li>ID, if this isn't set it will be set during the publication step. 37: It is used to assign parameters names in a way that can be tracked if 38: an instructor modifies things by hand. </li> 39: <li>name optional, if set, it will be used by the resource 41: assembly tool when one is modifying parameters. </li> 42: </ul> 43: </ul> 44: Implemented response tags 45: <ul type=disc> 46: <ul type=circle> 47: <li><responseparam> if it appears it should be inside of a <*response> 49: tag, defines an externally adjustable parameter for this question. Arguments: 50: </li> 51: <ul type=square> 52: <li>default required, specifies a default value for the 54: parameter </li> 55: <li>name required, specifies an internal name for the 57: parameter </li> 58: <li>type required specifies the type of parameter, one 60: of "tolerance", "int", "float", "string", 61: "date" (configuration of paramters is handled by lonparmset.pm 62: and parameter.html) </li> 63: <li>description a string describing the parameter, this is what 65: is used to talk about a parameter outside of a problem </li> 66: </ul> 67: <li><parameter> exactly the same as <responseparam> currently, 69: but should not appear inside of a <*response> </li> 70: <li><numericalresponse> implements a numerical answer, it needs an internal 72: <textline> for the 73: response to go in. It checks all styles of numerical supported in CAPA. 74: Possible args are: </li> 75: <ul type=square> 76: <li>answer required, specifies the correct answer, may 78: be either a perl list or scalar</li> 79: <li>units optional, specifies unit of correct answer, 81: CAPA style</li> 82: </ul> 83: <li><stringresponse> implements a string answer, it needs an internal 85: <textline> for the 86: response to go in. It can check the string for either case or order. </li> 87: <ul type=square> 88: <li>answer required, specifies the correct answer, may 90: be either a perl list or scalar</li> 91: <li>type optional, CAPA style str args, cs/ci/mc </li> 93: <ul type=square> 94: <li>cs - case senesitive, order important</li> 95: <li>ci - case insenesitive, order important</li> 96: <li>mc - case insenesitive, order unimportant</li> 97: </ul> 98: </ul> 99: <li><essayresponse> implements a ungraded large text response, it 101: need an internal <textarea> for the response to go in. </li> 103: <li><imageresponse> implements a image click style image submission, 105: uses the foil structure tags <a href="#foil">below</a>. Additional tags 106: that should appear in a <foil> are: </li> 107: <ul type=square> 108: <li><image> required, the contained text specifies a published 110: graphical resource that is the image used, should only appear once per 111: foil</li> 112: <li><rectangle> required, the contained text specifies a rectangular 114: area that is correct, should look like (1,2)-(3,4), at least 1 required</li> 115: <li><text> required, the contained text is printed on 117: top of the image.</li> 118: </ul> 119: <li><optionresponse> implements a "select from these choices" 121: style question, the choices are specified by the instructor, it uses the 122: foil structure tags <a href="#foil">below</a> with this additional args: 123: </li> 124: <ul type=square> 125: <li><foilgroup> is required to have options which 127: should be a perl list of possible options for the student. </li> 128: </ul> 129: <li><radiobuttonresponse> implements a true / false style question with 131: 1 correct answer.it uses the foil structure tags <a href="#foil">below</a> 132: but the value of a <foil>can only be "true" 133: or "false" or "unused" </li> 134: <li><dataresponse> implements a straight data storage entry idea, 136: needs and interveing input tag like <textline> to work correctly. 137: Arguments: </li> 138: <ul type=square> 139: <li>name internal name for the value, it will have the 141: part id and respose id added on to it </li> 142: <li>type type of data stored in this response field, 144: should be one of the types supported by parameter.html </li> 145: <li>display a string that will be used to describe the field 147: when interfacing with humans </li> 148: </ul> 149: </ul> 150: </ul> 151: o      153: <externalresponse> implements the ability to have an external program grade a response, 155: expects either a <textline> or <textfield> inside the tag. 156: Arguments: 157: <ul type=disc> 158: <ul type=circle> 159: <ul type=square> 160: <li>url the url to submit the answer and form to, does 162: not need to be a LON-CAPA machine. </li> 163: <li>answer a string or scalar variable that can encode 165: something that should encode the correct answer, in some cases this 166: may be nothing. </li> 167: <li>form a hash variable name that will be submitted 169: to the remote site as a HTTP form. </li> 170: </ul> 171: </ul> 172: </ul> 173: The response of the remote server needs to be in XML as follows. 174: <pre> <loncapagrade>     <awardetail> CORRECT     </awardetail>     <message> A message to be shown to the students     </message> </loncapagrade>            </pre> 175: <ul type=disc> 176: <ul type=circle> 177: <ul type=square> 178: <li><loncapagrade> no arguments but must surround the response. 180: </li> 181: <li><awardetail> required inner tag, the response inside must 183: be one of the detailed responses that appears in the data storage documentation 184: (CVS:loncapa/doce/homework/datastorage) </li> 185: <li><message> optional message to have shown to the student 187: </li> 188: </ul> 189: </ul> 190: </ul> 191: <ul type=disc> 192: <li><a name=foil>Foil Structure Tags</a> </li> 193: </ul> 194: All tags that implement a foil structure have an optional arg of max 195: that controls the maximum number of total foils to show. 196: <ul type=disc> 197: <ul type=circle> 198: <li><foilgroup> required, must be the tag that surrounds all 200: foil definitions </li> 201: <li><foil> required, all data inside is a possible foil 203: </li> 204: <li><conceptgroup> optional, surrounds a collection of <foil>, 206: when a problem is displayed only one of the contained <foil>is selected 207: for display. It receives one required argument concept. 208: </li> 209: </ul> 210: <li>Hint structure </li> 211: </ul> 212: All of these tags must appear inside a <*response> tag. 214: <ul type=disc> 215: <ul type=circle> 216: <li><hintgroup> Tag that surrounds all of a hint. </li> 218: <li><hintpart> required, Tag to implement conditional hints. 220: It has a required argument on. When a <*hint> tag 221: named the same as the value the on attribute evaluates to be correct the 222: <hintpart> will show. If no other <hintpart> are to show then 223: all hintparts with a on of "default" 224: will show </li> 225: <li><numericalhint> has all the arguments that <numericalresponse>, 227: does and the required attribute name which should be set 228: to the value of which <hintpart> will be shown. </li> 229: </ul> 230: <li>Input Tags </li> 231: </ul> 232: This group of tags implement a mechanism for getting data for students, they 233: will usually be used by a <*response>. 234: <ul type=disc> 235: <ul type=circle> 236: <li><textarea> creates a Large text input box, If data appears 238: between the start and end tags, the data will appear i the textarea if 239: the student has not yet made a submission. Additionally it takes two arguments 240: rows and cols which control the height and width of the area 242: respectively. It defaults to 10 and 80. </li> 243: <li><textline> creates a single line of input element, it accepts 245: 1 argument size which controls the width on the textline, 246: it defaults to 20. </li> 247: </ul> 248: <li>Output Tags </li> 249: </ul> 250: This group of tags generate useful pieces of output. 251: <ul type=disc> 252: <ul type=circle> 253: <li><standalone> everything in between the start and end tag 255: is shown only on the web, and only if the resource is not part of a course. 256: </li> 257: <li><displayduedate> this will insert the current duedate if one 259: is set into the document. It is generated to be inside a table of 1x1 260: elements </li> 261: <li><displaytitle> this will insert the title of the problem from 263: the metadata of the problem </li> 264: <li><window> the text in between is put in a popup javascript 266: window </li> 267: <li><m> the inside text is LaTeX, and is converted to 269: HTML (or MathML) on the fly, if the argument eval is set 270: to "on" the intervening text will have a perl var expansion 271: done to it before being converted. </li> 272: <li><randomlabel> shows a specified image with images or text 274: labels randomly assigned to a set of specific locations, those locations 275: may also have values assigned to them. There is a hash generated conating 276: the mapping of labels to locations, labels to values, and locations to 277: values. Example: </li> 278: </ul> 279: </ul> 280: <pre>  <randomlabel bgimg="URL" width="12" height="45" texwidth="50">     <labelgroup name="GroupOne" type="image">       <location x="123" y="456" value="10" />       <location x="321" y="654" value="20" />       <location x="213" y="546" value="13" />       <label description="TEXT-1">IMG-URL</label>       <label description="TEXT-2">IMG-URL</label>       <label description="TEXT-3">IMG-URL</label>     </labelgroup>     <labelgroup name="GroupTwo" type="text">       <location x="12" y="45" />       <location x="32" y="65" />       <location x="21" y="54" />       <label>TEXT-1</label>       <label>TEXT-2</label>       <label>TEXT-3</label>     </labelgroup>    </randomlabel>         </pre> 281: Arguments: 282: <ul type=disc> 283: <ul type=circle> 284: <ul type=square> 285: <li>bgimg either a fully qualified URL for an external 287: image, or a loncapa resource, it supports relative references (../images/apicture.gif), 288: the image must either be a GIF or JPEG </li> 289: <li>width the width of the image in pixels </li> 291: <li>height the height of the image in pixels </li> 293: <li>texwidth the width of the image in millimeters </li> 295: </ul> 296: </ul> 297: </ul> 298: Internal tags: 299: <ul type=disc> 300: <ul type=circle> 301: <ul type=square> 302: <li><labelgroup> 1 required, multiple allowed. Declares a group 304: of locations and labels associated with them. 305: Arguments: </li> 306: <ul type=square> 307: <li>name this is the name of the group, a hash with 309: this name will be generated holding the mappings for later use in 310: the problem. For each location a value will be set for which label 311: is there, (EX. $hash{'1'}="TEXT-2"). For locations with 312: values the hash will contain 2 items, a location to value mapping 313: ($hash{'value_1'}=10), and a label to value mapping ($hash{'labelvalue_2'}=10). 314: For all image style of labels there will also be a label description 315: to label URL mapping ($hash{'image_2'}=IMG-URL). Also the entry 'numlocations 316: will be set to the total number of locations that exist. (Note that 317: locations and labels start counting from 1.) </li> 318: <li>type the type of labels in this group, either 'image' 320: or 'text' </li> 321: </ul> 322: <li><location> declares a location on the image that a label 324: should appear at 325: Arguments: </li> 326: <ul type=square> 327: <li>x the x value of the location in pixels </li> 329: <li>y the y value of the location in pixels </li> 331: <li>value a scalar value to associate at this location 333: (optional) </li> 334: </ul> 335: <li><label> declaration of a label, if this is a text type 337: labelgroup the internal text should be the text of the label (HTML is 338: not currently supported), if this is an image type of label the internal 339: text must be a LON-CAPA resource specification, and the description 340: filed must be set. 341: Arguments: </li> 342: <ul type=square> 343: <li>description a required field for image labels, it will 345: be used when setting values in the hash. </li> 346: </ul> 347: </ul> 348: </ul> 349: <li>Scripting </li> 350: </ul> 351: These tags allow the document to behave programatically 352: <ul type=disc> 353: <ul type=circle> 354: <li><display> the intervening perl script is evaluated in 356: the safe space and the return value of the script replaces the entire 357: tag </li> 358: <li><import> causes the parse to read in the file named in 360: the body of the tag and parse it as if the entire text of the file had 361: existed at location of the tag </li> 362: <li><parserlib> the enclosed filename contains definitions for 364: new tags </li> 365: <li><script> if the argument type is set to 367: "loncapa/perl" the enclosed data is a perl script which is evaluated 368: inside the perl Safe space. The return value of the script is ignored. 369: </li> 370: <li><scriptlib> the enclosed filename contains perl code to 372: run in the safe space </li> 373: <li><block> has a required argument condition 375: that is evaluated, it the condition is true everything inside the tag 376: is evaluated, if it is false everything inside the block tag is skipped 377: </li> 378: <li><notsolved> everything inside the tag is skipped if the 380: problem is "solved" </li> 381: <li><postanswerdate> everything inside the tag is skipped if the 383: problem is before the answer date </li> 384: <li><preduedate> everything inside the tag is skipped if the 386: problem is after the due date </li> 387: <li><randomlist> the enclosed tags are parsed in a stable random 389: order, optional argument show restricts the number of tags 390: indie that are actually parsed the no more than show. </li> 392: <li><solved> everything inside the tag is skipped if the 394: problem is "not solved" </li> 395: <li><while> implements a while loop, required argument condition 397: is a perl scriptlet that when evaluated results in a true or false value, 398: on true the entirety of the text between the whiles is parsed. The condition 399: is tested again, etc. If false it goes to the next node in the parse. 400: </li> 401: </ul> 402: <li>Structure Tags </li> 403: </ul> 404: These tags give the problem a structure and take care of the recording of 405: data and giving the student messages. 406: <ul type=disc> 407: <ul type=circle> 408: <li><problem> must be the first tag in the file, this tag 410: sets up the header of the webpage and generates the submit buttons, it 411: also handles due dates properly </li> 412: <li><part> must be below <problem> if it is going 414: to be used. It does many of the same tasks as <problem> but allows 415: multiple separate problems to exist in a single file. </li> 416: <li><startouttext><endouttext> these tags are somewhat special, they must have 418: no internal text and occur in pairs. Their use is to mark up the problem 419: so the web editor knows what sections should be edited in a plain text 420: block on the web. </li> 421: </ul> 422: </ul> 423: <h3><a name="_Toc421867128"><script> Functions</a></h3> 424: A list of functions that have been written that are available in the Safe 425: space scripting environment inside a problem. 426: <ul type=disc> 427: <li>sin(x), cos(x), tan(x)</li> 428: <li>asin(x), acos(x), atan(x), atan2(y,x)</li> 429: <li>log(x), log10(x)</li> 430: <li>exp(), pow(x,y), sqrt(x)</li> 431: <li>abs(x), sgn(x)</li> 432: <li>erf(x), erfc(x)</li> 433: <li>ceil(x), floor(x)</li> 434: <li>min(...), max(...)</li> 435: <li>factorial(n)</li> 436: <li>N%M</li> 437: <li>sinh(x), cosh(x), tanh(x)</li> 438: <li>asinh(x), acosh(x), atanh(x)</li> 439: <li>roundto(x,n)</li> 440: <li>web("a","b","c") or web(a,b,c)</li> 441: <li>html("a") or html(a)</li> 442: <li>j0(x), j1(x), jn(n,x), jv(y,x)</li> 443: <li>y0(x), y1(x), yn(n,x), yv(y,x)</li> 444: <li>random</li> 445: <li>choose</li> 446: <li>tex("a","b") or tex(a,b)</li> 447: <li>var_in_tex(a)</li> 448: <li>to_string(x), to_string(x,y)</li> 449: <li>class(), section()</li> 450: <li>name(), student_number()</li> 451: <li>open_date(), due_date(), answer_date()</li> 452: <li>sub_string()</li> 453: <li>array_moments(array)</li> 454: <li>format(x,y),prettyprint(x,y)</li> 455: <li>map(...)</li> 456: <li>caparesponse_check</li> 457: <li>caparesponse_check_list</li> 458: </ul> 459: <h3><a name="_Toc421867129">Detailed descriptions of each function and comparison 460: with CAPA</a></h3> 461: <table border=1 cellpadding=0> 462: <tr> 463: <td width=131 valign=top class="Normal"> CAPA Functions</td> 464: <td width=134 valign=top class="Normal"> LON-CAPA</td> 465: <td width=147 valign=top class="Normal"> Descriptions</td> 466: <td width=101 valign=top class="Normal"> Differences (if any)</td> 467: </tr> 468: <tr> 469: <td width=131 valign=top class="Normal"> sin(x), cos(x), tan(x)</td> 470: <td width=134 valign=top class="Normal"> &sin($x), &cos($x), 471: &tan($x)</td> 472: <td width=147 valign=top class="Normal"> Trigonometric functions where 473: x is in radians. $x can be a pure number, i.e., you can call &sin(3.1415)</td> 474: <td width=101 valign=top class="Normal">  </td> 475: </tr> 476: <tr> 477: <td width=131 valign=top class="Normal"> asin(x), acos(x), atan(x), atan2(y,x)</td> 478: <td width=134 valign=top class="Normal"> &asin($x), &acos($x), 479: &atan($x), &atan2($y,$x)</td> 480: <td width=147 valign=top class="Normal"> Inverse trigonometric functions. 481: Return value is in radians. For asin and acos the value of x must be 482: between -1 and 1. The atan2 returns a value between -pi and pi the sign 483: of which is determined by y. $x and $y can be pure numbers</td> 484: <td width=101 valign=top class="Normal">  </td> 485: </tr> 486: <tr> 487: <td width=131 valign=top class="Normal"> log(x), log10(x)</td> 488: <td width=134 valign=top class="Normal"> &log($x), &log10($x)</td> 489: <td width=147 valign=top class="Normal"> Natural and base-10 logarithm. 490: $x can be a pure number</td> 491: <td width=101 valign=top class="Normal">  </td> 492: </tr> 493: <tr> 494: <td width=131 valign=top class="Normal"> exp(x), pow(x,y), sqrt(x)</td> 495: <td width=134 valign=top class="Normal"> &exp($x), &pow($x,$y), 496: &sqrt($x)</td> 497: <td width=147 valign=top class="Normal"> Exponential, power and square 498: root, i.e.,ex, xy and /x. $x and $y can be pure 499: numbers</td> 500: <td width=101 valign=top class="Normal">  </td> 501: </tr> 502: <tr> 503: <td width=131 valign=top class="Normal"> abs(x), sgn(x)</td> 504: <td width=134 valign=top class="Normal"> &abs($x), &sgn($x)</td> 505: <td width=147 valign=top class="Normal"> Abs takes the absolute value 506: of x while sgn(x) returns 1, 0 or -1 depending on the value of x. For 507: x>0, sgn(x) = 1, for x=0, sgn(x) = 0 and for x<0, sgn(x) = -1. 508: $x can be a pure number</td> 509: <td width=101 valign=top class="Normal">  </td> 510: </tr> 511: <tr> 512: <td width=131 valign=top class="Normal"> erf(x), erfc(x)</td> 513: <td width=134 valign=top class="Normal"> &erf($x), &erfc($x)</td> 514: <td width=147 valign=top class="Normal"> Error function.  erf = 515: 2/sqrt(pi) integral (0,x) et-sq and erfx(x) 516: = 1.0 - erf(x).  $x can be a pure number</td> 518: <td width=101 valign=top class="Normal">  </td> 519: </tr> 520: <tr> 521: <td width=131 valign=top class="Normal"> ceil(x), floor(x)</td> 522: <td width=134 valign=top class="Normal"> &ceil($x), &floor($x)</td> 523: <td width=147 valign=top class="Normal"> Ceil function returns an integer 524: rounded up whereas floor function returns and integer rounded down. 525: If x is an integer than it returns the value of the integer. $x can 526: be a pure number</td> 527: <td width=101 valign=top class="Normal">  </td> 528: </tr> 529: <tr> 530: <td width=131 valign=top class="Normal"> min(...), max(...)</td> 531: <td width=134 valign=top class="Normal"> &min(...), &max(...)</td> 532: <td width=147 valign=top class="Normal"> Returns the minimum/ maximum 533: value of a list of arguments if the arguments are numbers. If the arguments 534: are strings then it returns a string sorted according to the ASCII codes</td> 535: <td width=101 valign=top class="Normal">  </td> 536: </tr> 537: <tr> 538: <td width=131 valign=top class="Normal"> factorial(n)</td> 539: <td width=134 valign=top class="Normal"> &factorial($n)</td> 540: <td width=147 valign=top class="Normal"> Argument (n) must be an integer 541: else it will round down. The largest value for n is 170. $n can be a 542: pure number</td> 543: <td width=101 valign=top class="Normal">  </td> 544: </tr> 545: <tr> 546: <td width=131 valign=top class="Normal"> N%M</td> 547: <td width=134 valign=top class="Normal"> $N%$M</td> 548: <td width=147 valign=top class="Normal"> N and M are integers and returns 549: the remainder (in integer) of N/M. $N and $M can be pure numbers</td> 550: <td width=101 valign=top class="Normal">  </td> 551: </tr> 552: <tr> 553: <td width=131 valign=top class="Normal"> sinh(x), cosh(x), tanh(x)</td> 554: <td width=134 valign=top class="Normal"> &sinh($x), &cosh($x), 555: &tanh($x)</td> 556: <td width=147 valign=top class="Normal"> Hyperbolic functions. $x can 557: be a pure number</td> 558: <td width=101 valign=top class="Normal">  </td> 559: </tr> 560: <tr> 561: <td width=131 valign=top class="Normal"> asinh(x), acosh(x), atanh(x)</td> 562: <td width=134 valign=top class="Normal"> &asinh($x), &acosh($x), 563: &atanh($x)</td> 564: <td width=147 valign=top class="Normal"> Inverse hyperbolic functions. 565: $x can be a pure number</td> 566: <td width=101 valign=top class="Normal">  </td> 567: </tr> 568: <tr> 569: <td width=131 valign=top class="Normal"> /DIS($x,"nn")</td> 570: <td width=134 valign=top class="Normal"> &format($x,"nn")</td> 571: <td width=147 valign=top class="Normal"> Display or format $x as nn where 572: nn is nF or nE and n is an integer.</td> 573: <td width=101 valign=top class="Normal">  The difference is obvious.</td> 574: </tr> 575: <tr> 576: <td width=131 valign=top class="Normal"> Not in CAPA</td> 577: <td width=134 valign=top class="Normal"> &prettyprint($x,"nn")</td> 578: <td width=147 valign=top class="Normal"> Display or format $x as nn where 579: nn is nF or nE and n is an integer. In E mode it will attempt to generate 580: a pretty x10^3 rather than a E3 following the number</td> 581: <td width=101 valign=top class="Normal">  </td> 582: </tr> 583: <tr> 584: <td width=131 valign=top class="Normal"> roundto(x,n)</td> 585: <td width=134 valign=top class="Normal"> &roundto($x,$n)</td> 586: <td width=147 valign=top class="Normal"> Rounds a real number to n decimal 587: points. $x and $n can be pure numbers</td> 588: <td width=101 valign=top class="Normal">  </td> 589: </tr> 590: <tr> 591: <td width=131 valign=top class="Normal"> web("a","b","c") 592: or web(a,b,c)</td> 593: <td width=134 valign=top class="Normal"> &web("a","b","c") 594: or &web($a,$b,$c)</td> 595: <td width=147 valign=top class="Normal"> Returns either a, b or c depending 596: on the output medium. a is for plain ASCII, b for tex output and c for 597: html output</td> 598: <td width=101 valign=top class="Normal">  </td> 599: </tr> 600: <tr> 601: <td width=131 valign=top class="Normal"> html("a") or html(a)</td> 602: <td width=134 valign=top class="Normal"> &html("a") or 603: &html($a)</td> 604: <td width=147 valign=top class="Normal"> Output only if the output mode 605: chosen is in html format</td> 606: <td width=101 valign=top class="Normal">  </td> 607: </tr> 608: <tr> 609: <td width=131 valign=top class="Normal"> jn(m,x)</td> 610: <td width=134 valign=top class="Normal"> &j0($x), &j1($x), &jn($m,$x), 611: &jv($y,$x)</td> 612: <td width=147 valign=top class="Normal"> Bessel functions of the first 613: kind with orders 0, 1 and m respectively. For jn(m,x), m must be an 614: integer whereas for jv(y,x), y is real. $x can be a pure number. $m 615: must be an integer and can be a pure integer number. $y can be a pure 616: real number</td> 617: <td width=101 valign=top class="Normal"> In CAPA, j0, j1 and jn are contained 618: in one function, jn(m,x) where m takes the value of 0, 1 or 2. jv(y,x) 619: is new to LON-CAPA.</td> 620: </tr> 621: <tr> 622: <td width=131 valign=top class="Normal"> yn(m,x)</td> 623: <td width=134 valign=top class="Normal"> &y0($x), &y1($x), &yn($m,$x), 624: &yv($y,$x)</td> 625: <td width=147 valign=top class="Normal"> Bessel functions of the second 626: kind with orders 0, 1 and m respectively. For yn(m,x), m must be an 627: integer whereas for yv(y,x), y is real. $x can be a pure number. $m 628: must be an integer and can be a pure integer number. $y can be a pure 629: real number</td> 630: <td width=101 valign=top class="Normal"> In CAPA, y0, y1 and yn are contained 631: in one function, yn(m,x) where m takes the value of 0, 1 or 2. yv(y,x) 632: is new to LON-CAPA.</td> 633: </tr> 634: <tr> 635: <td width=131 valign=top class="Normal"> random(l,u,d)</td> 636: <td width=134 valign=top class="Normal"> &random($l,$u,$d)</td> 637: <td width=147 valign=top class="Normal"> Returns a uniformly distributed 638: random number between the lower bound, l and upper bound, u in steps 639: of d. $l, $u and $d can be pure numbers</td> 640: <td width=101 valign=top class="Normal"> In CAPA, all the 3 arguments 641: must be of the same type. However, now you can mix the type</td> 642: </tr> 643: <tr> 644: <td width=131 valign=top class="Normal"> choose(i,...)</td> 645: <td width=134 valign=top class="Normal"> &choose($i,...)</td> 646: <td width=147 valign=top class="Normal"> Choose the ith item from the 647: argument list. i must be an integer greater than 0 and the value of 648: i should not exceed the number of items. $i can be a pure integer</td> 649: <td width=101 valign=top class="Normal">  </td> 650: </tr> 651: <tr> 652: <td width=131 valign=top class="Normal"> /MAP(seed;w,x,y,z;a,b,c,d)</td> 653: <td width=134 valign=top class="Normal"> Option 1 - &map($seed,[\$w,\$x,\$y,\$z],[$a,$b,$c,$d]) 654: or 655: Option 2 - &map($seed,\@mappedArray,[$a,$b,$c,$d]) 656: Option 3 - @mappedArray = &map($seed,[$a,$b,$c,$d]) 657: Option 4 - ($w,$x,$y,$z) = &map($seed,\@a) 658: where $a='A' 659: $b='B' 660: $c='B' 661: $d='B' 662: $w, $x, $y, and $z are variables</td> 663: <td width=147 valign=top class="Normal"> Assigns to the variables $w, 664: $x, $y and $z the values of the $a, $b, $c and $c (A, B, C and D). The 665: precise value for $w .. depends on the seed. (Option 1 of calling map). 666: In option 2, the values of $a, $b .. are mapped into the array, @mappedArray. 667: The two options illustrate the different grouping. Options 3 and 4 give 668: a consistent way (with other functions) of mapping the items. For each 669: option, the group can be passed as an array, for example, [$a,$b,$c,$d] 670: => \@a.</td> 671: <td width=101 valign=top class="Normal"> In CAPA, the arguments are divided 672: into three groups separated by a semicolon ;. In LON-CAPA, the separation 673: is done by using [] brackets or using an array @a. Note the backslash 674: (\) before the arguments in the second and third groups.</td> 675: </tr> 676: <tr> 677: <td width=131 valign=top class="Normal"> rmap(seed;a,b,c,d;w,x,y,z)</td> 678: <td width=134 valign=top class="Normal"> Option 1 - &rmap($seed,[\$w,\$x,\$y,\$z],[$a,$b,$c,$d]) 679: or 680: Option 2 - &rmap($seed,\@rmappedArray,[$a,$b,$c,$d]) 681: Option 3 - @rmapped_array = &rmap($seed,[$a,$b,$c,$d]) 682: Option 4 - ($w,$x,$y,$z) = &rmap($seed,\@a) 683: where $a='A' 684: $b='B' 685: $c='B' 686: $d='B' 687: $w, $x, $y, and $z are variables</td> 688: <td width=147 valign=top class="Normal"> The rmap functions does the 689: reverse action of map if the same seed is used in calling map and rmap. 690: </td> 691: <td width=101 valign=top class="Normal"> In CAPA, the arguments are divided 692: into three groups separated by a semicolon ;. In LON-CAPA, the separation 693: is done by using [] brackets (with create an unamed vector reference) 694: or using an array @a. Note the backslash (\) before the arguments in 695: the second and third groups (Which cause Perl to send to variable locations 696: rather than the variable values, similar to a C pointer).</td> 697: </tr> 698: <tr> 699: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 700: <td width=134 valign=top class="Normal"> $a=&xmlparse($string) </td> 701: <td width=147 valign=top class="Normal"> Runs the internal parser over 702: the argument parsing for display. Warning 703: This will result in different strings in different targets. Don't use 704: the results of this function as an answer.</td> 705: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 706: </tr> 707: <tr> 708: <td width=131 valign=top class="Normal"> tex(a,b), tex("a","b")</td> 709: <td width=134 valign=top class="Normal"> &tex($a,$b), &tex("a","b")</td> 710: <td width=147 valign=top class="Normal"> Returns a if the output mode 711: is in tex otherwise returns b</td> 712: <td width=101 valign=top class="Normal">  </td> 713: </tr> 714: <tr> 715: <td width=131 valign=top class="Normal"> var_in_tex(a)</td> 716: <td width=134 valign=top class="Normal"> &var_in_tex($a)</td> 717: <td width=147 valign=top class="Normal"> Equivalent to tex("a","")</td> 718: <td width=101 valign=top class="Normal">  </td> 719: </tr> 720: <tr> 721: <td width=131 valign=top class="Normal"> to_string(x), to_string(x,y)</td> 722: <td width=134 valign=top class="Normal"> &to_string($x), &to_string($x,$y)</td> 723: <td width=147 valign=top class="Normal"> If x is an integer, returns 724: a string. If x is real than the output is a string with format given 725: by y. For example, if x = 12.3456, &to_string(x,".3F") 726: = 12.345 and &to_string(x,".3E") = 1.234E+01.</td> 727: <td width=101 valign=top class="Normal">  </td> 728: </tr> 729: <tr> 730: <td width=131 valign=top class="Normal"> capa_id(), class(), section(), 731: set(), problem()</td> 732: <td width=134 valign=top class="Normal"> &class(), &section()</td> 733: <td width=147 valign=top class="Normal"> Returns null string, class descriptive 734: name, section number, set number and null string.</td> 735: <td width=101 valign=top class="Normal"> capa_id(), set() and problem() 736: are no longer used. Currently, they return a null value.</td> 737: </tr> 738: <tr> 739: <td width=131 valign=top class="Normal"> name(), student_number()</td> 740: <td width=134 valign=top class="Normal"> &name(), &student_number()</td> 741: <td width=147 valign=top class="Normal"> Return the full name in the 742: following format: lastname, firstname initial. Student_number returns 743: the student 9-alphanumeric string. If undefined, the functions return 744: null.</td> 745: <td width=101 valign=top class="Normal">  </td> 746: </tr> 747: <tr> 748: <td width=131 valign=top class="Normal"> open_date(), due_date(), answer_date()</td> 749: <td width=134 valign=top class="Normal"> &open_date(), &due_date(), 750: &answer_date()</td> 751: <td width=147 valign=top class="Normal"> Problem open date, due date 752: and answer date. The time is also included in 24-hr format.</td> 753: <td width=101 valign=top class="Normal"> Output format for time is changed 754: slightly. If pass noon, it displays ..pm else it displays ..am. So 23:59 755: is displayed as 11:59 pm.</td> 756: </tr> 757: <tr> 758: <td width=131 valign=top class="Normal"> get_seed(), set_seed()</td> 759: <td width=134 valign=top class="Normal"> Not implemented</td> 760: <td width=147 valign=top class="Normal"> Get and set the random seed.</td> 761: <td width=101 valign=top class="Normal">  </td> 762: </tr> 763: <tr> 764: <td width=131 valign=top class="Normal"> sub_string(a,b,c)</td> 765: <td width=134 valign=top class="Normal"> &sub_string($a,$b,$c) 766: perl  substr function. However, note the differences</td> 767: <td width=147 valign=top class="Normal"> Retrieve a portion of string 768: a starting from b and length c. For example,  $a = "Welcome 769: to LON-CAPA"; $result=&sub_string($a,4,4); then $result is 770: "come"</td> 771: <td width=101 valign=top class="Normal"> Perl intrinsic function, substr(string,b,c) 772: starts counting from 0 (as opposed to 1). In the example to the left, 773: substr($a,4,4) returns "ome ".</td> 774: </tr> 775: <tr> 776: <td width=131 valign=top class="Normal"> array[xx]</td> 777: <td width=134 valign=top class="Normal"> @arrayname 778: Array is intrinsic in perl. To access a specific element use $arrayname[$n] 779: where $n is the $n+1 element since the array count starts from 0</td> 780: <td width=147 valign=top class="Normal"> "xx" can be a variable 781: or a calculation.</td> 782: <td width=101 valign=top class="Normal"> In LON-CAPA, an array is defined 783: by @arrayname. It is not necessary to specify the dimension of the array. </td> 784: </tr> 785: <tr> 786: <td width=131 valign=top class="Normal"> array_moments(B,A)</td> 787: <td width=134 valign=top class="Normal"> @B=&array_moments(@A)</td> 788: <td width=147 valign=top class="Normal"> Evaluates the moments of an 789: array A and place the result in array B[i] where i = 0 to 4. The contents 790: of B are as follows: B[0] = number of elements, B[1] = mean, B[2] = 791: variance, B[3] = skewness and B[4] = kurtosis.</td> 792: <td width=101 valign=top class="Normal"> In CAPA, the moments are passed 793: as an array in the first argument whereas in LON-CAPA, the array containing 794: the moments are set equal to the function.</td> 795: </tr> 796: <tr> 797: <td width=131 valign=top class="Normal"> array_max(Name), array_min(Name)</td> 798: <td width=134 valign=top class="Normal"> &min(@Name), &max(@Name)</td> 799: <td width=147 valign=top class="Normal"> In LON-CAPA to find the maximum 800: value of an array, use &max(@arrayname)  and to find the minimum 801: value of an array, use &min(@arrayname)</td> 802: <td width=101 valign=top class="Normal"> Combined with the min and max 803: functions defined earlier.</td> 804: </tr> 805: <tr> 806: <td width=131 valign=top class="Normal"> init_array(Name)</td> 807: <td width=134 valign=top class="Normal"> undef @name</td> 808: <td width=147 valign=top class="Normal"> To destroy the contents of an 809: array, use</td> 810: <td width=101 valign=top class="Normal"> Use perl intrinsic undef function.</td> 811: </tr> 812: <tr> 813: <td width=131 valign=top class="Normal"> random_normal (return_array,item_cnt,seed,av,std_dev)</td> 814: <td width=134 valign=top class="Normal"> @return_array=&random_normal 815: ($item_cnt,$seed,$av,$std_dev)</td> 816: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 817: of normal distribution of average $av and standard deviation $std_dev. 818: The distribution is generated from seed $seed</td> 819: <td width=101 valign=top class="Normal"> In CAPA the results are passed 820: as the first argument whereas in LON-CAPA the results are set equal 821: to the function.</td> 822: </tr> 823: <tr> 824: <td width=131 valign=top class="Normal"> random_beta (return_array,item_cnt,seed,aa,bb)</td> 825: <td width=134 valign=top class="Normal"> @return_array=&random_beta 826: ($item_cnt,$seed,$aa,$bb) 827: NOTE: Both $aa and $bb MUST be greater than 1.0E-37.</td> 828: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 829: of beta distribution. The density of beta is: X^($aa-1) *(1-X)^($bb-1) 830: /B($aa,$bb) for 0<X<1.</td> 831: <td width=101 valign=top class="Normal"> In CAPA the results are passed 832: as the first argument whereas in LON-CAPA the results are set equal 833: to the function.</td> 834: </tr> 835: <tr> 836: <td width=131 valign=top class="Normal"> random_gamma (return_array,item_cnt,seed,a,r)</td> 837: <td width=134 valign=top class="Normal"> @return_array=&random_gamma 838: ($item_cnt,$seed,$a,$r) 839: NOTE: Both $a and $r MUST be positive.</td> 840: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 841: of gamma distribution. The density of gamma is: ($a**$r)/gamma($r) * 842: X**($r-1) * exp(-$a*X).</td> 843: <td width=101 valign=top class="Normal"> In CAPA the results are passed 844: as the first argument whereas in LON-CAPA the results are set equal 845: to the function.</td> 846: </tr> 847: <tr> 848: <td width=131 valign=top class="Normal"> random_exponential (return_array,item_cnt,seed,av)</td> 849: <td width=134 valign=top class="Normal"> @return_array=&random_exponential 850: ($item_cnt,$seed,$av) 851: NOTE: $av MUST be non-negative.</td> 852: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 853: of exponential distribution. </td> 854: <td width=101 valign=top class="Normal"> In CAPA the results are passed 855: as the first argument whereas in LON-CAPA the results are set equal 856: to the function.</td> 857: </tr> 858: <tr> 859: <td width=131 valign=top class="Normal"> random_poisson (return_array,item_cnt,seed,mu)</td> 860: <td width=134 valign=top class="Normal"> @return_array=&random_poisson 861: ($item_cnt,$seed,$mu) 862: NOTE: $mu MUST be non-negative.</td> 863: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 864: of poisson distribution. </td> 865: <td width=101 valign=top class="Normal"> In CAPA the results are passed 866: as the first argument whereas in LON-CAPA the results are set equal 867: to the function.</td> 868: </tr> 869: <tr> 870: <td width=131 valign=top class="Normal"> random_chi (return_array,item_cnt,seed,df)</td> 871: <td width=134 valign=top class="Normal"> @return_array=&random_chi 872: ($item_cnt,$seed,$df) 873: NOTE: $df MUST be positive.</td> 874: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 875: of chi_square distribution with $df degrees of freedom. </td> 876: <td width=101 valign=top class="Normal"> In CAPA the results are passed 877: as the first argument whereas in LON-CAPA the results are set equal 878: to the function.</td> 879: </tr> 880: <tr> 881: <td width=131 valign=top class="Normal"> random_noncentral_chi (return_array,item_cnt,seed,df,nonc)</td> 882: <td width=134 valign=top class="Normal"> @return_array=&random_noncentral_chi 883: ($item_cnt,$seed,$df,$nonc) 884: NOTE: $df MUST be at least 1 and $nonc MUST be non-negative.</td> 885: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 886: of noncentral_chi_square distribution with $df degrees of freedom and 887: noncentrality parameter $nonc. </td> 888: <td width=101 valign=top class="Normal"> In CAPA the results are passed 889: as the first argument whereas in LON-CAPA the results are set equal 890: to the function.</td> 891: </tr> 892: <tr> 893: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 894: <td width=134 valign=top class="Normal"> @return_array=&random_f 895: ($item_cnt,$seed,$dfn,$dfd) 896: NOTE: Both $dfn and $dfd MUST be positive.</td> 897: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 898: of F (variance ratio) distribution with degrees of freedom $dfn (numerator) 899: and $dfd (denominator). </td> 900: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 901: </tr> 902: <tr> 903: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 904: <td width=134 valign=top class="Normal"> @return_array=&random_noncentral_f 905: ($item_cnt,$seed,$dfn,$dfd,$nonc) 906: NOTE: $dfn must be at least 1, $dfd MUST be positive, and $nonc must 907: be non-negative.</td> 908: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 909: of noncentral F (variance ratio) distribution with degrees of freedom 910: $dfn (numerator) and $dfd (denominator). $nonc is the noncentrality 911: parameter. </td> 912: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 913: </tr> 914: <tr> 915: <td width=131 valign=top class="Normal"> NOT DOCUMENTED IN CAPA</td> 916: <td width=134 valign=top class="Normal"> @return_array=&random_multivariate_normal 917: ($item_cnt,$seed,\@mean,\@covar) 918: NOTE: @mean should be of length p array of real numbers. @covar should 919: be a length p array of references to length p arrays of real numbers 920: (i.e. a p by p matrix.</td> 921: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 922: of multivariate_normal distribution with mean vector @mean and variance-covariance 923: matrix. </td> 924: <td width=101 valign=top class="Normal"> Note the backslash before the 925: @mean and @covar arrays.</td> 926: </tr> 927: <tr> 928: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 929: <td width=134 valign=top class="Normal"> @return_array=&random_multinomial 930: ($item_cnt,$seed,@p) 931: NOTE: $item_cnt is rounded with int() and the result must be non-negative. 932: The number of elements in @p must be at least 2.</td> 933: <td width=147 valign=top class="Normal"> Returns single observation from 934: multinomial distribution with $item_cnt events classified into as many 935: categories as the length of @p. The probability of an event being classified 936: into category i is given by ith element of @p. The observation is an 937: array with length equal to @p, so when called in a scalar context it 938: returns the length of @p. The sum of the elements of the obervation 939: is equal to $item_cnt.</td> 940: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 941: </tr> 942: <tr> 943: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 944: <td width=134 valign=top class="Normal"> @return_array=&random_permutation 945: ($item_cnt,@array) </td> 946: <td width=147 valign=top class="Normal"> Returns @array randomly permuted.</td> 947: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 948: </tr> 949: <tr> 950: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 951: <td width=134 valign=top class="Normal"> @return_array=&random_uniform 952: ($item_cnt,$seed,$low,$high) 953: NOTE: $low must be less than or equal to $high.</td> 954: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 955: from a uniform distribution. </td> 956: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 957: </tr> 958: <tr> 959: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 960: <td width=134 valign=top class="Normal"> @return_array=&random_uniform_integer 961: ($item_cnt,$seed,$low,$high) 962: NOTE: $low and $high are both passed through int(). $low must be less 963: than or equal to $high.</td> 964: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 965: from a uniform distribution in integers. </td> 966: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 967: </tr> 968: <tr> 969: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 970: <td width=134 valign=top class="Normal"> @return_array=&random_binomial 971: ($item_cnt,$seed,$nt,$p) 972: NOTE: $nt is rounded using int() and the result must be non-negative. 973: $p must be between 0 and 1 inclusive.</td> 974: <td width=147 valign=top class="Normal"> Generate $item_cnt deviates 975: from the binomial distribution with $nt trials and the probabilty of 976: an event in each trial is $p. </td> 977: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 978: </tr> 979: <tr> 980: <td width=131 valign=top class="Normal"> NOT IMPLEMENTED IN CAPA</td> 981: <td width=134 valign=top class="Normal"> @return_array=&random_negative_binomial 982: ($item_cnt,$seed,$ne,$p) 983: NOTE: $ne is rounded using int() and the result must be positive. $p 984: must be between 0 and 1 exclusive.</td> 985: <td width=147 valign=top class="Normal"> Generate an array of $item_cnt 986: outcomes generated from negative binomial distribution with $ne events 987: and the probabilty of an event in each trial is $p. </td> 988: <td width=101 valign=top class="Normal"> New to LON-CAPA</td> 989: </tr> 990: </table> 991: <h3><a name="_Toc421867130"><script> Variables</a></h3> 992: <ul type=disc> 993: <li>$external::target - set to the current target the xml parser is parsing 994: for </li> 995: <li>$external::part - set to the id 996: of the current problem <part>; zero if there are no <part> </li> 997: <li>$external::gradestatus - set to the value of the current resource.partid.solved 998: value </li> 999: <li>$external::datestatus - set to the current status of the clock either 1000: CLOSED, CAN_ANSWER, CANNOT_ANSWER, SHOW_ANSWER, or UNCHECKEDOUT </li> 1001: <li>$external::randomseed - set to the number that was used to seed the random 1002: number generator </li> 1003: <li>$pi - set to PI </li> 1004: <li>$rad2deg - converts radians to degrees </li> 1005: <li>$deg2rad - converts degrees to radians </li> 1006: </ul> 1007: <h3><a name="_Toc421867131">Form internals</a> </h3> 1008: Form elements used for homework editing/response 1009: the form is named lonhomework 1010: <h3><a name="_Toc421867132">Viewing a problem (either CSTR or RES space)</a></h3> 1011: <ul type=disc> 1012: <li>grade_target, grade_username, grade_domain, grade_symb - the vaules take 1013: precedence over the the normal ENV settings of these, use &Apache::lonxml::whichuser() 1014: to get back the correct vaues of the items </li> 1015: <li>HWVAL_response:number - the name of the input elements for each response. 1016: The response is the response's ID, and the :number part exists only for 1017: response with multiple foils, and is a unique number in order of the submission 1018: </li> 1019: <li>changerandseed - the 'Change' button, only exists right after the Change 1020: button is clicked </li> 1021: <li>problemmode - in CSTR, it is either 'View','Edit','EditXML' or 'Analyze' 1022: depending on the desired view </li> 1023: <li>rndseed - the currently requested random seed </li> 1024: <li>showallfoils - if it exists, and we are in CSTR space, the problem should 1025: ignore <conceptgroup> and the response's max setting and show all 1026: possible foils </li> 1027: <li>submit - the name of the Submit button </li> 1028: <li>submitted - a hidden form parameter that can be used to tell if the student 1029: has submitted answers or not, if it is set, there should be answers to grade. 1030: </li> 1031: </ul> 1032: <h3><a name="_Toc421867133">Editing a problem (Edit mode)</a></h3> 1033: tagdepth referes to the current value of the xmlparsers tagdepth couter ($Apache::lonxml::currentdepth) 1034: Note: the file edit.pm has many helper functions for creating the standard 1035: elements for editing a tag and it's attributes, all of those functions follow 1036: these conventions 1037: <ul type=disc> 1038: <li>tagdepth_argname - I.E. 1_3.max, a parameter editing value, max is the 1039: name of the parameter and it is for the third tag inside the first tag </li> 1040: <li>delete_tagdepth - if set to yes, delete tag tagdepth and all tags inside 1041: of it </li> 1042: <li>homework_edit_tagdepth - used by both &Apache::edit::editline and 1043: &Apache::edit::editfield for the <textarea> and <input> 1044: form elements they create </li> 1045: <li>insert_tagdepth - used to request an tag insert, it is set to the id number 1046: of the requested tag in the %Apache::lonxml::insertlist </li> 1047: </ul> 1048: <ul type=disc> 1049: <li>   </li> 1050: </ul> 1051: <h3><a name="_Toc421867134">Symbs</a></h3> 1052: To identify a specific instance of a resource, LON-CAPA uses symbols or �symbs.� 1053: These identifiers are built from the URL of the map, the resource number of 1054: the resource in the map, and the URL of the resource itself. The latter is 1055: somewhat redundant, but might help if maps change. 1056: An example is 1057:  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem 1058: The respective map entry is 1059:  <resource 1060: id="19" src="/res/msu/korte/tests/part12.problem"     1061: 1062:   title="Problem 1063: 2"> 1064:  </resource> 1065: Symbs are used by the random number generator, as well as 1066: to store and restore data specific to a certain instance of for example a 1067: problem. 1068: <h3><a name="_Toc421867135">Store / Restore</a></h3> 1069: 2 important functions in lonnet.pm are &Apache::lonnet::cstore() and &Apache::lonnet:restore() (and 1072: &Apache::lonnet::store(), which is is the non-critical message twin of cstore). These functions are for handlers to store a perl hash to 1076: a user�s permanent data space in an easy manner, and to retrieve it again 1077: on another call. It is expected that a handler would use this once at the 1078: beginning to retrieve data, and then again once at the end to send only the 1079: new data back. 1080: The data is stored in the user�s data directory 1081: on the user�s homeserver under the ID of the course. 1082: The hash that is returned by restore will have all of the previous value for all of the elements 1085: of the hash. 1086: Example: 1087: #creating a hash 1088: my %hash; 1089: $hash{'foo'}='bar'; 1090: #storing it 1091: &Apache::lonnet::cstore(\%hash); 1092: #changing a value 1093: $hash{'foo'}='notbar'; 1094: #adding a new value 1095: $hash{'bar'}='foo'; 1096: &Apache::lonnet::cstore(\%hash); 1097: #retrieving the hash 1098: my %history=&Apache::lonnet::restore(); 1099: #print the hash 1100: foreach my $key (sort(keys(%history))) 1101: { 1102:     print("\%history{$key} 1103: = $history{$key}"); 1104: } 1105: Will print out: 1106: %history{1:foo} = bar 1107: %history{1:keys} = foo:timestamp 1108: %history{1:timestamp} 1109: = 990455579 1110: %history{2:bar} = foo 1111: %history{2:foo} = notbar 1112: %history{2:keys} = foo:bar:timestamp 1113: %history{2:timestamp} 1114: = 990455580 1115: %history{bar} = foo 1116: %history{foo} = notbar 1117: %history{timestamp} = 1118: 990455580 1119: %history{version} = 2 1120: Note that the special hash entries keys, 1121: version and timestamp were 1123: added to the hash. version will be 1124: equal to the total number of versions of the data that have been stored. The 1125: timestamp attribute will be the UNIX time the hash was stored. keys is available in every historical section to list which keys 1128: were added or changed at a specific historical revision of a hash. 1129: Warning do not store the hash that restore returns directly. This 1131: will cause a mess since it will restore the historical keys as if the were 1132: new keys. I.E. 1:foo will become 1:1:foo etc. 1135: Calling convention: 1136:   my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home); 1138:   &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home); 1140: Arguments (only %newrecord is required the rest 1141: are somewhat optional, read the details): 1142: �      1144: $symb - a string containing the internal name of the specific instance 1146: of a resource. Usually this value can be gotten from &Apache::lonnet::symbread($filename). If the argument is blank, it will attempt to use symbread() for it. If the result is ambiguous store/restore will fail. 1151: 1152: �      1154: $courseid - the internal name for a course, usually found in $ENV{'request.course.id'} which is what will be looked at if no value is passed to 1158: the functions. 1159: �      1161: $domain - the domain that the user belongs to, usually found in $ENV{'user.domain'} which is what will be looked at if no value is passed to 1165: the functions. 1166: �      1168: $uname - the login name for the user, usually found in $ENV{'user.name'} which is what will be looked at if no value is passed to 1172: the functions. 1173: �      1175: $home - the homeserver for the user, usually found in $ENV{'user.home'} but can be easily gotten from a domain and name through &Apache::lonnet::homeserver($uname,$domain). If no value is passed to store/restore the value in %ENV 1181: will be used. 1182: �      1184: %newrecord - the hash to store being passed by reference 1186: Return values: 1187: �      1189: an empty string - the function was unable to determine exactly where to store 1191: or restore from. At least one of the "optional" arguments was unable 1192: to be determined. 1193: �      1195: a hash - restore successfully read a old hash for this specific 1197: user / resource instance. 1198: �      1200: no_such_host - the $home specfied 1202: desn't exist in the network. 1203: �      1205: con_delayed - the $home was uncontactable 1207: at this time. The store will be delayed until it is again available. 1208: �      1210: con_failed - the $home was uncontactable 1212: at this time and store was unable to delay the store until a later time. The 1213: store failed. 1214: �      1216: ok - the store completed succesfully 1218: �      1220: error: - remote server failied to store or restore the reason follows 1222: the : 1224: <h3><a name="_Toc421867136">Mandatory Homework Data</a></h3> 1225: <pre> </pre> 1226: <pre><Provided by &EXT() and set external to the resource, required></pre> 1228: <pre>resource.partid.opendate   #unix time of when the local machine should let the</pre> 1230: <pre>                           #student in</pre> 1232: <pre> </pre> 1234: <pre>resource.partid.duedate    #unix time of when the local machine should stop</pre> 1236: <pre>                           #accepting answers</pre> 1238: <pre> </pre> 1240: <pre>resource.partid.answerdate #unix time of when the local machine should</pre> 1242: <pre>                           #provide the correct answer to the student</pre> 1244: <pre> </pre> 1246: <pre>resource.partid.weight     # points the problem is worth</pre> 1248: <pre> </pre> 1250: <pre>resource.partid.maxtries   # maximum number of attempts the student can have</pre> 1252: <pre> </pre> 1254: <pre>resource.partid.type       # type of problem homework can be:</pre> 1256: <pre>                           # homework - randomized, graded, stored with </pre> 1258: <pre>                           #            requesting user, full feeback</pre> 1260: <pre>                           # exam - randomized, graded, stored with </pre> 1262: <pre>                           #        requesting user, minimal feedback</pre> 1264: <pre>                           # form - unrandomized, ungraded, stored with </pre> 1266: <pre>                           #        specified user, full feedback</pre> 1268: <pre>                           # survey - unrandomized, ungraded, stored with </pre> 1270: <pre>                           #          requesting user, full feedback</pre> 1272: <pre> </pre> 1274: <pre> </pre> 1276: <pre> </pre> 1278: <pre><numerical/formula/response needed: (has a default if nonexistant)></pre> 1280: <pre> </pre> 1282: <pre>resource.partid.responseid.tol   # lots of possibilities here</pre> 1284: <pre>                    # percentage, range (inclusive and exclusive),</pre> 1286: <pre>                     # variable name, etc</pre> 1288: <pre>                    # 3%</pre> 1290: <pre>                    # 0.5</pre> 1292: <pre>                    # .05+</pre> 1294: <pre>                    # 3%+</pre> 1296: <pre>                    # 0.5+,.005</pre> 1298: <pre> </pre> 1300: <pre>resource.partid.responseid.sig  # one or two comma sepearted integers,    </pre> 1302: <pre>                                # specifying the number of significatn figures</pre> 1304: <pre>                                # a student must use</pre> 1306: <pre> </pre> 1308: <pre> </pre> 1310: <pre> </pre> 1312: <pre><Problem sets using cstore (required):></pre> 1314: <pre>resource.partid.solved # if not set, problem yet to be viewed</pre> 1316: <pre>                # incorrect_attempted == incorrect and attempted</pre> 1318: <pre>                # correct_by_student == correct by student work</pre> 1320: <pre>                # correct_by_override == correct, instructor override</pre> 1322: <pre>                # incorrect_by_override == incorrect, instructor override</pre> 1324: <pre>                # excused == excused, problem no longer counts for student</pre> 1326: <pre>                # '' (empty) == not attempted</pre> 1328: <pre>                # ungraded_attempted == an ungraded answer has been</pre> 1330: <pre>                                          sumbitted and stored</pre> 1332: <pre>resource.partid.tries  # positive integer of number of unsuccessful attempts</pre> 1334: <pre>                # made, malformed answers don't count if feedback is</pre> 1336: <pre>                # on</pre> 1338: <pre> </pre> 1340: <pre>resource.partid.awarded # float between 0 and 1, percentage of</pre> 1342: <pre>                 # resource.weight that the stundent earned.</pre> 1344: <pre> </pre> 1346: <pre>resource.partid.award # final detailed award that was applied to the entire</pre> 1348: <pre>                      # part of the question, check awarddetail below for</pre> 1350: <pre>                      # possibilities</pre> 1352: <pre> </pre> 1354: <pre>resource.partid.previous # boolean, is this submission a previous submission</pre> 1356: <pre> </pre> 1358: <pre>resource.partid.responseid.submissons</pre> 1360: <pre>                    # the student submitted string for the part.response</pre> 1362: <pre> </pre> 1364: <pre>resource.partid.responseid.awarddetail</pre> 1366: <pre>                     # list of all of the results of grading the submissions</pre> 1368: <pre>                     # in detailed form of the specific failure</pre> 1370: <pre>                      #Possible values:</pre> 1372: <pre>                     # EXACT_ANS, APPROX_ANS : student is correct</pre> 1374: <pre>                     # NO_RESPONSE : student submitted no response</pre> 1376: <pre>                     # MISSING_ANSWER : student submitted some but not</pre> 1378: <pre>                     #                   all parts of a response</pre> 1380: <pre>                     # WANTED_NUMERIC : expected a numeric answer and</pre> 1382: <pre>                     #                   didn't get one</pre> 1384: <pre>                      # SIG_FAIL : incorrect number of Significant Figures</pre> 1386: <pre>                     # UNIT_FAIL : incorrect unit</pre> 1388: <pre>                     # UNIT_NOTNEEDED : Submitted a unit when one shouldn't</pre> 1390: <pre>                     # NO_UNIT : needed a unit but none was submitted</pre> 1392: <pre>                      # BAD_FORMULA : syntax error in submitted formula</pre> 1394: <pre>                     # INCORRECT : answer was wrong</pre> 1396: <pre>                     # SUBMITTED : submission wasn't graded</pre> 1398: <pre>                     # ERROR : unable to get a grade</pre> 1400: <pre> </pre> 1402: <pre>resource.partid.responseid.message (optional) (not yet supported)</pre> 1404: <pre>                       # a message that should be shown to the student</pre> 1406: <pre> </pre> 1408: <pre>resource.partid.bonustries (optional) (not yet supported)</pre> 1410: <pre>                     # if set, added to the maxtries parameter for student </pre> 1412: <pre>                     # total number of tries overall</pre> 1414: <pre> </pre> 1415: <h3><a name="_Toc421867137">Sample Problems</a></h3> 1416: A Simple Problem 1418: <problem> 1420:         1422: <script type="loncapa/perl"> 1423: $length=&random(10,99,.1); 1425: $width=&random(1,10,.01); 1427: @area=($length*($width*10)); 1429:         1431: </script> 1432: What 1434: is the area of a box $length mm in length and 1435: &format($width,"2E") 1437: cm in width. 1438:         1440: <numericalresponse id="11" answer="@area" units="mm^2"> 1441:                 1443: <textline></textline> 1444:                 1446: <responseparam name="tol" type="tolerance" default="5%"></responseparam> 1447:         1449: </numericalresponse> 1450: </problem> 1452: A More Complex Problem 1454: <problem> 1455: <displayduedate 1456: /> 1457: <displaytitle 1458: /> 1459: <script type="loncapa/perl"> 1460: $vF=" 1461: F1 "; 1462: $vF1=" 1463: F1 "; 1464: $vF2=" 1465: F2 "; 1466: $mF="|F|"; 1467: $F1mag="|F1|"; 1468: $F2mag="|F2|"; 1469: $trq1mag="| 1470: t1|"; 1471: $trq2mag="| 1472: t2|"; 1473: $Q1="Q1"; 1474: $Q2="Q2"; 1475: $tau="t"; 1477: $tau1="t1"; 1479:    $val=&random(1,4,1); 1480:    $tp=&choose($val,"her","her","his","his"); 1481:    $sd=&choose($val,"daughter","niece","nephew","son"); 1482: </script> 1483: <startouttext 1484: /> 1485: $trq1mag and $trq2mag 1486: are the magnitudes of the torques produced repectively by 1487: forces $vF1 and $vF2 1488: with respect the pivot P. The magnitudes of $vF1 is 1489: $F1mag and that of 1490: $vF2 is $F2mag. $Q1 and $Q2 are the locations 1491: on a rigid body where 1492: $vF1 and $vF2 act.  1493: <endouttext /> 1494: <optionresponse 1495: max="600"> 1496:         1497: <foilgroup options="('Correct','Incorrect','Can not tell')"> 1498:                 1499: <conceptgroup concept="Effect of the moment-arm on the torque"> 1500:                         1501: <foil name="1a" value="Incorrect"> 1502:                           1503: For $F1mag larger than $F2mag , $trq1mag is larger than $trq2mag 1504:                         1505: </foil> 1506:                         1507: <foil name="1b" value="Incorrect"> 1508:                           1509: For $F1mag smaller than $F2mag , $trq1mag is smaller than $trq2mag 1510:                         1511: </foil> 1512:            1513:              <foil 1514: name="1c" value="Correct"> 1515:                           1516: For $F1mag larger than $F2mag , $trq1mag can be less  than $trq2mag 1517:                         1518: </foil> 1519:                         1520: <foil name="1d" value="Correct"> 1521:                           1522: For $F1mag smaller than $F2mag , $trq1mag can be larger  than $trq2mag 1523:                         1524: </foil> 1525:                 1526: </conceptgroup> 1527:                 1528: <conceptgroup concept="For a given pivot, relation of force vector 1529: to torque."> 1530:                         1531: <foil name="2a" value="Correct"> 1532:                   1533: The moment-arm of $vF is the shortest distance from P to the line along $vF 1534: . 1535:                         1536: </foil> 1537:                         1538: <foil name="2b" value="Incorrect"> 1539:                           1540: The moment-arm of $vF is the shortest distance from P to $vF vector. 1541:                         1542: </foil> 1543:                         1544: <foil name="2c" value="Correct"> 1545:                           1546: The moment-arm of $vF is not the distance from P to Q1. 1547:                 1548:         </foil> 1549:                         1550: <foil name="2d" value="Incorrect"> 1551:                           1552: The moment-arm of $vF is the distance from P to Q1. 1553:                         1554: </foil> 1555:                 1556: </conceptgroup> 1557:                 1558: <conceptgroup concept="Torque is force x moment-arm."> 1559:                         1560: <foil name="3a" value="Correct"> 1561:                           1562: $trq1mag equals to the product of the moment-arm and $F1mag . 1563:                       1564: </foil> 1565:                         1566: <foil name="3b" value="Incorrect"> 1567:                         1568: $trq1mag equals to $F1mag times the distance from Q1 1569: to P. 1570:                         1571: </foil> 1572:                         1573: <foil name="3c" value="Correct"> 1574:                           1575: $trq1mag is not equal to the product of $F1mag and the distance from Q1 1576: to P. 1577:                         1578: </foil> 1579:                         1580: <foil name="3d" value="Incorrect"> 1581:                         1582: $trq1mag is not equal to the product of the moment-arm and $F1mag . 1583:          1584:                </foil> 1585:                 1586: </conceptgroup> 1587:                 1588: <conceptgroup concept="Pivot point is required to calculate torque"> 1589:                         1590: <foil name="4a" value="Correct"> 1591:                          1592: $tau1 vector depends on the location of P. 1593:                         1594: </foil> 1595:                         1596: <foil name="4b" value="Incorrect"> 1597:                          1598: $tau1 vector does not depend on the location of P. 1599:                         1600: </foil> 1601:                         1602: <foil name="4c" value="Correct"> 1603:                          1604: $tau1 vector has no meaning unless a pivot is selected. 1605:                         1606: </foil> 1607:                         1608: <foil name="4d" value="Incorrect"> 1609:                          1610: $tau1 vector can be determined without selecting P. 1611:                         1612: </foil> 1613:                 1614: </conceptgroup> 1615:                 1616: <conceptgroup concept="torque from 2 forces acting along same line"> 1617:                         1618: <foil name="5a" value="Correct"> 1619:                           1620: Two equal forces, acting on a body along the same line but at different positions, 1621: produce equal torques with respect to a given pivot." 1622:                         1623: </foil> 1624:                         1625: <foil name="5b" value="Incorrect"> 1626:                           1627: Two equal forces, along the same line, produce equal torques with respect 1628: to a given pivot only if they act at the same point on a body." 1629:                         1630: </foil> 1631:                         1632: <foil name="5c" value="Incorrect"> 1633:                           1634: Two equal forces acting on a body along the same line but at different positions, 1635: produce equal torques for only one pivot." 1636:                         1637: </foil> 1638:                 1639: </conceptgroup> 1640:                 1641: <foil name="6" value="unused"> 1642:                         1643: This foil will never display since it is unused. 1644:                 1645: </foil> 1646:         1647: </foilgroup> 1648:         1649: <notsolved> 1650:                 1651: <hintgroup> 1652: Think the definition 1653: of the torque. The force and the moment-arm respect to the pivot.  1654:                 1655: </hintgroup> 1656:       1657:   </notsolved> 1658: </optionresponse> 1659: </problem> 1660: <h3>  </h3> 1661: <img border=0 width=432 height=370 1662: src="Session%20On2_files/image003.png" v:shapes="_x0000_i1025"> 1663: Fig. 3.1.1 � Internal Structure of Homework Handler 1665: </div> 1666: 1668: <div class=Section2> </div> 1669: </body> 1670: </html>