Editorial changes to structure/prose

patrickhlauke commented 3 years ago

Small wording/grammatical tweaks
Rename the "Document conformance requirements for use of ARIA attributes with HTML attributes" to "Requirements for use of ARIA attributes in place of equivalent HTML attributes" and make it a proper sub-<section> (so it appears in the TOC and gets numbered)
Reword some of the abstract and conformance prose

stevefaulkner commented 3 years ago

@patrickhlauke

Document conformance requirements for use of ARIA attributes with HTML attributes

The use of the term "Document conformance" is important in this context as it describes what the rules are tested against

Document-conformance checking is the current party-approved goodthink way of talking about looking for problems in HTML documents. And do note that we call it document conformance and not authoring conformance, and we talk about conformance requirements for documents, not conformance requirements for authors. That’s because you as an author are a human being; a technical specification can’t place requirements on you, it can only place requirements on documents you create. And related tools don’t evaluate you as a human being for conformance to particular technologies; instead they just evaluate the documents you create. source: https://html5doctor.com/html5-check-it-before-you-wreck-it-with-miketm-smith/

patrickhlauke commented 3 years ago

The use of the term "Document conformance" is important in this context as it describes what the rules are tested against

sure, but it's a subsection of "Document conformance requirements for use of ARIA attributes in HTML", so it's clear it's about document conformance, I'd say (otherwise the heading becomes a bit unwieldy)

patrickhlauke commented 3 years ago

Made one last minute additional tweak to the abstract ... it always read a bit funny, this may be cleaner/clearer. @scottaohara

scottaohara commented 3 years ago

unsure what's going on here @patrickhlauke. Pulled this down and respec is throwing no errors or warnings, locally.

travis is returning this error:

Error: Command failed: java -jar /home/travis/build/w3c/html-aria/node_modules/vnu-jar/build/dist/vnu.jar --also-check-css /tmp/tmp.gdOiHUDM0J/output.html

cc @marcoscaceres

patrickhlauke commented 3 years ago

Is it perhaps somehow checking the test cases where we do expect actual failures?

scottaohara commented 3 years ago

it shouldn't be.

patrickhlauke commented 3 years ago

these are the specific errors Travis is reporting/blocking on

"file:/tmp/tmp.gdOiHUDM0J/output.html":332.138-332.205: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":334.138-334.202: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":337.152-337.262: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5613.7-5613.195: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5613.7-5613.195: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5623.13-5623.201: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5623.13-5623.201: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5639.13-5639.217: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5639.13-5639.217: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5649.13-5649.171: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5649.13-5649.171: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5661.13-5661.169: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5661.13-5661.169: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5671.13-5671.197: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5671.13-5671.197: error: Attribute “aria-modal” not allowed on element “aside” at this point.
Error: Command failed: java -jar /home/travis/build/w3c/html-aria/node_modules/vnu-jar/build/dist/vnu.jar --also-check-css /tmp/tmp.gdOiHUDM0J/output.html
"file:/tmp/tmp.gdOiHUDM0J/output.html":332.138-332.205: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":334.138-334.202: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":337.152-337.262: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5613.7-5613.195: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5613.7-5613.195: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5623.13-5623.201: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5623.13-5623.201: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5639.13-5639.217: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5639.13-5639.217: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5649.13-5649.171: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5649.13-5649.171: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5661.13-5661.169: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5661.13-5661.169: error: Attribute “aria-modal” not allowed on element “aside” at this point.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5671.13-5671.197: error: Bad value “dialog” for attribute “role” on element “aside”.
"file:/tmp/tmp.gdOiHUDM0J/output.html":5671.13-5671.197: error: Attribute “aria-modal” not allowed on element “aside” at this point.

https://travis-ci.com/github/w3c/html-aria/builds/223597886

As I don't think that's anywhere in the actual spec's index.html ... this smells to me like it is

patrickhlauke commented 3 years ago

ah, correction ... the errors here come from things that ReSpect injects into the page (though why only all of a sudden, now?)

e.g.

<dfn id="dfn-strong-native-semantics" tabindex="0" role="link" aria-haspopup="dialog" title="Show what links to this definition"><a data-cite="wai-aria-1.1#host_general_conflict" href="https://www.w3.org/TR/wai-aria-1.1/#host_general_conflict">strong native semantics</a></dfn>

and

<aside class="dfn-panel" hidden="" role="dialog" aria-modal="true" id="dfn-panel-for-dfn-no-corresponding-role" aria-label="Links in this document to definition: No corresponding role">
  ...
