Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Simple::Methody.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Simple::Methody 3pm"
61 .TH Pod::Simple::Methody 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Simple::Methody \-\- turn Pod::Simple events into method calls
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 4
71 \& require 5;
72 \& use strict;
73 \& package SomePodFormatter;
74 \& use base qw(Pod::Simple::Methody);
75 \&
76 \& sub handle_text {
77 \& my($self, $text) = @_;
78 \& ...
79 \& }
80 \&
81 \& sub start_head1 {
82 \& my($self, $attrs) = @_;
83 \& ...
84 \& }
85 \& sub end_head1 {
86 \& my($self) = @_;
87 \& ...
88 \& }
89 .Ve
90 .PP
91 \&...and start_/end_ methods for whatever other events you want to catch.
92 .SH DESCRIPTION
93 .IX Header "DESCRIPTION"
94 This class is of
95 interest to people writing Pod formatters based on Pod::Simple.
96 .PP
97 This class (which is very small \-\- read the source) overrides
98 Pod::Simple\*(Aqs _handle_element_start, _handle_text, and
99 _handle_element_end methods so that parser events are turned into method
100 calls. (Otherwise, this is a subclass of Pod::Simple and inherits all
101 its methods.)
102 .PP
103 You can use this class as the base class for a Pod formatter/processor.
104 .SH "METHOD CALLING"
105 .IX Header "METHOD CALLING"
106 When Pod::Simple sees a "=head1 Hi there", for example, it basically does
107 this:
108 .PP
109 .Vb 3
110 \& $parser\->_handle_element_start( "head1", \e%attributes );
111 \& $parser\->_handle_text( "Hi there" );
112 \& $parser\->_handle_element_end( "head1" );
113 .Ve
114 .PP
115 But if you subclass Pod::Simple::Methody, it will instead do this
116 when it sees a "=head1 Hi there":
117 .PP
118 .Vb 3
119 \& $parser\->start_head1( \e%attributes ) if $parser\->can(\*(Aqstart_head1\*(Aq);
120 \& $parser\->handle_text( "Hi there" ) if $parser\->can(\*(Aqhandle_text\*(Aq);
121 \& $parser\->end_head1() if $parser\->can(\*(Aqend_head1\*(Aq);
122 .Ve
123 .PP
124 If Pod::Simple sends an event where the element name has a dash,
125 period, or colon, the corresponding method name will have a underscore
126 in its place. For example, "foo.bar:baz" becomes start_foo_bar_baz
127 and end_foo_bar_baz.
128 .PP
129 See the source for Pod::Simple::Text for an example of using this class.
130 .SH "SEE ALSO"
131 .IX Header "SEE ALSO"
132 Pod::Simple, Pod::Simple::Subclassing
133 .SH SUPPORT
134 .IX Header "SUPPORT"
135 Questions or discussion about POD and Pod::Simple should be sent to the
136 pod\[email protected] mail list. Send an empty email to
137 pod\-people\[email protected] to subscribe.
138 .PP
139 This module is managed in an open GitHub repository,
140 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
141 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
142 .PP
143 Patches against Pod::Simple are welcome. Please send bug reports to
144 <bug\-pod\[email protected]>.
145 .SH "COPYRIGHT AND DISCLAIMERS"
146 .IX Header "COPYRIGHT AND DISCLAIMERS"
147 Copyright (c) 2002 Sean M. Burke.
148 .PP
149 This library is free software; you can redistribute it and/or modify it
150 under the same terms as Perl itself.
151 .PP
152 This program is distributed in the hope that it will be useful, but
153 without any warranty; without even the implied warranty of
154 merchantability or fitness for a particular purpose.
155 .SH AUTHOR
156 .IX Header "AUTHOR"
157 Pod::Simple was created by Sean M. Burke <[email protected]>.
158 But don\*(Aqt bother him, he\*(Aqs retired.
159 .PP
160 Pod::Simple is maintained by:
161 .IP \(bu 4
162 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
163 .IP \(bu 4
164 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
165 .IP \(bu 4
166 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR