Skip to content

Commit

Permalink
Harmonise wording for techniques checks/steps (#3915)
Browse files Browse the repository at this point in the history
Currently, techniques use a mix of wording `If step X...` and `If check
X...`, as well as a few outlier "If test procedure X...". Most prefix
the step/check number with `#`, but some don't. And conceptually, I
think it makes more sense saying that a *check* is true/false, rather
than a *step* being true/false.

This PR tries to harmonise this, settling for `check` and adding missing
`#` (though, it has to be said, this use of the octothorpe is a bit
US-centric, so maybe we want to harmonise to *not* having it?)

---------

Co-authored-by: ljoakley <32885548+ljoakley@users.noreply.github.com>
Co-authored-by: Mike Gower <mikegower@gmail.com>
  • Loading branch information
3 people authored Aug 7, 2024
1 parent c89709f commit 014f0e3
Show file tree
Hide file tree
Showing 54 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion techniques/aria/ARIA18.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h3>Alert dialog</h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>Checks 2, 3, 5 and 6 are true. For Success Criterion 3.3.3, Check 7 is also true.</li>
<li>Checks #2, #3, #5 and #6 are true. For Success Criterion 3.3.3, check #7 is also true.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2>
Expand Down
2 changes: 1 addition & 1 deletion techniques/client-side-script/SCR14.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h4>The <abbr title="HyperText Markup Language">HTML</abbr></h4>
<section class="results">
<h3>Expected Results</h3>
<ul>
<li>For a Web page that supports non-emergency interruptions, checks 1 and 2 are true.</li>
<li>For a Web page that supports non-emergency interruptions, checks #1 and #2 are true.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/css/C21.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h3>Procedure</h3>
<section class="results">
<h3>Expected Results</h3>
<ul>
<li>Test Procedure #2 is true.</li>
<li>Check #2 is true.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/css/C43.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h3>Procedure</h3>
<section class="test-results">
<h3>Expected Results</h3>
<ul>
<li>Check 1 is true.</li>
<li>Check #1 is true.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/css/C45.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h3>Procedure</h3>
<section class="test-results">
<h3>Expected Results</h3>
<ul>
<li>Check 2 is true.</li>
<li>Check #2 is true.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F1.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #2 is false, then this failure condition applies and the
<li>If check #2 is false, then this failure condition applies and the
content fails this Success Criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F107.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ <h3>Procedure</h3>
<section class="test-results">
<h3>Expected Results</h3>
<ul>
<li>If checks 1 and 2 are true, then the failure condition applies, and the content fails the Success Criterion.</li>
<li>If checks #1 and #2 are true, then the failure condition applies, and the content fails the Success Criterion.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F109.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h2>Examples</h2>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If steps #1 and #2 are true, then this failure condition applies and content fails the Success Criterion.</li>
<li>If checks #1 and #2 are true, then this failure condition applies and content fails the Success Criterion.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F12.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #3 is false, the site fails the Success Criterion.</li>
<li>If check #3 is false, the site fails the Success Criterion.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F13.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is true, then this failure condition applies and
<li>If check #1 is true, then this failure condition applies and
content fails the Success Criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F14.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #2 is false, then this failure condition applies and the
<li>If check #2 is false, then this failure condition applies and the
content fails this Success Criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F15.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h1>Failure of Success Criterion 4.1.2 due to implementing custom controls that
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #1 is false, then this failure condition applies and the
<li> If check #1 is false, then this failure condition applies and the
content fails this success criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F19.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ol>
<li> If step #2 is false, the content fails the Success Criterion. </li>
<li> If check #2 is false, the content fails the Success Criterion. </li>
</ol>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F20.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #1 is true then the text alternative is not up to date with
<li> If check #1 is true then the text alternative is not up to date with
current item, this failure condition applies, and content fails
these Success Criteria. </li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions techniques/failures/F22.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ <h3></h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #2 is true, the failure condition applies and the content
<li> If check #2 is true, the failure condition applies and the content
fails the Success Criterion </li>
<li> If step #5 is true and step #6 is false, the failure condition applies and
<li> If check #5 is true and check #6 is false, the failure condition applies and
the content fails the Success Criterion </li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F23.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ <h2>Tests</h2>
<section class="results">
<h3>Expected Results</h3>
<ul>
<li>If step #1 is not true then content fails Success Criterion 1.4.2</li>
<li>If check #1 is not true then content fails Success Criterion 1.4.2</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F24.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h3>Specifying foreground color of link text with CSS</h3>
</div>
</section>
<section class="results"><h3>Expected Results</h3>
<p>If step #2 is true but step #3 is false, OR if step #3 is true but step #2 is false then this
<p>If check #2 is true but step #3 is false, <em>or</em> if check #3 is true but step #2 is false then this
failure condition applies and content fails these Success Criteria.</p>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F25.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is false, then this failure condition applies and the
<li>If check #1 is false, then this failure condition applies and the
content fails this Success Criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F3.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3></h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #2 and step #3 are both false, then this failure condition applies and the content fails this Success Criterion. </li>
<li> If checks #2 and #3 are both false, then this failure condition applies and the content fails this Success Criterion. </li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F30.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #1 is true then this failure condition applies and content
<li> If check #1 is true then this failure condition applies and content
fails the Success Criterion. </li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F31.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h3></h3>
</ol>
</section>
<section class="results"><h3>Expected Results</h3>
<p> If step #2 is false then this failure condition applies and content fails
<p> If check #2 is false then this failure condition applies and content fails
the Success Criterion. </p>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2></section></body></html>
2 changes: 1 addition & 1 deletion techniques/failures/F32.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h3>Using line break characters to format vertical text</h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is true, then this failure condition applies and the
<li>If check #1 is true, then this failure condition applies and the
content fails this Success Criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F33.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #2 is true, then this failure condition applies and the
<li>If check #2 is true, then this failure condition applies and the
content fails these Success Criteria.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F34.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #2 is true, then this failure condition applies and the
<li>If check #2 is true, then this failure condition applies and the
content fails these Success Criteria.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F36.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ <h3></h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #3 is true, then this failure condition applies and content
<li> If check #3 is true, then this failure condition applies and content
fails the Success Criterion. </li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F37.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h3></h3>
</ol>
</section>
<section class="results"><h3>Expected Results</h3>
<p> If step #3 is false, then this failure condition applies and content
<p> If check #3 is false, then this failure condition applies and content
fails the Success Criterion.</p>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2></section></body></html>
4 changes: 2 additions & 2 deletions techniques/failures/F38.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is true and if step #2 is true, this failure condition applies and content fails the Success Criterion.</li>
<li>If check #1 and #2 are true, this failure condition applies and content fails the Success Criterion.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2></section></body></html>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2></section></body></html>
2 changes: 1 addition & 1 deletion techniques/failures/F39.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h3>Decorative images that have no <code class="language-html">alt</code> attrib
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #2 is false, this failure condition applies and the content
<li> If check #2 is false, this failure condition applies and the content
fails the Success Criterion. </li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F4.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h3>Procedure</h3>
<section class="results">
<h3>Expected Results</h3>
<ul>
<li>If step #1 and step #2 are true, the content fails the success criterion.</li>
<li>If checks #1 and #2 are true, the content fails the success criterion.</li>
</ul>
</section>
</section><section id="related">
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F52.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3>example commonly used to open new windows when pages are loaded</h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step 2 and step 3 are true, then this failure condition applies and
<li> If check #2 and check #3 are true, then this failure condition applies and
content fails the Success Criterion. </li>
</ul>
</section>
Expand Down
4 changes: 2 additions & 2 deletions techniques/failures/F61.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h3></h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If both checks 3 and 4 are true, then this failure condition applies and the content fails this Success Criterion</li>
<li>If checks #3 and #4 are true, then this failure condition applies and the content fails this Success Criterion</li>
</ul>
</section>
</section><section id="tests"><h2>Tests</h2>
Expand All @@ -65,4 +65,4 @@ <h3></h3>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2>

</section></body></html>
</section></body></html>
2 changes: 1 addition & 1 deletion techniques/failures/F67.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is false, then this failure condition applies and the content fails this Success Criterion.</li>
<li>If check #1 is false, then this failure condition applies and the content fails this Success Criterion.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F7.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is true and step #2 is false, the content fails the success
<li>If check #1 is true and check #2 is false, the content fails the success
criterion.</li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F77.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If Step #1 is false, then this failure condition applies and the content fails the Success Criterion.</li>
<li>If check #1 is false, then this failure condition applies and the content fails the Success Criterion.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F81.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #1 is false, then this failure condition applies and content fails the Success Criterion.</li>
<li>If check #1 is false, then this failure condition applies and content fails the Success Criterion.</li>
</ul>
</section>
</section></body></html>
2 changes: 1 addition & 1 deletion techniques/failures/F84.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If step #2 is true AND #3 is false, then this failure condition applies and content fails the success criterion.</li>
<li>If check #2 is true AND #3 is false, then this failure condition applies and content fails the success criterion.</li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F88.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If test procedure #2 is false, then this failure condition applies and the content fails to meet Success Criterion 1.4.8.</li>
<li>If check #2 is false, then this failure condition applies and the content fails to meet Success Criterion 1.4.8.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2><ul>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F9.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h3></h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li> If step #3, step #4, or step #5 is true, then this failure condition applies and
<li> If check #3, step #4, or step #5 is true, then this failure condition applies and
the content fails the Success Criterion. </li>
</ul>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F93.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h3>An auto-playing audio track</h3>
</section>
<section class="results"><h3>Expected Results</h3>
<ul>
<li>If checks 1-5 are true, then this failure condition applies and the content fails the Success Criterion.</li>
<li>If checks #1-5 are true, then this failure condition applies and the content fails the Success Criterion.</li>
</ul>
</section>
</section><section id="related"><h2>Related Techniques</h2></section><section id="resources"><h2>Resources</h2>
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F97.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h3>Procedure</h3>
<li>Open the content in landscape view. Check that the content is oriented for this view.</li>
<li>Open the content in portrait view. Check that the content is oriented for this view.</li>
<li>Check if portrait or landscape view is essential for the viewing and operation of the content.</li>
<li>If there are any controls in the content, user agent, operating system, or device that restrict or allow orientation changes, check that the controls can be set to allow checks one and two to be true.</li>
<li>If there are any controls in the content, user agent, operating system, or device that restrict or allow orientation changes, check that the controls can be set to allow checks #1 and #2 to be true.</li>
</ol>
</section>
<section class="test-results">
Expand Down
2 changes: 1 addition & 1 deletion techniques/failures/F99.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h3>Procedure</h3>
</section>
<section class="test-results">
<h3>Expected Results</h3>
<p>If step #4 is true then this failure condition applies and the content fails the Success Criterion.</p>
<p>If check #4 is false then this failure condition applies and the content fails the Success Criterion.</p>

</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion techniques/general/G134.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ <h2>Tests</h2>
<section class="results">
<h3>Expected Results</h3>
<p>For HTML, SGML-based and XML-based technologies:</p>
<p>Check 2 is true.</p>
<p>Check #2 is true.</p>
</section>
</section>
<section id="related">
Expand Down
Loading

0 comments on commit 014f0e3

Please sign in to comment.