Skip to content

Commit

Permalink
DOC-2368: additional copy edits to bundling-plugins.adoc and related …
Browse files Browse the repository at this point in the history
…partials,includes.
  • Loading branch information
kemister85 committed Apr 11, 2024
1 parent cd11eb9 commit 60cae0e
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 98 deletions.
24 changes: 7 additions & 17 deletions modules/ROOT/pages/bundling-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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']
|===
Expand All @@ -28,33 +22,29 @@ 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
|npm
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');
----
|===

Expand Down
Original file line number Diff line number Diff line change
@@ -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+)
* Typography (+typography+)
====
67 changes: 7 additions & 60 deletions modules/ROOT/partials/module-loading/bundling-plugin-files.adoc
Original file line number Diff line number Diff line change
@@ -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[]

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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.
The below plugin also requires the additional file along side the xref:bundling-plugins.adoc#base-folder[base folder].
Original file line number Diff line number Diff line change
@@ -1 +1 @@
When bundling plugins, replace the `+plugincode+` with the specific plugins from your {productname}.
When bundling replace the `+plugincode+` with the specific plugins in your {productname} configuration.
7 changes: 5 additions & 2 deletions modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 60cae0e

Please sign in to comment.