Improve documentation for entering Manually editable HTML tags

Created on 27 December 2023, 9 months ago
Updated 13 February 2024, 7 months ago

Problem/Motivation

If I want to add support for specific styles or values of specific styles under Manually editable HTML tags, there is a lack of guidance for the syntax.

For example, I cannot tell from the instructions provided how I would enter the following (I'll do a separate support request to get the answer; this is just an example for improving the instructions provided in the UI):

<ol style="[any one of the following]">

list-style-type: upper-roman;
list-style-type: upper-latin;
list-style-type: lower-roman;
list-style-type: lower-latin;
list-style-type: decimal;

Steps to reproduce

1. Go to simplytest.me
2. For the project, type Drupal and choose Drupal core, latest version of 10
3. Click to create the instance
4. Click manage, then configuration, then text formats
5. On the row for Basic HTML, click configure
6. Under CKEditor 5 plugin settings, view Manually editable HTML tags.

Expected result:

The following help text:

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 mark.

To add a specific style property to a tag, add style="[property]"
To add a specific style property and restrict it to specific values, add [however you accomplish this].

Alternatively, link to detailed instructions for filling out this field.

Actual result:

The following help text:

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 mark

Proposed resolution

Improve the instructions, whether by improving the user interface or by linking to content on the Drupal.org documentation website.

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

📌 Task
Status

Closed: works as designed

Version

11.0 🔥

Component
CKEditor 5 

Last updated 2 days ago

Created by

🇺🇸United States Charles Belov San Francisco, CA, US

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024