Merge pull request #342 from cmhughes/cmhdevelop

showMeAnother button

I've tested this feature both as a professor and as a student.  The show me another button displays after the correct number of attempts (or is never shown at all), clicking it takes you to a new page with a different version of the problem.  The options defined in the Course Configuration page all work.  You can check and preview answers, and look at solutions and hints if the options are enabled and if they are there. I the system is usable and integrates well with the existing pages. 

Thanks for working with us for this (quite lengthy) pull process.  I think this feature ended up being a really nice addition to WeBWorK.  You might sign up for an account with the WeBWorK bug tracker (http://bugs.webwork.maa.org/) since its almost certain people will find bugs once more and more servers are using it. 

Cheers. 
Geoff.

Author: goehle

conf/defaults.config

@@ -155,6 +155,23 @@ $editor{textTitle} = '';
 $editor{textEdition} = '';
 $editor{textAuthor} = '';
 
+################################################################################
+# showMeAnother
+################################################################################
+# switch to enable showMeAnother button
+$pg{options}{enableShowMeAnother} = 0;
+# maximum number of times (per problem) the button can be used
+$pg{options}{showMeAnotherMaxReps} = 3;
+# maximum number of attempts to check if changing the problem seed
+# changes the problem
+$pg{options}{showMeAnotherGeneratesDifferentProblem} = 5;
+# showMeAnother options
+$pg{options}{showMeAnother}=[
+"SMAcheckAnswers",
+"SMAshowSolutions",
+"SMAshowCorrect",
+"SMAshowHints",
+];
 ################################################################################
 # Language
 ################################################################################
@@ -1067,6 +1084,12 @@ $problemDefaults{value} = 1;
 # setting this to -1 gives students unlimited attempts.
 $problemDefaults{max_attempts} = -1;   
 
+# The default showMeAnother for a problem to use when using the 
+# Library Browser, Problem Editor or Hmwk Sets Editor to add problems to a set
+# or when this value is left blank in an imported set definition file.  Note that 
+# setting this to -1 disables the showMeAnother button
+$problemDefaults{showMeAnother} = -1;   
+
 ##### Answer evaluatior defaults
 
 $pg{ansEvalDefaults} = {
@@ -1329,13 +1352,15 @@ $ConfigValues = [
 		  type => 'popuplist'
 		},
 		{ var  => 'pg{specialPGEnvironmentVars}{DragMath}',
-          doc  => 'Use DragMath editor for answer entry',
-          doc2 => 'Set to true to display pencil DragMath equation editor next to each answer box',
-          type => 'boolean'},
-        { var  => 'pg{specialPGEnvironmentVars}{MathView}',
-          doc  => 'Use MathView editor for answer entry',
-          doc2 => 'Set to true to display MathView equation editor icon next to each answer box',
-          type => 'boolean'}, 
+                  doc  => 'Use DragMath editor for answer entry',
+                  doc2 => 'Set to true to display pencil DragMath equation editor next to each answer box',
+                  type => 'boolean'
+                },
+                { var  => 'pg{specialPGEnvironmentVars}{MathView}',
+                  doc  => 'Use MathView editor for answer entry',
+                  doc2 => 'Set to true to display MathView equation editor icon next to each answer box',
+                  type => 'boolean'
+                }, 
 		{ var => 'pg{options}{showEvaluatedAnswers}',
 		  doc => 'Display the evaluated student answer',
 		  doc2 => 'Set to true to display the "Entered" column which automatically shows the evaluated student answer, e.g. 1 if student input is sin(pi/2). If this is set to false, e.g. to save space in the response area, the student can still see their evaluated answer by hovering the mouse pointer over the typeset version of their answer.',
@@ -1399,21 +1424,38 @@ $ConfigValues = [
 		  values => [qw(1 0.95 0.9 0.85 0.8 0.75 0.7 0.65 0.6 0.55 0.5 0.45 0.4 0.35 0.3 0.25 0.2 0.15 0.1)],
 		  type => 'popuplist'
 		},
-	   { var => 'pg{timeAssignDue}',
-		doc => 'Time that the Assignment is Due',
-		doc2 => 'The time of the day that the assignment is due.  This can be changed on an individual basis, but WeBWorK will use this value for default when a date is set.',
-		type => 'text'
-	},
-	{	var => 'pg{assignOpenPriorToDue}',
-		doc => 'Amount of Time (in minutes) before Due Date that the Assignment is Open',
-		doc2 => 'The amount of time (in minutes) before the due date when the assignment is opened.',
-		type => 'number'
-	},
-	{	var => 'pg{answersOpenAfterDueDate}',
-		doc => 'Amount of Time (in minutes) after Due Date that Answers are Open',
-		doc2 => 'The amount of time (in minutes) after the due date that the Answers are available to student to view.',
-		type => 'number'
-	},
+        	{ var => 'pg{timeAssignDue}',
+		  doc => 'Time that the Assignment is Due',
+		  doc2 => 'The time of the day that the assignment is due.  This can be changed on an individual basis, but WeBWorK will use this value for default when a date is set.',
+		  type => 'text'
+		},
+		{ var => 'pg{assignOpenPriorToDue}',
+		  doc => 'Amount of Time (in minutes) before Due Date that the Assignment is Open',
+		 doc2 => 'The amount of time (in minutes) before the due date when the assignment is opened.',
+		 type => 'number'
+		},
+		{ var => 'pg{answersOpenAfterDueDate}',
+		  doc => 'Amount of Time (in minutes) after Due Date that Answers are Open',
+		  doc2 => 'The amount of time (in minutes) after the due date that the Answers are available to student to view.',
+		   type => 'number'
+		},
+	        { var => 'pg{options}{enableShowMeAnother}',
+        	  doc => 'Enable Show Me Another button',
+       		  doc2 => 'Enables use of the Show Me Another button, which offers the student a newly-seeded version of the current problem, complete with solution (if it exists for that problem).',
+          	  type => 'boolean'
+                },
+	        { var => 'pg{options}{showMeAnotherMaxReps}',
+                  doc => 'Maximum times Show me Another can be used per problem (-1 => unlimited)',
+                  doc2 => 'The Maximum number of times Show me Another can be used per problem by a student. If set to -1 then there is no limit to the number of times that Show Me Another can be used.',
+                  type => 'number'
+                },
+            { var => 'pg{options}{showMeAnother}',
+		  doc => 'List of options for Show Me Another button',
+		  doc2 => '<ul><li><b>SMAcheckAnswers</b>: enables the Check Answers button <i>for the new problem</i> when Show Me Another is clicked</li> <li><b>SMAshowSolutions</b>: shows walk-through solution <i>for the new problem</i> when Show Me Another is clicked; a check is done first to make sure that a solution exists </li><li><b>SMAshowCorrect</b>: correct answers <i>for the new problem</i> can be viewed when Show Me Another is clicked; note that <b>SMAcheckAnswers</b> needs to be enabled at the same time</li><li><b>SMAshowHints</b>: show hints <i>for the new problem</i> (assuming they exist)</li></ul>Note: there is very little point enabling the button unless you check at least one of these options - the students would simply see a new version that they can not attempt or learn from.</p>',
+		  min  => 0,
+		  values => ["SMAcheckAnswers", "SMAshowSolutions","SMAshowCorrect","SMAshowHints"],
+		  type => 'checkboxlist'
+		}
 	],
 	['E-Mail',
 		{ var => 'mail{feedbackSubjectFormat}',

conf/localOverrides.conf.dist

@@ -228,6 +228,12 @@ $problemDefaults{value} = 1;
 
 $problemDefaults{max_attempts} = -1;   
 
+# The default showMeAnother for a problem to use when using the 
+# Library Browser, Problem Editor or Hmwk Sets Editor to add problems to a set
+# or when this value is left blank in an imported set definition file.  Note that 
+# setting this to -1 disables the showMeAnother button
+$problemDefaults{showMeAnother} = -1;   
+
 ################################################################################
 # "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
 ################################################################################

htdocs/themes/math4/math4.css

@@ -364,6 +364,7 @@ div.WarningMessage { background-color: #FF9494; padding: 3px 3px 3px 3px; }
 div.ResultsWithoutError { color: inherit; background-color: #8F8; } /* green */
 div.ResultsWithError { color: #FF9494; background-color: inherit; } /* error red, from http://www.colourlovers.com/color/FF9494/error_red*/
 div.ResultsAlert { color: #F60; background-color: inherit; } /* orange */
+div.showMeAnotherBox { background-color: #EDE275; border-radius: 5px; border: 2px solid #FDD017; padding: 3px 3px 3px 3px} /* bright gold border and harvest gold background*/
 label.WarningMessage { background-color: #FF9494; padding: 3px 3px 3px 3px; }
 label.ResultsWithoutError { color: inherit; background-color: #8F8; } /* green */
 label.ResultsWithError { color: #FF9494; background-color: inherit; } /* error red, from http://www.colourlovers.com/color/FF9494/error_red*/

lib/WeBWorK/ContentGenerator.pm

@@ -1563,6 +1563,14 @@ method. The simplest way to to this is:
 sub optionsMacro {
 	my ($self, %options) = @_;
 	my $r = $self->r;
+    my %showMeAnother;
+    my $problemSeed;
+
+    # check if showMeAnother is defined
+    if($self->{showMeAnother}){
+        %showMeAnother = %{ $self->{showMeAnother} };
+        $problemSeed = $self->{problem}->{problem_seed};
+    }
 
 	my @options_to_show = @{$options{options_to_show}} if exists $options{options_to_show};
 	@options_to_show = "displayMode" unless @options_to_show;  #FIXME -- I don't understant this -- type seems wrong
@@ -1629,6 +1637,16 @@ sub optionsMacro {
 		$result .= CGI::br();
 	}
 
+    # hidden field for clicking Preview Answers and Check Answers from a Show Me Another screen
+    # it needs to send the seed from showMeAnother back to the screen
+    if($showMeAnother{active} or $showMeAnother{CheckAnswers} or $showMeAnother{Preview}){
+	  	$result .= CGI::hidden({name => "showMeAnotherCheckAnswers", id=>"showMeAnotherCheckAnswers_id", value => 1});
+        # output the problem seed from ShowMeAnother so that it can be recycled in the refreshed screen
+        $result .= CGI::hidden({name => "problemSeed", value  =>  $problemSeed});
+        # tell showMeAnother that a display change has been made
+        $result .= CGI::hidden({name => "SMAdisplayChange", value  =>  1});
+    }
+
 	$result .= CGI::submit(-name=>"redisplay", -label=>$r->maketext("Apply Options"));
 	$result .= CGI::end_div();
 	$result .= CGI::end_form();

lib/WeBWorK/ContentGenerator/Instructor.pm

@@ -520,6 +520,9 @@ sub addProblemToSet {
 	my $db = $self->r->db;
 	my $value_default = $self->{ce}->{problemDefaults}->{value};
 	my $max_attempts_default = $self->{ce}->{problemDefaults}->{max_attempts};	
+	my $showMeAnother_default = $self->{ce}->{problemDefaults}->{showMeAnother};	
+    # showMeAnotherCount is the number of times that showMeAnother has been clicked; initially 0
+	my $showMeAnotherCount = 0;	
 
 
 	die "addProblemToSet called without specifying the set name." if $args{setName} eq "";
@@ -535,6 +538,7 @@ sub addProblemToSet {
 	if (defined($args{value})){$value = $args{value};}  # 0 is a valid value for $args{value}  
 
 	my $maxAttempts = $args{maxAttempts} || $max_attempts_default;
+	my $showMeAnother = $args{showMeAnother} || $showMeAnother_default;
 	my $problemID = $args{problemID};
 
 	unless ($problemID) {
@@ -547,6 +551,8 @@ sub addProblemToSet {
 	$problemRecord->source_file($sourceFile);
 	$problemRecord->value($value);
 	$problemRecord->max_attempts($maxAttempts);
+	$problemRecord->showMeAnother($showMeAnother);
+	$problemRecord->{showMeAnotherCount}=$showMeAnotherCount;
 	$db->addGlobalProblem($problemRecord);
 
 	return $problemRecord;

lib/WeBWorK/ContentGenerator/Instructor/ProblemSetDetail.pm

@@ -40,12 +40,12 @@ use WeBWorK::Utils::DatePickerScripts;
 
 # these constants determine which fields belong to what type of record
 use constant SET_FIELDS => [qw(set_header hardcopy_header open_date due_date answer_date visible description enable_reduced_scoring reduced_scoring_date restricted_release restricted_status restrict_ip relax_restrict_ip assignment_type attempts_per_version version_time_limit time_limit_cap versions_per_interval time_interval problem_randorder problems_per_page hide_score:hide_score_by_problem hide_work hide_hint)];
-use constant PROBLEM_FIELDS =>[qw(source_file value max_attempts)];
+use constant PROBLEM_FIELDS =>[qw(source_file value max_attempts showMeAnother)];
 use constant USER_PROBLEM_FIELDS => [qw(problem_seed status num_correct num_incorrect)];
 
 # these constants determine what order those fields should be displayed in
 use constant HEADER_ORDER => [qw(set_header hardcopy_header)];
-use constant PROBLEM_FIELD_ORDER => [qw(problem_seed status value max_attempts attempted last_answer num_correct num_incorrect)];
+use constant PROBLEM_FIELD_ORDER => [qw(problem_seed status value max_attempts showMeAnother attempted last_answer num_correct num_incorrect)];
 # for gateway sets, we don't want to allow users to change max_attempts on a per
 #    problem basis, as that's nothing but confusing.
 use constant GATEWAY_PROBLEM_FIELD_ORDER => [qw(problem_seed status value attempted last_answer num_correct num_incorrect)];
@@ -326,6 +326,16 @@ use constant FIELD_PROPERTIES => {
 				"-1" => "unlimited",
 		},
 	},
+        showMeAnother => {
+                name => "Show me another",
+                type => "edit",
+                size => "6",
+		override  => "any",
+                default=>"-1",
+		labels    => {
+				"-1" => "Never",
+		},
+        },
 	problem_seed => {
 		name      => "Seed",
 		type      => "edit",
@@ -428,6 +438,7 @@ sub FieldTable {
 		($gwFields, $ipFields, $numLocations, $procFields) = $self->extraSetFields($userID, $setID, $globalRecord, $userRecord, $forUsers);
 	}
 
+
        	my $output = CGI::start_table({border => 0, cellpadding => 1});
 	if ($forUsers) {
 		$output .= CGI::Tr({},
@@ -477,6 +488,10 @@ sub FieldTable {
 		next if ( $field eq 'problem_seed'  &&
 			  ( $isGWset && $forUsers && ! $setVersion ) );
 
+                # skip the Show Me Another value if SMA is not enabled
+	        next if ( $field eq 'showMeAnother' &&
+                          !$ce->{pg}->{options}->{enableShowMeAnother} );
+
 		unless ($properties{type} eq "hidden") {
 			$output .= CGI::Tr({}, CGI::td({}, [$self->FieldHTML($userID, $setID, $problemID, $globalRecord, $userRecord, $field)])) . "\n";
 		}

lib/WeBWorK/ContentGenerator/Instructor/ProblemSetList.pm

@@ -1731,7 +1731,8 @@ sub importSetsFromDef {
 			  sourceFile => $rh_problem->{source_file},
 			  problemID => $freeProblemID++,
 			  value => $rh_problem->{value},
-			  maxAttempts => $rh_problem->{max_attempts});
+			  maxAttempts => $rh_problem->{max_attempts},
+			  showMeAnother => $rh_problem->{showMeAnother});
 		}
 
 
@@ -1753,6 +1754,7 @@ sub readSetDef {
 	my $filePath      = "$templateDir/$fileName";
 	my $value_default = $self->{ce}->{problemDefaults}->{value};
 	my $max_attempts_default = $self->{ce}->{problemDefaults}->{max_attempts};
+	my $showMeAnother = $self->{ce}->{problemDefaults}->{showMeAnother};
 
 	my $setName = '';
 
@@ -1937,7 +1939,13 @@ sub readSetDef {
 			## anything left?
 			push(@line, $curr) if ( $curr );
 
-			($name, $value, $attemptLimit, $continueFlag) = @line;
+            # read the line and only look for $showMeAnother if it has the correct number of entries
+            # otherwise the default value will be used
+            if(scalar(@line)==4){
+			    ($name, $value, $attemptLimit, $showMeAnother, $continueFlag) = @line;
+            } else {
+			    ($name, $value, $attemptLimit, $continueFlag) = @line;
+            }
 			#####################
 			#  clean up problem values
 			###########################
@@ -1953,6 +1961,7 @@ sub readSetDef {
 			push(@problemData, {source_file    => $name,
 			                    value          =>  $value,
 			                    max_attempts   =>, $attemptLimit,
+			                    showMeAnother   =>, $showMeAnother,
 			                    continuation   => $continueFlag 
 			                    });
 		}
@@ -2033,12 +2042,14 @@ SET:	foreach my $set (keys %filenames) {
 			my $source_file   = $problemRecord->source_file();
 			my $value         = $problemRecord->value();
 			my $max_attempts  = $problemRecord->max_attempts();
+			my $showMeAnother  = $problemRecord->showMeAnother();
 
 			# backslash-escape commas in fields
 			$source_file =~ s/([,\\])/\\$1/g;
 			$value =~ s/([,\\])/\\$1/g;
 			$max_attempts =~ s/([,\\])/\\$1/g;
-			$problemList     .= "$source_file, $value, $max_attempts \n";
+			$showMeAnother =~ s/([,\\])/\\$1/g;
+			$problemList     .= "$source_file, $value, $max_attempts, $showMeAnother \n";
 		}
 
 		# gateway fields

lib/WeBWorK/ContentGenerator/Instructor/ProblemSetList2.pm

@@ -1849,7 +1849,8 @@ sub importSetsFromDef {
 			  sourceFile => $rh_problem->{source_file},
 			  problemID => $freeProblemID++,
 			  value => $rh_problem->{value},
-			  maxAttempts => $rh_problem->{max_attempts});
+			  maxAttempts => $rh_problem->{max_attempts},
+			  showMeAnother => $rh_problem->{showMeAnother});
 		}
 
 
@@ -1886,6 +1887,7 @@ sub readSetDef {
 	my $filePath      = "$templateDir/$fileName";
 	my $value_default = $self->{ce}->{problemDefaults}->{value};
 	my $max_attempts_default = $self->{ce}->{problemDefaults}->{max_attempts};
+	my $showMeAnother = $self->{ce}->{problemDefaults}->{showMeAnother};
 
 	my $setName = '';
 
@@ -2069,7 +2071,12 @@ sub readSetDef {
 			## anything left?
 			push(@line, $curr) if ( $curr );
 
-			($name, $value, $attemptLimit, $continueFlag) = @line;
+            # read the line and only look for $showMeAnother if it has the correct number of entries
+            if(scalar(@line)==4){
+			    ($name, $value, $attemptLimit, $showMeAnother, $continueFlag) = @line;
+            } else {
+			    ($name, $value, $attemptLimit, $continueFlag) = @line;
+            }
 			#####################
 			#  clean up problem values
 			###########################
@@ -2085,6 +2092,7 @@ sub readSetDef {
 			push(@problemData, {source_file    => $name,
 			                    value          =>  $value,
 			                    max_attempts   =>, $attemptLimit,
+			                    showMeAnother  =>, $showMeAnother,
 			                    continuation   => $continueFlag 
 			                    });
 		}
@@ -2171,12 +2179,20 @@ SET:	foreach my $set (keys %filenames) {
 			my $source_file   = $problemRecord->source_file();
 			my $value         = $problemRecord->value();
 			my $max_attempts  = $problemRecord->max_attempts();
+			my $showMeAnother  = $problemRecord->showMeAnother();
 
 			# backslash-escape commas in fields
 			$source_file =~ s/([,\\])/\\$1/g;
 			$value =~ s/([,\\])/\\$1/g;
 			$max_attempts =~ s/([,\\])/\\$1/g;
-			$problemList     .= "$source_file, $value, $max_attempts \n";
+			$showMeAnother =~ s/([,\\])/\\$1/g;
+
+            # only include showMeAnother if it has been enabled in the course configuration
+            if($ce->{pg}->{options}{enableShowMeAnother}){
+			    $problemList     .= "$source_file, $value, $max_attempts, $showMeAnother \n";
+            } else {
+			    $problemList     .= "$source_file, $value, $max_attempts \n";
+            }
 		}
 
 		# gateway fields