Inconsistent use of language regarding plugins

Created on 3 September 2024, 24 days ago
Updated 20 September 2024, 8 days ago

Problem/Motivation

In the CKEditor configuration, plugins are referred to inconsistently in the interface. This means it is not clear that each toolbar button is a plugin. This can lead to confusion with regard to following instructions or resolving errors, if the administrator does not realize that the toolbar icon represents a plugin.

Tagging for accessibility, as this adds to cognitive load.

Steps to reproduce

1. Go to /admin/config/content/formats/manage/basic_html

Expected result:

Move a button into the Active toolbar to enable that plugin, or into the list of Available buttons to disable it. Buttons may be moved with the mouse or keyboard arrow keys.

The toolbar buttons that don't fit the user's browser window width will be grouped in a dropdown. If multiple toolbar rows are preferred, those can be configured by adding an explicit wrapping breakpoint wherever you want to start a new row.

Available buttons/plugins

Active toolbar plugins

Actual result:

Move a button into the Active toolbar to enable it, or into the list of Available buttons to disable it. Buttons may be moved with the mouse or keyboard arrow keys.

The toolbar buttons that don't fit the user's browser window width will be grouped in a dropdown. If multiple toolbar rows are preferred, those can be configured by adding an explicit wrapping breakpoint wherever you want to start a new row.

Available buttons

Active toolbar

2. Click Source Editing

(Update Sept. 17, 2024: This item appears to have been resolved separately from the current issue.)

Expected result, if Source Editing is a plugin:

A list of HTML tags that can be used while editing source. It is only necessary to add tags that are not already supported by other enabled plugins. For example, if "Bold" is enabled, it is not necessary to add the <strong> tag, but it may be necessary to add <dl><dt><dd> in a format that does not have a definition list plugin, but requires definition list markup.

There might be other edits needed to this text per Make CKEditor be forgiving of enabling something that's already enabled Active .

Expected result, if Source Editing is not a plugin:

A list of HTML tags that can be used while editing source. It is only necessary to add tags that are not already supported by enabled plugins. For example, if "Bold" is enabled, it is not necessary to add the <strong> tag, but it may be necessary to add <dl><dt><dd> in a format that does not have a definition list plugin, but requires definition list markup.

There might be other edits needed to this text per Make CKEditor be forgiving of enabling something that's already enabled Active .

Actual result:

A list of HTML tags that can be used while editing source. It is only necessary to add tags that are not already supported by other enabled plugins. For example, if "Bold" is enabled, it is not necessary to add the <strong> tag, but it may be necessary to add <dl><dt><dd> in a format that does not have a definition list plugin, but requires definition list markup.

Proposed resolution

Consistently refer to plugins throughout the interface, since error and warning messages refer to plugins.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

🐛 Bug report
Status

Needs review

Version

11.0 🔥

Component
CKEditor 5 

Last updated about 2 hours ago

Created by

🇺🇸United States charles belov San Francisco, CA, US

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

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024