From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.bugs Subject: bug#73425: 31.0.50; Support images in HTML versions of ELPA package manuals Date: Sun, 22 Sep 2024 18:03:26 +0000 Message-ID: <87h6a78t1t.fsf@posteo.net> References: <86v7ynh9au.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38614"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 73425@debbugs.gnu.org, Eshel Yaron To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 22 20:04:02 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ssQwE-0009mG-Aa for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 Sep 2024 20:04:02 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ssQvx-0007NE-Pt; Sun, 22 Sep 2024 14:03:46 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ssQvs-0007Mn-KV for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:03:42 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ssQvs-0001bF-BN for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:03:40 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:References:In-Reply-To:From:To:Subject; bh=0KXIUPTbf4FIrU7zLyPxi/zhhMO/ux1vkc0icXn5/fc=; b=NrDk5xTUNerLrTpqY98+hVL3NmX8WLGXoii1AxRt5JXWw04Ke/pKpGAYwz3TTnvaZruhu1+/1R/3HbZ8/Ax5hQh+JfO2Uz6lB0RuxxfEikSQi0W6swoYz/FUlWovCtg8pnZ6gMHNDzdjRIkxQLLVaeYZ4qySRoVqeQG2ADHFDb4PWi+PNekHiVnN0sNbCwaBNS0u/utomxobgeKEpCll0nx/C15269iPOHS/oEV7NzF3r8MM5XP2JHTaSJyK1avcHlHWBQHQmL4Ehav5fprlQU59E93+xWRSz5HBlJaxwNLCUiToeOiuOQDNSgJUWxLKTPoZEVc4IxrWhSrDDfEpoQ==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ssQwE-00018P-5A for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:04:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Philip Kaludercic Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 22 Sep 2024 18:04:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 73425 X-GNU-PR-Package: emacs Original-Received: via spool by 73425-submit@debbugs.gnu.org id=B73425.17270282404353 (code B ref 73425); Sun, 22 Sep 2024 18:04:02 +0000 Original-Received: (at 73425) by debbugs.gnu.org; 22 Sep 2024 18:04:00 +0000 Original-Received: from localhost ([127.0.0.1]:42723 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ssQwB-000188-Nu for submit@debbugs.gnu.org; Sun, 22 Sep 2024 14:04:00 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]:38461) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ssQw8-00017r-ET for 73425@debbugs.gnu.org; Sun, 22 Sep 2024 14:03:57 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 31B52240028 for <73425@debbugs.gnu.org>; Sun, 22 Sep 2024 20:03:27 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1727028208; bh=C8BnFhsj0b+ZldmwpsFWSNTvQllknSOdrLFjG7fSVQo=; h=From:To:Cc:Subject:Autocrypt:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=DtdS/rBAQZkwqwAIGmkw0Lh+cZn5k5tNNwjex/aumL2cqmycS3D9ZOOFrgg4LOsbX YqbEncUDR1u2SyDBtacK8QNS6qp5EhirN0LJUzbqcXw7syNmkF134lLFyHfN8E0N/9 NUGpK/q24gw7iv6lagg4Eyl1rP8M6OJiwUMeLScROno2SV0wknN3vKAKoPtsieai+S e/aPLJwkGRSRQDWgxHhpBxFSIW8Tpp3YPmd1LKiVJZ5kR4ld9yIDjtiBzNiXw7hCh8 QqiKPRQpFg6idEPz9cOM8q7pZcWswTsv5IZcWUgMl9hVijVMIetUxKdLkh0CTVWViu n0PRG5BmgwIlQ== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4XBYrv1CvXz6ty5; Sun, 22 Sep 2024 20:03:26 +0200 (CEST) In-Reply-To: <86v7ynh9au.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 22 Sep 2024 20:45:13 +0300") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM OpenPGP: id=7126E1DE2F0CE35C770BED01F2C3CC513DB89F66; url="https://keys.openpgp.org/vks/v1/by-fingerprint/7126E1DE2F0CE35C770BED01F2C3CC513DB89F66"; preference=signencrypt X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:292245 Archived-At: Eli Zaretskii writes: >> Cc: Philip Kaludercic >> Date: Sun, 22 Sep 2024 18:06:16 +0200 >> From: Eshel Yaron via "Bug reports for GNU Emacs, >> the Swiss army knife of text editors" >> >> 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. > > Why "no way"? If the image files are present at their filenames as > mentioned by the HTML version of the documentation, they will be shown > by the browser. The issue is that when generating the HTML documentation for elpa.gnu.org, we don't copy out any files, but just generate the HTML version of the manual. 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). >> 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. Unrelated to this issue, have you considered rendering screenshots as SVG files using `x-export-frames'? 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. > > To show images, your HTML version of the manual should reference local > files, not URLs from your some other server. And, of course, the > image files should be part of the package tarball. > >> - 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. > > I don't understand why this would be needed. Simply include the image > files with the package, and the rest should "just work", AFAIU. 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. [0] https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data >> - Provide a IMAGE_LINK_PREFIX value (e.g. pointing to my web server) >> that the ELPA server will use while building the HTML manual. > > That's definitely not TRT: ELPA packages should be self-contained as > far as their documentation is concerned. > >> - Override the creation of the HTML manual entirely, and have the ELPA >> server redirect or link to the version hosted on my web server. > > Likewise: there should be no dependency on any server. I agree. > Apologies if I misunderstood the problem. -- Philip Kaludercic on siskin