View source for Template:Reflist/doc

{{Documentation subpage}}
<!--{{High-use|all-pages=yes}}-->
{{notice|<nowiki />
* This page gives technical details for the {{tl|Reflist}} template. For a full overview of this template in use, see {{Wikipedia|Help:Footnotes}}.
}}
{{Transwiki guide |small=yes |text=See [[Template:Reflist/Transwiki guide|'''this information''']] on copying this template and modifying it for use on another wiki.}}
<!--{{Uses TemplateStyles|Template:Reflist/styles.css}}-->
This {{Wikipedia|Wikipedia:Citation templates|citation template}} provides formatting and organizational features for {{Wikipedia|Help:Footnotes|footnotes}}. It encapsulates the {{tag|references|s}} tag used by the {{cite.php}} MediaWiki extension to show the list of references as defined by {{tag|ref|o}} tags. It adds support for sizing the column width, groups and {{ldr}}.

==Parameters==
There are no ''required'' parameters; if none are supplied, a single-column list will be generated if there are fewer than 10 references in the list. If you have more than 10 references, it will use columns of 30em wide if your device allows this.

Optional parameters are:
* Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in {{Wikipedia|em (typography)#CSS|em}}s. Syntax (for example) {{para||30em}} with no space (i.e. not {{para||30 em}}). Note that this replaces '''colwidth'''—see {{Wikipedia|#Obsolete parameters|§&nbsp;Obsolete parameters}}.
* '''refs''': used with {{ldr}}.
* '''group''': identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., {{tlx|Reflist|2=group=groupname}} renders all references with ''groupname'' as the group name ({{tag|ref|o|params=group="groupname"}}). There are five pre-defined group names that style the list differently. See [[#Grouped references|§ Grouped references]] below.
* '''liststyle''': specifies the style used when the reference list is rendered. The default is a numbered list. When set, it will override the style set by the {{para|group}} parameter, without affecting group functionality. See [[#List styles|§ List styles]] below.
{{anchor|Multiple uses}}

==Usage==
{{markup|title=Using only footnote-style references
|<nowiki>Lorem ipsum.<ref>Source name, access date, etc.</ref>

Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

==References==
{{Reflist}}</nowiki>
|Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

{{fake heading|sub=3|References}}
{{Reflist}}
}}

{{markup|title=Using only bibliographical style references (no direct references from the text)
|<nowiki>Lorem ipsum. Lorem ipsum dolor sit amet.

==References==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}</nowiki>
|Lorem ipsum. Lorem ipsum dolor sit amet.

{{fake heading|sub=3|References}}
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
}}

{{markup|title=Using both footnote-style and bibliography-style references
|<nowiki>Lorem ipsum.<ref>Source name, access date, etc.</ref>

Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

==References==
{{Reflist}}

{{Refbegin}}
* reference 1
* reference 2
{{Refend}}</nowiki>
|Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

{{fake heading|sub=3|References}}
{{Reflist}}

{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
}}

===Columns===
{{tlx|Reflist|30em}} (for example) instructs the browser to create as many columns as possible (of width at least 30&nbsp;[[Em (typography)|em]], in this example) given the width of the display window. ([http://www.w3.org/TR/CSS21/syndata.html#length-units Units supported are em, ex, in, cm, mm, pt, pc, px], but em is almost always used.) There must not be a space between the number and the unit. Percent is not supported.

Choose a width appropriate to the typical width of the references:
* Automatic columns (default when no width is specified): Where there are only a few {{fnote}}; see, e.g., {{oldid|Silver State Arena|530211388#References|Silver State Arena (23:05, 28 December 2012)}}
* 30em: Where there are many footnotes plus a page-width Bibliography subsection: see, e.g., {{oldid|Ebola virus disease|819923970#References|Ebola virus disease (02:02, 12 January 2018)}}
* 20em: Where {{sfnote}} are used; see, e.g., {{oldid|NBR 224 and 420 Classes|442508215#Notes|NBR 224 and 420 Classes (13:32, 1 August 2011)}}.

====Example====
{{markup|title=15em wide columns (vary width of display window to see change in number of columns)
|<nowiki>Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

==References==
{{Reflist|15em}}</nowiki>
|Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

{{fake heading|sub=3|References}}
{{Reflist|15em}}<!-- note 15em used here for illustration purposes because larger value won't columnize in the "renders as" part on many screens -->
}}

The syntax {{tlx|Reflist|2}} (for example), which specifies two columns of equal width ''regardless of the available display width'', is deprecated. When you use 1 the template gives you a single column while 2 will pretend you specified 30em. When using higher column counts, it will pretend you specified 25em.

===List-defined references===
{{Further|{{Wikipedia|WP:LDR}}}}

A list of references may be defined within {{tl|Reflist}} using the {{para|refs}} parameter, just like including named {{tag|ref|params=name="..."}} elements inside the {{tag|references}} container.

====Example====
{{markup
|<nowiki>This is reference 1.<ref name="refname1" />
This is reference 2.<ref name="refname2" />

==References==
{{Reflist|refs=
<ref name="refname1">content1</ref>
<ref name="refname2">content2</ref>
}}</nowiki>
|This is reference 1.<ref name="refname1" group="decimal"/>
This is reference 2.<ref name="refname2" group="decimal"/>

{{fake heading|sub=3|References}}
{{Reflist|group=decimal|refs=
<ref name="refname1">content1</ref>
<ref name="refname2">content2</ref>
}}
}}

===Grouped references===
{{further|{{Wikipedia|WP:REFGROUP}}}}

References can be grouped into separate sections (for explanatory notes, table references, and the like) via <code>group=</code>:
:{{tag|ref|open|params=group="<var>groupname</var>"}}
where <var>groupname</var> is (for example) <code>notes</code> or <code>sources</code>. The group name need not be enclosed in quotes; this differs from the footnote marker where quotes are required if the group name includes a space.

Each group used in the article must have a matching reference list:
:{{tlx|Reflist|2=group=<var>groupname</var>}}

====Predefined groups====
{{further|{{Wikipedia|H:PREGROUP}}}}

There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting <code><nowiki>{{Reflist|group=lower-alpha}}</nowiki></code> will set the group to <code>lower-alpha</code> and will style the reference list with lower alpha characters. The matching footnote marker can be formed by {{tag|ref|params=group="lower-alpha"}}. This is made easier by a series of templates to set the group/label styles for the footnote marker and the reference list:
{{#section:Help:Footnotes|pregrouptable}}

===List styles===
{{for|technical details|{{Wikipedia|Help:Cite link labels}}}}

As noted in [[#Predefined groups|§ Predefined groups]], there are predefined groups that automatically add list styling. Using the listed templates is more convenient than using {{para|liststyle}}.

Reference lists are by default numbered lists. By using the {{para|liststyle}} parameter, you can control how the list is rendered. For example, using {{para|liststyle|upper-roman}} will result in references being labeled with [[Roman numerals]] instead of decimal numbers. The parameter accepts any valid CSS value defined for <code>list-style-type</code> as shown below.
{{CSS list-style-type values}}

It is possible to use {{para|liststyle}} so that the labels for the footnote marker and the reference list marker differ. This should be used with care as it can be confusing to readers. For example:

{{markup
|1=<nowiki><ref group="note">Reference</ref>

{{Reflist|group=note|liststyle=lower-alpha}}
</nowiki>
|2=<ref group="note">Reference</ref>

{{Reflist|group=note|liststyle=lower-alpha}}
}}

===Interaction with images===
{{Reflist hide}}
In the unusual case of an image being placed to the left of a reference list, layout problems may occur on some browsers. This can be prevented by using the columns feature.

==Technical details==
===Font size===
The font size should reduce to 90% for most browsers, but may appear to show at 100% for Internet Explorer and possibly other browsers.<ref group="general" name="fontsize" /> As of December 21, 2010, the standard {{tag|references|single}} tag has the same font styling. The smaller font may be disabled through {{myprefs|Gadgets|Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists}}.

===Browser support for columns===
{{CSS3 multiple column layout}}

Multiple columns are generated by using [[Cascading Style Sheets|CSS3]], which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with {{tl|Reflist}}.<ref group="general" name="stuffandnonsense" /><ref group="general" name="w3org1" />

These browsers '''support''' CSS3 columns:
* {{Wikipedia|Gecko (software)|Gecko}}-based browsers such as [[Mozilla Firefox]]
* {{Wikipedia|WebKit}}-based browsers such as {{Wikipedia|Safari (web browser)|Safari}} and {{Wikipedia|Google Chrome}}
* {{Wikipedia|Opera (web browser)|Opera}} from version 11.10 onward
* {{Wikipedia|Internet Explorer}} from version 10 onward

These browsers do '''not support''' CSS3 columns:
* Microsoft {{Wikipedia|MSHTML}}-based browsers including Internet Explorer up to version 9<ref group="general" name="msdn" />
*{{Wikipedia|[Opera (web browser)|Opera}} through to version 11

===Widows and orphans===
The use of columns can result in {{Wikipedia|widows and orphans}}, where a citation at the bottom of a column may be split to the top of the next column. {{Wikipedia|MediaWiki:Common.css}} includes CSS rules to prevent list items from breaking between columns. Widows may still show in extreme circumstances, such as a reference list formatted in columns where only a single reference is defined.

{{markup
|<nowiki>Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.

==References==
{{Reflist|10em}}</nowiki>
|Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.

{{fake heading|sub=3|References}}
{{Reflist|10em}}
}}

===Customizing the view===
{{Further|{{Wikipedia|Help:Reference display customization}}}}

By editing your CSS, the personal appearance of the reference list can be customized. From [[Special:Preferences|Preferences]], select the Appearance tab, then on the selected skin select Custom CSS. After editing and saving, follow the instructions at the top of the page to purge. See {{Wikipedia|Wikipedia:Skin#Customisation (advanced users)}} for more help.

'''Font size'''

The font size for all reference lists defaults to 90% of the standard size. To change it, add:

<syntaxhighlight lang="css">
ol.references,
.mw-parser-output div.reflist,
.mw-parser-output div.refbegin {
  font-size: 90%;
}
</syntaxhighlight>

Change 90% to the desired size.

'''Columns'''

To disable columns, add:

<syntaxhighlight lang="css">
.references-column-width {
  column-width: auto !important;
}
</syntaxhighlight>

'''Column dividers'''

To add dividers (rules) between columns, add:

<syntaxhighlight lang="css">
.references-column-width {
  column-rule: 1px solid #aaa;
}
</syntaxhighlight>

You can alter the appearance of the dividers by changing the values.

==Perennial suggestions==
'''Collapsing and scrolling'''

There have been a number of requests to add functionality for a collapsible or {{Wikipedia|WP:SCROLLING|scrolling}} reference list. These requests have not been fulfilled due to issues with readability, accessibility, and printing. The applicable guidelines are at {{Wikipedia|MOS:SCROLL}}. Links between the inline cite and the reference list do not work when the reference list is enclosed in a collapsed box.

To display the reference list in a scrollbox or collapsed per user, see {{Wikipedia|Help:Reference display customization}}.

For discussion on previous attempts to do this with a template, see the discussions for {{Wikipedia|Wikipedia:Templates for deletion/Log/2007 June 11#Template:Scrollref|Scrollref}} and {{Wikipedia|Wikipedia:Templates for discussion/Log/2010 May 26#Template:Refbox|Refbox}}.

'''Including the section title'''

There have been suggestions to include section header markup such as <code>==References==</code>. This is inadvisable because:
* There is no standard section name {{crossreference|(see {{section link|{{Wikipedia|WP:Manual of Style/Layout}}|Notes and references}})}}.
* When transcluded, the article will have an edit link that will confusingly open the template for editing.

==Obsolete parameters==
These parameters are no longer in use:
* '''colwidth''': Same as specifying a column-width for the first unnamed parameter. Replaced by width as unnamed first parameter.

Articles using unsupported parameters are tracked in {{clc|Pages using reflist with unknown parameters}}.

==Template data==
{{TemplateData header}}
<!--<templatedata>-->
<syntaxhighlight lang="JSON">
{
	"description": "This template displays the list of footnotes at the end of an article and provides additional formatting and organizing options. After hitting \"Apply changes\" and turning back to VE read mode, you will not see the references list. After hitting \"Publish page\" and turning back to normal read mode the reference list will reappear with the changes applied, see T53146.",
	"params": {
		"1": {
			"label": "Columns / Column width",
			"type": "string",
			"required": false,
			"description": "Two modes supported. First mode (deprecated): integer number of fixed columns into which the reference list is to be rendered.  Second mode: typographic unit of measurement such as 'em', specifying the width for the reference list columns, e.g. '33em'; spaced '33&nbsp;em' will not be recognized",
			"default": " 1 if < 11 references; otherwise 30em",
			"aliases": [
				"colwidth"
			]
		},
		"liststyle": {
			"label": "Liststyle",
			"type": "string",
			"required": false,
			"description": "Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for list-style-type",
			"default": "decimal",
			"suggestedvalues": [
				"none",
				"disc",
				"circle",
				"square",
				"decimal",
				"decimal-leading-zero",
				"lower-roman",
				"upper-roman",
				"lower-alpha",
				"upper-alpha",
				"lower-greek",
				"armenian",
				"georgian"
			]
		},
		"group": {
			"label": "Group",
			"type": "string",
			"required": false,
			"description": "Group is an identifier which restricts the references that are shown. Without this parameter, this template only shows references with no group identifier. With a group identifier specified, only references with a matching group identifier are handled. The rest are left alone."
		},
		"refs": {
			"label": "List of references",
			"type": "string",
			"required": false,
			"description": "Provides a space to define named references for use in the article. References defined in this space are not shown unless used somewhere in the article."
		}
	}
}
</syntaxhighlight>
<!--</templatedata>-->

==Limitations==
Do not use {{tl|Reflist}} or other templates or modules that use '''<nowiki>{{#tag:references}}</nowiki>''' in numbered or unnumbered lists if the list is inside an {{Wikipedia|Span and div|HTML div tag}}. See {{Wikipedia|Template talk:Reflist#Limitations|the talk page}} ([https://en.wikipedia.org/w/index.php?title=Template_talk:Reflist&oldid=942930696 permalink]) for examples and details.

:{{no mark}} {{em dash}} <nowiki>:{{Reflist}}</nowiki>
:{{no mark}} {{em dash}} <nowiki>*{{Reflist}}</nowiki>
:{{no mark}} {{em dash}} <nowiki>#{{Reflist}}</nowiki>
:{{yes check}} {{em dash}} <nowiki>{{Reflist}}</nowiki>

==See also==
* {{Wikipedia|Wikipedia:Citing sources}}&nbsp;– style guide for the citation of sources
* {{Wikipedia|Wikipedia:Citation templates}}&nbsp;– templates for use with references
* {{Wikipedia|Help:Shortened footnotes}}
* {{tl|Notelist}} and {{tl|efn}}&nbsp;– templates for use with footnotes
* {{tl|Refbegin}} and {{tl|Refend}}&nbsp;– format reference lists
* {{phab|T53260}} – Support editing {{tag|references|s}} tags to set multi-column display on/off

'''Variants'''
* {{tl|Template reference list}}&nbsp;– version of reflist for use in templates
* {{tl|Reflist-talk}} and {{tl|Sources-talk}}&nbsp;– for use in talk page sections and other non-mainspace pages

==References==
{{Reflist|group=general|refs=
<ref group="general" name="fontsize">See {{Wikipedia|User:Edokter/fonttest}} for a comparison of font sizes for various browsers; see [//en.wikipedia.org/w/index.php?title=Special%3ASearch&redirs=1&search=fonttest+prefix%3AMediaWiki+talk%3ACommon.css%2F&fulltext=Search&ns0=1 previous discussions] on changing the font size to resolve the IE issue.</ref>
<ref group="general" name="stuffandnonsense">{{cite web |accessdate=November 24, 2006 |date=December 30, 2005 |title=CSS3 Multi-Column Thriller |url=http://www.stuffandnonsense.co.uk/archives/css3_multi-column_thriller.html}}</ref>

<ref group="general" name="w3org1">{{cite web |url=http://www.w3.org/TR/css3-multicol/ |title=CSS3 module: Multi-column layout |publisher={{Wikipedia|World Wide Web Consortium|W3C}} |date=December 15, 2005 |accessdate=November 24, 2006}}</ref>
<ref group="general" name="msdn">{{cite web |url=https://docs.microsoft.com/en-us/previous-versions/cc351024(v=vs.85)#multi-column-layout |title=CSS Compatibility and Internet Explorer: Multi-column Layout |work={{Wikipedia|Microsoft Docs}} |publisher={{Wikipedia|Microsoft Developer Network}} |access-date=2021-03-19}}</ref>
}}
{{Wikipedia|Wikipedia referencing}}
{{Wikipedia|Wikipedia templates}}
{{Wikipedia|Wikipedia technical help}}
<includeonly>{{Sandbox other||
[[Category:Footnote templates]]
[[Category:Reference list templates]]
}}</includeonly>