DOC-2324: update playbook

Author: MitchC1999

antora-playbook.yml

@@ -1,16 +1,17 @@
 site:
   title: TinyMCE Documentation
-  url: https://localhost:4000
+  url: https://www.tiny.cloud
   start_page: tinymce::index.adoc
 content:
   sources:
   - url: ./
-    branches: HEAD
+    branches: [ HEAD ]
     start_path: ./
   - url: https://github.com/MitchC1999/tinymce-docs.git
     branches: [ 5, 7 ]
 urls:
   html_extension_style: indexify
+  latest_version_segment: latest
 ui:
   bundle:
     url: https://tiny-cloud-docs-antora-themes-staging.s3.amazonaws.com/ui-bundle.zip

modules/ROOT/pages/apis/tinymce.dom.domutils.adoc

@@ -48,6 +48,8 @@ available. If it's not, it will fall back to the custom TinyMCE implementation.|
 |xref:#encode[encode()]|Entity encodes a string. This method encodes the most common entities, such as `<`, `>`, `"` and `&`.|`xref:apis/tinymce.dom.domutils.adoc[DOMUtils]`
 |xref:#findCommonAncestor[findCommonAncestor()]|Find the common ancestor of two elements. This is a shorter method than using the DOM Range logic.|`xref:apis/tinymce.dom.domutils.adoc[DOMUtils]`
 |xref:#fire[fire()]|Fires the specified event name and optional object on the specified target.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__|`xref:apis/tinymce.dom.domutils.adoc[DOMUtils]`
 |xref:#get[get()]|Returns the specified element by ID or the input element if it isn't a string.|`xref:apis/tinymce.dom.domutils.adoc[DOMUtils]`
 |xref:#getAttrib[getAttrib()]|Returns the specified attribute by name.|`xref:apis/tinymce.dom.domutils.adoc[DOMUtils]`
@@ -396,6 +398,8 @@ Find the common ancestor of two elements. This is a shorter method than using th
 fire(target: Node | Document | Window, name: String, evt: Object): Event
 ----
 Fires the specified event name and optional object on the specified target.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__
 
 ==== Parameters

modules/ROOT/pages/apis/tinymce.dom.eventutils.adoc

@@ -19,6 +19,8 @@ This class wraps the browsers native event logic with more convenient methods.
 listeners to child nodes within that target.|`xref:apis/tinymce.dom.eventutils.adoc[EventUtils]`
 |xref:#dispatch[dispatch()]|Dispatches the specified event on the specified target.|`xref:apis/tinymce.dom.eventutils.adoc[EventUtils]`
 |xref:#fire[fire()]|Fires the specified event on the specified target.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__|`xref:apis/tinymce.dom.eventutils.adoc[EventUtils]`
 |xref:#unbind[unbind()]|Unbinds the specified event by name, name and callback or all events on the target.|`xref:apis/tinymce.dom.eventutils.adoc[EventUtils]`
 |===
@@ -93,6 +95,8 @@ Dispatches the specified event on the specified target.
 fire(target: Object, name: String, args: Object): EventUtils
 ----
 Fires the specified event on the specified target.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__
 
 ==== Parameters

modules/ROOT/pages/apis/tinymce.editor.adoc

@@ -88,6 +88,8 @@ link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more det
 the tinymce command identifiers documentation.|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#fire[fire()]|Fires the specified event by name. Consult the
 link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__|`xref:apis/tinymce.util.observable.adoc[Observable]`
 |xref:#focus[focus()]|Focuses/activates the editor. This will set this editor as the activeEditor in the tinymce collection
 it will also place DOM focus inside the editor.|`xref:apis/tinymce.editor.adoc[Editor]`
