-
Notifications
You must be signed in to change notification settings - Fork 385
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.
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
MSC1920: Alternative texts for stickers #1920
Conversation
This looks pretty sensible to me. Might be worth considering how this looks like in an extensible events world, but that can also become a problem for extensible events and not here. |
Looks good to me too (thanks @babolivier). As you suggest @turt2live it probably overlaps with extensible events, but I think we can probably ignore that for now (and leave it to be solved as part of the bigger case, in due course). |
Co-Authored-By: babolivier <contact@brendanabolivier.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm totally onboard with finally specifying alt
text, but I think this is far too loose of a spec and it makes me sad that m.image
/m.audio
/m.video
won't get the same treatment.
|
||
The current `m.sticker` event definition includes `body` as a description field for the | ||
sticker. This allows clients to attach a short description of the sticker in an | ||
event. So far this field has mainly been used to give a literal description of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's unclear to me what the body
s role is now? You've stated that the body
is used for something similar to alt_text
but is not used exclusively for that. This implies that body
needs to be more strict about what it cannot contain (not things that are suited for alt_text
).
I worry this PR is going to leave people trying to support both body
and alt_text
, and without a clear seperation of what they are, will end up duping the values for both.
What I want to see is:
- What you think body should and shouldn't be used for?
- What you think the "alternative text" is for the image (if you want to reference
alt
from the HTML spec, please do but make it explicit that you are copying that.
|
||
## Proposal | ||
|
||
Add a new optional `alt_text` field to the `m.sticker` event definition which |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was there a reason not to mirror alt
of HTML. alt_text
looks clunky next to body
(as then I'd argue for body_text
?
|
||
```json | ||
{ | ||
"type": "m.sticker", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By and large, I also think this spec applies to m.image
and it's a shame we are going to skip it entirely, or spec the same thing identically. This is more of a crapness of having stickers be near identical clones of m.image
where they should have really been a superset, and inherited it's kets.
"w": 222 | ||
}, | ||
"alt_text": "The white Matrix logo over a black hexagon", | ||
"body": "Matrix!" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small annoying nag, but "Matrix!" doesn't fit the spec of body
"a message to accompany and further
describe the sticker". If we are going to include the sticker body, let's be consistent.
Oh and I think we do need to consider this with extensible events, or at least include a comment as to why we aren't considering it in the proposal. (Yes extensible events are a proposal and not canon, but to pretend it doesn't exist is frankly silly given how much thought has gone into EE) It makes me slightly mad that extensible events are a prime target for including an Anyway grumpy half-shot is grumpy over stickers. EDIT To clarify, I'm mad over EE still not existing, not this proposal. |
Context on where this proposal comes from: when the Stakey stickerpack landed the other day, @rxl881 was enjoying how better it was that the |
I'd really like a flag in the message to hide the body as well to be honest. Line has stickers without associated descriptions and they work quite well in my experience. I use a few custom sticker packs without text added, so the alt text is super annoying to deal with on all the clients. |
Rendered