Editorial changes to structure/prose #306

patrickhlauke · 2021-04-19T21:35:21Z

Related to #297

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

Renamed from "Document conformance requirements for use of ARIA attributes with HTML attributes" to "Requirements for use of ARIA attributes in place of equivalent HTML attributes" ... as this actually makes it more understandable immediately why this table is different from the preceding one. Making it an actual `<section>` makes it appear in the left-hand TOC and gives it a number (3.1)

this was the only place in the whole spec that used "n/a" ... looked ugly/straggly

to avoid the odd-looking clash of "HTML MUST", moved "documents" in this sentence

Only an editorial change that, hopefully, makes it a bit more understandable/readable

stevefaulkner · 2021-04-19T21:57:20Z

@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 · 2021-04-19T22:03:08Z

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)

scottaohara

LGTM. Thanks for taking a look through this all. @stevefaulkner we can give this a merge once you're good to go.

… into patrickhlauke-tweaks

patrickhlauke · 2021-04-20T00:30:39Z

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

index.html

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

scottaohara · 2021-04-20T11:07:05Z

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 · 2021-04-20T11:39:04Z

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

scottaohara · 2021-04-20T11:49:42Z

it shouldn't be.

patrickhlauke · 2021-04-20T11:58:30Z

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 · 2021-04-20T12:02:34Z

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 · 2021-04-20T12:14:26Z

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

marcoscaceres · 2021-04-20T12:15:29Z

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

marcoscaceres · 2021-04-20T12:19:10Z

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 · 2021-04-20T12:20:58Z

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

the web

marcoscaceres · 2021-04-20T12:24:50Z

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

marcoscaceres · 2021-04-21T03:46:06Z

index.html

+                  allowed the `checked` attribute in HTML.
+                </p>
+                <p>
+                  Authors SHOULD NOT use the `aria-checked` attribute on any element where the <a data-cite="html/form-control-infrastructure.html#concept-fe-checked">checkedness</a> of the element can be in opposition to the current value of the <a data-cite="wai-aria-1.1#aria-checked">`aria-checked` attribute</a>.


We should get the HTML folks to export something properly for "checkedness".

marcoscaceres · 2021-04-21T12:54:22Z

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 · 2021-04-26T03:55:54Z

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

jnurthen · 2021-04-26T04:32:58Z

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

This should be resolved. Is it still an issue?

marcoscaceres · 2021-04-26T04:37:15Z

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

patrickhlauke · 2021-04-26T18:58:31Z

@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 · 2021-04-27T00:32:24Z

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.

