Uppercase of "HTML" in =begin format conflicts with Pod::Markdown

mvgrimes commented 8 years ago

It looks like ::Badges::Utils purposely uppercases the format if it is "html" but not if it is "markdown".

I'm guessing there was a reason for this, but it causes issues with Pod::Markdown (and its pod2markdown script). Pod::Markdown will pass through a =begin html block, but doesn't render =begin HTML blocks. While this might be viewed as a bug in Pod::Markdown, it seems like lowercase formats are more common. For example, in perlpod:

    Some format names that formatters currently are known to accept
    include "roff", "man", "latex", "tex", "text", and "html". (Some
    formatters will treat some of these as synonyms.)

Would you be open to using lc $format->{name} for all formats? How about passing the format through unchanged?

Thanks!

Csson commented 8 years ago

Hi,

I think the issue was that github renders both 'html' and 'markdown' blocks and I wanted to avoid that.

Now that I think about it a smarter solution would simply be to recommend to not use the markdown and html renderers simultaneously, and as you suggest remove that line.

Csson commented 8 years ago

I've just released 0.0401 with the following changes:

No munging of format case (they are all currently lower-cased though).
A new skip_markdown_if_html attribute determines if markdown should be created if html is also in formats. Defaults to true (don't create markdown).

Csson / p5-Pod-Weaver-Section-Badges

Uppercase of "HTML" in =begin format conflicts with Pod::Markdown #4