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

Export all algorithms (as algorithms) #451

Merged
merged 2 commits into from
Apr 22, 2022
Merged

Conversation

eeeps
Copy link
Contributor

@eeeps eeeps commented Apr 13, 2022

As discussed in WICG/client-hints-infrastructure#107 (comment)

A couple of these were already exported, but not as algorithms. I assume this change will break incoming links; is there an easy way to see existing incoming links?

@clelland
Copy link
Collaborator

Unfortunately not; I think there is work being done on a spec cross-references database, but I don't think anything is available yet.

Thanks for doing this! I'll check it out and make sure the rendered HTML is okay, and merge it.

@johannhof
Copy link
Member

Maybe I misunderstand what you're trying to do, but does https://dontcallmedom.github.io/webdex/ help? :)

@clelland
Copy link
Collaborator

That's exactly what I was thinking of, thank you! Now to see if it can find this, or just already-properly-exported definitions

@clelland
Copy link
Collaborator

It doesn't look like it breaks links to actual fragments -- anything which was linking to #algo-foo will still work; the ids haven't changed.

Internal links that just used <a> seem to be broken by this, though. (See, for example, step 3 in algorithm 9.1: It reads "Let policy be the result of executing Construct policy from dictionary and origin on parsed header and origin.", and "Construct policy from dictionary and origin" should be linked to algorithm 9.2)

I think the solution here is to change the <a> in that case to <a abstract-op>; that seems to restore the link in the rendered output.

@eeeps
Copy link
Contributor Author

eeeps commented Apr 19, 2022

Ok. I think I got them all @clelland, but please review!

@eeeps
Copy link
Contributor Author

eeeps commented Apr 21, 2022

Note that the original reason for this PR, WICG/client-hints-infrastructure#107, no longer needs this; sounds like <meta name=accept-ch> will use its own new syntax/parsing algorithm.

It still might be a good idea to export all of the Permissions Policy algorithms, and it definitely seems like a good idea to classify them as abstract-ops rather than generic dfns.

@clelland
Copy link
Collaborator

Agreed -- and I think you got all of the references; I didn't see any go missing when I re-rendered the output.
Merging this now, thanks!

@clelland clelland merged commit aa1a065 into w3c:main Apr 22, 2022
@eeeps eeeps deleted the export-algos branch April 22, 2022 22:00
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