Difference between revisions of "Template:Floruit/doc"

From blackwiki
Jump to navigation Jump to search
(Ce.)
Line 13: Line 13:
 
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 or options, and explanatory text. 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 ( ) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. Delete unused parameters or options, and explanatory text. See {{slink||Parameters}} for important details.
  
By default, displayable values are separated by a [[thin space]] ( ); [[Line wrap and word wrap|word wrapping]] is off. Template {{tl|dts}} (date time sorting) has been embedded in code and may become active, in cases where {{tlf|fl.}} output needs to be sortable (for example, when used inside tables).
+
By default, displayable values are separated by a [[thin space]] ( ); [[Line wrap and word wrap|word wrapping]] is off. Template {{tl|dts}} (date time sorting) has been embedded in code and becomes active when the {{em|floruit}} date is (optionally) set to be sortable.
  
 
===Applicability===
 
===Applicability===
Line 21: Line 21:
  
 
===Exceptions===
 
===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 actual birth and death dates, or an organization's actual founding and dissolution dates; however, it may be used in similar cases, when there is no exact, complete, or reliable date information, or when providing such detail is unnecessary.
+
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==
 
==Parameters==
All parameters are optional, but note that some options depend on other parameters. Parameter labels are in {{bxtn|bold}}; explanatory or expanded text may follow, in parentheses.
+
All parameters are optional; some options depend on other parameters. Parameter labels are in {{bxtn|bold}}; explanatory or expanded text may follow, in parentheses.
  
 
===Date formatting parameters===
 
===Date formatting parameters===
 
Optional:
 
Optional:
*{{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}}.
+
*{{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. 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}}.
 
:{{em|id=unnamed|Note1:}} You may treat {{bxt|date}} as an unnamed parameter, and insert only its desired value.
 
:{{em|id=unnamed|Note1:}} You may treat {{bxt|date}} as an unnamed parameter, and insert only its desired value.
:{{em|id=space|Note2:}} If {{bxt|date}} is not utilized, the displayed output may vary according to the user’s choice of following {{nobr|[[whitespace character]](s)}}, or other formatting.
+
:{{em|id=space|Note2:}} If {{bxt|date}} is not utilized, the displayed output may vary according to the user’s choice of [[whitespace character]](s) following the prefix "fl.", or according to other user formatting.
 
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#dec|{{em|here}}]] {{em|(unnamed) and}} [[#plain|{{em|here}}]] {{em|(not used)}}
 
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#dec|{{em|here}}]] {{em|(unnamed) and}} [[#plain|{{em|here}}]] {{em|(not used)}}
 
*{{bxtn|ca}} (circa){{spaced en dash}}set {{para|ca|yes}} for [[circa]] dates; the additional prefix "c.", is inserted before the date.
 
*{{bxtn|ca}} (circa){{spaced en dash}}set {{para|ca|yes}} for [[circa]] dates; the additional prefix "c.", is inserted before the date.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
Conditional:
 
Conditional:
*{{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 value for parameter}} {{bxt|date}}.
+
*{{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 value for parameter}} {{bxt|date}}.
:{{em|id=sort|Note3:}} To sort correctly, parameter {{para|sortable}} wraps template {{tl|dts}} around the date value(s); it works best with single-date values. When using {{para|sortable}} {{em|do not}} insert other templates as values to {{bxt|date}}; results may be unpredictable. Note {{tlf|dts}} has other shortcomings.
+
:{{em|id=sort|Note3:}} To sort correctly, parameter {{bxt|sortable}} wraps template {{tl|dts}} around the date value(s); it works best with single-date values. {{em|Do not}} embed templates as values to {{bxt|date}} when {{bxt|sortable}} is used; results may be unpredictable. Note {{tlf|dts}} has other shortcomings.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
  
 
===Prefix formatting parameters===
 
===Prefix formatting parameters===
 
Optional:
 
Optional:
*{{bxtn|pfx1}} (prefix style){{spaced en dash}}use this parameter to {{em|italicize}} the display of the prefix "fl.", by setting {{para|pfx1|italics}}.
+
*{{bxtn|pfx1}} (prefix style){{spaced en dash}} use this parameter to {{em|italicize}} the display of the prefix "fl.", 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}}]]
*{{bxtn|pfx2}} (prefix link){{spaced en dash}}alias {{bxtn|lk}}. By default, the prefix is wikilinked to ''[[floruit]]''; use this parameter to change the default by inserting one of the following values:
+
*{{bxtn|pfx2}} (prefix link){{spaced en dash}} alias {{bxtn|lk}}. By default, the prefix is wikilinked to ''[[floruit]]''; use this parameter to change the default by inserting one of the following values:
**set {{para|pfx2|abbr}} to instead 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; see {{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. See {{slink|Wikipedia:Manual of Style/Abbreviations|Miscellaneous shortenings}}.
 
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#ttip|{{em|here}}]] {{em|(tooltip) and}} [[#plain|{{em|here}}]] {{em|(plain text)}}
 
:{{en dash}}{{nbsp}}{{em|for examples see}} [[#ttip|{{em|here}}]] {{em|(tooltip) and}} [[#plain|{{em|here}}]] {{em|(plain text)}}
  
 
===Other parameters===
 
===Other parameters===
Conditional ({{em|all require a value for parameter}} {{bxt|date}}):
+
Conditional ({{em|require a value for parameter}} {{bxt|date}}):
*{{bxtn|b}} (brackets){{spaced en dash}}use {{bxt|b}} to display the template's output in parentheses, by setting {{para|b|yes}}.
+
*{{bxtn|b}} (brackets){{spaced en dash}} 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}}]]  
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#brc|{{em|here}}]]  
*{{bxtn|sfx}} (suffix){{spaced en dash}} use this parameter to append the {{em|floruit}} date with an era suffix preceded by a no-break space; the available options conform to the [[MOS:ERA|default calendar era]].
+
*{{bxtn|sfx}} (suffix){{spaced en dash}} use this parameter to append the {{em|floruit}} date with an era suffix preceded by a [[no-break space]]; the available options conform to the [[MOS:ERA|default calendar era]].
 
