Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove straggling case of "groups" #3652

Merged
merged 2 commits into from Jan 18, 2022
Merged

Remove straggling case of "groups" #3652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7794f3
Remove straggling case of "groups"
turt2live Jan 18, 2022
6b18e7c
changelog
turt2live Jan 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/3652.clarification
View file
Open in desktop
@@ -0,0 +1 @@
Clarify that group mentions are no longer in the specification.
21 changes: 13 additions & 8 deletions content/client-server-api/modules/mentions.md
View file
Open in desktop
Expand Up @@ -2,12 +2,11 @@
type: module
---

### User, room, and group mentions
### User and room mentions

This module allows users to mention other users, rooms, and groups
within a room message. This is achieved by including a [matrix.to
URI](/appendices/#matrixto-navigation) in the HTML body of an
[m.room.message](#mroommessage) event. This module does not have any server-specific
This module allows users to mention other users and rooms within a room message.
This is achieved by including a [Matrix URI](/appendices/#uris) in the HTML body of
an [m.room.message](#mroommessage) event. This module does not have any server-specific
behaviour to it.

Mentions apply only to [m.room.message](#mroommessage) events where the `msgtype` is
Expand All @@ -28,7 +27,7 @@ To make a mention, reference the entity being mentioned in the

#### Client behaviour

In addition to using the appropriate `matrix.to URI` for the mention,
In addition to using the appropriate `Matrix URI` for the mention,
clients should use the following guidelines when making mentions in
events to be sent:

Expand All @@ -40,7 +39,6 @@ events to be sent:
listed on the room. If no alias can be found, fall back to the room
ID. In all cases, use the alias/room ID being linked to as the
anchor's text.
- When referencing groups, use the group ID as the anchor's text.

The text component of the anchor should be used in the event's `body`
where the mention would normally be represented, as shown in the example
Expand All @@ -56,4 +54,11 @@ mention differently from other mentions, such as by using a red
background color to signify to the user that they were mentioned.

When clicked, the mention should navigate the user to the appropriate
room, group, or user information.
user or room information.

{{% boxes/note %}}
Similar to legacy [matrix.to URLs](/appendices/#matrixto-navigation),
groups used to be representable by mentions. They follow a similar format
to room mentions, though using the group ID in both the link and anchor
text.
{{% /boxes/note %}}