DOC-3174: Update interactive demos and examples for embedded mode in tinycomments

Author: kimwoodfield

modules/ROOT/examples/live-demos/comments-embedded/index.js

@@ -16,7 +16,7 @@ tinymce.init({
   quickbars_image_toolbar: 'alignleft aligncenter alignright | rotateleft rotateright | imageoptions',
   tinycomments_mode: 'embedded',
   sidebar_show: 'showcomments',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_resolve: (req, done, fail) => {
     const allowed = req.comments.length > 0 &&
                   req.comments[0].author === currentAuthor;

modules/ROOT/pages/comments-embedded-mode.adoc

@@ -11,17 +11,35 @@ To add the {pluginname} plugin in embedded mode to the {productname}, configure
 
 [source,js]
 ----
+const userDirectory = {
+  'author': { 
+    id: 'author', 
+    name: 'Name of the commenter', 
+    avatar: 'https://example.com/avatar/john.png' 
+  },
+};
+
 tinymce.init({
   selector: 'textarea',  // change this value according to your html
   plugins: 'tinycomments',
   toolbar: 'addcomment showcomments',
-  tinycomments_author: 'author',
-  tinycomments_author_name: 'Name of the commenter',
+  user_id: 'author',
+  fetch_users: (userIds) => {
+    const results = userIds.map((id) => {
+      const user = Object.values(userDirectory).find((user) => user.id === id);
+      if (user) {
+        return user;
+      } else {
+        throw new Error(`User ${id} not found`);
+      }
+    });
+    return Promise.resolve(results);
+  },
   tinycomments_mode: 'embedded'
 });
 ----
 
-This is the minimum recommended setup for the {pluginname} plugin in embedded mode. If the `+tinycomments_author+` and `+tinycomments_author_name+` options are not configured, all users will be assigned the name "_ANON_".
+This is the minimum recommended setup for the {pluginname} plugin in embedded mode. If the `+user_id+` or `+tinycomments_author+` options are not configured, all users will be assigned the name "_ANON_".
 
 [[comments-embedded-live-demo]]
 == Interactive example

modules/ROOT/partials/configuration/tinycomments_can_delete.adoc

@@ -1,15 +1,15 @@
 [[tinycomments_can_delete]]
 == `+tinycomments_can_delete+`
 
-_Optional_: This option sets the author permissions for _deleting comment conversations_. If the `+tinycomments_can_delete+` option is not included, the current author (`+tinycomments_author+`) cannot delete comment conversations created by other authors.
+_Optional_: This option sets the author permissions for _deleting comment conversations_. If the `+tinycomments_can_delete+` option is not included, the current author (`+user_id+`) cannot delete comment conversations created by other authors.
 
 *Type:* `+Function+`
 
 *Default value:*
 [source,js]
 ----
 (req, done, fail) => {
-  const allowed = req.comments.length > 0 && req.comments[0].author === <Current_tinycomments_author>;
+  const allowed = req.comments.length > 0 && req.comments[0].author === <Current_user_id>;
   done({
     canDelete: allowed
   });
@@ -30,7 +30,7 @@ tinymce.init({
   plugins: 'tinycomments',
   toolbar: 'addcomment showcomments',
   tinycomments_mode: 'embedded',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_delete: (req, done, fail) => {
     const allowed = req.comments.length > 0 && req.comments[0].author === currentAuthor;
     done({

modules/ROOT/partials/configuration/tinycomments_can_delete_comment.adoc

@@ -1,15 +1,15 @@
 [[tinycomments_can_delete_comment]]
 == `+tinycomments_can_delete_comment+`
 
-_Optional_: This option sets the author permissions for _deleting comments_. If the `+tinycomments_can_delete_comment+` option is not included, the current author (`+tinycomments_author+`) **cannot** delete comments added by other authors.
+_Optional_: This option sets the author permissions for _deleting comments_. If the `+tinycomments_can_delete_comment+` option is not included, the current author (`+user_id+`) **cannot** delete comments added by other authors.
 
 *Type:* `+Function+`
 
 *Default value:*
 [source,js]
 ----
 (req, done, fail) => {
-  const allowed = req.comment.author === <Current_tinycomments_author>;
+  const allowed = req.comment.author === <Current_user_id>;
   done({
     canDelete: allowed
   });
@@ -30,7 +30,7 @@ tinymce.init({
   plugins: 'tinycomments',
   toolbar: 'addcomment showcomments',
   tinycomments_mode: 'embedded',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_delete_comment: (req, done, fail) => {
     const allowed = req.comment.author === currentAuthor;
     done({

modules/ROOT/partials/configuration/tinycomments_can_edit_comment.adoc

@@ -1,15 +1,15 @@
 [[tinycomments_can_edit_comment]]
 == `+tinycomments_can_edit_comment+`
 
-_Optional_: This option sets the author permissions for _editing comments_. If the `+tinycomments_can_edit_comment+` option is not included, the current author (`+tinycomments_author+`) cannot edit comments added by other authors.
+_Optional_: This option sets the author permissions for _editing comments_. If the `+tinycomments_can_edit_comment+` option is not included, the current author (`+user_id+`) cannot edit comments added by other authors.
 
 *Type:* `+Function+`
 
 *Default value:*
 [source,js]
 ----
 (req, done, fail) => {
-  const allowed = req.comment.author === <Current_tinycomments_author>;
+  const allowed = req.comment.author === <Current_user_id>;
   done({
     canEdit: allowed
   });
@@ -29,7 +29,7 @@ tinymce.init({
   plugins: 'tinycomments',
   toolbar: 'addcomment showcomments',
   tinycomments_mode: 'embedded',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_edit_comment: (req, done, fail) => {
     const allowed = req.comment.author === currentAuthor;
     done({

modules/ROOT/partials/configuration/tinycomments_can_resolve.adoc

@@ -16,7 +16,7 @@ tinymce.init({
   plugins: 'tinycomments',
   toolbar: 'addcomment showcomments',
   tinycomments_mode: 'embedded',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_resolve: (req, done, fail) => {
     const allowed = req.comments.length > 0 && req.comments[0].author === currentAuthor;
     done({

modules/ROOT/partials/plugins/comments-open-sidebar.adoc

@@ -30,7 +30,7 @@ tinymce.init({
   selector: 'textarea',  // change this value according to your html
   plugins: 'tinycomments',
   tinycomments_mode: 'embedded',
-  tinycomments_author: currentAuthor,
+  user_id: currentAuthor,
   tinycomments_can_resolve: canResolveCommentsCallback,
   sidebar_show: 'showcomments'
 });