Template:Circa/doc: Difference between revisions

Latest revision as of 00:53, 3 September 2020

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.

This template is used on approximately 33,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.

Usage

This template generates an abbreviation for circa: c. By default the abbreviation is marked with <abbr>.

Examples

Syntax	What it looks like	Notes
`{{circa}} 1325`	c. 1325	Default style; line break allowed between "c." and "1325"; normal-width space
`{{circa\|1325}}`	c. 1325	Default style: no line break allowed; thin space
`{{circa\|1325\|i=yes}}`	c. 1325	With italic "c.", though italics are discouraged at MOS:CIRCA
`{{circa\|1325\|lk=abbr}}`	c. 1325	With abbreviation marking only (default)
`{{circa\|1325\|lk=yes}}`	c. 1325	With link only
`{{circa\|1325\|lk=no}}`	c. 1325	With neither link nor abbreviation marking
`{{circa\|1000\|1050}}`	c. 1000 – c. 1050	For ranges

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 non-empty 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. 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 "cap=yes" is specified, the result starts with a capital letter.

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.

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
+{{High-use| 19039 }}
+{{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.}}
 ==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 ''circa'' ("{{circa}}"). By default the abbreviation is marked with <code>&lt;abbr&gt;</code>.
 ===Examples===
+{| class="wikitable"
-{| class="wikitable" border="1"
 |-
 ! Syntax
 ! What it looks like
+! Notes
 |-
-| <code><nowiki>{{circa}}</nowiki></code>
+| <code><nowiki>{{circa}} 1325</nowiki></code>
-| {{circa}}
+| {{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
 |-
 | <code><nowiki>{{circa|1325|i=yes}}</nowiki></code>
 | {{circa|1325|i=yes}}
+| With italic "''c.''", though italics are discouraged at [[MOS:CIRCA]]
+|-
+| <code><nowiki>{{circa|1325|lk=abbr}}</nowiki></code>
+| {{circa|1325|lk=abbr}}
+| With abbreviation marking only (default)
 |-
 | <code><nowiki>{{circa|1325|lk=yes}}</nowiki></code>
 | {{circa|1325|lk=yes}}
+| With link only
 |-
 | <code><nowiki>{{circa|1325|lk=no}}</nowiki></code>
 | {{circa|1325|lk=no}}
+| With neither link nor abbreviation marking
 |-
-| <code><nowiki>{{circa|250–200&amp;nbsp;BC}}</nowiki></code>
+<!-- feature not implemented
-| {{circa|250–200&nbsp;BC}}
+| <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
 |}
 ===Parameters===
-An optional parameter represents a year or range of years. For example, "<code><nowiki>{{circa|1956}}</nowiki></code>" gives "{{circa|1956}}", marked so that web browsers do not insert a line break anywhere in the string. In contrast, "<code><nowiki>{{circa}} 1956</nowiki></code>" allows a line break between the "{{circa}}" and the number. Also, with the 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>".
-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 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 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}}.
-If the parameter {{para|lk}} (for link) is set to "{{para|lk|no}}" or to "{{para|lk|off}}", the abbreviation is rendered as "{{circa|lk=no}}", without an abbreviation element. If it is set to "{{para|lk|yes}}" or to "{{para|lk|on}}", it is rendered as "{{circa|lk=yes}}", with a wikilink to the ''[[Circa]]'' article. Otherwise, abbreviation is marked with the "<code>&lt;abbr&gt;</code>" element, as in "{{circa}}". 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. A convenient way of doing this is to use {{tl|circa}} the first time, and {{tl|c.}} thereafter. For example:
+If the parameter "<code>cap=yes</code>" is specified, the result starts with a capital letter.
-* <code><nowiki>[[Dionysius Exiguus]] was born {{circa|470}}, lived in Rome from {{c.|500}}, and died {{c.|544}}.</nowiki></code>
+{{circa/doc/sortable}}
-*:→ [[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:
+==See also==
+*[[Tempore]]
+*{{tl|Floruit}}
+*{{tl|Reign}}
-{|class="sortable"
+<includeonly>{{Sandbox other||
-|-
+<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
-!Title!!Col 1!!Col 2
+[[Category:Time and date abbreviation templates]]
-|-
-|Foo||align="right"|1066||align="right"|1066
-|-
-|Bar||align="right"|{{circa}} 1510||align="right"|{{circa|1510|sortable=yes}}
-|-
-|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|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 style="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-bandwidth browsers.
+}}</includeonly>
-<includeonly><!--
+<templatedata>
-++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
+{
-[[Category:Internal link templates]]
+	"params": {
-[[Category:Time, date and calendar templates]]
+		"1": {
-</includeonly>
+			"label": "year",
+			"type": "string",
+			"suggested": true
+		},
+		"2": {
+			"label": "end year",
+			"type": "string"
+		},
+		"sortable": {},
+		"i": {
+			"label": "italicize?",
+			"description": "If non-empty, italicizes 'c.'",
+			"example": "yes",
+			"type": "string"
+		},
+		"lk": {
+			"label": "link?",
+			"description": "If 'yes' or 'on', links to 'circa' article. If 'no' or 'off', does not title 'circa'.",
+			"example": "no",
+			"type": "string"
+		}
+	},
+	"paramOrder": [
+		"sortable",
+		"1",
+		"i",
+		"lk",
+		"2"
+	]
+}
+</templatedata>

Parameter		Description	Type	Status
sortable	`sortable`	no description	Unknown	optional
year	`1`	no description	String	suggested
italicize?	`i`	If non-empty, italicizes 'c.' Example yes	String	optional
link?	`lk`	If 'yes' or 'on', links to 'circa' article. If 'no' or 'off', does not title 'circa'. Example no	String	optional
end year	`2`	no description	String	optional

Template:Circa/doc: Difference between revisions

Latest revision as of 00:53, 3 September 2020

Contents

Usage

Examples

Parameters

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages