Pod::S...ection(3perl)

✨ NAME ✨

Pod::Simple::LinkSection β€” the ✨represent "section" attributes of L codes✨ vibe, bestie

(also hey, this one lives in the Perl Programmers Reference Guide, so you know it's official πŸ’…)


🌸 SYNOPSIS 🌸

# a long story

no literally that's the whole synopsis, it's giving mystery on purpose πŸ™ˆ


πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so first thing first: this class is not of interest to general users. If you're just out here living your life writing POD, this is not the class for you, bestie, and that's fine πŸ’–

But here's the tea: Pod::Simple uses this class to represent the value of the "section" attribute of "L" start-element events. Most applications can just use the normal stringification of objects of this class β€” and when they stringify, they give you just the text content of the section. So like, "foo" for L<Stuff/foo>, and "bar" for L<Stuff/bI<ar>>. Cute, right? ✨

However!! If you're particularly interested in getting the full value of the treelet, you 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' );

Look at that treelet. She's got structure, she's got layers, she's got a whole nested bless. Main character energy for real πŸ‘‘

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?? All that gorgeous tree, and one little stringify later it's just 'barbaz'. Iconic behaviour honestly πŸ’…


πŸŽ€ SEE ALSO πŸŽ€

  • Pod::Simple β€” the parent, the blueprint, the whole reason we're here 🫢

πŸ’œ SUPPORT πŸ’œ

Got questions? Got discussion? Got opinions about POD and Pod::Simple? Send them to the mail list at pod-people@perl.org πŸ“¬

Want in? Send an empty email to pod-people-subscribe@perl.org to subscribe. That's it. Empty. No subject line essay needed, bestie.

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 <https://github.com/perl-pod/pod-simple.git> and send patches! Forking is self-care 🧚

Patches against Pod::Simple are welcome (yes really, they want them πŸ’–). Please send bug reports to <bug-pod-simple@rt.cpan.org>.


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. So like, it's free, it's generous, but it does not come with promises, periodt.


🌈 AUTHOR 🌈

Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't bother him, he's retired. Respect the retirement, bestie, he's earned it πŸ™

Pod::Simple is maintained by:

  • Allison Randal "allison@perl.org"
  • Hans Dieter Pearcey "hdp@cpan.org"
  • David E. Wheeler "dwheeler@cpan.org"

absolute legends, all three πŸ‘‘


and that's the whole page fr fr πŸ’– this was perl v5.44.0, dated 2026-10-17, living under the name Pod::S...ection(3perl) in the Perl Programmers Reference Guide β€” slay, go read some POD, ily bye πŸŽ€

πŸ“¦ where this page comes from
  • arch rolling: perl 5.44.0-1 Β· Artistic-1.0-Perl AND GPL-1.0-or-later
  • πŸ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms