Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions modules/ROOT/pages/8.9.0-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,28 @@ The {productname} {release-version} release includes an accompanying release of

For information on the **<Premium plugin name 1>** plugin, see: xref:<plugincode>.adoc[<Premium plugin name 1>].

=== 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
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/comments-callback-mode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
2 changes: 2 additions & 0 deletions modules/ROOT/pages/comments-embedded-mode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[[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]
----
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: currentAuthor,
tinycomments_always_show_highlights: true
});
----
Loading