**set {{para|sfx|ad}} to display the suffix [[Anno Domini|AD]]
 
**set {{para|sfx|ad}} to display the suffix [[Anno Domini|AD]]
 
**set {{para|sfx|bc}} to display the suffix [[Anno Domini|BC]]
 
**set {{para|sfx|bc}} to display the suffix [[Anno Domini|BC]]
Line 59: Line 59:
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
Optional:
 
Optional:
*{{bxtn|wrap}} (word wrap){{spaced en dash}}by default, template output displays without word wrapping; to turn word wrap on, set {{para|wrap|yes}}.
+
*{{bxtn|wrap}} (word wrap){{spaced en dash}} by default, template output displays without word wrapping; to turn word wrap on, set {{para|wrap|yes}}.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
  
Line 79: Line 79:
 
:Generates: {{floruit|pfx2=no}} 2010s
 
:Generates: {{floruit|pfx2=no}} 2010s
 
:{{en dash}}{{nbsp}}{{em|please see [[#space|Note2]]}}
 
:{{en dash}}{{nbsp}}{{em|please see [[#space|Note2]]}}
*{{anchor|no-brc}}{{strong|Parentheses won't display without a}} {{bxt|date}} {{strong|value}}
 
:<code><nowiki>{{floruit|b=yes}} 2010s</nowiki></code>
 
:Generates: {{floruit|b=yes}} 2010s
 
 
*{{anchor|ttip}}{{strong|Year range, prefix with tooltip}}
 
*{{anchor|ttip}}{{strong|Year range, prefix with tooltip}}
 
:<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pfx2=abbr}}</nowiki></code>
 
:<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pfx2=abbr}}</nowiki></code>

Revision as of 14:55, 31 August 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

For presentation purposes only, in the box below [brackets] indicate parameter values; variables are italicized; explanatory text is in (parentheses).

Full parameter set in horizontal format
{{floruit|date= (or) [date-value]|ca= |sortable= |pfx1= |pfx2= |sfx= |b= |wrap= }}

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 or options, and explanatory text. See Script error: No such module "Section link". for important details.

By default, displayable values are separated by a thin space ( ); word wrapping is off. Template {{dts}} (date time sorting) has been embedded in code and becomes active when the floruit date is (optionally) set to be sortable.

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. 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; some options depend on other parameters. Parameter labels are in bold; explanatory or expanded text may follow, in parentheses.

Date formatting parameters

Optional:

  • dateTemplate: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. 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.
Note1: You may treat date as an unnamed parameter, and insert only its desired value.
Note2: If date is not utilized, the displayed output may vary according to the user’s choice of whitespace character(s) following the prefix "fl.", or according to other user formatting.
 for examples see here (unnamed) and here (not used)
 for an example see here

Conditional:

Note3: To sort correctly, parameter sortable wraps template {{dts}} around the date value(s); it works best with single-date values. Do not embed templates as values to date when sortable is used; results may be unpredictable. Note {{dts}} has other shortcomings.
 for an example see here

Prefix formatting parameters

Optional:

  • pfx1 (prefix style)Template:Spaced en dash use this parameter to italicize the display of the prefix "fl.", by setting |pfx1=italics.
 for an example see here
  • pfx2 (prefix link)Template:Spaced en dash alias lk. By default, the prefix is wikilinked to floruit; use this parameter to change the default by inserting one of the following values:
    • set |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 |pfx2=no or |pfx2=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"..
 for examples see here (tooltip) and here (plain text)

Other parameters

Conditional (require a value for parameter date):

 for an example see here
  • sfx (suffix)Template:Spaced en dash use this parameter to append the floruit date with an era suffix preceded by a no-break space; the available options conform to the default calendar era.
    • set |sfx=ad to display the suffix AD
    • set |sfx=bc to display the suffix BC
    • set |sfx=bce to display the suffix BCE
    • set |sfx=ce to display the suffix CE
 for an example see here

Optional:

  • wrap (word wrap)Template:Spaced en dash by default, template output displays without word wrapping; to turn word wrap on, set |wrap=yes.
 for an example see here

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|pfx2=no}} 2010s
Generates: fl. 2010s
 please see Note2
  • Year range, prefix with tooltip
{{floruit|date={{dash year|2010|2016}}|pfx2=abbr}}
Generates: fl.
 uses {{dash year}} to format year range, but please see Note3
  • Circa century, prefix wikilinked, and suffix
{{floruit|date=21st century|ca=yes|sfx=ce}}
Generates: fl.
  • Sortable, single year, prefix italicized with tooltip, word wrap is on
{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|wrap=yes}}
Generates: fl.
  • As above, in parentheses
{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|b=yes|wrap=yes}}
Generates: fl.

Redirects

{{floruit}} has the following redirects:

TemplateData

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)

Default
no
Booleanoptional
Sortablesortable

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

Default
no
Booleanoptional
Prefix stylepfx1

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

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

Default
[[Floruit|fl.]]
Stringoptional
Suffixsfx

Adds an era suffix; options are: "ad", "bc", "bce", or "ce"; displays in uppercase

Stringoptional
Bracketsb

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

Default
no
Booleanoptional
Word wrapwrap

Set to "yes" to turn word wrap on

Default
no
Booleanoptional

See also