Help language development. Donate to The Perl Foundation
Date::Names zef:tbrowder last updated on 2023-07-11
Date::Names
Module Date::Names - Provides month and weekday names for numbers (multilingual)
This is Version 2 with significant differences and more features compared to Version 1:
Changes:
language-specific data set hashes have changed to arrays
no symbols are exported; direct access is available, but not recommended—use the new class instead
@langrenamed to@langsadded class Date::Names for primary data access
SYNOPSIS
use Date::Names;
# choose the German language (English is the default)
my $d = Date::Names.new: :lang<de>;
# default is to show full names
say $d.dow(3); # OUTPUT: «Mittwoch»
say $d.mon(3); # OUTPUT: «März»
# what abbreviations are available?
$d.sets; # OUTPUT: «name sets with values: dow dow2 mon mon3»
# choose the desired sets
$d = Date::Names.new: :lang<de>, :mset<mon3>, :dset<dow2>;
say $d.dow(4); # OUTPUT: «Do»
say $d.mon(4); # OUTPUT: «Apr»
# arbitrarily truncate a word
say $d.mon(8,2); # OUTPUT: «Au»
# given a name, return the number of month of year or day of week
say $d.mon2num('März'); # OUTPUT: «3»
say $d.dow2num('Mittwoch'); # OUTPUT: «3»
DESCRIPTION
Module Date::Names provides the full name of months and days of the week for the numbers 1..12 and 1..7, respectively, primarily for use with Raku's date functions.
Full names of the months and weekdays are currently available in the following twelve languages:
Table 1. Language ISO codes (lower-case)
| Language | ISO code |
|---|---|
| Dutch | nl |
| English | en |
| French | fr |
| German | de |
| Indonesian | id |
| Italian | it |
| Norwegian (Bokmål) | nb |
| Norwegian (Nynorsk) | nn |
| Polish | pl |
| Romanian | ro |
| Russian | ru |
| Spanish | es |
| Ukranian | uk |
CAPITALIZATION and PUNCTUATION
All English month and weekday names are always capitalized. Other languages vary in capitalization depending on where the word or abbreviation is used or other factors. The names and abbreviations herein are in the most common form, but the user can always explicitly set the case by applying the Raku routines tclc, uc, or lc to the name or abbreviation.
Some of the abbreviations include an ending period since that is customary use in some languages (e.g., French).
LIMITATIONS
Not all languages have a complete set of two- and three-letter abbreviations, and some require up to four letters for the official abbreviations.
Table 2 shows the array names for the full names and abbreviations currently available. Array names with a 2 or 3 appended are complete abbreviation sets of that length only. Array names with an 'a' appended are sets of abbreviations of mixed length. A 'Y' in a cell indicates a language has a complete set of that type of abbreviation.
Note that in some countries the term "abbreviation" is distinctly different than "code" as it applies to date names. An asterisk in a cell marks those which are technically codes rather than abbreviations. Table 3 shows the meaning of other codes used in the Table 2 cells.
The array names in Table 2 (without a sigil) are the ones to be used for the day and month array names for the Date::Names class constructor.
Table 2. Name array availability by language
| Language / Array | mon | dow | mon3 | dow3 | mon2 | dow2 | mona | dowa |
|---|---|---|---|---|---|---|---|---|
| Dutch | Y | Y | Y | Y | Y | |||
| English | Y | Y | Y | Y | Y | |||
| French | Y | Y | Y | Y* | Y | Y | ||
| German | Y | Y | Y | Y | Y | |||
| Indonesian | Y | Y | Y | Y | ||||
| Italian | Y | Y | ||||||
| Norwegian (Bokmål) | Y | Y | Y | Y | Y | |||
| Norwegian (Nynorsk) | Y | Y | Y | Y | Y | |||
| Polish | Y | Y | Y | Y | ||||
| Romanian | Y | Y | Y | Y | Y | |||
| Russian | Y | Y | Y | Y | ||||
| Spanish | Y | Y | Y* | Y* | Y | Y | ||
| Ukranian | Y | Y | Y | Y | Y | P |
Table 3. Name array cell codes and meaning
| Code | Meaning |
|---|---|
| * | code rather than an abbreviation |
| L | array values are lower-case |
| M | array values are mixed-case |
| P | array values have a trailing period |
| T | array values are title-case |
| U | array values are upper-case |
| Y | language has this array |
Note that when the Date::Names class is fully implemented in Version 3, the user will be able to specify desired array table attributes for his or her tastes (case, trailing period, truncation or padding);
Methods to see what is available
(See All-SETS for the complete list for all languages.)
use Date::Names
my $dn = Date::Names.new: :lang<nl>;
# how many non-empty data sets?
say $dn.nsets; # OUTPUT: «5»
# show the sets:
$dn.sets; # OUTPUT: «name sets with values: dow dow2 dow3 mon mon3»
# show all sets in all available languages
$dn.show-all; # OUTPUT: see ALL-SETS.md)
New features:
English language default
Default month and weekday array choices
User chooses which month and weekday array to use
Methods for entering a valid abbreviation of weekday or month name and returning its number
Graceful messages if a desired array is empty [version 2+]
Planned features:
User chooses truncation or padding [API complete, needs tests]
User chooses case of the output names [API complete, needs tests]
User can choose to have a period or not for abbreviations [API complete, needs tests]
User can choose raw truncation on a full name, if permitted by the language [API partially complete]
Possible future features
Language-specific attributes to affect class behavior (e.g., allow raw truncation or not)
Add additional array names and types on a language basis automatically via a separate Common Locale Data Repository (CLDR) date module
Features desired by users
The basic class is working (see New features and Planned features above) and is will be able to control casing, absence or presence of periods on abbreviations, and truncation or padding as desired.
VERSION 3
A CLDR module which can produce compatible language data for this module will be available.
Additionally, the CLDR date data set names will be mapped to the current names where possible, and some short set names added if necessary.
All CLDR data set names will also be available as aliases or native arrays.
The Date::Names class API will be fixed and all currently planned features will be fully implemented and tested.
PULL REQUESTS
Native language speakers please submit PRs to (1) complete the existing language abbreviations, (2), correct errors, and (3) provide more languages. See the docs/CONTRIBUTING file for details.
CORRECTIONS and SUGGESTIONS
The goal of this module is to be useful to non-English users as well as English users. The author welcomes suggestions for improvement and increased utility.
ACKNOWLEDGEMENTS
The following persons contributed to this project via PRs and comments (@name is an alias on IRC #raku):
Moritz Lenz (@moritz, github: moritz) - German and Norwegian Bokmﾃ･l data
@sena_kun (github: Altai-man) - Russian data
Luc St-Louis (@lucs, github: lucs) - French data
Luis F. Uceta (github: uzluisf) - Spanish data
Elizabeth Mattijsen (@lizmat, github: lizmat) - Dutch data
github: heince - Indonesian data
github: tzjan - Polish data
Eskild Hustvedt (@Zero_Dogg, github: zerodogg) - Norwegian Nynorsk data
github: altblue - Romanian data
Andrij Mizyk (github: andmizyk) - Ukranian data
I am grateful for their help!
REFERENCES
[ES] http://www.wikilengua.org/index.php/Abreviaciones_en_fechas
[ES] http://lema.rae.es/dpd/srv/search?id=fKODyKTfZD6s0mX7bz
AUTHOR
Tom Browder, [email protected]
COPYRIGHT and LICENSE
Copyright © 2019-2022 Tom Browder
This program is free software; you may redistribute or modify it under the same terms as Raku itself.