backdrop-ops / docs.backdropcms.org

Website for displaying Backdrop CMS documentation and API source code.
https://docs.backdropcms.org/
6 stars 6 forks source link

Edits to "Text Formats, Editors & Filters" page #233

Open leeksoup opened 7 months ago

leeksoup commented 7 months ago

Suggested improvements to the Text Editors, Formats & Filters documentation at

Motivation: The "Convert line breaks into HTML" / filter_autop filter breaks text_summary() when combined with CKEditor. See https://github.com/backdrop/backdrop-issues/issues/6423

Suggested Edits:

To this part:

Convert line breaks into HTML - This filter converts line breaks into <br> or <p> tags depending on whether a single or double line break is found. This preserves the paragraph formatting in the text that is input.

Add:

This filter is redundant when a Text Editor is configured. It also breaks the Backdrop summary generation function when enabled along with CKEditor. It should be disabled in any format that includes a Text Editor.

To this part:

Convert URLs into links - Any web or email addresses that are found in the text will be converted to clickable links, thus saving the user the hassle of having to type <a href="....">.

Add:

This filter is redundant when a Text Editor is configured. It is recommended to disable it in any format that includes a Text Editor.

Update format names and details

Additional Edits:

I have filed an issue to implement the above recommendations in the default Filtered HTML (Basic) format. When that is resolved, this documentation page will need to be updated to correct the list of enabled filters for those formats. See https://github.com/backdrop/backdrop-issues/issues/6429