Template:Circa/doc: Difference between revisions
meta>TheFeds m Might as well use template to generate the lk=off example, rather than hardcoding. |
meta>TheFeds Standardizing with Template:Flr/doc. |
||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
==Usage== | ==Usage== | ||
<code><nowiki>{{circa}}</nowiki></code>, <code><nowiki>{{circa|12345}}</nowiki></code> ''or'' <code><nowiki>{{circa|12345|lk=off}}</nowiki></code> | '''''Source:''''' <code><nowiki>{{circa}}</nowiki> 12345</code>, <code><nowiki>{{circa|12345}}</nowiki></code> ''or'' <code><nowiki>{{circa|12345|lk=off}}</nowiki></code> | ||
'''''Result:''''' {{circa}} 12345, {{circa|12345}} ''or'' {{circa|12345|lk=off}} | |||
This template generates an abbreviation for [[circa]] ("c."), linked by default. | |||
===Parameters=== | ===Parameters=== | ||
| Line 30: | Line 26: | ||
If the parameter lk (for link) is set to <code>lk=off</code>, then the abbreviation will be rendered as {{circa|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.) | If the parameter lk (for link) is set to <code>lk=off</code>, then the abbreviation will be rendered as {{circa|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.) | ||
Potential future parameters could | Potential future parameters could add articles to appropriate categories, e.g. [[:Category:Year of birth missing]]. | ||
==See also== | ==See also== | ||
*[[Circa]] | *[[Circa]] | ||
<includeonly><!-- | <includeonly><!-- | ||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ||
[[Category:Internal link templates]] | |||
[[Category:Time, date and calendar templates]] | |||
</includeonly> | </includeonly> | ||
Revision as of 16:57, 20 July 2009
 | This is a documentation subpage for Template:Circa. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
Source: {{circa}} 12345, {{circa|12345}} or {{circa|12345|lk=off}}
Result: c. 12345, c. 12345 or c. 12345
This template generates an abbreviation for circa ("c."), linked by default.
Parameters
This template supports an optional (first, unnamed) parameter representing a year. For example, {{circa|1956}} renders to give c. 1956. This differs from {{circa}} 1956 in two ways, neither of which are readily apparent. First, {{circa|1956}} puts a non-breaking space in between the "c." and the number, which prevents the web browsers from inserting a line break there. The second benefit of {{circa|1956}} is that it will work in sortable tables. Compare, "Col 1" and "Col 2" in the following table:
| Title | Col 1 | Col 2 |
|---|---|---|
| Foo | 1066 | 1066 |
| Bar | c. 1510 | c. 1510 |
| Baz | 1956 | 1956 |
"Col 1" uses {{circa}} 1510, and does not sort correctly. "Col 2" uses {{circa|1510}} and does sort correctly. This works because {{circa|1510}} inserts an invisible span element at the start of the cell: <span display="none">1510</span>. Although it is not rendered, it is still seen by the sorting code and makes sorting work.
If the parameter lk (for link) is set to lk=off, then the abbreviation will be rendered as c. (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
