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

Editorial for "More details" in collapsible Head #266

Open
koalie opened this issue Nov 3, 2021 · 8 comments
Open

Editorial for "More details" in collapsible Head #266

koalie opened this issue Nov 3, 2021 · 8 comments
Assignees
Labels

Comments

@koalie
Copy link
Contributor

koalie commented Nov 3, 2021

In the p2021 mockups, I love the collapsible Head but I'm bothered by the fact that '"More details" about this document' reads "More details" both when the block is expanded and collapsed (given that it cleverly uses the last state chosen in browser.)

Unless as Denis suggests (in IRC) there's an easy way to update the wording depending on the state with javascript, I suggest to use "Toggle" instead of "More details", so that it's agnostic of the state.

The proposed snippet is:
<summary>Toggle details about this document</summary>

@fantasai
Copy link
Contributor

fantasai commented Dec 8, 2021

One could consider it as reading "More details (in addition to the title / status / date) below"? :)

I think SUMMARY is intended to represent the contents of the DETAILS, not be an action button label, so I would prefer to keep it as something that works similar to a heading...

@fantasai
Copy link
Contributor

We're currently using “More details about this document” which I think works okay. @koalie what do you think, is it okay or do you think we can do better? :)

@koalie
Copy link
Contributor Author

koalie commented Feb 14, 2023

I personally continue to be fooled into thinking there is more to reveal, by a summary that reads "More details" both in expanded and collapsed states. (Think about USB-A where I get to plug it 3 times almost all of the times. It's a similar UX for me.)

Good point about the semantics of summary/details; I had never thought about that.

For me it probably has to do with the arrow icons next to "summary". I think the arrows give me the sense of an action button. Perhaps it would not, if it were "+"/"-".

Also, if I am the only one in over 15 months who said anything about it, it probably is your cue that it's okay as is. Thanks for circling back! Feel free to close the issue as WONTFIX.

@plehegar
Copy link
Member

Feel free to reopen in new ideas come up.

@xfq
Copy link
Member

xfq commented Feb 15, 2023

I also think this is a bit strange, and several people in another thread feel the same way. However, if most people think this is okay, I won't insist.

When I translate specifications into other languages, I usually don't translate this phrase literally, but use phrases like "About this document".

@koalie
Copy link
Contributor Author

koalie commented Feb 20, 2023

Feel free to reopen in new ideas come up.

I have a couple of concrete suggestions to fix this:

  1. change "More details about this document" into "Details about this document"
  2. replace the triangle icons by "+" (for the collapsed state) and "-" (for the expanded state)

Thanks!

@koalie koalie reopened this Feb 20, 2023
@deniak
Copy link
Member

deniak commented Feb 21, 2023

Updating the summary text should be fairly easy. However, changing the default detail/summary marker could result in some accessibility issue as described in a blog post from @scottaohara

@koalie
Copy link
Contributor Author

koalie commented Feb 21, 2023

I chatted recently on social media about this (or rather, watched as experts took the ball and ran with it) and Eric Eggert confirmed that for the WAI subsite, these considerations had been taken into account.

I looked and found a different way to show "+"/"-" next to each other and the other one being striked-through even, for example in this article, if you want to see how it's done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants