Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2368: Update bundling documentation for all premium plugins for new index.js files. #3224

Merged
merged 17 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
8025496
DOC-2368: Update bundling documentation for all premium plugins for n…
kemister85 Apr 11, 2024
cd11eb9
DOC-2368: additional improvements.
kemister85 Apr 11, 2024
60cae0e
DOC-2368: additional copy edits to bundling-plugins.adoc and related …
kemister85 Apr 11, 2024
4e7cde1
Merge branch 'release/docs-7' into feature/7.1/DOC-2368
kemister85 Apr 15, 2024
411dbe1
Revert "DOC-2339: On-premises documentation for document converters. …
kemister85 Apr 15, 2024
c2fbb72
DOC-2368: update plugin code ref.
kemister85 Apr 15, 2024
6be1b3d
DOC-2368: delete plugin-file-plugins.adoc pages, update plugin.js for…
kemister85 Apr 15, 2024
6d123da
Merge branch 'tinymce/7' into feature/7.1/DOC-2368
kemister85 Apr 16, 2024
7bae1a6
Merge branch 'release/7.1' into feature/7.1/DOC-2368
kemister85 Apr 16, 2024
de54098
Update modules/ROOT/partials/plugin-files/plugin-file-bundling-messag…
kemister85 Apr 23, 2024
36a3de2
Update modules/ROOT/partials/plugin-files/plugin-file-index.js.adoc
kemister85 Apr 23, 2024
8ce34ee
Update modules/ROOT/partials/plugin-files/plugin-file-bundling-also-r…
kemister85 Apr 23, 2024
94641a8
Update modules/ROOT/pages/bundling-plugins.adoc
kemister85 Apr 23, 2024
cabcacb
Update modules/ROOT/pages/bundling-plugins.adoc
kemister85 Apr 23, 2024
260cea3
DOC-2368: update plugin-file-list-emoticons.adoc file to include note.
kemister85 Apr 23, 2024
e1b23dc
DOC-2368: add note to reference back to the tinymce v6 docs if versio…
kemister85 Apr 23, 2024
b86d89b
Update modules/ROOT/pages/bundling-plugins.adoc
kemister85 Apr 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions modules/ROOT/pages/bundling-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,13 @@
include::partial$module-loading/bundling-ref-example.adoc[]
:!editorcomponent:

The following table shows examples of the syntax used to bundle the following plugin.
[NOTE]
If using {productname} 7.0 or earlier, please refer to the link:https://www.tiny.cloud/docs/tinymce/6/bundling-plugins/[Bundling TinyMCE plugins using module loading] from the {productname} v6 documentation guide.
kemister85 marked this conversation as resolved.
Show resolved Hide resolved

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/example/plugin.js
----

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 "<plugincode>" plugin in a bundle using `content.js`for bundling:

[cols='1,1,4']
|===
Expand All @@ -28,37 +24,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';
//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';
//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');
//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');
//require('../tinymce/plugins/example/content_css.js');
require('../tinymce/plugins/example/plugin.js');
require('../tinymce/plugins/<plugincode>');
----
|===

Expand Down
59 changes: 29 additions & 30 deletions modules/ROOT/partials/integrations/react-quick-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -460,37 +460,36 @@ import './tinymce/icons/default/icons.min.js';
// Editor styles
import './tinymce/skins/ui/oxide/skin.min.js';

