https://github.com/rsrchboy/pod-weaver-section-collect-fromother
Import sections from other POD
https://github.com/rsrchboy/pod-weaver-section-collect-fromother
Last synced: 3 months ago
JSON representation
Import sections from other POD
- Host: GitHub
- URL: https://github.com/rsrchboy/pod-weaver-section-collect-fromother
- Owner: rsrchboy
- License: other
- Created: 2011-11-15T23:03:05.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-10-11T01:07:18.000Z (over 8 years ago)
- Last Synced: 2025-01-16T04:17:06.655Z (5 months ago)
- Language: Perl
- Homepage: http://metacpan.org/release/Pod-Weaver-Section-Collect-FromOther/
- Size: 18.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.mkdn
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/RsrchBoy/pod-weaver-section-collect-fromother)
[](http://cpants.charsbar.org/dist/overview/Pod-Weaver-Section-Collect-FromOther)
[](https://coveralls.io/r/RsrchBoy/pod-weaver-section-collect-fromother?branch=master)
# 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.
- [Pod::Weaver](https://metacpan.org/pod/Pod::Weaver)
- [Pod::Weaver::Section::Collect](https://metacpan.org/pod/Pod::Weaver::Section::Collect)
- [[Reindeer](https://metacpan.org/pod/Reindeer) uses this package to collect documentation from various sources.](https://metacpan.org/pod/Reindeer uses this package to collect documentation from various sources.)
# BUGS
Please report any bugs or feature requests on the bugtracker website
[https://github.com/RsrchBoy/pod-weaver-section-collect-fromother/issues](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
## 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](https://flattr.com/submit/auto?user_id=RsrchBoy&url=https%3A%2F%2Fgithub.com%2FRsrchBoy%2Fpod-weaver-section-collect-fromother&title=RsrchBoy's%20CPAN%20Pod-Weaver-Section-Collect-FromOther&tags=%22RsrchBoy's%20Pod-Weaver-Section-Collect-FromOther%20in%20the%20CPAN%22),
[Gratipay](https://gratipay.com/RsrchBoy/), or indulge my
[Amazon Wishlist](http://bit.ly/rsrchboys-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