Problem/Motivation

Lots of people have trouble writing good alt text.

We can improve this by providing a help page which documents some best practices. In Drupal 8 we required alt-text by default, but we didn't do much to explain how to write good alternative text.

As part of the We4Authors Cluster https://accessibilitycluster.com one recommendation is to provide clear help text that is linked to from alt text fields. https://www.funka.com/en/projekt/cluster-feature-testing/feature-3-of-10...

API changes

None

Data model changes

None

Comments

mgifford created an issue. See original summary.

ajv009’s picture

ajv009 commented

Maybe instead of creating a complete page just to explain alt-text, maybe we should just display a default text created from the file uploaded.
Ex. SOMe-fIlE__somE-filE--123ThiS_FiLe.txt
Alt-text: "Some File Some File 123 This File"

mgifford’s picture

mgifford
he/him
Primary language English
commented

@AJV009 sadly that approach is not accessible. Many CMS have tried this or variations, but far too often the filenames really don't make sense out of context. They also really don't make sense in the context of the article that is being written.

For more information see:
https://webaim.org/techniques/alttext/

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Version: 10.0.x-dev » 9.3.x-dev

It is not possible to create new help pages using hook_help(), which only allows each module to have one help page.

In the new help system, we already have a topic about accessibility, which you can see in
core/modules/help_topics/help_topics/core.ui_accessibility.html.twig

Maybe you could review that topic, and see if you'd like to add anything to it, including more information (maybe?) about good alt text? That could be done in 9.3.x.

As a note, the plan is once help_topics is stable, to merge it into help.module, so this topic might be moving to a new home (hopefully soon!). I think it would end up in a new directory called:
core/help_topics

mgifford’s picture

mgifford
he/him
Primary language English
commented

Here's an example from the We4Authors Cluster review of authoring tools and ways to better support authors https://accessibilitycluster.com/main-results/text-alternative-feature-%...

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.

heddn’s picture

heddn
Primary language English
Location Illinois
commented
Component: help.module » image.module
Status: Active » Closed (duplicate)
Related issues: +#3171916: Add Help for Image Fields

This sure seems like a duplicate of #3171916: Add Help for Image Fields.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.