Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::LinkSection.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::LinkSection 3perl"
58 .TH Pod::Simple::LinkSection 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::LinkSection \-\- represent "section" attributes of L codes
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& # a long story
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 This class is not of interest to general users.
73 .PP
74 Pod::Simple uses this class for representing the value of the
75 "section" attribute of "L" start-element events. Most applications
76 can just use the normal stringification of objects of this class;
77 they stringify to just the text content of the section,
78 such as "foo" for
79 \&\f(CW\*(C`L<Stuff/foo>\*(C'\fR, and "bar" for
80 \&\f(CW\*(C`L<Stuff/bI<ar>>\*(C'\fR.
81 .PP
82 However, anyone particularly interested in getting the full value of
83 the treelet, can just traverse the content of the treeleet
84 @$treelet_object. To wit:
85 .PP
86 .Vb 10
87 \& % perl \-MData::Dumper \-e
88 \& "use base qw(Pod::Simple::Methody);
89 \& sub start_L { print Dumper($_[1]{\*(Aqsection\*(Aq} ) }
90 \& _\|_PACKAGE_\|_\->new\->parse_string_document(\*(Aq=head1 L<Foo/bI<ar>baz>>\*(Aq)
91 \& "
92 \&Output:
93 \& $VAR1 = bless( [
94 \& \*(Aq\*(Aq,
95 \& {},
96 \& \*(Aqb\*(Aq,
97 \& bless( [
98 \& \*(AqI\*(Aq,
99 \& {},
100 \& \*(Aqar\*(Aq
101 \& ], \*(AqPod::Simple::LinkSection\*(Aq ),
102 \& \*(Aqbaz\*(Aq
103 \& ], \*(AqPod::Simple::LinkSection\*(Aq );
104 .Ve
105 .PP
106 But stringify it and you get just the text content:
107 .PP
108 .Vb 7
109 \& % perl \-MData::Dumper \-e
110 \& "use base qw(Pod::Simple::Methody);
111 \& sub start_L { print Dumper( \*(Aq\*(Aq . $_[1]{\*(Aqsection\*(Aq} ) }
112 \& _\|_PACKAGE_\|_\->new\->parse_string_document(\*(Aq=head1 L<Foo/bI<ar>baz>>\*(Aq)
113 \& "
114 \&Output:
115 \& $VAR1 = \*(Aqbarbaz\*(Aq;
116 .Ve
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 Pod::Simple
120 .SH SUPPORT
121 .IX Header "SUPPORT"
122 Questions or discussion about POD and Pod::Simple should be sent to the
123 pod\[email protected] mail list. Send an empty email to
124 pod\-people\[email protected] to subscribe.
125 .PP
126 This module is managed in an open GitHub repository,
127 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
128 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
129 .PP
130 Patches against Pod::Simple are welcome. Please send bug reports to
131 <bug\-pod\[email protected]>.
132 .SH "COPYRIGHT AND DISCLAIMERS"
133 .IX Header "COPYRIGHT AND DISCLAIMERS"
134 Copyright (c) 2004 Sean M. Burke.
135 .PP
136 This library is free software; you can redistribute it and/or modify it
137 under the same terms as Perl itself.
138 .PP
139 This program is distributed in the hope that it will be useful, but
140 without any warranty; without even the implied warranty of
141 merchantability or fitness for a particular purpose.
142 .SH AUTHOR
143 .IX Header "AUTHOR"
144 Pod::Simple was created by Sean M. Burke <[email protected]>.
145 But don't bother him, he's retired.
146 .PP
147 Pod::Simple is maintained by:
148 .IP \(bu 4
149 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
150 .IP \(bu 4
151 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
152 .IP \(bu 4
153 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR