help: Document @ topic mentions.

Documents new wildcard mention for topic participants updating
and making tweaks to all relevant pages.

Fixes #27657.

Co-authored-by: Alya Abbott <alya@zulip.com>
This commit is contained in:
David Rosa 2023-11-13 22:06:22 -08:00 committed by Tim Abbott
parent d87f47412b
commit 21aa5d261a
5 changed files with 35 additions and 12 deletions

View File

@ -30,20 +30,22 @@ messages) from desktop notifications.
## Wildcard mentions ## Wildcard mentions
By default, wildcard mentions (`@**all**`, `@**everyone**`, or `@**stream**`) By default, wildcard mentions (`@**all**`, `@**everyone**`, `@**stream**`,
trigger email/push notifications as though they were personal @-mentions. You or `@**topic**`) trigger email/push notifications as though they were
can toggle whether you receive notifications for wildcard mentions. personal @-mentions. You can toggle whether you receive notifications
for wildcard mentions.
!!! tip "" !!! tip ""
Unlike personal mentions, wildcard mentions do not trigger notifications Unlike personal mentions, wildcard mentions do not trigger notifications
in muted streams. in muted streams or topics.
{start_tabs} {start_tabs}
{settings_tab|notifications} {settings_tab|notifications}
1. In the **Notification triggers** table, toggle the **@all** checkbox for **Streams**. 1. In the **Notification triggers** table, toggle the **@all** checkbox for
**Streams** or **Followed topics**.
{end_tabs} {end_tabs}

View File

@ -4,7 +4,7 @@
Users: @**Bo Lin** or @**Ariella Drake|26** (two `*`) Users: @**Bo Lin** or @**Ariella Drake|26** (two `*`)
User group: @*support team* (one `*`) User group: @*support team* (one `*`)
Silent mention: @_**Bo Lin** or @_**Ariella Drake|26** (`@_` instead of `@`) Silent mention: @_**Bo Lin** or @_**Ariella Drake|26** (`@_` instead of `@`)
Wildcard mentions: @**all**, @**everyone**, or @**stream** (two `*`) Wildcard mentions: @**all**, @**everyone**, @**stream**, or @**topic** (two `*`)
``` ```
!!! tip "" !!! tip ""

View File

@ -3,4 +3,6 @@ attention to a message. Mentions follow the same [notification
settings](/help/dm-mention-alert-notifications) as direct messages and alert settings](/help/dm-mention-alert-notifications) as direct messages and alert
words. A [silent mention](/help/mention-a-user-or-group#silently-mention-a-user) words. A [silent mention](/help/mention-a-user-or-group#silently-mention-a-user)
allows you to refer to a user without triggering a notification. A wildcard allows you to refer to a user without triggering a notification. A wildcard
mention allows you to [mention everyone on a stream](/help/mention-a-user-or-group#mention-everyone-on-a-stream). mention allows you to
[mention everyone on a stream](/help/mention-a-user-or-group#mention-everyone-on-a-stream),
or [mention all topic participants](/help/mention-a-user-or-group#mention-all-topic-participants).

View File

@ -55,18 +55,37 @@ notification. Silent mentions start with `@_` instead of `@`.
{end_tabs} {end_tabs}
## Mention all topic participants
Using the `@**topic**` mention, you can mention everyone who has previously
participated in the topic by sending a message or
[reacting](/help/emoji-reactions) with an emoji. This lets you notify just those
who have already engaged in the conversation.
Users can disable notifications for `@**topic**` mentions by:
- Disabling notifications for wildcard mentions
[globally](/help/dm-mention-alert-notifications) or for [individual
streams](/help/stream-notifications).
- Muting the [topic](/help/mute-a-topic) or [stream](/help/mute-a-stream).
## Mention everyone on a stream ## Mention everyone on a stream
You can mention everyone on a stream with the `@**all**` mention (or, You can mention everyone on a stream with the `@**all**` mention (or,
equivalently, `@**everyone**` or `@**stream**`). Use sparingly! Used improperly, equivalently, `@**everyone**` or `@**stream**`). It's best to use these mentions
wildcard mentions can be annoying. only when your message requires timely attention from many stream subscribers.
An organization can be configured to
[restrict](/help/restrict-wildcard-mentions) wildcard mentions in large streams.
Note that this will not notify anyone who has muted the stream, and Users can disable notifications for `@**topic**` mentions by:
users can disable receiving email/push notifications for these
wildcard mentions, either - Disabling notifications for wildcard mentions
[globally](/help/dm-mention-alert-notifications) or for [individual [globally](/help/dm-mention-alert-notifications) or for [individual
streams](/help/stream-notifications). streams](/help/stream-notifications).
- Muting the [topic](/help/mute-a-topic) or [stream](/help/mute-a-stream).
## Examples ## Examples
{!mentions-examples.md!} {!mentions-examples.md!}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 41 KiB