DOC-1928: Replace "id" with "ID" in partials/configuration

Farzad Hayatbakhsh · Farzad Hayatbakhsh · commit c5a2d4b68d73 · 2024-12-23T09:58:17.000+10:00
diff --git a/modules/ROOT/partials/configuration/advtemplate_create_category.adoc b/modules/ROOT/partials/configuration/advtemplate_create_category.adoc
@@ -16,7 +16,7 @@ The plugin uses the `advtemplate_create_category` asynchronous function to creat
 [cols="1,1,3",options="header"]
 |===
 | Field  | Type       | Description
-| `+id+` | `+String+` | The id of the newly created category.
+| `+id+` | `+String+` | The ID of the newly created category.
 |===
 
 === Example: using `advtemplate_create_category`
diff --git a/modules/ROOT/partials/configuration/advtemplate_create_template.adoc b/modules/ROOT/partials/configuration/advtemplate_create_template.adoc
@@ -11,14 +11,14 @@ The plugin uses the `advtemplate_create_template` asynchronous function to creat
 | Field          | Type       | Required? | Description
 | `+title+`      | `+String+` | required  | The title of the template.
 | `+content+`    | `+String+` | required  | The content of the template.
-| `+categoryId+` | `+String+` | optional  | The parent category id.
+| `+categoryId+` | `+String+` | optional  | The parent category ID\.
 |===
 
 *Return data:*
 [cols="1,1,3",options="header"]
 |===
 | Field  | Type       | Description
-| `+id+` | `+String+` | The id of newly created template.
+| `+id+` | `+String+` | The ID of newly created template.
 |===
 
 === Example: using `advtemplate_create_template`
diff --git a/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc b/modules/ROOT/partials/configuration/advtemplate_delete_category.adoc
@@ -9,7 +9,7 @@ The plugin uses the `advtemplate_delete_category` asynchronous function to delet
 [cols="1,1,1,3",options="header"]
 |===
 | Field  | Type       | Required? | Description
-| `+id+` | `+String+` | required  | The id of the category to delete.
+| `+id+` | `+String+` | required  | The ID of the category to delete.
 |===
 
 *Return data:*
diff --git a/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc b/modules/ROOT/partials/configuration/advtemplate_delete_template.adoc
@@ -9,7 +9,7 @@ The plugin uses the `advtemplate_delete_template` asynchronous function to delet
 [cols="1,1,1,3",options="header"]
 |===
 | Field  | Type       | Required? | Description
-| `+id+` | `+String+` | required  | The id of the template to delete.
+| `+id+` | `+String+` | required  | The ID of the template to delete.
 |===
 
 *Return data:*
diff --git a/modules/ROOT/partials/configuration/advtemplate_get_template.adoc b/modules/ROOT/partials/configuration/advtemplate_get_template.adoc
@@ -9,14 +9,14 @@ The plugin uses the `advtemplate_get_template` asynchronous function to get a te
 [cols="1,1,1,3",options="header"]
 |===
 | Field  | Type       | Required? | Description
-| `+id+` | `+String+` | required  | The id of the template to get.
+| `+id+` | `+String+` | required  | The ID of the template to get.
 |===
 
 *Return data:*
 [cols="1,1,3",options="header"]
 |===
 | Field       | Type       | Description
-| `+id+`      | `+String+` | The id of the template.
+| `+id+`      | `+String+` | The ID of the template.
 | `+title+`   | `+String+` | The title of the template.
 | `+content+` | `+String+` | The content of the template.
 |===
diff --git a/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc b/modules/ROOT/partials/configuration/advtemplate_move_category_items.adoc
@@ -9,8 +9,8 @@ The plugin uses the `advtemplate_move_category_items` asynchronous function to m
 [cols="1,1,1,3",options="header"]
 |===
 | Field             | Type        | Required? | Description
-| `+oldCategoryId+` | `+String+`  | required  | The id of the source category.
-| `+newCategoryId+` | `+String+`  | optional  | The id of the destination category.
+| `+oldCategoryId+` | `+String+`  | required  | The ID of the source category.
+| `+newCategoryId+` | `+String+`  | optional  | The ID of the destination category.
 |===
 
 *Return data:* Empty object  `{}`
diff --git a/modules/ROOT/partials/configuration/advtemplate_move_template.adoc b/modules/ROOT/partials/configuration/advtemplate_move_template.adoc
@@ -9,8 +9,8 @@ The plugin uses the `advtemplate_move_template` asynchronous function to move th
 [cols="1,1,1,3",options="header"]
 |===
 | Field            | Type        | Required? | Description
-| `+templateId+`   | `+String+`  | required  | The id of the template to move.
-| `+newCategoryId+`| `+String+`  | optional  | The id of the destination category.
+| `+templateId+`   | `+String+`  | required  | The ID of the template to move.
+| `+newCategoryId+`| `+String+`  | optional  | The ID of the destination category.
 |===
 
 *Return data:* Empty object  `{}`
diff --git a/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc b/modules/ROOT/partials/configuration/advtemplate_rename_category.adoc
@@ -9,7 +9,7 @@ The plugin uses the `advtemplate_rename_category` asynchronous function to renam
 [cols="1,1,1,3",options="header"]
 |===
 | Field    | Type       | Required? | Description
-| `+id+`   | `+String+` | required  | The id of the category to rename.
+| `+id+`   | `+String+` | required  | The ID of the category to rename.
 | `+title+`| `+String+` | required  | New category title.
 |===
 
diff --git a/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc b/modules/ROOT/partials/configuration/advtemplate_rename_template.adoc
@@ -9,7 +9,7 @@ The plugin uses the `advtemplate_rename_template` asynchronous function to renam
 [cols="1,1,1,3",options="header"]
 |===
 | Field     | Type       | Required? | Description
-| `+id+`    | `+String+` | required  | The id of the template to rename.
+| `+id+`    | `+String+` | required  | The ID of the template to rename.
 | `+title+` | `+String+` | required  | New template title.
 |===
 
diff --git a/modules/ROOT/partials/configuration/auto_focus.adoc b/modules/ROOT/partials/configuration/auto_focus.adoc
@@ -1,7 +1,7 @@
 [[auto_focus]]
 == `+auto_focus+`
 
-Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance id is the id for the original `+textarea+` or `+div+` element that got replaced. If you set this option to `+true+`, the focus will be set to the last initialized editor instance.
+Automatically set the focus to an editor instance. The value of this option should be an editor instance `+id+`. The editor instance ID is the ID for the original `+textarea+` or `+div+` element that got replaced. If you set this option to `+true+`, the focus will be set to the last initialized editor instance.
 
 *Type:* `+String+` or `+true+`
 
diff --git a/modules/ROOT/partials/configuration/body_id.adoc b/modules/ROOT/partials/configuration/body_id.adoc
@@ -1,15 +1,15 @@
 [[body_id]]
 == `+body_id+`
 
-This option enables you to specify an id for the body of each editor instance. This id can then be used to do {productname} specific overrides in your `+content_css+`.
+This option enables you to specify an ID for the body of each editor instance. This ID can then be used to do {productname} specific overrides in your `+content_css+`.
 
 *Type:* `+String+`
 
 *Default value:* `+'tinymce'+`
 
 === Example: using `+body_id+`
 
-This will add the same id to all editors that gets created by the `+init+` call.
+This will add the same ID to all editors that gets created by the `+init+` call.
 
 [source,js]
 ----
diff --git a/modules/ROOT/partials/configuration/mentions_menu_complete.adoc b/modules/ROOT/partials/configuration/mentions_menu_complete.adoc
@@ -18,7 +18,7 @@ tinymce.init({
   mentions_menu_complete: (editor, userInfo) => {
     const span = editor.getDoc().createElement('span');
     span.className = 'mymention';
-    // store the user id in the mention so it can be identified later
+    // store the user ID in the mention so it can be identified later
     span.setAttribute('data-mention-id', userInfo.id);
     span.appendChild(editor.getDoc().createTextNode('@' + userInfo.name));
     return span;
diff --git a/modules/ROOT/partials/configuration/mentions_select.adoc b/modules/ROOT/partials/configuration/mentions_select.adoc
@@ -26,7 +26,7 @@ tinymce.init({
   },
   mentions_select: (mention, success) => {
     // `mention` is the element we previously created with `mentions_menu_complete`
-    // in this case we have chosen to store the id as an attribute
+    // in this case we have chosen to store the ID as an attribute
     const id = mention.getAttribute('data-mention-id');
     // request more information about the user from the server and cache locally
     if (!userRequest[id]) {
@@ -70,7 +70,7 @@ tinymce.init({
   },
   mentions_select: (mention, success) => {
     // `mention` is the element we previously created with `mentions_menu_complete`
-    // in this case we have chosen to store the id as an attribute
+    // in this case we have chosen to store the ID as an attribute
     const id = mention.getAttribute('data-mention-id');
     // request more information about the user from the server and cache locally
     if (!userRequest[id]) {
diff --git a/modules/ROOT/partials/configuration/selector.adoc b/modules/ROOT/partials/configuration/selector.adoc
@@ -20,7 +20,7 @@ tinymce.init({
 });
 ----
 
-=== Example: replace a textarea element with id "editable"
+=== Example: replace a textarea element with ID "editable"
 
 [source,js]
 ----
@@ -29,7 +29,7 @@ tinymce.init({
 });
 ----
 
-=== Example: inline editing mode on a div element with id "editable"
+=== Example: inline editing mode on a div element with ID "editable"
 
 [source,js]
 ----
diff --git a/modules/ROOT/partials/configuration/tinycomments_author.adoc b/modules/ROOT/partials/configuration/tinycomments_author.adoc
@@ -1,7 +1,7 @@
 [[tinycomments_author]]
 == `+tinycomments_author+`
 
-This option sets the author id to be used when creating or replying to comments.
+This option sets the author ID to be used when creating or replying to comments.
 
 *Type:* `+String+`
 
diff --git a/modules/ROOT/partials/configuration/tinycomments_create.adoc b/modules/ROOT/partials/configuration/tinycomments_create.adoc
@@ -15,7 +15,7 @@ The `+done+` callback should accept the following object:
 [source,js]
 ----
 {
-  conversationUid: string, // the new conversation uid
+  conversationUid: string, // the new conversation UID
   // Optional error callback which will be run if the new conversation could not be created
   onError: (err) => { ... },
   // Optional success callback which will be run when the new conversation is successfully created
diff --git a/modules/ROOT/partials/configuration/tinycomments_delete.adoc b/modules/ROOT/partials/configuration/tinycomments_delete.adoc
@@ -5,7 +5,7 @@ The `+tinycomments_delete+` function should asynchronously return a flag indicat
 
 The `+tinycomments_delete+` function is passed a (`+req+`) object as the first parameter, which contains the following key-value pair:
 
-`+conversationUid+`:: The uid of the conversation the reply is targeting.
+`+conversationUid+`:: The UID of the conversation the reply is targeting.
 
 The `+done+` callback should accept the following object:
 
diff --git a/modules/ROOT/partials/configuration/tinycomments_delete_comment.adoc b/modules/ROOT/partials/configuration/tinycomments_delete_comment.adoc
@@ -5,8 +5,8 @@ The `+tinycomments_delete_comment+` function should asynchronously return a flag
 
 The `+tinycomments_delete_comment+` function is given a request (`+req+`) object as the first parameter, which has these fields:
 
-`+conversationUid+`:: The uid of the conversation the reply is targeting.
-`+commentUid+`:: The uid of the comment to delete (cannot be the same as `+conversationUid+`).
+`+conversationUid+`:: The UID of the conversation the reply is targeting.
+`+commentUid+`:: The UID of the comment to delete (cannot be the same as `+conversationUid+`).
 
 The `+done+` callback should accept the following object:
 
diff --git a/modules/ROOT/partials/configuration/tinycomments_edit_comment.adoc b/modules/ROOT/partials/configuration/tinycomments_edit_comment.adoc
@@ -7,8 +7,8 @@ The `+tinycomments_edit_comment+` function allows updating or changing existing
 
 The `+tinycomments_edit_comment+` function is given a request (`+req+`) object as the first parameter, which has these fields:
 
-`+conversationUid+`:: The uid of the conversation the reply is targeting.
-`+commentUid+`:: The uid of the comment to edit (it can be the same as `+conversationUid+` if editing the first comment in a conversation).
+`+conversationUid+`:: The UID of the conversation the reply is targeting.
+`+commentUid+`:: The UID of the comment to edit (it can be the same as `+conversationUid+` if editing the first comment in a conversation).
 `+content+`:: The content of the comment to create.
 `+modifiedAt+`:: The date the comment was modified.
 
diff --git a/modules/ROOT/partials/configuration/tinycomments_lookup.adoc b/modules/ROOT/partials/configuration/tinycomments_lookup.adoc
@@ -11,15 +11,15 @@ The conventional conversation object structure that should be returned via the `
 
 The `+tinycomments_lookup+` function is passed a (`+req+`) object as the first parameter, which contains the following key-value pair:
 
-`+conversationUid+`:: The uid of the conversation the reply is targeting.
+`+conversationUid+`:: The UID of the conversation the reply is targeting.
 
 The `+done+` callback should accept the following object:
 
 [source,js]
 ----
 {
  conversation: {
-   uid: string, // the uid of the conversation,
+   uid: string, // the UID of the conversation,
    comments: [
     {
       author: string, // author of first comment
@@ -28,7 +28,7 @@ The `+done+` callback should accept the following object:
       createdAt: date, // when the first comment was created
       content: string, // content of first comment
       modifiedAt: date, // when the first comment was created/last updated
-      uid: string // the uid of the first comment in the conversation
+      uid: string // the UID of the first comment in the conversation
     },
     {
       author: string, // author of second comment
@@ -37,7 +37,7 @@ The `+done+` callback should accept the following object:
       createdAt: date, // when the second comment was created
       content: string, // content of second comment
       modifiedAt: date, // when the second comment was created/last updated
-      uid: string // the uid of the second comment in the conversation
+      uid: string // the UID of the second comment in the conversation
     }
   ]
  }
diff --git a/modules/ROOT/partials/configuration/tinycomments_reply.adoc b/modules/ROOT/partials/configuration/tinycomments_reply.adoc
@@ -7,7 +7,7 @@ The `+tinycomments_reply+` function saves the comment as a reply to an existing
 
 The `+tinycomments_reply+` function is given a request (`+req+`) object as the first parameter, which has these fields:
 
-`+conversationUid+`:: The uid of the conversation the reply is targeting.
+`+conversationUid+`:: The UID of the conversation the reply is targeting.
 `+content+`:: The content of the comment to create.
 `+createdAt+`:: The date the comment was created (ISO 8601 date string) format.
 
@@ -16,8 +16,8 @@ The `+done+` callback should accept the following object:
 [source,js]
 ----
 {
-  commentUid: string, // the new comment uid
-  author: string, // the id of the current author
+  commentUid: string, // the new comment UID
+  author: string, // the ID of the current author
   authorName: string // the name of the current author
 }
 ----
diff --git a/modules/ROOT/partials/configuration/tinycomments_resolve.adoc b/modules/ROOT/partials/configuration/tinycomments_resolve.adoc
@@ -7,7 +7,7 @@ The `+tinycomments_resolve+` function should asynchronously return a flag indica
 
 The `+tinycomments_resolve+` function is passed a (`+req+`) object as the first parameter, which contains the following key-value pair:
 
-`+conversationUid+`:: The uid of the targeting conversation
+`+conversationUid+`:: The UID of the targeting conversation
 
 The `+done+` callback should accept the following object:
 
