Editorial suggestions for consistent links to definitions and capital…

…ization (#3038) Co-authored-by: Francis Storr <[email protected]> Co-authored-by: Kenneth G. Franqueiro <[email protected]> Co-authored-by: Mike Gower <[email protected]>
w3c · Nov 19, 2024 · 1b2d567 · 1b2d567
1 parent a05e809
commit 1b2d567
Show file tree

Hide file tree

Showing 31 changed files with 38 additions and 40 deletions.
diff --git a/guidelines/sc/20/audio-control.html b/guidelines/sc/20/audio-control.html
@@ -4,7 +4,7 @@ <h4>Audio Control</h4>
 
    <p class="conformance-level">A</p>
 
-   <p>If any audio on a web page plays automatically for more than 3 seconds, either a <a>mechanism</a> is available to pause or stop the audio, or a mechanism is available to control audio
+   <p>If any audio on a web page plays automatically for more than 3 seconds, either a <a>mechanism</a> is available to <a>pause</a> or stop the audio, or a mechanism is available to control audio
       volume independently from the overall system volume level.
    </p>
 

diff --git a/guidelines/sc/20/error-prevention-all.html b/guidelines/sc/20/error-prevention-all.html
@@ -9,8 +9,8 @@ <h4>Error Prevention (All)</h4>
 
    <dl>
      <dt>Reversible</dt><dd>Submissions are reversible.</dd>
-     <dt>Checked</dt><dd>Data entered by the user is checked for input errors and the user is provided an opportunity to correct them.</dd>
-     <dt>Confirmed</dt><dd>A mechanism is available for reviewing, confirming, and correcting information before finalizing the submission.</dd>
+     <dt>Checked</dt><dd>Data entered by the user is checked for <a>input errors</a> and the user is provided an opportunity to correct them.</dd>
+     <dt>Confirmed</dt><dd>A <a>mechanism</a> is available for reviewing, confirming, and correcting information before finalizing the submission.</dd>
   </dl>
 
 </section>
diff --git a/guidelines/sc/20/error-prevention-legal-financial-data.html b/guidelines/sc/20/error-prevention-legal-financial-data.html
@@ -10,8 +10,8 @@ <h4>Error Prevention (Legal, Financial, Data)</h4>
 
    <dl>
      <dt>Reversible</dt><dd>Submissions are reversible.</dd>
-     <dt>Checked</dt><dd>Data entered by the user is checked for input errors and the user is provided an opportunity to correct them.</dd>
-     <dt>Confirmed</dt><dd>A mechanism is available for reviewing, confirming, and correcting information before finalizing the submission.</dd>
+     <dt>Checked</dt><dd>Data entered by the user is checked for <a>input errors</a> and the user is provided an opportunity to correct them.</dd>
+     <dt>Confirmed</dt><dd>A <a>mechanism</a> is available for reviewing, confirming, and correcting information before finalizing the submission.</dd>
   </dl>
 
 </section>
diff --git a/guidelines/sc/20/focus-visible.html b/guidelines/sc/20/focus-visible.html
@@ -4,8 +4,7 @@ <h4>Focus Visible</h4>
 
    <p class="conformance-level">AA</p>
 
-   <p>Any keyboard operable user interface has a mode of operation where the keyboard focus
-      indicator is visible.
+   <p>Any keyboard operable user interface has a mode of operation where the keyboard <a>focus indicator</a> is visible.
    </p>
 
 </section>
diff --git a/guidelines/sc/20/language-of-parts.html b/guidelines/sc/20/language-of-parts.html
@@ -6,7 +6,7 @@ <h4>Language of Parts</h4>
 
    <p>The <a>human language</a> of each passage or phrase in the content can be <a>programmatically determined</a> except for proper names, technical terms, words of indeterminate language, and words
       or phrases that have become part of the vernacular of the immediately surrounding
-      text.
+     <a>text</a>.
    </p>
 
 </section>
diff --git a/guidelines/sc/20/link-purpose-link-only.html b/guidelines/sc/20/link-purpose-link-only.html
@@ -4,7 +4,7 @@ <h4>Link Purpose (Link Only)</h4>
 
    <p class="conformance-level">AAA</p>
 
-   <p>A <a>mechanism</a> is available to allow the purpose of each link to be identified from link text alone,
+  <p>A <a>mechanism</a> is available to allow the <a>purpose of each link</a> to be identified from link text alone,
       except where the purpose of the link would be <a>ambiguous to users in general</a>.
    </p>
 

diff --git a/guidelines/sc/20/name-role-value.html b/guidelines/sc/20/name-role-value.html
@@ -5,7 +5,7 @@ <h4>Name, Role, Value</h4>
    <p class="conformance-level">A</p>
 
    <p>For all <a>user interface components</a> (including but not limited to: form elements, links and components generated by scripts),
-      the <a>name</a> and <a>role</a> can be <a>programmatically determined</a>; states, properties, and values that can be set by the user can be <a>programmatically set</a>; and notification of changes to these items is available to <a>user agents</a>, including <a>assistive technologies</a>.
+     the <a>name</a> and <a>role</a> can be <a>programmatically determined</a>; <a>states</a>, properties, and values that can be set by the user can be <a>programmatically set</a>; and notification of changes to these items is available to <a>user agents</a>, including <a>assistive technologies</a>.
    </p>
 
    <p class="note">This success criterion is primarily for web authors who develop or script their own

diff --git a/guidelines/sc/20/pause-stop-hide.html b/guidelines/sc/20/pause-stop-hide.html
@@ -15,7 +15,7 @@ <h4>Pause, Stop, Hide</h4>
 
          <p>For any moving, blinking or scrolling information that (1) starts automatically, (2)
             lasts more than five seconds, and (3) is presented in parallel with other content,
-            there is a mechanism for the user to <a>pause</a>, stop, or hide it unless the movement, blinking, or scrolling is part of an activity
+           there is a <a>mechanism</a> for the user to <a>pause</a>, stop, or hide it unless the movement, blinking, or scrolling is part of an activity
             where it is <a>essential</a>; and
          </p>
 

diff --git a/guidelines/sc/20/reading-level.html b/guidelines/sc/20/reading-level.html
@@ -4,7 +4,7 @@ <h4>Reading Level</h4>
 
    <p class="conformance-level">AAA</p>
 
-   <p>When text requires reading ability more advanced than the <a>lower secondary education level</a> after removal of proper names and titles, <a>supplemental content</a>, or a version that does not require reading ability more advanced than the lower
+  <p>When text requires reading ability more advanced than the <a>lower secondary education level</a> after removal of proper names and titles, <a>supplemental content</a>, or a version that does not require reading ability more advanced than the lower
       secondary education level, is available.
    </p>
 

diff --git a/guidelines/sc/20/timing-adjustable.html b/guidelines/sc/20/timing-adjustable.html
@@ -41,7 +41,7 @@ <h4>Timing Adjustable</h4>
 
       <dd>
 
-         <p>The time limit is a required part of a real-time event (for example, an auction),
+        <p>The time limit is a required part of a <a>real-time event</a> (for example, an auction),
             and no alternative to the time limit is possible; or
          </p>
 

diff --git a/guidelines/sc/20/visual-presentation.html b/guidelines/sc/20/visual-presentation.html
@@ -11,7 +11,7 @@ <h4>Visual Presentation</h4>
      <li>Width is no more than 80 characters or glyphs (40 if CJK).</li>   
      <li>Text is not justified (aligned to both the left and the right margins).</li>   
      <li>Line spacing (leading) is at least space-and-a-half within paragraphs, and paragraph spacing is at least 1.5 times larger than the line spacing.</li>   
-     <li>Text can be resized without assistive technology up to 200 percent in a way that does not require the user to scroll horizontally to read a line of text <a>on a full-screen window</a>.</li>   
+     <li>Text can be resized without <a>assistive technology</a> up to 200 percent in a way that does not require the user to scroll horizontally to read a line of text <a>on a full-screen window</a>.</li>   
   </ul>
 
 <p class="note">Content is not required to use these values. The requirement is that a mechanism is available for users to change these presentation aspects. The mechanism can be provided by the browser or other user agent. Content is not required to provide the mechanism.</p>

diff --git a/guidelines/sc/21/content-on-hover-or-focus.html b/guidelines/sc/21/content-on-hover-or-focus.html
@@ -19,7 +19,7 @@ <h4>Content on Hover or Focus</h4>
 
   </dl>
 
-    	<p>Exception: The visual presentation of the additional content is controlled by the user agent and is not modified by the author.</p>
+    	<p>Exception: The visual presentation of the additional content is controlled by the <a>user agent</a> and is not modified by the author.</p>
 
     	<p class="note">Examples of additional content controlled by the user agent include browser tooltips created through use of the HTML <a href="https://html.spec.whatwg.org/multipage/dom.html#the-title-attribute"><code>title</code> attribute</a> [[HTML]].</p>
      <p class="note">Custom tooltips, sub-menus, and other nonmodal popups that display on hover and focus are examples of additional content covered by this criterion.</p>

diff --git a/guidelines/sc/21/non-text-contrast.html b/guidelines/sc/21/non-text-contrast.html
@@ -10,7 +10,7 @@ <h4>Non-text Contrast</h4>
 
       <dt>User Interface Components</dt>
 
-     <dd>Visual information required to identify <a>user interface components</a> and <a>states</a>, except for inactive components or where the appearance of the component is determined by the user agent and not modified by the author;</dd>
+     <dd>Visual information required to identify <a>user interface components</a> and <a>states</a>, except for inactive components or where the appearance of the component is determined by the <a>user agent</a> and not modified by the author;</dd>
 
       <dt>Graphical Objects</dt>
 

diff --git a/guidelines/sc/21/reflow.html b/guidelines/sc/21/reflow.html
@@ -11,7 +11,7 @@ <h4>Reflow</h4>
    </ul>
    <p>Except for parts of the content which require two-dimensional layout for usage or meaning.</p>
 
-   <p class="note">320 CSS pixels is equivalent to a starting viewport width of 1280 CSS pixels wide at 400% zoom. For web content which is designed to scroll horizontally (e.g., with vertical text), 256 CSS pixels is equivalent to a starting viewport height of 1024 CSS pixels at 400% zoom.</p>
+  <p class="note">320 CSS pixels is equivalent to a starting <a>viewport</a> width of 1280 CSS pixels wide at 400% zoom. For web content which is designed to scroll horizontally (e.g., with vertical text), 256 CSS pixels is equivalent to a starting viewport height of 1024 CSS pixels at 400% zoom.</p>
 
    <p class="note">Examples of content which requires two-dimensional layout are images required for understanding (such as maps and diagrams), video, games, presentations, data tables (not individual cells), and interfaces where it is necessary to keep toolbars in view while manipulating content. It is acceptable to provide two-dimensional scrolling for such parts of the content.</p>
 

diff --git a/guidelines/sc/21/target-size-enhanced.html b/guidelines/sc/21/target-size-enhanced.html
@@ -9,11 +9,11 @@ <h4>Target Size (Enhanced)</h4>
 	<dt>Equivalent</dt> 
   <dd>The target is available through an equivalent link or control on the same page that is at least 44 by 44 CSS pixels;</dd>
 	<dt>Inline</dt> 
-  <dd>The target is in a sentence or block of text;</dd>
+  <dd>The target is in a sentence or <a>block of text</a>;</dd>
 	<dt>User Agent Control</dt> 
-  <dd>The size of the target is determined by the user agent and is not modified by the author;</dd>
+  <dd>The size of the target is determined by the <a>user agent</a> and is not modified by the author;</dd>
 	<dt>Essential</dt> 
-  <dd>A particular presentation of the target is <a>essential</a> to the information being conveyed.</dd>
+  <dd>A particular <a>presentation</a> of the target is <a>essential</a> to the information being conveyed.</dd>
 </dl>  
 
 </section>
diff --git a/guidelines/sc/21/text-spacing.html b/guidelines/sc/21/text-spacing.html
@@ -13,7 +13,7 @@ <h4>Text Spacing</h4>
      <li>Word spacing to at least 0.16 times the font size.</li>
    </ul>
 
- <p>Exception: Human languages and scripts that do not make use of one or more of these text style properties in written text can conform using only the properties that exist for that combination of language and script.</p>
+ <p>Exception: <a>Human languages</a> and scripts that do not make use of one or more of these text style properties in written text can conform using only the properties that exist for that combination of language and script.</p>
 
  <p class="note">Content is not required to use these text spacing values. The requirement is to ensure that when a user overrides the authored text spacing, content or functionality is not lost.</p>
 

diff --git a/guidelines/terms/20/blocks-of-text.html b/guidelines/terms/20/blocks-of-text.html
@@ -1,6 +1,6 @@
-<dt><dfn id="dfn-blocks-of-text">blocks of text</dfn></dt>
+<dt><dfn id="dfn-blocks-of-text" data-lt="block of text">blocks of text</dfn></dt>
 <dd>
 
-   <p>more than one sentence of text</p>
+  <p>more than one sentence of text</p>
 
 </dd>
diff --git a/guidelines/terms/20/human-language.html b/guidelines/terms/20/human-language.html
@@ -1,4 +1,4 @@
-<dt><dfn id="dfn-human-language-s" data-lt="human language(s)">human language</dfn></dt>
+<dt><dfn id="dfn-human-language-s" data-lt="human languages|human language(s)">human language</dfn></dt>
 <dd>
 
    <p>language that is spoken, written or signed (through visual or tactile means) to communicate

diff --git a/guidelines/terms/20/image-of-text.html b/guidelines/terms/20/image-of-text.html
@@ -1,11 +1,11 @@
 <dt><dfn id="dfn-images-of-text" data-lt="images of text">image of text</dfn></dt>
 <dd>
 
-   <p>text that has been rendered in a non-text form (e.g., an image) in order to achieve
+  <p>text that has been rendered in a non-text form (e.g., an image) in order to achieve
       a particular visual effect
    </p>
 
-   <p class="note">This does not include <a>text</a> that is part of a picture that contains significant other visual content.
+   <p class="note">This does not include text that is part of a picture that contains significant other visual content.
    </p>
 
    <aside class="example"><p>A person's name on a nametag in a photograph.</p></aside>

diff --git a/guidelines/terms/20/input-error.html b/guidelines/terms/20/input-error.html
@@ -1,4 +1,4 @@
-<dt><dfn id="dfn-input-error">input error</dfn></dt>
+<dt><dfn id="dfn-input-error" data-lt="input errors">input error</dfn></dt>
 <dd>
 
    <p>information provided by the user that is not accepted</p>

diff --git a/guidelines/terms/20/non-text-content.html b/guidelines/terms/20/non-text-content.html
@@ -3,7 +3,7 @@
 
    <p>any content that is not a sequence of characters that can be <a>programmatically determined</a> or where the sequence is not expressing something in <a>human language</a></p>
 
-   <p class="note">This includes <a>ASCII Art</a> (which is a pattern of characters), emoticons, leetspeak (which uses character substitution),
+   <p class="note">This includes <a>ASCII art</a> (which is a pattern of characters), emoticons, leetspeak (which uses character substitution),
       and images representing text
    </p>
 

diff --git a/guidelines/terms/20/on-a-full-screen-window.html b/guidelines/terms/20/on-a-full-screen-window.html
@@ -1,7 +1,7 @@
 <dt><dfn id="dfn-on-a-full-screen-window">on a full-screen window</dfn></dt>
 <dd>
 
-   <p>on the most common sized desktop/laptop display with the viewport maximized</p>
+  <p>on the most common sized desktop/laptop display with the <a>viewport</a> maximized</p>
 
    <p class="note">Since people generally keep their computers for several years, it is best not to rely
       on the latest desktop/laptop display resolutions but to consider the common desktop/laptop

diff --git a/guidelines/terms/20/programmatically-set.html b/guidelines/terms/20/programmatically-set.html
@@ -1,8 +1,7 @@
 <dt><dfn id="dfn-programmatically-set">programmatically set</dfn></dt>
 <dd>
 
-   <p>set by software using methods that are supported by user agents, including assistive
-      technologies
+  <p>set by software using methods that are supported by <a>user agents</a>, including <a>assistive technologies</a>
    </p>
 
 </dd>
diff --git a/guidelines/terms/20/text-alternative.html b/guidelines/terms/20/text-alternative.html
@@ -2,7 +2,7 @@
 <dd>
 
    <p><a>Text</a> that is programmatically associated with <a>non-text content</a> or referred to from text that is programmatically associated with non-text content.
-      Programmatically associated text is text whose location can be programmatically determined
+      Programmatically associated text is text whose location can be <a>programmatically determined</a>
       from the non-text content.
    </p>
 

diff --git a/guidelines/terms/20/viewport.html b/guidelines/terms/20/viewport.html
@@ -1,9 +1,9 @@
 <dt><dfn id="dfn-viewport">viewport</dfn></dt>
 <dd>
 
-   <p>object in which the user agent presents content</p>
+   <p>object in which the <a>user agent</a> presents content</p>
 
-   <p class="note">The <a>user agent</a> presents content through one or more viewports. Viewports include windows, frames,
+   <p class="note">The user agent presents content through one or more viewports. Viewports include windows, frames,
       loudspeakers, and virtual magnifying glasses. A viewport may contain another viewport
       (e.g., nested frames). Interface components created by the user agent such as prompts,
       menus, and alerts are not viewports.

diff --git a/guidelines/terms/21/region.html b/guidelines/terms/21/region.html
@@ -1,5 +1,5 @@
 <dt><dfn id="dfn-regions" data-lt="regions">region</dfn></dt>
 <dd>
-  <p>perceivable, programmatically determined section of content</p>
+  <p>perceivable, <a>programmatically determined</a> <a>section</a> of content</p>
   <p class="note">In HTML, any area designated with a landmark role would be a region.</p>
 </dd>
diff --git a/guidelines/terms/21/state.html b/guidelines/terms/21/state.html
@@ -1,6 +1,6 @@
 <dt><dfn id="dfn-states" data-lt="states">state</dfn></dt>
 <dd>
 
-   <p>dynamic property expressing characteristics of a user interface component that may change in response to user action or automated processes</p>
+  <p>dynamic property expressing characteristics of a <a>user interface component</a> that may change in response to user action or automated processes</p>
 	<p>States do not affect the nature of the component, but represent data associated with the component or user interaction possibilities. Examples include focus, hover, select, press, check, visited/unvisited, and expand/collapse.</p>
 </dd>
diff --git a/guidelines/terms/21/status-message.html b/guidelines/terms/21/status-message.html
@@ -1,6 +1,6 @@
 <dt><dfn id="dfn-status-messages" data-lt="status messages">status message</dfn></dt>
 <dd>
 
-   <p>change in content that is not a <a>change of context</a>, and that provides information to the user on the success or results of an action, on the waiting state of an application, on the progress of a process, or on the existence of errors</p>
+   <p>change in content that is not a <a>change of context</a>, and that provides information to the user on the success or results of an action, on the waiting state of an application, on the progress of a <a>process</a>, or on the existence of errors</p>
 
 </dd>
diff --git a/guidelines/terms/21/target.html b/guidelines/terms/21/target.html
@@ -1,7 +1,7 @@
 <dt><dfn id="dfn-targets" data-lt="targets">target</dfn></dt>
 <dd>
 
-     <p>region of the display that will accept a pointer action, such as the interactive area of a user interface component</p> 
+     <p>region of the display that will accept a pointer action, such as the interactive area of a <a>user interface component</a></p> 
     <p class="note">If two or more targets are overlapping, the overlapping area should not be included in the measurement of the target size, except when the overlapping targets perform the same action or open the same page.</p>
 
 </dd>
diff --git a/guidelines/terms/21/user-inactivity.html b/guidelines/terms/21/user-inactivity.html
@@ -1,5 +1,5 @@
 <dt><dfn id="dfn-user-inactivity">user inactivity</dfn></dt>
 <dd>
   <p>any continuous period of time where no user actions occur</p>
-	<p>The method of tracking will be determined by the web site or application.</p>
+	<p>The method of tracking will be determined by the website or application.</p>
 </dd>
diff --git a/guidelines/terms/22/minimum-bounding-box.html b/guidelines/terms/22/minimum-bounding-box.html
@@ -1,6 +1,6 @@
 <dt class="new"><dfn id="dfn-bounding-boxes" data-lt="bounding boxes|bounding box">minimum bounding box</dfn></dt>
 <dd class="new">
 	<p class="change">New</p>	
-   <p>the smallest enclosing rectangle aligned to the horizontal axis within which all the points of a shape lie. For components which wrap onto multiple lines as part of a sentence or block of text (such as hypertext links), the bounding box is based on how the component would appear on a single line.</p>
+   <p>the smallest enclosing rectangle aligned to the horizontal axis within which all the points of a shape lie. For components which wrap onto multiple lines as part of a sentence or <a>block of text</a> (such as hypertext links), the bounding box is based on how the component would appear on a single line.</p>
 </dd>