MSC3765: Rich text in room topics #3765

Johennes · 2022-04-03T12:26:44Z

Implementations:

In line with matrix-org/matrix-spec#1700, the following disclosure applies:

I am a Systems Architect at gematik, Software Engineer at Unomed, Matrix community member and former Element employee. This proposal was written and published with my community member hat on.

FCP tickyboxes

Signed-off-by: Johannes Marbach <[email protected]>

proposals/3765-rich-room-topics.md

Co-authored-by: Travis Ralston <[email protected]>

turt2live · 2022-04-17T19:35:37Z

proposals/3765-rich-room-topics.md

@@ -0,0 +1,96 @@
+# MSC3765: Rich text in room topics


@alphapapa says:

On one hand, I can see some elegance in repurposing room topics for general-purpose, long-term room reference information. OTOH, it seems like overloading the purpose of topics with what, in other systems, would go in "pinned" topics or messages, or a wiki, etc.

So IMHO I would consider implementing support for pinned messages/events before overloading topics like this. It would seem relatively straightforward for a room's state to have a list of pinned events, which could be sent in initial sync by the server or be retrieved manually by clients. Clients could then display these pinned events in a room's timeline view, optionally hiding them, compressing them, etc. And the pinned events could be edited by room moderators using existing event-editing tools. (Forgive me if there's already a proposal for something like that.)

@Johennes replies:

Interesting idea. Pinned events seem to already exist. However, in their current form, these are not fit to be used for what you describe because, depending on room settings, users joining the room after the events were sent could be unable to see them.

proposals/3765-rich-room-topics.md

turt2live · 2022-04-17T19:37:34Z

@alphapapa and others: please use threads on the diff to have your comments considered. This can be done by adding a line comment.

If there's no obvious line for where to put a comment, please use the line containing the title.

proposals/3765-rich-room-topics.md

ara4n · 2025-01-14T09:28:36Z

Not a blocking concern, but I'm a little worried that the m.topic wrapper on the content block is unnecessary and just makes things more verbose and clunky - see #3765 (comment) for context. Thoughts welcome on whether this should be a blocking concern or not. (i'm happy with everything else and have ticked anyway to avoid blocking)

Co-authored-by: Johannes Marbach <[email protected]>

richvdh · 2025-01-21T14:56:12Z

@mscbot concern which order are the representations in?

proposals/3765-rich-room-topics.md

richvdh · 2025-01-21T15:07:07Z

proposals/3765-rich-room-topics.md

+into a separate `content['m.text']` field. Lastly, the `m.topic` content
+block also serves as a good place for additional fields to be added by
+other MSCs in the future.


Non-blocking comment:

I don't entirely follow why we need an m.topic block as a place to put extra fields (unless we think that we're going to end up with topics inside other event types?) but maybe that's my lack of familiarity with extensible events.

@ara4n as the person that proposed this (I think?) can you clarify?

proposals/3765-rich-room-topics.md

Co-authored-by: Johannes Marbach <[email protected]>

richvdh · 2025-01-23T12:52:04Z

@mscbot resolve which order are the representations in?

richvdh

Thanks, this LGTM now, other than the outstanding question at #3765 (comment)

Half-Shot · 2025-01-31T11:39:41Z

proposals/3765-rich-room-topics.md

