ad-si
October 9, 2019, 3:17pm
1
Instead of displaying the original filename the lightbox overlay should display the alt tag and/or the title tag of the image.
The image name is often not useful at all. (E.g. something like shutterstock_1073920454325.jpg.) Futhermore the filename can’t even be changed later, since a new filename isn’t accepted, as an image already exists in the database using the same SHA1.
5 Likes
Johani
November 5, 2019, 10:54am
2
There’s a bit of a long story here. You can read the description of the PRs if you’re interested in learning more. Per
master ← hnb-ku:use-image-alt-in-overlay
merged 11:15PM - 03 Nov 19 UTC
some history / context:
https://meta.discourse.org/t/display-an-images-alt-o… r-title-attribute-in-ligthbox-overlay/130579
https://meta.discourse.org/t/image-title-and-alt-tags-not-displaying/38918/5
This PR is also a prerequisite to some work being done here
https://meta.discourse.org/t/make-it-more-obvious-an-image-is-resizable-when-uploading-an-image/132030
<hr>
Right now, when you add an image and it's big enough to be lightboxed you get an overlay that looks like so
This overlay contains some useful information but notice that it also contains the filename. Why does this happen? it happens because we check if the image has a title and use that, but otherwise we fallback to the filename.
https://github.com/hnb-ku/discourse/blob/master/lib/cooked_post_processor.rb#L427-L429
The issue here is that most image will not have a title because markdown does not add one unless you use a very particular syntax.
the default syntax we use when a user uploads / copy-pastes an image looks like this
```
```
and will result in this markup after it's processed by markdown
```
<img src="/uploads/default/original/1X/fbfa85f19aae34a5f2d7fd9586d843daac895655.png" alt="pluginPage01" width="368" height="413">
```
So, there's no title and we therefore fallback to the filename in the overlay.
Markdown supports adding a title but the syntax is different and looks like so
```
```
that would then generate
```
<img src="/uploads/default/original/1X/fbfa85f19aae34a5f2d7fd9586d843daac895655.png" alt="pluginPage01" title="image title" width="368" height="413">
```
which would then be used in the overlay because the image has a title.
What this PR does is add the image alt as a fallback before falling back to the file name.
That means that we go
title > alt > filename
This allows us to leverage on the alt that markdown generates and allows users to control the text or image description used in the overlay.
For example, let's say you have an image with the name `photo01.jpg` and you upload that image. you get this in the editor
```
```
Prior to this PR, even if you edit `photo01` to `cute cats playing with water` the overlay for the lightbox in the cooked post will still display as `photo01`
This PR makes it possible to change the overlay text in the editor by changing `photo01` to the desired text to be displayed in the lightbox overlay.
If an image has both a title and an alt, then the title is used and the alt is ignored, which ensures backwards compatibility for cases when a markdown title was added.
This will only affect new posts and old posts would need to be rebaked.
and
master ← hnb-ku:fix-resizing-regex
merged 10:40AM - 05 Nov 19 UTC
This is related to some work being done to improve image resizing controls in th… e composer here
https://meta.discourse.org/t/make-it-more-obvious-an-image-is-resizable-when-uploading-an-image/132030
and also relates to the work that was done here https://github.com/discourse/discourse/pull/8286
<hr>
We currently use this regex
```
/(!\[(?:\S*?(?=\|)\|)*?(?:\d{1,6}x\d{1,6})+?)(?:,?(\d{1,3})?%?)?(\]\(upload:\/\/\S*?\))/g
```
to match composer images that can be resized. This works well, but fails if there's some whitespace in the image alt or if the image has a title, Some examples
```diff
Default:
+ 
image with a scale %:
+ 
image with a scale % and a whitespace:
- 
Image with space in alt
- 
Image with a title
- 
Image with alt title and a scale %
- 
```
Matches are highlighted above in green, a red highlight means the string should match but it currently doesn't.
This PR changes the regex to this
```
/!\[(.*?)\|(\d{1,4}x\d{1,4})(,\s*\d{1,3}%)?\]\((upload:\/\/.*?)\)/g
```
If we use the same examples above with this regex, they all match
```diff
Default:
+ 
image with a scale %:
+ 
image with a scale % and a whitespace:
+ 
Image with space in alt
+ 
Image with a title
+ 
Image with alt title and a scale %
+ 
```
If you’re on the latest, you should now be able to change the text that shows in the overlay in the editor
When you upload an image, you’ll get this
You can edit fileName to whatever you want the image overlay to show.
A quick note:
This was always possible but would have required you to know how markdown handles titles
The way to add a title in markdown looks like this
Given that not many people know about this, the first PR above adds the image alt as a fallback before defaulting to the file name. It being a fallback means that if a title is there, then it’s respected, if not, we use the alt.
6 Likes
Johani
November 6, 2019, 10:00am
3
This topic was automatically closed after 22 hours. New replies are no longer allowed.
