MSC4193: Spoilers on Media #4193
Conversation
proposals/4193-spoilers-on-media.md
Outdated
| ## Security considerations | ||
| None, hopefully. | ||
| ## Unstable prefix | ||
| Until this is stable, clients should use `org.matrix.msc4193.spoiler` and `org.matrix.msc4193.spoiler.reason`. |
There was a problem hiding this comment.
org.matrix is reserved for matrix.org, so you'll need to use something like your own domain for the unstable prefix.
There was a problem hiding this comment.
I've updated it to my Codeberg Pages site.
There was a problem hiding this comment.
Usually it is fine to use org.matrix in a MSC if you'd like. Just include the MSC # in it.
proposals/4193-spoilers-on-media.md
Outdated
| ## Potential issues | ||
| A user with malicious intent may put something inappropriate in the reason field. | ||
| ## Alternatives | ||
| One alternative is the [Spoilerinator](https://codeberg.org/cf/spoilerinator) tool. |
There was a problem hiding this comment.
I would just clarify what this alternative does and the limitations of it.
From my brief look at it, it uses Matrix HTML to create an interactive/clickable dropdown to view the image.
The limitation of this compared to the MSC would be that not all clients implement HTML, and HTML on mobile clients isn't very good. Additionally this requires a multi-step process of copying the media URL / MXC URI and running this external tool, and most likely doesn't work in encrypted rooms.
There was a problem hiding this comment.
I've added a note about the limitations.
clokep
added
proposal
There was a problem hiding this comment.
Implementation requirements:
- Client sending spoilers
- Client respecting spoilers
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
| # MSC4193: Spoilers on Media | ||
| This proposal aims to enhance the protocol with more ways to make other users feel comfortable while using the protocol. | ||
| Background | ||
| Matrix includes a way to add a spoiler to text, which hides the text from visibility without explicit user interaction to show the hidden text. However, there is no official way to do this with images. |
There was a problem hiding this comment.
The existing spoilers work on all message types that support formatted_body and org.matrix.custom.html.
To send spoilers clients MUST use the
formatted_bodyand therefore theorg.matrix.custom.htmlformat, described above. This makes spoilers valid on anymsgtypewhich can support this format appropriately.
Since 1.10 images actually fall into that category, too, through their media captions.
So with this proposal it's now possible to have an image itself be behind a spoiler with its caption behind another spoiler. This made me wonder if we'd need some form of UI guidance on how to treat this situation? For instance, should the spoilers be revealed together or separately?
There was a problem hiding this comment.
I'd say that spoilers should be done separately.
There was a problem hiding this comment.
I'd imagine most people would want to configure each separately, as the caption may tell people what is inside the image to help them know whether they want to view it?
There was a problem hiding this comment.
That sounds sensible and I think c1e9fb4 has addressed it accordingly.
proposals/4193-spoilers-on-media.md
Outdated
| ``` | ||
| ## Potential issues | ||
| A user with malicious intent may put something inappropriate in the reason field. Additionally, clients that do not support this feature will show all media without a spoiler. | ||
| # Alternatives |
There was a problem hiding this comment.
#3725 also provides a way to do spoilers on media.
Rendered