unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 73425@debbugs.gnu.org
Cc: Philip Kaludercic <philipk@posteo.net>
Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals
Date: Sun, 22 Sep 2024 18:06:16 +0200	[thread overview]
Message-ID: <m1msjzlll3.fsf@dazzs-mbp.home> (raw)


Hi,

I'm opening this feature request following a discussion with Philip
elsewhere: Texinfo manual can include images, but AFAIK (and please
correct me if I'm wrong here) there's currently no way for ELPA packages
to include images in their manuals and have these images appear also in
the HTML version of the manual that the ELPA server builds and serves.

An example is my GNU ELPA package Kubed.  In the development version,
the manual refers to images which are present on my web server, where I
provide HTML versions[1][2] of the manual.  There, the images are
displayed properly.  On the ELPA server[3], OTOH, the images are nowhere
to be found, and we instead get just the alt text and caption.  That's
expected, but the alt text is shown with no distinctive styling so the
result seems quite confusing.

Ideally, I would like a way to be able to do one of the following:

- Include images in the package repository, somehow indicate in the
  package specification that the manual refers to these images, and have
  the ELPA server keep the images around in a predictable location, so I
  can link to it from the manual.
- Provide a IMAGE_LINK_PREFIX value (e.g. pointing to my web server)
  that the ELPA server will use while building the HTML manual.
- Override the creation of the HTML manual entirely, and have the ELPA
  server redirect or link to the version hosted on my web server.


Thanks,

Eshel

[1] https://eshelyaron.com/kubed.html
[2] https://eshelyaron.com/man/kubed/
[3] https://elpa.gnu.org/devel/doc/kubed.html





             reply	other threads:[~2024-09-22 16:06 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-22 16:06 Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2024-09-22 17:45 ` bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals 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
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=m1msjzlll3.fsf@dazzs-mbp.home \
    --to=bug-gnu-emacs@gnu.org \
    --cc=73425@debbugs.gnu.org \
    --cc=me@eshelyaron.com \
    --cc=philipk@posteo.net \
    /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).