From 678105a3a37ea03ebfb03237c5930a7d1d58b9bb Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 13 Jul 2026 13:59:45 +1000 Subject: [PATCH 1/3] Docs: TINYDOC-3524 - Fix empty table rows, add ignored-words persistence guidance, and note custom dictionaries require self-hosting in Spell Checker docs --- modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc | 2 ++ modules/ROOT/partials/commands/tinymcespellchecker-cmds.adoc | 1 - .../partials/configuration/spellchecker_ignore_list.adoc | 5 +++++ modules/ROOT/partials/events/tinymcespellchecker-events.adoc | 1 - .../ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc | 1 - 5 files changed, 7 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc index 0efad81291..ac0fa5615e 100644 --- a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc +++ b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc @@ -36,6 +36,8 @@ To enable the {productname} Enterprise Spellchecking plugin, add `+tinymcespellc For information on installing the server-side component for spell checking, please see the xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker]. +NOTE: Custom dictionaries, which add words that are recognized as correctly spelled across a deployment, are available only with a xref:individual-spelling-container.adoc[self-hosted spelling service]. They cannot be configured on {cloudname}. For details, see xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. + === Example: TinyMCE Self-hosted Installation [source,js] diff --git a/modules/ROOT/partials/commands/tinymcespellchecker-cmds.adoc b/modules/ROOT/partials/commands/tinymcespellchecker-cmds.adoc index 28abafb89f..84275c1c2e 100644 --- a/modules/ROOT/partials/commands/tinymcespellchecker-cmds.adoc +++ b/modules/ROOT/partials/commands/tinymcespellchecker-cmds.adoc @@ -5,7 +5,6 @@ |mceSpellcheckDisable |Turns spellchecking off. |mceSpellcheckDialog |Opens the spellchecking dialog. |mceSpellcheckDialogClose |Closes the spellchecking dialog. -2+| |mceSpellcheckUpdate |Checks the editor content for new misspellings, highlights them, and offers spelling suggestions. |=== diff --git a/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc b/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc index 3aaa236937..fee68c3567 100644 --- a/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc +++ b/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc @@ -7,6 +7,11 @@ NOTE: Languages specified as keys in the `+spellchecker_ignore_list+` object mus *Type:* `+Array+` or `+Object+` +[[persisting-ignored-words]] +=== Persisting ignored words + +Words ignored during an editing session — through the *Ignore* or *Ignore All* menu items, or the `+addIgnoredWords+` API — apply only to the current session and are not retained after the editor is reloaded. To persist ignored words across sessions, store them in the host application (for example, when handling the `+SpellcheckerIgnore+` and `+SpellcheckerIgnoreAll+` events) and reapply them through the `+spellchecker_ignore_list+` option each time the editor is initialized. + === Example: using `+spellchecker_ignore_list+` to ignore words in all languages [source,js] diff --git a/modules/ROOT/partials/events/tinymcespellchecker-events.adoc b/modules/ROOT/partials/events/tinymcespellchecker-events.adoc index fbee4bdd63..1f587406a6 100644 --- a/modules/ROOT/partials/events/tinymcespellchecker-events.adoc +++ b/modules/ROOT/partials/events/tinymcespellchecker-events.adoc @@ -9,6 +9,5 @@ The following events are provided by the xref:introduction-to-tiny-spellchecker. |SpellcheckStart |N/A |Fired when spellchecking is enabled. |SpellcheckEnd |N/A |Fired when spellchecking is disabled. |SpellcheckerLanguageChanged |`+{ language: string, prevLanguage: string }+` |Fired when the spellchecking language is changed. -3+| |SpellcheckerUpdated |`+{ spelling: SpellingUpdate }+` |Fired when the editor content is checked for misspellings, and includes suggestions within xref:introduction-to-tiny-spellchecker.adoc#spelling-object[the `+spelling+` object]. |=== diff --git a/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc b/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc index cb40533260..1d63e24fd2 100644 --- a/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc +++ b/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc @@ -4,7 +4,6 @@ |addIgnoredWords |words: `+string[]+`, lang?: `+string+` |Add an array of words to the `+spellchecker_ignore_list+` for a specific language. Add the array of words to all languages by omitting the `+lang+` parameter. |getLanguage |N/A |Get the current language enabled for spellchecking. |setLanguage |language: `+string+` |Set the current language for spellchecking. This must be a supported language code (case-sensitive). For a list of supported languages, see: xref:introduction-to-tiny-spellchecker.adoc#supported-languages[Spell Checker - `+Supported languages+`]. -3+| |getSpellingErrors |N/A |Returns an array of objects representing each existing misspelled word in the editor content, with each object using the keys `language` and `word`. |=== From fde57b4a30cbcd0870f51c2f81860f3a7ddadd33 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 13 Jul 2026 14:09:52 +1000 Subject: [PATCH 2/3] Docs: TINYDOC-3524 - Reword custom dictionaries callout to highlight it as a self-hosted benefit --- modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc index ac0fa5615e..3c1abf2842 100644 --- a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc +++ b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc @@ -36,7 +36,7 @@ To enable the {productname} Enterprise Spellchecking plugin, add `+tinymcespellc For information on installing the server-side component for spell checking, please see the xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker]. -NOTE: Custom dictionaries, which add words that are recognized as correctly spelled across a deployment, are available only with a xref:individual-spelling-container.adoc[self-hosted spelling service]. They cannot be configured on {cloudname}. For details, see xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. +TIP: A self-hosted spelling service also unlocks custom dictionaries, letting you add organization-specific terms — such as product names, trademarks, and technical vocabulary — that the spell checker treats as correctly spelled. This capability is not available on {cloudname}. For details, see xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. === Example: TinyMCE Self-hosted Installation From 69e55d2ff0ced2a911d6e07cf400cab6af08b427 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 13 Jul 2026 14:27:28 +1000 Subject: [PATCH 3/3] Docs: TINYDOC-3524 - Use neutral technical wording for custom dictionaries note --- modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc index 3c1abf2842..7c25f6202d 100644 --- a/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc +++ b/modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc @@ -36,7 +36,7 @@ To enable the {productname} Enterprise Spellchecking plugin, add `+tinymcespellc For information on installing the server-side component for spell checking, please see the xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker]. -TIP: A self-hosted spelling service also unlocks custom dictionaries, letting you add organization-specific terms — such as product names, trademarks, and technical vocabulary — that the spell checker treats as correctly spelled. This capability is not available on {cloudname}. For details, see xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. +NOTE: Custom dictionaries are supported only with a self-hosted spelling service. They allow additional terms, such as product names or technical vocabulary, to be treated as correctly spelled. Custom dictionaries are not available on {cloudname}. For details, see xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]. === Example: TinyMCE Self-hosted Installation