Difference between revisions of "Template:Floruit/doc"
(Ce.) |
(Update doc.) |
||
| Line 9: | Line 9: | ||
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 {{em|italicized}}; explanatory text is in (parentheses). | ||
{{csdoc|usage full}} | {{csdoc|usage full}} | ||
| − | :<code><nowiki>{{floruit|date= (or) </nowiki>[{{var|date-value}}]<nowiki>|ca= |sortable= | | + | :<code><nowiki>{{floruit|date= (or) </nowiki>[{{var|date-value}}]<nowiki>|ca= |sortable= |pfx1= |pfx2= |sfx= |b= |wrap= }}</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 ( ) 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 ( ) 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. | ||
| Line 41: | Line 41: | ||
===Prefix formatting parameters=== | ===Prefix formatting parameters=== | ||
Optional: | Optional: | ||
| − | *{{bxtn| | + | *{{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| | + | *{{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| | + | **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| | + | **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)}} | ||
| Line 52: | Line 52: | ||
*{{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| | + | *{{bxtn|sfx}} (suffix){{spaced en dash}} use this parameter to add an era suffix ([[MOS:ERA]]), preceded by a non-breaking space, to the {{em|floruit}} date. |
| − | **set {{para| | + | **set {{para|sfx|ad}} to display the suffix [[Anno Domini|AD]] |
| − | **set {{para| | + | **set {{para|sfx|bc}} to display the suffix [[Anno Domini|BC]] |
| − | **set {{para| | + | **set {{para|sfx|bce}} to display the suffix [[Common Era|BCE]] |
| − | **set {{para| | + | **set {{para|sfx|ce}} to display the suffix [[Common Era|CE]] |
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]] | :{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]] | ||
Optional: | Optional: | ||
| Line 76: | Line 76: | ||
:Either generates: {{floruit|2010s|b=yes}} | :Either generates: {{floruit|2010s|b=yes}} | ||
*{{anchor|plain}}{{strong|Prefix only, in plain text}} | *{{anchor|plain}}{{strong|Prefix only, in plain text}} | ||
| − | :<code><nowiki>{{floruit| | + | :<code><nowiki>{{floruit|pfx2=no}} 2010s</nowiki></code> |
| − | :Generates: {{floruit| | + | :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}} | *{{anchor|no-brc}}{{strong|Parentheses won't display without a}} {{bxt|date}} {{strong|value}} | ||
| Line 83: | Line 83: | ||
:Generates: {{floruit|b=yes}} 2010s | :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}}| | + | :<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pfx2=abbr}}</nowiki></code> |
| − | :Generates: {{floruit|date={{dash year|2010|2016}}| | + | :Generates: {{floruit|date={{dash year|2010|2016}}|pfx2=abbr}} |
:{{en dash}}{{nbsp}}{{em|uses}} {{tl|dash year}} {{em|to format year range, but please see [[#sort|Note3]]}} | :{{en dash}}{{nbsp}}{{em|uses}} {{tl|dash year}} {{em|to format year range, but please see [[#sort|Note3]]}} | ||
*{{anchor|circa}}{{strong|Circa century, prefix wikilinked, and suffix}} | *{{anchor|circa}}{{strong|Circa century, prefix wikilinked, and suffix}} | ||
| − | :<code><nowiki>{{floruit|date=21st century|ca=yes| | + | :<code><nowiki>{{floruit|date=21st century|ca=yes|sfx=ce}}</nowiki></code> |
| − | :Generates: {{floruit|date=21st century|ca=yes| | + | :Generates: {{floruit|date=21st century|ca=yes|sfx=ce}} |
*{{anchor|sort}}{{strong|Sortable, single year, prefix italicized with tooltip, word wrap is on}} | *{{anchor|sort}}{{strong|Sortable, single year, prefix italicized with tooltip, word wrap is on}} | ||
| − | :<code><nowiki>{{floruit|date=2016|sortable=yes| | + | :<code><nowiki>{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|wrap=yes}}</nowiki></code> |
| − | :Generates: {{floruit|date=2016|sortable=yes| | + | :Generates: {{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|wrap=yes}} |
*{{strong|As above, in parentheses}} | *{{strong|As above, in parentheses}} | ||
| − | :<code><nowiki>{{floruit|date=2016|sortable=yes| | + | :<code><nowiki>{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|b=yes|wrap=yes}}</nowiki></code> |
| − | :Generates: {{floruit|date=2016|sortable=yes| | + | :Generates: {{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|b=yes|wrap=yes}} |
==Redirects== | ==Redirects== | ||
| Line 110: | Line 110: | ||
{ | { | ||
"params": { | "params": { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"ca": { | "ca": { | ||
"label": "Circa", | "label": "Circa", | ||
| Line 157: | Line 143: | ||
"default": "no" | "default": "no" | ||
}, | }, | ||
| − | " | + | "pfx1": { |
| + | "label": "Prefix style", | ||
| + | "description": "Set to \"italics\" to render the prefix 'fl.' in italics", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "pfx2": { | ||
| + | "aliases": [ | ||
| + | "lk" | ||
| + | ], | ||
| + | "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", | ||
| + | "type": "string", | ||
| + | "default": "[[Floruit|fl.]]" | ||
| + | }, | ||
| + | "sfx": { | ||
"label": "Suffix", | "label": "Suffix", | ||
"description": "Adds an era suffix; options are: \"ad\", \"bc\", \"bce\", or \"ce\"; displays in uppercase", | "description": "Adds an era suffix; options are: \"ad\", \"bc\", \"bce\", or \"ce\"; displays in uppercase", | ||
| Line 168: | Line 168: | ||
"ca", | "ca", | ||
"sortable", | "sortable", | ||
| − | " | + | "pfx1", |
| − | " | + | "pfx2", |
| − | " | + | "sfx", |
"b", | "b", | ||
"wrap" | "wrap" | ||
Revision as of 18:34, 30 August 2016
| This is a documentation subpage for Template:Floruit. It contains usage information, categories and other content that is not part of the original template page. |
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.
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. Delete unused parameters. 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 may become active, in cases where {{fl.}} output needs to be sortable (for example, when used inside tables).
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.
Parameters
All parameters are optional, but note that 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 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.
- 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 following Template:Nobr, or other formatting.
- – for examples see here (unnamed) and here (not used)
- ca (circa)Template:Spaced en dashset
|ca=yesfor circa dates; the additional prefix "c.", is inserted before the date.
- – for an example see here
Conditional:
- sortableTemplate:Spaced en dashset
|sortable=yesto format the date value(s) so that they are displayed properly within sortable tables; requires a value for parameter date.
- 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. Note {{dts}} has other shortcomings. - – for an example see here
Prefix formatting parameters
Optional:
- pfx1 (prefix style)Template:Spaced en dashuse 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 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
|pfx2=abbrto 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
|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; see Script error: No such module "Section link"..
- set
Other parameters
Conditional (all require a value for parameter date):
- b (brackets)Template:Spaced en dashuse b to display the template's output in parentheses, by setting
|b=yes.
- – for an example see here
- sfx (suffix)Template:Spaced en dash use this parameter to add an era suffix (MOS:ERA), preceded by a non-breaking space, to the floruit date.
- – for an example see here
Optional:
- 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
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
- 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}}|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:
- {{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 | date 1 | Time-period or era, may be a single date or a range | String | suggested |
| Circa | ca | Set to "yes" for circa date(s)
| Boolean | optional |
| Sortable | sortable | Set to "yes" to sort the date correctly within tables; requires a 'date' value
| Boolean | optional |
| Prefix style | pfx1 | Set to "italics" to render the prefix 'fl.' 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
| String | optional |
| Suffix | sfx | Adds an era suffix; options are: "ad", "bc", "bce", or "ce"; displays in uppercase | String | optional |
| Brackets | b | Set to "yes" to display output in parentheses; requires a 'date' value
| Boolean | optional |
| Word wrap | wrap | Set to "yes" to turn word wrap on
| Boolean | optional |
See also