Chris Weyl > Pod-Weaver-Section-CollectWithIntro-0.001 > Pod::Weaver::Section::CollectWithIntro

Download:
Pod-Weaver-Section-CollectWithIntro-0.001.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.001   Source  

NAME ^

Pod::Weaver::Section::CollectWithIntro - Preface pod collections

VERSION ^

This document describes version 0.001 of Pod::Weaver::Section::CollectWithIntro - released October 29, 2012 as part of Pod-Weaver-Section-CollectWithIntro.

SYNOPSIS ^

    ; weaver.ini
    [CollectWithIntro / ATTRIBUTES]
    command = attr
    content = These attributes are especially tasty in the fall.

    # in your Perl...
    =attr blueberries

    Holds our blueberries.

    =cut

    # in the output pod...
    =head1 ATTRIBUTES

    These attributes are especially tasty in the fall.

    =head2 blueberries

    # ... you get the idea.

DESCRIPTION ^

This is a subclass of Pod::Weaver::Section::Collect that allows one to attach a prefix paragraph to the collected section/node.

ATTRIBUTES ^

content *required*

The intro paragraph. Right now this is expected to be a bog-simple string. Using POD or other bits will probably be supported down the road, but for now, it's just a string.

This is wrapped in a Pod::Elemental::Element::Pod5::Ordinary and included after the section header but before any of the elements.

SEE ALSO ^

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

SOURCE ^

The development version is on github at http://github.com/RsrchBoy/Pod-Weaver-Section-CollectWithIntro and may be cloned from git://github.com/RsrchBoy/Pod-Weaver-Section-CollectWithIntro.git

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://github.com/RsrchBoy/Pod-Weaver-Section-CollectWithIntro/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>

COPYRIGHT AND LICENSE ^

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

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999
syntax highlighting: