Difference between revisions of "Template:Floruit/doc"

From blackwiki
Jump to navigation Jump to search
(Sync.)
(Ce.)
Line 124: Line 124:
 
"description": "Set to \"yes\" for circa date(s)",
 
"description": "Set to \"yes\" for circa date(s)",
 
"type": "boolean",
 
"type": "boolean",
"default": "no"
+
"default": "no circa"
 
},
 
},
 
"date": {
 
"date": {
Line 139: Line 139:
 
"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": "boolean",
 
"type": "boolean",
"default": "no"
+
"default": "no sorting"
 
},
 
},
 
"b": {
 
"b": {
Line 145: Line 145:
 
"description": "Set to \"yes\" to display output in parentheses; requires a 'date' value",
 
"description": "Set to \"yes\" to display output in parentheses; requires a 'date' value",
 
"type": "boolean",
 
"type": "boolean",
"default": "no"
+
"default": "no parentheses"
 
},
 
},
 
"wrap": {
 
"wrap": {

Revision as of 20:05, 21 September 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= |sfx-lk= |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. 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 is prefixed with the abbreviation "fl.", wikilinked to its expanded form (floruit); displayable values are separated by a whitespace characters of varying lengths. 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. 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 parameter date is suggested, as some options depend on it. Incorrect values will be flagged under almost all usage scenarios (see Script error: No such module "Section link".). Parameter names are in bold; explanatory or expanded text may follow, in parentheses.

Date formatting parameters

Suggested:

  • 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.
Note: You may treat date as an unnamed parameter, and insert only its desired value.
Note: 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)

Optional:

 for an example see here

Conditional:

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

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 (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): use this parameter to append the floruit date with an era suffix preceded by a no-break space. 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.
 for an example see here
  • sfx-lk (suffix link): 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

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

  • Decade range
{{floruit|date=2010s}}
or
{{floruit|2010s}} (note)
Either generates: fl. 2010s
  • Decade range, 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 (note)
Generates: fl. 2010s
  • Year range, prefix with tooltip
{{floruit|date=2010{{en dash}}16}}|pfx2=abbr}}
Generates: fl.
  • Circa century and suffix
{{floruit|date=21st century|ca=yes|sfx=ce}}
Generates: fl.
  • Suffix wikilinked, prefix in plain text, circa century, in parentheses
{{floruit|date=21st century|b=yes|ca=yes|pfx2=no|sfx=ce|sfx-lk=yes}}
Generates: fl.
  • Sortable year, word wrap is on, prefix italicized, and suffix
{{floruit|date=050|sortable=yes|pfx1=italics|sfx=bce|wrap=yes}} (note)
Generates: fl.

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, sortable and wrap

  • Incorrect value: [error in template {{floruit}}: wrong value for the relevant-parameter option]

Parameters b, sfx and sortable

  • Date required: [error in template {{floruit}}: relevant-parameter option requires a date value]

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]

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
Bracketsb

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

Default
no parentheses
Booleanoptional
Circaca

Set to "yes" for circa date(s)

Default
no circa
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; requires a 'date' value

Stringoptional
Suffix linksfx-lk

Set to "yes" to wikilink the era suffix; requires a suffix

Default
no link
Booleanoptional
Sortablesortable

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

Default
no sorting
Booleanoptional
Word wrapwrap

Set to "yes" to turn word wrap on

Default
no wrap
Booleanoptional

See also

Footnotes

  1. 1.0 1.1 Template {{dts}} (date time sorting) has been embedded in code and becomes active when the sortable option is used. Note {{dts}} has several usage constraints.
  2. Any other value is ignored silently.
  3. When error messages appear in live usage, the included template link to {{floruit}} is active.