Skip to content

Commit a2885b8

Browse files
kemister85kemister85
committed
DOC-3329: Copy edits, improvements and structural changes.
1 parent a47e2f4 commit a2885b8

27 files changed

+100
-151
lines changed

‎modules/ROOT/pages/bundling-plugins.adoc‎

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
include::partial$module-loading/bundling-ref-example.adoc[]
88
:!editorcomponent:
99

10-
[NOTE]
11-
If using {productname} 7.0.1 or earlier, please refer to link:https://www.tiny.cloud/docs/tinymce/6/bundling-plugins/[Bundling {productname} plugins using module loading] from the {productname} v6 documentation guide.
12-
1310
include::partial$plugin-files/plugin-file-index.js.adoc[]
1411

1512

@@ -38,14 +35,14 @@ import 'tinymce-premium/plugins/<plugincode>';
3835
a|
3936
[source, js]
4037
----
41-
import '../tinymce/plugins/<plugincode>';
38+
import '<path_to_tinymce_zip>/plugins/<plugincode>';
4239
----
4340

4441
|`.zip` (premium plugins)
4542
a|
4643
[source, js]
4744
----
48-
import '../tinymce-premium/plugins/<plugincode>';
45+
import '<path_to_tinymce_premium_zip>/plugins/<plugincode>';
4946
----
5047

5148
.4+|Common JS
@@ -67,14 +64,14 @@ require('tinymce-premium/plugins/<plugincode>');
6764
a|
6865
[source, js]
6966
----
70-
require('../tinymce/plugins/<plugincode>');
67+
require('<path_to_tinymce_zip>/plugins/<plugincode>');
7168
----
7269

7370
|`.zip` (premium plugins)
7471
a|
7572
[source, js]
7673
----
77-
require('../tinymce-premium/plugins/<plugincode>');
74+
require('<path_to_tinymce_premium_zip>/plugins/<plugincode>');
7875
----
7976
|===
8077

@@ -88,6 +85,27 @@ When using `+import tinymce from 'tinymce'+`, import only the individual premium
8885

8986
After installing the `+tinymce-premium+` package, you need to configure the plugins in your editor. There are two main approaches:
9087

88+
=== License key manager
89+
90+
[IMPORTANT]
91+
====
92+
Always include the `+licensekeymanager+` plugin when using premium plugins with a commercial license. The editor will not function properly without it. For more information, see: xref:license-key.adoc[License Key].
93+
====
94+
95+
When bundling:
96+
[source,js]
97+
----
98+
import 'tinymce-premium/plugins/licensekeymanager';
99+
----
100+
101+
When using `+external_plugins+`:
102+
[source,js]
103+
----
104+
external_plugins: {
105+
'licensekeymanager': '<path_to_premium_plugins>/licensekeymanager/plugin.min.js'
106+
}
107+
----
108+
91109
=== Bundling (Recommended)
92110

93111
For most modern applications, bundling premium plugins is recommended. This includes the plugin code directly in your application bundle.
@@ -97,8 +115,9 @@ For most modern applications, bundling premium plugins is recommended. This incl
97115
[source,js]
98116
----
99117
import 'tinymce-premium/plugins/advcode';
100-
import 'tinymce-premium/plugins/licensekeymanager';
101118
import 'tinymce-premium/plugins/tinycomments';
119+
// Always include the licensekeymanager plugin when using premium plugins with a commercial license.
120+
import 'tinymce-premium/plugins/licensekeymanager';
102121
----
103122

104123
. Add the plugins to your editor configuration:
@@ -113,7 +132,7 @@ tinymce.init({
113132
});
114133
----
115134

116-
For complete bundling examples, see the <<Contents>> section below.
135+
For complete bundling examples, see the <<premium-plugins,Premium plugins>> and <<community-plugins,Community plugins>> sections below.
117136

118137
=== Using external_plugins (Non-bundling)
119138

