Merge pull request #5504 from ckeditor/changelog-updates

Update documentation
ckeditor · Jun 30, 2023 · 2b5bb61 · 2b5bb61
2 parents fe69ca7 + 7083fd6
commit 2b5bb61
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 25 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,16 +1,21 @@
-CKEditor 4 Changelog
-====================
+⚠️️️ **CKEditor 4 (the open source edition) is no longer maintained.** ⚠️
+
+If you would like to keep access to future CKEditor 4 security patches, check the [Extended Support Model](https://ckeditor.com/ckeditor-4-support/), which guarantees **security updates and critical bug fixes until December 2026**. Alternatively, [upgrade to CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/updating/ckeditor4/migration-from-ckeditor-4.html).
+
+## CKEditor 4.22.0
+
+⚠️ This is the last open source release of CKEditor 4. As announced in 2018, CKEditor 4 has reached its End of Life in June 2023.
 
-## CKEditor 4.22.0 [IN DEVELOPMENT]
 
 New Features:
 
-* [#5316](https://github.com/ckeditor/ckeditor4/issues/5316): Add vertical margins support for list elements in the [Paste from Word](https://ckeditor.com/cke4/addon/pastefromword) plugin.
+* [#5316](https://github.com/ckeditor/ckeditor4/issues/5316): Added vertical margins support for list elements in the [Paste from Word](https://ckeditor.com/cke4/addon/pastefromword) plugin.
 * [#5410](https://github.com/ckeditor/ckeditor4/issues/5410): Added the ability to indicate the language of styles in the [Styles Combo](https://ckeditor.com/cke4/addon/stylescombo) plugin via the [`config.styleSet`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html#cfg-stylesSet) configuration option.
-* [#5437](https://github.com/ckeditor/ckeditor4/issues/5437): Fixed: Incorrect indication of selected items in comboboxes. The selected item was unmarked upon each opening of the combobox.
+* [#5510](https://github.com/ckeditor/ckeditor4/issues/5510): Added notification system to the editor informing users that the editor version is up-to-date and secure. See [`config.versionCheck](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html#cfg-versionCheck) configuration option to learn more.
 
 Fixed Issues:
 
+* [#5437](https://github.com/ckeditor/ckeditor4/issues/5437): Fixed: Incorrect indication of selected items in combo boxes. The selected item was unmarked upon each opening of the combo box.
 * [#5495](https://github.com/ckeditor/ckeditor4/issues/5495): Fixed: Insufficient color ratio for links inside [Notifications](https://ckeditor.com/cke4/addon/notification).
 
 Other Changes:

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,7 +1,15 @@
-Software License Agreement
-==========================
+Software License Agreement for CKEditor 4 LTS (4.23.0 and above)
+================================================================
 
-CKEditor - The text editor for Internet - https://ckeditor.com/
+CKEditor - The text editor for Internet - https://ckeditor.com/ <br>
+Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+
+CKEditor 4 LTS ("Long Term Support") is available under exclusive terms of the [Extended Support Model](https://ckeditor.com/ckeditor-4-support/). [Contact us](https://ckeditor.com/contact/) to obtain a commercial license.
+
+Software License Agreement for CKEditor 4.22.* and below
+========================================================
+
+CKEditor - The text editor for Internet - https://ckeditor.com/ <br>
 Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
 
 Licensed under the terms of any of the following licenses at your

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# CKEditor 4 - Smart WYSIWYG HTML editor [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20on%20GitHub&url=https%3A%2F%2Fgithub.com%2Fckeditor%2Fckeditor4)
+# CKEditor 4 LTS - Smart WYSIWYG HTML editor [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20on%20GitHub&url=https%3A%2F%2Fgithub.com%2Fckeditor%2Fckeditor4)
 
 [![npm version](https://badge.fury.io/js/ckeditor4.svg)](https://www.npmjs.com/package/ckeditor4)
 [![GitHub tag](https://img.shields.io/github/tag/ckeditor/ckeditor4.svg)](https://github.com/ckeditor/ckeditor4)
@@ -8,9 +8,54 @@
 [![Join newsletter](https://img.shields.io/badge/join-newsletter-00cc99.svg)](http://eepurl.com/c3zRPr)
 [![Follow Twitter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/ckeditor)
 
-A highly configurable WYSIWYG HTML editor with hundreds of features, from creating rich text content with captioned images, videos, tables, media embeds, emoji or mentions to pasting from Word and Google Docs and drag&drop image upload.
+## ⚠️ CKEditor 4: End of Life and Extended Support Model until Dec 2026
 
-Supports a broad range of browsers, including legacy ones.
+CKEditor 4 was launched in 2012 and reached its End of Life (EOL) on June 30, 2023.
+
+A special edition, **[CKEditor 4 LTS](https://ckeditor.com/ckeditor-4-support/)** ("Long Term Support"), is available under commercial terms (["Extended Support Model"](https://ckeditor.com/ckeditor-4-support/)) for anyone looking to **extend the coverage of security updates and critical bug fixes**.
+
+With CKEditor 4 LTS, security updates and critical bug fixes are guaranteed until December 2026.
+
+## About this repository
+
+### Master branch = CKEditor 4 LTS
+
+After June 30, 2023 the `master` version of the [LICENSE.md](https://github.com/ckeditor/ckeditor4/blob/master/LICENSE.md) file changed to reflect the license of CKEditor 4 LTS available under the Extended Support Model.
+
+This repository now contains the source code of CKEditor 4 LTS that is protected by copyright law.
+
+### Getting CKEditor 4 (Open Source)
+
+You may continue using CKEditor 4.22.0 and below under the open source license terms. Please note, however, that the open source version no longer comes with any security updates, so your application will be at risk.
+
+In order to download the open source version of CKEditor 4, use ****tags 4.22.0 and below****. CKEditor 4.22.0 was the last version of CKEditor 4 available under the open source license terms.
+
+## Summary of options after the CKEditor 4 End of Life
+
+### Upgrading to CKEditor 5
+
+CKEditor 5 is a great new editor with [lots of exciting features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
+
+Before upgrading, please be aware of the following changes:
+
+- CKEditor 5 is a completely new editor. **Upgrading is not as simple as replacing the folder with "ckeditor"** - read more in the [Migration from CKEditor 4](https://ckeditor.com/docs/ckeditor5/latest/updating/ckeditor4/migration-from-ckeditor-4.html) guide.
+- CKEditor 5 is available only under the GPL copyleft license (or under a commercial license).
+- Open source projects with a GPL-incompatible license may apply for a license under the [Free for Open Source](https://ckeditor.com/wysiwyg-editor-open-source/) program.
+
+### Using an outdated, unsupported version
+
+You may continue using CKEditor 4.22.0 (or below). The license terms of the older CKEditor 4 versions have not changed. However, please note that by using software that is no longer maintained, you are introducing a **security risk to your application**.
+
+### Signing an "Extended Support Model" contract
+
+If you are not ready to replace CKEditor 4 in your application yet, you may continue using CKEditor 4 until December 2026.
+CKEditor 4 LTS, available under the "Extended Support Model", will ship all important security updates and critical bug fixes, providing an interrupted editing experience for your end users. Please note that this version of CKEditor 4 is available only under a special agreement and requires a license key.
+
+## About CKEditor 4
+
+A highly configurable WYSIWYG HTML editor with hundreds of features, from creating rich text content with captioned images, videos, tables, media embeds, emoji, or mentions to pasting from Word and Google Docs and drag&drop image upload.
+
+It supports a broad range of browsers, including legacy ones.
 
 ![CKEditor 4 screenshot](https://c.cksource.com/a/1/img/npm/ckeditor4.png)
 
@@ -19,7 +64,7 @@ Supports a broad range of browsers, including legacy ones.
 ### Using [npm package](https://www.npmjs.com/package/ckeditor)
 
 ```bash
-npm install --save ckeditor
+npm install --save ckeditor4
 ```
 
 Use it on your website:
@@ -28,29 +73,33 @@ Use it on your website:
 <div id="editor">
     <p>This is the editor content.</p>
 </div>
-<script src="./node_modules/ckeditor/ckeditor.js"></script>
+<script src="./node_modules/ckeditor4/ckeditor.js"></script>
 <script>
     CKEDITOR.replace( 'editor' );
 </script>
 ```
 
 ### Using [CDN](https://cdn.ckeditor.com/#ckeditor4)
 
-Load the CKEditor 4 script from CDN:
+Load the CKEditor 4 script from the CDN:
 
 ```html
 <div id="editor">
     <p>This is the editor content.</p>
 </div>
-<script src="https://cdn.ckeditor.com/4.13.0/standard/ckeditor.js"></script>
+<script src="https://cdn.ckeditor.com/4.22.0/standard/ckeditor.js"></script>
 <script>
     CKEDITOR.replace( 'editor' );
 </script>
 ```
 
-### Integrating with Angular, React and Vue.js
+#### CKEditor 4 LTS
 
-Refer to official usage guides for the [`ckeditor4-angular`](https://www.npmjs.com/package/ckeditor4-angular#usage), [`ckeditor4-react`](https://www.npmjs.com/package/ckeditor4-react#usage) and [`ckeditor4-vue`](https://www.npmjs.com/package/ckeditor4-vue#installation-and-usage) packages.
+Since the introduction of the LTS version of CKEditor (`4.23.0-lts`) in June 2023, all future versions of CKEditor 4 contain `-lts` in their version number.
+
+### Integrating with Angular, React, and Vue.js
+
+Refer to the official usage guides for the [`ckeditor4-angular`](https://www.npmjs.com/package/ckeditor4-angular#usage), [`ckeditor4-react`](https://www.npmjs.com/package/ckeditor4-react#usage), and [`ckeditor4-vue`](https://www.npmjs.com/package/ckeditor4-vue#installation-and-usage) packages.
 
 ### Manual download
 
@@ -59,9 +108,9 @@ Visit the [CKEditor 4 download section](https://ckeditor.com/ckeditor-4/download
 ## Features
 
 * Over 500 plugins in the [Add-ons Repository](https://ckeditor.com/cke4/addons).
-* Pasting from Microsoft Word, Excel and Google Docs.
+* Pasting from Microsoft Word, Excel, and Google Docs.
 * Drag&drop image uploads.
-* Media embeds to insert videos, tweets, maps, slideshows.
+* Media embeds to insert videos, tweets, maps, or slideshows.
 * Powerful clipboard integration.
 * Content quality control with Advanced Content Filter.
 * Extensible widget system.
@@ -95,15 +144,15 @@ This repository contains the following branches:
   - **`master`** &ndash; Development of the upcoming minor release.
   - **`stable`** &ndash; Latest stable release tag point (non-beta).
   - **`latest`** &ndash; Latest release tag point (including betas).
-  - **`release/A.B.x`** (e.g. `4.0.x`, `4.1.x`) &ndash; Release freeze, tests and tagging. Hotfixing.
+  - **`release/A.B.x`** (e.g. `4.0.x`, `4.1.x`) &ndash; Release freeze, tests, and tagging. Hotfixing.
 
 Note that the `master` branch is under heavy development. Its code did not pass the release testing phase, though, so it may be unstable.
 
-Additionally, all releases have their respective tags in the following form: `4.4.0`, `4.4.1`, etc.
+Additionally, all releases have their respective tags in the following form: `4.4.0`, `4.4.1`, etc. LTS editions have `-lts` at the end: `4.23.0-lts`, etc.
 
 ### Samples
 
-The `samples/` folder contains some examples that can be used to test your installation. Visit [CKEditor 4 Examples](https://ckeditor.com/docs/ckeditor4/latest/examples/index.html) for plenty of samples showcasing numerous editor features, with source code readily available to view, copy and use in your own solution.
+The `samples/` folder contains some examples that you can use to test your installation. Visit [CKEditor 4 Examples](https://ckeditor.com/docs/ckeditor4/latest/examples/index.html) for plenty of samples showcasing numerous editor features, with source code readily available to view, copy, and use in your own solution.
 
 ### Code structure
 
@@ -118,11 +167,11 @@ The development code contains the following main elements:
 
 ### Building a release
 
-A release-optimized version of the development code can be easily created locally. The `dev/builder/build.sh` script can be used for that purpose:
+You can create a release-optimized version of the development code locally. Use the `dev/builder/build.sh` script for that purpose:
 
 	> ./dev/builder/build.sh
 
-A "release-ready" working copy of your development code will be built in the new `dev/builder/release/` folder. An Internet connection is necessary to run the builder, for the first time at least.
+A "release-ready" working copy of your development code will be built in the new `dev/builder/release/` folder. An Internet connection is necessary to run the builder, at least for the first time.
 
 ### Testing environment
 
@@ -137,3 +186,15 @@ Use the [CKEditor 4 GitHub issue page](https://github.com/ckeditor/ckeditor4/iss
 Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
 
 For licensing, see LICENSE.md or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license)
+
+#### CKEditor 4.22.0 and below
+
+CKEditor 4 until version 4.22.0 was licensed under the terms of any of the following licenses of your choice:
+
+ - GNU General Public License Version 2 or later.
+ - GNU Lesser General Public License Version 2.1 or later.
+ - Mozilla Public License Version 1.1 or later.
+
+#### CKEditor 4.23.0-lts and above
+
+CKEditor 4 LTS (starting from version 4.23.0-lts) is available under a commercial license only.
diff --git a/core/ckeditor_version-check.js b/core/ckeditor_version-check.js
@@ -174,7 +174,7 @@
 
 	/**
 	 * The version check feature adds a notification system to the editor that informs
-	 * the user if the editor version is secure. It is highly recommended to stay up to
+	 * users if the editor version is secure. It is highly recommended to stay up to
 	 * date with the editor version to ensure that the editor is secure and provides
 	 * the best editing experience to users.
 	 *