Template:Circa/doc: Difference between revisions
meta>CmdrObot m sp: a invisible→an invisible |
meta>TheFeds Documenting addition of lk parameter for turning link off. Copyediting to highlight code segments. |
||
| 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== | ||
<nowiki>{{circa}}</nowiki> ''or'' <nowiki>{{circa|12345}}</nowiki> | <code><nowiki>{{circa}}</nowiki></code>, <code><nowiki>{{circa|12345}}</nowiki></code> ''or'' <code><nowiki>{{circa|12345|lk=off}}</nowiki></code> | ||
This template generates | This template generates an abbreviation for circa ("c."), linked by default. | ||
===Example=== | ===Example=== | ||
| Line 13: | Line 13: | ||
===Parameters=== | ===Parameters=== | ||
This template supports an optional (first, unnamed) parameter representing a year. For example, <code><nowiki>{{circa|1956}}</nowiki></code> renders to give {{circa|1956}}. This differs from <code><nowiki>{{circa}} 1956</nowiki></code> in two ways, neither of which are readily apparent. First, <code><nowiki>{{circa|1956}}</nowiki></code> 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 <nowiki>{{circa|1956}}</nowiki> is that it will work in [[Help:Sorting|sortable]] [[Help:Tables|tables]]. Compare, "Col 1" and "Col 2" in the following table: | |||
This template supports | |||
{|class="sortable" | {|class="sortable" | ||
| Line 27: | Line 26: | ||
|} | |} | ||
"Col 1" uses <nowiki>{{circa}} 1510</nowiki>, and does not sort correctly. | "Col 1" uses <code><nowiki>{{circa}} 1510</nowiki></code>, and does not sort correctly. "Col 2" uses <code><nowiki>{{circa|1510}}</nowiki></code> and does sort correctly. This works because <code><nowiki>{{circa|1510}}</nowiki></code> inserts an invisible [[span and div|span element]] at the start of the cell: <code><nowiki><span display="none">1510</span></nowiki></code>. 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 <code>lk=off</code>, then the abbreviation will be rendered as c. (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 generate appropriate categories for articles, based on type of time e.g. [[:Category:Year of birth missing]]. | Potential future parameters could generate appropriate categories for articles, based on type of time e.g. [[:Category:Year of birth missing]]. | ||
Revision as of 08:05, 19 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
{{circa}}, {{circa|12345}} or {{circa|12345|lk=off}}
This template generates an abbreviation for circa ("c."), linked by default.
Example
Source: Etaoin Shrdlu Cmfwyp (born {{circa}} 1956 in Vbgkqj) ...
Result: Etaoin Shrdlu Cmfwyp (born c. 1956 in Vbgkqj) ...
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 generate appropriate categories for articles, based on type of time e.g. Category:Year of birth missing.
