Calendar-Dates
view release on metacpan or search on metacpan
{
"abstract" : "Modules that contain calendar dates",
"author" : [
"perlancar <perlancar@cpan.org>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 6.010, CPAN::Meta::Converter version 2.150010",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
---
abstract: 'Modules that contain calendar dates'
author:
- 'perlancar <perlancar@cpan.org>'
build_requires:
File::Spec: '0'
IO::Handle: '0'
IPC::Open3: '0'
Test::More: '0'
configure_requires:
ExtUtils::MakeMaker: '0'
dynamic_config: 0
Makefile.PL view on Meta::CPAN
# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.010.
use strict;
use warnings;
use ExtUtils::MakeMaker;
my %WriteMakefileArgs = (
"ABSTRACT" => "Modules that contain calendar dates",
"AUTHOR" => "perlancar <perlancar\@cpan.org>",
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => 0
},
"DISTNAME" => "Calendar-Dates",
"LICENSE" => "perl",
"NAME" => "Calendar::Dates",
"PREREQ_PM" => {
"Role::Tiny" => 0
},
NAME
Calendar::Dates - Modules that contain calendar dates
SPECIFICATION VERSION
0.1
VERSION
This document describes version 0.2.3 of Calendar::Dates (from Perl
distribution Calendar-Dates), released on 2019-06-22.
DESCRIPTION
The "Calendar::Dates::*" namespace is reserved for modules that provide
calendar dates using a common interface. The interface is designed to
be: simple to implement, lightweight, and easy to use and export (e.g.
to an iCal calendar).
Conventions for subdivision under the "Calendar::Dates::" namespace:
* Country-specific calendars go to <XX>::*, where <XX> is the
ISO3166-1 2-letter country code
Examples:
Calendar::Dates::SG::Events
Calendar::Dates::SG::FestivalsEvents
Calendar::Dates::ID::Tax
* Country-specific (public) holiday calendars go to <XX>::Holiday::*
Examples:
Calendar::Dates::US::Holiday
* Region/province- and locality-specific calendars go to
<CC>::<Name>::*
Examples:
Calendar::Dates::ID::Jakarta::Events
* Year number can be added as the last component if the module only
supports a specific year
Examples:
Calendar::Dates::ID::Holiday::2019
* Religion-related calendars go to Religion::<Name>::*
Examples:
Calendar::Dates::Religion::Christianity
* Sports-related calendars go to Sports::*
Examples:
Calendar::Dates::Sports::WTA
Calendar::Dates::Sports::WTA::2019
Calendar::Dates::ID::Jakarta::Sports::Marathon
STATUS
Draft series (0.x), expected to be stable in 1.0.
get_entries
Usage:
my $entries = Calendar::Dates::Foo->get_entries([ \%params, ] $year [, $mon [, $day ] ]);
Return entries for a particular year (or month, or day). Method must die
if year (or month, or day) is not supported.
Parameters. The optional %params can be specified for more complex
querying/filtering. Each calendar module might support different
parameters, and should die if a parameter is unsupported. Currently
known common/standardized parameters:
* all
Boolean. If set to true, will include all entries that are normally
not included, e.g. low-priority entries (entries with tag
"low-priority").
* include_tags
URL.
* is_holiday
Boolean. You can also use tag "holiday" to mark an entry as a
holiday.
Optional parameters. A hashref (parameters) can be specified as an
optional first argument. It can be used to specify in more details what
kind of entries are requested. For example, a
Calendar::Dates::AU::Holiday module (Australian holiday calendar)
contains different holidays for different provinces. User can specify:
# return 2019 holiday dates for Victoria
$entries = Calendar::Dates::AU::Holiday->get_entries({province=>'VIC'}, 2019);
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/Calendar-Dates>.
SOURCE
modules, e.g. Calendar::DatesUtils::To::ICal.
* "Calendar::DatesRoles"
For roles related to Calendar::Dates.
Related modules and applications:
* App::CalendarDatesUtils
which contain utilities like list-calendar-dates, etc.
* calx from App::calx
Uses Calendar::Dates::* to highlight dates.
Related projects:
* Date::Holidays
A long established project. Shares a similar goal with
lib/Calendar/Dates.pm view on Meta::CPAN
package Calendar::Dates;
our $DATE = '2019-06-22'; # DATE
our $VERSION = '0.2.3'; # VERSION
1;
# ABSTRACT: Modules that contain calendar dates
__END__
=pod
=encoding UTF-8
=head1 NAME
Calendar::Dates - Modules that contain calendar dates
=head1 SPECIFICATION VERSION
0.1
=head1 VERSION
This document describes version 0.2.3 of Calendar::Dates (from Perl distribution Calendar-Dates), released on 2019-06-22.
=head1 DESCRIPTION
The C<Calendar::Dates::*> namespace is reserved for modules that provide
calendar dates using a common interface. The interface is designed to be: simple
to implement, lightweight, and easy to use and export (e.g. to an iCal
calendar).
Conventions for subdivision under the C<Calendar::Dates::> namespace:
=over
=item * Country-specific calendars go to <XX>::*, where <XX> is the ISO3166-1 2-letter country code
Examples:
Calendar::Dates::SG::Events
Calendar::Dates::SG::FestivalsEvents
Calendar::Dates::ID::Tax
=item * Country-specific (public) holiday calendars go to <XX>::Holiday::*
Examples:
Calendar::Dates::US::Holiday
=item * Region/province- and locality-specific calendars go to <CC>::<Name>::*
Examples:
Calendar::Dates::ID::Jakarta::Events
=item * Year number can be added as the last component if the module only supports a specific year
Examples:
Calendar::Dates::ID::Holiday::2019
=item * Religion-related calendars go to Religion::<Name>::*
Examples:
Calendar::Dates::Religion::Christianity
=item * Sports-related calendars go to Sports::*
Examples:
Calendar::Dates::Sports::WTA
Calendar::Dates::Sports::WTA::2019
Calendar::Dates::ID::Jakarta::Sports::Marathon
=back
=head1 STATUS
lib/Calendar/Dates.pm view on Meta::CPAN
=head2 get_entries
Usage:
my $entries = Calendar::Dates::Foo->get_entries([ \%params, ] $year [, $mon [, $day ] ]);
Return entries for a particular year (or month, or day). Method must die if year
(or month, or day) is not supported.
B<Parameters.> The optional C<%params> can be specified for more complex
querying/filtering. Each calendar module might support different parameters, and
should die if a parameter is unsupported. Currently known common/standardized
parameters:
=over
=item * all
Boolean. If set to true, will include all entries that are normally not
included, e.g. low-priority entries (entries with tag C<low-priority>).
lib/Calendar/Dates.pm view on Meta::CPAN
=item * is_holiday
Boolean. You can also use tag C<holiday> to mark an entry as a holiday.
=back
B<Optional parameters.> A hashref (parameters) can be specified as an optional
first argument. It can be used to specify in more details what kind of entries
are requested. For example, a Calendar::Dates::AU::Holiday module (Australian
holiday calendar) contains different holidays for different provinces. User can
specify:
# return 2019 holiday dates for Victoria
$entries = Calendar::Dates::AU::Holiday->get_entries({province=>'VIC'}, 2019);
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Calendar-Dates>.
=head1 SOURCE
lib/Calendar/Dates.pm view on Meta::CPAN
For roles related to Calendar::Dates.
=back
Related modules and applications:
=over
=item * L<App::CalendarDatesUtils>
which contain utilities like L<list-calendar-dates>, etc.
=item * L<calx> from L<App::calx>
Uses Calendar::Dates::* to highlight dates.
=back
Related projects:
=over
( run in 0.521 second using v1.01-cache-2.11-cpan-5dc5da66d9d )