@@ -102,6 +104,8 @@ holds the iframe or the editable element.|`xref:apis/tinymce.editor.adoc[Editor]
 |xref:#getDoc[getDoc()]|Returns the iframes document object.|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#getElement[getElement()]|Returns the target element/textarea that got replaced with a TinyMCE editor instance.|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#getParam[getParam()]|Returns a configuration parameter by name.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use the `editor.options.get` API instead.__|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#getWin[getWin()]|Returns the iframes window object.|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#hasEditableRoot[hasEditableRoot()]|Returns the current editable state of the editor's root element.|`xref:apis/tinymce.editor.adoc[Editor]`
@@ -138,6 +142,8 @@ This method will move the HTML contents from the editor into that textarea or di
 so all events etc that method has will get dispatched as well.|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#setContent[setContent()]|Sets the specified content to the editor instance, this will cleanup the content before it gets set using
 the different cleanup rules options.
+
+
 __Note: The content return value was deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0.__|`xref:apis/tinymce.editor.adoc[Editor]`
 |xref:#setDirty[setDirty()]|Explicitly sets the dirty state. This will fire the dirty event if the editor dirty state is changed from false to true
 by invoking this method.|`xref:apis/tinymce.editor.adoc[Editor]`
@@ -386,6 +392,8 @@ fire(name: String, args: Object?, bubble: Boolean?): Object
 ----
 Fires the specified event by name. Consult the
 link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__
 
 ==== Examples
@@ -533,6 +541,8 @@ Returns the target element/textarea that got replaced with a TinyMCE editor inst
 getParam(name: String, defaultVal: String, type: String): String
 ----
 Returns a configuration parameter by name.
+
+
 __Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use the `editor.options.get` API instead.__
 
 ==== Examples
@@ -943,6 +953,8 @@ setContent(content: String, args: Object): String
 ----
 Sets the specified content to the editor instance, this will cleanup the content before it gets set using
 the different cleanup rules options.
+
+
 __Note: The content return value was deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0.__
 
 ==== Examples

modules/ROOT/pages/apis/tinymce.editor.ui.registry.adoc

@@ -17,11 +17,15 @@ TinyMCE UI registration API.
 |xref:#addAutocompleter[addAutocompleter()]|Registers a new auto completer component. When a configured string pattern
 is matched in the content while typing, the autocompleter will be triggered.
 Emoticons and Charmap use an autocompleter.
+
+
 For information on creating an autocompleter, see:
 link:https://www.tiny.cloud/docs/tinymce/6/autocompleter/[
 UI Components - Autocompleter].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addButton[addButton()]|Registers a new toolbar button that executes a command when clicked or activated
 via keyboard navigation controls.
+
+
 For information on creating a basic toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-basic-toolbar-button/[
 UI Components - Types of toolbar buttons: Basic button].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
@@ -31,22 +35,32 @@ form element appearing when a content predicate is matched. An example
 of a contextual form is the link plugin when the configuration
 { link_context_toolbar: true } is used. When the cursor is on a link, a
 contextual input form appears allowing for quick changes to the url field.
+
+
 For information on creating context forms, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contextform/[
 UI Components - Context forms].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addContextMenu[addContextMenu()]|Registers a new context menu section that only appears when a content predicate is matched,
 for example, the cursor is inside a table.
+
+
 For information on creating context menus, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contextmenu/[
 UI Components - Context Menu].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addContextToolbar[addContextToolbar()]|Registers a new context toolbar that only appears when a content predicate is matched for example
 the cursor is on an image element.
+
+
 For information on creating context toolbars, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contexttoolbar/[
 UI Components - Context Toolbar].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addGroupToolbarButton[addGroupToolbarButton()]|Registers a new group toolbar button for the toolbar. Renders a toolbar button that opens a floating toolbar when
 clicked.
+
+
 **Note:** Group toolbar buttons can only be used when using the floating toolbar mode.
+
+
 For information on creating a group toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-group-toolbar-button/[
 UI Components - Types of toolbar buttons: Group toolbar button].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
@@ -56,17 +70,23 @@ to the editor instance it was configured for.|`xref:apis/tinymce.editor.ui.regis
 |xref:#addMenuButton[addMenuButton()]|Registers a new menu button. Adds a toolbar button that opens a menu when
 clicked. The menu can be populated by items created by addMenuItem,
 addNestedMenuItem or addToggleMenuItem.
+
+
 For information on creating a toolbar menu button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-menu-toolbar-button/[
 UI Components - Types of toolbar buttons: Menu button].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addMenuItem[addMenuItem()]|Registers a new menu item that executes a command when clicked or activated
 via keyboard navigation controls.
+
+
 For information on creating a basic menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/creating-custom-menu-items/[
 UI Components - Custom menu items: Basic menu items].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addNestedMenuItem[addNestedMenuItem()]|Registers a new menu item that reveals a submenu when clicked or activated
 by keyboard navigation controls.The submenu can be populated by items
 created by addMenuItem, addNestedMenuItem or addToggleMenuItem.
+
+
 For information on creating a nested menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-nested-menu-items/[
 UI Components - Custom menu items: Nested menu items].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
