You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Suggested Edits plugin allows users to easily review and manage changes made to a document by multiple authors.
12
+
The {pluginname} plugin allows multiple users to collaborate on a document. The plugin shows which user suggested which edits, whether they added, removed, modified, or replaced any content, and allows users to provide feedback on those suggestions or give a final review by approving or rejecting them.
The Suggested Edits plugin builds a document model of the editor content to track edits made by multiple authors. This model is used to compare the current content of the editor with the original version, highlighting changes such as insertions, modifications, and deletions.
22
+
The {pluginname} plugin keeps track of every suggested edit made to the document by the current user, as the edits are made, and stores this metadata in an internal model of the document. These suggestions can then be reviewed in the `'suggestededits'` xref:custom-view.adoc[editor view], where each edit is highlighted in the document, and where you can accept, reject, or provide feedback. The `'suggestededits'` view is accessible via either the `suggestededits` toolbar button or menu button within the `View` menu.
25
23
26
-
This allows users to review the changes made to the document, provide feedback on them, and accept or reject them as needed. See xref:#suggestededits_access[`suggestededits_access`] option for more information on how to configure user permissions for editing and reviewing content.
24
+
[IMPORTANT]
25
+
These edits, and any feedback provided, are stored in the model provided by the plugin xref:#get_model[`+get_model()+` API]. This model should be saved externally alongside the document, and loaded into the editor with the xref:#suggestededits_model[`+suggestededits_model+` option]. This will ensure that both the document and the model are in sync, and that every user's contributions are tracked correctly.
27
26
28
-
[NOTE]
29
-
The model's content should be considered as metadata of the editor's HTML content, and both should be saved together to ensure correctness. See xref:#suggestededits_content[`suggestededits_content`] for more information on how to configure the source of content loaded into the editor.
27
+
== Reviewing edits
28
+
29
+
The {pluginname} plugin provides a dedicated `'suggestededits'` xref:custom-view.adoc[editor view] for viewing and reviewing edits made by multiple authors. Which actions you can take in this view depends on the xref:#suggestededits_access[`+suggestededits_access+` option].
30
+
31
+
=== Header
32
+
33
+
The view contains a few controls to manage the review process:
34
+
35
+
* Show edits: A toggle button which hides/unhides the highlighted annotations.
36
+
* Complete review: Ends the review, applying the resolved changes to the document.
37
+
* Cancel: Exits the review with no change to the document.
30
38
31
-
A dedicated read-only view is provided for reviewing current changes, accessible via the `{plugincode}` toolbar button or the menu option under the `View` menu. The key components are:
39
+
=== Document
32
40
33
-
. **Read-only Diff View**:
34
-
+
35
-
Highlights the current changes made to the document, using the following color codes:
36
-
+
37
-
* Green: New content.
38
-
* Blue: Modified content. Modifications to HTML content implies attributes or formatting (e.g. bold, italic, etc.).
41
+
The current editor document is displayed in a sandboxed iframe, with each suggested edit highlighted as they appear in the document. The following color coding is used to indicate the type of change:
42
+
43
+
* Green: Added content.
44
+
* Blue: Modified attributes or formatting (e.g. bold, italic, etc.).
39
45
* Red: Removed content.
40
46
41
-
. **Sidebar**:
42
-
+
43
-
Contains a header with the following buttons:
44
-
+
45
-
* Show Changes: A toggle button which hides/unhides the change annotations.
46
-
* Complete: Ends the review and applies the resolved changes.
47
-
* Cancel: Ends the review without any further action.
47
+
Replaced content is represented as both added and removed content, and indicates that some content was removed and replaced with new content in a single edit. When a suggestion is selected, whether in the document or in the sidebar, the corresponding highlighted suggestion in the document will be outlined in blue and scrolled into view.
48
+
49
+
=== Sidebar
50
+
51
+
Each suggested edit is listed as a card in the sidebar and color coded by the type of change, along with the user who made the suggestion, when the edit was made, and any feedback provided on that suggestion. When selected, each suggestion can be handled in the following ways:
52
+
53
+
* Accept: Resolves the edit and will be applied to the document when .
54
+
* Reject: Removes the change from the document.
55
+
* Revert: Undoes a previously accepted or rejected change.
56
+
* Provide feedback: Opens a text area for you to provide feedback on the suggestion.
57
+
58
+
Any feedback will be stored in the model and displayed underneath the card details and in chronological order. This feedback thread can be used to discuss the suggestion with the author or other reviewers. The feedback author can edit or delete their own feedback.
59
+
60
+
At the top of the sidebar, there is also a dropdown menu to apply review actions in bulk to all suggested edits:
48
61
49
-
+
50
-
The sidebar also displays all tracked changes that need to be resolved. Each change can be handled in the following ways:
51
-
* Accept: Applies the change to the document.
52
-
* Reject: Removes the change from the document.
53
-
* Revert: Undoes a previously accepted or rejected change.
62
+
* Accept all.
63
+
* Reject all.
64
+
* Revert all.
54
65
55
-
== Types of suggestions
66
+
=== Finishing a review
56
67
57
-
There are four basic types of suggestions that are tracked by the Suggested Edits plugin:
68
+
When you complete a review, any resolved suggestions will be applied to the document and will no longer be tracked in the model as suggestions, including any feedback on resolved suggestions. This means that any accepted edits will remain in the docuemnt, and any rejected edits will be reverted to the state before the suggestion was made. More specifically, review actions will apply the following to the document:
58
69
59
-
=== Insert
60
-
Tracks the addition of new content to the document.
70
+
* When added content is -
71
+
** Accepted: The content will remain in the document.
72
+
** Rejected: The content will be removed from the document.
61
73
62
-
=== Modify
63
-
Tracks HTML attribute changes or formatting changes to existing content, such as bold or italic text. Note that if multiple users modify the same content, the original author will still be attributed with the change.
74
+
* When modified content is -
75
+
** Accepted: The content will keep the current formats and attributes.
76
+
** Rejected: The content will revert to the formats and attributes it had before the edit was made.
64
77
65
-
=== Delete
66
-
Tracks the removal of content from the document.
78
+
* When removed content is -
79
+
** Accepted: The content will be remain removed from the document.
80
+
** Rejected: The content will be restored to the document.
67
81
68
-
=== Replace
69
-
Tracks the replacement of existing content with new content. This is treated as a combination of a delete and an insert, where the original content is selected and replaced by new content. Note that if multiple users replace the same content, the most recent author will be attributed with the change.
82
+
If you cancel your review, no resolved suggestions will be applied to the document and all suggestions will remain in the model, including any feedback provided during that review session.
0 commit comments