Pod::I...Extract(3pm)

💖 Pod::Index::Extract — the Pod::I...Extract(3pm) manual, but make it cute 💖

okay bestie, welcome to the perl docs section of the group chat 🌸 this one is Pod::Index::Extract, and it's literally a lil module that goes "give me just this one slice of POD pls" and hands it back to you. no cap.

---

✨ NAME ✨

Pod::Index::Extract — extracts a "pod scope" 🎀

like… it pulls out one scoped chunk of POD and that's the whole job. iconic behaviour honestly.

---

🦋 SYNOPSIS 🦋

use Pod::Index::Extract;

my $parser = Pod::Index::Extract->new;
# [...] get $fh_in to the desired position
$parser->parse_from_filehandle($fh_in, $fh_out);

see that # [...] comment? yeah that's you, bestie, doing the work of parking $fh_in at the right spot first. the module is not gonna do that part for you 💅

---

🌈 DESCRIPTION 🌈

okay so here's the tea ☕️

This module is a subclass of Pod::Parser. It outputs POD without any transformation — like, zero glow-up, zero editing, it just passes the POD through as-is. But here's the catch: it only outputs the POD that is "in scope" as defined in Pod::Index. so it's a filter, not a rewriter. slay.

To use this module, you first need to position a filehandle at the beginning of the desired scope, and then call parse_from_filehandle with that filehandle for input. It will just print the POD until it reaches the end of the scope, after which it will jump to the end of the file. literally just vibing through your POD until the scope runs out and then dipping to EOF 🏃‍♀️💨

and here's the cute part: if the scope starts with an =item, it will wrap it with an =over and a =back, so it can be used as valid POD in isolation. 🫶 like it knows a bare =item would be giving chaos, so it puts a little outfit on it so it can go out in public alone. periodt.

---

⭐ VERSION ⭐

0.14

---

👑 SEE ALSO 👑

• Pod::Index
• Pod::Index::Entry
• Pod::Parser

go read those too, iykyk 🧚

---

💜 AUTHOR 💜

Ivan Tubert-Brohman <itub@cpan.org>

---

🍓 COPYRIGHT 🍓

Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

okay that's the whole page, no notes 💖 this was perl v5.30.0, dated 2020-05-17, and it's the Pod::I...Extract(3pm) manual — love that for us. bye bestie, hydrate and go read your POD scopes 🌸✨