In Wikisource, this template is usable only in the Author and Main namespace works, which were not transcluded from the Page namespace
Thiscitation template provides formatting and organizational features for footnotes. It encapsulates the<references /> tag used by the cite.php MediaWiki extension to show the list of references as defined by<ref> tags. It adds support for a reduced font size, columns and groups.
Parameters
- Single unnamed parameter:
- column-count: anatural number specifying fixed columns into which the reference list is to be rendered. Example:
|2|. - column-width: a typographic unit of measurement such asem, specifying the width for the reference list columns. Example:
|30em|.
- colwidth: explicitly sets the column-width; do not useclose with this parameter— it is not needed and it will causecolwidth to not work.
- refs: used with named references (e.g.,
<ref name=name />); it specifies alist of some or all named references used in the article. - 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">). - liststyle: specifies the style used when the reference list is enumerated; if none is specified, the default is to render a numbered list.
- close: forces the reference list to close and render all references defined to that point; see thesection on multiple uses for details.
- line-height: default is 130%
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}} | Lorem ipsum.[1]Lorem ipsum dolor sit amet.[2] - ↑Source name, access date, etc.
- ↑Source name, access date, etc.
|
| |
Columns
Using{{reflist|2}} will create a two-column reference list, and{{reflist|3}} will create a three-column list, and so on. Choose the number of columns that is appropriate for the average width of the references on the page.
Using{{reflist|30em}} will create columns with a minimum width of 30 em, allowing the browser to automatically choose the number of columns based on the width of the web browser. Choose a column width that is appropriate for the average width of the references on the page.
Columns are currently supported by browsers such asMozilla Firefox,Google Chrome,Safari andOpera. Seebelow for more information.
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. There are CSS3 selectors that could resolve this, but they are not yet supported by any major browsers.
Examples
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>==References=={{Reflist|2}} | Lorem ipsum.[1]Lorem ipsum dolor sit amet.[2] - ↑Source name, access date, etc.
- ↑Source name, access date, etc.
|
| |
Column width 30em| 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|30em}} | Lorem ipsum.[1]Lorem ipsum dolor sit amet.[2] - ↑Source name, access date, etc.
- ↑Source name, access date, etc.
|
| |
|colwidth=30em| 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|colwidth=30em}} | Lorem ipsum.[1]Lorem ipsum dolor sit amet.[2] - ↑Source name, access date, etc.
- ↑Source name, access date, etc.
|
| |
List styles
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 items being prefixed withroman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined forlist-style-type as shown below.
The citations in the reference list will show the default decimal styling if:
- The value for
|liststyle= does not exactly match one of the predefined values - The value for
|liststyle= is enclosed by quotes - {{Reflist}} is indented with the : markup
Multiple uses
If {{Reflist}} is used multiple times without a parameter, each instance will include all of the previously defined references. To force the parser to close previous references, each use of {{Reflist}} must be forced as a new instance by the use of any parameter. If no parameter is desired, the convention is to use the undefined parameter{{reflist|close}}.
List-defined references
A list of references may be defined within {{Reflist}} using the|refs= parameter, just like including named <ref name=". . ."> elements inside the <references /> container. This has been available since September 2009. There are new error messages associated with this feature, documented atHelp:Cite errors, including one for references defined in {{Reflist}} but not used within the body.
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>}} | |
| |
Grouped references
As of June 2008, the footnotes system supports the separation of references into groups. This allows groups for explanatory notes, table references and the like. SeeWP:REFGROUP.
The general format for the reference tag is:
<ref group="groupname">
And using|group= for the reflist:
- {{reflist|group="groupname"}}
- Wheregroupname is a group identifier such as "notes", "nb" or "label".
Technical details
Browser support for columns
Multiple columns are generated by usingCSS3, which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with {{Reflist}}.[1][2]
These browserssupport CSS3 columns:
These browsers donot support CSS3 columns:
- MicrosoftTrident-based browsers including Internet Explorer through to version 9[3]
- Opera through to version 11
Supporting CSS
{{Reflist}} uses a CSS rule inMediaWiki:Common.css to set the font size:
div.reflist { font-size: 90%; }
One of the following classes is assigned by the template when either column count or column width is set:
.references-column-count and.references-column-count-n (wheren is the number of columns).references-column-width
The following CSS properties are utilized using the {{column-count}} and {{column-width}} templates:
column-count CSS3 standardcolumn-width CSS3 standard-moz-column-count Mozilla CSS extension-moz-column-width Mozilla CSS extension-webkit-column-count Webkit CSS extension-webkit-column-width Webkit CSS extension
Customizing the view
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:
ol.references,div.reflist,div.refbegin{font-size:90%;}Change 90% to the desired size.
- Columns
To disable columns, add:
.references-column-count,.references-column-width{column-count:1!important;column-width:auto!important;-moz-column-count:1!important;-moz-column-width:auto!important;-webkit-column-count:1!important;-webkit-column-width:auto!important;}Similarly, to force all reference lists to a number of columns, change the number.
- Column dividers
To add dividers (rules) between columns, add:
.references-column-count,.references-column-width{column-rule:1pxsolid#aaa;-moz-column-rule:1pxsolid#aaa;-webkit-column-rule:1pxsolid#aaa;}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 to due to issues with readability, accessibility, and printing. The applicable guidelines are at . 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, seeHelp:Reference display customization.
For discussion on previous attempts to do this with a template, see the discussions forScrollref andRefbox.
- Including the section title
There have been suggestions to include section header markup such as==References==. This is inadvisable because:
- There is no standard section name; seeWP:FNNR.
- When transcluded, the article will have an edit link that will confusingly open the template for editing.
See also
Variants
- {{smallrefs}} Use in place of
<references/> when a smaller type size is desired. - {{Template reference list}} – version of reflist for use in templates
- {{Reflist-talk}} – for use on talk pages
- {{Notelist}} – for use with explanatory notes; sets
|group=lower-alpha - {{Notelist-ua}} – for use with explanatory notes; sets
|group=upper-alpha - {{Notelist-lr}} – for use with explanatory notes; sets
|group=lower-roman
References
See also