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:16:44 +0000 Message-ID: <8734lr8sfn.fsf@posteo.net> References: <86v7ynh9au.fsf@gnu.org> <87h6a78t1t.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8888"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , 73425@debbugs.gnu.org To: Eshel Yaron Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 22 20:18:03 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 1ssR9m-00029Q-Ic for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 Sep 2024 20:18:02 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ssR9X-0001Zh-By; Sun, 22 Sep 2024 14:17:47 -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 1ssR9U-0001ZJ-3A for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:17:44 -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 1ssR9Q-0002pi-FN for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:17:41 -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=w6JdsOzOa7T7RbGQRIw4u37PrnPkMEGEFl6IbF5Sweg=; b=gTgMzvah09WMOXG1KLFjdtN0yBNpZCgk2s+JQJhMg0467B4u15KPoLDxKfXYOCJ6WjXSybXamHKdNVsKSt4OrsOAW1RGUw/Nz+R+k8W5mrIyuHerMoaHPONzSKWiOEVfeZPoxokmRFzfZziLHlHJUBLvGh7fukMUx6sZrqLK7PBBE5AfNrkWO6h/a/PSgsuptIR2QuWeV8DN3pbX5NQWID5j+M/aGQn1NOHbPVGASiWMUtJCgu9vCMUnv2YHF+hFyEWV8eWItQsKSF8PShOnKHmUsgNdYM7nIMYWu/LOHxExQtkiEzGPyhWbAzYjhoEYvsyISBmasmmn4xmxNQ17hg==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ssR9m-0001sy-AM for bug-gnu-emacs@gnu.org; Sun, 22 Sep 2024 14:18: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:18: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.17270290367181 (code B ref 73425); Sun, 22 Sep 2024 18:18:02 +0000 Original-Received: (at 73425) by debbugs.gnu.org; 22 Sep 2024 18:17:16 +0000 Original-Received: from localhost ([127.0.0.1]:42743 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ssR91-0001rl-Li for submit@debbugs.gnu.org; Sun, 22 Sep 2024 14:17:16 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]:54315) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ssR90-0001rY-2l for 73425@debbugs.gnu.org; Sun, 22 Sep 2024 14:17:14 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 827C4240101 for <73425@debbugs.gnu.org>; Sun, 22 Sep 2024 20:16:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1727029006; bh=CFECyzHQOQ9JrQqmvw0PhyRT0wamMgDm51EWGt9IEf8=; h=From:To:Cc:Subject:Autocrypt:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=HYV7OcIZ4JhkQn3fjdnc8/g/+U1X3lydCBOWpd79L0gsXmQNvup25fFS2idXRaVcd P6zrnIbxfi4x9FEy5BDww6I27NkM+e3JxmoReiy4930w7jNIkRBluoaNYjs+hn/2DI ytkJKpXD9Od8e7Mp9O09O1nkVGr8O58Hf5Tgl4/O99UkKKd4NoV2OHKZd2TS8CQFAt jlr/ioGJjhy5IpyKf0CJn4w8HJ7xXHNVjExzAN43UW1k2Vz7RutffDigtWt68oWe0b k5UO+2aBzAMtlM10wctbnL0Zd8EC/LP86l02/ItW6T6/+rWoUEdufbYUOde4qUB79S rk/OlQjbjuDtQ== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4XBZ8F2wQ8z9rxD; Sun, 22 Sep 2024 20:16:44 +0200 (CEST) In-Reply-To: (Eshel Yaron's message of "Sun, 22 Sep 2024 20:13:52 +0200") 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:292249 Archived-At: Eshel Yaron writes: > Philip Kaludercic writes: > >> 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). > > Yes. > >>>> 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'? > > I haven't, but I'll be sure to check it out. Thanks for the tip :) > >>>> 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. > > I'm not aware of such an option. BTW, which version of Texinfo does the > ELPA server run? --8<---------------cut here---------------start------------->8--- $ ssh elpa makeinfo --version texi2any (GNU texinfo) 6.8 Copyright (C) 2021 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. --8<---------------cut here---------------end--------------->8--- I.e. the version distributed by Debian stable. > > > Thanks, > > Eshel -- Philip Kaludercic on siskin