/usr/share/perl5/Pod/Elemental.pm is in libpod-elemental-perl 0.102361-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | package Pod::Elemental;
{
$Pod::Elemental::VERSION = '0.102361';
}
use Moose;
# ABSTRACT: work with nestable Pod elements
use namespace::autoclean;
use Sub::Exporter::ForMethods ();
use Mixin::Linewise::Readers
{ installer => Sub::Exporter::ForMethods::method_installer },
-readers;
use Moose::Autobox;
use MooseX::Types;
use Pod::Eventual::Simple;
use Pod::Elemental::Document;
use Pod::Elemental::Transformer::Pod5;
use Pod::Elemental::Objectifier;
sub read_handle {
my ($self, $handle) = @_;
$self = $self->new unless ref $self;
my $events = $self->event_reader->read_handle($handle);
my $elements = $self->objectifier->objectify_events($events);
my $document = $self->document_class->new({
children => $elements,
});
return $document;
}
has event_reader => (
is => 'ro',
required => 1,
default => sub { return Pod::Eventual::Simple->new },
);
has objectifier => (
is => 'ro',
isa => duck_type( [qw(objectify_events) ]),
required => 1,
default => sub { return Pod::Elemental::Objectifier->new },
);
has document_class => (
is => 'ro',
required => 1,
default => 'Pod::Elemental::Document',
);
__PACKAGE__->meta->make_immutable;
no Moose;
1;
__END__
=pod
=head1 NAME
Pod::Elemental - work with nestable Pod elements
=head1 VERSION
version 0.102361
=head1 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
=head1 DESCRIPTION
Pod::Elemental is a system for treating a Pod (L<plain old
documentation|perlpod>) documents as trees 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 still makes a lot of document transformations easy.
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 L<Pod5
transformation|Pod::Elemental::Transformer::Pod5>, which assumes that the basic
meaning of Pod commands described in the Perl 5 documentation hold: C<=begin>,
C<=end>, and C<=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.
=head1 ATTRIBUTES
=head2 event_reader
The event reader (by default a new instance of
L<Pod::Eventual::Simple|Pod::Eventual::Simple> is used to convert input into an
event stream. In general, it should provide C<read_*> methods that behave like
Pod::Eventual::Simple.
=head2 objectifier
The objectifier (by default a new Pod::Elemental::Objectifier) must provide an
C<objectify_events> method that converts Pod events into
Pod::Elemental::Element objects.
=head2 document_class
This is the class for documents created by reading pod.
=head1 METHODS
=head2 read_handle
=head2 read_file
=head2 read_string
These methods read the given input and return a Pod::Elemental::Document.
=head1 AUTHOR
Ricardo SIGNES <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 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.
=cut
|