From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Philip Kaludercic <philipk@posteo.net>
Cc: Eli Zaretskii <eliz@gnu.org>, me@eshelyaron.com, 73425@debbugs.gnu.org
Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals
Date: Mon, 23 Sep 2024 10:00:00 -0400 [thread overview]
Message-ID: <jwvmsjy4gt8.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <87ldzifxx2.fsf@posteo.net> (Philip Kaludercic's message of "Mon, 23 Sep 2024 10:48:41 +0000")
>> 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.
On disk, this is only one place: the `doc/compat.html` is a symlink to
`doc/compat/compat.html`. The only URL we want to expose is
the `doc/compat.html`, OTOH (which is why `doc/compat.html` is a symlink
rather than an HTTP redirect).
The reason is the following:
- We put all the generated files into the `doc/PKG/` subdir so we know
which files belong to which package when we need to "garbage collect"
old files when updating a package.
- We need to the URL to be `doc/compat.html` (i.e. include only the
manual name but not the package name) so that links from one
manual to the other work correctly regardless if the other manual
belongs to the same package or not.
Stefan
prev parent reply other threads:[~2024-09-23 14:00 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
2024-09-23 14:00 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwvmsjy4gt8.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 \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.