Editing Help:Footnotes (section)

==Footnotes: predefined groups==
{{shortcut|H:PREGROUP|WP:EXPLNOTE}}
{{for|technical details|Help:Cite link labels}}
{{for|Shortened footnotes with explanatory footnotes|Help:Shortened footnotes#Explanatory notes}}
{{See also|Wikipedia:Citing sources#Variation in citation methods|Wikipedia:Manual of Style/Layout#Notes and references}}
<section begin=pregroup /><!--this section is used as the documentation for the efn/notelist templates-->{{anchor|footnotes_predefined_groups}}
There are several predefined groups that can have a reference list styled so that the label (a superscripted character within square brackets, e.g., {{dummy ref|1}}) of an [[Help:Explanatory notes|explanatory note]] or citation ({{aka}} 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 [[Wikipedia:Citing sources#Separating citations from explanatory footnotes|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 <sup>'''''a b c'''''</sup>) will be ''next to'' the note's label, with links to the multiple locations of its marker in the main text. See [[Help:Footnotes#Footnotes: using a source more than once|WP:REFNAME]] and the first point below in [[#Issues|§&nbsp;Issues]].

===Template use by reference group type===
<section begin=pregrouptable />
{| class="wikitable"
|- style="vertical-align:top;"
! Group type !! Footnote marker template<br/>or markup !! Reference list<br/> template !! Sample labels
|-
|rowspan=3|''none by default,<br>but optionally any'' || {{tag|ref}}
|rowspan=3| {{tlx|reflist}}
|rowspan=3| 1 2 3 4 5 6 7 8 9 10
|-
| {{tlx|r}} (for nested references)
|-
| {{tlx|refn}} (for nested references)
|-
| lower-alpha || {{ubl| {{tlx|efn}} | {{tlx|efn-la}} }} || {{ubl| {{tlx|notelist}} | {{tlx|notelist-la}} }} || a b c d e f g h i j
|-
| upper-alpha || {{tlx|efn-ua}} || {{tlx|notelist-ua}} || A B C D E F G H I J
|-
| lower-roman || {{tlx|efn-lr}} || {{tlx|notelist-lr}} || i ii iii iv v vi vii viii ix x
|-
| upper-roman || {{tlx|efn-ur}} || {{tlx|notelist-ur}} || I II III IV V VI VII VIII IX X
|-
| lower-greek || {{tlx|efn-lg}} || {{tlx|notelist-lg}} || α β γ δ ε ζ η θ ι κ
|-
|note || {{ubl| {{tlx|NoteTag}} | {{tlx|efn-num}} }} || {{ubl| {{tlx|NoteFoot}} | {{tlx|notelist-num}} }} || note 1 note 2 note 3
|}<section end="pregrouptable" />

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

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

{{markup|title=With lower-alpha labels
|<nowiki>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}}
</nowiki>
|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}}
}}

{{markup|title=With lower-roman labels
|<nowiki>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}}
</nowiki>
|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}}
}}

{{markup|title=With {{para|group}} and multiple types
|<nowiki>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}}
</nowiki>
|Lorem ipsum dolor sit amet.{{efn|group=lower-roman|Footnote 1}} Consectetur adipisicing elit.{{efn|group=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}}
}}

{{markup|title=With named references
|<nowiki>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}}
</nowiki>
|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}}
}}
'''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.

{{markup|title=Named references can also be defined in the notelist
|<nowiki>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}}
}}
</nowiki>
|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}}
}}
}}

{{collapsed top|title=Currently broken; see {{section link|MediaWiki talk:Common.css|&lt;references /&gt; groups}}.}}

[[WP:LDR|List-defined footnotes]] are incompatible with Visual Editor. {{tl|notelist}} is a simply a wrapper for {{tl|reflist}}, which is a wrapper for {{tag|references|s}}. Explanatory footnotes can be used with the raw tag (which ''is'' compatible with Visual Editor) by specifying the correct group name, for example:

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

{{tl|refwidth}} can be used to set column widths.
{{collapsed bottom}}

===Issues===
* Multiple backlink labels (see [[WP:REFNAME]]) are always styled as lower-alpha. This can be confusing when {{tlx|efn}} is used. See the note in the introduction of [[#footnotes_predefined_groups|this section]], above.
* The entries in the reference list will show the default decimal styling if:
** The value for {{para|group}} in {{tlx|reflist}} or {{tag|references|s}} does not exactly match one of the predefined values; use {{tlx|efn}} or variant as {{para|group}} will not be needed.
** The value for {{para|group}} in {{tlx|reflist}} or {{tag|references|s}} is enclosed by quotes; use {{tlx|efn}} or variant as {{para|group}} will not be needed.
** {{tlx|reflist}} is indented with the {{code|:}} markup.
** {{tag|references|s}} is used instead of {{tlx|reflist}}
* The entries in the reference list will have no styling if:
** A reference is included in {{tlx|navbox}} or one of the variants and the style is set to <code>bodyclass=hlist</code>; to resolve this, replace the style with <code>listclass=hlist</code>.<section end=pregroup />
* If the note text contains an "=" sign, precede the note text with {{para|1}}, like this: <code><nowiki>{{efn|name=fn1|1=Very long footnote with an equation, 2+2=4}}</nowiki></code>
* If {{tlx|notelist}} is embedded within an infobox, a navbox or a reference section that already uses a small font size, the footnotes will likely render in a font size that breaches the 85% minimum needed to maintain accessibility described at [[MOS:SMALLFONT]]. This can be addressed by wrapping <nowiki>{{notelist}}</nowiki> with <nowiki><div></nowiki> tags that increase the font size of the output produced by the <code>notelist</code> template. For instance, to call <code>notelist</code> within an infobox that calls {{tlx|infobox}}, <code><nowiki><div style="font-size:108%">{{notelist}}</div></nowiki></code> will cause the output of the <code>notelist</code> template to render in the same font size as the remainder of the text in the infobox.