unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Stefan Kangas <stefankangas@gmail.com>
Cc: Philip Kaludercic <philipk@posteo.net>,
	me@eshelyaron.com, Eli Zaretskii <eliz@gnu.org>,
	73425@debbugs.gnu.org
Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals
Date: Thu, 26 Sep 2024 16:10:53 -0400	[thread overview]
Message-ID: <jwvmsjuw5c8.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <CADwFkmknPrXs2TyodEzxR_dbicDeb31X7y1SVYDLKp8=i6xLMA@mail.gmail.com> (Stefan Kangas's message of "Wed, 25 Sep 2024 21:02:45 -0700")

>> Yes.  My suggestion is to allow listing additional non-.texi/.org files
>> under :doc that would be copied out to the web server.  So in Eshel's
>> case, we could update the specification to be
>>
>>  (kubed			:url "https://git.sr.ht/~eshel/kubed"
>>   :doc ("kubed.texi" "images/"))
>>
>> and the HTTP server could host all files under images/.
>
> That has a significant drawback: when package maintainers want to add a
> new image, they have to patch the (Non-)GNU ELPA package listing.

Agreed.

> It would be better to keep that information it in the package itself
> somehow, like we do with .elpaignore.  Or we could just copy all image
> files automatically.

I think we should provide a "generic" way to provide some of the
`elpa-packages` contents directly from the package's own files.
I was thinking of something like a

    ;; ELPA-spec: (:readme "README.md" :doc "clear.texi" ...)

there's a security implication, so we'd need to "sanitize" this info
before using it, but other than that it should not be too hard
to implement.

But to get back to the "real" problem of images: in order for manual
`foo` to be able to have (working) cross-links to manual `bar`, it's
important that they are both exposed as `.../doc/foo.html` and
`.../doc/bar.html`, so they can't both use an image with a relative
URL of `snapshot1.png`.


        Stefan






  reply	other threads:[~2024-09-26 20:10 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
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 [this message]
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=jwvmsjuw5c8.fsf-monnier+emacs@gnu.org \
    --to=bug-gnu-emacs@gnu.org \
    --cc=73425@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=me@eshelyaron.com \
    --cc=monnier@iro.umontreal.ca \
    --cc=philipk@posteo.net \
    --cc=stefankangas@gmail.com \
    /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).