Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How should =pod name be rendered? #2457

Open
finanalyst opened this issue Nov 9, 2018 · 1 comment
Open

How should =pod name be rendered? #2457

finanalyst opened this issue Nov 9, 2018 · 1 comment
Labels
NOTSPECCED need roast tests before documenting
Milestone

Comments

@finanalyst
Copy link
Collaborator

finanalyst commented Nov 9, 2018

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.

@JJ
Copy link
Contributor

JJ commented Nov 9, 2018

I really have no idea. What's your take, @tbrowder ?

@JJ JJ added the NOTSPECCED need roast tests before documenting label Nov 9, 2018
@coke coke added this to the backlog milestone Mar 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NOTSPECCED need roast tests before documenting
Projects
None yet
Development

No branches or pull requests

3 participants