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

Add https://www.w3.org/TR/test-methodology/ #775

Merged
merged 1 commit into from
Nov 25, 2022
Merged

Conversation

darobin
Copy link
Member

@darobin darobin commented Nov 17, 2022

I believe that this document is eligible under criterion 4, specifically "it contains informative content that other specs often need to refer to (e.g. guidelines from horizontal activities such as accessibility, internationalization, privacy and security)." I discovered that it was missing by trying to reference the dfn for testable assertion which I believe to be a rather central concept.

I believe that this document is eligible under criterion 4, specifically "*it contains informative content that other specs often need to refer to (e.g. guidelines from horizontal activities such as accessibility, internationalization, privacy and security)*." I discovered that it was missing by trying to reference the `dfn` for `testable assertion` which I believe to be a rather central concept.
@dontcallmedom
Copy link
Member

I think adding the doc to the web-specs list is uncontroversial; unfortunately, doing that in the current form of the Note won't get you what you want, since the Note doesn't use the data-export convention that is expected before a definition shows up in xref via webref. (I can't even blame the incompetence of the editors of that document since these conventions didn't exist back then)

That could be fixed in several ways:

  • republishing the Note with improved markup; I think adding data-export could be construed as a class 1 change and so could be done by the Team, or if it's not, it could be done as a candidate correction.
  • find a new group to own (and possibly republish) the document; I could imagine the Spec Editors Community Group being the right place to start an editors draft (although I'm not sure we have a clear process to authorize a CG to take over maintenance of a WG Note); just having something that can be documented as an editors draft would suffice in getting the right data extracted down the line

@darobin
Copy link
Member Author

darobin commented Nov 21, 2022

Damn, foiled at every step!

If people want to start working on this document again, I certainly would support that. However, apart from the examples and the format that are quite dated, does it need much change? I suspect it can stay as is, and so a class 1 change would seem to be the better avenue. I can provide an updated HTML source if it help?

One alternative I thought of: we could have a legacy mode for extraction, defined as just grabbing all the dfn. Then we could have "https://www.w3.org/TR/test-methodology/ legacy" in there and just make changes to the toolchain?

@dontcallmedom
Copy link
Member

assuming legacy would only target <dfn> with an id attribute, there is some precedent for that with the ecmascript extraction. @tidoust, thoughts?

@tidoust
Copy link
Member

tidoust commented Nov 21, 2022

Some sort of legacy mode was also what came to mind when I read this. I created w3c/reffy#1115 to track this in Reffy. On top of my head, I would rather suggest something slightly more specific than a legacy that does not really say much as to what we consider to be legacy, as in:

{
 "url": "https://www.w3.org/TR/test-methodology/",
 "dfns": "tags only"
}

@darobin
Copy link
Member Author

darobin commented Nov 21, 2022

That works for me just as well!

@tidoust
Copy link
Member

tidoust commented Nov 25, 2022

No need to flag the spec in any way in browser-specs after all. Next version of Reffy will automatically detect legacy specs for dfns and export dfns from legacy specs.

@tidoust tidoust merged commit a282c6d into w3c:main Nov 25, 2022
@darobin
Copy link
Member Author

darobin commented Nov 28, 2022

This is excellent — thanks @tidoust! Hannibal voice, chewing on a cigar: I love it when a plan comes together without even having to change anything on my side!

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.

3 participants