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.

Sign up for GitHub

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

Jump to bottom

edit: Add 2 applicability examples #346

Merged
merged 4 commits into from
Mar 28, 2019
Merged

edit: Add 2 applicability examples #346

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b3e7c8
edit: Add 2 applicability examples
WilcoFiers Mar 20, 2019
b94a210
Resolve example comments
WilcoFiers Mar 25, 2019
60f5a01
Update page as test target example
WilcoFiers Mar 28, 2019
caeca97
Update attrobute as test target example
WilcoFiers Mar 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions act-rules-format.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,19 @@ Even concepts like headings and images can be misunderstood. These terms could r
</blockquote>
</div>

<div class=example>
<p>**Example:** The applicability of a rule with the page as a test target</a></p>
<blockquote>
<p>The rule applies to any page where the document element is an `html` element not embedded in another page, for example as part of an `iframe` or `object`.</p>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it the document element that is not to be embedded in another page?
That is how I read the sentence. I don't know if that is technically correct though. I hope you developer guys do know :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where the document element is an html element not embedded in another page

this sounds a bit confusing to me: sometimes a page can be both standalone and embedded in a (possibly third-party) iframe…
Maybe we could refer to WCAG's Web Page definition instead?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or alternatively we could use HTML's browsing context terminology (see active document and top-level browsing context), but this may gets too technical.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

The rule applies to any page where the document element is an html element, and the html element is not embedded in another page. Examples of an html element embedded in another page can be as part of an iframe or object elements.

</blockquote>
</div>

<div class=example>
<p>**Example:** The applicability of a rule with a DOM attribute as a test target</a></p>
<blockquote>
<p>Any `role` attribute that is specified on an HTML or SVG element.</p>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest changing

"Any role attribute that is specified on an HTML or SVG element."

-->

"The rule applies to any any role attribute that is specified on an HTML or SVG element."

... to align better with the other example.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WilcoFiers, is "HTML element" and "SVG element" unambiguous enough for this example in light of our discussion yesterday on whether HTML element meant "element in the HTML namespace", "listed in the HTML specification" or "has its semantics defined in the HTML specification"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. We can maybe have another pass on the examples when we're closer to Rec, make sure they are fully current to our writing style. For now, I think this is fine.

</blockquote>
</div>

### Applicability for Composite Rules ### {#applicability-composite}

Expand Down