help: Update Message formatting section and page on Mentions.

This commit is contained in:
David Rosa
2023-03-14 20:20:57 -06:00
committed by Tim Abbott
parent b6b217681a
commit 93062b3ec4
5 changed files with 32 additions and 18 deletions

View File

@@ -22,7 +22,7 @@ whenever you need a reminder of the formatting syntax below.
* [Quotes](#quotes)
* [Spoilers](#spoilers)
* [Emoji and emoticons](#emoji-and-emoticons)
* [Mentions](#mentions)
* [Mention a user or group](#mention-a-user-or-group)
* [Status messages](#status-messages)
* [Global times](#global-times)
* [Tables](#tables)
@@ -86,21 +86,11 @@ whenever you need a reminder of the formatting syntax below.
{!emoji-and-emoticons-examples.md!}
## Mentions
## Mention a user or group
Learn more about mentions [here](/help/mention-a-user-or-group).
{!mentions-intro.md!}
```
Users: @**Polonius** or @**aaron|26** or @**|26** (two asterisks)
User group: @*support team* (one asterisk)
Silent mention: @_**Polonius** or @_**|26** (@_ instead of @)
```
The variants with numbers use user IDs, and are intended for
disambiguation (if multiple users have the same name) and bots (for
the variant that only contains the user ID).
![Markdown mentions](/static/images/help/markdown-mentions.png)
{!mentions-examples.md!}
## Status messages

View File

@@ -0,0 +1,17 @@
### What you type
```
Users: @**Bo Lin** or @**Ariella Drake|26** (two `*`)
User group: @*support team* (one `*`)
Silent mention: @_**Bo Lin** or @_**Ariella Drake|26** (`@_` instead of `@`)
```
!!! tip ""
A `|` followed by a user ID is inserted automatically when you select a
user from the typeahead suggestions, if there are two users with the same
name in the organization.
### What it looks like
![Markdown mentions](/static/images/help/markdown-mentions.png)

View File

@@ -0,0 +1,5 @@
You can mention a team member or [user group](/help/user-groups) to call their
attention to a message. Mentions follow the same [notification
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)
allows you to refer to a user without triggering a notification.

View File

@@ -1,9 +1,6 @@
# Mention a user or group
You can mention a team member or [user group](/help/user-groups) to call their attention to a
message. Mentions follow the same
[notification settings](/help/dm-mention-alert-notifications) as direct
messages and alert words.
{!mentions-intro.md!}
## Mention a user or group
@@ -70,8 +67,13 @@ wildcard mentions, either
[globally](/help/dm-mention-alert-notifications) or for [individual
streams](/help/stream-notifications).
## Examples
{!mentions-examples.md!}
## Related articles
* [Message formatting](/help/format-your-message-using-markdown)
* [Restrict wildcard mentions](/help/restrict-wildcard-mentions)
* [Quote and reply](/help/quote-and-reply)
* [View your mentions](/help/view-your-mentions)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 27 KiB