develooper Front page | perl.perl5.porters | Postings from November 2021

Re: Pre-RFC: tables in Pod

Thread Previous
From:
Dan Book
Date:
November 16, 2021 02:57
Subject:
Re: Pre-RFC: tables in Pod
Message ID:
CABMkAVVpU6_1rwsWQujNR6LHeK+Hy3iShRituSRGG1fntJZUvw@mail.gmail.com
On Mon, Nov 15, 2021 at 9:52 PM Tom Molesworth via perl5-porters <
perl5-porters@perl.org> wrote:

> On Tue, 16 Nov 2021 at 09:42, Tomasz Konojacki <me@xenu.pl> wrote:
>
>> Tables are one of the most frequently requested features for Pod.
>>
>
> +1 on having tables in POD in general.
>
> The following is an observation, rather than a negative vote:
>
> This proposal is inconsistent with the paragraph nature of POD - we end up
> with "rectangular POD", where paragraph formatting directives are embedded
> within visual sections of the markup rather than starting at the beginning
> of each line:
>
> | B<Header 1>                   | B<Header 2>
>         |
>
> |-------------------------------|-------------------------------------------------|
> |=over 4                        |
>         |
> |                               |
>         |
> |=item * C<$x> - is a variable  |=for html <img src="
> https://perl.org/logo.bmp">  |
> |                               |
>         |
> |=back                          |
>         |
>
> As such, I think it'll be a mess - for authors and toolchain
> implementations alike - and we'll end up  wishing we'd stuck with markdown.
>
> A paragraph-based table definition would be tedious to write and hard to
> visualise, but would be more in the spirit of the existing POD definition.
>

I don't understand what this example is meant to portray. Formatting codes
would be allowed in tables, but directives would and should not be -
directives must be at the start of a line and isn't logically coherent as
to what it is meant to render, within an HTML or text-art table.

The contents of a table as proposed would be a specific subformat, like a
verbatim block. It need not be subject to paragraph-based directives
itself, and as you note, that would be excessively verbose. I am +1 to the
general shape proposed.

-Dan

Thread Previous


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