Skip to content
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

Merged
merged 4 commits into from
Sep 17, 2018
Merged

Update "8. Aspects under Test" #242

merged 4 commits into from
Sep 17, 2018

Conversation

annethyme
Copy link

@annethyme annethyme commented Aug 16, 2018

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

Remove "8.1 Common Aspects" to move it to a working group note. Insert link and examples in "8. Aspects under Test" instead.
@@ -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](#).
Copy link
Collaborator

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?

Copy link
Contributor

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?

Copy link
Collaborator

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?

Copy link
Collaborator

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.

Copy link
Contributor

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:

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?

@moekraft
Copy link
Collaborator

Added link to new WG Note https://w3c.github.io/wcag-act/NOTE-act-rules-common-aspects.html

@moekraft moekraft self-assigned this Sep 10, 2018
@nitedog
Copy link
Contributor

nitedog commented Sep 12, 2018

I was not able to add this as a PR on this PR, so there is the suggested rewording:

[[
An aspect is a distinct part of the Test Subject or its underlying implementation. For example, rendering a particular piece of content to an end user can involve multiple different technologies, some or all of which can be of interest to an ACT Rule. Some rules need to operate directly on the Hypertext Transfer Protocol [[http11]] messages exchanged between a server and a client, while others need to operate on the Document Object Model [[DOM]] tree exposed by a web browser. Other rules need to operate on several aspects simultaneously, such as both the HTTP messages and the DOM tree.

[=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:

  • Changed order of some sentences for better flow and coherence
  • Removed some occurrences of the word "may" used informally


<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>
Copy link
Author

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."

Copy link
Collaborator

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
@annethyme
Copy link
Author

@moekraft, I think I got the styling issues in the examples fixed now.

@moekraft
Copy link
Collaborator

@annethyme Thank you!

@moekraft moekraft merged commit 56f0ff2 into w3c:master Sep 17, 2018
moekraft added a commit that referenced this pull request Sep 17, 2018
Generating latest draft following merge of PR #242 and #247
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants