Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

Pod::Simple::Methody

Perl 5 version 26.0 documentation
Go to top • Download PDF
Show page index • Show recent pages
Recently read

Pod::Simple::Methody

NAME

Pod::Simple::Methody -- turn Pod::Simple events into method calls

SYNOPSIS

  1.  require 5;
  2.  use strict;
  3.  package SomePodFormatter;
  4.  use base qw(Pod::Simple::Methody);
  6.  sub handle_text {
  7.    my($self, $text) = @_;
  8.    ...
  9.  }
  11.  sub start_head1 {
  12.    my($self, $attrs) = @_;
  13.    ...
  14.  }
  15.  sub end_head1 {
  16.    my($self) = @_;
  17.    ...
  18.  }

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

DESCRIPTION

This class is of interest to people writing Pod formatters based on Pod::Simple.

This class (which is very small -- read the source) 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.)

You can use this class as the base class for a Pod formatter/processor.

METHOD CALLING

When Pod::Simple sees a "=head1 Hi there", for example, it basically does this:

  1.   $parser->_handle_element_start( "head1", \%attributes );
  2.   $parser->_handle_text( "Hi there" );
  3.   $parser->_handle_element_end( "head1" );

But if you subclass Pod::Simple::Methody, it will instead do this when it sees a "=head1 Hi there":

  1.   $parser->start_head1( \%attributes ) if $parser->can('start_head1');
  2.   $parser->handle_text( "Hi there" )   if $parser->can('handle_text');
  3.   $parser->end_head1()                 if $parser->can('end_head1');

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.

SEE ALSO

Pod::Simple, Pod::Simple::Subclassing

SUPPORT

Questions or discussion about POD and Pod::Simple should be sent to the pod-people@perl.org mail list. Send an empty email to pod-people-subscribe@perl.org to subscribe.

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 git://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.

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.

AUTHOR

Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't bother him, he's retired.

Pod::Simple is maintained by:

  • Allison Randal allison@perl.org
  • Hans Dieter Pearcey hdp@cpan.org
  • David E. Wheeler dwheeler@cpan.org
Page index