Difference between revisions of "Template:Floruit/doc"

From blackwiki
Jump to navigation Jump to search
(→‎Template data: {{TemplateDataHeader}}.)
(Update doc after latest edits.)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!--Categories go at the bottom of this page and interwikis go in Wikidata.-->
 
<!--Categories go at the bottom of this page and interwikis go in Wikidata.-->
<!--Partly based on {{cl|Citation Style 1 templates}} documentation.-->
+
<!--Partly based on documentation for {{cl|Citation Style 1 templates}}.-->
 
The template {{bxtn|floruit}} (or [[#Redirects|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). The prefix abbreviation is wikilinked to ''floruit'' by default, but users may employ different or additional display options. Please also see {{slink||Exceptions}} for possible usage exceptions.
 
The template {{bxtn|floruit}} (or [[#Redirects|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). The prefix abbreviation is wikilinked to ''floruit'' by default, but users may employ different or additional display options. Please also see {{slink||Exceptions}} for possible usage exceptions.
  
 
==Usage==
 
==Usage==
 +
 +
===Structure===
 
{{csdoc|usage full}}
 
{{csdoc|usage full}}
:<code><nowiki>{{floruit|date= </nowiki>{{bxt|or}} {{var|[date-value]}}<nowiki>|ca= |sortable= |pre1= |pre2= }}</nowiki></code>
+
:<code><nowiki>{{floruit|date= </nowiki>{{bxt|or}} {{var|[date-value]}}<nowiki>|ca= |sortable= |pre1= |pre2= |b= }}</nowiki></code>
 
{{end}}
 
{{end}}
 
Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces (&#160;) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Delete unused parameters. See {{slink||Parameters}} for important details.
 
Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces (&#160;) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Delete unused parameters. See {{slink||Parameters}} for important details.
 +
 +
===Applicability===
 +
This template may be used when exact or complete date information
 +
{{Ordered list|list_style_type=lower-alpha|is not required|is not necessary or pertinent|is not reliably known}}
 +
[[Floruit|By definition]], the relevant date(s) may be year, decade, or century ranges, or may otherwise be inexact or approximate.
  
 
===Exceptions===
 
===Exceptions===
[[Floruit|By definition]], the relevant date(s) may be inexact or approximate; normally, this template should not be used when {{em|exact dates}} should be indicated. For example, this template should not be used for a person's birth or death dates, or for an organization's founding or dissolution dates; however, it may be used in similar cases, when there is no reliable or exact dating information.
+
Normally, this template should not be used when exact, complete dates need to be indicated. For example, this template should not be used to show a person's birth and death dates, or an organization's founding and dissolution dates, when the complete, exact days are required; however, it may be used in similar cases, and when there is no exact, complete, or reliable dating information, or when providing such detail is not necessary.
  
 
==Examples==
 
==Examples==
Line 21: Line 28:
 
:{{en dash}}{{nbsp}}{{em|Date entered without label}} {{para|date}} ({{em|[[#unnamed|Note1]]}})
 
:{{en dash}}{{nbsp}}{{em|Date entered without label}} {{para|date}} ({{em|[[#unnamed|Note1]]}})
 
:Either generates: {{floruit|2010s}}
 
:Either generates: {{floruit|2010s}}
 +
*{{strong|As above, in parentheses}}
 +
:<code><nowiki>{{floruit|date=2010s|b=yes}}</nowiki></code>
 +
:or
 +
:<code><nowiki>{{floruit|2010s|b=yes}}</nowiki></code>
 +
:Either generates: {{floruit|2010s|b=yes}}
 
*{{strong|Prefix only, in plain text}}
 
*{{strong|Prefix only, in plain text}}
 
:<code><nowiki>{{floruit|pre2=no}} 2010s</nowiki></code>
 
:<code><nowiki>{{floruit|pre2=no}} 2010s</nowiki></code>
 
:Generates: {{floruit|pre2=no}} 2010s
 
:Generates: {{floruit|pre2=no}} 2010s
 
:{{en dash}}{{nbsp}}{{em|Please see [[#space|Note2]]}}
 
:{{en dash}}{{nbsp}}{{em|Please see [[#space|Note2]]}}
 +
*{{strong|Parentheses don't display without a}} {{bxt|date}} {{strong|value}}
 +
:<code><nowiki>{{floruit|b=yes}} 2010s</nowiki></code>
 +
:Generates: {{floruit|b=yes}} 2010s
 
*{{strong|Year range, prefix with tooltip}}
 
*{{strong|Year range, prefix with tooltip}}
 
:<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pre2=abbr}}</nowiki></code>
 
:<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pre2=abbr}}</nowiki></code>
Line 32: Line 47:
 
:<code><nowiki>{{floruit|date=21st century CE|ca=yes}}</nowiki></code>
 
:<code><nowiki>{{floruit|date=21st century CE|ca=yes}}</nowiki></code>
 
:Generates: {{floruit|date=21st century CE|ca=yes}}
 
:Generates: {{floruit|date=21st century CE|ca=yes}}
*{{strong|Single year sortable, prefix italicized with tooltip}}  
+
*{{strong|Sortable, single year, prefix italicized with tooltip}}  
 
:<code><nowiki>{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr}}</nowiki></code>
 
:<code><nowiki>{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr}}</nowiki></code>
 
:Generates: {{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr}}
 
:Generates: {{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr}}
 +
*{{strong|As above, in parentheses}}
 +
:<code><nowiki>{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr|b=yes}}</nowiki></code>
 +
:Generates: {{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr|b=yes}}
  
 
==Parameters==
 
==Parameters==
All parameters are optional.
+
All parameters are optional; please note that some options depend on other parameters.
  
 
===Date formatting parameters===
 
===Date formatting parameters===
*{{bxtn|date}}{{spaced en dash}}the time period during which the subject is known to have been active or popular. Dated in year(s), decade(s), centuries or other time units, including ranges. Do not wikilink. Not checked for date-formatting errors. May be any one of Wikipedia's [[MOS:DATEFORMAT|acceptable date formats]], but please follow the relevant format established in the article, if any.  
+
*{{bxtn|date}}{{spaced en dash}}the time period during which the subject is known to have been active or popular. Dated in year(s), decade(s), centuries or other time units, including ranges. Do not wikilink. Not checked for date-formatting errors. May be any one of Wikipedia's [[MOS:DATEFORMAT|acceptable date formats]], but please follow the relevant format established in the article, if any. Depending on the template options used, {{em|this parameter may require a value}}, see {{bxt|sortable}} and {{bxt|title=brackets|1=b}}, below.
 
:{{em|id=unnamed|Note1}}: You may treat parameter {{bxt|date}} as unnamed, and insert only the parameter's desired value; in such cases, this value should be the {{em|first entry}} in the template.
 
:{{em|id=unnamed|Note1}}: You may treat parameter {{bxt|date}} as unnamed, and insert only the parameter's desired value; in such cases, this value should be the {{em|first entry}} in the template.
:{{em|id=space|Note2:}} The value of {{bxt|date}} is preceded by a [[narrow no-break space]] (&#8239;); if the parameter is not utilized, the template’s display may vary according to the user’s choice of [[whitespace character]](s) or other formatting.
+
:{{em|id=space|Note2:}} The value of {{bxt|date}} is preceded by a [[narrow no-break space]] (&#8239;); if the parameter is not utilized, the displayed output may vary according to the user’s choice of [[whitespace character]](s) or other formatting.
:*{{bxtn|sortable}}{{spaced en dash}}set {{para|sortable|yes}} to format the date value(s) so that they are displayed properly within [[WP:TABLESORT|sortable table]]s; requires a {{bxt|date}} value.
+
:*{{bxtn|sortable}}{{spaced en dash}}set {{para|sortable|yes}} to format the {{bxt|date}} value(s) so that they are displayed properly within [[WP:TABLESORT|sortable table]]s; {{em|requires a date value}}.
 
::{{em|id=sort|Note3:}} To sort correctly, {{para|sortable}} wraps template {{tl|dts}} around the date value(s); it works best with single date values. When using this parameter, {{em|do not}} insert other templates as values to {{bxt|date}}; results may be unpredictable.
 
::{{em|id=sort|Note3:}} To sort correctly, {{para|sortable}} wraps template {{tl|dts}} around the date value(s); it works best with single date values. When using this parameter, {{em|do not}} insert other templates as values to {{bxt|date}}; results may be unpredictable.
*{{bxtn|ca}}{{spaced en dash}}set {{para|ca|yes}} for [[circa]] dates; adds a [[narrow no-break space]] (&#8239;), followed by the additional prefix "c.", before the date value.
+
*{{bxtn|title=circa|1=ca}}{{spaced en dash}}set {{para|ca|yes}} for [[circa]] dates; adds a [[narrow no-break space]] (&#8239;), followed by the additional prefix "c.", before the date value.
  
 
===Prefix formatting parameters===
 
===Prefix formatting parameters===
*{{bxtn|pre1}}{{spaced en dash}}use this parameter to {{em|italicize}} the display of the prefix "fl.", by setting {{para|pre1|italics}}.
+
*{{bxtn|title=prefix font-style|1=pre1}}{{spaced en dash}}use this parameter to {{em|italicize}} the display of the prefix "fl.", by setting {{para|pre1|italics}}.
*{{bxtn|pre2}}{{spaced en dash}}alias {{bxtn|lk}}. By default, the prefix is wikilinked to ''[[floruit]]''; use this parameter to change this default by inserting one of the following values:
+
*{{bxtn|title=prefix links|1=pre2}}{{spaced en dash}}alias {{bxtn|lk}}. By default, the prefix is wikilinked to ''[[floruit]]''; use this parameter to change this default by inserting one of the following values:
 
**set {{para|pre2|abbr}} to instead display a [[tooltip]] when the cursor hovers over "fl.", expanding it to "floruit". Tooltip display may depend on browser and/or operating system version.
 
**set {{para|pre2|abbr}} to instead display a [[tooltip]] when the cursor hovers over "fl.", expanding it to "floruit". Tooltip display may depend on browser and/or operating system version.
 
**set {{para|pre2|no}} or {{para|pre2|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; see {{slink|Wikipedia:Manual of Style/Abbreviations|Miscellaneous shortenings}}.
 
**set {{para|pre2|no}} or {{para|pre2|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; see {{slink|Wikipedia:Manual of Style/Abbreviations|Miscellaneous shortenings}}.
 +
 +
===Other parameters===
 +
*{{bxtn|title=brackets|1=b}}{{spaced en dash}}use {{bxt|b}} (brackets) to display the template's output in parentheses "()", by setting {{para|b|yes}}; {{em|requires a date value}}.
  
 
==Redirects==
 
==Redirects==
Line 63: Line 84:
 
==See also==
 
==See also==
 
*[[Tempore]]
 
*[[Tempore]]
 +
*{{tl|b.}}
 
*{{tl|circa}}
 
*{{tl|circa}}
 
*{{tl|reign}}
 
*{{tl|reign}}
Line 72: Line 94:
 
"params": {
 
"params": {
 
"pre1": {
 
"pre1": {
"label": "Prefix italics",
+
"label": "Prefix style",
 
"description": "Set to \"italics\" to render the prefix 'fl.' in italics",
 
"description": "Set to \"italics\" to render the prefix 'fl.' in italics",
 
"type": "string"
 
"type": "string"
Line 91: Line 113:
 
"date": {
 
"date": {
 
"aliases": [
 
"aliases": [
"1 [unnamed]"
+
"1"
 
],
 
],
 
"label": "Date",
 
"label": "Date",
Line 101: Line 123:
 
"label": "Sortable",
 
"label": "Sortable",
 
"description": "Set to \"yes\" to sort the date correctly within tables; requires a 'date' value",
 
"description": "Set to \"yes\" to sort the date correctly within tables; requires a 'date' value",
 +
"type": "string"
 +
},
 +
"b": {
 +
"label": "Brackets",
 +
"description": "Set to \"yes\" to display output in parentheses; requires a 'date' value",
 
"type": "string"
 
"type": "string"
 
}
 
}
Line 110: Line 137:
 
"sortable",
 
"sortable",
 
"pre1",
 
"pre1",
"pre2"
+
"pre2",
 +
"b"
 
],
 
],
 
"format": "inline"
 
"format": "inline"

Revision as of 14:23, 17 March 2016

The 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). The prefix abbreviation is wikilinked to floruit by default, but users may employ different or additional display options. Please also see Script error: No such module "Section link". for possible usage exceptions.

Usage

Structure

Full parameter set in horizontal format
{{floruit|date= or [date-value]|ca= |sortable= |pre1= |pre2= |b= }}

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. Delete unused parameters. See Script error: No such module "Section link". for important details.

Applicability

This template may be used when exact or complete date information Template:Ordered list By definition, the relevant date(s) may be year, decade, or century ranges, or may otherwise be inexact or approximate.

Exceptions

Normally, this template should not be used when exact, complete dates need to be indicated. For example, this template should not be used to show a person's birth and death dates, or an organization's founding and dissolution dates, when the complete, exact days are required; however, it may be used in similar cases, and when there is no exact, complete, or reliable dating information, or when providing such detail is not necessary.

Examples

Some of the following examples may utilize additional, embedded templates, in order to enhance presentation or clarity. Such practice is optional.

  • Decade, prefix wikilinked
{{floruit|date=2010s}}
or
{{floruit|2010s}}
 Date entered without label |date= (Note1)
Either generates: fl. 2010s
  • As above, in parentheses
{{floruit|date=2010s|b=yes}}
or
{{floruit|2010s|b=yes}}
Either generates: fl. 2010s
  • Prefix only, in plain text
{{floruit|pre2=no}} 2010s
Generates: fl. 2010s
 Please see Note2
  • Parentheses don't display without a date value
{{floruit|b=yes}} 2010s
Generates: fl. 2010s
  • Year range, prefix with tooltip
{{floruit|date={{dash year|2010|2016}}|pre2=abbr}}
Generates: fl.
 Uses {{dash year}} to format year range, but please see Note3
  • Circa century, prefix wikilinked
{{floruit|date=21st century CE|ca=yes}}
Generates: fl.
  • Sortable, single year, prefix italicized with tooltip
{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr}}
Generates: fl.
  • As above, in parentheses
{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr|b=yes}}
Generates: fl.

Parameters

All parameters are optional; please note that some options depend on other parameters.

Date formatting parameters

  • dateTemplate:Spaced en dashthe time period during which the subject is known to have been active or popular. Dated in year(s), decade(s), centuries or other time units, including ranges. Do not wikilink. Not checked for date-formatting errors. May be any one of Wikipedia's acceptable date formats, but please follow the relevant format established in the article, if any. Depending on the template options used, this parameter may require a value, see sortable and b, below.
Note1: You may treat parameter date as unnamed, and insert only the parameter's desired value; in such cases, this value should be the first entry in the template.
Note2: The value of date is preceded by a narrow no-break space ( ); if the parameter is not utilized, the displayed output may vary according to the user’s choice of whitespace character(s) or other formatting.
Note3: To sort correctly, |sortable= wraps template {{dts}} around the date value(s); it works best with single date values. When using this parameter, do not insert other templates as values to date; results may be unpredictable.

Prefix formatting parameters

  • pre1Template:Spaced en dashuse this parameter to italicize the display of the prefix "fl.", by setting |pre1=italics.
  • pre2Template:Spaced en dashalias lk. By default, the prefix is wikilinked to floruit; use this parameter to change this default by inserting one of the following values:
    • set |pre2=abbr to instead display a tooltip when the cursor hovers over "fl.", expanding it to "floruit". Tooltip display may depend on browser and/or operating system version.
    • set |pre2=no or |pre2=off to display "fl." in plain text; use to avoid overlinking when this template is used repeatedly in the body of an article; see Script error: No such module "Section link"..

Other parameters

  • bTemplate:Spaced en dashuse b (brackets) to display the template's output in parentheses "()", by setting |b=yes; requires a date value.

Redirects

{{floruit}} can be replaced with the redirects:

See also

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Floruit

Formats the display of periods of activity or popularity for people, ideas, or movements

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Datedate 1

Time-period or era, may be a single date or a range

Stringsuggested
Circaca

Set to "yes" for circa date(s)

Stringoptional
Sortablesortable

Set to "yes" to sort the date correctly within tables; requires a 'date' value

Stringoptional
Prefix stylepre1

Set to "italics" to render the prefix 'fl.' in italics

Stringoptional
Prefix linkspre2 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

Stringoptional
Bracketsb

Set to "yes" to display output in parentheses; requires a 'date' value

Stringoptional