diff --git a/modules/ROOT/pages/bundling-plugins.adoc b/modules/ROOT/pages/bundling-plugins.adoc index 379e538d67..2e3d1dc394 100644 --- a/modules/ROOT/pages/bundling-plugins.adoc +++ b/modules/ROOT/pages/bundling-plugins.adoc @@ -7,17 +7,11 @@ include::partial$module-loading/bundling-ref-example.adoc[] :!editorcomponent: -The following table shows examples of the syntax used to bundle the following plugin. - -Required files for an example plugin: +include::partial$plugin-files/plugin-file-index.js.adoc[] -[source, js] ----- -./plugins/example/content.js // or './plugins/example/content_css.js' -./plugins/plugincode // the plugincode placeholder must be replaced with the specific plugincode ----- +The following table shows examples of the syntax used to bundle the following plugin. -Example syntax for including the example "plugin" in a bundle using `content.js` or `content_css.js` files for bundling: +Example syntax for including the example "plugin" in a bundle using `content.js`for bundling: [cols='1,1,4'] |=== @@ -28,16 +22,14 @@ Example syntax for including the example "plugin" in a bundle using `content.js` a| [source, js] ---- -import pluginCss from 'tinymce/plugins/example/content.js'; // or import pluginCss from 'tinymce/plugins/example/content_css.js'; -import 'tinymce/plugins/example'; +import 'tinymce/plugins/plugincode'; ---- |`.zip` a| [source, js] ---- -import '../tinymce/plugins/example/content.js'; // or import '../tinymce/plugins/example/content_css.js'; -import '../tinymce/plugins/example/plugin'; +import '../tinymce/plugins/plugincode'; ---- .2+|Common JS @@ -45,16 +37,14 @@ import '../tinymce/plugins/example/plugin'; a| [source, js] ---- -const pluginCss = require('tinymce/plugins/example/content.js'); // or require('tinymce/plugins/example/content_css.js'); -require('tinymce/plugins/example'); +require('tinymce/plugins/plugincode'); ---- |`.zip` a| [source, js] ---- -const pluginCss = require('../tinymce/plugins/example/content.js'); //or require('../tinymce/plugins/example/content_css.js'); -require('../tinymce/plugins/example/plugin.js'); +require('../tinymce/plugins/plugincode'); ---- |=== diff --git a/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc b/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc index 6a7f7e9b10..f88c389e1b 100644 --- a/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc +++ b/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc @@ -1,15 +1,26 @@ +[NOTE] +==== Plugin language files (such as `+./plugins/plugincode/langs/sv_SE.js+`) are required where the editor user interface is localized using the xref:ui-localization.adoc#language[language option]. The below plugins require these xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files] +* AI Assistant (+ai+) * Accessibility Checker (+a11ychecker+) +* Enhanced Code (+advcode+) * Enhanced Tables (+advtable+) -* Comments (+tinycomments+) -* ExportWord (+exportword+) -* Footnotes (+footnotes+) +* Templates (+advtemplate+) +* Spelling Autocorrect (+autocorrect+) * Image Editing (+editimage+) +* Export to PDF (+exportpdf+) +* Export to Word (+exportword+) +* Footnotes (+footnotes+) +* Import from Word (+importword+) * Merge Tags (+mergetags+) +* Page Embedding (+pageembed+) * PowerPaste (+powerpaste+) +* Revision History (+revisionhistory+) +* Table of Contents (+tableofcontents+) +* Comments (+tinycomments+) * Spell Checker (+tinymcespellchecker+) -* Spelling Autocorrect (+autocorrect+) -* Table of Contents (+tableofcontents+) \ No newline at end of file +* Typography (+typography+) +==== \ No newline at end of file diff --git a/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc b/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc index e639d49fc5..b8f8884df5 100644 --- a/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc +++ b/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc @@ -1,83 +1,30 @@ == Contents -include::partial$module-loading/bundling-plugins-that-cant-bundle.adoc[] - [[premium-plugins]] -== Premium plugins - -include::partial$plugin-files/plugin-file-bundling-message.adoc[] - -include::partial$plugin-files/plugin-file-index.js.adoc[] +=== Premium plugins [NOTE] -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -''' - -include::partial$plugin-files/plugin-file-bundling-also-requires.adoc[] - -[[a11ychecker]] -=== Accessibility Checker (`+a11ychecker+`) - -include::partial$plugin-files/plugin-file-list-a11ychecker.adoc[] - -[[tinycomments]] -=== Comments (`+tinycomments+`) - -include::partial$plugin-files/plugin-file-list-tinycomments.adoc[] - -[[advcode]] -=== Enhanced Code Editor (`+advcode+`) - -include::partial$plugin-files/plugin-file-list-advcode.adoc[] +Currently `.zip` style bundling is only available for premium plugins. -[[linkchecker]] -=== Link Checker (`+linkchecker+`) - -include::partial$plugin-files/plugin-file-list-linkchecker.adoc[] - -[[mediaembed]] -=== Media Embed (`+mediaembed+`) - -include::partial$plugin-files/plugin-file-list-mediaembed.adoc[] - -[[mentions]] -=== Mentions (`+mentions+`) - -include::partial$plugin-files/plugin-file-list-mentions.adoc[] - -[[pageembed]] -=== Pageembed (`+pageembed+`) - -include::partial$plugin-files/plugin-file-list-pageembed.adoc[] - -[[powerpaste]] -=== PowerPaste (`+powerpaste+`) - -include::partial$plugin-files/plugin-file-list-powerpaste.adoc[] +include::partial$plugin-files/plugin-file-bundling-message.adoc[] -''' +include::partial$module-loading/admon-bundling-plugin-langs.adoc[] [[community-plugins]] -== Community plugins +=== Community plugins include::partial$plugin-files/plugin-file-bundling-message.adoc[] -include::partial$plugin-files/plugin-file-index.js.adoc[] - -''' - include::partial$plugin-files/plugin-file-bundling-also-requires.adoc[] [[emoticons]] -=== Emoticons (`+emoticons+`) +==== Emoticons (`+emoticons+`) include::partial$plugin-files/plugin-file-list-emoticons.adoc[] -''' [[plugin-language-files]] -== Plugin language files +=== Plugin language files include::partial$module-loading/bundling-plugin-language-files.adoc[] \ No newline at end of file diff --git a/modules/ROOT/partials/module-loading/bundling-plugins-that-cant-bundle.adoc b/modules/ROOT/partials/module-loading/bundling-plugins-that-cant-bundle.adoc deleted file mode 100644 index 5423d522c6..0000000000 --- a/modules/ROOT/partials/module-loading/bundling-plugins-that-cant-bundle.adoc +++ /dev/null @@ -1,12 +0,0 @@ -[IMPORTANT] -==== -The following premium plugins *can not* be bundled if the {productname} version is earlier than **6.8.0**. However, if the {productname} version is equivalent to **v6.8.0** or **later**, the following premium plugins can be bundled: - -* Accessibility Checker (`+a11ychecker+`) -* Comments (`+tinycomments+`) -* Enhanced Code Editor (`+advcode+`) -* Enhanced Media Embed (`+mediaembed+`) -* Link Checker (`+linkchecker+`) -* Mentions (`+mentions+`) -* Page Embed (`+pageembed+`) -==== diff --git a/modules/ROOT/partials/plugin-files/plugin-file-bundling-also-requires.adoc b/modules/ROOT/partials/plugin-files/plugin-file-bundling-also-requires.adoc index 62a92166dd..81160b6fe5 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-bundling-also-requires.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-bundling-also-requires.adoc @@ -1,2 +1,2 @@ [TIP] -The below plugin/s also require the files outlined under each plugin section when bundling {productname} in addition to the xref:bundling-plugins.adoc#base-index-js-file[base `index.js`] file. \ No newline at end of file +The below plugin also requires the additional file along side the xref:bundling-plugins.adoc#base-folder[base folder]. \ No newline at end of file diff --git a/modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc b/modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc index a4993ed1de..f067014492 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc @@ -1 +1 @@ -When bundling plugins, replace the `+plugincode+` with the specific plugins from your {productname}. \ No newline at end of file +When bundling replace the `+plugincode+` with the specific plugins in your {productname} configuration. \ No newline at end of file diff --git a/modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc b/modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc index f61a8ae76c..3e310b430a 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc @@ -1,5 +1,8 @@ -[[base-index-js-file]] -.Base index.js required file for each plugin. +[[base-folder]] +== Required base folder + +The below base folder is required for each plugin when bundling {productname}. + [source, js] ---- ./plugins/plugincode