/ 
DateTime-Calendar-FrenchRevolutionary-0.13
River stage one • 1 direct dependent • 1 total dependent
/ DateTime::Calendar::FrenchRevolutionary::Locale::fr

NAME

DateTime::Calendar::FrenchRevolutionary::Locale::fr -- French localization for the French revolutionary calendar.

SYNOPSIS

use DateTime::Calendar::FrenchRevolutionary::Locale;
my $french_locale = DateTime::Calendar::FrenchRevolutionary::Locale->load('fr');

my $french_month_name =$french_locale->month_name($date);

DESCRIPTION

This module provides localization for DateTime::Calendar::FrenchRevolutionary. Usually, its methods will be invoked only from DT::C::FR.

USAGE

This module provides the following class methods:

  • new

    Returns an object instance, which is just a convenient value to be stored in a variable.

    Contrary to the widely used Gregorian calendar, there is no need to customize a French Revolutionary calendar locale. Therefore, there are no instance data and no instance methods.

  • month_name ($date)

    Returns the French name for $date's month, where $date is a DateTime::Calendar::FrenchRevolutionary object.

  • month_abbreviation ($date)

    Returns a 3-letter abbreviation for the French month name.

  • day_name ($date)

    Returns the French day name.

  • day_abbreviation ($date)

    Returns a 3-letter abbreviation for the French day name.

  • feast_short ($date)

    Returns the name for the plant, animal or tool that correspond to $date's feast.

  • feast_long ($date)

    Same as feast_short, with a "jour" prefix.

  • feast_caps ($date)

    Same as feast_long with capitalized first letters.

  • on_date ($date)

    Gives a small text about the events which occurred the same month and day as $date between the calendar's epoch (22 Sep 1792) and the day it was rescinded (31 Dec 1805).

    Most of these events come from an anonymous propaganda book published in year VIII (1799--1800). The others are common knowledge available in any French History book or any encyclopedia.

SUPPORT

Support for this module is provided via the datetime@perl.org email list. See http://lists.perl.org/ for more details.

AUTHOR

Jean Forget <JFORGET@cpan.org>

The development of this module is hosted by Les Mongueurs de Perl, http://www.mongueurs.net/.

SEE ALSO

Books

Calendrier Militaire, anonymous

Internet

http://datetime.perl.org/

LICENSE STUFF

Copyright (c) 2003, 2004, 2010, 2012, 2014, 2016 Jean Forget. All rights reserved. This program is free software. You can distribute, modify, and otherwise mangle DateTime::Calendar::FrenchRevolutionary under the same terms as perl 5.16.3.

This program is distributed under the same terms as Perl 5.16.3: GNU Public License version 1 or later and Perl Artistic License

You can find the text of the licenses in the LICENSE file or at http://www.perlfoundation.org/artistic_license_1_0 and http://www.gnu.org/licenses/gpl-1.0.html.

Here is the summary of GPL:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, see <http://www.gnu.org/licenses/> or write to the Free Software Foundation, Inc., http://fsf.org.