Skip to content

Commit

Permalink
Merge branch 'feature/7/DOC-2354' into feature/7/DOC-2354_TINY-10797
Browse files Browse the repository at this point in the history
  • Loading branch information
FarzadHayat authored Apr 8, 2024
2 parents fd8bea7 + 9f49dad commit 38589cc
Show file tree
Hide file tree
Showing 12 changed files with 169 additions and 57 deletions.
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: 0 additions & 6 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -400,14 +400,8 @@
** 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#new-premium-plugin<s>[New Premium Plugin<s>]
**** xref:7.0.1-release-notes.adoc#new-open-source-plugin<s>[New Open Source Plugin<s>]
**** xref:7.0.1-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium Plugin changes]
**** xref:7.0.1-release-notes.adoc#accompanying-premium-plugin-end-of-life-announcement[Accompanying Premium Plugin end-of-life announcement]
**** xref:7.0.1-release-notes.adoc#accompanying-open-source-plugin-end-of-life-announcement[Accompanying Open Source Plugin end-of-life announcement]
**** xref:7.0.1-release-notes.adoc#accompanying-enhanced-skins-and-icon-packs-changes[Accompanying Enhanced Skins & Icon Packs changes]
**** xref:7.0.1-release-notes.adoc#improvements[Improvements]
**** xref:7.0.1-release-notes.adoc#additions[Additions]
**** xref:7.0.1-release-notes.adoc#changes[Changes]
**** xref:7.0.1-release-notes.adoc#removed[Removed]
**** xref:7.0.1-release-notes.adoc#bug-fixes[Bug fixes]
Expand Down
135 changes: 84 additions & 51 deletions modules/ROOT/pages/7.0.1-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,8 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[]

{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:

// Remove sections and section boilerplates as necessary.
// Pluralise as necessary or remove the placeholder plural marker.
* xref:new-premium-plugin<s>[New Premium plugin<s>]
* xref:new-open-source-plugin<s>[New Open Source plugin<s>]
* xref:accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
* xref:accompanying-premium-plugin-end-of-life-announcement[Accompanying Premium plugin end-of-life announcement]
* xref:accompanying-open-source-plugin-end-of-life-announcement[Accompanying open source plugin end-of-life-announcement]
* xref:accompanying-enhanced-skins-and-icon-packs-changes[Accompanying Enhanced Skins & Icon Packs changes]
* xref:improvements[Improvements]
* xref:additions[Additions]
* xref:changes[Changes]
* xref:removed[Removed]
* xref:bug-fixes[Bug fixes]
Expand All @@ -31,34 +23,64 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[]
* xref:known-issues[Known issues]


[[new-premium-plugin<s>]]
New Premium plugin<s>
[[accompanying-premium-plugin-changes]]
== Accompanying Premium plugin changes

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

=== <Premium plugin name>
=== Enhanced Code Editor

The new Premium plugin, **<Premium plugin name>** // description here.
The {productname} {release-version} release includes an accompanying release of the **Enhanced Code Editor** premium plugin.

For information on the **<Premium plugin name>** plugin, see xref:<plugincode>.adoc[<Premium plugin name>].
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

[[new-open-source-plugin]]
== New Open Source plugin
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 a dark skin, such as `oxide-dark`.

The following new Open Source plugin was released alongside {productname} {release-version}.
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.

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

The new open source plugin, **<Open source plugin name>** // description here.
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.

For information on the **<Open source plugin name>** plugin, see xref:<plugincode>.adoc[<Open source plugin name>].
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].

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

The following premium plugin updates were released alongside {productname} {release-version}.
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].

=== Mentions

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

This **Mentions** release includes the following fix.

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

Previously in **Mentions**, when typing Korean on Firefox Android and moving the caret inside the word being typed, the auto completer 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.

For information on the **Mentions** plugin, see: xref:mentions.adoc[Mentions].

=== <Premium plugin name 1> <Premium plugin name 1 version>

Expand All @@ -72,56 +94,53 @@ 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>].

=== Table of Contents

[[accompanying-premium-plugin-end-of-life-announcement]]
== Accompanying Premium plugin end-of-life announcement
The {productname} {release-version} release includes an accompanying release of the **Table of Contents** premium plugin.

The following Premium plugin has been announced as reaching its end-of-life:
This **Table of Contents** release includes the following fixes.

=== <Premium plugin name eol>
==== Encoding header of Table of Contents causing HTML source to be revealed on refresh.
// #TINY-10682

{productname}’s xref:<plugincode>.adoc[<Premium plugin name eol>] plugin will be deactivated on <month> <DD>, <YYYY>, and is no longer available for purchase.
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.

[[accompanying-open-source-plugin-end-of-life-announcement]]
== Accompanying open source plugin end-of-life announcement
For example, if the **Table of Contents** (ToC) header contained the following content with "_Contents_" emphasized as follows:

The following open source plugin has been announced as reaching its end-of-life:
liveDemo::tiny-10682-initial[]

=== <Open source plugin name eol>
Upon refreshing the ToC, the header would change to display the HTML tags literally, exposing the underlying HTML:

{productname}’s xref:<plugincode>.adoc[<Open source plugin name eol>] plugin will be deactivated on <month> <DD>, <YYYY>, and is no longer available for purchase.
liveDemo::tiny-10682-before[]

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

[[accompanying-enhanced-skins-and-icon-packs-changes]]
== Accompanying Enhanced Skins & Icon Packs changes
liveDemo::tiny-10682-after[]

The {productname} {release-version} release includes an accompanying release of the **Enhanced Skins & Icon Packs**.
==== Encode header title for literal display in Table of Contents.
// #TINY-10789

=== Enhanced Skins & Icon Packs
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.

The **Enhanced Skins & Icon Packs** release includes the following updates:
{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.

The **Enhanced Skins & Icon Packs** were rebuilt to pull in the changes also incorporated into the default {productname} {release-version} skin, Oxide.
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:

For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-and-icon-packs.adoc[Enhanced Skins & Icon Packs].
liveDemo::tiny-10789-before[]

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

[[improvements]]
== Improvements

{productname} {release-version} also includes the following improvement<s>:
liveDemo::tiny-10789-after[]

=== <TINY-vwxyz 1 changelog entry>
// #TINY-vwxyz1

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


[[additions]]
== Additions
[[improvements]]
== Improvements

{productname} {release-version} also includes the following addition<s>:
{productname} {release-version} also includes the following improvement<s>:

=== <TINY-vwxyz 1 changelog entry>
// #TINY-vwxyz1
Expand Down Expand Up @@ -156,6 +175,20 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a

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

=== 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

Expand Down

0 comments on commit 38589cc

Please sign in to comment.