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

Re: reStructuredText WAS Re: Pre-RFC: markdown in pod

Thread Previous | Thread Next
Oodler 577 via perl5-porters
November 15, 2021 23:20
Re: reStructuredText WAS Re: Pre-RFC: markdown in pod
Message ID:
Just throwing this out there,

After my email the other day about hating "=head1 ALLCAPS", I
relaized that POD also has value as a pure text format.

I raise this because any "table" should also look like a table in
plain text. This gives means we can't *just* use something that's
already out there and nobody seems to be suggesting HTML. Docbook
(SGML, technically) does tables this way,

Latex does it this way,

Finally, it is important to note when we fully consider that
traditionally, POD has been concerned with flow in one direction.
Here we must think about it both. And this leads me to suggest that
if we're going to inline *anything* foreign, it might be wise to
consider *adapting* something we already have, see [1].


1. `perldoc perlform`

* Felipe Gasper <> [2021-11-15 17:31:37 -0500]:

> > On Nov 15, 2021, at 14:58, Nicholas Clark <> wrote:
> > 
> > And I guess there's also the elephant in the room - even CommonMark is no
> > good as-is, because *all* markdown permits you to inline HTML, which makes
> > sense for it. We need to specify "Markdown, but without inline HTML", else
> > how do we target perldoc?
> Another way to say this is: Markdown *targets* HTML, more or less by design. It doesn?t really intend to render to plain text?at least, a while back when I looked for a Markdown-to-text renderer I came up empty.
> A bit earlier in this thread I mentioned reStructuredText. From what I can see, this format is basically ?like Markdown but renders to text?. What if Perl went this route instead?
> -FG

SDF-EU Public Access UNIX System - #openmp #pdl #native

Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About