1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
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 \
129 .\" ========================================================================
131 .IX Title "Pod::Simple::LinkSection 3"
132 .TH Pod::Simple::LinkSection 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
134 Pod::Simple::LinkSection \-\- represent "section" attributes of L codes
136 .IX Header "SYNOPSIS"
141 .IX Header "DESCRIPTION"
142 This class is not of interest to general users.
144 Pod::Simple uses this class for representing the value of the
145 \&\*(L"section\*(R" attribute of \*(L"L\*(R" start-element events. Most applications
146 can just use the normal stringification of objects of this class;
147 they stringify to just the text content of the section,
148 such as \*(L"foo\*(R" for
149 \&\f(CW\*(C`L\&<Stuff/foo>\*(C'\fR, and \*(L"bar\*(R" for
150 \&\f(CW\*(C`L\&<Stuff/bI\&<ar>>\*(C'\fR.
152 However, anyone particularly interested in getting the full value of
153 the treelet, can just traverse the content of the treeleet
154 @$treelet_object. To wit:
157 \& % perl \-MData::Dumper \-e
158 \& "use base qw(Pod::Simple::Methody);
159 \& sub start_L { print Dumper($_[1]{'section'} ) }
160 \& __PACKAGE__\->new\->parse_string_document('=head1 L<Foo/bI<ar>baz>>')
171 \& ], 'Pod::Simple::LinkSection' ),
173 \& ], 'Pod::Simple::LinkSection' );
176 But stringify it and you get just the text content:
179 \& % perl \-MData::Dumper \-e
180 \& "use base qw(Pod::Simple::Methody);
181 \& sub start_L { print Dumper( '' . $_[1]{'section'} ) }
182 \& __PACKAGE__\->new\->parse_string_document('=head1 L<Foo/bI<ar>baz>>')
188 .IX Header "SEE ALSO"
190 .SH "COPYRIGHT AND DISCLAIMERS"
191 .IX Header "COPYRIGHT AND DISCLAIMERS"
192 Copyright (c) 2002 Sean M. Burke. All rights reserved.
194 This library is free software; you can redistribute it and/or modify it
195 under the same terms as Perl itself.
197 This program is distributed in the hope that it will be useful, but
198 without any warranty; without even the implied warranty of
199 merchantability or fitness for a particular purpose.
202 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR