This is inside+` diff --git a/modules/ROOT/partials/configuration/dialog_streamContent.adoc b/modules/ROOT/partials/configuration/dialog_streamContent.adoc index 623d130a97..1fdf29ece9 100644 --- a/modules/ROOT/partials/configuration/dialog_streamContent.adoc +++ b/modules/ROOT/partials/configuration/dialog_streamContent.adoc @@ -67,7 +67,7 @@ The recommended method for updating content in an `+iframe+` component is: onAction: (api) => api.setData({ myiframe: 'new content' }) ---- -. This updates the iframe to contain the string `'new content'`. This text can be any valid html. +. This updates the iframe to contain the string `'new content'`. This text can be any valid HTML. . `onAction` is a callback defined in the dialog spec. It is called when a button within the dialog `body` is triggered. diff --git a/modules/ROOT/partials/configuration/exportword_converter_options.adoc b/modules/ROOT/partials/configuration/exportword_converter_options.adoc index 9ca4223cad..35772ff021 100644 --- a/modules/ROOT/partials/configuration/exportword_converter_options.adoc +++ b/modules/ROOT/partials/configuration/exportword_converter_options.adoc @@ -11,7 +11,7 @@ As of {productname} 7.5.0, the default value of the `exportword_converter_option .**Default value:** [source,js] ---- -exportword_converter_options: { +{ document: { size: 'letter' } diff --git a/modules/ROOT/partials/configuration/file_picker_callback.adoc b/modules/ROOT/partials/configuration/file_picker_callback.adoc index fa1dcd7d4e..7ffb68509e 100644 --- a/modules/ROOT/partials/configuration/file_picker_callback.adoc +++ b/modules/ROOT/partials/configuration/file_picker_callback.adoc @@ -11,6 +11,8 @@ It should be noted, that we only provide a hook. It is up to you to implement sp *Type:* `+Function+` +*Default value:* `+undefined+` + NOTE: The following example demonstrates how you can use `+file_picker_callback+` API, but doesn't pick any real files. Check the xref:interactive-example[Interactive example] for a more functional example. === Example: using `+file_picker_callback+` diff --git a/modules/ROOT/partials/configuration/filetypes.adoc b/modules/ROOT/partials/configuration/filetypes.adoc index 6a9407171b..e559f866a8 100644 --- a/modules/ROOT/partials/configuration/filetypes.adoc +++ b/modules/ROOT/partials/configuration/filetypes.adoc @@ -7,7 +7,7 @@ include::partial$plugins/tinydrive-filetypeslist.adoc[] For example: If the application is using {cloudfilemanager} to insert images, then set `+['image']+` in the file types array. -*Type:* `+Array+` +*Type:* `+Array+` of `+Strings+` === Interactive example: Using `+filetypes+` to restrict {cloudfilemanager} to image formats diff --git a/modules/ROOT/partials/configuration/fix_list_elements.adoc b/modules/ROOT/partials/configuration/fix_list_elements.adoc index 39f5d35d60..3c628a8049 100644 --- a/modules/ROOT/partials/configuration/fix_list_elements.adoc +++ b/modules/ROOT/partials/configuration/fix_list_elements.adoc @@ -12,8 +12,8 @@ This invalid list:
a pre tag.
something
+`. This option cannot be disabled. -To avoid block elements in content, use the xref:content-behavior-options.adoc#newline_behavior[newline_behavior] setting to change what happens when enter is pressed. +To avoid block elements in content, use the xref:content-behavior-options.adoc#newline_behavior[newline_behavior] setting to change what happens when kbd:[Enter] is pressed. WARNING: Not using `+p+` elements as the root block will impair the functionality of the editor. diff --git a/modules/ROOT/partials/configuration/forced_root_block_attrs.adoc b/modules/ROOT/partials/configuration/forced_root_block_attrs.adoc index 8648e19fe3..0f6c86bc40 100644 --- a/modules/ROOT/partials/configuration/forced_root_block_attrs.adoc +++ b/modules/ROOT/partials/configuration/forced_root_block_attrs.adoc @@ -5,6 +5,8 @@ This option enables you specify attributes for the xref:content-filtering.adoc#f *Type:* `+Object+` +*Default value:* `+{}+` + === Example: using `+forced_root_block_attrs+` [source,js] diff --git a/modules/ROOT/partials/configuration/format_empty_lines.adoc b/modules/ROOT/partials/configuration/format_empty_lines.adoc index ec32cae790..a2af32a04b 100644 --- a/modules/ROOT/partials/configuration/format_empty_lines.adoc +++ b/modules/ROOT/partials/configuration/format_empty_lines.adoc @@ -5,6 +5,8 @@ This option allows "inline" formats to be applied to empty lines for multi-line *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+format_empty_lines+` diff --git a/modules/ROOT/partials/configuration/formats.adoc b/modules/ROOT/partials/configuration/formats.adoc index c351dedf96..230e89f7c1 100644 --- a/modules/ROOT/partials/configuration/formats.adoc +++ b/modules/ROOT/partials/configuration/formats.adoc @@ -233,6 +233,8 @@ Makes sure that the format is not merged with other wrappers having the same for *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` ===== Example: using `+exact+` parameter @@ -256,6 +258,8 @@ States that the format is a container format for block elements. For example, a *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` ===== Example: using `+wrapper+` @@ -313,7 +317,7 @@ tinymce.init({ This option controls if the selection should expand upwards to the closest matching block element. This can be useful when configuring `+removeformat+` to remove block elements. So if the selection start is at the beginning of a matching block, then that matching block will be included as well. If the end of the selection is at the end of a matching block element then that parent element will be included as well. -So if the selection is from _a_ to _b_ in this html contents `+b]
+` then the _h1_ will be removed even if it's not part of the actual selection. +So if the selection is from _a_ to _b_ in the HTML contents `+b]
+` then the _h1_ will be removed even if it's not part of the actual selection. *Type:* `+Boolean+` @@ -354,6 +358,8 @@ Enables control for removing the child elements of the matching format. This is *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` for `+selector+` formats ===== Example: using `+deep+` @@ -392,6 +398,8 @@ After merge: *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+true+` ===== Example: using `+merge_siblings+` diff --git a/modules/ROOT/partials/configuration/fullscreen_native.adoc b/modules/ROOT/partials/configuration/fullscreen_native.adoc index 25b02fe3ee..ad37926427 100644 --- a/modules/ROOT/partials/configuration/fullscreen_native.adoc +++ b/modules/ROOT/partials/configuration/fullscreen_native.adoc @@ -31,6 +31,6 @@ tinymce.init({ The `+fullscreen_native+` option has the following limitations. When `+fullscreen_native+` is enabled: -* The Escape keyboard key (Esc) will exit full screen mode. Default editor behavior of the Esc key will be overridden by browser and the Esc key will exit full screen mode instead of closing dialogs, menus, or moving focus from the editor UI to the editor content. This may lead to accessibility issues. -* For Firefox users, the full screen keyboard shortcut (Command+Shift+F or Ctrl+Shift+F) cannot be used to repeatedly toggle the browser-native full screen mode on and off without interacting with the editor between on toggles. If the user does not interact with the editor between off and on toggles, the plugin will fall-back to filling the browser window. +* The kbd:[Esc] key will exit full screen mode. Default editor behavior of the kbd:[Esc] key will be overridden by browser and the kbd:[Esc] key will exit full screen mode instead of closing dialogs, menus, or moving focus from the editor UI to the editor content. This may lead to accessibility issues. +* For Firefox users, the full screen keyboard shortcut (kbd:[Command+Shift+F] or kbd:[Ctrl+Shift+F]) cannot be used to repeatedly toggle the browser-native full screen mode on and off without interacting with the editor between on toggles. If the user does not interact with the editor between off and on toggles, the plugin will fall-back to filling the browser window. * If the editor is initialized inside an iframe element, full screen mode will only fill the iframe on Firefox. diff --git a/modules/ROOT/partials/configuration/highlight_on_focus.adoc b/modules/ROOT/partials/configuration/highlight_on_focus.adoc index 632f907aea..70e139fa1c 100644 --- a/modules/ROOT/partials/configuration/highlight_on_focus.adoc +++ b/modules/ROOT/partials/configuration/highlight_on_focus.adoc @@ -28,7 +28,7 @@ tinymce.init({ === Using `+highlight_on_focus+` with custom skins -If a xref:creating-a-skin.adoc[custom skin] is being used, two variables can be updated to match the `+highlight_on_focus+` option’s appearance with the custom skin. +If a xref:creating-a-skin.adoc[custom skin] is being used, two variables can be updated to match the `+highlight_on_focus+` option's appearance with the custom skin. The two rules and their default values are: diff --git a/modules/ROOT/partials/configuration/icons.adoc b/modules/ROOT/partials/configuration/icons.adoc index be53a1e76b..7cc7e82ecf 100644 --- a/modules/ROOT/partials/configuration/icons.adoc +++ b/modules/ROOT/partials/configuration/icons.adoc @@ -6,6 +6,8 @@ ifeval::[{customIconPack} != true] The *icons* option allows the editor icons to be extended or replaced using an icon pack. For information on creating icon packs, see: xref:creating-an-icon-pack.adoc[Create an icon pack for {productname}]. *Type:* `+String+` + +*Default value:* `+''+` endif::[] On initialization, {productname} will try to load any icon pack specified by the *icons* option. The icons in the icon pack will be merged with xref:editor-icon-identifiers.adoc[{productname}'s default icons] and icons in the icon pack will overwrite the default icons with the same identifier. diff --git a/modules/ROOT/partials/configuration/icons_url.adoc b/modules/ROOT/partials/configuration/icons_url.adoc index 10d4c6003e..af091b520a 100644 --- a/modules/ROOT/partials/configuration/icons_url.adoc +++ b/modules/ROOT/partials/configuration/icons_url.adoc @@ -25,6 +25,8 @@ endif::[] ifeval::[{customIconPack} != true] *Type:* `+String+` +*Default value:* `+''+` + === Example: using `+icons_url+` [source,js] diff --git a/modules/ROOT/partials/configuration/iframe_template_callback.adoc b/modules/ROOT/partials/configuration/iframe_template_callback.adoc index 509cf25f2c..8eaf237b4f 100644 --- a/modules/ROOT/partials/configuration/iframe_template_callback.adoc +++ b/modules/ROOT/partials/configuration/iframe_template_callback.adoc @@ -7,6 +7,8 @@ This option allows you to specify the function that will return the HTML embed c *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+iframe_template_callback+` [source,js] diff --git a/modules/ROOT/partials/configuration/image_class_list.adoc b/modules/ROOT/partials/configuration/image_class_list.adoc index d024736586..b2f490e237 100644 --- a/modules/ROOT/partials/configuration/image_class_list.adoc +++ b/modules/ROOT/partials/configuration/image_class_list.adoc @@ -5,6 +5,8 @@ This option lets you specify a predefined list of classes to add to an image. It *Type:* `+Array+` +*Default value:* `+undefined+` + === Example: using `+image_class_list+` [source,js] diff --git a/modules/ROOT/partials/configuration/image_list.adoc b/modules/ROOT/partials/configuration/image_list.adoc index c71b4c71ee..9b708f57c2 100644 --- a/modules/ROOT/partials/configuration/image_list.adoc +++ b/modules/ROOT/partials/configuration/image_list.adoc @@ -3,7 +3,7 @@ This option lets you specify a predefined list of sources for images. `+image_list+` takes the form of an array containing items to add to a list with a corresponding image. Each item has a `+title+` and a `+value+`. -*Type:* `+false+`, `+String+`, `+Function+` or `+Array+` +*Type:* `+false+`, `+String+`, `+Function+`, or `+Array+` of `+Objects+` *Default value:* `+false+` diff --git a/modules/ROOT/partials/configuration/image_proxy.adoc b/modules/ROOT/partials/configuration/image_proxy.adoc index 2b66a3cacd..8c938756e5 100644 --- a/modules/ROOT/partials/configuration/image_proxy.adoc +++ b/modules/ROOT/partials/configuration/image_proxy.adoc @@ -17,6 +17,8 @@ NOTE: `{proxy_setting_name}` is *not* required when enabling this plugin via xre *Type:* `+String+` +*Default value:* `+undefined+` + === Example: using `{proxy_setting_name}` [source,js,subs="attributes+"] diff --git a/modules/ROOT/partials/configuration/image_toolbar.adoc b/modules/ROOT/partials/configuration/image_toolbar.adoc index 06323131b8..f5bb5ff989 100644 --- a/modules/ROOT/partials/configuration/image_toolbar.adoc +++ b/modules/ROOT/partials/configuration/image_toolbar.adoc @@ -3,9 +3,7 @@ The *quickbars_image_toolbar* option configures the Quick Image toolbar provided by the xref:quickbars.adoc[quickbars plugin]. To change the buttons on the Quick Image toolbar, provide a space-separated string of xref:available-toolbar-buttons.adoc[toolbar button names]. The Quick Image toolbar is intended for image-related buttons, but any xref:available-toolbar-buttons.adoc[{productname} toolbar buttons] or xref:custom-toolbarbuttons.adoc[custom toolbar buttons] are allowed. -To disable the Quick Image toolbar, set `+quickbars_image_toolbar+` to `+false+`. - -*Type:* `+String+` or `+false+` +*Type:* `+String+` or `+Boolean+` *Default value:* `+'alignleft aligncenter alignright'+` diff --git a/modules/ROOT/partials/configuration/images_file_types.adoc b/modules/ROOT/partials/configuration/images_file_types.adoc index 7c42095c90..9ff346a2fd 100644 --- a/modules/ROOT/partials/configuration/images_file_types.adoc +++ b/modules/ROOT/partials/configuration/images_file_types.adoc @@ -8,10 +8,10 @@ This option configures which image file formats are accepted by the editor. Chan *Type:* `+String+` -*Default value:* `+'jpeg,jpg,jpe,jfi,jif,jfif,png,gif,bmp,webp'+` - *Possible values:* A list of valid web image file extensions. For a list of possible values see: https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types[MDN Web Docs - Image file type and format guide]. +*Default value:* `+'jpeg,jpg,jpe,jfi,jif,jfif,png,gif,bmp,webp'+` + === Example: using `+images_file_types+` [source,js] diff --git a/modules/ROOT/partials/configuration/images_upload_base_path.adoc b/modules/ROOT/partials/configuration/images_upload_base_path.adoc index df2e0a2312..2bdf231306 100644 --- a/modules/ROOT/partials/configuration/images_upload_base_path.adoc +++ b/modules/ROOT/partials/configuration/images_upload_base_path.adoc @@ -5,6 +5,8 @@ This option lets you specify a `+basepath+` to prepend to URLs returned from the *Type:* `+String+` +*Default value:* `+''+` + === Example: using `+images_upload_base_path+` [source,js] diff --git a/modules/ROOT/partials/configuration/images_upload_handler.adoc b/modules/ROOT/partials/configuration/images_upload_handler.adoc index 25ed503cc4..3cf2e718ab 100644 --- a/modules/ROOT/partials/configuration/images_upload_handler.adoc +++ b/modules/ROOT/partials/configuration/images_upload_handler.adoc @@ -17,6 +17,8 @@ When this option is not set, {productname} utilizes an `+XMLHttpRequest+` to upl *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+images_upload_handler+` [source,js] diff --git a/modules/ROOT/partials/configuration/importcss_append.adoc b/modules/ROOT/partials/configuration/importcss_append.adoc index d7630aa1d8..73880008f1 100644 --- a/modules/ROOT/partials/configuration/importcss_append.adoc +++ b/modules/ROOT/partials/configuration/importcss_append.adoc @@ -5,6 +5,8 @@ If set to `+true+` this option will append the imported styles to the end of the *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+importcss_append+` diff --git a/modules/ROOT/partials/configuration/importcss_exclusive.adoc b/modules/ROOT/partials/configuration/importcss_exclusive.adoc index 461cc1c219..f24c5b1445 100644 --- a/modules/ROOT/partials/configuration/importcss_exclusive.adoc +++ b/modules/ROOT/partials/configuration/importcss_exclusive.adoc @@ -5,6 +5,8 @@ If set to `+false+` then selectors will not be globally exclusive meaning they c *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+true+` === Example: using `+importcss_exclusive+` diff --git a/modules/ROOT/partials/configuration/importcss_file_filter.adoc b/modules/ROOT/partials/configuration/importcss_file_filter.adoc index 8f20b42d29..39e27d214c 100644 --- a/modules/ROOT/partials/configuration/importcss_file_filter.adoc +++ b/modules/ROOT/partials/configuration/importcss_file_filter.adoc @@ -5,6 +5,8 @@ This option enables you to add the CSS files that should be used for populating *Type:* `+String+`, `+RegExp+` or `+Function+` +*Default value:* `+undefined+` + === Example: using `+importcss_file_filter+` [source,js] diff --git a/modules/ROOT/partials/configuration/importcss_groups.adoc b/modules/ROOT/partials/configuration/importcss_groups.adoc index 5cbf7fa073..138839ed38 100644 --- a/modules/ROOT/partials/configuration/importcss_groups.adoc +++ b/modules/ROOT/partials/configuration/importcss_groups.adoc @@ -3,7 +3,7 @@ This option enables group matching selectors into submenus in the `+Formats+` menu dropdown. You can use a `+String+`, `+RegExp+` or a `+Function+` to filter selectors. You can also omit the filter to get all non-matching ones into a specific group. You can also specify a group specific `+selector_converter+` so that formats for a specific group are produced by that converter. -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` === Example using a string filter with `+importcss_groups+` diff --git a/modules/ROOT/partials/configuration/importcss_merge_classes.adoc b/modules/ROOT/partials/configuration/importcss_merge_classes.adoc index 6d7c5533ec..dc0d82cecc 100644 --- a/modules/ROOT/partials/configuration/importcss_merge_classes.adoc +++ b/modules/ROOT/partials/configuration/importcss_merge_classes.adoc @@ -5,6 +5,8 @@ This option is used in cases where the class attribute should be replaced or mer *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+true+` === Example: using `+importcss_merge_classes+` diff --git a/modules/ROOT/partials/configuration/importcss_selector_converter.adoc b/modules/ROOT/partials/configuration/importcss_selector_converter.adoc index 8b3b35eeb0..2905468db9 100644 --- a/modules/ROOT/partials/configuration/importcss_selector_converter.adoc +++ b/modules/ROOT/partials/configuration/importcss_selector_converter.adoc @@ -5,6 +5,8 @@ This option allows you to override the default selector to format converter func *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+importcss_selector_converter+` [source,js] diff --git a/modules/ROOT/partials/configuration/importword_converter_options.adoc b/modules/ROOT/partials/configuration/importword_converter_options.adoc index 8fefb52339..88d10bda89 100644 --- a/modules/ROOT/partials/configuration/importword_converter_options.adoc +++ b/modules/ROOT/partials/configuration/importword_converter_options.adoc @@ -1,7 +1,7 @@ [[importword-converter-options]] == `importword_converter_options` -**Type:** `+String+` +**Type:** `+Object+` [NOTE] As of {productname} 7.5.0, the default value of the `importword_converter_options` setting has been updated to the following: @@ -9,7 +9,7 @@ As of {productname} 7.5.0, the default value of the `importword_converter_option .**Default value:** [source,js] ---- -importword_converter_options: { +{ formatting: { styles: 'inline', resets: 'inline', diff --git a/modules/ROOT/partials/configuration/importword_token_provider.adoc b/modules/ROOT/partials/configuration/importword_token_provider.adoc index cb4bff5dc4..1c18f7a27e 100644 --- a/modules/ROOT/partials/configuration/importword_token_provider.adoc +++ b/modules/ROOT/partials/configuration/importword_token_provider.adoc @@ -5,7 +5,7 @@ The `importword_token_provider` option enables integration with a token-based au *Type:* `+Function+` -*Default value:* `undefined` +*Default value:* `+undefined+` === Example: using `importword_token_provider` diff --git a/modules/ROOT/partials/configuration/indent.adoc b/modules/ROOT/partials/configuration/indent.adoc index c4b10b31ed..84c015f829 100644 --- a/modules/ROOT/partials/configuration/indent.adoc +++ b/modules/ROOT/partials/configuration/indent.adoc @@ -1,7 +1,7 @@ [[indent]] == `+indent+` -This option, which is on by default, adds a newline character — U+000A, `\n` — between closing and opening block elements when HTML is output using `xref:apis/tinymce.editor.adoc#getContent[getContent()]` and when HTML is rendered in the {productname} xref:preview.adoc[Preview] dialog. +This option, which is on by default, adds a newline character — U+000A, `\n` — between closing and opening block elements when HTML is output using `xref:apis/tinymce.editor.adoc#getContent[getContent()]` and when HTML is rendered in the {productname} xref:preview.adoc[Preview] dialog. Set `+indent+` to `+false+` to get HTML output from {productname} without having any newline characters added. diff --git a/modules/ROOT/partials/configuration/indent_use_margin.adoc b/modules/ROOT/partials/configuration/indent_use_margin.adoc index db7367c549..403d8d6745 100644 --- a/modules/ROOT/partials/configuration/indent_use_margin.adoc +++ b/modules/ROOT/partials/configuration/indent_use_margin.adoc @@ -5,6 +5,8 @@ This option is set if the editor should use margin instead of padding when inden *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+indent_use_margin+` diff --git a/modules/ROOT/partials/configuration/indentation.adoc b/modules/ROOT/partials/configuration/indentation.adoc index f5ba452169..46b8af59b0 100644 --- a/modules/ROOT/partials/configuration/indentation.adoc +++ b/modules/ROOT/partials/configuration/indentation.adoc @@ -3,8 +3,6 @@ This option allows specification of the indentation level for indent/outdent buttons in the UI. -The *indentation* option defaults to 30px but can be any value. - *Type:* `+String+` *Default value:* `+'40px'+` diff --git a/modules/ROOT/partials/configuration/init_content_sync.adoc b/modules/ROOT/partials/configuration/init_content_sync.adoc index 60fcaa45c2..024a1bbdc7 100644 --- a/modules/ROOT/partials/configuration/init_content_sync.adoc +++ b/modules/ROOT/partials/configuration/init_content_sync.adoc @@ -9,12 +9,14 @@ When disabled, the editor is initialized asynchronously using `srcdoc`. This can When enabled, the editor is initialized synchronously, using `document.write`. This can reduce flickering. -Flickering can still occur during synchronous initialization, however, such as when loading the content css. +Flickering can still occur during synchronous initialization, however, such as when loading the content CSS. NOTE: using the https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#document.write()[`document.write`] method is https://developer.mozilla.org/en-US/docs/Web/API/Document/write[strongly discouraged]. *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+init_content_sync+` diff --git a/modules/ROOT/partials/configuration/init_instance_callback.adoc b/modules/ROOT/partials/configuration/init_instance_callback.adoc index 916fe5962e..0224bdf56d 100644 --- a/modules/ROOT/partials/configuration/init_instance_callback.adoc +++ b/modules/ROOT/partials/configuration/init_instance_callback.adoc @@ -5,6 +5,8 @@ This option allows a function to be provided that will be executed each time an *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+init_instance_callback+` [source,js] diff --git a/modules/ROOT/partials/configuration/inline-css.adoc b/modules/ROOT/partials/configuration/inline-css.adoc index 326c21e790..cb87d19776 100644 --- a/modules/ROOT/partials/configuration/inline-css.adoc +++ b/modules/ROOT/partials/configuration/inline-css.adoc @@ -4,7 +4,9 @@ Determines whether it is valid for a given CSS selector to have its CSS properti *Default value:* All selectors are considered valid to have their CSS inlined. -*Type:* `+String+`, `RegExp` or `Function` +*Type:* `+String+`, `+RegExp+` or `+Function+` + +*Default value:* `+undefined+` [source,ts] ---- @@ -19,7 +21,9 @@ Determines whether it is valid for a given CSS stylesheet to have its CSS inspec *Default value:* All CSS stylesheet are considered valid to have their CSS inspected and inlined. -*Type:* `+String+`, `RegExp` or `Function` +*Type:* `+String+`, `+RegExp+` or `+Function+` + +*Default value:* `+undefined+` [source,ts] ---- diff --git a/modules/ROOT/partials/configuration/inline_boundaries_selector.adoc b/modules/ROOT/partials/configuration/inline_boundaries_selector.adoc index 70dd5b8622..f555d259cc 100644 --- a/modules/ROOT/partials/configuration/inline_boundaries_selector.adoc +++ b/modules/ROOT/partials/configuration/inline_boundaries_selector.adoc @@ -1,13 +1,13 @@ [[inline_boundaries_selector]] == `+inline_boundaries_selector+` -This option allows you specify what elements the inline boundaries should apply to. This defaults to `+a[href],code,.mce-annotation+` but can be extended to include other inline elements such as `+b+`, `+strong+`, `+i+`, and `+em+`. +This option allows you specify what elements the inline boundaries should apply to. This defaults to `+'a[href],code,span.mce-annotation'+` but can be extended to include other inline elements such as `+b+`, `+strong+`, `+i+`, and `+em+`. If you add new elements, you need to add CSS selectors for them in the content CSS. See the xref:editor-content-css.adoc[Boilerplate Content CSS page] for details. *Type:* `+String+` -*Default value:* `+'a[href],code,.mce-annotation'+` +*Default value:* `+'a[href],code,span.mce-annotation'+` === Example: using `+inline_boundaries_selector+` diff --git a/modules/ROOT/partials/configuration/insert_toolbar.adoc b/modules/ROOT/partials/configuration/insert_toolbar.adoc index 723f526c87..e9a1141758 100644 --- a/modules/ROOT/partials/configuration/insert_toolbar.adoc +++ b/modules/ROOT/partials/configuration/insert_toolbar.adoc @@ -3,9 +3,7 @@ The *quickbars_insert_toolbar* option configures the Quick Insert toolbar provided by the xref:quickbars.adoc[quickbars plugin]. To change the buttons on the Quick Insert toolbar, provide a space-separated string of xref:available-toolbar-buttons.adoc[toolbar button names]. The Quick Insert toolbar is intended for buttons related to inserting content, but any xref:available-toolbar-buttons.adoc[{productname} toolbar buttons] or xref:custom-toolbarbuttons.adoc[custom toolbar buttons] are allowed. -To disable the Quick Insert toolbar, set `+quickbars_insert_toolbar+` to `+false+`. - -*Type:* `+String+` +*Type:* `+String+` or `+Boolean+` *Default value:* `+'quickimage quicktable'+` diff --git a/modules/ROOT/partials/configuration/insertdatetime_formats.adoc b/modules/ROOT/partials/configuration/insertdatetime_formats.adoc index 8b9e12d880..af73b3b28d 100644 --- a/modules/ROOT/partials/configuration/insertdatetime_formats.adoc +++ b/modules/ROOT/partials/configuration/insertdatetime_formats.adoc @@ -3,7 +3,7 @@ Allows you to specify a list of date/time formats to be used in the date menu or date select box. A complete list of formats is available under xref:insertdatetime.adoc#referencedatetimeformats[date formats] below. -*Type:* `+Array+` +*Type:* `+Array+` of `+Strings+` *Default value:* `+[ '%H:%M:%S', '%Y-%m-%d', '%I:%M:%S %p', '%D' ]+` diff --git a/modules/ROOT/partials/configuration/invalid_elements.adoc b/modules/ROOT/partials/configuration/invalid_elements.adoc index 5b6e76a587..5cf758098a 100644 --- a/modules/ROOT/partials/configuration/invalid_elements.adoc +++ b/modules/ROOT/partials/configuration/invalid_elements.adoc @@ -5,6 +5,8 @@ This option instructs the editor to remove specific elements when {productname} *Type:* `+String+` +*Default value:* `+undefined+` + === Example: using `+invalid_elements+` [source,js] diff --git a/modules/ROOT/partials/configuration/invalid_styles.adoc b/modules/ROOT/partials/configuration/invalid_styles.adoc index a5f8cb8b9b..54268a1473 100644 --- a/modules/ROOT/partials/configuration/invalid_styles.adoc +++ b/modules/ROOT/partials/configuration/invalid_styles.adoc @@ -6,11 +6,11 @@ This option enables you to restrict the styles that are valid for specific eleme * *String format* - This is a list of global styles to disallow. * *Object format* - This is a more complex format in which you can specify invalid styles for individual elements. -=== Simple global classes - *Type:* `+String+`, `+Object+` -==== Example: using `+invalid_styles+` string +*Default value:* `+undefined+` + +=== Example: using `+invalid_styles+` string for global classes [source,js] ---- @@ -20,11 +20,7 @@ tinymce.init({ }); ---- -=== Element specific classes - -*Type:* `+String+`, `+Object+` - -==== Example: using `+invalid_styles+` object +=== Example: using `+invalid_styles+` object for element specific classes [source,js] ---- diff --git a/modules/ROOT/partials/configuration/keep_styles.adoc b/modules/ROOT/partials/configuration/keep_styles.adoc index a809f72b35..b26331fecf 100644 --- a/modules/ROOT/partials/configuration/keep_styles.adoc +++ b/modules/ROOT/partials/configuration/keep_styles.adoc @@ -1,7 +1,7 @@ [[keep_styles]] == `+keep_styles+` -The *keep_styles* option will keep the editor's current text style when a user presses `+enter/return+`. +The *keep_styles* option will keep the editor's current text style when a user presses kbd:[Enter] or kbd:[Return]. *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/language_load.adoc b/modules/ROOT/partials/configuration/language_load.adoc index 1f14e99e89..5af4e6d3ff 100644 --- a/modules/ROOT/partials/configuration/language_load.adoc +++ b/modules/ROOT/partials/configuration/language_load.adoc @@ -3,7 +3,9 @@ This option determines whether additional plugin or theme languages are loaded during {productname} editor initialization. By default, plugins which have support for languages other than English will automatically load the additional language packs. -*Type:* `+boolean+` +*Type:* `+Boolean+` + +*Possible values:* `+true+`, `+false+` *Default value:* `+true+` diff --git a/modules/ROOT/partials/configuration/language_url.adoc b/modules/ROOT/partials/configuration/language_url.adoc index 9a9fc28314..a5ca7d9763 100644 --- a/modules/ROOT/partials/configuration/language_url.adoc +++ b/modules/ROOT/partials/configuration/language_url.adoc @@ -3,12 +3,14 @@ When using the xref:ui-localization.adoc#language[`+language+`] option to set the user interface language you can place language pack(s) in a directory other than the default. If you do this, however, you must add the `language_url` option to your configuration and set this option to a path pointing to the language file(s) location. -We recommend the path URL be relative to the web application’s root. That is, begin with the absolute path reference character `+/+`. Avoid relying on application context for safe path resolution of language packs. +We recommend the path URL be relative to the web application's root. That is, begin with the absolute path reference character `+/+`. Avoid relying on application context for safe path resolution of language packs. -Also, the `+language+` option must also be set and must be set to the name of the language pack file being loaded. +The `+language+` option must be set to the same name as the language pack file being loaded. *Type:* `+String+` +*Default value:* `+''+` + === Example: using `+language_url+` @@ -16,7 +18,7 @@ Also, the `+language+` option must also be set and must be set to the name of th ---- tinymce.init({ selector: 'textarea', // change this value according to your HTML - language_url: '/path/to/language/pack/fi.js', // path from the root of your web application — / — to the language pack(s) + language_url: '/path/to/language/pack/fi.js', // path from the root of your web application — / — to the language pack(s) language: 'fi' // the name of the language pack file }); ---- diff --git a/modules/ROOT/partials/configuration/link_assume_external_targets.adoc b/modules/ROOT/partials/configuration/link_assume_external_targets.adoc index 7a7774bbd5..4fefd5d39d 100644 --- a/modules/ROOT/partials/configuration/link_assume_external_targets.adoc +++ b/modules/ROOT/partials/configuration/link_assume_external_targets.adoc @@ -10,9 +10,9 @@ Set whether {productname} should prepend a `+http://+` prefix if the supplied UR *Type:* `+Boolean+` or `+String+` -*Possible values:* `+true+`, `+false+` +*Possible values:* `+true+`, `+false+`, `+'http'+`, `+'https'+` -*Default value:* `+false+`, `+'http'+`, `+'https'+` +*Default value:* `+false+` === Example: using `+link_assume_external_targets+` diff --git a/modules/ROOT/partials/configuration/link_class_list.adoc b/modules/ROOT/partials/configuration/link_class_list.adoc index bda1a05383..4b508fae64 100644 --- a/modules/ROOT/partials/configuration/link_class_list.adoc +++ b/modules/ROOT/partials/configuration/link_class_list.adoc @@ -3,7 +3,7 @@ The `+link_class_list+` option allows you to specify a list of classes for the link dialog. These classes will appear in a dropdown menu in the link dialog. Each class must be defined as an object with a `+title+` and a `+value+`. For example: `+{ title: 'Cat', value: 'cat' }+`. When the dialog is submitted, the `+value+` of the selected class item from the dropdown will be set as the link's `+class+`. -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` *Default value:* `+[]+` diff --git a/modules/ROOT/partials/configuration/link_default_target.adoc b/modules/ROOT/partials/configuration/link_default_target.adoc index d502295982..e25858e79b 100644 --- a/modules/ROOT/partials/configuration/link_default_target.adoc +++ b/modules/ROOT/partials/configuration/link_default_target.adoc @@ -17,6 +17,8 @@ endif::[] *Type:* `+String+` +*Default value:* `+undefined+` + === Example: using `+link_default_target+` [source,js,subs="attributes+"] diff --git a/modules/ROOT/partials/configuration/link_list.adoc b/modules/ROOT/partials/configuration/link_list.adoc index dff28de01e..6544b84ad8 100644 --- a/modules/ROOT/partials/configuration/link_list.adoc +++ b/modules/ROOT/partials/configuration/link_list.adoc @@ -5,7 +5,7 @@ This option lets you specify a predefined list of links for the link dialog. The There are multiple ways to specify how to get the data for the link list, but all methods rely on the returned data containing an array of link items. A link item is an object with a `+title+` and a `+value+`. For example: `+{ title: 'My page 1', value: 'https://www.tiny.cloud' }+`. -*Type:* `+String+`, `+Array+` or `+Function+` +*Type:* `+String+`, `+Function+`, or `+Array+` of `+Objects+` === Example of an array of link items diff --git a/modules/ROOT/partials/configuration/link_quicklink.adoc b/modules/ROOT/partials/configuration/link_quicklink.adoc index 178eca5122..574ddb8f40 100644 --- a/modules/ROOT/partials/configuration/link_quicklink.adoc +++ b/modules/ROOT/partials/configuration/link_quicklink.adoc @@ -1,7 +1,7 @@ [[link_quicklink]] == `+link_quicklink+` -This option changes the behaviour of the `+CTRL + K+` shortcut. By default, pressing `+CTRL + K+` will open the link dialog. If `+link_quicklink+` is set to `+true+`, pressing `+CTRL + K+` will instead open the link context toolbar. If the cursor is within an existing link, this context toolbar will contain fields for modifying, removing and opening the selected link. If not, the context toolbar allows for the quick insertion of a link. +This option changes the behaviour of the kbd:[Ctrl+K] shortcut. By default, pressing kbd:[Ctrl+K] will open the link dialog. If `+link_quicklink+` is set to `+true+`, pressing kbd:[Ctrl+K] will instead open the link context toolbar. If the cursor is within an existing link, this context toolbar will contain fields for modifying, removing and opening the selected link. If not, the context toolbar allows for the quick insertion of a link. NOTE: This context toolbar is the same as the context toolbar mentioned in the xref:link.adoc#link_context_toolbar[`+link_context_toolbar+`] documentation above. diff --git a/modules/ROOT/partials/configuration/link_rel_list.adoc b/modules/ROOT/partials/configuration/link_rel_list.adoc index 640c8c1c64..b5948bd94f 100644 --- a/modules/ROOT/partials/configuration/link_rel_list.adoc +++ b/modules/ROOT/partials/configuration/link_rel_list.adoc @@ -3,7 +3,7 @@ This option lets you specify a list of `+rel+` values for the `+link+` dialog. These values gets applied to the `+rel+` attribute. Each `+rel+` item must be defined as an object with a `+title+` and a `+value+`. For example: `+{ title: 'No Referrer', value: 'noreferrer' }+`. When the dialog is submitted, the `+value+` of the selected `+rel+` item will be set as the link's `+rel+` attribute. -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` *Default value:* `+[]+` diff --git a/modules/ROOT/partials/configuration/link_target_list.adoc b/modules/ROOT/partials/configuration/link_target_list.adoc index f6ebc044ab..232db2e908 100644 --- a/modules/ROOT/partials/configuration/link_target_list.adoc +++ b/modules/ROOT/partials/configuration/link_target_list.adoc @@ -5,7 +5,7 @@ The `+link_target_list+` option lets you specify a list of named targets for the If xref:link.adoc#link_default_target[`+link_default_target+`] is also configured and its value matches a value specified by `+link_target_list+`, that item will be set as the default item for the targets dropdown in the link dialog. -*Type:* `+Boolean+` or `+Array+` +*Type:* `+Boolean+` or `+Array+` of `+Objects+` *Default value:* [source,js] diff --git a/modules/ROOT/partials/configuration/linkchecker_content_css.adoc b/modules/ROOT/partials/configuration/linkchecker_content_css.adoc index cb51373c87..9efe15f55b 100644 --- a/modules/ROOT/partials/configuration/linkchecker_content_css.adoc +++ b/modules/ROOT/partials/configuration/linkchecker_content_css.adoc @@ -21,6 +21,8 @@ It is possible to replace or extend those styles, by providing a URL to custom s *Type:* `+String+` +*Default value:* `+pluginUrl + '/content.min.css'+` + === Example: using `+linkchecker_content_css+` [source,js] diff --git a/modules/ROOT/partials/configuration/lists_indent_on_tab.adoc b/modules/ROOT/partials/configuration/lists_indent_on_tab.adoc index a4bf4fd240..1c7bafc618 100644 --- a/modules/ROOT/partials/configuration/lists_indent_on_tab.adoc +++ b/modules/ROOT/partials/configuration/lists_indent_on_tab.adoc @@ -1,7 +1,7 @@ [[lists_indent_on_tab]] == `+lists_indent_on_tab+` -This boolean option allows to disable the indent on tab key functionality. Its default value is set to `+true+`. +This boolean option allows to disable the indent on kbd:[Tab] key functionality. Its default value is set to `+true+`. *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/max_height.adoc b/modules/ROOT/partials/configuration/max_height.adoc index 1b501df378..a4c6c6cec3 100644 --- a/modules/ROOT/partials/configuration/max_height.adoc +++ b/modules/ROOT/partials/configuration/max_height.adoc @@ -8,6 +8,8 @@ The `+max_height+` option has two kinds of behaviors depending on the state of t *Type:* `+Number+` +*Default value:* `+undefined+` + === Example: using `+max_height+` ifeval::["{plugincode}" != "autoresize"] diff --git a/modules/ROOT/partials/configuration/max_image_dimension.adoc b/modules/ROOT/partials/configuration/max_image_dimension.adoc index b8b5f5bb06..ac654de6b7 100644 --- a/modules/ROOT/partials/configuration/max_image_dimension.adoc +++ b/modules/ROOT/partials/configuration/max_image_dimension.adoc @@ -5,6 +5,8 @@ This option constrains the width and height of uploaded images. When specified, *Type:* `+Number+` +*Default value:* `+undefined+` + [[example-using-max_image_dimension-with-the-tinydrivebrowse-api]] === Example: using `+max_image_dimension+` with the tinydrive.browse API @@ -20,7 +22,7 @@ tinymce.init({ text: 'Custom browse', onAction: () => { editor.plugins.tinydrive.browse({ - max_image_dimension: 1024 + max_image_dimension: 1024 // set the maximum image dimension to 1024 pixels }).then(() => { console.log('Tiny Drive dialog closed.'); }); diff --git a/modules/ROOT/partials/configuration/max_width.adoc b/modules/ROOT/partials/configuration/max_width.adoc index 79323437ff..88543f1187 100644 --- a/modules/ROOT/partials/configuration/max_width.adoc +++ b/modules/ROOT/partials/configuration/max_width.adoc @@ -7,6 +7,8 @@ NOTE: This behavior is different than the xref:autoresize.adoc[`+autoresize+`] p *Type:* `+Number+` +*Default value:* `+undefined+` + === Example: using `+max_width+` [source,js] diff --git a/modules/ROOT/partials/configuration/media_url_resolver.adoc b/modules/ROOT/partials/configuration/media_url_resolver.adoc index a6d7a5a67a..ac1cfc76db 100644 --- a/modules/ROOT/partials/configuration/media_url_resolver.adoc +++ b/modules/ROOT/partials/configuration/media_url_resolver.adoc @@ -3,7 +3,7 @@ This option allows you to specify a function that will be used to replace {productname}'s default media embed logic with your own, custom logic. -The media url resolver function takes three arguments: `+data+`, a `+resolve+` callback and a `+reject+` callback. The `+data+` argument will be an object with a `+url+` property on it. In your custom handler function you can then handle the `+url+` in whatever way you want and return the HTML you want to embed by calling the `+resolve+` callback and passing it an object with the HTML set on the `+html+` property, like this: `+resolve({ html: 'YOUR_HTML' })+`. +The media URL resolver function takes three arguments: `+data+`, a `+resolve+` callback and a `+reject+` callback. The `+data+` argument will be an object with a `+url+` property on it. In your custom handler function you can then handle the `+url+` in whatever way you want and return the HTML you want to embed by calling the `+resolve+` callback and passing it an object with the HTML set on the `+html+` property, like this: `+resolve({ html: 'YOUR_HTML' })+`. If, in your handler, you would like to fall back to the default media embed logic, call the `+resolve+` callback with an object where the `+html+` property is set to an empty string, like this: `+resolve({ html: '' })+`. @@ -11,9 +11,11 @@ If something goes wrong in your function and you want to show an error to the us *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+media_url_resolver+` -The following example simply checks if the url contains some special url and returns an iframe if it does. Otherwise it calls the `+resolve+` callback with an empty string, falling back to the default media embed logic. +The following example simply checks if the URL contains some special URL and returns an iframe if it does. Otherwise it calls the `+resolve+` callback with an empty string, falling back to the default media embed logic. [source,js] ---- diff --git a/modules/ROOT/partials/configuration/mediaembed_max_width.adoc b/modules/ROOT/partials/configuration/mediaembed_max_width.adoc index bbd0bd402e..f1bfbe8c91 100644 --- a/modules/ROOT/partials/configuration/mediaembed_max_width.adoc +++ b/modules/ROOT/partials/configuration/mediaembed_max_width.adoc @@ -1,7 +1,7 @@ [[mediaembed_max_width]] == `+mediaembed_max_width+` -This option specifies a maximum width in pixels of the embedded content. Defaults to `+650+`. +This option specifies a maximum width in pixels of the embedded content. *Type:* `+Number+` diff --git a/modules/ROOT/partials/configuration/mentions_fetch.adoc b/modules/ROOT/partials/configuration/mentions_fetch.adoc index 4836dc0aef..e6d12c1ed6 100644 --- a/modules/ROOT/partials/configuration/mentions_fetch.adoc +++ b/modules/ROOT/partials/configuration/mentions_fetch.adoc @@ -11,6 +11,8 @@ For information on the user properties to pass to the success callback for the a *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+mentions_fetch+` [source,js] diff --git a/modules/ROOT/partials/configuration/mentions_item_type.adoc b/modules/ROOT/partials/configuration/mentions_item_type.adoc index a254c16fca..f564b7430a 100644 --- a/modules/ROOT/partials/configuration/mentions_item_type.adoc +++ b/modules/ROOT/partials/configuration/mentions_item_type.adoc @@ -10,10 +10,10 @@ For information on the properties required for the user object provided to xref: *Type:* `+String+` -*Default value:* `+'name'+` - *Possible values:* `+'name'+`, `+'profile'+` +*Default value:* `+'name'+` + === Example: using `+mentions_item_type+` [source,js] @@ -32,9 +32,9 @@ The following table describes the properties available for user objects provided [cols="1,1,1,1,4",options="header"] |=== -|Name |Value |`+name+` |`+profile+` |Description -|id |string |required |required |Used to identify the user mention in different callbacks -|name |string |required |required |Name to display and highlight matches -|image |string |not available |optional |Image source for user avatar -|description |string |not available |optional |Description to display +| Name | Value | `+name+` | `+profile+` | Description +| id | `+String+` | required | required | Used to identify the user mention in different callbacks +| name | `+String+` | required | required | Name to display and highlight matches +| image | `+String+` | not available | optional | Image source for user avatar +| description | `+String+` | not available | optional | Description to display |=== diff --git a/modules/ROOT/partials/configuration/mentions_menu_complete.adoc b/modules/ROOT/partials/configuration/mentions_menu_complete.adoc index 5bafd6d0d4..be99109026 100644 --- a/modules/ROOT/partials/configuration/mentions_menu_complete.adoc +++ b/modules/ROOT/partials/configuration/mentions_menu_complete.adoc @@ -5,6 +5,8 @@ This option overrides the default logic for inserting the mention into the edito *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+mentions_menu_complete+` [source,js] diff --git a/modules/ROOT/partials/configuration/mentions_menu_hover.adoc b/modules/ROOT/partials/configuration/mentions_menu_hover.adoc index fc50ef57af..e340c688f1 100644 --- a/modules/ROOT/partials/configuration/mentions_menu_hover.adoc +++ b/modules/ROOT/partials/configuration/mentions_menu_hover.adoc @@ -5,6 +5,8 @@ This option enables you to provide an element to present next to the menu item b *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+mentions_menu_hover+` [source,js] diff --git a/modules/ROOT/partials/configuration/mentions_select.adoc b/modules/ROOT/partials/configuration/mentions_select.adoc index 8bc67c707f..af96e8de6d 100644 --- a/modules/ROOT/partials/configuration/mentions_select.adoc +++ b/modules/ROOT/partials/configuration/mentions_select.adoc @@ -5,6 +5,8 @@ This option enables a hover card to be presented when a user hovers over a menti *Type:* `+Function+` +*Default value:* `+undefined+` + === Example: using `+mentions_select+` [source,js] diff --git a/modules/ROOT/partials/configuration/mentions_selector.adoc b/modules/ROOT/partials/configuration/mentions_selector.adoc index b31144fbaa..ed8a48c073 100644 --- a/modules/ROOT/partials/configuration/mentions_selector.adoc +++ b/modules/ROOT/partials/configuration/mentions_selector.adoc @@ -3,7 +3,9 @@ This option enables you to provide a custom CSS selector that should match the element created using `+mentions_menu_complete+`. This enables the plugin to find existing mentions. The callback takes two parameters: the editor instance and the userInfo object. -*Type:* `+Function+` +*Type:* `+String+` + +*Default value:* `+.mention+` === Example: using `+mentions_selector+` diff --git a/modules/ROOT/partials/configuration/menu.adoc b/modules/ROOT/partials/configuration/menu.adoc index 3bec6eee89..43aac90183 100644 --- a/modules/ROOT/partials/configuration/menu.adoc +++ b/modules/ROOT/partials/configuration/menu.adoc @@ -10,7 +10,7 @@ To group certain menu items, insert a `+|+` pipe character between the menu item *Type:* `+Object+` [[example-the-tinymce-default-menu-items]] -=== Example: the TinyMCE Default Menu Items +=== Example: the {productname} Default Menu Items include::partial$configuration/defaultmenuitems.adoc[] diff --git a/modules/ROOT/partials/configuration/menubar.adoc b/modules/ROOT/partials/configuration/menubar.adoc index ed93efb7e3..47ba972daa 100644 --- a/modules/ROOT/partials/configuration/menubar.adoc +++ b/modules/ROOT/partials/configuration/menubar.adoc @@ -7,9 +7,9 @@ To define the menus on {productname}'s menu bar, provide the menubar option with *Type:* `+String+` or `+Boolean+` -*Possible values:* `+true+`, `+false+` +*Possible values:* `+true+`, `+false+` or `+String+` of menus -*Default value:* `+true+`, or `+String+` of menus +*Default value:* `+true+` for desktop and `+false+` for mobile include::partial$misc/admon-different-default-for-mobile.adoc[] diff --git a/modules/ROOT/partials/configuration/mergetags_list.adoc b/modules/ROOT/partials/configuration/mergetags_list.adoc index 05e7d72cc7..7e3e599824 100644 --- a/modules/ROOT/partials/configuration/mergetags_list.adoc +++ b/modules/ROOT/partials/configuration/mergetags_list.adoc @@ -3,26 +3,31 @@ `+mergetags_list+` is an object array that specifies the menu content used for merge tags insertion. Every object specifies the configuration of a submenu or a menu item. -IMPORTANT: If the `+mergetags_list+` option is not set, or contains no entries, both the Merge Tags toolbar button and the Merge Tags menu item are hidden. Merge tag autosuggestions are also disabled if the `+mergetags_list+` option is not set, or contains no entries. +[IMPORTANT] +==== +If the `+mergetags_list+` option is not set, or contains no entries, both the Merge Tags toolbar button and the Merge Tags menu item are hidden. Merge tag autosuggestions are also disabled if the `+mergetags_list+` option is not set, or contains no entries. +==== -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` + +*Default value:* `+undefined+` === Menu item properties [cols="1,1,1,4",options="header"] |=== -|Name|Type|Required|Description -|title |string |optional |If set: the menu item label to display instead of the `+value+`. -|value |string |required |The merge tag content to be inserted after the menu item is activated. +| Name | Type | Required? | Description +| title | `+String+` | optional | If set: the menu item label to display instead of the `+value+`. +| value | `+String+` | required | The merge tag content to be inserted after the menu item is activated. |=== === Submenu properties [cols="1,1,1,4",options="header"] |=== -|Name|Type|Required|Description -|title |string |required |The submenu label to display. -|menu |Array |required |The list of nested submenus and menu items. +| Name | Type | Required? | Description +| title | `+String+` | required | The submenu label to display. +| menu | `+Array+` | required | The list of nested submenus and menu items. |=== === Example: using `+mergetags_list+` diff --git a/modules/ROOT/partials/configuration/min_width.adoc b/modules/ROOT/partials/configuration/min_width.adoc index 3d1733453d..32d3080647 100644 --- a/modules/ROOT/partials/configuration/min_width.adoc +++ b/modules/ROOT/partials/configuration/min_width.adoc @@ -7,6 +7,8 @@ NOTE: This behavior is different from the xref:autoresize.adoc[`+autoresize+`] p *Type:* `+Number+` +*Default value:* `+undefined+` + === Example: using `+min_width+` [source,js] diff --git a/modules/ROOT/partials/configuration/mobile.adoc b/modules/ROOT/partials/configuration/mobile.adoc index fa46695323..e643f2718f 100644 --- a/modules/ROOT/partials/configuration/mobile.adoc +++ b/modules/ROOT/partials/configuration/mobile.adoc @@ -5,6 +5,8 @@ This option allows an alternative configuration to be specified that will overri *Type:* `+Object+` +*Default value:* `+undefined+` + === Example of mobile specific configuration This example shows how to setup a mobile section to override some of the desktop settings with mobile specific settings. diff --git a/modules/ROOT/partials/configuration/model_url.adoc b/modules/ROOT/partials/configuration/model_url.adoc index c9945f4bfb..7915cfc5ea 100644 --- a/modules/ROOT/partials/configuration/model_url.adoc +++ b/modules/ROOT/partials/configuration/model_url.adoc @@ -5,6 +5,8 @@ This option allows specifying the location of the `dom` model file. This is usef *Type:* `+String+` +*Default value:* `+undefined+` + === Example: using `+model_url+` [source,js] diff --git a/modules/ROOT/partials/configuration/newline_behavior.adoc b/modules/ROOT/partials/configuration/newline_behavior.adoc index ba2a4d92b6..ef072637bc 100644 --- a/modules/ROOT/partials/configuration/newline_behavior.adoc +++ b/modules/ROOT/partials/configuration/newline_behavior.adoc @@ -3,12 +3,12 @@ include::partial$misc/admon-requires-6.1v.adoc[] -This option enables you to adjust what happens when Enter or Return is pressed. There are four options: +This option enables you to adjust what happens when kbd:[Enter] or kbd:[Return] is pressed. There are four options: -* `default` inserts a block (defined by xref:content-filtering.adoc#forced_root_block[forced_root_block]) on Enter, and a `br` tag on Shift+Enter. -* `block` forces the above Enter behavior in all cases. -* `linebreak` forces the above Shift+Enter behavior in all cases. -* `invert` swaps Enter and Shift+Enter behaviors. +* `default` inserts a block (defined by xref:content-filtering.adoc#forced_root_block[forced_root_block]) on kbd:[Enter], and a `br` tag on kbd:[Shift+Enter]. +* `block` forces the above kbd:[Enter] behavior in all cases. +* `linebreak` forces the above kbd:[Shift+Enter] behavior in all cases. +* `invert` swaps kbd:[Enter] and kbd:[Shift+Enter] behaviors. NOTE: This option changes the behavior of the `mceInsertNewLine` command. `insertParagraph` and `InsertLineBreak` commands are not affected. diff --git a/modules/ROOT/partials/configuration/nonbreaking_force_tab.adoc b/modules/ROOT/partials/configuration/nonbreaking_force_tab.adoc index 70199b9395..403b5b8c44 100644 --- a/modules/ROOT/partials/configuration/nonbreaking_force_tab.adoc +++ b/modules/ROOT/partials/configuration/nonbreaking_force_tab.adoc @@ -1,19 +1,19 @@ [[nonbreaking_force_tab]] == `+nonbreaking_force_tab+` -This option allows you to force {productname} to insert three `+ +` entities when the user presses the keyboard `+tab+` key. +This option allows you to force {productname} to insert three `+ +` entities when the user presses the keyboard kbd:[Tab] key. It's important to note that this does not change the behavior of the menu and toolbar controls, which will continue to insert a single `+ +` entity when `+nonbreaking_force_tab+` value is `+true+`. -However, the `+true+` condition does capture the tab key and contain it within the editable area, whereas when set to its default state of `+false+` a tab keypress will move the cursor to the next editable area (e.g. a browser url bar or form field on the current page). +However, the `+true+` condition does capture the kbd:[Tab] key and contain it within the editable area, whereas when set to its default state of `+false+` a kbd:[Tab] keypress will move the cursor to the next editable area (e.g. a browser URL bar or form field on the current page). [WARNING] .Usage with `+table+` or `+lists+` plugin ==== The `+nonbreaking_force_tab+` setting can break the following functionality: -* The `+table+` plugin uses the Tab key for navigating between table cells. -* The `+lists+` plugin uses the Tab key for item indentation. +* The `+table+` plugin uses the kbd:[Tab] key for navigating between table cells. +* The `+lists+` plugin uses the kbd:[Tab] key for item indentation. ==== *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/pad_empty_with_br.adoc b/modules/ROOT/partials/configuration/pad_empty_with_br.adoc index 291d8369ee..40a364a6ba 100644 --- a/modules/ROOT/partials/configuration/pad_empty_with_br.adoc +++ b/modules/ROOT/partials/configuration/pad_empty_with_br.adoc @@ -3,7 +3,7 @@ include::partial$misc/admon-requires-6.6.1v.adoc[] -By default, {productname} places non-breaking space entities — `+ +` — as placeholders inside empty block elements. +By default, {productname} places non-breaking space entities — `+ +` — as placeholders inside empty block elements. For example, the empty paragraph `++` will, by default, be serialized to `++`. diff --git a/modules/ROOT/partials/configuration/powerpaste_html_import.adoc b/modules/ROOT/partials/configuration/powerpaste_html_import.adoc index fac8d6c6f7..7b2c812006 100644 --- a/modules/ROOT/partials/configuration/powerpaste_html_import.adoc +++ b/modules/ROOT/partials/configuration/powerpaste_html_import.adoc @@ -20,7 +20,7 @@ What the supported string-based values do: Removes inline styles and classes. -This results in simple content that uses the site’s CSS stylesheet while retaining the semantic structure of the original document. +This results in simple content that uses the site's CSS stylesheet while retaining the semantic structure of the original document. |`+merge+` |Preserves the inline formatting and structure of the original document. @@ -41,7 +41,7 @@ Content copied or cut from a {productname} instance and then pasted into a {prod In this circumstance, whatever is copied or cut is exactly what is pasted. ==== -=== example: using `+powerpaste_html_import+` to require a prompt when pasting html +=== example: using `+powerpaste_html_import+` to require a prompt when pasting HTML content [source,js] ---- diff --git a/modules/ROOT/partials/configuration/promotion.adoc b/modules/ROOT/partials/configuration/promotion.adoc index d1e54e82a4..965d17de05 100644 --- a/modules/ROOT/partials/configuration/promotion.adoc +++ b/modules/ROOT/partials/configuration/promotion.adoc @@ -5,6 +5,8 @@ *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+true+` in Community self-hosted instances; otherwise `+false+`. *Possible values:* `+true+`, `+false+` diff --git a/modules/ROOT/partials/configuration/readonly.adoc b/modules/ROOT/partials/configuration/readonly.adoc index 396c0f921f..17db5a38dd 100644 --- a/modules/ROOT/partials/configuration/readonly.adoc +++ b/modules/ROOT/partials/configuration/readonly.adoc @@ -5,6 +5,8 @@ Setting the `readonly` option to `+true+` initializes the editor in **readonly** *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` *Possible values:* `+true+`, `+false+` diff --git a/modules/ROOT/partials/configuration/resize_img_proportional.adoc b/modules/ROOT/partials/configuration/resize_img_proportional.adoc index 5f95cd8ef2..613d98a3ae 100644 --- a/modules/ROOT/partials/configuration/resize_img_proportional.adoc +++ b/modules/ROOT/partials/configuration/resize_img_proportional.adoc @@ -3,8 +3,8 @@ When a user resizes an image in the editor, this option controls whether image is resized proportionally or freely. If set to: -* `+true+` -- When users resize an image, the image will be resized proportionally (both dimensions of the image are resized by the same percentage of length). Users can freely resize images by holding the `+Shift+` key while resizing. -* `+false+` -- When users resize an image, the image can be resized freely. Users can proportionally resize images by holding the `+Shift+` key while resizing. +* `+true+` -- When users resize an image, the image will be resized proportionally (both dimensions of the image are resized by the same percentage of length). Users can freely resize images by holding the kbd:[Shift] key while resizing. +* `+false+` -- When users resize an image, the image can be resized freely. Users can proportionally resize images by holding the kbd:[Shift] key while resizing. *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/revisionhistory_display_author.adoc b/modules/ROOT/partials/configuration/revisionhistory_display_author.adoc index 007e042deb..82ef638784 100644 --- a/modules/ROOT/partials/configuration/revisionhistory_display_author.adoc +++ b/modules/ROOT/partials/configuration/revisionhistory_display_author.adoc @@ -5,6 +5,8 @@ This option configures the display of the revision's author. When set to `+true+ *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `revisionhistory_display_author` diff --git a/modules/ROOT/partials/configuration/style_formats_autohide.adoc b/modules/ROOT/partials/configuration/style_formats_autohide.adoc index 26d688cf65..42b39dcc9c 100644 --- a/modules/ROOT/partials/configuration/style_formats_autohide.adoc +++ b/modules/ROOT/partials/configuration/style_formats_autohide.adoc @@ -5,6 +5,8 @@ This option enables auto hiding of styles that can't be applied to the current c *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+style_formats_autohide+` diff --git a/modules/ROOT/partials/configuration/style_formats_merge.adoc b/modules/ROOT/partials/configuration/style_formats_merge.adoc index b971297507..11afb86ac6 100644 --- a/modules/ROOT/partials/configuration/style_formats_merge.adoc +++ b/modules/ROOT/partials/configuration/style_formats_merge.adoc @@ -5,6 +5,8 @@ This option allows you to set whether {productname} should append custom styles *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` === Example: using `+style_formats_merge+` diff --git a/modules/ROOT/partials/configuration/table_tab_navigation.adoc b/modules/ROOT/partials/configuration/table_tab_navigation.adoc index 56e57c79d3..09506b26f4 100644 --- a/modules/ROOT/partials/configuration/table_tab_navigation.adoc +++ b/modules/ROOT/partials/configuration/table_tab_navigation.adoc @@ -1,7 +1,7 @@ [[table_tab_navigation]] == `+table_tab_navigation+` -This option enables you to disable the default tab between table cells feature. By default, when a user presses tab the cursor will move between cells within the table. By setting the `+table_tab_navigation+` value to `+false+` the cursor will tab between browser elements (such as the URL bar or form fields, etc). +This option enables you to disable the default tab between table cells feature. By default, when a user presses kbd:[Tab] the cursor will move between cells within the table. By setting the `+table_tab_navigation+` value to `+false+` the cursor will tab between browser elements (such as the URL bar or form fields, etc). *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/text_color.adoc b/modules/ROOT/partials/configuration/text_color.adoc index 7879934583..96efc44a60 100644 --- a/modules/ROOT/partials/configuration/text_color.adoc +++ b/modules/ROOT/partials/configuration/text_color.adoc @@ -247,9 +247,9 @@ tinymce.init({ [IMPORTANT] .End-user customisation of text color grids ---- -When end-users add a new custom color via a text color grid, that color is added to the associated text color grid but the new custom color is only held in the host browser’s local storage. +When end-users add a new custom color via a text color grid, that color is added to the associated text color grid but the new custom color is only held in the host browser's local storage. -If, for example, an end-user adds a custom color to the foreground text color grid, that new color is presented in the foreground text color grid in the end-user’s {productname} instance. The new custom color is not, however, stored in any of the instance’s color map arrays. +If, for example, an end-user adds a custom color to the foreground text color grid, that new color is presented in the foreground text color grid in the end-user's {productname} instance. The new custom color is not, however, stored in any of the instance's color map arrays. Also, when a user adds a custom color to one palette (for example, the `color_map_background` palette), the {productname} editor instance does not replicate the new custom color in the complementary palette (for example, the `color_map_foreground` palette). ---- @@ -340,6 +340,8 @@ This option allows disabling the custom color picker in all color swatches of th *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+true+` ==== Example: using `+custom_colors+` diff --git a/modules/ROOT/partials/configuration/toolbar_mode.adoc b/modules/ROOT/partials/configuration/toolbar_mode.adoc index b37d417aa9..faffd1bf27 100644 --- a/modules/ROOT/partials/configuration/toolbar_mode.adoc +++ b/modules/ROOT/partials/configuration/toolbar_mode.adoc @@ -85,7 +85,7 @@ tinymce.init({ The scrolling toolbar mode is intended for touch screen devices. -If the `+toolbar_mode+` is configured to `+scrolling+`, the overflow toolbar buttons will remain on the toolbar, but will be hidden from view. To access the overflow toolbar buttons, scroll the toolbar. To scroll the toolbar on a touch screen, use a swiping action. To scroll on a desktop device, hold shift and scroll with a mouse. +If the `+toolbar_mode+` is configured to `+scrolling+`, the overflow toolbar buttons will remain on the toolbar, but will be hidden from view. To access the overflow toolbar buttons, scroll the toolbar. To scroll the toolbar on a touch screen, use a swiping action. To scroll on a desktop device, hold kbd:[Shift] and scroll with a mouse. A scrollbar will be shown on the toolbar on desktop devices and hybrid devices in desktop mode. diff --git a/modules/ROOT/partials/configuration/toolbar_sticky.adoc b/modules/ROOT/partials/configuration/toolbar_sticky.adoc index 3ee01dc824..e66d803a62 100644 --- a/modules/ROOT/partials/configuration/toolbar_sticky.adoc +++ b/modules/ROOT/partials/configuration/toolbar_sticky.adoc @@ -9,6 +9,8 @@ To see a demo of sticky toolbar, see the https://codepen.io/tinymce/full/qBWLLMP *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` in `classic` mode, `+true+` in `inline` mode *Possible values:* `+true+`, `+false+` diff --git a/modules/ROOT/partials/configuration/type_ahead_urls.adoc b/modules/ROOT/partials/configuration/type_ahead_urls.adoc index 8d62dbdb12..6bb9a36e30 100644 --- a/modules/ROOT/partials/configuration/type_ahead_urls.adoc +++ b/modules/ROOT/partials/configuration/type_ahead_urls.adoc @@ -1,7 +1,7 @@ [[typeahead_urls]] == `+typeahead_urls+` -This option controls whether the typeahead url field feature should be enabled or disabled. +This option controls whether the typeahead URL field feature should be enabled or disabled. *Type:* `+Boolean+` diff --git a/modules/ROOT/partials/configuration/ui_mode.adoc b/modules/ROOT/partials/configuration/ui_mode.adoc index aba34aa81e..721acd9600 100644 --- a/modules/ROOT/partials/configuration/ui_mode.adoc +++ b/modules/ROOT/partials/configuration/ui_mode.adoc @@ -11,11 +11,11 @@ By default, these UI elements are rendered in a container that is attached to th When the editor is rendered in a scrollable container, scrolling the editor's container will cause these UI elements to be detached from the anchor. -If `+toolbar_sticky+` is set to true, the sticky toolbar and the menus have no effect on docking when scrolling the editor’s container; they are only triggered when the page is scrolled. +If `+toolbar_sticky+` is set to true, the sticky toolbar and the menus have no effect on docking when scrolling the editor's container; they are only triggered when the page is scrolled. However, setting this option to `+'split'+` enables support for editors in scrollable containers and adjusts the behaviour as follows: -* Popups, menus and inline dialogs are rendered in a separate container and inserted as a sibling to the editor. These UI elements move together as you scroll the editor’s container. +* Popups, menus and inline dialogs are rendered in a separate container and inserted as a sibling to the editor. These UI elements move together as you scroll the editor's container. * If `+toolbar_sticky+` is set to true, the UI element can be docked on both page and container scroll. This means the UI element will stay in the same place relative to the container, regardless of how much you scroll the page or the container itself. *Type:* `+String+`