Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2acbde5
DOC-3202: Add migration guides for users migrating from TinyMCE 4,5 t…
kemister85 Apr 24, 2025
d6c410c
DOC-3202: add migration guide outline initial.
kemister85 May 13, 2025
4688e86
DOC-3202: Fix formatting for plugin migration examples in migration g…
kemister85 May 13, 2025
5ca7ecd
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 13, 2025
380001c
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 14, 2025
3cc1af0
Update modules/ROOT/pages/migration-from-5x.adoc
kemister85 May 14, 2025
51d8b7e
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 20, 2025
7226b42
Update modules/ROOT/pages/migration-from-5x.adoc
kemister85 May 20, 2025
7208ba5
Update modules/ROOT/pages/migration-from-5x.adoc
kemister85 May 20, 2025
431e621
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 20, 2025
80da356
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 20, 2025
91a1eb2
Update modules/ROOT/pages/migration-from-5x.adoc
kemister85 May 20, 2025
008a4d1
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 20, 2025
96dc4f9
Update modules/ROOT/pages/migration-from-4x.adoc
kemister85 May 20, 2025
05e3196
Update modules/ROOT/pages/migration-from-5x.adoc
kemister85 May 20, 2025
f76d032
DOC-3202: copy edits, improvements based on feedback.
kemister85 May 21, 2025
ebfc5cf
DOC-3202: fix nesting and syntax issues.
kemister85 May 21, 2025
c2cb082
DOC-3202: add missing imagetools legacy plugin.
kemister85 May 21, 2025
ee579b0
DOC-3202: Update migration guides: refine plugin migration examples a…
kemister85 May 21, 2025
0cca86c
DOC-3202: update information around theme and skins.
kemister85 May 21, 2025
fcfb0c0
DOC-3202: update plugin exosystem information.
kemister85 May 21, 2025
1625ed8
DOC-3202: copy edits, cleanup.
kemister85 May 21, 2025
0401325
DOC-3202: fix indentation for code blocks.
kemister85 May 21, 2025
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
2 changes: 2 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,8 @@
**** xref:bundling-localization.adoc[UI localizations]
**** xref:bundling-themes.adoc[Themes]
** xref:upgrading.adoc[Upgrading {productname}]
** xref:migration-from-4x.adoc[Migrating from {productname} 4]
** xref:migration-from-5x.adoc[Migrating from {productname} 5]
** xref:migration-from-6x.adoc[Migrating from {productname} 6]
** xref:migration-from-froala.adoc[Migrating from Froala]
** xref:generate-rsa-key-pairs.adoc[Generate public key pairs]
Expand Down
149 changes: 149 additions & 0 deletions modules/ROOT/pages/migration-from-4x.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
= Migrating from {productname} 4 to {productname} {release-version}
:navtitle: Migrating from TinyMCE 4
:description: Guidance for migrating from TinyMCE 4 to TinyMCE {release-version}
:keywords: migration, considerations, premigration, pre-migration
:release-version: 7.0


== Overview

{productname} has evolved significantly from version 4 to version {release-version}, introducing major architectural changes, modern UI improvements, enhanced performance, and better security. This guide outlines the critical breaking changes, recommended migration action steps, and top-level configuration adjustments required to upgrade from {productname} v4 to v{release-version}.

== Key Changes

=== UI Themes and Skins

* **Removed**: modern, lightgray, and mobile themes/skins.
* **New**: silver theme with oxide skin (supports light and dark variants). see xref:customize-ui.adoc#themes[customize-ui].
* **Impact**: Custom v4 skins/themes are incompatible with v{release-version} and must be rewritten using the oxide skin structure.

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
skin: "oxide-dark",
content_css: "dark",
});
----

=== Plugin Ecosystem

// The contextmenu plugin was absorbed into core, the options still works, see https://www.tiny.cloud/docs/tinymce/latest/contextmenu/. not sure why this is mentioned as removed.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
* **Removed**: `colorpicker`, `contextmenu`, `imagetools`, `legacyoutput`, `bbcode`, `fullpage`, `template`, `print`, `spellchecker`, and `tabfocus` plugins.
* **Core Integrations**: Many plugins are now part of the core (e.g., `paste`, `hr`, `noneditable`, `table`).
* **Premium Only**: Plugins like `spellchecker`, `tableofcontents`, `mediaembed` are now premium.

