Problem/Motivation

When you configure the Media Embed text filter (added in #2940029: Add an input filter to display embedded Media entities), it offers you this wall of descriptive text:

Embeds media items using a custom tag, <drupal-media>. If used in conjunction with the 'Align/Caption' filters, make sure this filter is configured to run after them. If you are using the HTML filter, be sure the data-align and/or data-caption attributes are allowed on the <drupal-media> tag. If you would like users to be able to override the alt text on image media, add the alt attribute to the <drupal-media> tag as well.

During product manager review in #2801307-94: [META] Support WYSIWYG embedding of media entities, @webchick had this to say about that:

The description of the Media embed filter is super long and has more twists and turns than a murder mystery. Suggestion was to configure it with "smart defaults" (align, caption, alt, and title all accessible by default, to match what image does), and strike the second part of the sentence.

Proposed resolution

@webchick's idea is a good one, easy to implement, and on par with what we do in core already to support the specialized image embedding for CKEditor. So let's do that.

Remaining tasks

Write a patch and possibly an update path, with tests.

User interface changes

The filter's descriptive text will be shortened to a reasonable length, and out-of-the-box configuration will become easier for site builders.

API changes

Nein.

Data model changes

Nope.

Release notes snippet

TBD

Comments

phenaproxima created an issue. See original summary.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Assigned: Unassigned » webchick
Status: Active » Postponed (maintainer needs more info)
Issue tags: +Media Initiative, +Usability

I agree.

Note that the issue summary is inaccurate.

Actual filter description

Embeds media items using a custom HTML tag. If used in conjunction with the 'Align/Caption' filters, make sure this filter is configured to run after them.

Filter description in issue summary (which is what #2994702: Allow editors to alter embed-specific metadata, as well as `data-align` and `data-caption` is changing it to)

Embeds media items using a custom tag, <drupal-media>. If used in conjunction with the 'Align/Caption' filters, make sure this filter is configured to run after them. If you are using the HTML filter, be sure the data-align and/or data-caption attributes are allowed on the <drupal-media> tag. If you would like users to be able to override the alt text on image media, add the alt attribute to the <drupal-media> tag as well.

… I already raised concerns about that change in #2994702: Allow editors to alter embed-specific metadata, as well as `data-align` and `data-caption`.

@webchick, how do you feel about the description that is currently in HEAD?

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

I guess the description that's in HEAD right now is apparently "Embeds media items using a custom HTML tag. If used in conjunction with the 'Align/Caption' filters, make sure this filter is configured to run after them" That seems straight-forward and fine. I guess this is only caused once #2994702: Allow editors to alter embed-specific metadata, as well as `data-align` and `data-caption` is applied, so the feedback is best addressed as part of that patch. (Sorry, we were reviewing the initiative as a whole, I wasn't sure what text/features were caused by what patch.)

oknate’s picture

oknate
Location Greater New York City Area
commented
Status: Postponed (maintainer needs more info) » Closed (outdated)

Marking closed outdated, as it looks like everyone agrees this should be handled with in #2994702: Allow editors to alter embed-specific metadata, as well as `data-align` and `data-caption`.