feature(Plugins/Premium Plugins/Spellchecker pro): Update docs for Spellchecker pro premium plugin, tinydrive and rtc (#2309)

hamza0867 · web-flow · commit f616f5aa5a06 · 2022-03-29T20:36:46.000+10:00
diff --git a/modules/ROOT/pages/plugins/premium/rtc.adoc b/modules/ROOT/pages/plugins/premium/rtc.adoc
@@ -10,4 +10,4 @@ include::partial$misc/premiumplugin.adoc[]
 
 include::partial$rtc/rtc-description.adoc[]
 
-For information on the Real-time Collaboration plugin, see link:{baseurl}/rtc/[Real-time Collaboration (RTC)].
+For information on the Real-time Collaboration plugin, see xref:rtc/index.adoc[Real-time Collaboration (RTC)].
diff --git a/modules/ROOT/pages/plugins/premium/tinydrive.adoc b/modules/ROOT/pages/plugins/premium/tinydrive.adoc
@@ -8,9 +8,9 @@
 
 NOTE: This plugin is only available for link:{pricingpage}[{cloudname} users].
 
-The link:{baseurl}/tinydrive/introduction/[{cloudfilemanager}] plugin adds the functionality to upload and manage files and images to the cloud. This plugin is only available in link:{accountsignup}[{cloudname}] and requires you to register for an API key.
+The xref:tinydrive/introduction.adoc[{cloudfilemanager}] plugin adds the functionality to upload and manage files and images to the cloud. This plugin is only available in link:{accountsignup}[{cloudname}] and requires you to register for an API key.
 
-To enable this functionality, add `tinydrive` to the list of plugins in the `tinymce.init` call. You also need to authenticate the user using a link:{baseurl}/tinydrive/jwt-authentication[JSON Web Token] (JWT).
+To enable this functionality, add `tinydrive` to the list of plugins in the `tinymce.init` call. You also need to authenticate the user using a xref:tinydrive/jwt-authentication.adoc[JSON Web Token] (JWT).
 
 Once you enable {cloudfilemanager} it integrates as the default file picker for the Image, Link, and Media dialogs and as the default upload handler for local images being pasted or inserted into the document.
 
@@ -31,7 +31,7 @@ tinymce.init({
 
 == Configuration
 
-You can read more about the various configuration options for {cloudfilemanager} in the dedicated link:{baseurl}/tinydrive/configuration/[configuration page].
+You can read more about the various configuration options for {cloudfilemanager} in the dedicated xref:tinydrive/configuration.adoc[configuration page].
 
 include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
 
diff --git a/modules/ROOT/pages/plugins/premium/tinymcespellchecker.adoc b/modules/ROOT/pages/plugins/premium/tinymcespellchecker.adoc
@@ -8,13 +8,13 @@
 
 include::partial$misc/premiumplugin.adoc[]
 
-*Spell Checker Pro* adds spell checking as-you-type capabilities to {productname}. For information on the supported languages, refer to link:{baseurl}/plugins/premium/tinymcespellchecker/#spellchecker_language[this] section.
+*Spell Checker Pro* adds spell checking as-you-type capabilities to {productname}. For information on the supported languages, refer to xref:plugins/premium/tinymcespellchecker.adoc#spellchecker_language[this] section.
 
 liveDemo::spellcheckerpro[]
 
 == Cloud Installation
 
-To enable the {productname} Enterprise Spellchecking plugin with link:{baseurl}/cloud-deployment-guide/editor-and-features[{cloudname}]:
+To enable the {productname} Enterprise Spellchecking plugin with xref:cloud-deployment-guide/editor-and-features.adoc[{cloudname}]:
 
 . If configured, disable the `spellchecker` plugin provided with {productname}, by removing it from the `plugins` list.
 . Add `tinymcespellchecker` to the `plugins` list.
@@ -39,7 +39,7 @@ To enable the {productname} Enterprise Spellchecking plugin:
 . If configured, disable the `spellchecker` plugin provided with {productname}, by removing it from the `plugins` list.
 . Add `tinymcespellchecker` to the `plugins` list.
 
-For information on installing the server-side component for spell checking, please see the link:{baseurl}/enterprise/server/[server-side component installation guide].
+For information on installing the server-side component for spell checking, please see the xref:enterprise/server/index.adoc[server-side component installation guide].
 
 === Example: TinyMCE Self-hosted Installation
 
@@ -65,7 +65,7 @@ include::partial$configuration/spellchecker_dialog.adoc[]
 
 include::partial$configuration/spellchecker_language.adoc[]
 
-include::partial$misc/spellchecker-languages.adoc[]
+include::partial$misc/spellchecker-languages.adoc[leveloffset=+2]
 
 include::partial$configuration/spellchecker_languages.adoc[]
 
@@ -77,10 +77,6 @@ include::partial$plugins/tinymcespellchecker-content-langs.adoc[]
 
 include::partial$configuration/spellchecker_select_languages.adoc[]
 
-// Bookmark for deprecated option name
-
-+++<a class="anchor" id="spellchecker_whitelist">++++++</a>+++
-
 include::partial$configuration/spellchecker_ignore_list.adoc[]
 
 include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
diff --git a/modules/ROOT/partials/configuration/spellchecker_active.adoc b/modules/ROOT/partials/configuration/spellchecker_active.adoc
@@ -1,3 +1,4 @@
+[[spellchecker_active]]
 === `spellchecker_active`
 
 This option enables or disables the spell checker when the editor is loaded. When set to `false`, the spellchecker will not be active when the editor is initialized. The toolbar button or the menu item will have to be selected by the user to start the spell checker.
diff --git a/modules/ROOT/partials/configuration/spellchecker_dialog.adoc b/modules/ROOT/partials/configuration/spellchecker_dialog.adoc
@@ -2,8 +2,8 @@
 
 This option specifies the primary spell checking mode.
 
-* When set to `true`, the <<toolbarbuttons,`spellcheck` toolbar button>> will open a dialog that will step the user through each potential spelling error in the document.
-* When set to `false`, the <<toolbarbuttons,`spellcheck` toolbar button>> will enable or disable as-you-type spell checking and the <<toolbarbuttons,`spellcheckdialog` toolbar button>> will open the spell checker dialog.
+* When set to `true`, the xref:plugins/premium/tinymcespellchecker.adoc#toolbarbuttons[`spellcheck` toolbar button] will open a dialog that will step the user through each potential spelling error in the document.
+* When set to `false`, the xref:plugins/premium/tinymcespellchecker.adoc#toolbarbuttons[`spellcheck` toolbar button] will enable or disable as-you-type spell checking and the xref:plugins/premium/tinymcespellchecker.adoc#toolbarbuttons[`spellcheckdialog` toolbar button] will open the spell checker dialog.
 
 *Type:* `Boolean`
 
diff --git a/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc b/modules/ROOT/partials/configuration/spellchecker_ignore_list.adoc
@@ -1,9 +1,10 @@
+// Bookmark for deprecated spellchecker_whitelist option name
 [[spellchecker_ignore_list]]
-=== `spellchecker_ignore_list`
+=== [[spellchecker_whitelist]] `spellchecker_ignore_list`
 
 This option specifies which words should be ignored by the spell checker. If an array of words is provided, the specified words will be ignored for all languages. If an object containing an array of words per language is provided, the specified words will be ignored for the specified languages.
 
-NOTE: Languages specified as keys in the `spellchecker_ignore_list` object must match the configured link:{baseurl}/plugins/premium/tinymcespellchecker/#spellchecker_languages[Spellchecker Languages].
+NOTE: Languages specified as keys in the `spellchecker_ignore_list` object must match the configured xref:plugins/premium/tinymcespellchecker.adoc#spellchecker_languages[Spellchecker Languages].
 
 *Type:* `String[]` or `Object`
 
diff --git a/modules/ROOT/partials/configuration/spellchecker_language.adoc b/modules/ROOT/partials/configuration/spellchecker_language.adoc
@@ -1,3 +1,4 @@
+[[spellchecker_language]]
 === `spellchecker_language`
 
 This option specifies the default language used by Spell Checker Pro.
diff --git a/modules/ROOT/partials/configuration/spellchecker_languages.adoc b/modules/ROOT/partials/configuration/spellchecker_languages.adoc
@@ -1,6 +1,7 @@
+[[spellchecker_languages]]
 === `spellchecker_languages`
 
-This option specifies the spellchecker languages that are available to the user, provided as a comma delimited string. For a list of available languages, see: <<supportedlanguages,Supported languages>>.
+This option specifies the spellchecker languages that are available to the user, provided as a comma delimited string. For a list of available languages, see: xref:supportedlanguages[Supported languages].
 
 *Type:* comma-separated `String`
 
diff --git a/modules/ROOT/partials/configuration/spellchecker_on_load.adoc b/modules/ROOT/partials/configuration/spellchecker_on_load.adoc
@@ -1,6 +1,7 @@
+[[spellchecker_on_load]]
 === `spellchecker_on_load`
 
-NOTE: Removed in Spell Checker Pro 2.0 (TinyMCE 5.2). Spell Checker Pro will now always run on editor initialization. To disable Spell Checker Pro on load, use <<spellchecker_active,`spellchecker_active`>>.
+NOTE: Removed in Spell Checker Pro 2.0 (TinyMCE 5.2). Spell Checker Pro will now always run on editor initialization. To disable Spell Checker Pro on load, use xref:spellchecker_active[`spellchecker_active`].
 
 This option runs the spellchecker when the contents of the editor is loaded.
 
diff --git a/modules/ROOT/partials/configuration/spellchecker_rpc_url.adoc b/modules/ROOT/partials/configuration/spellchecker_rpc_url.adoc
@@ -1,8 +1,9 @@
+[[spellchecker_rpc_url]]
 === `spellchecker_rpc_url`
 
-This option specifies the URL of the server-side `ephox-spelling` service. For instructions on how to set up a Spell Checker Pro server-side component, see: the link:{baseurl}/enterprise/server/[server-side component installation guide].
+This option specifies the URL of the server-side `ephox-spelling` service. For instructions on how to set up a Spell Checker Pro server-side component, see: the xref:enterprise/server/index.adoc[server-side component installation guide].
 
-NOTE: `spellchecker_rpc_url` is *not* required when enabling this plugin via link:{baseurl}/cloud-deployment-guide/editor-and-features/[{cloudname}]
+NOTE: `spellchecker_rpc_url` is *not* required when enabling this plugin via xref:cloud-deployment-guide/editor-and-features.adoc[{cloudname}]
 
 *Type:* `String`
 
diff --git a/modules/ROOT/partials/configuration/spellchecker_select_languages.adoc b/modules/ROOT/partials/configuration/spellchecker_select_languages.adoc
@@ -5,7 +5,7 @@ IMPORTANT: This option will be removed in {productname} 6.0.
 
 NOTE: The `spellchecker_select_languages` option was deprecated with the release of {productname} 5.9. The `content_langs` option should be used instead. This change was made to allow more control over the way languages are specified, and to reflect that the option can be used outside of spell checking.
 
-This option specifies the languages that can be set for content when working with multi-language content. The specified languages will be available from the <<toolbarbuttons,`language` toolbar drop-down menu button>>.  For a list of available languages, see: <<supportedlanguages,Supported languages>>.
+This option specifies the languages that can be set for content when working with multi-language content. The specified languages will be available from the xref:plugins/premium/tinymcespellchecker.adoc#toolbarbuttons[`language` toolbar drop-down menu button].  For a list of available languages, see: xref:plugins/premium/tinymcespellchecker.adoc#supportedlanguages[Supported languages].
 
 *Type:* comma-separated `String`
 
diff --git a/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc b/modules/ROOT/partials/plugin-apis/tinymcespellchecker-apis.adoc
@@ -13,12 +13,13 @@ include::partial$misc/requires_5_7v.adoc[]
 
 | 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: link:{baseurl}/plugins/premium/tinymcespellchecker/#supportedlanguages[Spell Checker Pro - `Supported languages`].
+| Set the current language for spellchecking. This must be a supported language code (case-sensitive). For a list of supported languages, see: xref:plugins/premium/tinymcespellchecker.adoc#supportedlanguages[Spell Checker Pro - `Supported languages`].
 |===
 
 *Examples*
 
-```js
+[source, js]
+----
 // ignore words for all languages
 tinymce.activeEditor.plugins.tinymcespellchecker.addIgnoredWords(['tinymce']);
 
@@ -30,4 +31,4 @@ tinymce.activeEditor.plugins.tinymcespellchecker.getLanguage();
 
 // set the current language to a specific language
 tinymce.activeEditor.plugins.tinymcespellchecker.setLanguage('sv');  // e.g. Swedish
-```
+----
diff --git a/modules/ROOT/partials/plugins/tinymcespellchecker-content-langs.adoc b/modules/ROOT/partials/plugins/tinymcespellchecker-content-langs.adoc
@@ -1,7 +1,8 @@
 [[content_langs]]
 === `content_langs`
 
-include::partial$misc/requires_5_9v.adoc[] The `content_langs` option replaces the `spellchecker_select_languages` option. The value of the `spellchecker_select_languages` option, or its default, are used as a fallback for `content_langs`.
+include::partial$misc/requires_5_9v.adoc[]
+The `content_langs` option replaces the `spellchecker_select_languages` option. The value of the `spellchecker_select_languages` option, or its default, are used as a fallback for `content_langs`.
 
 include::partial$configuration/content_langs_base.adoc[]
 
@@ -12,8 +13,8 @@ include::partial$configuration/content_langs_base.adoc[]
 The Spell Checker Pro plugin will use the `code` property to determine which dictionary to use on the content, unless the `customCode` property is available. The language tag specified by `customCode` overrides the spelling dictionary, to allow for non-standard languages such as the medical dictionaries provided with Spell Checker Pro. For all languages, ensure that:
 
 * The `code` property is valid language tag, according to https://www.ietf.org/rfc/bcp/bcp47.txt[Tags for Identifying Languages (BCP47)]
-* Either the `code` property is one of the <<supportedlanguages,Supported Languages>> or the `customCode` override property is defined.
-* The `customCode` property is one of the <<supportedlanguages,Supported Languages>> if it is defined.
+* Either the `code` property is one of the xref:plugins/premium/tinymcespellchecker.adoc#supportedlanguages[Supported Languages] or the `customCode` override property is defined.
+* The `customCode` property is one of the xref:plugins/premium/tinymcespellchecker.adoc#supportedlanguages[Supported Languages] if it is defined.
 
 For example:
 
diff --git a/modules/ROOT/partials/toolbar-button-ids/tinymcespellchecker-toolbar-buttons.adoc b/modules/ROOT/partials/toolbar-button-ids/tinymcespellchecker-toolbar-buttons.adoc
@@ -1,3 +1,4 @@
+[[toolbarbuttons]]
 |===
 | Toolbar button identifier | Description
 

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@ include::partial$misc/premiumplugin.adoc[]`
`10`	`10`
`11`	`11`	`include::partial$rtc/rtc-description.adoc[]`
`12`	`12`
`13`		`-For information on the Real-time Collaboration plugin, see link:{baseurl}/rtc/[Real-time Collaboration (RTC)].`
	`13`	`+For information on the Real-time Collaboration plugin, see xref:rtc/index.adoc[Real-time Collaboration (RTC)].`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+[[spellchecker_active]]`
`1`	`2`	=== `spellchecker_active`
`2`	`3`
`3`	`4`	This option enables or disables the spell checker when the editor is loaded. When set to `false`, the spellchecker will not be active when the editor is initialized. The toolbar button or the menu item will have to be selected by the user to start the spell checker.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+[[spellchecker_language]]`
`1`	`2`	=== `spellchecker_language`
`2`	`3`
`3`	`4`	`This option specifies the default language used by Spell Checker Pro.`