Template:Circa/doc: Difference between revisions
meta>TheFeds m →Parameters: Adding a code tag for consistency. |
meta>Eubulides Redo documentation to talk about new sortable parameter. |
||
| 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== | ||
'''' | This template generates an abbreviation for ''circa'' ("c."). By default the abbreviation is linked to the ''[[Circa]]'' article. | ||
===Examples=== | |||
{| class="wikitable" border="1" | |||
|- | |||
! Syntax | |||
! What it looks like | |||
|- | |||
| <code><nowiki>{{circa}}</nowiki></code> | |||
| {{circa}} | |||
|- | |||
| <code><nowiki>{{circa|1325}}</nowiki></code> | |||
| {{circa|1325}} | |||
|- | |||
| <code><nowiki>{{circa|1325|lk=no}}</nowiki></code> | |||
| {{circa|1325|lk=no}} | |||
|- | |||
| <code><nowiki>{{circa|250–200&nbsp;BC}}</nowiki></code> | |||
| {{circa|250–200 BC}} | |||
|} | |||
===Parameters=== | ===Parameters=== | ||
This template supports an optional (first, unnamed) parameter representing a year. For example, <code><nowiki>{{circa|1956}}</nowiki></code> | This template supports an optional (first, unnamed) parameter representing a year. For example, <code><nowiki>{{circa|1956}}</nowiki></code> gives "{{circa|1956}}". This differs from <code><nowiki>{{circa}} 1956</nowiki></code> in two ways. First, <code><nowiki>{{circa|1956}}</nowiki></code> puts a [[non-breaking space]] between the "c." and the number, which prevents web browsers from inserting a line break there. | ||
If the parameter "<code>sortable=yes</code>" is specified, the template generates invisible text that will cause the output to work in [[Help:Sorting|sortable]] [[Help:Tables|tables]], at the cost of causing problems for visually-impaired readers. Compare, "Col 1" and "Col 2" in the following table: | |||
{|class="sortable" | {|class="sortable" | ||
| Line 17: | Line 36: | ||
|Foo||align="right"|1066||align="right"|1066 | |Foo||align="right"|1066||align="right"|1066 | ||
|- | |- | ||
|Bar||align="right"|{{circa}} 1510||align="right"|{{circa|1510}} | |Bar||align="right"|{{circa}} 1510||align="right"|{{circa|1510|sortable=yes}} | ||
|- | |- | ||
|Baz||align="right"|1956||align="right"|1956 | |Baz||align="right"|1956||align="right"|1956 | ||
|} | |} | ||
"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. | "Col 1" uses <code><nowiki>{{circa}} 1510</nowiki></code>, and does not sort correctly. "Col 2" uses <code><nowiki>{{circa|1510|sortable=yes}}</nowiki></code> and does sort correctly. This works because <code><nowiki>{{circa|1510|sortable=yes}}</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. The downside of this approach is that the invisible text is still rendered by [[screen reader]]s that are used by visually impaired readers, and by text browsers such as [[Lynx (web browser)|Lynx]], so the table will become garbled for readers who are using assisstive technology or low-bandwith browsers. | ||
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. | |||
<includeonly><!-- | <includeonly><!-- | ||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ||
Revision as of 18:30, 10 September 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
This template generates an abbreviation for circa ("c."). By default the abbreviation is linked to the Circa article.
Examples
| Syntax | What it looks like |
|---|---|
{{circa}}
|
c. |
{{circa|1325}}
|
c. 1325 |
{{circa|1325|lk=no}}
|
c. 1325 |
{{circa|250–200 BC}}
|
c. 250–200 BC |
Parameters
This template supports an optional (first, unnamed) parameter representing a year. For example, {{circa|1956}} gives "c. 1956". This differs from {{circa}} 1956 in two ways. First, {{circa|1956}} puts a non-breaking space between the "c." and the number, which prevents 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 | c. 1510 | c. 1510 |
| Baz | 1956 | 1956 |
"Col 1" uses {{circa}} 1510, and does not sort correctly. "Col 2" uses {{circa|1510|sortable=yes}} and does sort correctly. This works because {{circa|1510|sortable=yes}} 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. 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 assisstive technology or low-bandwith browsers.
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.
