View source for Template:Reference column heading/doc

{{Documentation subpage}}

{{Template shortcut|Refh|Ref heading}}
Produces an abbreviated title with a tooltip for table reference columns without taking up much space. Can be, but generally should not be, substituted.

== Usage ==
{{Demo inline|<nowiki>{{Refh}}</nowiki>}}

{{Demo inline|<nowiki>{{Refh|multi=no}}</nowiki>}}

=== In a table ===
<syntaxhighlight lang="wikitext">
{| class="wikitable"
! scope="col" | Text
! scope="col" | {{Refh}}
|-
| Content
| {{centered|<ref>...</ref>}}
|}
</syntaxhighlight>
{| class="wikitable"
! scope="col" | Text
! scope="col" | {{Refh}}
|-
| Content
| {{centered|{{Dummy reference}}}}
|}

==Frequently asked questions==
{{FAQ row
|index=1
|show=yes
|q=Why does the template use {{tq|Ref.}} rather than {{tq|Refs.}} or {{tq|Ref(s).}} for the abbreviated text?
|a=It's best for the abbreviation to be as short as possible, to keep the column narrow and create more space elsewhere. Communicating to the reader that the column contains references is essential; letting them know whether to expect one or multiple references per line is not.
}}
{{FAQ row
|index=2
|show=yes
|q=Why does the template use {{tq|Reference(s)}} rather than {{tq|Reference}} or {{tq|References}} for the tooltip text?
|a=The typical grammatical convention is for column headers to use plurals only if there are multiple elements <em>per line</em>, not in total throughout the table. For instance, you'll generally find a column header with {{tq|Name}}, not {{tq|Names}}. {{tq|Reference(s)}} indicates that some lines may have multiple references, whereas others only one. Even if a table currently has multiple references for every line, sticking with {{tq|(s)}} is best because it doesn't mislead future editors about what is required or create the possibility they forget to change the plurality if adding a new line with only a single reference. Similarly, a table that currently has only one reference per line may still wish to retain the {{tq|(s)}}. However, if it is expected that all entries in a list will have only one reference (e.g. if each line is sourced to an entry in the same comprehensive database), then {{para|plural|no}} may be used to produce the tooltip {{tq|Reference}}.
}}

== TemplateData ==
{{Templatedata header}}
<templatedata>
{
	"params": {
		"multi": {
			"description": "Specifies whether the column can contain multiple references per row and changes the texts to plural forms accordingly.",
			"type": "boolean",
			"default": "yes",
			"aliases": [
				"plural"
			],
			"suggested": true
		}
	},
	"description": "Creates a heading for table reference columns."
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Table templates]]
[[Category:Abbreviation templates]]
}}</includeonly>