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

Allow a collapsible SotD section #1919

Open
jyasskin opened this issue Feb 6, 2025 · 2 comments
Open

Allow a collapsible SotD section #1919

jyasskin opened this issue Feb 6, 2025 · 2 comments

Comments

@jyasskin
Copy link
Member

jyasskin commented Feb 6, 2025

If I edit a spec to turn the

<h2>Status of this document</h2>
Section contents

into

<details>
  <summary><h2>Status of this document</h2></summary>
  Section contents
</details>

it starts failing pubrules with There must be a status section that follows the abstract, labeled with an h2 element with content "Status of This Document". The Team maintains the status section of a document. Obviously there is a status section here; Specberus just doesn't know to look inside the <details> for it.

I'd like to do this for https://w3ctag.github.io/explainers/, where ideally people reading it would start their experience by looking at the document's actual content, and not the W3C's metadata.

@deniak
Copy link
Member

deniak commented Feb 7, 2025

A good number of pubrules' checks are related to the SotD which lists some important bits (stability of the document, IPR, process document, etc). Most web developers won't care about that section but it's not clear to me if we could/should make it less visible.

Also, having a <h2> in the summary can cause some alignment issues (see screenshot below). We could tweak the stylesheet but I'm not a big fan of that option. The alternative would be to not use a heading but it will make the section even less visible.

Image

/cc @plehegar

@jyasskin
Copy link
Member Author

jyasskin commented Feb 8, 2025

The style problem, aside maybe from some margin collapsing, is fixed with

<details><summary style="list-style-position:outside">
 <h2 style="display:inline-block">...

Screenshot of the "Status of this document" section with improved vertical spacing

Documents that want to do this could keep that style inline if folks don't think it belongs in the main stylesheet.

I think it's important that the information be there, but that most readers are skipping over this section anyway when they look at our documents.

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