</aside>

marcoscaceres commented 3 years ago

We literally just shipped an update today 🥳 what did we break?

marcoscaceres commented 3 years ago

Ah! Ok, I see. Will fix first thing tomorrow.

marcoscaceres commented 3 years ago

Some of those strike me as odd... like "Bad value “dialog” for attribute “role” on element “aside”"?

Why is that not valid? Do the other strike anyone as odd? (Apart from the role=link on an anchor)

patrickhlauke commented 3 years ago

We literally just shipped an update today 🥳 what did we break?

the web

marcoscaceres commented 3 years ago

Best part of "HTML in ARIA" is that y'all get to tell me how to fix those 🤣😂🤣😂🤣

scottaohara commented 3 years ago

Some of those strike me as odd... like "Bad value “dialog” for attribute “role” on element “aside”"?

Why is that not valid? Do the other strike anyone as odd? (Apart from the role=link on an anchor)

I could see a progressive enhancement case for an aside becoming a role=dialog, which would call for an allowance here. But, is that applicable to this situation? will this even work if JS is not enabled (in which case no role would be provided)? in which case, why use an aside if its implicit semantics are going to be overwritten?

marcoscaceres commented 3 years ago

Won't work without JS. So sounds like a good 'ol div might be better than aside for those. Agree?

For the anchors inside links, we will need to actually investigate those. That seems legit.

scottaohara commented 3 years ago

Won't work without JS. So sounds like a good 'ol div might be better than aside for those. Agree?

yeh. if the aside element's implicit role is never meant to be exposed, then there's no reason to use it.

For the anchors inside links, we will need to actually investigate those. That seems legit.

agree. it's a problem.

marcoscaceres commented 3 years ago

Something weird going on with those "clarification of states versus properties".

I've not investigated yet. Will check tomorrow once I'm at computer again. At least the other errors are fixed.

marcoscaceres commented 3 years ago

FYI, "clarification of states versus properties", see https://github.com/w3c/aria/pull/1468 ... @jnurthen is going to send a PR to this spec soon.

jnurthen commented 3 years ago

FYI, "clarification of states versus properties", see https://github.com/w3c/aria/pull/1468 ... @jnurthen is going to send a PR to this spec soon.

This should be resolved. Is it still an issue?

marcoscaceres commented 3 years ago

Oh! just spotted the other PR @jnurthen. Thanks for sending that!... checking why CI is failing now.

patrickhlauke commented 3 years ago

@marcoscaceres are we ok to merge this in the knowledge that the travis fail is related to respec rather than the spec itself? or should we hold off merging?

marcoscaceres commented 3 years ago

The ReSpec issues should be fixed now, but I can't seem to get Travis to retrigger the build. Can someone head over there and click the restart build button? Then it should all turn green and should be good to merge.

patrickhlauke commented 3 years ago

@marcoscaceres still erroring out on the following

"file:/tmp/tmp.q4jesHOjfW/output.html":332.138-332.205: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.q4jesHOjfW/output.html":334.138-334.202: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.q4jesHOjfW/output.html":337.152-337.262: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
Error: Command failed: java -jar /home/travis/build/w3c/html-aria/node_modules/respec-validator/node_modules/vnu-jar/build/dist/vnu.jar --also-check-css /tmp/tmp.q4jesHOjfW/output.html
"file:/tmp/tmp.q4jesHOjfW/output.html":332.138-332.205: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.q4jesHOjfW/output.html":334.138-334.202: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.
"file:/tmp/tmp.q4jesHOjfW/output.html":337.152-337.262: error: The element “a” must not appear as a descendant of an element with the attribute “role=link”.

also, for some reason Travis can't be retriggered manually ... "Oh no! An error occurred. The build could not be restarted."

marcoscaceres commented 3 years ago

@marcoscaceres still erroring out on the following

Looking into those! Will report back soon.

also, for some reason Travis can't be retriggered manually ... "Oh no! An error occurred. The build could not be restarted."

Yeah, getting the same error. Not sure what's going on there :(

Going to transition us to use GitHub Actions, which makes things easier.

marcoscaceres commented 3 years ago

I think once we rebase on https://github.com/w3c/html-aria/pull/310 , it should hopefully be happy again.

patrickhlauke commented 3 years ago

I think once we rebase on #310 , it should hopefully be happy again.

yes, that seems to have done it

w3c / html-aria

Editorial changes to structure/prose #306