[LON-CAPA-cvs] cvs: loncom /homework grades.pm /interface loncreatecourse.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Tue, 11 Nov 2008 16:40:47 -0000


This is a MIME encoded message

--jms1226421647
Content-Type: text/plain

jms		Tue Nov 11 16:40:47 2008 EDT

  Modified files:              
    /loncom/interface	loncreatecourse.pm 
    /loncom/homework	grades.pm 
  Log:
  Added/modified POD comments
  
--jms1226421647
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081111164047.txt"

Index: loncom/interface/loncreatecourse.pm
diff -u loncom/interface/loncreatecourse.pm:1.110 loncom/interface/loncreatecourse.pm:1.111
--- loncom/interface/loncreatecourse.pm:1.110	Wed Oct  8 11:03:53 2008
+++ loncom/interface/loncreatecourse.pm	Tue Nov 11 16:40:43 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Create a course
 #
-# $Id: loncreatecourse.pm,v 1.110 2008/10/08 11:03:53 bisitz Exp $
+# $Id: loncreatecourse.pm,v 1.111 2008/11/11 16:40:43 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,50 @@
 #
 ###
 
+=head1 NAME
+
+Apache::loncreatecourse.pm
+
+=head1 SYNOPSIS
+
+Allows domain coordinators to create new
+courses and assign course coordinators.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+handler()
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item *
+
+print_course_creation_page()
+
+=item *
+
+create_course()
+
+=item *
+
+print_intro_page()
+
+=item *
+
+upload_batchfile()
+
+=item *
+
+process_batchfile()
+
+=back
+
+=cut
+
 package Apache::loncreatecourse;
 
 use strict;
Index: loncom/homework/grades.pm
diff -u loncom/homework/grades.pm:1.528 loncom/homework/grades.pm:1.529
--- loncom/homework/grades.pm:1.528	Mon Jul 14 10:28:19 2008
+++ loncom/homework/grades.pm	Tue Nov 11 16:40:47 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # The LON-CAPA Grading handler
 #
-# $Id: grades.pm,v 1.528 2008/07/14 10:28:19 raeburn Exp $
+# $Id: grades.pm,v 1.529 2008/11/11 16:40:47 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,183 @@
 # http://www.lon-capa.org/
 #
 
