From 23d7aa8b84942483c01a874d3496d16b028cf193 Mon Sep 17 00:00:00 2001 From: godai78 Date: Thu, 5 Oct 2023 09:53:51 +0200 Subject: [PATCH] Docs: post-release docs review. [short flow] --- docs/updating/update-to-40.md | 10 +++++----- .../ckeditor5-clipboard/docs/features/drag-drop.md | 10 +++++----- .../docs/framework/deep-dive/clipboard.md | 2 +- packages/ckeditor5-clipboard/src/clipboardpipeline.ts | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) 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. // └───────────┬──────────┘ └───────────┬──────────┘ // │ │ // └────────────────┌────────────────┘