The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Pod-Loom-0.08
River stage one • 1 direct dependent • 1 total dependent
++
/ Pod::Loom::Template::Default

NAME

Pod::Loom::Template::Default - Default template for Pod::Loom

VERSION

This document describes version 0.05 of Pod::Loom::Template::Default, released March 23, 2014 as part of Pod-Loom version 0.08.

DESCRIPTION

Pod::Loom::Template::Default is the default template for Pod::Loom. It places the sections in this order:

  +  NAME
  +  VERSION
     SYNOPSIS
     DESCRIPTION
  ++ ATTRIBUTES
  ++ METHODS
  ++ SUBROUTINES
     *
  ++ DIAGNOSTICS
  +  CONFIGURATION AND ENVIRONMENT
     DEPENDENCIES
  +  INCOMPATIBILITIES
  +  BUGS AND LIMITATIONS
  +  AUTHOR
  +  COPYRIGHT AND LICENSE
  +  DISCLAIMER OF WARRANTY

Sections marked with + will be provided by this template if they do not appear in the original document. Sections marked ++ will be appended to even if they do appear in the original document (if the document contains any entries that belong in that section).

See "Controlling the template" in Pod::Loom::Template for details on how to rearrange sections and sort entries.

ATTRIBUTES

abstract

The abstract for the module. Required by NAME.

authors

An arrayref of author names (with optional email address in <>). Required by AUTHOR.

bugtracker

An optional hashref giving the location of the distribution's public bugtracker. If not specified, defaults to the CPAN RT. If present, may have keys web and mailto.

dist

The name of the distribution that contains this module. Required by AUTHOR.

license_notice

The complete text of the COPYRIGHT AND LICENSE section. Required by COPYRIGHT AND LICENSE.

module

The name of the module. Required by NAME and CONFIGURATION AND ENVIRONMENT.

repository

An optional string giving the location of the distribution's public source code repository.

sort_attr

This should be 0, 1, or an arrayref. If non 0, attributes will be sorted. An arrayref lists the attributes that should come first, with the remaining attributes in alphabetical order. See "Pod::Loom-sort_COMMAND" in Pod::Loom::Template.

sort_diag

Just like sort_attr, but for diagnostic messages.

sort_method

Just like sort_attr, but for methods.

sort_sub

Just like sort_attr, but for subroutines.

version

The version number of the module. Used by VERSION.

version_desc

The complete text of the VERSION section. Used by VERSION.

METHODS

section_NAME

  <module> - <abstract>

section_VERSION

  <version_desc>

Or, if "version_desc" is not set:

  version <version>

If neither version_desc nor "version" is set, no VERSION section will be added.

section_ATTRIBUTES

If the original document contains any =attr commands, they will be converted to =head2 commands in this section. If there are no attributes, no ATTRIBUTES section will be added.

section_METHODS

This is just like ATTRIBUTES, except it gathers =method entries.

section_SUBROUTINES

This is just like ATTRIBUTES, except it gathers =sub entries.

section_DIAGNOSTICS

If the original document contains any =diag commands, they will be converted to an =item list in this section. If there are no diagnostics, no DIAGNOSTICS section will be added.

section_CONFIGURATION_AND_ENVIRONMENT

 <module> requires no configuration files or environment variables.

section_INCOMPATIBILITIES

 None reported.

section_BUGS_AND_LIMITATIONS

 No bugs have been reported.

section_AUTHOR

First, it lists the authors from the "authors" attribute (converting @ to AT in email addresses). Then it directs bug reports to the distribution's queue at rt.cpan.org (using the "dist" attribute):

  Please report any bugs or feature requests to
  S<C<< <bug-<dist> AT rt.cpan.org> >>>,
  or through the web interface at
  L<http://rt.cpan.org/Public/Bug/Report.html?Queue=<dist>>

And, if "repository" is set:

  You can follow or contribute to <dist>'s development at
  <repository>.
  <license_notice>

section_DISCLAIMER_OF_WARRANTY

See "DISCLAIMER OF WARRANTY".

CONFIGURATION AND ENVIRONMENT

Pod::Loom::Template::Default requires no configuration files or environment variables.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

AUTHOR

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-Pod-Loom AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Pod-Loom.

You can follow or contribute to Pod-Loom's development at https://github.com/madsen/pod-loom.

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Christopher J. Madsen.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.