local-lib5/man/man3/Pod::Simple::Methody.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Pod::Simple::Methody 3"
 132 .TH Pod::Simple::Methody 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Pod::Simple::Methody \-\- turn Pod::Simple events into method calls
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 4
 138 \& require 5;
 139 \& use strict;
 140 \& package SomePodFormatter;
 141 \& use base qw(Pod::Simple::Methody);
 142 .Ve
 143 .PP
 144 .Vb 4
 145 \& sub handle_text {
 146 \&   my($self, $text) = @_;
 147 \&   ...
 148 \& }
 149 .Ve
 150 .PP
 151 .Vb 8
 152 \& sub start_head1 {
 153 \&   my($self, $attrs) = @_;
 154 \&   ...
 155 \& }
 156 \& sub end_head1 {
 157 \&   my($self) = @_;
 158 \&   ...
 159 \& }
 160 .Ve
 161 .PP
 162 \&...and start_/end_ methods for whatever other events you want to catch.
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 This class is of
 166 interest to people writing Pod formatters based on Pod::Simple.
 167 .PP
 168 This class (which is very small \*(-- read the source) overrides
 169 Pod::Simple's _handle_element_start, _handle_text, and
 170 _handle_element_end methods so that parser events are turned into method
 171 calls. (Otherwise, this is a subclass of Pod::Simple and inherits all
 172 its methods.)
 173 .PP
 174 You can use this class as the base class for a Pod formatter/processor.
 175 .SH "METHOD CALLING"
 176 .IX Header "METHOD CALLING"
 177 When Pod::Simple sees a \*(L"=head1 Hi there\*(R", for example, it basically does
 178 this:
 179 .PP
 180 .Vb 3
 181 \&  $parser\->_handle_element_start( "head1", \e%attributes );
 182 \&  $parser\->_handle_text( "Hi there" );
 183 \&  $parser\->_handle_element_end( "head1" );
 184 .Ve
 185 .PP
 186 But if you subclass Pod::Simple::Methody, it will instead do this
 187 when it sees a \*(L"=head1 Hi there\*(R":
 188 .PP
 189 .Vb 3
 190 \&  $parser\->start_head1( \e%attributes ) if $parser\->can('start_head1');
 191 \&  $parser\->handle_text( "Hi there" )   if $parser\->can('handle_text');
 192 \&  $parser\->end_head1()                 if $parser\->can('end_head1');
 193 .Ve
 194 .PP
 195 If Pod::Simple sends an event where the element name has a dash,
 196 period, or colon, the corresponding method name will have a underscore
 197 in its place.  For example, \*(L"foo.bar:baz\*(R" becomes start_foo_bar_baz
 198 and end_foo_bar_baz.
 199 .PP
 200 See the source for Pod::Simple::Text for an example of using this class.
 201 .SH "SEE ALSO"
 202 .IX Header "SEE ALSO"
 203 Pod::Simple, Pod::Simple::Subclassing
 204 .SH "COPYRIGHT AND DISCLAIMERS"
 205 .IX Header "COPYRIGHT AND DISCLAIMERS"
 206 Copyright (c) 2002 Sean M. Burke.  All rights reserved.
 207 .PP
 208 This library is free software; you can redistribute it and/or modify it
 209 under the same terms as Perl itself.
 210 .PP
 211 This program is distributed in the hope that it will be useful, but
 212 without any warranty; without even the implied warranty of
 213 merchantability or fitness for a particular purpose.
 214 .SH "AUTHOR"
 215 .IX Header "AUTHOR"
 216 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR