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

Modify title element for screen reader users #23

Open
jnurthen opened this issue Oct 16, 2018 · 7 comments
Open

Modify title element for screen reader users #23

jnurthen opened this issue Oct 16, 2018 · 7 comments

Comments

@jnurthen
Copy link

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 the title to
"Preview of PR xxx: "

@tobie
Copy link
Owner

tobie commented Dec 14, 2018

That's a great idea. It would need to happen on ReSpec and Bikeshed themselves. Pinging @marcoscaceres and @tabatkins.

@tabatkins
Copy link

Bikeshed allows you to specify different values for <title> and <h1>; the Title metadata covers both by default, but H1 will provide a different value for the <h1> instead.

So presumably pr-preview could fill that in or something?

@tobie
Copy link
Owner

tobie commented Dec 14, 2018

ReSpec has a preview template and it makes changing these things way easier.

@tobie
Copy link
Owner

tobie commented Dec 15, 2018

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.

@tobie
Copy link
Owner

tobie commented Dec 15, 2018

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.

@tabatkins
Copy link

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.

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.

@marcoscaceres
Copy link

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.

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

No branches or pull requests

4 participants