Template:Reflist/doc: Difference between revisions
From Celeste Wiki
Content deleted Content added
No edit summary |
removed red links and unusable sections |
||
Line 1: | Line 1: | ||
⚫ | This citation template provides formatting and organizational features for 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}}. |
||
{{Documentation subpage}} |
|||
{{notice|<nowiki /> |
|||
* This page gives technical details for the {{tl|reflist}} template. For a full overview of this template in use, see [[Help: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.}} |
|||
⚫ | This |
||
==Parameters== |
==Parameters== |
||
Line 10: | Line 5: | ||
Optional parameters are: |
Optional parameters are: |
||
* Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in |
* Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in ems. 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. |
||
Line 73: | Line 68: | ||
===Columns=== |
===Columns=== |
||
{{tlx|Reflist|30em}} (for example) instructs the browser to create as many columns as possible (of width at least 30 |
{{tlx|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. ([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: |
||
* Automatic columns (default when no width is specified): Where there are only a few |
* Automatic columns (default when no width is specified): Where there are only a few footnotes; |
||
* 30em: Where there are many footnotes plus a page-width Bibliography subsection |
* 30em: Where there are many footnotes plus a page-width Bibliography subsection; |
||
* 20em: Where shortened footnotes are used. |
|||
* 20em: Where {{sfnote}} are used; see, e.g., {{oldid|NBR 224 and 420 Classes|442508215#Notes|NBR 224 and 420 Classes (13:32, 1 August 2011)}}. |
|||
====Example==== |
====Example==== |
||
Line 104: | Line 99: | ||
===List-defined references=== |
===List-defined references=== |
||
{{see|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 129: | Line 122: | ||
===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>"}} |
||
Line 139: | Line 130: | ||
====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}} |
||
===List styles=== |
===List styles=== |
||
{{for|technical details|Help:Cite link labels}} |
|||
As noted in [[#Predefined groups|§ Predefined groups]], there are predefined groups that automatically add list styling. Using the listed templates is more convenient than using {{para|liststyle}}. |
As noted in [[#Predefined groups|§ Predefined groups]], there are predefined groups that automatically add list styling. Using the listed templates is more convenient than using {{para|liststyle}}. |
||
Line 170: | Line 157: | ||
==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. |
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|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 |
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 {{tl|Reflist}}. |
||
These browsers '''support''' CSS3 columns: |
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: |
These browsers do '''not support''' CSS3 columns: |
||
* Microsoft |
* Microsoft Trident-based browsers including Internet Explorer up to version 9 |
||
* |
* Opera through to version 11 |
||
===Widows and orphans=== |
===Widows and orphans=== |
||
The use of columns can result in |
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 |
{{markup |
||
Line 210: | Line 197: | ||
* <code>.references-column-width</code> |
* <code>.references-column-width</code> |
||
The following CSS properties are utilized using the |
The following CSS properties are utilized using the column-width templates: |
||
* <code>column-width</code> CSS3 standard |
* <code>column-width</code> CSS3 standard |
||
===Customizing the view=== |
===Customizing the view=== |
||
⚫ | |||
{{see|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 |
||
'''Font size''' |
'''Font size''' |
||
Line 253: | Line 238: | ||
You can alter the appearance of the dividers by changing the values. |
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 [[WP:SCROLLING|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 [[Wikipedia:Templates for deletion/Log/2007 June 11#Template:Scrollref|Scrollref]] and [[Wikipedia:Templates for discussion/Log/2010 May 26#Template:Refbox|Refbox]]. |
|||
'''Including the section title''' |
|||
There have been suggestions to include section header markup such as <code>==References==</code>. This is inadvisable because: |
|||
* 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. |
|||
==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 {{para|close|1}} was used to work around a bug involving multiple uses of {{tl|Reflist}} 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 {{tl|Reflist-talk}}.)'' |
|||
Articles using unsupported parameters are tracked in {{clc|Pages using reflist with unknown parameters}}. |
|||
==Template data== |
==Template data== |
||
Line 316: | Line 279: | ||
==Limitations== |
==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 |
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 HTML div tag. |
||
:{{no mark}} {{em dash}} <nowiki>:{{reflist}}</nowiki> |
:{{no mark}} {{em dash}} <nowiki>:{{reflist}}</nowiki> |
||
Line 323: | Line 286: | ||
:{{yes check}} {{em dash}} <nowiki>{{reflist}}</nowiki> |
:{{yes check}} {{em dash}} <nowiki>{{reflist}}</nowiki> |
||
==See also== |
|||
* [[Wikipedia:Citing sources]] – style guide for the citation of sources |
|||
* [[Wikipedia:Citation templates]] – templates for use with references |
|||
* {{tl|Refbegin}} and {{tl|Refend}} – format reference lists |
|||
* {{phab|T53260}} – Support editing <references /> tags to set multi-column display on/off |
|||
'''Variants''' |
|||
* {{tl|Template reference list}} – version of reflist for use in templates |
|||
* {{tl|Reflist-talk}} and {{tl|Sources-talk}} – for use in talk page sections and other non-mainspace pages |
|||
==References== |
|||
{{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="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="msdn">{{cite web |url=http://msdn.microsoft.com/en-us/library/cc351024(VS.85).aspx#multicolumn |title=CSS Compatibility and Internet Explorer: Multi-column Layout |work=Microsoft Developer Network |publisher=Microsoft |accessdate=March 16, 2011}}</ref> |
|||
}} |
|||
{{Wikipedia referencing}} |
|||
{{Wikipedia templates}} |
|||
{{Wikipedia technical help}} |
|||
<includeonly>{{Sandbox other|| |
<includeonly>{{Sandbox other|| |
||
[[Category: |
[[Category:Citation templates]] |
||
[[Category:Reference list templates]] |
|||
}}</includeonly> |
}}</includeonly> |