From 3475ef62ab28e4f71ae4e6bdf3d7b4db50741237 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 18 Jan 2022 08:58:58 -0700 Subject: [PATCH] Remove straggling case of "groups" (#3652) * Remove straggling case of "groups" * changelog --- .../newsfragments/3652.clarification | 1 + content/client-server-api/modules/mentions.md | 21 ++++++++++++------- 2 files changed, 14 insertions(+), 8 deletions(-) create mode 100644 changelogs/client_server/newsfragments/3652.clarification diff --git a/changelogs/client_server/newsfragments/3652.clarification b/changelogs/client_server/newsfragments/3652.clarification new file mode 100644 index 00000000..8fd7a393 --- /dev/null +++ b/changelogs/client_server/newsfragments/3652.clarification @@ -0,0 +1 @@ +Clarify that group mentions are no longer in the specification. \ No newline at end of file diff --git a/content/client-server-api/modules/mentions.md b/content/client-server-api/modules/mentions.md index 924c413d..65e2adab 100644 --- a/content/client-server-api/modules/mentions.md +++ b/content/client-server-api/modules/mentions.md @@ -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 @@ -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: @@ -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 @@ -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 %}} \ No newline at end of file