ଛାଞ୍ଚ:reflist/doc

This template encapsulates the ଛାଞ୍ଚ:tag tag to show the list of references defined by ଛାଞ୍ଚ:tag tags, with some formatting. It reduces the font size and has options for columns and groups. References can be defined within the body of the article or within the reference list.

The ଛାଞ୍ଚ:tag and ଛାଞ୍ଚ:tag tags are part of the Cite.php MediaWiki extension.

Usage

Using only footnote-style references

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

== References ==
{{Reflist}}

Using only bibliographical style references (no direct references from the text)

== Content ==
Lorem ipsum. Lorem ipsum dolor sit amet.

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

Using both footnote-style and bibliography-style references

== References ==
{{Reflist}}

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

Columns

Using ଛାଞ୍ଚ:tlx will create a two-column reference list, and ଛାଞ୍ଚ:tlx 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 ଛାଞ୍ଚ:tlx 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 only by Gecko-based browsers (such as Mozilla Firefox) and WebKit-based browsers (such as Google Chrome and Safari). See below for more information.

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. There are CSS3 selectors that could resolve this, but they are not yet supported by any major browsers.

See also bug combining grouped references and columns

List styles

ଛାଞ୍ଚ:main Reference lists are by default numbered lists. By using the ଛାଞ୍ଚ:para parameter, you can control how the list is rendered. For example, using ଛାଞ୍ଚ:para will result in items being prefixed with roman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined for list-style-type as shown below.

The citations in the reference list will show the default decimal styling if:

• The value for ଛାଞ୍ଚ:para does not exactly match one of the predefined values
• The value for ଛାଞ୍ଚ:para 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 ଛାଞ୍ଚ:tlx.

List-defined references

ଛାଞ୍ଚ:see A list of references may be defined within {{Reflist}}

using the ଛାଞ୍ଚ:para 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 at Help:Cite errors, including one for references defined in {{Reflist}}

but not used within the body.

Example

This is reference 1.<ref name="refname1" />
This is reference 2.<ref name="refname2" />

{{Reflist|refs=
<ref name="refname1">content1</ref>
<ref name="refname2">content2</ref>
}}

Result

This is reference 1. This is reference 2.

The LDR group text is to avoid conflicts with other groups of references in this documentation and would not be present in real use.

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. See WP:REFGROUP.

The general format for the reference tag is:

ଛାଞ୍ଚ:tag

And using ଛାଞ୍ଚ:para for the reflist:

ଛାଞ୍ଚ:tlx

Where groupname would be a group identifier such as "note", "nb" or "label".

There are three pre-defined group names that will automatically cause the link labels and this template to display other characters instead of numbers (see List styles above). These are: "lower-alpha" (a, b, c...), "lower-greek" (α, β, γ...) and "lower-roman" (i, ii, iii...) and must be written without quotes.

See also bug combining grouped references and columns

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 tag has the same font styling. The smaller font may be disabled through Special:Preferences → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.

Technical details

Browser support for columns

ଛାଞ୍ଚ:CSS3 multiple column layout 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 10 Platform Preview

These browsers do not support CSS3 columns:

• Microsoft Trident-based browsers including Internet Explorer through to version 9
• Opera through to version 11

Supporting CSS

{{Reflist}}

uses a CSS rule in MediaWiki: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 (where n is the numer of columns)
• .references-column-width

The following CSS properties are utilized using the {{column-count}}

and {{column-width}}

templates:

• column-count CSS3 standard
• column-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

ଛାଞ୍ଚ:see 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 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:

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: 1px solid #aaa;
    -moz-column-rule: 1px solid #aaa;
    -webkit-column-rule: 1px solid #aaa;
}

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

Bugs

ଛାଞ୍ଚ:anchor Note that, whereas {{reflist|15em|group="e"}} works as expected, {{reflist|15em |group="e"}} (with an extra space) currently does not display in columns.

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 to 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 ==References==. This is inadvisable because:

• There is no standard section name; see WP:FNNR
• When transcluded, the article will have an edit link that will confusingly open the template for editing

See also

• Wikipedia:Citing sources – style guide for the citation of sources
• Wikipedia:Manual of Style (footnotes) – style guide for footnotes and inline citations
• Wikipedia:Citation templates – templates for use with references
• {{Template reference list}}

 – version of reflist for use in templates

• {{Refbegin}}

and {{Refend}}

 – format reference lists

• {{Reflist-talk}}

 – for use on talk pages