Debian Codegraph @

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