NAME

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

SYNOPSIS

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

  my $english_month_name =$english_locale->month_name($date);

DESCRIPTION

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

The month names come from Thomas Carlyle's book. Most of the feast names come from Alan Taylor's kokogiak.com web site, later checked with Wikipedia and with Jonathan Badger's French Revolutionary Calendar module written in Ruby. The day names are from this module's author.

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 an English translation for $date's month, where $date is a DateTime::Calendar::FrenchRevolutionary object.

• month_abbreviation ($date)

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

• day_name ($date)

  Returns an English translation for the day name.

• day_abbreviation ($date)

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

• feast_short ($date)

  Hopefully returns an adequate English translation for the plant, animal or tool that correspond to $date's feast.

  Note: in some cases, the feast French name is left untranslated, while in some other cases, the translation is inadequate. If you are fluent in both French and English, do not hesitate to send corrections to the author.

• feast_long ($date)

  Same as feast_short, with a "day" suffix, as in the current calendar's "groundhog day" or "Colombus day".

• 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 https://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

The French Revolution, Thomas Carlyle, Oxford University Press

Calendrier Militaire, anonymous

Internet

http://datetime.perl.org/

https://www.allhotelscalifornia.com/kokogiakcom/frc/default.asp

https://github.com/jhbadger/FrenchRevCal-ruby

https://en.wikipedia.org/wiki/French_Republican_Calendar

LICENSE STUFF

Copyright (c) 2003, 2004, 2010, 2012, 2014, 2016, 2019 Jean Forget. All rights reserved. This program is free software. You can distribute, adapt, 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 https://dev.perl.org/licenses/artistic.html and https://www.gnu.org/licenses/old-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 <https://www.gnu.org/licenses/> or write to the Free Software Foundation, Inc., https://www.fsf.org.

cpanm DateTime::Calendar::FrenchRevolutionary

perl -MCPAN -e shell
install DateTime::Calendar::FrenchRevolutionary