-
-
28 Jun 2021 21:11:50 UTC
- Distribution: Pod-Simple
- Module version: 3.43
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (5)
- Testers (736 / 0 / 0)
- Kwalitee
Bus factor: 5- 72.74% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (299.2KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- Carp
- Config
- Cwd
- File::Basename
- File::Find
- File::Spec
- Pod::Escapes
- Symbol
- Test::More
- Text::Wrap
- if
- integer
- overload
- strict
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
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" forL<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
SUPPORT
Questions or discussion about POD and Pod::Simple should be sent to the pod-people@perl.org mail list. Send an empty email to pod-people-subscribe@perl.org to subscribe.
This module is managed in an open GitHub repository, https://github.com/perl-pod/pod-simple/. Feel free to fork and contribute, or to clone git://github.com/perl-pod/pod-simple.git and send patches!
Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simple@rt.cpan.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 <sburke@cpan.org>. But don't bother him, he's retired.
Pod::Simple is maintained by:
Allison Randal
allison@perl.org
Hans Dieter Pearcey
hdp@cpan.org
David E. Wheeler
dwheeler@cpan.org
Module Install Instructions
To install Pod::Simple, copy and paste the appropriate command in to your terminal.
cpanm Pod::Simple
perl -MCPAN -e shell install Pod::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.