Clarify/Improve "Track images" text filter option title/description

Created on 13 April 2021, over 3 years ago
Updated 13 March 2023, almost 2 years ago

Problem/Motivation

EditorFileReference provides a filter described as "a filter to track images uploaded via a Text Editor." It's title and description in the admin UI are as follows:

Title: Track images uploaded via a Text Editor
Description: Ensures that the latest versions of images uploaded via a Text Editor are displayed."

This title and description could be made more clear as to what is actually occurring. Is this referring to image file revisions? Additionally, ๐Ÿ“Œ Leverage the 'loading' html attribute to enable lazy-load by default for images in Drupal core Fixed added functionality to this filter to append the loading=lazy attribute (as well as height/width attributes) and that is not mentioned in the title/description at all.

Steps to reproduce

  1. Install Drupal
  2. Login to Drupal
  3. Access /admin/config/content/formats/manage/full_html.
  4. Filter option is present on the page.

Proposed resolution

  1. Improve title and description to make it more clear what "tracking images" means.
  2. Add additional info to the title and/or description to describe the functionality added by ๐Ÿ“Œ Leverage the 'loading' html attribute to enable lazy-load by default for images in Drupal core Fixed

Bonus Question

Why are these two sets of functionality wrapped in a single option? Should they be two separate filter options so that a user could enable one but not the other? If the answer is yes, this will likely become its own issue.

Thanks to @adamzimmermann, @agarzola, and @chrisfree for collaborating with me on this issue.

๐Ÿ“Œ Task
Status

Needs work

Version

10.1 โœจ

Component
Image systemย  โ†’

Last updated 1 day ago

Created by

๐Ÿ‡บ๐Ÿ‡ธUnited States markdorison

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

  • Needs usability review

    Used to alert the usability topic maintainer(s) that an issue significantly affects (or has the potential to affect) the usability of Drupal, and their signoff is needed. When adding this tag, make it easy to review the issue. Make sure the issue summary describes the problem and the proposed solution. Screenshots usually help a lot! To get sign-off on issues with the "Needs usability review" tag, post about them in the #ux channel on Drupal Slack, and/or attend a UX meeting to demo the patch and get direct feedback from designers/UX folks/product management on next steps. If an issue represents a significant new feature, UI change, or change to the general "user experience" of Drupal, use Needs product manager review instead. See the scope of responsibilities for product managers.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • The Needs Review Queue Bot โ†’ tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

    Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

    Consult the Drupal Contributor Guide โ†’ to find step-by-step guides for working with issues.

  • Status changed to Needs review almost 2 years ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States markdorison
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nayana_mvr

    Do we need to change the description as mentioned in the original problem statement. Because while testing in Drupal version 10.1.x, I could see 2 different options now. I think it was implemented as mentioned in #15 ๐Ÿ“Œ Clarify/Improve "Track images" text filter option title/description Needs work

    1. Track images uploaded via a Text Editor.
    2. Lazy load images

    If we apply the latest MR changes, it will look like this

    There is already a separate option for lazy loading with description that says that this option should be placed after the option 'Track images uploaded via a Text Editor'.

    Please correct me if I'm wrong.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave
  • Status changed to Needs work almost 2 years ago
  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    @smustgrave forwarded the issue to the #ux channel. i've taken a look at the current state. there are a few things i've noticed.

    1. the patch changes the checkbox label from Track images uploaded via a Text Editor to Ensure latest image revision are referenced and append lazy=loading. problem is the description for the next checkbox label lazy load images references the previous checkbox label Instruct browsers to lazy load images if dimensions are specified. Use in conjunction with and place after the 'Track images uploaded via a Text Editor' filter that adds image dimensions required for lazy loading. Results can be overridden by <img loading="eager">. which still uses the old wording and would have to be updated as well.

    2. but the bigger problem is what the actual function of that checkbox Ensure latest image revision are referenced and append lazy=loading is. i can second the question in comment#13. i don't quite understand what the filter actually does with the original label nor with the current. my train of thought reading the current label and description:

    • when i scan the checkbox label at first the term image strikes my eye - based on that i would have assumed the functionality applies in case i try to add an image in a ckeditor5 wysiwyg field.
    • but then there are the words "latest" and "revision" which sounds more like it is about media entities?!
    • and then lazy=loading is also applied - but i ask myself the question why is there another checkbox about lazy loading, wasn't lazy loading already added to the markup in the previous step?
    • and i ask myself to what that latest image revision is referenced to at all? does reference mean the image dimensions are getting set?

    so based on the micro copy the purpose of each checkbox isn't clearly evident. the apparent functional interdependence and overlap of the two filters complicates things further. i'll set the issue back to needs work.

Production build 0.71.5 2024