Plugin Migration Examples:

* `contextmenu` (Removed in v5):
** Replace with browser-native context menus or custom menu logic.
** Consider using link:https://www.tiny.cloud/docs/tinymce/latest/apis/tinymce.editor.ui.registry/#addContextMenu[editor.ui.registry.addContextMenu] for custom right-click actions.
* `bbcode` (Removed in v6):
** Replace with custom parsing or server-side processing if needed.
* `fullpage` (Removed in v6):
** No direct replacement. Use custom templates or server-side processing for full HTML documents.
* `template` (Removed in v{release-version}):
** Use premium xref:advanced-templates.adoc[advtemplate] or implement custom modal dialogs for templating.
* `textcolor` (Removed in v6):
** Use `forecolor` and `backcolor` buttons instead.

Comment thread
kemister85 marked this conversation as resolved.
.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
toolbar: "undo redo | forecolor backcolor | bold italic | alignleft aligncenter alignright alignjustify",
plugins: ["lists link image table code"],
});
----

=== Content Structure

* **Removed**: `forced_root_block: false`.
** **Requirement**: All content must be wrapped in block elements (e.g., <p>).

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
forced_root_block: "p"
});
----

=== Configuration Changes

// multiple toolbars still work https://www.tiny.cloud/docs/tinymce/latest/toolbar-configuration-options/#toolbarn not sure why this is mentioned as decricated
* **Deprecated**: toolbar1, toolbar2, theme, skin, mobile configurations.
** **New Options**: Consolidate toolbar settings and use new options like xref:content-filtering.adoc#sandbox-iframes[sandbox iframes], xref:content-filtering.adoc#convert-unsafe-embeds[convert_unsafe_embeds], and xref:accessibility.adoc#highlight_on_focus[highlight_on_focus].

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
toolbar: "undo redo | blocks | bold italic | alignleft aligncenter alignright alignjustify | outdent indent | removeformat",
toolbar_mode: "floating",
sandbox_iframes: true,
convert_unsafe_embeds: true
});
----

=== Licensing Changes (GPL v2+ and Commercial)

* **Legacy License**: {productname} 4 was licensed under LGPL 2.1.
* **New License**: {productname} {release-version} is licensed under GPL v2+ or a commercial license.
* **Impact**: The xref:license-key.adoc[License key] option is required as part of your editor configuration if self-hosting {productname}.
Comment thread
kemister85 marked this conversation as resolved.
Outdated

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
license_key: "your-license-key"
});
----

== Migration Tips

. **Backup and Prepare**: Ensure comprehensive backups before upgrading.
. **Update Core Initialization**:
.. Remove `theme`, `skin`, and `forced_root_block: false` options.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
.. Consolidate toolbars.
.. Review new v{release-version} defaults for security settings.
. **Plugin Migration**:
.. Remove deprecated plugins from your configuration.
.. Update renamed plugins (e.g., `spellchecker` → `tinymcespellchecker`).
.. Verify premium plugins for compatibility.
. **Custom Code Updates**:
.. Rewrite custom plugins using the `editor.ui.registry.*` API. see link:https://www.tiny.cloud/docs/tinymce/latest/apis/tinymce.editor.ui.registry/[editor.ui.registry].
.. Replace v4 API methods like `editor.addButton`, `editor.addMenuItem`, `editor.windowManager.open`.
.. Update media embed handling (`media_url_resolver` API changes). see xref:media.adoc#media_url_resolver[media_url_resolver].
. **CSS Updates**:
.. Remove `.mce-*` classes and use `.tox-*` classes.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
.. Review custom skins and stylesheets for compatibility with Oxide.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
. **Testing and Deployment**:
.. Thoroughly test your updated configuration before production deployment.
.. Validate media, iframe, and content security settings.

== Additional Resources

