Editing Module:British regnal year/doc

{{module rating|beta}}

This module implements the {{tl|British regnal year}} template. It converts a year in the Gregorian calendar into a British [[regnal year]].

=== Syntax ===
<nowiki>{{</nowiki><code>#invoke:British regnal year|main|</code><span style="color:gray;">''<year in Gregorian calendar>''</span><code><nowiki>}}</nowiki></code>

=== Example ===
<nowiki>{{</nowiki><code>British regnal year|1952</code><nowiki>}}</nowiki> → {{British regnal year|1952}}

=== Data ===

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 <code>year</code> value. The data table entries are organised as follows:
* <code>year</code> - 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.
* <code>linkCurrent</code> - a wikilink to the current monarch's Wikipedia article.
* <code>startYear</code> - the regnal year of the <code>year</code> value for the current monarch. If this is the monarch's first year on the throne, this is <code>1</code>; if it is their second year, this is <code>2</code>, and so on.
* <code>linkPrev</code> - a wikilink to the Wikipedia article of the previous monarch.
* <code>prevEndYear</code> - the regnal year of the <code>year</code> value for the previous monarch.
* <code>note</code> - a short note about the years for this time period. This is displayed after the other content.

=== See also ===

* {{tl|year in other calendars}}
<noinclude>
[[Category:Module documentation pages]]
</noinclude>