Template:Reflist/doc

Add links
From Wikipedia, the free encyclopedia

This template encapsulates the ‎<references /> tag to show the list of references defined by ‎<ref>...‎</ref> 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 ‎<ref>...‎</ref> and ‎<references /> tags are part of the Cite.php MediaWiki extension.

Usage[edit]

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[edit]

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 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[edit]

Main page: Help:Cite link labels

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 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 |liststyle= does not exactly match one of the predefined values
  • The value for |liststyle= is enclosed by quotes
  • {{Reflist}} is indented with the : markup

CSS list-style-type values
CSS 2.1 list-style-type values[1]
none
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
disc
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
circle
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
square
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
decimal
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
decimal-leading-zero
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
lower-roman
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
upper-roman
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
lower-alpha
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
upper-alpha
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
lower-greek
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
armenian
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
georgian
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes


CSS2 list-style-type values dropped in CSS 2.1 but still supported by some browsers[2]
hebrew
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No
cjk-ideographic
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No
hiragana
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No
katakana
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No
hiragana-iroha
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No
katakana-iroha
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No No No No Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No


CSS3 list-style-type values (incomplete)[3]

CSS3 adds hundreds of new values, most not yet supported by major browsers.

upper-greek
  1. text
  2. text
  3. text
  4. text
Internet Explorer Firefox Safari Chrome Opera
6 7 8 9 10 3 4 5 4 5 9 10 11 12 10 11 12
No No Yes Yes Yes No No No No Yes Yes Yes Yes Yes No No No

Multiple uses[edit]

Further information: Help:Footnotes § Multiple reference lists

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=1}}.

List-defined references[edit]

Further information: WP: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 at Help:Cite errors, including one for references defined in {{Reflist}} but not used within the body.

Example[edit]

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[edit]

This is reference 1.[LDR 1] This is reference 2.[LDR 2]

  1. ^ content1
  2. ^ content2

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[edit]

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:

‎<ref group="groupname">

And using |group= for the reflist:

{{Reflist|group="groupname"}}
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[edit]

The font size should reduce to 90% for most browsers, but may appear to show at 100% for Internet Explorer and possibly other browsers.[4] As of December 21, 2010, the standard ‎<references /> 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[edit]

Browser support for columns[edit]

Shortcut
CSS3 multiple column layout
browser support
Internet
Explorer		 Firefox Safari Chrome Opera
6 3 3 < 10 10
7 4 4 11 11
8 5 5 12 12
9 6 13 13
10 7 14 14
Chrome 13 has display issues with colwidth parameter.

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}}.[5][6]

These browsers support CSS3 columns:

These browsers do not support CSS3 columns:

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

Supporting CSS[edit]

{{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[edit]

Further information: Help:Reference display customization

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[edit]

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[edit]

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[edit]

Variants

References[edit]

  1. ^ Script error: No such module "Vorlage:Internetquelle". In: Script error: No such module "Vorlage:Internetquelle". 7. Dezember 2010;.
  2. ^ Script error: No such module "Vorlage:Internetquelle". In: Script error: No such module "Vorlage:Internetquelle". 11. April 2008;.
  3. ^ Script error: No such module "Vorlage:Internetquelle". In: Script error: No such module "Vorlage:Internetquelle". 7. November 2002;.
  4. ^ See User:Edokter/fonttest for a comparison of font sizes for various browsers; see previous discussions on changing the font size to resolve the IE issue.
  5. ^ Script error: No such module "Vorlage:Internetquelle". 30. Dezember 2005, abgerufen am 24. November 2006.
  6. ^ Script error: No such module "Vorlage:Internetquelle". W3C, 15. Dezember 2005, abgerufen am 24. November 2006.
  7. ^ Script error: No such module "Vorlage:Internetquelle". In: Script error: No such module "Vorlage:Internetquelle". Microsoft, abgerufen am 16. März 2011.
Retrieved from "https://en.wikipedia.beta.wmflabs.org/w/index.php?title=Template:Reflist/doc&oldid=49506"