-
Notifications
You must be signed in to change notification settings - Fork 17
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
Modify title element for screen reader users #23
Comments
That's a great idea. It would need to happen on ReSpec and Bikeshed themselves. Pinging @marcoscaceres and @tabatkins. |
Bikeshed allows you to specify different values for So presumably pr-preview could fill that in or something? |
ReSpec has a preview template and it makes changing these things way easier. |
More clearly, for PR Preview to be able to prefix the title element, it would either need to do some parse and replace on the output of the Bikeshed server, or request that every config file also include the title of the spec. On the other hand, if Bikeshed had a preview template or mode, the prefixing could be automatic. |
Now if you wanted titles to just be "Preview of PR ###" without any reference to the title of the document itself, than that's a lot easier to organize on my side. |
Hm, Bikeshed could use a fix here. I compute all the macros and sub them in when doing "computed-metadata" defaults, but I don't provide that for anything else. So you can't "build on" the existing [TITLE] macro from command-line metadata. But I'm not opposed to having a special-purpose mode that amends the title for you and maybe adds some metadata to the header. |
Filed https://github.com/w3c/respec/issues/2030 on the ReSpec side. As it's a "good first issue," trying to find someone to work on it. |
When viewing a preview there is a really prominent notice so visual users know they are viewing the preview version. Screen reader users are unlikely to get to this content as they are not likely to read that part of the document.
I suggest modifying the document
title
element with a short prefix to denote that this is a preview. For example modify thetitle
to"Preview of PR xxx: "
The text was updated successfully, but these errors were encountered: