Difference between revisions of "Template:Reflist/doc"

From Princed Wiki
Jump to: navigation, search
(Undid revision 616038700 by Jerzy (talk) Actually no longer necessary)
 
m (1 revision: Adding the "Reflist" template.)
 
(No difference)

Latest revision as of 20:17, 8 July 2014

Lua error: Internal error: The interpreter exited with status 127.

Lua error: Internal error: The interpreter exited with status 127.

Lua error: Internal error: The interpreter exited with status 127.

This citation template provides formatting and organizational features for footnotes. It encapsulates the <references /> tag used by the 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 List-defined references.

If you don't use any of the additional features, then it produces the same output as the simpler and slightly faster <references /> tag.

Parameters

  • First unnamed parameter:
column-count: a natural number specifying fixed columns into which the reference list is to be rendered. Example: |2|.
column-width: a typographic unit of measurement such as em, specifying the width for the reference list columns. Example: |30em|.
  • refs: used with named references (e.g., <ref name=name />); it specifies a list of some or all named references used in the article.
  • 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>).
  • liststyle: specifies the style used when the reference list is enumerated; if none is specified, the default is to render a numbered list.
  • close=1: forces the reference list to close and render all references defined to that point; see the section on multiple uses for details.

Usage

Using only footnote-style references
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}}
 Lorem ipsum.[1]

Lorem ipsum dolor sit amet.[2]

References
  1. ↑ Source name, access date, etc.
  2. ↑ Source name, access date, etc.
Using only bibliographical style references (no direct references from the text)
Markup Renders as
Lorem ipsum. Lorem ipsum dolor sit amet.

==References==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
 Lorem ipsum. Lorem ipsum dolor sit amet.
References
  • reference 1
  • reference 2
</dl>
Using both footnote-style and bibliography-style references
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}}
 Lorem ipsum.[1]

Lorem ipsum dolor sit amet.[2]

References
  1. ↑ Source name, access date, etc.
  2. ↑ Source name, access date, etc.
  • reference 1
  • reference 2
</dl>

Columns

Lua error: Internal error: The interpreter exited with status 127.

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. To identify articles using this deprecated feature, see Category:Articles using fixed number of columns in reflist.

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.

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

Lorem ipsum dolor sit amet.

==References==
{{Reflist|3}}
 Lorem ipsum.[1]

Lorem ipsum dolor sit amet.

References
  1. ↑ Source name, access date, etc.

Practices

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

Examples

Two columns
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|2}}
 Lorem ipsum.[1]

Lorem ipsum dolor sit amet.[2]

References
  1. ↑ Source name, access date, etc.
  2. ↑ Source name, access date, etc.
30em wide columns
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|30em}}
 Lorem ipsum.[1]

Lorem ipsum dolor sit amet.[2]

References
  1. ↑ Source name, access date, etc.
  2. ↑ Source name, access date, etc.

List styles

Lua error: Internal error: The interpreter exited with status 127.

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

Lua error: Internal error: The interpreter exited with status 127.

Multiple uses

Lua error: Internal error: The interpreter exited with status 127. <section begin=multiref /> In previous versions of MediaWiki, using {{Reflist}} multiple times in the same page required a dummy parameter to prevent template caching. The underlying bug causing the inappropriate caching has since been fixed, so dummy parameters are no longer needed and the template will work properly when used multiple times in all cases. <section end=multiref />

List-defined references

Lua error: Internal error: The interpreter exited with status 127.

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

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]

References
  1. ↑ content1
  2. ↑ content2

Grouped references

Lua error: Internal error: The interpreter exited with status 127. 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.

The general format for the reference tag is:

<ref group="groupname">

And using |group= for the reflist:

{{Reflist|group=groupname}}
Where groupname is a group identifier such as "notes", "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.

Image flow issues

  1. ↑ Lua error: Internal error: The interpreter exited with status 127.
  2. ↑ Lua error: Internal error: The interpreter exited with status 127.
  3. ↑ Lua error: Internal error: The interpreter exited with status 127.

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]
References
File:Example.png
100px
  1. ↑ Lorem ipsum dolor sit amet.
  2. ↑ 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]
References
File:Example.png
100px
  1. ↑ Lorem ipsum dolor sit amet.
  2. ↑ 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 Preferences → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.

Browser support for columns

Shortcut:
CSS3 multiple-column layout
browser support
Internet
Explorer 		Firefox Safari Chrome Opera
≤ 9 ≤ 1.0 ≤ 2 N/A ≤ 11.0
≥ 10
(2012) 		≥ 1.5
(2005) 		≥ 3
(2007) 		≥ 1
(2008) 		≥ 11.1
(2011)

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:

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

Lua error: Internal error: The interpreter exited with status 127.

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:

<source lang="css"> ol.references, div.reflist, div.refbegin { 

 font-size: 90%;

} </source>

Change 90% to the desired size.

Columns

To disable columns, add:

<source lang="css"> .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;

} </source>

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

Column dividers

To add dividers (rules) between columns, add:

<source lang="css"> .references-column-count, .references-column-width { 

 column-rule: 1px solid #aaa;
 -moz-column-rule: 1px solid #aaa;
 -webkit-column-rule: 1px solid #aaa;

} </source>

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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Reflist

<templatedata> { 

"description": "This template displays the list of footnotes at the end of an article and provides additional formatting and organizing options.",
"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\u00a0em' 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

Variants

  • {{Template reference list}} – version of reflist for use in templates
  • {{Reflist-talk}} – for use on talk pages
  • {{Notelist}} – for use with explanatory notes; sets |group=lower-alpha
  • {{Notelist-ua}} – for use with explanatory notes; sets |group=upper-alpha
  • {{Notelist-lr}} – for use with explanatory notes; sets |group=lower-roman

References

  1. ↑ 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.
  2. ↑ Lua error: Internal error: The interpreter exited with status 127.
  3. ↑ Lua error: Internal error: The interpreter exited with status 127.
  4. ↑ Lua error: Internal error: The interpreter exited with status 127.
Retrieved from "https://www.princed.org/w/index.php?title=Template:Reflist/doc&oldid=1500"