Difference between revisions of "Template:Dr/doc"

From blackwiki
Jump to navigation Jump to search
imported>GeneralNotability
(Add templatedata)
imported>John of Reading
m (Typo fixing, replaced: millenia → millennia (2))
Line 36: Line 36:
 
"1": {
 
"1": {
 
"label": "Input type",
 
"label": "Input type",
"description": "Specifies whether the input is interpreted as years (y), decades (d), centuries (c), or millenia (m)",
+
"description": "Specifies whether the input is interpreted as years (y), decades (d), centuries (c), or millennia (m)",
 
"type": "string",
 
"type": "string",
 
"required": true
 
"required": true
Line 42: Line 42:
 
"2": {
 
"2": {
 
"label": "Output type",
 
"label": "Output type",
"description": "Specifies whether the output should be in years (y), decades (d), centuries (c), or millenia (m)",
+
"description": "Specifies whether the output should be in years (y), decades (d), centuries (c), or millennia (m)",
 
"type": "string",
 
"type": "string",
 
"required": true
 
"required": true

Revision as of 19:34, 12 December 2019

Produces a year, decade, century or millennium for use in an infobox or navbox.

Usage

First parameter is y, d, c, m, depending on what is being input.

Second parameter is y, d, c, m, depending on what is to be output.

Third parameter is the input number. For example, 1 represents the year 1, the 10s, the 1st century or the 1st millennium (depending on the first parameter). For BC, make the number negative (for the decade 0s BC, use -0).

Fourth parameter is an offset from the output value. Notice that the output decade/century/millennium is the (first) decade/century/millennium of the input year/decade/century/millennium, but an output year is the second year of an input decade/century/millennium.

Fifth parameter contains style options. Normally the item is linked if it is within the range for which Wikipedia has articles (to configure that range, please edit {{dr-make}}). The following options are available:

  • y = always link
  • n = never link
  • t = never link, and no no-break spaces or other formatting (e.g. for use in category names)
  • s = small letters for BC (or AD if present)
  • a = use AD if not BC
  • ys, ysa, ya, ns, nsa, na, sa = permitted combinations of the above

Example: {{dr|c|d|-5|3|s}} produces 460s BC, i.e. first decade of the 5th century BC, offset by +3 decades.

Subtemplates


Produces a year, decade, century or millennium for use in an infobox or navbox.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Input type1

Specifies whether the input is interpreted as years (y), decades (d), centuries (c), or millennia (m)

Stringrequired
Output type2

Specifies whether the output should be in years (y), decades (d), centuries (c), or millennia (m)

Stringrequired
Input number3

Starting year, century, etc. Negative values are interpreted as BC.

Numberrequired
Offset4

Offset of the output value from the input value, interpreted as the output type

Numberrequired
Style options5

Flags to select the output style. Possible options are "always link" (y), "never link" (n), "never link and no formatting" (t), "small letters for BC/AD" (s), "use AD if not BC" (a). These may be combined, but y, n, and t are mutually exclusive.

Stringsuggested