* link:https://www.tiny.cloud/docs/tinymce/latest/[{productname} {release-version} Documentation]
* xref:license-key.adoc[License Key Setup]
* link:https://community.tiny.cloud/[Community Forum]
* link:https://github.com/tinymce/tinymce/issues[GitHub Issues]
Comment thread
kemister85 marked this conversation as resolved.

== Helpful Links

To make your upgrade smooth, check the following version-specific migration guides:

* link:https://www.tiny.cloud/docs/tinymce/5/migration-from-4x/[Migrating from {productname} 4 to {productname} 5]
* link:https://www.tiny.cloud/docs/tinymce/6/migration-from-5x/[Migrating from {productname} 5 to {productname} 6]
* link:https://www.tiny.cloud/docs/tinymce/latest/migration-from-6x/[Migrating from {productname} 6 to {productname} {release-version}]

These include deeper configuration notes, plugin replacements, and examples.

== Next Steps

Ensure you follow the migration steps carefully to avoid common issues like missing plugins, broken UI, and unexpected formatting changes. Consider running your updated editor in a staging environment for a complete verification before final deployment.
152 changes: 152 additions & 0 deletions modules/ROOT/pages/migration-from-5x.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
= Migrating from {productname} 5 to {productname} {release-version}
:navtitle: Migrating from TinyMCE 5
:description: Guidance for migrating from TinyMCE 5 to TinyMCE {release-version}
:keywords: migration, considerations, premigration, pre-migration
:release-version: 7.0

== Overview

{productname} has evolved significantly from version 5 to version {release-version}, introducing architectural improvements, modern UI enhancements, stricter security defaults, and updated plugin structures. This guide outlines the critical breaking changes, recommended migration action steps, and top-level configuration adjustments required to upgrade from {productname} v5 to v{release-version}.

== Key Changes

=== UI Themes and Skins

* **Minor Adjustments**: Oxide-based skins from v5 remain mostly compatible but may require small CSS adjustments for v{release-version}.
* **Impact**: Test custom skins visually, as minor DOM changes can affect layout and styling.
* **Browser Support**: Internet Explorer 11 is no longer supported in v{release-version} (dropped in v6), requiring modern browsers.

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
skin: "oxide-dark",
content_css: "dark",
});
----

=== Plugin Ecosystem

// The contextmenu plugin was absorbed into core, the options still works, see https://www.tiny.cloud/docs/tinymce/latest/contextmenu/. not sure why this is mentioned as removed.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
* **Moved to Core**: `paste`, `hr`, `table`, `noneditable`, `nonbreaking`.
* **Removed**: `imagetools`, `template`, `colorpicker`, `contextmenu`, `legacyoutput`.
* **Premium Only**: `mediaembed`, `toc` (renamed to `tableofcontents`), `advtemplate`.

Plugin Migration Examples:

* `contextmenu` (Removed in v5):
** Replace with browser-native context menus or custom menu logic.
** Consider using link:https://www.tiny.cloud/docs/tinymce/latest/apis/tinymce.editor.ui.registry/#addContextMenu[editor.ui.registry.addContextMenu] for custom right-click actions.
* `bbcode` (Removed in v6):
** Replace with custom parsing or server-side processing if needed.
* `fullpage` (Removed in v6):
** No direct replacement. Use custom templates or server-side processing for full HTML documents.
* `template` (Removed in v{release-version}):
** Use premium xref:advanced-templates.adoc[advtemplate] or implement custom modal dialogs for templating.
* `textcolor` (Removed in v6):
** Use `forecolor` and `backcolor` buttons instead.

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
toolbar: "undo redo | forecolor backcolor | bold italic | alignleft aligncenter alignright alignjustify",
plugins: ["lists link image table code"],
});
----

=== Content Structure

* **Removed**: `forced_root_block: false`.
** **Requirement**: All content must be wrapped in block elements (e.g., `<p>`).

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
forced_root_block: "p"
});
----

=== API and Initialization Changes

// multiple toolbars still work https://www.tiny.cloud/docs/tinymce/latest/toolbar-configuration-options/#toolbarn not sure why this is mentioned as decricated
Comment thread
kemister85 marked this conversation as resolved.
Outdated
* **Deprecated**: toolbar1, toolbar2, theme, skin, mobile configurations.
* **New Options**: Consolidate toolbar settings and use new options like xref:content-filtering.adoc#sandbox-iframes[sandbox iframes], xref:content-filtering.adoc#convert-unsafe-embeds[convert_unsafe_embeds], and xref:accessibility.adoc#highlight_on_focus[highlight_on_focus].
* **UI API Updates**: Rewrite custom plugins using the `editor.ui.registry.*` API. Replace methods like `editor.addButton`, `editor.addMenuItem`, and `editor.windowManager.open`.
* **Promise-based Methods**: `media_url_resolver` now returns a Promise, requiring async handling.
* **Obsolete Options**: Remove `force_hex_color` and update `table_responsive_width` to `table_sizing_mode`.

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
toolbar: "undo redo | blocks | bold italic | alignleft aligncenter alignright alignjustify | outdent indent | removeformat",
toolbar_mode: "floating",
sandbox_iframes: true,
convert_unsafe_embeds: true,
highlight_on_focus: true
});
----

=== Licensing Changes (GPL v2+ and Commercial)

* **Legacy License**: {productname} 5 was licensed under LGPL 2.1.
* **New License**: {productname} {release-version} is licensed under GPL v2+ or a commercial license.
* **Impact**: The xref:license-key.adoc[License key] option is required as part of your editor configuration if self-hosting {productname}.
Comment thread
kemister85 marked this conversation as resolved.
Outdated

.Example:
[source,js]
----
tinymce.init({
selector: "textarea",
license_key: "your-license-key"
});
----

== Migration Tips

. **Backup and Prepare**: Ensure comprehensive backups before upgrading.
. **Update Core Initialization**:
.. Remove `theme`, `skin`, and `forced_root_block: false` options.
.. Consolidate toolbars.
.. Review new v{release-version} defaults for security settings.
. **Plugin Migration**:
.. Remove deprecated plugins from your configuration.
.. Update renamed plugins (e.g., `spellchecker` → `tinymcespellchecker`).
.. Verify premium plugins for compatibility.
. **Custom Code Updates**:
.. Rewrite custom plugins using the `editor.ui.registry.*` API.
.. Replace v5 API methods like `editor.addButton`, `editor.addMenuItem`, `editor.windowManager.open`.
.. Update media embed handling (`media_url_resolver` API changes). see xref:media.adoc#media_url_resolver[media_url_resolver].
. **CSS Updates**:
.. Remove `.mce-*` classes and use `.tox-*` classes.
.. Review custom skins and stylesheets for compatibility with Oxide.
Comment thread
kemister85 marked this conversation as resolved.
Outdated
. **Testing and Deployment**:
.. Thoroughly test your updated configuration before production deployment.
.. Validate media, iframe, and content security settings.

== Additional Resources
Comment thread
kemister85 marked this conversation as resolved.

* link:https://www.tiny.cloud/docs/tinymce/latest/[{productname} {release-version} Documentation]
* xref:license-key.adoc[License Key Setup]
* link:https://community.tiny.cloud/[Community Forum]
* link:https://github.com/tinymce/tinymce/issues[GitHub Issues]
Comment thread
kemister85 marked this conversation as resolved.

== Helpful Links

To make your upgrade smooth, check the following version-specific migration guides:

* link:https://www.tiny.cloud/docs/tinymce/5/migration-from-4x/[Migrating from {productname} 4 to {productname} 5]
* link:https://www.tiny.cloud/docs/tinymce/6/migration-from-5x/[Migrating from {productname} 5 to {productname} 6]
* link:https://www.tiny.cloud/docs/tinymce/latest/migration-from-6x/[Migrating from {productname} 6 to {productname} {release-version}]

These include deeper configuration notes, plugin replacements, and examples.

== Next Steps

Ensure you follow the migration steps carefully to avoid common issues like missing plugins, broken UI, and unexpected formatting changes. Consider running your updated editor in a staging environment for a complete verification before final deployment.