Text::...up::Pod(3pm)

💖 Text::Markup::Pod — the manual, but make it cute 💖

okay bestie, so this is the Perl doc page for Text::Markup::Pod, which lives in the User Contributed Perl Documentation corner of the internet. She's a Pod parser for Text::Markup and honestly? she's serving. Let's get into it. 🎀

---

✨ NAME ✨

Text::Markup::Pod — literally just: a Pod parser for Text::Markup. short, sweet, iconic, no notes. 💅

---

🌸 SYNOPSIS 🌸

here's the whole vibe in two lines, no cap:

use Text::Markup;
my $pod = Text::Markup->new->parse(file => 'README.pod');

that's it. that's the girl. 🦋

---

🧚 DESCRIPTION 🧚

so. this module is the Pod parser for Text::Markup. what she does is run your file through Pod::Simple::XHTML and hand you back the result. that's the whole job, and she does it flawlessly, periodt. 👑

⚠️ important bestie, don't skip this: if your Pod has any non-ASCII characters, the encoding must be declared — either via a BOM or via the =encoding tag. no declaration, no deal. the vibes will not save you here. 😭

🍓 which files she claims as hers

Text::Markup::Pod recognizes files with these extensions as Pod:

• .pod
• .pm
• .pl

💜 wanna change that? say less

to change the files she recognizes, load this module directly and pass a regular expression matching the extension(s) you want, like so:

use Text::Markup::Pod qr{cgi};

look at her being flexible. main character energy fr fr. ✨

---

🎀 OPTIONS 🎀

you can pass an arrayref of settings to this parser and it changes the output she gives you back. for example, to suppress an HTML header and footer, pass:

my $pod_fragment = Text::Markup->new->parse(
        file => 'README.pod',
        options => [
            html_header => '',
            html_footer => '',
        ]
);

how does it work under the hood, you ask? this implementation makes method calls to the Pod::Simple::XHTML parser using the key as the method name and the value as the parameter list to pass. so yeah, whatever key/value you drop in there goes straight through. 🫶

and if you want the full list of options plus the inherited options you can manipulate:

See Pod::Simple::XHTML and Pod::Simple for the full list of options and inherited options which can be manipulated. 👀

go read those, bestie, there's a lot of slay in there. 📚

---

🌈 AUTHOR 🌈

David E. Wheeler <david@justatheory.com>

(shoutout to the author, we love a legend 👑)

---

💖 COPYRIGHT AND LICENSE 💖

Copyright (c) 2011-2025 David E. Wheeler. Some Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

translation: she's free software, remix her, share her, just keep the same terms as Perl itself. open source queen. 🦋

---

and that's the whole page!! tysm for reading, hope this helped, ilysm 🥰

signing off from perl v5.40.1, dated 2025-12-18, on the Text::Markup::Pod(3pm) page — mwah 💋✨