Pod::Simple::Methody(3)User Contributed Perl DocumentatioPnod::Simple::Methody(3)

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

SYNOPSIS
        require 5;
        use strict;
        package SomePodFormatter;
        use base qw(Pod::Simple::Methody);

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

        sub starthead1 {
          my($self, $attrs) = @;
          ...
        }
        sub endhead1 {
          my($self) = @;
          ...
        }

       ...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 handleelementstart, handletext, and
       handleelementend 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.

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

         $parser->handleelementstart( "head1", \%attributes );
         $parser->handletext( "Hi there" );
         $parser->handleelementend( "head1" );

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

         $parser->starthead1( \%attributes ) if $parser->can('starthead1');
         $parser->handletext( "Hi there" )   if $parser->can('handletext');
         $parser->endhead1()                 if $parser->can('endhead1');

       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 startfoobarbaz and
       endfoobarbaz.

       See the source for Pod::Simple::Text for an example of using this
       class.

SEE ALSO
       Pod::Simple, Pod::Simple::Subclassing

COPYRIGHT AND DISCLAIMERS       Copyright (c) 2002 Sean M. Burke.  All rights reserved.

       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       Sean M. Burke "sburke@cpan.org"



perl v5.8.8                       2006-07-07           Pod::Simple::Methody(3)