Instructions paragraph cleanup (#3941)

kfranqueiro · web-flow · commit 5ce33615d7b3 · 2024-09-13T07:15:34.000-07:00
Resolves #3918. There are multiple commits in this PR, each grouping a subset of removals: - Removals of entire `<p class="instructions">` paragraphs having no effect on output - Some of these contained boilerplate from the original techniques or understanding template; others had content redundant of information that the build system automatically generates. (There was one instance of the latter in `label-in-name.html` that did not even have `class="instructions"`, and was thus already causing repetition of auto-generated content.) - Previews: [ARIA24](https://deploy-preview-3941--wcag2.netlify.app/techniques/aria/aria24), [SCR39](https://deploy-preview-3941--wcag2.netlify.app/techniques/client-side-script/scr39), [F102](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f102), [F105](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f105), [G211](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g211), [G212](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g212), [G217](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g217), [G219](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g219), [2.3.3](https://deploy-preview-3941--wcag2.netlify.app/understanding/animation-from-interactions), [2.5.2](https://deploy-preview-3941--wcag2.netlify.app/understanding/pointer-cancellation), [2.5.3](https://deploy-preview-3941--wcag2.netlify.app/understanding/label-in-name), [2.5.5](https://deploy-preview-3941--wcag2.netlify.app/understanding/target-size-enhanced), - Removals of `class="instructions"` from paragraphs with custom content that should not have had this class; these were previously absent from build output but will now be present. - To be clear, this PR does not add any content that was not already previously authored and reviewed. - Previews: [C39](https://deploy-preview-3941--wcag2.netlify.app/techniques/css/c39), [F97](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f97), [G211](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g211), [G217](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g217), [G218](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g218), [G220](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g220), [H100](https://deploy-preview-3941--wcag2.netlify.app/techniques/html/h100) In cases where removal of these paragraphs clearly yielded an empty section, I have removed the entire section. (In some cases, these sections were already commented out.) This overlaps a bit with #3927; I have updated the log there to exclude what's already handled in this PR. **Note:** as part of this PR, I have removed `identify-changes.html` and `interruptions-minimum.html` from `understanding/21`, as both of these seemed to be unused and largely contained template boilerplate. These removals do not affect build output at all.
diff --git a/techniques/aria/ARIA24.html b/techniques/aria/ARIA24.html
@@ -15,11 +15,6 @@ <h2>Metadata</h2>
          <p id="type">advisory</p>
       </section>
 
-      <section id="applicability">
-         <h2>When to Use</h2>
-         <p class="instructions">This technique is applicable to Markup languages that support ARIA.</p>
-      </section>
-
       <section id="description">
 
          <h2>Description</h2>
diff --git a/techniques/client-side-script/SCR39.html b/techniques/client-side-script/SCR39.html
@@ -29,7 +29,6 @@ <h2>Description</h2>
   </section>
   <section id="examples">
     <h2>Examples</h2>
-    <p class="instructions"></p>
     <section class="example">
 		<h3>Content preview for links</h3>
 		<p>When hovering over or focusing on a link, a content preview for the link appears just above or below that link.
diff --git a/techniques/css/C39.html b/techniques/css/C39.html
@@ -17,7 +17,7 @@ <h2>Metadata</h2>
 
 <section id="applicability">
   <h2>When to Use</h2>
-  <p class="instructions">
+  <p>
     CSS which causes motion that is triggered by user interactions.
   </p>
 </section>
diff --git a/techniques/failures/F102.html b/techniques/failures/F102.html
@@ -8,7 +8,6 @@
 		<h1>Failure of Success Criterion 1.4.10 due to content disappearing and not being available when content has reflowed</h1>
 		<section id="meta">
 			<h2>Metadata</h2>
-			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.</p>
 			<p id="sc"><!-- SC to which this applies --></p>
 			<p id="type"><!-- sufficient, advisory, or failure --></p>
 		</section>
diff --git a/techniques/failures/F105.html b/techniques/failures/F105.html
@@ -8,7 +8,6 @@
 		<h1>Failure of Success Criterion 2.5.1 due to providing functionality via a path-based gesture without simple pointer alternative</h1>
 		<section id="meta">
 			<h2>Metadata</h2>
-			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.</p>
 			<p id="sc">Applies to 2.5.1 Pointer Gestures</p>
 			<p id="type">Failure Technique</p>
 		</section>
@@ -55,14 +54,5 @@ <h2>Related Techniques</h2>
       	<li><a href="../general/G216">Providing single point activation for a control slider</a></li>
 			</ul>
 		</section>
-		<!--
-		<section id="resources">
-			<h2>Resources</h2>
-			<p class="instructions">Provide links to external resources that are relevant to users of the technique. This section is optional.</p>
-			<ul>
-				<li>Link</li>
-			</ul>
-		</section>
-		-->
 	</body>
 </html>
diff --git a/techniques/failures/F97.html b/techniques/failures/F97.html
@@ -14,7 +14,7 @@ <h2>Metadata</h2>
 		</section>
 		<section id="applicability">
 			<h2>When to Use</h2>
-			<p class="instructions">All technologies that allow the viewing of content to be restricted to one orientation.</p>
+			<p>All technologies that allow the viewing of content to be restricted to one orientation.</p>
 		</section>
 		<section id="description">
 			<h2>Description</h2>
diff --git a/techniques/general/G211.html b/techniques/general/G211.html
@@ -14,11 +14,11 @@ <h2>Metadata</h2>
 		</section>
 		<section id="applicability">
 			<h2>When to Use</h2>
-			<p class="instructions">This technique applies to all web technologies that include interactive controls (such as links or form inputs).</p>
+			<p>This technique applies to all web technologies that include interactive controls (such as links or form inputs).</p>
 		</section>
 		<section id="description">
 			<h2>Description</h2>
-			<p class="instructions">The objective of this technique is to ensure that speech input users can operate web content reliably while not adversely affecting other users of assistive technology.</p>
+			<p>The objective of this technique is to ensure that speech input users can operate web content reliably while not adversely affecting other users of assistive technology.</p>
 			<p>When speech input users interact with a web page, they usually speak a command followed by the reference to some visible label (such as text beside an input field or inside a button or link). For example, they may say "click search" to activate a button labelled Search. When speech recognition software processes speech input and looks for matches, it uses the <a href="https://www.w3.org/TR/accname/"> accessible name</a> of controls. Where there is a mismatch between the text in the label and the text in the accessible name, it can cause issues for the user. The simplest way to enable speech input users and meet 2.5.3 Label in Name is to ensure that the accessible name matches the visible text label.</p>
 			<h3>Determining the appropriate label</h3>
 			<p>Sometimes more than one text string will be positioned in the vicinity of a control that could be considered a candidate for its label. For example, a set of inputs that each have their own labels may also be preceded by a heading, an instruction or a group label (such as an HTML legend/fieldset or an ARIA group or radiogroup). Note that the term "group label" means something different than "label", both programmatically and in regard to 2.5.3 Label in Name.</p>
@@ -207,18 +207,15 @@ <h3>Expected Results</h3>
 		</section>
 		<section id="related">
 			<h2>Related Techniques</h2>
-			<p class="instructions">Provide links to other techniques that users should consider. This section is optional.</p>
 			<ul>
 				<li><a href="../html/H44">H44: Using label elements to associate text labels with form controls</a></li>
 				<li><a href="../html/H71">H71: Providing a description for groups of form controls using fieldset and legend elements</a></li>
 				<li><a href="../html/H85">H85: Using OPTGROUP to group OPTION elements inside a SELECT</a></li>
-				<li><a href="../aria/ARIA17">ARIA17: Using grouping roles to identify related form controls</a> 
-				</li>
+				<li><a href="../aria/ARIA17">ARIA17: Using grouping roles to identify related form controls</a></li>
 			</ul>
 		</section>
 		<section id="resources">
 			<h2>Resources</h2>
-			<p class="instructions">Provide links to external resources that are relevant to users of the technique. This section is optional.</p>
 			<ul>
 				<li><a href="https://www.w3.org/TR/accname/">Accessible Name and Description Computation</a></li>
 				<li><a href="https://www.w3.org/TR/html-aam/#accessible-name-and-description-computation">Accessible Name and Description Computation in HTML Accessibility API Mappings 1.0</a></li>
diff --git a/techniques/general/G212.html b/techniques/general/G212.html
@@ -8,7 +8,6 @@
 		<h1>Using native controls to ensure  functionality is triggered on the up-event.</h1>
 		<section id="meta">
 			<h2>Metadata</h2>
-			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.</p>
 			<p id="sc">2.5.2 Pointer Cancellation<!-- SC to which this applies --></p>
 			<p id="type">Sufficient<!-- sufficient, advisory, or failure --></p>
 		</section>
diff --git a/techniques/general/G217.html b/techniques/general/G217.html
@@ -8,13 +8,12 @@
 		<h1>Providing a mechanism to allow users to remap or turn off character key shortcuts</h1>
 		<section id="meta">
 			<h2>Metadata</h2>
-			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.</p>
 			<p id="sc">2.1.4 Character Key Shortcuts</p>
 			<p id="type">Sufficient</p>
 		</section>
 		<section id="applicability">
 			<h2>Applicability</h2>
-			<p class="instructions">Any technology that supports scripting.</p>
+			<p>Any technology that supports scripting.</p>
 		</section>
 		<section id="description">
 			<h2>Description</h2>
@@ -53,19 +52,5 @@ <h3>Expected Results</h3>
 				</ul>
 			</section>
 		</section>
-		<section id="related">
-			<h2>Related Techniques</h2>
-			<p class="instructions">Provide links to other techniques that users should consider. This section is optional.</p>
-			<ul>
-				<li>ID</li>
-			</ul>
-		</section>
-		<section id="resources">
-			<h2>Resources</h2>
-			<p class="instructions">Provide links to external resources that are relevant to users of the technique. This section is optional.</p>
-			<ul>
-				<li>Link</li>
-			</ul>
-		</section>
 	</body>
 </html>
diff --git a/techniques/general/G218.html b/techniques/general/G218.html
@@ -13,7 +13,7 @@ <h2>Metadata</h2>
 		</section>
 		<section id="applicability">
 			<h2>Applicability</h2>
-			<p class="instructions">Technologies that support authentication.</p>
+			<p>Technologies that support authentication.</p>
 		</section>
 		<section id="description">
 			<h2>Description</h2>
diff --git a/techniques/general/G219.html b/techniques/general/G219.html
@@ -8,7 +8,6 @@
     <h1>Ensuring that an alternative is available for <a>dragging movement</a>s that operate on content</h1>
 		<section id="meta">
 			<h2>Metadata</h2>
-			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.</p>
 			<p id="sc">2.5.X Dragging</p>
 			<p id="type">Sufficient</p>
 		</section>
@@ -56,14 +55,9 @@ <h3>Expected Results</h3>
 		</section>
 		<section id="related">
 			<h2>Related Techniques</h2>
-			<p class="instructions">Provide links to other techniques that users should consider. This section is optional.</p>
 			<ul>
 				<li><a href="../general/G215">G215: Providing controls to achieve the same result as path based or multipoint</a></li>
 			</ul>
 		</section>
-		<section id="resources">
-			<h2>Resources</h2>
-
-		</section>
 	</body>
 </html>
diff --git a/techniques/general/G220.html b/techniques/general/G220.html
@@ -13,7 +13,7 @@ <h2>Metadata</h2>
 		</section>
 		<section id="applicability">
 			<h2>Applicability</h2>
-			<p class="instructions">Technologies that contain links</p>
+			<p>Technologies that contain links</p>
 		</section>
 		<section id="description">
 			<h2>Description</h2>
diff --git a/techniques/html/H100.html b/techniques/html/H100.html
@@ -13,7 +13,7 @@ <h2>Metadata</h2>
     </section>
     <section id="applicability">
       <h2>Applicability</h2>
-      <p class="instructions">Technologies that support authentication.</p>
+      <p>Technologies that support authentication.</p>
     </section>
     <section id="description">
       <h2>Description</h2>
diff --git a/understanding/21/animation-from-interactions.html b/understanding/21/animation-from-interactions.html
@@ -84,16 +84,6 @@ <h3>Sufficient</h3>
 						<li>Gx: Allowing users to set a preference that prevents animation.</li>
 					</ul>
 			</section>
-			<!--<section id="advisory">
-				<h2>Advisory</h2>
-				<p class="instructions">Techniques that are not sufficient by themselves to meet the Guideline or Success Criterion.</p>
-				<p class="instructions">Same template as sufficient techniques.</p>
-			</section>
-			<section id="failure">
-				<h2>Failure</h2>
-				<p class="instructions">Techniques that document conditions that would cause the page not to meet the Guideline or Success Criterion, even if sufficient techniques are also used.</p>
-				<p class="instructions">Same template as sufficient techniques.</p>
-			</section>-->
 		</section>
 	</body>
 </html>
diff --git a/understanding/21/identify-changes.html b/understanding/21/identify-changes.html
diff --git a/understanding/21/interruptions-minimum.html b/understanding/21/interruptions-minimum.html
diff --git a/understanding/21/label-in-name.html b/understanding/21/label-in-name.html
diff --git a/understanding/21/pointer-cancellation.html b/understanding/21/pointer-cancellation.html
diff --git a/understanding/21/target-size-enhanced.html b/understanding/21/target-size-enhanced.html

-Original file line number
+Diff line change
          <p id="type">advisoryp>
       section>
 -      <section id="applicability">
 -         <h2>When to Useh2>
 -         <p class="instructions">This technique is applicable to Markup languages that support ARIA.p>
 -      section>
+-
       <section id="description">
          <h2>Descriptionh2>
-Original file line number
+Diff line change
 		<h1>Failure of Success Criterion 1.4.10 due to content disappearing and not being available when content has reflowedh1>
 		<section id="meta">
 			<h2>Metadatah2>
 -			<p class="instructions">Provide information below to help editors associate the technique properly. Contents of the meta section are not output by the processor.p>
 			<p id="sc">p>
 			<p id="type">p>
 		section>
-Original file line number
+Diff line change
 		section>
 		<section id="applicability">
 			<h2>When to Useh2>
 -			<p class="instructions">This technique applies to all web technologies that include interactive controls (such as links or form inputs).p>
 +			<p>This technique applies to all web technologies that include interactive controls (such as links or form inputs).p>
 		section>
 		<section id="description">
 			<h2>Descriptionh2>
 -			<p class="instructions">The objective of this technique is to ensure that speech input users can operate web content reliably while not adversely affecting other users of assistive technology.p>
 +			<p>The objective of this technique is to ensure that speech input users can operate web content reliably while not adversely affecting other users of assistive technology.p>
 			<p>When speech input users interact with a web page, they usually speak a command followed by the reference to some visible label (such as text beside an input field or inside a button or link). For example, they may say "click search" to activate a button labelled Search. When speech recognition software processes speech input and looks for matches, it uses the <a href="https://www.w3.org/TR/accname/"> accessible namea> of controls. Where there is a mismatch between the text in the label and the text in the accessible name, it can cause issues for the user. The simplest way to enable speech input users and meet 2.5.3 Label in Name is to ensure that the accessible name matches the visible text label.p>
 			<h3>Determining the appropriate labelh3>
 			<p>Sometimes more than one text string will be positioned in the vicinity of a control that could be considered a candidate for its label. For example, a set of inputs that each have their own labels may also be preceded by a heading, an instruction or a group label (such as an HTML legend/fieldset or an ARIA group or radiogroup). Note that the term "group label" means something different than "label", both programmatically and in regard to 2.5.3 Label in Name.p>
 		section>
 		<section id="related">
 			<h2>Related Techniquesh2>
 -			<p class="instructions">Provide links to other techniques that users should consider. This section is optional.p>
 			<ul>
 				<li><a href="../html/H44">H44: Using label elements to associate text labels with form controlsa>li>
 				<li><a href="../html/H71">H71: Providing a description for groups of form controls using fieldset and legend elementsa>li>
 				<li><a href="../html/H85">H85: Using OPTGROUP to group OPTION elements inside a SELECTa>li>
 -				<li><a href="../aria/ARIA17">ARIA17: Using grouping roles to identify related form controlsa>
 -				li>
 +				<li><a href="../aria/ARIA17">ARIA17: Using grouping roles to identify related form controlsa>li>
 			ul>
 		section>
 		<section id="resources">
 			<h2>Resourcesh2>
 -			<p class="instructions">Provide links to external resources that are relevant to users of the technique. This section is optional.p>
 			<ul>
 				<li><a href="https://www.w3.org/TR/accname/">Accessible Name and Description Computationa>li>
 				<li><a href="https://www.w3.org/TR/html-aam/#accessible-name-and-description-computation">Accessible Name and Description Computation in HTML Accessibility API Mappings 1.0a>li>