Template:Reflist/doc: Difference between revisions
Jump to navigation
Jump to search
Ozycaevias (talk | contribs) m (1 revision imported) |
m (→top: +{{Lua}}) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | <noinclude>{{pp-protected|small=yes}}</noinclude>{{Documentation subpage}} | ||
{{High-use | {{High-use|all-pages=yes}} | ||
{{notice|<nowiki /> | {{notice|<nowiki /> | ||
* This page gives technical details for the {{tl| | * This page gives technical details for the {{tl|Reflist}} template. For a full overview of this template in use, see [[Help:Footnotes]]. | ||
}} | }} | ||
{{Template shortcut|refs|rflist}} | |||
{{Template redirect|Reference|Reference list|Footnotes}} | |||
{{Transwiki guide |small=yes |text=See [[Template:Reflist/Transwiki guide|'''this information''']] on copying this template and modifying it for use on another wiki.}} | {{Transwiki guide |small=yes |text=See [[Template:Reflist/Transwiki guide|'''this information''']] on copying this template and modifying it for use on another wiki.}} | ||
This [[Wikipedia:Citation templates|citation template]] provides formatting and organizational features for [[Help:Footnotes|footnotes]]. | {{Lua|Module:Check for unknown parameters}} | ||
{{Uses TemplateStyles|Template:Reflist/styles.css}} | |||
This [[Wikipedia:Citation templates|citation template]] provides formatting and organizational features for [[Help:Footnotes|footnotes]]. It encapsulates the {{tag|references|s}} tag used by the {{cite.php}} MediaWiki extension to show the list of references as defined by {{tag|ref|o}} tags. It adds support for sizing the column width, groups and {{ldr}}. | |||
==Parameters== | ==Parameters== | ||
| Line 13: | Line 17: | ||
* Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in [[em (typography)#CSS|em]]s. Syntax (for example) {{para||30em}} with no space (i.e. not {{para||30 em}}). Note that this replaces '''colwidth'''—see [[#Obsolete parameters|§ Obsolete parameters]]. | * Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in [[em (typography)#CSS|em]]s. Syntax (for example) {{para||30em}} with no space (i.e. not {{para||30 em}}). Note that this replaces '''colwidth'''—see [[#Obsolete parameters|§ Obsolete parameters]]. | ||
* '''refs''': used with {{ldr}}. | * '''refs''': used with {{ldr}}. | ||
* '''group''': identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., {{tlx|Reflist|2=group=groupname}} renders all references with groupname as the group name ({{tag|ref|o|params=group=groupname}}). There are five pre-defined group names that style the list differently. See [[#Grouped references|§ Grouped references]] below. | * '''group''': identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., {{tlx|Reflist|2=group=groupname}} renders all references with ''groupname'' as the group name ({{tag|ref|o|params=group="groupname"}}). There are five pre-defined group names that style the list differently. See [[#Grouped references|§ 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 {{para|group}} parameter, without affecting group functionality. See [[#List styles|§ List styles]] 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 {{para|group}} parameter, without affecting group functionality. See [[#List styles|§ List styles]] below. | ||
{{anchor|Multiple uses}} | {{anchor|Multiple uses}} | ||
| Line 74: | Line 78: | ||
===Columns=== | ===Columns=== | ||
{{tlx|Reflist|30em}} (for example) instructs the browser to create as many columns as possible (of width at least 30 [[Em (typography)|em]], in this example) given the width of the display window. ([http://www.w3.org/TR/CSS21/syndata.html#length-units 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. | {{tlx|Reflist|30em}} (for example) instructs the browser to create as many columns as possible (of width at least 30 [[Em (typography)|em]], in this example) given the width of the display window. ([http://www.w3.org/TR/CSS21/syndata.html#length-units 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. Percent is not supported. | ||
Choose a width appropriate to the typical width of the references: | Choose a width appropriate to the typical width of the references: | ||
| Line 101: | Line 105: | ||
}} | }} | ||
The syntax {{tlx|Reflist|2}} (for example), which specifies two columns of equal width ''regardless of the available display width'', is deprecated. 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. | |||
===List-defined references=== | ===List-defined references=== | ||
{{ | {{Further|WP:LDR}} | ||
A list of references may be defined within {{tl|Reflist}} using the {{para|refs}} parameter, just like including named {{tag|ref|params=name="..."}} elements inside the {{tag|references}} container. | A list of references may be defined within {{tl|Reflist}} using the {{para|refs}} parameter, just like including named {{tag|ref|params=name="..."}} elements inside the {{tag|references}} container. | ||
| Line 119: | Line 122: | ||
<ref name="refname2">content2</ref> | <ref name="refname2">content2</ref> | ||
}}</nowiki> | }}</nowiki> | ||
|This is reference 1.<ref name="refname1" group=decimal/> | |This is reference 1.<ref name="refname1" group="decimal"/> | ||
This is reference 2.<ref name="refname2" group=decimal/> | This is reference 2.<ref name="refname2" group="decimal"/> | ||
{{fake heading|sub=3|References}} | {{fake heading|sub=3|References}} | ||
| Line 130: | Line 133: | ||
===Grouped references=== | ===Grouped references=== | ||
{{ | {{further|WP:REFGROUP}} | ||
References can be grouped into separate sections (for explanatory notes, table references, and the like) via <code>group=</code>: | References can be grouped into separate sections (for explanatory notes, table references, and the like) via <code>group=</code>: | ||
:{{tag|ref|open|params=group=<var>groupname</var>}} | :{{tag|ref|open|params=group="<var>groupname</var>"}} | ||
where <var>groupname</var> is (for example) <code>notes</code> or <code>sources</code>. 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. | where <var>groupname</var> is (for example) <code>notes</code> or <code>sources</code>. 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. | ||
| Line 140: | Line 143: | ||
====Predefined groups==== | ====Predefined groups==== | ||
{{ | {{further|H:PREGROUP}} | ||
There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting <code><nowiki>{{Reflist|group=lower-alpha}}</nowiki></code> will set the group to <code>lower-alpha</code> and will style the reference list with lower alpha characters. The matching footnote marker can be formed by {{tag|ref|params=group=lower-alpha}}. This is made easier by a series of templates to set the group/label styles for the footnote marker and the reference list: | There are predefined group names that automatically set the labels in the footnote markers and the reference list to other styles. Thus, setting <code><nowiki>{{Reflist|group=lower-alpha}}</nowiki></code> will set the group to <code>lower-alpha</code> and will style the reference list with lower alpha characters. The matching footnote marker can be formed by {{tag|ref|params=group="lower-alpha"}}. 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}} | {{#section:Help:Footnotes|pregrouptable}} | ||
| Line 156: | Line 159: | ||
{{markup | {{markup | ||
|1=<nowiki><ref group=note>Reference</ref> | |1=<nowiki><ref group="note">Reference</ref> | ||
{{Reflist|group=note|liststyle=lower-alpha}} | {{Reflist|group=note|liststyle=lower-alpha}} | ||
</nowiki> | </nowiki> | ||
|2=<ref group=note>Reference</ref> | |2=<ref group="note">Reference</ref> | ||
{{Reflist|group=note|liststyle=lower-alpha}} | {{Reflist|group=note|liststyle=lower-alpha}} | ||
| Line 171: | Line 174: | ||
==Technical details== | ==Technical details== | ||
===Font size=== | ===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.<ref group=general name=fontsize /> As of December 21, 2010, the standard {{tag|references|single}} tag has the same font styling. The smaller font may be disabled through {{myprefs|Gadgets|Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists}}. | The font size should reduce to 90% for most browsers, but may appear to show at 100% for Internet Explorer and possibly other browsers.<ref group="general" name="fontsize" /> As of December 21, 2010, the standard {{tag|references|single}} tag has the same font styling. The smaller font may be disabled through {{myprefs|Gadgets|Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists}}. | ||
===Browser support for columns=== | ===Browser support for columns=== | ||
{{CSS3 multiple column layout}} | {{CSS3 multiple column layout}} | ||
Multiple columns are generated by using [[Cascading Style Sheets|CSS3]], which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with {{tl|Reflist}}.<ref group=general name="stuffandnonsense" /><ref group=general name="w3org1" /> | Multiple columns are generated by using [[Cascading Style Sheets|CSS3]], which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with {{tl|Reflist}}.<ref group="general" name="stuffandnonsense" /><ref group="general" name="w3org1" /> | ||
These browsers '''support''' CSS3 columns: | These browsers '''support''' CSS3 columns: | ||
* [[Gecko ( | * [[Gecko (software)|Gecko]]-based browsers such as [[Mozilla Firefox]] | ||
* [[WebKit]]-based browsers such as [[Safari (web browser)|Safari]] and [[Google Chrome]] | * [[WebKit]]-based browsers such as [[Safari (web browser)|Safari]] and [[Google Chrome]] | ||
* [[Opera (web browser)|Opera]] from version 11.10 onward | * [[Opera (web browser)|Opera]] from version 11.10 onward | ||
| Line 185: | Line 188: | ||
These browsers do '''not support''' CSS3 columns: | These browsers do '''not support''' CSS3 columns: | ||
* Microsoft [[ | * Microsoft [[MSHTML]]-based browsers including Internet Explorer up to version 9<ref group="general" name="msdn" /> | ||
* [[Opera (web browser)|Opera]] through to version 11 | * [[Opera (web browser)|Opera]] through to version 11 | ||
| Line 203: | Line 206: | ||
{{Reflist|10em}} | {{Reflist|10em}} | ||
}} | }} | ||
===Customizing the view=== | ===Customizing the view=== | ||
{{ | {{Further|Help:Reference display customization}} | ||
By editing your CSS, the personal appearance of the reference list can be customized. From [[Special:Preferences|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. | By editing your CSS, the personal appearance of the reference list can be customized. From [[Special:Preferences|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. | ||
| Line 225: | Line 216: | ||
The font size for all reference lists defaults to 90% of the standard size. To change it, add: | The font size for all reference lists defaults to 90% of the standard size. To change it, add: | ||
< | <syntaxhighlight lang="css"> | ||
ol.references, | ol.references, | ||
div.reflist, | .mw-parser-output div.reflist, | ||
div.refbegin { | .mw-parser-output div.refbegin { | ||
font-size: 90%; | font-size: 90%; | ||
} | } | ||
</ | </syntaxhighlight> | ||
Change 90% to the desired size. | Change 90% to the desired size. | ||
| Line 239: | Line 230: | ||
To disable columns, add: | To disable columns, add: | ||
< | <syntaxhighlight lang="css"> | ||
.references-column-width { | .references-column-width { | ||
column-width: auto !important; | column-width: auto !important; | ||
} | } | ||
</ | </syntaxhighlight> | ||
'''Column dividers''' | '''Column dividers''' | ||
| Line 251: | Line 240: | ||
To add dividers (rules) between columns, add: | To add dividers (rules) between columns, add: | ||
< | <syntaxhighlight lang="css"> | ||
.references-column-width { | .references-column-width { | ||
column-rule: 1px solid #aaa; | column-rule: 1px solid #aaa; | ||
} | } | ||
</ | </syntaxhighlight> | ||
You can alter the appearance of the dividers by changing the values. | You can alter the appearance of the dividers by changing the values. | ||
| Line 273: | Line 260: | ||
There have been suggestions to include section header markup such as <code>==References==</code>. This is inadvisable because: | There have been suggestions to include section header markup such as <code>==References==</code>. This is inadvisable because: | ||
* There is no standard section name {{ | * There is no standard section name {{crossreference|(see {{section link|WP:Manual of Style/Layout|Notes and references}})}}. | ||
* When transcluded, the article will have an edit link that will confusingly open the template for editing. | * When transcluded, the article will have an edit link that will confusingly open the template for editing. | ||
| Line 279: | Line 266: | ||
These parameters are no longer in use: | 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. | * '''colwidth''': Same as specifying a column-width for the first unnamed parameter. Replaced by width as unnamed first parameter. | ||
Articles using unsupported parameters are tracked in {{clc|Pages using reflist with unknown parameters}}. | Articles using unsupported parameters are tracked in {{clc|Pages using reflist with unknown parameters}}. | ||
==Template data== | ==Template data== | ||
{{ | {{TemplateData header}} | ||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 293: | Line 279: | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
"description": "Two modes supported. | "description": "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 em' will not be recognized", | ||
"default": " 1 if < 11 references; otherwise 30em", | "default": " 1 if < 11 references; otherwise 30em", | ||
"aliases": [ | "aliases": [ | ||
| Line 304: | Line 290: | ||
"required": false, | "required": false, | ||
"description": "Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for list-style-type", | "description": "Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for list-style-type", | ||
"default": "decimal" | "default": "decimal", | ||
"suggestedvalues": [ | |||
"none", | |||
"disc", | |||
"circle", | |||
"square", | |||
"decimal", | |||
"decimal-leading-zero", | |||
"lower-roman", | |||
"upper-roman", | |||
"lower-alpha", | |||
"upper-alpha", | |||
"lower-greek", | |||
"armenian", | |||
"georgian" | |||
] | |||
}, | }, | ||
"group": { | "group": { | ||
| Line 321: | Line 322: | ||
} | } | ||
</templatedata> | </templatedata> | ||
==Limitations== | |||
Do not use {{tl|Reflist}} or other templates or modules that use '''<nowiki>{{#tag:references}}</nowiki>''' in numbered or unnumbered lists if the list is inside an [[Span and div|HTML div tag]]. See [[Template talk:Reflist#Limitations|the talk page]] ([https://en.wikipedia.org/w/index.php?title=Template_talk:Reflist&oldid=942930696 permalink]) for examples and details. | |||
:{{no mark}} {{em dash}} <nowiki>:{{Reflist}}</nowiki> | |||
:{{no mark}} {{em dash}} <nowiki>*{{Reflist}}</nowiki> | |||
:{{no mark}} {{em dash}} <nowiki>#{{Reflist}}</nowiki> | |||
:{{yes check}} {{em dash}} <nowiki>{{Reflist}}</nowiki> | |||
==See also== | ==See also== | ||
* [[Wikipedia:Citing sources]] – style guide for the citation of sources | * [[Wikipedia:Citing sources]] – style guide for the citation of sources | ||
* [[Wikipedia:Citation templates]] – templates for use with references | * [[Wikipedia:Citation templates]] – templates for use with references | ||
* [[Help:Shortened footnotes]] | |||
* {{tl|Notelist}} and {{tl|efn}} – templates for use with footnotes | |||
* {{tl|Refbegin}} and {{tl|Refend}} – format reference lists | * {{tl|Refbegin}} and {{tl|Refend}} – format reference lists | ||
* {{phab|T53260}} – Support editing {{tag|references|s}} tags to set multi-column display on/off | |||
'''Variants''' | '''Variants''' | ||
| Line 334: | Line 345: | ||
==References== | ==References== | ||
{{Reflist|group=general|refs= | {{Reflist|group=general|refs= | ||
<ref group=general name=fontsize>See [[User:Edokter/fonttest]] for a comparison of font sizes for various browsers; see [//en.wikipedia.org/w/index.php?title=Special%3ASearch&redirs=1&search=fonttest+prefix%3AMediaWiki+talk%3ACommon.css%2F&fulltext=Search&ns0=1 previous discussions] on changing the font size to resolve the IE issue.</ref> | <ref group="general" name="fontsize">See [[User:Edokter/fonttest]] for a comparison of font sizes for various browsers; see [https://en.wikipedia.org/w/index.php?title=Special%3ASearch&redirs=1&search=fonttest+prefix%3AMediaWiki+talk%3ACommon.css%2F&fulltext=Search&ns0=1 previous discussions] on changing the font size to resolve the IE issue.</ref> | ||
<ref group=general name=stuffandnonsense>{{cite web |accessdate=November 24, 2006 |date=December 30, 2005 |title=CSS3 Multi-Column Thriller |url=http://www.stuffandnonsense.co.uk/archives/css3_multi-column_thriller.html}}</ref> | <ref group="general" name="stuffandnonsense">{{cite web |accessdate=November 24, 2006 |date=December 30, 2005 |title=CSS3 Multi-Column Thriller |url=http://www.stuffandnonsense.co.uk/archives/css3_multi-column_thriller.html}}</ref> | ||
<ref group=general name=w3org1>{{cite web |url=http://www.w3.org/TR/css3-multicol/ |title=CSS3 module: Multi-column layout |publisher=[[World Wide Web Consortium|W3C]] |date=December 15, 2005 |accessdate=November 24, 2006}}</ref> | <ref group="general" name="w3org1">{{cite web |url=http://www.w3.org/TR/css3-multicol/ |title=CSS3 module: Multi-column layout |publisher=[[World Wide Web Consortium|W3C]] |date=December 15, 2005 |accessdate=November 24, 2006}}</ref> | ||
<ref group=general name=msdn>{{cite web |url= | <ref group="general" name="msdn">{{cite web |url=https://docs.microsoft.com/en-us/previous-versions/cc351024(v=vs.85)#multi-column-layout |title=CSS Compatibility and Internet Explorer: Multi-column Layout |work=[[Microsoft Docs]] |publisher=[[Microsoft Developer Network]] |access-date=2021-03-19}}</ref> | ||
}} | }} | ||
{{Wikipedia referencing}} | {{Wikipedia referencing}} | ||
{{Wikipedia | {{Wikipedia templates}} | ||
{{Wikipedia technical help}} | {{Wikipedia technical help}} | ||
<includeonly> | <includeonly>{{Sandbox other|| | ||
{{ | |||
[[Category:Footnote templates]] | [[Category:Footnote templates]] | ||
[[Category:Reference list templates]] | [[Category:Reference list templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Revision as of 17:00, 19 September 2023
 | This is a documentation subpage for Template:Reflist. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 5,220,000 pages, or roughly 3320% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
 |
|
 | See this information on copying this template and modifying it for use on another wiki. |
 | This template uses Lua: |
null
This citation template provides formatting and organizational features for footnotes. It encapsulates the <references /> tag used by the Cite MediaWiki extension to show the list of references as defined by <ref> tags. It adds support for sizing the column width, groups and List-defined references.
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)
|30emwith no space (i.e. not|30 em). Note that this replaces colwidth—see § Obsolete parameters. - refs: used with List-defined references.
- 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.
Usage
| 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}}
|
|
| Markup | Renders as |
|---|---|
Lorem ipsum. Lorem ipsum dolor sit amet.
==References==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
|
Lorem ipsum. Lorem ipsum dolor sit amet.
|
| 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}}
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
|
|
Columns
{{Reflist|30em}} (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. Percent is not supported.
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 Footnotes; see, e.g., Silver State Arena (23:05, 28 December 2012)
- 30em: Where there are many footnotes plus a page-width Bibliography subsection: see, e.g., Ebola virus disease (02:02, 12 January 2018)
- 20em: Where Shortened footnotes are used; see, e.g., NBR 224 and 420 Classes (13:32, 1 August 2011).
Example
| Markup | Renders as |
|---|---|
Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
==References==
{{Reflist|15em}}
|
|
The syntax {{Reflist|2}} (for example), which specifies two columns of equal width regardless of the available display width, is deprecated. 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.
List-defined references
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.
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>
}}
|
This is reference 1.[decimal 1] This is reference 2.[decimal 2] |
Grouped references
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
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
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.
CSS list-style-type values
| none |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
...but still supported by some browsers.
| hebrew |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
|---|
|
| 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 |
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:
| Markup | Renders as |
|---|---|
<ref group="note">Reference</ref>
{{Reflist|group=note|liststyle=lower-alpha}}
|
|
Interaction with images
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.[general 1] As of December 21, 2010, the standard <references /> tag has the same font styling. The smaller font may be disabled through Preferences → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.
Browser support for columns
| Property | Internet Explorer |
Firefox | Safari | Chrome | Opera |
|---|---|---|---|---|---|
| column-width column-count |
≥ 10 (2012) |
≥ 1.5 (2005) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
| columns | ≥ 10 (2012) |
≥ 9 (2011) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
| break-before break-after break-inside |
≥ 10 (2012) |
≥ 65 (2019) |
≥ 10 (2016) |
≥ 65 (2016) |
≥ 15 (2013) |
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}}.[general 2][general 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 MSHTML-based browsers including Internet Explorer up to version 9[general 4]
- 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.
| Markup | Renders as |
|---|---|
Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.
==References==
{{Reflist|10em}}
|
|
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,
.mw-parser-output div.reflist,
.mw-parser-output div.refbegin {
font-size: 90%;
}
Change 90% to the desired size.
Columns
To disable columns, add:
.references-column-width {
column-width: auto !important;
}
Column dividers
To add dividers (rules) between columns, add:
.references-column-width {
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 .
- 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.
Articles using unsupported parameters are tracked in Category:Pages using reflist with unknown parameters (0).
Template data
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
TemplateData for Reflist
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.
| 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 em' will not be recognized
| String | optional |
| Liststyle | liststyle | Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for list-style-type
| 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 |
Limitations
Do not use {{Reflist}} or other templates or modules that use {{#tag:references}} in numbered or unnumbered lists if the list is inside an HTML div tag. See the talk page (permalink) for examples and details.
- Template:No mark Template:Em dash :{{Reflist}}
- Template:No mark Template:Em dash *{{Reflist}}
- Template:No mark Template:Em dash #{{Reflist}}
- Template:Yes check Template:Em dash {{Reflist}}
See also
- Wikipedia:Citing sources – style guide for the citation of sources
- Wikipedia:Citation templates – templates for use with references
- Help:Shortened footnotes
- {{Notelist}} and {{efn}} – templates for use with footnotes
- {{Refbegin}} and {{Refend}} – format reference lists
- T53260 – Support editing
<references />tags to set multi-column display on/off
Variants
- {{Template reference list}} – version of reflist for use in templates
- {{Reflist-talk}} and {{Sources-talk}} – for use in talk page sections and other non-mainspace pages
References
- ↑ 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.
- ↑ "CSS3 Multi-Column Thriller". December 30, 2005. Retrieved November 24, 2006.
- ↑ "CSS3 module: Multi-column layout". W3C. December 15, 2005. Retrieved November 24, 2006.
- ↑ "CSS Compatibility and Internet Explorer: Multi-column Layout". Microsoft Docs. Microsoft Developer Network. Retrieved 2021-03-19.