(as restarting build doesn't seem to work)

patrickhlauke · 2021-04-27T06:34:37Z

@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 · 2021-04-27T23:28:01Z

@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 · 2021-04-28T05:41:43Z

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

chore: fixup data-cite usage

Renamed from "Document conformance requirements for use of ARIA attributes with HTML attributes" to "Requirements for use of ARIA attributes in place of equivalent HTML attributes" ... as this actually makes it more understandable immediately why this table is different from the preceding one. Making it an actual `<section>` makes it appear in the left-hand TOC and gives it a number (3.1)

this was the only place in the whole spec that used "n/a" ... looked ugly/straggly

to avoid the odd-looking clash of "HTML MUST", moved "documents" in this sentence

Only an editorial change that, hopefully, makes it a bit more understandable/readable

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

(as restarting build doesn't seem to work)

… into patrickhlauke-tweaks

patrickhlauke · 2021-04-28T07:26:07Z

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

yes, that seems to have done it

patrickhlauke added 6 commits April 19, 2021 22:12

Make abstract more legible/understandable

e9b4750

Minor grammatical and formatting fix

a664bd4

Change "n/a" to "Not applicable"

eead842

this was the only place in the whole spec that used "n/a" ... looked ugly/straggly

Remove incorrect comma

1813a48

to avoid the odd-looking clash of "HTML MUST", moved "documents" in this sentence

Reword conformance section

5c205be

Only an editorial change that, hopefully, makes it a bit more understandable/readable

patrickhlauke requested review from stevefaulkner and scottaohara April 19, 2021 21:35

patrickhlauke mentioned this pull request Apr 19, 2021

Editorial updates for 1.0 #297

Closed

4 tasks

scottaohara approved these changes Apr 19, 2021

View reviewed changes

patrickhlauke and others added 3 commits April 20, 2021 01:20

Merge branch 'gh-pages' into patrickhlauke-tweaks

23dead4

Further tweak the abstract for better readability/sense

f49bcb2

Merge branch 'patrickhlauke-tweaks' of https://github.com/w3c/html-aria…

835a6ce

… into patrickhlauke-tweaks

marcoscaceres reviewed Apr 20, 2021

View reviewed changes

index.html Outdated Show resolved Hide resolved

patrickhlauke and others added 3 commits April 20, 2021 08:43

Changes suggested by Marcos

921f553

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

Merge branch 'gh-pages' into patrickhlauke-tweaks

2757e3b

Update index.html

5eecaca

marcoscaceres reviewed Apr 21, 2021

View reviewed changes

Merge branch 'gh-pages' into patrickhlauke-tweaks

dee3ad4

Minimal change to retrigger Travis CI

9c84380

(as restarting build doesn't seem to work)

marcoscaceres added 3 commits April 28, 2021 10:29

chore: fixup data-cite usage

68ea03f

Revert accessible name change

0c14420

Remove dfn for aria bibref

70c627b

patrickhlauke and others added 12 commits April 28, 2021 08:19

Merge pull request #310 from w3c/data-cite

74cc9c8

chore: fixup data-cite usage

Make abstract more legible/understandable

f6dec6f

Minor grammatical and formatting fix

a42875d

Change "n/a" to "Not applicable"

943d5dd

this was the only place in the whole spec that used "n/a" ... looked ugly/straggly

Remove incorrect comma

b79675c

to avoid the odd-looking clash of "HTML MUST", moved "documents" in this sentence

Reword conformance section

f017d70

Only an editorial change that, hopefully, makes it a bit more understandable/readable

Further tweak the abstract for better readability/sense

4445451

Changes suggested by Marcos

e40240a

Co-authored-by: Marcos Cáceres <marcos@marcosc.com>

Update index.html

069def7

Minimal change to retrigger Travis CI

7c95ef5

(as restarting build doesn't seem to work)

Merge branch 'patrickhlauke-tweaks' of https://github.com/w3c/html-aria…

8e417e8

… into patrickhlauke-tweaks

patrickhlauke merged commit b65efa2 into gh-pages Apr 28, 2021

patrickhlauke deleted the patrickhlauke-tweaks branch April 28, 2021 07:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editorial changes to structure/prose #306

Editorial changes to structure/prose #306

patrickhlauke commented Apr 19, 2021 •

edited by pr-preview bot

stevefaulkner commented Apr 19, 2021

patrickhlauke commented Apr 19, 2021

scottaohara left a comment •

edited

patrickhlauke commented Apr 20, 2021

scottaohara commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021

scottaohara commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021 •

edited

patrickhlauke commented Apr 20, 2021 •

edited

marcoscaceres commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

marcoscaceres Apr 21, 2021

marcoscaceres commented Apr 21, 2021

marcoscaceres commented Apr 26, 2021 •

edited

jnurthen commented Apr 26, 2021

marcoscaceres commented Apr 26, 2021

patrickhlauke commented Apr 26, 2021 •

edited

marcoscaceres commented Apr 27, 2021

patrickhlauke commented Apr 27, 2021 •

edited

marcoscaceres commented Apr 27, 2021

marcoscaceres commented Apr 28, 2021

patrickhlauke commented Apr 28, 2021

Editorial changes to structure/prose #306

Editorial changes to structure/prose #306

Conversation

patrickhlauke commented Apr 19, 2021 • edited by pr-preview bot

stevefaulkner commented Apr 19, 2021

patrickhlauke commented Apr 19, 2021

scottaohara left a comment • edited

Choose a reason for hiding this comment

patrickhlauke commented Apr 20, 2021

scottaohara commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021

scottaohara commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021 • edited

patrickhlauke commented Apr 20, 2021 • edited

marcoscaceres commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

patrickhlauke commented Apr 20, 2021

marcoscaceres commented Apr 20, 2021

marcoscaceres Apr 21, 2021

Choose a reason for hiding this comment

marcoscaceres commented Apr 21, 2021

marcoscaceres commented Apr 26, 2021 • edited

jnurthen commented Apr 26, 2021

marcoscaceres commented Apr 26, 2021

patrickhlauke commented Apr 26, 2021 • edited

marcoscaceres commented Apr 27, 2021

patrickhlauke commented Apr 27, 2021 • edited

marcoscaceres commented Apr 27, 2021

marcoscaceres commented Apr 28, 2021

patrickhlauke commented Apr 28, 2021

patrickhlauke commented Apr 19, 2021 •

edited by pr-preview bot

scottaohara left a comment •

edited

patrickhlauke commented Apr 20, 2021 •

edited

patrickhlauke commented Apr 20, 2021 •

edited

marcoscaceres commented Apr 26, 2021 •

edited

patrickhlauke commented Apr 26, 2021 •

edited

patrickhlauke commented Apr 27, 2021 •

edited