Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

[source,js]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
|===

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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].
|===
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
|===

Expand Down
Loading