doc/homework/homework5.html - view

File: [LON-CAPA] / doc / homework / homework5.html
Revision 1.1: download - view: text, annotated - select for diffs
Sat May 19 00:24:39 2001 UTC (22 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: HEAD

- new homework documentation

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>LON-CAPA Homework System</title> </head> <body> <h1>LON-CAPA Homework System</h1> <h2>Tags</h2> <ul> <li> Response tags Arguments for all response tags <ul> <li> ID, if this isn't set it will be set during the publication step. It is used to assign parameters names in a way that can be tracked if an instructor modifies things by hand. </li> <li> name optional, if set, it will be used by the resource assembly tool when one is modifying parameters. </li> </ul> Implemented response tags <ul> <li> <numericalresponse> implements a numerical answer, it needs an internal <textline> for the response to go in. It checks all styles of numerical supported in CAPA. Possible args are: <ul> <li>answer required, specifies the correct answer, must be a perl list</li> <li>type optional, CAPA style str args, cs/ci/mc</li> <li>units optional, specifies unit of correct answer, CAPA style</li> </ul> </li> <li> <essayresponse> implements a ungraded large text response, it need an internal <textarea> for the response to go in. </li> <li> <imageresponse> implements a image click style image submission, uses the foil structure tags <a href="#foil">below</a>. Additional tags that should appear in a <foil> are: <ul> <li><image> required, the contained text specifies a published graphical resource that is the image used, should only appear once per foil</li> <li><rectangle> required, the contained text specifies a rectangular area that is correct, should look like (1,2)-(3,4), at least 1 required</li> <li><text> required, the contained text is printed on top of the image.</li> </ul> </li> <li> <optionresponse> implements a "select from these choices" style question, the choices are specified by the instructor, it uses the foil structure tags <a href="#foil">below</a> with this additional args: <ul> <li> <foilgroup> is required to have options which should be a perl list of possible options for the student. </li> </ul> </li> <li> <radiobuttonresponse> implements a true / false style question with 1 correct answer.it uses the foil structure tags <a href="#foil">below</a> but the value of a <foil>can only be "true" or "false" or "unused" </li> </ul> <li> <a name="foil">Foil Structure Tags</a> All tags that implement a foil structure have an optional arg of max that controls the maximum number of total foils to show. <ul> <li> <foilgroup> required, must be the tag that surrounds all foil definitions </li> <li> <foil> required, all data inside is a possible foil </li> <li> <conceptgroup> optional, surrounds a collection of <foil>, when a problem is displayed only one of the contained <foil>is selected for display. It receives one required argument concept. </li> </ul> </li> <li> Hint structure All of these tags must appear inside a <*response> tag. <ul> <li> <hintgroup> Tag that surrounds all of a hint. </li> <li> <hintpart> required, Tag to implement conditional hints. It has a required argument on. When a <*hint> tag named the same as the value the on attribute evaluates to be correct the <hintpart> will show. If no other <hintpart> are to show then all hintparts with a on of "default" will show </li> <li> <numericalhint> has all the arguments that <numericalresponse>, does and the required attribute name which should be set to the value of which <hintpart> will be shown. </li> </ul> </li> <li> Input Tags This group of tags implement a mechanism for getting data for students, they will usually be used by a <*response>. <ul> <li> <textarea> creates a Large text input box, If data appears between the start and end tags, the data will appear i the textarea if the student has not yet made a submission. Additionally it takes two arguments rows and cols which control the height and width of the area respectively. It defaults to 10 and 80. </li> <li> <textline> creates a single line of input element, it accepts 1 argument size which controls the width on the textline, it defaults to 20. </li> </ul> </li> <li> Output Tags This group of tags generate useful pieces of output. <ul> <li> <displayduedate> this will insert the current duedate if one is set into the document. It is generated to be inside a table of 1x1 elements </li> <li> <displaytitle> this will insert the title of the problem from the metadata of the problem </li> <li> <window> the text in between is put in a popup javascript window </li> </ul> </li> <li> Scripting These tags allow the document to behave programatically <ul> <li> <display> the intervening perl script is evaluated in the safe space and the return value of the script replaces the entire tag </li> <li> <import> causes the parse to read in the file named in the body of the tag and parse it as if the entire text of the file had existed at location of the tag </li> <li> <parserlib> the enclosed filename contains definitions for new tags </li> <li> <script> if the argument type is set to "loncapa/perl" the enclosed data is a perl script which is evaluated inside the perl Safe space. The return value of the script is ignored. </li> <li> <scriptlib> the enclosed filename contains perl code to run in the safe space </li> <li> <block> has a required argument condition that is evaluated, it the condition is true everything inside the tag is evaluated, if it is false everything inside the block tag is skipped </li> <li> <notsolved> everything inside the tag is skipped if the problem is "solved" </li> <li> <postanswerdate> everything inside the tag is skipped if the problem is before the answer date </li> <li> <preduedate> everything inside the tag is skipped if the problem is after the due date </li> <li> <randomlist> the enclosed tags are parsed in a stable random order </li> <li> <solved> everything inside the tag is skipped if the problem is "not solved" </li> <li> <while> implements a while loop, required argument condition is a perl scriptlet that when evaluated results in a true or false value, on true the entirety of the text between the whiles is parsed. The condition is tested again, etc. If false it goes to the next node in the parse. </li> </ul> </li> <li> Structure Tags These tags give the problem a structure and take care of the recording of data and giving the student messages. <ul> <li> <problem> must be the first tag in the file, this tag sets up the header of the webpage and generates the submit buttons, it also handles due dates properly </li> <li> <part> must be below <problem> if it is going to be used. It does many of the same tasks as <problem> but allows multiple separate problems to exist in a single file. </li> <li> <startouttext><endouttext> these tags are somewhat special, they must have no internal text and occur in pairs. Their use is to mark up the problem so the web editor knows what sections should be edited in a plain text block on the web. </li> </ul> </li> </ul> <h2><script> Functions</h2> A list of functions that have been written that are available in the Safe space scripting environment inside a problem. The eventual goal is to provide all of the functions available in CAPA <ul> <li>random</li> <li>tan</li> <li>atan</li> <li>acos</li> <li>asin</li> <li>log10</li> <li>pow</li> <li>ceil</li> <li>floor</li> <li>format</li> <li>map</li> <li>choose</li> <li>caparesponse_check</li> <li>caparesponse_check_list</li> </ul> <h2><script> Variables</h2> <ul> <li> $external::target - set to the current target the xml parser is parsing for </li> <li> $external::part - set to the id of the current problem <part>; zero if there are now <part> </li> <li> $external::gradestatus - set to the value of the current resource.partid.solved value </li> <li> $external::datestatus - set to the current status of the clock either CLOSED, CAN_ANSWER, CANNOT_ANSWER, or SHOW_ANSWER </li> <li> $external::randomseed - set to the number that was used to seed the random number generator </li> <li>$pi - set to PI </li> </ul> <hr> <address><a href="mailto:albertel@marvin.lite.msu.edu">Guy Albertelli</a></address>   Last modified: Fri May 18 18:12:27 EDT 2001  </body> </html> <ul> <li> <> </li> </ul>