+  "type": "m.room.topic",
+  "state_key": "",
+  "content": {
+    "m.topic": {


Just for clarity here (since we've always failed to spec this behavior outright). Should m.topic be omitted if the topic was removed from the room, or empty array (or both because it amounts to the same thing?).

The implementation doesn't allow for this currently, and I'm just doing some cleanup.

I don't really have a strong opinion on this at all but in an attempt to make the decision feel less arbitrary: content["m.topic"] will have to be optional because otherwise we'd make all existing topic events suddenly be incompatible. In other words, omitting m.topic will have to be possible. Since that already provides us a way to remove the rich topic, we might as well say that this is the way. Happy to hear other thoughts, however.

mscbot · 2025-02-18T21:44:35Z

🔔 This is now entering its final comment period, as per the review above. 🔔

mscbot · 2025-02-23T21:44:46Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

richvdh · 2025-02-26T09:12:27Z

proposals/3765-rich-room-topics.md

+On the server side, any logic that currently operates on the `topic` field is
+updated to use the `m.topic` content block instead:
+
+- In [`/_matrix/client/v3/createRoom`], the `topic` parameter should cause `m.room.topic`
+  to be written with a `text/plain` mimetype in `m.topic`. If at the same time an
+  `m.room.topic` event is supplied in `initial_state`, it is overwritten entirely.
+  A future MSC may generalize the `topic` parameter to allow specifying other mime
+  types without `initial_state`.
+- In [`GET /_matrix/client/v3/publicRooms`], [`GET /_matrix/federation/v1/publicRooms`]
+  and their `POST` siblings, the `topic` response field should be read from the
+  `text/plain` mimetype of `m.topic` if it exists or omitted otherwise.
+  A plain text topic is sufficient here because this data is commonly
+  only displayed to users that are *not* a member of the room yet. These
+  users don't commonly have the same need for rich room topics as users
+  who already reside in the room. A future MSC may update these endpoints
+  to support rich text topics.
+- The same logic is applied to [`/_matrix/client/v1/rooms/{roomId}/hierarchy`]
+  and [`/_matrix/federation/v1/hierarchy/{roomId}`].
+- In [server side search], the `room_events` category is expanded to search
+  over the `m.text` content block of `m.room.topic` events.


@Johennes this bit doesn't seem to have been implemented in mainline synapse (unless I'm missing it): do we have a sample server-side implementation?

Hm, no. I actually never made a server implementation. Initially this proposal didn't have any server parts and then I guess I forgot the implementation when adding these later. 🤦

Better late than never: element-hq/synapse#18195

The advantage of having shunted the implementation is that it now can use stable identifiers directly. 😇

richvdh · 2025-02-26T10:43:11Z

proposals/3765-rich-room-topics.md

+  `m.room.topic` event is supplied in `initial_state`, it is overwritten entirely.
+  A future MSC may generalize the `topic` parameter to allow specifying other mime
+  types without `initial_state`.
+- In [`GET /_matrix/client/v3/publicRooms`], [`GET /_matrix/federation/v1/publicRooms`]


For reference: MSC3266 adds /room_summary, defined to behave the same as /publicRooms, so that will also need updating if the code isn't shared.

Add rich room topic MSC

9b914c6

Signed-off-by: Johannes Marbach <[email protected]>

Johennes changed the title ~~MSC3677: Rich text in room topics~~ MSC3765: Rich text in room topics Apr 3, 2022

Johennes added 2 commits April 3, 2022 14:28

Rename to reflect propper MSC number

06d315d

Fix typo

09c7014

ShadowJonathan reviewed Apr 3, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

turt2live added proposal-in-review proposal A matrix spec change proposal client-server Client-Server API kind:feature MSC for not-core and not-maintenance stuff labels Apr 3, 2022

ara4n reviewed Apr 3, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Show resolved Hide resolved

ara4n reviewed Apr 3, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

turt2live reviewed Apr 4, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

turt2live reviewed Apr 4, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

Johennes and others added 3 commits April 4, 2022 19:49

Explain why m.topic is kept separate from m.message

1d0031a

Use json5 for formatting code snippet

3b572e7

Co-authored-by: Travis Ralston <[email protected]>

Remove unneeded unstable room version

6270109

This comment was marked as duplicate.

Sign in to view

turt2live reviewed Apr 17, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Show resolved Hide resolved

emorrp1 reviewed Apr 18, 2022

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

turt2live removed the proposal-in-review label May 5, 2022

Johennes added 2 commits January 5, 2023 15:50

Adapt to latest version of MSC1767

af184dd

Add paragraph about preventing formatting abuse

aa373d1

Apply suggestions from code review

ac5c6fc

Johennes commented Dec 18, 2024

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

richvdh and others added 2 commits January 21, 2025 14:46

Update proposals/3765-rich-room-topics.md

79e3f5d

Co-authored-by: Johannes Marbach <[email protected]>

Properly explain why the m.topic content block is needed (#4251)

a64a825

mscbot added the unresolved-concerns This proposal has at least one outstanding concern label Jan 21, 2025

richvdh reviewed Jan 21, 2025

View reviewed changes

Johennes commented Jan 23, 2025

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

Johennes commented Jan 23, 2025

View reviewed changes

proposals/3765-rich-room-topics.md Outdated Show resolved Hide resolved

Apply suggestions from code review

c83f56d

Co-authored-by: Johannes Marbach <[email protected]>

mscbot removed the unresolved-concerns This proposal has at least one outstanding concern label Jan 23, 2025

richvdh approved these changes Jan 23, 2025

View reviewed changes

Half-Shot reviewed Jan 31, 2025

View reviewed changes

mscbot added final-comment-period This MSC has entered a final comment period in interest to approval, postpone, or delete in 5 days. and removed proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period. labels Feb 18, 2025

mscbot added finished-final-comment-period and removed disposition-merge final-comment-period This MSC has entered a final comment period in interest to approval, postpone, or delete in 5 days. labels Feb 23, 2025

turt2live merged commit 3f3b34a into main Feb 24, 2025
1 check passed

turt2live added spec-pr-missing Proposal has been implemented and is being used in the wild but hasn't yet been added to the spec and removed finished-final-comment-period labels Feb 24, 2025

sumnerevans mentioned this pull request Feb 24, 2025

event: add support for MSC3765 rich text room topics mautrix/go#354

Merged

Johennes mentioned this pull request Feb 25, 2025

MSC3266: Room summary API #3266

Open

richvdh reviewed Feb 26, 2025

View reviewed changes

Johennes mentioned this pull request Feb 28, 2025

Add plain-text handling for rich-text topics as per MSC3765 element-hq/synapse#18195

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC3765: Rich text in room topics #3765

MSC3765: Rich text in room topics #3765

Johennes commented Apr 3, 2022 •

edited by clokep

Loading

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

turt2live Apr 17, 2022

turt2live Apr 17, 2022

turt2live commented Apr 17, 2022

ara4n commented Jan 14, 2025

richvdh commented Jan 21, 2025

richvdh Jan 21, 2025

richvdh commented Jan 23, 2025

richvdh left a comment

Half-Shot Jan 31, 2025

Johennes Feb 11, 2025 •

edited

Loading

mscbot commented Feb 18, 2025

mscbot commented Feb 23, 2025

richvdh Feb 26, 2025

Johennes Feb 26, 2025

Johennes Feb 28, 2025

richvdh Feb 26, 2025

MSC3765: Rich text in room topics #3765

MSC3765: Rich text in room topics #3765

Conversation

Johennes commented Apr 3, 2022 • edited by clokep Loading

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turt2live commented Apr 17, 2022

ara4n commented Jan 14, 2025

richvdh commented Jan 21, 2025

Choose a reason for hiding this comment

richvdh commented Jan 23, 2025

richvdh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Johennes Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

mscbot commented Feb 18, 2025

mscbot commented Feb 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Johennes commented Apr 3, 2022 •

edited by clokep

Loading

Johennes Feb 11, 2025 •

edited

Loading