Difference between revisions of "Template:Floruit/doc"

From blackwiki
Jump to navigation Jump to search
Line 58: Line 58:
  
 
==Parameters==
 
==Parameters==
All parameters are optional; please note that some options depend on other parameters. Parameter labels are in {{bxtn|bold}}; explanatory/expanded text may follow, in (parentheses).
+
All parameters are optional; please note that 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===

Revision as of 20:18, 18 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= |pre1= |pre2= |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. See Script error: No such module "Section link". for important details.

By default, word wrapping is off in template output.

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. 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.

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 won'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, word wrap is on
{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr|wrap=yes}}
Generates: fl.
  • As above, in parentheses
{{floruit|date=2016|sortable=yes|pre1=italics|pre2=abbr|b=yes|wrap=yes}}
Generates: fl.

Parameters

All parameters are optional; please note that some options depend on other parameters. Parameter labels are in bold; explanatory or expanded text may follow, in parentheses.

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.
Note2: The value of date is preceded by a thin space ( ); if the parameter is not utilized, the displayed output may vary according to the user’s choice of Template:Nobr or other formatting.
 for examples see here and here
Note3: To sort correctly, parameter |sortable= wraps template {{dts}} around the date value(s); it works best with single-date values. When using |sortable= do not insert other templates as values to date; results may be unpredictable.
 for an example see here
 for an example see here

Prefix formatting parameters

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

Other parameters

  • b (brackets)Template:Spaced en dashuse b to display the template's output in parentheses "()", by setting |b=yes; requires a date value.
 for examples see here and here
  • wrap (word wrap)Template:Spaced en dashby default, template output displays without word wrapping; to turn word wrap on, set |wrap=yes.
 for an example see here

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

Default
N
Booleanoptional
Prefix stylepre1

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

Stringoptional
Prefix linkpre2 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
Bracketsb

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

Default
N
Booleanoptional
Word wrapwrap

Set to "yes" to turn word wrap on

Default
N
Booleanoptional