Skip to content

Commit 71b19af

Browse files
committed
DOC-3246: More docs
1 parent e3ec479 commit 71b19af

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

modules/ROOT/pages/suggestededits.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,28 +83,28 @@ If you cancel your review, no resolved suggestions will be applied to the docume
8383

8484
== Initial setup
8585

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
87-
8886
To setup the {pluginname} plugin in the editor:
8987

9088
* add `{plugincode}` to the `plugins` option in the editor configuration;
9189
* add `{plugincode}` to the `toolbar` option in the editor configuration;
92-
* add `{plugincode}_model` to the editor configuration, if a document is already being tracked.
9390

9491
For example:
9592

9693
[source,js]
9794
----
98-
const suggestededits_model = `<YOUR_DOCUMENT_MODEL>` // model provided by the getModel API
99-
10095
tinymce.init({
10196
selector: 'textarea#suggestededits', // change this value according to your HTML
10297
plugins: 'suggestededits',
10398
toolbar: 'suggestededits',
104-
suggestededits_model,
10599
});
106100
----
107101

102+
This configuration will add {pluginname} to the editor toolbar, allowing users to access the plugin features. However, to fully utilize the plugin, you will need to provide additional configuration options.
103+
104+
The {pluginname} plugin requires a model to store. If the model is not provided in the editor configuration, or is `+undefined+`, the plugin will generate a new model. The model contains all the current suggested edits, so unless you are starting a new document, the current model for the document should always be provided. This model can be retrieved from the editor at any time using the xref:#get_model[`getModel` API], and should be saved externally alongside the document.
105+
106+
The {pluginname} plugin also requires a unique user identifier to attribute suggestions made by each user, including edits and feedback. The current user should be set with the xref:#user_id[`+user_id+` option]. The user ID should be a unique string that identifies the user, such as a username or an email address. Each suggestion in the model will have a uid, allowing other users to see who made which suggestion.
107+
108108
== Options
109109

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

0 commit comments

Comments
 (0)