// importing the plugin js.
// importing the plugin index.js file.
// if you use a plugin that is not listed here the editor will fail to load
import './tinymce/plugins/advlist/plugin.min.js';
import './tinymce/plugins/anchor/plugin.min.js';
import './tinymce/plugins/autolink/plugin.min.js';
import './tinymce/plugins/autoresize/plugin.min.js';
import './tinymce/plugins/autosave/plugin.min.js';
import './tinymce/plugins/charmap/plugin.min.js';
import './tinymce/plugins/code/plugin.min.js';
import './tinymce/plugins/codesample/plugin.min.js';
import './tinymce/plugins/directionality/plugin.min.js';
import './tinymce/plugins/emoticons/plugin.min.js';
import './tinymce/plugins/fullscreen/plugin.min.js';
import './tinymce/plugins/help/plugin.min.js';
import './tinymce/plugins/help/js/i18n/keynav/en.js';
import './tinymce/plugins/image/plugin.min.js';
import './tinymce/plugins/importcss/plugin.min.js';
import './tinymce/plugins/insertdatetime/plugin.min.js';
import './tinymce/plugins/link/plugin.min.js';
import './tinymce/plugins/lists/plugin.min.js';
import './tinymce/plugins/media/plugin.min.js';
import './tinymce/plugins/nonbreaking/plugin.min.js';
import './tinymce/plugins/pagebreak/plugin.min.js';
import './tinymce/plugins/preview/plugin.min.js';
import './tinymce/plugins/quickbars/plugin.min.js';
import './tinymce/plugins/save/plugin.min.js';
import './tinymce/plugins/searchreplace/plugin.min.js';
import './tinymce/plugins/table/plugin.min.js';
import './tinymce/plugins/visualblocks/plugin.min.js';
import './tinymce/plugins/visualchars/plugin.min.js';
import './tinymce/plugins/wordcount/plugin.min.js';
import './tinymce/plugins/advlist';
import './tinymce/plugins/anchor';
import './tinymce/plugins/autolink';
import './tinymce/plugins/autoresize';
import './tinymce/plugins/autosave';
import './tinymce/plugins/charmap';
import './tinymce/plugins/code';
import './tinymce/plugins/codesample';
import './tinymce/plugins/directionality';
import './tinymce/plugins/emoticons';
import './tinymce/plugins/fullscreen';
import './tinymce/plugins/help';
import './tinymce/plugins/image';
import './tinymce/plugins/importcss';
import './tinymce/plugins/insertdatetime';
import './tinymce/plugins/link';
import './tinymce/plugins/lists';
import './tinymce/plugins/media';
import './tinymce/plugins/nonbreaking';
import './tinymce/plugins/pagebreak';
import './tinymce/plugins/preview';
import './tinymce/plugins/quickbars';
import './tinymce/plugins/save';
import './tinymce/plugins/searchreplace';
import './tinymce/plugins/table';
import './tinymce/plugins/visualblocks';
import './tinymce/plugins/visualchars';
import './tinymce/plugins/wordcount';

// importing plugin resources
import './tinymce/plugins/emoticons/js/emojis.js';
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
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]
[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+)
* 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+)
* Typography (+typography+)
====
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ require('../tinymce/js/tinymce/models/dom/model.js');
require('../tinymce/js/tinymce/skins/ui/oxide/skin.css');

/* Import plugins - include the relevant plugin in the 'plugins' option. */
require('../tinymce/js/tinymce/plugins/advlist/plugin.js');
require('../tinymce/js/tinymce/plugins/code/plugin.js');
require('../tinymce/js/tinymce/plugins/emoticons/plugin.js');
require('../tinymce/js/tinymce/plugins/advlist');
require('../tinymce/js/tinymce/plugins/code');
require('../tinymce/js/tinymce/plugins/emoticons');
require('../tinymce/js/tinymce/plugins/emoticons/js/emojis');
require('../tinymce/js/tinymce/plugins/link/plugin.js');
require('../tinymce/js/tinymce/plugins/lists/plugin.js');
require('../tinymce/js/tinymce/plugins/table/plugin.js');
require('../tinymce/js/tinymce/plugins/link');
require('../tinymce/js/tinymce/plugins/lists');
require('../tinymce/js/tinymce/plugins/table');

/* content UI CSS is required */
const contentUiSkinCss = fs.readFileSync('tinymce/js/tinymce/skins/ui/oxide/content.css', { encoding: 'UTF-8' });
Expand Down
Loading
Loading