Apocalypse > Pod-Weaver-Section-SeeAlso-1.002 > Pod::Weaver::Section::SeeAlso

Download:
Pod-Weaver-Section-SeeAlso-1.002.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.002   Source  

NAME ^

Pod::Weaver::Section::SeeAlso - add a SEE ALSO pod section

VERSION ^

  This document describes v1.002 of Pod::Weaver::Section::SeeAlso - released February 21, 2011 as part of Pod-Weaver-Section-SeeAlso.

DESCRIPTION ^

This section plugin will produce a hunk of pod that references the main module of a dist from it's submodules and adds any other text already present in the pod. It will do this only if it is being built with Dist::Zilla because it needs the data from the dzil object.

In the main module, this section plugin just transforms the links into a proper list. In the submodules, it also adds the link to the main module.

For an example of what the hunk looks like, look at the "SEE ALSO" section in this POD :)

WARNING: Please do not put any POD commands in your SEE ALSO section!

What you should do when you want to add extra links is:

        =head1 SEE ALSO
        Foo::Bar
        Bar::Baz
        www.cpan.org

And this module will automatically convert it into:

        =head1 SEE ALSO
        =over 4
        =item *
        L<Main::Module>
        =item *
        L<Foo::Bar>
        =item *
        L<Bar::Baz>
        =item *
        L<www.cpan.org>
        =back

You can specify more links by using the "links" attribute or by specifying it as a comment. The format of the comment is:

        # SEEALSO: Foo::Bar, Module::Nice::Foo, www.foo.com

At this time you can only use one comment line. If you need to do it multiple times, please prod me to update the module or give me a patch :)

The way the links are ordered is: POD in the module, links attribute, comment links.

ATTRIBUTES ^

add_main_link

A boolean value controlling whether the link back to the main module should be added in the submodules.

Defaults to true.

header

Specify the content to be displayed before the list of links is shown.

The default is a sufficient explanation (see "SEE ALSO").

links

Specify a list of links you want to add to the SEE ALSO section.

You can either specify it like this: "Foo::Bar" or do it in POD format: "Foo::Bar". This module will automatically add the proper POD formatting if it is missing.

The default is an empty list.

SEE ALSO ^

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

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc Pod::Weaver::Section::SeeAlso

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Email

You can email the author of this module at APOCAL at cpan.org asking for help with any problems you have.

Internet Relay Chat

You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: http://en.wikipedia.org/wiki/Internet_Relay_Chat. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-pod-weaver-section-seealso at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Weaver-Section-SeeAlso. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

http://github.com/apocalypse/perl-pod-weaver-section-seealso

  git clone git://github.com/apocalypse/perl-pod-weaver-section-seealso.git

AUTHOR ^

Apocalypse <APOCAL@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Apocalypse.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

syntax highlighting: