From: Philip Kaludercic <philipk@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 73425@debbugs.gnu.org, me@eshelyaron.com,
Stefan Monnier <monnier@iro.umontreal.ca>
Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals
Date: Mon, 23 Sep 2024 10:48:41 +0000 [thread overview]
Message-ID: <87ldzifxx2.fsf@posteo.net> (raw)
In-Reply-To: <86ikunh5kg.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 22 Sep 2024 22:05:51 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Philip Kaludercic <philipk@posteo.net>
>> Cc: me@eshelyaron.com, 73425@debbugs.gnu.org
>> Date: Sun, 22 Sep 2024 18:23:38 +0000
>>
>> Eli Zaretskii <eliz@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).
Right, and we can facilitate this by allowing package specifications to
annotate where images are found.
> How do we generate these HTML files from the Texinfo sources?
Basically by executing,
--8<---------------cut here---------------start------------->8---
makeinfo --no-split [input-name] -o [output-name] --html --css-ref=[css-url]
--8<---------------cut here---------------end--------------->8---
>> 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?
I am not sure, my suspicion is some kind of historical backwards
compatibility. I have CC'ed Stefan who might know more.
> In any case, what I propose is to have the image files right near the
> HTML files which reference them.
That would make sense.
>> >> 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?
Some kind of --embed flag, that would inline images. So instead of
generating
<img src="/path/to/image.png" />
makeinfo could produce
<img src="data:image/png;base64,iVBORw0KGgoAAAANS..."
--
Philip Kaludercic on siskin
next prev parent reply other threads:[~2024-09-23 10:48 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-22 16:06 bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-22 17:45 ` Eli Zaretskii
2024-09-22 18:03 ` Philip Kaludercic
2024-09-22 18:13 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-22 18:16 ` Philip Kaludercic
2024-09-22 18:43 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-22 18:15 ` Eli Zaretskii
2024-09-22 18:23 ` Philip Kaludercic
2024-09-22 19:05 ` Eli Zaretskii
2024-09-23 10:48 ` Philip Kaludercic [this message]
2024-09-23 12:03 ` Eli Zaretskii
2024-09-23 12:46 ` Philip Kaludercic
2024-09-23 14:19 ` Eli Zaretskii
2024-09-26 4:02 ` Stefan Kangas
2024-09-26 20:10 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-23 14:00 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ldzifxx2.fsf@posteo.net \
--to=philipk@posteo.net \
--cc=73425@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=me@eshelyaron.com \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).