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
DOC-3356: Rename TinyMCE AI Review and Actions pages for URL clarity
Rename tinymceai-review-plugin and tinymceai-actions-plugin to
tinymceai-review and tinymceai-actions so paths reflect features under
the tinymceai plugin. Update navigation, cross-references, and partials.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tinymceai-actions.adoc
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Preview transformations and Actions API calls are **stateless**: each invocation
15
15
The Quick Actions feature is available as part of the `+tinymceai+` plugin for {productname} and through the Actions API. This page covers both:
16
16
17
17
* Plugin sections describe user-facing features and configuration (xref:tinymceai.adoc#options-quickactions[Quick Actions configuration]).
18
-
* API sections cover REST API access (starting at xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]).
18
+
* API sections cover REST API access (starting at xref:tinymceai-actions.adoc#actions-api[Actions API]).
19
19
20
20
[[demo]]
21
21
== Demo
@@ -32,7 +32,7 @@ Quick Actions fit transforming a selection or section (for example grammar fixes
32
32
Both Quick Actions and Review can propose edits that apply only after acceptance or rejection. The main differences are scope and where the work happens in the editor:
33
33
34
34
* *Quick Actions*: Operate on a selection or section (including the full document when the scope includes it). The Quick Actions menu runs one-off operations such as Chat with a pre-filled prompt, preview transformations, translation, and custom actions.
35
-
* *Review*: Always analyzes the entire document in read-only Review mode. Suggestions appear in the Review sidebar and in the document. See xref:tinymceai-review-plugin.adoc[Review] for details.
35
+
* *Review*: Always analyzes the entire document in read-only Review mode. Suggestions appear in the Review sidebar and in the document. See xref:tinymceai-review.adoc[Review] for details.
Finally, individual Quick Actions can also be added to the toolbar as shortcuts for easier access.
50
50
51
-
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].
51
+
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.adoc#default-actions[available actions].
52
52
53
53
The final example configuration looks as follows:
54
54
@@ -106,21 +106,21 @@ There are two types of actions available in the quick actions feature:
106
106
107
107
* Preview actions such as _Continue writing_, _Make shorter_, _Improve writing_, and _Fix grammar_ show a preview of your document where suggested edits appear so you can review them and apply or skip each change.
108
108
109
-
Custom actions let integrators define whether each action opens Chat or shows a preview. See xref:tinymceai-actions-plugin.adoc#custom-actions[Custom Actions].
109
+
Custom actions let integrators define whether each action opens Chat or shows a preview. See xref:tinymceai-actions.adoc#custom-actions[Custom Actions].
110
110
111
111
[[default-actions]]
112
112
== Default Actions
113
113
114
114
By default, the Quick Actions feature includes several built-in actions that speed up the content editing process. All Quick Actions can be accessed through the menu button image:icons/ai-prompt.svg[Quick Actions icon,24px] (`tinymceai-quickactions`) or individually when selected by the integrator in the xref:toolbar-configuration-options.adoc[editor toolbar configuration]. Whole action categories can be added to the toolbar as well.
115
115
116
-
Custom actions can be added to the list, and default actions can be removed or reordered by configuring `tinymceai_quickactions_menu`. See xref:tinymceai-actions-plugin.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu].
116
+
Custom actions can be added to the list, and default actions can be removed or reordered by configuring `tinymceai_quickactions_menu`. See xref:tinymceai-actions.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu].
117
117
118
118
[[quick-actions-reference-table]]
119
119
The following table lists built-in Quick Actions.
120
120
121
121
* The **Editor** column is the label in the Quick Actions menu when that action is available in the editor.
122
-
* The **Menu or control ID** column lists values for `tinymceai_quickactions_menu`, `tinymceai_quickactions_chat_prompts`, `tinymceai_quickactions_change_tone_menu`, and the toolbar when adding individual controls (see xref:tinymceai-actions-plugin.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu]).
123
-
* The **System `actionName` or quick-action prompt id** column is the service identifier. Preview actions use a system `actionName` with the xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]. Chat actions use a quick-action prompt id and xref:tinymceai-chat.adoc[Chat] with a pre-filled prompt, not the system actions API.
122
+
* The **Menu or control ID** column lists values for `tinymceai_quickactions_menu`, `tinymceai_quickactions_chat_prompts`, `tinymceai_quickactions_change_tone_menu`, and the toolbar when adding individual controls (see xref:tinymceai-actions.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu]).
123
+
* The **System `actionName` or quick-action prompt id** column is the service identifier. Preview actions use a system `actionName` with the xref:tinymceai-actions.adoc#actions-api[Actions API]. Chat actions use a quick-action prompt id and xref:tinymceai-chat.adoc[Chat] with a pre-filled prompt, not the system actions API.
124
124
125
125
[cols="1,3,2,3,1,1",options="header"]
126
126
|===
@@ -185,7 +185,7 @@ For system action endpoints, schemas, and streaming details, see the https://tin
185
185
[[custom-actions]]
186
186
== Custom Actions
187
187
188
-
The `tinymceai_quickactions_custom` configuration property allows adding new commands to the Quick actions feature. The items can be of type `action` (a quick action that shows a preview of the editor content with AI suggestions so changes can be reviewed before applying) or type `chat` (which opens the chat interface for a conversation related to the prompt and selection). The `title` is used in the menu items, while the `prompt` is what is actually sent to the AI. The `model` is required for `action` type commands. Learn more about xref:tinymceai-actions-plugin.adoc#types-of-actions[types of actions].
188
+
The `tinymceai_quickactions_custom` configuration property allows adding new commands to the Quick actions feature. The items can be of type `action` (a quick action that shows a preview of the editor content with AI suggestions so changes can be reviewed before applying) or type `chat` (which opens the chat interface for a conversation related to the prompt and selection). The `title` is used in the menu items, while the `prompt` is what is actually sent to the AI. The `model` is required for `action` type commands. Learn more about xref:tinymceai-actions.adoc#types-of-actions[types of actions].
189
189
190
190
[source,js]
191
191
----
@@ -263,14 +263,14 @@ tinymce.init({
263
263
[[actions-api]]
264
264
== Actions API
265
265
266
-
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—each request is independent, as described under xref:tinymceai-actions-plugin.adoc#stateless-actions[Stateless actions]. 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].
266
+
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—each request is independent, as described under xref:tinymceai-actions.adoc#stateless-actions[Stateless actions]. 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].
267
267
268
268
Actions use streaming output with Server-Sent Events for real-time feedback as results are generated.
269
269
270
270
[[actions-system-actions-api]]
271
271
=== System Actions
272
272
273
-
Built-in Quick Actions—including identifiers, descriptions, and whether each command uses the system Actions API or Chat (Conversations API)—are summarized in xref:tinymceai-actions-plugin.adoc#quick-actions-reference-table[Default Actions].
273
+
Built-in Quick Actions—including identifiers, descriptions, and whether each command uses the system Actions API or Chat (Conversations API)—are summarized in xref:tinymceai-actions.adoc#quick-actions-reference-table[Default Actions].
274
274
275
275
For endpoint details, request and response schemas, authentication, and streaming behavior for system `actionName` calls, see https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API].
276
276
@@ -297,4 +297,4 @@ The https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] reference (in
297
297
== Related Features
298
298
299
299
* xref:tinymceai-chat.adoc[AI Chat]: For interactive discussions with document analysis and context.
300
-
* xref:tinymceai-review-plugin.adoc[AI Review]: For content quality analysis and improvement suggestions.
300
+
* xref:tinymceai-review.adoc[AI Review]: For content quality analysis and improvement suggestions.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tinymceai-models.adoc
+4-4Lines changed: 4 additions & 4 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
:description_short: AI model configuration
8
8
:keywords: AI, models, configuration, tinymceai
9
9
10
-
{pluginname} supports multiple AI models from different providers. Which models may be used is determined by xref:tinymceai-permissions.adoc#model-permissions[model permissions] in the JWT; the plugin configuration UI, REST API request bodies, and per-action options (for example xref:tinymceai-actions-plugin.adoc[Quick Actions] custom items) then select which allowed model applies in each situation. This page covers model capabilities, configuration options, and limitations that apply to both plugin and API usage.
10
+
{pluginname} supports multiple AI models from different providers. Which models may be used is determined by xref:tinymceai-permissions.adoc#model-permissions[model permissions] in the JWT; the plugin configuration UI, REST API request bodies, and per-action options (for example xref:tinymceai-actions.adoc[Quick Actions] custom items) then select which allowed model applies in each situation. This page covers model capabilities, configuration options, and limitations that apply to both plugin and API usage.
11
11
12
12
[[recommended-agent-models]]
13
13
== Recommended: Agent Models
@@ -138,7 +138,7 @@ Plugin configuration, API parameters, and per-feature options do not grant acces
138
138
* **JWT model permissions**: Set `ai:models:*`, `ai:models:agent`, `ai:models:<provider>:*`, or `ai:models:<provider>:<model-name>` as required. See xref:tinymceai-permissions.adoc#model-permissions[Model permissions] and xref:tinymceai-jwt-authentication-intro.adoc[JWT Authentication].
139
139
* **Plugin configuration**: `tinymceai_default_model` sets the default model, and `tinymceai_allow_model_selection` controls whether end users can choose among allowed models in the UI. See xref:tinymceai.adoc#options-chat[Chat configuration options].
140
140
* **API requests**: The `model` field in request bodies selects the model for that call. See xref:tinymceai-models.adoc#api-examples[API Examples] below.
141
-
* **Custom Quick Actions and similar**: Per-item options such as the `model` property on xref:tinymceai-actions-plugin.adoc#custom-actions[custom Quick Actions] select a model for that action; the value must be among the models allowed by the JWT.
141
+
* **Custom Quick Actions and similar**: Per-item options such as the `model` property on xref:tinymceai-actions.adoc#custom-actions[custom Quick Actions] select a model for that action; the value must be among the models allowed by the JWT.
142
142
143
143
[NOTE]
144
144
====
@@ -394,6 +394,6 @@ The https://tinymceai.api.tiny.cloud/docs#tag/Models[Models API] section of the
394
394
== Related Features
395
395
396
396
* xref:tinymceai-chat.adoc[Chat]: Use models in interactive AI discussions and configure model selection.
397
-
* xref:tinymceai-review-plugin.adoc[Review]: Apply models to content analysis and improvement.
398
-
* xref:tinymceai-actions-plugin.adoc[Quick Actions]: Use models for content transformation tasks.
397
+
* xref:tinymceai-review.adoc[Review]: Apply models to content analysis and improvement.
398
+
* xref:tinymceai-actions.adoc[Quick Actions]: Use models for content transformation tasks.
399
399
* xref:tinymceai.adoc[Plugin Reference]: Complete plugin configuration options including model settings.
0 commit comments