IQSS / IQSS/dataverse

Feature Request/Idea: Improve alt text for image files in datasets

Open
#8,370 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Accessibility
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
When a dataset's image file is displayed, it might improve accessibility if its alt text is more descriptive.

As of Dataverse v5.9, image files in datasets are displayed as thumbnails on several pages, including in the search cards on search pages and in the "Files" tab on dataset pages, and the alt text for those image displays seem to be either the dataset title or the name of the image file, depending on where the thumbnail appears.

When the image is displayed on the File page in the "Metadata" tab, the alt text is the name of the image file. When it's displayed on the "Preview" tab by the Previewers tool, the alt text is an empty string.

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
Curator, Depositor, Guest

What inspired the request?
A depositor recently emailed a repository to ask how they could include a description of their images that can be used for the alt text.

What existing behavior do you want changed?
When the images in datasets are displayed, e.g. in thumbnails and on the file pages, the value for the alt text attribute can be something that the dataset depositor or a curator can define instead of using the file's name or the dataset title.

Any brand new behavior do you want to add to Dataverse?
Allowing the depositor or curator to define the alt text might be done by adding a field at the file level for entering alt text or using what's entered in the file's Description field.

Any related open or closed issues to this feature request?

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

Start by reviewing the image displays in search cards, the dataset Files tab, the File page Metadata tab, and the Previewers tool's Preview tab. Determine how a depositor or curator could define alt text, then verify that the chosen value is used consistently for the listed image displays.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
accessibility
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.