@@ -125,9 +144,9 @@ tinymce.init({
125144
selector: 'textarea',
126145
license_key: 'T8LK:...', // Your commercial license key
127146
external_plugins: {
128-
'advcode': '/node_modules/tinymce-premium/plugins/advcode/plugin.min.js',
129-
'licensekeymanager': '/node_modules/tinymce-premium/plugins/licensekeymanager/plugin.min.js',
130-
'tinycomments': '/node_modules/tinymce-premium/plugins/tinycomments/plugin.min.js'
147+
'advcode': '<path_to_premium_plugins>/advcode/plugin.min.js',
148+
'licensekeymanager': '<path_to_premium_plugins>/licensekeymanager/plugin.min.js',
149+
'tinycomments': '<path_to_premium_plugins>/tinycomments/plugin.min.js'
131150
},
132151
plugins: 'advcode tinycomments',
133152
// ... other configuration
@@ -145,25 +164,4 @@ The `+external_plugins+` option supports three URL formats:
145164
For more information, see: xref:editor-important-options.adoc#external_plugins[`+external_plugins+` configuration option].
146165
====
147166

148-
=== License key manager
149-
150-
[IMPORTANT]
151-
====
152-
Always include the `+licensekeymanager+` plugin when using premium plugins with a commercial license. The editor will not function properly without it. For more information, see: xref:license-key.adoc[License Key].
153-
====
154-
155-
When bundling:
156-
[source,js]
157-
----
158-
import 'tinymce-premium/plugins/licensekeymanager';
159-
----
160-
161-
When using `+external_plugins+`:
162-
[source,js]
163-
----
164-
external_plugins: {
165-
'licensekeymanager': '/node_modules/tinymce-premium/plugins/licensekeymanager/plugin.min.js'
166-
}
167-
----
168-
169167
include::partial$module-loading/bundling-plugin-files.adoc[]

‎modules/ROOT/pages/cloud-quick-start.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::partial$misc/admon-account-creation-and-social-option.adoc[]
1313

1414
== Include the {productname} script
1515

16-
Include the following line of code in the `+<head>+` of an HTML page:
16+
Include the following line of code in the `+<head>+` of a HTML page:
1717

1818
[source,html,subs="attributes+"]
1919
----

‎modules/ROOT/pages/dotnet-projects.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Ensure the `+tinymce+` directory containing the `+tinymce.min.js+` file is acces
3030

3131
== Include the {productname} script
3232

33-
Include the following line of code in the `+<head>+` of an HTML page:
33+
Include the following line of code in the `+<head>+` of a HTML page:
3434

3535
[source,html,subs="attributes+"]
3636
----

‎modules/ROOT/pages/license-key.adoc‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,29 @@ The commercial license key manager is available:
3737
The following setup steps are **required** for the editor to function with commercial license keys. The editor will not work without proper license key manager configuration.
3838
====
3939

40-
If hosting {productname} standalone, for example, in a `/public` folder, **ensure** the `+licensekeymanager+` folder is included in the `+plugins+` folder with all of the other plugins. The editor will not function without this.
40+
== Considerations when hosting vs bundling
4141

42-
If bundling {productname} as part of an application **ensure** the `+licensekeymanager/index.js+` file is imported, otherwise the editor will not function without this.
42+
* If **hosting** {productname} standalone, for example, in a `/public` folder, **ensure** the `+licensekeymanager+` folder is included in the `+plugins+` folder with all of the other plugins. The editor will not function without this.
43+
* If **bundling** {productname} as part of an application **ensure** the `+licensekeymanager/index.js+` file is imported, otherwise the editor will not function without this.
4344

44-
.Example importing the License Key Manager in a bundled application
45-
+
4645
When using the `+tinymce+` NPM package with premium plugins from ZIP:
46+
4747
[source,javascript]
4848
----
4949
import 'tinymce/plugins/licensekeymanager';
5050
----
51-
+
51+
5252
When using the `+tinymce-premium+` NPM package (recommended):
53+
5354
[source,javascript]
5455
----
5556
import 'tinymce-premium/plugins/licensekeymanager';
5657
----
57-
+
58+
5859
[NOTE]
5960
====
60-
The `+licensekeymanager+` plugin is included in the `+tinymce-premium+` package. The `+tinymce-premium+` package version aligns with the `+tinymce+` package version (e.g., both at 8.3.0).
61+
* The `+licensekeymanager+` plugin is included in the `+tinymce-premium+` package.
62+
* The `+tinymce-premium+` package version must match the `+tinymce+` package version (e.g., both at 8.3.0).
6163
====
6264

6365
== License Types and Deployment Options

‎modules/ROOT/pages/npm-projects.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ Install the `+tinymce-premium+` package using npm:
6060
npm install tinymce-premium@^8.3
6161
----
6262

63+
include::partial$install/npm-premium-version-note.adoc[]
64+
6365
[NOTE]
6466
====
6567
* For {productname} 8.3, the `+tinymce-premium+` package is only published to the NPM registry. Other package manager registries (Packagist/Composer, NuGet etc.) may be considered for future releases.
@@ -99,7 +101,7 @@ For framework-specific integration guides, see:
99101

100102
== Include the {productname} script
101103

102-
Include the following line of code in the `+<head>+` of an HTML page:
104+
Include the following line of code in the `+<head>+` of a HTML page:
103105

104106
[source,html,subs="attributes+"]
105107
----

‎modules/ROOT/pages/php-projects.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The location of the main {productname} script will be: `+vendor/tinymce/tinymce/
2121

2222
== Include the {productname} script
2323

24-
Include the following line of code in the `+<head>+` of an HTML page:
24+
Include the following line of code in the `+<head>+` of a HTML page:
2525

2626
[source,html,subs="attributes+"]
2727
----

‎modules/ROOT/pages/zip-install.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For commercial customers using premium plugins, you can install the `+tinymce-pr
2727

2828
== Include the {productname} script
2929

30-
Include the following line of code in the `+<head>+` of an HTML page:
30+
Include the following line of code in the `+<head>+` of a HTML page:
3131

3232
[source,html,subs="attributes+"]
3333
----

‎modules/ROOT/partials/install/npm-premium-plugins-install.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ For commercial customers using premium plugins, install the `+tinymce-premium+`
77
npm install tinymce-premium@^8.3
88
----
99

10+
include::partial$install/npm-premium-version-note.adoc[]
11+
1012
Or install a specific version:
1113

1214
[source,sh]

‎modules/ROOT/partials/install/npm-premium-version-note.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[IMPORTANT]
2+
====
3+
The `+tinymce-premium@^8.3+` package is for {productname} 8.3 onwards.
4+
====
5+

‎modules/ROOT/partials/integrations/premium-plugins-bundling.adoc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
import 'tinymce-premium/plugins/advcode';
33
import 'tinymce-premium/plugins/tinycomments';
44
// Always include the licensekeymanager plugin when using premium plugins with a commercial license.
5-
// For more information, see: License Key documentation.
65
import 'tinymce-premium/plugins/licensekeymanager';

0 commit comments

Comments
 (0)