paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Add section on transcoded images.

Browse Source
This commit is contained in:
Karl Stolley
2025-10-14 14:11:06 -05:00
committed by Tim Abbott
parent 19e5c8b8c9
commit 90054890f3
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
api_docs/message-formatting.md
View File

@@ -172,6 +172,29 @@ backlogged, an individual message containing multiple image previews
may be re-rendered multiple times as each image finishes thumbnailing may be re-rendered multiple times as each image finishes thumbnailing
and triggers a message update. and triggers a message update.
### Transcoded images
Image elements whose formats are not widely supported by web browsers
(e.g., HEIC and TIFF) may contain a `data-transcoded-image` attribute,
which specifies a high-resolution thumbnail format that clients may
opt to present instead of the original image. If the
`data-transcoded-image` attribute is present, clients should use the
`data-original-content-type` attribute to decide whether to display the
original image or use the transcoded version.
Transcoded images are presented with this structure in image previews:
``` html
<div class="message_inline_image">
<a href="/user_uploads/path/to/example.heic" title="example.heic">
<img data-original-dimensions="1920x1080"
data-original-content-type="image/heic"
data-transcoded-image="1920x1080.webp"
src="/user_uploads/thumbnail/path/to/example.heic/840x560.webp">
</a>
</div>
```
### Recommended client processing of image previews ### Recommended client processing of image previews
Clients are recommended to do the following when processing image Clients are recommended to do the following when processing image