Pod::Simple::LinkSection(3pm)                   Perl Programmers Reference Guide                   Pod::Simple::LinkSection(3pm)



NAME
       Pod::Simple::LinkSection -- represent "section" attributes of L codes

SYNOPSIS
        # a long story

DESCRIPTION
       This class is not of interest to general users.

       Pod::Simple uses this class for representing the value of the "section" attribute of "L" start-element events.  Most
       applications can just use the normal stringification of objects of this class; they stringify to just the text content of
       the section, such as "foo" for "L<Stuff/foo>", and "bar" for "L<Stuff/bI<ar>>".

       However, anyone particularly interested in getting the full value of the treelet, can just traverse the content of the
       treeleet @$treelet_object.  To wit:

         % perl -MData::Dumper -e
           "use base qw(Pod::Simple::Methody);
            sub start_L { print Dumper($_[1]{'section'} ) }
            __PACKAGE__->new->parse_string_document('=head1 L<Foo/bI<ar>baz>>')
           "
       Output:
         $VAR1 = bless( [
                          '',
                          {},
                          'b',
                          bless( [
                                   'I',
                                   {},
                                   'ar'
                                 ], 'Pod::Simple::LinkSection' ),
                          'baz'
                        ], 'Pod::Simple::LinkSection' );

       But stringify it and you get just the text content:

         % perl -MData::Dumper -e
           "use base qw(Pod::Simple::Methody);
            sub start_L { print Dumper( '' . $_[1]{'section'} ) }
            __PACKAGE__->new->parse_string_document('=head1 L<Foo/bI<ar>baz>>')
           "
       Output:
         $VAR1 = 'barbaz';

SEE ALSO
       Pod::Simple

SUPPORT
       Questions or discussion about POD and Pod::Simple should be sent to the pod-peopleATperl.org mail list. Send an empty
       email to pod-people-subscribeATperl.org to subscribe.

       This module is managed in an open GitHub repository, http://github.com/theory/pod-simple/ <http://github.com/theory/pod-
       simple/>. Feel free to fork and contribute, or to clone git://github.com/theory/pod-simple.git
       <git://github.com/theory/pod-simple.git>; and send patches!

       Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simpleATrt.org>.

COPYRIGHT AND DISCLAIMERS
       Copyright (c) 2004 Sean M. Burke.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied
       warranty of merchantability or fitness for a particular purpose.

AUTHOR
       Pod::Simple was created by Sean M. Burke <sburkeATcpan.org>.  But don't bother him, he's retired.

       Pod::Simple is maintained by:

       o   Allison Randal "allisonATperl.org"

       o   Hans Dieter Pearcey "hdpATcpan.org"

       o   David E. Wheeler "dwheelerATcpan.org"



perl v5.12.4                                               2011-06-07                              Pod::Simple::LinkSection(3pm)