Problem/Motivation

Theme screenshot alt-text and theme descriptions need improved text to provide more detailed explanations of the features supported by the theme (especially for non-sighted admins). Review and update as needed the text for all themes.

Every screen-shot has the alt text "Screen-shot for [theme-name] theme".

Originally the proposal included updating tags as well. However, tags were removed in #2471619: Remove tags from all core theme.info.yml files.
The description and alt text on Drupal 9.4.x.
Bartik
description: 'A flexible, recolorable theme with many regions and a responsive, mobile-first layout.'
Seven was fixed in [#2193691
description: 'The default administration theme for Drupal 8 was designed with clean lines, simple blocks, and sans-serif font to emphasize the tools and tasks at hand.'
alt text: 'Default administration theme for Drupal 8 with simple blocks and clean lines.'
Claro
description: 'A clean, accessible, and powerful Drupal administration theme.'
alt text: 'Screenshot of Claro, Drupal administration theme.'
Olivero
description: 'A clean, accessible, and flexible Drupal front-end theme.'
alt text: 'Screenshot of Olivero, Drupal front-end theme.'
Stark
description: 'An intentionally plain theme with no styling to demonstrate default Drupal’s HTML and CSS. Learn how to build a custom theme from Stark in the Theming Guide.'

Steps to reproduce

Proposed resolution

Bartik from #922696: Follow-up: New methods, standards for describing core themes on themes admin page (was Theme screenshots do not have adequate alt text...)
description:

  1. Responsive mobile first layout with multiple regions for layout flexibility. Customisable color schemes.
  2. Clean typography with serif fonts in a mobile-first layout. The color scheme can be customized. Multiple regions for content provide a lot of layout flexibility.

alt text: TBD

Seven was fixed in #2193691: New methods, standards for describing Seven themes admin page
description: 'The default administration theme for Drupal 8 was designed with clean lines, simple blocks, and sans-serif font to emphasize the tools and tasks at hand.'
alt text: 'Default administration theme for Drupal 8 with simple blocks and clean lines.'

Claro
description: TBD
alt text: TBD

Olivero
description: TBD
alt text: TBD

Stark
description: TBD
alt text: TBD

Remaining tasks

Suggest new wording/Write a patch.
Add screenshots to show visual changes the patch makes.
Review the patch.

User interface changes

Adds more detailed explanations of the features supported by the theme.

API changes

N/A

Data model changes

N/A

Release notes snippet

Original report by Everett Zufelt

On /admin/appearance there is a list of all Core themes. Each theme provides a screen-shot, a name, and a description.

1. Every screen-shot has the alt text "Screen-shot for [theme-name] theme".

2. The theme descriptions are inconsistent in how they describe the themes.

3. None of the theme descriptions are close to being sufficient to inform a blind administrator about how the theme looks or how its regions are laid out.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

peterx’s picture

I know of only one blind site admin and, unfortunately, he does not use Drupal. Do we have someone to test this change?

We could find out what interests people by looking at searches on https://www.drupal.org/project/project_theme.
We then have to weed out the subjective things because everyone labels their themes as powerful, simple.

Responsive is the first thing I would add.

Does it require SASS or composer or anything external? That is something to avoid for many sites.

You can count the number of regions as an indicator of flexibility.

People seem to like grid systems then argue over the specific grid. 960 is probably the most useful option.

Wireframes?

What would be useful and could be checked objectively?

Jeff Burnz’s picture

the alt text is probably the most important thing. Personally I want parity with modules, so we can group themes, set dependancies etc, such as require by, requires etc.

peterx’s picture

Classy has the following description:
description: 'A base theme with sensible default CSS classes added. Learn how to use Classy as a base theme in the Drupal 8 Theming Guide.'

I suggest we reuse the module config link idea for documentation. Make a documentation page a standard requirement for core themes and modules.

documentation:
    url: https://www.drupal.org/theme-guide/8
    title: Drupal 8 Theming Guide

For things like SASS:

uses:
    SASS

SASS could then be selectable in the list.

Jeff Burnz’s picture

@perterx, yeah, that would totally awesome, it's horrible how we have to write stuff like this into the description.

emma.maria’s picture

Assigned: Unassigned » emma.maria
emma.maria’s picture

Assigned: emma.maria » Unassigned
alvar0hurtad0’s picture

Status: Active » Needs review
FileSize
691 bytes

IMHO this is the patch

emma.maria’s picture

Title: New methods, standards for describing Bartik themes admin page » New methods and standards for describing Bartik on the theme admin page
Issue summary: View changes
Issue tags: -Accessibility +Needs usability review, +Needs accessibility review

Updated the issue summary to make it easier to follow.
Everything was outlined in detail in #922696: Follow-up: New methods, standards for describing core themes on themes admin page (was Theme screenshots do not have adequate alt text...).
This is just the specific follow up ticket for the work for Bartik.

emma.maria’s picture

Issue summary: View changes
emma.maria’s picture

Patch review of #7

- The screenshot text is correct.
- The new description text is taken from @yoroy's take on the new text which I approve of - see https://www.drupal.org/node/922696#comment-7963475.

My only query is where are the tags used? And what tags do we have to choose from?
I looked at Seven's tags and also asked @lewisnyman and we can't find where these tags are used. I can see the use of them for contrib but are they used/needed for default themes that are not listed on drupal.org in the same way?

alvar0hurtad0’s picture

About the tags, the patch uses: responsive, fixed width, 3 column, customizable color.

Seven has: multi-column, fluid, responsive, sans-serif, accessible

I can change the tags, what do you think?

Jeff Burnz’s picture

Status: Needs review » Needs work

Like emma I don't see the point of tags in core themes, they serve no purpose.

FWIW though Bartik is not a fixed width design in the classic sense of a fixed width design.

Other than that I never quite understood what "clean typography" is, I think a better description is that it's minimalist.

Jeff Burnz’s picture

Is there actually an issue for using this alt text? If there is can someone please add it as the parent or related issue, otherwise I think we really need to be doing that first.

emma.maria’s picture

So I think for this issue we should focus on just the description and the alt text.

We have agreed above that tags might be pointless for core themes, we can spin this discussion off into a separate issue to discuss.

Issue for this #2471619: Remove tags from all core theme.info.yml files.

Alt text concerns

The issue summary stated that the alt text should be as follows ....

1. Every screen-shot has the alt text "Screen-shot for [theme-name] theme".

However in the Seven version of this issue #2193691: New methods, standards for describing Seven themes admin page which had the exact same guidelines, they decided and committed this much more descriptive text as follows...

+alt text: 'Default administration theme for Drupal 8 with simple blocks and clean lines.'

Work to be carried out for this issue:

1. Remove the tags from the patch.
2. Decide if we should change to a more descriptive alt text for Bartik or raise an issue for Seven to tone theirs down.
3. If we keep the current alt text please can we correct "screen-shot" to "screenshot".

lauriii’s picture

I don't see what is the reason for more descriptive alt text. It seems to contain everything that is also in the description?

jeanfei’s picture

Work to be carried out for this issue:
1. Remove the tags from the patch.
2. Decide if we should change to a more descriptive alt text for Bartik or raise an issue for Seven to tone theirs down.
3. If we keep the current alt text please can we correct "screen-shot" to "screenshot".

I've removed the tags line and correct 'Screen-shot' to 'Screenshot'. I didn't change the alt text.

jeanfei’s picture

Status: Needs work » Needs review
yannickoo’s picture

I don't see what is the reason for more descriptive alt text. It seems to contain everything that is also in the description?

I'm a little bit confused with this new alt property, +1 for lauriii's comment. Is sth. like "Screenshot for x theme" would be fine for all themes, wouldn't it?

star-szr’s picture

Status: Needs review » Needs work

Also that 'alt text' key is not used anywhere that I can see. Using that if present would have to be a separate issue if it's desired.

The alt text is currently auto-generated and is already "Screenshot for Bartik theme" - only difference is there is no period.

yannickoo’s picture

Status: Needs work » Needs review
FileSize
771 bytes
emma.maria’s picture

Issue tags: +drupaldevdays
Bojhan’s picture

Ugh, this sounds horrible. I have no idea what half of this really means "clean typography" "mobile-first? - not true". etc.

Isn't the fact that this shows the flexibility of Drupal the reason, we want people to see this? Design wise there are good attributes, but I don't think typography plays such a central role.

yoroy’s picture

I agree, what was I thinking! :-)

Is "Provides multiple regions for layout flexibility. The color scheme can be customized." better?

Bojhan’s picture

@Roy Going to art school, this should be our speciality. I do really like when it comes to the aesthetic talking about the intend.

"Default theme with multiple regions for content that provide layout flexibility. Using.... "

emma.maria’s picture

Status: Needs review » Needs work
Issue tags: -Novice
Bojhan’s picture

Issue tags: -Needs usability review

Anyone can pick this up, doesn't specifically needs ux review.

Status: Needs work » Needs review
mgifford’s picture

Does this need the <h3>Why this should be an RC target</h3> info & RC phase evaluation table? Also there's the "rc target triage" tag.

I'd like this in for the 8.0 release for sure.

emma.maria’s picture

Version: 8.0.x-dev » 8.2.x-dev
galactus86’s picture

I'm in DrupalCon 2016 New Orleans, mentored sprints, going to review this.

galactus86’s picture

I'm in DrupalCon 2016 New Orleans, mentored sprints, going to review this.

galactus86’s picture

I took some text from #23 and added to the description. I also added that it is the default theme for Drupal 8. I did pair a programming with Unitoch and cdyksrtra.

cdykstra’s picture

I did pair a programming with Unitoch and jasonPivot at DrupalCon NOLA 2016.

cdykstra’s picture

Status: Needs review » Reviewed & tested by the community
star-szr’s picture

+++ b/core/themes/bartik/bartik.info.yml
@@ -14,7 +14,7 @@
+description: 'A default theme included with every Drupal site. A responsive theme with multiple regions for content that provide layout flexibility.'

The second sentence reads a bit awkwardly to me. Another suggestion:

A responsive theme with multiple content regions for creating flexible layouts.

lauriii’s picture

Status: Reviewed & tested by the community » Needs work

According to #35

mgifford’s picture

Issue tags: +Novice

Looks like an easy fix.

gaurav.pahuja’s picture

Status: Needs work » Needs review
FileSize
554 bytes
602 bytes

Status: Needs review » Needs work

The last submitted patch, 38: 2193693-38.patch, failed testing.

snehi’s picture

Status: Needs work » Needs review

+1 for RTBC

pradeep22saini’s picture

Status: Needs review » Needs work

On applying the patch #38 with git apply gives error. On drupal 8.2.x-dev branch.

pradeep22saini’s picture

Status: Needs work » Needs review
FileSize
558 bytes

Updated patch.

Status: Needs review » Needs work

The last submitted patch, 42: 2193693-40.patch, failed testing.

pradeep22saini’s picture

FileSize
558 bytes
pradeep22saini’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 44: 2193693-41.patch, failed testing.

rajeshwari10’s picture

Assigned: Unassigned » rajeshwari10
rajeshwari10’s picture

Status: Needs work » Closed (fixed)

This issue is already fixed.

star-szr’s picture

Assigned: rajeshwari10 » Unassigned
Status: Closed (fixed) » Needs work

@rajeshwari10 thanks for looking into this. This issue hasn't been fixed yet so I'm reopening it. To give a couple tips: If it were fixed it would be helpful for you to point to an issue where this has been fixed, and in that case this would be closed as a duplicate issue (ideally with a reference made via the related issues field to/from the duplicate issue). Also the status of Closed (fixed) shouldn't be set by a human, that is only to be used by the system for issues that are set to 'Fixed' and have no activity after 2 weeks.

ashishdalvi’s picture

Assigned: Unassigned » ashishdalvi
ashishdalvi’s picture

Unable to apply patch. Tried patch reroll as well.

No reason why patch is failing. So uploading patch again.

ashishdalvi’s picture

Status: Needs work » Needs review

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

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

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

Title: New methods and standards for describing Bartik on the theme admin page » Improve theme description and screenshot alt-text for usability
Component: Bartik theme » user interface text
Assigned: ashishdalvi » Unassigned
Issue summary: View changes
Status: Needs review » Needs work
Issue tags: -Documentation, -Novice
Parent issue: #922696: Follow-up: New methods, standards for describing core themes on themes admin page (was Theme screenshots do not have adequate alt text...) »
Related issues: +#922696: Follow-up: New methods, standards for describing core themes on themes admin page (was Theme screenshots do not have adequate alt text...)

Thanks everyone for contributing to this issue.

It has been quiet here for over 5 years and Olivero has been added and soon Claro. If the scope of this was changed to cover all themes then this can be fixed in one issue. And as a reviewer, it would a lot easier to review the changes to all the themes as once. This is similar to how the coding standard issues are done. With that in mind I have taken a bold step and updated the Issue Summary and Title.

Settings to NW for adding improvements to the text for all themes. Changing component to what I think is a better fit. Unassigning as well because it has been over 5 years.

Hope this helps get this moving again!

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.