Add a "Show Correct Answers" button to the problem and test pages.

When this button is used correct answers will be shown with no other content in the feedback popover, scaffolds will all be open, and the feedback popovers will open immediately on page load. This is an instructor only option for now. I don't think this will be a good idea to enable for students. Furthermore, the "Show Correct Answers" buttons on other instructor pages (pg problem editor, problem library, set detail page, statistics, and manual problem grader) now use this for showing correct answers. This works well for most problems, but there are some cases where answers are tightly grouped particularly when there are on the same line that the popovers can overlap in not the best way. This is one potential resolution of openwebwork/pg#1047.
openwebwork · Apr 30, 2024 · 9078c81 · 9078c81
1 parent 96d947c
commit 9078c81
Show file tree

Hide file tree

Showing 10 changed files with 156 additions and 102 deletions.
diff --git a/htdocs/js/PGProblemEditor/pgproblemeditor.js b/htdocs/js/PGProblemEditor/pgproblemeditor.js
@@ -413,7 +413,8 @@
 					processAnswers: 0,
 					showPreviewButton: isProblem,
 					showCheckAnswersButton: isProblem,
-					showCorrectAnswersButton: isProblem,
+					showCorrectAnswersButton: 0,
+					showCorrectAnswersOnlyButton: isProblem,
 					showFooter: 0,
 					displayMode: document.getElementById('action_view_displayMode_id')?.value ?? 'MathJax',
 					language: document.querySelector('input[name="hidden_language"]')?.value ?? 'en',

diff --git a/htdocs/js/RenderProblem/renderproblem.js b/htdocs/js/RenderProblem/renderproblem.js
@@ -20,6 +20,7 @@
 				showAnswerNumbers: 0,
 				showHints: 1,
 				showSolutions: 1,
+				showCorrectAnswersOnlyButton: 1,
 				isInstructor: 1,
 				forceScaffoldsOpen: 1,
 				noprepostambles: 1,

