Template:Circa/doc: Difference between revisions

Jump to navigation Jump to search
(add another example for ranges, without repeating c.)
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
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| 19039 }}
{{High-use}}
{{COinS safe|n|addtext=<br />The CS1 and CS2 templates have limited [[Help:Citation_Style_1#CS1_compliance_with_Wikipedia's_Manual_of_Style|support]] for <code>c.</code> as an abbreviation in the date fields.}}
{{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]]'': {{Circa}} By default the abbreviation is marked with <code>&lt;abbr&gt;</code>.
This template generates an abbreviation for ''[[wikt:circa#English|circa]]'': {{circa}} By default the abbreviation is marked with an HTML <code>&lt;abbr&gt;</code> tag, which in most browsers renders as a [[tooltip]] when hovered.


===Examples===
===Examples===
Line 14: Line 14:
! Notes
! Notes
|-
|-
| <code><nowiki>{{Circa}} 1325</nowiki></code>
| <code><nowiki>{{circa|1325}}</nowiki></code>
| {{Circa}} 1325
| {{circa|1325}}
| Default style; line break allowed between "{{Circa}}" and "1325"; normal-width space
|-
| <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>{{Circa|1325|i=yes}}</nowiki></code>
| <code><nowiki>{{circa|1325|lk=yes}}</nowiki></code>
| {{Circa|1325|i=yes}}
| {{circa|1325|lk=yes}}
| With italic "''c.''", though italics are discouraged at [[MOS:CIRCA]]
| Replace abbreviation tooltip with a link to Wiktionary instead
|-
|-
| <code><nowiki>{{Circa|1325|lk=abbr}}</nowiki></code>
| <code><nowiki>{{circa|1325|lk=no}}</nowiki></code>
| {{Circa|1325|lk=abbr}}
| {{circa|1325|lk=no}}
| With abbreviation marking only (default)
| No abbreviation tooltip at all
|-
|-
| <code><nowiki>{{Circa|1325|lk=yes}}</nowiki></code>
| <code><nowiki>{{circa|1000|1050}}</nowiki></code>
| {{Circa|1325|lk=yes}}
| {{circa|1000|1050}}
| With link only
| For a range with both dates uncertain. No tooltip on the second instance of "c."
|-
|-
| <code><nowiki>{{Circa|1325|lk=no}}</nowiki></code>
| <code><nowiki>{{circa|1000–1050}}</nowiki></code>
| {{Circa|1325|lk=no}}
| {{circa|1000–1050}}
| With neither link nor abbreviation marking
| Another option for a range; but, per [[MOS:CIRCA]], prefer <code><nowiki>{{circa|1000|1050}}</nowiki></code>  
|-
| <code><nowiki>{{Circa|1350|cap=yes}}</nowiki></code>
| {{Circa|1350|cap=yes}}
| Starting with capital letter
|-
| <code><nowiki>{{Circa|1000|1050}}</nowiki></code>
| {{Circa|1000|1050}}
| For ranges
|-
| <code><nowiki>{{Circa|1000}}–1050</nowiki></code>
| {{Circa|1000}}–1050
| For ranges in a more compact form (without spaces and extra "c.")
|}
|}


===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:
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>".
* "{{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|i}} is set to a non-empty 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 a wikilink or abbreviation element. If it is absent, or set to "{{para|lk|abbr}}", the abbreviation is rendered with the HTML <code>&lt;abbr&gt;</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:


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>&lt;abbr&gt;</code>" element, as in "{{Circa}}", ''and'' linked to the [[Circa]] article. The <code>lk</code> parameter can be used to avoid overuse of "<code>&lt;abbr&gt;</code>" or [[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}}.


* <code><nowiki>[[Dionysius Exiguus]] was born {{Circa|470}}, lived in Rome from {{Circa|lk=no|500}}, and died {{Circa|lk=no|544}}.</nowiki></code>
{{circa/doc/sortable}}
*:→ [[Dionysius Exiguus]] was born {{Circa|470}}, lived in Rome from {{Circa|lk=no|500}}, and died {{Circa|lk=no|544}}.


If the parameter "<code>cap=yes</code>" is specified, the result starts with a capital letter.
==Tracking categories==
 
*{{clc|Pages using circa with unknown parameters}}
{{Circa/doc/sortable}}


==See also==
==See also==
*[[Tempore]]
*{{tl|Died-in}}
*{{tl|Floruit}}
*{{tl|Floruit}}
*{{tl|Reign}}
*{{tl|Reign}}
*[[Tempore]]


<includeonly>{{Sandbox other||
==TemplateData==
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
{{templatedata header}}
[[Category:Time, date and calendar templates]]
[[Category:Internal link templates]]
 
}}</includeonly>
<templatedata>
<templatedata>
{
{
Line 92: Line 72:
},
},
"sortable": {},
"sortable": {},
"i": {
"label": "italicize?",
"description": "If non-empty, italicizes 'c.'",
"example": "yes",
"type": "string"
},
"lk": {
"lk": {
"label": "link?",
"label": "link?",
Line 108: Line 82:
"sortable",
"sortable",
"1",
"1",
"i",
"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>

Latest revision as of 03:35, 22 March 2022

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 1510 c. 1510
Baz 1956 1956
Jaz c. 410 0410 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.

Template parameters

ParameterDescriptionTypeStatus
sortablesortable

no description

Unknownoptional
year1

no description

Stringsuggested
link?lk

If 'yes' or 'on', links to 'circa' article. If 'no' or 'off', does not title 'circa'.

Example
no
Stringoptional
end year2

no description

Stringoptional


Retrieved from "https://iiwiki.us/mediawiki/index.php?title=Template:Circa/doc&oldid=477060"