Skip to content

Commit c310f40

Browse files
authored
DOC-3526: New tinymceai_reviews_change_tone_menu option to control the Change Tone review menu (#4211)
* DOC-3526: Add TinyMCE AI addition release note for tinymceai_reviews_change_tone_menu (TINY-14274) * Docs: DOC-3526 - Document tinymceai_reviews_change_tone_menu option (TINY-14274) Add the tinymceai_reviews_change_tone_menu configuration option to the TinyMCE AI options reference and link to it from the 8.7.0 release note. Correct the release note: an empty array is accepted with a warning and does not hide the Change Tone review. * Docs: DOC-3526 - Refine TINY-14274 wording per style review
1 parent edb3dd7 commit c310f40

2 files changed

Lines changed: 61 additions & 0 deletions

File tree

modules/ROOT/pages/8.7.0-release-notes.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,19 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[]
2828

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

31+
=== TinyMCE AI
32+
33+
The {productname} {release-version} release includes an accompanying release of the **TinyMCE AI** premium plugin.
34+
35+
**TinyMCE AI** includes the following addition.
36+
37+
==== New `tinymceai_reviews_change_tone_menu` option to control the Change Tone review menu
38+
// #TINY-14274
39+
40+
{productname} {release-version} adds the `+tinymceai_reviews_change_tone_menu+` option for **TinyMCE AI**. This option controls which tone options appear in the Change Tone review and their order. Only preset tone IDs are supported. Duplicate IDs are removed, and the menu displays tones in the configured order. If the option includes an invalid tone ID, the configuration is rejected and the default tones are used. For valid tone IDs and option details, see xref:tinymceai.adoc#tinymceai_reviews_change_tone_menu[`+tinymceai_reviews_change_tone_menu+`].
41+
42+
For information on the **TinyMCE AI** plugin, see: xref:tinymceai.adoc[TinyMCE AI].
43+
3144
// === <Premium plugin name 1> <Premium plugin name 1 version>
3245

3346
// The {productname} {release-version} release includes an accompanying release of the **<Premium plugin name 1>** premium plugin.

modules/ROOT/partials/configuration/tinymceai_options.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -563,6 +563,54 @@ tinymce.init({
563563
});
564564
----
565565

566+
[[tinymceai_reviews_change_tone_menu]]
567+
=== `+tinymceai_reviews_change_tone_menu+`
568+
569+
Array of tone IDs that define which tone options appear in the Change Tone review and their order. Only the listed tones appear in the menu.
570+
571+
This option applies only when `+'ai-reviews-change-tone'+` is included in the xref:tinymceai.adoc#tinymceai_reviews[`+tinymceai_reviews+`] option.
572+
573+
*Type:* `+Array+` of `+String+`
574+
575+
*Valid values:*
576+
577+
* `+'ai-reviews-tone-casual'+`: Casual tone
578+
* `+'ai-reviews-tone-direct'+`: Direct tone
579+
* `+'ai-reviews-tone-friendly'+`: Friendly tone
580+
* `+'ai-reviews-tone-confident'+`: Confident tone
581+
* `+'ai-reviews-tone-professional'+`: Professional tone
582+
583+
Duplicate IDs are removed, and the menu displays tones in the configured order. If the option includes an invalid tone ID, the configuration is rejected and the default tones are used. An empty array (`+[]+`) is accepted, but {productname} logs a console warning. To remove the Change Tone review entirely, omit `+'ai-reviews-change-tone'+` from the xref:tinymceai.adoc#tinymceai_reviews[`+tinymceai_reviews+`] option.
584+
585+
*Default value:*
586+
[source,js]
587+
----
588+
[
589+
'ai-reviews-tone-casual',
590+
'ai-reviews-tone-direct',
591+
'ai-reviews-tone-friendly',
592+
'ai-reviews-tone-confident',
593+
'ai-reviews-tone-professional'
594+
]
595+
----
596+
597+
.Example
598+
[source,js]
599+
----
600+
tinymce.init({
601+
selector: 'textarea',
602+
plugins: 'tinymceai',
603+
toolbar: 'tinymceai-chat tinymceai-quickactions tinymceai-review',
604+
tinymceai_reviews_change_tone_menu: [
605+
'ai-reviews-tone-professional',
606+
'ai-reviews-tone-friendly'
607+
],
608+
// Required for authentication
609+
tinymceai_token_provider: () => {
610+
return fetch('/api/token').then(r => r.json());
611+
}
612+
});
613+
566614
[[integrator-defined-reviews]]
567615
==== Integrator-defined reviews
568616

0 commit comments

Comments
 (0)