openlibhums / openlibhums/janeway
Make Page Titles meaningful and consistent
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Page titles need to be updated
Requirement
See WCAG 2.4.2
Web pages have titles that describe topic or purpose.
...
Examples
...
A set of web pages
The title of the landing page is "ARIA Authoring Practices Guide | APG | WAI | W3C"
- The patterns list page has the title "Patterns | APG | WAI | W3C"
- Specific patterns are pages titled "X Pattern | APG | WAI | W3C" (e.g., "Alert and Message Dialogs Pattern | APG | WAI | W3C")
- Specific examples for each pattern are pages titled "X Example | APG | WAI | W3C" (e.g., "Alert Dialog Example | APG | WAI | W3C")
- Practices page has the title "Practices | APG | WAI | W3C"
- Index page has the title "Index | APG | WAI | W3C"
Audit results
From A11y audit, #5146
Testing showed that our page titles are not consistent. That some default to the Journal Name, that many do not include orientating information such as the section or journal or press.
examples:
Article - article_name | Journal name
Issues - Issues
Issues [Clean] - journal_name
Articles - Articles
Collections - journal_name | Collections:
News Item - News - news_title
News Item [Clean] - news_title
Journals - press_name | Journals
Journals [OLH] - press_name
Work to do
- decide on a pattern that fits our set of pages. It should orientate as well as inform as per hte example above.
- consider how to handle the OLH site. In order to orientate users between press and journal level, having press and journal both named the same means additional context is needed beyond just using their names to distinguish between press and journal.
- update all title templates to follow this pattern.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the audit findings from #5146 and compare the listed page-title examples against the WCAG 2.4.2 requirement. Locate the title templates producing the inconsistent formats, decide a pattern that distinguishes press and journal levels, and update all templates so page titles consistently describe their topic or purpose.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- accessibility, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100