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

Re: Pre-RFC: tables in Pod

Thread Previous | Thread Next
From:
Yuki Kimoto
Date:
June 29, 2022 06:39
Subject:
Re: Pre-RFC: tables in Pod
Message ID:
CAExogxM8sxsR0wRQ0S4SO37Ra3Mv-Lb6H-=EewxvghtxYUTR6w@mail.gmail.com
2021-11-16 10:42 Tomasz Konojacki <me@xenu.pl> wrote:

> Tables are one of the most frequently requested features for Pod.
>
> There's some prior art in PseudoPod[1] and Pod6[2], but I dislike them
> both. PseudoPod's table syntax is way too verbose, while Pod6 is too
> complicated and whitespace sensitive.
>
> I came up the following syntax:
>
> =begin table
>
> table specification
>
> =end table
>
> The table specification syntax is based on GitHub Markdown with some
> extensions (most notably rowspan and colspan). Please read its
> documentation first:
>
>
> https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
>
> Using Pod formatting codes (e.g. B<foo>) is allowed inside tables.
>
> Since this is just an elevator pitch, instead of writing a full
> specification, I will just show a few examples:
>
> ------------------------------------------------------------------------
>
> Basic table. Leading and terminating pipes are optional.
>
> Input:
>
> | foo | bar | baz |
> | oof | rab | zab |
>
> Output:
>
> +-----------------+
> | foo | bar | baz |
> +-----------------+
> | oof | rab | zab |
> +------------------
>
> ------------------------------------------------------------------------
>
> Table with headers. The "header2" column is right-aligned. In GitHub
> headers are required, in this specification they will be optional (as
> you've seen in the previous example).
>
> Input:
>
> | header1 | header2 | header3 |
> | ---     | ---:    | ---     |
> | abc     | def     | ghi     |
>
> Output (it's hard to show in plain text, but the first row will be
> rendered as <thead> in HTML):
>
> +-----------------------------+
> | header1 | header2 | header3 |
> +-----------------------------+
> | abc     |     def | ghi     |
> +-----------------------------+
>
> ------------------------------------------------------------------------
>
> "-" merges with the previous cell horizontally (cellspan); "^",
> vertically (rowspan). They can be escaped with E<> or a backslash.
> GitHub Markdown doesn't have this feature.
>
> Input:
>
> | foo | -   | baz |
> | ^   | -   | zab |
>
> Output:
>
> +-----------------+
> | foo       | baz |
> +           +-----+
> |           | zab |
> +------------------
>
> ------------------------------------------------------------------------
>
> [1] -
> https://metacpan.org/dist/Pod-PseudoPod/view/lib/Pod/PseudoPod/Tutorial.pod#Tables
> [2] - https://docs.raku.org/language/tables


I'm interested in tables in POD because I use tables in POD in SPVM
documentation.

What I only need is the expression of <th> tag in any position.

  =begin table

    |H<head>|H<head>|
    |item|item|
    |item|item|

  =end table

  =begin table

    |H<head>|item|
    |H<head>|item|
    |H<head>|item|

  =end table

I also hope the feature of tables in POD is implemented.

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