Specify editor & plugin versions

Specifying the OpenTiny editor version deployed from Cloud

Use the URL provided to specify the OpenTiny version when deploying via Tiny Cloud. Refer to the OpenTiny editor via the Tiny Cloud for more information.

The following example is the default for loading OpenTiny 6 via Tiny Cloud. Substitute 'no-api-key' with your api key in the examples below.

<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6/tinymce.min.js" referrerpolicy="origin"></script>

This URL specifies the latest and quality assured release of OpenTiny.

Selecting specific version numbers

All Tiny Cloud channels are based on the OpenTiny Enterprise version. For information on the latest version of the Tiny Cloud 6 release channel, see: OpenTiny Release Notes. For a list of changes that may be present in the Tiny Cloud testing channel, see: OpenTiny Changelog.

6, 6-testing, and 6-dev release channels

Choose from the 6, 6-testing, or 6-dev release channels to load the latest version of OpenTiny from Tiny Cloud.

These channels are updated automatically and provide the latest OpenTiny version that matches the criteria below.

6 release channel

This channel deploys the latest release of OpenTiny that has passed our quality assurance process. The current version of OpenTiny available through the /6 channel can be found on the Tiny Cloud OpenTiny 6 version page. The OpenTiny 6 channel can be loaded from https://cdn.tiny.cloud/1/no-api-key/tinymce/6/tinymce.min.js.

Example: using the 6 release channel
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6/tinymce.min.js" referrerpolicy="origin"></script>

6-testing release channel

This channel deploys the current release candidate for the 6 channel. The OpenTiny release candidate is undergoing quality assurance. The current version of OpenTiny available through the 6-testing channel can be found on the Tiny Cloud OpenTiny 6-testing version page.

Example: using the 6-testing release channel
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6-testing/tinymce.min.js" referrerpolicy="origin"></script>

6-dev release channel

This channel deploys nightly builds of OpenTiny. This channel includes the unreleased changes documented in the OpenTiny changelog. The current version of OpenTiny available through the 6-dev channel can be found on the Tiny Cloud OpenTiny 6-dev version page.

Example: using the 6-dev release channel
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6-dev/tinymce.min.js" referrerpolicy="origin"></script>

Specifying the version of premium plugins deployed from Tiny Cloud

Each OpenTiny version is bundled with a set of premium plugins, but it is possible to specify different versions of each premium plugin to use with OpenTiny. Use the URL query parameters to specify the version of each premium plugin to load. This approach works with both the OpenTiny editor and premium plugins deployment via Tiny Cloud or just the premium plugins deployment from Tiny Cloud.

The identifier of the plugin is used as a query parameter. This table summarises the possible options.

Plugin Identifier Supported Versions

Accessibility Checker

a11ychecker

Versions

Advanced Code Editor

advcode

Versions

Advanced Tables

advtable

Versions

Advanced Typography

typography

Versions

Case Change

casechange

Versions

Checklist

checklist

Versions

Comments

comments

Versions

Enhanced Image Editing

editimage

Versions

Enhanced Media Embed

mediaembed

Versions

Export

export

Versions

Footnotes

footnotes

Versions

Format Painter

formatpainter

Versions

Inline CSS

inlinecss

Versions

Link Checker

linkchecker

Versions

Mentions

mentions

Versions

Merge Tags

mergetags

Versions

Page Embed

pageembed

Versions

Permanent Pen

permanentpen

Versions

PowerPaste

powerpaste

Versions

Spell Checker Pro

tinymcespellchecker

Versions

Spelling Autocorrect

autocorrect

Versions

Table of Contents

tableofcontents

Versions

Tiny Drive

tinydrive

Versions

Specifying versions for the editor and premium plugin deployment

When deploying both the editor and premium plugins from Tiny Cloud, OpenTiny 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.

Combine multiple plugin specifications using & in your query string. For example, to load:

  • mentions v3.0

  • powerpaste v6.0

  • all other premium plugins from those bundled with 6

Append ?mentions=3.0&powerpaste=6.0, such as:

<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6/tinymce.min.js?mentions=3.0&powerpaste=6.0" referrerpolicy="origin"></script>

Specifying a self-hosted deployment of features/plugins

When deploying only premium plugins from Tiny Cloud, some features are served from Tiny Cloud and some features served from a self-hosted installation. There are two ways to achieve this: plugins.min.js and cloud-plugins.min.js.

plugins.min.js

Instead of loading tinymce.min.js from Tiny Cloud, serve OpenTiny from a self-hosted server, and load plugins.min.js from Tiny Cloud. OpenTiny which will attempt to load every premium plugin from Tiny Cloud, 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:

The following example:

  • Assumes OpenTiny has already been loaded by another script on the page.

  • Attempts to load mentions v3.0 and powerpaste v6.0 from Tiny Cloud.

  • Attempts to load advcode from the self-hosted installation.

  • Attempts to load all other premium plugins from those bundled with version 6 of OpenTiny.

<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6/plugins.min.js?mentions=3.0&powerpaste=6.0&advcode=sdk" referrerpolicy="origin"></script>

The disadvantage of plugins.min.js: to load only one plugin from the Tiny Cloud and the rest from a self-hosted deployment, ALL other plugins need to be added as query parameter with the version as sdk. When Tiny Cloud 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.

cloud-plugins.min.js

Instead of loading tinymce.min.js from Tiny Cloud, serve OpenTiny from a self-hosted server, and load cloud-plugins.min.js from Tiny Cloud. Unlike plugins.min.js, cloud-plugins.min.js defaults to loading every premium plugin from the self-hosted OpenTiny installation, not Tiny Cloud. However, plugins can be loaded from Tiny Cloud by specifying them as query parameters.

With cloud-plugins.min.js, the plugins listed in the query strings do not require a version. If there is no version specified, OpenTiny uses the version bundled with the OpenTiny version requested. There is also no need to specify sdk as the version for any plugin, as that is the default.

The following example:

  • Assumes OpenTiny has already been loaded by another script on the page.

  • Attempts to load mentions v3.0 and powerpaste v6.0 from Tiny Cloud.

  • Attempts to load advcode from the version bundled with version 6 of OpenTiny because it doesn’t specify a version.

  • Attempts to load all other premium plugins from the self-hosted installation.

<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/6/cloud-plugins.min.js?mentions=3.0&powerpaste=6.0&advcode" referrerpolicy="origin"></script>

The disadvantage of cloud-plugins.min.js: every plugin to be loaded from Tiny Cloud must be added to the query parameter. When Tiny Cloud releases a new plugin, this will need to be updated. In situations where most premium plugins need to be loaded from Tiny Cloud, use plugins.min.js.