Ihor Radchenko <yanta...@posteo.net> writes:
> Karthik Chikmagalur <karthikchikmaga...@gmail.com> writes:
>
>>> See the attached further adjustments to the manual.
>>
>> Ihor, many of the adjustments you made are how it was previously
>> written -- links with descriptions are exported awkwardly to LaTeX in
>> the document you sent me. I changed links with descriptions to links without
>> descriptions and added a "(see [[foo]])" comment, but in your patch
>> you've changed them back.
>
> Oops. My patch happens to be exactly the opposite of my changes. (I
> chose wrong direction of the diff range)
Here is the correct diff.
>From ef65b9f4c2e46216f862169ecaee0d9cea09e290 Mon Sep 17 00:00:00 2001
Message-ID: <ef65b9f4c2e46216f862169ecaee0d9cea09e290.1732643142.git.yanta...@posteo.net>
From: Ihor Radchenko <yanta...@posteo.net>
Date: Tue, 26 Nov 2024 18:45:32 +0100
Subject: [PATCH] Adjustments to the manual
---
doc/org-manual.org | 43 +++++++++++++++++++++++--------------------
1 file changed, 23 insertions(+), 20 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 3a4840d56f..95846b4758 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11780,18 +11780,20 @@ ** 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][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.
+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.
-You can customize the previews as described in the [[*Adding Hyperlink
-preview]] section. Link previews do not have to display images -- any
-overlay property (see [[info:elisp#Overlay Properties]]) can be used.
+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 preview the supported link types in the whole buffer, in the
current section, active region or at point with the following commands:
@@ -11800,11 +11802,12 @@ ** 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, 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.
+ 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.
By default, only links without descriptions are previewed. You
can force displaying previews for all supported links (including
@@ -11827,14 +11830,14 @@ ** Images and link previews
Assure inline display of external link previews in the whole buffer
and refresh them.
-- (~org-link-preview-region~) ::
+- {{{kbd(M-x 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.
-- (~org-link-preview-clear~) ::
+- {{{kbd(M-x org-link-preview-clear)}}} ::
#+findex: org-link-preview-clear
Clear external link previews in the active region, or the buffer.
@@ -11870,8 +11873,8 @@ *** Images
[[./img/a.jpg]]
#+end_example
-When [[*Images and link previews][link previews]] are displayed as
-images, the image size and alignment can be further customized.
+When link previews are displayed as images, the image size and
+alignment can be further customized.
#+vindex: org-image-actual-width
#+vindex: org-image-max-width
@@ -21911,7 +21914,7 @@ ** Adding Hyperlink preview
In our example, we use the =convert= program (part of the
=imagemagick= suite of tools) to create the thumbnail that is
displayed inline.
-
+
#+begin_src emacs-lisp
(defun org-link-docview-preview (ov path _elem)
"Preview file at PATH in overlay OV.
@@ -21938,7 +21941,7 @@ ** Adding Hyperlink preview
3. Now previews of docview links for supported document types (PDF,
djvu) are generated (along with image file previews) when calling
~org-link-preview~.
-
+
** Adding Export Backends
:PROPERTIES:
:DESCRIPTION: How to write new export backends.
--
2.47.0
--
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>
