Change "Help" links to be more specific.

drgrice1 · Dec 11, 2024 · af515d5 · af515d5
1 parent fc43d68
commit af515d5
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 18 deletions.
diff --git a/lib/WeBWorK/ContentGenerator/Instructor/ProblemSetDetail.pm b/lib/WeBWorK/ContentGenerator/Instructor/ProblemSetDetail.pm
@@ -1000,7 +1000,7 @@ sub fieldHTML ($c, $userID, $setID, $problemID, $globalRecord, $userRecord, $fie
 			},
 			$c->c(
 				$c->tag('i',    class => 'icon fas fa-question-circle', 'aria-hidden' => 'true'),
-				$c->tag('span', class => 'visually-hidden',             $c->maketext('Help'))
+				$c->tag('span', class => 'visually-hidden',             $c->maketext('[_1] Help', $properties{name}))
 		)->join('')
 		)
 		: '';

diff --git a/templates/ContentGenerator/CourseAdmin/add_course_form.html.ep b/templates/ContentGenerator/CourseAdmin/add_course_form.html.ep
@@ -230,7 +230,9 @@
 						. 'inspect the new course configuration file and make adjustments for the new instructor.') =%>"
 					>
 					<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-					<span class="visually-hidden"><%= maketext('Help') =%></span>
+					<span class="visually-hidden">
+						<%= maketext('Notes regarding copying the course configuration file') =%>
+					</span>
 				</a>
 			</label>
 		</div>

diff --git a/templates/ContentGenerator/Grades/student_stats.html.ep b/templates/ContentGenerator/Grades/student_stats.html.ep
@@ -17,7 +17,7 @@
 						. 'has not been attempted. The bottom number is the number of incorrect attempts.'
 					) =%>">
 					<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-					<span class="visually-hidden"><%= maketext('Help') %></span>
+					<span class="visually-hidden"><%= maketext('Problem Score Help') %></span>
 				</a>
 			</th>
 		</tr>

diff --git a/templates/ContentGenerator/Instructor/PGProblemEditor/format_code_form.html.ep b/templates/ContentGenerator/Instructor/PGProblemEditor/format_code_form.html.ep
@@ -11,7 +11,7 @@
 			. 'the functionality of the code and in general is desired to have a common problem layout.') =%>"
 			data-bs-placement="top" data-bs-toggle="popover" role="button">
 			<i aria-hidden="true" class="fas fa-question-circle"></i>
-			<span class="visually-hidden"><%= maketext('Help Icon') %></span>
+			<span class="visually-hidden"><%= maketext('Perltidy Help') %></span>
 		</a>
 	</div>
 	<div class="form-check">
@@ -27,7 +27,7 @@
 			. 'which may not be converted correctly.') =%>"
 		data-bs-placement="top" data-bs-toggle="popover" role="button">
 			<i aria-hidden="true" class="fas fa-question-circle"></i>
-			<span class="visually-hidden"><%= maketext('Help Icon') %></span>
+			<span class="visually-hidden"><%= maketext('PGML Conversion Help') %></span>
 		</a>
 	</div>
 </div>
diff --git a/templates/ContentGenerator/Instructor/PGProblemEditor/hardcopy_form.html.ep b/templates/ContentGenerator/Instructor/PGProblemEditor/hardcopy_form.html.ep
@@ -33,7 +33,7 @@
 				tabindex => 0,
 				begin =%>
 				<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-				<span class="visually-hidden"><%= maketext('Help') =%></span>
+				<span class="visually-hidden"><%= maketext('Hardcopy Format Help') =%></span>
 			<% end =%>
 		<% end =%>
 		<div class="col-auto">

diff --git a/...ontentGenerator/Instructor/ProblemSetDetail/restricted_login_proctor_password_row.html.ep b/...ontentGenerator/Instructor/ProblemSetDetail/restricted_login_proctor_password_row.html.ep
@@ -20,7 +20,7 @@
 					. 'their username and password on the student\'s screen for authentication.'
 			) =%>">
 			<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-			<span class="visually-hidden"><%= maketext('Help') =%></span>
+			<span class="visually-hidden"><%= maketext('Proctor Password Help') =%></span>
 		</a>
 	</td>
 	<td>

diff --git a/templates/ContentGenerator/Instructor/Stats/problem_stats.html.ep b/templates/ContentGenerator/Instructor/Stats/problem_stats.html.ep
@@ -58,7 +58,7 @@
 						'Success index is the square of the average score divided by the average number of attempts.'
 					) %>">
 					<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-					<span class="visually-hidden"><%= maketext('Help') =%></span>
+					<span class="visually-hidden"><%= maketext('Success Index Help') =%></span>
 				</a>
 			</th>
 			<td><%= sprintf('%0.1f', 100 * $successIndex) %></td>
