Ivan Tubert-Brohman > Pod-Index > Pod::Index::Extract

Download:
Pod-Index-0.14.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.14   Source  

NAME ^

Pod::Index::Extract - Extracts a "pod scope"

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);

DESCRIPTION ^

This module is a subclass of Pod::Parser. It outputs POD without any transformation; however, it only outputs the POD that is "in scope" as defined in Pod::Index.

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.

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.

VERSION ^

0.14

SEE ALSO ^

Pod::Index, Pod::Index::Entry, Pod::Parser

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.

syntax highlighting: