[LON-CAPA-cvs] cvs: loncom /homework outputtags.pm radiobuttonresponse.pm

[jms]

jms		Fri Nov 14 21:27:17 2008 EDT

  Modified files:              
    /loncom/homework	radiobuttonresponse.pm outputtags.pm 
  Log:
  Added/converted comments to POD style
  
Index: loncom/homework/radiobuttonresponse.pm
diff -u loncom/homework/radiobuttonresponse.pm:1.136 loncom/homework/radiobuttonresponse.pm:1.137
--- loncom/homework/radiobuttonresponse.pm:1.136	Fri Oct 24 16:22:54 2008
+++ loncom/homework/radiobuttonresponse.pm	Fri Nov 14 21:27:17 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # mutliple choice style responses
 #
-# $Id: radiobuttonresponse.pm,v 1.136 2008/10/24 16:22:54 bisitz Exp $
+# $Id: radiobuttonresponse.pm,v 1.137 2008/11/14 21:27:17 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -25,6 +25,128 @@
 # http://www.lon-capa.org/
 #
 
+
+=head1 NAME
+
+Apache::radiobuttonresponse
+
+=head1 SYNOPSIS
+
+Handles multiple-choice style responses.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+start_radiobuttonresponse()
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item *
+
+bubble_line_count()
+
+=item *
+
+end_radiobuttonresponse()
+
+=item *
+
+start_foilgroup()
+
+=item *
+
+storesurvey()
+
+=item *
+
+grade_response()
+
+=item *
+
+end_foilgroup()
+
+=item *
+
+getfoilcounts()
+
+=item *
+
+format_prior_answer()
+
+=item *
+
+displayallfoils()
+
+=item *
+
+&whichfoils($max,$randomize)
+
+Randomizes the list of foils.
+Respects
+  - each foils desire to be randomized
+  - the existance of Concept groups of foils (select 1 foil from each)
+  - and selects a single correct statement from all possilble true statments
+  - and limits it to a toal of $max foils
+
+WARNING: this routine uses the random number generator, it should only
+be called once per target, otherwise it can cause randomness changes in
+homework problems.
+
+Arguments
+  $max - maximum number of foils to select (including the true one)
+         (so a max of 5 is: 1 true, 4 false)
+
+  $randomize - whether to randomize the listing of foils, by default
+               will randomize, only if randomize is 'no' will it not
+
+Returns
+  $answer - location in the array of the correct answer
+  @foils  - array of foil names in to display order
+
+=item *
+
+displayfoils()
+
+=item *
+
+displayallanswers()
+
+=item *
+
+displayanswers()
+
+=item *
+
+start_conceptgroup()
+
+=item *
+
+end_conceptgroup()
+
+=item *
+
+insert_conceptgroup()
+
+=item *
+
+start_foil()
+
+=item *
+
+end_foil()
+
+=item *
+
+insert_foil()
+
+=back
+
+=cut
+
 package Apache::radiobuttonresponse;
 use strict;
 use HTML::Entities();
@@ -403,33 +525,6 @@
     return $result;
 }
 
-=pod
-
-=item &whichfoils($max,$randomize)
-
-Randomizes the list of foils.
-Respects
-  - each foils desire to be randomized
-  - the existance of Concept groups of foils (select 1 foil from each)
-  - and selects a single correct statement from all possilble true statments
-  - and limits it to a toal of $max foils
-
-WARNING: this routine uses the random number generator, it should only
-be called once per target, otherwise it can cause randomness changes in
-homework problems.
-
-Arguments
-  $max - maximum number of foils to select (including the true one)
-         (so a max of 5 is: 1 true, 4 false)
-
-  $randomize - whether to randomize the listing of foils, by default
-               will randomize, only if randomize is 'no' will it not
-
-Returns
-  $answer - location in the array of the correct answer
-  @foils  - array of foil names in to display order
-
-=cut
 
 sub whichfoils {
     my ($max,$randomize)=@_;
Index: loncom/homework/outputtags.pm
diff -u loncom/homework/outputtags.pm:1.51 loncom/homework/outputtags.pm:1.52
--- loncom/homework/outputtags.pm:1.51	Mon Oct  8 23:02:57 2007
+++ loncom/homework/outputtags.pm	Fri Nov 14 21:27:17 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA 
 # tags that create controlled output
 #
-# $Id: outputtags.pm,v 1.51 2007/10/08 23:02:57 albertel Exp $
+# $Id: outputtags.pm,v 1.52 2008/11/14 21:27:17 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,67 @@
 # http://www.lon-capa.org/
 #
 
+=head1 NAME
+
+Apache::outputtags;
+
+=head1 SYNOPSIS
+
+Handles tags associated with output. Seems to
+relate to due dates of the assignment.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+start_displayduedate()
+
+=head1 OTHER SUBROUTINES
+
+=over
+
+=item *
+
+initialize_outputtags() : Empties the hash of tags that have already been displayed that should only be displayed once.
+
+=item *
+
+end_displayduedate()
+
+=item *
+
+start_displaytitle()
+
+=item *
+
+end_displaytitle()
+
+=item *
+
+multipart()
+
+=item *
+
+start_displayweight()
+
+=item *
+
+end_displayweight()
+
+=item *
+
+start_displaystudentphoto()
+
+=item *
+
+end_displaystudentphoto()
+
+
+=back
+
+=cut
+
 package Apache::outputtags; 
 
 use strict;
@@ -36,9 +97,7 @@
 BEGIN {
     &Apache::lonxml::register('Apache::outputtags',('displayduedate','displaytitle','displayweight','displaystudentphoto'));
 }
-#  Empties the hash of tags that have already been displayed
-#  that should only be displayed once.
-#
+
 sub initialize_outputtags {
     %Apache::outputtags::showonce=();
 }