Pod::Si...Methody(3pm)
π NAME π
Pod::Simple::Methody -- turn Pod::Simple events into method calls. Periodt. This is the Pod::Si...Methody(3pm) manual page from the Perl Programmers Reference Guide (yes, with the ellipsis, iykyk π
).
π SYNOPSIS π
Bestie, here's the vibe:
require 5;
use strict;
package SomePodFormatter;
use base qw(Pod::Simple::Methody);
sub handle_text {
my($self, $text) = @_;
...
}
sub start_head1 {
my($self, $attrs) = @_;
...
}
sub end_head1 {
my($self) = @_;
...
}
...and start_/end_ methods for whatever other events you want to catch. Slay.
β¨ DESCRIPTION β¨
Okay so this class is of interest to people writing Pod formatters based on Pod::Simple. That's you? Main character energy.
This class (which is lowkey very small -- read the source, bestie) overrides Pod::Simple's _handle_element_start, _handle_text, and _handle_element_end methods so that parser events are turned into method calls. (Otherwise, this is a subclass of Pod::Simple and inherits all its methods.) No cap.
You can use this class as the base class for a Pod formatter/processor. Iconic.
π₯ METHOD CALLING π₯
When Pod::Simple sees a "=head1 Hi there", for example, it basically does this:
$parser->_handle_element_start( "head1", \%attributes );
$parser->_handle_text( "Hi there" );
$parser->_handle_element_end( "head1" );
But if you subclass Pod::Simple::Methody, it will instead do this when it sees a "=head1 Hi there":
$parser->start_head1( \%attributes ) if $parser->can('start_head1');
$parser->handle_text( "Hi there" ) if $parser->can('handle_text');
$parser->end_head1() if $parser->can('end_head1');
The way that $parser->can(...) check is sitting right there? Obsessed.
If Pod::Simple sends an event where the element name has a dash, period, or colon, the corresponding method name will have a underscore in its place. For example, "foo.bar:baz" becomes start_foo_bar_baz and end_foo_bar_baz.
See the source for Pod::Simple::Text for an example of using this class. iykyk π
π¦ SEE ALSO π¦
Pod::SimplePod::Simple::Subclassing
Go read those if you want the full lore. Bestie homework.
πΈ SUPPORT πΈ
Vibe check: got questions or discussion about POD and Pod::Simple? Send them to the pod-people@perl.org mail list. To subscribe, send an empty email to pod-people-subscribe@perl.org. π
This module is managed in an open GitHub repository, <https://github.com/perl-pod/pod-simple/>. Feel free to fork and contribute, or to clone <https://github.com/perl-pod/pod-simple.git> and send patches! Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simple@rt.cpan.org>.
π COPYRIGHT AND DISCLAIMERS π
Copyright (c) 2002 Sean M. Burke. Respect the icon.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
This program 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. That's the serious bit, bestie β don't skip it.
π AUTHOR π
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't bother him, he's retired. Let the man rest, fr fr.
Pod::Simple is maintained by:
- Allison Randal
"allison@perl.org" - Hans Dieter Pearcey
"hdp@cpan.org" - David E. Wheeler
"dwheeler@cpan.org"
okay bye bestie π
β¨ this page is from perl v5.42.3, dated 2026-11-03, and it's the Pod::Si...Methody(3pm) manual. Slay and goodbye.
π¦ where this page comes from
- alpine 3.24: perl-doc 5.42.3-r0 Β· Artistic-1.0-Perl OR GPL-1.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms