|
1 | | -= Specify editor & plugin versions |
2 | | -:description_short: Specifying editor and plugin versions for Tiny Cloud deployments. |
3 | | -:description: Specifying editor and plugin versions for Tiny Cloud deployments. |
| 1 | += Specify editor version & plugins |
| 2 | +:description_short: Specifying editor version and plugins for {cloudname} deployments. |
| 3 | +:description: Instructions on setting the {productname} editor version and plugins for {cloudname} deployments. |
4 | 4 | :keywords: tinymce, cloud, script, textarea, apiKey, hybrid |
5 | 5 |
|
6 | 6 | [[specifying-the-tinymce-editor-version-deployed-from-cloud]] |
7 | | -== Specifying the TinyMCE editor version deployed from Cloud |
| 7 | +== Specifying the {productname} editor version from {cloudname} |
8 | 8 |
|
9 | | -Use the URL provided to specify the {productname} version when deploying via {cloudname}. Refer to the xref:editor-and-features.adoc[{productname} editor via the {cloudname}] for more information. |
10 | | - |
11 | | -The following example is the default for loading {productname} {productmajorversion} via {cloudname}. Substitute 'no-api-key' with your api key in the examples below. |
| 9 | +To set the {productname} version when deploying from {cloudname}, use the following URL: |
12 | 10 |
|
13 | 11 | [source,html,subs="attributes+"] |
14 | 12 | ---- |
15 | 13 | <script src="{cdnurl}" referrerpolicy="origin"></script> |
16 | 14 | ---- |
17 | 15 |
|
18 | | -This URL specifies the latest and quality assured release of {productname}. |
| 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. |
19 | 17 |
|
20 | | -=== Selecting specific version numbers |
| 18 | +[TIP] |
| 19 | +Replace 'no-api-key' with your own API key. |
21 | 20 |
|
22 | | -NOTE: All {cloudname} channels are based on the {enterpriseversion} version. For information on the latest version of the {cloudname} `{productmajorversion}` release channel, see: xref:release-notes.adoc[{productname} Release Notes]. For a list of changes that *may* be present in the {cloudname} testing channel, see: xref:changelog.adoc[{productname} Changelog]. |
| 21 | +For more details, check out the xref:editor-and-features.adoc[{productname} editor via {cloudname}]. |
23 | 22 |
|
24 | | -[#{productmajorversion}-{productmajorversion}-testing-and-{productmajorversion}-dev-release-channels] |
25 | | -=== {productmajorversion}, {productmajorversion}-testing, and {productmajorversion}-dev release channels |
| 23 | +[[specifying-the-cloud-deployment-of-plugins]] |
| 24 | +== Specifying the Cloud Deployment of Plugins |
26 | 25 |
|
27 | | -Choose from the `{productmajorversion}`, `{productmajorversion}-testing`, or `{productmajorversion}-dev` release channels to load the latest version of {productname} from {cloudname}. |
| 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. |
28 | 27 |
|
29 | | -These channels are updated automatically and provide the latest {productname} version that matches the criteria below. |
| 28 | +include::partial$misc/admon-script-tag-placement.adoc[] |
30 | 29 |
|
31 | | -[#{productmajorversion}-release-channel] |
32 | | -==== {productmajorversion} release channel |
| 30 | +{companyname} offers the following configuration scripts to assist: |
33 | 31 |
|
34 | | -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}`. |
| 32 | +=== `plugin.min.js` Standalone with No Exclusions. |
35 | 33 |
|
36 | | -[#example-using-the-{productmajorversion}-release-channel] |
37 | | -===== Example: using the `{productmajorversion}` release channel |
| 34 | +The `plugins.min.js` script loads every premium plugin the API key is entitled to from the CDN. |
38 | 35 |
|
39 | 36 | [source,html,subs="attributes+"] |
40 | 37 | ---- |
41 | | -<script src="{cdnurl}" referrerpolicy="origin"></script> |
| 38 | +<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/plugins.min.js" referrerpolicy="origin"></script> |
42 | 39 | ---- |
43 | 40 |
|
44 | | -[#{productmajorversion}-testing-release-channel] |
45 | | -==== {productmajorversion}-testing release channel |
46 | | - |
47 | | -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]. |
| 41 | +=== `plugins.min.js` with Exclusions for Specific Plugins. |
48 | 42 |
|
49 | | -[#example-using-the-{productmajorversion}-testing-release-channel] |
50 | | -===== Example: using the `{productmajorversion}-testing` release channel |
| 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: |
51 | 44 |
|
52 | 45 | [source,html,subs="attributes+"] |
53 | 46 | ---- |
54 | | -<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-testing/tinymce.min.js" referrerpolicy="origin"></script> |
| 47 | +<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/plugins.min.js?mentions=sdk&powerpaste=sdk" referrerpolicy="origin"></script> |
55 | 48 | ---- |
56 | 49 |
|
57 | | -[#{productmajorversion}-dev-release-channel] |
58 | | -==== {productmajorversion}-dev release channel |
| 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 | +==== |
59 | 55 |
|
60 | | -This channel deploys nightly builds of {productname}. This channel includes the unreleased changes documented in the https://github.com/tinymce/tinymce/blob/develop/modules/tinymce/CHANGELOG.md[{productname} changelog]. The current version of {productname} available through the `{productmajorversion}-dev` channel can be found on the https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/version.txt[{cloudname} {productname} {productmajorversion}-dev version page]. |
| 56 | +=== `cloud-plugins.min.js` for Specific Premium Plugins from {companyname} Cloud. |
61 | 57 |
|
62 | | -[#example-using-the-{productmajorversion}-dev-release-channel] |
63 | | -===== Example: using the `{productmajorversion}-dev` release channel |
| 58 | +The `cloud-plugins.min.js` script allows loading of specific premium plugins from {companyname} Cloud. |
64 | 59 |
|
65 | 60 | [source,html,subs="attributes+"] |
66 | 61 | ---- |
67 | | -<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/tinymce.min.js" referrerpolicy="origin"></script> |
| 62 | +<script src="https://cdn.tiny.cloud/1/api-key/tinymce/6/cloud-plugins.min.js?mentions&powerpaste&advcode" referrerpolicy="origin"></script> |
68 | 63 | ---- |
69 | 64 |
|
70 | | -== Specifying the version of premium plugins deployed from Tiny Cloud |
71 | | - |
72 | | -Each {productname} version is bundled with a set of premium plugins, but it is possible to specify different versions of each premium plugin to use with {productname}. Use the URL query parameters to specify the version of each premium plugin to load. This approach works with both the xref:editor-and-features.adoc[{productname} editor and premium plugins deployment via {cloudname}] or just the xref:features-only.adoc[premium plugins deployment from {cloudname}]. |
73 | | - |
74 | | -The `+identifier+` of the plugin is used as a query parameter. This table summarises the possible options. |
75 | | - |
76 | | -[cols=",,",options="header"] |
77 | | -|=== |
78 | | -|Plugin |Identifier |Supported Versions |
79 | | -|xref:a11ychecker.adoc[Accessibility Checker] |`+a11ychecker+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/a11ychecker/available-versions[Versions] |
80 | | -|xref:advcode.adoc[Advanced Code Editor] |`+advcode+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/advcode/available-versions[Versions] |
81 | | -|xref:advtable.adoc[Advanced Tables] |`+advtable+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/advtable/available-versions[Versions] |
82 | | -|xref:advanced-typography.adoc[Advanced Typography] |`+typography+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/advtable/available-versions[Versions] |
83 | | -|xref:casechange.adoc[Case Change] |`+casechange+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/casechange/available-versions[Versions] |
84 | | -|xref:checklist.adoc[Checklist] |`+checklist+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/checklist/available-versions[Versions] |
85 | | -|xref:introduction-to-tiny-comments.adoc[Comments] |`+comments+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/tinycomments/available-versions[Versions] |
86 | | -|xref:editimage.adoc[Enhanced Image Editing] |`+editimage+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/editimage/available-versions[Versions] |
87 | | -|xref:introduction-to-mediaembed.adoc[Enhanced Media Embed] |`+mediaembed+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/mediaembed/available-versions[Versions] |
88 | | -|xref:export.adoc[Export] |`+export+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/export/available-versions[Versions] |
89 | | -|xref:footnotes.adoc[Footnotes] |`+footnotes+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/footnotes/available-versions[Versions] |
90 | | -|xref:formatpainter.adoc[Format Painter] |`+formatpainter+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/formatpainter/available-versions[Versions] |
91 | | -|xref:inline-css.adoc[Inline CSS] |`+inlinecss+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/formatpainter/available-versions[Versions] |
92 | | -|xref:linkchecker.adoc[Link Checker] |`+linkchecker+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/linkchecker/available-versions[Versions] |
93 | | -|xref:mentions.adoc[Mentions] |`+mentions+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/mentions/available-versions[Versions] |
94 | | -|xref:mergetags.adoc[Merge Tags] |`+mergetags+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/mergetags/available-versions[Versions] |
95 | | -|xref:pageembed.adoc[Page Embed] |`+pageembed+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/pageembed/available-versions[Versions] |
96 | | -|xref:permanentpen.adoc[Permanent Pen] |`+permanentpen+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/permanentpen/available-versions[Versions] |
97 | | -|xref:introduction-to-powerpaste.adoc[PowerPaste] |`+powerpaste+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/powerpaste/available-versions[Versions] |
98 | | -|xref:rtc-getting-started.adoc[Real-Time Collaboration (RTC)] |`+rtc+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/powerpaste/available-versions[Versions] |
99 | | -|xref:introduction-to-tiny-spellchecker.adoc[Spell Checker Pro] |`+tinymcespellchecker+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/tinymcespellchecker/available-versions[Versions] |
100 | | -|xref:autocorrect.adoc[Spelling Autocorrect] |`+autocorrect+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/autocorrect/available-versions[Versions] |
101 | | -|xref:tableofcontents.adoc[Table of Contents] |`+tableofcontents+`|http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/tableofcontents/available-versions[Versions] |
102 | | -|xref:tinydrive-introduction.adoc[Tiny Drive] |`+tinydrive+` |http://cdn.tiny.cloud/1/no-api-key/tinymce-plugins/tinydrive/available-versions[Versions] |
103 | | -|=== |
104 | | - |
105 | | -=== Specifying versions for the editor and premium plugin deployment |
106 | | - |
107 | | -When deploying xref:editor-and-features.adoc[both the editor and premium plugins from {cloudname}], {productname} will load the premium plugins bundled with that version of the editor. To load a different version of a premium plugin, append the name of the plugin and the version to load as query parameters. The version must match one of the versions listed in the `+Supported Versions+` link for the relevant plugin. |
108 | | - |
109 | | -Combine multiple plugin specifications using `+&+` in your query string. For example, to load: |
110 | | - |
111 | | -* mentions v3.0 |
112 | | -* powerpaste v6.0 |
113 | | -* all other premium plugins from those bundled with `{productmajorversion}` |
114 | | - |
115 | | -Append `+?mentions=3.0&powerpaste=6.0+`, such as: |
| 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. |
116 | 67 |
|
117 | | -[source,html,subs="attributes+"] |
118 | | ----- |
119 | | -<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}/tinymce.min.js?mentions=3.0&powerpaste=6.0" referrerpolicy="origin"></script> |
120 | | ----- |
| 68 | +''' |
121 | 69 |
|
122 | | -=== Specifying a self-hosted deployment of features/plugins |
| 70 | +=== Selecting Specific Editor Versions |
123 | 71 |
|
124 | | -When deploying xref:features-only.adoc[only premium plugins from {cloudname}], some features are served from {cloudname} and some features served from a self-hosted installation. There are two ways to achieve this: `+plugins.min.js+` and `+cloud-plugins.min.js+`. |
| 72 | +[IMPORTANT] |
| 73 | +==== |
| 74 | +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 | +==== |
125 | 78 |
|
126 | | -==== plugins.min.js |
| 79 | +[#{productmajorversion}-{productmajorversion}-testing-and-{productmajorversion}-dev-release-channels] |
| 80 | +=== Difference between using {productname} {productmajorversion}, {productmajorversion}-Testing, and {productmajorversion}-Dev release channels |
127 | 81 |
|
128 | | -Instead of loading `+tinymce.min.js+` from {cloudname}, serve {productname} from a self-hosted server, and load `+plugins.min.js+` from {cloudname}. {productname} which will attempt to load every *premium* plugin from {cloudname}, unless the version of the plugin is specified as the special version `+sdk+`. The query string for `+plugins.min.js+` works the same way as `+tinymce.min.js+`, except for the addition of `+sdk+`. For example, this script tag: |
| 82 | +Choose from the `{productmajorversion}`, `{productmajorversion}-testing`, or `{productmajorversion}-dev` release channels to load the latest version of {productname} from {cloudname}. |
129 | 83 |
|
130 | | -The following example: |
| 84 | +These channels are updated automatically and provide the latest {productname} version based on the following criteria: |
131 | 85 |
|
132 | | -* Assumes {productname} has already been loaded by another script on the page. |
133 | | -* Attempts to load `+mentions+` `+v3.0+` and `+powerpaste+` `+v6.0+` from {cloudname}. |
134 | | -* Attempts to load `+advcode+` from the self-hosted installation. |
135 | | -* Attempts to load all other premium plugins from those bundled with version `{productmajorversion}` of {productname}. |
| 86 | +[#{productmajorversion}-release-channel] |
| 87 | +==== {productmajorversion} Release Channel |
| 88 | + |
| 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}`. |
| 90 | + |
| 91 | +[#example-using-the-{productmajorversion}-release-channel] |
| 92 | +===== Example: using the `{productmajorversion}` release channel |
136 | 93 |
|
137 | 94 | [source,html,subs="attributes+"] |
138 | 95 | ---- |
139 | | -<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}/plugins.min.js?mentions=3.0&powerpaste=6.0&advcode=sdk" referrerpolicy="origin"></script> |
| 96 | +<script src="{cdnurl}" referrerpolicy="origin"></script> |
140 | 97 | ---- |
141 | 98 |
|
142 | | -The disadvantage of `+plugins.min.js+`: to load only one plugin from the {cloudname} and the rest from a self-hosted deployment, *ALL* other plugins need to be added as query parameter with the version as `+sdk+`. When {cloudname} releases a new plugin, this will need to be updated. In situations where most premium plugins need to be loaded from a self-hosted deployment, use `+cloud-plugins.min.js+`. |
| 99 | +[#{productmajorversion}-testing-release-channel] |
| 100 | +==== {productmajorversion}-Testing Release Channel |
143 | 101 |
|
144 | | -==== cloud-plugins.min.js |
| 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]. |
145 | 103 |
|
146 | | -Instead of loading `+tinymce.min.js+` from {cloudname}, serve {productname} from a self-hosted server, and load `+cloud-plugins.min.js+` from {cloudname}. Unlike `+plugins.min.js+`, `+cloud-plugins.min.js+` defaults to loading every *premium* plugin from the *self-hosted {productname} installation*, not {cloudname}. However, plugins can be loaded from {cloudname} by specifying them as query parameters. |
| 104 | +[#example-using-the-{productmajorversion}-testing-release-channel] |
| 105 | +===== Example: Using the `{productmajorversion}-testing` Release Channel |
147 | 106 |
|
148 | | -With `+cloud-plugins.min.js+`, the plugins listed in the query strings do not require a version. If there is no version specified, {productname} uses the version bundled with the {productname} version requested. There is also no need to specify `+sdk+` as the version for any plugin, as that is the default. |
| 107 | +[source,html,subs="attributes+"] |
| 108 | +---- |
| 109 | +<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-testing/tinymce.min.js" referrerpolicy="origin"></script> |
| 110 | +---- |
| 111 | + |
| 112 | +[#{productmajorversion}-dev-release-channel] |
| 113 | +==== {productmajorversion}-Dev Release Channel |
| 114 | + |
| 115 | +This channel deploys nightly builds of {productname}, which includes **unreleased changes** from the link:https://github.com/tinymce/tinymce/tree/main[{productname} repository^]. |
149 | 116 |
|
150 | | -The following example: |
| 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^]. |
151 | 118 |
|
152 | | -* Assumes {productname} has already been loaded by another script on the page. |
153 | | -* Attempts to load `+mentions+` `+v3.0+` and `+powerpaste+` `+v6.0+` from {cloudname}. |
154 | | -* Attempts to load `+advcode+` from the version bundled with version `{productmajorversion}` of {productname} because it doesn't specify a version. |
155 | | -* Attempts to load all other premium plugins from the self-hosted installation. |
| 119 | + |
| 120 | +[#example-using-the-{productmajorversion}-dev-release-channel] |
| 121 | +===== Example: Using the `{productmajorversion}-dev` Release Channel |
156 | 122 |
|
157 | 123 | [source,html,subs="attributes+"] |
158 | 124 | ---- |
159 | | -<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}/cloud-plugins.min.js?mentions=3.0&powerpaste=6.0&advcode" referrerpolicy="origin"></script> |
160 | | ----- |
161 | | - |
162 | | -The disadvantage of `+cloud-plugins.min.js+`: every plugin to be loaded from {cloudname} must be added to the query parameter. When {cloudname} releases a new plugin, this will need to be updated. In situations where most premium plugins need to be loaded from {cloudname}, use `+plugins.min.js+`. |
| 125 | +<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/{productmajorversion}-dev/tinymce.min.js" referrerpolicy="origin"></script> |
| 126 | +---- |
0 commit comments