Module:British regnal year/doc
This is the documentation page for Module:British regnal year
| 40x40px | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module implements the {{British regnal year}} template. It converts a year in the Gregorian calendar into a British regnal year.
Syntax
{{#invoke:British regnal year|main|<year in Gregorian calendar>}}
Example
{{British regnal year|1952}} → 16 Geo. 6 – 1 Eliz. 2
How it works
The data for the module is stored in a table at Module:British regnal year/data. The module looks through the data list from newest to oldest, and returns the data for the first result where the input year is greater than or equal to the year value. It calculates the regnal year based on the input year, the value of year, and the value of startYear. For most years it calculates the previous regnal year by subtracting one from the input year, but if the input year is equal to the value of year, the module uses the prevEndYear value and gets the link from linkPrev instead. A note can be added at the end of any entry by using the note field.
Data fields
The data table entries are organised as follows:
year- the year that the template searches for when deciding what links to display. In most cases this is the year that the monarch's reign began, although it can be different if the history is complicated.linkCurrent- a wikilink to the current monarch's Wikipedia article.startYear- the regnal year of theyearvalue for the current monarch. If this is the monarch's first year on the throne, this is1; if it is their second year, this is2, and so on.linkPrev- a wikilink to the Wikipedia article of the previous monarch.prevEndYear- the regnal year of theyearvalue for the previous monarch.note- a short note about the years for this time period. This is displayed after the other content.