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
Copy file name to clipboardExpand all lines: modules/ROOT/partials/configuration/fetch_users.adoc
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
[[fetch_users]]
2
2
== `fetch_users`
3
3
4
-
A callback function that retrieves user data for the plugin. It receives an array of user IDs and returns a `Promise` resolving to an array of user objects. The callback uses the xref:#userlookupapi[`UserLookup API`].
4
+
A **required callback function** that fetches user data for the Suggested Edits view. This function is called with an array of user IDs and should return a `Promise` that resolves to an array of user objects. The callback is used by the xref:userlookup.adoc[`UserLookup`] API.
5
5
6
6
*Type:* `Function`
7
7
@@ -11,7 +11,8 @@ A callback function that retrieves user data for the plugin. It receives an arra
11
11
*Returns:*
12
12
- `Promise<Array<Object>>`: A promise that resolves to an array of user objects.
Copy file name to clipboardExpand all lines: modules/ROOT/partials/configuration/suggestededits_content.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
[[suggestededits_content]]
2
2
== `suggestededits_content`
3
-
The `{plugincode}_content` option determines where the initial content of the document is loaded from. With this option, you can set the content to be loaded from either the editor or the model, allowing you to control the source of truth for the document.
3
+
The `suggestededits_content` option determines where the initial content of the document is loaded from. With this option, you can set the content to be loaded from either the editor or the model, allowing you to control the source of truth for the document.
4
4
5
5
When set to `'html'`, the editor loads the initial content from the HTML in the textarea or the `content` property. In this case, if a model is provided, it will need to match the content in the editor for the plugin to work correctly
6
6
7
-
When set to `'model'`, the editor loads the initial content from the `{plugincode}_model` option. In this case, the content in the editor will be overwritten with the content from the model. This would allow you to only require the model for document tracking, though it is still recommended to save the content in the editor externally.
7
+
When set to `'model'`, the editor loads the initial content from the `suggestededits_model` option. In this case, the content in the editor will be overwritten with the content from the model. This would allow you to only require the model for document tracking, though it is still recommended to save the content in the editor externally.
8
8
9
9
In either case, if a model is not provided, the plugin will generate a new model from the current content of the editor, whether it is empty or not.
10
10
@@ -14,7 +14,7 @@ In either case, if a model is not provided, the plugin will generate a new model
This option specifies a unique identifier for the current user, enabling the plugin to distinguish between different users in the editor. The option uses the xref:#userlookupapi[`UserLookup API`].
4
+
This option sets the unique identifier for the current user in the editor. It is used in the the xref:userlookup.adoc[`UserLookup`] API.
5
5
6
6
*Type:* `+String+`
7
7
8
-
.Example
8
+
*Default value:* `'Anonymous'`
9
+
10
+
=== Example: using `user_id` option
11
+
9
12
[source,javascript]
10
13
----
11
14
tinymce.init({
12
15
selector: 'textarea', // Change this value according to your HTML
13
-
user_id: 'unique-identifier' // replace this with a unique string to identify the user
16
+
user_id: 'alextaylor' // replace this with a unique string to identify the user
0 commit comments