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

Make Valid Usage blocks collapsible #22

Open
SaschaWillems opened this issue Sep 15, 2023 · 4 comments
Open

Make Valid Usage blocks collapsible #22

SaschaWillems opened this issue Sep 15, 2023 · 4 comments
Assignees
Labels
component Fix or change to an antora component repository needed documentation Improvements or additions to documentation

Comments

@SaschaWillems
Copy link
Collaborator

SaschaWillems commented Sep 15, 2023

Some of the Valid usage blocks are extremely large. For chapters that have multiple such blocks this makes it hard to find the actual spec text. E.g. the Drawing Commands chapter. This makes it unnecessary hard to read.

(edit @oddhack: note this is also tracked in internal vulkan/vulkan issue 2889).

@SaschaWillems SaschaWillems changed the title Make VUIDs collapsible Make Valid Usage blocks collapsible Sep 15, 2023
@oddhack
Copy link
Collaborator

oddhack commented Sep 19, 2023

This is tricky. AFAICT if we default to making VUID blocks collapsed, then opening a deep link to a VUID will not show it. If we don't default to that, then the OOTB behavior is as you say.

This isn't an Antora issue, the same thing exists in the currently published specs and there's an internal issue about it in the vulkan spec repo, but no agreed path forward.

@oddhack oddhack added documentation Improvements or additions to documentation component Fix or change to an antora component repository needed labels Jan 29, 2024
@oddhack oddhack self-assigned this Jan 29, 2024
@oddhack oddhack added this to the For Discussion milestone Jan 30, 2024
@oddhack
Copy link
Collaborator

oddhack commented Mar 26, 2024

@gpx1000 suggested that we could use JS that would have access to not just the URL, but the anchor in the DOM, so that if you opened the site as explicitly ...#VUID-... it could uncollapse the VUs, and otherwise collapse them. Also that there could be persistent state in the form of a cookie to record the user preference.

@SaschaWillems
Copy link
Collaborator Author

Sounds like an option. Cookies might be problematic though, at least for people from countries that fall under the GDPR (e.g. all of the EU).

@oddhack
Copy link
Collaborator

oddhack commented Mar 26, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component Fix or change to an antora component repository needed documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants