NAME
    Calendar::Dates - Modules that contain calendar dates

SPECIFICATION VERSION
    0.1

VERSION
    This document describes version 0.1.0 of Calendar::Dates (from Perl
    distribution Calendar-Dates), released on 2019-02-13.

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

METHODS
  get_min_year
    Usage:

     my $min_year = Calendar::Dates::Foo->get_min_year;

    Return the earliest year that the module has dates for. See also
    "get_max_year". Note that the module might not support some years
    between the earliest and latest years.

  get_max_year
    Usage:

     my $max_year = Calendar::Dates::Foo->get_max_year;

    Return the latest year that the module has dates for. See also
    "get_min_year". Note that the module might not support some years
    between the earliest and latest years.

  get_entries
    Usage:

     my $records = Calendar::Dates::Foo->get_entries($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. Entries are arrayref, where
    each entry is a DefHash. The following keys are recognized, an asterisk
    ("*") signifies required key (see DefHash for more details on each key):

    *   date*

        String. Either ISO8601 date in the format "YYYY-MM-DD" or
        "YYYY-MM-DD"T"HH:MM" or date interval in the format of
        "YYYY-MM-DD"T"HH:MM/HH:MM".

        Examples:

         2019-02-13
         2019-02-13T07:00
         2019-02-13T07:00/09:00

        Interval that spans day is currently not allowed. You might want to
        create separate entries for each day in the span.

        Timezones are not currently allowed. Dates are assumed in the local
        time zone.

    *   year*

        Integer. Year number (e.g. 2019).

    *   month*

        Integer. Month number (1-12).

    *   day*

        Integer. Day of month number (1-31).

    *   summary

        From DefHash specification. Should be in English. To specify summary
        in other language, use "summary.alt.lang.<LL>" keys.

    *   description

        From DefHash specification. Should be in English. To specify
        description in other language, use "description.alt.lang.<LL>" keys.

    *   tags

        From DefHash specification. Some recommended/known tags: tentative,
        holiday, religious.

    *   url

        URL.

    *   image_url

        URL.

    *   is_holiday

        Boolean. You can also use tag "holiday" to mark an entry as a
        holiday.

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Calendar-Dates>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-Calendar-Dates>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=Calendar-Dates>

    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.

SEE ALSO
    "Calendar::DatesUtils" namespace for modules that make use of
    "Calendar::Dates::*" modules, e.g. Calendar::DatesUtils::To::ICal.

    "Calendar::DatesRoles" namespace.

    App::CalendarDatesUtils which contain utilities like
    list-calendar-dates, etc.

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2019 by perlancar@cpan.org.

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