Import sections from other POD
Perl
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/Pod/Weaver/Section/Collect
t
.gitignore
.travis.yml
Changes
LICENSE
README.mkdn
dist.ini

README.mkdn

Build Status Kwalitee status Coverage Status

NAME

Pod::Weaver::Section::Collect::FromOther - Import sections from other POD

VERSION

This document describes version 0.003 of Pod::Weaver::Section::Collect::FromOther - released October 10, 2016 as part of Pod-Weaver-Section-Collect-FromOther.

DESCRIPTION

Copy chunks of POD from other documents, and incorporate them. Our purpose here is to enable the easy documentation of packages that serve to combine parts of preexisting packages (and thus preexisting documentation).

METHODS

prepare_input($input)

Check the given $input for any commands that would trigger us, and extract/insert pod as requested.

copy_sections_from_other($module, $header_text, $opts)

Loads the POD from $module (specified as a package name, in our @INC), looks for a =head1 section with $header_text, and copies everything pulls it out until the next =head1 section.

We return the elements we find from the first command until the next section; this is to enable preface text to be skipped. This behaviour can be altered by setting $opts to 'all';

We return a series of elements suitable for inclusion directly into another document. Note that if this set includes a list, that list will be converted, with each =item command becoming a =head2.

SEE ALSO

Please see those modules/websites for more information related to this module.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/RsrchBoy/pod-weaver-section-collect-fromother/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Chris Weyl cweyl@alumni.drew.edu

I'm a material boy in a material world

Please note I do not expect to be gittip'ed or flattr'ed for this work, rather it is simply a very pleasant surprise. I largely create and release works like this because I need them or I find it enjoyable; however, don't let that stop you if you feel like it ;)

Flattr, Gratipay, or indulge my Amazon Wishlist... If and *only* if you so desire.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2011 by Chris Weyl.

This is free software, licensed under:

The GNU Lesser General Public License, Version 2.1, February 1999