--- loncom/homework/response.pm	2008/10/24 16:22:54	1.206
+++ loncom/homework/response.pm	2008/12/23 18:09:36	1.210
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # various response type definitons response definition
 #
-# $Id: response.pm,v 1.206 2008/10/24 16:22:54 bisitz Exp $
+# $Id: response.pm,v 1.210 2008/12/23 18:09:36 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,29 @@
 # http://www.lon-capa.org/
 #
 
+=pod
+
+=head1 NAME
+
+Apache::resonse.pm
+
+=head1 SYNOPSIS
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 NOTABLE SUBROUTINES
+
+=over
+
+=item 
+
+=back
+
+=cut
+
+
 package Apache::response;
 use strict;
 use Apache::lonlocal;
@@ -216,35 +239,26 @@ sub meta_stores_write {
 		      "></stores>\n";
 }
 
+=pod
+
+=item mandatory_part_meta()
+
+Autogenerate metadata for mandatory
+input (from RAT or lonparmset) and
+output (to lonspreadsheet)
+of each part
+
+Note: responseid-specific data 'submission' and 'awarddetail'
+not available to spreadsheet -> skip here
+
+=cut
+
+
 sub mandatory_part_meta {
-#
-# Autogenerate metadata for mandatory
-# input (from RAT or lonparmset) and 
-# output (to lonspreadsheet)
-# of each part
-#
-    return
-#    &meta_parameter_write('opendate','date_start','',
-#                          'Opening Date').
-#    &meta_parameter_write('duedate','date_end','',
-#                          'Due Date').
-#    &meta_parameter_write('answerdate','date_start','',
-#                          'Show Answer Date').
-#    &meta_parameter_write('weight','int_zeropos','',
-#                          'Available Points').
-#    &meta_parameter_write('maxtries','int_pos','',
-#                          'Maximum Number of Tries').
-	&meta_package_write('part').
-        &meta_stores_write('solved','string',
-			   'Problem Status').
-        &meta_stores_write('tries','int_zeropos',
-			   'Number of Attempts').
-        &meta_stores_write('awarded','float',
-			   'Partial Credit Factor');
-#
-# Note: responseid-specific data 'submission' and 'awarddetail'
-# not available to spreadsheet -> skip here
-#
+    return &meta_package_write('part').
+           &meta_stores_write('solved','string','Problem Status').
+           &meta_stores_write('tries','int_zeropos','Number of Attempts').
+           &meta_stores_write('awarded','float','Partial Credit Factor');
 }
 
 sub meta_part_order {
@@ -288,6 +302,7 @@ sub check_for_previous {
 		    $previous{'last'}='1';
 		}
 		if (! $previous{'award'} ) { $previous{'award'} = 'UNKNOWN';	}
+                if ($previous{'award'} eq 'INTERNAL_ERROR') { $previous{'used'}=0; }
 		&Apache::lonxml::debug("got a match :$previous{'award'}:$previous{'used'}:");
 	    }
 	}
@@ -887,7 +902,7 @@ sub showallfoils {
 
 =pod
 
-=item &getresponse($offset,$resulttype);
+=item &getresponse();
 
 Retreives the current submitted response, helps out in the case of
 scantron mode.
@@ -991,7 +1006,7 @@ sub repetition {
 
 =pod
 
-=item &scored_response($part_id,$response_id);
+=item &scored_response();
 
 Sets the results hash elements
 
@@ -1148,17 +1163,20 @@ sub pick_foil_for_concept {
 	$Apache::response::conceptgroup{'names'};
 
 }
-#------------------------------------------------------------
-#
-#  Get a parameter associated with a problem.
-# Parameters:
-#  $id        - the id of the paramater, either a part id, 
-#               or a partid and responspe id joined by _
-#  $name      - Name of the parameter to fetch
-#  $default   - Default value for the paramter.
-#
-#  
-#
+
+=pod
+
+=item get_response_param()
+
+Get a parameter associated with a problem.
+Parameters:
+	$id        - the id of the paramater, either a part id, 
+              or a partid and responspe id joined by _
+	$name      - Name of the parameter to fetch
+	$default   - Default value for the paramter.
+
+=cut
+
 sub get_response_param {
     my ($id,$name,$default)=@_;
     my $parameter;
@@ -1219,14 +1237,21 @@ sub add_to_gradingqueue {
     }
 }
 
-# basically undef and 0 (both false) mean that they still have work to do
-# and all true values mean that they can't do any more work
-#
-# a return of undef means it is unattempted
-# a return of 0 means it is attmpted and wrong but still has tries
-# a return of 1 means it is marked correct
-# a return of 2 means they have exceed maximum number of tries
-# a return of 3 means it after the answer date
+=pod 
+
+=item check_status()
+
+basically undef and 0 (both false) mean that they still have work to do
+and all true values mean that they can't do any more work
+
+	a return of undef means it is unattempted
+	a return of 0 means it is attmpted and wrong but still has tries
+	a return of 1 means it is marked correct
+	a return of 2 means they have exceed maximum number of tries
+	a return of 3 means it after the answer date
+
+=cut
+
 sub check_status {
     my ($id)=@_;
     if (!defined($id)) { $id=$Apache::inputtags::part; }
@@ -1251,7 +1276,7 @@ sub check_status {
 
 =pod
 
-=item setup_prior_tries_hash($func,$data)
+=item setup_prior_tries_hash()
 
   Foreach each past .submission $func is called with 3 arguments
      - the mode to set things up for (currently always 'grade')
@@ -1294,3 +1319,6 @@ sub setup_prior_tries_hash {
 1;
 __END__
  
+=pod
+
+=cut