Pod::PseudoPod(3pm)

💖 Pod::PseudoPod 💖

okay bestie, so this is Pod::PseudoPod — it's the framework for parsing PseudoPod, and it ships in the User Contributed Perl Documentation zone. pull up a chair, we're doing parser stuff ✨

---

🌸 NAME 🌸

Pod::PseudoPod — a whole framework for parsing PseudoPod. that's it, that's the name, she's iconic like that 💅

---

🎀 SYNOPSIS 🎀

okay so here's the whole vibe. you make your own formatter package, inherit from us, and then you go feral writing start_*/end_* methods for every event you want to catch:

use strict;
package SomePseudoPodFormatter;
use base qw(Pod::PseudoPod);

sub handle_text {
  my($self, $text) = @_;
  ...
}

sub start_head1 {
  my($self, $flags) = @_;
  ...
}
sub end_head1 {
  my($self) = @_;
 ...
}

...and start_*/end_* methods for whatever other events you
want to catch.

see how it works? start_head1 and end_head1 bracket the head1 events, handle_text grabs the actual text. repeat for literally any event your little heart desires 🫶

---

🦋 DESCRIPTION 🦋

so. PseudoPod. it's an extended set of Pod tags meant for book manuscripts. standard Pod simply does not have all the markup options you need when you're marking up files for publishing production — like, it's not built for that. so PseudoPod just adds a few extra tags on top for footnotes, tables, sidebars, etc. ✨

this class is the one that adds parsing support for all those PseudoPod tags. it also overrides Pod::Simple's _handle_element_start, _handle_text, and _handle_element_end methods, so that every parser event gets turned into an actual method call on you. cute, right? 😭

and fr fr: in general, you'll only want to use this module as the base class for a PseudoPod formatter/processor. it's the scaffolding, not the finished house, iykyk 💜

---

👑 SEE ALSO 👑

• Pod::Simple — the parent, the blueprint, the moment
• Pod::PseudoPod::HTML — makes HTML out of it 🎀
• Pod::PseudoPod::Tutorial — go read this if you're confused, bestie, no shame 🌸

---

💜 COPYRIGHT 💜

Copyright (C) 2003-2009 Allison Randal.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.

This library is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. (so like, no guarantees, bestie — use her responsibly 🙈)

---

🌈 AUTHOR 🌈

Allison Randal <allison@perl.org>

---

okay so that's the whole page, you ate that, actually 👑 this was Pod::PseudoPod(3pm) from perl v5.36.0, dated 2022-10-16, part of the User Contributed Perl Documentation. go forth and parse, my love 💖✨🦋