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

Include string in 2nd segment of HTML title tag to indicate page is part of APG #31

Closed
shawna-slh opened this issue Apr 8, 2022 · 7 comments

Comments

@shawna-slh
Copy link
Contributor

straw proposal:

text-of-h1 | ARIA Authoring | WAI | W3C

@mcking65
Copy link
Contributor

mcking65 commented May 2, 2022

@shawna-slh

I agree this is a very important issue, and we need to resolve it before launch.

The current HTML title is:

text-of-h1 | WAI | W3C

To be consistent with what we have requested for the URI in #37, I'd like to suggest that we change the HTML title on all pages except the home page to:

text-of-h1 | APG | WAI | W3C

This is another situation where brevity adds a lot of value, especially for zoom and screen reader users.

@mcking65 mcking65 changed the title HTML title Include string in 2nd segment of HTML title tag to indicate page is part of APG May 2, 2022
@richnoah
Copy link

richnoah commented May 3, 2022

@mcking65 @shawna-slh we are currently not able to add | APG | to the string. The API takes the h1 for the page and adds | WAI | W3C to it. We do not have a means of appending to it.

This was after investigating the docs at https://wai-website-theme.netlify.app/writing/frontmatter/#title, the example config at https://github.com/w3c/wai-resource-template/blob/master/_config.yml, and I searched the entire WAI Resource template at https://github.com/w3c/wai-resource-template and the entire WAI theme.

An override would not work in this instance. Both the h1 and title tag should work even if JS is turned off. Since these elements are heavily used by search engines and bots it is advisable to not implement an override.

@shawna-slh
Copy link
Contributor Author

@SteveALee Feel free to address this directly, or talk with me first, as you wish. :-)

@SteveALee
Copy link
Contributor

The latest version of standalone_resource layout now supports the following in front matter and config.yml

  • type_of_guidance text will appear in HTML head title (eg browser tab) - eg APG
  • type_of_guidance missing or false then no text in HTML head title
  • type_of_guidance_in_content set to true will make text also appear above H1 on a page

So I suggest you set type_of_guidance: APG in config.yml so appears in ALL page titles only

@shawna-slh
Copy link
Contributor Author

I think I updated this info somewhere, but can't find it. So I'm adding it here for the record.

My preference is to include ARIA:

text-of-h1 | ARIA APG | WAI | W3C

Yet I'm OK without ARIA as Matt prefers:

text-of-h1 | APG | WAI | W3C

@richnoah richnoah moved this from Next Up to In progress in Launch APG redesign on w3.org/wai site May 9, 2022
@mcking65 mcking65 mentioned this issue May 10, 2022
@richnoah richnoah moved this from In progress to In Review in Launch APG redesign on w3.org/wai site May 10, 2022
@mcking65
Copy link
Contributor

I have reviewed the preview of #62, and this issue is addressed.

@mcking65
Copy link
Contributor

Verified still fixed after today's changes to #62.

@richnoah richnoah moved this from In Review to Done in Launch APG redesign on w3.org/wai site May 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

4 participants