From 5027e0742cc6b489fae18bdab63c9c01045a747c Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 21 Aug 2025 00:18:57 +1000 Subject: [PATCH 01/15] DOC-3264: New feature documentation for fullpagehtml. --- .../ROOT/examples/live-demos/fullpage/demo.js | 16 ++++++ .../examples/live-demos/fullpage/index.html | 3 ++ modules/ROOT/nav.adoc | 1 + modules/ROOT/pages/available-menu-items.adoc | 6 +++ .../ROOT/pages/available-toolbar-buttons.adoc | 6 +++ modules/ROOT/pages/fullpage.adoc | 54 +++++++++++++++++++ modules/ROOT/pages/how-to-guides.adoc | 6 +++ .../fullpage-default-body-style.adoc | 21 ++++++++ .../fullpage-default-doctype.adoc | 21 ++++++++ .../fullpage-default-encoding.adoc | 21 ++++++++ .../configuration/fullpage-default-title.adoc | 21 ++++++++ .../partials/index-pages/premium-plugins.adoc | 6 +++ .../menu-item-ids/fullpage-menu-items.adoc | 5 ++ .../fullpage-toolbar-buttons.adoc | 5 ++ 14 files changed, 192 insertions(+) create mode 100644 modules/ROOT/examples/live-demos/fullpage/demo.js create mode 100644 modules/ROOT/examples/live-demos/fullpage/index.html create mode 100644 modules/ROOT/pages/fullpage.adoc create mode 100644 modules/ROOT/partials/configuration/fullpage-default-body-style.adoc create mode 100644 modules/ROOT/partials/configuration/fullpage-default-doctype.adoc create mode 100644 modules/ROOT/partials/configuration/fullpage-default-encoding.adoc create mode 100644 modules/ROOT/partials/configuration/fullpage-default-title.adoc create mode 100644 modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc create mode 100644 modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc diff --git a/modules/ROOT/examples/live-demos/fullpage/demo.js b/modules/ROOT/examples/live-demos/fullpage/demo.js new file mode 100644 index 0000000000..c7be66fe1d --- /dev/null +++ b/modules/ROOT/examples/live-demos/fullpage/demo.js @@ -0,0 +1,16 @@ +tinymce.init({ + selector: 'textarea#fullpage', + height: '800px', + plugins: [ + "fullpage", "advlist", "anchor", "autolink", "charmap", "code", "fullscreen", + "help", "image", "insertdatetime", "link", "lists", "media", + "preview", "searchreplace", "table", "visualblocks", + ], + menubar: 'file', + toolbar: "undo redo | fullpage | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image", + // Full Page Plugin Configuration Options + fullpage_default_doctype: '', // Has default in source code + fullpage_default_title: 'Full Page Plugin Demo Document', // No default in source code + fullpage_default_encoding: 'UTF-8', // No default in source code + fullpage_default_body_style: 'margin: 20px; padding: 15px; font-family: Georgia, Times, serif; font-size: 16px; color: #2c3e50;' // No default in source code +}); \ No newline at end of file diff --git a/modules/ROOT/examples/live-demos/fullpage/index.html b/modules/ROOT/examples/live-demos/fullpage/index.html new file mode 100644 index 0000000000..1b87814266 --- /dev/null +++ b/modules/ROOT/examples/live-demos/fullpage/index.html @@ -0,0 +1,3 @@ + diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index c874b625c5..78914743e6 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -315,6 +315,7 @@ **** JWT Authentication ***** xref:export-to-word-with-jwt-authentication-nodejs.adoc[Node.js] ***** xref:export-to-word-with-jwt-authentication-php.adoc[PHP] +*** xref:fullpage.adoc[Full Page] *** xref:footnotes.adoc[Footnotes] *** xref:formatpainter.adoc[Format Painter] *** xref:importword.adoc[Import from Word] diff --git a/modules/ROOT/pages/available-menu-items.adoc b/modules/ROOT/pages/available-menu-items.adoc index 8f55b4d322..00f87efd19 100644 --- a/modules/ROOT/pages/available-menu-items.adoc +++ b/modules/ROOT/pages/available-menu-items.adoc @@ -100,6 +100,12 @@ include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] :plugincode: emoticons include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] +:plugincategory: premium +:pluginname: Full Page +:plugincode: fullpage +:pluginpage: fullpage.adoc +include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] + :plugincategory: premium :pluginname: Export to PDF :plugincode: exportpdf diff --git a/modules/ROOT/pages/available-toolbar-buttons.adoc b/modules/ROOT/pages/available-toolbar-buttons.adoc index 0a95913626..23d272df30 100644 --- a/modules/ROOT/pages/available-toolbar-buttons.adoc +++ b/modules/ROOT/pages/available-toolbar-buttons.adoc @@ -112,6 +112,12 @@ include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] :plugincode: emoticons include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] +:plugincategory: premium +:pluginname: Full Page +:plugincode: fullpage +:pluginpage: fullpage.adoc +include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] + :plugincategory: premium :pluginname: Export to PDF :plugincode: exportpdf diff --git a/modules/ROOT/pages/fullpage.adoc b/modules/ROOT/pages/fullpage.adoc new file mode 100644 index 0000000000..3ee81bd565 --- /dev/null +++ b/modules/ROOT/pages/fullpage.adoc @@ -0,0 +1,54 @@ += Full Page Plugin +:navtitle: Full Page +:description: Edit metadata and document properties including title, keywords, and description via a dialog box, with HTML structure exposure in source code view. +:description_short: Edit document metadata and properties with dialog interface and source code exposure. +:keywords: full page, metadata, document properties, title, keywords, description, HTML structure, source code +:pluginname: Full Page +:plugincode: fullpage +:plugincategory: premium + +include::partial$misc/admon-premium-plugin.adoc[] + +The {pluginname} plugin provides comprehensive control over document metadata and properties. It enables users to edit HTML document metadata such as title, keywords, and description through an intuitive dialog interface. When combined with the code plugin, it also exposes the complete HTML structure including ``, ``, and various meta tags in the source code view. + + +== Interactive example + + +liveDemo::{plugincode}[] + +== Basic setup + +To add the {pluginname} plugin to the editor, add `{plugincode}` to the `plugins` option in the editor configuration. + +For example: + +[source,js] +---- +tinymce.init({ + selector: 'textarea', // change this value according to your HTML + plugins: 'fullpage', + toolbar: 'fullpage', + fullpage_default_doctype: '' +}); +---- + +== Options + +The following configuration options affect the behavior of the {pluginname} plugin. + +include::partial$configuration/fullpage-default-doctype.adoc[leveloffset=+1] + +include::partial$configuration/fullpage-default-title.adoc[leveloffset=+1] + +include::partial$configuration/fullpage-default-encoding.adoc[leveloffset=+1] + +include::partial$configuration/fullpage-default-body-style.adoc[leveloffset=+1] + +include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] + +include::partial$toolbar-button-ids/{plugincode}-toolbar-buttons.adoc[leveloffset=+1] + +include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] + +include::partial$menu-item-ids/{plugincode}-menu-items.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/ROOT/pages/how-to-guides.adoc b/modules/ROOT/pages/how-to-guides.adoc index cedb48ce9d..69135e6236 100644 --- a/modules/ROOT/pages/how-to-guides.adoc +++ b/modules/ROOT/pages/how-to-guides.adoc @@ -91,6 +91,12 @@ xref:events.adoc[Available Events] List of common editor events +a| +[.lead] +xref:fullpage.adoc[Full Page Plugin] + +Edit document metadata and properties including title, keywords, and description via dialog interface. + a| [.lead] xref:keyboard-shortcuts.adoc[Keyboard shortcuts] diff --git a/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc b/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc new file mode 100644 index 0000000000..0dcf03b294 --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc @@ -0,0 +1,21 @@ +[[fullpage-default-body-style]] +== `+fullpage_default_body_style+` + +This option enables you to specify the default CSS styles for the body element. + +*Type:* `+String+` + +*Possible values:* Any valid CSS style string + +*Default value:* No default value (empty string) + +=== Example: using `+fullpage_default_body_style+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpage', + fullpage_default_body_style: 'margin: 20px; padding: 10px; font-family: Arial, sans-serif;' +}); +---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-doctype.adoc b/modules/ROOT/partials/configuration/fullpage-default-doctype.adoc new file mode 100644 index 0000000000..ee38139264 --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpage-default-doctype.adoc @@ -0,0 +1,21 @@ +[[fullpage-default-doctype]] +== `+fullpage_default_doctype+` + +This option enables you to specify the default doctype for the output HTML. + +*Type:* `+String+` + +*Possible values:* `+''+` + +*Default value:* `+''+` + +=== Example: using `+fullpage_default_doctype+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpage', + fullpage_default_doctype: '' +}); +---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-encoding.adoc b/modules/ROOT/partials/configuration/fullpage-default-encoding.adoc new file mode 100644 index 0000000000..a1c924a11d --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpage-default-encoding.adoc @@ -0,0 +1,21 @@ +[[fullpage-default-encoding]] +== `+fullpage_default_encoding+` + +This option enables you to specify the default encoding for the output HTML. + +*Type:* `+String+` + +*Possible values:* Any string value representing a character encoding + +*Default value:* No default value (empty string) + +=== Example: using `+fullpage_default_encoding+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpage', + fullpage_default_encoding: 'ISO-8859-1' +}); +---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-title.adoc b/modules/ROOT/partials/configuration/fullpage-default-title.adoc new file mode 100644 index 0000000000..ea883e2fb8 --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpage-default-title.adoc @@ -0,0 +1,21 @@ +[[fullpage-default-title]] +== `+fullpage_default_title+` + +This option enables you to specify the default title for the output HTML. + +*Type:* `+String+` + +*Possible values:* Any string value representing the document title + +*Default value:* No default value (empty string) + +=== Example: using `+fullpage_default_title+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpage', + fullpage_default_title: 'My default page title' +}); +---- diff --git a/modules/ROOT/partials/index-pages/premium-plugins.adoc b/modules/ROOT/partials/index-pages/premium-plugins.adoc index 75cc78e56a..f6631dd3c4 100644 --- a/modules/ROOT/partials/index-pages/premium-plugins.adoc +++ b/modules/ROOT/partials/index-pages/premium-plugins.adoc @@ -69,6 +69,12 @@ xref:exportpdf.adoc[Export to PDF] Export and generate content from {productname} into `document.pdf` format. +a| +[.lead] +xref:fullpage.adoc[Full Page] + +Edit document metadata and properties including title, keywords, and description via dialog interface. + a| [.lead] xref:footnotes.adoc[Footnotes] diff --git a/modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc b/modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc new file mode 100644 index 0000000000..fe5ee66fea --- /dev/null +++ b/modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc @@ -0,0 +1,5 @@ +[cols="1,1,2",options="header"] +|=== +|Menu item identifier |xref:menus-configuration-options.adoc#example-the-tinymce-default-menu-items[Default Menu Location] |Description +|`+fullpage+` |File |Opens the Full Page dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. +|=== diff --git a/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc b/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc new file mode 100644 index 0000000000..32545ca11d --- /dev/null +++ b/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc @@ -0,0 +1,5 @@ +[cols="1,3",options="header"] +|=== +|Toolbar button identifier |Description +|`+fullpage+` |Opens the Full Page dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. +|=== From 23e91b871e76fddd8d7a0fa1fd86f9b4d9d13f3a Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 28 Aug 2025 11:52:26 +1000 Subject: [PATCH 02/15] DOC-3209: Update plugin name, file-names and improve examples. --- .../ROOT/examples/live-demos/fullpage/demo.js | 17 +++---- .../examples/live-demos/fullpage/index.html | 4 +- modules/ROOT/nav.adoc | 2 +- modules/ROOT/pages/available-menu-items.adoc | 6 +-- .../ROOT/pages/available-toolbar-buttons.adoc | 6 +-- .../{fullpage.adoc => fullpagehtml.adoc} | 34 ++++++++----- modules/ROOT/pages/how-to-guides.adoc | 2 +- .../partials/commands/fullpagehtml-cmds.adoc | 11 +++++ .../fullpage-default-body-style.adoc | 21 -------- .../fullpagehtml-default-body-style.adoc | 21 ++++++++ ...adoc => fullpagehtml-default-doctype.adoc} | 10 ++-- ...doc => fullpagehtml-default-encoding.adoc} | 10 ++-- ...e.adoc => fullpagehtml-default-title.adoc} | 10 ++-- .../fullpagehtml-hide-in-source-view.adoc | 48 +++++++++++++++++++ .../partials/index-pages/premium-plugins.adoc | 2 +- ...tems.adoc => fullpagehtml-menu-items.adoc} | 2 +- .../fullpage-toolbar-buttons.adoc | 5 -- .../fullpagehtml-toolbar-buttons.adoc | 5 ++ 18 files changed, 142 insertions(+), 74 deletions(-) rename modules/ROOT/pages/{fullpage.adoc => fullpagehtml.adoc} (61%) create mode 100644 modules/ROOT/partials/commands/fullpagehtml-cmds.adoc delete mode 100644 modules/ROOT/partials/configuration/fullpage-default-body-style.adoc create mode 100644 modules/ROOT/partials/configuration/fullpagehtml-default-body-style.adoc rename modules/ROOT/partials/configuration/{fullpage-default-doctype.adoc => fullpagehtml-default-doctype.adoc} (55%) rename modules/ROOT/partials/configuration/{fullpage-default-encoding.adoc => fullpagehtml-default-encoding.adoc} (59%) rename modules/ROOT/partials/configuration/{fullpage-default-title.adoc => fullpagehtml-default-title.adoc} (58%) create mode 100644 modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc rename modules/ROOT/partials/menu-item-ids/{fullpage-menu-items.adoc => fullpagehtml-menu-items.adoc} (51%) delete mode 100644 modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc create mode 100644 modules/ROOT/partials/toolbar-button-ids/fullpagehtml-toolbar-buttons.adoc diff --git a/modules/ROOT/examples/live-demos/fullpage/demo.js b/modules/ROOT/examples/live-demos/fullpage/demo.js index c7be66fe1d..8fbb14ef71 100644 --- a/modules/ROOT/examples/live-demos/fullpage/demo.js +++ b/modules/ROOT/examples/live-demos/fullpage/demo.js @@ -1,16 +1,17 @@ tinymce.init({ - selector: 'textarea#fullpage', + selector: 'textarea#fullpagehtml', height: '800px', plugins: [ - "fullpage", "advlist", "anchor", "autolink", "charmap", "code", "fullscreen", + "fullpagehtml", "advlist", "anchor", "autolink", "charmap", "code", "fullscreen", "help", "image", "insertdatetime", "link", "lists", "media", "preview", "searchreplace", "table", "visualblocks", ], menubar: 'file', - toolbar: "undo redo | fullpage | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image", - // Full Page Plugin Configuration Options - fullpage_default_doctype: '', // Has default in source code - fullpage_default_title: 'Full Page Plugin Demo Document', // No default in source code - fullpage_default_encoding: 'UTF-8', // No default in source code - fullpage_default_body_style: 'margin: 20px; padding: 15px; font-family: Georgia, Times, serif; font-size: 16px; color: #2c3e50;' // No default in source code + toolbar: "undo redo | fullpagehtml | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image", + // Full Page HTML Plugin Configuration Options + fullpagehtml_default_doctype: '', + fullpagehtml_default_title: 'Full Page HTML Plugin Demo Document', + fullpagehtml_default_encoding: 'UTF-8', + fullpagehtml_default_body_style: 'margin: 20px; padding: 15px; font-family: Georgia, Times, serif; font-size: 16px; color: #2c3e50;', + fullpagehtml_hide_in_source_view: false // Show full page HTML in source view }); \ No newline at end of file diff --git a/modules/ROOT/examples/live-demos/fullpage/index.html b/modules/ROOT/examples/live-demos/fullpage/index.html index 1b87814266..26f6869a1d 100644 --- a/modules/ROOT/examples/live-demos/fullpage/index.html +++ b/modules/ROOT/examples/live-demos/fullpage/index.html @@ -1,3 +1,3 @@ - diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 78914743e6..44f9aff1fa 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -315,7 +315,7 @@ **** JWT Authentication ***** xref:export-to-word-with-jwt-authentication-nodejs.adoc[Node.js] ***** xref:export-to-word-with-jwt-authentication-php.adoc[PHP] -*** xref:fullpage.adoc[Full Page] +*** xref:fullpagehtml.adoc[Full Page HTML] *** xref:footnotes.adoc[Footnotes] *** xref:formatpainter.adoc[Format Painter] *** xref:importword.adoc[Import from Word] diff --git a/modules/ROOT/pages/available-menu-items.adoc b/modules/ROOT/pages/available-menu-items.adoc index 00f87efd19..56faf50683 100644 --- a/modules/ROOT/pages/available-menu-items.adoc +++ b/modules/ROOT/pages/available-menu-items.adoc @@ -101,9 +101,9 @@ include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] :plugincategory: premium -:pluginname: Full Page -:plugincode: fullpage -:pluginpage: fullpage.adoc +:pluginname: Full Page HTML +:plugincode: fullpagehtml +:pluginpage: fullpagehtml.adoc include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] :plugincategory: premium diff --git a/modules/ROOT/pages/available-toolbar-buttons.adoc b/modules/ROOT/pages/available-toolbar-buttons.adoc index 23d272df30..74ffd4a6d6 100644 --- a/modules/ROOT/pages/available-toolbar-buttons.adoc +++ b/modules/ROOT/pages/available-toolbar-buttons.adoc @@ -113,9 +113,9 @@ include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] :plugincategory: premium -:pluginname: Full Page -:plugincode: fullpage -:pluginpage: fullpage.adoc +:pluginname: Full Page HTML +:plugincode: fullpagehtml +:pluginpage: fullpagehtml.adoc include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] :plugincategory: premium diff --git a/modules/ROOT/pages/fullpage.adoc b/modules/ROOT/pages/fullpagehtml.adoc similarity index 61% rename from modules/ROOT/pages/fullpage.adoc rename to modules/ROOT/pages/fullpagehtml.adoc index 3ee81bd565..f7665f8044 100644 --- a/modules/ROOT/pages/fullpage.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -1,10 +1,10 @@ -= Full Page Plugin -:navtitle: Full Page += Full Page HTML Plugin +:navtitle: Full Page HTML :description: Edit metadata and document properties including title, keywords, and description via a dialog box, with HTML structure exposure in source code view. :description_short: Edit document metadata and properties with dialog interface and source code exposure. -:keywords: full page, metadata, document properties, title, keywords, description, HTML structure, source code -:pluginname: Full Page -:plugincode: fullpage +:keywords: full page html, metadata, document properties, title, keywords, description, HTML structure, source code +:pluginname: Full Page HTML +:plugincode: fullpagehtml :plugincategory: premium include::partial$misc/admon-premium-plugin.adoc[] @@ -27,9 +27,9 @@ For example: ---- tinymce.init({ selector: 'textarea', // change this value according to your HTML - plugins: 'fullpage', - toolbar: 'fullpage', - fullpage_default_doctype: '' + plugins: 'fullpagehtml', + toolbar: 'fullpagehtml', + fullpagehtml_default_doctype: '' }); ---- @@ -37,13 +37,15 @@ tinymce.init({ The following configuration options affect the behavior of the {pluginname} plugin. -include::partial$configuration/fullpage-default-doctype.adoc[leveloffset=+1] +include::partial$configuration/fullpagehtml-default-doctype.adoc[leveloffset=+1] -include::partial$configuration/fullpage-default-title.adoc[leveloffset=+1] +include::partial$configuration/fullpagehtml-default-title.adoc[leveloffset=+1] -include::partial$configuration/fullpage-default-encoding.adoc[leveloffset=+1] +include::partial$configuration/fullpagehtml-default-encoding.adoc[leveloffset=+1] -include::partial$configuration/fullpage-default-body-style.adoc[leveloffset=+1] +include::partial$configuration/fullpagehtml-default-body-style.adoc[leveloffset=+1] + +include::partial$configuration/fullpagehtml-hide-in-source-view.adoc[leveloffset=+1] include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[] @@ -51,4 +53,10 @@ include::partial$toolbar-button-ids/{plugincode}-toolbar-buttons.adoc[leveloffse include::partial$misc/plugin-menu-item-id-boilerplate.adoc[] -include::partial$menu-item-ids/{plugincode}-menu-items.adoc[leveloffset=+1] \ No newline at end of file +include::partial$menu-item-ids/{plugincode}-menu-items.adoc[leveloffset=+1] + +== Commands + +The {pluginname} plugin provides the following {productname} command. + +include::partial$commands/fullpagehtml-cmds.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/ROOT/pages/how-to-guides.adoc b/modules/ROOT/pages/how-to-guides.adoc index 69135e6236..f5c07a0e5a 100644 --- a/modules/ROOT/pages/how-to-guides.adoc +++ b/modules/ROOT/pages/how-to-guides.adoc @@ -93,7 +93,7 @@ List of common editor events a| [.lead] -xref:fullpage.adoc[Full Page Plugin] +xref:fullpagehtml.adoc[Full Page HTML Plugin] Edit document metadata and properties including title, keywords, and description via dialog interface. diff --git a/modules/ROOT/partials/commands/fullpagehtml-cmds.adoc b/modules/ROOT/partials/commands/fullpagehtml-cmds.adoc new file mode 100644 index 0000000000..5a8a78fa11 --- /dev/null +++ b/modules/ROOT/partials/commands/fullpagehtml-cmds.adoc @@ -0,0 +1,11 @@ +[cols="1,3",options="header"] +|=== +|Command |Description +|mceFullPageHtmlProperties |Opens the Full Page HTML dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. +|=== + +.Example +[source,js] +---- +tinymce.activeEditor.execCommand('mceFullPageHtmlProperties'); +---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc b/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc deleted file mode 100644 index 0dcf03b294..0000000000 --- a/modules/ROOT/partials/configuration/fullpage-default-body-style.adoc +++ /dev/null @@ -1,21 +0,0 @@ -[[fullpage-default-body-style]] -== `+fullpage_default_body_style+` - -This option enables you to specify the default CSS styles for the body element. - -*Type:* `+String+` - -*Possible values:* Any valid CSS style string - -*Default value:* No default value (empty string) - -=== Example: using `+fullpage_default_body_style+` - -[source,js] ----- -tinymce.init({ - selector: 'textarea', - plugins: 'fullpage', - fullpage_default_body_style: 'margin: 20px; padding: 10px; font-family: Arial, sans-serif;' -}); ----- diff --git a/modules/ROOT/partials/configuration/fullpagehtml-default-body-style.adoc b/modules/ROOT/partials/configuration/fullpagehtml-default-body-style.adoc new file mode 100644 index 0000000000..ac19d7e20d --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpagehtml-default-body-style.adoc @@ -0,0 +1,21 @@ +[[fullpagehtml-default-body-style]] +== `+fullpagehtml_default_body_style+` + +This option enables you to specify the default body style for the output HTML. + +*Type:* `+String+` + +*Possible values:* Any string value representing valid CSS styles + +*Default value:* No default value (empty string) + +=== Example: using `+fullpagehtml_default_body_style+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpagehtml', + fullpagehtml_default_body_style: 'margin: 20px; padding: 10px; font-family: Arial, sans-serif;' +}); +---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-doctype.adoc b/modules/ROOT/partials/configuration/fullpagehtml-default-doctype.adoc similarity index 55% rename from modules/ROOT/partials/configuration/fullpage-default-doctype.adoc rename to modules/ROOT/partials/configuration/fullpagehtml-default-doctype.adoc index ee38139264..8d878093ac 100644 --- a/modules/ROOT/partials/configuration/fullpage-default-doctype.adoc +++ b/modules/ROOT/partials/configuration/fullpagehtml-default-doctype.adoc @@ -1,5 +1,5 @@ -[[fullpage-default-doctype]] -== `+fullpage_default_doctype+` +[[fullpagehtml-default-doctype]] +== `+fullpagehtml_default_doctype+` This option enables you to specify the default doctype for the output HTML. @@ -9,13 +9,13 @@ This option enables you to specify the default doctype for the output HTML. *Default value:* `+''+` -=== Example: using `+fullpage_default_doctype+` +=== Example: using `+fullpagehtml_default_doctype+` [source,js] ---- tinymce.init({ selector: 'textarea', - plugins: 'fullpage', - fullpage_default_doctype: '' + plugins: 'fullpagehtml', + fullpagehtml_default_doctype: '' }); ---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-encoding.adoc b/modules/ROOT/partials/configuration/fullpagehtml-default-encoding.adoc similarity index 59% rename from modules/ROOT/partials/configuration/fullpage-default-encoding.adoc rename to modules/ROOT/partials/configuration/fullpagehtml-default-encoding.adoc index a1c924a11d..c6b3016300 100644 --- a/modules/ROOT/partials/configuration/fullpage-default-encoding.adoc +++ b/modules/ROOT/partials/configuration/fullpagehtml-default-encoding.adoc @@ -1,5 +1,5 @@ -[[fullpage-default-encoding]] -== `+fullpage_default_encoding+` +[[fullpagehtml-default-encoding]] +== `+fullpagehtml_default_encoding+` This option enables you to specify the default encoding for the output HTML. @@ -9,13 +9,13 @@ This option enables you to specify the default encoding for the output HTML. *Default value:* No default value (empty string) -=== Example: using `+fullpage_default_encoding+` +=== Example: using `+fullpagehtml_default_encoding+` [source,js] ---- tinymce.init({ selector: 'textarea', - plugins: 'fullpage', - fullpage_default_encoding: 'ISO-8859-1' + plugins: 'fullpagehtml', + fullpagehtml_default_encoding: 'ISO-8859-1' }); ---- diff --git a/modules/ROOT/partials/configuration/fullpage-default-title.adoc b/modules/ROOT/partials/configuration/fullpagehtml-default-title.adoc similarity index 58% rename from modules/ROOT/partials/configuration/fullpage-default-title.adoc rename to modules/ROOT/partials/configuration/fullpagehtml-default-title.adoc index ea883e2fb8..4757ec509a 100644 --- a/modules/ROOT/partials/configuration/fullpage-default-title.adoc +++ b/modules/ROOT/partials/configuration/fullpagehtml-default-title.adoc @@ -1,5 +1,5 @@ -[[fullpage-default-title]] -== `+fullpage_default_title+` +[[fullpagehtml-default-title]] +== `+fullpagehtml_default_title+` This option enables you to specify the default title for the output HTML. @@ -9,13 +9,13 @@ This option enables you to specify the default title for the output HTML. *Default value:* No default value (empty string) -=== Example: using `+fullpage_default_title+` +=== Example: using `+fullpagehtml_default_title+` [source,js] ---- tinymce.init({ selector: 'textarea', - plugins: 'fullpage', - fullpage_default_title: 'My default page title' + plugins: 'fullpagehtml', + fullpagehtml_default_title: 'My default page title' }); ---- diff --git a/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc b/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc new file mode 100644 index 0000000000..d454ee99e6 --- /dev/null +++ b/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc @@ -0,0 +1,48 @@ +[[fullpagehtml-hide-in-source-view]] +== `+fullpagehtml_hide_in_source_view+` + +This option enables you to control whether the full page HTML structure is hidden in source code view. + +*Type:* `+Boolean+` + +*Possible values:* `+true+` or `+false+` + +*Default value:* `+false+` + +=== Example: using `+fullpagehtml_hide_in_source_view+` + +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpagehtml', + fullpagehtml_hide_in_source_view: true +}); +---- + +When `+fullpagehtml_hide_in_source_view+` is set to `+true+`, the source code view will show only the body content without the full HTML document structure: + +.Example +[source,html] +---- +

Full page HTML Demo

+

This is the body content that users can edit.

+---- + +When set to `+false+` (default), the source code view shows the complete HTML document: + +.Example +[source,html] +---- + + + + + Full Page HTML Plugin Demo Document + + +

Full page HTML Demo

+

This is the body content that users can edit.

+ + +---- diff --git a/modules/ROOT/partials/index-pages/premium-plugins.adoc b/modules/ROOT/partials/index-pages/premium-plugins.adoc index f6631dd3c4..09b45a8059 100644 --- a/modules/ROOT/partials/index-pages/premium-plugins.adoc +++ b/modules/ROOT/partials/index-pages/premium-plugins.adoc @@ -71,7 +71,7 @@ Export and generate content from {productname} into `document.pdf` format. a| [.lead] -xref:fullpage.adoc[Full Page] +xref:fullpagehtml.adoc[Full Page HTML] Edit document metadata and properties including title, keywords, and description via dialog interface. diff --git a/modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc b/modules/ROOT/partials/menu-item-ids/fullpagehtml-menu-items.adoc similarity index 51% rename from modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc rename to modules/ROOT/partials/menu-item-ids/fullpagehtml-menu-items.adoc index fe5ee66fea..04f566dc2e 100644 --- a/modules/ROOT/partials/menu-item-ids/fullpage-menu-items.adoc +++ b/modules/ROOT/partials/menu-item-ids/fullpagehtml-menu-items.adoc @@ -1,5 +1,5 @@ [cols="1,1,2",options="header"] |=== |Menu item identifier |xref:menus-configuration-options.adoc#example-the-tinymce-default-menu-items[Default Menu Location] |Description -|`+fullpage+` |File |Opens the Full Page dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. +|`+fullpagehtml+` |File |Opens the Full Page HTML dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. |=== diff --git a/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc b/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc deleted file mode 100644 index 32545ca11d..0000000000 --- a/modules/ROOT/partials/toolbar-button-ids/fullpage-toolbar-buttons.adoc +++ /dev/null @@ -1,5 +0,0 @@ -[cols="1,3",options="header"] -|=== -|Toolbar button identifier |Description -|`+fullpage+` |Opens the Full Page dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. -|=== diff --git a/modules/ROOT/partials/toolbar-button-ids/fullpagehtml-toolbar-buttons.adoc b/modules/ROOT/partials/toolbar-button-ids/fullpagehtml-toolbar-buttons.adoc new file mode 100644 index 0000000000..0f58aed82c --- /dev/null +++ b/modules/ROOT/partials/toolbar-button-ids/fullpagehtml-toolbar-buttons.adoc @@ -0,0 +1,5 @@ +[cols="1,3",options="header"] +|=== +|Toolbar button identifier |Description +|`+fullpagehtml+` |Opens the Full Page HTML dialog to edit document metadata and properties including title, keywords, description, and HTML structure settings. +|=== From 614ad7f9aff9c560ad5a6909579ef07a72d829dd Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 28 Aug 2025 11:59:55 +1000 Subject: [PATCH 03/15] DOC-3209: Update example to be more generic. --- .../fullpagehtml-hide-in-source-view.adoc | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc b/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc index d454ee99e6..510e8eeb99 100644 --- a/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc +++ b/modules/ROOT/partials/configuration/fullpagehtml-hide-in-source-view.adoc @@ -25,8 +25,12 @@ When `+fullpagehtml_hide_in_source_view+` is set to `+true+`, the source code vi .Example [source,html] ---- -

Full page HTML Demo

-

This is the body content that users can edit.

+

Welcome to Our Website

+

This is the main content area where users can edit text, add images, and format their content.

+
    +
  • First bullet point
    • +
  • Second bullet point
    • +
---- When set to `+false+` (default), the source code view shows the complete HTML document: @@ -41,8 +45,12 @@ When set to `+false+` (default), the source code view shows the complete HTML do Full Page HTML Plugin Demo Document -

Full page HTML Demo

-

This is the body content that users can edit.

+

Welcome to Our Website

+

This is the main content area where users can edit text, add images, and format their content.

+
    +
  • First bullet point
    • +
  • Second bullet point
    • +
---- From 8f16c7ec5638037a7c44a6bc102338eca7802352 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 28 Aug 2025 12:09:39 +1000 Subject: [PATCH 04/15] DOC-3209: Add release note entry for fullpagehtml. --- modules/ROOT/pages/8.1.0-release-notes.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/8.1.0-release-notes.adoc b/modules/ROOT/pages/8.1.0-release-notes.adoc index 3e7a6181b4..79f00b4eec 100644 --- a/modules/ROOT/pages/8.1.0-release-notes.adoc +++ b/modules/ROOT/pages/8.1.0-release-notes.adoc @@ -30,11 +30,11 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[] The following new Premium plugin was released alongside {productname} {release-version}. -// === +=== Full Page HTML -// The new Premium plugin, **** // description here. +The new Premium plugin, **Full Page HTML** provides comprehensive control over document metadata and properties. It enables users to edit HTML document metadata such as title, keywords, and description through an intuitive dialog interface. When combined with the code plugin, it also exposes the complete HTML structure including ``, ``, and various meta tags in the source code view. -// For information on the **** plugin, see xref:.adoc[]. +For information on the **Full Page HTML** plugin, see xref:fullpagehtml.adoc[Full Page HTML]. [[accompanying-premium-plugin-changes]] From 8f11b2df079a6bb4443cf117f9158e3621367c04 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 8 Sep 2025 16:26:27 +1000 Subject: [PATCH 05/15] DOC-3209: Updated live-demo and fix incorrect file name causing demo to fail. --- antora.yml | 2 +- .../examples/live-demos/fullpage/index.html | 3 --- .../live-demos/fullpagehtml/index.html | 21 +++++++++++++++++++ .../demo.js => fullpagehtml/index.js} | 3 +-- 4 files changed, 23 insertions(+), 6 deletions(-) delete mode 100644 modules/ROOT/examples/live-demos/fullpage/index.html create mode 100644 modules/ROOT/examples/live-demos/fullpagehtml/index.html rename modules/ROOT/examples/live-demos/{fullpage/demo.js => fullpagehtml/index.js} (91%) diff --git a/antora.yml b/antora.yml index 98a90fea0a..8aa13468ec 100644 --- a/antora.yml +++ b/antora.yml @@ -10,7 +10,7 @@ asciidoc: companyurl: https://www.tiny.cloud cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js - tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js + tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js tinydrive_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinydrive/8/tinydrive.min.js webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent/dist/tinymce-webcomponent.min.js jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js diff --git a/modules/ROOT/examples/live-demos/fullpage/index.html b/modules/ROOT/examples/live-demos/fullpage/index.html deleted file mode 100644 index 26f6869a1d..0000000000 --- a/modules/ROOT/examples/live-demos/fullpage/index.html +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/modules/ROOT/examples/live-demos/fullpagehtml/index.html b/modules/ROOT/examples/live-demos/fullpagehtml/index.html new file mode 100644 index 0000000000..0d217b04a0 --- /dev/null +++ b/modules/ROOT/examples/live-demos/fullpagehtml/index.html @@ -0,0 +1,21 @@ + diff --git a/modules/ROOT/examples/live-demos/fullpage/demo.js b/modules/ROOT/examples/live-demos/fullpagehtml/index.js similarity index 91% rename from modules/ROOT/examples/live-demos/fullpage/demo.js rename to modules/ROOT/examples/live-demos/fullpagehtml/index.js index 8fbb14ef71..9d5f2b8cc4 100644 --- a/modules/ROOT/examples/live-demos/fullpage/demo.js +++ b/modules/ROOT/examples/live-demos/fullpagehtml/index.js @@ -6,8 +6,7 @@ tinymce.init({ "help", "image", "insertdatetime", "link", "lists", "media", "preview", "searchreplace", "table", "visualblocks", ], - menubar: 'file', - toolbar: "undo redo | fullpagehtml | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image", + toolbar: "fullpagehtml | undo redo | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image", // Full Page HTML Plugin Configuration Options fullpagehtml_default_doctype: '', fullpagehtml_default_title: 'Full Page HTML Plugin Demo Document', From 4c4030a8dda230a92c15c1a170aad4253a638f80 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 8 Sep 2025 16:37:25 +1000 Subject: [PATCH 06/15] DOC-3209: add missing icon and remove old legacy icon. --- .../ROOT/images/icons/default-document-properties.svg | 1 + modules/ROOT/images/icons/document-properties.svg | 10 ---------- modules/ROOT/partials/configuration/icon_list.adoc | 2 +- 3 files changed, 2 insertions(+), 11 deletions(-) create mode 100644 modules/ROOT/images/icons/default-document-properties.svg delete mode 100644 modules/ROOT/images/icons/document-properties.svg diff --git a/modules/ROOT/images/icons/default-document-properties.svg b/modules/ROOT/images/icons/default-document-properties.svg new file mode 100644 index 0000000000..bc305f278e --- /dev/null +++ b/modules/ROOT/images/icons/default-document-properties.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/modules/ROOT/images/icons/document-properties.svg b/modules/ROOT/images/icons/document-properties.svg deleted file mode 100644 index eba5de0b3f..0000000000 --- a/modules/ROOT/images/icons/document-properties.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - icon-document-properties - Created with Sketch. - - - - - \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/icon_list.adoc b/modules/ROOT/partials/configuration/icon_list.adoc index 69835f6847..07dc1217ff 100644 --- a/modules/ROOT/partials/configuration/icon_list.adoc +++ b/modules/ROOT/partials/configuration/icon_list.adoc @@ -57,7 +57,7 @@ | `+cut-column+` | image:icons/cut-column.svg[cut-column.svg] | `+cut-column.svg+` | `+cut-row+` | image:icons/cut-row.svg[cut-row.svg] | `+cut-row.svg+` | `+cut+` | image:icons/cut.svg[cut.svg] | `+cut.svg+` -| `+document-properties+` | image:icons/document-properties.svg[document-properties.svg] | `+document-properties.svg+` +| `+default-document-properties+` | image:icons/default-document-properties.svg[default-document-properties.svg] | `+default-document-properties.svg+` | `+drag+` | image:icons/drag.svg[drag.svg] | `+drag.svg+` | `+dropbox+` | image:icons/dropbox.svg[dropbox.svg] | `+dropbox.svg+` | `+duplicate-column+` | image:icons/duplicate-column.svg[duplicate-column.svg] | `+duplicate-column.svg+` From 952848ced0e57c534173fe747200781a8d369623 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 11 Sep 2025 11:59:31 +1000 Subject: [PATCH 07/15] DOC-2309: Add links to xss_sanitization and valid_elements explaining some meta tags could be removed by default. --- modules/ROOT/pages/fullpagehtml.adoc | 40 +++++++++++++++++++ .../misc/admon-inline-not-supported.adoc | 1 + 2 files changed, 41 insertions(+) create mode 100644 modules/ROOT/partials/misc/admon-inline-not-supported.adoc diff --git a/modules/ROOT/pages/fullpagehtml.adoc b/modules/ROOT/pages/fullpagehtml.adoc index f7665f8044..0dd654b3a9 100644 --- a/modules/ROOT/pages/fullpagehtml.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -9,6 +9,8 @@ include::partial$misc/admon-premium-plugin.adoc[] +include::partial$misc/admon-inline-not-supported.adoc[] + The {pluginname} plugin provides comprehensive control over document metadata and properties. It enables users to edit HTML document metadata such as title, keywords, and description through an intuitive dialog interface. When combined with the code plugin, it also exposes the complete HTML structure including ``, ``, and various meta tags in the source code view. @@ -33,6 +35,44 @@ tinymce.init({ }); ---- +[WARNING] +==== +**Meta tags may be removed by XSS sanitization** + +By default, {productname} sanitizes HTML content to protect against XSS attacks, which may remove certain meta tags from the full page HTML. If integrators experience issues with meta tags being removed, the following configuration options are available, though not advisable: + +* `xss_sanitization: false` - Disables DOMPurify. +* `valid_elements: '*[*]'` - Allows all elements and attributes. + +See xref:security.adoc#xss_sanitization-option[xss_sanitization option] and xref:content-filtering.adoc#valid_elements[valid_elements option] for more information. + +**Preserving meta tags (advanced configuration)** + +If meta tags are being removed by XSS sanitization, the editor can be configured to preserve them using one of the following approaches, though these options are **not recommended**: + +.Example: using `+xss_sanitization+` to disable DOMPurify +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpagehtml', + toolbar: 'fullpagehtml', + xss_sanitization: false // Disables DOMPurify, TinyMCE's built-in XSS sanitization which allows potentially unsafe HTML content to be inserted +}); +---- + +.Example: using `+valid_elements+` to allow all elements and attributes +[source,js] +---- +tinymce.init({ + selector: 'textarea', + plugins: 'fullpagehtml', + toolbar: 'fullpagehtml', + valid_elements: '*[*]' // Allows all elements and attributes - use with caution +}); +---- +==== + == Options The following configuration options affect the behavior of the {pluginname} plugin. diff --git a/modules/ROOT/partials/misc/admon-inline-not-supported.adoc b/modules/ROOT/partials/misc/admon-inline-not-supported.adoc new file mode 100644 index 0000000000..c66ce38704 --- /dev/null +++ b/modules/ROOT/partials/misc/admon-inline-not-supported.adoc @@ -0,0 +1 @@ +NOTE: This feature is not supported when {productname} is run in _inline_ mode. It is only supported in _classic_ mode. For more information on the differences between the editing modes, see xref:use-tinymce-inline.adoc[Inline editing mode]. From 7399ca460bf684f69d2535a91137a738c9168ed9 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Fri, 12 Sep 2025 13:10:27 +1000 Subject: [PATCH 08/15] Update modules/ROOT/pages/fullpagehtml.adoc --- modules/ROOT/pages/fullpagehtml.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/fullpagehtml.adoc b/modules/ROOT/pages/fullpagehtml.adoc index 0dd654b3a9..cd8f2f4c9f 100644 --- a/modules/ROOT/pages/fullpagehtml.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -42,7 +42,7 @@ tinymce.init({ By default, {productname} sanitizes HTML content to protect against XSS attacks, which may remove certain meta tags from the full page HTML. If integrators experience issues with meta tags being removed, the following configuration options are available, though not advisable: * `xss_sanitization: false` - Disables DOMPurify. -* `valid_elements: '*[*]'` - Allows all elements and attributes. +* `valid_elements: '+*[*]'+` - Allows all elements and attributes. See xref:security.adoc#xss_sanitization-option[xss_sanitization option] and xref:content-filtering.adoc#valid_elements[valid_elements option] for more information. From c9185cd946c089de5298fe9312982120c18e0855 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Fri, 12 Sep 2025 13:14:28 +1000 Subject: [PATCH 09/15] Update modules/ROOT/pages/fullpagehtml.adoc --- modules/ROOT/pages/fullpagehtml.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/fullpagehtml.adoc b/modules/ROOT/pages/fullpagehtml.adoc index cd8f2f4c9f..43f636eafe 100644 --- a/modules/ROOT/pages/fullpagehtml.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -42,7 +42,7 @@ tinymce.init({ By default, {productname} sanitizes HTML content to protect against XSS attacks, which may remove certain meta tags from the full page HTML. If integrators experience issues with meta tags being removed, the following configuration options are available, though not advisable: * `xss_sanitization: false` - Disables DOMPurify. -* `valid_elements: '+*[*]'+` - Allows all elements and attributes. +* `+valid_elements: '*[*]'+` - Allows all elements and attributes. See xref:security.adoc#xss_sanitization-option[xss_sanitization option] and xref:content-filtering.adoc#valid_elements[valid_elements option] for more information. From 43d7ff92a626d12a7175ef2f30b8af271057663e Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 15 Sep 2025 15:59:28 +1000 Subject: [PATCH 10/15] Update antora.yml --- antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 8aa13468ec..98a90fea0a 100644 --- a/antora.yml +++ b/antora.yml @@ -10,7 +10,7 @@ asciidoc: companyurl: https://www.tiny.cloud cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js - tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js + tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js tinydrive_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinydrive/8/tinydrive.min.js webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent/dist/tinymce-webcomponent.min.js jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js From 3963ab0c8be71d97918b93b10c325c6ce8f1966c Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 16 Sep 2025 09:29:58 +1000 Subject: [PATCH 11/15] DOC-3254: Add known issue and plugin incompatibility issues with Suggested Edits and Revision History. --- modules/ROOT/pages/8.1.0-release-notes.adoc | 9 +++++---- modules/ROOT/pages/fullpagehtml.adoc | 11 +++++++++++ 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/8.1.0-release-notes.adoc b/modules/ROOT/pages/8.1.0-release-notes.adoc index 79f00b4eec..7012a6b19c 100644 --- a/modules/ROOT/pages/8.1.0-release-notes.adoc +++ b/modules/ROOT/pages/8.1.0-release-notes.adoc @@ -138,9 +138,10 @@ The following premium plugin updates were released alongside {productname} {rele This section describes issues that users of {productname} {release-version} may encounter and possible workarounds for these issues. -There known issue in {productname} {release-version}. +There is one known issue in {productname} {release-version}. -// === -// #TINY-vwxyz1 +=== Full Page HTML plugin incompatibility with Suggested Edits and Revision History + +The Full Page HTML plugin enables document properties and metadata to be set. However, these are not picked up by Suggested Edits and Revision History, and actions performed in these plugins will overwrite the values set by the Full Page plugin. -// CCFR here. \ No newline at end of file +**Workaround:** Avoid using the Full Page HTML plugin in combination with Suggested Edits or Revision History plugins to prevent data loss of document metadata and properties. \ No newline at end of file diff --git a/modules/ROOT/pages/fullpagehtml.adoc b/modules/ROOT/pages/fullpagehtml.adoc index 43f636eafe..ffc7e13c67 100644 --- a/modules/ROOT/pages/fullpagehtml.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -73,6 +73,17 @@ tinymce.init({ ---- ==== +[WARNING] +==== +**Incompatibility with Suggested Edits and Revision History** + +The Full Page HTML plugin is not compatible with the Suggested Edits and Revision History plugins. Document properties and metadata set by the Full Page HTML plugin are not currently preserved when using these collaboration features, and may be lost during the review process. + +**Recommendation:** Avoid using the Full Page HTML plugin in combination with Suggested Edits or Revision History plugins to prevent data loss of document metadata and properties at this current time until this issue is resolved. + +For more information, see the xref:8.1.0-release-notes.adoc#full-page-html-plugin-incompatibility-with-suggested-edits-and-revision-history[known issue] in the {productname} 8.1.0 release notes. +==== + == Options The following configuration options affect the behavior of the {pluginname} plugin. From af2b16310104c13b1731472fa77ee9d1867c3d84 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 16 Sep 2025 09:45:43 +1000 Subject: [PATCH 12/15] Update modules/ROOT/pages/fullpagehtml.adoc --- modules/ROOT/pages/fullpagehtml.adoc | 38 ++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/modules/ROOT/pages/fullpagehtml.adoc b/modules/ROOT/pages/fullpagehtml.adoc index ffc7e13c67..e85dd60730 100644 --- a/modules/ROOT/pages/fullpagehtml.adoc +++ b/modules/ROOT/pages/fullpagehtml.adoc @@ -37,40 +37,56 @@ tinymce.init({ [WARNING] ==== -**Meta tags may be removed by XSS sanitization** +**Certain elements may be removed by XSS sanitization** +By default, {productname} sanitizes HTML content to protect against XSS attacks. Elements outside the HTML5 specification, such as `