|
|
(One intermediate revision by one other user not shown) |
Line 1: |
Line 1: |
| {{Documentation subpage}} | | {{{{PAGENAME}}/Documentation}} |
| <includeonly>{{High-risk|2,000,000+}}</includeonly>
| |
| {{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.}}
| |
| | |
| 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.
| |
| | |
| The {{tag|ref}} and {{tag|references |single}} tags are part of the [[mw:Extension:Cite/Cite.php|Cite.php]] MediaWiki extension.
| |
| | |
| ==Usage==
| |
| ;Using only footnote-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>
| |
| | |
| ==References==
| |
| | |
| {{Reflist}}
| |
| </pre>
| |
| | |
| ;Using only bibliographical style references (no direct references from the text)
| |
| <pre>
| |
| | |
| ==Content==
| |
| Lorem ipsum. Lorem ipsum dolor sit amet.
| |
| | |
| ==References==
| |
| {{Refbegin}}
| |
| * reference 1
| |
| * reference 2
| |
| {{Refend}}
| |
| </pre>
| |
| | |
| ;Using both footnote-style and bibliography-style references
| |
| <pre>
| |
| ==References==
| |
| | |
| {{Reflist}}
| |
| | |
| {{Refbegin}}
| |
| * reference 1
| |
| * reference 2
| |
| {{Refend}}
| |
| </pre>
| |
| | |
| ===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.
| |
| | |
| 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. There are CSS3 selectors that could resolve this, but they are not yet supported by any major browsers.
| |
| | |
| See also [[#groupandcolumn|bug combining grouped references and columns]].
| |
| | |
| ===List styles===
| |
| {{main|Help:Cite link labels}}
| |
| | |
| Reference lists are by default numbered lists. By using the {{para|liststyle}} parameter, you can control how the list is rendered. For example, using {{para|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 <code>list-style-type</code> as shown below.
| |
| | |
| The citations in the reference list will show the default decimal styling if:
| |
| * The value for {{para|liststyle}} does not exactly match one of the predefined values
| |
| * The value for {{para|liststyle}} is enclosed by quotes
| |
| * {{tl|Reflist}} is indented with the : markup
| |
| | |
| {{CSS list-style-type values}}
| |
| | |
| ===Multiple uses===
| |
| {{see|Help:Footnotes#Multiple reference lists}}
| |
| | |
| 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. If no parameter is desired, the convention is to use the undefined parameter {{tlx|Reflist|close=1}}.
| |
| | |
| ===List-defined references===
| |
| {{see|WP:List-defined references}}
| |
| | |
| A list of references may be defined within {{tl|Reflist}} using the {{para|refs}} parameter, just like including named <nowiki><ref name=". . ."></nowiki> elements inside the <nowiki><references></nowiki> 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 {{tl|Reflist}} but not used within the body.
| |
| | |
| ====Example====
| |
| | |
| <pre>
| |
| This is reference 1.<ref name="refname1" />
| |
| This is reference 2.<ref name="refname2" />
| |
| | |
| {{Reflist|refs=
| |
| <ref name="refname1">content1</ref>
| |
| <ref name="refname2">content2</ref>
| |
| }}
| |
| </pre>
| |
| | |
| ====Result====
| |
| | |
| This is reference 1.<ref name="refname1" group="LDR"/>
| |
| This is reference 2.<ref name="refname2" group="LDR"/>
| |
| | |
| {{Reflist|group="LDR"|refs=
| |
| <ref name="refname1">content1</ref>
| |
| <ref name="refname2">content2</ref>
| |
| }}
| |
| | |
| The LDR group text is to avoid conflicts with other groups of references in this documentation and would not be present in real use.
| |
| | |
| ===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 is:
| |
| | |
| :{{tag|ref|open|params=group=''"groupname"''}}
| |
| | |
| And using {{para|group}} 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...) and must be written without quotes.
| |
| | |
| See also [[#groupandcolumn|bug combining grouped references and columns]].
| |
| | |
| ==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.
| |
| | |
| ==Technical details==
| |
| | |
| ===Browser support for columns===
| |
| | |
| {{shortcut|WP:REFCOLS}}
| |
| | |
| {{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 number 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]] – style guide for the citation of sources
| |
| * [[Wikipedia:Citation templates]] – templates for use with references
| |
| * {{tl|Refbegin}} and {{tl|Refend}} – format reference lists
| |
| | |
| Variants
| |
| * {{tl|Template reference list}} – version of reflist for use in templates
| |
| * {{tl|Reflist-talk}} – for use on talk pages
| |
| * {{tl|Notelist}} – for use with explanatory notes; sets {{para|group|lower-alpha}}
| |
| | |
| ==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>
| |
| | |
| [[Category:Citation templates]]
| |
| </includeonly>
| |