diff --git a/lib/FormatRenderedProblem.pm b/lib/FormatRenderedProblem.pm
@@ -235,51 +235,52 @@ sub formatRenderedProblem {
 	my %template_params = (
 		template => $formatName eq 'ptx' ? 'RPCRenderFormats/ptx' : 'RPCRenderFormats/default',
 		$formatName eq 'json' ? (format => 'json') : (),
-		formatName               => $formatName,
-		ws                       => $ws,
-		ce                       => $ce,
-		lh                       => $lh,
-		rh_result                => $rh_result,
-		SITE_URL                 => $SITE_URL,
-		FORM_ACTION_URL          => $SITE_URL . $ws->c->webwork_url . '/' . $ws->c->current_route,
-		COURSE_LANG_AND_DIR      => get_lang_and_dir($formLanguage),
-		theme                    => $ws->{inputs_ref}{theme} || $ce->{defaultTheme},
-		courseID                 => $ws->{inputs_ref}{courseID}       // '',
-		user                     => $ws->{inputs_ref}{user}           // '',
-		passwd                   => $ws->{inputs_ref}{passwd}         // '',
-		disableCookies           => $ws->{inputs_ref}{disableCookies} // '',
-		key                      => $ws->authen->{session_key},
-		PROBLEM_LANG_AND_DIR     => $PROBLEM_LANG_AND_DIR,
-		problemSeed              => $rh_result->{problem_seed} // $ws->{inputs_ref}{problemSeed} // 6666,
-		psvn                     => $rh_result->{psvn}         // $ws->{inputs_ref}{psvn}        // 54321,
-		problemUUID              => $problemUUID,
-		displayMode              => $displayMode,
-		third_party_css          => \@third_party_css,
-		extra_css_files          => \@extra_css_files,
-		third_party_js           => \@third_party_js,
-		extra_js_files           => \@extra_js_files,
-		problemText              => $problemText,
-		extra_header_text        => $ws->{inputs_ref}{extra_header_text} // '',
-		resultSummary            => $resultSummary,
-		showScoreSummary         => $submitMode && !$renderErrorOccurred && $problemResult,
-		answerhashXML            => $answerhashXML,
-		LTIGradeMessage          => $LTIGradeMessage,
-		sourceFilePath           => $ws->{inputs_ref}{sourceFilePath}          // '',
-		problemSource            => $ws->{inputs_ref}{problemSource}           // '',
-		rawProblemSource         => $ws->{inputs_ref}{rawProblemSource}        // '',
-		uriEncodedProblemSource  => $ws->{inputs_ref}{uriEncodedProblemSource} // '',
-		fileName                 => $ws->{inputs_ref}{fileName}                // '',
-		formLanguage             => $formLanguage,
-		isInstructor             => $ws->{inputs_ref}{isInstructor}       // '',
-		forceScaffoldsOpen       => $ws->{inputs_ref}{forceScaffoldsOpen} // '',
-		showSummary              => $showSummary,
-		showHints                => $ws->{inputs_ref}{showHints}                // '',
-		showSolutions            => $ws->{inputs_ref}{showSolutions}            // '',
-		showPreviewButton        => $ws->{inputs_ref}{showPreviewButton}        // '',
-		showCheckAnswersButton   => $ws->{inputs_ref}{showCheckAnswersButton}   // '',
-		showCorrectAnswersButton => $ws->{inputs_ref}{showCorrectAnswersButton} // '',
-		showFooter               => $ws->{inputs_ref}{showFooter}               // '',
-		pretty_print             => \&pretty_print
+		formatName                   => $formatName,
+		ws                           => $ws,
+		ce                           => $ce,
+		lh                           => $lh,
+		rh_result                    => $rh_result,
+		SITE_URL                     => $SITE_URL,
+		FORM_ACTION_URL              => $SITE_URL . $ws->c->webwork_url . '/' . $ws->c->current_route,
+		COURSE_LANG_AND_DIR          => get_lang_and_dir($formLanguage),
+		theme                        => $ws->{inputs_ref}{theme} || $ce->{defaultTheme},
+		courseID                     => $ws->{inputs_ref}{courseID}       // '',
+		user                         => $ws->{inputs_ref}{user}           // '',
+		passwd                       => $ws->{inputs_ref}{passwd}         // '',
+		disableCookies               => $ws->{inputs_ref}{disableCookies} // '',
+		key                          => $ws->authen->{session_key},
+		PROBLEM_LANG_AND_DIR         => $PROBLEM_LANG_AND_DIR,
+		problemSeed                  => $rh_result->{problem_seed} // $ws->{inputs_ref}{problemSeed} // 6666,
+		psvn                         => $rh_result->{psvn}         // $ws->{inputs_ref}{psvn}        // 54321,
+		problemUUID                  => $problemUUID,
+		displayMode                  => $displayMode,
+		third_party_css              => \@third_party_css,
+		extra_css_files              => \@extra_css_files,
+		third_party_js               => \@third_party_js,
+		extra_js_files               => \@extra_js_files,
+		problemText                  => $problemText,
+		extra_header_text            => $ws->{inputs_ref}{extra_header_text} // '',
+		resultSummary                => $resultSummary,
+		showScoreSummary             => $submitMode && !$renderErrorOccurred && $problemResult,
+		answerhashXML                => $answerhashXML,
+		LTIGradeMessage              => $LTIGradeMessage,
+		sourceFilePath               => $ws->{inputs_ref}{sourceFilePath}          // '',
+		problemSource                => $ws->{inputs_ref}{problemSource}           // '',
+		rawProblemSource             => $ws->{inputs_ref}{rawProblemSource}        // '',
+		uriEncodedProblemSource      => $ws->{inputs_ref}{uriEncodedProblemSource} // '',
+		fileName                     => $ws->{inputs_ref}{fileName}                // '',
+		formLanguage                 => $formLanguage,
+		isInstructor                 => $ws->{inputs_ref}{isInstructor}       // '',
+		forceScaffoldsOpen           => $ws->{inputs_ref}{forceScaffoldsOpen} // '',
+		showSummary                  => $showSummary,
+		showHints                    => $ws->{inputs_ref}{showHints}                    // '',
+		showSolutions                => $ws->{inputs_ref}{showSolutions}                // '',
+		showPreviewButton            => $ws->{inputs_ref}{showPreviewButton}            // '',
+		showCheckAnswersButton       => $ws->{inputs_ref}{showCheckAnswersButton}       // '',
+		showCorrectAnswersButton     => $ws->{inputs_ref}{showCorrectAnswersButton}     // '',
+		showCorrectAnswersOnlyButton => $ws->{inputs_ref}{showCorrectAnswersOnlyButton} // 0,
+		showFooter                   => $ws->{inputs_ref}{showFooter}                   // '',
+		pretty_print                 => \&pretty_print
 	);
 
 	return $ws->c->render(%template_params) if $formatName eq 'json' || !$ws->{inputs_ref}{send_pg_flags};

diff --git a/lib/WeBWorK/ContentGenerator/GatewayQuiz.pm b/lib/WeBWorK/ContentGenerator/GatewayQuiz.pm
@@ -1443,6 +1443,8 @@ async sub getProblemHTML ($c, $effectiveUser, $set, $formFields, $mergedProblem)
 		&& $c->{can}{showProblemScores}
 		&& $mergedProblem->num_correct + $mergedProblem->num_incorrect > 0;
 
+	my $showOnlyCorrectAnswers = $c->param('showCorrectAnswers') && $c->{will}{showCorrectAnswers};
+
 	my $pg = await renderPG(
 		$c,
 		$effectiveUser,
@@ -1465,14 +1467,15 @@ async sub getProblemHTML ($c, $effectiveUser, $set, $formFields, $mergedProblem)
 				|| $c->{previewAnswers}
 				|| $c->{will}{checkAnswers}
 				|| $showReturningFeedback,
-			showAttemptAnswers      => $c->ce->{pg}{options}{showEvaluatedAnswers},
-			showAttemptPreviews     => 1,
-			showAttemptResults      => !$c->{previewAnswers} && $c->{can}{showProblemScores},
-			forceShowAttemptResults => $c->{will}{showProblemGrader}
+			showAttemptAnswers  => $showOnlyCorrectAnswers ? 0 : $c->ce->{pg}{options}{showEvaluatedAnswers},
+			showAttemptPreviews => !$showOnlyCorrectAnswers,
+			showAttemptResults  => !$showOnlyCorrectAnswers && !$c->{previewAnswers} && $c->{can}{showProblemScores},
+			forceShowAttemptResults => $showOnlyCorrectAnswers
+				|| $c->{will}{showProblemGrader}
 				|| ($c->ce->{pg}{options}{automaticAnswerFeedback}
 					&& !$c->{previewAnswers}
 					&& $c->can_showCorrectAnswersForAll($set, $c->{problem}, $c->{tmplSet})),
-			showMessages       => 1,
+			showMessages       => !$showOnlyCorrectAnswers,
 			showCorrectAnswers => (
 				$c->{will}{showProblemGrader} ? 2
 				: !$c->{previewAnswers} && $c->can_showCorrectAnswersForAll($set, $c->{problem}, $c->{tmplSet})

diff --git a/lib/WeBWorK/ContentGenerator/Problem.pm b/lib/WeBWorK/ContentGenerator/Problem.pm
@@ -560,6 +560,8 @@ async sub pre_header_initialize ($c) {
 		}
 	}
 
+	my $showOnlyCorrectAnswers = $c->param('showCorrectAnswers') && $will{showCorrectAnswers};
+
 	# Translation
 	debug('begin pg processing');
 	my $pg = await renderPG(
@@ -580,18 +582,19 @@ async sub pre_header_initialize ($c) {
 			effectivePermissionLevel => $db->getPermissionLevel($effectiveUserID)->permission,
 			useMathQuill             => $will{useMathQuill},
 			useMathView              => $will{useMathView},
-			forceScaffoldsOpen       => 0,
+			forceScaffoldsOpen       => $showOnlyCorrectAnswers,
 			isInstructor             => $authz->hasPermissions($userID, 'view_answers'),
 			showFeedback             => $c->{submitAnswers} || $c->{previewAnswers} || $showReturningFeedback,
-			showAttemptAnswers       => $ce->{pg}{options}{showEvaluatedAnswers},
-			showAttemptPreviews      => 1,
+			showAttemptAnswers       => $showOnlyCorrectAnswers ? 0 : $ce->{pg}{options}{showEvaluatedAnswers},
+			showAttemptPreviews      => !$showOnlyCorrectAnswers,
 			showAttemptResults       => $c->{submitAnswers} || $showReturningFeedback,
-			forceShowAttemptResults  => $will{checkAnswers}
+			forceShowAttemptResults  => $showOnlyCorrectAnswers
+				|| $will{checkAnswers}
 				|| $will{showProblemGrader}
 				|| ($ce->{pg}{options}{automaticAnswerFeedback}
 					&& !$c->{previewAnswers}
 					&& after($c->{set}->answer_date, $c->submitTime)),
-			showMessages       => 1,
+			showMessages       => !$showOnlyCorrectAnswers,
 			showCorrectAnswers => (
 				$will{showProblemGrader} || ($c->{submitAnswers} && $c->{showCorrectOnRandomize}) ? 2
 				: !$c->{previewAnswers} && after($c->{set}->answer_date, $c->submitTime)
@@ -1461,6 +1464,15 @@ sub output_summary ($c) {
 			),
 			$c->attemptResults($pg)
 		);
+	} elsif ($c->param('showCorrectAnswers') && $will{showCorrectAnswers}) {
+		push(
+			@$output,
+			$c->tag(
+				'div',
+				class => 'alert alert-danger d-inline-block mb-2 p-1',
+				$c->maketext('CORRECT ANSWERS SHOWN ONLY -- ANSWERS NOT RECORDED')
+			),
+		);
 	} elsif ($c->{previewAnswers}) {
 		push(
 			@$output,

diff --git a/lib/WeBWorK/ContentGenerator/ShowMeAnother.pm b/lib/WeBWorK/ContentGenerator/ShowMeAnother.pm
@@ -61,7 +61,8 @@ async sub pre_header_initialize ($c) {
 	#                  checked or previewed.
 
 	my $initializeSMA = !$c->authen->session->{showMeAnother}
-		|| ($c->authen->session->{showMeAnother} && !($c->{checkAnswers} || $c->{previewAnswers}));
+		|| ($c->authen->session->{showMeAnother}
+			&& !($c->{checkAnswers} || $c->{previewAnswers} || $c->param('showCorrectAnswers')));
 
 	# This will be set to true if changing the seed changes the problem (assume this is NOT the case by default).
 	$c->stash->{isPossible} = 0;
@@ -161,7 +162,7 @@ async sub pre_header_initialize ($c) {
 				delete $c->authen->session->{showMeAnother};
 			}
 		}
-	} elsif ($c->{checkAnswers} || $c->{previewAnswers}) {
+	} elsif ($c->{checkAnswers} || $c->{previewAnswers} || $c->param('showCorrectAnswers')) {
 		$c->stash->{isPossible} = 1;
 		$c->{problem}->problem_seed($c->authen->session->{showMeAnother}{problemSeed});
 	} else {
@@ -189,6 +190,8 @@ async sub pre_header_initialize ($c) {
 
 	return unless $c->stash->{isPossible};
 
+	my $showOnlyCorrectAnswers = $c->param('showCorrectAnswers') && $c->{will}{showCorrectAnswers};
+
 	# Final PG problem translation.
 	debug('begin pg processing');
 	my $pg = await renderPG(
@@ -208,15 +211,17 @@ async sub pre_header_initialize ($c) {
 			effectivePermissionLevel => $db->getPermissionLevel($c->{effectiveUserID})->permission,
 			useMathQuill             => $c->{will}{useMathQuill},
 			useMathView              => $c->{will}{useMathView},
-			forceScaffoldsOpen       => 0,
+			forceScaffoldsOpen       => $showOnlyCorrectAnswers,
 			isInstructor             => $c->authz->hasPermissions($c->{userID}, 'view_answers'),
 			showFeedback             => $c->{checkAnswers} || $c->{previewAnswers},
-			showAttemptAnswers       => $ce->{pg}{options}{showEvaluatedAnswers},
-			showAttemptPreviews      => 1,
+			showAttemptAnswers       => $showOnlyCorrectAnswers ? 0 : $ce->{pg}{options}{showEvaluatedAnswers},
+			showAttemptPreviews      => !$showOnlyCorrectAnswers,
 			showAttemptResults       => $c->{checkAnswers},
-			showMessages             => 1,
-			showCorrectAnswers       => $c->{will}{checkAnswers} && $c->{will}{showCorrectAnswers} ? 1 : 0,
-			debuggingOptions         => getTranslatorDebuggingOptions($c->authz, $c->{userID})
+			forceShowAttemptResults  => $showOnlyCorrectAnswers,
+			showMessages             => !$showOnlyCorrectAnswers,
+			showCorrectAnswers       => $showOnlyCorrectAnswers
+				|| ($c->{will}{checkAnswers} && $c->{will}{showCorrectAnswers}) ? 1 : 0,
+			debuggingOptions => getTranslatorDebuggingOptions($c->authz, $c->{userID})
 		}
 	);
 

diff --git a/lib/WebworkWebservice/RenderProblem.pm b/lib/WebworkWebservice/RenderProblem.pm
@@ -222,19 +222,31 @@ async sub renderProblem {
 		effectivePermissionLevel => $rh->{effectivePermissionLevel} || $rh->{permissionLevel} || 0,
 		useMathQuill             => $ce->{pg}{specialPGEnvironmentVars}{entryAssist} eq 'MathQuill',
 		useMathView              => $ce->{pg}{specialPGEnvironmentVars}{entryAssist} eq 'MathView',
-		isInstructor             => $rh->{isInstructor}       // 0,
-		forceScaffoldsOpen       => $rh->{forceScaffoldsOpen} // 0,
+		isInstructor             => $rh->{isInstructor} // 0,
+		forceScaffoldsOpen       => $rh->{WWcorrectAnsOnly} ? 1 : ($rh->{forceScaffoldsOpen} // 0),
 		QUIZ_PREFIX              => $rh->{answerPrefix},
 		showFeedback             => $rh->{previewAnswers} || $rh->{WWsubmit} || $rh->{WWcorrectAns},
-		showAttemptAnswers       => $rh->{showAttemptAnswers} // 1,
-		showAttemptPreviews      => $rh->{showAttemptPreviews}
-			// ($rh->{previewAnswers} || $rh->{WWsubmit} || $rh->{WWcorrectAns}),
+		showAttemptAnswers       => $rh->{WWcorrectAnsOnly} ? 0 : ($rh->{showAttemptAnswers} // 1),
+		showAttemptPreviews      => (
+			$rh->{WWcorrectAnsOnly} ? 0
+			: ($rh->{showAttemptPreviews} // ($rh->{previewAnswers} || $rh->{WWsubmit} || $rh->{WWcorrectAns}))
+		),
 		showAttemptResults      => $rh->{showAttemptResults} // ($rh->{WWsubmit} || $rh->{WWcorrectAns}),
-		forceShowAttemptResults => $rh->{forceShowAttemptResults} || ($rh->{isInstructor}
-			&& ($rh->{showAttemptResults} // ($rh->{WWsubmit} || $rh->{WWcorrectAns}))),
-		showMessages       => $rh->{showMessages} // ($rh->{previewAsnwers} || $rh->{WWsubmit} || $rh->{WWcorrectAns}),
-		showCorrectAnswers => $rh->{showCorrectAnswers} // ($rh->{WWcorrectAns} ? 2 : 0),
-		debuggingOptions   => {
+		forceShowAttemptResults => (
+			$rh->{WWcorrectAnsOnly} ? 1
+			: (
+				$rh->{forceShowAttemptResults}
+					|| ($rh->{isInstructor}
+						&& ($rh->{showAttemptResults} // ($rh->{WWsubmit} || $rh->{WWcorrectAns})))
+			)
+		),
+		showMessages => (
+			$rh->{WWcorrectAnsOnly} ? 0
+			: ($rh->{showMessages} // ($rh->{previewAsnwers} || $rh->{WWsubmit} || $rh->{WWcorrectAns}))
+		),
+		showCorrectAnswers =>
+			($rh->{WWcorrectAnsOnly} ? 1 : ($rh->{showCorrectAnswers} // ($rh->{WWcorrectAns} ? 2 : 0))),
+		debuggingOptions => {
 			show_resource_info          => $rh->{show_resource_info}          // 0,
 			view_problem_debugging_info => $rh->{view_problem_debugging_info} // 0,
 			show_pg_info                => $rh->{show_pg_info}                // 0,

diff --git a/templates/ContentGenerator/GatewayQuiz.html.ep b/templates/ContentGenerator/GatewayQuiz.html.ep
@@ -499,11 +499,15 @@
 				%
 				% if ($c->{submitAnswers}) {
 					% if ($c->{scoreRecordedMessage}[ $probOrder->[$i] ] ne 'recorded') {
-						% $recordMessage = tag('div', class => 'alert alert-dangeer d-inline-block mb-2 p-1',
+						% $recordMessage = tag('div', class => 'alert alert-danger d-inline-block mb-2 p-1',
 							% maketext('ANSWERS NOT RECORDED -- [_1]', $c->{scoreRecordedMessage}[ $probOrder->[$i] ])
 						% );
 					% }
 					% $resultsTable = $c->attemptResults($pg);
+				% } elsif (param('showCorrectAnswers') && $c->{will}{showCorrectAnswers}) {
+					% $recordMessage = tag('div', class => 'alert alert-danger d-inline-block mb-2 p-1',
+						% maketext('CORRECT ANSWERS SHOWN ONLY -- ANSWERS NOT RECORDED')
+					% );
 				% } elsif ($c->{will}{checkAnswers} || $c->{will}{showProblemGrader}) {
 					% $recordMessage = tag('div', class => 'alert alert-danger d-inline-block mb-2 p-1',
 						% maketext('ANSWERS ONLY CHECKED -- ANSWERS NOT RECORDED')
@@ -679,7 +683,11 @@
 		% }
 		%
 		% if ($c->{can}{showProblemGrader}) {
-			<div class="col-12 my-2">
+			<div class="submit-buttons-container col-12 my-2">
+				% if ($c->{can}{showCorrectAnswers}) {
+					<%= submit_button maketext('Show Correct Answers'), name => 'showCorrectAnswers',
+						class => 'btn btn-primary mb-1' =%>
+				% }
 				% if ($c->{will}{showProblemGrader}) {
 					<%= submit_button maketext('Hide Problem Graders'), name => 'hideProblemGrader',
 						class => 'btn btn-primary mb-1' =%>

diff --git a/templates/ContentGenerator/Problem/instructor_buttons.html.ep b/templates/ContentGenerator/Problem/instructor_buttons.html.ep
@@ -1,6 +1,10 @@
 % last unless $authz->hasPermissions(param('user'), 'access_instructor_tools');
 %
 <div class="submit-buttons-container col-12 my-2">
+	% if ($c->{can}{showCorrectAnswers}) {
+		<%= submit_button maketext('Show Correct Answers'), name => 'showCorrectAnswers',
+			class => 'btn btn-primary mb-1' =%>
+	% }
 	% if ($c->{can}{showProblemGrader} && !$c->{will}{showMeAnother}) {
 		% if ($c->{will}{showProblemGrader}) {
 			<%= submit_button maketext('Hide Problem Grader'), name => 'hideProblemGrader',