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-2354 TinyMCE 7.0.1 Release notes & community changelog #3189

Merged
merged 22 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e86b5a2
DOC-2354 7.0.1 Release Notes initial outline
FarzadHayat Mar 27, 2024
5b35673
add deprecated to nav.adoc
FarzadHayat Mar 27, 2024
768582d
update GitHub PR template
FarzadHayat Mar 27, 2024
b618fc6
DOC-2354: Add TINY-10789 release note entry (#3191)
FarzadHayat Mar 28, 2024
77dd6ae
DOC-2354: Add TINY-10760 release note entry (#3197)
FarzadHayat Apr 1, 2024
8019660
DOC-2354: Add TINY-10682 release note entry (#3192)
FarzadHayat Apr 2, 2024
9824a88
remove some unnecessary sections
FarzadHayat Apr 4, 2024
4beef85
DOC-2354: Add TINY-10785 release note entry (#3193)
FarzadHayat Apr 4, 2024
bb3c835
DOC-2354: Add TINY-10784 release note entry (#3200)
FarzadHayat Apr 4, 2024
69ea862
DOC-2354: Add TINY-10684 release note entry (#3208)
FarzadHayat Apr 4, 2024
8357d45
DOC-2354: Add TINY-10715 release note entry (#3195)
FarzadHayat Apr 4, 2024
9f49dad
DOC-2354: Add TINY-10488 release note entry (#3201)
FarzadHayat Apr 4, 2024
c5c1751
DOC-2354: Add TINY-10797 release note entry (#3196)
FarzadHayat Apr 8, 2024
39f50d3
DOC-2354: Add TINY-10705 release note entry (#3194)
FarzadHayat Apr 8, 2024
537a717
DOC-2354: Add TINY-10766 release note entry (#3199)
FarzadHayat Apr 8, 2024
102c389
DOC-2354: Add TINY-10747 release note entry (#3209)
FarzadHayat Apr 8, 2024
5959dbe
remove unused template code
FarzadHayat Apr 9, 2024
938157d
fix order of entries to match changelog
FarzadHayat Apr 9, 2024
84dc973
moved TINY-10715 to open source bug fixes section
FarzadHayat Apr 9, 2024
09a6a9e
fix TINY-10715 entry
FarzadHayat Apr 9, 2024
9fe116f
add 7.0.1 changelog entries to changelog.adoc
FarzadHayat Apr 9, 2024
c8c925d
Apply suggestions from Karl's code review
FarzadHayat Apr 9, 2024
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
4 changes: 3 additions & 1 deletion -new-material-templates/release-notes-template/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// The following two lines are already extant in `nav.adoc` and are here as a guidepost.
// The new navigation material is added immediately below these lines.
* Release information
** xref:release-notes.adoc[Release notes for TinyMCE 6]
** xref:release-notes.adoc[Release notes for {productname} {productmajorversion}]
// Remove un-used-for-this-particular-release entries.
*** TinyMCE <x.y[.z]>
**** xref:<x.y[.z]>-release-notes.adoc#overview[Overview]
Expand All @@ -14,8 +14,10 @@
**** xref:<x.y[.z]>-release-notes.adoc#improvements[Improvements]
**** xref:<x.y[.z]>-release-notes.adoc#additions[Additions]
**** xref:<x.y[.z]>-release-notes.adoc#changes[Changes]
**** xref:<x.y[.z]>-release-notes.adoc#removed[Removed]
**** xref:<x.y[.z]>-release-notes.adoc#bug-fixes[Bug fixes]
**** xref:<x.y[.z]>-release-notes.adoc#security-fixes[Security fixes]
**** xref:<x.y[.z]>-release-notes.adoc#deprecated[Deprecated]
**** xref:<x.y[.z]>-release-notes.adoc#known-issues[Known issues]

// This file is instructional and is never included in the published name-space.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Ticket: DOC-<num>

Site: [DOC-<num> site](http://docs-<hotfix/feature>-70-doc-<num>.staging.tiny.cloud/docs/tinymce/latest/)
Site: [Staging branch](http://docs-<hotfix|feature>-7-doc-<num>.staging.tiny.cloud/docs/tinymce/latest/)

Changes:
* <placeholder-text>
Expand Down
9 changes: 9 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10682-after/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div id="div#tiny-10682-initial">
<div class="mce-toc">
<h2>Table of <em>Contents</em></h2>
<ul>
<li><a href="#my-heading">My Heading</a></li>
</ul>
</div>
<h1 id="my-heading">My Heading</h1>
</div>
8 changes: 8 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10682-after/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tinymce.init({
selector: 'div#tiny-10682-after',
plugins: 'tableofcontents',
menubar: false,
inline: true,
toolbar: false,
readonly: true
});
9 changes: 9 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10682-before/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div id="div#tiny-10682-before">
<div class="mce-toc">
<h2>Table of &lt;em&gt;Contents&lt;/em&gt;</h2>
<ul>
<li><a href="#my-heading">My Heading</a></li>
</ul>
</div>
<h1 id="my-heading">My Heading</h1>
</div>
8 changes: 8 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10682-before/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tinymce.init({
selector: 'div#tiny-10682-before',
plugins: 'tableofcontents',
menubar: false,
inline: true,
toolbar: false,
readonly: true
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div id="div#tiny-10682-initial">
<div class="mce-toc">
<h2>Table of <em>Contents</em></h2>
<ul>
<li><a href="#my-heading">My Heading</a></li>
</ul>
</div>
<h1 id="my-heading">My Heading</h1>
</div>
8 changes: 8 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10682-initial/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tinymce.init({
selector: 'div#tiny-10682-initial',
plugins: 'tableofcontents',
menubar: false,
inline: true,
toolbar: false,
readonly: true
});
9 changes: 9 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10789-after/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div id="tiny-10789-after">
<div class="mce-toc">
<h2>Table of Contents</h2>
<ul>
<li><a href="#my-heading">My &lt;em&gt;Heading&lt;/em&gt;</a></li>
</ul>
</div>
<h1 id="my-heading">My &lt;em&gt;Heading&lt;/em&gt;</h1>
</div>
8 changes: 8 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10789-after/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tinymce.init({
selector: 'div#tiny-10789-after',
plugins: 'tableofcontents',
menubar: false,
inline: true,
toolbar: false,
readonly: true
});
9 changes: 9 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10789-before/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div id="tiny-10789-before">
<div class="mce-toc">
<h2>Table of Contents</h2>
<ul>
<li><a href="#my-heading">My <em>Heading</em></a></li>
</ul>
</div>
<h1 id="my-heading">My &lt;em&gt;Heading&lt;/em&gt;</h1>
</div>
8 changes: 8 additions & 0 deletions modules/ROOT/examples/live-demos/tiny-10789-before/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
tinymce.init({
selector: 'div#tiny-10789-before',
plugins: 'tableofcontents',
menubar: false,
inline: true,
toolbar: false,
readonly: true
});
6 changes: 5 additions & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,11 @@
** xref:tinymce-and-csp.adoc[Content Security Policies (CSP)]
** xref:tinymce-and-cors.adoc[Cross-Origin Resource Sharing (CORS)]
* Release information
** xref:release-notes.adoc[Release notes for TinyMCE 7]
** xref:release-notes.adoc[Release notes for {productname} {productmajorversion}]
*** TinyMCE 7.0.1
**** xref:7.0.1-release-notes.adoc#overview[Overview]
**** xref:7.0.1-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium Plugin changes]
**** xref:7.0.1-release-notes.adoc#bug-fixes[Bug fixes]
*** TinyMCE 7.0
**** xref:7.0-release-notes.adoc#overview[Overview]
**** xref:7.0-release-notes.adoc#new-premium-plugins[New Premium plugins]
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/7.0-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -851,6 +851,8 @@ Currently, Non-breaking spaces `+&nbsp;+` may be inadvertently inserted around c
<p>&nbsp;</p> // unexpected
----

NOTE: This issue xref:7.0.1-release-notes.adoc#pasting-markdown-into-some-situations-would-cause-the-pasted-data-to-be-placed-in-unexpected-places[is addressed] in {productname} 7.0.1.

=== Tab navigation inside the Enhanced Code Editor function as expected when the host browser is Safari.
// #TINY-10596

Expand Down
171 changes: 171 additions & 0 deletions modules/ROOT/pages/7.0.1-release-notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
= {productname} {release-version}
:release-version: 7.0.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, April 10^th^, 2024.

These release notes provide an overview of the changes for {productname} {release-version}, including:

* xref:accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
* xref:bug-fixes[Bug fixes]


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

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

=== Enhanced Code Editor

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

This **Enhanced Code Editor** release includes the following fixes.

==== Text inside code editor was not properly rendered when using a dark {productname} skin.
// #TINY-10784

In previous versions of the **Enhanced Code Editor**, the text color of the code editor was inherited from the {productname} skin. This caused the light theme of the code editor to display white text on a white background when using xref:customize-ui.adoc#skins[a dark skin], such as `oxide-dark`.

In {productname} {release-version}, this issue has been resolved. Now, the light theme of the Enhanced Code Editor will always use a dark text color, regardless of the skin being used. As a result, the light mode will render correctly and be easily readable when using a dark skin.

==== Light mode background with `advcode_inline: true` had the wrong color when {productname} was used with a dark skin.
// #TINY-10760

Previously in the **Enhanced Code Editor**, the `advcode` background color depended on the skin of the {productname} editor when `advcode_inline` was set to `true`. As a result, when {productname} was used with a dark skin, the `advcode` light mode would display dark text on a dark background.

In {productname} {release-version}, this issue has been fixed. Now, when `advcode_inline` is set to `true`, the background for `advcode` light mode is set to white. As a result, the `advcode` light mode correctly displays dark text on a light background when {productname} is used with a dark skin.

For information on the **Enhanced Code Editor** plugin, see: xref:advcode.adoc[Enhanced Code Editor].

=== Markdown

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

This **Markdown** release includes the following fixes and improvements.

==== Pasting markdown then pressing undo resulted in incorrect text layout.
// #TINY-10747

Previously in **Markdown**, the markdown paste feature performed a direct content insertion for creating the intermediary undo level between the raw pasted content and the markdown conversion. As a consequence, the editor would lose the newline formatting of the original text when pasting markdown and then pressing undo.

In {productname} {release-version}, the markdown paste feature has been updated to use the clipboard insert command for creating the undo level. This ensures that the editor retains the newline formatting of the original text when pasting markdown and then pressing undo.

==== Pasting markdown into some situations would cause the pasted data to be placed in unexpected places.
// #TINY-10766, also addresses TINY-10788 and #TINY-10749

Previously in the **Markdown** plugin, the "markdown-on-paste" feature used the `editor.selection.setContent` function to insert content into the {productname} editor. This approach resulted in some unnecessary `+&nbsp;+` characters being appended before and after the pasted text. As a result, the editor experienced some unexpected content placement behavior and possible duplicated content.

{productname} {release-version} addresses this issue by changing the paste feature to use the `editor.insertContent` function instead. As a result, pasting markdown no longer adds unnecessary `+&nbsp;+` and the pasted content is placed correctly and does not duplicate.

NOTE: This fix addresses xref:7.0-release-notes.adoc#non-breaking-spaces-nbsp-may-be-inadvertently-inserted-around-content-during-markdown-conversion[a known issue] in the xref:markdown.adoc[Markdown premium plugin].

For information on the **Markdown** plugin, see: xref:markdown.adoc[Markdown].

=== Revision History

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

This **Revision History** release includes the following fix.

==== Reduce the chance of diff annotation styles being overridden by inline styles.
// #TINY-10785

Previously in **Revision History**, the inline CSS styles of content took precedence over the diff annotation styles. As a consequence, the changes highlighted were not distinguishable to the users.

{productname} {release-version} addresses this issue by adding an `!important` declaration to the default annotation styles. As a result, the annotation styling properties will take precedence over the inline styles, ensuring that the changes are clearly visible to the users.

NOTE: This fix assumes that the inline styles are not using `!important` declarations. If the inline styles are using `!important` declarations, the annotation styles will be overridden.

For information on the **Revision History** plugin, see: xref:revisionhistory.adoc[Revision History].

=== Table of Contents

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

This **Table of Contents** release includes the following fixes.

==== Encoding header of Table of Contents causing HTML source to be revealed on refresh.
// #TINY-10682

Previously in {productname}, the **Table of Contents** (ToC) header encoding caused special characters to be incorrectly displayed as code instead of their HTML representation.

To address this issue, the HTML encoding has been removed. As a result, the ToC header now renders correctly as HTML even after refreshing, displaying as intended.

For example, if the **Table of Contents** (ToC) header contained the following content with "_Contents_" emphasized as follows:

liveDemo::tiny-10682-initial[]

Upon refreshing the ToC, the header would change to display the HTML tags literally, exposing the underlying HTML:

liveDemo::tiny-10682-before[]

Now, the header maintains the intended HTML rendering even after refreshing:

liveDemo::tiny-10682-after[]

==== Encode header title for literal display in Table of Contents.
// #TINY-10789

Previously in {productname}, during Table of Contents (ToC) generation, heading elements containing HTML tags such as `<em>` for italics were incorrectly rendered within the ToC itself.

{productname} {release-version} addresses this issue by encoding the heading element during ToC generation. This ensures that any HTML tags present within the heading element are treated as plain text and displayed literally.

For example, if your document contained a heading element with HTML tags as string in the heading content, the ToC would previously render the heading element as follows:

liveDemo::tiny-10789-before[]

Now, the ToC maintains the HTML tags within the heading element as plain text, matching the heading element itself:

liveDemo::tiny-10789-after[]

For information on the **Table of Contents** plugin, see: xref:tableofcontents.adoc[Table of Contents].


[[bug-fixes]]
== Bug fixes

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

=== Toggle list behavior generated wrong HTML when the `forced_root_block` option was set to `div`.
// #TINY-10488

Previously in {productname}, when creating a new list item, the editor only considered default root nodes. This caused the caret to be placed incorrectly and resulted in the editor generating a new list instead of adding a list item to the existing list.

In {productname} {release-version}, this issue has been fixed. The editor now checks for non-default root nodes, such as when `forced_root_block` is set to `div`, when creating new list items. As a result, the caret is placed correctly after the creation of the new list item, allowing the editor to add a list item instead of generating a new list.

=== Tapping inside a composed text on Firefox Android would not close the autocompleter.
// #TINY-10715

Previously in {productname}, when typing Korean on Firefox Android and moving the caret inside the word being typed, the autocompleter menu did not close. This issue was caused by Gboard triggering an extra input even after the composition had ended. As a result, the autocompleter mistakenly interpreted it as the user starting to type again.

In {productname} {release-version}, this issue has been fixed. Now, the autocompleter menu is properly closed when tapping inside the word being typed on Firefox Android.

=== An inline editor toolbar now behaves correctly in horizontally scrolled containers.
// #TINY-10684

Previously in {productname}, when using an inline editor within a horizontally scrollable container, the calculation of the inline toolbar's width was incorrect. This resulted in the toolbar's maximum width being set too small or the toolbar displaying unexpected overflow behavior.

{productname} {release-version} resolves this issue, now, the toolbar's maximum width calculation has been fixed to span the available viewport space. As a result, the inline toolbar will now behave correctly, displaying all items when there's enough space, or hiding them behind the overflow toolbar button when necessary.

=== Tooltips unintended shrinking and incorrectly positioned when shown in horizontally scrollable container.
// #TINY-10797

Previously in {productname}, toolbar tooltips within the editor were positioned as `absolute`. This caused tooltips to shrink and become misplaced when the editor was placed inside a container with horizontal scrolling.

To resolve this issue, the tooltip element is now styled with a "max-content" width. As a result, tooltips within the editor's toolbar will display as intended and remain anchored to the corresponding button regardless of the presence of horizontal scrolling.

=== The status bar was invisible when the editor's height was set to the minimum.
// #TINY-10705

As a part of the change to add link:https://www.tiny.cloud/docs/tinymce/6/6.3-release-notes/#a-new-addview-api-was-added-to-editor-ui-registry[_addView API_], the status bar was moved inside the editor container. Consequently, when the editor's height was set to the minimum and the toolbar contained many buttons, the status bar would be hidden under the toolbar buttons.

In {productname} {release-version}, this change is reverted by moving the status bar outside the editor. As a result, the status bar is now visible even when the editor's height is resized to the minimum.
16 changes: 16 additions & 0 deletions modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@

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


== 7.0.1 - 2024-04-10

=== Fixed
* Toggle list behavior generated wrong HTML when the `forced_root_block` option was set to `div`.
// #TINY-10488
* Tapping inside a composed text on Firefox Android would not close the autocompleter.
// #TINY-10715
* An inline editor toolbar now behaves correctly in horizontally scrolled containers.
// #TINY-10684
* Tooltips unintended shrinking and incorrectly positioned when shown in horizontally scrollable container.
// #TINY-10797
* The status bar was invisible when the editor's height was set to the minimum.
// #TINY-10705


== 7.0.0 - 2024-03-20

[NOTE]
Expand Down
8 changes: 7 additions & 1 deletion 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.0.1-release-notes.adoc#overview[{productname} 7.0.1]

Release notes for {productname} 7.0.1

a|
[.lead]
xref:7.0-release-notes.adoc#overview[{productname} 7.0]
Expand All @@ -23,6 +29,6 @@ Release notes for {productname} 7.0
// 2. When the number of cells in the table is even:
// * prepend the inline comment markup to this
// element.
a|
// a|

|===
Loading