@@ -88,7 +88,7 @@
 		data-bs-content="<%=
 			maketext('Success index is the square of the score divided by the number of attempts.') =%>">
 		<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-		<span class="visually-hidden"><%= maketext('Help') =%></span>
+		<span class="visually-hidden"><%= maketext('Success Index Help') =%></span>
 	</a>
 % end
 % push @tableHeaders, $successIndexHeader->();

diff --git a/templates/ContentGenerator/Instructor/Stats/set_stats.html.ep b/templates/ContentGenerator/Instructor/Stats/set_stats.html.ep
@@ -20,7 +20,7 @@
 							. 'Indvidual students may have different settings.'
 					) %>">
 					<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-					<span class="visually-hidden"><%= maketext('Help') =%></span>
+					<span class="visually-hidden"><%= maketext('Set Status Help') =%></span>
 				</a>
 			</th>
 			<td>
@@ -49,7 +49,7 @@
 								. 'template answer date has passed.  See Set Detail page for actual availability.'
 						) =%>">
 						<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-						<span class="visually-hidden"><%= maketext('Help') =%></span>
+						<span class="visually-hidden"><%= maketext('Answer Availability Help') =%></span>
 					</a>
 				% }
 			</td>
@@ -108,7 +108,7 @@
 		data-bs-content="<%= maketext(
 			'Success index is the square of the average score divided by the average number of attempts.') %>">
 		<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-		<span class="visually-hidden"><%= maketext('Help') =%></span>
+		<span class="visually-hidden"><%= maketext('Success Index Help') =%></span>
 	</a>
 % end
 %

diff --git a/templates/ContentGenerator/Instructor/StudentProgress/set_progress.html.ep b/templates/ContentGenerator/Instructor/StudentProgress/set_progress.html.ep
@@ -197,7 +197,7 @@
 								. 'has not been attempted. The bottom number is the number of incorrect attempts.'
 							) =%>">
 							<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-							<span class="visually-hidden"><%= maketext('Help') =%></span>
+							<span class="visually-hidden"><%= maketext('Problem Score Help') =%></span>
 						</a>
 					</th>
 				% }

diff --git a/templates/ContentGenerator/Instructor/UserDetail/set_date_table.html.ep b/templates/ContentGenerator/Instructor/UserDetail/set_date_table.html.ep
@@ -20,7 +20,7 @@
 							'If the test was timed, granting the user an additional version '
 							. 'may be preferred to changing its dates.' )%>">
 						<i class="icon fa-solid fa-question-circle fa-lg" aria-hidden="true"></i><% =%>\
-						<span class="visually-hidden"><%= maketext('Help Icon') %></span><% =%>\
+						<span class="visually-hidden"><%= maketext('Advice on changing test dates') %></span><% =%>\
 					</a>
 				% }
 				<%= $isVersioned ? maketext(q{User's Test Version Dates}) : maketext('User Overrides') =%>

diff --git a/templates/ContentGenerator/ProblemSet/problem_list.html.ep b/templates/ContentGenerator/ProblemSet/problem_list.html.ep
@@ -30,7 +30,7 @@
 								},
 								begin =%>
 								<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-								<span class="visually-hidden"><%= maketext('Help') =%></span>
+								<span class="visually-hidden"><%= maketext('Adjusted Status Help') =%></span>
 							<% end =%>
 						</th>
 						<th><%= maketext('Counts for Parent') %></th>

diff --git a/templates/HTML/SingleProblemGrader/grader.html.ep b/templates/HTML/SingleProblemGrader/grader.html.ep
@@ -49,7 +49,7 @@
 							},
 							begin =%>
 							<i class="icon fas fa-question-circle" aria-hidden="true"></i>
-							<span class="visually-hidden"><%= maketext('Help') =%></span>
+							<span class="visually-hidden"><%= maketext('Answer Score Help') =%></span>
 						<% end =%>
 					<% end =%>
 					<div class="col-sm">
@@ -150,7 +150,7 @@
 						},
 						begin =%>
 						<i class="fas fa-question-circle" aria-hidden="true"></i>
-						<span class="visually-hidden"><%= maketext('Help Icon') %></span>
+						<span class="visually-hidden"><%= maketext('Point Value Help') %></span>
 					<% end =%>
 				<% end =%>
 				<div class="col-sm">
@@ -220,7 +220,7 @@
 						},
 						begin =%>
 						<i class="fas fa-question-circle" aria-hidden="true"></i>
-						<span class="visually-hidden"><%= maketext('Help Icon') %></span>
+						<span class="visually-hidden"><%= maketext('Problem Score Help') %></span>
 					<% end =%>
 				<% end =%>
 				<div class="col-sm">