Re: [PATCH v11] Inline image display as part of a new org-link-preview system

[Ihor Radchenko <yantar92@posteo.net>]

[-- Attachment #1: Type: text/plain, Size: 1034 bytes --]

Karthik Chikmagalur <karthikchikmagalur@gmail.com> writes:

> I've attached the latest version of the patchset, with the link
> descriptions in the manual fixed for PDF readability.  I can't test it
> here so please let me know if it looks good.
>
> I've also rebased the commits onto main.

Thanks!
See the attached further adjustments to the manual.

Also, I found a bug in the new preview system.
Consider the following Org file:

* This is test :ATTACH:
:PROPERTIES:
:ID:       c4cd9f0c-b1fc-4906-9e34-967564123e64
:END:

[[attachment:2024-11-25_19-03.png]][[attachment:2024-11-25_19-03.png]][[attachment:2024-11-25_19-03.png]] 

If you try to preview images in section, not all the images will be previewed.
Furthermore, trying to toggle image previews with point at the links
will yield "wrong side of point":

1. Open the file. Make sure that you adjust the links to point to the
   real files
2. C-c C-x C-v
3. Observe only one link being previewed
4. Move point to link that is not previewed
5. C-c C-x C-v
6. Observe error


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: cleanup.diff --]
[-- Type: text/x-patch, Size: 3508 bytes --]

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 95846b4758..e904b27db2 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11780,20 +11780,19 @@ ** Literal Examples
 
 ** Images and link previews
 :PROPERTIES:
-:DESCRIPTION: Preview links in the buffer
+:DESCRIPTION: Preview links in the buffer.
 :END:
 
-Org mode can display previews of hyperlinks (see [[*Hyperlinks]])
-inside Org buffers.  By default, only image links[fn::Image links are
-=file:= and =attachment:= links to existing image files; Emacs can
-only display the linked images listed in ~image-types~ variable] can
-be previewed inline, where the images are displayed in place of the
-link path.
+Org mode can display previews of [[*Hyperlinks][hyperlinks]] inside Org buffers.  By
+default, only image links[fn::Image links are =file:= and
+=attachment:= links to existing image files; Emacs should be able to
+display the linked images (see ~image-types~ variable)] can be
+previewed inline, where the images are displayed in place of the link
+path.
 
-You can customize the previews as described in [[*Adding Hyperlink
-preview]].  Link previews do not have to display images -- any kind of
-display decoration (see [[info:elisp#Overlay Properties]]) can be
-used.
+You can customize the previews as described in the [[*Adding Hyperlink
+preview]] section.  Link previews do not have to display images -- any
+kind of [[info:elisp#Overlay Properties][display decoration]] can be used.
 
 You can preview the supported link types in the whole buffer, in the
 current section, active region or at point with the following commands: 
@@ -11802,12 +11801,11 @@ ** Images and link previews
 
   #+kindex: C-c C-x C-v
   #+findex: org-link-preview
-  Create inline previews for external links in the active region, if
-  any; the link at point, if there is such; or in the current section
-  otherwise.  With a prefix argument, clear link previews at point or
-  in the current entry.  With a double prefix argument, preview all
-  links in the buffer.  With triple prefix argument, hide previews for
-  all links in the buffer.
+  Create inline previews for external links in the active region, the
+  link at point or in the current section.  With a prefix argument,
+  clear link previews at point or in the current entry.  With a double
+  prefix argument, preview all links in the buffer.  With triple
+  prefix argument, hide previews for all links in the buffer.
 
   By default, only links without descriptions are previewed.  You
   can force displaying previews for all supported links (including
@@ -11830,14 +11828,14 @@ ** Images and link previews
   Assure inline display of external link previews in the whole buffer
   and refresh them.
 
-- {{{kbd(M-x org-link-preview-region)}}} ::
+- (~org-link-preview-region~) ::
 
   #+findex: org-link-preview-region
   Create inline previews for external links in the active region, or
   the buffer.  With a prefix argument, also preview links with a text
   description part.
 
-- {{{kbd(M-x org-link-preview-clear)}}} ::
+- (~org-link-preview-clear~) ::
 
   #+findex: org-link-preview-clear
   Clear external link previews in the active region, or the buffer.
@@ -11873,7 +11871,7 @@ *** Images
 [[./img/a.jpg]]
 #+end_example
 
-When link previews are displayed as images, the image size and
+When [[*Images and link previews][link previews]] are displayed as images, the image size and
 alignment can be further customized.
 
 #+vindex: org-image-actual-width

[-- Attachment #3: Type: text/plain, Size: 225 bytes --]



-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>