Cfc style updates #4080
Merged
Cfc style updates #4080
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Only occurrence specifically referring to an SC by name should be upper case, as per style guide
matching W3C style guide
match W3C styling
✅ Deploy Preview for wcag2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mbgower
commented
Sep 20, 2024
As per https://www.w3.org/WAI/EO/wiki/Style web/Web capitalization web - lowercase as adjective, such as "web accessibility", "web page", "web application" Web - can capitalize when referring to the World Wide Web, or leave lower case for consistency within a document
|
@shawna-slh if you have time to eyeball this and confirm I haven't unintentionally altered something that should remain capitalized (i.e., the start of a sentence), I would welcome. |
bruce-usab
requested changes
Sep 23, 2024
There was a problem hiding this comment.
@mbgower I found a few case typos. Comments inline. If I were more confident, I would just make the edits.
guidelines/index.html
Outdated
| </li> | ||
| <li> | ||
| <p><strong>Guidelines</strong> - Under the principles are guidelines. The 13 guidelines provide the basic goals that authors should work toward in order to make content more accessible to users with different disabilities. The guidelines are not testable, but provide the framework and overall objectives to help authors understand the success criteria and better implement the techniques.</p> | ||
| </li> | ||
| <li> | ||
| <p><strong>Success Criteria</strong> - For each guideline, testable success criteria are provided to allow WCAG 2.2 to be used where requirements and conformance testing are necessary such as in design specification, purchasing, regulation, and contractual agreements. In order to meet the needs of different groups and different situations, three levels of conformance are defined: A (lowest), AA, and AAA (highest). Additional information on WCAG levels can be found in <a href="https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels">Understanding Levels of Conformance</a>.</p> | ||
| <p><strong>success criteria</strong> - For each guideline, testable success criteria are provided to allow WCAG 2.2 to be used where requirements and conformance testing are necessary such as in design specification, purchasing, regulation, and contractual agreements. In order to meet the needs of different groups and different situations, three levels of conformance are defined: A (lowest), AA, and AAA (highest). Additional information on WCAG levels can be found in <a href="https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels">Understanding Levels of Conformance</a>.</p> |
There was a problem hiding this comment.
Success criteria should use title case since paragraph does that:
Sufficient and Advisory Techniques
| @@ -539,8 +539,8 @@ <h2>Statement of Partial Conformance - Language</h2> | |||
|
|
|||
| <section class="informative" id="privacy-summary"> | |||
| <h2>Privacy Considerations</h2> | |||
| <p>Success Criteria within this specification which the Working Group has identified possible implications for privacy, either by providing protections for end users or which are important for web site providers to take in to consideration when implementing features designed to protect user privacy, are listed below. This list reflects the current understanding of the Working Group but other Success Criteria may have privacy implications that the Working Group is not aware of at the time of publishing.</p> | |||
| <p>Success Criteria within this specification that may relate to privacy are:</p> | |||
| <p>Success criteria within this specification which the Working Group has identified possible implications for privacy, either by providing protections for end users or which are important for website providers to take in to consideration when implementing features designed to protect user privacy, are listed below. This list reflects the current understanding of the Working Group but other Success criteria may have privacy implications that the Working Group is not aware of at the time of publishing.</p> | |||
There was a problem hiding this comment.
...other Success criteria
I am not sure if both words should be capitalized, but one of the two is wrong.
| @@ -550,8 +550,8 @@ <h2>Privacy Considerations</h2> | |||
|
|
|||
| <section class="informative" id="security-summary"> | |||
| <h2>Security Considerations</h2> | |||
There was a problem hiding this comment.
Same as previous comment, other Success criteria
bruce-usab
approved these changes
Sep 27, 2024
mbgower
commented
Sep 27, 2024
mbgower
commented
Sep 27, 2024
guidelines/index.html
Outdated
| </li> | ||
| <li> | ||
| <p><strong>Guidelines</strong> - Under the principles are guidelines. The 13 guidelines provide the basic goals that authors should work toward in order to make content more accessible to users with different disabilities. The guidelines are not testable, but provide the framework and overall objectives to help authors understand the success criteria and better implement the techniques.</p> | ||
| </li> | ||
| <li> | ||
| <p><strong>Success Criteria</strong> - For each guideline, testable success criteria are provided to allow WCAG 2.2 to be used where requirements and conformance testing are necessary such as in design specification, purchasing, regulation, and contractual agreements. In order to meet the needs of different groups and different situations, three levels of conformance are defined: A (lowest), AA, and AAA (highest). Additional information on WCAG levels can be found in <a href="https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels">Understanding Levels of Conformance</a>.</p> | ||
| <p><strong>success criteria</strong> - For each guideline, testable success criteria are provided to allow WCAG 2.2 to be used where requirements and conformance testing are necessary such as in design specification, purchasing, regulation, and contractual agreements. In order to meet the needs of different groups and different situations, three levels of conformance are defined: A (lowest), AA, and AAA (highest). Additional information on WCAG levels can be found in <a href="https://www.w3.org/WAI/WCAG22/Understanding/conformance#levels">Understanding Levels of Conformance</a>.</p> | ||
| </li> | ||
| <li> | ||
| <p><strong>Sufficient and Advisory Techniques</strong> - For each of the <em>guidelines</em> and <em>success criteria</em> in the WCAG 2.2 document itself, the working group has also documented a wide variety of <em>techniques</em>. The techniques are informative and fall into two categories: those that are <em>sufficient</em> for meeting the success criteria and those that are <em>advisory</em>. The advisory techniques go beyond what is required by the individual success criteria and allow authors to better address the guidelines. Some advisory techniques address accessibility barriers that are not covered by the testable success criteria. Where common failures are known, these are also documented. See also <a href="https://www.w3.org/WAI/WCAG22/Understanding/understanding-techniques">Sufficient and Advisory Techniques in Understanding WCAG 2.2</a>.</p> |
There was a problem hiding this comment.
Suggested change
| <p><strong>Sufficient and Advisory Techniques</strong> - For each of the <em>guidelines</em> and <em>success criteria</em> in the WCAG 2.2 document itself, the working group has also documented a wide variety of <em>techniques</em>. The techniques are informative and fall into two categories: those that are <em>sufficient</em> for meeting the success criteria and those that are <em>advisory</em>. The advisory techniques go beyond what is required by the individual success criteria and allow authors to better address the guidelines. Some advisory techniques address accessibility barriers that are not covered by the testable success criteria. Where common failures are known, these are also documented. See also <a href="https://www.w3.org/WAI/WCAG22/Understanding/understanding-techniques">Sufficient and Advisory Techniques in Understanding WCAG 2.2</a>.</p> | |
| <p><strong>Sufficient and advisory techniques</strong> - For each of the <em>guidelines</em> and <em>success criteria</em> in the WCAG 2.2 document itself, the working group has also documented a wide variety of <em>techniques</em>. The techniques are informative and fall into two categories: those that are <em>sufficient</em> for meeting the success criteria and those that are <em>advisory</em>. The advisory techniques go beyond what is required by the individual success criteria and allow authors to better address the guidelines. Some advisory techniques address accessibility barriers that are not covered by the testable success criteria. Where common failures are known, these are also documented. See also <a href="https://www.w3.org/WAI/WCAG22/Understanding/understanding-techniques">Sufficient and Advisory Techniques in Understanding WCAG 2.2</a>.</p> |
There was a problem hiding this comment.
@shawna-slh what's your feeling on these?
scottaohara
approved these changes
Sep 27, 2024
|
Discussed on TF call, with consensus on changes. @mbgower is going to check with @shawna-slh on use of title case with Layers of Guidance section. |
Co-authored-by: Mike Gower <[email protected]>
bruce-usab
approved these changes
Oct 4, 2024
|
Discussed on backlog call 10/4, reverting to keeping title case for first word(s) following bullets of Layers of Guidance. |
kfranqueiro
pushed a commit
that referenced
this pull request
Dec 18, 2024
Style changes to normative documents made to ensure consistency as part
of the republishing of WCAG 2.2
- Ensures all normative occurrences of "web page" are two words and
lower case.
- Ensures all normative occurrences of "website" are a single word, not
capitalized.
- Ensures all normative occurrences of "success criterion/criteria" that
do not specify SCs by name, are lower case
- Ensures all normative occurrences of "web content" and other uses of
"web" are lower case
<!--
This comment and the below content is programmatically generated.
You may add a comma-separated list of anchors you'd like a
direct link to below (e.g. #idl-serializers, #idl-sequence):
Don't remove this comment or modify anything below this line.
If you don't want a preview generated for this pull request,
just replace the whole of this comment's content by "no preview"
and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/w3c/wcag/pull/4080.html"
title="Last updated on Oct 4, 2024, 3:14 PM UTC (571cf14)">Preview</a> |
<a
href="https://pr-preview.s3.amazonaws.com/w3c/wcag/4080/bf4b123...571cf14.html"
title="Last updated on Oct 4, 2024, 3:14 PM UTC (571cf14)">Diff</a>
---------
Co-authored-by: Alastair Campbell <[email protected]>
(cherry picked from commit a2c3cb3)
kfranqueiro
pushed a commit
that referenced
this pull request
Dec 18, 2024
Style changes to normative documents made to ensure consistency as part
of the republishing of WCAG 2.2
- Ensures all normative occurrences of "web page" are two words and
lower case.
- Ensures all normative occurrences of "website" are a single word, not
capitalized.
- Ensures all normative occurrences of "success criterion/criteria" that
do not specify SCs by name, are lower case
- Ensures all normative occurrences of "web content" and other uses of
"web" are lower case
<!--
This comment and the below content is programmatically generated.
You may add a comma-separated list of anchors you'd like a
direct link to below (e.g. #idl-serializers, #idl-sequence):
Don't remove this comment or modify anything below this line.
If you don't want a preview generated for this pull request,
just replace the whole of this comment's content by "no preview"
and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/w3c/wcag/pull/4080.html"
title="Last updated on Oct 4, 2024, 3:14 PM UTC (571cf14)">Preview</a> |
<a
href="https://pr-preview.s3.amazonaws.com/w3c/wcag/4080/bf4b123...571cf14.html"
title="Last updated on Oct 4, 2024, 3:14 PM UTC (571cf14)">Diff</a>
---------
Co-authored-by: Alastair Campbell <[email protected]>
(cherry picked from commit a2c3cb3)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Style changes to normative documents made to ensure consistency as part of the republishing of WCAG 2.2
Preview | Diff