diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 12d6c9fe112..2374380e9ca 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -17,8 +17,8 @@ jobs: close-issue-label: resolution:expired stale-pr-label: status:stale close-pr-label: resolution:expired - stale-issue-message: "There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may be relevant, so if you're interested in the solution, leave a comment or reaction under this issue." - stale-pr-message: "There has been no activity on this PR for the past year. We've marked it as stale and will close it in 30 days. We understand it may be relevant, so if you're interested in the contribution, leave a comment or reaction under this PR." + stale-issue-message: "There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue." + stale-pr-message: "There has been no activity on this PR for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the contribution, leave a comment or reaction under this PR." close-issue-message: "We've closed your issue due to inactivity over the last year. We understand that the issue may still be relevant. If so, feel free to open a new one (and link this issue to it)." close-pr-message: "We've closed your PR due to inactivity over the last year. While time has passed, the core of your contribution might still be relevant. If you're able, consider reopening a similar PR." days-before-stale: 365 diff --git a/CHANGELOG.md b/CHANGELOG.md index daa7a6c75a3..5108cfb55e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,11 @@ We are happy to announce the release of CKEditor 5 v40.0.0. ### Release highlights -#### AI Assistant +#### Release of the AI Assistant feature **We are tremendously excited to share our AI Assistant plugin with you!** -With the AI Assistant, you can boost your editing effectiveness and creativity in a completely new way. This feature gives writers and editors the power to seamlessly interact with artificial intelligence. Users can generate, expand, rewrite, improve, translate, and process the content in many different ways. +With the AI Assistant, you can boost your editing effectiveness and creativity in a completely new way. This feature gives the writers and editors the power to seamlessly interact with artificial intelligence. Users can generate, expand, rewrite, improve, translate, and process the content in many different ways. The AI Assistant can be used in two ways. You can quickly re-work selected content by choosing one of the predefined AI commands. Or, you can write your own query to generate or process the content in any way you like! diff --git a/README.md b/README.md index 3071b3b8728..16256bedb0c 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ CKEditor 5 is an ultra-modern JavaScript rich-text editor with MVC architec ### CKEditor 5 online builder -The easiest way to start using CKEditor 5 with all the features you need, is to prepare a customized build with the [online builder](https://ckeditor.com/ckeditor-5/online-builder/). All you need to do is choose the preferred predefined build as a base, add all the required plugins, and download the ready-to-use package. Refer to the [Online builder Quick start](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html#creating-custom-builds-with-online-builder) guide to follow this installation path. +The easiest way to start using CKEditor 5 with all the features you need is to prepare a customized build with the [online builder](https://ckeditor.com/ckeditor-5/online-builder/). All you need to do is choose the preferred predefined build as a base, add all the required plugins, and download the ready-to-use package. Refer to the [Online builder Quick start](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html#creating-custom-builds-with-online-builder) guide to follow this installation path. ### CKEditor 5 predefined builds @@ -129,7 +129,7 @@ Follow the [CKEditor 5 changelog](https://github.com/ckeditor/ckeditor5/blo The CKEditor 5 Framework offers access to a plethora of various plugins, supporting [all kinds of editing features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html). -From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these. +From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, and font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these. The number of options and the ease of customization and adding new ones make the editing experience even better for any environment and professional background. @@ -151,7 +151,7 @@ See the [official contributors' guide](https://ckeditor.com/docs/ckeditor5/lates ### Reporting issues and feature requests -Report issues in [the `ckeditor5` repository](https://github.com/ckeditor/ckeditor5/issues). Read more on the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/reporting-issues.html) section of the CKEditor 5 documentation. +Report issues in [the `ckeditor5` repository](https://github.com/ckeditor/ckeditor5/issues). Read more in the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/reporting-issues.html) section of the CKEditor 5 documentation. ## License diff --git a/docs/examples/builds/balloon-block-editor.md b/docs/examples/builds/balloon-block-editor.md index 279b41e2ad2..1203e91b0c5 100644 --- a/docs/examples/builds/balloon-block-editor.md +++ b/docs/examples/builds/balloon-block-editor.md @@ -10,15 +10,14 @@ classes: main__content--no-toc {@link installation/getting-started/predefined-builds#balloon-block-editor Balloon block editor} lets you create your content directly in its target location with the help of two toolbars: -* a balloon toolbar that appears next to the selected editable document element (offering inline content formatting tools), -* a {@link features/blocktoolbar block toolbar} accessible using a button (`⠿`) attached to the editable content area and following the selection in the document (bringing additional block formatting tools), -* the `⠿` toolbar is also a handle that can be used to drag and drop blocks around the content. +* A balloon toolbar that appears next to the selected editable document element (offering inline content formatting tools). +* A {@link features/blocktoolbar block toolbar} accessible using the toolbar handle button {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} attached to the editable content area and following the selection in the document (bringing additional block formatting tools). The {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} button is also a handle that can be used to drag and drop blocks around the content. {@snippet examples/balloon-block-editor} ## Editor example configuration -Check out the {@link installation/getting-started/predefined-builds#installation-example-4 Quick start} guide to learn more about implementing this kind of editor. You will find implementation steps there. You can see this example editor’s code below. +Check out the {@link installation/getting-started/predefined-builds#installation-example-4 Quick start} guide to learn more about implementing this kind of editor. You will find the implementation steps there. You can see this example editor’s code below.
View editor configuration script diff --git a/docs/features/index.md b/docs/features/index.md index 5f07839cc6d..4a30308a124 100644 --- a/docs/features/index.md +++ b/docs/features/index.md @@ -83,6 +83,8 @@ Keep full control of your work. Be safe and never lose anything thanks to the {@ The {@link features/word-count words and characters counter} will help you track progress and control the volume of the content. +Our {@link features/ai-assistant AI Assistant} {@icon @ckeditor/ckeditor5-ai/theme/icons/robot-pencil.svg AI Assistant} will help you rewrite, edit, or translate the already existing content to match your needs, or even come up with a completely new one! + Use {@link features/autoformat Markdown syntax} to format content on the go to speed the editing process, employ {@link features/text-transformation automatic text transformations} (also known as autocorrect) and the {@link features/spelling-and-grammar-checking spell checker} {@icon @webspellchecker/wproofreader-ckeditor5/theme/icons/wproofreader.svg Spell and grammar check} to ensure everything is correct. Create multi-language documents and correct them on the go with automatic language detection and {@link features/language text part language} feature. {@img assets/img/features-spellcheck-multilanguage.png 800 CKEditor 5 spell-checking feature.} diff --git a/docs/installation/getting-started/configuration.md b/docs/installation/getting-started/configuration.md index e4a99e84389..dda2708e9fd 100644 --- a/docs/installation/getting-started/configuration.md +++ b/docs/installation/getting-started/configuration.md @@ -14,7 +14,7 @@ order: 40 **Quick recap** -In the {@link installation/getting-started/quick-start-other previous guide} you have learned about various ways to set up CKEditor 5 in the project. Now, you know how to use the online builder or create the editor from the source. It is time to play a bit with the configuration! +In the {@link installation/getting-started/quick-start-other previous guide} you have learned about various ways to set up CKEditor 5 in the project. Now, you know how to use the online builder or create the editor from the source. It is time to play a bit with the configuration! When creating an editor on your page, it is possible to set up {@link module:core/editor/editorconfig~EditorConfig configurations} that change many of its aspects. For example: diff --git a/docs/updating/update-to-40.md b/docs/updating/update-to-40.md index cc716570ef3..d6643270379 100644 --- a/docs/updating/update-to-40.md +++ b/docs/updating/update-to-40.md @@ -32,13 +32,13 @@ Last but not least, content styles have been updated with this release, which me #### Unlinked comment threads and UX/UI changes -The comment thread's **resolved** state has been separated from the **unlinked** state. Thread is **resolved** when manually resolved by the user. Thread is **unlinked** when the related content in the editor was removed. Earlier, these actions were treated as the same. Both actions still put the comment thread inside the comments archive. This new approach is reflected in the comments archive UI and UX. Notably, an unlinked comment thread can be further resolved and reopened, while inside the comments archive. Additionally, an unlinked comment thread has a gray header color to differentiate it from a resolved comment thread. +The comment thread's **resolved** state has been separated from the **unlinked** state. Thread is **resolved** when manually resolved by the user. A thread is **unlinked** when the related content in the editor has been removed. Earlier, these actions were treated as the same. Both actions still put the comment thread inside the comments archive. This new approach is reflected in the comments archive UI and UX. Notably, an unlinked comment thread can be further resolved and reopened, while inside the comments archive. Additionally, an unlinked comment thread has a gray header color to differentiate it from a resolved comment thread. -The new approach has impact on how revision history (or loading legacy document data) works. Now, **resolved** comment threads will stay in the comments archive after restoring a revision. However, **unlinked** comment threads will be restored together with the document data. +The new approach has an impact on how revision history (or loading legacy document data) works. Now, **resolved** comment threads will stay in the comments archive after restoring a revision. However, **unlinked** comment threads will be restored together with the document data. #### New `CommentThread#unlinkedAt` property -A new property -- {@link module:comments/comments/commentsrepository~CommentThread#unlinkedAt `CommentThread#unlinkedAt`} -- has been introduced. If your integration saves comment threads data in your system, make sure to update your code, so it saves the new property, and returns it together with other `CommentThread` data. +A new property -- {@link module:comments/comments/commentsrepository~CommentThread#unlinkedAt `CommentThread#unlinkedAt`} -- has been introduced. If your integration saves comment threads data in your system, make sure to update your code, so it saves the new property and returns it together with other `CommentThread` data. #### Changes impacting custom features @@ -48,7 +48,7 @@ The `CommentsArchive#resolvedThreads` property has been renamed to `#archivedThr The `deletedAt` property is no longer passed in `AddCommentThreadEvent` as it is not needed anymore. Additionally, now, `CommentsRepository` should never store deleted comment threads. -Your custom code may need to be updated accordingly (e.g. if your application uses comments outside editor feature). Examples: +Your custom code may need to be updated accordingly (e.g. if your application uses the comments outside the editor feature). Examples: ```js // Before: @@ -89,7 +89,7 @@ This change was reflected in the {@link features/comments-outside-editor comment Previously, in a real-time collaboration environment, deleted comment threads were fetched and added to `CommentsRepository` when the editor re-connected to Cloud Services. This was an incorrect behavior and was fixed. -If your custom integration manually adds deleted comment threads to `CommentsRepository`, it should not, and should be fixed. If your custom integration somehow depends on this incorrect behavior, you may need to change it. +If your custom integration manually adds deleted comment threads to `CommentsRepository`, it should not and should be fixed. If your custom integration somehow depends on this incorrect behavior, you may need to change it. ### New Balloon Block editor icon diff --git a/packages/ckeditor5-clipboard/docs/features/drag-drop.md b/packages/ckeditor5-clipboard/docs/features/drag-drop.md index 4494969e9c4..d254c7f46ba 100644 --- a/packages/ckeditor5-clipboard/docs/features/drag-drop.md +++ b/packages/ckeditor5-clipboard/docs/features/drag-drop.md @@ -9,7 +9,7 @@ category: features # Drag and drop -The drag and drop feature lets you drag and drop text, and content blocks such as paragraphs, tables, or lists inside the editor. This allows you to select an entire block or multiple blocks, and move them before or after other blocks. You can also drag and drop HTML and plain-text content from outside the editor and use it to upload images. +The drag and drop feature lets you drag and drop both text and content blocks such as paragraphs, tables, or lists inside the editor. This allows you to select an entire block or multiple blocks, and move them before or after other blocks. You can also drag and drop HTML and plain-text content from outside the editor and use it to upload images. ## Demo @@ -31,13 +31,13 @@ When the {@link features/ckbox CKBox file manager} is enabled in your CKEditor&n ## Drag and drop of content blocks -Since v40.0.0, the drag and drop plugin enables dragging content blocks such as paragraphs, tables, or lists inside the editor by default. This allows you to select an entire block or multiple blocks, and move them before or after other blocks. +Since v40.0.0, the drag and drop plugin fully supports dragging content blocks such as paragraphs, tables, or lists inside the editor by default. This allows you to select an entire block or multiple blocks, and move them before or after other blocks. The drag and drop functions include: * Selection of the text, elements, multiple blocks, and moving these around. * Placement of blocks inside other blocks such as tables, blockquotes, etc. -* The braille dots panel icon (`⠿`) in the balloon block editor now behaves as a drag handle. +* The braille dots panel icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} in the [balloon block editor](#balloon-block-editor-demo) now behaves as a drag handle. ### Classic editor demo @@ -47,7 +47,7 @@ Select a block or blocks, and drag them across the document. You can place block ### Balloon block editor demo -In the balloon block editor, you can also drag content blocks using the drag handle. Select or focus on the block, and then drag the block with the braille dots panel icon (`⠿`). +In the balloon block editor, you can also drag content blocks using the drag handle. Select or focus on the block, and then drag the block with the braille dots panel icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator}. {@snippet features/block-balloon-drag-drop} @@ -79,7 +79,7 @@ The {@link module:clipboard/dragdrop~DragDrop `DragDrop`} plugin will activate a ## Styling the drag and drop -The drag and drop target line color is managed by CSS variable (`--ck-clipboard-drop-target-color`). You can use the following snippet to change the color of the line: +The drag and drop target line color is managed by the CSS variable (`--ck-clipboard-drop-target-color`). You can use the following snippet to change the color of the line: ```css :root { diff --git a/packages/ckeditor5-clipboard/docs/framework/deep-dive/clipboard.md b/packages/ckeditor5-clipboard/docs/framework/deep-dive/clipboard.md index 898209c9cdb..a2d861743fd 100644 --- a/packages/ckeditor5-clipboard/docs/framework/deep-dive/clipboard.md +++ b/packages/ckeditor5-clipboard/docs/framework/deep-dive/clipboard.md @@ -231,7 +231,7 @@ The output pipeline is the equivalent of the input pipeline but for the copy and ```plaintext ┌──────────────────────┐ ┌──────────────────────┐ Retrieves the selected │ view.Document │ │ view.Document │ model.DocumentFragment - │ copy │ │ cut │ and fires `outputTransformation` + │ copy │ │ cut │ and fires the `outputTransformation` └───────────┬──────────┘ └───────────┬──────────┘ event. │ │ └────────────────┌────────────────┘ diff --git a/packages/ckeditor5-clipboard/src/clipboardpipeline.ts b/packages/ckeditor5-clipboard/src/clipboardpipeline.ts index 9701bee4d57..9b7f783f6c2 100644 --- a/packages/ckeditor5-clipboard/src/clipboardpipeline.ts +++ b/packages/ckeditor5-clipboard/src/clipboardpipeline.ts @@ -62,7 +62,7 @@ import viewToPlainText from './utils/viewtoplaintext'; // // ┌──────────────────────┐ ┌──────────────────────┐ // │ view.Document │ │ view.Document │ Retrieves the selected model.DocumentFragment -// │ copy │ │ cut │ and fires `outputTransformation` event. +// │ copy │ │ cut │ and fires the `outputTransformation` event. // └───────────┬──────────┘ └───────────┬──────────┘ // │ │ // └────────────────┌────────────────┘ diff --git a/packages/ckeditor5-ui/docs/features/blocktoolbar.md b/packages/ckeditor5-ui/docs/features/blocktoolbar.md index e7901fdc1aa..53a21c51c80 100644 --- a/packages/ckeditor5-ui/docs/features/blocktoolbar.md +++ b/packages/ckeditor5-ui/docs/features/blocktoolbar.md @@ -10,7 +10,7 @@ The block toolbar plugin provides an additional [configurable](#configuration) t ## Demo - In the editor below, move the caret around the content. You'll see that the block toolbar button (`⠿`) is following your selection. Click the button to show the toolbar. + In the editor below, move the caret around the content. You'll see that the block toolbar button {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} is following your selection. Click the button to show the toolbar. {@snippet features/blocktoolbar} @@ -21,9 +21,9 @@ The block toolbar plugin provides an additional [configurable](#configuration) t ## Additional feature information -To access the block toolbar, you need to click the button with braille pattern dots icon (`⠿`) on the left-hand side of the content area (the gutter). The button appears next to the selected block element (e.g. a paragraph), following the caret as the user edits the content and navigates the document. +To access the block toolbar, you need to click the button with braille pattern dots icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} on the left-hand side of the content area (the gutter). The button appears next to the selected block element (e.g. a paragraph), following the caret as the user edits the content and navigates the document. -The icon (`⠿`) is also a handle to drag blocks of content around the editor. E.g. click on a heading in the demo above and drag it all the way down between the following paragraphs to see this functionality in action. +The icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} is also a handle to drag blocks of content around the editor. E.g. click on a heading in the demo above and drag it all the way down between the following paragraphs to see this functionality in action. The block toolbar complements the {@link installation/getting-started/predefined-builds#balloon-editor balloon editor} where it falls short, for example when you must insert some content (like an image), but the selection is collapsed, so you cannot access the toolbar. You can read more about it in the {@link installation/getting-started/predefined-builds#balloon-block-editor balloon block editor overview}. @@ -53,7 +53,7 @@ If you plan to run the editor in a right–to–left (RTL) language, keep in min } ``` -Before the v40.0.0 release of CKEditor 5, the block toolbar used the pilcrow icon (¶) as a handle. This was changed to braille pattern dots icon (`⠿`) as a default. If you want to use a different icon, you can configure it easily, for example: +Before the v40.0.0 release of CKEditor 5, the block toolbar used the pilcrow icon (¶) as a handle. This was changed to braille pattern dots icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} as a default. If you want to use a different icon, you can configure it easily, for example: ```js blockToolbar: {