@@ -77,21 +97,29 @@ button with the same sidebar name is created. Additionally there is a
 ToggleSidebar command and a 'ToggleSidebar' event that can used to
 manage the sidebar open/closed state. The tinycomments plugin uses a
 sidebar for its Ui components.
+
+
 For information on creating a custom sidebar, see:
 link:https://www.tiny.cloud/docs/tinymce/6/customsidebar/[
 UI Components - Custom sidebar].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addSplitButton[addSplitButton()]|Registers a new split button for the toolbar. The advanced list plugin uses
 a split button to simplify its functionality.
+
+
 For information on creating a split toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-split-toolbar-button/[
 UI Components - Types of toolbar buttons: Split button].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addToggleButton[addToggleButton()]|Registers a new toggle button for the toolbar. A toggle buttons state can
 be set in the configuration.
+
+
 For information on creating a toggle toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-toggle-toolbar-button/[
 UI Components - Types of toolbar buttons: Toggle button].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
 |xref:#addToggleMenuItem[addToggleMenuItem()]|Registers a new menu item that will act like a toggle button,
 showing a tick in the menu item to represent state.
+
+
 For information on creating a toggle menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-toggle-menu-items/[
 UI Components - Custom menu items: Toggle menu items].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
@@ -117,6 +145,8 @@ addAutocompleter(name: String, obj: InlineContent.AutocompleterSpec)
 Registers a new auto completer component. When a configured string pattern
 is matched in the content while typing, the autocompleter will be triggered.
 Emoticons and Charmap use an autocompleter.
+
+
 For information on creating an autocompleter, see:
 link:https://www.tiny.cloud/docs/tinymce/6/autocompleter/[
 UI Components - Autocompleter].
@@ -136,6 +166,8 @@ addButton(name: String, obj: Toolbar.ToolbarButtonSpec)
 ----
 Registers a new toolbar button that executes a command when clicked or activated
 via keyboard navigation controls.
+
+
 For information on creating a basic toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-basic-toolbar-button/[
 UI Components - Types of toolbar buttons: Basic button].
@@ -159,6 +191,8 @@ form element appearing when a content predicate is matched. An example
 of a contextual form is the link plugin when the configuration
 { link_context_toolbar: true } is used. When the cursor is on a link, a
 contextual input form appears allowing for quick changes to the url field.
+
+
 For information on creating context forms, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contextform/[
 UI Components - Context forms].
@@ -178,6 +212,8 @@ addContextMenu(name: String, obj: Menu.ContextMenuSpec)
 ----
 Registers a new context menu section that only appears when a content predicate is matched,
 for example, the cursor is inside a table.
+
+
 For information on creating context menus, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contextmenu/[
 UI Components - Context Menu].
@@ -197,6 +233,8 @@ addContextToolbar(name: String, obj: Toolbar.ContextToolbarSpec)
 ----
 Registers a new context toolbar that only appears when a content predicate is matched for example
 the cursor is on an image element.
+
+
 For information on creating context toolbars, see:
 link:https://www.tiny.cloud/docs/tinymce/6/contexttoolbar/[
 UI Components - Context Toolbar].
@@ -216,7 +254,11 @@ addGroupToolbarButton(name: String, obj: Toolbar.GroupToolbarButtonSpec)
 ----
 Registers a new group toolbar button for the toolbar. Renders a toolbar button that opens a floating toolbar when
 clicked.
+
+
 **Note:** Group toolbar buttons can only be used when using the floating toolbar mode.
+
+
 For information on creating a group toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-group-toolbar-button/[
 UI Components - Types of toolbar buttons: Group toolbar button].
@@ -261,6 +303,8 @@ addMenuButton(name: String, obj: Toolbar.ToolbarMenuButtonSpec)
 Registers a new menu button. Adds a toolbar button that opens a menu when
 clicked. The menu can be populated by items created by addMenuItem,
 addNestedMenuItem or addToggleMenuItem.
+
+
 For information on creating a toolbar menu button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-menu-toolbar-button/[
 UI Components - Types of toolbar buttons: Menu button].
@@ -280,6 +324,8 @@ addMenuItem(name: String, obj: Menu.MenuItemSpec)
 ----
 Registers a new menu item that executes a command when clicked or activated
 via keyboard navigation controls.
