Add support for the <wpt> element #90

sideshowbarker · 2018-08-26T10:13:55Z

This change adds support for generating output from the <wpt> element, as documented at https://tabatkins.github.io/bikeshed/#wpt-element) and discussed at speced/bikeshed#1116.

Specifically, this change causes lists of tests in <wpt> elements from the source to generate TESTS sections in the spec output, with links to corresponding https://github.com/web-platform-tests/wpt, https://wpt.fyi and https://web-platform-tests.live URLs for the listed tests.

The change by design intentionally doesn’t provide the following <wpt>-related features:

Doesn’t verify that each test listed in a <wpt> element actually exists in https://github.com/web-platform-tests/wpt/
Doesn’t verify that every single test file that exists in the https://github.com/web-platform-tests/wpt/tree/master/html tree is listed in a <wpt> element somewhere in the spec source.

Fixes #87

zcorpan · 2018-08-27T11:15:44Z

src/wattsi.pas

+         WPTOutput.Add('<li class=wpt-test>');
+         WPTOutput.Add('<a href="https://wpt.fyi/results'
+            + WPTPath + '">' + WPTFilename + '</a>');
+         WPTOutput.Add('<a href="http://web-platform-tests.live'


This should have similar logic as

https://github.com/web-platform-tests/wpt.fyi/blob/master/webapp/components/test-runs.html#L74

for http vs https.

zcorpan · 2018-08-27T11:24:04Z

src/wattsi.pas

@@ -2015,6 +2051,41 @@ procedure Save(const Document: TDocument; const FileName: AnsiString; const InSp
      if (Current is TElement) then
      begin
         Element := TElement(Current);
+         // TODO: Move the styles below to https://resources.whatwg.org/spec.css or


Address this

src/wattsi.pas

This change adds support for generating output from the `<wpt>` element, as documented at https://tabatkins.github.io/bikeshed/#wpt-element) and discussed at speced/bikeshed#1116. Specifically, this change causes lists of tests in `<wpt>` elements from the source to generate TESTS sections in the spec output, with links to corresponding https://github.com/web-platform-tests/wpt, https://wpt.fyi and https://web-platform-tests.live URLs for the listed tests. The change by design intentionally doesn’t provide the following `<wpt>`-related features: - Doesn’t verify that each test listed in a `<wpt>` element actually exists in https://github.com/web-platform-tests/wpt/ - Doesn’t verify that every single test file that exists in the https://github.com/web-platform-tests/wpt/tree/master/html tree is listed in a `<wpt>` element somewhere in the spec source. Fixes #87

zcorpan

LGTM except for the TODO

whatwg/wattsi#90

Move to https://resources.whatwg.org/standard.css See whatwg/whatwg.org#230

sideshowbarker · 2018-09-11T02:52:17Z

LGTM except for the TODO

OK, da2eea9 removes the embedded styles, and whatwg/whatwg.org#230 moves them to https://resources.whatwg.org/standard.css

domenic · 2018-10-20T19:27:02Z

The outputted HTML here differs from what I'm seeing in e.g. the bottom of https://quirks.spec.whatwg.org/#the-hashless-hex-color-quirk , which I assume is the HTML produced by Bikeshed. Among other things, this means we can't merge whatwg/whatwg.org#230 because then those styles would mess up quirks.whatwg.org. Probably we should align? :-/

domenic · 2018-10-20T20:13:22Z

Can we omit these from review draft mode?

sideshowbarker · 2018-10-21T04:40:05Z

Can we omit these from review draft mode?

I think we already have it doing that — see 6bb32df. Is that not working as expected?

sideshowbarker · 2018-10-21T04:49:23Z

The outputted HTML here differs from what I'm seeing in e.g. the bottom of https://quirks.spec.whatwg.org/#the-hashless-hex-color-quirk , which I assume is the HTML produced by Bikeshed. Among other things, this means we can't merge whatwg/whatwg.org#230 because then those styles would mess up quirks.whatwg.org. Probably we should align? :-/

OK, to fix that for now, I can update the stylesheet patch to instead use the class name wpt-tests-margin (or whatever — lemme know if you have a suggestion) instead of wpt-tests-block (which is the class name that Bikeshed uses for it’s non-marginal <wpt> output).

Would that be sufficient for now?

Long term, I think @tabatkins has already said he’s supportive of adding support to Bikeshed for also styling the <wpt> output as marginal annotations (at least as a user option) — so I think we can eventually use the same styles.

But for right now, if I just change the class name, that avoids the current conflict. So please lemme know if that would resolve it satisfactorily for the time being.

domenic · 2018-10-21T15:27:09Z

Agreed, let's just change the class name. I'll try doing that and merging myself.

We should come up with a nice long-term plan for the markup and CSS for all of this. See whatwg/meta#117 for my thoughts there. But let's get it all in and working first :).

See whatwg/wattsi#90. Eventually we may use similar styles for <wpt> annotations in specs besides HTML; for now they are using Bikeshed's built-in styles. Unification is tracked at whatwg/meta#117.

sideshowbarker force-pushed the sideshowbarker/wpt-element branch 4 times, most recently from 645ff87 to 05e77f9 Compare August 26, 2018 11:47

zcorpan reviewed Aug 27, 2018

View reviewed changes

zcorpan reviewed Aug 30, 2018

View reviewed changes

src/wattsi.pas Show resolved Hide resolved

sideshowbarker added 4 commits August 30, 2018 11:38

Don’t output TESTS section in developer edition

0c91626

Use test filename to set “live test” URL scheme

597400d

Don’t output TESTS section in review drafts

6bb32df

sideshowbarker force-pushed the sideshowbarker/wpt-element branch from 014ab4d to 1649eff Compare August 30, 2018 15:41

Put <wpt> output in the margin, like caniuse annos

cb86e15

sideshowbarker force-pushed the sideshowbarker/wpt-element branch from 1649eff to cb86e15 Compare August 30, 2018 16:01

zcorpan approved these changes Sep 7, 2018

View reviewed changes

sideshowbarker added a commit to whatwg/whatwg.org that referenced this pull request Sep 11, 2018

Add styles for <wpt> output to standard.css

552fe98

whatwg/wattsi#90

sideshowbarker mentioned this pull request Sep 11, 2018

Add styles for <wpt> output to standard.css whatwg/whatwg.org#230

Merged

Remove embedded CSS styles for <wpt>

da2eea9

Move to https://resources.whatwg.org/standard.css See whatwg/whatwg.org#230

domenic mentioned this pull request Oct 20, 2018

We need a better stylesheet for margin annotations whatwg/meta#117

Open

Rename class

2d87fd7

domenic approved these changes Oct 21, 2018

View reviewed changes

domenic merged commit 1512df5 into master Oct 21, 2018

domenic deleted the sideshowbarker/wpt-element branch October 21, 2018 15:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for the <wpt> element #90

Add support for the <wpt> element #90

sideshowbarker commented Aug 26, 2018 •

edited

Loading

zcorpan Aug 27, 2018

zcorpan Aug 27, 2018

zcorpan left a comment

sideshowbarker commented Sep 11, 2018

domenic commented Oct 20, 2018

domenic commented Oct 20, 2018

sideshowbarker commented Oct 21, 2018

sideshowbarker commented Oct 21, 2018

domenic commented Oct 21, 2018

Add support for the <wpt> element #90

Add support for the <wpt> element #90

Conversation

sideshowbarker commented Aug 26, 2018 • edited Loading

zcorpan Aug 27, 2018

Choose a reason for hiding this comment

zcorpan Aug 27, 2018

Choose a reason for hiding this comment

zcorpan left a comment

Choose a reason for hiding this comment

sideshowbarker commented Sep 11, 2018

domenic commented Oct 20, 2018

domenic commented Oct 20, 2018

sideshowbarker commented Oct 21, 2018

sideshowbarker commented Oct 21, 2018

domenic commented Oct 21, 2018

sideshowbarker commented Aug 26, 2018 •

edited

Loading