From ebd4181ae02a2aaa926b19ec4bb7060d32bcc156 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Thu, 13 Oct 2022 19:23:24 -0400 Subject: [PATCH] help: Update message menu documentation. Updates all help center documentation according to the latest changes to the three-dot message menu and the UI for moving and editing messages. Fixes #23217. --- .../zerver/help/configure-notification-bot.md | 2 +- .../zerver/help/edit-or-delete-a-message.md | 22 +++++++++---------- templates/zerver/help/emoji-reactions.md | 2 +- .../help/move-content-to-another-stream.md | 12 +++++----- .../help/move-content-to-another-topic.md | 4 +++- templates/zerver/help/quote-and-reply.md | 4 ++-- templates/zerver/help/rename-a-topic.md | 19 ++++++++-------- templates/zerver/help/star-a-message.md | 2 +- .../view-the-markdown-source-of-a-message.md | 3 ++- 9 files changed, 36 insertions(+), 34 deletions(-) diff --git a/templates/zerver/help/configure-notification-bot.md b/templates/zerver/help/configure-notification-bot.md index c621f8aee6..ad1bcc32c3 100644 --- a/templates/zerver/help/configure-notification-bot.md +++ b/templates/zerver/help/configure-notification-bot.md @@ -16,7 +16,7 @@ The notification bot also generates automated private messages to individual users for some user specific events, such as [being subscribed to a stream][add-users-to-stream] by another user. -Additionally, when [moving messages to a another stream][move-messages], +Additionally, when [moving messages to another stream][move-messages], users can have the notification bot send automated notices to help others find the moved content. diff --git a/templates/zerver/help/edit-or-delete-a-message.md b/templates/zerver/help/edit-or-delete-a-message.md index 99f8a5a0f9..ba6e8288ea 100644 --- a/templates/zerver/help/edit-or-delete-a-message.md +++ b/templates/zerver/help/edit-or-delete-a-message.md @@ -19,25 +19,22 @@ content. {!message-actions.md!} -1. Click the pencil () icon. +1. Click the **pencil** () icon. 1. Edit the message, and click **Save**. +!!! warn "" + **Note:** If you don't see the **pencil** () icon, + you are not permitted to edit this message. + {end_tabs} -!!! warn "" +!!! tip "" - **Note:** After you have edited a message, the message is publicly + After you have edited a message, the message is publicly marked as **EDITED**. You can - [view a message's edit history](/help/view-a-messages-edit-history), - assuming that feature has not been - [disabled by an organization administrator](/help/disable-message-edit-history). - -If you don't see the pencil () icon, the message content -can no longer be edited. You should see a file () -icon instead. Clicking the file icon will allow you to view the -[Markdown source](/help/view-the-markdown-source-of-a-message) of the message, or -[edit the topic](/help/rename-a-topic). + [view a message's edit history](/help/view-a-messages-edit-history) + if it is [enabled](/help/disable-message-edit-history) in your organization. ## Delete a message @@ -96,6 +93,7 @@ permissions to delete that message. ## Related articles +* [View the Markdown source of a message](/help/view-the-markdown-source-of-a-message) * [Delete a topic](/help/delete-a-topic) * [Archive a stream](/help/archive-a-stream) * [Message retention policy](/help/message-retention-policy) diff --git a/templates/zerver/help/emoji-reactions.md b/templates/zerver/help/emoji-reactions.md index 51031c6d31..b883a09e9c 100644 --- a/templates/zerver/help/emoji-reactions.md +++ b/templates/zerver/help/emoji-reactions.md @@ -11,7 +11,7 @@ underneath the message. {!message-actions.md!} -1. Click the smiley face () icon. +1. Click the **smiley face** () icon. !!! warn "" diff --git a/templates/zerver/help/move-content-to-another-stream.md b/templates/zerver/help/move-content-to-another-stream.md index e20b9ae67d..3c2df3d2c9 100644 --- a/templates/zerver/help/move-content-to-another-stream.md +++ b/templates/zerver/help/move-content-to-another-stream.md @@ -26,11 +26,11 @@ destination streams. 1. Select the destination stream for the topic from the streams dropdown list. -1. (optional) Change the topic. +1. _(optional)_ Change the topic name. 1. Toggle whether automated notices should be sent. -1. Click **Confirm**. +1. Click **Confirm** to move the topic to another stream. !!! warn "" @@ -52,13 +52,13 @@ destination streams. 1. Select the destination stream for the message from the streams dropdown list. -1. (optional) Change the topic. - -1. Toggle whether automated notices should be sent. +1. _(optional)_ Change the topic name. 1. From the dropdown menu, select which messages to move. -1. Click **Save**. +1. Toggle whether automated notices should be sent. + +1. Click **Confirm** to move the selected content to another stream. !!! warn "" diff --git a/templates/zerver/help/move-content-to-another-topic.md b/templates/zerver/help/move-content-to-another-topic.md index 2bcde5cab3..4a6cd4f47e 100644 --- a/templates/zerver/help/move-content-to-another-topic.md +++ b/templates/zerver/help/move-content-to-another-topic.md @@ -29,7 +29,9 @@ for the details on when topic editing is allowed. 1. From the dropdown menu, select which messages to move. -1. Click **Save**. +1. Toggle whether automated notices should be sent. + +1. Click **Confirm** to move the selected content to another topic. {end_tabs} diff --git a/templates/zerver/help/quote-and-reply.md b/templates/zerver/help/quote-and-reply.md index 36ed94479b..d6f9064736 100644 --- a/templates/zerver/help/quote-and-reply.md +++ b/templates/zerver/help/quote-and-reply.md @@ -19,7 +19,7 @@ to avoid unnecessarily mentioning someone twice. {!message-actions-menu.md!} -1. Click **Quote and reply**. +1. Click **Quote and reply or forward**. 1. *(optional)* Delete any parts of the quoted message that are not relevant to your reply. @@ -30,7 +30,7 @@ to avoid unnecessarily mentioning someone twice. !!! keyboard_tip "" - You can also use > to **quote and reply** to the + You can also use > to **quote and reply or forward** the selected message. ## Related articles diff --git a/templates/zerver/help/rename-a-topic.md b/templates/zerver/help/rename-a-topic.md index 12aad5e3a8..5480e1896b 100644 --- a/templates/zerver/help/rename-a-topic.md +++ b/templates/zerver/help/rename-a-topic.md @@ -21,29 +21,30 @@ for the details on when topic editing is allowed. {start_tabs} -1. Click on the icon in the message recipient bar. +1. Click the **pencil** () icon in the message recipient bar. 1. Edit the topic name. -1. Click the **✔** to save your changes. +1. Click the **checkmark** () icon to save your changes. {end_tabs} -### Via a message (alternate method) +### Via the left sidebar (alternate method) {start_tabs} -{!message-actions-menu.md!} +{!topic-actions.md!} -1. Select **Move message**. If you do not see this option, you do not have permission - to edit the topic of this message. +1. Select **Move topic**. -1. Edit the topic. +1. Edit the topic name. -1. From the dropdown menu, select **Change previous and following messages to this topic**. +1. _(optional)_ Select the destination stream for the topic from the streams dropdown list. -1. Click **Save**. +1. Toggle whether automated notices should be sent. + +1. Click **Confirm** to rename the topic. {end_tabs} diff --git a/templates/zerver/help/star-a-message.md b/templates/zerver/help/star-a-message.md index 053a1f3e1f..5581b479a9 100644 --- a/templates/zerver/help/star-a-message.md +++ b/templates/zerver/help/star-a-message.md @@ -10,7 +10,7 @@ tasks you need to go back to or documents you reference often. {tab|desktop} {!message-actions.md!} -1. Click the star () icon. +1. Click the **star** () icon. {tab|mobile} diff --git a/templates/zerver/help/view-the-markdown-source-of-a-message.md b/templates/zerver/help/view-the-markdown-source-of-a-message.md index 891efd0475..6d424d9015 100644 --- a/templates/zerver/help/view-the-markdown-source-of-a-message.md +++ b/templates/zerver/help/view-the-markdown-source-of-a-message.md @@ -9,10 +9,11 @@ formatted, or to copy the Markdown source for a reply. {!message-actions-menu.md!} -3. Click **View source**. +3. Click **View message source**. {end_tabs} ## Related articles * [Format messages using Markdown](/help/format-your-message-using-markdown) +* [Edit or delete a message](/help/edit-or-delete-a-message)