edit: Add 2 applicability examples #346
Conversation
act-rules-format.bs
Outdated
| <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 root element is an `html` element, and which is not embedded in another page.</p> |
There was a problem hiding this comment.
I find it unclear whether the "which" refers to "any page" or "the root element". I think it needs a bit of clarification.
act-rules-format.bs
Outdated
| <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 root element is an `html` element, and which is not embedded in another page.</p> |
There was a problem hiding this comment.
While both "root" and "element" are defined in DOM (https://www.w3.org/TR/dom/#concept-tree-root and https://www.w3.org/TR/dom/#concept-element), I don't think we can use "root element" unambiguously. The term "document element" seems like a better fit: https://www.w3.org/TR/dom/#document-element
|
@kasperisager @annethyme comments resolved. Please look again. |
act-rules-format.bs
Outdated
| <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> |
There was a problem hiding this comment.
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 :)
There was a problem hiding this comment.
where the document element is an
htmlelement 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?
There was a problem hiding this comment.
or alternatively we could use HTML's browsing context terminology (see active document and top-level browsing context), but this may gets too technical.
There was a problem hiding this comment.
Suggestion:
The rule applies to any page where the document element is an
htmlelement, and thehtmlelement is not embedded in another page. Examples of anhtmlelement embedded in another page can be as part of aniframeorobjectelements.
act-rules-format.bs
Outdated
| <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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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"?
There was a problem hiding this comment.
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.
Closes #288
Closes #298
Closes #330
Preview | Diff