Difference between revisions of "Template:Floruit/doc"

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(105 intermediate revisions by 17 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!--Categories go at the bottom of this page and interwikis go in Wikidata.-->
+
{{Template shortcut|fl|fl.}}
<!--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.
 
  
 +
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
==Usage==
 
==Usage==
 +
'''''Source:''''' <code><nowiki>{{fl.}}</nowiki> 1234</code>, <code><nowiki>{{fl.|1234}}</nowiki></code> ''or'' <code><nowiki>{{fl.|1234|lk=off}}</nowiki></code>
  
===Structure===
+
'''''Result:''''' {{fl.}} 1234, {{fl.|1234}} ''or'' {{fl.|1234|lk=off}}
For presentation purposes only, in the box below [brackets] indicate parameter values; variables are {{em|italicized}}; explanatory text is in (parentheses).
 
{{csdoc|usage full}}
 
:<code><nowiki>{{floruit|date= (or) </nowiki>[{{var|date-value}}]<nowiki>|ca= |sortable= |pfx1= |pfx2= |sfx= |b= |wrap= }}</nowiki></code>
 
{{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.
 
  
By default, displayable values are separated by a [[thin space]] (&#8201;); [[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).
+
This template generates an abbreviation for [[floruit]] ("fl."); by default, it has a mouse-over tooltip explaining its meaning.
  
===Applicability===
+
===Parameters===
This template may be used when exact or complete date information
+
This template supports an optional (first, unnamed) parameter representing a year. For example, {{tlx|fl.|1956}} renders to give {{fl.|1956}}. This differs from <code><nowiki>{{fl.}} 1956</nowiki></code> in that <code><nowiki>{{fl.|1956}}</nowiki></code> puts a [[non-breaking space]] in between the "fl." and the number, which prevents the web browsers from inserting a line break there.
{{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 month, year, decade, or century ranges, or may otherwise be inexact or approximate. See [[WP:APPROXDATE]] for additional guidance.
 
  
===Exceptions===
+
{{Circa/doc/sortable}}
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==
+
If the {{para|lk}} (as in "link") parameter  is set to {{para|lk|off}}, then the abbreviation will be rendered as {{fl.|lk=off}} (without a wikilink). Otherwise, the link is displayed. (This can be used to avoid [[WP:Overlinking|overlinking]] when this template is used repeatedly in the body of an article.)
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.
 
  
===Date formatting parameters===
+
Potential future parameters could add articles to appropriate categories, e.g. [[:Category:Year of birth missing]].
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}}.
 
:{{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.
 
:{{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.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
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}}.
 
:{{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.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
 
 
 
===Prefix formatting parameters===
 
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}}.
 
:{{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:
 
**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|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)}}
 
 
 
===Other parameters===
 
Conditional ({{em|all 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}}.
 
:{{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]].
 
**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|bce}} to display the suffix [[Common Era|BCE]]
 
**set {{para|sfx|ce}} to display the suffix [[Common Era|CE]]
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#circa|{{em|here}}]]
 
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}}.
 
:{{en dash}}{{nbsp}}{{em|for an example see}} [[#sort|{{em|here}}]]
 
 
 
==Examples==
 
Some of the following examples may utilize additional, embedded templates, in order to enhance presentation or clarity. Such practice is optional.
 
*{{anchor|dec}}{{strong|Decade, prefix wikilinked}}
 
:<code><nowiki>{{floruit|date=2010s}}</nowiki></code>
 
:or
 
:<code><nowiki>{{floruit|2010s}}</nowiki></code>
 
:{{en dash}}{{nbsp}}{{em|date entered without label}} {{para|date}} ({{em|[[#unnamed|Note1]]}})
 
:Either generates: {{floruit|2010s}}
 
*{{anchor|brc}}{{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}}
 
*{{anchor|plain}}{{strong|Prefix only, in plain text}}
 
:<code><nowiki>{{floruit|pfx2=no}} 2010s</nowiki></code>
 
:Generates: {{floruit|pfx2=no}} 2010s
 
:{{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}}
 
:<code><nowiki>{{floruit|date={{dash year|2010|2016}}|pfx2=abbr}}</nowiki></code>
 
: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]]}}
 
*{{anchor|circa}}{{strong|Circa century, prefix wikilinked, and suffix}}
 
:<code><nowiki>{{floruit|date=21st century|ca=yes|sfx=ce}}</nowiki></code>
 
:Generates: {{floruit|date=21st century|ca=yes|sfx=ce}}
 
*{{anchor|sort}}{{strong|Sortable, single year, prefix italicized with tooltip, word wrap is on}}
 
:<code><nowiki>{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|wrap=yes}}</nowiki></code>
 
:Generates: {{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|wrap=yes}}
 
*{{strong|As above, in parentheses}}
 
:<code><nowiki>{{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|b=yes|wrap=yes}}</nowiki></code>
 
:Generates: {{floruit|date=2016|sortable=yes|pfx1=italics|pfx2=abbr|b=yes|wrap=yes}}
 
 
 
==Redirects==
 
<!--This section is linked from within this document ([[MOS:HEAD]])-->
 
{{tlf|floruit}} has the following [[Wikipedia:redirect|redirect]]s:
 
*{{tl|fl.}}
 
*{{tl|flor}}
 
*{{tl|flor.}}
 
*{{tl|flourished}}
 
*{{tl|flr}}
 
 
 
==TemplateData==
 
{{TemplateDataHeader|floruit}}
 
<templatedata>
 
{
 
"params": {
 
"ca": {
 
"label": "Circa",
 
"description": "Set to \"yes\" for circa date(s)",
 
"type": "boolean",
 
"default": "no"
 
},
 
"date": {
 
"aliases": [
 
"1"
 
],
 
"label": "Date",
 
"description": "Time-period or era, may be a single date or a range",
 
"type": "string",
 
"suggested": true
 
},
 
"sortable": {
 
"label": "Sortable",
 
"description": "Set to \"yes\" to sort the date correctly within tables; requires a 'date' value",
 
"type": "boolean",
 
"default": "no"
 
},
 
"b": {
 
"label": "Brackets",
 
"description": "Set to \"yes\" to display output in parentheses; requires a 'date' value",
 
"type": "boolean",
 
"default": "no"
 
},
 
"wrap": {
 
"label": "Word wrap",
 
"description": "Set to \"yes\" to turn word wrap on",
 
"type": "boolean",
 
"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",
 
"description": "Adds an era suffix; options are: \"ad\", \"bc\", \"bce\", or \"ce\"; displays in uppercase",
 
"type": "string"
 
}
 
},
 
"description": "Formats the display of periods of activity or popularity for people, ideas, or movements",
 
"paramOrder": [
 
"date",
 
"ca",
 
"sortable",
 
"pfx1",
 
"pfx2",
 
"sfx",
 
"b",
 
"wrap"
 
],
 
"format": "inline"
 
}
 
</templatedata>
 
  
 
==See also==
 
==See also==
*[[Tempore]]
+
* [[Floruit]]
*{{tl|b.}}
+
* [[Circa]]
*{{tl|circa}}
+
* {{tl|Circa}}
*{{tl|reign}}
+
* {{tl|Reign}}
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<includeonly>{{Sandbox other||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Internal link templates]]
+
[[Category:Time and date abbreviation templates]]
[[Category:Time, date and calendar templates]]
 
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 04:54, 25 April 2020

Usage

Source: {{fl.}} 1234, {{fl.|1234}} or {{fl.|1234|lk=off}}

Result: fl. 1234, fl. 1234 or fl. 1234

This template generates an abbreviation for floruit ("fl."); by default, it has a mouse-over tooltip explaining its meaning.

Parameters

This template supports an optional (first, unnamed) parameter representing a year. For example, {{fl.|1956}} renders to give fl. 1956. This differs from {{fl.}} 1956 in that {{fl.|1956}} puts a non-breaking space in between the "fl." and the number, which prevents the web browsers from inserting a line break there.

If the parameter "sortable=yes" is specified, the template generates invisible text that will cause the output to work in sortable tables, at the cost of causing problems for visually-impaired readers. Compare "Col 1" and "Col 2" in the following table:

Title Col 1 Col 2
Foo 1066 1066
Bar fl. 1510 1510fl. 1510
Baz 1956 1956
Jaz fl. 410 410fl. 410

"Col 1" uses {{Floruit}} 1510, and does not sort correctly. "Col 2" uses {{Floruit|1510|sortable=yes}}, and does sort correctly. This works because {{Floruit|1510|sortable=yes}} inserts an invisible span element at the start of the cell: <span style="display:none;">1510</span>. Although it is not rendered, it is still seen by the sorting code and makes sorting work.

The downside of this approach is that the invisible text is still rendered by screen readers that are used by visually impaired readers, and by text browsers such as Lynx, so the table will become garbled for readers who are using assistive technology or text browsers.

If the |lk= (as in "link") parameter is set to |lk=off, then the abbreviation will be rendered as fl. (without a wikilink). Otherwise, the link is displayed. (This can be used to avoid overlinking when this template is used repeatedly in the body of an article.)

Potential future parameters could add articles to appropriate categories, e.g. Category:Year of birth missing.

See also