From 4d96e28f705d068d1e3d5b174b1c84817971563e Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Fri, 14 Aug 2026 16:46:28 +1000 Subject: [PATCH 1/3] Docs: TINYMCE-14726 - New option `tinycomments_always_show_highlights` to keep comment highlights visible while the sidebar is closed --- modules/ROOT/pages/8.9.0-release-notes.adoc | 22 ++++++++++++++++ .../ROOT/pages/comments-callback-mode.adoc | 2 ++ .../ROOT/pages/comments-embedded-mode.adoc | 2 ++ .../tinycomments_always_show_highlights.adoc | 26 +++++++++++++++++++ 4 files changed, 52 insertions(+) create mode 100644 modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc diff --git a/modules/ROOT/pages/8.9.0-release-notes.adoc b/modules/ROOT/pages/8.9.0-release-notes.adoc index 30243b6272..fa78cf33eb 100644 --- a/modules/ROOT/pages/8.9.0-release-notes.adoc +++ b/modules/ROOT/pages/8.9.0-release-notes.adoc @@ -71,6 +71,28 @@ The {productname} {release-version} release includes an accompanying release of For information on the **** plugin, see: xref:.adoc[]. +=== Comments + +The {productname} {release-version} release includes an accompanying release of the **Comments** premium plugin. + +**Comments** includes the following additions. + +==== New option `+tinycomments_always_show_highlights+` to keep comment highlights visible while the sidebar is closed +// #TINYMCE-14726 + +Previously, the Comments plugin highlighted commented content only while the Comments sidebar was open. Closing the sidebar removed the highlighting from the editor content, so commented content was easy to overlook and users could overwrite it without warning. + +In {productname} {release-version}, the Comments plugin offers the xref:comments-embedded-mode.adoc#tinycomments_always_show_highlights[`+tinycomments_always_show_highlights+`] option. When this option is set to `+true+`, commented content remains highlighted whether the Comments sidebar is open or closed. This option defaults to `+false+`, which preserves the existing behavior. + +==== Selecting a comment highlight opens the Comments sidebar +// #TINYMCE-14726 + +Previously, the Comments plugin removed the highlighting while the Comments sidebar was closed, so users could not reopen a conversation from the editor content. + +In {productname} {release-version}, when the xref:comments-embedded-mode.adoc#tinycomments_always_show_highlights[`+tinycomments_always_show_highlights+`] option is set to `+true+`, selecting highlighted content reopens the closed Comments sidebar. + +For information on the **Comments** plugin, see: xref:introduction-to-tiny-comments.adoc[Comments]. + [[accompanying-premium-plugin-end-of-life-announcement]] == Accompanying Premium plugin end-of-life announcement diff --git a/modules/ROOT/pages/comments-callback-mode.adoc b/modules/ROOT/pages/comments-callback-mode.adoc index 7f76a26891..9bb1da44bc 100644 --- a/modules/ROOT/pages/comments-callback-mode.adoc +++ b/modules/ROOT/pages/comments-callback-mode.adoc @@ -83,6 +83,8 @@ include::partial$configuration/fetch_users.adoc[leveloffset=+1] include::partial$configuration/tinycomments_fetch_author_info.adoc[leveloffset=+1] +include::partial$configuration/tinycomments_always_show_highlights.adoc[leveloffset=+1] + include::partial$plugins/comments-open-sidebar.adoc[] include::partial$plugins/comments-highlighting-css.adoc[] diff --git a/modules/ROOT/pages/comments-embedded-mode.adoc b/modules/ROOT/pages/comments-embedded-mode.adoc index 280630f5bf..f2845cc30c 100644 --- a/modules/ROOT/pages/comments-embedded-mode.adoc +++ b/modules/ROOT/pages/comments-embedded-mode.adoc @@ -64,6 +64,8 @@ include::partial$configuration/tinycomments_can_delete_comment.adoc[leveloffset= include::partial$configuration/tinycomments_can_edit_comment.adoc[leveloffset=+1] +include::partial$configuration/tinycomments_always_show_highlights.adoc[leveloffset=+1] + include::partial$plugins/comments-open-sidebar.adoc[] include::partial$plugins/comments-highlighting-css.adoc[] \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc new file mode 100644 index 0000000000..3e651c4d72 --- /dev/null +++ b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc @@ -0,0 +1,26 @@ +[[tinycomments_always_show_highlights]] +== `+tinycomments_always_show_highlights+` + +_Optional_: The {pluginname} plugin offers the `+tinycomments_always_show_highlights+` option to keep the highlighting on commented content visible while the {pluginname} sidebar is closed. By default, {productname} highlights commented content only while the sidebar is open, and removes the highlighting from the editor content once the sidebar is closed. + +When this option is set to `+true+`, {productname} highlights commented content whether the sidebar is open or closed, and selecting highlighted content reopens the closed {pluginname} sidebar. + +*Type:* `+Boolean+` + +*Default value:* `+false+` + +*Possible values:* `+true+`, `+false+` + +=== Example: using `+tinycomments_always_show_highlights+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', // change this value according to your html + plugins: 'tinycomments', + toolbar: 'addcomment showcomments', + tinycomments_mode: 'embedded', + user_id: 'embedded_journalist', + tinycomments_always_show_highlights: true +}); +---- From 1d5c5550f431c08224da4a0e352d18529d34ba0f Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Fri, 14 Aug 2026 17:13:44 +1000 Subject: [PATCH 2/3] Docs: TINYMCE-14726 - Align user_id example value with the embedded mode setup example --- .../configuration/tinycomments_always_show_highlights.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc index 3e651c4d72..006990bf0b 100644 --- a/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc +++ b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc @@ -20,7 +20,7 @@ tinymce.init({ plugins: 'tinycomments', toolbar: 'addcomment showcomments', tinycomments_mode: 'embedded', - user_id: 'embedded_journalist', + user_id: 'author', tinycomments_always_show_highlights: true }); ---- From eb8b292bbbfd5a9eee4b8ab6f67d6f6a0f408881 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Fri, 14 Aug 2026 17:28:33 +1000 Subject: [PATCH 3/3] Docs: TINYMCE-14726 - Match the Comments option examples in the tinycomments_always_show_highlights example --- .../configuration/tinycomments_always_show_highlights.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc index 006990bf0b..7d3372409d 100644 --- a/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc +++ b/modules/ROOT/partials/configuration/tinycomments_always_show_highlights.adoc @@ -15,12 +15,14 @@ When this option is set to `+true+`, {productname} highlights commented content [source,js] ---- +const currentAuthor = 'embedded_journalist'; + tinymce.init({ selector: 'textarea', // change this value according to your html plugins: 'tinycomments', toolbar: 'addcomment showcomments', tinycomments_mode: 'embedded', - user_id: 'author', + user_id: currentAuthor, tinycomments_always_show_highlights: true }); ----