develooper Front page | perl.perl5.porters | Postings from June 2022

Re: Pre-RFC: images in Pod

Thread Previous | Thread Next
From:
Neil Bowers
Date:
June 9, 2022 22:25
Subject:
Re: Pre-RFC: images in Pod
Message ID:
f4a93eba-ee1e-42c2-b16a-4da1383bb635@Spark
Revisiting this after something of a gap … here’s the basic case:

	P<There can be only one|https://highlander.org/macleod.png>

Q1: how should this be rendered if an image can’t be displayed? Someone commented that styling should be left to formatters, but I think podspec should propose a standard rendering as text.

Q2: should we support non http URLs? For example a CPAN dist might want to bundle images for the doc (and have them turn up on MetaCPAN), and the Perl distribution might want to include images for diagrams: P<illustration of method resolution|images/mro.png>. That’s like to get hairy, so one option is to say that v1 just supports http URLs and worry about relative paths if there’s a call for it.

Seems sensible to allow optional dimensions with an additional parameter:

	P<There can be only one|https://highlander.org/macleod.png|640x480>

Q3: I often just put just a width on images, so it should probably allow that. I.e. P<alt text|https://foo.com/bar.png|320>. Should any other format of dimensions be supported?

Neil

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About