.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Template::Plugin::Calendar::Simple 3pm"
.TH Template::Plugin::Calendar::Simple 3pm "2016-01-08" "perl v5.22.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Template::Plugin::Calendar::Simple \- Just another HTML calendar generator.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& [% USE cal = Calendar.Simple %]
\&
\&
\&
\& [% FOREACH day = cal.days %]
\& [% day %] |
\& [% END %]
\&
\& [% FOREACH row = cal.rows %]
\&
\& [% FOREACH col = row %]
\& [% col || \*(Aq \*(Aq %] |
\& [% END %]
\&
\& [% END %]
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides calendar delimiters for a Template Toolkit template via
Calendar::Simple. This module supplies the data, you supply the \s-1HTML.\s0
Defaults to current month within the current year. Past months and years
can be specified within the Template constructor:
.PP
.Vb 1
\& [% USE cal = Calendar.Simple( 5, 2000 ) %]
.Ve
.PP
Can generate calendars that start with Monday instead of Sunday like so:
.PP
.Vb 4
\& [% USE cal = Calendar.Simple( 5, 2000, 1 ) %]
\& ...
\& [% FOREACH day = cal.days( 1 ) %]
\& ...
.Ve
.PP
See the unit tests for more examples.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """new()""" 4
.el .IP "\f(CWnew()\fR" 4
.IX Item "new()"
Constructor. Will be called for you by the Template Toolkit engine.
.ie n .IP """rows()""" 4
.el .IP "\f(CWrows()\fR" 4
.IX Item "rows()"
.Vb 1
\& [% FOREACH row = cal.rows %]
.Ve
.Sp
Returns a Template::Iterator which contains the calendar rows.
Each row, however, is simply an array.
.ie n .IP """days()""" 4
.el .IP "\f(CWdays()\fR" 4
.IX Item "days()"
.Vb 1
\& [% FOREACH day = cal.days %]
.Ve
.Sp
Most calendars have a header with the days \- this method returns
an array of abbreviated day names (currently only in English). If
any argument is passed, then the week day starts with Monday instead
of Sunday.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Template::Plugin
.IP "\(bu" 4
Calendar::Simple.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Please report any bugs or feature requests to either
.IP "\(bu" 4
Email: \f(CW\*(C`bug\-template\-plugin\-calendar\-simple at rt.cpan.org\*(C'\fR
.IP "\(bu" 4
Web:
.PP
I will be notified, and then you'll automatically be notified of progress
on your bug as I make changes.
.SH "GITHUB"
.IX Header "GITHUB"
The Github project is
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\& perldoc Template::Plugin::Calendar::Simple
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker (report bugs here)
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.IP "\(bu" 4
Search \s-1CPAN \s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeff Anderson, \f(CW\*(C`\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2016 Jeff Anderson.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:
.PP
.PP
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
.PP
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
.PP
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
.PP
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
.PP
Disclaimer of Warranty: \s-1THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS\s0' \s-1AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR\s0 NON-INFRINGEMENT \s-1ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\s0