From 8025496aace73e8ad5ef4c9759ca1c0b7a0ffab1 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Thu, 11 Apr 2024 11:24:23 +1000 Subject: [PATCH] DOC-2368: Update bundling documentation for all premium plugins for new index.js files. --- modules/ROOT/pages/bundling-plugins.adoc | 14 +- .../admon-bundling-plugin-langs.adoc | 16 +- .../module-loading/bundling-plugin-files.adoc | 309 +----------------- .../bundling-plugin-language-files.adoc | 78 ++--- .../plugin-file-bundling-message.adoc | 1 + .../plugin-files/plugin-file-index.js.adoc | 6 + .../plugin-file-list-a11ychecker.adoc | 8 +- .../plugin-file-list-emoticons.adoc | 3 +- .../plugin-file-list-powerpaste.adoc | 8 +- .../plugin-file-list-tinycomments.adoc | 8 +- 10 files changed, 80 insertions(+), 371 deletions(-) create mode 100644 modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc create mode 100644 modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc diff --git a/modules/ROOT/pages/bundling-plugins.adoc b/modules/ROOT/pages/bundling-plugins.adoc index 721a60c14a..379e538d67 100644 --- a/modules/ROOT/pages/bundling-plugins.adoc +++ b/modules/ROOT/pages/bundling-plugins.adoc @@ -14,7 +14,7 @@ Required files for an example plugin: [source, js] ---- ./plugins/example/content.js // or './plugins/example/content_css.js' -./plugins/example/plugin.js +./plugins/plugincode // the plugincode placeholder must be replaced with the specific plugincode ---- Example syntax for including the example "plugin" in a bundle using `content.js` or `content_css.js` files for bundling: @@ -28,8 +28,7 @@ Example syntax for including the example "plugin" in a bundle using `content.js` a| [source, js] ---- -import pluginCss from 'tinymce/plugins/example/content.js'; -//import pluginCss from 'tinymce/plugins/example/content_css.js'; +import pluginCss from 'tinymce/plugins/example/content.js'; // or import pluginCss from 'tinymce/plugins/example/content_css.js'; import 'tinymce/plugins/example'; ---- @@ -37,8 +36,7 @@ import 'tinymce/plugins/example'; a| [source, js] ---- -import '../tinymce/plugins/example/content.js'; -//import '../tinymce/plugins/example/content_css.js'; +import '../tinymce/plugins/example/content.js'; // or import '../tinymce/plugins/example/content_css.js'; import '../tinymce/plugins/example/plugin'; ---- @@ -47,8 +45,7 @@ import '../tinymce/plugins/example/plugin'; a| [source, js] ---- -const pluginCss = require('tinymce/plugins/example/content.js'); -//require('tinymce/plugins/example/content_css.js'); +const pluginCss = require('tinymce/plugins/example/content.js'); // or require('tinymce/plugins/example/content_css.js'); require('tinymce/plugins/example'); ---- @@ -56,8 +53,7 @@ require('tinymce/plugins/example'); a| [source, js] ---- -const pluginCss = require('../tinymce/plugins/example/content.js'); -//require('../tinymce/plugins/example/content_css.js'); +const pluginCss = require('../tinymce/plugins/example/content.js'); //or require('../tinymce/plugins/example/content_css.js'); require('../tinymce/plugins/example/plugin.js'); ---- |=== 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 367803cf55..acec22b1e4 100644 --- a/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc +++ b/modules/ROOT/partials/module-loading/admon-bundling-plugin-langs.adoc @@ -1 +1,15 @@ -NOTE: The plugin language files (such as `+./plugins/plugin/langs/sv_SE.js+`) are required where the editor user interface is localized using the xref:ui-localization.adoc#language[language option]. Please refer to xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files] \ No newline at end of file +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]. Please refer to xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files] + +The below plugins require these xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files] + +* Enhanced Tables (+advtable+) +* Accessibility Checker (+a11ychecker+) +* Comments (+tinycomments+) +* ExportWord (+exportword+) +* Footnotes (+footnotes+) +* Image Editing (+editimage+) +* Merge Tags (+mergetags+) +* PowerPaste (+powerpaste+) +* Spell Checker (+tinymcespellchecker+) +* Spelling Autocorrect (+autocorrect+) +* Table of Contents (+tableofcontents+) \ 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 9b651ab29f..b78e8ca870 100644 --- a/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc +++ b/modules/ROOT/partials/module-loading/bundling-plugin-files.adoc @@ -2,336 +2,47 @@ include::partial$module-loading/bundling-plugins-that-cant-bundle.adoc[] -* xref:premium-plugins[Premium plugins] -** xref:accessibility-checker[Accessibility Checker (a11ychecker)] -** xref:case-change[Case Change (casechange)] -** xref:checklist[Checklist (checklist)] -** xref:comments[Comments (tinycomments)] -** xref:advanced-code[Enhanced Code Editor (advcode)] -** xref:advanced-code[Advanced Code (advcode)] -** xref:advanced-tables[Enhanced Tables (advtable)] -** xref:case-change[Case Change (casechange)] -** xref:checklist[Checklist (checklist)] -** xref:comments[Comments (tinycomments)] -** xref:enhanced-media-embed[Enhanced Media Embed (mediaembed)] -** xref:exportword[Export to Word (exportword)] -** xref:footnotes[Footnotes (footnotes)] -** xref:format-painter[Format Painter (formatpainter)] -** xref:link-checker[Link Checker (linkchecker)] -** xref:markdown[Markdown (markdown)] -** xref:mentions[Mentions (mentions)] -** xref:mergetags[Merge Tags] -** xref:page-embed[Page Embed (pageembed)] -** xref:permanent-pen[Permanent Pen (permanentpen)] -** xref:powerpaste[PowerPaste (powerpaste)] -** xref:spell-checker[Spell Checker (tinymcespellchecker)] -** xref:autocorrect[Spelling Autocorrect] -** xref:table-of-contents[Table of Contents (tableofcontents)] -* xref:community-plugins[Community plugins] -** xref:advanced-list[List Styles (advlist)] -** xref:anchor[Anchor (anchor)] -** xref:autolink[Autolink (autolink)] -** xref:autoresize[Autoresize (autoresize)] -** xref:autosave[Autosave (autosave)] -** xref:character-map[Character Map (charmap)] -** xref:code[Code (code)] -** xref:codesamplecodesample[Code Sample (codesample)] -** xref:directionality[Directionality (directionality)] -** xref:emoticons[Emoticons (emoticons)] -** xref:full-screen[Full Screen (fullscreen)] -** xref:help[Help (help)] -** xref:image[Image (image)] -** xref:image-editing[Image Editing (editimage)] -** xref:import-css[Import CSS (importcss)] -** xref:insert-datetime[Insert Date/Time (insertdatetime)] -** xref:link[Link (link)] -** xref:lists[Lists (lists)] -** xref:media[Media (media)] -** xref:nonbreaking-space[Nonbreaking Space (nonbreaking)] -** xref:page-break[Page Break (pagebreak)] -** xref:preview[Preview (preview)] -** xref:quick-toolbar[Quick Toolbar (quickbars)] -** xref:save[Save (save)] -** xref:search-and-replace[Search and Replace (searchreplace)] -** xref:table[Table (table)] -** xref:visual-blocks[Visual Blocks (visualblocks)] -** xref:visual-characters[Visual Characters (visualchars)] -** xref:word-count[Word Count (wordcount)] [[premium-plugins]] == Premium plugins -[[accessibility-checker]] -=== Accessibility Checker (`+a11ychecker+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-a11ychecker.adoc[] - +include::partial$plugin-files/plugin-file-bundling-message.adoc[] -[[advanced-tables]] -=== Enhanced Tables (`+advtable+`) +include::partial$plugin-files/plugin-file-index.js.adoc[] +[NOTE] +==== include::partial$module-loading/admon-bundling-plugin-langs.adoc[] +==== -include::partial$plugin-files/plugin-file-list-advtable.adoc[] - -[[case-change]] -=== Case Change (`+casechange+`) - -include::partial$plugin-files/plugin-file-list-casechange.adoc[] - -[[checklist]] -=== Checklist (`+checklist+`) +[[accessibility-checker]] +=== Accessibility Checker (`+a11ychecker+`) -include::partial$plugin-files/plugin-file-list-checklist.adoc[] +include::partial$plugin-files/plugin-file-list-a11ychecker.adoc[] [[comments]] === Comments (`+tinycomments+`) -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - include::partial$plugin-files/plugin-file-list-tinycomments.adoc[] -[[enhanced-code-editor]] -=== Enhanced Code Editor (`+advcode+`) - -include::partial$plugin-files/plugin-file-list-advcode.adoc[] - -[[enhanced-media-embed]] -=== Enhanced Media Embed (`+mediaembed+`) - -include::partial$plugin-files/plugin-file-list-mediaembed.adoc[] - -[[export-word]] -=== ExportWord (`+exportword+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-exportword.adoc[] - -[[footnotes]] -=== Footnotes (`+footnotes+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-footnotes.adoc[] - -[[format-painter]] -=== Format Painter (`+formatpainter+`) - -include::partial$plugin-files/plugin-file-list-formatpainter.adoc[] - -[[image-editing]] -=== Image Editing (`+editimage+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-editimage.adoc[] - -[[link-checker]] -=== Link Checker (`+linkchecker+`) - -include::partial$plugin-files/plugin-file-list-linkchecker.adoc[] - -[[markdown]] -=== Markdown (`+markdown+`) - -include::partial$plugin-files/plugin-file-list-markdown.adoc[] - -[[mentions]] -=== Mentions (`+mentions+`) - -include::partial$plugin-files/plugin-file-list-mentions.adoc[] - -[[mergetags]] -=== Merge Tags (`+mergetags+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-mergetags.adoc[] - -[[page-embed]] -=== Page Embed (`+pageembed+`) - -include::partial$plugin-files/plugin-file-list-pageembed.adoc[] - -[[permanent-pen]] -=== Permanent Pen (`+permanentpen+`) - -include::partial$plugin-files/plugin-file-list-permanentpen.adoc[] - [[powerpaste]] === PowerPaste (`+powerpaste+`) -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - include::partial$plugin-files/plugin-file-list-powerpaste.adoc[] -[[spell-checker]] -=== Spell Checker (`+tinymcespellchecker+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-tinymcespellchecker.adoc[] - -[[autocorrect]] -=== Spelling Autocorrect (`+autocorrect+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-autocorrect.adoc[] - -[[table-of-contents]] -=== Table of Contents (`+tableofcontents+`) - -include::partial$module-loading/admon-bundling-plugin-langs.adoc[] - -include::partial$plugin-files/plugin-file-list-tableofcontents.adoc[] [[community-plugins]] == Community plugins -[[list-styles]] -=== List Styles (`+advlist+`) - -include::partial$plugin-files/plugin-file-list-advlist.adoc[] - -[[anchor]] -=== Anchor (`+anchor+`) - -include::partial$plugin-files/plugin-file-list-anchor.adoc[] - -[[autolink]] -=== Autolink (`+autolink+`) - -include::partial$plugin-files/plugin-file-list-autolink.adoc[] - -[[autoresize]] -=== Autoresize (`+autoresize+`) - -include::partial$plugin-files/plugin-file-list-autoresize.adoc[] - -[[autosave]] -=== Autosave (`+autosave+`) - -include::partial$plugin-files/plugin-file-list-autosave.adoc[] - -[[character-map]] -=== Character Map (`+charmap+`) +include::partial$plugin-files/plugin-file-bundling-message.adoc[] -include::partial$plugin-files/plugin-file-list-charmap.adoc[] - -[[code]] -=== Code (`+code+`) - -include::partial$plugin-files/plugin-file-list-code.adoc[] - -[[codesamplecodesample]] -=== Code Sample (`+codesample+`) - -include::partial$plugin-files/plugin-file-list-codesample.adoc[] - -[[directionality]] -=== Directionality (`+directionality+`) - -include::partial$plugin-files/plugin-file-list-directionality.adoc[] +include::partial$plugin-files/plugin-file-index.js.adoc[] [[emoticons]] === Emoticons (`+emoticons+`) include::partial$plugin-files/plugin-file-list-emoticons.adoc[] -[[full-screen]] -=== Full Screen (`+fullscreen+`) - -include::partial$plugin-files/plugin-file-list-fullscreen.adoc[] - -[[help]] -=== Help (`+help+`) - -include::partial$plugin-files/plugin-file-list-help.adoc[] - -[[image]] -=== Image (`+image+`) - -include::partial$plugin-files/plugin-file-list-image.adoc[] - -[[import-css]] -=== Import CSS (`+importcss+`) - -include::partial$plugin-files/plugin-file-list-importcss.adoc[] - -[[insert-datetime]] -=== Insert Date/Time (`+insertdatetime+`) - -include::partial$plugin-files/plugin-file-list-insertdatetime.adoc[] - -[[link]] -=== Link (`+link+`) - -include::partial$plugin-files/plugin-file-list-link.adoc[] - -[[lists]] -=== Lists (`+lists+`) - -include::partial$plugin-files/plugin-file-list-lists.adoc[] - -[[media]] -=== Media (`+media+`) - -include::partial$plugin-files/plugin-file-list-media.adoc[] - -[[nonbreaking-space]] -=== Nonbreaking Space (`+nonbreaking+`) - -include::partial$plugin-files/plugin-file-list-nonbreaking.adoc[] - -[[page-break]] -=== Page Break (`+pagebreak+`) - -include::partial$plugin-files/plugin-file-list-pagebreak.adoc[] - -[[preview]] -=== Preview (`+preview+`) - -include::partial$plugin-files/plugin-file-list-preview.adoc[] - -[[quick-toolbar]] -=== Quick Toolbar (`+quickbars+`) - -include::partial$plugin-files/plugin-file-list-quickbars.adoc[] - -[[save]] -=== Save (`+save+`) - -include::partial$plugin-files/plugin-file-list-save.adoc[] - -[[search-and-replace]] -=== Search and Replace (`+searchreplace+`) - -include::partial$plugin-files/plugin-file-list-searchreplace.adoc[] - -[[table]] -=== Table (`+table+`) - -include::partial$plugin-files/plugin-file-list-table.adoc[] - -[[visual-blocks]] -=== Visual Blocks (`+visualblocks+`) - -include::partial$plugin-files/plugin-file-list-visualblocks.adoc[] - -[[visual-characters]] -=== Visual Characters (`+visualchars+`) - -include::partial$plugin-files/plugin-file-list-visualchars.adoc[] - -[[word-count]] -=== Word Count (`+wordcount+`) - -include::partial$plugin-files/plugin-file-list-wordcount.adoc[] - [[plugin-language-files]] == Plugin language files diff --git a/modules/ROOT/partials/module-loading/bundling-plugin-language-files.adoc b/modules/ROOT/partials/module-loading/bundling-plugin-language-files.adoc index 602ebcafe1..e91036fdc5 100644 --- a/modules/ROOT/partials/module-loading/bundling-plugin-language-files.adoc +++ b/modules/ROOT/partials/module-loading/bundling-plugin-language-files.adoc @@ -1,43 +1,43 @@ -IMPORTANT: Replace `` with the specific plugin name when adding the plugin language files to your config. +IMPORTANT: Replace `plugincode` placeholder with the specific `plugincode` when adding the plugin language files to your config. [source, js] ---- -./plugins//langs/ar.js -./plugins//langs/bg_BG.js -./plugins//langs/ca.js -./plugins//langs/cs.js -./plugins//langs/da.js -./plugins//langs/de.js -./plugins//langs/el.js -./plugins//langs/es.js -./plugins//langs/eu.js -./plugins//langs/fa.js -./plugins//langs/fi.js -./plugins//langs/fr_FR.js -./plugins//langs/he_IL.js -./plugins//langs/hi.js -./plugins//langs/hr.js -./plugins//langs/hu_HU.js -./plugins//langs/id.js -./plugins//langs/it.js -./plugins//langs/ja.js -./plugins//langs/kk.js -./plugins//langs/ko_KR.js -./plugins//langs/ms.js -./plugins//langs/nb_NO.js -./plugins//langs/nl.js -./plugins//langs/pl.js -./plugins//langs/pt_BR.js -./plugins//langs/pt_PT.js -./plugins//langs/ro.js -./plugins//langs/ru.js -./plugins//langs/sk.js -./plugins//langs/sl_SI.js -./plugins//langs/sv_SE.js -./plugins//langs/th_TH.js -./plugins//langs/tr.js -./plugins//langs/uk.js -./plugins//langs/vi.js -./plugins//langs/zh_CN.js -./plugins//langs/zh_TW.js +./plugins/plugincode/langs/ar.js +./plugins/plugincode/langs/bg_BG.js +./plugins/plugincode/langs/ca.js +./plugins/plugincode/langs/cs.js +./plugins/plugincode/langs/da.js +./plugins/plugincode/langs/de.js +./plugins/plugincode/langs/el.js +./plugins/plugincode/langs/es.js +./plugins/plugincode/langs/eu.js +./plugins/plugincode/langs/fa.js +./plugins/plugincode/langs/fi.js +./plugins/plugincode/langs/fr_FR.js +./plugins/plugincode/langs/he_IL.js +./plugins/plugincode/langs/hi.js +./plugins/plugincode/langs/hr.js +./plugins/plugincode/langs/hu_HU.js +./plugins/plugincode/langs/id.js +./plugins/plugincode/langs/it.js +./plugins/plugincode/langs/ja.js +./plugins/plugincode/langs/kk.js +./plugins/plugincode/langs/ko_KR.js +./plugins/plugincode/langs/ms.js +./plugins/plugincode/langs/nb_NO.js +./plugins/plugincode/langs/nl.js +./plugins/plugincode/langs/pl.js +./plugins/plugincode/langs/pt_BR.js +./plugins/plugincode/langs/pt_PT.js +./plugins/plugincode/langs/ro.js +./plugins/plugincode/langs/ru.js +./plugins/plugincode/langs/sk.js +./plugins/plugincode/langs/sl_SI.js +./plugins/plugincode/langs/sv_SE.js +./plugins/plugincode/langs/th_TH.js +./plugins/plugincode/langs/tr.js +./plugins/plugincode/langs/uk.js +./plugins/plugincode/langs/vi.js +./plugins/plugincode/langs/zh_CN.js +./plugins/plugincode/langs/zh_TW.js ---- \ 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 new file mode 100644 index 0000000000..a4993ed1de --- /dev/null +++ b/modules/ROOT/partials/plugin-files/plugin-file-bundling-message.adoc @@ -0,0 +1 @@ +When bundling plugins, replace the `+plugincode+` with the specific plugins from your {productname}. \ 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 new file mode 100644 index 0000000000..c7d76d6c3c --- /dev/null +++ b/modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc @@ -0,0 +1,6 @@ + +.Base index.js required file for each plugin. +[source, js] +---- +./plugins/plugincode +---- \ No newline at end of file diff --git a/modules/ROOT/partials/plugin-files/plugin-file-list-a11ychecker.adoc b/modules/ROOT/partials/plugin-files/plugin-file-list-a11ychecker.adoc index 96654c8258..4891e33065 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-list-a11ychecker.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-list-a11ychecker.adoc @@ -1,10 +1,4 @@ -.Base js file. -[source, js] ----- -./plugins/a11ychecker/plugin.js ----- - -.css or bundled css +.Requires css or bundled css [source, js] ---- ./plugins/a11ychecker/css/annotations.css // or diff --git a/modules/ROOT/partials/plugin-files/plugin-file-list-emoticons.adoc b/modules/ROOT/partials/plugin-files/plugin-file-list-emoticons.adoc index 71f0922db5..cff2b39e36 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-list-emoticons.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-list-emoticons.adoc @@ -1,7 +1,6 @@ -.Base js file +.Requires other js files [source, js] ---- -./plugins/emoticons/plugin.js ./plugins/emoticons/js/emojiimages.js ./plugins/emoticons/js/emojis.js ---- diff --git a/modules/ROOT/partials/plugin-files/plugin-file-list-powerpaste.adoc b/modules/ROOT/partials/plugin-files/plugin-file-list-powerpaste.adoc index 35ef74418f..84b1d18438 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-list-powerpaste.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-list-powerpaste.adoc @@ -1,10 +1,4 @@ -.Base js file -[source, js] ----- -./plugins/powerpaste/plugin.js ----- - -.other js files +.requires other js files [source, js] ---- ./plugins/powerpaste/js/wordimport.js diff --git a/modules/ROOT/partials/plugin-files/plugin-file-list-tinycomments.adoc b/modules/ROOT/partials/plugin-files/plugin-file-list-tinycomments.adoc index dcd3744dd9..ba11f521d8 100644 --- a/modules/ROOT/partials/plugin-files/plugin-file-list-tinycomments.adoc +++ b/modules/ROOT/partials/plugin-files/plugin-file-list-tinycomments.adoc @@ -1,10 +1,4 @@ -.Base js file -[source, js] ----- -./plugins/tinycomments/plugin.js ----- - -.css or bundled css +.Requires css or bundled css [source, js] ---- ./plugins/tinycomments/css/tinycomments.css //or