Difference between revisions of "Template:Floruit/sandbox"
(More doc, etc.) |
(Sync soon.) |
||
| Line 10: | Line 10: | ||
===Structure=== | ===Structure=== | ||
| − | For presentation purposes only, in the box below [brackets] indicate parameter values; variables are {{em|italicized}}; explanatory text is in (parentheses). | + | For presentation purposes only, in the box below [brackets] indicate parameter values; variables are {{italics correction|{{em|italicized}}}}; explanatory text is in (parentheses). |
{{csdoc|usage full}} | {{csdoc|usage full}} | ||
:<code><nowiki>{{floruit/sandbox|date= (or) </nowiki>[{{var|date-value}}]<nowiki>|date2= (or) </nowiki>[{{var|end-date-value}}]<nowiki>|b= |ca= |pfx1= |pfx2= |unit= |sfx= |sfx-lk= |sortable= |wrap= }}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date= (or) </nowiki>[{{var|date-value}}]<nowiki>|date2= (or) </nowiki>[{{var|end-date-value}}]<nowiki>|b= |ca= |pfx1= |pfx2= |unit= |sfx= |sfx-lk= |sortable= |wrap= }}</nowiki></code> | ||
| Line 27: | Line 27: | ||
==Parameters== | ==Parameters== | ||
| − | All parameters are optional. | + | All parameters are optional. Use of parameters {{bxt|date}}, and (additionally, for date ranges) {{bxt|date2}}, is suggested; either or both of these parameters may be required by other options. Incorrect parameter values will be flagged under almost all usage scenarios (see {{slink||Error messages}}).<br/> |
Parameter names are in {{bxtn|bold}} below, for presentation only. | Parameter names are in {{bxtn|bold}} below, for presentation only. | ||
===Date formatting parameters=== | ===Date formatting parameters=== | ||
Suggested: | Suggested: | ||
| − | *{{bxtn|date}} or {{bxtn|[1]}} (stand-alone date, or start date for range){{spnd}} the time period (or the start date of a time period) during which the subject is known to have been active or popular. Values may be in any relevant date unit. You may also use this parameter as a free-form field, for stand-alone dates or for date ranges; such ranges must be separated by a [[spaced en dash]] where applicable ([[WP:APPROXDATE]]). | + | *{{bxtn|date}} or {{bxtn|[1]}} (stand-alone date, or start date for range){{spnd}} the time period (or the start date of a time period) during which the subject is known to have been active or popular. Values may be in any relevant date unit. You may also use this parameter as a free-form field, for stand-alone dates or for date ranges; such ranges must be separated by a [[spaced en dash]] where applicable ([[WP:APPROXDATE]]). For time periods not delimited with start and end dates (such as "1990s" or "21st century") use this parameter only; in ranges with start and end dates, the additional parameter {{bxt|date2}} [[#rng|below]] may be used and is recommended. Apply any of Wikipedia's [[MOS:DATEFORMAT|acceptable date formats]], but please follow the relevant format established in the article, if any. Depending on the date prefix used (parameter {{bxt|pfx2}} [[#pre2|below]]), the value of {{bxt|date}} may be preceded by a [[narrow no-break space]], or by a [[no-break space]]. A value for this parameter {{em|may be required by other options}}. |
:{{em|id=unnamed|Note:}} You may treat {{bxt|date}} as an unnamed parameter, and insert only its desired value. | :{{em|id=unnamed|Note:}} You may treat {{bxt|date}} as an unnamed parameter, and insert only its desired value. | ||
| − | :{{em|id=space|Note:}} | + | :{{em|id=space|Note:}} Template display does not include trailing [[whitespace character]](s); when {{bxt|date}} is not utilized, displayed output may vary according to user formatting. |
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#dec|{{em|here}}]] {{em|(named and unnamed) and}} [[#plain|{{em|here}}]] {{em|(not used)}} | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#dec|{{em|here}}]] {{em|(named and unnamed) and}} [[#plain|{{em|here}}]] {{em|(not used)}} | ||
| − | *{{anchor|rng}}{{bxtn|date2}} or {{bxtn|[2]}} (end date for range){{spnd}} used to format date ranges delimited with start and end dates; this parameter is recommended when depicting such ranges. {{em|Requires}} a start date for the range | + | *{{anchor|rng}}{{bxtn|date2}} or {{bxtn|[2]}} (end date for range){{spnd}} used to format date ranges delimited with start and end dates; this parameter is recommended when depicting such ranges. {{em|Requires}} a start date for the range via parameter {{bxt|date}}. A [[spaced en dash]] is used as the range separator. A value for this parameter {{em|may be required by other options}}. |
:{{em|id=unnamed2|Note:}} You may treat {{bxt|date2}} as an unnamed parameter, and insert only its desired value. | :{{em|id=unnamed2|Note:}} You may treat {{bxt|date2}} as an unnamed parameter, and insert only its desired value. | ||
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#brc|{{em|here}}]] {{em|(named and unnamed)}} | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#brc|{{em|here}}]] {{em|(named and unnamed)}} | ||
Optional: | Optional: | ||
| − | *{{bxtn|ca}} (circa){{spnd}} use for [[circa]] dates; the additional prefix "c.", preceded by a narrow no-break space, is inserted before the relevant date(s) ( c.) | + | *{{bxtn|ca}} (circa){{spnd}} use for [[circa]] dates; the additional prefix "c.", preceded by a narrow no-break space, is inserted before the relevant date(s) ( c.). |
| − | **set {{para|ca|yes}} or {{para|ca|date}} to apply circa independently of any parameter; or to apply to just parameter {{bxt|date}} when used as a stand-alone (or free-form) date | + | **set {{para|ca|yes}} or {{para|ca|date}} to apply circa independently of any parameter; or to apply to just parameter {{bxt|date}} when used as a stand-alone (or free-form) date; or, when {{bxt|date}} is used as the start date for a formatted range |
| − | **set {{para|ca|date2}} in formatted ranges only; applies to the end date ( | + | **set {{para|ca|date2}} in formatted ranges {{italics correction|{{em|only}}}}; applies to the end date (parameter {{bxt|date2}}) |
| − | **set {{para|ca|both}} in formatted ranges as above, but applies to both start and end date ( | + | **set {{para|ca|both}} in formatted ranges {{em|only}}, as above, but applies to both start and end date (parameters {{bxt|date}} and {{bxt|date2}}) |
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#ca1|here]] {{em|(stand-alone date and range start date)}}, [[#ca2|here]] {{em|(range end date), and}} [[#ca12|here]] {{em|(start and end date)}} | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#ca1|here]] {{em|(stand-alone date and range start date)}}, [[#ca2|here]] {{em|(range end date), and}} [[#ca12|here]] {{em|(start and end date)}} | ||
Conditional ({{em|requires a value for parameter}} {{bxt|date}}): | Conditional ({{em|requires a value for parameter}} {{bxt|date}}): | ||
| − | *{{bxtn|sortable}}{{spnd}} set {{para|sortable|yes}} to format the value for parameter {{bxt|date}} so that it is displayed properly within [[WP:TABLESORT|sortable table]]s; it works {{em|only}} with dates that conform to Wikipedia's [[MOS:DATEFORMAT|acceptable date formats]].{{efn|name=dts}} | + | *{{bxtn|sortable}}{{spnd}} set {{para|sortable|yes}} to format the value for parameter {{bxt|date}} so that it is displayed properly within [[WP:TABLESORT|sortable table]]s; it works correctly {{em|only}} with dates that conform to Wikipedia's [[MOS:DATEFORMAT|acceptable date formats]].{{efn|name=dts}} |
:{{em|id=sorted|Note:}} When using {{bxt|sortable}}, year values less than 1000 require leading zeroes up to the century digit, e.g. "050". Era suffixes (via parameter {{bxt|sfx}} [[#suf|below]]) are ignored. | :{{em|id=sorted|Note:}} When using {{bxt|sortable}}, year values less than 1000 require leading zeroes up to the century digit, e.g. "050". Era suffixes (via parameter {{bxt|sfx}} [[#suf|below]]) are ignored. | ||
| − | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]] | + | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]] ({{em|displays additional options}}) |
===Prefix formatting parameters=== | ===Prefix formatting parameters=== | ||
Optional: | Optional: | ||
*{{bxtn|pfx1}} (prefix style){{spnd}} use this parameter to {{em|italicize}} the display of the prefix, by setting {{para|pfx1|italics}}. | *{{bxtn|pfx1}} (prefix style){{spnd}} use this parameter to {{em|italicize}} the display of the prefix, by setting {{para|pfx1|italics}}. | ||
| − | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]] | + | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]] ({{em|displays additional options}}) |
| − | *{{anchor|pre2}}{{bxtn|pfx2}} (prefix link){{spnd}} alias {{bxtn|lk}}. The abbreviation "fl." wikilinked to ''[[floruit]]'' and followed by a narrow no-break space is used as the default prefix; use this parameter to change the default by inserting one of the following values: | + | *{{anchor|pre2}}{{bxtn|pfx2}} (prefix link){{spnd}} alias {{bxtn|lk}}. The abbreviation "fl.", wikilinked to ''[[floruit]]'' and followed by a narrow no-break space, is used as the default prefix; use this parameter to change the default by inserting one of the following values: |
**set {{para|pfx2|abbr}} to display a [[tooltip]] when the pointer hovers over "fl.", expanding it to "floruit"; tooltip display may depend on browser and/or operating system version | **set {{para|pfx2|abbr}} to display a [[tooltip]] when the pointer hovers over "fl.", expanding it to "floruit"; tooltip display may depend on browser and/or operating system version | ||
**set {{para|pfx2|no}} or {{para|pfx2|off}} to display "fl." in plain text; use to avoid [[WP:Overlinking|overlinking]] when this template is used repeatedly in the body of an article ({{slink|Wikipedia:Manual of Style/Abbreviations|Miscellaneous shortenings}}) | **set {{para|pfx2|no}} or {{para|pfx2|off}} to display "fl." in plain text; use to avoid [[WP:Overlinking|overlinking]] when this template is used repeatedly in the body of an article ({{slink|Wikipedia:Manual of Style/Abbreviations|Miscellaneous shortenings}}) | ||
| − | **set {{para|pfx2|active}} to replace "fl." with "active" | + | **set {{para|pfx2|active}} to replace "fl." with "active", wikilinked to ''[[floruit]]'' and followed by a no-break space; recommended when referring to persons with known occupations |
| − | **set {{para|pfx2|active-no}} or {{para|pfx2|active-off}} to use "active" as above, but in plain text | + | **set {{para|pfx2|active-no}} or {{para|pfx2|active-off}} to use "active" as above, but to display it in plain text |
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#ttip|{{em|here}}]] {{em|(tooltip)}}, [[#plain|{{em|here}}]] {{em|(plain text), and}} [[#act|{{em|here}}]] {{em|("active")}} | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#ttip|{{em|here}}]] {{em|(tooltip)}}, [[#plain|{{em|here}}]] {{em|(plain text), and}} [[#act|{{em|here}}]] {{em|("active")}} | ||
| − | === | + | ===Suffix formatting parameters=== |
Conditional ({{em|require a value for parameter}} {{bxt|date}}; {{em|may require a value for parameter}} {{bxt|date2}}): | Conditional ({{em|require a value for parameter}} {{bxt|date}}; {{em|may require a value for parameter}} {{bxt|date2}}): | ||
| − | + | *{{anchor|suf}}{{bxtn|sfx}} (suffix){{spnd}} use this parameter to add an era suffix preceded by a no-break space to the floruit date or range. Displays in plain text, but you may use the dependent parameter {{bxt|sfx-lk}} (see [[#suflink|below]]) to display with an appropriate wikilink. The available options conform to the [[MOS:ERA|default calendar era]]. If parameter {{bxt|unit}} is specified, the suffix follows the unit value. When using this with formatted ranges (see parameter {{bxt|date2}}) the value applies to the end date only, {{em|except}} when the date range straddles eras. | |
| − | + | **set {{para|sfx|ad}} to display the suffix AD ([[Anno Domini]]) after parameter {{bxt|date}} when used as a stand-alone (or free-form) date; or, in formatted ranges, after the end date (parameter {{bxt|date2}}) | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | *{{anchor|suf}}{{bxtn|sfx}} (suffix){{spnd}} use this parameter to add an era suffix preceded by a no-break space to the floruit date or range. Displays in plain text, but you may use the dependent parameter {{bxt|sfx-lk}} (see [[#suflink|below]]) to display with an appropriate wikilink. The available options conform to the [[MOS:ERA|default calendar era]]. If parameter {{bxt|unit}} is specified, the suffix follows the unit value. When using formatted ranges (see parameter {{bxt|date2}}) the value applies to the end date, {{em|except}} when the date range straddles eras. | ||
| − | **set {{para|sfx|ad}} to display the suffix AD ([[Anno Domini]]) after parameter {{bxt|date}} when used as a stand-alone (or free-form) date; or, in formatted ranges, after the end date parameter | ||
**set {{para|sfx|bc}} as above, but displays the suffix BC ([[Anno Domini|Before Christ]]) | **set {{para|sfx|bc}} as above, but displays the suffix BC ([[Anno Domini|Before Christ]]) | ||
**set {{para|sfx|bce}} as above, but displays the suffix BCE ([[Common Era|Before Common Era]]) | **set {{para|sfx|bce}} as above, but displays the suffix BCE ([[Common Era|Before Common Era]]) | ||
**set {{para|sfx|ce}} as above, but displays the suffix CE ([[Common Era]]) | **set {{para|sfx|ce}} as above, but displays the suffix CE ([[Common Era]]) | ||
| − | **set {{para|sfx|b-a}} in formatted ranges only, | + | **set {{para|sfx|b-a}} in formatted ranges {{em|only}}, to denote they straddle eras; displays BC after the start date (parameter {{bxt|date}}) and AD after the end date (parameter {{bxt|date2}}) |
| − | **set {{para|sfx|b-c}} in formatted ranges as above, but displays BCE after the start date and CE after the end date | + | **set {{para|sfx|b-c}} in formatted ranges {{em|only}}, as above, but displays BCE after the start date and CE after the end date |
| − | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#suf1|{{em|here}}]] {{em|( | + | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#suf1|{{em|here}}]] {{em|(free-form range)}}, [[#suf2|{{em|here}}]] {{em|(range end date), and}} [[#suf12|{{em|here}}]] {{em|(start and end date straddle eras)}} |
*{{anchor|suflink}}{{bxtn|sfx-lk}} (suffix link){{spnd}} use to wikilink the suffix to the appropriate page, by setting {{para|sfx-lk|yes}};{{efn|name=noerr|Any other value is ignored silently.}} parameter {{bxt|sfx}} is {{em|required}}. | *{{anchor|suflink}}{{bxtn|sfx-lk}} (suffix link){{spnd}} use to wikilink the suffix to the appropriate page, by setting {{para|sfx-lk|yes}};{{efn|name=noerr|Any other value is ignored silently.}} parameter {{bxt|sfx}} is {{em|required}}. | ||
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#suf-lk|{{em|here}}]] | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#suf-lk|{{em|here}}]] | ||
| + | |||
| + | ===Other parameters=== | ||
| + | Conditional ({{em|require a value for parameter}} {{bxt|date}}; {{em|may require a value for parameter}} {{bxt|date2}}): | ||
| + | *{{bxtn|b}} (brackets){{spnd}} use {{bxt|b}} to display the template's output in parentheses, by setting {{para|b|yes}}. | ||
| + | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#brc|{{em|here}}]] | ||
| + | *{{bxtn|unit}} (date unit){{spnd}} use this parameter to specify a date unit for the floruit date or range, preceded by a no-break space. When using this with formatted ranges (see parameter {{bxt|date2}}), the value applies to the end date, or to both start and end date. | ||
| + | **set {{para|unit|c}} to add "century" after parameter {{bxt|date}} when it is a stand-alone (or free-form) date; or, in formatted ranges, after the end date (parameter {{bxt|date2}}) | ||
| + | **set {{para|unit|m}} as above, but adds "millennium" instead | ||
| + | **set {{para|unit|c-c}} in formatted ranges {{italics correction|{{em|only}}}}; adds "century" after both the start and the end date ({{bxt|date}} and {{bxt|date2}}) | ||
| + | **set {{para|unit|m-m}} in formatted ranges {{em|only}}, as above, but adds "millennium" instead | ||
| + | :{{en dash}}{{nbsp}}{{em|for examples see}} [[#du1|{{em|here}}]] {{em|(stand-alone date)}}, [[#ca2|{{em|here}}]] {{em|(range end date), and}} [[#du12|{{em|here}}]] {{em|(start and end date)}} | ||
Optional: | Optional: | ||
*{{bxtn|wrap}} (word wrap){{spnd}} by default, template output displays without word wrapping; to turn word wrap on, set {{para|wrap|yes}}. | *{{bxtn|wrap}} (word wrap){{spnd}} by default, template output displays without word wrapping; to turn word wrap on, set {{para|wrap|yes}}. | ||
| Line 86: | Line 89: | ||
==Examples== | ==Examples== | ||
| − | *{{anchor|dec}}{{strong|Decade range, | + | *{{anchor|dec}}{{strong|Decade range, non-delimited}} |
:<code><nowiki>{{floruit/sandbox|date=2000s}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date=2000s}}</nowiki></code> | ||
:or | :or | ||
| Line 96: | Line 99: | ||
:<code><nowiki>{{floruit/sandbox|2000|2010|b=yes}}</nowiki></code> ([[#unnamed2|{{em|note}}]]) | :<code><nowiki>{{floruit/sandbox|2000|2010|b=yes}}</nowiki></code> ([[#unnamed2|{{em|note}}]]) | ||
:Either generates: {{floruit/sandbox|2000|2010|b=yes}} | :Either generates: {{floruit/sandbox|2000|2010|b=yes}} | ||
| − | *{{anchor|ca1}}{{strong|Circa | + | *{{anchor|ca1}}{{strong|Circa non-delimited decade range, and circa start date for formatted decade range}} |
:<code><nowiki>{{floruit/sandbox|date=2000s|ca=yes}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date=2000s|ca=yes}}</nowiki></code> | ||
:Generates: {{floruit/sandbox|date=2000s|ca=yes}} | :Generates: {{floruit/sandbox|date=2000s|ca=yes}} | ||
| − | : | + | :and |
:<code><nowiki>{{floruit/sandbox|2000|2010|ca=date}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|2000|2010|ca=date}}</nowiki></code> | ||
:Generates: {{floruit/sandbox|2000|2010|ca=date}} | :Generates: {{floruit/sandbox|2000|2010|ca=date}} | ||
| − | *{{anchor|ca2}}{{strong|Circa century range | + | *{{anchor|ca2}}{{strong|Circa end date for century range, with date unit}} |
:<code><nowiki>{{floruit/sandbox|date=20th|date2=21st|ca=date2|unit=c}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date=20th|date2=21st|ca=date2|unit=c}}</nowiki></code> | ||
:Generates: {{floruit/sandbox|date=20th|date2=21st|ca=date2|unit=c}} | :Generates: {{floruit/sandbox|date=20th|date2=21st|ca=date2|unit=c}} | ||
| Line 111: | Line 114: | ||
:<code><nowiki>{{floruit/sandbox|pfx2=no}} 2010s</nowiki></code> ([[#space|{{em|note}}]]) | :<code><nowiki>{{floruit/sandbox|pfx2=no}} 2010s</nowiki></code> ([[#space|{{em|note}}]]) | ||
:Generates: {{floruit/sandbox|pfx2=no}} 2010s | :Generates: {{floruit/sandbox|pfx2=no}} 2010s | ||
| − | *{{anchor|ttip}}{{strong| | + | *{{anchor|ttip}}{{strong|Year range, formatted, prefix with tooltip}} |
:<code><nowiki>{{floruit/sandbox|date=2010|date2=2016|pfx2=abbr}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date=2010|date2=2016|pfx2=abbr}}</nowiki></code> | ||
:Generates: {{floruit/sandbox|date=2010|date2=2016|pfx2=abbr}} | :Generates: {{floruit/sandbox|date=2010|date2=2016|pfx2=abbr}} | ||
| Line 117: | Line 120: | ||
:<code><nowiki>{{floruit/sandbox|date=January 2000|date2=April 2001|pfx2=active}}</nowiki></code> | :<code><nowiki>{{floruit/sandbox|date=January 2000|date2=April 2001|pfx2=active}}</nowiki></code> | ||
:Generates: {{floruit/sandbox|date=January 2000|date2=April 2001|pfx2=active}} | :Generates: {{floruit/sandbox|date=January 2000|date2=April 2001|pfx2=active}} | ||
| − | *{{anchor| | + | *{{anchor|suf1}}{{strong|Suffix, free-form decade range}} |
| − | :<code><nowiki>{{floruit/sandbox|date= | + | :<code><nowiki>{{floruit/sandbox|date=2000s to 2010s|sfx=ce}}</nowiki></code> |
| − | :Generates: {{floruit/sandbox|date= | + | :Generates: {{floruit/sandbox|date=2000s to 2010s|sfx=ce}} |
| − | *{{anchor|suf-lk}}{{strong| | + | *{{anchor|suf2}}{{strong|Suffix for end date, formatted mixed-unit range}} |
| − | :<code><nowiki>{{floruit/sandbox|date= | + | :<code><nowiki>{{floruit/sandbox|date=1990s|date2=before 2010|sfx=ce}}</nowiki></code> |
| − | :Generates: {{floruit/sandbox|date= | + | :Generates: {{floruit/sandbox|date=1990s|date2=before 2010|sfx=ce}} |
| + | *{{anchor|suf12}}{{strong|Suffix, formatted century range straddles eras, with date units}} | ||
| + | :<code><nowiki>{{floruit/sandbox|date=1st|date2=1st|unit=c-c|sfx=b-a}}</nowiki></code> | ||
| + | :Generates: {{floruit/sandbox|date=1st|date2=1st|unit=c-c|sfx=b-a}} | ||
| + | *{{anchor|suf-lk}}{{strong|Suffix wikilinked, "active" prefix in plain text, formatted decade range, with circa start date, in parentheses}} | ||
| + | :<code><nowiki>{{floruit/sandbox|date=2000s|date2=2010s|b=yes|pfx2=active-no|ca=yes|sfx=ce|sfx-lk=yes}}</nowiki></code> | ||
| + | :Generates: {{floruit/sandbox|date=2000s|date2=2010s|b=yes|pfx2=active-no|ca=yes|sfx=ce|sfx-lk=yes}} | ||
| + | *{{anchor|du1}}{{strong|Date unit, non-delimited century range}} | ||
| + | :<code><nowiki>{{floruit/sandbox|date=21st|unit=c}}</nowiki></code> | ||
| + | :Generates: {{floruit/sandbox|date=21st|unit=c}} | ||
| + | *{{anchor|du12}}{{strong|Date unit, formatted century range}} | ||
| + | :<code><nowiki>{{floruit/sandbox|date=20th|date2=21st|unit=c-c}}</nowiki></code> | ||
| + | :Generates: {{floruit/sandbox|date=20th|date2=21st|unit=c-c }} | ||
*{{anchor|sort}}{{strong|Sortable year, word wrap is on, prefix italicized, and suffix}} | *{{anchor|sort}}{{strong|Sortable year, word wrap is on, prefix italicized, and suffix}} | ||
:<code><nowiki>{{floruit/sandbox|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}}</nowiki></code> ([[#sorted|{{em|note}}]]) | :<code><nowiki>{{floruit/sandbox|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}}</nowiki></code> ([[#sorted|{{em|note}}]]) | ||
:Generates: {{floruit/sandbox|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}} | :Generates: {{floruit/sandbox|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}} | ||
| − | |||
| − | |||
| − | |||
==Error messages== | ==Error messages== | ||
| Line 145: | Line 157: | ||
{{strong|Parameter {{bxt|sortable}}}} | {{strong|Parameter {{bxt|sortable}}}} | ||
*Incorrect date format:{{efn|name=dts-err|Trap for related {{tl|dts}} native errors.{{efn|name=dts}}}} {{error|message={{small|[error in template {{tl2|floruit}}: wrong date format for the sortable option]}}}} | *Incorrect date format:{{efn|name=dts-err|Trap for related {{tl|dts}} native errors.{{efn|name=dts}}}} {{error|message={{small|[error in template {{tl2|floruit}}: wrong date format for the sortable option]}}}} | ||
| − | |||
==Redirects== | ==Redirects== | ||
| Line 163: | Line 174: | ||
"ca": { | "ca": { | ||
"label": "Circa", | "label": "Circa", | ||
| − | "description": "Set to \"yes\" for circa date | + | "description": "Set to \"yes\" or \"date\" for circa stand-alone dates or for circa start dates in formatted ranges; set to \"date2\" for circa end date in formatted ranges; set to \"both\" for circa formatted ranges; may require 'date' and 'end date' values", |
| − | "type": " | + | "type": "string", |
"default": "no circa" | "default": "no circa" | ||
}, | }, | ||
| Line 171: | Line 182: | ||
"1" | "1" | ||
], | ], | ||
| − | "label": "Date", | + | "label": "Date or start date", |
| − | "description": "Time-period or era | + | "description": "Time-period or era; may be stand-alone or the start date for a formatted range; may be required by other options", |
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
| Line 178: | Line 189: | ||
"sortable": { | "sortable": { | ||
"label": "Sortable", | "label": "Sortable", | ||
| − | "description": "Set to \"yes\" to sort the date correctly within tables; works with | + | "description": "Set to \"yes\" to sort the date correctly within tables; works with properly formatted dates only; requires a 'date' value", |
"type": "boolean", | "type": "boolean", | ||
"default": "no sorting" | "default": "no sorting" | ||
| Line 196: | Line 207: | ||
"pfx1": { | "pfx1": { | ||
"label": "Prefix style", | "label": "Prefix style", | ||
| − | "description": "Set to \"italics\" to render the prefix | + | "description": "Set to \"italics\" to render the floruit prefix in italics", |
"type": "string" | "type": "string" | ||
}, | }, | ||
| Line 204: | Line 215: | ||
], | ], | ||
"label": "Prefix link", | "label": "Prefix link", | ||
| − | "description": "Use to change the default display of the prefix fl.: \"abbr\" replaces wikilink to 'floruit' with a tooltip; \"no\" or \"off\" renders fl. in plain text", | + | "description": "Use to change the default display of the prefix fl.: \"abbr\" replaces wikilink to 'floruit' with a tooltip; \"no\" or \"off\" renders fl. in plain text; \"active\" displays that term as prefix instead, wikilinked to 'floruit'; \"active-no\" or \"active-off\" displays prefix 'active' in plain text ", |
"type": "string", | "type": "string", | ||
"default": "[[Floruit|fl.]]" | "default": "[[Floruit|fl.]]" | ||
| Line 210: | Line 221: | ||
"sfx": { | "sfx": { | ||
"label": "Suffix", | "label": "Suffix", | ||
| − | "description": "Adds | + | "description": "Adds era suffix(es); options are: \"ad\", \"bc\", \"bce\", or \"ce\" for stand-alone dates, or for the end date in formatted ranges; formatted ranges that straddle eras may set this to \"b-a\" for a BC-to-AD straddle, or to \"b-c\" for a BCE-to-CE straddle; displays in uppercase; requires a 'date' value; may require an 'end date' value", |
"type": "string" | "type": "string" | ||
}, | }, | ||
"sfx-lk": { | "sfx-lk": { | ||
"label": "Suffix link", | "label": "Suffix link", | ||
| − | "description": "Set to \"yes\" to wikilink the era suffix; requires | + | "description": "Set to \"yes\" to wikilink the era suffix(es); requires suffix(es)", |
"type": "boolean", | "type": "boolean", | ||
"default": "no link" | "default": "no link" | ||
| + | }, | ||
| + | "date2": { | ||
| + | "aliases": [ | ||
| + | "2" | ||
| + | ], | ||
| + | "label": "End date", | ||
| + | "type": "string", | ||
| + | "suggested": true, | ||
| + | "description": "End time-period or date for a formatted range; requires a 'date' value; may be required by other options" | ||
| + | }, | ||
| + | "unit": { | ||
| + | "label": "Date unit", | ||
| + | "type": "string", | ||
| + | "description": "Set to \"c\" or \"m\" to add 'century' or 'millennium' respectively, after a stand-alone date or after the end date in a formatted range; set to \"c-c\" or \"m-m\" to add the units after both dates in a formatted range; requires a 'date' value; may require an 'end date' value" | ||
} | } | ||
}, | }, | ||
| Line 223: | Line 248: | ||
"paramOrder": [ | "paramOrder": [ | ||
"date", | "date", | ||
| + | "date2", | ||
| + | "pfx1", | ||
| + | "pfx2", | ||
"b", | "b", | ||
"ca", | "ca", | ||
| − | " | + | "unit", |
| − | |||
"sfx", | "sfx", | ||
"sfx-lk", | "sfx-lk", | ||
Revision as of 23:15, 28 September 2016
| This is the template sandbox page for Template:Floruit (diff). |
| To quickly become familiar with this template, see Script error: No such module "Section link". (as usage summary), and Script error: No such module "Section link".. |
Template floruit (or any of its aliases) may be used to format the display of time periods or eras during which people, ideas, theories, or political, cultural or religious movements etc., may have been active or popular. It utilizes "fl.", an abbreviation of floruit or "flourished" (in Latin), as a prefix to the relevant date(s); a special option may instead employ "active" as prefix. The prefix is wikilinked to floruit by default, but different or additional display options may be used. Please also see Script error: No such module "Section link". for possible usage exceptions.
Contents
Usage
Structure
For presentation purposes only, in the box below [brackets] indicate parameter values; variables are italicized; explanatory text is in (parentheses).
|
Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces ( ) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Misspelled or undefined parameters are ignored. Delete unused parameters or options, and explanatory text. See Script error: No such module "Section link". for important details.
By default, the date or range is prefixed with the abbreviation "fl.", wikilinked to its expanded form (floruit); optionally, the prefix may be replaced by "active" in special cases. Displayable template values are separated by a whitespace characters of varying lengths. Formatted date ranges are separated by a spaced en dash. Line wrap and word wrap is off. Optionally, the floruit date may be set to be sortable.[lower-alpha 1] In most cases, usage errors will result in display of relevant error messages.
Applicability
This template may be used when exact or complete date information Template:Ordered list By definition, the relevant date(s) may be month, year, decade, or century ranges, or may otherwise be inexact or approximate. When the template is applied to persons with known occupations, the prefix option "active" is recommended; see WP:APPROXDATE for additional guidance.
Exceptions
Normally, this template should not be used when exact, complete dates need to be indicated, such as a person's birth and death dates, or an organization's founding and dissolution dates. However, it may be used in similar cases if exact or reliable date information is unavailable, or if providing such detail is unnecessary.
Parameters
All parameters are optional. Use of parameters date, and (additionally, for date ranges) date2, is suggested; either or both of these parameters may be required by other options. Incorrect parameter values will be flagged under almost all usage scenarios (see Script error: No such module "Section link".).
Parameter names are in bold below, for presentation only.
Date formatting parameters
Suggested:
- date or [1] (stand-alone date, or start date for range)Template:Spnd the time period (or the start date of a time period) during which the subject is known to have been active or popular. Values may be in any relevant date unit. You may also use this parameter as a free-form field, for stand-alone dates or for date ranges; such ranges must be separated by a spaced en dash where applicable (WP:APPROXDATE). For time periods not delimited with start and end dates (such as "1990s" or "21st century") use this parameter only; in ranges with start and end dates, the additional parameter date2 below may be used and is recommended. Apply any of Wikipedia's acceptable date formats, but please follow the relevant format established in the article, if any. Depending on the date prefix used (parameter pfx2 below), the value of date may be preceded by a narrow no-break space, or by a no-break space. A value for this parameter may be required by other options.
- Note: You may treat date as an unnamed parameter, and insert only its desired value.
- Note: Template display does not include trailing whitespace character(s); when date is not utilized, displayed output may vary according to user formatting.
- – for examples see here (named and unnamed) and here (not used)
- date2 or [2] (end date for range)Template:Spnd used to format date ranges delimited with start and end dates; this parameter is recommended when depicting such ranges. Requires a start date for the range via parameter date. A spaced en dash is used as the range separator. A value for this parameter may be required by other options.
- Note: You may treat date2 as an unnamed parameter, and insert only its desired value.
- – for examples see here (named and unnamed)
Optional:
- ca (circa)Template:Spnd use for circa dates; the additional prefix "c.", preceded by a narrow no-break space, is inserted before the relevant date(s) ( c.).
- set
|ca=yesor|ca=dateto apply circa independently of any parameter; or to apply to just parameter date when used as a stand-alone (or free-form) date; or, when date is used as the start date for a formatted range - set
|ca=date2in formatted ranges only; applies to the end date (parameter date2) - set
|ca=bothin formatted ranges only, as above, but applies to both start and end date (parameters date and date2)
- set
- – for examples see here (stand-alone date and range start date), here (range end date), and here (start and end date)
Conditional (requires a value for parameter date):
- sortableTemplate:Spnd set
|sortable=yesto format the value for parameter date so that it is displayed properly within sortable tables; it works correctly only with dates that conform to Wikipedia's acceptable date formats.[lower-alpha 1]
- Note: When using sortable, year values less than 1000 require leading zeroes up to the century digit, e.g. "050". Era suffixes (via parameter sfx below) are ignored.
- – for an example see here (displays additional options)
Prefix formatting parameters
Optional:
- pfx1 (prefix style)Template:Spnd use this parameter to italicize the display of the prefix, by setting
|pfx1=italics.
- – for an example see here (displays additional options)
- pfx2 (prefix link)Template:Spnd alias lk. The abbreviation "fl.", wikilinked to floruit and followed by a narrow no-break space, is used as the default prefix; use this parameter to change the default by inserting one of the following values:
- set
|pfx2=abbrto display a tooltip when the pointer hovers over "fl.", expanding it to "floruit"; tooltip display may depend on browser and/or operating system version - set
|pfx2=noor|pfx2=offto display "fl." in plain text; use to avoid overlinking when this template is used repeatedly in the body of an article (Script error: No such module "Section link".) - set
|pfx2=activeto replace "fl." with "active", wikilinked to floruit and followed by a no-break space; recommended when referring to persons with known occupations - set
|pfx2=active-noor|pfx2=active-offto use "active" as above, but to display it in plain text
- set
Suffix formatting parameters
Conditional (require a value for parameter date; may require a value for parameter date2):
- sfx (suffix)Template:Spnd use this parameter to add an era suffix preceded by a no-break space to the floruit date or range. Displays in plain text, but you may use the dependent parameter sfx-lk (see below) to display with an appropriate wikilink. The available options conform to the default calendar era. If parameter unit is specified, the suffix follows the unit value. When using this with formatted ranges (see parameter date2) the value applies to the end date only, except when the date range straddles eras.
- set
|sfx=adto display the suffix AD (Anno Domini) after parameter date when used as a stand-alone (or free-form) date; or, in formatted ranges, after the end date (parameter date2) - set
|sfx=bcas above, but displays the suffix BC (Before Christ) - set
|sfx=bceas above, but displays the suffix BCE (Before Common Era) - set
|sfx=ceas above, but displays the suffix CE (Common Era) - set
|sfx=b-ain formatted ranges only, to denote they straddle eras; displays BC after the start date (parameter date) and AD after the end date (parameter date2) - set
|sfx=b-cin formatted ranges only, as above, but displays BCE after the start date and CE after the end date
- set
- – for examples see here (free-form range), here (range end date), and here (start and end date straddle eras)
- sfx-lk (suffix link)Template:Spnd use to wikilink the suffix to the appropriate page, by setting
|sfx-lk=yes;[lower-alpha 2] parameter sfx is required.
- – for an example see here
Other parameters
Conditional (require a value for parameter date; may require a value for parameter date2):
- b (brackets)Template:Spnd use b to display the template's output in parentheses, by setting
|b=yes.
- – for an example see here
- unit (date unit)Template:Spnd use this parameter to specify a date unit for the floruit date or range, preceded by a no-break space. When using this with formatted ranges (see parameter date2), the value applies to the end date, or to both start and end date.
- set
|unit=cto add "century" after parameter date when it is a stand-alone (or free-form) date; or, in formatted ranges, after the end date (parameter date2) - set
|unit=mas above, but adds "millennium" instead - set
|unit=c-cin formatted ranges only; adds "century" after both the start and the end date (date and date2) - set
|unit=m-min formatted ranges only, as above, but adds "millennium" instead
- set
Optional:
- wrap (word wrap)Template:Spnd by default, template output displays without word wrapping; to turn word wrap on, set
|wrap=yes.
- – for an example see here
Examples
- Decade range, non-delimited
- Decade range, formatted, in parentheses
{{floruit/sandbox|date=2000|date2=2010|b=yes}}- or
{{floruit/sandbox|2000|2010|b=yes}}(note)- Either generates: (fl. 2000 – 2010)
- Circa non-delimited decade range, and circa start date for formatted decade range
{{floruit/sandbox|date=2000s|ca=yes}}- Generates: fl. c. 2000s
- and
{{floruit/sandbox|2000|2010|ca=date}}- Generates: fl. c. 2000 – 2010
- Circa end date for century range, with date unit
{{floruit/sandbox|date=20th|date2=21st|ca=date2|unit=c}}- Generates: fl. 20th – c. 21st century
- Circa century range, with date unit
{{floruit/sandbox|date=20th|date2=21st|ca=both|unit=c}}- Generates: fl. c. 20th – c. 21st century
- Prefix only, in plain text
{{floruit/sandbox|pfx2=no}} 2010s(note)- Generates: fl. 2010s
- Year range, formatted, prefix with tooltip
{{floruit/sandbox|date=2010|date2=2016|pfx2=abbr}}- Generates: fl. 2010 – 2016
- "Active" prefix, formatted range
{{floruit/sandbox|date=January 2000|date2=April 2001|pfx2=active}}- Generates: active January 2000 – April 2001
- Suffix, free-form decade range
{{floruit/sandbox|date=2000s to 2010s|sfx=ce}}- Generates: fl. 2000s to 2010s CE
- Suffix for end date, formatted mixed-unit range
{{floruit/sandbox|date=1990s|date2=before 2010|sfx=ce}}- Generates: fl. 1990s – before 2010 CE
- Suffix, formatted century range straddles eras, with date units
{{floruit/sandbox|date=1st|date2=1st|unit=c-c|sfx=b-a}}- Generates: fl. 1st century BC – 1st century AD
- Suffix wikilinked, "active" prefix in plain text, formatted decade range, with circa start date, in parentheses
{{floruit/sandbox|date=2000s|date2=2010s|b=yes|pfx2=active-no|ca=yes|sfx=ce|sfx-lk=yes}}- Generates: (active c. 2000s – 2010s CE)
- Date unit, non-delimited century range
{{floruit/sandbox|date=21st|unit=c}}- Generates: fl. 21st century
- Date unit, formatted century range
{{floruit/sandbox|date=20th|date2=21st|unit=c-c}}- Generates: fl. 20th century – 21st century
- Sortable year, word wrap is on, prefix italicized, and suffix
{{floruit/sandbox|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}}(note)- Generates: fl. 50 BCE
Error messages
Multiple errors are flagged per parameter; errors involving the same parameter may be mutually exclusive.
Messages replace the relevant parameter value(s), and appear under the following conditions:[lower-alpha 3]
Parameters b, ca, pfx1, pfx2, unit, sortable and wrap
- Incorrect value: [error in template
{{floruit}}: wrong value for the parameter option]
Parameters b, unit, sfx and sortable
- Date required: [error in template
{{floruit}}: parameter option requires a date value]
Parameter date2
- Start date missing: [error in template
{{floruit}}: date range requires a starting date]
Parameter sfx
- Incorrect or unsupported entry: [error in template
{{floruit}}: wrong or unsupported suffix]
Parameter sfx-lk
- Suffix not defined: [error in template
{{floruit}}: suffix link requires suffix]
Parameter sortable
- Incorrect date format:[lower-alpha 4] [error in template
{{floruit}}: wrong date format for the sortable option]
Redirects
{{floruit}} has the following redirects:
- {{fl.}}
- {{flor}}
- {{flor.}}
- {{flourished}}
- {{flr}}
TemplateData
TemplateData for floruit
Formats the display of periods of activity or popularity for people, ideas, or movements
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Date or start date | date 1 | Time-period or era; may be stand-alone or the start date for a formatted range; may be required by other options | String | suggested |
| End date | date2 2 | End time-period or date for a formatted range; requires a 'date' value; may be required by other options | String | suggested |
| Prefix style | pfx1 | Set to "italics" to render the floruit prefix in italics | String | optional |
| Prefix link | pfx2 lk | Use to change the default display of the prefix fl.: "abbr" replaces wikilink to 'floruit' with a tooltip; "no" or "off" renders fl. in plain text; "active" displays that term as prefix instead, wikilinked to 'floruit'; "active-no" or "active-off" displays prefix 'active' in plain text
| String | optional |
| Brackets | b | Set to "yes" to display output in parentheses; requires a 'date' value
| Boolean | optional |
| Circa | ca | Set to "yes" or "date" for circa stand-alone dates or for circa start dates in formatted ranges; set to "date2" for circa end date in formatted ranges; set to "both" for circa formatted ranges; may require 'date' and 'end date' values
| String | optional |
| Date unit | unit | Set to "c" or "m" to add 'century' or 'millennium' respectively, after a stand-alone date or after the end date in a formatted range; set to "c-c" or "m-m" to add the units after both dates in a formatted range; requires a 'date' value; may require an 'end date' value | String | optional |
| Suffix | sfx | Adds era suffix(es); options are: "ad", "bc", "bce", or "ce" for stand-alone dates, or for the end date in formatted ranges; formatted ranges that straddle eras may set this to "b-a" for a BC-to-AD straddle, or to "b-c" for a BCE-to-CE straddle; displays in uppercase; requires a 'date' value; may require an 'end date' value | String | optional |
| Suffix link | sfx-lk | Set to "yes" to wikilink the era suffix(es); requires suffix(es)
| Boolean | optional |
| Sortable | sortable | Set to "yes" to sort the date correctly within tables; works with properly formatted dates only; requires a 'date' value
| Boolean | optional |
| Word wrap | wrap | Set to "yes" to turn word wrap on
| Boolean | optional |
See also
Footnotes
- ↑ 1.0 1.1 1.2 Template {{dts}} (date time sorting) has been embedded in code and becomes active when the sortable option is used.
- ↑ Any other value is ignored silently.
- ↑ When error messages appear in live usage, the included template link to {{floruit}} is active.
- ↑ Trap for related {{dts}} native errors.[lower-alpha 1]
| The above documentation is transcluded from Template:Floruit/doc. (edit | history) Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages. Subpages of this template. |