Template:Circa/doc: Difference between revisions
meta>Eubulides No need for in example, since it now spans. |
meta>SMcCandlish →Parameters: Updating and clarifying docs. |
||
| Line 32: | Line 32: | ||
===Parameters=== | ===Parameters=== | ||
Using the date itself as parameter (for example, "<code><nowiki>{{circa|1956}}</nowiki></code>", giving "{{circa|1956}}"), web browsers do not insert a line break anywhere in the string. By contrast, "<code><nowiki>{{circa}} 1956</nowiki></code>" allows a line break between the "{{circa}}" and the number. Also, with the date as a parameter a thinner space is used with many browsers: | |||
* "{{circa|1956}}" is generated by "<code><nowiki>{{circa|1956}}</nowiki></code>". | * "{{circa|1956}}" is generated by "<code><nowiki>{{circa|1956}}</nowiki></code>". | ||
| Line 39: | Line 39: | ||
If the parameter {{para|i}} is set to a nonempty value, the "c." is put in italics: for example, "<code><nowiki>{{circa|i=''}}</nowiki></code>" generates "{{circa|i=''}}" instead of "{{circa}}". | If the parameter {{para|i}} is set to a nonempty value, the "c." is put in italics: for example, "<code><nowiki>{{circa|i=''}}</nowiki></code>" generates "{{circa|i=''}}" instead of "{{circa}}". | ||
If the parameter {{para|lk}} (for link) is set | If the parameter {{para|lk}} (for "link") is set as "{{para|lk|no}}" or "{{para|lk|off}}", the abbreviation is rendered as "{{circa|lk=no}}", without an abbreviation element. If it is set to "{{para|lk|yes}}" or "{{para|lk|on}}", it is rendered as "{{circa|lk=yes}}", with a wikilink to the ''[[Circa]]'' article and ''not'' an abbreviation element. Otherwise, the abbreviation is marked with the "<code><abbr></code>" element, as in "{{circa}}" ''and'' linked to the [[circa]] article. The <code>lk</code> parameter can be used to avoid overuse of "<code><abbr></code>" or [[WP:Overlinking|overlinking]] when this template is used repeatedly in the body of an article. A convenient way of doing this is to use {{tl|circa}} the first time, and {{tl|c.}} thereafter. For example: | ||
* <code><nowiki>[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}.</nowiki></code> | * <code><nowiki>[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}.</nowiki></code> | ||
*:→ [[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}. | *:→ [[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}. | ||
This need only be done where sortability ''(see below)'' of the dates is desired, e.g. in a table. Otherwise, uses of "c." after the first should simply be "c." in plain text. | |||
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: | 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: | ||
Revision as of 23:30, 1 December 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 marked with <abbr>.
Examples
| Syntax | What it looks like |
|---|---|
{{circa}}
|
c. |
{{circa|1325}}
|
c. 1325 |
{{circa|1325|i=yes}}
|
c. 1325 |
{{circa|1325|lk=yes}}
|
c. 1325 |
{{circa|1325|lk=no}}
|
c. 1325 |
{{circa|250–200 BC}}
|
c. 250–200 BC |
Parameters
Using the date itself as parameter (for example, "{{circa|1956}}", giving "c. 1956"), web browsers do not insert a line break anywhere in the string. By contrast, "{{circa}} 1956" allows a line break between the "c." and the number. Also, with the date as a parameter a thinner space is used with many browsers:
- "c. 1956" is generated by "
{{circa|1956}}". - "c. 1956" is generated by "
{{circa}} 1956".
If the parameter |i= is set to a nonempty value, the "c." is put in italics: for example, "{{circa|i=''}}" generates "c." instead of "c.".
If the parameter |lk= (for "link") is set as "|lk=no" or "|lk=off", the abbreviation is rendered as "c.", without an abbreviation element. If it is set to "|lk=yes" or "|lk=on", it is rendered as "c.", with a wikilink to the Circa article and not an abbreviation element. Otherwise, the abbreviation is marked with the "<abbr>" element, as in "c." and linked to the circa article. The lk parameter can be used to avoid overuse of "<abbr>" or overlinking when this template is used repeatedly in the body of an article. A convenient way of doing this is to use {{circa}} the first time, and {{c.}} thereafter. For example:
[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}.- → Dionysius Exiguus was born c. 470, lived in Rome from Template:C., and died Template:C..
This need only be done where sortability (see below) of the dates is desired, e.g. in a table. Otherwise, uses of "c." after the first should simply be "c." in plain text.
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 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 assisstive technology or low-bandwidth browsers.
