diff --git a/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc b/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc index c35970dd4d..a7ebab42b8 100644 --- a/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc +++ b/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc @@ -1,12 +1,6 @@ [[]] == `` -// Replace all instances of with the -// configuration option name then remove this comment. - -// Add explanatory material as per the comment block below then remove -// the block and this comment. - //// What does the option do? Why use it? @@ -19,7 +13,7 @@ Are there risks? - For longer or more complicated scenarios, use the limitations section below. //// -*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+` +*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, `+RegExp+`, `+null+`, `+undefined+` // Remove the *Possible values* line if there is no discrete set of possible values. *Possible values:* `'string1'`, `'string2'`, `false` @@ -32,14 +26,14 @@ Are there risks? [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML : '' }); ---- // Add a working and tested configuration (edit as required) // or remove if not applicable. -=== Example: disabling the +=== Example: disabling the `` option To disable , set `` to `false`. @@ -53,17 +47,12 @@ tinymce.init({ // Remove if not applicable. // Edit the sub-head to singular or plural as required. -=== Limitation(s) of the `` option +=== Limitation of the `` option -The `` option has the following limitations. - -// Add explanatory material as per the comment block below then remove -// the block and this comment. +The `` option has the following limitation: //// Known limitations. Complicated scenarios. Anything that warrants a CAUTION or WARNING admonition. -/// - -// Remove all comment lines and comment blocks before publishing. +//// diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc index 391b450c3b..a7ebab42b8 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc @@ -13,7 +13,7 @@ Are there risks? - For longer or more complicated scenarios, use the limitations section below. //// -*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+` +*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, `+RegExp+`, `+null+`, `+undefined+` // Remove the *Possible values* line if there is no discrete set of possible values. *Possible values:* `'string1'`, `'string2'`, `false` @@ -26,32 +26,33 @@ Are there risks? [source,js] ---- tinymce.init({ - selector: 'textarea', // Change this value according to your HTML + selector: 'textarea', // change this value according to your HTML : '' }); ---- // Add a working and tested configuration (edit as required) // or remove if not applicable. -=== Example: disabling the +=== Example: disabling the `` option To disable , set `` to `false`. [source,js] ---- tinymce.init({ - selector: 'textarea', // Change this value according to your HTML + selector: 'textarea', // change this value according to your HTML : 'false' }); ---- // Remove if not applicable. +// Edit the sub-head to singular or plural as required. === Limitation of the `` option -The `` option has the following limitations. +The `` option has the following limitation: //// Known limitations. Complicated scenarios. Anything that warrants a CAUTION or WARNING admonition. -//// \ No newline at end of file +//// diff --git a/antora.yml b/antora.yml index 23beb449cb..1bdc03bbb8 100644 --- a/antora.yml +++ b/antora.yml @@ -6,6 +6,7 @@ asciidoc: # anchor configuration (the @ allows it to be overridden if required) idprefix: '@' idseparator: '-@' + experimental: '' # generic variables companyurl: https://www.tiny.cloud cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/7/tinymce.min.js @@ -27,6 +28,7 @@ asciidoc: productname: TinyMCE productmajorversion: 7 productminorversion: '7.6' + branding: Build with TinyMCE ##### product name in codeblock prodnamecode: tinymce #### more names diff --git a/modules/ROOT/pages/advanced-typography.adoc b/modules/ROOT/pages/advanced-typography.adoc index 2e249b6c30..dff8dde39a 100644 --- a/modules/ROOT/pages/advanced-typography.adoc +++ b/modules/ROOT/pages/advanced-typography.adoc @@ -21,7 +21,7 @@ The {pluginname} plugin rules are sourced from the https://github.com/typograf/t However, the {pluginname} plugin only uses a sub-set of all the rules available in this library. -Of the library’s full https://github.com/typograf/typograf/blob/dev/docs/RULES.en-US.md[Rules of typograf] list, the {pluginname} plugin uses the following: +Of the library's full https://github.com/typograf/typograf/blob/dev/docs/RULES.en-US.md[Rules of typograf] list, the {pluginname} plugin uses the following: * common/space/delBeforePunctuation * common/space/afterComma @@ -77,7 +77,7 @@ tinymce.init({ selector: 'textarea', // change this value according to your HTML plugins: '{plugincode}', toolbar: '{plugincode}', - typography_default_lang: [ "en-US" ], // Required to set specific typography language rules. + typography_default_lang: 'en-US', // Required to set specific typography language rules. }); ---- diff --git a/modules/ROOT/pages/customsidebar.adoc b/modules/ROOT/pages/customsidebar.adoc index fb59b4c0cc..3a6a6574e5 100644 --- a/modules/ROOT/pages/customsidebar.adoc +++ b/modules/ROOT/pages/customsidebar.adoc @@ -18,42 +18,30 @@ When a new sidebar is registered, a corresponding toolbar button for toggling th === Specification object -[[tooltip]] -==== `+tooltip+` +[cols="1,1,4", options="header"] +|=== +| Property | Type | Description -The `+tooltip+` specifies a tooltip to be displayed when hovering over the sidebar toggle button. +| `+tooltip+` +| `+String+` +| Specifies a tooltip to be displayed when hovering over the sidebar toggle button. -*Type:* `+String+` +| `+icon+` +| `+String+` +| Specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon[custom icon]. -[[icon]] -==== `+icon+` +| `+onSetup+` +| `+Function+` +| Specifies a function to be called when the panel is first created. It passes in an API object and should return a callback that takes an API. The default is `+(api) => (api) => {}+`. This function runs whenever the sidebar is rendered, and the returned callback is executed when the sidebar is destroyed. Therefore, the returned function is essentially an `+onTeardown+` handler, and can be used to unbind events and callbacks. -The `+icon+` specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon[custom icon]. +| `+onShow+` +| `+Function+` +| Specifies a function to be called when the panel is displayed. It passes in an API object. -*Type:* `+String+` - -[[onSetup]] -==== `+onSetup+` - -The `+onSetup+` specifies a function to be called when the panel is first created. It passes in an API object and should return a callback that takes an API. The default is `+(api) => (api) => {}+`. - -`+onSetup+` is a complex property. It requires a function that takes the sidebar’s API and should return a callback that takes the sidebar's API and returns nothing. This occurs because `+onSetup+` runs whenever the sidebar is rendered, and the returned callback is executed when the sidebar is destroyed. Therefore the returned function is essentially an `+onTeardown+` handler, and can be used to unbind events and callbacks. - -*Type:* `+Function+` - -[[onShow]] -==== `+onShow+` - -The `+onShow+` specifies a function to be called when the panel displayed. It passes in an API object. - -*Type:* `+Function+` - -[[onHide]] -==== `+onHide+` - -The `+onHide+` specifies a function to be called when the panel is hidden. It passes in an API object. - -*Type:* `+Function+` +| `+onHide+` +| `+Function+` +| Specifies a function to be called when the panel is hidden. It passes in an API object. +|=== === API Object @@ -72,7 +60,8 @@ include::partial$configuration/sidebar_show.adoc[leveloffset=+1] [source,js] ---- tinymce.init({ - ... + selector: 'textarea', // change this value according to your HTML + sidebar_show: 'mysidebar', toolbar: 'mysidebar', setup: (editor) => { editor.ui.registry.addSidebar('mysidebar', { diff --git a/modules/ROOT/partials/configuration/a11y_advanced_options.adoc b/modules/ROOT/partials/configuration/a11y_advanced_options.adoc index de6765c7f7..2ee53e80a9 100644 --- a/modules/ROOT/partials/configuration/a11y_advanced_options.adoc +++ b/modules/ROOT/partials/configuration/a11y_advanced_options.adoc @@ -20,11 +20,11 @@ If `xref:a11ychecker.adoc#a11ychecker_allow_decorative_images[a11ychecker_allow_ *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+a11y_advanced_options+` +*Default value:* `+false+` + +.Example: using `+a11y_advanced_options+` ifeval::["{includedSection}" == "uploadcarePlugin"] diff --git a/modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc b/modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc index 1273b98df0..f70e8fa949 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc @@ -32,11 +32,11 @@ If `+a11ychecker_allow_decorative_images+` is not explicitly set, the value defi *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+a11ychecker_allow_decorative_images+` +*Default value:* `+false+` + +.Example: using `+a11ychecker_allow_decorative_images+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc b/modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc index b901d701ea..2a07493d33 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_filter_issue.adoc @@ -13,14 +13,14 @@ The callback function will be passed xref:a11ychecker.adoc#issue[`issue` objects (issue) => true; ---- -=== Example: using `+a11ychecker_filter_issue+` to filter out the Accessibility Checker T1 rule +The callback function in the following example will return `+false+` if the issue `id` value is `'T1'`, filtering `'T1'` issues from the Accessibility Checker report. -The callback function in the following example will return `false` if the issue `id` value is `'T1'`, filtering `'T1'` issues from the Accessibility Checker report. +.Example: using `+a11ychecker_filter_issue+` to filter out the Accessibility Checker T1 rule [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'a11ychecker', toolbar: 'a11ycheck', a11ychecker_filter_issue: (issue) => { @@ -29,14 +29,14 @@ tinymce.init({ }); ---- -=== Example: using `+a11ychecker_filter_issue+` to filter out all Accessibility Checker table rules and rules less than `+'error'+` level - The callback function in the following example will only return `+false+` if the issue `+element+` is a `+'table'+` and the `+'severity'+` level is not `+'error'+`, filtering all low-severity and `+table+` element-related issues from the Accessibility Checker report. +.Example: using `+a11ychecker_filter_issue+` to filter out all Accessibility Checker table rules and rules less than `+'error'+` level + [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'a11ychecker', toolbar: 'a11ycheck', a11ychecker_filter_issue: (issue) => { @@ -45,14 +45,14 @@ tinymce.init({ }); ---- -=== Example: using `+a11ychecker_filter_issue+` to filter images with empty alternative text from the Accessibility Checker I1 rule +The callback function in the following example will only return `+false+` for any issues with `'I1'` as the `+'id'+` image elements with an empty `+'alt+'` attribute, otherwise the issue won't be filtered out. This implementation can be useful as allowing images to have empty alternative text can be another method of applying the `+role="presentation"+` attribute to mark an image as `+decorative+`. -The callback function in the following example will only return `false` for any issues with `'I1'` as the `+'id'+` image elements with an empty `+'alt+'` attribute, otherwise the issue won’t be filtered out. This implementation can be useful as allowing images to have empty alternative text can be another method of applying the `+role="presentation"+` attribute to mark an image as `+decorative+`. +.Example: using `+a11ychecker_filter_issue+` to filter images with empty alternative text from the Accessibility Checker I1 rule [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'a11ychecker', toolbar: 'a11ycheck', a11ychecker_filter_issue: (issue) => { diff --git a/modules/ROOT/partials/configuration/a11ychecker_html_version.adoc b/modules/ROOT/partials/configuration/a11ychecker_html_version.adoc index 228023058f..67bdc3c982 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_html_version.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_html_version.adoc @@ -7,11 +7,11 @@ For example: Setting the version to HTML 4 will enable the rule "Complex tables *Type:* `+String+` -*Default value:* `+html5+` - *Possible values:* `+html4+`, `+html5+` -=== Example: using `+a11ychecker_html_version+` +*Default value:* `+html5+` + +.Example: using `+a11ychecker_html_version+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/a11ychecker_ignored_rules.adoc b/modules/ROOT/partials/configuration/a11ychecker_ignored_rules.adoc index 3cef0f5fb1..da083616f8 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_ignored_rules.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_ignored_rules.adoc @@ -3,24 +3,24 @@ The `+a11ychecker_ignored_rules+` option prevents specific Accessibility Checker rules from being checked. This feature allows developers to skip rules that they do not wish to check. For example: To skip rules that flag known content issues or custom HTML that should not be checked. -*Type:* A comma-separated string. - -*Default value:* `+''+` +*Type:* A comma-separated `+String+` of rule IDs. *Possible values:* `+'D1'+`, `+'D2'+`, `+'D3'+`, `+'D4O'+`, `+'D4U'+`, `+'D5A'+`, `+'D5B'+`, `+'D5C'+`, `+'H93'+`, `+'I1'+`, `+'I2'+`, `+'T1'+`, `+'T2'+`, `+'T3'+`, `+'T4A'+`, `+'T4B'+`, `+'T4C'+` -=== Example: using `+a11ychecker_ignored_rules+` +*Default value:* `+''+` -This examples shows how to ignore the following checks (rules): +This examples shows how to ignore the following rules: * D2 - Sequential headings * I2 - Image `+alt+` text is not the image filename * T4B - Table headers +.Example: using `+a11ychecker_ignored_rules+` + [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'a11ychecker', toolbar: 'a11ycheck', a11ychecker_ignored_rules: 'D2, I2, T4B' diff --git a/modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc b/modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc index 2d8c53af01..07d52e8187 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_issue_url_callback.adoc @@ -11,14 +11,14 @@ The `+a11ychecker_issue_url_callback+` option is used to change the target URL f (ruleId) => `https://www.tiny.cloud/docs/tinymce/6/a11ychecker/#${ruleId}` ---- -=== Example: using `+a11ychecker_issue_url_callback+` - This example shows how to change the link for the "Click for more info" button (image:icons/help.svg[help icon - a question mark inside a circle]) on the Accessibility Checker dialog to point to anchors at `+www.example.com/tinymce/a11ychecker/more_info+`. +.Example: using `+a11ychecker_issue_url_callback+` + [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'a11ychecker', toolbar: 'a11ycheck', a11ychecker_issue_url_callback: (ruleId) => diff --git a/modules/ROOT/partials/configuration/a11ychecker_level.adoc b/modules/ROOT/partials/configuration/a11ychecker_level.adoc index 68ce4d396b..85afe3823e 100644 --- a/modules/ROOT/partials/configuration/a11ychecker_level.adoc +++ b/modules/ROOT/partials/configuration/a11ychecker_level.adoc @@ -10,11 +10,11 @@ For example, the "Text must have a contrast ratio of at least ..." rule: *Type:* `+String+` -*Default value:* `+aa+` - *Possible values:* `+a+`, `+aa+`, `+aaa+` -=== Example: using `+a11ychecker_level+` +*Default value:* `+aa+` + +.Example: using `+a11ychecker_level+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/advanced-typography.adoc b/modules/ROOT/partials/configuration/advanced-typography.adoc index d8aaadfd88..fb7a78b4ab 100644 --- a/modules/ROOT/partials/configuration/advanced-typography.adoc +++ b/modules/ROOT/partials/configuration/advanced-typography.adoc @@ -5,16 +5,21 @@ This option gives the user the ability to pre-set a default typography language By setting up the `typography_default_lang`, each time the user opens the {productname} editor, it will automatically default to the new default language applied. -=== Example: Using `typography_default_langs` +*Type:* `+String+` + +*Possible values:* see the xref:advanced-typography.adoc#currently-supported-languages[Currently supported languages] + +*Default value:* `+en-US+` + +.Example: Using `typography_default_langs` [source,js,subs="attributes+"] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html - menu: { tools: { title: 'Tools', items: 'code wordcount typography' }}, - plugins: 'typography', - toolbar: 'typography', - typography_default_lang: 'en-US', // Define the default language here, example: 'en-US' + selector: 'textarea', // change this value according to your HTML + plugins: '{plugincode}', + toolbar: '{plugincode}', + typography_default_lang: 'en-US' }); ---- @@ -23,22 +28,22 @@ tinymce.init({ This option tells the {pluginname} plugin to ignore content within specified HTML tags or within specified HTML tags that have specified attributes. -If an HTML tag or an HTML tag with a specified attribute is added to the `typography_ignore` array, the Typography plugin’s rules are not applied to material set within that tag. +If an HTML tag or an HTML tag with a specified attribute is added to the `typography_ignore` array, the Typography plugin's rules are not applied to material set within that tag. -*Type:* `+Array+` +*Type:* `+Array+` of `+Strings+` *Possible values:* `[ '', 'span[""]' ]` -*Default value:* none +*Default value:* `+[]+` -=== Example: Using `typography_ignore` +.Example: Using `typography_ignore` [source,js,subs="attributes+"] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: '{plugincode}', - toolbar: 'typography', + toolbar: '{plugincode}', typography_default_lang: 'en-US', typography_ignore: [ 'code', 'span["lang"]' ] }); @@ -53,12 +58,12 @@ This option allows the user to apply language-specific typography rules to parti When setting up `typography_langs` in {productname}, `lang` values — such as `+"en-US"+`, `+"de"+`, and `+"es"+` — populate the Advanced Typography language dropdown list for the user to select from when applying language-specific typography rules to the selected text. -=== Example: Using `typography_default_lang` +.Example: Using `typography_default_lang` [source,js,subs="attributes+"] ---- tinymce.init({ - selector: "textarea", // change this value according to your html + selector: "textarea", // change this value according to your HTML plugins: "typography", toolbar: "typography", typography_default_lang: [ "en-US", "de", "es" ], // Required to set specific typography language rules. @@ -71,18 +76,22 @@ tinymce.init({ This option sets which languages are available for applying language-specific typography rules. -A user can then select text and select from the available languages. That language’s language-specific typography rules are then applied to the selected text. +A user can then select text and select from the available languages. That language's language-specific typography rules are then applied to the selected text. -*Type:* `+Object+` +*Type:* `+Array+` of `+Strings+` -=== Example: Using `typography_langs` +*Possible values:* see the xref:advanced-typography.adoc#currently-supported-languages[Currently supported languages] + +*Default value:* `+[ 'be', 'bg', 'ca', 'cs', 'da', 'nl', 'en-GB', 'en-US', 'eo', 'et', 'fi', 'de', 'el', 'hu', 'ga', 'it', 'lv', 'no', 'pl', 'ro', 'ru', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'uk' ]+` + +.Example: Using `typography_langs` [source,js,subs="attributes+"] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: '{plugincode}', - toolbar: '{plugincode} language', + toolbar: '{plugincode}', typography_default_lang: 'en-US', typography_langs: [ 'en-US', @@ -96,92 +105,35 @@ tinymce.init({ [cols="1,1"] |=== -|Supported language |Language code - -|Belarusian -|be - -|Bulgarian -|bg - -|Catalan -|ca - -|Czech -|cs - -|Danish -|da - -|Dutch -|nl - -|English (UK) -|en-GB - -|English (US) -|en-US - -|Esperanto -|eo - -|Estonian -|et - -|Finnish -|fi - -|German -|de - -|Greek -|el - -|Hungarian -|hu - -|Irish -|ga - -|Italian -|it - -|Latvian -|lv - -|Norwegian -|no - -|Polish -|pl - -|Romanian -|ro - -|Russian -|ru - -|Servian -|sr - -|Slovak -|sk - -|Slovenian -|sl - -|Spanish -|es - -|Swedish -|sv - -|Turkish -|tr - -|Ukrainian -|uk - +| Supported language | Language code +| Belarusian | be +| Bulgarian | bg +| Catalan | ca +| Czech | cs +| Danish | da +| Dutch | nl +| English (UK) | en-GB +| English (US) | en-US +| Esperanto | eo +| Estonian | et +| Finnish | fi +| German | de +| Greek | el +| Hungarian | hu +| Irish | ga +| Italian | it +| Latvian | lv +| Norwegian | no +| Polish | pl +| Romanian | ro +| Russian | ru +| Serbian | sr +| Slovak | sk +| Slovenian | sl +| Spanish | es +| Swedish | sv +| Turkish | tr +| Ukrainian | uk |=== [[typography_rules]] @@ -193,17 +145,21 @@ The {pluginname} plugin rules are sourced from the https://github.com/typograf/t All rules supported by the {pluginname} plugin are documented in the https://github.com/typograf/typograf/blob/dev/docs/RULES.en-US.md[Rules of typograf]. -*Type:* `+Array+` +*Type:* `+Array+` of `+Strings+` + +*Possible values:* see the xref:advanced-typography.adoc#advanced-typography-plugin-rules[Advanced Typography Plugin Rules] -=== Example: Using `typography_rules` +*Default value:* `+undefined+` (all rules are applied) + +.Example: Using `typography_rules` [source,js,subs="attributes+"] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: '{plugincode}', toolbar: '{plugincode}', - typography_default_lang: 'en_US', // This is required to configure the default language used by typography. + typography_default_lang: 'en-US', typography_rules: [ 'common/punctuation/quote', 'en-US/dash/main', diff --git a/modules/ROOT/partials/configuration/advcode.adoc b/modules/ROOT/partials/configuration/advcode.adoc index 3a2847bddb..9e339dc267 100644 --- a/modules/ROOT/partials/configuration/advcode.adoc +++ b/modules/ROOT/partials/configuration/advcode.adoc @@ -3,13 +3,15 @@ include::partial$misc/admon-requires-6.3v.adoc[] -As part of the {productname} 6.3 release, the {pluginname} plugin includes a new option, `advcode_inline`, that allows users to open the Enhanced Code Editor within {productname}’s existing editor space instead of being displayed in a separate dialog box. +As part of the {productname} 6.3 release, the {pluginname} plugin includes a new option, `advcode_inline`, that allows users to open the Enhanced Code Editor within {productname}'s existing editor space instead of being displayed in a separate dialog box. -Type : `boolean`, +*Type:* `+Boolean+` + +*Possible values:* `+true+`, `+false+` -Default: false +*Default value:* `+false+` -== Example: basic setup +.Example: basic setup [source,js] ---- @@ -26,19 +28,19 @@ tinymce.init({ include::partial$misc/admon-requires-7.3v.adoc[] -As part of the {productname} 7.3 release, the {pluginname} plugin includes a new option, `advcode_prettify_getcontent`, which is set to `false` by default. +As part of the {productname} 7.3 release, the {pluginname} plugin includes a new option, `advcode_prettify_getcontent`, which is set to `+false+` by default. -When this option is set to `true` it will format the HTML code when `editor.getContent` is called. +When this option is set to `+true+` it will format the HTML code when `editor.getContent` is called. This is equivalent to retrieving formatted content by calling `+tinymce.activeEditor.getContent({ prettify: true })+`, regardless of the option's status. *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -== Example: basic setup +*Default value:* `+false+` + +.Example: basic setup [source,js] ---- @@ -58,17 +60,17 @@ If existing HTML content in the database is not well-formatted or has inconsiste include::partial$misc/admon-requires-7.3v.adoc[] -As part of the {productname} 7.3 release, the {pluginname} plugin includes a new option, `advcode_prettify_editor`, which is set to `true` by default. +As part of the {productname} 7.3 release, the {pluginname} plugin includes a new option, `advcode_prettify_editor`, which is set to `+true+` by default. By default, any code rendered inside **Enhanced Coded Editor** will be formatted with correct indentation. -Type : `boolean`, - -Default: `+true+` +*Type:* `+Boolean+` *Possible values:* `+true+`, `+false+` -== Example: basic setup +*Default value:* `+true+` + +.Example: basic setup [source,js] ---- @@ -81,4 +83,4 @@ tinymce.init({ ---- [NOTE] -To disable this default behavior, set the `advcode_prettify_editor` option to `false`. \ No newline at end of file +To disable this default behavior, set the `advcode_prettify_editor` option to `+false+`. \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/advlist_bullet_styles.adoc b/modules/ROOT/partials/configuration/advlist_bullet_styles.adoc index d58ac41fd4..ea7d05ec40 100644 --- a/modules/ROOT/partials/configuration/advlist_bullet_styles.adoc +++ b/modules/ROOT/partials/configuration/advlist_bullet_styles.adoc @@ -3,23 +3,23 @@ This option allows you to include specific unordered list item markers in the default `+bullist+` toolbar control. -*Type:* `+String+` - -*Default value:* `+'default,circle,square'+` +*Type:* A comma-separated `+String+` of list styles. *Possible values:* -* `+default+`: the browser’s default style +* `+default+`: the browser's default style * `+circle+`: a hollow circle * `+disc+`: a filled circle * `+square+`: a filled square -=== Example: using `+advlist_bullet_styles+` +*Default value:* `+'default,circle,square'+` + +.Example: using `+advlist_bullet_styles+` [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'lists advlist', toolbar: 'bullist', advlist_bullet_styles: 'square' // only include square bullets in list diff --git a/modules/ROOT/partials/configuration/advlist_number_styles.adoc b/modules/ROOT/partials/configuration/advlist_number_styles.adoc index 63d92fe1ba..83adecc08a 100644 --- a/modules/ROOT/partials/configuration/advlist_number_styles.adoc +++ b/modules/ROOT/partials/configuration/advlist_number_styles.adoc @@ -3,20 +3,20 @@ This option allows you to include specific ordered list item markers in the default `+numlist+` toolbar control. -*Type:* `+String+` - -*Default value:* `+'default,lower-alpha,lower-greek,lower-roman,upper-alpha,upper-roman'+` +*Type:* A comma-separated `+String+` of list styles. *Possible values:* * `+default+`: the browser's default style -* `+lower-alpha+`: lowercase ASCII letters, e.g. a, b, c, ... z +* `+lower-alpha+`: lowercase ASCII letters, e.g. a, b, c, ... z, aa, ab, ac ... * `+lower-greek+`: lowercase classical Greek (alpha, beta, gamma), e.g. α, β, γ ... * `+lower-roman+`: lowercase roman numerals, e.g. i, ii, iii, iv, v ... -* `+upper-alpha+`: uppercase ASCII letters, e.g. A, B, C, ... Z +* `+upper-alpha+`: uppercase ASCII letters, e.g. A, B, C, ... Z, AA, AB, AC ... * `+upper-roman+`: uppercase roman numerals, e.g. I, II, III, IV, V ... -=== Example: using `+advlist_number_styles+` +*Default value:* `+'default,lower-alpha,lower-greek,lower-roman,upper-alpha,upper-roman'+` + +.Example: using `+advlist_number_styles+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/advtable_value_series.adoc b/modules/ROOT/partials/configuration/advtable_value_series.adoc index b13fb1cf3f..1162d221bf 100644 --- a/modules/ROOT/partials/configuration/advtable_value_series.adoc +++ b/modules/ROOT/partials/configuration/advtable_value_series.adoc @@ -48,13 +48,14 @@ Each top-level properties of the `advtable_value_series` object are used as the [cols="1,2,1,4",options="header"] |=== -|Name |Value |Requirement |Description -|title |`+string+` |Required |The text shown in the UI for the series. -|update |`+boolean+` |Optional |default: `+false+` - When `+true+`, the series values will be updated when changes are made to the table. -|resizable |`+boolean+` |Optional |default: `+true+` - When `+true+`, table cells containing the series values can be resized using a mouse or touch device. -|generator |`+(info: GeneratorInfo, rowIndex: number, columnIndex: number) => GeneratorResult+` |Required |For details on creating a value series generator, see: xref:advtable.adoc#creating-a-value-series-generator[Creating a value series generator]. +| Name | Value | Requirement | Description +| title | `+String+` | Required | The text shown in the UI for the series. +| update | `+Boolean+` | Optional | default: `+false+` - When `+true+`, the series values will be updated when changes are made to the table. +| resizable | `+Boolean+` | Optional | default: `+true+` - When `+true+`, table cells containing the series values can be resized using a mouse or touch device. +| generator | `+(info: GeneratorInfo, rowIndex: number, columnIndex: number) => GeneratorResult+` | Required | For details on creating a value series generator, see: xref:advtable.adoc#creating-a-value-series-generator[Creating a value series generator]. |=== + [[creating-a-value-series-generator]] ==== Creating a value series generator @@ -69,13 +70,13 @@ An object with the following properties is passed to the generator callback func [cols="1,2,4",options="header"] |=== -|Name |Value |Description -|sectionType |`+'thead'+`, `+'tbody'+` or `+'tfoot'+` |The section of the table cell. -|cellType |`+'td'+` or `+'th'+` |The type of the table cell. -|getRowType |`+() => 'header' \| 'body' \| 'footer'+` | A function that returns the type of row the table cell is part of. A 'header' row is either a row that is part of a `thead` section or contains all `th` cells. -|classes |`+string[]+` |The classes present on the table cell. -|direction |`+'row'+` or `+'column'+` |The direction of the generator. -|prev |`+GeneratorResult+` |The generator result from the previous iteration. +| Name | Value | Description +| sectionType | `+'thead'+`, `+'tbody'+` or `+'tfoot'+` | The section of the table cell. +| cellType | `+'td'+` or `+'th'+` | The type of the table cell. +| getRowType | `+() => 'header' \| 'body' \| 'footer'+` | A function that returns the type of row the table cell is part of. A 'header' row is either a row that is part of a `thead` section or contains all `th` cells. +| classes | `+Array+` of `+Strings+` | The classes present on the table cell. +| direction | `+'row'+` or `+'column'+` | The direction of the generator. +| prev | `+GeneratorResult+` | The generator result from the previous iteration. |=== [[generatorresult]] @@ -85,18 +86,19 @@ The generator callback function should return an object with the following prope [cols="1,1,1,4",options="header"] |=== -|Name |Value |Requirement |Description -|classes |`+string[]+` |Optional |The classes to be applied to the table cell. -|attributes |`+Object+` |Optional |The attributes to be applied to the table cell. The `+attributes+` should be provided as an object where each key is an attribute and each value is of type `+string+`, `+boolean+`, `+number+`, or `+null+`. A value of `+null+` for an attribute will remove the attribute from the table cell. -|value |`+string+`, `+number+` or `+undefined+` |Optional |The value of the table cell. If the value is `+undefined+`, the editor will use the previous value of the table cell. +| Name | Value | Requirement | Description +| classes | `+Array+` of `+Strings+` | Optional | The classes to be applied to the table cell. +| attributes | `+Object+` | Optional | The attributes to be applied to the table cell. The `+attributes+` should be provided as an object where each key is an attribute and each value is of type `+String+`, `+Boolean+`, `+Number+`, or `+null+`. A value of `+null+` for an attribute will remove the attribute from the table cell. +| value | `+String+`, `+Number+` or `+undefined+` | Optional | The value of the table cell. If the value is `+undefined+`, the editor will use the previous value of the table cell. |=== -=== Example: using `+advtable_value_series+` + +.Example: using `+advtable_value_series+` [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'table advtable', toolbar: 'advtablerownumbering', advtable_value_series: { @@ -112,12 +114,12 @@ tinymce.init({ }); ---- -=== Example: using a custom generator to exclude header and footer rows from row numbering +.Example: using a custom generator to exclude header and footer rows from row numbering [source,js] ---- tinymce.init({ - selector: "textarea", // change this value according to your html + selector: "textarea", // change this value according to your HTML plugins: 'table advtable', toolbar: "table advtablerownumbering", advtable_value_series: { diff --git a/modules/ROOT/partials/configuration/advtemplate_create_category.adoc b/modules/ROOT/partials/configuration/advtemplate_create_category.adoc index d0773614bc..ebb2dc6b89 100644 --- a/modules/ROOT/partials/configuration/advtemplate_create_category.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_create_category.adoc @@ -8,24 +8,24 @@ The plugin uses the `advtemplate_create_category` asynchronous function to creat *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+title+` | `+string+` | required | The title of the category. +| Field | Type | Required? | Description +| `+title+` | `+String+` | required | The title of the category. |=== *Return data:* [cols="1,1,3",options="header"] |=== -|Field |Type |Description -|`+id+` | `+string+` | The id of the newly created category. +| Field | Type | Description +| `+id+` | `+String+` | The ID of the newly created category. |=== -=== Example: using `advtemplate_create_category` +.Example: using `advtemplate_create_category` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_create_category: (title) => fetch('/categories', { method: 'POST', diff --git a/modules/ROOT/partials/configuration/advtemplate_create_template.adoc b/modules/ROOT/partials/configuration/advtemplate_create_template.adoc index f42e41f791..94adae9dd3 100644 --- a/modules/ROOT/partials/configuration/advtemplate_create_template.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_create_template.adoc @@ -8,26 +8,26 @@ The plugin uses the `advtemplate_create_template` asynchronous function to creat *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+title+` | `+string+` | required | The title of the template. -|`+content+` | `+string+` | required | The content of the template. -|`+categoryId+` | `+string+` | optional | The parent category id. +| Field | Type | Required? | Description +| `+title+` | `+String+` | required | The title of the template. +| `+content+` | `+String+` | required | The content of the template. +| `+categoryId+` | `+String+` | optional | The parent category ID\. |=== *Return data:* [cols="1,1,3",options="header"] |=== -|Field |Type |Description -|`+id+` | `+string+` | The id of newly created template. +| Field | Type | Description +| `+id+` | `+String+` | The ID of newly created template. |=== -=== Example: using `advtemplate_create_template` +.Example: using `advtemplate_create_template` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_create_template: (title, content, categoryId) => fetch('/templates', { method: 'POST', diff --git a/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc b/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc index bc15c03c54..3c09bde65c 100644 --- a/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc @@ -8,20 +8,20 @@ The plugin uses the `advtemplate_delete_category` asynchronous function to delet *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+id+` | `+string+` | required | The id of the category to delete. +| Field | Type | Required? | Description +| `+id+` | `+String+` | required | The ID of the category to delete. |=== *Return data:* Empty object `{}` -=== Example: using `advtemplate_delete_category` +.Example: using `advtemplate_delete_category` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_delete_category: (id) => fetch('/categories/' + id, { method: 'DELETE', diff --git a/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc b/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc index 641be4f857..f78c553a85 100644 --- a/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc @@ -8,20 +8,20 @@ The plugin uses the `advtemplate_delete_template` asynchronous function to delet *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+id+` | `+string+` | required | The id of the template to delete. +| Field | Type | Required? | Description +| `+id+` | `+String+` | required | The ID of the template to delete. |=== *Return data:* Empty object `{}` -=== Example: using `advtemplate_delete_template` +.Example: using `advtemplate_delete_template` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_delete_template: (id) => fetch('/templates/' + id, { method: 'DELETE', diff --git a/modules/ROOT/partials/configuration/advtemplate_get_template.adoc b/modules/ROOT/partials/configuration/advtemplate_get_template.adoc index 1ea8167d1b..9004fb91e4 100644 --- a/modules/ROOT/partials/configuration/advtemplate_get_template.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_get_template.adoc @@ -8,27 +8,27 @@ The plugin uses the `advtemplate_get_template` asynchronous function to get a te *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+id+` | `+string+` | required | The id of the template to get. +| Field | Type | Required? | Description +| `+id+` | `+String+` | required | The ID of the template to get. |=== *Return data:* [cols="1,1,3",options="header"] |=== -|Field |Type |Description -|`+id+` | `+string+` | The id of the template. -|`+title+` | `+string+` | The title of the template. -|`+content+` | `+string+` | The content of the template. +| Field | Type | Description +| `+id+` | `+String+` | The ID of the template. +| `+title+` | `+String+` | The title of the template. +| `+content+` | `+String+` | The content of the template. |=== -=== Example: using `advtemplate_get_template` +.Example: using `advtemplate_get_template` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_get_template: (id) => fetch('/templates/' + id, { method: 'GET', diff --git a/modules/ROOT/partials/configuration/advtemplate_list.adoc b/modules/ROOT/partials/configuration/advtemplate_list.adoc index 34148ff307..d772565638 100644 --- a/modules/ROOT/partials/configuration/advtemplate_list.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_list.adoc @@ -1,22 +1,21 @@ [[advtemplate_list]] == `advtemplate_list` -The plugin uses the `advtemplate_list` asynchronous function to retreive the template list. +The plugin uses the `advtemplate_list` asynchronous function to retrieve the template list. *Type:* `+Function+` (Returns a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise[Promise]) -*Input parameters:* -None +*Input parameters:* None -*Return data:* `+Array+` +*Return data:* `+Array+` of `+Objects+` -=== Example: using `advtemplate_list` +.Example: using `advtemplate_list` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_list: () => fetch('/categories', { method: 'GET', @@ -39,14 +38,16 @@ The data returned by `advtemplate_list` must adhere to the following requirement [source,js] ---- -[{ +[ + { id: '1', title: 'Resolving tickets', }, { id: '2', title: 'Quick replies', - items: [{ + items: [ + { id: '3', title: 'Message received', }, diff --git a/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc b/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc index 840931b590..65d3694dd5 100644 --- a/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc @@ -8,21 +8,20 @@ The plugin uses the `advtemplate_move_category_items` asynchronous function to m *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+oldCategoryId+` | `+string+` | required | The id of the source category . -|`+newCategoryId+` | `+string+` | optional | The id of the destination category. +| Field | Type | Required? | Description +| `+oldCategoryId+` | `+String+` | required | The ID of the source category. +| `+newCategoryId+` | `+String+` | optional | The ID of the destination category. |=== -*Return data:* -Empty object `{}` +*Return data:* Empty object `{}` -=== Example: using `advtemplate_move_category_itmes` +.Example: using `advtemplate_move_category_itmes` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_move_category_items: (oldCategoryId, newCategoryId) => fetch('/categories/' + oldCategoryId, { method: 'PATCH', diff --git a/modules/ROOT/partials/configuration/advtemplate_move_template.adoc b/modules/ROOT/partials/configuration/advtemplate_move_template.adoc index 640c2fac1d..a9814560f4 100644 --- a/modules/ROOT/partials/configuration/advtemplate_move_template.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_move_template.adoc @@ -8,21 +8,20 @@ The plugin uses the `advtemplate_move_template` asynchronous function to move th *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+templateId+` | `+string+` | required | The id of the template to move . -|`+newCategoryId+` | `+string+` | optional | The id of the destination category. +| Field | Type | Required? | Description +| `+templateId+` | `+String+` | required | The ID of the template to move. +| `+newCategoryId+`| `+String+` | optional | The ID of the destination category. |=== -*Return data:* -Empty object `{}` +*Return data:* Empty object `{}` -=== Example: using `advtemplate_move_template` +.Example: using `advtemplate_move_template` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_move_template: (templateId) => fetch('/templates/' + templateId, { method: 'PATCH', diff --git a/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc b/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc index 2e69c8d551..0e7f61a43f 100644 --- a/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc @@ -8,21 +8,20 @@ The plugin uses the `advtemplate_rename_category` asynchronous function to renam *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+id+` | `+string+` | required | The id of the category to rename. -|`+title+` | `+string+` | required | New category title. +| Field | Type | Required? | Description +| `+id+` | `+String+` | required | The ID of the category to rename. +| `+title+`| `+String+` | required | New category title. |=== -*Return data:* -Empty object `{}` +*Return data:* Empty object `{}` -=== Example: using `advtemplate_rename_category` +.Example: using `advtemplate_rename_category` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_rename_category: (id, title) => fetch('/categories/' + id, { method: 'PUT', diff --git a/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc b/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc index 895bc6a4b3..c3b90eb7f1 100644 --- a/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc @@ -8,21 +8,20 @@ The plugin uses the `advtemplate_rename_template` asynchronous function to renam *Input parameters:* [cols="1,1,1,3",options="header"] |=== -|Field |Type |Required? |Description -|`+id+` | `+string+` | required | The id of the template to rename. -|`+title+` | `+string+` | required | New template title. +| Field | Type | Required? | Description +| `+id+` | `+String+` | required | The ID of the template to rename. +| `+title+` | `+String+` | required | New template title. |=== -*Return data:* -Empty object `{}` +*Return data:* Empty object `{}` -=== Example: using `advtemplate_rename_template` +.Example: using `advtemplate_rename_template` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: ["advtemplate"], + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', advtemplate_rename_template: (id, title) => fetch('/templates/' + id, { method: 'PUT', diff --git a/modules/ROOT/partials/configuration/advtemplate_templates.adoc b/modules/ROOT/partials/configuration/advtemplate_templates.adoc index 260c73a89c..25f468e0c6 100644 --- a/modules/ROOT/partials/configuration/advtemplate_templates.adoc +++ b/modules/ROOT/partials/configuration/advtemplate_templates.adoc @@ -3,7 +3,7 @@ This option lets you specify a static list of predefined templates that can be inserted using the _Templates_ dialog. It is for scenarios where the provided template list is unchangeable. In this use-case, there is no need to set up a persistent template store and provide a more complex plugin configuration. -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` The template list assigned to the `advtemplate_templates` option must adhere to the following requirements: @@ -12,14 +12,16 @@ The template list assigned to the `advtemplate_templates` option must adhere to . Each category item is required to include a `items` sublist, which can be empty. . Category items must not contain nested subcategories. -=== Example: using `advtemplate_templates` +*Default value:* `+undefined+` + +.Example: using `advtemplate_templates` [source,js] ---- tinymce.init({ - selector: 'textarea#advtemplate', // change this value according to your html - plugins: "advtemplate", - toolbar: "inserttemplate", + selector: 'textarea', // change this value according to your HTML + plugins: 'advtemplate', + toolbar: 'inserttemplate', advtemplate_templates: [ { title: 'Template 1', diff --git a/modules/ROOT/partials/configuration/ai_request.adoc b/modules/ROOT/partials/configuration/ai_request.adoc index badb897832..1b95be5ab3 100644 --- a/modules/ROOT/partials/configuration/ai_request.adoc +++ b/modules/ROOT/partials/configuration/ai_request.adoc @@ -13,7 +13,7 @@ NOTE: This option is required to use the {pluginname} plugin. *Type:* `+Function+` -=== Example: using `ai_request` to interface with the OpenAI Completions API +.Example: using `ai_request` to interface with the OpenAI Completions API [source,js] ---- diff --git a/modules/ROOT/partials/configuration/ai_shortcuts.adoc b/modules/ROOT/partials/configuration/ai_shortcuts.adoc index c3fdc64ac1..83bb6603d8 100644 --- a/modules/ROOT/partials/configuration/ai_shortcuts.adoc +++ b/modules/ROOT/partials/configuration/ai_shortcuts.adoc @@ -70,12 +70,12 @@ The default {pluginname} shortcuts are only available in English. They have not Also, the default {pluginname} shortcuts are subject to change. If you prefer to keep these shortcuts, include them within your integration. ==== -=== Example: using `ai_shortcuts` to present a customized set of {pluginname} shortcuts +.Example: using `ai_shortcuts` to present a customized set of {pluginname} shortcuts [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your html + selector: 'textarea', // change this value according to your HTML plugins: 'ai', toolbar: 'aidialog aishortcuts', ai_request: (request, respondWith) => respondWith.string(() => Promise.reject("See docs to implement AI Assistant")), @@ -98,9 +98,9 @@ tinymce.init({ }); ---- -=== Example: disabling `ai_shortcuts` +To disable the {pluginname} shortcuts menu and toolbar options, set `ai_shortcuts` to `+false+` (or to `+[]+`, an empty array). -To disable the {pluginname} shortcuts menu and toolbar options, set `ai_shortcuts` to `false` (or to `+[]+`, an empty array). +.Example: disabling `ai_shortcuts` with `+false+` [source,js] ---- @@ -110,6 +110,8 @@ tinymce.init({ }); ---- +.Example: disabling `ai_shortcuts` with an empty array + [source,js] ---- tinymce.init({ diff --git a/modules/ROOT/partials/configuration/allow_conditional_comments.adoc b/modules/ROOT/partials/configuration/allow_conditional_comments.adoc index f558947cd5..a970863aef 100644 --- a/modules/ROOT/partials/configuration/allow_conditional_comments.adoc +++ b/modules/ROOT/partials/configuration/allow_conditional_comments.adoc @@ -5,11 +5,11 @@ This option allows you to specify whether the editor should parse and keep condi *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+allow_conditional_comments+` +*Default value:* `+false+` + +.Example: using `+allow_conditional_comments+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/allow_html_in_named_anchor.adoc b/modules/ROOT/partials/configuration/allow_html_in_named_anchor.adoc index 66f09c2afe..ad3a67bda3 100644 --- a/modules/ROOT/partials/configuration/allow_html_in_named_anchor.adoc +++ b/modules/ROOT/partials/configuration/allow_html_in_named_anchor.adoc @@ -5,11 +5,11 @@ This option allows you to specify whether the editor should parse and keep `+htm *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+allow_html_in_named_anchor+` +*Default value:* `+false+` + +.Example: using `+allow_html_in_named_anchor+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/allow_mathml_annotation_encodings.adoc b/modules/ROOT/partials/configuration/allow_mathml_annotation_encodings.adoc index 13cbd55551..01435d15a0 100644 --- a/modules/ROOT/partials/configuration/allow_mathml_annotation_encodings.adoc +++ b/modules/ROOT/partials/configuration/allow_mathml_annotation_encodings.adoc @@ -7,7 +7,7 @@ This option allows a specific list of valid MathML annotation encodings to be us *Default value:* `+[]+` (empty array) -=== Example: using `+allow_mathml_annotation_encodings+` +.Example: using `+allow_mathml_annotation_encodings+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/allow_script_urls.adoc b/modules/ROOT/partials/configuration/allow_script_urls.adoc index 6dc50ab2ac..001bd9a462 100644 --- a/modules/ROOT/partials/configuration/allow_script_urls.adoc +++ b/modules/ROOT/partials/configuration/allow_script_urls.adoc @@ -5,11 +5,11 @@ Enabling this option will allow `+javascript: urls+` in links and images. This i *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+allow_script_urls+` +*Default value:* `+false+` + +.Example: using `+allow_script_urls+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/allow_unsafe_link_target.adoc b/modules/ROOT/partials/configuration/allow_unsafe_link_target.adoc index fb509f7ffa..bfaa881eda 100644 --- a/modules/ROOT/partials/configuration/allow_unsafe_link_target.adoc +++ b/modules/ROOT/partials/configuration/allow_unsafe_link_target.adoc @@ -7,11 +7,11 @@ By default all links with a `+target+` of _{blanktarget}_ will get a `+rel+` att *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+allow_unsafe_link_target+` +*Default value:* `+false+` + +.Example: using `+allow_unsafe_link_target+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/anchor_bottom.adoc b/modules/ROOT/partials/configuration/anchor_bottom.adoc index 74f5f3f741..cff8f320e8 100644 --- a/modules/ROOT/partials/configuration/anchor_bottom.adoc +++ b/modules/ROOT/partials/configuration/anchor_bottom.adoc @@ -1,13 +1,13 @@ [[anchor_bottom]] == `anchor_bottom` -Lets you specify a custom name for the bottom anchor in the url type ahead drop down. To disable the bottom anchor from the drop down set it `+false+`. +Lets you specify a custom name for the bottom anchor in the URL type ahead drop down. To disable the bottom anchor from the drop down set it `+false+`. -*Type:* `+String+` +*Type:* `+String+` or `+false+` *Default value:* `+'#bottom'+` -=== Example of custom value +.Example: using `anchor_bottom` [source,js] ---- @@ -17,7 +17,7 @@ tinymce.init({ }); ---- -=== Example of disabling +.Example: disabling the bottom anchor [source,js] ---- diff --git a/modules/ROOT/partials/configuration/anchor_top.adoc b/modules/ROOT/partials/configuration/anchor_top.adoc index 765077c959..485ee17215 100644 --- a/modules/ROOT/partials/configuration/anchor_top.adoc +++ b/modules/ROOT/partials/configuration/anchor_top.adoc @@ -1,13 +1,13 @@ [[anchor_top]] == `anchor_top` -Lets you specify a custom name for the top anchor in the url type ahead drop down. To disable the to anchor from the drop down set it `+false+`. +Lets you specify a custom name for the top anchor in the URL type ahead drop down. To disable the to anchor from the drop down set it `+false+`. -*Type:* `+String+` +*Type:* `+String+` or `+false+` *Default value:* `+'#top'+` -=== Example of custom value +.Example: using `anchor_top` [source,js] ---- @@ -17,7 +17,7 @@ tinymce.init({ }); ---- -=== Example of disabling +.Example: disabling the top anchor [source,js] ---- diff --git a/modules/ROOT/partials/configuration/audio_template_callback.adoc b/modules/ROOT/partials/configuration/audio_template_callback.adoc index e0d15bc7cf..c9e01b6e67 100644 --- a/modules/ROOT/partials/configuration/audio_template_callback.adoc +++ b/modules/ROOT/partials/configuration/audio_template_callback.adoc @@ -5,7 +5,9 @@ This option allows you to specify the function that will return the HTML embed c *Type:* `+Function+` -=== Example: using `+audio_template_callback+` +*Default value:* `+undefined+` + +.Example: using `+audio_template_callback+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/auto_focus.adoc b/modules/ROOT/partials/configuration/auto_focus.adoc index 895abca7be..b0a967bf37 100644 --- a/modules/ROOT/partials/configuration/auto_focus.adoc +++ b/modules/ROOT/partials/configuration/auto_focus.adoc @@ -1,11 +1,13 @@ [[auto_focus]] == `+auto_focus+` -Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance id is the id for the original `+textarea+` or `+div+` element that got replaced. +Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance ID is the ID for the original `+textarea+` or `+div+` element that got replaced. If you set this option to `+true+`, the focus will be set to the last initialized editor instance. -*Type:* `+String+` +*Type:* `+String+` or `+true+` -=== Example: using `+auto_focus+` +*Default value:* `+undefined+` + +.Example: using `+auto_focus+` with custom `+id+` [source,js] ---- @@ -14,3 +16,13 @@ tinymce.init({ auto_focus: 'element1' }); ---- + +.Example: using `+auto_focus+` with `+true+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', // change this value according to your HTML + auto_focus: true +}); +---- \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/autocorrect_autocorrect.adoc b/modules/ROOT/partials/configuration/autocorrect_autocorrect.adoc index a7eb8f438e..08bfdb6685 100644 --- a/modules/ROOT/partials/configuration/autocorrect_autocorrect.adoc +++ b/modules/ROOT/partials/configuration/autocorrect_autocorrect.adoc @@ -1,19 +1,19 @@ [[autocorrect_autocorrect]] == `+autocorrect_autocorrect+` -This option enables or disables spelling error autocorrection when the {productname} editor is loaded. +This option enables or disables spelling error auto-correction when the {productname} editor is loaded. -When set to `true`, spelling error autocorrection is enabled when {productname} is initialized. +When set to `+true+`, spelling error auto-correction is enabled when {productname} is initialized. include::partial$misc/autocorrect-options-notes.adoc[] *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+autocorrect_autocorrect+` +*Default value:* `+true+` + +.Example: using `+autocorrect_autocorrect+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autocorrect_capitalize.adoc b/modules/ROOT/partials/configuration/autocorrect_capitalize.adoc index a9c2e0c97b..d9698f6b24 100644 --- a/modules/ROOT/partials/configuration/autocorrect_capitalize.adoc +++ b/modules/ROOT/partials/configuration/autocorrect_capitalize.adoc @@ -3,17 +3,17 @@ This option enables or disables capitalization autocorrection when the {productname} editor is loaded. -When set to `true`, capitalization autocorrection is enabled when {productname} is initialized. +When set to `+true+`, capitalization autocorrection is enabled when {productname} is initialized. include::partial$misc/autocorrect-options-notes.adoc[] *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+autocorrect_capitalize+` +*Default value:* `+false+` + +.Example: using `+autocorrect_capitalize+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autocorrect_service_url.adoc b/modules/ROOT/partials/configuration/autocorrect_service_url.adoc index 3af2c91102..e93016665d 100644 --- a/modules/ROOT/partials/configuration/autocorrect_service_url.adoc +++ b/modules/ROOT/partials/configuration/autocorrect_service_url.adoc @@ -5,11 +5,14 @@ This option specifies the URL of the server-side `+ephox-spelling+` service. For instructions on how to set up a Spellchecking server-side component, see: the xref:introduction-to-premium-selfhosted-services.adoc[server-side component installation guide]. -NOTE: `autocorrect_service_url` is *not* required when enabling this plugin via xref:editor-and-features.adoc[{cloudname}]. +[NOTE] +==== +`autocorrect_service_url` is *not* required when enabling this plugin via xref:editor-and-features.adoc[{cloudname}]. +==== *Type:* `+String+` -=== Example: using `+autocorrect_service_url+` +.Example: using `+autocorrect_service_url+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/automatic_uploads.adoc b/modules/ROOT/partials/configuration/automatic_uploads.adoc index c4ec5bf2a9..27fe36c487 100644 --- a/modules/ROOT/partials/configuration/automatic_uploads.adoc +++ b/modules/ROOT/partials/configuration/automatic_uploads.adoc @@ -3,15 +3,18 @@ Enable or disable automatic upload of images represented by data URLs or blob URIs. Such images get generated, for example, as a result of image manipulation through the xref:editimage.adoc[Image Editing] plugin, or after image is drag-n-dropped onto the editor from the desktop. -NOTE: This option will do nothing if `+images_upload_url+` or `+images_upload_handler+` is not specified. +[NOTE] +==== +This option will do nothing if `+images_upload_url+` or `+images_upload_handler+` is not specified. +==== *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+automatic_uploads+` +*Default value:* `+true+` + +.Example: using `+automatic_uploads+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc b/modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc index 780e92df8f..015622e66e 100644 --- a/modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc +++ b/modules/ROOT/partials/configuration/autoresize_bottom_margin.adoc @@ -5,7 +5,9 @@ This option allows you to specify the size of the `+padding+` at the bottom of t *Type:* `+Number+` -=== Example: using `+autoresize_bottom_margin+` +*Default value:* `+50+` + +.Example: using `+autoresize_bottom_margin+` [source,js] ---- @@ -18,7 +20,7 @@ tinymce.init({ As of version 6.3, `autoresize_bottom_margin` must be set to a value below the `+margin-bottom+` property of any content CSS, else it will be ignored and set to `+0+`. -=== Example: setting `+autoresize_bottom_margin+` to zero because `+margin-bottom+` is set elsewhere +.Example: setting `+autoresize_bottom_margin+` to zero because `+margin-bottom+` is set elsewhere [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autoresize_overflow_padding.adoc b/modules/ROOT/partials/configuration/autoresize_overflow_padding.adoc index 25275c4c25..f6f0f12ffc 100644 --- a/modules/ROOT/partials/configuration/autoresize_overflow_padding.adoc +++ b/modules/ROOT/partials/configuration/autoresize_overflow_padding.adoc @@ -5,7 +5,9 @@ This option allows you to specify the size of the `+padding+` at the sides of th *Type:* `+Number+` -=== Example: `+autoresize_overflow_padding+` +*Default value:* `+1+` + +.Example: `+autoresize_overflow_padding+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autosave_ask_before_unload.adoc b/modules/ROOT/partials/configuration/autosave_ask_before_unload.adoc index a8ddc91149..31b73974bc 100644 --- a/modules/ROOT/partials/configuration/autosave_ask_before_unload.adoc +++ b/modules/ROOT/partials/configuration/autosave_ask_before_unload.adoc @@ -5,11 +5,11 @@ This option allows you to set whether the editor should prompt the user to advis *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+autosave_ask_before_unload+` +*Default value:* `+true+` + +.Example: using `+autosave_ask_before_unload+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autosave_interval.adoc b/modules/ROOT/partials/configuration/autosave_interval.adoc index 0c1c956fae..0d20ce2e3f 100644 --- a/modules/ROOT/partials/configuration/autosave_interval.adoc +++ b/modules/ROOT/partials/configuration/autosave_interval.adoc @@ -7,7 +7,7 @@ This option enables you to specify the time the editor should wait between takin *Default value:* `+'30s'+` -=== Example: using `+autosave_interval+` +.Example: using `+autosave_interval+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autosave_prefix.adoc b/modules/ROOT/partials/configuration/autosave_prefix.adoc index a582005467..063c815143 100644 --- a/modules/ROOT/partials/configuration/autosave_prefix.adoc +++ b/modules/ROOT/partials/configuration/autosave_prefix.adoc @@ -5,15 +5,15 @@ This option allows you to set the prefix that is used for local storage keys. *Type:* `+String+` -*Default value:* `+'tinymce-autosave-{path}{query}-{id}-'+` +*Default value:* `+'tinymce-autosave-{path}{query}{hash}-{id}-'+` -=== Example: using `+autosave_prefix+` +.Example: using `+autosave_prefix+` [source,js] ---- tinymce.init({ selector: 'textarea', // change this value according to your HTML plugins: 'autosave', - autosave_prefix: 'tinymce-autosave-{path}{query}-{id}-' + autosave_prefix: 'tinymce-autosave-{path}{query}{hash}-{id}-' }); ---- diff --git a/modules/ROOT/partials/configuration/autosave_restore_when_empty.adoc b/modules/ROOT/partials/configuration/autosave_restore_when_empty.adoc index 461b317219..7bf7b5cc50 100644 --- a/modules/ROOT/partials/configuration/autosave_restore_when_empty.adoc +++ b/modules/ROOT/partials/configuration/autosave_restore_when_empty.adoc @@ -1,15 +1,15 @@ [[autosave_restore_when_empty]] == `+autosave_restore_when_empty+` -This option enables you to specify if {productname} should automatically restore the content stored in local storage when the editor is empty on initialization. This can be useful for users who don't know that they can restore lost work if the browser crashed by selecting `+Restore last draft+` from the `+File+` menu. +This option enables you to specify if {productname} should automatically restore the content stored in local storage when the editor is empty on initialization. This can be useful for users who don't know that they can restore lost work if the browser crashed by selecting menu:File[Restore last draft]. *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+autosave_restore_when_empty+` +*Default value:* `+false+` + +.Example: using `+autosave_restore_when_empty+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/autosave_retention.adoc b/modules/ROOT/partials/configuration/autosave_retention.adoc index 429ee725c0..8fec778330 100644 --- a/modules/ROOT/partials/configuration/autosave_retention.adoc +++ b/modules/ROOT/partials/configuration/autosave_retention.adoc @@ -7,7 +7,7 @@ This option lets you to specify the duration editor content should remain in loc *Default value:* `+'20m'+` -=== Example: using `+autosave_retention+` +.Example: using `+autosave_retention+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/base_url.adoc b/modules/ROOT/partials/configuration/base_url.adoc index 1f331b4509..1ae62a12c4 100644 --- a/modules/ROOT/partials/configuration/base_url.adoc +++ b/modules/ROOT/partials/configuration/base_url.adoc @@ -7,7 +7,7 @@ By default, the `+base_url+` is the directory containing {productname} javascrip *Type:* `+String+` -=== Example: using `+base_url+` +.Example: using `+base_url+` [source,js,subs="attributes+"] ---- diff --git a/modules/ROOT/partials/configuration/block_formats.adoc b/modules/ROOT/partials/configuration/block_formats.adoc index f7e9ced8f9..065bf9ddc7 100644 --- a/modules/ROOT/partials/configuration/block_formats.adoc +++ b/modules/ROOT/partials/configuration/block_formats.adoc @@ -5,9 +5,9 @@ This option defines the formats to be displayed in the `+blocks+` dropdown toolb *Type:* `+String+` -*Default value:* `+'Paragraph=p; Heading 1=h1; Heading 2=h2; Heading 3=h3; Heading 4=h4; Heading 5=h5; Heading 6=h6;+` +*Default value:* `+'Paragraph=p; Heading 1=h1; Heading 2=h2; Heading 3=h3; Heading 4=h4; Heading 5=h5; Heading 6=h6; Preformatted=pre'+` -=== Example: using `+block_formats+` +.Example: using `+block_formats+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/block_unsupported_drop.adoc b/modules/ROOT/partials/configuration/block_unsupported_drop.adoc index 03e578f996..ca036bcda1 100644 --- a/modules/ROOT/partials/configuration/block_unsupported_drop.adoc +++ b/modules/ROOT/partials/configuration/block_unsupported_drop.adoc @@ -5,11 +5,11 @@ When the `+block_unsupported_drop+` option is set to `+true+`, the editor blocks *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+block_unsupported_drop+` +*Default value:* `+true+` + +.Example: using `+block_unsupported_drop+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/body_class.adoc b/modules/ROOT/partials/configuration/body_class.adoc index 728fd98093..49ef5a15e9 100644 --- a/modules/ROOT/partials/configuration/body_class.adoc +++ b/modules/ROOT/partials/configuration/body_class.adoc @@ -5,10 +5,12 @@ Use the `+body_class+` option to add a class to the body of each editor instance *Type:* `+String+` -=== Example: using `+body_class+` +*Default value:* `+''+` This will add the same class to all editors that gets created by the `+init+` call. +.Example: using `+body_class+` + [source,js] ---- tinymce.init({ @@ -19,6 +21,8 @@ tinymce.init({ This will set specific classes on the bodies of specific editors. +.Example: using `+body_class+` with multiple classes + [source,js] ---- tinymce.init({ diff --git a/modules/ROOT/partials/configuration/body_id.adoc b/modules/ROOT/partials/configuration/body_id.adoc index 67cf2bf56b..b761dffe67 100644 --- a/modules/ROOT/partials/configuration/body_id.adoc +++ b/modules/ROOT/partials/configuration/body_id.adoc @@ -1,13 +1,15 @@ [[body_id]] == `+body_id+` -This option enables you to specify an id for the body of each editor instance. This id can then be used to do {productname} specific overrides in your `+content_css+`. +This option enables you to specify an ID for the body of each editor instance. This ID can then be used to do {productname} specific overrides in your `+content_css+`. *Type:* `+String+` -=== Example: using `+body_id+` +*Default value:* `+'tinymce'+` -This will add the same id to all editors that gets created by the `+init+` call. +This will add the same ID to all editors that gets created by the `+init+` call. + +.Example: using `+body_id+` [source,js] ---- @@ -19,6 +21,8 @@ tinymce.init({ This will set specific ids on the bodies of specific editors. +.Example: using `+body_id+` with multiple IDs + [source,js] ---- tinymce.init({ diff --git a/modules/ROOT/partials/configuration/br_in_pre.adoc b/modules/ROOT/partials/configuration/br_in_pre.adoc index d18d843ba8..492dff9a9f 100644 --- a/modules/ROOT/partials/configuration/br_in_pre.adoc +++ b/modules/ROOT/partials/configuration/br_in_pre.adoc @@ -1,7 +1,7 @@ [[br_in_pre]] == `+br_in_pre+` -This option allows you to disable {productname}'s default behavior when pressing the enter key within a `+pre+` tag. By default, pressing enter within a `+pre+` tag produces a `+br+` tag at the insertion point. For example: +This option allows you to disable {productname}'s default behavior when pressing the kbd:[Enter] key within a `+pre+` tag. By default, pressing kbd:[Enter] within a `+pre+` tag produces a `+br+` tag at the insertion point. For example: `+
This is inside
a pre tag.
+` @@ -9,15 +9,18 @@ However, when `+br_in_pre+` is set to `+false+`, rather than inserting a `+br+` `+
This is inside
a pre tag.
+` -NOTE: When this option is set to `+false+`, `+shift+enter+` will insert a `+br+` tag. +[NOTE] +==== +When this option is set to `+false+`, kbd:[Shift+Enter] will insert a `+br+` tag. +==== *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+br_in_pre+` +*Default value:* `+true+` + +.Example: using `+br_in_pre+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/branding.adoc b/modules/ROOT/partials/configuration/branding.adoc index c16b7222d3..a6ef65517e 100644 --- a/modules/ROOT/partials/configuration/branding.adoc +++ b/modules/ROOT/partials/configuration/branding.adoc @@ -1,17 +1,17 @@ [[branding]] == `+branding+` -Use the `+branding+` option to disable the "*Powered by Tiny*" link displayed in the status bar for link:{legalpages}/attribution-requirements/[product attribution]. +Use the `+branding+` option to disable the "*{branding}*" link displayed in the status bar for link:{legalpages}/attribution-requirements/[product attribution]. IMPORTANT: Product attribution is required for free users utilizing the Tiny Cloud infrastructure. If using {productname} under the _GNU General Public License Version 2 or later_ license, then support for the open source project would be appreciated by keeping attribution turned on in your editor. For information on {productname} attribution requirements, see: link:{legalpages}/attribution-requirements/[Logo & attribution requirements]. *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+branding+` +*Default value:* `+true+` + +.Example: using `+branding+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/browser_spellcheck.adoc b/modules/ROOT/partials/configuration/browser_spellcheck.adoc index 5eb93dc007..df28656dfc 100644 --- a/modules/ROOT/partials/configuration/browser_spellcheck.adoc +++ b/modules/ROOT/partials/configuration/browser_spellcheck.adoc @@ -7,10 +7,10 @@ For integrated spell-checking, check out the xref:introduction-to-tiny-spellchec *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` +*Default value:* `+false+` + [source,js] ---- tinymce.init({ @@ -19,4 +19,4 @@ tinymce.init({ }); ---- -For more information about spell checking in {productname}, see xref:spell-checking.adoc[this page] in the General-configuration-guide/ guide. +For more information about spell checking in {productname}, refer to xref:spell-checking.adoc[Spell Checking in {productname}]. diff --git a/modules/ROOT/partials/configuration/builtinformats.adoc b/modules/ROOT/partials/configuration/builtinformats.adoc index d07e11f218..ba35336b52 100644 --- a/modules/ROOT/partials/configuration/builtinformats.adoc +++ b/modules/ROOT/partials/configuration/builtinformats.adoc @@ -6,35 +6,35 @@ The following formats will work on most content. [cols="1,2",options="header"] |=== -|Format option |Description -|`+alignleft+` |Left alignment. -|`+aligncenter+` |Center alignment. -|`+alignright+` |Right alignment. -|`+alignjustify+` |Justified alignment. -|`+bold+` |Bold elements or styling. -|`+italic+` |Italic elements or styling. -|`+underline+` |Underline styling. -|`+strikethrough+` |Strike-through styling. -|`+blockquote+` |Blockquote (`+
+`) elements. -|`+subscript+` |Subscript (`++`) elements. -|`+superscript+` |Superscript (`++`) elements. -|`+code+` |Code (`++`) elements. -|`+p+` |Paragraph (`+

+`) elements. -|`+h1+` |Level 1 heading (`+

+`) elements. -|`+h2+` |Level 2 heading (`+

+`) elements. -|`+h3+` |Level 3 heading (`+

+`) elements. -|`+h4+` |Level 4 heading (`+

+`) elements. -|`+h5+` |Level 5 heading (`+

+`) elements. -|`+h6+` |Level 6 heading (`+
+`) elements. -|`+div+` |Division (`+
+`) blocks. -|`+address+` |Address (`+
+`) elements. -|`+pre+` |Preformated (`+
+`) blocks.
-|`+samp+` |Sample (`++`) blocks.
-|`+forecolor+` |The text color.
-|`+hilitecolor+` |The text highlight color.
-|`+fontname+` |Font name. Such as `+'comic sans'+`.
-|`+fontsize+` |Font size. Such as `+'30px'+`.
-|`+fontsize_class+` |Font size (1-7).
+| Format option      | Description
+| `+alignleft+`      | Left alignment.
+| `+aligncenter+`    | Center alignment.
+| `+alignright+`     | Right alignment.
+| `+alignjustify+`   | Justified alignment.
+| `+bold+`           | Bold elements or styling.
+| `+italic+`         | Italic elements or styling.
+| `+underline+`      | Underline styling.
+| `+strikethrough+`  | Strike-through styling.
+| `+blockquote+`     | Blockquote (`+
+`) elements. +| `+subscript+` | Subscript (`++`) elements. +| `+superscript+` | Superscript (`++`) elements. +| `+code+` | Code (`++`) elements. +| `+p+` | Paragraph (`+

+`) elements. +| `+h1+` | Level 1 heading (`+

+`) elements. +| `+h2+` | Level 2 heading (`+

+`) elements. +| `+h3+` | Level 3 heading (`+

+`) elements. +| `+h4+` | Level 4 heading (`+

+`) elements. +| `+h5+` | Level 5 heading (`+

+`) elements. +| `+h6+` | Level 6 heading (`+
+`) elements. +| `+div+` | Division (`+
+`) blocks. +| `+address+` | Address (`+
+`) elements. +| `+pre+` | Preformated (`+
+`) blocks.
+| `+samp+`           | Sample (`++`) blocks.
+| `+forecolor+`      | The text color.
+| `+hilitecolor+`    | The text highlight color.
+| `+fontname+`       | Font name. Such as `+'comic sans'+`.
+| `+fontsize+`       | Font size. Such as `+'30px'+`.
+| `+fontsize_class+` | Font size (1-7).
 |===
 
 [NOTE]
@@ -54,9 +54,9 @@ The following formats work within definition lists (`+
+`). [cols="1,3",options="header"] |=== -|Format option |Description -|`+dt+` |Definition title (`+
+`) elements. -|`+dd+` |Definition data (`+
+`) elements. +| Format option | Description +| `+dt+` | Definition title (`+
+`) elements. +| `+dd+` | Definition data (`+
+`) elements. |=== ==== Link related formats @@ -65,8 +65,8 @@ The following formats will work on links (`++`). [cols="1,3",options="header"] |=== -|Format option |Description -|`+link+` |Link (`++`) elements. +| Format option | Description +| `+link+` | Link (`++`) elements. |=== ==== Table related formats @@ -75,8 +75,8 @@ The following formats will work within tables on `++` and `++` elements. [cols="1,3",options="header"] |=== -|Format option |Description -|`+valigntop+` |Aligns the cell content to the top of the cell. -|`+valignmiddle+` |Aligns the cell content to the middle of the cell. -|`+valignbottom+` |Aligns the cell content to the bottom of the cell. +| Format option | Description +| `+valigntop+` | Aligns the cell content to the top of the cell. +| `+valignmiddle+` | Aligns the cell content to the middle of the cell. +| `+valignbottom+` | Aligns the cell content to the bottom of the cell. |=== diff --git a/modules/ROOT/partials/configuration/cache_suffix.adoc b/modules/ROOT/partials/configuration/cache_suffix.adoc index d61c1356ce..96ab1a9fbd 100644 --- a/modules/ROOT/partials/configuration/cache_suffix.adoc +++ b/modules/ROOT/partials/configuration/cache_suffix.adoc @@ -5,7 +5,9 @@ This option allows a custom cache buster URL part to be added at the end of each *Type:* `+String+` -=== Example: using `+cache_suffix+` +*Default value:* `+undefined+` + +.Example: using `+cache_suffix+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/casechange_title_case_minors.adoc b/modules/ROOT/partials/configuration/casechange_title_case_minors.adoc index 802babe08f..595ad04a54 100644 --- a/modules/ROOT/partials/configuration/casechange_title_case_minors.adoc +++ b/modules/ROOT/partials/configuration/casechange_title_case_minors.adoc @@ -1,13 +1,13 @@ [[casechange_title_case_minors]] == `+casechange_title_case_minors+` -The `+casechange_title_case_minors+` option is used to customize the rules while using *Title Case.* This option makes it possible to configure what words not to capitalize. All other words not specified by this rule set will be capitalized overriding the default *Title Case* rule set. +The `+casechange_title_case_minors+` option is used to customize the rules while using *Title Case*. This option makes it possible to configure what words not to capitalize. All other words not specified by this rule set will be capitalized, overriding the default *Title Case* rule set. *Type:* `+Array+` *Default value:* _A rule set based on https://titlecaseconverter.com/rules/#WP[Wikipedia Title Case]_ -=== Example: using `+casechange_title_case_minors+` +.Example: using `+casechange_title_case_minors+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/charmap.adoc b/modules/ROOT/partials/configuration/charmap.adoc index 2a465669fa..99673e7297 100644 --- a/modules/ROOT/partials/configuration/charmap.adoc +++ b/modules/ROOT/partials/configuration/charmap.adoc @@ -1,13 +1,13 @@ [[charmap]] == `+charmap+` -:plugincode: charmap - With this option it is possible to fully override the default character map. This can be an array or a function that returns an array in the above mentioned format. -*Type:* `+Array+`, `+Function+` +*Type:* `+Array+` or `+Function+` + +*Default value:* `+undefined+` -=== Example: using `+charmap+` +.Example: using `+charmap+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/charmap_append.adoc b/modules/ROOT/partials/configuration/charmap_append.adoc index 16dc45a651..d2499a77f9 100644 --- a/modules/ROOT/partials/configuration/charmap_append.adoc +++ b/modules/ROOT/partials/configuration/charmap_append.adoc @@ -3,9 +3,11 @@ This option provides a way to append some additional characters to the default character map. This can be array or a function that returns an array in the above mentioned format. -*Type:* `+Array+`, `+Function+` +*Type:* `+Array+` or `+Function+` -=== Example: using `+charmap_append+` +*Default value:* `+undefined+` + +.Example: using `+charmap_append+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/codesample_global_prismjs.adoc b/modules/ROOT/partials/configuration/codesample_global_prismjs.adoc index 0452a7da26..41ef1b6abb 100644 --- a/modules/ROOT/partials/configuration/codesample_global_prismjs.adoc +++ b/modules/ROOT/partials/configuration/codesample_global_prismjs.adoc @@ -13,11 +13,11 @@ When using this option, ensure that Prism.js and any language add-ons are loaded *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+codesample_global_prismjs+` +*Default value:* `+false+` + +.Example: using `+codesample_global_prismjs+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/codesample_languages.adoc b/modules/ROOT/partials/configuration/codesample_languages.adoc index dc787f7a0f..7ea071b7e3 100644 --- a/modules/ROOT/partials/configuration/codesample_languages.adoc +++ b/modules/ROOT/partials/configuration/codesample_languages.adoc @@ -1,27 +1,40 @@ [[codesample_languages]] == `+codesample_languages+` -This configuration option enables you to set a list of languages to be displayed in the languages drop down. +This configuration option enables you to set a list of languages to be displayed in the languages dropdown. -=== Example: using `+codesample_languages+` +*Type:* `+Array+` of `+Objects+` + +*Default value:* + +[source,js] +---- +[ + { text: 'HTML/XML', value: 'markup' }, + { text: 'JavaScript', value: 'javascript' }, + { text: 'CSS', value: 'css' }, + { text: 'PHP', value: 'php' }, + { text: 'Ruby', value: 'ruby' }, + { text: 'Python', value: 'python' }, + { text: 'Java', value: 'java' }, + { text: 'C', value: 'c' }, + { text: 'C#', value: 'csharp' }, + { text: 'C++', value: 'cpp' } +] +---- + +.Example: using `+codesample_languages+` [source,js] ---- tinymce.init({ selector: 'textarea', plugins: 'codesample', + toolbar: 'codesample', codesample_languages: [ { text: 'HTML/XML', value: 'markup' }, { text: 'JavaScript', value: 'javascript' }, - { text: 'CSS', value: 'css' }, - { text: 'PHP', value: 'php' }, - { text: 'Ruby', value: 'ruby' }, - { text: 'Python', value: 'python' }, - { text: 'Java', value: 'java' }, - { text: 'C', value: 'c' }, - { text: 'C#', value: 'csharp' }, - { text: 'C++', value: 'cpp' } - ], - toolbar: 'codesample' + { text: 'CSS', value: 'css' } + ] }); ---- diff --git a/modules/ROOT/partials/configuration/comments-tinycomments_access.adoc b/modules/ROOT/partials/configuration/comments-tinycomments_access.adoc index d21ae722a2..0f5a77c3da 100644 --- a/modules/ROOT/partials/configuration/comments-tinycomments_access.adoc +++ b/modules/ROOT/partials/configuration/comments-tinycomments_access.adoc @@ -3,19 +3,20 @@ *Type:* `+String+` -*Possible values:* `'comment'` +*Possible values:* `+'full'+`, `'comment'` + +*Default value:* `+'full'+` This option sets the editor to the readonly mode, while still allowing comments to be made. [IMPORTANT] ==== -* When `tinycomments_access` is set to `comment`, the editor will automatically switch to xref:editor-important-options.adoc#readonly[Readonly Mode]. +* When `tinycomments_access` is set to `'comment'`, the editor will automatically switch to xref:editor-important-options.adoc#readonly[Readonly Mode]. ==== === Comments with `tinycomments_access` set to `'comment'` -When `tinycomments_access` is set to `comment`, the editor will be in xref:editor-important-options.adoc#readonly[Readonly mode], but the comments will be in a **comment-only** mode. This means that users can add and delete comments, but they cannot edit the editor content. - +When `tinycomments_access` is set to `'comment'`, the editor will be in xref:editor-important-options.adoc#readonly[Readonly mode], but the comments will be in a **comment-only** mode. This means that users can add and delete comments, but they cannot edit the editor content. .Example [source,javascript] @@ -31,15 +32,14 @@ tinymce.init({ liveDemo::comments-ui-mode[] -=== Comments with `readonly` set to `true` +=== Comments with `readonly` set to `+true+` When not using the `tinycomments_access` option, the comments sidebar will have a different state depending on the use of the xref:editor-important-options.adoc#readonly[`readonly` option]. -With neither xref:editor-important-options.adoc#readonly[Readonly mode] nor `tinycomments: "comment"` configured, both the editor and the comments sidebar will be in their default state. By default, comments can be both viewed and added, and the editor content is editable. +With neither xref:editor-important-options.adoc#readonly[Readonly mode] nor `tinycomments: 'comment'` configured, both the editor and the comments sidebar will be in their default state. By default, comments can be both viewed and added, and the editor content is editable. With xref:editor-important-options.adoc#readonly[Readonly mode] enabled, the comments sidebar will be in a **view-only** mode, meaning all comments can be viewed and navigated, but no new comments can be added. Also, in the **readonly** state, the editor will still not be editable. - .Example [source,javascript] ---- diff --git a/modules/ROOT/partials/configuration/content_css.adoc b/modules/ROOT/partials/configuration/content_css.adoc index fbcc163b39..7648b5d8d0 100644 --- a/modules/ROOT/partials/configuration/content_css.adoc +++ b/modules/ROOT/partials/configuration/content_css.adoc @@ -3,9 +3,14 @@ The `+content_css+` option loads the specified CSS files into the editable area. -*Type:* `+String+`, `+Array+` +*Type:* `+String+`, `+Array+` of `+Strings+`, or `+false+` -NOTE: This option is intended for use with {productname}'s classic mode, as the editable area is sandboxed within an iframe. For inline mode editors, relevant CSS stylesheets should be loaded as part of the webpage {productname} is rendered in, not using the `+content_css+` option. +*Default value:* `+['default']+` for classic mode, `+[]+` for inline mode + +[NOTE] +==== +This option is intended for use with {productname}'s classic mode, as the editable area is sandboxed within an iframe. For inline mode editors, relevant CSS stylesheets should be loaded as part of the webpage {productname} is rendered in, not using the `+content_css+` option. +==== include::partial$misc/shipped-content-css.adoc[] diff --git a/modules/ROOT/partials/configuration/content_css_cors.adoc b/modules/ROOT/partials/configuration/content_css_cors.adoc index 5f7e3dc4e3..f5f79f7111 100644 --- a/modules/ROOT/partials/configuration/content_css_cors.adoc +++ b/modules/ROOT/partials/configuration/content_css_cors.adoc @@ -5,11 +5,11 @@ When `+content_css_cors+` is set to `+true+`, the editor will add a `+crossorigi *Type:* `+Boolean+` -*Default value:* `+false+` - *Possible values:* `+true+`, `+false+` -=== Example: using `+content_css_cors+` +*Default value:* `+false+` + +.Example: using `+content_css_cors+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/content_langs.adoc b/modules/ROOT/partials/configuration/content_langs.adoc index 610d3c6f8f..1cad9e6dd8 100644 --- a/modules/ROOT/partials/configuration/content_langs.adoc +++ b/modules/ROOT/partials/configuration/content_langs.adoc @@ -5,9 +5,11 @@ include::partial$configuration/content_langs_base.adoc[] There is no default value for the `+content_langs+` option. If no value is specified, the `+language+` toolbar button and menu item are not available. A default value for this option is provided by the Spell Checker plugin. For information on using the `+content_langs+` option with the Spell Checker plugin, see: xref:introduction-to-tiny-spellchecker.adoc#content_langs[Spell Checker plugin - `+content_langs+`]. -*Type:* `+Array+` +*Type:* `+Array+` of `+Objects+` -=== Example: using `+content_langs+` +*Default value:* `+undefined+` + +.Example: using `+content_langs+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/content_langs_base.adoc b/modules/ROOT/partials/configuration/content_langs_base.adoc index 817bfc5d35..6a6e781d3d 100644 --- a/modules/ROOT/partials/configuration/content_langs_base.adoc +++ b/modules/ROOT/partials/configuration/content_langs_base.adoc @@ -2,8 +2,8 @@ This option sets the languages displayed in the `+language+` toolbar button and [cols="1,1,1,4",options="header"] |=== -|Name |Type |Requirement |Description -|`+title+` |String |required |The name shown for this language in the UI. -|`+code+` |String |required |The language tag, as defined in https://www.ietf.org/rfc/bcp/bcp47.txt[Tags for Identifying Languages (BCP47)], for this language. This language tag is placed in the `+lang+` attribute for elements formatted using this language. -|`+customCode+` |String |optional |An alternative language tag, that does not need to be compatible with BCP47. This string is placed in the `+data-mce-lang+` attribute for elements formatted using this language, if it is defined. +| Name | Type | Requirement | Description +| `+title+` | String | required | The name shown for this language in the UI. +| `+code+` | String | required | The language tag, as defined in https://www.ietf.org/rfc/bcp/bcp47.txt[Tags for Identifying Languages (BCP47)], for this language. This language tag is placed in the `+lang+` attribute for elements formatted using this language. +| `+customCode+`| String | optional | An alternative language tag, that does not need to be compatible with BCP47. This string is placed in the `+data-mce-lang+` attribute for elements formatted using this language, if it is defined. |=== diff --git a/modules/ROOT/partials/configuration/content_security_policy.adoc b/modules/ROOT/partials/configuration/content_security_policy.adoc index 4bb784e316..e78d45059e 100644 --- a/modules/ROOT/partials/configuration/content_security_policy.adoc +++ b/modules/ROOT/partials/configuration/content_security_policy.adoc @@ -5,7 +5,9 @@ This option allows a custom content security policy to be set for the editor's i *Type:* `+String+` -=== Example: using `+content_security_policy+` +*Default value:* `+''+` + +.Example: using `+content_security_policy+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/content_style.adoc b/modules/ROOT/partials/configuration/content_style.adoc index 92e9ce116f..0806de2f5f 100644 --- a/modules/ROOT/partials/configuration/content_style.adoc +++ b/modules/ROOT/partials/configuration/content_style.adoc @@ -5,9 +5,14 @@ This option allows custom CSS styles to be set as a string. The styles are injec *Type:* `+String+` -NOTE: `+content_style+` styles are not saved within {productname}'s content. If they are needed for display purposes, ensure the styles are also included in the page the content will be displayed on. +*Default value:* `+undefined+` -=== Example: applying one CSS style using `+content_style+` +[NOTE] +==== +`+content_style+` styles are not saved within {productname}'s content. If they are needed for display purposes, ensure the styles are also included in the page the content will be displayed on. +==== + +.Example: applying one CSS style using `+content_style+` [source,js] ---- @@ -19,7 +24,7 @@ tinymce.init({ To add two or more styles with this option, provide the styles as a single string. -=== Example: applying two or more CSS styles using `+content_style+` +.Example: applying two or more CSS styles using `+content_style+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/contextmenu.adoc b/modules/ROOT/partials/configuration/contextmenu.adoc index e01ba87e58..637f3ecb0f 100644 --- a/modules/ROOT/partials/configuration/contextmenu.adoc +++ b/modules/ROOT/partials/configuration/contextmenu.adoc @@ -23,7 +23,7 @@ include::partial$misc/admon-ctrl-right-click.adoc[] include::partial$misc/admon-mobile-context-menus.adoc[] -=== Example: using `+contextmenu+` +.Example: using `+contextmenu+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/contextmenu_avoid_overlap.adoc b/modules/ROOT/partials/configuration/contextmenu_avoid_overlap.adoc index 2156dd78ab..fe08d87d22 100644 --- a/modules/ROOT/partials/configuration/contextmenu_avoid_overlap.adoc +++ b/modules/ROOT/partials/configuration/contextmenu_avoid_overlap.adoc @@ -7,7 +7,7 @@ The `+contextmenu_avoid_overlap+` option prevents the context menu from covering *Default value:* `+''+` -=== Example +.Example: using `+contextmenu_avoid_overlap+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/contextmenu_never_use_native.adoc b/modules/ROOT/partials/configuration/contextmenu_never_use_native.adoc index b2faf60e10..40b531de24 100644 --- a/modules/ROOT/partials/configuration/contextmenu_never_use_native.adoc +++ b/modules/ROOT/partials/configuration/contextmenu_never_use_native.adoc @@ -7,9 +7,11 @@ CAUTION: Using this option may result in unexpected behavior when right-clicking *Type:* `+Boolean+` +*Possible values:* `+true+`, `+false+` + *Default value:* `+false+` -=== Example: using `+contextmenu_never_use_native+` +.Example: using `+contextmenu_never_use_native+` [source,js] ---- diff --git a/modules/ROOT/partials/configuration/convert_fonts_to_spans.adoc b/modules/ROOT/partials/configuration/convert_fonts_to_spans.adoc index 43b373c4b3..e8cb76cd3c 100644 --- a/modules/ROOT/partials/configuration/convert_fonts_to_spans.adoc +++ b/modules/ROOT/partials/configuration/convert_fonts_to_spans.adoc @@ -7,10 +7,10 @@ If you set this option to `+true+`, {productname} will convert all `+font+` elem *Type:* `+Boolean+` -*Default value:* `+true+` - *Possible values:* `+true+`, `+false+` +*Default value:* `+true+` + [source,js] ---- tinymce.init({ diff --git a/modules/ROOT/partials/configuration/convert_unsafe_embeds.adoc b/modules/ROOT/partials/configuration/convert_unsafe_embeds.adoc index 33509afa72..c437ec6184 100644 --- a/modules/ROOT/partials/configuration/convert_unsafe_embeds.adoc +++ b/modules/ROOT/partials/configuration/convert_unsafe_embeds.adoc @@ -7,16 +7,16 @@ When converted to ``, `