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

[Karthik Chikmagalur]

>> 2.  Org's LaTeX previews (both the existing and WIP versions) use a
>> different system.  They set two overlay properties: `category' set to
>> `org', and `org-overlay-type', set to `org-latex-preview'.  Should we
>> use a consistent set of properties to identify Org-related overlays?
>
> May you elaborate on why you went with category = 'org? category
> property has a special meaning in overlays.

I stand corrected -- the `category' is not being set either in the new
or old LaTeX preview code.  The only overlay property used for
identification is

    (overlay-put ov 'org-overlay-type 'org-latex-overlay)

in `org--make-preview-overlay'.  We have retained this behavior, we did
not add to or change it in the LaTeX preview rewrite patchset.

>> This is an implementation detail and none of it really matters, but I
>> can unify them if required.
>
> What I am certain about is that we do need to keep `org-image-overlay'
> property as it might be used by third-party code.
>
> We may add something extra to make things more consistent across Org
> mode, but `org-image-overlay' must be kept for backwards compatibility
> reasons.

Noted.

>> +Org mode can display previews of [[*Hyperlinks][hyperlinks]] inside Org 
>> buffers.  By
>
> I just started doing a final pass of the proofreading and figured that
> we should not use links to other parts of the manual or other manuals
> that have description. This is because texinfo formats them
> unexpectedly, as Section X.X [description], page YYY. May you please run
> make docs with your patch and look into the results org.pdf file?
>
> We need to make sure that things the new section is readable there.

make docs failed with the following output (also included as attachment
for completeness):

https://paste.karthinks.com/4ca52197-org-make-docs-errors.html

It seems unrelated to what we want to check.  Any ideas how to fix it?

Karthik

-*- mode: compilation; default-directory: 
"~/.local/share/git/elpaca/repos/org/" -*-
Compilation started at Wed Oct 30 12:41:09

make docs
======================================================
= Invoke "make help" for a synopsis of make targets. =
= Created a default local.mk template.               =
= Setting "oldorg" as the default target.            =
= Please adapt local.mk to your local setup!         =
======================================================
Loading /home/karthik/.local/share/git/elpaca/repos/org/lisp/org-compat.el 
(source)...
Loading /home/karthik/.local/share/git/elpaca/repos/org/mk/org-fixup.el 
(source)...
make -C doc info
make[1]: Entering directory 
'/home/karthik/.local/share/git/elpaca/repos/org/doc'
org-version: 9.8-pre (release_9.7.12-377-g806f01)
makeinfo --no-split org.texi -o org.info
org.texi:16204: warning: @anchor should not appear on @item line
org.texi:16217: warning: @anchor should not appear on @item line
emacs  -Q -batch --eval '(setq vc-handled-backends nil org-startup-folded nil 
org-element-cache-persistent nil)'                                      \
  --eval '(add-to-list `load-path "../lisp")' \
  --eval '(load "../mk/org-fixup.el")'        \
  --eval '(setq gc-cons-threshold (* 50 1000 1000))' \
  --eval '(org-make-guide)'
Loading /home/karthik/.local/share/git/elpaca/repos/org/mk/org-fixup.el 
(source)...
makeinfo --no-split orgguide.texi -o orgguide.info
orgguide.texi:1431: warning: @node name should not contain `,': Capture, 
Refile, Archive
make[1]: Leaving directory '/home/karthik/.local/share/git/elpaca/repos/org/doc'
make -C doc html
make[1]: Entering directory 
'/home/karthik/.local/share/git/elpaca/repos/org/doc'
makeinfo --html --number-sections --css-ref 
"https://www.gnu.org/software/emacs/manual.css"; --no-split -o org.html org.texi
org.texi:16204: warning: @anchor should not appear on @item line
org.texi:16217: warning: @anchor should not appear on @item line
makeinfo --html --number-sections --css-ref 
"https://www.gnu.org/software/emacs/manual.css"; --no-split -o orgguide.html 
orgguide.texi
make[1]: Leaving directory '/home/karthik/.local/share/git/elpaca/repos/org/doc'
make -C doc pdf
make[1]: Entering directory 
'/home/karthik/.local/share/git/elpaca/repos/org/doc'
texi2pdf --batch --clean --expand org.texi
org.texi:16204: warning: @anchor should not appear on @item line
org.texi:16217: warning: @anchor should not appear on @item line
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/nixos.org) 
(preloaded format=pdftex)
 restricted \write18 enabled.
entering extended mode
(../../../org.t2d/pdf/src/org.texi
(/home/karthik/.local/share/git/elpaca/repos/org/doc/texinfo.tex
Loading texinfo [version 2013-09-11.11]: pdf, fonts, markup, glyphs,
page headings, tables, conditionals, indexing, sectioning, toc, environments,
defuns, macros, cross references, insertions, localization, formatting,
and turning on texinfo input format.)
Runaway argument?
{en_\finish }\else \globaldefs = 1 \input txi-en.tex \fi \closein 1 \endgroup \
ETC.
../../../org.t2d/pdf/src/org.texi:14: Paragraph ended before \documentlanguaget
rywithoutunderscore was complete.
<to be read again> 
                   \par 
l.14 
     
? 
../../../org.t2d/pdf/src/org.texi:14: Emergency stop.
<to be read again> 
                   \par 
l.14 
     
../../../org.t2d/pdf/src/org.texi:14:  ==> Fatal error occurred, no output PDF 
file produced!
Transcript written on org.log.
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/nixos.org) 
(preloaded format=pdftex)
 restricted \write18 enabled.
entering extended mode
(../../../org.t2d/pdf/src/org.texi
(/home/karthik/.local/share/git/elpaca/repos/org/doc/texinfo.tex
Loading texinfo [version 2013-09-11.11]: pdf, fonts, markup, glyphs,
page headings, tables, conditionals, indexing, sectioning, toc, environments,
defuns, macros, cross references, insertions, localization, formatting,
and turning on texinfo input format.) (./org.aux)
Runaway argument?
{en_\finish }\else \globaldefs = 1 \input txi-en.tex \fi \closein 1 \endgroup \
ETC.
../../../org.t2d/pdf/src/org.texi:14: Paragraph ended before \documentlanguaget
rywithoutunderscore was complete.
<to be read again> 
                   \par 
l.14 
     
? 
../../../org.t2d/pdf/src/org.texi:14: Emergency stop.
<to be read again> 
                   \par 
l.14 
     
../../../org.t2d/pdf/src/org.texi:14:  ==> Fatal error occurred, no output PDF 
file produced!
Transcript written on org.log.
/run/current-system/sw/bin/texi2dvi: pdftex exited with bad status, quitting.
make[1]: *** [Makefile:92: org.pdf] Error 1
make[1]: Leaving directory '/home/karthik/.local/share/git/elpaca/repos/org/doc'
make: *** [mk/targets.mk:122: pdf] Error 2

Compilation exited abnormally with code 2 at Wed Oct 30 12:41:21