+=head1 NAME
+
+Apache::grades
+
+=head1 SYNOPSIS
+
+Handles the viewing of grades.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 OVERVIEW
+
+Do an ssi with retries:
+While I'd love to factor out this with the vesrion in lonprintout,
+that would either require a data coupling between modules, which I refuse to perpetuate (there's quite enough of that already), or would require the invention of another infrastructure
+I'm not quite ready to invent (e.g. an ssi_with_retry object).
+
+At least the logic that drives this has been pulled out into loncommon.
+
+
+
+ssi_with_retries - Does the server side include of a resource.
+                     if the ssi call returns an error we'll retry it up to
+                     the number of times requested by the caller.
+                     If we still have a proble, no text is appended to the
+                     output and we set some global variables.
+                     to indicate to the caller an SSI error occurred.  
+                     All of this is supposed to deal with the issues described
+                     in LonCAPA BZ 5631 see:
+                     http://bugs.lon-capa.org/show_bug.cgi?id=5631
+                     by informing the user that this happened.
+
+Parameters:
+  resource   - The resource to include.  This is passed directly, without
+               interpretation to lonnet::ssi.
+  form       - The form hash parameters that guide the interpretation of the resource
+               
+  retries    - Number of retries allowed before giving up completely.
+Returns:
+  On success, returns the rendered resource identified by the resource parameter.
+Side Effects:
+  The following global variables can be set:
+   ssi_error                - If an unrecoverable error occurred this becomes true.
+                              It is up to the caller to initialize this to false
+                              if desired.
+   ssi_error_resource  - If an unrecoverable error occurred, this is the value
+                              of the resource that could not be rendered by the ssi
+                              call.
+   ssi_error_message   - The error string fetched from the ssi response
+                              in the event of an error.
+
+
+=head1 HANDLER SUBROUTINE
+
+ssi_with_retries()
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item *
+
+
+scantron_get_correction() : 
+
+   Builds the interface screen to interact with the operator to fix a
+   specific error condition in a specific scanline
+
+ Arguments:
+    $r           - Apache request object
+    $i           - number of the current scanline
+    $scan_record - hash ref as returned from &scantron_parse_scanline()
+    $scan_config - hash ref as returned from &get_scantron_config()
+    $line        - full contents of the current scanline
+    $error       - error condition, valid values are
+                   'incorrectCODE', 'duplicateCODE',
+                   'doublebubble', 'missingbubble',
+                   'duplicateID', 'incorrectID'
+    $arg         - extra information needed
+       For errors:
+         - duplicateID   - paper number that this studentID was seen before on
+         - duplicateCODE - array ref of the paper numbers this CODE was
+                           seen on before
+         - incorrectCODE - current incorrect CODE 
+         - doublebubble  - array ref of the bubble lines that have double
+                           bubble errors
+         - missingbubble - array ref of the bubble lines that have missing
+                           bubble errors
+
+=item *
+
+scantron_get_maxbubble() : 
+
+   Returns the maximum number of bubble lines that are expected to
+   occur. Does this by walking the selected sequence rendering the
+   resource and then checking &Apache::lonxml::get_problem_counter()
+   for what the current value of the problem counter is.
+
+   Caches the results to $env{'form.scantron_maxbubble'},
+   $env{'form.scantron.bubble_lines.n'}, 
+   $env{'form.scantron.first_bubble_line.n'} and
+   $env{"form.scantron.sub_bubblelines.n"}
+   which are the total number of bubble, lines, the number of bubble
+   lines for response n and number of the first bubble line for response n,
+   and a comma separated list of numbers of bubble lines for sub-questions
+   (for optionresponse, matchresponse, and rankresponse items), for response n.  
+
+
+=item *
+
+scantron_validate_missingbubbles() : 
+
+   Validates all scanlines in the selected file to not have any
+    answers that don't have bubbles that have not been verified
+    to be bubble free.
+
+=item *
+
+scantron_process_students() : 
+
+   Routine that does the actual grading of the bubble sheet information.
+
+   The parsed scanline hash is added to %env 
+
+   Then foreach unskipped scanline it does an &Apache::lonnet::ssi()
+   foreach resource , with the form data of
+
+	'submitted'     =>'scantron' 
+	'grade_target'  =>'grade',
+	'grade_username'=> username of student
+	'grade_domain'  => domain of student
+	'grade_courseid'=> of course
+	'grade_symb'    => symb of resource to grade
+
+    This triggers a grading pass. The problem grading code takes care
+    of converting the bubbled letter information (now in %env) into a
+    valid submission.
+
+=item *
+
+scantron_upload_scantron_data() :
+
+    Creates the screen for adding a new bubble sheet data file to a course.
+
+=item *
+
+scantron_upload_scantron_data_save() : 
+
+   Adds a provided bubble information data file to the course if user
+   has the correct privileges to do so. 
+
+=item *
+
+valid_file() :
+
+   Validates that the requested bubble data file exists in the course.
+
+=item *
+
+scantron_download_scantron_data() : 
+
+   Shows a list of the three internal files (original, corrected,
+   skipped) for a specific bubble sheet data file that exists in the
+   course.
+
+=item *
+
+scantron_validate_ID() : 
+
+   Validates all scanlines in the selected file to not have any
+   invalid or underspecified student IDs
+
+=back
+
+=cut
+
 package Apache::grades;
 use strict;
 use Apache::style;
@@ -58,46 +235,6 @@
 my $ssi_error_message;
 
 
-#  Do an ssi with retries:
-#  While I'd love to factor out this with the vesrion in lonprintout,
-#  that would either require a data coupling between modules, which I refuse to perpetuate
-#  (there's quite enough of that already), or would require the invention of another infrastructure
-#  I'm not quite ready to invent (e.g. an ssi_with_retry object).
-#
-# At least the logic that drives this has been pulled out into loncommon.
-
-
-#
-#   ssi_with_retries - Does the server side include of a resource.
-#                      if the ssi call returns an error we'll retry it up to
-#                      the number of times requested by the caller.
-#                      If we still have a proble, no text is appended to the
-#                      output and we set some global variables.
-#                      to indicate to the caller an SSI error occurred.  
-#                      All of this is supposed to deal with the issues described
-#                      in LonCAPA BZ 5631 see:
-#                      http://bugs.lon-capa.org/show_bug.cgi?id=5631
-#                      by informing the user that this happened.
-#
-# Parameters:
-#   resource   - The resource to include.  This is passed directly, without
-#                interpretation to lonnet::ssi.
-#   form       - The form hash parameters that guide the interpretation of the resource
-#                
-#   retries    - Number of retries allowed before giving up completely.
-# Returns:
-#   On success, returns the rendered resource identified by the resource parameter.
-# Side Effects:
-#   The following global variables can be set:
-#    ssi_error                - If an unrecoverable error occurred this becomes true.
-#                               It is up to the caller to initialize this to false
-#                               if desired.
-#    ssi_error_resource  - If an unrecoverable error occurred, this is the value
-#                               of the resource that could not be rendered by the ssi
-#                               call.
-#    ssi_error_message   - The error string fetched from the ssi response
-#                               in the event of an error.
-#
 sub ssi_with_retries {
     my ($resource, $retries, %form) = @_;
     my ($content, $response) = &Apache::loncommon::ssi_with_retries($resource, $retries, %form);
@@ -6611,14 +6748,7 @@
     return (0,$currentphase+1);
 }
 
-=pod
-
-=item scantron_validate_ID
 
-   Validates all scanlines in the selected file to not have any
-   invalid or underspecified student IDs
-
-=cut
 
 sub scantron_validate_ID {
     my ($r,$currentphase) = @_;
@@ -6684,35 +6814,6 @@
     return (0,$currentphase+1);
 }
 
-=pod
-
-=item scantron_get_correction
-
-   Builds the interface screen to interact with the operator to fix a
-   specific error condition in a specific scanline
-
- Arguments:
-    $r           - Apache request object
-    $i           - number of the current scanline
-    $scan_record - hash ref as returned from &scantron_parse_scanline()
-    $scan_config - hash ref as returned from &get_scantron_config()
-    $line        - full contents of the current scanline
-    $error       - error condition, valid values are
-                   'incorrectCODE', 'duplicateCODE',
-                   'doublebubble', 'missingbubble',
-                   'duplicateID', 'incorrectID'
-    $arg         - extra information needed
-       For errors:
-         - duplicateID   - paper number that this studentID was seen before on
-         - duplicateCODE - array ref of the paper numbers this CODE was
-                           seen on before
-         - incorrectCODE - current incorrect CODE 
-         - doublebubble  - array ref of the bubble lines that have double
-                           bubble errors
-         - missingbubble - array ref of the bubble lines that have missing
-                           bubble errors
-
-=cut
 
 sub scantron_get_correction {
     my ($r,$i,$scan_record,$scan_config,$line,$error,$arg)=@_;
@@ -7283,25 +7384,6 @@
     return (0,$currentphase+1);
 }
 
-=pod
-
-=item scantron_get_maxbubble
-
-   Returns the maximum number of bubble lines that are expected to
-   occur. Does this by walking the selected sequence rendering the
-   resource and then checking &Apache::lonxml::get_problem_counter()
-   for what the current value of the problem counter is.
-
-   Caches the results to $env{'form.scantron_maxbubble'},
-   $env{'form.scantron.bubble_lines.n'}, 
-   $env{'form.scantron.first_bubble_line.n'} and
-   $env{"form.scantron.sub_bubblelines.n"}
-   which are the total number of bubble, lines, the number of bubble
-   lines for response n and number of the first bubble line for response n,
-   and a comma separated list of numbers of bubble lines for sub-questions
-   (for optionresponse, matchresponse, and rankresponse items), for response n.  
-
-=cut
 
 sub scantron_get_maxbubble {
     if (defined($env{'form.scantron_maxbubble'}) &&
@@ -7444,15 +7526,6 @@
     return $env{'form.scantron_maxbubble'};
 }
 
-=pod
-
-=item scantron_validate_missingbubbles
-
-   Validates all scanlines in the selected file to not have any
-    answers that don't have bubbles that have not been verified
-    to be bubble free.
-
-=cut
 
 sub scantron_validate_missingbubbles {
     my ($r,$currentphase) = @_;
@@ -7507,29 +7580,6 @@
     return (0,$currentphase+1);
 }
 
-=pod
-
-=item scantron_process_students
-
-   Routine that does the actual grading of the bubble sheet information.
-
-   The parsed scanline hash is added to %env 
-
-   Then foreach unskipped scanline it does an &Apache::lonnet::ssi()
-   foreach resource , with the form data of
-
-	'submitted'     =>'scantron' 
-	'grade_target'  =>'grade',
-	'grade_username'=> username of student
-	'grade_domain'  => domain of student
-	'grade_courseid'=> of course
-	'grade_symb'    => symb of resource to grade
-
-    This triggers a grading pass. The problem grading code takes care
-    of converting the bubbled letter information (now in %env) into a
-    valid submission.
-
-=cut
 
 sub scantron_process_students {
     my ($r) = @_;
@@ -7660,14 +7710,6 @@
     return '';
 }
 
-=pod
-
-=item scantron_upload_scantron_data
-
-    Creates the screen for adding a new bubble sheet data file to a course.
-
-=cut
-
 sub scantron_upload_scantron_data {
     my ($r)=@_;
     $r->print(&Apache::loncommon::coursebrowser_javascript($env{'request.role.domain'}));
@@ -7708,14 +7750,6 @@
     return '';
 }
 
-=pod
-
-=item scantron_upload_scantron_data_save
-
-   Adds a provided bubble information data file to the course if user
-   has the correct privileges to do so.  
-
-=cut
 
 sub scantron_upload_scantron_data_save {
     my($r)=@_;
@@ -7777,14 +7811,6 @@
     return '';
 }
 
-=pod
-
-=item valid_file
-
-   Validates that the requested bubble data file exists in the course.
-
-=cut
-
 sub valid_file {
     my ($requested_file)=@_;
     foreach my $filename (sort(&scantron_filenames())) {
@@ -7793,16 +7819,6 @@
     return 0;
 }
 
-=pod
-
-=item scantron_download_scantron_data
-
-   Shows a list of the three internal files (original, corrected,
-   skipped) for a specific bubble sheet data file that exists in the
-   course.
-
-=cut
-
 sub scantron_download_scantron_data {
     my ($r)=@_;
     my $default_form_data=&defaultFormData(&get_symb($r,1));
@@ -8107,11 +8123,6 @@
     return;
 }
 
-=pod
-
-=back
-
-=cut
 
 #-------- end of section for handling grading scantron forms -------
 #

--jms1226421647--