Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::Methody.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Simple::Methody 3perl"
58 .TH Pod::Simple::Methody 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Simple::Methody \-\- turn Pod::Simple events into method calls
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 4
68 \& require 5;
69 \& use strict;
70 \& package SomePodFormatter;
71 \& use base qw(Pod::Simple::Methody);
72 \&
73 \& sub handle_text {
74 \& my($self, $text) = @_;
75 \& ...
76 \& }
77 \&
78 \& sub start_head1 {
79 \& my($self, $attrs) = @_;
80 \& ...
81 \& }
82 \& sub end_head1 {
83 \& my($self) = @_;
84 \& ...
85 \& }
86 .Ve
87 .PP
88 \&...and start_/end_ methods for whatever other events you want to catch.
89 .SH DESCRIPTION
90 .IX Header "DESCRIPTION"
91 This class is of
92 interest to people writing Pod formatters based on Pod::Simple.
93 .PP
94 This class (which is very small \-\- read the source) overrides
95 Pod::Simple's _handle_element_start, _handle_text, and
96 _handle_element_end methods so that parser events are turned into method
97 calls. (Otherwise, this is a subclass of Pod::Simple and inherits all
98 its methods.)
99 .PP
100 You can use this class as the base class for a Pod formatter/processor.
101 .SH "METHOD CALLING"
102 .IX Header "METHOD CALLING"
103 When Pod::Simple sees a "=head1 Hi there", for example, it basically does
104 this:
105 .PP
106 .Vb 3
107 \& $parser\->_handle_element_start( "head1", \e%attributes );
108 \& $parser\->_handle_text( "Hi there" );
109 \& $parser\->_handle_element_end( "head1" );
110 .Ve
111 .PP
112 But if you subclass Pod::Simple::Methody, it will instead do this
113 when it sees a "=head1 Hi there":
114 .PP
115 .Vb 3
116 \& $parser\->start_head1( \e%attributes ) if $parser\->can(\*(Aqstart_head1\*(Aq);
117 \& $parser\->handle_text( "Hi there" ) if $parser\->can(\*(Aqhandle_text\*(Aq);
118 \& $parser\->end_head1() if $parser\->can(\*(Aqend_head1\*(Aq);
119 .Ve
120 .PP
121 If Pod::Simple sends an event where the element name has a dash,
122 period, or colon, the corresponding method name will have a underscore
123 in its place. For example, "foo.bar:baz" becomes start_foo_bar_baz
124 and end_foo_bar_baz.
125 .PP
126 See the source for Pod::Simple::Text for an example of using this class.
127 .SH "SEE ALSO"
128 .IX Header "SEE ALSO"
129 Pod::Simple, Pod::Simple::Subclassing
130 .SH SUPPORT
131 .IX Header "SUPPORT"
132 Questions or discussion about POD and Pod::Simple should be sent to the
133 pod\[email protected] mail list. Send an empty email to
134 pod\-people\[email protected] to subscribe.
135 .PP
136 This module is managed in an open GitHub repository,
137 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
138 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
139 .PP
140 Patches against Pod::Simple are welcome. Please send bug reports to
141 <bug\-pod\[email protected]>.
142 .SH "COPYRIGHT AND DISCLAIMERS"
143 .IX Header "COPYRIGHT AND DISCLAIMERS"
144 Copyright (c) 2002 Sean M. Burke.
145 .PP
146 This library is free software; you can redistribute it and/or modify it
147 under the same terms as Perl itself.
148 .PP
149 This program is distributed in the hope that it will be useful, but
150 without any warranty; without even the implied warranty of
151 merchantability or fitness for a particular purpose.
152 .SH AUTHOR
153 .IX Header "AUTHOR"
154 Pod::Simple was created by Sean M. Burke <[email protected]>.
155 But don't bother him, he's retired.
156 .PP
157 Pod::Simple is maintained by:
158 .IP \(bu 4
159 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
160 .IP \(bu 4
161 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
162 .IP \(bu 4
163 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR