Skip to content

Commit b1acbb3

Browse files
author
Sorita Heng
committed
Comment out note about stacked changes and minor copy edits
1 parent 0e1756f commit b1acbb3

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

modules/ROOT/pages/trackchanges.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,7 @@ include::partial$misc/admon-iframe-only.adoc[]
2323

2424
The Track Changes plugin monitors edits made to a document by comparing its current state to the original version. Each change is attributed to its respective author and can be approved or rejected before being applied to the document.
2525

26-
[NOTE]
27-
Since the comparison is made against the original version of the document, if there are unresolved changes by multiple authors affecting the same part, the most recent change will be used for comparison. The `hasChanges` API can be used to implement a safeguard that prevents further edits on a document with unresolved changes.
28-
29-
The plugin includes a dedicated view for reviewing current changes, accessible via the `{plugincode} toolbar button or the menu option under the `View` menu. The key components are:
26+
The plugin includes a dedicated view for reviewing current changes, accessible via the `{plugincode}` toolbar button or the menu option under the `View` menu. The key components are:
3027

3128
. **Read-only Diff View**:
3229
+
@@ -41,7 +38,7 @@ Highlights the current changes made to the document, using the following color c
4138
Contains a header with the following buttons:
4239
+
4340
* Show Changes: A toggle button which hides/unhides the change annotations.
44-
* Complete: Ends the review applies the resolved changes.
41+
* Complete: Ends the review and applies the resolved changes.
4542
* Cancel: Ends the review without any further action.
4643

4744
+
@@ -109,4 +106,12 @@ include::partial$events/{plugincode}-events.adoc[]
109106

110107
The {pluginname} plugin provides the following APIs.
111108

112-
include::partial$plugin-apis/{plugincode}-apis.adoc[]
109+
include::partial$plugin-apis/{plugincode}-apis.adoc[]
110+
111+
////
112+
== Known Limitations
113+
114+
[NOTE]
115+
Since the comparison is made against the original version of the document, if there are unresolved changes by multiple authors affecting the same part, the most recent change will be used for comparison. The `hasChanges` API can be used to implement a safeguard that prevents further edits on a document with unresolved changes.
116+
117+
////

modules/ROOT/partials/plugin-apis/trackchanges-apis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
|===
33
|Name |Arguments |Description
44

5-
|getModel |N/A |Return an object representing the document model used to store tracked changes data.
5+
|getModel |N/A |Return an object representing the document model used to store data of the tracked changes.
66
//|setModel |xref:#trackeddocument[TrackedDocument] `+Object+` | Set the current model of the document.
77
//|resetModel |N/A |Reset the document to its original state.
88
|hasChanges |N/A |Return a boolean value indicating whether the document contains changes to be reviewed.

0 commit comments

Comments
 (0)