DOC-3468 - Document TinyMCE AI 8.5 custom reviews, commands, and quickbars integration#4070
DOC-3468 - Document TinyMCE AI 8.5 custom reviews, commands, and quickbars integration#4070kemister85 wants to merge 4 commits intofeature/8.5.0/DOC-3355from
Conversation
…bars integration - Add tinymceai_reviews option with ai-reviews-custom for custom review - Document all new Quick Action commands and TinyMCEAIChatPrompt - Add id property to tinymceai_quickactions_custom for toolbar/menu/quickbars use - Update full-featured and tinymceai-review demos with explicit tinymceai_reviews - Update editor-command-identifiers and tinymceai-actions for quickbars integration - Remove undocumented TinyMCEAIDiagnostic command - Update review sidebar screenshot
2ec0b88 to
8c99741
Compare
| cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js | ||
| tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js | ||
| tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js | ||
| tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js |
There was a problem hiding this comment.
- Revert before merging
| tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js | |
| tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js |
| [[custom-review-choose-review]] | ||
| == Custom review | ||
|
|
||
| When `+'ai-reviews-custom'+` is present in xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`], the Review sidebar includes a **Custom review** category. A natural-language prompt can be entered, and an AI model can be selected when xref:tinymceai.adoc#tinymceai_allow_model_selection[`tinymceai_allow_model_selection`] allows it; the review runs from **Run**. The document is analyzed with streaming suggestions like xref:tinymceai-review.adoc#review-sidebar-and-built-in-reviews[built-in reviews]; **Run** remains disabled until the prompt is entered and a model is selected. |
There was a problem hiding this comment.
Asked the devs a question to clarify this. Waiting on response.
There was a problem hiding this comment.
Noted — waiting on the dev response before making further changes to this section.
- Remove explicit tinymceai_reviews from all 4 demo files (default config) - Simplify Custom review table row and NOTE (no qualifier needed) - Apply wording suggestion for quickbars custom action note - Reword Custom review section as default rather than conditional
|
The TINY-14229 change (new optional |
|
The TINY-14266 change (new commands for executing AI UI actions) has been covered in the release notes: #4082 |
| [[tinymceai-floating-sidebar-api]] | ||
| === Floating sidebar and `+ToggleSidebar+` | ||
|
|
||
| When xref:tinymceai.adoc#tinymceai_sidebar_type[`tinymceai_sidebar_type`] is `+'floating'+`, the core `+ToggleSidebar+` command, the `+ToggleSidebar+` event, and `+queryCommandValue('ToggleSidebar')+` work the same as for a static sidebar for `+'tinymceai-chat'+` and `+'tinymceai-review'+`. |
There was a problem hiding this comment.
I wonder if we even need to include this info I treated it more like a bug that we didn't fully support this API but maybe we could have general notes or some example on how to deal with these events and the query state in general not specifically for floating sidebars?
|
|
||
| [NOTE] | ||
| ==== | ||
| Command names use the `+TinyMCEAIQuickActions…+` prefix (with an `+s+`) for **Explain**, **Summarize**, and **Highlight key points** — these map to the xref:tinymceai.adoc#tinymceai_quickactions_chat_prompts[chat prompts] submenu, not to standalone `+TinyMCEAIQuickAction…+` spellings. |
There was a problem hiding this comment.
Hmm, right I wonder if this will be confusing not to have the s suffix but then again executing a command like TinyMCEAIQuickActionsCustom could be interpreted that you are executing multiple quick actions when we are just executing one. 🤔
| * `+prompt+`: The prompt sent to the AI | ||
| * `+type+`: `+'action'+` or `+'chat'+` | ||
| * `+model+`: Required for `+action+` type only | ||
| * `+id+` (optional): Stable identifier for the custom action. When set, the same string can be listed in xref:tinymceai.adoc#tinymceai_quickactions_menu[`tinymceai_quickactions_menu`] so the action appears as its own top-level menu item instead of only inside the Custom submenu. The identifier can also be used in xref:quickbars.adoc#quickbars_selection_toolbar[`+quickbars_selection_toolbar+`], the xref:menus-configuration-options.adoc#menu[`+menu+`] option, or any other toolbar or menu configuration that accepts control identifiers. |
There was a problem hiding this comment.
It's actually only menu items. So the id makes it possible to use the custom menu item in any place we expect menu ids.
Ticket: DOC-3468
Site:
Changes:
ai-reviews-customtotinymceai_reviewsoption with new default value; addedidproperty totinymceai_quickactions_customwith examples fortinymceai_quickactions_menu,quickbars_selection_toolbar, andmenuconfigurationsTinyMCEAIQuickActionTranslate(language arg),TinyMCEAIQuickActionCustom(prompt/model), andTinyMCEAIChatPrompt(prompt/displayedPrompt); added ToggleSidebar usage for floating sidebars; removed undocumentedTinyMCEAIDiagnosticidusage inquickbars_selection_toolbarexample.jsandindex.js) — Added explicittinymceai_reviewsarray includingai-reviews-customPre-checks:
feature/8.5.0/DOC-3355_DOC-3468modules/ROOT/nav.adochas been updated (if applicable). — N/A, no new pagesrelease noteentry. — Release notes handled by DOC-3355supported-versions.adoctable. — N/AReview: