Skip to content

Commit 0475b29

Browse files
author
Farzad Hayat
authored
Port changes from 7x Docs for restructure of editor-plugin-version.adoc (#3340)
1 parent 6bef3d1 commit 0475b29

File tree

1 file changed

+68
-58
lines changed

1 file changed

+68
-58
lines changed
Lines changed: 68 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,45 @@
1-
= Specify editor version & plugins
1+
= Specify Editor Version & Plugins
22
:description_short: Specifying editor version and plugins for {cloudname} deployments.
33
:description: Instructions on setting the {productname} editor version and plugins for {cloudname} deployments.
4-
:keywords: tinymce, cloud, script, textarea, apiKey, hybrid
4+
:keywords: tinymce, cloud, script, textarea, apiKey, hybrid, dev, testing, production
55

66
[[specifying-the-tinymce-editor-version-deployed-from-cloud]]
7-
== Specifying the {productname} editor version from {cloudname}
7+
== Specifying the {productname} Editor Version from {cloudname}
88

9-
To set the {productname} version when deploying from {cloudname}, use the following URL:
9+
The example below shows the default way to load {productname} {productmajorversion} from {cloudname}. This URL ensures the most recent and verified version of {productname} is used.
1010

1111
[source,html,subs="attributes+"]
1212
----
1313
<script src="{cdnurl}" referrerpolicy="origin"></script>
1414
----
1515

16-
The example above shows the default way to load {productname} {productmajorversion} from {cloudname}. This URL ensures the most recent and verified version of {productname} is used.
17-
18-
[TIP]
19-
Replace 'no-api-key' with your own API key.
20-
21-
For more details, check out the xref:editor-and-features.adoc[{productname} editor via {cloudname}].
22-
23-
[[specifying-the-cloud-deployment-of-plugins]]
24-
== Specifying the Cloud Deployment of Plugins
25-
26-
When self-hosting {productname}, integrators have the choice to host premium plugins or load them from {companyname} Cloud (a.k.a. hybrid mode). Depending on your requirements, you can use a combination of both approaches.
27-
28-
include::partial$misc/admon-script-tag-placement.adoc[]
29-
30-
{companyname} offers the following configuration scripts to assist:
31-
32-
=== `plugin.min.js` Standalone with No Exclusions.
33-
34-
The `plugins.min.js` script loads every premium plugin the API key is entitled to from the CDN.
35-
36-
[source,html,subs="attributes+"]
37-
----
38-
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/plugins.min.js" referrerpolicy="origin"></script>
39-
----
40-
41-
=== `plugins.min.js` with Exclusions for Specific Plugins.
42-
43-
To exclude specific premium plugins from `plugins.min.js` because you are self-hosting them, add the excluded plugins to the script query parameters as shown below:
16+
To load a specific version of {productname} {productmajorversion} other than the latest release, replace the `{productmajorversion}` in the URL with the desired version. For example, to load a minor version such as {productname} `{productmajorversion}.1`, use the following URL:
4417

4518
[source,html,subs="attributes+"]
4619
----
47-
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/plugins.min.js?mentions=sdk&powerpaste=sdk" referrerpolicy="origin"></script>
20+
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}.1/tinymce.min.js" referrerpolicy="origin"></script>
4821
----
4922

50-
[NOTE]
51-
====
52-
Ensure that the excluded plugins' names are appended with `=sdk`, such as `mentions=sdk`.
53-
When {companyname} Cloud releases a new premium plugin, if you wish to self-host it this script tag will need to be updated to exclude it.
54-
====
55-
56-
=== `cloud-plugins.min.js` for Specific Premium Plugins from {companyname} Cloud.
57-
58-
The `cloud-plugins.min.js` script allows loading of specific premium plugins from {companyname} Cloud.
23+
To load a specific patch version, replace the `{productmajorversion}` in the URL with the desired patch version. For example, to load {productname} `{productmajorversion}.1.2`, use the following URL:
5924

6025
[source,html,subs="attributes+"]
6126
----
62-
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/cloud-plugins.min.js?mentions&powerpaste&advcode" referrerpolicy="origin"></script>
27+
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}.1.2/tinymce.min.js" referrerpolicy="origin"></script>
6328
----
6429

65-
[NOTE]
66-
This approach is intended for edge cases where you self-host most premium plugins on your own servers and only need one or two from {companyname} Cloud.
67-
68-
'''
30+
[TIP]
31+
Replace 'no-api-key' with your own API key.
6932

70-
=== Selecting Specific Editor Versions
33+
[#{productmajorversion}-{productmajorversion}-testing-and-{productmajorversion}-dev-release-channels]
34+
=== Difference between using {productname} {productmajorversion}, {productmajorversion}-Testing, and {productmajorversion}-Dev Release Channels
7135

7236
[IMPORTANT]
7337
====
7438
All {cloudname} channels are based on the {enterpriseversion} version.
75-
* For information on the latest version of the {cloudname} `{productmajorversion}` release channel, see: xref:release-notes.adoc[{productname} Release Notes].
76-
* For a list of changes that *may* be present in the {cloudname} testing channel, see: xref:changelog.adoc[{productname} Changelog].
77-
====
7839
79-
[#{productmajorversion}-{productmajorversion}-testing-and-{productmajorversion}-dev-release-channels]
80-
=== Difference between using {productname} {productmajorversion}, {productmajorversion}-Testing, and {productmajorversion}-Dev release channels
40+
* For complete information on the latest version of the {cloudname} `{productmajorversion}` Release Channel including premium changes, see: xref:release-notes.adoc[{productname} Release Notes].
41+
* For a summarized list of only the changes that affect the open-source version of {productname}, see: xref:changelog.adoc[{productname} Changelog].
42+
====
8143

8244
Choose from the `{productmajorversion}`, `{productmajorversion}-testing`, or `{productmajorversion}-dev` release channels to load the latest version of {productname} from {cloudname}.
8345

@@ -86,10 +48,10 @@ These channels are updated automatically and provide the latest {productname} ve
8648
[#{productmajorversion}-release-channel]
8749
==== {productmajorversion} Release Channel
8850

89-
This channel deploys the latest release of {productname} that has passed our quality assurance process. The current version of {productname} available through the `/{productmajorversion}` channel can be found on the https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}/version.txt[{cloudname} {productname} {productmajorversion} version page]. The {productname} {productmajorversion} channel can be loaded from `{cdnurl}`.
51+
This channel deploys the latest release of {productname} that has passed our quality assurance process. The current version of {productname} available through the `{productmajorversion}` channel can be found on the link:https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}/version.txt[{cloudname} {productname} {productmajorversion} version page].
9052

9153
[#example-using-the-{productmajorversion}-release-channel]
92-
===== Example: using the `{productmajorversion}` release channel
54+
===== Example: Using the `{productmajorversion}` Release Channel
9355

9456
[source,html,subs="attributes+"]
9557
----
@@ -99,7 +61,7 @@ This channel deploys the latest release of {productname} that has passed our qua
9961
[#{productmajorversion}-testing-release-channel]
10062
==== {productmajorversion}-Testing Release Channel
10163

102-
This channel deploys the current *release candidate* for the `{productmajorversion}` channel. The {productname} release candidate is undergoing quality assurance. The current version of {productname} available through the `{productmajorversion}-testing` channel can be found on the https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-testing/version.txt[{cloudname} {productname} {productmajorversion}-testing version page].
64+
This channel deploys the current *release candidate* for the `{productmajorversion}` channel. The {productname} release candidate is undergoing quality assurance. The current version of {productname} available through the `{productmajorversion}-testing` channel can be found on the link:https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-testing/version.txt[{cloudname} {productname} {productmajorversion}-testing version page].
10365

10466
[#example-using-the-{productmajorversion}-testing-release-channel]
10567
===== Example: Using the `{productmajorversion}-testing` Release Channel
@@ -114,7 +76,7 @@ This channel deploys the current *release candidate* for the `{productmajorversi
11476

11577
This channel deploys nightly builds of {productname}, which includes **unreleased changes** from the link:https://github.com/tinymce/tinymce/tree/main[{productname} repository^].
11678

117-
The current version of {productname} is available on the `{productmajorversion}-dev` channel can be found on the link:https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/version.txt[{cloudname} {productname} {productmajorversion}-dev version page^].
79+
The current version of {productname} available on the `{productmajorversion}-dev` channel can be found on the link:https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/version.txt[{cloudname} {productname} {productmajorversion}-dev version page^].
11880

11981

12082
[#example-using-the-{productmajorversion}-dev-release-channel]
@@ -123,4 +85,52 @@ The current version of {productname} is available on the `{productmajorversion}-
12385
[source,html,subs="attributes+"]
12486
----
12587
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/tinymce.min.js" referrerpolicy="origin"></script>
126-
----
88+
----
89+
90+
For more details, check out the xref:editor-and-features.adoc[{productname} editor via {cloudname}].
91+
92+
[[specifying-the-cloud-deployment-of-plugins]]
93+
== Specifying the Cloud Deployment of Plugins
94+
95+
When self-hosting {productname}, integrators have the choice to host premium plugins or load them from {companyname} Cloud (a.k.a. hybrid mode). Depending on your requirements, you can use a combination of both approaches.
96+
97+
include::partial$misc/admon-script-tag-placement.adoc[]
98+
99+
{companyname} offers the following configuration scripts to assist:
100+
101+
=== `plugin.min.js` Standalone with No Exclusions
102+
103+
The `plugins.min.js` script loads every premium plugin the API key is entitled to from the CDN.
104+
105+
[source,html,subs="attributes+"]
106+
----
107+
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/{productmajorversion}/plugins.min.js" referrerpolicy="origin"></script>
108+
----
109+
110+
=== `plugins.min.js` with Exclusions for Specific Plugins
111+
112+
To exclude specific premium plugins from `plugins.min.js` because you are self-hosting them, add the excluded plugins to the script query parameters as shown below:
113+
114+
[source,html,subs="attributes+"]
115+
----
116+
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/{productmajorversion}/plugins.min.js?mentions=sdk&powerpaste=sdk" referrerpolicy="origin"></script>
117+
----
118+
119+
[NOTE]
120+
====
121+
Ensure that the excluded plugins' names are appended with `=sdk`, such as `mentions=sdk`.
122+
123+
When {companyname} Cloud releases a new premium plugin, if you wish to self-host it, this script tag will need to be updated to exclude it.
124+
====
125+
126+
=== `cloud-plugins.min.js` for Specific Premium Plugins from {companyname} Cloud
127+
128+
The `cloud-plugins.min.js` script allows loading of specific premium plugins from {companyname} Cloud.
129+
130+
[source,html,subs="attributes+"]
131+
----
132+
<script src="https://cdn.tiny.cloud/1/api-key/tinymce/{productmajorversion}/cloud-plugins.min.js?mentions&powerpaste&advcode" referrerpolicy="origin"></script>
133+
----
134+
135+
[NOTE]
136+
This approach is intended for edge cases where you self-host most premium plugins on your own servers and only need one or two from {companyname} Cloud.

0 commit comments

Comments
 (0)