Template:Wp/krj/Reflist/doc

Template:Wp/krj/Documentation subpage Template:Wp/krj/High-use Template:Wp/krj/notice Template:Wp/krj/Transwiki guide This citation template provides formatting and organizational features for footnotes. It encapsulates the Template:Wp/krj/Tag tag used by the Template:Wp/krj/Cite.php MediaWiki extension to show the list of references as defined by Template:Wp/krj/Tag tags. It adds support for sizing the column width, groups and Template:Wp/krj/Ldr.

Parameters

There are no required 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 30em 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 in ems. Syntax (for example) Template:Wp/krj/Para with no space (i.e. not Template:Wp/krj/Para). Note that this replaces colwidth—see § Obsolete parameters.
• refs: used with Template:Wp/krj/Ldr.
• group: identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., Template:Wp/krj/tlx renders all references with groupname as the group name (Template:Wp/krj/Tag). 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 Template:Wp/krj/Para parameter, without affecting group functionality. See § List styles below.

Usage

Columns

Template:Wp/krj/Tlx (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.

Choose a width appropriate to the typical width of the references:

• Automatic columns (default when no width is specified): Where there are only a few Template:Wp/krj/Fnote; see, e.g., Template:Wp/krj/Oldid
• 30em: Where there are many footnotes plus a page-width Bibliography subsection: see, e.g., Template:Wp/krj/Oldid
• 20em: Where Template:Wp/krj/Sfnote are used; see, e.g., Template:Wp/krj/Oldid.

Example

• Note 1: The syntax Template:Wp/krj/Tlx (for example), which specifies two columns of equal width regardless of the available display width, is deprecated (and is disabled for mobile view). When you use 1 the template gives you a single column while 2 will pretend you specified 30em. When using higher column counts, it will pretend you specified 25em.
• Note 2: Browser support: Internet Explorer 10+, Microsoft Edge, Firefox 2+, Chrome 4+, Safari 3.1+, Opera 11.1+

List-defined references

A list of references may be defined within Template:Wp/krj/Tl using the Template:Wp/krj/Para parameter, just like including named Template:Wp/krj/Tag elements inside the Template:Wp/krj/Tag container.

Grouped references

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

Template:Wp/krj/Tag

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:

Template:Wp/krj/Tlx

Predefined groups

There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting {{Wp/krj/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 Template:Wp/krj/Tag. This is made easier by a series of templates to set the group/label styles for the footnote marker and the reference list: Help:Footnotes

List styles

As noted in § Predefined groups, there are predefined groups that automatically add list styling. Using the listed templates is more convenient than using Template:Wp/krj/Para.

Reference lists are by default numbered lists. By using the Template:Wp/krj/Para parameter, you can control how the list is rendered. For example, using Template:Wp/krj/Para 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. Error on call to Template:cite web: Parameters url and title must be specified.

It is possible to use Template:Wp/krj/Para 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:

Interaction with images

Template:Wp/krj/Reflist hide 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 most browsers, but may appear to show at 100% for Internet Explorer and possibly other browsers. As of December 21, 2010, the standard Template:Wp/krj/Tag tag has the same font styling. The smaller font may be disabled through Template:Wp/krj/Myprefs.

Browser support for columns

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 Template:Wp/krj/Tl.

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 up to version 9
• Opera through to version 11

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

Supporting CSS

Template:Wp/krj/Tl uses a CSS rule in MediaWiki:Common.css to set the font size:

• div.reflist { font-size: 90%; }

The following class is assigned by the template when column width is set:

• .references-column-width

The following CSS properties are utilized using the Template:Wp/krj/Tl templates:

• column-width CSS3 standard
• -moz-column-width Mozilla 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. 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-width {
  -moz-column-width: auto !important;
  -webkit-column-width: auto !important;
  column-width: auto !important;
}

Column dividers

To add dividers (rules) between columns, add:

.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 Template:Wp/krj/Crossref.
• When transcluded, the article will have an edit link that will confusingly open the template for editing.

Obsolete parameters

These parameters are no longer in use:

• colwidth: Same as specifying a column-width for the first unnamed parameter. Replaced by width as unnamed first parameter.
• close: Until 2014, the parameter Template:Wp/krj/Para was used to work around a bug involving multiple uses of Template:Wp/krj/Tl on the same page. When the bug was fixed, this was removed. (For multiple uses on talk pages and other non-article pages structured in sections, see Template:Wp/krj/Tl.)

Articles using unsupported parameters are tracked in Template:Wp/krj/Clc.

Template data

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.

Template parameters

Parameter		Description	Type	Status
Columns / Column width	1 colwidth	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&nbsp;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 Default decimal	String	optional
Group	group	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

See also

• Template:Wp/krj/Phab - Cite: Support multi-column and alternative list-style for Template:Wp/krj/Tag tag (like enwiki Template:Wp/krj/Tl)
• Wikipedia:Citing sources – style guide for the citation of sources
• Wikipedia:Citation templates – templates for use with references
• Template:Wp/krj/Tl and Template:Wp/krj/Tl – format reference lists

Variants

• Template:Wp/krj/Tl – version of reflist for use in templates
• Template:Wp/krj/Tl – for use in talk page sections and other non-mainspace pages