doc icon indicating copy to clipboard operation
doc copied to clipboard

How should =pod name be rendered?

Open finanalyst opened this issue 6 years ago • 3 comments

The problem

The two modules that generate HTML from POD, namely Pod::To::HTML and BigPage::To::HTML interpret the POD6 specification differently.

P2HTML renders

=begin foo 
=end foo

as

<section> <h1>foo</h1> </section>

P2BigPage renders the same POD as empty

P2HTML renders

=begin foo
stuff
=end foo

as:

<section> <h1> foo </h1><p>stuff</p></section>

This is clear from the tests in the P2HTML module.

P2BigPage renders this as

stuff

Suggestions

Clarify that the pattern =begin name ... =end name is rendered to <section name="name"> ... </section> without an explicit title.

The attribute 'name' has no meaning for the tag <section >, so the information from the pod file can be kept without needing to handle it.

finanalyst avatar Nov 09 '18 08:11 finanalyst