Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2610: TinyMCE 7.6.1 Release Documentation. #3569

Merged
merged 2 commits into from
Jan 22, 2025
Merged
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
2 changes: 1 addition & 1 deletion .api-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.6.0
7.6.1
12 changes: 9 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,12 @@
** xref:tinymce-and-cors.adoc[Cross-Origin Resource Sharing (CORS)]
* Release information
** xref:release-notes.adoc[Release notes for {productname}]
*** {productname} 7.6.1
**** xref:7.6.1-release-notes.adoc#overview[Overview]
**** xref:7.6.1-release-notes.adoc#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
**** xref:7.6.1-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
**** xref:7.6.1-release-notes.adoc#bug-fixes[Bug fixes]
**** xref:7.6.1-release-notes.adoc#security-fixes[Security fixes]
*** {productname} 7.6.0
**** xref:7.6.0-release-notes.adoc#overview[Overview]
**** xref:7.6.0-release-notes.adoc#new-premium-plugin[New Premium plugin]
Expand Down Expand Up @@ -477,8 +483,8 @@
**** xref:7.1.1-release-notes.adoc#bug-fixes[Bug fixes]
*** {productname} 7.1
**** xref:7.1-release-notes.adoc#overview[Overview]
**** * xref:7.1-release-notes.adoc#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
**** * xref:7.1-release-notes.adoc#new-premium-plugin[New Premium plugin]
***** xref:7.1-release-notes.adoc#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
***** xref:7.1-release-notes.adoc#new-premium-plugin[New Premium plugin]
**** xref:7.1-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
**** xref:7.1-release-notes.adoc#improvements[Improvements]
**** xref:7.1-release-notes.adoc#bug-fixes[Bug fixes]
Expand All @@ -504,4 +510,4 @@
* xref:invalid-api-key.adoc[Invalid API key]
* xref:license-key.adoc[License key]
* xref:support.adoc[Support]
* xref:usage-based-billing.adoc[Usage-Based Billing]
* xref:usage-based-billing.adoc[Usage-Based Billing]
193 changes: 193 additions & 0 deletions modules/ROOT/pages/7.6.1-release-notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
= {productname} {release-version}
:release-version: 7.6.1
:navtitle: {productname} {release-version}
:description: Release notes for {productname} {release-version}
:keywords: releasenotes, new, changes, bugfixes
:page-toclevels: 1

include::partial$misc/admon-releasenotes-for-stable.adoc[]


[[overview]]
== Overview

{productname} {release-version} was released for {enterpriseversion} and {cloudname} on Wednesday, January 22^nd^, 2025. These release notes provide an overview of the changes for {productname} {release-version}, including:

* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
* xref:accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
* xref:bug-fixes[Bug fixes]
* xref:security-fixes[Security fixes]

[[accompanying-premium-self-hosted-server-side-component-changes]]
== Accompanying Premium self-hosted server-side component changes

The {productname} {release-version} release includes accompanying changes affecting the {productname} **self-hosted** services for the following plugins:

* **Enhanced Media Embed** plugin `mediaembed`.
* **Image Editing** plugin `editimage`.
* **Link Checker** plugin `linkchecker`.
* **Spell Checker** plugin `tinymcespellchecker`.
* **Spelling Autocorrect** plugin `autocorrect`.

For information on:

* The **Enhanced Media Embed** plugin, see: xref:introduction-to-mediaembed.adoc[Enhanced Media Embed plugin].
* The **Image Editing** plugin, see: xref:editimage.adoc[Image Editing plugin].
* The **Link Checker** plugin, see: xref:linkchecker.adoc[Link Checker plugin].
* The **Spell Checker** plugin, see: xref:introduction-to-tiny-spellchecker.adoc[Spell Checkerplugin].
* The **Spelling Autocorrect** plugin, see: xref:autocorrect.adoc[Spelling Autocorrect plugin].
* Deploying the **server-side** components, see: xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation].

The Java server-side components have been updated to the following versions:

* `ephox-hyperlinking.war`: 2.109.2
* `ephox-image-proxy.war`: 2.111.2
* `ephox-spelling.war`: 2.127.2


