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

css-ui-3 ends up describing CSS UI 4 #417

Closed
gsnedders opened this issue Oct 9, 2020 · 6 comments
Closed

css-ui-3 ends up describing CSS UI 4 #417

gsnedders opened this issue Oct 9, 2020 · 6 comments

Comments

@gsnedders
Copy link
Contributor

    {
      "url": "https://www.w3.org/TR/css-ui-3/",
      "seriesComposition": "full",
      "shortname": "css-ui-3",
      "series": {
        "shortname": "css-ui",
        "currentSpecification": "css-ui-4"
      },
      "seriesVersion": "3",
      "shortTitle": "CSS User Interface 3",
      "seriesNext": "css-ui-4",
      "release": {
        "url": "https://www.w3.org/TR/css-ui-3/",
        "filename": "Overview.html"
      },
      "nightly": {
        "url": "https://drafts.csswg.org/css-ui/",
        "repository": "https://github.com/w3c/csswg-drafts",
        "filename": "Overview.html"
      },
      "title": "CSS Basic User Interface Module Level 4",
      "source": "w3c",
      "versions": [
        "https://www.w3.org/TR/css-ui-3/",
        "https://drafts.csswg.org/css-ui/"
      ],
      "crawled": "https://drafts.csswg.org/css-ui/",
      "date": "18 September 2020",
...

This is undoubtedly down to css-ui-3 linking to an unversioned ED. Given it's a REC, it is perhaps slightly harder to change that to be versioned. I wonder if it's worth special-casing css-ui-3 for this?

Related to w3c/csswg-drafts#2941 and w3c/webref#11

@tidoust
Copy link
Member

tidoust commented Oct 12, 2020

This is indeed due to css-ui-3 linking to an unversioned ED that now targets css-ui-4. I am not entirely clear about what the CSS WG resolved to do in the end. Is the end goal to have all /TR/ documents target versioned ED?

So far, the list of specs in browser-specs that Reffy uses typically tracks multiple levels of specs when the current one (as determined by the group) is not the latest one (see spec selection criteria. For instance, there is no entry for the first Pointer Lock recommendation, only one for Pointer Lock 2.0, which is still a Working Draft.

The fact that the CSS WG made the unversioned ED now target level 4 should mean that level 4 is now the current level and supersedes level 3. That suggests that there is no longer any need to track level 3. In other words, instead of special-casing css-ui-3, could we drop it from the list of crawled specs?

Regardless, I note that there are two levels at which the information could be updated:

  1. In the spec itself. I believe that the CSS WG can ask to update the link to the ED in a REC without having to go through an extremely complex process (still more complex than a mere update though)
  2. In W3C databases so that the W3C API returns the versioned ED, which would then get picked up by browser-specs and Reffy. That is something @deniak could probably do. That seems doable for one spec but a bit tedious and error prone if it has to be done for each and every CSS spec.

@gsnedders
Copy link
Contributor Author

I am not entirely clear about what the CSS WG resolved to do in the end. Is the end goal to have all /TR/ documents target versioned ED?

Yes. And I /think/ (but am on the wrong computer and don't have a checkout of TR here) that this is the only REC with an unversioned link.

The fact that the CSS WG made the unversioned ED now target level 4 should mean that level 4 is now the current level and supersedes level 3. That suggests that there is no longer any need to track level 3. In other words, instead of special-casing css-ui-3, could we drop it from the list of crawled specs?

That seems sane! I wasn't quite clear enough on the spec selection criteria, especially for the "tr" view, but that seems sensible reading over it.

I wonder if it makes sense to have some way to audit the current != latest list?

tidoust added a commit to tidoust/browser-specs that referenced this issue Oct 13, 2020
Several CSS specifications, being developed by the CSS WG, supersedes the
previous level, published as a W3C Recommendation (meaning that the series
shortname targets the new level). That suggests that the previous level no
longer needs to be tracked.

This update removes the following CSS Recommendations from the index:
- [CSS Color 3](https://www.w3.org/TR/css-color-3/)
- [CSS Containment 1](https://www.w3.org/TR/css-contain-1/)
- [CSS Fonts 3](https://www.w3.org/TR/css-fonts-3/)
- [CSS Basic UI 3](https://www.w3.org/TR/css-ui-3/)
- [CSS Writing Modes 3](https://www.w3.org/TR/css-writing-modes-3/)
- [CSS Mediaqueries 3](https://www.w3.org/TR/css3-mediaqueries/)
- [CSS Selectors 3](https://www.w3.org/TR/selectors-3/)
- [CSS User Timing 2](https://www.w3.org/TR/user-timing-2/)

See original discussion in:
w3c/reffy#417
@tidoust
Copy link
Member

tidoust commented Oct 13, 2020

Yes. And I /think/ (but am on the wrong computer and don't have a checkout of TR here) that this is the only REC with an unversioned link.

FWIW, the CSS Fonts 3 and CSS User Timing 2 RECs also use unversioned links which target a more recent level.

Also, the CSS Containment 1 REC correctly links to a versioned ED, but the W3C API returns the unversioned ED for this one, which seems wrong. I'll have it fixed.

I wonder if it makes sense to have some way to audit the current != latest list?

I had a look and indeed found a few specs in that situation. I created a PR on browser-specs accordingly, see w3c/browser-specs#174.

The browser-specs index does not (yet?) track the TR status of a spec, so the audit cannot easily be automated for now, as we probably want to keep tracking the following specs that are still being worked upon (not published as a Rec yet), even though there exists a more recent level:

@gsnedders
Copy link
Contributor Author

It's interesting comparing this with what Shepherd believes is "current work" on https://drafts.csswg.org / https://drafts.fxtf.org:

Current work is CSS Compositing 2 (Level 1 is effectively a branch heading towards REC at this point)

Is… probably right? And matches the current work tag.

Current work is L4, L3 is effectively a REC branch.

Current work is L4, L3 is effectively a REC branch.

Current work is L4, L3 is effectively a REC branch.

@tidoust
Copy link
Member

tidoust commented Oct 13, 2020

Shepherd, browser-specs, and /TR/, should ideally all agree on which level is "current work". I fixed browser-specs for CSS Box 3, since it should have been flagged as "current". I also raised an issue to retrieve that info from the W3C API in the future, not to have to maintain it manually.

The rest of the list seems correct. That is precisely how I generated the list in the first place: specs that are not yet REC and that have a more recent level which is flagged as "current work".

@tidoust
Copy link
Member

tidoust commented Oct 14, 2020

The W3C API now returns versioned ED for css-contain-1, and css-fonts-3 and css-ui-3. These updates shipped in v1.18.1 of browser-specs, integrated in Reffy through #421.

We're still figuring out whether and when to drop levels from browser-specs (see w3c/browser-specs#174), and how to detect potential hiccups. In the meantime, the reported issue no longer exists, and css-ui-3 properly describes css-ui-3 again. I'm closing this issue accordingly.

(That said, note that the issue still exists for user-timing-2 but there is no versioned ED that I'm aware of for that one...)

@tidoust tidoust closed this as completed Oct 14, 2020
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

No branches or pull requests

2 participants