View source for Template:Reflist/doc

{{Documentation subpage}}

This [[Wikipedia:Citation templates|citation template]] provides formatting and organizational features for [[w:Help:Footnotes|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 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 {{tag|references|s}} tag.

==Parameters==
* '''First unnamed parameter''':
** '''column-count''': a natural number specifying fixed columns into which the reference list is to be rendered. Example: <code>|2|</code>.
** '''column-width''': a typographic unit of measurement such as ''em'', specifying the width for the reference list columns. Example: <code>|30em|</code>.
* '''refs''': used with named references (e.g., {{tag|ref|s|params=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., {{tlx|Reflist|2=group=groupname}} renders all references with groupname as the group name ({{tag|ref|o|params=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==
<pre>
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}}
</pre>

gives:

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

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": {
		"en": "A reference list, with options for setting columns, groups, extra references etc.",
		"cs": "Seznam referencí s možnostmi nastavení sloupců, skupin, dalších odkazů atd.",
		"pt-br": "Uma lista de referências, com opções para definir colunas, grupos, referências extras etc."
	},
	"params": {
		"1": {
			"label": {
				"en": "Column Count",
				"cs": "Počet sloupců",
				"pt-br": "Quantidade de colunas"
			},
			"type": "number",
			"default": "1",
			"description": {
				"en": "A natural number specifying fixed columns into which the reference list is to be rendered.",
				"pt-br": "Um número natural que especifica colunas fixas nas quais a lista de referência deve ser renderizada."
			},
			"example": {
				"en": "|2|",
				"cs": "|2|",
				"pt-br": "|2|"
			}
		},
		"colwidth": {
			"label": {
				"en": "Column Width",
				"cs": "Šířka sloupce",
				"pt-br": "Largura da coluna"
			},
			"type": "string",
			"description": {
				"en": "A typographic unit of measurement such as “em”, specifying the width for the reference list columns.",
				"pt-br": "Uma unidade de medida tipográfica como “em”, especificando a largura das colunas da lista de referência."
			},
			"example": {
				"en": "|colwidth=30em|",
				"cs": "|colwidth=30em|",
				"pt-br": "|colwidth=30em|"
			}
		},
		"liststyle": {
			"label": {
				"en": "List Style",
				"cs": "Styl seznamu",
				"pt-br": "Estilo de lista"
			},
			"description": {
				"en": "Specifies the style used when the reference list is enumerated; accepts any valid CSS value defined for “list-style-type”.",
				"cs": "Určuje styl použitý při výčtu seznamu odkazů; přijímá jakoukoli platnou hodnotu CSS definovanou pro “typ-style-listu”.",
				"pt-br": "Especifica o estilo usado quando a lista de referência é enumerada; aceita qualquer valor CSS válido definido para “list-style-type”."
			},
			"suggestedvalues": [
				"decimal",
				"lower-alpha",
				"lower-greek",
				"lower-roman",
				"upper-alpha",
				"upper-roman"
			],
			"default": "decimal",
			"type": "string"
		},
		"group": {
			"label": {
				"en": "Group name",
				"cs": "Název skupiny",
				"pt-br": "Nome do grupo"
			},
			"description": {
				"en": "The name of the references group. Identifies by name the subset of references to be rendered; the value should correspond to that used inline.",
				"cs": "Název skupiny doporučení.",
				"pt-br": "O nome do grupo da referência. Identifica pelo nome o subconjunto de referências a serem renderizadas; o valor deve corresponder ao inline usado."
			},
			"type": "string",
			"example": {
				"en": "{{reflist|group=groupname}} renders all references with “groupname” as the group name (<ref group=“groupname”>)",
				"pt-br": "{{reflist|group=groupname}} renderiza todas as referências com “groupname” como o nome do grupo (<ref group=“groupname”>)"
			}
		},
		"refs": {
			"label": {
				"en": "List of references",
				"cs": "Seznam doporučení",
				"pt-br": "Lista de referências"
			},
			"description": {
				"en": "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.",
				"cs": "Poskytuje prostor pro definování pojmenovaných odkazů pro použití v článku.",
				"pt-br": "Fornece um espaço para definir referências nomeadas para uso no artigo. Usado com referências nomeadas (por exemplo, <ref name=“name” />); ele especifica uma lista de algumas ou todas as referências nomeadas usadas no artigo."
			},
			"suggested": true,
			"type": "content"
		}
	}
}
</templatedata>