Template:Ref

Template documentation
Note: portions of the template sample may not be visible without values provided.
View or edit this template's documentation. (About template documentation)

Preface:

• There are some circumstances where putting ref text inline is preferable, such as those located in parser functions that may or may not produce a result. In this case, if no ref is produced, references put in another section also won't display, which may be desired behavior.
• This template and the {{ref}} template don't have full Cite features and may not always be sufficient, as they're intended only as a shortcut for our most common use cases.

Recommended Examples

One ref, text at bottom

Single references text afterwards{{ref|name=note1}} at bottom.
{{references|
{{ref|This is "note1" content, moved to references section,|name=note1}}
}}

Gives:
Single references, text afterwards at bottom.

One ref, reused, text at bottom

Multiple references{{ref|name=note1}}, same ref used twice, text afterwards{{ref|name=note1}} at bottom.
{{references|
{{ref|This is "note1" content, moved to references section,|name=note1}}
}}

Gives:
Multiple references, same ref used twice, text afterwards at bottom.

Multiple, different refs, text at bottom

Multiple references{{ref|name=note1}}, same ref used twice, text afterwards{{ref|name=note2}} at bottom.
{{references|
{{ref|This is "note1" content, moved to references section,|name=note1}}
{{ref|This is "note2" content, moved to references section,|name=note2}}
}}

Gives:
Multiple references, same ref used twice, text afterwards at bottom.

Non-recommended Examples

Single references, inline

Some text with reference afterwards.{{ref|This is the footnote or reference text that appears where the references are set.}}
{{references}}

Gives:
Some text with reference afterwards.

Multiple references, inline

This is some {{ref|This is "one" text but this content being here makes the rest of the paragraph hard to read|name=one}} paragraph text, you're supposed to be able to read it{{ref|name=one}}, but the reference text in the middle makes that hard.{{ref|name=one}}
{{references}}

Gives:
This is some paragraph text, you're supposed to be able to read it, but the reference text in the middle makes that hard.

See Also

• See {{references}} for information on how to combine with the reference template.
• For Cite documentation, see Help:Cite
  • See Cite Extension - For multiple uses of the same footnote.
  • See Cite Extension - For separating references from text.

Notes

• Both templates are part of Extension:Cite.
• This template intentionally doesn't make use of Cite's group or extends parameters (they generally aren't used on this wiki).

A cite extension syntax (that we use on this wiki) shortcut. Most often combined with {{references}} template. This template makes the [[mw:Extensions:Cite|Cite]] extension easier to use by templating the one use-case we mostly use into an easier to use/understand and type, format. For more advanced uses of ''Cite'', apart from this template, see [[mw:Help:Cite|Help:Cite]] on MediaWiki.

Template parameters

Parameter		Description	Type	Status
(Optional, but only for refs with same name)	1 text	no description	String	optional
(Optional) name	name 2	no description	String	optional