Clarify spoiler documentation

This commit is contained in:
Andrew Morgan 2022-10-26 11:46:33 +01:00
parent f73ebb40f1
commit 06a469c8d9

View file

@ -327,12 +327,11 @@ If a reason were to be supplied, it would look like:
}
```
When sending a spoiler, clients SHOULD provide the spoilered text fallback in the `body`
as shown above (including the reason). The fallback SHOULD omit the spoiler text verbatim
since `body` might show up in text-only clients or in notifications. To prevent spoilers
showing up in such situations, clients are strongly encouraged to first upload the spoilered
text to the media repository then reference the MXC URI in a markdown-style link, as shown
above.
When sending a spoiler, clients SHOULD provide the fallback in the `body` as shown above
(including the reason). The fallback SHOULD omit the spoiler text verbatim since `body`
might show up in text-only clients or in notifications. To prevent spoilers showing up in
such situations, clients are strongly encouraged to first upload the text containing spoilers
to the media repository, then reference the MXC URI in a markdown-style link, as shown above.
Clients SHOULD render spoilers differently with some sort of disclosure. For example, the
client could blur the actual text and ask the user to click on it for it to be revealed.