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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Export user activation gated APIs for linking from other specs. #7300

Merged
merged 5 commits into from
Nov 9, 2021
Merged

Export user activation gated APIs for linking from other specs. #7300

merged 5 commits into from
Nov 9, 2021

Conversation

mustaqahmed
Copy link
Contributor

@mustaqahmed mustaqahmed commented Nov 5, 2021 •
edited by pr-preview bot

This PR makes activation gated API types available as external reference points.

  • At least two implementers are interested: not applicable.
  • Tests: not applicable.
  • Implementation bugs: not applicable.

(See WHATWG Working Mode: Changes for more details.)

馃挜 Error: Wattsi server error 馃挜

PR Preview failed to build. (Last tried on Nov 9, 2021, 4:42 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

馃毃 Wattsi Server - Wattsi Server is the web service used to build the WHATWG HTML spec.

馃敆 Related URL

<html>
<head><title>524 Origin Time-out</title></head>
<body bgcolor="white">
<center><h1>524 Origin Time-out</h1></center>
<hr><center>cloudflare-nginx</center>
</body>
</html>

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

domenic
domenic approved these changes Nov 5, 2021
View reviewed changes
Copy link
Member

@domenic domenic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me as these are useful concepts to talk about. I'm a little worried people will do something like "This API is a [transient activation-consuming API]" instead of properly writing an algorithm step to consume user activation, but that's not a reason to block :).

Probably we should add lt="transient-activation-consuming API", i.e. the non-plural version, as the main term for each of these?

@mustaqahmed
Copy link
Contributor Author

Makes sense to me as these are useful concepts to talk about. I'm a little worried people will do something like "This API is a [transient activation-consuming API]" instead of properly writing an algorithm step to consume user activation, but that's not a reason to block :).

Hmm, I realized that I am doing exactly that in w3c/pointerlock#76! But that would still be an improvement---it would become a stepping stone for an algorithmic rewrite. So "no a reason to block" applies 馃榿.

Probably we should add lt="transient-activation-consuming API", i.e. the non-plural version, as the main term for each of these?

PTAL, did you mean this?

@domenic
Copy link
Member

domenic commented Nov 5, 2021

No, I meant keep the data-x as-is, but add a lt="" attribute. Unfortunately we have both data-x="" and lt="" because HTML is a special snowflake.

Also I guess be careful on the hyphens and use the style that we see in the spec, not in the source code, i.e. lt="transient activation-consuming API". I did the wrong thing in my suggestion above.

@mustaqahmed
Copy link
Contributor Author

ptal. Looks like data-x with hyphen-separated-words works?

@domenic
Copy link
Member

domenic commented Nov 8, 2021

Sorry, I must not be communicating clearly.

  • The data-x values are fine as-is. Let's not change them at all in this PR (and undo the changes you've done so far).

  • We want to ensure that, in addition to adding the export attribute, we also add lt="" attributes with non-pluralized linking text.

So, the end result should be something like this:

  • Before: <dfn data-x="sticky activation gated api">Sticky activation-gated APIs</dfn>
  • After: <dfn export data-x="sticky activation gated api" lt="sticky activation-gated API">Sticky activation-gated APIs</dfn>

@mustaqahmed
Copy link
Contributor Author

So, the end result should be something like this:

  • Before: <dfn data-x="sticky activation gated api">Sticky activation-gated APIs</dfn>
  • After: <dfn export data-x="sticky activation gated api" lt="sticky activation-gated API">Sticky activation-gated APIs</dfn>

To be frank, that's how I interpreted your suggestion originally. But my local html-build complained with lt= which then got me lost between data-x=, data-lt= and lt=! Don't know how to resolve it. Here is my patch in case the bot build is happy with it (otherwise I would need help).

@domenic
Copy link
Member

domenic commented Nov 9, 2021

Oh my goodness, I am so sorry, I forgot that for whatever dumb reason we decided to require data-lt="" instead of lt="". I will push a commit to fix, and then merge for you, in penance :)

@domenic domenic merged commit 54bff73 into whatwg:main Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@domenic domenic domenic approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@mustaqahmed @domenic