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 metadata to collapse "more details" and "status" sections #3025

Open
jyasskin opened this issue Feb 5, 2025 · 3 comments
Open

Add metadata to collapse "more details" and "status" sections #3025

jyasskin opened this issue Feb 5, 2025 · 3 comments

Comments

@jyasskin
Copy link
Collaborator

jyasskin commented Feb 5, 2025

In https://w3ctag.github.io/explainers/, I'd like the "More details about this document" and "Status of this document" to start collapsed, so that people reading the document get right to the advice. I could do that by locally overriding header.include, but then we don't get any future updates to the w3c default.

My theory is that the way to do this is to add a metadata "Collapse-Metadata: boolish", which defines an empty [COLLAPSE-METADATA] text macro, and then use that in w3c/header.include to remove [open] from the More details <details> and wrap the Status section with a <details>. I'll start on that, but I wanted to file an issue to see if there's a better way.

@jyasskin
Copy link
Collaborator Author

jyasskin commented Feb 7, 2025

It turns out that pubrules currently rejects documents with these changes. I've filed w3c/specberus#1919 and w3c/specberus#1920 to try to loosen that up.

I also wrote a change to implement this, at main...jyasskin:bikeshed:collapse-metadata, but I'll wait to send it until I know whether pubrules will accept the change.

@tabatkins
Copy link
Collaborator

We can make this a little simpler, fwiw: set COLLAPSE-METADATA to "open" when the pref is true. Then you can just write <details [COLLAPSE-METADATA?] ...> in the boilerplate, rather than duplicating the element.

@jyasskin
Copy link
Collaborator Author

I think that's [OPEN-METADATA] that's "open" when Collapse-Metadata is no, so that it can also be used in include-if. Perhaps that means that it should be Open-Metadata defaulting to yes?

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