GNU bug report logs - #73425
31.0.50; Support images in HTML versions of ELPA package manuals

Previous Next

Package: emacs;

Reported by: Eshel Yaron <me <at> eshelyaron.com>

Date: Sun, 22 Sep 2024 16:07:01 UTC

Severity: wishlist

Found in version 31.0.50

Full log


View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: 73425 <at> debbugs.gnu.org, me <at> eshelyaron.com
Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals
Date: Sun, 22 Sep 2024 22:05:51 +0300
> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: me <at> eshelyaron.com,  73425 <at> debbugs.gnu.org
> Date: Sun, 22 Sep 2024 18:23:38 +0000
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> What we need is some kind of an indication in the package specification,
> >> what files should be copied out for the manual to access, as otherwise
> >> the images would only be hidden in the package tarball, that a web
> >> browser cannot access (AFAIK).
> >
> > "Copied" where and why?  Aren't the HTML docs generated in the
> > package's tree, like the Info docs?
> 
> No, these are the files we generate for a package under
> https://elpa.gnu.org/packages:
> 
>   -rw-r--r--  1 phi phi 368640 Mar 22  2024 compat-29.1.4.5.tar
>   -rw-r--r--  1 phi phi  11183 Mar 22  2024 compat.html
>   -rw-r--r--  1 phi phi    997 Mar 22  2024 compat-readme.txt
>   -rw-r--r--  1 phi phi   1230 Mar 22  2024 compat.svg
>   lrwxrwxrwx  1 phi phi     19 Mar 22  2024 compat.tar -> compat-29.1.4.5.tar
>   -rw-r--r--  1 phi phi   1016 Mar 22  2024 compat.xml

Then the image files should be in the same directory (or in its
images/ subdirectory, but that would need to be coordinated with the
package developers).

How do we generate these HTML files from the Texinfo sources?

> plus the manual under https://elpa.gnu.org/packages/doc/[package name]

So we have the HTML docs in two places?  Why two?  And why do I see
both https://elpa.gnu.org/packages/doc/compat.html and
https://elpa.gnu.org/packages/doc/compat/compat.html?

In any case, what I propose is to have the image files right near the
HTML files which reference them.

> >> Do you know if TeXinfo has an option to inline images?  If the
> >> "makeinfo" command could somehow generate data: urls when exporting
> >> images, then this could be very easily solved.
> >
> > This is already supported, for a long time, both in Info and HTML
> > formats (and in other formats as well; see the node "Image Syntax" in
> > the Texinfo manual.
> 
> I did take a look at that node, but I couldn't find anything that would
> help me.

??? What are you looking for that is not there?




This bug report was last modified 109 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.