[LON-CAPA-cvs] cvs: doc /homework homework5.html xml.html
albertel
lon-capa-cvs@mail.lon-capa.org
Fri, 03 May 2002 18:34:20 -0000
albertel Fri May 3 14:34:20 2002 EDT
Modified files:
/doc/homework homework5.html xml.html
Log:
- updated some documenations, and added some documentation of the form parameters used by the homework engine
Index: doc/homework/homework5.html
diff -u doc/homework/homework5.html:1.13 doc/homework/homework5.html:1.14
--- doc/homework/homework5.html:1.13 Thu Mar 28 17:55:35 2002
+++ doc/homework/homework5.html Fri May 3 14:34:20 2002
@@ -885,7 +885,7 @@
</li>
<li>
$external::part - set to the <i>id</i> of the current problem
- <part>; zero if there are now <part>
+ <part>; zero if there are no <part>
</li>
<li>
$external::gradestatus - set to the value of the current
@@ -893,7 +893,7 @@
</li>
<li>
$external::datestatus - set to the current status of the clock
- either CLOSED, CAN_ANSWER, CANNOT_ANSWER, or SHOW_ANSWER
+ either CLOSED, CAN_ANSWER, CANNOT_ANSWER, SHOW_ANSWER, or UNCHECKEDOUT
</li>
<li>
$external::randomseed - set to the number that was used to
@@ -903,12 +903,74 @@
<li>$rad2deg - converts radians to degrees </li>
<li>$deg2rad - converts degrees to radians </li>
</ul>
-
+
+ <h2> Form internals </h2>
+ <p> Form elements used for homework editing/response </p>
+ <p> the form is named lonhomework </p>
+ <h3> Viewing a problem (either CSTR or RES space)</h3>
+ <ul>
+ <li>
+ grade_target, grade_username, grade_domain, grade_symb - the
+ vaules take precedence over the the normal ENV settings of
+ these, use &Apache::lonxml::whichuser() to get back the
+ correct vaues of the items
+ </li>
+ <li>
+ HWVAL_response:number - the name of the input elements for each response. The response is the response's ID, and the :number part exists only for response with multiple foils, and is a unique number in order of the submission
+ </li>
+ <li>
+ changerandseed - the 'Change' button, only exists right after
+ the Change button is clicked
+ </li>
+ <li>
+ problemmode - in CSTR, it is either 'View','Edit','EditXML' or
+ 'Analyze' depending on the desired view
+ </li>
+ <li>
+ rndseed - the currently requested random seed
+ </li>
+ <li>
+ showallfoils - if it exists, and we are in CSTR space, the
+ problem should ignore <conceptgroup> and the response's
+ max setting and show all possible foils
+ </li>
+ <li>
+ submit - the name of the Submit button
+ </li>
+ <li>
+ submitted - a hidden form parameter that can be used to tell
+ if the student has submitted answers or not, if it is set,
+ there should be answers to grade.
+ </li>
+ </ul>
+ <h3> Editing a problem (Edit mode)</h3>
+ <p> tagdepth referes to the current value of the xmlparsers tagdepth couter ($Apache::lonxml::currentdepth)</p>
+<p> Note: the file edit.pm has many helper functions for creating the standard elements for editing a tag and it's attributes, all of those functions follow these conventions </p>
+ <ul>
+ <li>
+ tagdepth_argname - I.E. 1_3.max, a parameter editing value,
+ max is the name of the parameter and it is for the third tag
+ inside the first tag
+ </li>
+ <li>
+ delete_tagdepth - if set to yes, delete tag tagdepth and all
+ tags inside of it
+ </li>
+ <li>
+ homework_edit_tagdepth - used by both &Apache::edit::editline
+ and &Apache::edit::editfield for the <textarea> and
+ <input> form elements they create
+ </li>
+ <li>
+ insert_tagdepth - used to request an tag insert, it is set to
+ the id number of the requested tag in the
+ %Apache::lonxml::insertlist
+ </ul>
<hr>
<address><a href="mailto:albertel@marvin.lite.msu.edu">Guy Albertelli</a></address>
<!-- Created: Thu May 17 15:05:35 EDT 2001 -->
<!-- hhmts start -->
-Last modified: Thu Mar 28 17:59:42 EST 2002
+Last modified: Fri May 3 14:24:52 EDT 2002
<!-- hhmts end -->
</body>
</html>
Index: doc/homework/xml.html
diff -u doc/homework/xml.html:1.2 doc/homework/xml.html:1.3
--- doc/homework/xml.html:1.2 Mon May 21 11:24:47 2001
+++ doc/homework/xml.html Fri May 3 14:34:20 2002
@@ -36,7 +36,9 @@
<import> tag actually does anything
</li>
<li>
- <i>@Apache::lonxml::extlinks</i> -
+ <i>@Apache::lonxml::extlinks</i> - a list of URLs that the
+ user is allowed to look at because of the current resource
+ (images, and links)
</li>
<li>
<i>#Apache::lonxml::metamode</i> - some output is turned off,
@@ -56,6 +58,10 @@
namespaces used in the insertlist.tab file that are currently
active, used only in edit mode.
</li>
+ <li>
+ <i>$Apache::lonxml::registered</i> - set to 1 once the remote
+ has been updated to know what resource we are looking at.
+ </li>
</ul>
<h3>Notable Perl subroutines</h3>
@@ -89,6 +95,12 @@
%Apache::lonxml::insertlist structure of what tags can have
what other tags inside.
</li>
+ <li>
+ <i>whichuser</i> - returns a list of $symb, $courseid,
+ $domain, $name that is correct for calls to lonnet functions
+ for this setup. Uses form.grade_ parameters, if the user is
+ allowed to mgr in the course
+ </li>
</ul>
<h3>Functions Tag Handlers can use</h3>
<p>
@@ -204,7 +216,7 @@
<address><a href="mailto:albertel@marvin.lite.msu.edu">Guy Albertelli</a></address>
<!-- Created: Sun May 20 15:47:08 EDT 2001 -->
<!-- hhmts start -->
-Last modified: Mon May 21 11:21:05 EDT 2001
+Last modified: Fri May 3 14:26:22 EDT 2002
<!-- hhmts end -->
</body>
</html>