Template:Circa/doc: Difference between revisions
Jump to navigation
Jump to search
Ozycaevias (talk | contribs) m (1 revision imported) |
m (update /doc) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). --> | <!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). --> | ||
{{High-use | {{High-use}} | ||
{{COinS safe|n|addtext=<br />The CS1 and CS2 templates have limited [[Help:Citation_Style_1# | {{COinS safe|n|addtext=<br />The CS1 and CS2 templates have limited [[Help:Citation_Style_1#Date_format_compliance_with_Wikipedia's_Manual_of_Style|support]] for <code>c.</code> as an abbreviation in the date fields.}} | ||
==Usage== | ==Usage== | ||
This template generates an abbreviation for ''[[circa]]'': {{ | This template generates an abbreviation for ''[[wikt:circa#English|circa]]'': {{circa}} By default the abbreviation is marked with an HTML <code><abbr></code> tag, which in most browsers renders as a [[tooltip]] when hovered. | ||
===Examples=== | ===Examples=== | ||
| Line 14: | Line 14: | ||
! Notes | ! Notes | ||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{circa|1325}}</nowiki></code> | ||
| {{circa|1325}} | |||
| {{ | |||
| Default style: no line break allowed; thin space | | Default style: no line break allowed; thin space | ||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{circa|1325|lk=yes}}</nowiki></code> | ||
| {{ | | {{circa|1325|lk=yes}} | ||
| | | Replace abbreviation tooltip with a link to Wiktionary instead | ||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{circa|1325|lk=no}}</nowiki></code> | ||
| {{ | | {{circa|1325|lk=no}} | ||
| | | No abbreviation tooltip at all | ||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{circa|1000|1050}}</nowiki></code> | ||
| {{ | | {{circa|1000|1050}} | ||
| | | For a range with both dates uncertain. No tooltip on the second instance of "c." | ||
|- | |- | ||
| <code><nowiki>{{ | | <code><nowiki>{{circa|1000–1050}}</nowiki></code> | ||
| {{ | | {{circa|1000–1050}} | ||
| | | Another option for a range; but, per [[MOS:CIRCA]], prefer <code><nowiki>{{circa|1000|1050}}</nowiki></code> | ||
|} | |} | ||
===Parameters=== | ===Parameters=== | ||
Using the date itself as parameter (for example, "<code><nowiki>{{ | 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>". | ||
If the parameter {{para| | 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 absent, or set to "{{para|lk|abbr}}", the abbreviation is rendered with the HTML <code><abbr></code> 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 ''[[:wikt:circa]]'' article in Wiktionary and ''not'' an abbreviation element. <code>lk=no</code> can be used to avoid [[WP:Overlinking|overlinking]] when this template is used repeatedly in the body of an article. For example: | ||
* <code><nowiki>[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{circa|lk=no|500}}, and died {{circa|lk=no|544}}.</nowiki></code> | |||
*:→ [[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{circa|lk=no|500}}, and died {{circa|lk=no|544}}. | |||
{{circa/doc/sortable}} | |||
==Tracking categories== | |||
*{{clc|Pages using circa with unknown parameters}} | |||
{{ | |||
==See also== | ==See also== | ||
* | *{{tl|Died-in}} | ||
*{{tl|Floruit}} | *{{tl|Floruit}} | ||
*{{tl|Reign}} | *{{tl|Reign}} | ||
*[[Tempore]] | |||
==TemplateData== | |||
{{templatedata header}} | |||
}} | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 92: | Line 72: | ||
}, | }, | ||
"sortable": {}, | "sortable": {}, | ||
"lk": { | "lk": { | ||
"label": "link?", | "label": "link?", | ||
| Line 108: | Line 82: | ||
"sortable", | "sortable", | ||
"1", | "1", | ||
"lk", | "lk", | ||
"2" | "2" | ||
| Line 114: | Line 87: | ||
} | } | ||
</templatedata> | </templatedata> | ||
<includeonly>{{Sandbox other|| | |||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! --> | |||
[[Category:Time and date abbreviation templates]] | |||
}}</includeonly> | |||
Revision as of 22:12, 7 March 2022
 | This is a documentation subpage for Template:Circa. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 34,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
 | This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see COinS in Wikipedia. The CS1 and CS2 templates have limited support for c. as an abbreviation in the date fields. |
Usage
This template generates an abbreviation for circa: c. By default the abbreviation is marked with an HTML <abbr> tag, which in most browsers renders as a tooltip when hovered.
Examples
| Syntax | What it looks like | Notes |
|---|---|---|
{{circa|1325}}
|
c. 1325 | Default style: no line break allowed; thin space |
{{circa|1325|lk=yes}}
|
c. 1325 | Replace abbreviation tooltip with a link to Wiktionary instead |
{{circa|1325|lk=no}}
|
c. 1325 | No abbreviation tooltip at all |
{{circa|1000|1050}}
|
c. 1000 – c. 1050 | For a range with both dates uncertain. No tooltip on the second instance of "c." |
{{circa|1000–1050}}
|
c. 1000–1050 | Another option for a range; but, per MOS:CIRCA, prefer {{circa|1000|1050}}
|
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 |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 absent, or set to "|lk=abbr", the abbreviation is rendered with the HTML <abbr> element. If it is set to "|lk=yes" or "|lk=on", it is rendered as "c.", with a wikilink to the wikt:circa article in Wiktionary and not an abbreviation element. lk=no can be used to avoid overlinking when this template is used repeatedly in the body of an article. For example:
[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{circa|lk=no|500}}, and died {{circa|lk=no|544}}.- → Dionysius Exiguus was born c. 470, lived in Rome from c. 500, and died c. 544.
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 |
| Jaz | c. 410 | c. 410 |
"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 assistive technology or text browsers.
Tracking categories
See also
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See the monthly parameter usage report for this template.
TemplateData for Circa
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| sortable | sortable | no description | Unknown | optional |
| year | 1 | no description | String | suggested |
| link? | lk | If 'yes' or 'on', links to 'circa' article. If 'no' or 'off', does not title 'circa'.
| String | optional |
| end year | 2 | no description | String | optional |