Pod::Elemental(3)

💖 NAME 💖

okay so Pod::Elemental(3) — straight from the User Contributed Perl Documentation zone — is the manual for Pod::Elemental, and its whole personality is: work with nestable Pod elements. That's the name, that's the assignment, periodt. 💅

✨ VERSION ✨

Version 0.103006, bestie. Slay.

🦋 SYNOPSIS 🦋

use Pod::Elemental;
use Pod::Elemental::Transformer::Pod5;

my $document = Pod::Elemental->read_file('lib/Pod/Elemental.pm');

Pod::Elemental::Transformer::Pod5->new->transform_node($document);

print $document->as_debug_string, "\n"; # quick overview of doc structure

print $document->as_pod_string, "\n";   # reproduce the document in Pod

🌸 DESCRIPTION 🌸

okay so Pod::Elemental is a whole system for treating a Pod (plain old documentation) document as a tree of elements. This model may be familiar from many other document systems, especially the HTML DOM. Pod::Elemental's document object model is much less sophisticated than the HTML DOM, but it still makes a lot of document transformations easy. No cap. ✨

In general, you'll want to read in a Pod document and then perform a number of prepackaged transformations on it. The most common of these will be the Pod5 transformation, which assumes that the basic meaning of Pod commands described in the Perl 5 documentation holds: =begin, =end, and =for commands mark regions of the document, leading whitespace marks a verbatim paragraph, and so on. The Pod5 transformer also eliminates the need to track elements representing vertical whitespace. Obsessed, honestly. 🫶

🧚 PERL VERSION 🧚

This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

⚠️ that's the caveat, bestie — don't assume the minimum perl version is locked forever.

🎀 ATTRIBUTES 🎀

event_reader

The event reader (by default, a new instance of Pod::Eventual::Simple) is used to convert input into an event stream. In general, it should provide read_* methods that behave like Pod::Eventual::Simple.

objectifier

The objectifier (by default a new Pod::Elemental::Objectifier) must provide an objectify_events method that converts Pod events into Pod::Elemental::Element objects.

document_class

This is the class for documents created by reading pod. iykyk.

💅 METHODS 💅

read_handle, read_file, read_string

These methods read the given input and return a Pod::Elemental::Document. Yes, all three of them — read_handle, read_file, and read_string — are giving "read the thing, hand you the document." 💖

👑 AUTHOR 👑

Ricardo SIGNES <cpan@semiotic.systems>

🌈 CONTRIBUTORS 🌈

• Christian Walde <walde.christian@googlemail.com>
• Justin Cook <jcook@cray.com>
• Karen Etheridge <ether@cpan.org>
• Philippe Bruhat (BooK) <book@cpan.org>
• Ricardo Signes <rjbs@semiotic.systems>

🍓 COPYRIGHT AND LICENSE 🍓

This software is copyright (c) 2022 by Ricardo SIGNES.

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

This page is from perl v5.42.0 and dated 2023-01-01 — love that for us. Bye bestie, go transform some nodes! 💜🦋