Template:Reflist/doc: Difference between revisions

From lisamarieyoung.ca
en>Nerun
No edit summary
 
m (1 revision imported)
 
(No difference)

Latest revision as of 02:40, 10 November 2023

[[Category:Template documentation pages{{#translation:}}]]

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.

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., Template:((Reflist|group=groupnameTemplate:)) renders all references with groupname as the group name (‎<ref group=groupname>).
  • liststyle: specifies the style used when the reference list is enumerated; if none is specified, the default is to render a numbered list.

Example

Lorem.<ref>ipsum</ref><ref>dolor</ref><ref>sit</ref><ref>amet</ref>
Consectetur.<ref>adipisicing</ref><ref>elit, sed</ref><ref>do</ref>

{{Reflist|3}}

gives:

Lorem.[1][2][3][4] Consectetur.[5][6][7]

  1. ipsum
  2. dolor
  3. sit
  4. amet
  5. adipisicing
  6. elit, sed
  7. do

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Reflist in articles based on its TemplateData.

TemplateData for Reflist

A reference list, with options for setting columns, groups, extra references etc.

Template parameters

ParameterDescriptionTypeStatus
Column Count1

A natural number specifying fixed columns into which the reference list is to be rendered.

Default
1
Example
|2|
Numberoptional
Column Widthcolwidth

A typographic unit of measurement such as “em”, specifying the width for the reference list columns.

Example
|colwidth=30em|
Stringoptional
List Styleliststyle

Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for “list-style-type”.

Suggested values
decimal lower-alpha lower-greek lower-roman upper-alpha upper-roman
Default
decimal
Stringoptional
Group namegroup

The name of the references group. Identifies by name the subset of references to be rendered; the value should correspond to that used inline.

Example
{{reflist|group=groupname}} renders all references with “groupname” as the group name (<ref group=“groupname”>)
Stringoptional
List of referencesrefs

Provides a space to define named references for use in the article. Used with named references (e.g., ‎<ref name=“name” />); it specifies a list of some or all named references used in the article.

Contentsuggested