Template:Ombox/core and Template:Reflist/doc: Difference between pages

From nonlocal pde
(Difference between pages)
Jump to navigation Jump to search
imported>RayAYang
m (1 revision)
 
imported>Edokter
m (Reverted edits by Nfried (talk) to last version by Webistrator)
 
Line 1: Line 1:
<table class="plainlinks ombox {{#ifeq:{{{small}}}|yes|mbox-small}}  
{{documentation subpage}}
{{#switch:{{{type|}}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
| speedy    = ombox-speedy
<includeonly>{{high-risk|1,800,000+}}</includeonly>
| delete    = ombox-delete
{{ombox | type=notice | text = Columns are currently supported only by newer versions of [[Gecko (layout engine)|Gecko]]-based browsers (such as [[Mozilla Firefox]]) and [[WebKit]]-based browsers (such as [[Google Chrome]] and [[Safari (web browser)|Safari]]).  '''All versions of [[Internet Explorer]] through to version 9 and [[Opera (web browser)|Opera]] through to version 11 do not support columns.'''  See [[#Browser support for columns|below]] for more information.}}
| content    = ombox-content
 
| style     = ombox-style
This template encapsulates the {{tag|references |single}} tag to show the list of references defined by {{tag|ref}} tags,  with some formatting. It reduces the font size and has options for columns and groups. References can be defined within the body of the article or within the reference list.
| move      = ombox-move
 
| protection = ombox-protection
The {{tag|ref}} and {{tag|references |single}} tags are part of the [[mw:Extension:Cite/Cite.php|Cite.php]] MediaWiki extension.
| notice          <!-- notice = default -->
 
| #default  = ombox-notice
== Usage ==
}}" style="{{{style|}}}">
 
<tr>
;Using only footnote-style references
{{#ifeq:{{{image|}}}|none
<pre>
| <!-- No image. Cell with some width or padding necessary for text cell to have 100% width. --><td class="mbox-empty-cell"></td>
== Content ==
| <td class="mbox-image">
Lorem ipsum.<ref>Source name, access date, etc.</ref>
  {{#if:{{{image|}}}
 
  | {{{image}}}
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
  | [[Image:{{#switch:{{{type|}}}
 
    | speedy    = Imbox speedy deletion.png
== References ==
    | delete    = Imbox deletion.png
{{Reflist}}
    | content    = Imbox content.png
</pre>
    | style      = Edit-clear.svg
 
    | move      = Imbox move.png
;Using only bibliographical style references
    | protection = Imbox protection.png
<pre>
    | notice          <!-- notice = default -->
== Content ==
    | #default  = Imbox notice.png
Lorem ipsum.
    }} | {{#ifeq:{{{small|}}}|yes
 
    | 30x30px
Lorem ipsum dolor sit amet.
    | 40x40px
 
    }}|link=|alt=]]
== References ==
  }}</td>
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
</pre>
 
;Using both footnote-style and bibliography-style references
<pre>
 
== Content ==
 
Lorem ipsum.<ref>Source name, access date, etc.</ref>
 
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>
 
Lorem ipsum.
 
Lorem ipsum dolor sit amet.
 
== References ==
 
{{Reflist}}
 
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
</pre>
 
== 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 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 [[Special:Preferences]] → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.
 
== Columns ==
 
Using {{tlx|Reflist|2}} will create a two-column reference list, and {{tlx|Reflist|3}} will create a three-column list, and so on. Choose the number of columns that is appropriate for the average width of the references on the page.
 
Using {{tlx|Reflist|30em}} will create columns with a minimum width of 30[[Em (typography)|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.
 
Columns are currently supported only by [[Gecko (layout engine)|Gecko]]-based browsers (such as [[Mozilla Firefox]]) and [[WebKit]]-based browsers (such as [[Google Chrome]] and [[Safari (browser)|Safari]]). See [[#Browser support for columns|below]] for more information.
 
See also [[#groupandcolumn|bug combining grouped references and columns]]
 
== List styles ==
 
{{ombox | type=notice | text='''This is an experimental feature that may be subject to change.'''<br />See [[Wikipedia:Manual of Style (footnotes)/Cite link labels]] for more information. }}
Reference lists are by default numbered lists. By using the <code>liststyle=</code> parameter, you can control how the list is rendered. For example, using <code>liststyle = upper-roman</code> will result in items being prefixed with [[roman numerals]] instead of decimal numbers. The parameter accepts any valid CSS value defined for <code>list-style-type</code> as shown below.
 
{{CSS list-style-type values}}
 
== Multiple uses ==
 
If {{tl|Reflist}} is used multiple times without a parameter, each instance will include all of the previously defined references. To force the parser to close previous references, each use of {{tl|Reflist}} must be forced as a new instance by the use of any parameter. Even an undefined parameter such as {{tlx|Reflist|close&#61;1}} will force the references to close.
 
== Grouped references ==
 
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. See [[WP:REFGROUP]].
 
The general format for the reference tag would be:
 
:{{tag|ref|open|params=group=''"groupname"''}}
 
And for the reflist:
:{{tlx|Reflist|2=group=''"groupname"''}}
 
:Where ''groupname'' would be a group identifier such as "note", "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|List styles]] above). These are: "lower-alpha" (a, b, c...), "lower-greek" (α, β, γ...) and "lower-roman" (i, ii, iii...).
 
See also [[#groupandcolumn|bug combining grouped references and columns]]
 
== List-defined references ==
 
{{see|WP:LDR}}
As of September 2009, references may be defined within {{tl|Reflist}} using {{para|refs}} and invoked within the content. There are new error messages associated with this update, documented at [[Help:Cite errors]]. As usual, groups can be used. Defined references must be used within the body; unused references will show an error message.
 
=== Example ===
 
<pre>
This is reference 1.<ref name="refname1" group="groupname" />
This is reference 2.<ref name="refname2" group="groupname" />
This is reference 3.<ref name="refname3" group="groupname" />
 
{{Reflist|group="groupname"|refs=
<ref name="refname1" group="groupname">content1</ref>
<ref name="refname2" group="groupname">content2</ref>
<ref name="refname3" group="groupname">content3</ref>
}}
}}
<td class="mbox-text" style="{{{textstyle|}}}"> {{{text}}} </td>
</pre>
{{#if:{{{imageright|}}}
 
| {{#ifeq:{{{imageright|}}}|none
=== Result ===
  | <!-- No image. -->
 
  | <td class="mbox-imageright"> {{{imageright}}} </td>
This is reference 1.<ref name="refname1" group="groupname"/>
  }}
This is reference 2.<ref name="refname2" group="groupname"/>
This is reference 3.<ref name="refname3" group="groupname"/>
 
{{Reflist|group="groupname"|refs=
<ref name="refname1">content1</ref>
<ref name="refname2">content2</ref>
<ref name="refname3">content3</ref>
}}
}}
</tr>
</table><!-- Detect and report usage with faulty "type" parameter:
-->{{#switch:{{{type|}}}
|  <!-- No type fed, is also valid input -->
| speedy
| delete
| content
| style
| move
| protection
| notice    =    <!-- Do nothing, valid "type" -->
| #default  = <div style="text-align: center;">This message box is using an invalid "type={{{type|}}}" parameter and needs fixing.</div>[[Category:Wikipedia message box parameter needs fixing|{{main other|Main:}}{{FULLPAGENAME}}]]<!-- Sort on namespace -->
}}<noinclude>


{{documentation}}
== Technical details ==
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
</noinclude>
=== Browser support for columns ===
 
{{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 name="stuffandnonsense" /><ref name="w3org1" />
 
These browsers '''support''' CSS3 columns:
* [[Gecko (layout engine)|Gecko]]-based browsers such as [[Mozilla Firefox]]
* [[WebKit]]-based browsers such as [[Safari (web browser)|Safari]] and [[Google Chrome]]
* [[Opera (web browser)|Opera]] from version 11.10 onward
* [[Internet Explorer]] 10 Platform Preview
 
These browsers do '''not support''' CSS3 columns:
* Microsoft [[Trident (layout engine)|Trident]]-based browsers including Internet Explorer through to version 9<ref name=msdn />
* [[Opera (web browser)|Opera]] through to version 11
 
=== Supporting CSS ===
 
{{tl|Reflist}} uses a CSS rule in [[MediaWiki:Common.css]] to set the font size:
 
* <code>div.reflist { font-size: 90%; }</code>
 
One of the following classes is assigned by the template when either column count or column width is set:
 
* <code>.references-column-count</code> and <code>.references-column-count-''n''</code> (where <code>''n''</code> is the numer of columns)
* <code>.references-column-width</code>
 
The following CSS properties are utilized using the {{tl|column-count}} and {{tl|column-width}} templates:
 
* <code>column-count</code> CSS3 standard
* <code>column-width</code> CSS3 standard
* <code>-moz-column-count</code> Mozilla CSS extension
* <code>-moz-column-width</code> Mozilla CSS extension
* <code>-webkit-column-count</code> Webkit CSS extension
* <code>-webkit-column-width</code> Webkit CSS extension
 
=== 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. 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.
 
===Bugs===
{{anchor|groupandcolumn}}
Note that, whereas <nowiki>{{reflist|15em|group="e"}}</nowiki> works as expected, <nowiki>{{reflist|15em |group="e"}}</nowiki> (with an extra space) currently does not display in columns.
 
== 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 to 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; see [[WP:FNNR]]
* When transcluded, the article will have an edit link that will confusingly open the template for editing
 
== See also ==
 
* [[Wikipedia:Citing sources]]&nbsp;– style guide for the citation of sources
* [[Wikipedia:Footnotes]]&nbsp;– style guide for footnotes and inline citations
* [[Wikipedia:Citation templates]]&nbsp;– templates for use with references
* {{tl|Template reference list}}&nbsp;– version of reflist for use in templates
* {{tl|Refbegin}} and {{tl|Refend}}&nbsp;– format reference lists
* {{tl|Reflist-talk}}&nbsp;– for use on talk pages
 
== References ==
 
{{Reflist|refs=
 
<ref name=fontsize>See [[User:Edokter/fonttest]] for a comparison of font sizes for various browsers; see [http://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 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 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 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>
 
}}
 
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Citation templates]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[ar:قالب:ثبت المراجع]]
[[be-x-old:Шаблён:Зноскі]]
[[bn:Template:Reflist]]
[[bs:Šablon:Refspisak]]
[[br:Patrom:Daveoù]]
[[ca:Plantilla:Referències]]
[[cy:Nodyn:Cyfeiriadau]]
[[et:Mall:Viited]]
[[eo:Ŝablono:Referencoj]]
[[es:Plantilla:Listaref]]
[[eu:Txantiloi:Erreferentzia zerrenda]]
[[fa:الگو:پانویس]]
[[fr:Modèle:Références]]
[[hi:Template:टिप्पणीसूची]]
[[hr:Predložak:Izvori]]
[[hsb:Předłoha:Referency]]
[[hu:Sablon:Reflist]]
[[ia:Patrono:Reflist]]
[[it:Template:References]]
[[ja:Template:Reflist]]
[[ka:თარგი:სქოლიოს სია]]
[[ko:틀:주석]]
[[lv:Veidne:Reflist]]
[[ml:ഫലകം:Reflist]]
[[ms:Templat:Reflist]]
[[no:Mal:Reflist]]
[[pl:Szablon:Przypisy]]
[[pt:Predefinição:Referências]]
[[ro:Format:Listănote]]
[[ru:Шаблон:Примечания]]
[[sr:Шаблон:Напомене]]
[[fi:Malline:Viitteet]]
[[th:แม่แบบ:รายการอ้างอิง]]
[[uk:Шаблон:Reflist]]
[[vi:Bản mẫu:Tham khảo]]
[[zh:Template:Reflist]]
</includeonly>

Revision as of 09:58, 11 May 2011

Template:Mbox

This template encapsulates the <references /> tag to show the list of references defined by <ref></ref> tags, with some formatting. It reduces the font size and has options for columns and groups. References can be defined within the body of the article or within the reference list.

The <ref></ref> and <references /> tags are part of the Cite.php MediaWiki extension.

Usage

Using only footnote-style references
== Content ==
Lorem ipsum.<ref>Source name, access date, etc.</ref>

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

== References ==
{{Reflist}}
Using only bibliographical style references
== Content ==
Lorem ipsum.

Lorem ipsum dolor sit amet.

== References ==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
Using both footnote-style and bibliography-style references

== Content ==

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

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

Lorem ipsum.

Lorem ipsum dolor sit amet.

== References ==

{{Reflist}}

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

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 Special:Preferences → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.

Columns

Using {{Reflist|2}} will create a two-column reference list, and {{Reflist|3}} will create a three-column list, and so on. Choose the number of columns that is appropriate for the average width of the references on the page.

Using {{Reflist|30em}} will create columns with a minimum width of 30em, 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.

Columns are currently supported only by Gecko-based browsers (such as Mozilla Firefox) and WebKit-based browsers (such as Google Chrome and Safari). See below for more information.

See also bug combining grouped references and columns

List styles

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.


Multiple uses

If {{Reflist}} is used multiple times without a parameter, each instance will include all of the previously defined references. To force the parser to close previous references, each use of {{Reflist}} must be forced as a new instance by the use of any parameter. Even an undefined parameter such as {{Reflist|close=1}} will force the references to close.

Grouped references

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. See WP:REFGROUP.

The general format for the reference tag would be:

<ref group="groupname">

And for the reflist:

{{Reflist|group="groupname"}}
Where groupname would be a group identifier such as "note", "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...).

See also bug combining grouped references and columns

List-defined references

As of September 2009, references may be defined within {{Reflist}} using |refs= and invoked within the content. There are new error messages associated with this update, documented at Help:Cite errors. As usual, groups can be used. Defined references must be used within the body; unused references will show an error message.

Example

This is reference 1.<ref name="refname1" group="groupname" />
This is reference 2.<ref name="refname2" group="groupname" />
This is reference 3.<ref name="refname3" group="groupname" />

{{Reflist|group="groupname"|refs=
<ref name="refname1" group="groupname">content1</ref>
<ref name="refname2" group="groupname">content2</ref>
<ref name="refname3" group="groupname">content3</ref>
}}

Result

This is reference 1.[groupname 1] This is reference 2.[groupname 2] This is reference 3.[groupname 3]

  1. content1
  2. content2
  3. content3

Technical details

Browser support for columns

CSS3 multiple column layout
browser support
Internet
Explorer
Firefox Safari Chrome Opera
6 3 3.1 7 10.5
7 3.5 3.2 8 10.6
8 3.6 4 9 11
9 4 5 10 11.1
10

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}}.[5][6]

These browsers support CSS3 columns:

These browsers do not support CSS3 columns:

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

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.

Bugs

Note that, whereas {{reflist|15em|group="e"}} works as expected, {{reflist|15em |group="e"}} (with an extra space) currently does not display in columns.

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

See also

References