=== Updating the self-hosted server-side components

The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components:

. Update your Java Application Server to the minimum required version:

include::partial$misc/supported-application-servers.adoc[]

. Replace the existing server-side `.war` files with the `.war` files bundled with {productname} {release-version} or later.

For information on:

* Deploying the server-side components, see: xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation].
* Deploying the server-side components using Docker, see: xref:bundle-intro-setup.adoc[Containerized service deployments].

include::partial$misc/admon-no-functionality-changes-in-updated-server-side-components.adoc[]


[[accompanying-premium-plugin-changes]]
== Accompanying Premium plugin changes

The following premium plugin updates were released alongside {productname} {release-version}.

=== Comments

The {productname} {release-version} release includes an accompanying release of the **Comments** premium plugin.

**Comments** includes the following fixes.

==== The mentions dropdown remained visible even after the mention text was deleted in quick succession.
// #TINY-11673

In previous versions of the **Comments** plugin, an issue was identified where the mentions in comments dropdown was still visible after the `@` mentioned text was removed in quick succession.

This behavior occurred when the users list was updated following a successful API fetch request, even when the mentioned text was completely deleted.

As a result, users were unable to interact with or close the `@` mentions dropdown.

In {productname} {release-version}, the logic has been updated to ensure the users list is only refreshed if the mentioned text is not entirely removed. This change ensures that the mentions dropdown automatically closes when the `@` mentioned text is deleted.

==== The mentions menu in the comments textarea without items was not closed when pressing the `Space` or `Enter` key.
// #TINY-11454

Previously, an issue was identified where pressing the Space or Enter key when the mentions dropdown in the comments textarea displayed the message "no users found" did not close the dropdown, unlike in the editor.

{productname} {release-version} resolves this issue by ensuring that pressing the Space or Enter key closes the dropdown, maintaining consistent functionality between the comments textarea and the editor.

==== Toggle sidebar shortcut remained active when the editor was disabled.
// #TINY-11646

Previously, an issue was identified where the comment sidebar would close when using the keyboard shortcut `Cmd + Opt + M` on Mac and `Ctrl + Alt + M` on Windows while the editor was in a disabled state.

This led to inconsistent behavior, as keyboard shortcuts remained functional despite the editor being disabled.

{productname} {release version} addresses this issue. The behavior of keyboard shortcuts has been updated to ensure that the comment sidebar shortcut is disabled when the editor is in a disabled state.

For information on the **Comments** plugin, see: xref:introduction-to-tiny-comments.adoc[Introduction to {companyname} Comments].

=== Image Optimizer

The {productname} {release-version} release includes an accompanying release of the **Image Optimizer** premium plugin.

**Image Optimizer** includes the following fixes.

==== Resizing images by typing into the input didn't update the `style` attribute correctly.
// TINY-11669

An issue was identified where an internal custom `style` attribute of an image was not updated correctly after a user modified its width and height.

This issue occurred because the resize function was triggered while the selection focus was elsewhere, due to a debounce delay between the input and the resize operation. As a result, the resize operation was performed on the current selection instead of the intended image.

This led to other editor components that rely on that custom `style` attribute to accidentally read outdated values, resulting in the resize not being applied correctly since the selection was not on the intended image.

{productname} {release-version} addresses this issue, by updating the custom `style` attribute appropriately whenever a resize operation is performed. The resize function now takes in the intended image as a parameter, ensuring that all editor components referencing that custom `style` attribute read the most recent value entered. Additionally, the resize operation is applied to the correct image, even before the debounce time elapses.

==== Images with existing `srcset` were not handled correctly.
// #TINY-11653

An issue was identified where images with an existing `srcset` attribute containing an Uploadcare URL were being processed incorrectly.

The problem occurred when attempting to update an `srcset` attribute that did not contain an Uploadcare URL. In such cases, no changes were applied, resulting in the image failing to update if the existing `srcset` had a different structure.

{productname} {release-version} resolves this issue by exclusively targeting `srcset` attributes with Uploadcare URLs. This ensures that all relevant images are updated correctly, with the `srcset` being regenerated from scratch to incorporate any modifications made.

