Difference between revisions of "Template:Reflist/doc"

Latest revision as of 14:07, 16 July 2015

This page gives technical details for the {{reflist}} template. For a full overview of this template in use, see Help:Footnotes. Columns are not supported by some older browsers, most notably Internet Explorer 9 and below and Opera 11.0 and below. See below for more information.

This citation template provides formatting and organizational features for footnotes. It encapsulates the <references /> tag used by the Template:Cite.php MediaWiki extension to show the list of references as defined by <ref> tags. It adds support for a reduced font size, columns, groups and Template:Ldr.

Parameters

• First unnamed parameter:

  column-count: a natural number specifying fixed columns into which the reference list is to be rendered. Example: |2 – this feature is deprecated as described below and should no longer be used.

  column-width: a typographic unit of measurement such as em, specifying the width for the reference list columns. Example: |30em.

• refs: used with Template:Ldr.
• 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 with groupname 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.

{{safesubst:#invoke:anchor|main}}

Obsolete

These parameters are obsolete and should be removed or replaced when encountered.

• colwidth: same as specifying a column-width for the first unnamed parameter.
• close: Until 2014 the parameter |close=1 was used to work around a bug involving multiple uses of {{Reflist}} on the same page.

Usage

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. Lorem ipsum dolor sit amet.

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

Lorem ipsum.<ref>Source name, access date, etc.</ref>

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

==References==
{{Reflist}}

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

Columns

Browser support: Internet Explorer 10+, Firefox 2+, Chrome 4+, Safari 3.1+, Opera 11.1+

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. A width measurement must conform to the format given in CSS 2.1 Syntax and basic data types: Lengths; in particular, there must not be a space between the number and the unit.

Using {{Reflist|2}} will force creation of a two-column reference list, and {{Reflist|3}} will force creation of a three-column list, and so on. This feature is now deprecated in favor of the option described above, which is better suited to flexible formatting for a variety of display screen sizes, ranging from mobile phones and tablets to wide-screen "cinema" displays. Forcing a fixed number of columns has been disabled in mobile view.

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 avoid 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.

Lorem ipsum.<ref>Source name, access date, etc.</ref>

Lorem ipsum dolor sit amet.

==References==
{{Reflist|3}} 

Practices

The number of columns to use is up to the editor, but some major practices include:

• 1 column (default): Where there are only a few Template:Fnote; see Template:Oldid
• 30em: Where there are many footnotes plus a page-width Bibliography subsection: see Template:Oldid
• 20em: Where Template:Sfnote are used; see Template:Oldid.

Examples

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.<ref>Source name, access date, etc.</ref>

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

==References==
{{Reflist|30em}} 

List-defined references

Template:See

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 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" />

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

Grouped references

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

<ref group=groupname>

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

{{Reflist|group=groupname}}

Predefined groups

Template:Details 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 to lower-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: {{#section:Help:Footnotes|pregrouptable}}

List styles

{{#invoke:Hatnote|hatnote}}

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 with Roman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined for list-style-type as shown below. Template:CSS list-style-type values

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:

<ref group=note>Reference</ref>

{{Reflist|group=note|liststyle=lower-alpha}}
 

Image flow issues

Template:Reflist hide When an image is inserted to the left of the reference list, the list may flow under the image, clipping the reference numbers or hiding them behind the image frame, depending upon the browser.

Markup	Renders as
Lorem ipsum dolor sit amet.<ref>Lorem ipsum dolor sit amet.</ref><ref>Lorem ipsum dolor sit amet.</ref> ==References== [[File:Example.png|left|thumb|100px]] {{Reflist}}	Lorem ipsum dolor sit amet.[1][2] Template:Fake heading ↑ Lorem ipsum dolor sit amet. ↑ Lorem ipsum dolor sit amet.

To resolve this issue, use the columns feature. If columns are not desired, simply set it to one column using {{reflist|1}}. Note that if the list is longer than the image, it will cause the space below the image to remain empty. It is recommended that a comment be added so that follow-on editors will understand the use.

Markup	Renders as
Lorem ipsum dolor sit amet.<ref>Lorem ipsum dolor sit amet.</ref><ref>Lorem ipsum dolor sit amet.</ref> ==References== [[File:Example.png|left|thumb|100px]] {{Reflist|1}}<!--Set one column to resolve flow issues with left floated image.-->	Lorem ipsum dolor sit amet.[1][2] Template:Fake heading ↑ Lorem ipsum dolor sit amet. ↑ Lorem ipsum dolor sit amet.

Technical details

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.^[1] As of December 21, 2010, the standard <references /> tag has the same font styling. The smaller font may be disabled through Template:Myprefs.

Browser support for columns

Template: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}}.^[2][3]

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 Trident-based browsers including Internet Explorer through to version 9^[4]
• 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 number 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

Template: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 {
  -moz-column-count: 1 !important;
  -moz-column-width: auto !important;
  -webkit-column-count: 1 !important;
  -webkit-column-width: auto !important;
  column-count: 1 !important;
  column-width: auto !important;
}

Similarly, to force all reference lists to a certain number of columns, change the number to the desired ammount.

Column dividers

To add dividers (rules) between columns, add:

.references-column-count, .references-column-width {
  -moz-column-rule: 1px solid #aaa;
  -webkit-column-rule: 1px solid #aaa;
  column-rule: 1px solid #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 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 ==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.

Template data

<templatedata> { "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 \"Save 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: 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'; note that '33 em' will not be recognized", "default": "1", "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" }, "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." } } } </templatedata>

See also

• Template:Phab - Cite: Support multi-column and alternative list-style for <references /> tag (like enwiki {{reflist}})
• Wikipedia:Citing sources – style guide for the citation of sources
• Wikipedia:Citation templates – templates for use with references
• {{Refbegin}} and {{Refend}} – format reference lists

Variants

• {{Template reference list}} – version of reflist for use in templates
• {{Reflist-talk}} – for use on talk pages
• {{Reflistp}} – for use in previews; it does not show a reference list when saved and it adds a tracking category for later cleanup

References