+
+
 For information on creating a basic menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/creating-custom-menu-items/[
 UI Components - Custom menu items: Basic menu items].
@@ -300,6 +346,8 @@ addNestedMenuItem(name: String, obj: Menu.NestedMenuItemSpec)
 Registers a new menu item that reveals a submenu when clicked or activated
 by keyboard navigation controls.The submenu can be populated by items
 created by addMenuItem, addNestedMenuItem or addToggleMenuItem.
+
+
 For information on creating a nested menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-nested-menu-items/[
 UI Components - Custom menu items: Nested menu items].
@@ -324,6 +372,8 @@ button with the same sidebar name is created. Additionally there is a
 ToggleSidebar command and a 'ToggleSidebar' event that can used to
 manage the sidebar open/closed state. The tinycomments plugin uses a
 sidebar for its Ui components.
+
+
 For information on creating a custom sidebar, see:
 link:https://www.tiny.cloud/docs/tinymce/6/customsidebar/[
 UI Components - Custom sidebar].
@@ -343,6 +393,8 @@ addSplitButton(name: String, obj: Toolbar.ToolbarSplitButtonSpec)
 ----
 Registers a new split button for the toolbar. The advanced list plugin uses
 a split button to simplify its functionality.
+
+
 For information on creating a split toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-split-toolbar-button/[
 UI Components - Types of toolbar buttons: Split button].
@@ -362,6 +414,8 @@ addToggleButton(name: String, obj: Toolbar.ToolbarToggleButtonSpec)
 ----
 Registers a new toggle button for the toolbar. A toggle buttons state can
 be set in the configuration.
+
+
 For information on creating a toggle toolbar button, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-toggle-toolbar-button/[
 UI Components - Types of toolbar buttons: Toggle button].
@@ -381,6 +435,8 @@ addToggleMenuItem(name: String, obj: Menu.ToggleMenuItemSpec)
 ----
 Registers a new menu item that will act like a toggle button,
 showing a tick in the menu item to represent state.
+
+
 For information on creating a toggle menu item, see:
 link:https://www.tiny.cloud/docs/tinymce/6/custom-toggle-menu-items/[
 UI Components - Custom menu items: Toggle menu items].

modules/ROOT/pages/apis/tinymce.editor.ui.ui.adoc

@@ -25,6 +25,8 @@ This editor ui instance.
 |Name|Summary|Defined by
 |xref:#tinymce.editor.ui.hide[tinymce.editor.ui.hide()]|Hides the editor user interface for inline editors. This method affects all user
 interface elements, including: menu bar, toolbar, notifications, and dialogs.
+
+
 If the `toolbar_persist` option is set to `true` and this method is used,
 the user interface will remain hidden, regardless of focus.|`xref:apis/tinymce.editor.ui.ui.adoc[Ui]`
 |xref:#tinymce.editor.ui.isEnabled[tinymce.editor.ui.isEnabled()]|Determines if the editor user interface is `enabled` (`true`) or `disabled` (`false`).|`xref:apis/tinymce.editor.ui.ui.adoc[Ui]`
@@ -33,6 +35,8 @@ This method affects all user interface elements, including: menu bar,
 toolbar, notifications, and dialogs. Can not be set to 'true' when in readonly mode.|`xref:apis/tinymce.editor.ui.ui.adoc[Ui]`
 |xref:#tinymce.editor.ui.show[tinymce.editor.ui.show()]|Reveals the editor user interface for inline editors. This method affects all user
 interface elements, including: menu bar, toolbar, notifications, and dialogs.
+
+
 If the `toolbar_persist` option is set to `true` and this method is used,
 the user interface will remain visible, regardless of focus.|`xref:apis/tinymce.editor.ui.ui.adoc[Ui]`
 |===
@@ -48,6 +52,8 @@ tinymce.editor.ui.hide()
 ----
 Hides the editor user interface for inline editors. This method affects all user
 interface elements, including: menu bar, toolbar, notifications, and dialogs.
+
+
 If the `toolbar_persist` option is set to `true` and this method is used,
 the user interface will remain hidden, regardless of focus.
 
@@ -91,6 +97,8 @@ tinymce.editor.ui.show()
 ----
 Reveals the editor user interface for inline editors. This method affects all user
 interface elements, including: menu bar, toolbar, notifications, and dialogs.
+
+
 If the `toolbar_persist` option is set to `true` and this method is used,
 the user interface will remain visible, regardless of focus.