-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update "8. Aspects under Test" #242
Conversation
Remove "8.1 Common Aspects" to move it to a working group note. Insert link and examples in "8. Aspects under Test" instead.
act-rules-format.bs
Outdated
@@ -109,38 +109,34 @@ An aspect is a distinct part of the [test subject](#output-test-subject) or its | |||
|
|||
An atomic rule MUST include a description of all the aspects under test by the rule. Each aspect MUST be discrete with no overlap between the aspects. Some aspects are already well defined within the context of web content, such as HTTP messages, DOM tree, and CSS styling [[CSS2]], and do not warrant a detailed description. Other aspects may not be well defined or even specific to web content. In these cases, an ACT Rule SHOULD include either a detailed description of the aspect in question or a reference to that description. | |||
|
|||
A list of common aspects for reference in ACT rules can be found in [Common Aspects under Test](#). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nitedog can you create a page for us to link to somewhere on w3.org?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how do you feel about a WG Note instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that works. @maryjom any thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nitedog Can you explain what the difference would be between a WG Note, an Understanding doc, and simply putting it in a non-normative Appendix. Just trying to minimize the number of documents we need to maintain and understand the right place to develop/put such content.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A WG Note is non-normative. This is fairly easy to write, publish, and update,, and is more formal than "just any page on the W3C website". At the same time, it is not part of the primary ACT Rules Format specification, which is a normative W3C Recommendation and significantly harder to update (eg. when we identify new aspects).
Actually, I foresee three or four WG Notes supporting the primary ACT Rules Format specification:
- Collection of "Aspects" (eg. HTTP etc. taken from the current spec)
- Generic review process (which we already have https://w3c.github.io/wcag-act-rules/review-process.html)
- Suggested notation for output format (which we also have at https://github.com/w3c/earl)
- (possibly) suggested template for rules (also available https://auto-wcag.github.io/auto-wcag/pages/design/rule-template.html)
All these WG Notes would be referenced in a non-normative way (eg. "you MAY use the following" type of requirement). We already have most of the content but it is rather scattered. This would pull all the content into one "package" with coherent cross-referencing and linking.
Could you please add this for discussion at one of the next calls?
Added link to new WG Note https://w3c.github.io/wcag-act/NOTE-act-rules-common-aspects.html |
I was not able to add this as a PR on this PR, so there is the suggested rewording: [[ [=Atomic rules=] MUST list the aspects used in the Test Definition. Each aspect MUST be discrete with no overlap between the aspects. An atomic rule MUST include a description of all the aspects under test by the rule. Some aspects are already well defined within the context of web content, such as HTTP messages, DOM tree, and CSS styling [[CSS2]], and do not warrant a detailed description. Other aspects are not well defined or even specific to web content. In these cases, an ACT Rule SHOULD include either a detailed description of the aspect in question or a reference to that description. A list of common aspects for reference in ACT rules can be found in Common Aspects under Test. Since there is no Test Definition in Composed rules, there SHOULD NOT be an aspects under test list for composed rules. Main changes:
|
act-rules-format.bs
Outdated
|
||
<div class=example> | ||
<p>Test aspects for a rule that checks for use of (language specific) generic link texts like "click here" and "more":</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be switched out for an example where there is less controversy about how it should work or if a test for this can actually be created?
Another possible example that would have the same test aspects:
"Test aspects for a rule that checks if the language attribute for a web page matches the human language of the text on that page."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally like the current example of checking for a transcript since it concedes that defining the test aspects may not always be black and white, and best judgement may be necessary.
My only worry is that since it is an example in our document it may be seen as a "fully-complete" or "fully-correct" case that needs no further tweaking and will be referred to during implementation later on.
html markup of lists in examples corrected
@moekraft, I think I got the styling issues in the examples fixed now. |
@annethyme Thank you! |
Remove "8.1 Common Aspects" to move it to a working group note. Insert link and examples in "8. Aspects under Test" instead.
In answer to #233.
Preview | Diff