For information on the **Image Optimizer** plugin, see: xref:uploadcare.adoc[Image Optimizer].

=== Import from Word

The {productname} {release-version} release includes an accompanying release of the **Import from Word** premium plugin.

**Import from Word** includes the following fix.

==== Error messages were not rendered correctly
// #TINY-11662

In previous releases of the **Import from Word** premium plugin, an error occurring during the import process triggered an "Operation failed" notification that featured an incorrect icon and lacked the expected background. This design was inconsistent with the error notifications displayed by related plugins, such as the xref:exportpdf.adoc[Export to PDF] plugin and the xref:exportword.adoc[Export to Word] plugin, which use a red background and an exclamation mark to signify errors.

In {productname} {release-version}, this UI inconsistency has been resolved. Error notifications for the Word document import process now render correctly, aligning with the visual standards of related plugins.

For more information on the **Import from Word** plugin, see xref:importword.adoc[Import from Word].

[[bug-fixes]]
== Bug fixes

{productname} {release-version} also includes the following bug fixes:

=== Text input was prevented in form elements in the contents of the editor.
// #TINY-11446

Previously, an issue was identified in Google Chrome and Microsoft Edge where text input was prevented within form elements, resulting in the inability to insert text into these elements.

{productname} {release-version} addresses this issue, by updating the logic for handling text input on non-editable elements to include support for form elements. As a result, text can now be successfully inserted into form elements in Google Chrome and Microsoft Edge.

=== Opening a notification when the toolbar is at the bottom threw an error.
// #TINY-11498

An issue was identified in the inline mode editor where, if the toolbar was positioned at the bottom of the screen, a UI error occurred that rendered notifications non-functional after being opened.

This issue significantly impacted the user experience, preventing users from interacting with the notification interface effectively.

{productname} {release-version} resolves this issue by enhancing the notification positioning logic to account for the toolbar's location. Notifications now function seamlessly, regardless of the toolbar's placement on the screen.

==== Table resize bars was not properly aligned for inline editors inside scrollable containers.
// #TINY-11215

In earlier versions of {productname}, an issue was identified in the inline mode editor where table resize bars were improperly positioned when placed within a scrollable container. When the container was scrolled, the resize bars became misaligned with the corresponding table rows and columns.

This misalignment caused a disconnect between the table rows and their associated resize handles, leading to usability challenges as the handles appeared in the incorrect location.

In {productname} {release-version}, this issue has been resolved by ensuring the table resize bars are properly attached to the respective table rows and columns when the container is scrolled, enhancing usability and functionality.

[[security-fixes]]
== Security fixes

{productname} {release-version} includes one fix for the following security issue:

The following server-side component has been updated to include dependency updates addressing the following security issues.

* https://nvd.nist.gov/vuln/detail/CVE-2024-12801[CVE-2024-12801]
* https://nvd.nist.gov/vuln/detail/CVE-2024-12798[CVE-2024-12798]

This update is considered as a **Medium** & *Low* severity vulnerability fix.

For information on the server-side components updates, see: xref:#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes].

include::partial$misc/admon-no-functionality-changes-in-updated-server-side-components.adoc[]
10 changes: 10 additions & 0 deletions modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].

== xref:7.6.1-release-notes.adoc[7.6.1 - 2025-01-22]

=== Fixed
* Text input was prevented in form elements in the contents of the editor.
// #TINY-11446
* Opening a notification when the toolbar is positioned at the bottom of the editor threw an error.
// #TINY-11498
* Table resize bars was not properly aligned for inline editors inside scrollable containers.
// #TINY-11215

== xref:7.6.0-release-notes.adoc[7.6.0 - 2024-12-11]

=== Added
Expand Down
6 changes: 6 additions & 0 deletions modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This section lists the releases for {productname} 7 and the changes made in each
[cols="1,1"]
|===

a|
[.lead]
xref:7.6.1-release-notes.adoc#overview[{productname} 7.6.1]

Release notes for {productname} 7.6.1

a|
[.lead]
xref:7.6.0-release-notes.adoc#overview[{productname} 7.6.0]
Expand Down
Loading