Template:NoteTag

Template documentationview edit history purge

This template is used on approximately 6,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

There are several predefined groups that can have a reference list styled so that the label (a superscripted character within square brackets, e.g., ^[1]) of an explanatory note or citation (a.k.a. footnote, reference) matches and links to the note marker label located in the main text and the label in front of the note's text in the appropriate group's list. There can be more than one of these groups' lists in the Notes, References and other similarly purposed sections.

These predefined note and citation groups have templates that make the wikitext markup simpler. These templates also allow a standard reference to be inserted, so that an explanatory note can have a reference, or citations can be nested.

Note: If the note's text has a reference name that is used more than once, the labels will still match, but the clickable alpha characters (superscript lowercase letters like ^{a b c}) will be next to the note's label, with links to the multiple locations of its marker in the main text. See WP:REFNAME and the first point below in § Issues.

Template use by reference group type

Group type	Footnote marker template or markup	Reference list template	Sample labels
none by default, but optionally any	`<ref>...</ref>`	`{{reflist}}`	1 2 3 4 5 6 7 8 9 10
	`{{r}}` (for nested references)
	`{{refn}}` (for nested references)
lower-alpha	`{{efn}}` `{{efn-la}}`	`{{notelist}}` `{{notelist-la}}`	a b c d e f g h i j
upper-alpha	`{{efn-ua}}`	`{{notelist-ua}}`	A B C D E F G H I J
lower-roman	`{{efn-lr}}`	`{{notelist-lr}}`	i ii iii iv v vi vii viii ix x
upper-roman	`{{efn-ur}}`	`{{notelist-ur}}`	I II III IV V VI VII VIII IX X
lower-greek	`{{efn-lg}}`	`{{notelist-lg}}`	α β γ δ ε ζ η θ ι κ
note	`{{NoteTag}}` `{{efn-num}}`	`{{NoteFoot}}` `{{notelist-num}}`	note 1 note 2 note 3

{{efn}} supports |name=, which works the same as the parameter in <ref> (see, for instance, the 4th and 5th examples below). It also supports |group=, which functions similarly to the parameter of the same name in <ref> but accepts only 'lower-alpha', 'upper-alpha', 'lower-roman', 'upper-roman', 'lower-greek', or 'note'. Do not enclose values in quotes.
{{notelist}} supports the |colwidth= and |refs= parameters, which work the same as the same parameters in {{reflist}}, and |group=, which works similarly to the parameter of the same name in {{efn}}. Do not enclose values in quotes.

In these examples, the footnote labels match between the footnote marker and the reference list:

With lower-alpha labels
Markup	Renders as
Lorem ipsum dolor sit amet.{{efn\|Footnote 1}} Consectetur adipisicing elit.{{efn\|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn\|Footnote 3}} {{notelist}}	Lorem ipsum dolor sit amet.^{[lower-alpha 1]} Consectetur adipisicing elit.^{[lower-alpha 2]} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.^{[lower-alpha 3]} ↑ Footnote 1 ↑ Footnote 2 ↑ Footnote 3

With lower-roman labels
Markup	Renders as
Lorem ipsum dolor sit amet.{{efn-lr\|Footnote 1}} Consectetur adipisicing elit.{{efn-lr\|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn-lr\|Footnote 3}} {{notelist-lr}}	Lorem ipsum dolor sit amet.^{[lower-roman 1]} Consectetur adipisicing elit.^{[lower-roman 2]} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.^{[lower-roman 3]} ↑ Footnote 1 ↑ Footnote 2 ↑ Footnote 3

Markup Renders as

Lorem ipsum dolor sit amet.{{efn|group=lower-roman|Footnote 1}} Consectetur adipisicing elit.{{efn|lower-alpha|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|group=lower-roman|Footnote 3}}

Notes: 
{{notelist|group=lower-roman}}
Refs: 
{{notelist|group=lower-alpha}}

Lorem ipsum dolor sit amet.^{[lower-roman 1]} Consectetur adipisicing elit.^{[lower-alpha 1]} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.^{[lower-roman 2]}

Notes:

↑ Footnote 1
↑ Footnote 3

Refs:

↑ Footnote 2

With named references
Markup	Renders as
Lorem ipsum dolor sit amet.{{efn\|name=fn1\|Footnote 1}} Consectetur adipisicing elit.{{efn\|Footnote 2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn\|name=fn1}} {{notelist}}	Lorem ipsum dolor sit amet.^{[lower-alpha 1]} Consectetur adipisicing elit.^{[lower-alpha 2]} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.^{[lower-alpha 1]} 1 2 Footnote 1 ↑ Footnote 2

Note: With named references you only need to add the details once. For each use after the first you just need to re-use the reference name. Doing this will not cause the inline superscript to display a custom name.

Named references can also be defined in the notelist

Markup

Renders as

Lorem ipsum dolor sit amet.{{efn|name=fn1}} Consectetur adipisicing elit.{{efn|name=fn2}} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{efn|name=fn1}}

{{notelist|refs=
{{efn|name=fn1|Very long footnote 1}}
{{efn|name=fn2|Very long footnote 2}}
}}

Lorem ipsum dolor sit amet.^{[lower-alpha 1]} Consectetur adipisicing elit.^{[lower-alpha 2]} Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.^{[lower-alpha 1]}

1 2 Very long footnote 1
↑ Very long footnote 2

Currently broken; see MediaWiki talk:Common.css § <references /> groups.

List-defined footnotes are incompatible with Visual Editor. {{notelist}} is a simply a wrapper for {{reflist}}, which is a wrapper for <references />. Explanatory footnotes can be used with the raw tag (which is compatible with Visual Editor) by specifying the correct group name, for example:

<references group="lower-alpha">
<ref name="name1">Content</ref>
<ref name="name2">Content</ref>
</references>

{{refwidth}} can be used to set column widths.

Issues

Multiple backlink labels (see WP:REFNAME) are always styled as lower-alpha. This can be confusing when {{efn}} is used. See the note in the introduction of this section, above.
The entries in the reference list will show the default decimal styling if:
- The value for |group= in {{reflist}} or <references /> does not exactly match one of the predefined values; use {{efn}} or variant as |group= will not be needed.
- The value for |group= in {{reflist}} or <references /> is enclosed by quotes; use {{efn}} or variant as |group= will not be needed.
- {{reflist}} is indented with the : markup.
- <references /> is used instead of {{reflist}}
The entries in the reference list will have no styling if:
- A reference is included in {{navbox}} or one of the variants and the style is set to bodyclass=hlist; to resolve this, replace the style with listclass=hlist.

TemplateData

Inserts an explanatory footnote. Notes can be named and grouped. Will show as for example: [Note 1]

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Text	`1` `note` `content` `text`	Text of the note	Content	required
Name	`name`	Reference name of the note	Line	optional

The above documentation is transcluded from Template:NoteTag/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[1] Footnote 1

[2] Footnote 2

[3] Footnote 3

[4] Footnote 1

[5] Footnote 2

[6] Footnote 3

[7] Footnote 1

[9] Footnote 3

[8] Footnote 2

[fn1-10] 1 2 Footnote 1

[11] Footnote 2

[fn1-12] 1 2 Very long footnote 1

[fn2-13] Very long footnote 2

[lower-alpha 1]

[lower-alpha 2]

[lower-alpha 3]

[lower-roman 1]

[lower-roman 2]

[lower-roman 3]

[lower-roman 1]

[lower-alpha 1]

[lower-roman 2]

[lower-alpha 1]

[lower-alpha 2]

[lower-alpha 1]

[lower-alpha 2]