Template:Circa/doc: Difference between revisions
meta>SMcCandlish →Parameters: Updating and clarifying docs. |
meta>Eubulides Document abbr=. Replace incorrect info about plain-text "c. 1900" with examples showing why it's not equivalent. |
||
| Line 12: | Line 12: | ||
! What it looks like | ! What it looks like | ||
|- | |- | ||
| <code><nowiki>{{circa}}</nowiki></code> | | <code><nowiki>{{circa}} 1325</nowiki></code> | ||
| {{circa}} | | {{circa}} 1325 | ||
| Line break allowed between "{{circa}}" and "1325"; normal-width space | |||
|- | |- | ||
| <code><nowiki>{{circa|1325}}</nowiki></code> | | <code><nowiki>{{circa|1325}}</nowiki></code> | ||
| {{circa|1325}} | | {{circa|1325}} | ||
| No line break allowed; thin space | |||
|- | |- | ||
| <code><nowiki>{{circa|1325|i=yes}}</nowiki></code> | | <code><nowiki>{{circa|1325|i=yes}}</nowiki></code> | ||
| {{circa|1325|i=yes}} | | {{circa|1325|i=yes}} | ||
| Like <code><nowiki>{{circa|1325}}</nowiki></code>, but with italic "''c.''" | |||
|- | |||
| <code><nowiki>{{circa|1325|lk=abbr}}</nowiki></code> | |||
| {{circa|1325|lk=abbr}} | |||
| Like <code><nowiki>{{circa|1325}}</nowiki></code>, but without the wikilink | |||
|- | |- | ||
| <code><nowiki>{{circa|1325|lk=yes}}</nowiki></code> | | <code><nowiki>{{circa|1325|lk=yes}}</nowiki></code> | ||
| {{circa|1325|lk=yes}} | | {{circa|1325|lk=yes}} | ||
| Like <code><nowiki>{{circa|1325}}</nowiki></code>, but without the abbreviation marking | |||
|- | |- | ||
| <code><nowiki>{{circa|1325|lk=no}}</nowiki></code> | | <code><nowiki>{{circa|1325|lk=no}}</nowiki></code> | ||
| {{circa|1325|lk=no}} | | {{circa|1325|lk=no}} | ||
| Like <code><nowiki>{{circa|1325}}</nowiki></code>, but with neither wikilink nor abbreviation marking | |||
|- | |||
| <code><nowiki>{{c.|1325}}</nowiki></code> | |||
| {{c.|1325}} | |||
| Shorthand for <code><nowiki>{{circa|1325|lk=no}}</nowiki></code> | |||
|- | |||
| <code><nowiki>c. 1325</nowiki></code> | |||
| c. 1325 | |||
| Line break allowed; normal-width space | |||
|- | |||
| <code><nowiki>c.&nbsp;1325</nowiki></code> | |||
| c. 1325 | |||
| No line break allowed; normal-width space | |||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{c.|250–200 BC}}</nowiki></code> | ||
| {{ | | {{c.|250–200 BC}} | ||
| Another example of shorthand. As before, no line breaks allowed, and a thin space after "c." | |||
|- | |||
| <code><nowiki>c. 250–200 BC</nowiki></code> | |||
| c. 250–200 BC | |||
| Line breaks allowed; normal-width space after "c." | |||
|} | |} | ||
| Line 39: | Line 65: | ||
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 as "{{para|lk|no}}" or "{{para|lk|off}}", the abbreviation is rendered as "{{circa|lk=no}}", without | 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 a wikilink or abbreviation element. If it is set to "{{para|lk|abbr}}", it is rendered with the abbreviation element but without the wikilink. 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}}. | ||
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 19:30, 14 January 2010
 | 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}} 1325
|
c. 1325 | Line break allowed between "c." and "1325"; normal-width space |
{{circa|1325}}
|
c. 1325 | No line break allowed; thin space |
{{circa|1325|i=yes}}
|
c. 1325 | Like {{circa|1325}}, but with italic "c."
|
{{circa|1325|lk=abbr}}
|
c. 1325 | Like {{circa|1325}}, but without the wikilink
|
{{circa|1325|lk=yes}}
|
c. 1325 | Like {{circa|1325}}, but without the abbreviation marking
|
{{circa|1325|lk=no}}
|
c. 1325 | Like {{circa|1325}}, but with neither wikilink nor abbreviation marking
|
{{c.|1325}}
|
Template:C. | Shorthand for {{circa|1325|lk=no}}
|
c. 1325
|
c. 1325 | Line break allowed; normal-width space |
c. 1325
|
c. 1325 | No line break allowed; normal-width space |
{{c.|250–200 BC}}
|
Template:C. | Another example of shorthand. As before, no line breaks allowed, and a thin space after "c." |
c. 250–200 BC
|
c. 250–200 BC | Line breaks allowed; normal-width space after "c." |
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 a wikilink or abbreviation element. If it is set to "|lk=abbr", it is rendered with the abbreviation element but without the wikilink. 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..
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.
