Skip to content

Commit e3ec479

Browse files
committed
DOC-3174: Edits
1 parent 193d1c4 commit e3ec479

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

modules/ROOT/pages/suggestededits.adoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ include::partial$misc/admon-iframe-only.adoc[]
1919

2020
== How it works
2121

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.
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. These edits, and any feedback provided, are stored in the model provided by the plugin xref:#get_model[`+get_model()+` API].
2323

2424
[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.
25+
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.
2626

2727
== Reviewing edits
2828

@@ -83,7 +83,7 @@ If you cancel your review, no resolved suggestions will be applied to the docume
8383

8484
== Initial setup
8585

86-
The Suggested Edits plugin uses a document model to track changes. If the model is not provided in the editor configuration, the plugin will create a new model from the current content of the editor. This model can be retrieved from the editor at any time using the xref:#get_model[`getModel` API], and should be saved externally
86+
The {pluginname} plugin requires a model to store . If the model is not provided in the editor configuration, the plugin will create a new model from the current content of the editor. This model can be retrieved from the editor at any time using the xref:#get_model[`getModel` API], and should be saved externally
8787

8888
To setup the {pluginname} plugin in the editor:
8989

@@ -109,7 +109,15 @@ tinymce.init({
109109

110110
The following configuration options affect the behavior of the {pluginname} plugin.
111111

112-
include::partial$configuration/suggestededits-options.adoc[leveloffset=+1]
112+
include::partial$configuration/user_id.adoc[leveloffset=+1]
113+
114+
include::partial$configuration/fetch_users.adoc[leveloffset=+1]
115+
116+
include::partial$configuration/suggestededits_model.adoc[leveloffset=+1]
117+
118+
include::partial$configuration/suggestededits_content.adoc[leveloffset=+1]
119+
120+
include::partial$configuration/suggestededits_access.adoc[leveloffset=+1]
113121

114122
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
115123

modules/ROOT/partials/configuration/suggestededits-options.adoc

Lines changed: 0 additions & 5 deletions
This file was deleted.

modules/ROOT/partials/toolbar-button-ids/suggestededits-toolbar-buttons.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
|===
33
|Toolbar button identifier |Description
44

5-
|`+suggestededits+` |Open the Suggested Edits view.
5+
|`+suggestededits+` |Open the Review edits view.
6+
|`+suggestededits-label+` |Opens the Review edits view.
67
|===

0 commit comments

Comments
 (0)