Seethis information on copying this template and modifying it for use on another wiki.
Thiscitation template provides formatting and organizational features forfootnotes. It encapsulates the<references /> tag used by theCite MediaWiki extension to show the list of references as defined by<ref> tags. It adds support for sizing the column width, groups andList-defined references.
Parameters
There are norequired 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 30 em 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 inems. Syntax (for example)|30em with no space (i.e. not|30 em). Note that this replacescolwidth—see§ Obsolete parameters.
refs: used withList-defined references. This parameter is not compatible withVisualEditor, but the equivalent syntax using<references>...</references> is.
group: identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g.,{{reflist|group=groupname}} renders all references withgroupname as the group name (<ref group="groupname">). 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
Using only footnote-style references
Markup
Renders as
Lorem ipsum.<ref>Source name, access date, etc.</ref>Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>== References =={{reflist}}
{{reflist|30em}} (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:
15em wide columns (vary width of display window to see change in number of columns)
Markup
Renders as
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}}
Lorem ipsum.[1]Lorem ipsum dolor sit amet.[2]Lorem ipsum dolor sit amet.[3]Lorem ipsum dolor sit amet.[4]Lorem ipsum dolor sit amet.[5]
The syntax{{reflist|2}} (for example), which specifies two columns of equal widthregardless of the available display width, is deprecated. When you use 1 the template produces a single column; using 2 will act as if you specified 30em; using higher column counts will act as if you specified 25em.
A list of references may be defined within{{reflist}} using the|refs= parameter, just like including named<ref name="...">...</ref> elements inside the<references>...</references> container.
This syntax isnot compatible with theVisualEditor;<references>...</references> can be used instead.
Example
Markup
Renders as
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>}}
References can be grouped into separate sections (for explanatory notes, table references, and the like) viagroup=:
<ref group="groupname">
wheregroupname is (for example)notes orsources. 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:
There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting{{reflist|group=lower-alpha}} will set the group tolower-alpha and will style the reference list with lower alpha characters. The matching footnote marker can be formed by<ref group="lower-alpha">...</ref>. This is made easier by a series of templates to set the group/label styles for the footnote marker and the reference list:
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|liststyle=upper-roman will result in references being labeled withRoman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined forlist-style-type.
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:
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 almost all browsers, but may appear to show at 100% for very old browsers, such as early versions of Internet Explorer.[general 1] As of December 21, 2010, the standard<references /> tag has the same font styling. The smaller font may be disabled throughPreferences →Gadgets → Disable smaller font sizes of elements such as infoboxes, navboxes and reference lists.
Multiple columns are generated by usingCSS. Almost all browsers should support the multi-column property and will show multiple columns with{{reflist}}.[general 2][general 3][general 4]
The use of columns can result inwidows 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
Renders as
Lorem ipsum.<ref>Source name, access date, etc.</ref>Lorem ipsum dolor sit amet.== References =={{reflist|10em}}
By editing your CSS, the personal appearance of the reference list can be customized. FromPreferences, 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. SeeWikipedia: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:
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 orscrolling reference list. These requests have not been fulfilled due to issues with readability, accessibility, and printing. The applicable guidelines are atMOS:SCROLL. Links between the inline cite and the reference list do not work when the reference list is enclosed in a collapsed box.
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.
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
String
optional
Liststyle
liststyle
Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for list-style-type
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.
String
optional
List of references
refs
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.
String
optional
Limitations
Do not use{{reflist}} or other templates or modules that use{{#tag:references}} in numbered or unnumbered lists if the list is inside anHTML div tag. Seethe talk page (permalink) for examples and details.
