From 6b829d7f03a92cf42cb24ed0c87c7bb9b21f8be7 Mon Sep 17 00:00:00 2001 From: godai78 Date: Wed, 13 Sep 2023 11:03:54 +0200 Subject: [PATCH 1/6] Docs: adding migration to 40.x guide. --- docs/updating/update-to-39.md | 1 - docs/updating/update-to-40.md | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/updating/update-to-40.md diff --git a/docs/updating/update-to-39.md b/docs/updating/update-to-39.md index 493de0799e4..a9dc0db80b3 100644 --- a/docs/updating/update-to-39.md +++ b/docs/updating/update-to-39.md @@ -3,7 +3,6 @@ category: update-guides meta-title: Update to version 39.x | CKEditor 5 Documentation menu-title: Update to v39.x order: 85 -modified_at: 2023-07-31 --- # Update to CKEditor 5 v39.x diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md new file mode 100644 index 00000000000..bc37a8771f4 --- /dev/null +++ b/docs/updating/update-to-40.md @@ -0,0 +1,23 @@ +--- +category: update-guides +meta-title: Update to version 40.x | CKEditor 5 Documentation +menu-title: Update to v40.x +order: 85 +modified_at: 2023-09-13 +--- + +# Update to CKEditor 5 v40.x + + + When updating your CKEditor 5 installation, make sure **all the packages are the same version** to avoid errors. + + For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions. + + +## Update to CKEditor 5 v40.0.0 + +For the entire list of changes introduced in version 39.0.0, see the [release notes for CKEditor 5 v40.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v40.0.0). + +Listed below are the most important changes that require your attention when upgrading to CKEditor 5 v40.0.0. + +### New lists feasture From f62ccc68feba3fde88ad040e8f9451969590544c Mon Sep 17 00:00:00 2001 From: godai78 Date: Tue, 19 Sep 2023 09:18:11 +0200 Subject: [PATCH 2/6] Docs: adding image changes. --- docs/updating/update-to-40.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index bc37a8771f4..bd21fc1ffce 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -2,7 +2,7 @@ category: update-guides meta-title: Update to version 40.x | CKEditor 5 Documentation menu-title: Update to v40.x -order: 85 +order: 84 modified_at: 2023-09-13 --- @@ -16,8 +16,16 @@ modified_at: 2023-09-13 ## Update to CKEditor 5 v40.0.0 -For the entire list of changes introduced in version 39.0.0, see the [release notes for CKEditor 5 v40.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v40.0.0). +For the entire list of changes introduced in version 40.0.0, see the [release notes for CKEditor 5 v40.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v40.0.0). Listed below are the most important changes that require your attention when upgrading to CKEditor 5 v40.0.0. -### New lists feasture +### Changes to the image feature + +This release introduces changes connected with the image `width` and `height` attributes. These are now preserved while loading editor content. Images without their size specified will automatically gain natural image size on any interaction with the image within the editor. Due to this new behavior, the `width` and `height` attributes are now used to preserve the image's natural width and height and the model attribute name of a resized image is now changed to `resizedWidth`. + +Also, the `srcset` model attribute which provides parameters for responsive images, has been simplified. It is no longer an object `{ data: "...", width: "..." }`, but the value that was previously stored in the `data` part. + +Both of these are major breaking changes. + +### New lists feature From 2fc01cddb26283502bc476cbcffbceffe86db983 Mon Sep 17 00:00:00 2001 From: godai78 Date: Tue, 19 Sep 2023 11:16:09 +0200 Subject: [PATCH 3/6] Docs: list advent info. [short flow] --- docs/updating/update-to-40.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index bd21fc1ffce..3066a585062 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -28,4 +28,8 @@ Also, the `srcset` model attribute which provides parameters for responsive imag Both of these are major breaking changes. -### New lists feature +### New default lists plugin coming + +The regular lists feature will be replaced with the new {@link features/document-lists document lists} in one of the upcoming releases and it will be sunset at the beginning of 2024. The change will be seamless for the users, but there are significant changes between these plugins. We will update the information about this process as it unfolds. + +See [#14767](https://github.com/ckeditor/ckeditor5/issues/14767) for more details. \ No newline at end of file From 077219f51c5e4caca0ac14266f03f0ccdeabf93a Mon Sep 17 00:00:00 2001 From: godai78 Date: Thu, 21 Sep 2023 10:49:55 +0200 Subject: [PATCH 4/6] Docs: balloon toolbar icon; content styles. [short flow] --- docs/updating/update-to-40.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index 3066a585062..58fda455b0c 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -24,11 +24,28 @@ Listed below are the most important changes that require your attention when upg This release introduces changes connected with the image `width` and `height` attributes. These are now preserved while loading editor content. Images without their size specified will automatically gain natural image size on any interaction with the image within the editor. Due to this new behavior, the `width` and `height` attributes are now used to preserve the image's natural width and height and the model attribute name of a resized image is now changed to `resizedWidth`. -Also, the `srcset` model attribute which provides parameters for responsive images, has been simplified. It is no longer an object `{ data: "...", width: "..." }`, but the value that was previously stored in the `data` part. +The `srcset` model attribute which provides parameters for responsive images, has been simplified. It is no longer an object `{ data: "...", width: "..." }`, but the value that was previously stored in the `data` part. -Both of these are major breaking changes. +Last but not least, content styles have been updated with this release, which means you need to update them in your editor implementation to avoid any discrepancies. Please refer to the {@link installation/advanced/content-styles Content styles} guide to learn how to generate the stylesheet. -### New default lists plugin coming +### New Balloon Block editor icon + +We have changed the default Balloon Block editor indicator icon from the pilcrow icon (`¶`) to the braille pattern dots icon (`⠿`). The new icon better corresponds to the dual function of the indicator, which may be used to both invoke the balloon toolbar and to drag to content block around. + +While `⠿` is now a default, the icon can still be configured by the integrator, for example: + +```js + blockToolbar: { + items: [ + 'bold', + 'italic', + 'link' + ], + icon: 'pilcrow' // or SVG. + }, +``` + +### A new default lists plugin coming The regular lists feature will be replaced with the new {@link features/document-lists document lists} in one of the upcoming releases and it will be sunset at the beginning of 2024. The change will be seamless for the users, but there are significant changes between these plugins. We will update the information about this process as it unfolds. From 0925a596c1237cf517b3c67c8a8e225a64519f88 Mon Sep 17 00:00:00 2001 From: godai78 Date: Thu, 21 Sep 2023 13:44:54 +0200 Subject: [PATCH 5/6] Dcos: minor fixes. [short flow] --- docs/updating/update-to-40.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index 58fda455b0c..26852da104f 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -3,7 +3,7 @@ category: update-guides meta-title: Update to version 40.x | CKEditor 5 Documentation menu-title: Update to v40.x order: 84 -modified_at: 2023-09-13 +modified_at: 2023-09-21 --- # Update to CKEditor 5 v40.x @@ -30,7 +30,7 @@ Last but not least, content styles have been updated with this release, which me ### New Balloon Block editor icon -We have changed the default Balloon Block editor indicator icon from the pilcrow icon (`¶`) to the braille pattern dots icon (`⠿`). The new icon better corresponds to the dual function of the indicator, which may be used to both invoke the balloon toolbar and to drag to content block around. +We have changed the default {@link features/blocktoolbar Balloon Block editor toolbar} indicator icon from the pilcrow icon (`¶`) to the braille pattern dots icon (`⠿`). The new icon better corresponds to the dual function of the indicator, which may be used to both invoke the balloon toolbar and to drag to content block around. While `⠿` is now a default, the icon can still be configured by the integrator, for example: From aa23abf14249c73e9aadf85b4cfc095a7c058d9f Mon Sep 17 00:00:00 2001 From: godai78 Date: Tue, 26 Sep 2023 11:04:27 +0200 Subject: [PATCH 6/6] Docs: update lists info. [short flow] --- docs/updating/update-to-40.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index 26852da104f..5cfbcedda6b 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -3,7 +3,7 @@ category: update-guides meta-title: Update to version 40.x | CKEditor 5 Documentation menu-title: Update to v40.x order: 84 -modified_at: 2023-09-21 +modified_at: 2023-09-26 --- # Update to CKEditor 5 v40.x @@ -47,6 +47,10 @@ While `⠿` is now a default, the icon can still be configured by the integrator ### A new default lists plugin coming -The regular lists feature will be replaced with the new {@link features/document-lists document lists} in one of the upcoming releases and it will be sunset at the beginning of 2024. The change will be seamless for the users, but there are significant changes between these plugins. We will update the information about this process as it unfolds. +We currently maintain two list features: {@link features/lists List} and {@link features/document-lists DocumentList}. The list v1 feature was implemented in the early days of CKEditor 5. It supports “plain lists” – lists where `
  • ` cannot contain block content (paragraphs, headings, tables, block images). It supports to-do lists, but it does not support extending list markup via the {@link features/general-html-support General HTML Support (GHS)} feature. -See [#14767](https://github.com/ckeditor/ckeditor5/issues/14767) for more details. \ No newline at end of file +The list v2 (document list) feature was implemented in 2022 to add support for block content in list items. It supported extending list markup via GHS. It did not, however, support to-do lists. Since then we concentrated on bringing full list v1 functionality to this plugin. We are nearing the end of a long job of pairing these two plugins in their functions. You can follow the current state of works in the [Document list feature parity](https://github.com/ckeditor/ckeditor5/issues/14632) issue. + +Considering this progress, the old lists feature will be replaced with the new document lists in one of the upcoming releases and it will be sunset at the beginning of 2024. The change will be seamless for the users, but there are significant changes between these plugins. We will update the information about this process as it unfolds. + +See the [#14767](https://github.com/ckeditor/ckeditor5/issues/14767) issue for more details.