openlibhums / openlibhums/janeway

Add ARIA attributes to DOI display throughout Janeway interface

Open
#3,259 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new feature
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.

Crossref are proposing an update to their display guideline to add ARIA attributes to the HTML used to display DOIs. As Janeway administrators and Crossref members who support websites which are accessible to all, we would like to run a trial of their proposal.

Crossref rationale:

DOIs and URLs themselves don’t really tell readers much. People with visual impairments rely on screen readers to read out loud the contents of a page. We’re asking for the title of each DOI to be added, in an ARIA (Accessible Rich Internet Applications) attribute, so these users understand what these links are for.
Accessible text, as this kind of description is known, should be included for all links, but at this time, we’re specifically recommending it for landing pages of newly registered records.

Describe the solution you'd like
Wherever Hyperlinked DOIs are displayed in the Janeway user interface, add aria-label with the text DOI for [object type]: [object title].

Examples:

  • Journal article: <a href="https://doi.org/10.5555/12345678" aria-label="DOI for journal article: Toward a Unified Theory of High-Energy Metaphysics: Silly String Theory">https://doi.org/10.5555/12345678</a>
  • Preprint: <a href="https://doi.org/10.5557/12345670" aria-label="DOI for preprint: Silly string and its application to pies">https://doi.org/10.5557/12345670</a>

Additional context

Crossref only recommend the format "DOI for [object title]", however we recommend adding the extra "[object type]" data based on some feedback from Google Scholar during a recent meeting.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Janeway codebase for every template or entry point that renders a hyperlinked DOI, then review how the journal article and preprint examples are displayed. Confirm that each relevant interface occurrence has the requested object type and title in its accessible label, and check the affected pages manually for consistent output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
accessibility, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.