Template:Reflist/doc

This citation template provides formatting and organizational features for footnotes. It encapsulates the tag used by the  MediaWiki extension to show the list of references as defined by  tags. It adds support for sizing the column width, groups and.

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 ems. Syntax (for example) 30em with no space (i.e. not 30 em). Note that this replaces colwidth—see § Obsolete parameters.
 * refs: used with.
 * group: identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., renders all references with groupname as the group name . There are five pre-defined group names that style the list differently. See § 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 group parameter, without affecting group functionality. See § List styles below.

Usage
{{markup|title=Using only footnote-style references
 * Lorem ipsum.

Lorem ipsum dolor sit amet.

Columns
(for example) instructs the browser to create as many columns as possible (of width at least 30 em, in this example) given the width of the display window. (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 ; see, e.g.,
 * 30em: Where there are many footnotes plus a page-width Bibliography subsection: see, e.g.,
 * 20em: Where are used; see, e.g.,.

Example
{{markup|title=15em wide columns (vary width of display window to see change in number of columns) Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet.
 * Lorem ipsum.

List-defined references
A list of references may be defined within Reflist using the refs parameter, just like including named  elements inside the  container.

Example
{{markup This is reference 2.
 * This is reference 1.

Grouped references
References can be grouped into separate sections (for explanatory notes, table references, and the like) via :

where groupname is (for example)  or. 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:

Predefined groups
There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting  will set the group to   and will style the reference list with lower alpha characters. The matching footnote marker can be formed by . This is made easier by a series of templates to set the group/label styles for the footnote marker and the reference list:

List styles
As noted in § Predefined groups, there are predefined groups that automatically add list styling. Using the listed templates is more convenient than using liststyle.

Reference lists are by default numbered lists. By using the liststyle parameter, you can control how the list is rendered. For example, using upper-roman will result in references being labeled with Roman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined for  as shown below.

It is possible to use 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:

Interaction with images
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.

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. As of December 21, 2010, the standard tag has the same font styling. The smaller font may be disabled through.

Browser support for columns
Multiple columns are generated by using CSS3, which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with Reflist.

These browsers support CSS3 columns:
 * Gecko-based browsers such as Mozilla Firefox
 * WebKit-based browsers such as Safari and Google Chrome
 * Opera from version 11.10 onward
 * Internet Explorer from version 10 onward

These browsers do not support CSS3 columns:
 * Microsoft MSHTML-based browsers including Internet Explorer up to version 9
 * Opera through to version 11

Widows and orphans
The use of columns can result in widows and orphans, where a citation at the bottom of a column may be split to the top of the next column. 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 Lorem ipsum dolor sit amet.
 * Lorem ipsum.

Supporting CSS
Reflist uses a CSS rule in MediaWiki:Common.css to set the font size:

The following class is assigned by the template when column width is set:

The following CSS properties are utilized using the column-width templates:
 * CSS3 standard

Customizing the view
By editing your CSS, the personal appearance of the reference list can be customized. From 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 Skin for more help.

Font size

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

Change 90% to the desired size.

Columns

To disable columns, add:

Column dividers

To add dividers (rules) between columns, add:

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 scrolling reference list. These requests have not been fulfilled due to issues with readability, accessibility, and printing. The applicable guidelines are at 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 Help:Reference display customization.

For discussion on previous attempts to do this with a template, see the discussions for Scrollref and Refbox.

Including the section title

There have been suggestions to include section header markup such as. This is inadvisable because:
 * There is no standard section name.
 * 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.
 * close: Until 2014, the parameter 1 was used to work around a bug involving multiple uses of Reflist on the same page. When the bug was fixed, this was removed. (For multiple uses on talk pages and other non-article pages structured in sections, see Reflist-talk.)

Articles using unsupported parameters are tracked in.

Template data
{	"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 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." }	} }

Limitations
Do not use Reflist or other templates or modules that use   in numbered or unnumbered lists if the list is inside an HTML div tag. See the talk page (permalink) for examples and details.