You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tinymceai-actions-plugin.adoc
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
:keywords: AI, quick actions, actions, tinymceai
8
8
:page-role: -toc
9
9
10
-
Quick actions simplify routine content transformations by offering one-click AI-powered suggestions directly within the editor. This feature enhances speed, relevance, and usability, particularly for repeatable or simple tasks. The plugin feature comes with a review interface for most AI suggestions; some actions (such as Explain or Summarize) open the xref:tinymceai-chat.adoc[Chat] instead and start the conversation with a pre-filled prompt. The API includes the ability to call predefined and optimized system actions, or to define your own.
10
+
Quick actions simplify routine content transformations by offering one-click AI-powered suggestions directly within the editor. This feature enhances speed, relevance, and usability, particularly for repeatable or simple tasks. For suggestions that change the document, the editor shows a preview and applies changes only after each suggestion is accepted or rejected. For actions that only open Chat with a pre-filled prompt, see xref:tinymceai-chat.adoc[Chat]. The API includes the ability to call predefined and optimized system actions, or to define your own.
11
11
12
12
The Quick Actions feature is available as part of the `+tinymceai+` plugin for {productname} and through the Actions API. This page covers both:
13
13
@@ -17,35 +17,29 @@ The Quick Actions feature is available as part of the `+tinymceai+` plugin for {
17
17
[[demo]]
18
18
== Demo
19
19
20
-
liveDemo::tinymceai-actions[]
21
-
22
-
Actions are fast, stateless operations that transform content. Unlike Reviews that provide suggestions for review, Actions run a transformation and display the result in a preview interface where users can accept or reject before changes are applied.
23
-
24
-
**When to use Actions vs Reviews?**
20
+
The live demo loads the full {productname} example with Chat, Quick Actions, and Review on the toolbar.
25
21
26
-
* *Actions*: Transform a selection or small section of text (fix grammar, translate, adjust tone).
27
-
* *Reviews*: Analyze entire documents for quality improvements and get suggestions without automatically changing the content.
22
+
liveDemo::tinymceai-actions[]
28
23
24
+
[[quick-actions-vs-review]]
25
+
== Quick Actions vs Review
29
26
30
-
image::tinymceai/tinymce-ai-quick-actions-toolbar-primary-menu-with-chat-commands.png[{pluginname} quick actions showing AI-powered suggestions and Q&A functionality,width=80%]
27
+
* *Quick Actions*: Target a selection or section (including the full document when the scope includes it). The feature supports a wide range of operations: for example opening Chat with a pre-filled prompt, preview transformations, translation, and custom actions.
28
+
* *Review*: Always analyzes the entire document and is built for whole-document quality review with suggestions in the Review sidebar. See xref:tinymceai-review-plugin.adoc[Review] for details.
31
29
32
30
[[integration]]
33
31
== Integration
34
32
35
33
To start using the Quick Actions feature, first load the {pluginname} plugin in the editor configuration. See xref:tinymceai.adoc[Plugin Reference] for installation and enabling AI features.
36
34
37
-
Then, add the menu that opens the list of Quick Actions (`tinymceai-quickactions`) image:icons/ai-prompt.svg[Quick Actions icon,24px] to the main toolbar and/or context toolbar (selection toolbar) configurations.
35
+
Then, add the menu that opens the list of Quick Actions (`tinymceai-quickactions`) image:icons/ai-prompt.svg[Quick Actions icon,24px] to the main toolbar and/or context toolbar (selection toolbar) configurations.
38
36
39
-
[NOTE]
40
-
====
41
-
AI features are added to the selection toolbar by default when the plugin is enabled. Use the toolbar configuration options to customize which AI features appear.
42
-
====
37
+
image::tinymceai/tinymce-ai-quick-actions-change-tone-flyout-submenu.png[{pluginname} Quick Actions dropdown in the toolbar,width=80%]
43
38
44
-
To learn more about toolbar configuration, refer to the xref:toolbar-configuration-options.adoc[toolbar configuration] guide.
45
39
46
-
image::tinymceai/tinymce-ai-quick-actions-change-tone-flyout-submenu.png[{pluginname} Quick Actions dropdown in the toolbar,width=80%]
40
+
Finally, individual Quick Actions can also be added to the toolbar as shortcuts for easier access.
47
41
48
-
Finally, individual Quick Actions can also be added to the toolbar as shortcuts for easier access. For example, add the `ai-quickactions-improve-writing` image:icons-premium/improve-writing.svg[Improve Writing icon,24px] button, or the `ai-chat-explain` image:icons-premium/explain.svg[Explain icon,24px] button (find it in the demo above). Whole categories can be added to the toolbar as well. xref:tinymceai-actions-plugin.adoc#default-actions[Learn more about available actions].
42
+
For example, add the `ai-quickactions-improve-writing` image:icons-premium/improve-writing.svg[Improve Writing icon,24px] button, or the `ai-chat-explain` image:icons-premium/explain.svg[Explain icon,24px] button (find it in the demo above). Whole categories can be added to the toolbar as well. Learn more about xref:tinymceai-actions-plugin.adoc#default-actions[available actions].
49
43
50
44
The final example configuration looks as follows:
51
45
@@ -78,6 +72,13 @@ tinymce.init({
78
72
});
79
73
----
80
74
75
+
[NOTE]
76
+
====
77
+
AI features are added to the selection toolbar by default when the plugin is enabled. Use the toolbar configuration options to customize which AI features appear.
78
+
====
79
+
80
+
To learn more about toolbar configuration, refer to the xref:toolbar-configuration-options.adoc[toolbar configuration] guide.
81
+
81
82
[[types-of-actions]]
82
83
== Types of actions
83
84
@@ -244,9 +245,9 @@ tinymce.init({
244
245
[[actions-api]]
245
246
== Actions API
246
247
247
-
The Quick Actions plugin feature is built on top of the Actions API, which provides REST API access to action functionality. Actions are fast, stateless operationsthat transform content. Unlike Reviews that provide suggestions for review, Actions run a transformation and display the result in a preview interface where users can accept or reject before changes are applied.
248
+
The Quick Actions plugin feature is built on top of the Actions API, which provides REST API access to action functionality. Actions are fast, stateless operations. For suggestions that change the document, the preview flow applies edits only after each suggestion is accepted or rejected. Actions that only open Chat with a pre-filled prompt use the Conversations API; see xref:tinymceai-chat.adoc[Chat].
248
249
249
-
**When to use Actions vs Reviews:** Use Actions when transforming a selection or small section of text (fix grammar, translate, adjust tone). Use Reviews when analyzing entire documents for quality improvements and getting suggestions without automatically changing the content.
250
+
**When to use Quick Actions vs Review:** Use Quick Actions for operations on a selection or section (including Chat with a pre-filled prompt, preview transformations, translation, and custom actions). Use Review for whole-document quality review with suggestions in the Review sidebar. See xref:tinymceai-review-plugin.adoc[Review] for details.
250
251
251
252
Unlike conversations, actions do not remember previous interactions. Each action is independent and focused on a single task. Actions use streaming output with Server-Sent Events for real-time feedback as results are generated.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tinymceai-review-plugin.adoc
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
:keywords: AI, review, reviews, tinymceai
8
8
:page-role: -toc
9
9
10
-
The Review feature provides AI-powered quality assurance for content by running checks for grammar, style, tone, and more. The plugin introduces an intuitive interface for reviewing and managing AI-suggested edits directly within the document, ensuring content meets professional standards with minimal manual effort. The API offers the same functionality with flexible integration.
10
+
The Review feature provides AI-powered quality assurance for content by running checks for grammar, style, clarity, tone, and more. Review always analyzes the entire document. For operations on a selection or section, see xref:tinymceai-actions-plugin.adoc[Quick Actions]. The editor enters read-only Review mode until the review completes or is dismissed. Suggestions appear in the Review sidebar and in the document; each change applies only after acceptance or rejection. The plugin introduces an intuitive interface for reviewing and managing AI-suggested edits directly within the document, ensuring content meets professional standards with minimal manual effort. The API offers the same functionality with flexible integration.
11
11
12
12
The Review feature is available as a plugin UI and through the Reviews API. This page covers both:
13
13
@@ -17,11 +17,15 @@ The Review feature is available as a plugin UI and through the Reviews API. This
17
17
[[demo]]
18
18
== Demo
19
19
20
+
The interactive demo below loads the editor with the Review feature. Use the Review toolbar button to open the Review sidebar and run the built-in review commands.
21
+
20
22
liveDemo::tinymceai-review[]
21
23
22
-
The Review feature analyzes content and provides specific recommendations for grammar, style, clarity, and tone improvements. Unlike Actions that transform content directly, Reviews analyze content and provide suggestions without automatically changing the content.
24
+
=== Review sidebar and commands
25
+
26
+
The figure below is a static screenshot of the Review sidebar in Review mode before any suggestions are returned. Built-in reviews are grouped by category (Proofread, Improve clarity, Improve readability, Change length, Adjust tone and style). Expand a category to read the description and select **Run** to analyze the whole document. In this example, **Improve readability** is expanded.
23
27
24
-
image::tinymceai/tinymce-ai-review-sidebar-command-categories-proofread-clarity.png[{pluginname} Review feature showing AI-powered quality assurance and suggested edits,width=80%]
28
+
image::tinymceai/tinymce-ai-review-sidebar-command-categories-proofread-clarity.png[Review sidebar showing review categories with Improve readability expanded and Run available,width=80%]
25
29
26
30
[[integration]]
27
31
== Integration
@@ -81,9 +85,9 @@ Which review commands appear in the Review sidebar can be configured using the `
81
85
[[reviews-api]]
82
86
== Reviews API
83
87
84
-
The Review plugin feature is built on top of the Reviews API, which provides REST API access to review functionality. Reviews provide comprehensive content analysis and improvement suggestions. Unlike Actions that transform content directly, Reviews analyze content and provide specific recommendations for grammar, style, clarity, and tone improvements.
88
+
The Review plugin feature is built on top of the Reviews API, which provides REST API access to review functionality. Reviews provide comprehensive content analysis and improvement suggestions for the entire document. Suggested edits apply only after acceptance or rejection in the Review workflow. For operations on a selection or section, see xref:tinymceai-actions-plugin.adoc[Quick Actions].
85
89
86
-
**When to use Reviews vs Actions:** Use Reviews when analyzing entire documents for quality improvements and getting suggestions without automatically changing the content. Use Actions when transforming specific text content (fix grammar, translate, adjust tone).
90
+
**When to use Reviews vs Quick Actions:** Use Reviews for whole-document quality checks with suggestions in the Review sidebar. Use Quick Actions for a selection or section, including preview transformations, translation, Chat with a pre-filled prompt, and custom actions. See xref:tinymceai-actions-plugin.adoc[Quick Actions] for details.
87
91
88
92
Reviews use streaming output with Server-Sent Events for real-time feedback as suggestions are generated. Each review type is optimized for specific improvement tasks, providing consistent, high-quality analysis of text structure, style, and quality. Reviews provide specific, actionable recommendations for content improvement.
0 commit comments