Module:Japanese calendar/doc
This is the documentation page for Module:Japanese calendar
This module is used to calculate dates in the Japanese calendar. It defines an "era" class which is designed to be called from other Lua modules, and it also contains several functions to export Japanese calendar data directly to Wikipedia pages through #invoke.
Usage
Through #invoke
{{#invoke:Japanese calendar|function_name|year=year|era=article name or kanji|previous=yes|next=yes}}
The function name specifies how the data should be outputted. The year
and era
parameters determine what era and year the module outputs. The next
and previous
parameters tell the module to return data for the next or previous era, rather than the one specified. If a combination of parameters is invalid the module will usually output nothing. However, if both the next
and previous
parameters are specified it will output an error.
- Year and era
The year
parameter is the year in the Gregorian calendar. The era
parameter can either be the article name for that era, or the era's name in kanji. (Transcribed English era names can usually be used, but will not work if they are ambiguous.) Either year
or era
must be specified. If both are specified, the module defaults to using era
to get the era data. This enables output of the last year of the previous era (for example, Shōwa 64 is the same year as Heisei 1).
Code | Output |
---|---|
{{#invoke:Japanese calendar|link|year=1950}} |
Shōwa |
{{#invoke:Japanese calendar|link|era=Shōwa period}} |
Shōwa |
{{#invoke:Japanese calendar|link|era=昭和}} |
Shōwa |
{{#invoke:Japanese calendar|link|era=Shōwa}} |
|
{{#invoke:Japanese calendar|link_year|year=1989}} |
Heisei 1 |
{{#invoke:Japanese calendar|link_year|year=1989|era=Shōwa period}} |
Shōwa 64 |
{{#invoke:Japanese calendar|link_year|year=1990}} |
Heisei 2 |
{{#invoke:Japanese calendar|link_year|year=1990|era=Shōwa period}} |
- Functions
Code | Description | Example |
---|---|---|
baseyear |
The first year of the specified era. | {{#invoke:Japanese calendar|baseyear|era=Heisei}} →
|
endyear |
The last year of the specified era. | {{#invoke:Japanese calendar|endyear|era=Shōwa period}} → 1989
|
year |
The year for the specified era, without the era name. Defaults to the newer era, if more than one is applicable. | {{#invoke:Japanese calendar|year|year=1989}} → 1
|
kanjiyear |
The same as year , but in kanji. The first year of an era is changed to the kanji 元, and the others are changed to full-width numbers. |
{{#invoke:Japanese calendar|kanjiyear|year=1989}} → 元
|
article |
The Wikipedia article for the era, unlinked. | {{#invoke:Japanese calendar|article|year=1950}} → Shōwa period
|
label |
The name of the era. Same as article for undisambiguated titles. |
{{#invoke:Japanese calendar|label|year=1950}} → Shōwa
|
link |
A link to the Wikipedia article of the specified era. | {{#invoke:Japanese calendar|link|year=1950}} → Shōwa
|
kanji |
The kanji for the specified era. | {{#invoke:Japanese calendar|kanji|year=1950}} → 昭和
|
label_year |
label followed by year |
{{#invoke:Japanese calendar|label_year|year=1989}} → Heisei 1
|
link_year |
link followed by year |
{{#invoke:Japanese calendar|link_year|year=1989}} → Heisei 1
|
label_kanjiyear |
label followed by kanjiyear |
{{#invoke:Japanese calendar|label_kanjiyear|year=1989}} → Heisei 元
|
link_kanjiyear |
link followed by kanjiyear |
{{#invoke:Japanese calendar|link_kanjiyear|year=1989}} → Heisei 元
|
- Next, previous and old
If the next
parameter is specified, the module outputs the data for the subsequent era; if the previous
parameter is specified it outputs the data for the previous one. If the old
parameter is specified, the module outputs the data for the "old" era. This is the same as the current era unless the year is set to the first year of the specified era. If this is the case, then old
outputs the data for the previous era. However, if the module could not find a valid previous era then the data for the current era is returned.
Code | Output |
---|---|
{{#invoke:Japanese calendar|baseyear|era=Shōwa period}} |
1926 |
{{#invoke:Japanese calendar|baseyear|era=Shōwa period|next=yes}} |
1989 |
{{#invoke:Japanese calendar|baseyear|era=Shōwa period|previous=yes}} |
1912 |
{{#invoke:Japanese calendar|baseyear|era=Shōwa period|old=yes}} |
1926 |
{{#invoke:Japanese calendar|link|year=1880}} |
Meiji |
{{#invoke:Japanese calendar|link|year=1880|next=yes}} |
Taishō |
{{#invoke:Japanese calendar|link|year=1880|previous=yes}} |
Keiō |
{{#invoke:Japanese calendar|link|year=1880|old=yes}} |
Meiji |
{{#invoke:Japanese calendar|link_year|year=1926}} |
Shōwa 1 |
{{#invoke:Japanese calendar|link_year|year=1926|old=yes}} |
Taishō 15 |
{{#invoke:Japanese calendar|link_year|year=1927}} |
Shōwa 2 |
{{#invoke:Japanese calendar|link_year|year=1927|old=yes}} |
Shōwa 2 |
From another Lua module
First of all, the era class must be loaded, like this:
local era = require( 'Module:Japanese calendar' ).era
Once the class is loaded, you can make a new era object using era:new()
:
local myEra = era:new{ year = year, era = article name or kanji }
Either year
or era
must be specified. It is also possible to use an index
field, corresponding to the index of Module:Japanese calendar/data, but this is for internal use only and will change as new eras are added.
- Properties
Era objects have a number of properties. Their values might be nil
if the module did not have enough information to process them, or the values could be false
if they correspond to an invalid era. You can specify properties with the dot syntax:
local article = myEra.article
The properties are as follows:
gregorianYear
: the year in the Gregorian calendar. Same as the input year.startYear
: the first year of the specified era.endYear
: the last year of the specified era.eraYear
: the year of the specified era, without the era name.eraYearKanji
: a string representing the era year in kanji. The first year of an era is changed to the kanji 元, and the others are changed to full-width numbers. Note: even though the output may often look like a number, it will always be a string value.article
: the Wikipedia article for the era, unlinked.label
: the name of the era. Same asarticle
unless the article title is disambiguated.kanji
: the name of the era in kanji.
- Methods
Era objects have three methods. Methods can be specified with the colon syntax:
local nextEra = myEra:getNextEra()
The methods are as follows:
era:getNextEra()
- gets the era object for the next era. Returnsnil
if it doesn't exist.era:getPreviousEra()
- gets the era object for the previous era. Returnsnil
if it doesn't exist.era:getOldEra()
- gets the era object for the "old" era. This is the same as the current era object unless eraYear equals 1. If eraYear equals 1 then this returns the era object for the previous era. If the module could not find a valid previous era object then the current era object is returned.